runtime.c 49 KB
Newer Older
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * 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.
 */

Damien's avatar
Damien committed
27
28
29
30
#include <stdio.h>
#include <string.h>
#include <assert.h>

31
#include "py/mpstate.h"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#include "py/nlr.h"
#include "py/parsehelper.h"
#include "py/parsenum.h"
#include "py/compile.h"
#include "py/objtuple.h"
#include "py/objlist.h"
#include "py/objmodule.h"
#include "py/objgenerator.h"
#include "py/smallint.h"
#include "py/runtime0.h"
#include "py/runtime.h"
#include "py/builtin.h"
#include "py/stackctrl.h"
#include "py/gc.h"
46

47
#if 0 // print debugging info
48
#define DEBUG_PRINT (1)
49
#define DEBUG_printf DEBUG_printf
50
#define DEBUG_OP_printf(...) DEBUG_printf(__VA_ARGS__)
51
#else // don't print debugging info
52
53
#define DEBUG_printf(...) (void)0
#define DEBUG_OP_printf(...) (void)0
54
#endif
Damien's avatar
Damien committed
55

56
57
58
const mp_obj_module_t mp_module___main__ = {
    .base = { &mp_type_module },
    .name = MP_QSTR___main__,
59
    .globals = (mp_obj_dict_t*)&MP_STATE_VM(dict_main),
60
61
};

Damien George's avatar
Damien George committed
62
void mp_init(void) {
63
    qstr_init();
Paul Sokolovsky's avatar
Paul Sokolovsky committed
64
    mp_stack_ctrl_init();
65

66
    // no pending exceptions to start with
67
    MP_STATE_VM(mp_pending_exception) = MP_OBJ_NULL;
68

69
70
71
72
#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
    mp_init_emergency_exception_buf();
#endif

73
    // call port specific initialization if any
74
75
76
77
#ifdef MICROPY_PORT_INIT_FUNC
    MICROPY_PORT_INIT_FUNC;
#endif

78
    // optimization disabled by default
79
    MP_STATE_VM(mp_optimise_value) = 0;
80

81
82
    // init global module stuff
    mp_module_init();
83

84
    // initialise the __main__ module
85
86
    mp_obj_dict_init(&MP_STATE_VM(dict_main), 1);
    mp_obj_dict_store(&MP_STATE_VM(dict_main), MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR___main__));
87
88

    // locals = globals for outer module (see Objects/frameobject.c/PyFrame_New())
89
    MP_STATE_CTX(dict_locals) = MP_STATE_CTX(dict_globals) = &MP_STATE_VM(dict_main);
90
91
92

    #if MICROPY_CAN_OVERRIDE_BUILTINS
    // start with no extensions to builtins
93
    MP_STATE_VM(mp_module_builtins_override_dict) = NULL;
94
    #endif
Damien's avatar
Damien committed
95
96
}

Damien George's avatar
Damien George committed
97
void mp_deinit(void) {
98
    //mp_obj_dict_free(&dict_main);
99
    mp_module_deinit();
stijn's avatar
stijn committed
100
101
102
103
104

    // call port specific deinitialization if any 
#ifdef MICROPY_PORT_INIT_FUNC
    MICROPY_PORT_DEINIT_FUNC;
#endif
Damien's avatar
Damien committed
105
106
}

107
108
mp_obj_t mp_load_const_int(qstr qstr) {
    DEBUG_OP_printf("load '%s'\n", qstr_str(qstr));
109
    mp_uint_t len;
110
111
112
113
    const byte* data = qstr_data(qstr, &len);
    return mp_parse_num_integer((const char*)data, len, 0);
}

Damien George's avatar
Damien George committed
114
mp_obj_t mp_load_const_dec(qstr qstr) {
Damien's avatar
Damien committed
115
    DEBUG_OP_printf("load '%s'\n", qstr_str(qstr));
116
    mp_uint_t len;
117
    const byte* data = qstr_data(qstr, &len);
118
    return mp_parse_num_decimal((const char*)data, len, true, false);
Damien's avatar
Damien committed
119
120
}

Damien George's avatar
Damien George committed
121
mp_obj_t mp_load_const_str(qstr qstr) {
Damien's avatar
Damien committed
122
    DEBUG_OP_printf("load '%s'\n", qstr_str(qstr));
123
    return MP_OBJ_NEW_QSTR(qstr);
Damien's avatar
Damien committed
124
125
}

Damien George's avatar
Damien George committed
126
mp_obj_t mp_load_const_bytes(qstr qstr) {
127
    DEBUG_OP_printf("load b'%s'\n", qstr_str(qstr));
128
    mp_uint_t len;
129
130
131
132
    const byte *data = qstr_data(qstr, &len);
    return mp_obj_new_bytes(data, len);
}

Damien George's avatar
Damien George committed
133
mp_obj_t mp_load_name(qstr qstr) {
Damien's avatar
Damien committed
134
    // logic: search locals, globals, builtins
135
    DEBUG_OP_printf("load name %s\n", qstr_str(qstr));
136
    // If we're at the outer scope (locals == globals), dispatch to load_global right away
137
138
    if (MP_STATE_CTX(dict_locals) != MP_STATE_CTX(dict_globals)) {
        mp_map_elem_t *elem = mp_map_lookup(&MP_STATE_CTX(dict_locals)->map, MP_OBJ_NEW_QSTR(qstr), MP_MAP_LOOKUP);
139
140
141
        if (elem != NULL) {
            return elem->value;
        }
Damien's avatar
Damien committed
142
    }
143
    return mp_load_global(qstr);
Damien's avatar
Damien committed
144
145
}

Damien George's avatar
Damien George committed
146
mp_obj_t mp_load_global(qstr qstr) {
147
148
    // logic: search globals, builtins
    DEBUG_OP_printf("load global %s\n", qstr_str(qstr));
149
    mp_map_elem_t *elem = mp_map_lookup(&MP_STATE_CTX(dict_globals)->map, MP_OBJ_NEW_QSTR(qstr), MP_MAP_LOOKUP);
150
    if (elem == NULL) {
151
        #if MICROPY_CAN_OVERRIDE_BUILTINS
152
        if (MP_STATE_VM(mp_module_builtins_override_dict) != NULL) {
153
            // lookup in additional dynamic table of builtins first
154
            elem = mp_map_lookup(&MP_STATE_VM(mp_module_builtins_override_dict)->map, MP_OBJ_NEW_QSTR(qstr), MP_MAP_LOOKUP);
155
156
157
158
159
160
            if (elem != NULL) {
                return elem->value;
            }
        }
        #endif
        elem = mp_map_lookup((mp_map_t*)&mp_module_builtins_globals.map, MP_OBJ_NEW_QSTR(qstr), MP_MAP_LOOKUP);
161
        if (elem == NULL) {
162
163
164
165
166
167
168
            if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
                nlr_raise(mp_obj_new_exception_msg(&mp_type_NameError,
                    "name not defined"));
            } else {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_NameError,
                    "name '%s' is not defined", qstr_str(qstr)));
            }
169
170
171
        }
    }
    return elem->value;
Damien's avatar
Damien committed
172
173
}

Damien George's avatar
Damien George committed
174
mp_obj_t mp_load_build_class(void) {
Damien's avatar
Damien committed
175
    DEBUG_OP_printf("load_build_class\n");
176
    #if MICROPY_CAN_OVERRIDE_BUILTINS
177
    if (MP_STATE_VM(mp_module_builtins_override_dict) != NULL) {
178
        // lookup in additional dynamic table of builtins first
179
        mp_map_elem_t *elem = mp_map_lookup(&MP_STATE_VM(mp_module_builtins_override_dict)->map, MP_OBJ_NEW_QSTR(MP_QSTR___build_class__), MP_MAP_LOOKUP);
180
181
182
183
184
        if (elem != NULL) {
            return elem->value;
        }
    }
    #endif
185
    return (mp_obj_t)&mp_builtin___build_class___obj;
Damien's avatar
Damien committed
186
187
}

Damien George's avatar
Damien George committed
188
void mp_store_name(qstr qstr, mp_obj_t obj) {
189
    DEBUG_OP_printf("store name %s <- %p\n", qstr_str(qstr), obj);
190
    mp_obj_dict_store(MP_STATE_CTX(dict_locals), MP_OBJ_NEW_QSTR(qstr), obj);
191
192
}

Damien George's avatar
Damien George committed
193
void mp_delete_name(qstr qstr) {
194
    DEBUG_OP_printf("delete name %s\n", qstr_str(qstr));
195
    // TODO convert KeyError to NameError if qstr not found
196
    mp_obj_dict_delete(MP_STATE_CTX(dict_locals), MP_OBJ_NEW_QSTR(qstr));
197
198
}

Damien George's avatar
Damien George committed
199
void mp_store_global(qstr qstr, mp_obj_t obj) {
200
    DEBUG_OP_printf("store global %s <- %p\n", qstr_str(qstr), obj);
201
    mp_obj_dict_store(MP_STATE_CTX(dict_globals), MP_OBJ_NEW_QSTR(qstr), obj);
Damien's avatar
Damien committed
202
203
}

204
205
206
void mp_delete_global(qstr qstr) {
    DEBUG_OP_printf("delete global %s\n", qstr_str(qstr));
    // TODO convert KeyError to NameError if qstr not found
207
    mp_obj_dict_delete(MP_STATE_CTX(dict_globals), MP_OBJ_NEW_QSTR(qstr));
208
209
}

210
mp_obj_t mp_unary_op(mp_uint_t op, mp_obj_t arg) {
211
    DEBUG_OP_printf("unary " UINT_FMT " %p\n", op, arg);
212

213
    if (MP_OBJ_IS_SMALL_INT(arg)) {
214
        mp_int_t val = MP_OBJ_SMALL_INT_VALUE(arg);
Damien's avatar
Damien committed
215
        switch (op) {
Damien George's avatar
Damien George committed
216
            case MP_UNARY_OP_BOOL:
217
                return MP_BOOL(val != 0);
Damien George's avatar
Damien George committed
218
            case MP_UNARY_OP_POSITIVE:
219
                return arg;
Damien George's avatar
Damien George committed
220
            case MP_UNARY_OP_NEGATIVE:
221
222
223
224
225
226
                // check for overflow
                if (val == MP_SMALL_INT_MIN) {
                    return mp_obj_new_int(-val);
                } else {
                    return MP_OBJ_NEW_SMALL_INT(-val);
                }
Damien George's avatar
Damien George committed
227
            case MP_UNARY_OP_INVERT:
228
229
230
231
                return MP_OBJ_NEW_SMALL_INT(~val);
            default:
                assert(0);
                return arg;
232
        }
233
234
235
236
    } else {
        mp_obj_type_t *type = mp_obj_get_type(arg);
        if (type->unary_op != NULL) {
            mp_obj_t result = type->unary_op(op, arg);
237
            if (result != MP_OBJ_NULL) {
238
239
                return result;
            }
Damien's avatar
Damien committed
240
        }
241
242
243
244
245
246
247
248
249
        if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                "unsupported type for operator"));
        } else {
            // TODO specify in error message what the operator is
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                "bad operand type for unary operator: '%s'",
                mp_obj_get_type_str(arg)));
        }
Damien's avatar
Damien committed
250
    }
Damien's avatar
Damien committed
251
252
}

253
mp_obj_t mp_binary_op(mp_uint_t op, mp_obj_t lhs, mp_obj_t rhs) {
254
    DEBUG_OP_printf("binary " UINT_FMT " %p %p\n", op, lhs, rhs);
255
256
257
258
259
260
261
262
263
264

    // TODO correctly distinguish inplace operators for mutable objects
    // lookup logic that CPython uses for +=:
    //   check for implemented +=
    //   then check for implemented +
    //   then check for implemented seq.inplace_concat
    //   then check for implemented seq.concat
    //   then fail
    // note that list does not implement + or +=, so that inplace_concat is reached first for +=

265
    // deal with is
Damien George's avatar
Damien George committed
266
    if (op == MP_BINARY_OP_IS) {
267
268
269
        return MP_BOOL(lhs == rhs);
    }

270
    // deal with == and != for all types
Damien George's avatar
Damien George committed
271
    if (op == MP_BINARY_OP_EQUAL || op == MP_BINARY_OP_NOT_EQUAL) {
272
        if (mp_obj_equal(lhs, rhs)) {
Damien George's avatar
Damien George committed
273
            if (op == MP_BINARY_OP_EQUAL) {
274
275
276
277
278
                return mp_const_true;
            } else {
                return mp_const_false;
            }
        } else {
Damien George's avatar
Damien George committed
279
            if (op == MP_BINARY_OP_EQUAL) {
280
281
282
283
284
285
286
287
                return mp_const_false;
            } else {
                return mp_const_true;
            }
        }
    }

    // deal with exception_match for all types
Damien George's avatar
Damien George committed
288
    if (op == MP_BINARY_OP_EXCEPTION_MATCH) {
289
290
        // rhs must be issubclass(rhs, BaseException)
        if (mp_obj_is_exception_type(rhs)) {
291
            if (mp_obj_exception_match(lhs, rhs)) {
292
293
294
295
                return mp_const_true;
            } else {
                return mp_const_false;
            }
296
297
298
299
300
301
302
303
304
305
306
307
        } else if (MP_OBJ_IS_TYPE(rhs, &mp_type_tuple)) {
            mp_obj_tuple_t *tuple = rhs;
            for (mp_uint_t i = 0; i < tuple->len; i++) {
                rhs = tuple->items[i];
                if (!mp_obj_is_exception_type(rhs)) {
                    goto unsupported_op;
                }
                if (mp_obj_exception_match(lhs, rhs)) {
                    return mp_const_true;
                }
            }
            return mp_const_false;
308
        }
309
        goto unsupported_op;
310
311
    }

312
    if (MP_OBJ_IS_SMALL_INT(lhs)) {
313
        mp_int_t lhs_val = MP_OBJ_SMALL_INT_VALUE(lhs);
314
        if (MP_OBJ_IS_SMALL_INT(rhs)) {
315
            mp_int_t rhs_val = MP_OBJ_SMALL_INT_VALUE(rhs);
316
317
318
            // This is a binary operation: lhs_val op rhs_val
            // We need to be careful to handle overflow; see CERT INT32-C
            // Operations that can overflow:
319
320
            //      +       result always fits in mp_int_t, then handled by SMALL_INT check
            //      -       result always fits in mp_int_t, then handled by SMALL_INT check
321
            //      *       checked explicitly
322
323
            //      /       if lhs=MIN and rhs=-1; result always fits in mp_int_t, then handled by SMALL_INT check
            //      %       if lhs=MIN and rhs=-1; result always fits in mp_int_t, then handled by SMALL_INT check
324
            //      <<      checked explicitly
325
            switch (op) {
Damien George's avatar
Damien George committed
326
327
328
329
330
331
332
333
                case MP_BINARY_OP_OR:
                case MP_BINARY_OP_INPLACE_OR: lhs_val |= rhs_val; break;
                case MP_BINARY_OP_XOR:
                case MP_BINARY_OP_INPLACE_XOR: lhs_val ^= rhs_val; break;
                case MP_BINARY_OP_AND:
                case MP_BINARY_OP_INPLACE_AND: lhs_val &= rhs_val; break;
                case MP_BINARY_OP_LSHIFT:
                case MP_BINARY_OP_INPLACE_LSHIFT: {
334
335
                    if (rhs_val < 0) {
                        // negative shift not allowed
336
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative shift count"));
337
338
339
340
341
342
343
344
345
346
                    } else if (rhs_val >= BITS_PER_WORD || lhs_val > (MP_SMALL_INT_MAX >> rhs_val) || lhs_val < (MP_SMALL_INT_MIN >> rhs_val)) {
                        // left-shift will overflow, so use higher precision integer
                        lhs = mp_obj_new_int_from_ll(lhs_val);
                        goto generic_binary_op;
                    } else {
                        // use standard precision
                        lhs_val <<= rhs_val;
                    }
                    break;
                }
Damien George's avatar
Damien George committed
347
348
                case MP_BINARY_OP_RSHIFT:
                case MP_BINARY_OP_INPLACE_RSHIFT:
349
350
                    if (rhs_val < 0) {
                        // negative shift not allowed
351
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative shift count"));
352
353
                    } else {
                        // standard precision is enough for right-shift
354
355
356
357
358
                        if (rhs_val >= BITS_PER_WORD) {
                            // Shifting to big amounts is underfined behavior
                            // in C and is CPU-dependent; propagate sign bit.
                            rhs_val = BITS_PER_WORD - 1;
                        }
359
360
361
                        lhs_val >>= rhs_val;
                    }
                    break;
Damien George's avatar
Damien George committed
362
363
364
365
366
367
                case MP_BINARY_OP_ADD:
                case MP_BINARY_OP_INPLACE_ADD: lhs_val += rhs_val; break;
                case MP_BINARY_OP_SUBTRACT:
                case MP_BINARY_OP_INPLACE_SUBTRACT: lhs_val -= rhs_val; break;
                case MP_BINARY_OP_MULTIPLY:
                case MP_BINARY_OP_INPLACE_MULTIPLY: {
368

369
                    // If long long type exists and is larger than mp_int_t, then
370
                    // we can use the following code to perform overflow-checked multiplication.
371
                    // Otherwise (eg in x64 case) we must use mp_small_int_mul_overflow.
372
373
374
375
376
377
378
379
                    #if 0
                    // compute result using long long precision
                    long long res = (long long)lhs_val * (long long)rhs_val;
                    if (res > MP_SMALL_INT_MAX || res < MP_SMALL_INT_MIN) {
                        // result overflowed SMALL_INT, so return higher precision integer
                        return mp_obj_new_int_from_ll(res);
                    } else {
                        // use standard precision
380
                        lhs_val = (mp_int_t)res;
381
382
383
                    }
                    #endif

384
385
386
387
388
389
390
391
                    if (mp_small_int_mul_overflow(lhs_val, rhs_val)) {
                        // use higher precision
                        lhs = mp_obj_new_int_from_ll(lhs_val);
                        goto generic_binary_op;
                    } else {
                        // use standard precision
                        return MP_OBJ_NEW_SMALL_INT(lhs_val * rhs_val);
                    }
392
393
                    break;
                }
Damien George's avatar
Damien George committed
394
395
                case MP_BINARY_OP_FLOOR_DIVIDE:
                case MP_BINARY_OP_INPLACE_FLOOR_DIVIDE:
396
397
398
                    if (rhs_val == 0) {
                        goto zero_division;
                    }
399
                    lhs_val = mp_small_int_floor_divide(lhs_val, rhs_val);
400
                    break;
401

402
                #if MICROPY_PY_BUILTINS_FLOAT
Damien George's avatar
Damien George committed
403
                case MP_BINARY_OP_TRUE_DIVIDE:
404
405
                case MP_BINARY_OP_INPLACE_TRUE_DIVIDE:
                    if (rhs_val == 0) {
406
                        goto zero_division;
407
408
                    }
                    return mp_obj_new_float((mp_float_t)lhs_val / (mp_float_t)rhs_val);
409
                #endif
410

Damien George's avatar
Damien George committed
411
                case MP_BINARY_OP_MODULO:
412
413
                case MP_BINARY_OP_INPLACE_MODULO: {
                    lhs_val = mp_small_int_modulo(lhs_val, rhs_val);
414
415
                    break;
                }
416

Damien George's avatar
Damien George committed
417
418
                case MP_BINARY_OP_POWER:
                case MP_BINARY_OP_INPLACE_POWER:
419
                    if (rhs_val < 0) {
420
                        #if MICROPY_PY_BUILTINS_FLOAT
421
422
423
                        lhs = mp_obj_new_float(lhs_val);
                        goto generic_binary_op;
                        #else
424
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative power with no float support"));
425
426
                        #endif
                    } else {
427
                        mp_int_t ans = 1;
428
429
                        while (rhs_val > 0) {
                            if (rhs_val & 1) {
430
                                if (mp_small_int_mul_overflow(ans, lhs_val)) {
431
432
                                    goto power_overflow;
                                }
433
                                ans *= lhs_val;
434
435
436
                            }
                            if (rhs_val == 1) {
                                break;
437
438
                            }
                            rhs_val /= 2;
439
                            if (mp_small_int_mul_overflow(lhs_val, lhs_val)) {
440
441
                                goto power_overflow;
                            }
442
                            lhs_val *= lhs_val;
443
                        }
444
                        lhs_val = ans;
445
                    }
446
                    break;
447
448
449
450
451
452

                power_overflow:
                    // use higher precision
                    lhs = mp_obj_new_int_from_ll(MP_OBJ_SMALL_INT_VALUE(lhs));
                    goto generic_binary_op;

Damien George's avatar
Damien George committed
453
454
455
456
                case MP_BINARY_OP_LESS: return MP_BOOL(lhs_val < rhs_val); break;
                case MP_BINARY_OP_MORE: return MP_BOOL(lhs_val > rhs_val); break;
                case MP_BINARY_OP_LESS_EQUAL: return MP_BOOL(lhs_val <= rhs_val); break;
                case MP_BINARY_OP_MORE_EQUAL: return MP_BOOL(lhs_val >= rhs_val); break;
457

458
459
                default:
                    goto unsupported_op;
460
            }
461
            // TODO: We just should make mp_obj_new_int() inline and use that
462
            if (MP_SMALL_INT_FITS(lhs_val)) {
463
                return MP_OBJ_NEW_SMALL_INT(lhs_val);
464
465
            } else {
                return mp_obj_new_int(lhs_val);
466
            }
467
#if MICROPY_PY_BUILTINS_FLOAT
468
        } else if (MP_OBJ_IS_TYPE(rhs, &mp_type_float)) {
469
470
471
472
473
474
            mp_obj_t res = mp_obj_float_binary_op(op, lhs_val, rhs);
            if (res == MP_OBJ_NULL) {
                goto unsupported_op;
            } else {
                return res;
            }
475
#if MICROPY_PY_BUILTINS_COMPLEX
476
        } else if (MP_OBJ_IS_TYPE(rhs, &mp_type_complex)) {
477
478
479
480
481
482
            mp_obj_t res = mp_obj_complex_binary_op(op, lhs_val, 0, rhs);
            if (res == MP_OBJ_NULL) {
                goto unsupported_op;
            } else {
                return res;
            }
483
#endif
484
#endif
485
        }
486
    }
487

488
    /* deal with `in`
489
490
     *
     * NOTE `a in b` is `b.__contains__(a)`, hence why the generic dispatch
Damien George's avatar
Damien George committed
491
     * needs to go below with swapped arguments
492
     */
Damien George's avatar
Damien George committed
493
    if (op == MP_BINARY_OP_IN) {
494
495
496
        mp_obj_type_t *type = mp_obj_get_type(rhs);
        if (type->binary_op != NULL) {
            mp_obj_t res = type->binary_op(op, rhs, lhs);
497
            if (res != MP_OBJ_NULL) {
498
                return res;
John R. Lenton's avatar
John R. Lenton committed
499
            }
500
501
502
        }
        if (type->getiter != NULL) {
            /* second attempt, walk the iterator */
Damien George's avatar
Damien George committed
503
            mp_obj_t iter = mp_getiter(rhs);
504
            mp_obj_t next;
505
            while ((next = mp_iternext(iter)) != MP_OBJ_STOP_ITERATION) {
506
                if (mp_obj_equal(next, lhs)) {
507
                    return mp_const_true;
John R. Lenton's avatar
John R. Lenton committed
508
                }
509
            }
510
            return mp_const_false;
511
512
        }

513
514
515
516
517
518
519
        if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                "object not iterable"));
        } else {
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                "'%s' object is not iterable", mp_obj_get_type_str(rhs)));
        }
520
521
    }

522
    // generic binary_op supplied by type
523
524
525
    mp_obj_type_t *type;
generic_binary_op:
    type = mp_obj_get_type(lhs);
526
527
    if (type->binary_op != NULL) {
        mp_obj_t result = type->binary_op(op, lhs, rhs);
528
        if (result != MP_OBJ_NULL) {
529
            return result;
Damien's avatar
Damien committed
530
531
        }
    }
532

533
534
    // TODO implement dispatch for reverse binary ops

535
unsupported_op:
536
537
538
539
540
541
542
543
544
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
            "unsupported type for operator"));
    } else {
        // TODO specify in error message what the operator is
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
            "unsupported operand types for binary operator: '%s', '%s'",
            mp_obj_get_type_str(lhs), mp_obj_get_type_str(rhs)));
    }
545
546

zero_division:
547
    nlr_raise(mp_obj_new_exception_msg(&mp_type_ZeroDivisionError, "division by zero"));
Damien's avatar
Damien committed
548
549
}

Damien George's avatar
Damien George committed
550
551
mp_obj_t mp_call_function_0(mp_obj_t fun) {
    return mp_call_function_n_kw(fun, 0, 0, NULL);
552
553
}

Damien George's avatar
Damien George committed
554
555
mp_obj_t mp_call_function_1(mp_obj_t fun, mp_obj_t arg) {
    return mp_call_function_n_kw(fun, 1, 0, &arg);
556
557
}

Damien George's avatar
Damien George committed
558
mp_obj_t mp_call_function_2(mp_obj_t fun, mp_obj_t arg1, mp_obj_t arg2) {
559
    mp_obj_t args[2];
560
561
    args[0] = arg1;
    args[1] = arg2;
Damien George's avatar
Damien George committed
562
    return mp_call_function_n_kw(fun, 2, 0, args);
563
564
}

565
// args contains, eg: arg0  arg1  key0  value0  key1  value1
566
mp_obj_t mp_call_function_n_kw(mp_obj_t fun_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
567
568
    // TODO improve this: fun object can specify its type and we parse here the arguments,
    // passing to the function arrays of fixed and keyword arguments
569

570
    DEBUG_OP_printf("calling function %p(n_args=" UINT_FMT ", n_kw=" UINT_FMT ", args=%p)\n", fun_in, n_args, n_kw, args);
571

572
573
574
575
576
    // get the type
    mp_obj_type_t *type = mp_obj_get_type(fun_in);

    // do the call
    if (type->call != NULL) {
577
        return type->call(fun_in, n_args, n_kw, args);
578
    }
579

580
581
582
583
584
585
586
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
            "object not callable"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
            "'%s' object is not callable", mp_obj_get_type_str(fun_in)));
    }
587
588
}

589
590
// args contains: fun  self/NULL  arg(0)  ...  arg(n_args-2)  arg(n_args-1)  kw_key(0)  kw_val(0)  ... kw_key(n_kw-1)  kw_val(n_kw-1)
// if n_args==0 and n_kw==0 then there are only fun and self/NULL
591
mp_obj_t mp_call_method_n_kw(mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
592
    DEBUG_OP_printf("call method (fun=%p, self=%p, n_args=" UINT_FMT ", n_kw=" UINT_FMT ", args=%p)\n", args[0], args[1], n_args, n_kw, args);
593
    int adjust = (args[1] == NULL) ? 0 : 1;
Damien George's avatar
Damien George committed
594
    return mp_call_function_n_kw(args[0], n_args + adjust, n_kw, args + 2 - adjust);
595
596
}

597
mp_obj_t mp_call_method_n_kw_var(bool have_self, mp_uint_t n_args_n_kw, const mp_obj_t *args) {
598
599
600
601
602
603
604
    mp_obj_t fun = *args++;
    mp_obj_t self = MP_OBJ_NULL;
    if (have_self) {
        self = *args++; // may be MP_OBJ_NULL
    }
    uint n_args = n_args_n_kw & 0xff;
    uint n_kw = (n_args_n_kw >> 8) & 0xff;
605
606
    mp_obj_t pos_seq = args[n_args + 2 * n_kw]; // map be MP_OBJ_NULL
    mp_obj_t kw_dict = args[n_args + 2 * n_kw + 1]; // map be MP_OBJ_NULL
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639

    DEBUG_OP_printf("call method var (fun=%p, self=%p, n_args=%u, n_kw=%u, args=%p, seq=%p, dict=%p)\n", fun, self, n_args, n_kw, args, pos_seq, kw_dict);

    // We need to create the following array of objects:
    //     args[0 .. n_args]  unpacked(pos_seq)  args[n_args .. n_args + 2 * n_kw]  unpacked(kw_dict)
    // TODO: optimize one day to avoid constructing new arg array? Will be hard.

    // The new args array
    mp_obj_t *args2;
    uint args2_alloc;
    uint args2_len = 0;

    // Try to get a hint for the size of the kw_dict
    uint kw_dict_len = 0;
    if (kw_dict != MP_OBJ_NULL && MP_OBJ_IS_TYPE(kw_dict, &mp_type_dict)) {
        kw_dict_len = mp_obj_dict_len(kw_dict);
    }

    // Extract the pos_seq sequence to the new args array.
    // Note that it can be arbitrary iterator.
    if (pos_seq == MP_OBJ_NULL) {
        // no sequence

        // allocate memory for the new array of args
        args2_alloc = 1 + n_args + 2 * (n_kw + kw_dict_len);
        args2 = m_new(mp_obj_t, args2_alloc);

        // copy the self
        if (self != MP_OBJ_NULL) {
            args2[args2_len++] = self;
        }

        // copy the fixed pos args
640
        mp_seq_copy(args2 + args2_len, args, n_args, mp_obj_t);
641
642
643
644
645
646
        args2_len += n_args;

    } else if (MP_OBJ_IS_TYPE(pos_seq, &mp_type_tuple) || MP_OBJ_IS_TYPE(pos_seq, &mp_type_list)) {
        // optimise the case of a tuple and list

        // get the items
647
        mp_uint_t len;
648
649
650
651
652
653
654
655
656
657
658
659
660
        mp_obj_t *items;
        mp_obj_get_array(pos_seq, &len, &items);

        // allocate memory for the new array of args
        args2_alloc = 1 + n_args + len + 2 * (n_kw + kw_dict_len);
        args2 = m_new(mp_obj_t, args2_alloc);

        // copy the self
        if (self != MP_OBJ_NULL) {
            args2[args2_len++] = self;
        }

        // copy the fixed and variable position args
661
        mp_seq_cat(args2 + args2_len, args, n_args, items, len, mp_obj_t);
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
        args2_len += n_args + len;

    } else {
        // generic iterator

        // allocate memory for the new array of args
        args2_alloc = 1 + n_args + 2 * (n_kw + kw_dict_len) + 3;
        args2 = m_new(mp_obj_t, args2_alloc);

        // copy the self
        if (self != MP_OBJ_NULL) {
            args2[args2_len++] = self;
        }

        // copy the fixed position args
677
        mp_seq_copy(args2 + args2_len, args, n_args, mp_obj_t);
678
679
680
681

        // extract the variable position args from the iterator
        mp_obj_t iterable = mp_getiter(pos_seq);
        mp_obj_t item;
682
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
683
684
685
686
687
688
689
690
691
692
693
694
            if (args2_len >= args2_alloc) {
                args2 = m_renew(mp_obj_t, args2, args2_alloc, args2_alloc * 2);
                args2_alloc *= 2;
            }
            args2[args2_len++] = item;
        }
    }

    // The size of the args2 array now is the number of positional args.
    uint pos_args_len = args2_len;

    // Copy the fixed kw args.
695
    mp_seq_copy(args2 + args2_len, args + n_args, 2 * n_kw, mp_obj_t);
696
697
698
699
700
701
702
703
704
705
    args2_len += 2 * n_kw;

    // Extract (key,value) pairs from kw_dict dictionary and append to args2.
    // Note that it can be arbitrary iterator.
    if (kw_dict == MP_OBJ_NULL) {
        // pass
    } else if (MP_OBJ_IS_TYPE(kw_dict, &mp_type_dict)) {
        // dictionary
        mp_map_t *map = mp_obj_dict_get_map(kw_dict);
        assert(args2_len + 2 * map->used <= args2_alloc); // should have enough, since kw_dict_len is in this case hinted correctly above
706
707
        for (mp_uint_t i = 0; i < map->alloc; i++) {
            if (MP_MAP_SLOT_IS_FILLED(map, i)) {
708
709
710
711
712
713
714
715
716
717
718
                args2[args2_len++] = map->table[i].key;
                args2[args2_len++] = map->table[i].value;
            }
        }
    } else {
        // generic mapping
        // TODO is calling 'items' on the mapping the correct thing to do here?
        mp_obj_t dest[2];
        mp_load_method(kw_dict, MP_QSTR_items, dest);
        mp_obj_t iterable = mp_getiter(mp_call_method_n_kw(0, 0, dest));
        mp_obj_t item;
719
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
            if (args2_len + 1 >= args2_alloc) {
                uint new_alloc = args2_alloc * 2;
                if (new_alloc < 4) {
                    new_alloc = 4;
                }
                args2 = m_renew(mp_obj_t, args2, args2_alloc, new_alloc);
                args2_alloc = new_alloc;
            }
            mp_obj_t *items;
            mp_obj_get_array_fixed_n(item, 2, &items);
            args2[args2_len++] = items[0];
            args2[args2_len++] = items[1];
        }
    }

    mp_obj_t res = mp_call_function_n_kw(fun, pos_args_len, (args2_len - pos_args_len) / 2, args2);
    m_del(mp_obj_t, args2, args2_alloc);

    return res;
}

741
// unpacked items are stored in reverse order into the array pointed to by items
742
void mp_unpack_sequence(mp_obj_t seq_in, mp_uint_t num, mp_obj_t *items) {
743
    mp_uint_t seq_len;
744
    if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple) || MP_OBJ_IS_TYPE(seq_in, &mp_type_list)) {
745
        mp_obj_t *seq_items;
746
        if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple)) {
747
748
749
            mp_obj_tuple_get(seq_in, &seq_len, &seq_items);
        } else {
            mp_obj_list_get(seq_in, &seq_len, &seq_items);
750
        }
751
        if (seq_len < num) {
752
            goto too_short;
753
        } else if (seq_len > num) {
754
            goto too_long;
755
        }
756
        for (mp_uint_t i = 0; i < num; i++) {
757
758
            items[i] = seq_items[num - 1 - i];
        }
759
    } else {
Damien George's avatar
Damien George committed
760
        mp_obj_t iterable = mp_getiter(seq_in);
761
762

        for (seq_len = 0; seq_len < num; seq_len++) {
Damien George's avatar
Damien George committed
763
            mp_obj_t el = mp_iternext(iterable);
764
            if (el == MP_OBJ_STOP_ITERATION) {
765
766
767
768
                goto too_short;
            }
            items[num - 1 - seq_len] = el;
        }
769
        if (mp_iternext(iterable) != MP_OBJ_STOP_ITERATION) {
770
771
            goto too_long;
        }
772
    }
773
774
775
    return;

too_short:
776
777
778
779
780
781
782
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
            "wrong number of values to unpack"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
            "need more than %d values to unpack", seq_len));
    }
783
too_long:
784
785
786
787
788
789
790
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
            "wrong number of values to unpack"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
            "too many values to unpack (expected %d)", num));
    }
791
792
}

793
// unpacked items are stored in reverse order into the array pointed to by items
794
795
796
void mp_unpack_ex(mp_obj_t seq_in, mp_uint_t num_in, mp_obj_t *items) {
    mp_uint_t num_left = num_in & 0xff;
    mp_uint_t num_right = (num_in >> 8) & 0xff;
797
    DEBUG_OP_printf("unpack ex " UINT_FMT " " UINT_FMT "\n", num_left, num_right);
798
    mp_uint_t seq_len;
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
    if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple) || MP_OBJ_IS_TYPE(seq_in, &mp_type_list)) {
        mp_obj_t *seq_items;
        if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple)) {
            mp_obj_tuple_get(seq_in, &seq_len, &seq_items);
        } else {
            if (num_left == 0 && num_right == 0) {
                // *a, = b # sets a to b if b is a list
                items[0] = seq_in;
                return;
            }
            mp_obj_list_get(seq_in, &seq_len, &seq_items);
        }
        if (seq_len < num_left + num_right) {
            goto too_short;
        }
814
        for (mp_uint_t i = 0; i < num_right; i++) {
815
816
817
            items[i] = seq_items[seq_len - 1 - i];
        }
        items[num_right] = mp_obj_new_list(seq_len - num_left - num_right, seq_items + num_left);
818
        for (mp_uint_t i = 0; i < num_left; i++) {
819
820
821
822
823
824
825
826
827
828
829
            items[num_right + 1 + i] = seq_items[num_left - 1 - i];
        }
    } else {
        // Generic iterable; this gets a bit messy: we unpack known left length to the
        // items destination array, then the rest to a dynamically created list.  Once the
        // iterable is exhausted, we take from this list for the right part of the items.
        // TODO Improve to waste less memory in the dynamically created list.
        mp_obj_t iterable = mp_getiter(seq_in);
        mp_obj_t item;
        for (seq_len = 0; seq_len < num_left; seq_len++) {
            item = mp_iternext(iterable);
830
            if (item == MP_OBJ_STOP_ITERATION) {
831
832
833
834
                goto too_short;
            }
            items[num_left + num_right + 1 - 1 - seq_len] = item;
        }
835
        mp_obj_list_t *rest = mp_obj_new_list(0, NULL);
836
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
837
838
            mp_obj_list_append(rest, item);
        }
839
        if (rest->len < num_right) {
840
841
842
            goto too_short;
        }
        items[num_right] = rest;
843
        for (mp_uint_t i = 0; i < num_right; i++) {
844
            items[num_right - 1 - i] = rest->items[rest->len - num_right + i];
845
        }
846
        mp_obj_list_set_len(rest, rest->len - num_right);
847
848
849
850
    }
    return;

too_short:
851
852
853
854
855
856
857
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError,
            "wrong number of values to unpack"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
            "need more than %d values to unpack", seq_len));
    }
858
859
}

860
mp_obj_t mp_load_attr(mp_obj_t base, qstr attr) {
861
    DEBUG_OP_printf("load attr %p.%s\n", base, qstr_str(attr));
862
    // use load_method
863
    mp_obj_t dest[2];
864
865
    mp_load_method(base, attr, dest);
    if (dest[1] == MP_OBJ_NULL) {
866
        // load_method returned just a normal attribute
867
        return dest[0];
868
869
870
    } else {
        // load_method returned a method, so build a bound method object
        return mp_obj_new_bound_meth(dest[0], dest[1]);
Damien's avatar
Damien committed
871
872
873
    }
}

874
875
876
// no attribute found, returns:     dest[0] == MP_OBJ_NULL, dest[1] == MP_OBJ_NULL
// normal attribute found, returns: dest[0] == <attribute>, dest[1] == MP_OBJ_NULL
// method attribute found, returns: dest[0] == <method>,    dest[1] == <self>
Damien George's avatar
Damien George committed
877
void mp_load_method_maybe(mp_obj_t base, qstr attr, mp_obj_t *dest) {
878
879
880
881
882
883
884
    // clear output to indicate no attribute/method found yet
    dest[0] = MP_OBJ_NULL;
    dest[1] = MP_OBJ_NULL;

    // get the type
    mp_obj_type_t *type = mp_obj_get_type(base);

Damien George's avatar
Damien George committed
885
886
    // look for built-in names
    if (0) {
887
#if MICROPY_CPYTHON_COMPAT
Damien George's avatar
Damien George committed
888
889
890
    } else if (attr == MP_QSTR___class__) {
        // a.__class__ is equivalent to type(a)
        dest[0] = type;
891
#endif
Damien George's avatar
Damien George committed
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908

    } else if (attr == MP_QSTR___next__ && type->iternext != NULL) {
        dest[0] = (mp_obj_t)&mp_builtin_next_obj;
        dest[1] = base;

    } else if (type->load_attr != NULL) {
        // this type can do its own load, so call it
        type->load_attr(base, attr, dest);

    } else if (type->locals_dict != NULL) {
        // generic method lookup
        // this is a lookup in the object (ie not class or type)
        assert(MP_OBJ_IS_TYPE(type->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
        mp_map_t *locals_map = mp_obj_dict_get_map(type->locals_dict);
        mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP);
        if (elem != NULL) {
            // check if the methods are functions, static or class methods
909
            // see http://docs.python.org/3/howto/descriptor.html
Damien George's avatar
Damien George committed
910
911
912
913
914
915
916
            if (MP_OBJ_IS_TYPE(elem->value, &mp_type_staticmethod)) {
                // return just the function
                dest[0] = ((mp_obj_static_class_method_t*)elem->value)->fun;
            } else if (MP_OBJ_IS_TYPE(elem->value, &mp_type_classmethod)) {
                // return a bound method, with self being the type of this object
                dest[0] = ((mp_obj_static_class_method_t*)elem->value)->fun;
                dest[1] = mp_obj_get_type(base);
917
918
919
            } else if (MP_OBJ_IS_TYPE(elem->value, &mp_type_type)) {
                // Don't try to bind types
                dest[0] = elem->value;
Damien George's avatar
Damien George committed
920
921
922
923
924
925
926
            } else if (mp_obj_is_callable(elem->value)) {
                // return a bound method, with self being this object
                dest[0] = elem->value;
                dest[1] = base;
            } else {
                // class member is a value, so just return that value
                dest[0] = elem->value;
Damien's avatar
Damien committed
927
928
            }
        }
929
    }
930
931
}

Damien George's avatar
Damien George committed
932
void mp_load_method(mp_obj_t base, qstr attr, mp_obj_t *dest) {
933
934
    DEBUG_OP_printf("load method %p.%s\n", base, qstr_str(attr));

Damien George's avatar
Damien George committed
935
    mp_load_method_maybe(base, attr, dest);
936

937
    if (dest[0] == MP_OBJ_NULL) {
938
        // no attribute/method called attr
939
940
941
        if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_AttributeError,
                "no such attribute"));
942
        } else {
943
944
945
946
947
948
949
950
951
952
            // following CPython, we give a more detailed error message for type objects
            if (MP_OBJ_IS_TYPE(base, &mp_type_type)) {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_AttributeError,
                    "type object '%s' has no attribute '%s'",
                    qstr_str(((mp_obj_type_t*)base)->name), qstr_str(attr)));
            } else {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_AttributeError,
                    "'%s' object has no attribute '%s'",
                    mp_obj_get_type_str(base), qstr_str(attr)));
            }
953
954
        }
    }
955
956
}

Damien George's avatar
Damien George committed
957
void mp_store_attr(mp_obj_t base, qstr attr, mp_obj_t value) {
Damien's avatar
Damien committed
958
    DEBUG_OP_printf("store attr %p.%s <- %p\n", base, qstr_str(attr), value);
959
960
961
962
963
    mp_obj_type_t *type = mp_obj_get_type(base);
    if (type->store_attr != NULL) {
        if (type->store_attr(base, attr, value)) {
            return;
        }
964
    }
965
966
967
968
969
970
971
972
    if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_AttributeError,
            "no such attribute"));
    } else {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_AttributeError,
            "'%s' object has no attribute '%s'",
            mp_obj_get_type_str(base), qstr_str(attr)));
    }
973
974
}

Damien George's avatar
Damien George committed
975
mp_obj_t mp_getiter(mp_obj_t o_in) {
976
    assert(o_in);
977
978
    mp_obj_type_t *type = mp_obj_get_type(o_in);
    if (type->getiter != NULL) {
979
980
981
982
983
        mp_obj_t iter = type->getiter(o_in);
        if (iter == MP_OBJ_NULL) {
            goto not_iterable;
        }
        return iter;
984
    } else {
985
        // check for __iter__ method
986
        mp_obj_t dest[2];
Damien George's avatar
Damien George committed
987
        mp_load_method_maybe(o_in, MP_QSTR___iter__, dest);
988