runtime.c 42.8 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 "mpconfig.h"
32
#include "nlr.h"
Damien's avatar
Damien committed
33
#include "misc.h"
34
#include "qstr.h"
35
#include "obj.h"
36
#include "objtuple.h"
37
#include "objmodule.h"
38
#include "parsenum.h"
39
#include "runtime0.h"
Damien's avatar
Damien committed
40
#include "runtime.h"
41
#include "emitglue.h"
42
#include "builtin.h"
43
#include "builtintables.h"
44
#include "bc.h"
45
#include "smallint.h"
46
#include "objgenerator.h"
47
#include "lexer.h"
48
#include "stackctrl.h"
49

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

59
// locals and globals need to be pointers because they can be the same in outer module scope
60
61
STATIC mp_obj_dict_t *dict_locals;
STATIC mp_obj_dict_t *dict_globals;
62

63
// dictionary for the __main__ module
64
STATIC mp_obj_dict_t dict_main;
65
66
67
68

const mp_obj_module_t mp_module___main__ = {
    .base = { &mp_type_module },
    .name = MP_QSTR___main__,
69
    .globals = (mp_obj_dict_t*)&dict_main,
70
71
};

Damien George's avatar
Damien George committed
72
void mp_init(void) {
73
    qstr_init();
Paul Sokolovsky's avatar
Paul Sokolovsky committed
74
    mp_stack_ctrl_init();
75

76
77
78
79
#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
    mp_init_emergency_exception_buf();
#endif

80
    // call port specific initialization if any
81
82
83
84
#ifdef MICROPY_PORT_INIT_FUNC
    MICROPY_PORT_INIT_FUNC;
#endif

85
86
    // optimization disabled by default
    mp_optimise_value = 0;
87

88
89
    // init global module stuff
    mp_module_init();
90

91
    // initialise the __main__ module
92
93
    mp_obj_dict_init(&dict_main, 1);
    mp_obj_dict_store(&dict_main, MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR___main__));
94
95

    // locals = globals for outer module (see Objects/frameobject.c/PyFrame_New())
96
    dict_locals = dict_globals = &dict_main;
Damien's avatar
Damien committed
97
98
}

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

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

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

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

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

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

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

Damien George's avatar
Damien George committed
148
mp_obj_t mp_load_global(qstr qstr) {
149
150
    // logic: search globals, builtins
    DEBUG_OP_printf("load global %s\n", qstr_str(qstr));
151
    mp_map_elem_t *elem = mp_map_lookup(&dict_globals->map, MP_OBJ_NEW_QSTR(qstr), MP_MAP_LOOKUP);
152
    if (elem == NULL) {
153
154
        // TODO lookup in dynamic table of builtins first
        elem = mp_map_lookup((mp_map_t*)&mp_builtin_object_dict_obj.map, MP_OBJ_NEW_QSTR(qstr), MP_MAP_LOOKUP);
155
        if (elem == NULL) {
156
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_NameError, "name '%s' is not defined", qstr_str(qstr)));
157
158
159
        }
    }
    return elem->value;
Damien's avatar
Damien committed
160
161
}

Damien George's avatar
Damien George committed
162
mp_obj_t mp_load_build_class(void) {
Damien's avatar
Damien committed
163
    DEBUG_OP_printf("load_build_class\n");
164
165
166
    // TODO lookup __build_class__ in dynamic table of builtins first
    // ... else no user-defined __build_class__, return builtin one
    return (mp_obj_t)&mp_builtin___build_class___obj;
Damien's avatar
Damien committed
167
168
}

Damien George's avatar
Damien George committed
169
void mp_store_name(qstr qstr, mp_obj_t obj) {
170
    DEBUG_OP_printf("store name %s <- %p\n", qstr_str(qstr), obj);
171
    mp_obj_dict_store(dict_locals, MP_OBJ_NEW_QSTR(qstr), obj);
172
173
}

Damien George's avatar
Damien George committed
174
void mp_delete_name(qstr qstr) {
175
    DEBUG_OP_printf("delete name %s\n", qstr_str(qstr));
176
177
    // TODO convert KeyError to NameError if qstr not found
    mp_obj_dict_delete(dict_locals, MP_OBJ_NEW_QSTR(qstr));
178
179
}

Damien George's avatar
Damien George committed
180
void mp_store_global(qstr qstr, mp_obj_t obj) {
181
    DEBUG_OP_printf("store global %s <- %p\n", qstr_str(qstr), obj);
182
    mp_obj_dict_store(dict_globals, MP_OBJ_NEW_QSTR(qstr), obj);
Damien's avatar
Damien committed
183
184
}

185
186
187
188
189
190
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
    mp_obj_dict_delete(dict_globals, MP_OBJ_NEW_QSTR(qstr));
}

Damien George's avatar
Damien George committed
191
mp_obj_t mp_unary_op(int op, mp_obj_t arg) {
Damien's avatar
Damien committed
192
    DEBUG_OP_printf("unary %d %p\n", op, arg);
193

194
    if (MP_OBJ_IS_SMALL_INT(arg)) {
195
        mp_int_t val = MP_OBJ_SMALL_INT_VALUE(arg);
Damien's avatar
Damien committed
196
        switch (op) {
Damien George's avatar
Damien George committed
197
            case MP_UNARY_OP_BOOL:
198
                return MP_BOOL(val != 0);
Damien George's avatar
Damien George committed
199
            case MP_UNARY_OP_POSITIVE:
200
                return arg;
Damien George's avatar
Damien George committed
201
            case MP_UNARY_OP_NEGATIVE:
202
203
204
205
206
207
                // 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
208
            case MP_UNARY_OP_INVERT:
209
210
211
212
                return MP_OBJ_NEW_SMALL_INT(~val);
            default:
                assert(0);
                return arg;
213
        }
214
215
216
217
    } 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);
218
            if (result != MP_OBJ_NULL) {
219
220
                return result;
            }
Damien's avatar
Damien committed
221
        }
222
        // TODO specify in error message what the operator is
223
        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
224
    }
Damien's avatar
Damien committed
225
226
}

Damien George's avatar
Damien George committed
227
mp_obj_t mp_binary_op(int op, mp_obj_t lhs, mp_obj_t rhs) {
Damien's avatar
Damien committed
228
    DEBUG_OP_printf("binary %d %p %p\n", op, lhs, rhs);
229
230
231
232
233
234
235
236
237
238

    // 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 +=

239
    // deal with is
Damien George's avatar
Damien George committed
240
    if (op == MP_BINARY_OP_IS) {
241
242
243
        return MP_BOOL(lhs == rhs);
    }

244
    // deal with == and != for all types
Damien George's avatar
Damien George committed
245
    if (op == MP_BINARY_OP_EQUAL || op == MP_BINARY_OP_NOT_EQUAL) {
246
        if (mp_obj_equal(lhs, rhs)) {
Damien George's avatar
Damien George committed
247
            if (op == MP_BINARY_OP_EQUAL) {
248
249
250
251
252
                return mp_const_true;
            } else {
                return mp_const_false;
            }
        } else {
Damien George's avatar
Damien George committed
253
            if (op == MP_BINARY_OP_EQUAL) {
254
255
256
257
258
259
260
261
                return mp_const_false;
            } else {
                return mp_const_true;
            }
        }
    }

    // deal with exception_match for all types
Damien George's avatar
Damien George committed
262
    if (op == MP_BINARY_OP_EXCEPTION_MATCH) {
263
264
265
266
267
268
        // rhs must be issubclass(rhs, BaseException)
        if (mp_obj_is_exception_type(rhs)) {
            // if lhs is an instance of an exception, then extract and use its type
            if (mp_obj_is_exception_instance(lhs)) {
                lhs = mp_obj_get_type(lhs);
            }
269
            if (mp_obj_is_subclass_fast(lhs, rhs)) {
270
271
272
273
274
                return mp_const_true;
            } else {
                return mp_const_false;
            }
        }
275
276
        assert(0);
        return mp_const_false;
277
278
    }

279
    if (MP_OBJ_IS_SMALL_INT(lhs)) {
280
        mp_int_t lhs_val = MP_OBJ_SMALL_INT_VALUE(lhs);
281
        if (MP_OBJ_IS_SMALL_INT(rhs)) {
282
            mp_int_t rhs_val = MP_OBJ_SMALL_INT_VALUE(rhs);
283
284
285
            // 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:
286
287
            //      +       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
288
            //      *       checked explicitly
289
290
            //      /       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
291
            //      <<      checked explicitly
292
            switch (op) {
Damien George's avatar
Damien George committed
293
294
295
296
297
298
299
300
                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: {
301
302
                    if (rhs_val < 0) {
                        // negative shift not allowed
303
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative shift count"));
304
305
306
307
308
309
310
311
312
313
                    } 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
314
315
                case MP_BINARY_OP_RSHIFT:
                case MP_BINARY_OP_INPLACE_RSHIFT:
316
317
                    if (rhs_val < 0) {
                        // negative shift not allowed
318
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative shift count"));
319
320
321
322
323
                    } else {
                        // standard precision is enough for right-shift
                        lhs_val >>= rhs_val;
                    }
                    break;
Damien George's avatar
Damien George committed
324
325
326
327
328
329
                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: {
330

331
                    // If long long type exists and is larger than mp_int_t, then
332
                    // we can use the following code to perform overflow-checked multiplication.
333
                    // Otherwise (eg in x64 case) we must use mp_small_int_mul_overflow.
334
335
336
337
338
339
340
341
                    #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
342
                        lhs_val = (mp_int_t)res;
343
344
345
                    }
                    #endif

346
347
348
349
350
351
352
353
                    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);
                    }
354
355
                    break;
                }
Damien George's avatar
Damien George committed
356
357
                case MP_BINARY_OP_FLOOR_DIVIDE:
                case MP_BINARY_OP_INPLACE_FLOOR_DIVIDE:
358
359
360
                    if (rhs_val == 0) {
                        goto zero_division;
                    }
361
                    lhs_val = mp_small_int_floor_divide(lhs_val, rhs_val);
362
                    break;
363

364
                #if MICROPY_PY_BUILTINS_FLOAT
Damien George's avatar
Damien George committed
365
                case MP_BINARY_OP_TRUE_DIVIDE:
366
367
                case MP_BINARY_OP_INPLACE_TRUE_DIVIDE:
                    if (rhs_val == 0) {
368
                        goto zero_division;
369
370
                    }
                    return mp_obj_new_float((mp_float_t)lhs_val / (mp_float_t)rhs_val);
371
                #endif
372

Damien George's avatar
Damien George committed
373
                case MP_BINARY_OP_MODULO:
374
375
                case MP_BINARY_OP_INPLACE_MODULO: {
                    lhs_val = mp_small_int_modulo(lhs_val, rhs_val);
376
377
                    break;
                }
378

Damien George's avatar
Damien George committed
379
380
                case MP_BINARY_OP_POWER:
                case MP_BINARY_OP_INPLACE_POWER:
381
                    if (rhs_val < 0) {
382
                        #if MICROPY_PY_BUILTINS_FLOAT
383
384
385
                        lhs = mp_obj_new_float(lhs_val);
                        goto generic_binary_op;
                        #else
386
                        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "negative power with no float support"));
387
388
                        #endif
                    } else {
389
                        mp_int_t ans = 1;
390
391
                        while (rhs_val > 0) {
                            if (rhs_val & 1) {
392
                                if (mp_small_int_mul_overflow(ans, lhs_val)) {
393
394
                                    goto power_overflow;
                                }
395
                                ans *= lhs_val;
396
397
398
                            }
                            if (rhs_val == 1) {
                                break;
399
400
                            }
                            rhs_val /= 2;
401
                            if (mp_small_int_mul_overflow(lhs_val, lhs_val)) {
402
403
                                goto power_overflow;
                            }
404
                            lhs_val *= lhs_val;
405
                        }
406
                        lhs_val = ans;
407
                    }
408
                    break;
409
410
411
412
413
414

                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
415
416
417
418
                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;
419

420
421
                default:
                    goto unsupported_op;
422
            }
423
            // TODO: We just should make mp_obj_new_int() inline and use that
424
            if (MP_SMALL_INT_FITS(lhs_val)) {
425
                return MP_OBJ_NEW_SMALL_INT(lhs_val);
426
427
            } else {
                return mp_obj_new_int(lhs_val);
428
            }
429
#if MICROPY_PY_BUILTINS_FLOAT
430
        } else if (MP_OBJ_IS_TYPE(rhs, &mp_type_float)) {
431
432
433
434
435
436
            mp_obj_t res = mp_obj_float_binary_op(op, lhs_val, rhs);
            if (res == MP_OBJ_NULL) {
                goto unsupported_op;
            } else {
                return res;
            }
437
#if MICROPY_PY_BUILTINS_COMPLEX
438
        } else if (MP_OBJ_IS_TYPE(rhs, &mp_type_complex)) {
439
440
441
442
443
444
            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;
            }
445
#endif
446
#endif
447
        }
448
    }
449

450
    /* deal with `in`
451
452
     *
     * NOTE `a in b` is `b.__contains__(a)`, hence why the generic dispatch
Damien George's avatar
Damien George committed
453
     * needs to go below with swapped arguments
454
     */
Damien George's avatar
Damien George committed
455
    if (op == MP_BINARY_OP_IN) {
456
457
458
        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);
459
            if (res != MP_OBJ_NULL) {
460
                return res;
John R. Lenton's avatar
John R. Lenton committed
461
            }
462
463
464
465
        }
        if (type->getiter != NULL) {
            /* second attempt, walk the iterator */
            mp_obj_t next = NULL;
Damien George's avatar
Damien George committed
466
            mp_obj_t iter = mp_getiter(rhs);
467
            while ((next = mp_iternext(iter)) != MP_OBJ_STOP_ITERATION) {
468
                if (mp_obj_equal(next, lhs)) {
469
                    return mp_const_true;
John R. Lenton's avatar
John R. Lenton committed
470
                }
471
            }
472
            return mp_const_false;
473
474
        }

475
        nlr_raise(mp_obj_new_exception_msg_varg(
476
                     &mp_type_TypeError, "'%s' object is not iterable",
477
478
479
480
                     mp_obj_get_type_str(rhs)));
        return mp_const_none;
    }

481
    // generic binary_op supplied by type
482
483
484
    mp_obj_type_t *type;
generic_binary_op:
    type = mp_obj_get_type(lhs);
485
486
    if (type->binary_op != NULL) {
        mp_obj_t result = type->binary_op(op, lhs, rhs);
487
        if (result != MP_OBJ_NULL) {
488
            return result;
Damien's avatar
Damien committed
489
490
        }
    }
491

492
493
    // TODO implement dispatch for reverse binary ops

John R. Lenton's avatar
John R. Lenton committed
494
    // TODO specify in error message what the operator is
495
unsupported_op:
496
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
John R. Lenton's avatar
John R. Lenton committed
497
498
        "unsupported operand types for binary operator: '%s', '%s'",
        mp_obj_get_type_str(lhs), mp_obj_get_type_str(rhs)));
499
    return mp_const_none;
500
501

zero_division:
502
    nlr_raise(mp_obj_new_exception_msg(&mp_type_ZeroDivisionError, "division by zero"));
Damien's avatar
Damien committed
503
504
}

Damien George's avatar
Damien George committed
505
506
mp_obj_t mp_call_function_0(mp_obj_t fun) {
    return mp_call_function_n_kw(fun, 0, 0, NULL);
507
508
}

Damien George's avatar
Damien George committed
509
510
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);
511
512
}

Damien George's avatar
Damien George committed
513
mp_obj_t mp_call_function_2(mp_obj_t fun, mp_obj_t arg1, mp_obj_t arg2) {
514
    mp_obj_t args[2];
515
516
    args[0] = arg1;
    args[1] = arg2;
Damien George's avatar
Damien George committed
517
    return mp_call_function_n_kw(fun, 2, 0, args);
518
519
}

520
// args contains, eg: arg0  arg1  key0  value0  key1  value1
Damien George's avatar
Damien George committed
521
mp_obj_t mp_call_function_n_kw(mp_obj_t fun_in, uint n_args, uint n_kw, const mp_obj_t *args) {
522
523
    // 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
524

525
526
    DEBUG_OP_printf("calling function %p(n_args=%d, n_kw=%d, args=%p)\n", fun_in, n_args, n_kw, args);

527
528
529
530
531
    // get the type
    mp_obj_type_t *type = mp_obj_get_type(fun_in);

    // do the call
    if (type->call != NULL) {
532
        return type->call(fun_in, n_args, n_kw, args);
533
    }
534
535

    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "'%s' object is not callable", mp_obj_get_type_str(fun_in)));
536
537
}

538
539
// 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
Damien George's avatar
Damien George committed
540
mp_obj_t mp_call_method_n_kw(uint n_args, uint n_kw, const mp_obj_t *args) {
541
542
    DEBUG_OP_printf("call method (fun=%p, self=%p, n_args=%u, n_kw=%u, args=%p)\n", args[0], args[1], n_args, n_kw, args);
    int adjust = (args[1] == NULL) ? 0 : 1;
Damien George's avatar
Damien George committed
543
    return mp_call_function_n_kw(args[0], n_args + adjust, n_kw, args + 2 - adjust);
544
545
}

546
mp_obj_t mp_call_method_n_kw_var(bool have_self, uint n_args_n_kw, const mp_obj_t *args) {
547
548
549
550
551
552
553
    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;
554
555
    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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588

    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
589
        mp_seq_copy(args2 + args2_len, args, n_args, mp_obj_t);
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
        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
        uint len;
        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
610
        mp_seq_cat(args2 + args2_len, args, n_args, items, len, mp_obj_t);
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
        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
626
        mp_seq_copy(args2 + args2_len, args, n_args, mp_obj_t);
627
628
629
630

        // extract the variable position args from the iterator
        mp_obj_t iterable = mp_getiter(pos_seq);
        mp_obj_t item;
631
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
632
633
634
635
636
637
638
639
640
641
642
643
            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.
644
    mp_seq_copy(args2 + args2_len, args + n_args, 2 * n_kw, mp_obj_t);
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
    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
        for (uint i = 0; i < map->alloc; i++) {
            if (map->table[i].key != MP_OBJ_NULL) {
                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;
668
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
            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;
}

690
// unpacked items are stored in reverse order into the array pointed to by items
Damien George's avatar
Damien George committed
691
void mp_unpack_sequence(mp_obj_t seq_in, uint num, mp_obj_t *items) {
692
    uint seq_len;
693
    if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple) || MP_OBJ_IS_TYPE(seq_in, &mp_type_list)) {
694
        mp_obj_t *seq_items;
695
        if (MP_OBJ_IS_TYPE(seq_in, &mp_type_tuple)) {
696
697
698
            mp_obj_tuple_get(seq_in, &seq_len, &seq_items);
        } else {
            mp_obj_list_get(seq_in, &seq_len, &seq_items);
699
        }
700
        if (seq_len < num) {
701
            goto too_short;
702
        } else if (seq_len > num) {
703
            goto too_long;
704
        }
705
706
707
        for (uint i = 0; i < num; i++) {
            items[i] = seq_items[num - 1 - i];
        }
708
    } else {
Damien George's avatar
Damien George committed
709
        mp_obj_t iterable = mp_getiter(seq_in);
710
711

        for (seq_len = 0; seq_len < num; seq_len++) {
Damien George's avatar
Damien George committed
712
            mp_obj_t el = mp_iternext(iterable);
713
            if (el == MP_OBJ_STOP_ITERATION) {
714
715
716
717
                goto too_short;
            }
            items[num - 1 - seq_len] = el;
        }
718
        if (mp_iternext(iterable) != MP_OBJ_STOP_ITERATION) {
719
720
            goto too_long;
        }
721
    }
722
723
724
    return;

too_short:
725
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "need more than %d values to unpack", seq_len));
726
too_long:
727
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "too many values to unpack (expected %d)", num));
728
729
}

730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
// unpacked items are stored in reverse order into the array pointed to by items
void mp_unpack_ex(mp_obj_t seq_in, uint num_in, mp_obj_t *items) {
    uint num_left = num_in & 0xff;
    uint num_right = (num_in >> 8) & 0xff;
    DEBUG_OP_printf("unpack ex %d %d\n", num_left, num_right);
    uint seq_len;
    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;
        }
        for (uint i = 0; i < num_right; i++) {
            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);
        for (uint i = 0; i < num_left; i++) {
            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);
767
            if (item == MP_OBJ_STOP_ITERATION) {
768
769
770
771
772
                goto too_short;
            }
            items[num_left + num_right + 1 - 1 - seq_len] = item;
        }
        mp_obj_t rest = mp_obj_new_list(0, NULL);
773
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
            mp_obj_list_append(rest, item);
        }
        uint rest_len;
        mp_obj_t *rest_items;
        mp_obj_list_get(rest, &rest_len, &rest_items);
        if (rest_len < num_right) {
            goto too_short;
        }
        items[num_right] = rest;
        for (uint i = 0; i < num_right; i++) {
            items[num_right - 1 - i] = rest_items[rest_len - num_right + i];
        }
        mp_obj_list_set_len(rest, rest_len - num_right);
    }
    return;

too_short:
    nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "need more than %d values to unpack", seq_len));
}

794
mp_obj_t mp_load_attr(mp_obj_t base, qstr attr) {
795
    DEBUG_OP_printf("load attr %p.%s\n", base, qstr_str(attr));
796
    // use load_method
797
    mp_obj_t dest[2];
798
799
    mp_load_method(base, attr, dest);
    if (dest[1] == MP_OBJ_NULL) {
800
        // load_method returned just a normal attribute
801
        return dest[0];
802
803
804
    } 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
805
806
807
    }
}

808
809
810
// 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
811
void mp_load_method_maybe(mp_obj_t base, qstr attr, mp_obj_t *dest) {
812
813
814
815
816
817
818
    // 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
819
820
    // look for built-in names
    if (0) {
821
#if MICROPY_CPYTHON_COMPAT
Damien George's avatar
Damien George committed
822
823
824
    } else if (attr == MP_QSTR___class__) {
        // a.__class__ is equivalent to type(a)
        dest[0] = type;
825
#endif
Damien George's avatar
Damien George committed
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842

    } 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
843
            // see http://docs.python.org/3/howto/descriptor.html
Damien George's avatar
Damien George committed
844
845
846
847
848
849
850
            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);
851
852
853
            } 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
854
855
856
857
858
859
860
            } 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
861
862
            }
        }
863
    }
864
865
}

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

Damien George's avatar
Damien George committed
869
    mp_load_method_maybe(base, attr, dest);
870

871
    if (dest[0] == MP_OBJ_NULL) {
872
873
        // no attribute/method called attr
        // following CPython, we give a more detailed error message for type objects
874
        if (MP_OBJ_IS_TYPE(base, &mp_type_type)) {
875
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_AttributeError,
876
                "type object '%s' has no attribute '%s'", qstr_str(((mp_obj_type_t*)base)->name), qstr_str(attr)));
877
        } else {
878
            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)));
879
880
        }
    }
881
882
}

Damien George's avatar
Damien George committed
883
void mp_store_attr(mp_obj_t base, qstr attr, mp_obj_t value) {
Damien's avatar
Damien committed
884
    DEBUG_OP_printf("store attr %p.%s <- %p\n", base, qstr_str(attr), value);
885
886
887
888
889
    mp_obj_type_t *type = mp_obj_get_type(base);
    if (type->store_attr != NULL) {
        if (type->store_attr(base, attr, value)) {
            return;
        }
890
    }
891
    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)));
892
893
}

Damien George's avatar
Damien George committed
894
mp_obj_t mp_getiter(mp_obj_t o_in) {
895
    assert(o_in);
896
897
    mp_obj_type_t *type = mp_obj_get_type(o_in);
    if (type->getiter != NULL) {
898
899
900
901
902
        mp_obj_t iter = type->getiter(o_in);
        if (iter == MP_OBJ_NULL) {
            goto not_iterable;
        }
        return iter;
903
    } else {
904
        // check for __iter__ method
905
        mp_obj_t dest[2];
Damien George's avatar
Damien George committed
906
        mp_load_method_maybe(o_in, MP_QSTR___iter__, dest);
907
        if (dest[0] != MP_OBJ_NULL) {
908
            // __iter__ exists, call it and return its result
Damien George's avatar
Damien George committed
909
            return mp_call_method_n_kw(0, 0, dest);
910
        } else {
Damien George's avatar
Damien George committed
911
            mp_load_method_maybe(o_in, MP_QSTR___getitem__, dest);
912
913
914
915
916
            if (dest[0] != MP_OBJ_NULL) {
                // __getitem__ exists, create an iterator
                return mp_obj_new_getitem_iter(dest);
            } else {
                // object not iterable
917
not_iterable:
918
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "'%s' object is not iterable", mp_obj_get_type_str(o_in)));
919
            }
920
        }
921
922
    }
}
923

924
// may return MP_OBJ_STOP_ITERATION as an optimisation instead of raise StopIteration()
925
// may also raise StopIteration()
Damien George's avatar
Damien George committed
926
mp_obj_t mp_iternext_allow_raise(mp_obj_t o_in) {
927
928
929
    mp_obj_type_t *type = mp_obj_get_type(o_in);
    if (type->iternext != NULL) {
        return type->iternext(o_in);
930
    } else {
931
932
        // check for __next__ method
        mp_obj_t dest[2];
Damien George's avatar
Damien George committed
933
        mp_load_method_maybe(o_in, MP_QSTR___next__, dest);
934
935
        if (dest[0] != MP_OBJ_NULL) {
            // __next__ exists, call it and return its result
Damien George's avatar
Damien George committed
936
            return mp_call_method_n_kw(0, 0, dest);
937
        } else {
938
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "'%s' object is not an iterator", mp_obj_get_type_str(o_in)));
939
        }
940
941
942
    }
}

943
// will always return MP_OBJ_STOP_ITERATION instead of raising StopIteration() (or any subclass thereof)
944
// may raise other exceptions
Damien George's avatar
Damien George committed
945
mp_obj_t mp_iternext(mp_obj_t o_in) {
946
947
948
949
950
951
    mp_obj_type_t *type = mp_obj_get_type(o_in);
    if (type->iternext != NULL) {
        return type->iternext(o_in);
    } else {
        // check for __next__ method
        mp_obj_t dest[2];
Damien George's avatar
Damien George committed
952
        mp_load_method_maybe(o_in, MP_QSTR___next__, dest);
953
954
955
956
        if (dest[0] != MP_OBJ_NULL) {
            // __next__ exists, call it and return its result
            nlr_buf_t nlr;
            if (nlr_push(&nlr) == 0) {
Damien George's avatar
Damien George committed
957
                mp_obj_t ret = mp_call_method_n_kw(0, 0, dest);
958
959
960
961
                nlr_pop();
                return ret;
            } else {
                if (mp_obj_is_subclass_fast(mp_obj_get_type(nlr.ret_val), &mp_type_StopIteration)) {
962
                    return MP_OBJ_STOP_ITERATION;