mirascript-core 0.1.105

Compiler and bytecode definitions for the MiraScript 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use strum::{Display, FromRepr, VariantArray};

/// MiraScript OpCodes
#[cfg_attr(feature = "wasm-constants", wasm_bindgen::prelude::wasm_bindgen)]
#[repr(u8)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, VariantArray, Display, FromRepr)]
pub enum OpCode {
    // debugging
    /// No operation
    Noop = 0x00,

    // operators
    /// ADD %ret %1 %2\
    /// %ret = %1 + %2
    Add,
    /// SUB %ret %1 %2\
    /// %ret = %1 - %2
    Sub,
    /// MUL %ret %1 %2\
    /// %ret = %1 * %2
    Mul,
    /// DIV %ret %1 %2\
    /// %ret = %1 / %2
    Div,
    /// MOD %ret %1 %2\
    /// %ret = %1 % %2
    Mod,
    /// EXP %ret %1 %2\
    /// %ret = %1 ^ %2
    Pow,
    /// POS %ret %1\
    /// %ret = +%1
    Pos,
    /// NEG %ret %1\
    /// %ret = -%1
    Neg,
    /// NOT %ret %1\
    /// %ret = !%1
    Not,
    /// PLUS %ret %1\
    /// %ret = +%1
    Plus,
    /// EQ %ret %1 %2\
    /// %ret = %1 == %2
    Eq,
    /// NEQ %ret %1 %2\
    /// %ret = %1 != %2
    Neq,
    /// LT %ret %1 %2\
    /// %ret = %1 < %2
    Lt,
    /// LTE %ret %1 %2\
    /// %ret = %1 <= %2
    Lte,
    /// GT %ret %1 %2\
    /// %ret = %1 > %2
    Gt,
    /// GTE %ret %1 %2\
    /// %ret = %1 >= %2
    Gte,
    /// AEQ %ret %1 %2\
    /// %ret = %1 =~ %2
    Aeq,
    /// NAEQ %ret %1 %2\
    /// %ret = %1 !~ %2
    Naeq,
    /// SAME %ret %1 %2\
    /// %ret = %1 === %2 // Same value zero
    Same,
    /// Nsame %ret %1 %2\
    /// %ret = %1 !== %2
    Nsame,
    /// IN %ret %1 %2\
    /// %ret = %1 in %2
    In,
    /// IN_GLOBAL %ret %1 %2\
    /// %ret = %1 in global
    InGlobal,
    /// CONCAT %ret `n` %1 %2 ... %n\
    /// %ret = %1 .. %2 .. ... .. %n
    Concat,
    /// FORMAT %ret %1 `index`\
    /// %ret = format(%1, CONSTANTS\[index])
    Format,
    /// AND %ret %1 %2\
    /// %ret = %1 && %2
    And,
    /// OR %ret %1 %2\
    /// %ret = %1 || %2
    Or,
    /// ASSERT_INIT %v\
    /// assert(%v != uninitialized)
    AssertInit,
    /// ASSERT_NON_NIL %v\
    /// assert(%v != nil)
    AssertNonNil,
    /// TYPE %ret %1\
    /// %ret = type(%1)
    Type,
    /// TO_BOOLEAN %ret %1\
    /// %ret = boolean(%1)
    ToBoolean,
    /// TO_NUMBER %ret %1\
    /// %ret = number(%1)
    ToNumber,
    /// TO_STRING %ret %1\
    /// %ret = string(%1)
    ToString,
    // Hint: use Eq/Same %ret %1 %0 for is nil
    /// IS_BOOLEAN %ret %1\
    /// %ret = type(%1) == "boolean"
    IsBoolean,
    /// IS_NUMBER %ret %1\
    /// %ret = type(%1) == "number"
    IsNumber,
    /// IS_STRING %ret %1\
    /// %ret = type(%1) == "string"
    IsString,
    /// IS_RECORD %ret %1\
    /// %ret = type(%1) == "record"
    IsRecord,
    /// IS_ARRAY %ret %1\
    /// %ret = type(%1) == "array"
    IsArray,

    // variable management
    /// CONSTANT %reg `index`\
    /// %reg = CONSTANTS\[index]
    Constant,
    /// UNINIT %reg
    /// %reg = uninitialized
    Uninit,
    /// ASSIGN %ret %1\
    /// %ret = %1
    Assign,
    /// SWAP %1 %2\
    /// (%1, %2) = (%2, %1)
    Swap,
    /// GET_UPVALUE %ret `level` %%up\
    /// %ret = UPVALUES\[level]\[%%up]
    GetUpvalue,
    /// SET_UPVALUE %value `level` %%up \
    /// UPVALUES\[level]\[%%up] = %value
    SetUpvalue,
    /// GET_GLOBAL %ret `name` \
    /// %ret = GLOBALS\[CONSTANTS\[name]]
    GetGlobal,
    /// GET_GLOBAL_DYN %ret %name \
    /// %ret = GLOBALS\[%name]
    GetGlobalDyn,

    // objects
    /// RECORD %ret\
    /// %ret = (
    Record,
    /// MODULE %ret `name`\
    /// %ret = mod CONSTANTS\[name] {
    Module,
    /// FIELD `name` %field\
    /// \[CONSTANTS\[name]]: %field,
    Field,
    /// FIELD_DYN %name %field\
    /// \[%name]: %field,
    FieldDyn,
    /// FIELD_INDEX `index` %field\
    /// \[index]: %field,
    FieldIndex,
    /// FIELD_OPT `name` %field\
    /// \[CONSTANTS\[name]]?: %field,
    FieldOpt,
    /// FIELD_OPT_DYN %name %field\
    /// \[%name]?: %field,
    FieldOptDyn,
    /// FIELD_OPT_INDEX `index` %field\
    /// \[index]?: %field,
    FieldOptIndex,
    /// PICK %ret %var `n` `key_1` `key_2` ... `key_n`\
    /// %ret = %var pick keys CONSTANTS\[key_1], CONSTANTS\[key_2], ..., CONSTANTS\[key_n]
    Pick,
    /// OMIT %ret %var `n` `key_1` `key_2` ... `key_n`\
    /// %ret = %var omit keys CONSTANTS\[key_1], CONSTANTS\[key_2], ..., CONSTANTS\[key_n]
    Omit,
    /// ARRAY %ret\
    /// %ret = \[
    Array,
    /// ITEM %item\
    /// %item,
    Item,
    /// ITEM_RANGE `start` `end`\
    /// `start`..`end`,
    ItemRange,
    /// ITEM_RANGE_DYN %start %end\
    /// %start..%end,
    ItemRangeDyn,
    /// ITEM_RANGE_EXCLUSIVE_DYN %start %end\
    /// %start..<%end,
    ItemRangeExclusiveDyn,
    /// SPREAD %var\
    /// ..%var,
    Spread,
    /// FREEZE\
    /// ) for record or ] for array
    Freeze,
    /// HAS %ret %var `key`\
    /// %ret = initialized(%var\[CONSTANTS\[key]])
    Has,
    /// HAS_DYN %ret %var %key\
    /// %ret = initialized(%var\[%key])
    HasDyn,
    /// HAS_INDEX %ret %var `index`\
    /// %ret = initialized(%var\[index])
    HasIndex,
    /// GET %ret %var `key`\
    /// %ret = %var\[CONSTANTS\[key]] ?? nil
    Get,
    /// GET_DYN %ret %var %key\
    /// %ret = %var\[%key] ?? nil
    GetDyn,
    /// GET_INDEX %ret %var `index`\
    /// %ret = %var\[index] ?? nil
    GetIndex,
    /// SET %value %var `key`\
    /// %var\[CONSTANTS\[key]] = %value
    Set,
    /// SET_DYN %value %var %key\
    /// %var\[%key] = %value
    SetDyn,
    /// SET_INDEX %value %var `index`\
    /// %var\[index] = %value
    SetIndex,
    /// SLICE %ret %var `start` `end`\
    /// %ret = %var\[start..end]
    Slice,
    /// SLICE_START %ret %var `end`\
    /// %ret = %var\[..end]
    SliceStart,
    /// SLICE_END %ret %var `start`\
    /// %ret = %var\[start..]
    SliceEnd,
    /// SLICE_DYN %ret %var %start %end\
    /// %ret = %var\[%start..%end]
    SliceDyn,
    /// SLICE_EXCLUSIVE_DYN %ret %var %start %end\
    /// %ret = %var\[%start..<%end]
    SliceExclusiveDyn,
    /// LENGTH %ret %var\
    /// %ret = $Length(%var)
    Length,

    // control flow
    /// LOOP `regn`\
    /// loop { let %1, .. ,%regn;
    Loop,
    /// LOOP_FOR `regn` %iterable\
    /// for %1 in %iterable { let %2, .. ,%regn;
    LoopFor,
    /// LOOP_RANGE `regn` %start %end\
    /// for %1 in %start..%end { let %2, .. ,%regn;
    LoopRange,
    /// LOOP_RANGE_EXCLUSIVE `regn` %start %end\
    /// for %1 in %start..<%end { let %2, .. ,%regn;
    LoopRangeExclusive,
    /// LOOP_END\
    /// }
    LoopEnd,
    /// BREAK\
    /// break;
    Break,
    /// CONTINUE\
    /// continue;
    Continue,
    /// IF %cond\
    /// if (%cond) {
    If,
    /// IF_NOT %cond\
    /// if (!%cond) {
    IfNot,
    /// IF_INIT %var\
    /// if (initialized(%var)) {
    IfInit,
    /// IF_NOT_INIT %var\
    /// if (!initialized(%var)) {
    IfNotInit,
    /// IF_NIL %var\
    /// if (%var == nil) {
    IfNil,
    /// IF_NOT_NIL %var\
    /// if (%var != nil) {
    IfNotNil,
    /// ELSE\
    /// } else {
    Else,
    /// IF_END\
    /// }
    IfEnd,
    /// FUNC %f `argn` `regn`\
    /// %f = (%1, %2, ... , %argn) => { let %argn+1, ... , %regn;
    Func,
    /// FUNC_VARG %f `argn` `regn`\
    /// %f = (%1, %2, ... , %argn-1, ...%argn) => { let %argn+1, ... , %regn;
    FuncVarg,
    /// FUNC_END\
    /// }
    FuncEnd,
    /// RETURN %value\
    /// return %value;
    Return,
    /// CALL %ret `f` `argn` %1 %2 ... %argn `spread_n` `spread_arg_a` ...\
    /// %ret = GLOBAL\[CONSTANTS\[f]](%1, %2, ... , %argn);
    ///
    /// If spread_arg_a is present, arg at that index will be spread
    Call,
    /// CALL_DYN %ret %f `argn` %1 %2 ... %argn `spread_n` `spread_arg_a` ...\
    /// %ret = %f(%1, %2, ... , %argn);
    ///
    /// If spread_arg_a is present, arg at that index will be spread
    CallDyn,
}

impl From<OpCode> for u8 {
    fn from(op: OpCode) -> u8 {
        op as u8
    }
}

impl TryFrom<u8> for OpCode {
    type Error = ();

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        OpCode::from_repr(value).ok_or(())
    }
}

impl OpCode {
    pub const WIDE_MASK: u8 = 0x80;
    pub const PARAM_MAX: u32 = u8::MAX as u32;
    pub const PARAM_WIDE_MAX: u32 = u32::MAX;

    pub fn code(&self) -> u8 {
        *self as u8
    }
    pub fn wide_code(&self) -> u8 {
        *self as u8 | Self::WIDE_MASK
    }
}

pub trait OpParamTrait {
    fn value(&self) -> u32;
    fn is_wide(&self) -> bool;
    fn code(&self) -> u8 {
        debug_assert!(!self.is_wide());
        self.value() as u8
    }
    fn wide_code(&self) -> [u8; 4] {
        (self.value()).to_le_bytes()
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Register(u32);

impl Register {
    pub fn new(index: usize) -> Self {
        debug_assert!(index != 0);
        Self(index as u32)
    }

    /// Write to this register will be ignored
    /// Reading from this register will always return `nil`
    pub const EMPTY: Self = Self(0);

    pub fn is_empty(&self) -> bool {
        self.0 == 0
    }
}

impl OpParamTrait for Register {
    fn value(&self) -> u32 {
        self.0
    }
    fn is_wide(&self) -> bool {
        self.value() > u8::MAX as u32
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct OpParam(i32);

impl OpParam {
    pub fn new(value: i32) -> Self {
        value.into()
    }
}

impl OpParamTrait for OpParam {
    fn value(&self) -> u32 {
        self.0 as u32
    }

    fn is_wide(&self) -> bool {
        self.0 < i8::MIN as i32 || self.0 > i8::MAX as i32
    }
}

impl From<usize> for OpParam {
    fn from(param: usize) -> Self {
        Self(param as i32)
    }
}

impl From<i32> for OpParam {
    fn from(param: i32) -> Self {
        Self(param)
    }
}