leo-passes 1.7.2

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

// Copyright (C) 2019-2023 Aleo Systems 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::{Function, Input, Type, Variant};
use leo_span::Span;

use crate::SymbolTable;

/// Metadata associated with the finalize block.
#[derive(Debug, Clone)]
pub struct FinalizeData {
    /// The inputs to the finalize block.
    pub(crate) input: Vec<Input>,
    /// The output type of the finalize block.
    pub(crate) output_type: Type,
}

/// An entry for a function in the symbol table.
#[derive(Clone, Debug)]
pub struct FunctionSymbol {
    /// The index associated with the scope in the parent symbol table.
    pub(crate) id: usize,
    /// The output type of the function.
    pub(crate) output_type: Type,
    /// Is this function a transition, inlined, or a regular function?.
    pub variant: Variant,
    /// The `Span` associated with the function.
    pub(crate) _span: Span,
    /// The inputs to the function.
    pub(crate) input: Vec<Input>,
    /// Metadata associated with the finalize block.
    pub(crate) finalize: Option<FinalizeData>,
}

impl SymbolTable {
    pub(crate) fn new_function_symbol(id: usize, func: &Function) -> FunctionSymbol {
        FunctionSymbol {
            id,
            output_type: func.output_type.clone(),
            variant: func.variant,
            _span: func.span,
            input: func.input.clone(),
            finalize: func.finalize.as_ref().map(|finalize| FinalizeData {
                input: finalize.input.clone(),
                output_type: finalize.output_type.clone(),
            }),
        }
    }
}