leo-ast 4.0.2

Abstract syntax tree (AST) 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

// Copyright (C) 2019-2026 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 crate::{Expression, IntegerType, Literal, LiteralVariant, ProgramId, Type};
use snarkvm::console::program::ArrayType as ConsoleArrayType;

use leo_span::Span;
use serde::{Deserialize, Serialize};
use snarkvm::prelude::Network;
use std::fmt;

/// An array type.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct ArrayType {
    pub element_type: Box<Type>,
    pub length: Box<Expression>,
}

impl ArrayType {
    /// Creates a new array type.
    pub fn new(element: Type, length: Expression) -> Self {
        Self { element_type: Box::new(element), length: Box::new(length) }
    }

    /// Creates a new bit array type.
    pub fn bit_array(length: u32) -> Self {
        Self {
            element_type: Box::new(Type::Boolean),
            length: Box::new(Expression::Literal(Literal {
                variant: LiteralVariant::Integer(IntegerType::U32, length.to_string()),
                id: Default::default(),
                span: Span::default(),
            })),
        }
    }

    /// Returns the element type of the array.
    pub fn element_type(&self) -> &Type {
        &self.element_type
    }

    /// Returns the base element type of the array.
    pub fn base_element_type(&self) -> &Type {
        match self.element_type.as_ref() {
            Type::Array(array_type) => array_type.base_element_type(),
            type_ => type_,
        }
    }

    pub fn from_snarkvm<N: Network>(array_type: &ConsoleArrayType<N>, program_id: ProgramId) -> Self {
        Self {
            element_type: Box::new(Type::from_snarkvm(array_type.next_element_type(), program_id)),
            length: Box::new(Expression::Literal(Literal {
                variant: LiteralVariant::Integer(IntegerType::U32, array_type.length().to_string().replace("u32", "")),
                id: Default::default(),
                span: Span::default(),
            })),
        }
    }

    pub fn to_snarkvm<N: Network>(&self) -> anyhow::Result<ConsoleArrayType<N>> {
        let length = if let Expression::Literal(literal) = &*self.length {
            match &literal.variant {
                LiteralVariant::Integer(_, s) => {
                    s.parse::<u32>().map_err(|e| anyhow::anyhow!("Array length is not a valid u32: {e}"))?
                }
                LiteralVariant::Unsuffixed(s) => {
                    s.parse::<u32>().map_err(|e| anyhow::anyhow!("Array length is not a valid u32: {e}"))?
                }
                _ => anyhow::bail!("Array length must be an integer literal"),
            }
        } else {
            anyhow::bail!("Array length must be an integer literal")
        };

        ConsoleArrayType::new(self.element_type.to_snarkvm()?, vec![snarkvm::console::types::U32::new(length)])
    }
}

impl fmt::Display for ArrayType {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        // For display purposes (in error messages for example.), do not include the type suffix.
        if let Expression::Literal(literal) = &*self.length
            && let LiteralVariant::Integer(_, s) = &literal.variant
        {
            return write!(f, "[{}; {s}]", self.element_type);
        }

        write!(f, "[{}; {}]", self.element_type, self.length)
    }
}

impl From<ArrayType> for Type {
    fn from(value: ArrayType) -> Self {
        Type::Array(value)
    }
}