leo-ast 4.1.0

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

// 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 std::fmt::Display;

use leo_errors::Formatted;
use leo_span::Span;

use super::Value;
use crate::{BinaryOperation, UnaryOperation};

const CODE_PREFIX: &str = "CEV";
const CODE_MASK: i32 = 8000;

pub(crate) fn binary_op_failure(
    lhs: &Value,
    op: BinaryOperation,
    rhs: &Value,
    reason: impl Display,
    span: Span,
) -> Formatted {
    Formatted::error(
        CODE_PREFIX,
        CODE_MASK,
        format!("binary operation `{lhs} {op} {rhs}` failed at compile time: {reason}"),
        span,
    )
    .with_help(
        "The operands are constant, so this operation was evaluated at compile time and would also fail at runtime. \
         Adjust the operands to avoid the failure (e.g. division by zero or integer overflow).",
    )
}

pub(crate) fn unary_op_failure(value: &Value, op: UnaryOperation, reason: impl Display, span: Span) -> Formatted {
    Formatted::error(
        CODE_PREFIX,
        CODE_MASK + 1,
        format!("unary operation `{value}.{op}()` failed at compile time: {reason}"),
        span,
    )
    .with_help(
        "The operand is constant, so this operation was evaluated at compile time and would also fail at runtime. \
         Adjust the operand to avoid the failure (e.g. negating the minimum signed integer).",
    )
}

pub(crate) fn intrinsic_failure(reason: impl Display, span: Span) -> Formatted {
    Formatted::error(
        CODE_PREFIX,
        CODE_MASK + 2,
        format!("compile-time evaluation of this intrinsic failed: {reason}"),
        span,
    )
    .with_note("Reaching this error indicates an internal inconsistency: the type checker should have rejected this call. Please file an issue.")
}