monkey-compiler 2.0.2

a compiler for monkeylang
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
#[cfg(test)]
mod tests {
    use crate::compiler_test::{run_compiler_test, CompilerTestCase};
    use crate::op_code::Opcode::*;
    use crate::op_code::{concat_instructions, make_instructions};
    use object::Object;
    use std::rc::Rc;

    #[test]
    fn test_functions() {
        let tests = vec![
            CompilerTestCase {
                input: "fn() { return 5 + 10; }",
                expected_constants: vec![
                    Object::Integer(5),
                    Object::Integer(10),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpConst, &[1]),
                            make_instructions(OpAdd, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[2, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "fn() { 5 + 10; }",
                expected_constants: vec![
                    Object::Integer(5),
                    Object::Integer(10),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpConst, &[1]),
                            make_instructions(OpAdd, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[2, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "fn() { 1; 2}",
                expected_constants: vec![
                    Object::Integer(1),
                    Object::Integer(2),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpPop, &[0]),
                            make_instructions(OpConst, &[1]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[2, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
        ];
        run_compiler_test(tests);
    }

    #[test]
    fn test_function_without_return_value() {
        let tests = vec![CompilerTestCase {
            input: "fn() { }",
            expected_constants: vec![Object::CompiledFunction(Rc::from(
                object::CompiledFunction {
                    name: String::new(),
                    instructions: concat_instructions(&vec![make_instructions(OpReturn, &[0])])
                        .data,
                    num_locals: 0,
                    num_parameters: 0,
                },
            ))],
            expected_instructions: vec![
                make_instructions(OpClosure, &[0, 0]),
                make_instructions(OpPop, &[0]),
            ],
        }];
        run_compiler_test(tests);
    }

    #[test]
    fn trailing_debugger_keeps_the_functions_implicit_return() {
        let tests = vec![
            // The trailing debugger runs after the return value is decided, so
            // the value stays on the stack across it.
            CompilerTestCase {
                input: "fn() { 1; debugger; }",
                expected_constants: vec![
                    Object::Integer(1),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpDebugger, &[]),
                            make_instructions(OpReturnValue, &[]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[1, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "fn() { let x = 1; debugger; }",
                expected_constants: vec![
                    Object::Integer(1),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpSetLocal, &[0]),
                            make_instructions(OpDebugger, &[]),
                            make_instructions(OpReturn, &[]),
                        ])
                        .data,
                        num_locals: 1,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[1, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "fn() { debugger; }",
                expected_constants: vec![Object::CompiledFunction(Rc::from(
                    object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpDebugger, &[]),
                            make_instructions(OpReturn, &[]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    },
                ))],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[0, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            // After an explicit return the debugger is dead code; the body still
            // ends with a fallback OpReturn.
            CompilerTestCase {
                input: "fn() { return 1; debugger; }",
                expected_constants: vec![
                    Object::Integer(1),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpReturnValue, &[]),
                            make_instructions(OpDebugger, &[]),
                            make_instructions(OpReturn, &[]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[1, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
        ];
        run_compiler_test(tests);
    }

    #[test]
    fn test_function_calls() {
        let tests = vec![
            CompilerTestCase {
                input: "fn() { 24 }();",
                expected_constants: vec![
                    Object::Integer(24),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[1, 0]),
                    make_instructions(OpCall, &[0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "let noArg = fn() { 24; }; noArg();",
                expected_constants: vec![
                    Object::Integer(24),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: "noArg".to_string(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[1, 0]),
                    make_instructions(OpSetGlobal, &[0]),
                    make_instructions(OpGetGlobal, &[0]),
                    make_instructions(OpCall, &[0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "let oneArg = fn(a) { a; }; oneArg(24);",
                expected_constants: vec![
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: "oneArg".to_string(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpGetLocal, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 1,
                        num_parameters: 1,
                    })),
                    Object::Integer(24),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[0, 0]),
                    make_instructions(OpSetGlobal, &[0]),
                    make_instructions(OpGetGlobal, &[0]),
                    make_instructions(OpConst, &[1]),
                    make_instructions(OpCall, &[1]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "let manyArg = fn(a, b, c) { a; b; c; }; manyArg(24, 25, 26);",
                expected_constants: vec![
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: "manyArg".to_string(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpGetLocal, &[0]),
                            make_instructions(OpPop, &[0]),
                            make_instructions(OpGetLocal, &[1]),
                            make_instructions(OpPop, &[0]),
                            make_instructions(OpGetLocal, &[2]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 3,
                        num_parameters: 3,
                    })),
                    Object::Integer(24),
                    Object::Integer(25),
                    Object::Integer(26),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[0, 0]),
                    make_instructions(OpSetGlobal, &[0]),
                    make_instructions(OpGetGlobal, &[0]),
                    make_instructions(OpConst, &[1]),
                    make_instructions(OpConst, &[2]),
                    make_instructions(OpConst, &[3]),
                    make_instructions(OpCall, &[3]),
                    make_instructions(OpPop, &[0]),
                ],
            },
        ];

        run_compiler_test(tests);
    }

    #[test]
    fn test_let_statement_scope() {
        let tests = vec![
            CompilerTestCase {
                input: "let num = 55; fn() { num; }",
                expected_constants: vec![
                    Object::Integer(55),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpGetGlobal, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpConst, &[0]),
                    make_instructions(OpSetGlobal, &[0]),
                    make_instructions(OpClosure, &[1, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "fn() { let num = 55; num; }",
                expected_constants: vec![
                    Object::Integer(55),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpSetLocal, &[0]),
                            make_instructions(OpGetLocal, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 1,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[1, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "fn() { let a = 55; let b = 77; a + b; }",
                expected_constants: vec![
                    Object::Integer(55),
                    Object::Integer(77),
                    Object::CompiledFunction(Rc::from(object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpConst, &[0]),
                            make_instructions(OpSetLocal, &[0]),
                            make_instructions(OpConst, &[1]),
                            make_instructions(OpSetLocal, &[1]),
                            make_instructions(OpGetLocal, &[0]),
                            make_instructions(OpGetLocal, &[1]),
                            make_instructions(OpAdd, &[0]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 2,
                        num_parameters: 0,
                    })),
                ],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[2, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
        ];
        run_compiler_test(tests);
    }

    #[test]
    fn test_builtins() {
        let tests = vec![
            CompilerTestCase {
                input: "len([]); push([], 1);",
                expected_constants: vec![Object::Integer(1)],
                expected_instructions: vec![
                    make_instructions(OpGetBuiltin, &[0]),
                    make_instructions(OpArray, &[0]),
                    make_instructions(OpCall, &[1]),
                    make_instructions(OpPop, &[0]),
                    make_instructions(OpGetBuiltin, &[5]),
                    make_instructions(OpArray, &[0]),
                    make_instructions(OpConst, &[0]),
                    make_instructions(OpCall, &[2]),
                    make_instructions(OpPop, &[0]),
                ],
            },
            CompilerTestCase {
                input: "fn() { len([]) }",
                expected_constants: vec![Object::CompiledFunction(Rc::from(
                    object::CompiledFunction {
                        name: String::new(),
                        instructions: concat_instructions(&vec![
                            make_instructions(OpGetBuiltin, &[0]),
                            make_instructions(OpArray, &[0]),
                            make_instructions(OpCall, &[1]),
                            make_instructions(OpReturnValue, &[0]),
                        ])
                        .data,
                        num_locals: 0,
                        num_parameters: 0,
                    },
                ))],
                expected_instructions: vec![
                    make_instructions(OpClosure, &[0, 0]),
                    make_instructions(OpPop, &[0]),
                ],
            },
        ];
        run_compiler_test(tests);
    }
}