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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

// 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 super::*;
use crate::Identifier;

use itertools::Itertools as _;

/// An initializer for a single field / variable of a composite initializer expression.
/// That is, in `Foo { bar: 42, baz }`, this is either `bar: 42`, or `baz`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CompositeFieldInitializer {
    /// The name of the field / variable to be initialized.
    pub identifier: Identifier,
    /// The expression to initialize the field with.
    /// When `None`, a binding, in scope, with the name will be used instead.
    pub expression: Option<Expression>,
    /// The span of the node.
    pub span: Span,
    /// The ID of the node.
    pub id: NodeID,
}

crate::simple_node_impl!(CompositeFieldInitializer);

impl fmt::Display for CompositeFieldInitializer {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if let Some(expr) = &self.expression {
            write!(f, "{}: {expr}", self.identifier)
        } else {
            write!(f, "{}", self.identifier)
        }
    }
}

/// A composite initialization expression, e.g., `Foo { bar: 42, baz }`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CompositeExpression {
    /// A path to a composite type to initialize.
    pub path: Path,
    /// Expressions for the const arguments passed to the composite's const parameters.
    pub const_arguments: Vec<Expression>,
    /// Initializer expressions for each of the fields in the composite.
    ///
    /// N.B. Any functions or member constants in the composite definition
    /// are excluded from this list.
    pub members: Vec<CompositeFieldInitializer>,
    /// A span from `name` to `}`.
    pub span: Span,
    /// The ID of the node.
    pub id: NodeID,
}

impl fmt::Display for CompositeExpression {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.path)?;
        if !self.const_arguments.is_empty() {
            write!(f, "::[{}]", self.const_arguments.iter().format(", "))?;
        }
        write!(f, " {{")?;

        if !self.members.is_empty() {
            write!(f, " ")?;
        }
        write!(f, "{}", self.members.iter().format(", "))?;
        if !self.members.is_empty() {
            write!(f, " ")?;
        }
        write!(f, "}}")
    }
}

impl From<CompositeExpression> for Expression {
    fn from(value: CompositeExpression) -> Self {
        Expression::Composite(value)
    }
}

crate::simple_node_impl!(CompositeExpression);