leo-passes 2.7.1

Compiler passes 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-2025 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_ast::{DefinitionPlace, DefinitionStatement, Expression, Identifier, NodeID, Statement};
use leo_span::Symbol;

use std::{cell::RefCell, fmt::Display};

/// A struct used to create assignment statements.
#[derive(Debug, Default, Clone)]
pub struct Assigner {
    /// The inner counter.
    /// `RefCell` is used here to avoid `&mut` all over the compiler.
    inner: RefCell<AssignerInner>,
}

impl Assigner {
    /// Return a new unique `Symbol` from a `&str`.
    pub fn unique_symbol(&self, arg: impl Display, separator: impl Display) -> Symbol {
        self.inner.borrow_mut().unique_symbol(arg, separator)
    }

    /// Constructs the definition statement `let place = expr;`.
    /// This function should be the only place where `DefinitionStatement`s are constructed.
    pub fn simple_definition(&self, identifier: Identifier, value: Expression, id: NodeID) -> Statement {
        self.inner.borrow_mut().simple_definition(identifier, value, id)
    }
}

/// Contains the actual data for `Assigner`.
/// Modeled this way to afford an API using interior mutability.
#[derive(Debug, Default, Clone)]
pub struct AssignerInner {
    /// A strictly increasing counter, used to ensure that new variable names are unique.
    pub(crate) counter: usize,
}

impl AssignerInner {
    /// Return a new unique `Symbol` from a `&str`.
    fn unique_symbol(&mut self, arg: impl Display, separator: impl Display) -> Symbol {
        self.counter += 1;
        Symbol::intern(&format!("{}{}{}", arg, separator, self.counter - 1))
    }

    /// Constructs the definition statement `let place = expr;`.
    /// This function should be the only place where `DefinitionStatement`s are constructed.
    fn simple_definition(&mut self, identifier: Identifier, value: Expression, id: NodeID) -> Statement {
        DefinitionStatement {
            place: DefinitionPlace::Single(identifier),
            type_: None,
            value,
            span: Default::default(),
            id,
        }
        .into()
    }
}