leo-passes 1.10.0

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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

// 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 crate::DeadCodeEliminator;

use leo_ast::{
    AccessExpression,
    AssociatedFunction,
    Expression,
    ExpressionReconstructor,
    Identifier,
    MemberAccess,
    StructExpression,
    StructVariableInitializer,
    TupleAccess,
    Type,
};
use leo_span::sym;

impl ExpressionReconstructor for DeadCodeEliminator<'_> {
    type AdditionalOutput = ();

    /// Reconstructs the components of an access expression.
    fn reconstruct_access(&mut self, input: AccessExpression) -> (Expression, Self::AdditionalOutput) {
        (
            Expression::Access(match input {
                AccessExpression::AssociatedFunction(function) => {
                    // If the associated function manipulates a mapping, mark the statement as necessary.
                    match (&function.ty, function.name.name) {
                        (Type::Identifier(Identifier { name: sym::Mapping, .. }), sym::get)
                        | (Type::Identifier(Identifier { name: sym::Mapping, .. }), sym::get_or_use)
                        | (Type::Identifier(Identifier { name: sym::Mapping, .. }), sym::set) => {
                            self.is_necessary = true;
                        }
                        _ => {}
                    };
                    // Reconstruct the access expression.
                    let result = AccessExpression::AssociatedFunction(AssociatedFunction {
                        ty: function.ty,
                        name: function.name,
                        arguments: function
                            .arguments
                            .into_iter()
                            .map(|arg| self.reconstruct_expression(arg).0)
                            .collect(),
                        span: function.span,
                        id: function.id,
                    });
                    // Unset `self.is_necessary`.
                    self.is_necessary = false;
                    result
                }
                AccessExpression::Member(member) => AccessExpression::Member(MemberAccess {
                    inner: Box::new(self.reconstruct_expression(*member.inner).0),
                    name: member.name,
                    span: member.span,
                    id: member.id,
                }),
                AccessExpression::Tuple(tuple) => AccessExpression::Tuple(TupleAccess {
                    tuple: Box::new(self.reconstruct_expression(*tuple.tuple).0),
                    index: tuple.index,
                    span: tuple.span,
                    id: tuple.id,
                }),
                AccessExpression::AssociatedConstant(constant) => AccessExpression::AssociatedConstant(constant),
            }),
            Default::default(),
        )
    }

    /// Reconstruct the components of the struct init expression.
    /// This is necessary since the reconstructor does not explicitly visit each component of the expression.
    fn reconstruct_struct_init(&mut self, input: StructExpression) -> (Expression, Self::AdditionalOutput) {
        (
            Expression::Struct(StructExpression {
                name: input.name,
                // Reconstruct each of the struct members.
                members: input
                    .members
                    .into_iter()
                    .map(|member| StructVariableInitializer {
                        identifier: member.identifier,
                        expression: match member.expression {
                            Some(expression) => Some(self.reconstruct_expression(expression).0),
                            None => unreachable!("Static single assignment ensures that the expression always exists."),
                        },
                        span: member.span,
                        id: member.id,
                    })
                    .collect(),
                span: input.span,
                id: input.id,
            }),
            Default::default(),
        )
    }

    /// Marks identifiers as used.
    /// This is necessary to determine which statements can be eliminated from the program.
    fn reconstruct_identifier(&mut self, input: Identifier) -> (Expression, Self::AdditionalOutput) {
        // Add the identifier to `self.used_variables`.
        if self.is_necessary {
            self.used_variables.insert(input.name);
        }
        // Return the identifier as is.
        (Expression::Identifier(input), Default::default())
    }
}