leo-passes 2.6.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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

// 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/>.

mod expression;

mod program;

mod scope_state;

mod statement;

mod visitor;
use visitor::*;

use self::scope_state::ScopeState;
use crate::{CallGraph, CompilerState, Pass, StructGraph};

use leo_ast::ProgramVisitor;
use leo_errors::Result;

use indexmap::{IndexMap, IndexSet};

/// Specify network limits for type checking.
pub struct TypeCheckingInput {
    pub max_array_elements: usize,
    pub max_mappings: usize,
    pub max_functions: usize,
}

/// A pass to check types.
///
/// Also constructs the struct graph, call graph, and local symbol table data.
pub struct TypeChecking;

impl Pass for TypeChecking {
    type Input = TypeCheckingInput;
    type Output = ();

    const NAME: &'static str = "TypeChecking";

    fn do_pass(input: Self::Input, state: &mut CompilerState) -> Result<Self::Output> {
        let struct_names = state
            .symbol_table
            .iter_records()
            .map(|(loc, _)| loc.name)
            .chain(state.symbol_table.iter_structs().map(|(name, _)| name))
            .collect();
        let function_names = state.symbol_table.iter_functions().map(|(loc, _)| loc.name).collect();

        let ast = std::mem::take(&mut state.ast);

        // Note that the `struct_graph` and `call_graph` are initialized with their full node sets.
        state.struct_graph = StructGraph::new(struct_names);
        state.call_graph = CallGraph::new(function_names);

        let mut visitor = TypeCheckingVisitor {
            state,
            scope_state: ScopeState::new(),
            async_function_input_types: IndexMap::new(),
            async_function_callers: IndexMap::new(),
            used_structs: IndexSet::new(),
            conditional_scopes: Vec::new(),
            limits: input,
        };
        visitor.visit_program(ast.as_repr());
        visitor.state.handler.last_err().map_err(|e| *e)?;

        // Remove unused structs from the struct graph.
        // This prevents unused struct definitions from being included in the generated bytecode.
        visitor.state.struct_graph.retain_nodes(&visitor.used_structs);
        visitor.state.ast = ast;

        Ok(())
    }
}