cairo-lang-casm 2.0.0

Cairo assembly encoding.
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
122
123
124
125
126
127
128
129
130
131
132
133

use std::fmt::Display;

use cairo_lang_utils::casts::IntoOrPanic;
use thiserror::Error;

use crate::operand::{BinOpOperand, CellRef, DerefOrImmediate, Register, ResOperand};

#[cfg(test)]
#[path = "ap_change_test.rs"]
mod test;

#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)]
pub enum ApChange {
    Known(usize),
    Unknown,
}
impl Display for ApChange {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ApChange::Known(change) => write!(f, "ApChange::Known({change})"),
            ApChange::Unknown => write!(f, "ApChange::Unknown"),
        }
    }
}

#[derive(Debug, Error, Eq, PartialEq)]
pub enum ApChangeError {
    #[error("Unknown ap change")]
    UnknownApChange,
    #[error("Offset overflow")]
    OffsetOverflow,
}

/// Trait for applying ap changes.
pub trait ApplyApChange: Sized {
    /// Attempts to apply ap change, fail on overflow only.
    fn apply_known_ap_change(self, ap_change: usize) -> Option<Self>;
    /// Can unknown ap change be applied.
    fn can_apply_unknown(&self) -> bool;

    /// Attempts to apply ap change.
    fn apply_ap_change(self, ap_change: ApChange) -> Result<Self, ApChangeError> {
        match ap_change {
            ApChange::Unknown if self.can_apply_unknown() => Ok(self),
            ApChange::Unknown => Err(ApChangeError::UnknownApChange),
            ApChange::Known(ap_change) => {
                self.apply_known_ap_change(ap_change).ok_or(ApChangeError::OffsetOverflow)
            }
        }
    }

    /// Same as [Self::apply_known_ap_change] but unchecked.
    fn unchecked_apply_known_ap_change(self, ap_change: usize) -> Self {
        self.apply_known_ap_change(ap_change).unwrap()
    }
}

impl ApplyApChange for ResOperand {
    fn apply_known_ap_change(self, ap_change: usize) -> Option<Self> {
        Some(match self {
            ResOperand::Deref(operand) => {
                ResOperand::Deref(operand.apply_known_ap_change(ap_change)?)
            }
            ResOperand::DoubleDeref(operand, offset) => {
                ResOperand::DoubleDeref(operand.apply_known_ap_change(ap_change)?, offset)
            }
            ResOperand::Immediate(value) => ResOperand::Immediate(value),
            ResOperand::BinOp(operand) => {
                ResOperand::BinOp(operand.apply_known_ap_change(ap_change)?)
            }
        })
    }

    fn can_apply_unknown(&self) -> bool {
        match self {
            ResOperand::Deref(operand) => operand.can_apply_unknown(),
            ResOperand::DoubleDeref(operand, ..) => operand.can_apply_unknown(),
            ResOperand::Immediate(_) => true,
            ResOperand::BinOp(operand) => operand.can_apply_unknown(),
        }
    }
}

impl ApplyApChange for CellRef {
    fn apply_known_ap_change(self, ap_change: usize) -> Option<Self> {
        Some(match &self.register {
            Register::AP => CellRef {
                register: Register::AP,
                offset: self.offset.checked_sub(ap_change.into_or_panic())?,
            },
            Register::FP => self,
        })
    }

    fn can_apply_unknown(&self) -> bool {
        match &self.register {
            Register::AP => false,
            Register::FP => true,
        }
    }
}

impl ApplyApChange for DerefOrImmediate {
    fn apply_known_ap_change(self, ap_change: usize) -> Option<Self> {
        Some(match self {
            DerefOrImmediate::Deref(operand) => {
                DerefOrImmediate::Deref(operand.apply_known_ap_change(ap_change)?)
            }
            DerefOrImmediate::Immediate(operand) => DerefOrImmediate::Immediate(operand),
        })
    }

    fn can_apply_unknown(&self) -> bool {
        match self {
            DerefOrImmediate::Deref(operand) => operand.can_apply_unknown(),
            DerefOrImmediate::Immediate(_) => true,
        }
    }
}

impl ApplyApChange for BinOpOperand {
    fn apply_known_ap_change(self, ap_change: usize) -> Option<Self> {
        Some(BinOpOperand {
            op: self.op,
            a: self.a.apply_known_ap_change(ap_change)?,
            b: self.b.apply_known_ap_change(ap_change)?,
        })
    }

    fn can_apply_unknown(&self) -> bool {
        self.a.can_apply_unknown() && self.b.can_apply_unknown()
    }
}