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

// 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 crate::{Block, Expression, Identifier, Indent, Node, NodeID, Statement, Type};

use leo_span::Span;

use serde::{Deserialize, Serialize};
use std::fmt;

/// A bounded `for` loop statement `for variable in start .. =? stop block`.
#[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Debug)]
pub struct IterationStatement {
    /// The binding / variable to introduce in the body `block`.
    pub variable: Identifier,
    /// The type of the iteration.
    pub type_: Option<Type>,
    /// The start of the iteration.
    pub start: Expression,
    /// The end of the iteration, possibly `inclusive`.
    pub stop: Expression,
    /// Whether `stop` is inclusive or not.
    /// Signified with `=` when parsing.
    pub inclusive: bool,
    /// The block to run on each iteration.
    pub block: Block,
    /// The span from `for` to `block`.
    pub span: Span,
    /// The ID of the node.
    pub id: NodeID,
}

impl fmt::Display for IterationStatement {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let eq = if self.inclusive { "=" } else { "" };
        if let Some(ty) = &self.type_ {
            writeln!(f, "for {}: {} in {}..{eq}{} {{", self.variable, ty, self.start, self.stop)?;
        } else {
            writeln!(f, "for {} in {}..{eq}{} {{", self.variable, self.start, self.stop)?;
        }
        for stmt in self.block.statements.iter() {
            writeln!(f, "{}{}", Indent(stmt), stmt.semicolon())?;
        }
        writeln!(f, "}}")
    }
}

impl From<IterationStatement> for Statement {
    fn from(value: IterationStatement) -> Self {
        Statement::Iteration(Box::new(value))
    }
}

crate::simple_node_impl!(IterationStatement);