lucia_lang/compiler/
opcode.rs

1//! The OpCodes for LVM.
2
3use std::fmt;
4
5use gc_arena::Collect;
6
7/// The jump target.
8#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
9pub struct JumpTarget(pub usize);
10
11/// The operation code.
12#[derive(Debug, Clone, Copy, Collect, PartialEq, Eq, PartialOrd, Ord, Hash)]
13#[collect(require_static)]
14pub enum OpCode {
15    /// Removes the top-of-stack (TOS) item.
16    Pop,
17    /// Push the i-th item to the top of the stack.
18    Copy(usize),
19    /// Swap TOS with the item at position i.
20    Swap(usize),
21    /// Pushes the value associated with `local_names[namei]` onto the stack.
22    LoadLocal(usize),
23    /// Pushes the value associated with `global_names[namei]` onto the stack.
24    LoadGlobal(usize),
25    /// Pushes the value associated with `upvalue_names[namei]` onto the stack.
26    LoadUpvalue(usize),
27    /// Pushes `consts[consti]` onto the stack.
28    LoadConst(usize),
29    /// Stores TOS into the `local_names[namei]`.
30    StoreLocal(usize),
31    /// Stores TOS into the `global_names[namei]`.
32    StoreGlobal(usize),
33    /// Stores TOS into the `upvalue_names[namei]`.
34    StoreUpvalue(usize),
35
36    /// Imports the module `consts[consti]` and pushed it onto the stack.
37    Import(usize),
38    /// Loads the attribute `consts[consti]` the module found in TOS and pushed it onto the stack.
39    ImportFrom(usize),
40    /// Loads all symbols from the module TOS to the global namespace.
41    ImportGlob,
42
43    /// Pushes a new table onto the stack. Pops `2 * count` items to build table.
44    BuildTable(usize),
45    /// Pushes a new list onto the stack. Pops `count` items to build list.
46    BuildList(usize),
47    /// Implements `TOS = TOS1::TOS`.
48    GetAttr,
49    /// Implements `TOS = TOS1[TOS]`.
50    GetItem,
51    /// Implements `TOS = TOS[#]`.
52    GetMeta,
53    /// Implements `TOS1::TOS = TOS2`.
54    SetAttr,
55    /// Implements `TOS1[TOS] = TOS2`.
56    SetItem,
57    /// Implements `TOS[#] = TOS1`.
58    SetMeta,
59
60    /// Implements `TOS = -TOS`.
61    Neg,
62    /// Implements `TOS = not TOS`.
63    Not,
64
65    /// Implements `TOS = TOS1 + TOS`.
66    Add,
67    /// Implements `TOS = TOS1 - TOS`.
68    Sub,
69    /// Implements `TOS = TOS1 * TOS`.
70    Mul,
71    /// Implements `TOS = TOS1 / TOS`.
72    Div,
73    /// Implements `TOS = TOS1 % TOS`.
74    Mod,
75
76    /// Implements `TOS = TOS1 == TOS`.
77    Eq,
78    /// Implements `TOS = TOS1 != TOS`.
79    Ne,
80    /// Implements `TOS = TOS1 > TOS`.
81    Gt,
82    /// Implements `TOS = TOS1 >= TOS`.
83    Ge,
84    /// Implements `TOS = TOS1 < TOS`.
85    Lt,
86    /// Implements `TOS = TOS1 <= TOS`.
87    Le,
88    /// Implements `TOS = TOS1 is TOS`.
89    Is,
90
91    /// Get the __iter__ of TOS and pushed it onto the stack.
92    Iter,
93    /// Sets the bytecode counter to target.
94    Jump(JumpTarget),
95    /// If TOS is null, sets the bytecode counter to target.
96    JumpIfNull(JumpTarget),
97    /// If TOS is false, sets the bytecode counter to target. TOS is popped.
98    JumpPopIfFalse(JumpTarget),
99    /// If TOS is true, sets the bytecode counter to target and leaves TOS on the stack. Otherwise, TOS is popped.
100    JumpIfTrueOrPop(JumpTarget),
101    /// If TOS is false, sets the bytecode counter to target and leaves TOS on the stack. Otherwise, TOS is popped.
102    JumpIfFalseOrPop(JumpTarget),
103
104    /// Pops numbers of item for function arguments, then pop an callable value and call it.
105    Call(usize),
106    /// Call with a shortcut for propagating errors.
107    TryCall(usize),
108    /// Returns with TOS to the caller of the function.
109    Return,
110    /// Returns with TOS as a error.
111    Throw,
112    /// Same as "Call(usize); Return;", this is for tail call optimization.
113    ReturnCall(usize),
114
115    /// A jump target, only used during code generation.
116    JumpTarget(JumpTarget),
117}
118
119impl fmt::Display for OpCode {
120    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
121        let width = 20;
122        match self {
123            Self::Pop => write!(f, "Pop"),
124            Self::Copy(i) => write!(f, "{:width$}{}", "Copy", i),
125            Self::Swap(i) => write!(f, "{:width$}{}", "Swap", i),
126            Self::LoadLocal(i) => write!(f, "{:width$}{}", "LoadLocal", i),
127            Self::LoadGlobal(i) => write!(f, "{:width$}{}", "LoadGlobal", i),
128            Self::LoadUpvalue(i) => write!(f, "{:width$}{}", "LoadUpvalue", i),
129            Self::LoadConst(i) => write!(f, "{:width$}{}", "LoadConst", i),
130            Self::StoreLocal(i) => write!(f, "{:width$}{}", "StoreLocal", i),
131            Self::StoreGlobal(i) => write!(f, "{:width$}{}", "StoreGlobal", i),
132            Self::StoreUpvalue(i) => write!(f, "{:width$}{}", "StoreUpvalue", i),
133            Self::Import(i) => write!(f, "{:width$}{}", "Import", i),
134            Self::ImportFrom(i) => write!(f, "{:width$}{}", "ImportFrom", i),
135            Self::ImportGlob => write!(f, "ImportGlob"),
136            Self::BuildTable(i) => write!(f, "{:width$}{}", "BuildTable", i),
137            Self::BuildList(i) => write!(f, "{:width$}{}", "BuildList", i),
138            Self::GetAttr => write!(f, "GetAttr"),
139            Self::GetItem => write!(f, "GetItem"),
140            Self::GetMeta => write!(f, "GetMeta"),
141            Self::SetAttr => write!(f, "SetAttr"),
142            Self::SetItem => write!(f, "SetItem"),
143            Self::SetMeta => write!(f, "SetMeta"),
144            Self::Neg => write!(f, "Neg"),
145            Self::Not => write!(f, "Not"),
146            Self::Add => write!(f, "Add"),
147            Self::Sub => write!(f, "Sub"),
148            Self::Mul => write!(f, "Mul"),
149            Self::Div => write!(f, "Div"),
150            Self::Mod => write!(f, "Mod"),
151            Self::Eq => write!(f, "Eq"),
152            Self::Ne => write!(f, "Ne"),
153            Self::Gt => write!(f, "Gt"),
154            Self::Ge => write!(f, "Ge"),
155            Self::Lt => write!(f, "Lt"),
156            Self::Le => write!(f, "Le"),
157            Self::Is => write!(f, "Is"),
158            Self::Iter => write!(f, "Iter"),
159            Self::Jump(JumpTarget(i)) => write!(f, "{:width$}{}", "Jump", i),
160            Self::JumpIfNull(JumpTarget(i)) => write!(f, "{:width$}{}", "JumpIfNull", i),
161            Self::JumpPopIfFalse(JumpTarget(i)) => write!(f, "{:width$}{}", "JumpPopIfFalse", i),
162            Self::JumpIfTrueOrPop(JumpTarget(i)) => write!(f, "{:width$}{}", "JumpIfTrueOrPop", i),
163            Self::JumpIfFalseOrPop(JumpTarget(i)) => {
164                write!(f, "{:width$}{}", "JumpIfFalseOrPop", i)
165            }
166            Self::Call(i) => write!(f, "{:width$}{}", "Call", i),
167            Self::TryCall(i) => write!(f, "{:width$}{}", "TryCall", i),
168            Self::Return => write!(f, "Return"),
169            Self::Throw => write!(f, "Throw"),
170            Self::ReturnCall(i) => write!(f, "{:width$}{}", "ReturnCall", i),
171            Self::JumpTarget(JumpTarget(i)) => write!(f, "{:width$}{}", "JumpTarget", i),
172        }
173    }
174}
lucia_lang/compiler/opcode.rs

lucia_lang/compiler/
opcode.rs
