compile.c 139 KB
Newer Older
1
2
3
4
5
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
6
 * Copyright (c) 2013-2015 Damien P. George
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

xbe's avatar
xbe committed
27
#include <stdbool.h>
Damien's avatar
Damien committed
28
29
30
31
32
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>

33
34
35
36
#include "py/scope.h"
#include "py/emit.h"
#include "py/compile.h"
#include "py/runtime.h"
Damien's avatar
Damien committed
37

38
39
#if MICROPY_ENABLE_COMPILER

Damien's avatar
Damien committed
40
41
42
// TODO need to mangle __attr names

typedef enum {
43
#define DEF_RULE(rule, comp, kind, ...) PN_##rule,
44
#include "py/grammar.h"
Damien's avatar
Damien committed
45
46
#undef DEF_RULE
    PN_maximum_number_of,
47
    PN_string, // special node for non-interned string
48
    PN_bytes, // special node for non-interned bytes
49
    PN_const_object, // special node for a constant, generic Python object
Damien's avatar
Damien committed
50
51
} pn_kind_t;

52
#define NEED_METHOD_TABLE MICROPY_EMIT_NATIVE
53
54
55
56

#if NEED_METHOD_TABLE

// we need a method table to do the lookup for the emitter functions
57
58
#define EMIT(fun) (comp->emit_method_table->fun(comp->emit))
#define EMIT_ARG(fun, ...) (comp->emit_method_table->fun(comp->emit, __VA_ARGS__))
59
60
#define EMIT_LOAD_FAST(qst, local_num) (comp->emit_method_table->load_id.fast(comp->emit, qst, local_num))
#define EMIT_LOAD_GLOBAL(qst) (comp->emit_method_table->load_id.global(comp->emit, qst))
Damien's avatar
Damien committed
61

62
63
64
65
66
67
68
69
70
71
#else

// if we only have the bytecode emitter enabled then we can do a direct call to the functions
#define EMIT(fun) (mp_emit_bc_##fun(comp->emit))
#define EMIT_ARG(fun, ...) (mp_emit_bc_##fun(comp->emit, __VA_ARGS__))
#define EMIT_LOAD_FAST(qst, local_num) (mp_emit_bc_load_fast(comp->emit, qst, local_num))
#define EMIT_LOAD_GLOBAL(qst) (mp_emit_bc_load_global(comp->emit, qst))

#endif

72
73
74
#define EMIT_INLINE_ASM(fun) (comp->emit_inline_asm_method_table->fun(comp->emit_inline_asm))
#define EMIT_INLINE_ASM_ARG(fun, ...) (comp->emit_inline_asm_method_table->fun(comp->emit_inline_asm, __VA_ARGS__))

75
// elements in this struct are ordered to make it compact
Damien's avatar
Damien committed
76
typedef struct _compiler_t {
77
    qstr source_file;
78

79
80
81
    uint8_t is_repl;
    uint8_t pass; // holds enum type pass_kind_t
    uint8_t func_arg_is_super; // used to compile special case of super() function call
82
83
84
    uint8_t have_star;

    // try to keep compiler clean from nlr
85
    mp_obj_t compile_error; // set to an exception object if there's an error
86
    size_t compile_error_line; // set to best guess of line of error
Damien's avatar
Damien committed
87

88
    uint next_label;
89

90
91
92
    uint16_t num_dict_params;
    uint16_t num_default_params;

93
94
    uint16_t break_label; // highest bit set indicates we are breaking out of a for loop
    uint16_t continue_label;
95
    uint16_t cur_except_level; // increased for SETUP_EXCEPT, SETUP_FINALLY; decreased for POP_BLOCK, POP_EXCEPT
96
    uint16_t break_continue_except_level;
Damien's avatar
Damien committed
97
98
99
100

    scope_t *scope_head;
    scope_t *scope_cur;

101
    emit_t *emit;                                   // current emitter
102
    #if NEED_METHOD_TABLE
103
    const emit_method_table_t *emit_method_table;   // current emit method table
104
    #endif
105

106
    #if MICROPY_EMIT_INLINE_THUMB
107
108
    emit_inline_asm_t *emit_inline_asm;                                   // current emitter for inline asm
    const emit_inline_asm_method_table_t *emit_inline_asm_method_table;   // current emit method table for inline asm
109
    #endif
Damien's avatar
Damien committed
110
111
} compiler_t;

112
113
114
STATIC void compile_error_set_line(compiler_t *comp, mp_parse_node_t pn) {
    // if the line of the error is unknown then try to update it from the pn
    if (comp->compile_error_line == 0 && MP_PARSE_NODE_IS_STRUCT(pn)) {
115
        comp->compile_error_line = ((mp_parse_node_struct_t*)pn)->source_line;
116
    }
117
118
119
}

STATIC void compile_syntax_error(compiler_t *comp, mp_parse_node_t pn, const char *msg) {
120
121
122
123
124
    // only register the error if there has been no other error
    if (comp->compile_error == MP_OBJ_NULL) {
        comp->compile_error = mp_obj_new_exception_msg(&mp_type_SyntaxError, msg);
        compile_error_set_line(comp, pn);
    }
125
126
}

127
STATIC void compile_trailer_paren_helper(compiler_t *comp, mp_parse_node_t pn_arglist, bool is_method_call, int n_positional_extra);
128
STATIC void compile_comprehension(compiler_t *comp, mp_parse_node_struct_t *pns, scope_kind_t kind);
129
STATIC void compile_node(compiler_t *comp, mp_parse_node_t pn);
Damien's avatar
Damien committed
130

131
STATIC uint comp_next_label(compiler_t *comp) {
132
133
134
    return comp->next_label++;
}

135
136
137
138
139
140
141
142
143
144
145
146
STATIC void compile_increase_except_level(compiler_t *comp) {
    comp->cur_except_level += 1;
    if (comp->cur_except_level > comp->scope_cur->exc_stack_size) {
        comp->scope_cur->exc_stack_size = comp->cur_except_level;
    }
}

STATIC void compile_decrease_except_level(compiler_t *comp) {
    assert(comp->cur_except_level > 0);
    comp->cur_except_level -= 1;
}

147
STATIC scope_t *scope_new_and_link(compiler_t *comp, scope_kind_t kind, mp_parse_node_t pn, uint emit_options) {
148
    scope_t *scope = scope_new(kind, pn, comp->source_file, emit_options);
Damien's avatar
Damien committed
149
150
151
152
153
154
155
156
157
158
159
160
161
162
    scope->parent = comp->scope_cur;
    scope->next = NULL;
    if (comp->scope_head == NULL) {
        comp->scope_head = scope;
    } else {
        scope_t *s = comp->scope_head;
        while (s->next != NULL) {
            s = s->next;
        }
        s->next = scope;
    }
    return scope;
}

163
164
165
typedef void (*apply_list_fun_t)(compiler_t *comp, mp_parse_node_t pn);

STATIC void apply_to_single_or_list(compiler_t *comp, mp_parse_node_t pn, pn_kind_t pn_list_kind, apply_list_fun_t f) {
166
    if (MP_PARSE_NODE_IS_STRUCT_KIND(pn, pn_list_kind)) {
167
168
        mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
        int num_nodes = MP_PARSE_NODE_STRUCT_NUM_NODES(pns);
Damien's avatar
Damien committed
169
170
171
        for (int i = 0; i < num_nodes; i++) {
            f(comp, pns->nodes[i]);
        }
172
    } else if (!MP_PARSE_NODE_IS_NULL(pn)) {
Damien's avatar
Damien committed
173
174
175
176
        f(comp, pn);
    }
}

177
STATIC void compile_generic_all_nodes(compiler_t *comp, mp_parse_node_struct_t *pns) {
178
    int num_nodes = MP_PARSE_NODE_STRUCT_NUM_NODES(pns);
Damien's avatar
Damien committed
179
180
    for (int i = 0; i < num_nodes; i++) {
        compile_node(comp, pns->nodes[i]);
181
182
183
184
185
        if (comp->compile_error != MP_OBJ_NULL) {
            // add line info for the error in case it didn't have a line number
            compile_error_set_line(comp, pns->nodes[i]);
            return;
        }
Damien's avatar
Damien committed
186
187
188
    }
}

189
190
191
192
STATIC void compile_load_id(compiler_t *comp, qstr qst) {
    if (comp->pass == MP_PASS_SCOPE) {
        mp_emit_common_get_id_for_load(comp->scope_cur, qst);
    } else {
193
        #if NEED_METHOD_TABLE
194
        mp_emit_common_id_op(comp->emit, &comp->emit_method_table->load_id, comp->scope_cur, qst);
195
196
197
        #else
        mp_emit_common_id_op(comp->emit, &mp_emit_bc_method_table_load_id_ops, comp->scope_cur, qst);
        #endif
198
199
200
201
202
203
204
    }
}

STATIC void compile_store_id(compiler_t *comp, qstr qst) {
    if (comp->pass == MP_PASS_SCOPE) {
        mp_emit_common_get_id_for_modification(comp->scope_cur, qst);
    } else {
205
        #if NEED_METHOD_TABLE
206
        mp_emit_common_id_op(comp->emit, &comp->emit_method_table->store_id, comp->scope_cur, qst);
207
208
209
        #else
        mp_emit_common_id_op(comp->emit, &mp_emit_bc_method_table_store_id_ops, comp->scope_cur, qst);
        #endif
210
211
212
213
214
215
216
    }
}

STATIC void compile_delete_id(compiler_t *comp, qstr qst) {
    if (comp->pass == MP_PASS_SCOPE) {
        mp_emit_common_get_id_for_modification(comp->scope_cur, qst);
    } else {
217
        #if NEED_METHOD_TABLE
218
        mp_emit_common_id_op(comp->emit, &comp->emit_method_table->delete_id, comp->scope_cur, qst);
219
220
221
        #else
        mp_emit_common_id_op(comp->emit, &mp_emit_bc_method_table_delete_id_ops, comp->scope_cur, qst);
        #endif
222
223
224
    }
}

225
STATIC void c_tuple(compiler_t *comp, mp_parse_node_t pn, mp_parse_node_struct_t *pns_list) {
226
    int total = 0;
227
    if (!MP_PARSE_NODE_IS_NULL(pn)) {
228
229
230
231
        compile_node(comp, pn);
        total += 1;
    }
    if (pns_list != NULL) {
232
        int n = MP_PARSE_NODE_STRUCT_NUM_NODES(pns_list);
233
234
235
236
237
        for (int i = 0; i < n; i++) {
            compile_node(comp, pns_list->nodes[i]);
        }
        total += n;
    }
238
    EMIT_ARG(build_tuple, total);
239
}
Damien's avatar
Damien committed
240

241
STATIC void compile_generic_tuple(compiler_t *comp, mp_parse_node_struct_t *pns) {
Damien's avatar
Damien committed
242
    // a simple tuple expression
243
    c_tuple(comp, MP_PARSE_NODE_NULL, pns);
Damien's avatar
Damien committed
244
245
}

246
STATIC bool node_is_const_false(mp_parse_node_t pn) {
247
248
    return MP_PARSE_NODE_IS_TOKEN_KIND(pn, MP_TOKEN_KW_FALSE)
        || (MP_PARSE_NODE_IS_SMALL_INT(pn) && MP_PARSE_NODE_LEAF_SMALL_INT(pn) == 0);
Damien's avatar
Damien committed
249
250
}

251
STATIC bool node_is_const_true(mp_parse_node_t pn) {
252
253
    return MP_PARSE_NODE_IS_TOKEN_KIND(pn, MP_TOKEN_KW_TRUE)
        || (MP_PARSE_NODE_IS_SMALL_INT(pn) && MP_PARSE_NODE_LEAF_SMALL_INT(pn) != 0);
Damien's avatar
Damien committed
254
255
}

256
STATIC void c_if_cond(compiler_t *comp, mp_parse_node_t pn, bool jump_if, int label) {
257
258
    if (node_is_const_false(pn)) {
        if (jump_if == false) {
259
            EMIT_ARG(jump, label);
260
261
262
263
        }
        return;
    } else if (node_is_const_true(pn)) {
        if (jump_if == true) {
264
            EMIT_ARG(jump, label);
265
266
        }
        return;
267
268
269
270
    } else if (MP_PARSE_NODE_IS_STRUCT(pn)) {
        mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
        int n = MP_PARSE_NODE_STRUCT_NUM_NODES(pns);
        if (MP_PARSE_NODE_STRUCT_KIND(pns) == PN_or_test) {
271
            if (jump_if == false) {
272
            and_or_logic1:;
273
                uint label2 = comp_next_label(comp);
274
                for (int i = 0; i < n - 1; i++) {
275
                    c_if_cond(comp, pns->nodes[i], !jump_if, label2);
276
                }
277
                c_if_cond(comp, pns->nodes[n - 1], jump_if, label);
278
                EMIT_ARG(label_assign, label2);
279
            } else {
280
            and_or_logic2:
281
                for (int i = 0; i < n; i++) {
282
                    c_if_cond(comp, pns->nodes[i], jump_if, label);
283
284
285
                }
            }
            return;
286
        } else if (MP_PARSE_NODE_STRUCT_KIND(pns) == PN_and_test) {
287
            if (jump_if == false) {
288
                goto and_or_logic2;
289
            } else {
290
                goto and_or_logic1;
291
            }
292
        } else if (MP_PARSE_NODE_STRUCT_KIND(pns) == PN_not_test_2) {
293
294
            c_if_cond(comp, pns->nodes[0], !jump_if, label);
            return;
295
296
297
298
299
300
301
        } else if (MP_PARSE_NODE_STRUCT_KIND(pns) == PN_atom_paren) {
            // cond is something in parenthesis
            if (MP_PARSE_NODE_IS_NULL(pns->nodes[0])) {
                // empty tuple, acts as false for the condition
                if (jump_if == false) {
                    EMIT_ARG(jump, label);
                }
302
303
            } else {
                assert(MP_PARSE_NODE_IS_STRUCT_KIND(pns->nodes[0], PN_testlist_comp));
304
305
306
307
308
309
                // non-empty tuple, acts as true for the condition
                if (jump_if == true) {
                    EMIT_ARG(jump, label);
                }
            }
            return;
310
311
312
313
314
        }
    }

    // nothing special, fall back to default compiling for node and jump
    compile_node(comp, pn);
315
    EMIT_ARG(pop_jump_if, jump_if, label);
Damien's avatar
Damien committed
316
317
318
}

typedef enum { ASSIGN_STORE, ASSIGN_AUG_LOAD, ASSIGN_AUG_STORE } assign_kind_t;
319
STATIC void c_assign(compiler_t *comp, mp_parse_node_t pn, assign_kind_t kind);
Damien's avatar
Damien committed
320

321
STATIC void c_assign_atom_expr(compiler_t *comp, mp_parse_node_struct_t *pns, assign_kind_t assign_kind) {
Damien's avatar
Damien committed
322
323
324
325
    if (assign_kind != ASSIGN_AUG_STORE) {
        compile_node(comp, pns->nodes[0]);
    }

326
327
    if (MP_PARSE_NODE_IS_STRUCT(pns->nodes[1])) {
        mp_parse_node_struct_t *pns1 = (mp_parse_node_struct_t*)pns->nodes[1];
328
        if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_atom_expr_trailers) {
329
            int n = MP_PARSE_NODE_STRUCT_NUM_NODES(pns1);
Damien's avatar
Damien committed
330
331
332
333
334
            if (assign_kind != ASSIGN_AUG_STORE) {
                for (int i = 0; i < n - 1; i++) {
                    compile_node(comp, pns1->nodes[i]);
                }
            }
335
336
            assert(MP_PARSE_NODE_IS_STRUCT(pns1->nodes[n - 1]));
            pns1 = (mp_parse_node_struct_t*)pns1->nodes[n - 1];
Damien's avatar
Damien committed
337
        }
338
        if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_trailer_bracket) {
Damien's avatar
Damien committed
339
340
341
342
343
344
345
            if (assign_kind == ASSIGN_AUG_STORE) {
                EMIT(rot_three);
                EMIT(store_subscr);
            } else {
                compile_node(comp, pns1->nodes[0]);
                if (assign_kind == ASSIGN_AUG_LOAD) {
                    EMIT(dup_top_two);
346
                    EMIT(load_subscr);
Damien's avatar
Damien committed
347
348
349
350
                } else {
                    EMIT(store_subscr);
                }
            }
351
352
        } else if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_trailer_period) {
            assert(MP_PARSE_NODE_IS_ID(pns1->nodes[0]));
Damien's avatar
Damien committed
353
354
            if (assign_kind == ASSIGN_AUG_LOAD) {
                EMIT(dup_top);
355
                EMIT_ARG(load_attr, MP_PARSE_NODE_LEAF_ARG(pns1->nodes[0]));
Damien's avatar
Damien committed
356
357
358
359
            } else {
                if (assign_kind == ASSIGN_AUG_STORE) {
                    EMIT(rot_two);
                }
360
                EMIT_ARG(store_attr, MP_PARSE_NODE_LEAF_ARG(pns1->nodes[0]));
Damien's avatar
Damien committed
361
362
            }
        } else {
363
            goto cannot_assign;
Damien's avatar
Damien committed
364
365
        }
    } else {
366
        goto cannot_assign;
Damien's avatar
Damien committed
367
368
    }

369
370
371
372
    return;

cannot_assign:
    compile_syntax_error(comp, (mp_parse_node_t)pns, "can't assign to expression");
Damien's avatar
Damien committed
373
374
}

375
// we need to allow for a caller passing in 1 initial node (node_head) followed by an array of nodes (nodes_tail)
376
STATIC void c_assign_tuple(compiler_t *comp, mp_parse_node_t node_head, uint num_tail, mp_parse_node_t *nodes_tail) {
377
378
379
    uint num_head = (node_head == MP_PARSE_NODE_NULL) ? 0 : 1;

    // look for star expression
380
    uint have_star_index = -1;
381
382
383
384
    if (num_head != 0 && MP_PARSE_NODE_IS_STRUCT_KIND(node_head, PN_star_expr)) {
        EMIT_ARG(unpack_ex, 0, num_tail);
        have_star_index = 0;
    }
385
    for (uint i = 0; i < num_tail; i++) {
386
        if (MP_PARSE_NODE_IS_STRUCT_KIND(nodes_tail[i], PN_star_expr)) {
387
            if (have_star_index == (uint)-1) {
388
389
                EMIT_ARG(unpack_ex, num_head + i, num_tail - i - 1);
                have_star_index = num_head + i;
Damien's avatar
Damien committed
390
            } else {
391
                compile_syntax_error(comp, nodes_tail[i], "multiple *x in assignment");
Damien's avatar
Damien committed
392
393
394
395
                return;
            }
        }
    }
396
    if (have_star_index == (uint)-1) {
397
        EMIT_ARG(unpack_sequence, num_head + num_tail);
Damien's avatar
Damien committed
398
    }
399
400
401
    if (num_head != 0) {
        if (0 == have_star_index) {
            c_assign(comp, ((mp_parse_node_struct_t*)node_head)->nodes[0], ASSIGN_STORE);
Damien's avatar
Damien committed
402
        } else {
403
404
405
            c_assign(comp, node_head, ASSIGN_STORE);
        }
    }
406
    for (uint i = 0; i < num_tail; i++) {
407
408
409
410
        if (num_head + i == have_star_index) {
            c_assign(comp, ((mp_parse_node_struct_t*)nodes_tail[i])->nodes[0], ASSIGN_STORE);
        } else {
            c_assign(comp, nodes_tail[i], ASSIGN_STORE);
Damien's avatar
Damien committed
411
412
413
414
415
        }
    }
}

// assigns top of stack to pn
416
STATIC void c_assign(compiler_t *comp, mp_parse_node_t pn, assign_kind_t assign_kind) {
417
418
    assert(!MP_PARSE_NODE_IS_NULL(pn));
    if (MP_PARSE_NODE_IS_LEAF(pn)) {
419
        if (MP_PARSE_NODE_IS_ID(pn)) {
420
            qstr arg = MP_PARSE_NODE_LEAF_ARG(pn);
Damien's avatar
Damien committed
421
422
423
            switch (assign_kind) {
                case ASSIGN_STORE:
                case ASSIGN_AUG_STORE:
424
                    compile_store_id(comp, arg);
Damien's avatar
Damien committed
425
426
                    break;
                case ASSIGN_AUG_LOAD:
427
                default:
428
                    compile_load_id(comp, arg);
Damien's avatar
Damien committed
429
430
431
                    break;
            }
        } else {
432
            compile_syntax_error(comp, pn, "can't assign to literal");
Damien's avatar
Damien committed
433
434
435
            return;
        }
    } else {
436
        // pn must be a struct
437
438
        mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
        switch (MP_PARSE_NODE_STRUCT_KIND(pns)) {
439
            case PN_atom_expr_normal:
Damien's avatar
Damien committed
440
                // lhs is an index or attribute
441
                c_assign_atom_expr(comp, pns, assign_kind);
Damien's avatar
Damien committed
442
443
444
445
446
447
448
449
                break;

            case PN_testlist_star_expr:
            case PN_exprlist:
                // lhs is a tuple
                if (assign_kind != ASSIGN_STORE) {
                    goto bad_aug;
                }
450
                c_assign_tuple(comp, MP_PARSE_NODE_NULL, MP_PARSE_NODE_STRUCT_NUM_NODES(pns), pns->nodes);
Damien's avatar
Damien committed
451
452
453
454
                break;

            case PN_atom_paren:
                // lhs is something in parenthesis
455
                if (MP_PARSE_NODE_IS_NULL(pns->nodes[0])) {
Damien's avatar
Damien committed
456
                    // empty tuple
457
                    goto cannot_assign;
458
459
                } else {
                    assert(MP_PARSE_NODE_IS_STRUCT_KIND(pns->nodes[0], PN_testlist_comp));
460
461
462
                    if (assign_kind != ASSIGN_STORE) {
                        goto bad_aug;
                    }
463
                    pns = (mp_parse_node_struct_t*)pns->nodes[0];
Damien's avatar
Damien committed
464
465
466
467
468
469
470
471
472
                    goto testlist_comp;
                }
                break;

            case PN_atom_bracket:
                // lhs is something in brackets
                if (assign_kind != ASSIGN_STORE) {
                    goto bad_aug;
                }
473
                if (MP_PARSE_NODE_IS_NULL(pns->nodes[0])) {
Damien's avatar
Damien committed
474
                    // empty list, assignment allowed
475
                    c_assign_tuple(comp, MP_PARSE_NODE_NULL, 0, NULL);
476
477
                } else if (MP_PARSE_NODE_IS_STRUCT_KIND(pns->nodes[0], PN_testlist_comp)) {
                    pns = (mp_parse_node_struct_t*)pns->nodes[0];
Damien's avatar
Damien committed
478
479
480
                    goto testlist_comp;
                } else {
                    // brackets around 1 item
481
                    c_assign_tuple(comp, pns->nodes[0], 0, NULL);
Damien's avatar
Damien committed
482
483
484
485
                }
                break;

            default:
486
                goto cannot_assign;
Damien's avatar
Damien committed
487
488
489
490
491
        }
        return;

        testlist_comp:
        // lhs is a sequence
492
493
494
        if (MP_PARSE_NODE_IS_STRUCT(pns->nodes[1])) {
            mp_parse_node_struct_t *pns2 = (mp_parse_node_struct_t*)pns->nodes[1];
            if (MP_PARSE_NODE_STRUCT_KIND(pns2) == PN_testlist_comp_3b) {
Damien's avatar
Damien committed
495
                // sequence of one item, with trailing comma
496
                assert(MP_PARSE_NODE_IS_NULL(pns2->nodes[0]));
497
                c_assign_tuple(comp, pns->nodes[0], 0, NULL);
498
            } else if (MP_PARSE_NODE_STRUCT_KIND(pns2) == PN_testlist_comp_3c) {
Damien's avatar
Damien committed
499
                // sequence of many items
500
501
                uint n = MP_PARSE_NODE_STRUCT_NUM_NODES(pns2);
                c_assign_tuple(comp, pns->nodes[0], n, pns2->nodes);
502
            } else if (MP_PARSE_NODE_STRUCT_KIND(pns) == PN_comp_for) {
503
                // TODO can we ever get here? can it be compiled?
504
                goto cannot_assign;
Damien's avatar
Damien committed
505
506
507
508
509
510
511
            } else {
                // sequence with 2 items
                goto sequence_with_2_items;
            }
        } else {
            // sequence with 2 items
            sequence_with_2_items:
512
            c_assign_tuple(comp, MP_PARSE_NODE_NULL, 2, pns->nodes);
Damien's avatar
Damien committed
513
514
515
516
517
        }
        return;
    }
    return;

518
519
520
521
    cannot_assign:
    compile_syntax_error(comp, pn, "can't assign to expression");
    return;

Damien's avatar
Damien committed
522
    bad_aug:
523
    compile_syntax_error(comp, pn, "illegal expression for augmented assignment");
Damien's avatar
Damien committed
524
525
}

526
// stuff for lambda and comprehensions and generators:
527
528
529
//  if n_pos_defaults > 0 then there is a tuple on the stack with the positional defaults
//  if n_kw_defaults > 0 then there is a dictionary on the stack with the keyword defaults
//  if both exist, the tuple is above the dictionary (ie the first pop gets the tuple)
530
STATIC void close_over_variables_etc(compiler_t *comp, scope_t *this_scope, int n_pos_defaults, int n_kw_defaults) {
531
532
533
    assert(n_pos_defaults >= 0);
    assert(n_kw_defaults >= 0);

534
535
536
537
538
539
    // set flags
    if (n_kw_defaults > 0) {
        this_scope->scope_flags |= MP_SCOPE_FLAG_DEFKWARGS;
    }
    this_scope->num_def_pos_args = n_pos_defaults;

Damien's avatar
Damien committed
540
    // make closed over variables, if any
541
    // ensure they are closed over in the order defined in the outer scope (mainly to agree with CPython)
Damien's avatar
Damien committed
542
543
    int nfree = 0;
    if (comp->scope_cur->kind != SCOPE_MODULE) {
544
545
546
547
548
        for (int i = 0; i < comp->scope_cur->id_info_len; i++) {
            id_info_t *id = &comp->scope_cur->id_info[i];
            if (id->kind == ID_INFO_KIND_CELL || id->kind == ID_INFO_KIND_FREE) {
                for (int j = 0; j < this_scope->id_info_len; j++) {
                    id_info_t *id2 = &this_scope->id_info[j];
549
                    if (id2->kind == ID_INFO_KIND_FREE && id->qst == id2->qst) {
Damien George's avatar
Damien George committed
550
                        // in Micro Python we load closures using LOAD_FAST
551
                        EMIT_LOAD_FAST(id->qst, id->local_num);
552
553
554
                        nfree += 1;
                    }
                }
Damien's avatar
Damien committed
555
556
557
558
559
560
            }
        }
    }

    // make the function/closure
    if (nfree == 0) {
561
        EMIT_ARG(make_function, this_scope, n_pos_defaults, n_kw_defaults);
Damien's avatar
Damien committed
562
    } else {
563
        EMIT_ARG(make_closure, this_scope, nfree, n_pos_defaults, n_kw_defaults);
Damien's avatar
Damien committed
564
565
566
    }
}

567
568
569
STATIC void compile_funcdef_lambdef_param(compiler_t *comp, mp_parse_node_t pn) {
    if (MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_typedargslist_star)
        || MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_varargslist_star)) {
570
571
        comp->have_star = true;
        /* don't need to distinguish bare from named star
572
        mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
573
574
        if (MP_PARSE_NODE_IS_NULL(pns->nodes[0])) {
            // bare star
575
576
        } else {
            // named star
577
        }
578
        */
579

580
581
    } else if (MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_typedargslist_dbl_star)
        || MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_varargslist_dbl_star)) {
582
        // named double star
583
584
585
586
587
588
589
590
591
592
593
594
595
        // TODO do we need to do anything with this?

    } else {
        mp_parse_node_t pn_id;
        mp_parse_node_t pn_colon;
        mp_parse_node_t pn_equal;
        if (MP_PARSE_NODE_IS_ID(pn)) {
            // this parameter is just an id

            pn_id = pn;
            pn_colon = MP_PARSE_NODE_NULL;
            pn_equal = MP_PARSE_NODE_NULL;

596
        } else if (MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_typedargslist_name)) {
597
598
599
600
601
602
            // this parameter has a colon and/or equal specifier

            mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
            pn_id = pns->nodes[0];
            pn_colon = pns->nodes[1];
            pn_equal = pns->nodes[2];
603
604
605
606
607
608
609
610

        } else {
            assert(MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_varargslist_name)); // should be
            // this parameter has an equal specifier

            mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
            pn_id = pns->nodes[0];
            pn_equal = pns->nodes[1];
611
612
613
614
615
616
        }

        if (MP_PARSE_NODE_IS_NULL(pn_equal)) {
            // this parameter does not have a default value

            // check for non-default parameters given after default parameters (allowed by parser, but not syntactically valid)
617
            if (!comp->have_star && comp->num_default_params != 0) {
618
                compile_syntax_error(comp, pn, "non-default argument follows default argument");
619
620
621
622
                return;
            }

        } else {
Damien's avatar
Damien committed
623
624
            // this parameter has a default value
            // in CPython, None (and True, False?) as default parameters are loaded with LOAD_NAME; don't understandy why
625

626
            if (comp->have_star) {
627
628
629
                comp->num_dict_params += 1;
                // in Micro Python we put the default dict parameters into a dictionary using the bytecode
                if (comp->num_dict_params == 1) {
630
631
632
633
                    // in Micro Python we put the default positional parameters into a tuple using the bytecode
                    // we need to do this here before we start building the map for the default keywords
                    if (comp->num_default_params > 0) {
                        EMIT_ARG(build_tuple, comp->num_default_params);
634
635
                    } else {
                        EMIT(load_null); // sentinel indicating empty default positional args
636
                    }
637
638
639
                    // first default dict param, so make the map
                    EMIT_ARG(build_map, 0);
                }
640
641

                // compile value then key, then store it to the dict
642
                compile_node(comp, pn_equal);
643
                EMIT_ARG(load_const_str, MP_PARSE_NODE_LEAF_ARG(pn_id));
644
                EMIT(store_map);
Damien's avatar
Damien committed
645
            } else {
646
647
                comp->num_default_params += 1;
                compile_node(comp, pn_equal);
Damien's avatar
Damien committed
648
649
            }
        }
650
651
652

        // TODO pn_colon not implemented
        (void)pn_colon;
Damien's avatar
Damien committed
653
654
655
    }
}

656
STATIC void compile_funcdef_lambdef(compiler_t *comp, scope_t *scope, mp_parse_node_t pn_params, pn_kind_t pn_list_kind) {
657
658
659
660
661
662
663
    // When we call compile_funcdef_lambdef_param below it can compile an arbitrary
    // expression for default arguments, which may contain a lambda.  The lambda will
    // call here in a nested way, so we must save and restore the relevant state.
    bool orig_have_star = comp->have_star;
    uint16_t orig_num_dict_params = comp->num_dict_params;
    uint16_t orig_num_default_params = comp->num_default_params;

Damien's avatar
Damien committed
664
    // compile default parameters
665
    comp->have_star = false;
666
667
    comp->num_dict_params = 0;
    comp->num_default_params = 0;
668
    apply_to_single_or_list(comp, pn_params, pn_list_kind, compile_funcdef_lambdef_param);
669

670
    if (comp->compile_error != MP_OBJ_NULL) {
671
        return;
672
673
    }

674
    // in Micro Python we put the default positional parameters into a tuple using the bytecode
675
676
    // the default keywords args may have already made the tuple; if not, do it now
    if (comp->num_default_params > 0 && comp->num_dict_params == 0) {
677
        EMIT_ARG(build_tuple, comp->num_default_params);
678
        EMIT(load_null); // sentinel indicating empty default keyword args
679
680
    }

681
682
    // make the function
    close_over_variables_etc(comp, scope, comp->num_default_params, comp->num_dict_params);
683
684
685
686
687

    // restore state
    comp->have_star = orig_have_star;
    comp->num_dict_params = orig_num_dict_params;
    comp->num_default_params = orig_num_default_params;
688
689
690
691
692
693
694
695
696
697
698
699
}

// leaves function object on stack
// returns function name
STATIC qstr compile_funcdef_helper(compiler_t *comp, mp_parse_node_struct_t *pns, uint emit_options) {
    if (comp->pass == MP_PASS_SCOPE) {
        // create a new scope for this function
        scope_t *s = scope_new_and_link(comp, SCOPE_FUNCTION, (mp_parse_node_t)pns, emit_options);
        // store the function scope so the compiling function can use it at each pass
        pns->nodes[4] = (mp_parse_node_t)s;
    }

Damien's avatar
Damien committed
700
701
702
    // get the scope for this function
    scope_t *fscope = (scope_t*)pns->nodes[4];

703
704
    // compile the function definition
    compile_funcdef_lambdef(comp, fscope, pns->nodes[1], PN_typedargslist);
Damien's avatar
Damien committed
705
706
707
708
709
710
711

    // return its name (the 'f' in "def f(...):")
    return fscope->simple_name;
}

// leaves class object on stack
// returns class name
712
STATIC qstr compile_classdef_helper(compiler_t *comp, mp_parse_node_struct_t *pns, uint emit_options) {
713
    if (comp->pass == MP_PASS_SCOPE) {
Damien's avatar
Damien committed
714
        // create a new scope for this class
715
        scope_t *s = scope_new_and_link(comp, SCOPE_CLASS, (mp_parse_node_t)pns, emit_options);
Damien's avatar
Damien committed
716
        // store the class scope so the compiling function can use it at each pass
717
        pns->nodes[3] = (mp_parse_node_t)s;
Damien's avatar
Damien committed
718
719
720
721
722
723
724
725
726
727
728
    }

    EMIT(load_build_class);

    // scope for this class
    scope_t *cscope = (scope_t*)pns->nodes[3];

    // compile the class
    close_over_variables_etc(comp, cscope, 0, 0);

    // get its name
729
    EMIT_ARG(load_const_str, cscope->simple_name);
Damien's avatar
Damien committed
730
731

    // nodes[1] has parent classes, if any
732
733
734
735
736
    // empty parenthesis (eg class C():) gets here as an empty PN_classdef_2 and needs special handling
    mp_parse_node_t parents = pns->nodes[1];
    if (MP_PARSE_NODE_IS_STRUCT_KIND(parents, PN_classdef_2)) {
        parents = MP_PARSE_NODE_NULL;
    }
737
    comp->func_arg_is_super = false;
738
    compile_trailer_paren_helper(comp, parents, false, 2);
Damien's avatar
Damien committed
739
740
741
742
743

    // return its name (the 'C' in class C(...):")
    return cscope->simple_name;
}

744
// returns true if it was a built-in decorator (even if the built-in had an error)
745
STATIC bool compile_built_in_decorator(compiler_t *comp, int name_len, mp_parse_node_t *name_nodes, uint *emit_options) {
746
    if (MP_PARSE_NODE_LEAF_ARG(name_nodes[0]) != MP_QSTR_micropython) {
747
748
749
750
        return false;
    }

    if (name_len != 2) {
751
        compile_syntax_error(comp, name_nodes[0], "invalid micropython decorator");
752
753
754
        return true;
    }

755
    qstr attr = MP_PARSE_NODE_LEAF_ARG(name_nodes[1]);
756
    if (attr == MP_QSTR_bytecode) {
757
        *emit_options = MP_EMIT_OPT_BYTECODE;
758
#if MICROPY_EMIT_NATIVE
759
    } else if (attr == MP_QSTR_native) {
760
        *emit_options = MP_EMIT_OPT_NATIVE_PYTHON;
761
    } else if (attr == MP_QSTR_viper) {
762
        *emit_options = MP_EMIT_OPT_VIPER;
763
#endif
764
#if MICROPY_EMIT_INLINE_THUMB
765
    } else if (attr == MP_QSTR_asm_thumb) {
766
        *emit_options = MP_EMIT_OPT_ASM_THUMB;
767
#endif
768
    } else {
769
        compile_syntax_error(comp, name_nodes[1], "invalid micropython decorator");
770
771
772
773
774
    }

    return true;
}

775
STATIC void compile_decorated(compiler_t *comp, mp_parse_node_struct_t *pns) {
Damien's avatar
Damien committed
776
    // get the list of decorators
777
    mp_parse_node_t *nodes;
778
    int n = mp_parse_node_extract_list(&pns->nodes[0], PN_decorators, &nodes);
Damien's avatar
Damien committed
779

780
781
782
783
784
    // inherit emit options for this function/class definition
    uint emit_options = comp->scope_cur->emit_options;

    // compile each decorator
    int num_built_in_decorators = 0;
Damien's avatar
Damien committed
785
    for (int i = 0; i < n; i++) {
786
787
        assert(MP_PARSE_NODE_IS_STRUCT_KIND(nodes[i], PN_decorator)); // should be
        mp_parse_node_struct_t *pns_decorator = (mp_parse_node_struct_t*)nodes[i];
788
789

        // nodes[0] contains the decorator function, which is a dotted name
790
        mp_parse_node_t *name_nodes;
791
        int name_len = mp_parse_node_extract_list(&pns_decorator->nodes[0], PN_dotted_name, &name_nodes);
792
793
794
795
796
797
798
799
800
801
802

        // check for built-in decorators
        if (compile_built_in_decorator(comp, name_len, name_nodes, &emit_options)) {
            // this was a built-in
            num_built_in_decorators += 1;

        } else {
            // not a built-in, compile normally

            // compile the decorator function
            compile_node(comp, name_nodes[0]);
803
804
805
            for (int j = 1; j < name_len; j++) {
                assert(MP_PARSE_NODE_IS_ID(name_nodes[j])); // should be
                EMIT_ARG(load_attr, MP_PARSE_NODE_LEAF_ARG(name_nodes[j]));
806
807
808
            }

            // nodes[1] contains arguments to the decorator function, if any
809
            if (!MP_PARSE_NODE_IS_NULL(pns_decorator->nodes[1])) {
810
                // call the decorator function with the arguments in nodes[1]
Damien George's avatar
Damien George committed
811
                comp->func_arg_is_super = false;
812
813
                compile_node(comp, pns_decorator->nodes[1]);
            }
Damien's avatar
Damien committed
814
815
816
        }
    }

817
    // compile the body (funcdef, async funcdef or classdef) and get its name
818
    mp_parse_node_struct_t *pns_body = (mp_parse_node_struct_t*)pns->nodes[1];
Damien's avatar
Damien committed
819
    qstr body_name = 0;
820
    if (MP_PARSE_NODE_STRUCT_KIND(pns_body) == PN_funcdef) {
821
        body_name = compile_funcdef_helper(comp, pns_body, emit_options);
822
823
824
825
826
827
828
829
    #if MICROPY_PY_ASYNC_AWAIT
    } else if (MP_PARSE_NODE_STRUCT_KIND(pns_body) == PN_async_funcdef) {
        assert(MP_PARSE_NODE_IS_STRUCT(pns_body->nodes[0]));
        mp_parse_node_struct_t *pns0 = (mp_parse_node_struct_t*)pns_body->nodes[0];
        body_name = compile_funcdef_helper(comp, pns0, emit_options);
        scope_t *fscope = (scope_t*)pns0->nodes[4];
        fscope->scope_flags |= MP_SCOPE_FLAG_GENERATOR;
    #endif
Damien's avatar
Damien committed
830
    } else {
831
832
        assert(MP_PARSE_NODE_STRUCT_KIND(pns_body) == PN_classdef); // should be
        body_name = compile_classdef_helper(comp, pns_body, emit_options);
Damien's avatar
Damien committed
833
834
835
    }

    // call each decorator
836
    for (int i = 0; i < n - num_built_in_decorators; i++) {
837
        EMIT_ARG(call_function, 1, 0, 0);
Damien's avatar
Damien committed
838
839
840
    }

    // store func/class object into name
841
    compile_store_id(comp, body_name);
Damien's avatar
Damien committed
842
843
}

844
STATIC void compile_funcdef(compiler_t *comp, mp_parse_node_struct_t *pns) {
845
    qstr fname = compile_funcdef_helper(comp, pns, comp->scope_cur->emit_options);
Damien's avatar
Damien committed
846
    // store function object into function name
847
    compile_store_id(comp, fname);
Damien's avatar
Damien committed
848
849
}

850
STATIC void c_del_stmt(compiler_t *comp, mp_parse_node_t pn) {
851
    if (MP_PARSE_NODE_IS_ID(pn)) {
852
        compile_delete_id(comp, MP_PARSE_NODE_LEAF_ARG(pn));
853
    } else if (MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_atom_expr_normal)) {
854
        mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
Damien's avatar
Damien committed
855

856
        compile_node(comp, pns->nodes[0]); // base of the atom_expr_normal node
Damien's avatar
Damien committed
857

858
859
        if (MP_PARSE_NODE_IS_STRUCT(pns->nodes[1])) {
            mp_parse_node_struct_t *pns1 = (mp_parse_node_struct_t*)pns->nodes[1];
860
            if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_atom_expr_trailers) {
861
                int n = MP_PARSE_NODE_STRUCT_NUM_NODES(pns1);
Damien's avatar
Damien committed
862
863
864
                for (int i = 0; i < n - 1; i++) {
                    compile_node(comp, pns1->nodes[i]);
                }
865
866
                assert(MP_PARSE_NODE_IS_STRUCT(pns1->nodes[n - 1]));
                pns1 = (mp_parse_node_struct_t*)pns1->nodes[n - 1];
Damien's avatar
Damien committed
867
            }
868
            if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_trailer_bracket) {
Damien's avatar
Damien committed
869
870
                compile_node(comp, pns1->nodes[0]);
                EMIT(delete_subscr);
871
872
            } else if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_trailer_period) {
                assert(MP_PARSE_NODE_IS_ID(pns1->nodes[0]));
873
                EMIT_ARG(delete_attr, MP_PARSE_NODE_LEAF_ARG(pns1->nodes[0]));
Damien's avatar
Damien committed
874
            } else {
875
                goto cannot_delete;
Damien's avatar
Damien committed
876
877
            }
        } else {
878
            goto cannot_delete;
Damien's avatar
Damien committed
879
880
        }

881
882
    } else if (MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_atom_paren)) {
        pn = ((mp_parse_node_struct_t*)pn)->nodes[0];
883
884
885
886
        if (MP_PARSE_NODE_IS_NULL(pn)) {
            goto cannot_delete;
        } else {
            assert(MP_PARSE_NODE_IS_STRUCT_KIND(pn, PN_testlist_comp));
887
            mp_parse_node_struct_t *pns = (mp_parse_node_struct_t*)pn;
Damien's avatar
Damien committed
888
889
            // TODO perhaps factorise testlist_comp code with other uses of PN_testlist_comp

890
891
892
            if (MP_PARSE_NODE_IS_STRUCT(pns->nodes[1])) {
                mp_parse_node_struct_t *pns1 = (mp_parse_node_struct_t*)pns->nodes[1];
                if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_testlist_comp_3b) {
Damien's avatar
Damien committed
893
                    // sequence of one item, with trailing comma
894
                    assert(MP_PARSE_NODE_IS_NULL(pns1->nodes[0]));
Damien's avatar
Damien committed
895
                    c_del_stmt(comp, pns->nodes[0]);
896
                } else if (MP_PARSE_NODE_STRUCT_KIND(pns1) == PN_testlist_comp_3c) {
Damien's avatar
Damien committed
897
                    // sequence of many items
898
                    int n = MP_PARSE_NODE_STRUCT_NUM_NODES(pns1);
Damien's avatar
Damien committed
899
900
901
902
                    c_del_stmt(comp, pns->nodes[0]);
                    for (int i = 0; i < n; i++) {
                        c_del_stmt(comp, pns1->nodes[i]);
                    }
903
                } else if (MP_PARSE_NODE_STRUCT_KIND(pns) == PN_comp_for) {
904
                    // TODO not implemented; can't del comprehension? can we get here?
905
                    goto cannot_delete;
Damien's avatar
Damien committed
906
907
908
909
910
911
912
913
914
915
916
917
                } else {
                    // sequence with 2 items
                    goto sequence_with_2_items;
                }
            } else {
                // sequence with 2 items
                sequence_with_2_items:
                c_del_stmt(comp, pns->nodes[0]);
                c_del_stmt(comp, pns->nodes[1]);
            }
        }
    } else {
918
        // some arbitrary statment that we can't delete (eg del 1)
919
        goto cannot_delete;
Damien's avatar
Damien committed
920
    }
921
922
923
924
925

    return;

cannot_delete:
    compile_syntax_error(comp, (mp_parse_node_t)pn, "can't delete expression");
Damien's avatar
Damien committed
926
927
}

928
STATIC void compile_del_stmt(compiler_t *comp, mp_parse_node_struct_t *pns) {
Damien's avatar
Damien committed
929
930
931
    apply_to_single_or_list(comp, pns->nodes[0], PN_exprlist, c_del_stmt);
}

932
STATIC void compile_break_stmt(compiler_t *comp, mp_parse_node_struct_t *pns) {
Damien's avatar
Damien committed
933
    if (comp->break_label == 0) {
934
        compile_syntax_error(comp, (mp_parse_node_t)pns, "'break' outside loop");
Damien's avatar
Damien committed
935
    }
936
    assert(comp->cur_except_level >= comp->break_continue_except_level);
937
    EMIT_ARG(break_loop, comp->break_label, comp->cur_except_level - comp->break_continue_except_level);
Damien's avatar
Damien committed
938
939
}

940
STATIC void compile_continue_stmt(compiler_t *comp, mp_parse_node_struct_t *pns) {
Damien's avatar
Damien committed
941
    if (comp->continue_label == 0) {
942
        compile_syntax_error(comp, (mp_parse_node_t)pns, "'continue' outside loop");
Damien's avatar
Damien committed
943
    }
944
    assert(comp->cur_except_level >= comp->break_continue_except_level);