microcad-lang 0.5.0

µcad 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
50
51
52
53
54

// Copyright © 2024-2026 The µcad authors <info@microcad.xyz>
// SPDX-License-Identifier: AGPL-3.0-or-later

//! Module definition syntax element.

use std::rc::Rc;

use microcad_lang_base::{Identifier, SrcRef, SrcReferrer};
use microcad_lang_proc_macros::Identifiable;

use crate::lower::ir;

/// Module definition.
#[derive(Clone, Debug, Default, Identifiable)]
pub struct ModuleDefinition {
    /// SrcRef of the `mod` keyword
    pub keyword_ref: SrcRef,
    /// Outer documentation.
    pub doc: ir::DocBlock,
    /// Visibility of the module.
    pub visibility: ir::Visibility,
    /// Name of the module.
    pub(crate) id: ir::Identifier,
    /// Module body. ('None' if file module)
    pub body: Option<ir::Body>,
}

impl ModuleDefinition {
    /// Create a new module definition.
    pub fn new(visibility: ir::Visibility, id: Identifier) -> Rc<Self> {
        Rc::new(Self {
            visibility,
            id,
            ..Default::default()
        })
    }
}

impl SrcReferrer for ModuleDefinition {
    fn src_ref(&self) -> SrcRef {
        self.id.src_ref()
    }
}

impl std::fmt::Display for ModuleDefinition {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{visibility}mod {id}",
            id = self.id,
            visibility = self.visibility,
        )
    }
}