miden-assembly-syntax 0.24.0

Parsing and semantic analysis of the Miden Assembly language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

mod index;
mod items;
mod resolver;

use miden_debug_types::Spanned;

pub use self::{
    index::{GlobalItemIndex, ItemIndex, ModuleIndex},
    items::Item,
    resolver::{
        LocalSymbol, LocalSymbolResolver, SymbolResolution, SymbolResolutionError, SymbolTable,
    },
};
use super::{Ident, Import, Visibility};

#[derive(Debug, Copy, Clone)]
pub enum Declaration<'a> {
    Item(&'a Item),
    Import(&'a Import),
    Submodule(&'a SubmoduleDecl),
}

impl Spanned for Declaration<'_> {
    fn span(&self) -> miden_debug_types::SourceSpan {
        match self {
            Self::Item(item) => item.span(),
            Self::Import(import) => import.local_name().span(),
            Self::Submodule(decl) => decl.name.span(),
        }
    }
}

/// Represents a submodule declaration in a [super::Module], i.e. `mod foo` or `pub mod foo`
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SubmoduleDecl {
    /// The visibility of the submodule outside the containing namespace.
    ///
    /// A private submodule is visible only to:
    ///
    /// * It's parent
    /// * It's siblings and their descendants
    ///
    /// A public submodule is visible to everyone.
    pub visibility: Visibility,
    /// The name of the submodule
    ///
    /// The full path of the submodule is derived from the path of its parent module
    pub name: Ident,
}