leo-ast 4.0.2

Abstract syntax tree (AST) for the Leo programming 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

// Copyright (C) 2019-2026 Provable Inc.
// This file is part of the Leo library.

// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.

use leo_span::Symbol;

use crate::{Composite, ConstDeclaration, Function, Indent, Interface, Module};
use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
use std::fmt;

/// Stores the Leo library abstract syntax tree.
///
/// Libraries may contain `const` declarations, `struct` definitions, `fn` functions,
/// `interface` definitions, and submodules (each a separate source file under the
/// library's `src/` directory).
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct Library {
    pub name: Symbol,
    /// Submodules of this library, keyed by their path (e.g., `[utils]` for `src/utils.leo`).
    pub modules: IndexMap<Vec<Symbol>, Module>,
    /// The constants defined in this library.
    pub consts: Vec<(Symbol, ConstDeclaration)>,
    /// The struct definitions in this library.
    pub structs: Vec<(Symbol, Composite)>,
    /// The function definitions in this library.
    pub functions: Vec<(Symbol, Function)>,
    /// The interface definitions in this library.
    pub interfaces: Vec<(Symbol, Interface)>,
}

impl fmt::Display for Library {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        writeln!(f, "library {} {{", self.name)?;

        for (_, interface) in self.interfaces.iter() {
            writeln!(f, "{}", Indent(interface))?;
        }

        for (_, struct_def) in self.structs.iter() {
            writeln!(f, "{}", Indent(struct_def))?;
        }

        for (_, const_decl) in self.consts.iter() {
            writeln!(f, "{};", Indent(const_decl))?;
        }

        for (_, func) in self.functions.iter() {
            writeln!(f, "{}", Indent(func))?;
        }

        for (_, module) in self.modules.iter() {
            writeln!(f, "{}", module)?;
        }

        writeln!(f, "}}")
    }
}