leo_passes/type_checking/
mod.rs

1// Copyright (C) 2019-2025 Provable Inc.
2// This file is part of the Leo library.
3
4// The Leo library is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// The Leo library is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.
16
17mod ast;
18
19mod program;
20
21mod scope_state;
22
23mod visitor;
24use visitor::*;
25
26use self::scope_state::ScopeState;
27use crate::{CompilerState, Pass};
28
29use leo_ast::{CallGraph, NetworkName, ProgramVisitor, StructGraph};
30use leo_errors::Result;
31
32use snarkvm::prelude::{CanaryV0, MainnetV0, Network, TestnetV0};
33
34use indexmap::{IndexMap, IndexSet};
35
36/// Specify network limits for type checking.
37#[derive(Clone)]
38pub struct TypeCheckingInput {
39    pub max_array_elements: usize,
40    pub max_mappings: usize,
41    pub max_functions: usize,
42    pub max_inputs: usize,
43    pub max_outputs: usize,
44}
45
46impl TypeCheckingInput {
47    /// Create a new `TypeCheckingInput` from the given network.
48    pub fn new(network: NetworkName) -> Self {
49        let (max_array_elements, max_mappings, max_functions, max_inputs, max_outputs) = match network {
50            NetworkName::MainnetV0 => (
51                MainnetV0::MAX_ARRAY_ELEMENTS,
52                MainnetV0::MAX_MAPPINGS,
53                MainnetV0::MAX_FUNCTIONS,
54                MainnetV0::MAX_INPUTS,
55                MainnetV0::MAX_OUTPUTS,
56            ),
57            NetworkName::TestnetV0 => (
58                TestnetV0::MAX_ARRAY_ELEMENTS,
59                TestnetV0::MAX_MAPPINGS,
60                TestnetV0::MAX_FUNCTIONS,
61                TestnetV0::MAX_INPUTS,
62                TestnetV0::MAX_OUTPUTS,
63            ),
64            NetworkName::CanaryV0 => (
65                CanaryV0::MAX_ARRAY_ELEMENTS,
66                CanaryV0::MAX_MAPPINGS,
67                CanaryV0::MAX_FUNCTIONS,
68                CanaryV0::MAX_INPUTS,
69                CanaryV0::MAX_OUTPUTS,
70            ),
71        };
72        Self { max_array_elements, max_mappings, max_functions, max_inputs, max_outputs }
73    }
74}
75
76/// A pass to check types.
77///
78/// Also constructs the struct graph, call graph, and local symbol table data.
79pub struct TypeChecking;
80
81impl Pass for TypeChecking {
82    type Input = TypeCheckingInput;
83    type Output = ();
84
85    const NAME: &'static str = "TypeChecking";
86
87    fn do_pass(input: Self::Input, state: &mut CompilerState) -> Result<Self::Output> {
88        let struct_names = state
89            .symbol_table
90            .iter_records()
91            .map(|(loc, _)| loc.path.clone())
92            .chain(state.symbol_table.iter_structs().map(|(name, _)| name.clone()))
93            .collect();
94        let function_names = state.symbol_table.iter_functions().map(|(loc, _)| loc.clone()).collect();
95
96        let ast = std::mem::take(&mut state.ast);
97
98        // Initialize the struct graph with all the structs in the program.
99        state.struct_graph = StructGraph::new(struct_names);
100        // Initialize the call graph with all the functions in the program.
101        state.call_graph = CallGraph::new(function_names);
102
103        let mut visitor = TypeCheckingVisitor {
104            state,
105            scope_state: ScopeState::new(),
106            async_function_input_types: IndexMap::new(),
107            async_function_callers: IndexMap::new(),
108            used_structs: IndexSet::new(),
109            conditional_scopes: Vec::new(),
110            limits: input,
111            async_block_id: None,
112        };
113        visitor.visit_program(ast.as_repr());
114        visitor.state.handler.last_err()?;
115
116        // Remove unused structs from the struct graph.
117        // This prevents unused struct definitions from being included in the generated bytecode.
118        visitor.state.struct_graph.retain_nodes(&visitor.used_structs);
119        visitor.state.ast = ast;
120
121        Ok(())
122    }
123}
leo_passes/type_checking/mod.rs

leo_passes/type_checking/
mod.rs
