objtype.c 34.7 KB
Newer Older
1
2
3
4
5
6
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
7
 * Copyright (c) 2014 Paul Sokolovsky
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 *
 * 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.
 */

28
29
#include <stdio.h>
#include <stddef.h>
30
31
#include <string.h>
#include <assert.h>
32

33
#include "mpconfig.h"
34
35
#include "nlr.h"
#include "misc.h"
36
#include "qstr.h"
37
#include "obj.h"
38
#include "runtime0.h"
39
#include "runtime.h"
40
#include "objtype.h"
41

42
43
44
45
46
47
48
#if 0 // print debugging info
#define DEBUG_PRINT (1)
#define DEBUG_printf DEBUG_printf
#else // don't print debugging info
#define DEBUG_printf(...) (void)0
#endif

49
/******************************************************************************/
50
// instance object
51

52
#define is_instance_type(type) ((type)->make_new == instance_make_new)
53
#define is_native_type(type) ((type)->make_new != instance_make_new)
54
mp_obj_t instance_make_new(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args);
55
STATIC void instance_convert_return_attr(mp_obj_t self, const mp_obj_type_t *type, mp_obj_t member, mp_obj_t *dest);
56

57
STATIC mp_obj_t mp_obj_new_instance(mp_obj_t class, uint subobjs) {
58
    mp_obj_instance_t *o = m_new_obj_var(mp_obj_instance_t, mp_obj_t, subobjs);
59
60
    o->base.type = class;
    mp_map_init(&o->members, 0);
61
    mp_seq_clear(o->subobj, 0, subobjs, sizeof(*o->subobj));
62
63
64
    return o;
}

65
STATIC int instance_count_native_bases(const mp_obj_type_t *type, const mp_obj_type_t **last_native_base) {
66
67
68
69
70
71
72
    uint len;
    mp_obj_t *items;
    mp_obj_tuple_get(type->bases_tuple, &len, &items);

    int count = 0;
    for (uint i = 0; i < len; i++) {
        assert(MP_OBJ_IS_TYPE(items[i], &mp_type_type));
73
74
75
76
77
78
        const mp_obj_type_t *bt = (const mp_obj_type_t *)items[i];
        if (bt == &mp_type_object) {
            // Not a "real" type
            continue;
        }
        if (is_native_type(bt)) {
79
80
81
            *last_native_base = items[i];
            count++;
        } else {
82
            count += instance_count_native_bases(items[i], last_native_base);
83
84
85
86
87
88
89
90
91
92
93
        }
    }

    return count;
}

// TODO
// This implements depth-first left-to-right MRO, which is not compliant with Python3 MRO
// http://python-history.blogspot.com/2010/06/method-resolution-order.html
// https://www.python.org/download/releases/2.3/mro/
//
94
// will return MP_OBJ_NULL if not found
95
96
97
98
99
// will return MP_OBJ_SENTINEL if special method was found in a native type base
// via slot id (meth_offset). As there can be only one native base, it's known that it
// applies to instance->subobj[0]. In most cases, we also don't need to know which type
// it was - because instance->subobj[0] is of that type. The only exception is when
// object is not yet constructed, then we need to know base native type to construct
100
// instance->subobj[0]. This case is handled via instance_count_native_bases() though.
101
102
103
104
105
struct class_lookup_data {
    mp_obj_instance_t *obj;
    qstr attr;
    machine_uint_t meth_offset;
    mp_obj_t *dest;
106
    bool is_type;
107
108
109
110
111
};

STATIC void mp_obj_class_lookup(struct class_lookup_data  *lookup, const mp_obj_type_t *type) {
    assert(lookup->dest[0] == NULL);
    assert(lookup->dest[1] == NULL);
112
    for (;;) {
113
114
115
116
        // Optimize special method lookup for native types
        // This avoids extra method_name => slot lookup. On the other hand,
        // this should not be applied to class types, as will result in extra
        // lookup either.
117
118
119
120
        if (lookup->meth_offset != 0 && is_native_type(type)) {
            if (*(void**)((char*)type + lookup->meth_offset) != NULL) {
                DEBUG_printf("mp_obj_class_lookup: matched special meth slot for %s\n", qstr_str(lookup->attr));
                lookup->dest[0] = MP_OBJ_SENTINEL;
121
                return;
122
123
124
            }
        }

125
        if (type->locals_dict != NULL) {
126
            // search locals_dict (the set of methods/attributes)
127
            assert(MP_OBJ_IS_TYPE(type->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
128
            mp_map_t *locals_map = mp_obj_dict_get_map(type->locals_dict);
129
            mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(lookup->attr), MP_MAP_LOOKUP);
130
            if (elem != NULL) {
131
                lookup->dest[0] = elem->value;
132
133
134
135
136
137
                if (lookup->is_type) {
                    // If we look up class method, we need to pass original type there,
                    // not type where we found a class method.
                    const mp_obj_type_t *org_type = (const mp_obj_type_t*)lookup->obj;
                    instance_convert_return_attr(NULL, org_type, elem->value, lookup->dest);
                } else if (lookup->obj != MP_OBJ_NULL && !lookup->is_type && is_native_type(type)) {
138
                    instance_convert_return_attr(lookup->obj->subobj[0], type, elem->value, lookup->dest);
139
                } else {
140
                    instance_convert_return_attr(lookup->obj, type, elem->value, lookup->dest);
141
                }
142
143
144
145
146
#if DEBUG_PRINT
                printf("mp_obj_class_lookup: Returning: ");
                mp_obj_print(lookup->dest[0], PRINT_REPR); printf(" ");
                mp_obj_print(lookup->dest[1], PRINT_REPR); printf("\n");
#endif
147
                return;
148
            }
149
150
        }

151
        // Try this for completeness, but all native methods should be statically defined
152
        // in locals_dict, and would be handled by above.
153
        if (lookup->obj != MP_OBJ_NULL && !lookup->is_type && is_native_type(type)) {
154
155
            mp_load_method_maybe(lookup->obj->subobj[0], lookup->attr, lookup->dest);
            if (lookup->dest[0] != MP_OBJ_NULL) {
156
                return;
157
158
159
            }
        }

160
161
162
        // attribute not found, keep searching base classes

        // for a const struct, this entry might be NULL
163
        if (type->bases_tuple == MP_OBJ_NULL) {
164
            return;
165
166
167
168
        }

        uint len;
        mp_obj_t *items;
169
        mp_obj_tuple_get(type->bases_tuple, &len, &items);
170
        if (len == 0) {
171
            return;
172
173
        }
        for (uint i = 0; i < len - 1; i++) {
174
            assert(MP_OBJ_IS_TYPE(items[i], &mp_type_type));
175
176
177
178
179
            mp_obj_type_t *bt = (mp_obj_type_t*)items[i];
            if (bt == &mp_type_object) {
                // Not a "real" type
                continue;
            }
180
181
            mp_obj_class_lookup(lookup, bt);
            if (lookup->dest[0] != MP_OBJ_NULL) {
182
                return;
183
184
185
186
            }
        }

        // search last base (simple tail recursion elimination)
187
        assert(MP_OBJ_IS_TYPE(items[len - 1], &mp_type_type));
188
        type = (mp_obj_type_t*)items[len - 1];
189
190
191
192
        if (type == &mp_type_object) {
            // Not a "real" type
            return;
        }
193
194
195
    }
}

196
STATIC void instance_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
197
    mp_obj_instance_t *self = self_in;
198
    qstr meth = (kind == PRINT_STR) ? MP_QSTR___str__ : MP_QSTR___repr__;
199
    mp_obj_t member[2] = {MP_OBJ_NULL};
200
201
202
203
204
205
206
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = meth,
        .meth_offset = offsetof(mp_obj_type_t, print),
        .dest = member,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
207
    if (member[0] == MP_OBJ_NULL && kind == PRINT_STR) {
208
        // If there's no __str__, fall back to __repr__
209
210
211
        lookup.attr = MP_QSTR___repr__;
        lookup.meth_offset = 0;
        mp_obj_class_lookup(&lookup, self->base.type);
212
213
    }

214
    if (member[0] == MP_OBJ_SENTINEL) {
215
216
217
218
219
220
221
222
223
        // Handle Exception subclasses specially
        if (mp_obj_is_native_exception_instance(self->subobj[0])) {
            if (kind != PRINT_STR) {
                print(env, "%s", qstr_str(self->base.type->name));
            }
            mp_obj_print_helper(print, env, self->subobj[0], kind | PRINT_EXC_SUBCLASS);
        } else {
            mp_obj_print_helper(print, env, self->subobj[0], kind);
        }
224
        return;
225
226
    }

227
228
    if (member[0] != MP_OBJ_NULL) {
        mp_obj_t r = mp_call_function_1(member[0], self_in);
229
230
231
232
233
        mp_obj_print_helper(print, env, r, PRINT_STR);
        return;
    }

    // TODO: CPython prints fully-qualified type name
234
235
236
    print(env, "<%s object at %p>", mp_obj_get_type_str(self_in), self_in);
}

237
mp_obj_t instance_make_new(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
238
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
239
    mp_obj_type_t *self = self_in;
240

241
    const mp_obj_type_t *native_base;
242
    uint num_native_bases = instance_count_native_bases(self, &native_base);
243
    assert(num_native_bases < 2);
244

245
    mp_obj_instance_t *o = mp_obj_new_instance(self_in, num_native_bases);
246

247
248
249
250
251
252
253
254
    // This executes only "__new__" part of obejection creation.
    // TODO: This won't work will for classes with native bases.
    // TODO: This is hack, should be resolved along the lines of
    // https://github.com/micropython/micropython/issues/606#issuecomment-43685883
    if (n_args == 1 && *args == MP_OBJ_SENTINEL) {
        return o;
    }

255
    // look for __new__ function
256
    mp_obj_t init_fn[2] = {MP_OBJ_NULL};
257
258
259
260
261
262
263
    struct class_lookup_data lookup = {
        .obj = NULL,
        .attr = MP_QSTR___new__,
        .meth_offset = offsetof(mp_obj_type_t, make_new),
        .dest = init_fn,
    };
    mp_obj_class_lookup(&lookup, self);
264

265
    mp_obj_t new_ret = o;
266
    if (init_fn[0] == MP_OBJ_SENTINEL) {
267
268
269
        // Native type's constructor is what wins - it gets all our arguments,
        // and none Python classes are initialized at all.
        o->subobj[0] = native_base->make_new((mp_obj_type_t*)native_base, n_args, n_kw, args);
270
    } else if (init_fn[0] != MP_OBJ_NULL) {
271
        // now call Python class __new__ function with all args
272
        if (n_args == 0 && n_kw == 0) {
273
            new_ret = mp_call_function_n_kw(init_fn[0], 1, 0, (mp_obj_t*)(void*)&self_in);
274
        } else {
275
            mp_obj_t *args2 = m_new(mp_obj_t, 1 + n_args + 2 * n_kw);
276
            args2[0] = self_in;
277
            memcpy(args2 + 1, args, (n_args + 2 * n_kw) * sizeof(mp_obj_t));
278
            new_ret = mp_call_function_n_kw(init_fn[0], n_args + 1, n_kw, args2);
279
            m_del(mp_obj_t, args2, 1 + n_args + 2 * n_kw);
280
        }
281
282
283
284
285
286
287
288
289
290
291
292
293

    }

    // https://docs.python.org/3.4/reference/datamodel.html#object.__new__
    // "If __new__() does not return an instance of cls, then the new instance’s __init__() method will not be invoked."
    if (mp_obj_get_type(new_ret) != self_in) {
        return new_ret;
    }

    o = new_ret;

    // now call Python class __init__ function with all args
    init_fn[0] = init_fn[1] = NULL;
294
295
296
297
    lookup.obj = o;
    lookup.attr = MP_QSTR___init__;
    lookup.meth_offset = 0;
    mp_obj_class_lookup(&lookup, self);
298
299
300
301
302
303
304
305
306
307
308
309
    if (init_fn[0] != MP_OBJ_NULL) {
        mp_obj_t init_ret;
        if (n_args == 0 && n_kw == 0) {
            init_ret = mp_call_method_n_kw(0, 0, init_fn);
        } else {
            mp_obj_t *args2 = m_new(mp_obj_t, 2 + n_args + 2 * n_kw);
            args2[0] = init_fn[0];
            args2[1] = init_fn[1];
            memcpy(args2 + 2, args, (n_args + 2 * n_kw) * sizeof(mp_obj_t));
            init_ret = mp_call_method_n_kw(n_args, n_kw, args2);
            m_del(mp_obj_t, args2, 2 + n_args + 2 * n_kw);
        }
310
        if (init_ret != mp_const_none) {
311
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "__init__() should return None, not '%s'", mp_obj_get_type_str(init_ret)));
312
313
314
315
316
317
318
        }

    }

    return o;
}

319
STATIC const qstr unary_op_method_name[] = {
Damien George's avatar
Damien George committed
320
321
322
323
324
325
    [MP_UNARY_OP_BOOL] = MP_QSTR___bool__,
    [MP_UNARY_OP_LEN] = MP_QSTR___len__,
    //[MP_UNARY_OP_POSITIVE,
    //[MP_UNARY_OP_NEGATIVE,
    //[MP_UNARY_OP_INVERT,
    [MP_UNARY_OP_NOT] = MP_QSTR_, // don't need to implement this, used to make sure array has full size
326
327
};

328
STATIC mp_obj_t instance_unary_op(int op, mp_obj_t self_in) {
329
    mp_obj_instance_t *self = self_in;
330
    qstr op_name = unary_op_method_name[op];
331
    /* Still try to lookup native slot
332
    if (op_name == 0) {
333
        return MP_OBJ_NULL;
334
    }
335
    */
336
    mp_obj_t member[2] = {MP_OBJ_NULL};
337
338
339
340
341
342
343
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = op_name,
        .meth_offset = offsetof(mp_obj_type_t, unary_op),
        .dest = member,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
344
    if (member[0] == MP_OBJ_SENTINEL) {
345
        return mp_unary_op(op, self->subobj[0]);
346
347
    } else if (member[0] != MP_OBJ_NULL) {
        return mp_call_function_1(member[0], self_in);
348
    } else {
349
        return MP_OBJ_NULL; // op not supported
350
351
352
    }
}

353
STATIC const qstr binary_op_method_name[] = {
354
    /*
Damien George's avatar
Damien George committed
355
356
357
358
359
    MP_BINARY_OP_OR,
    MP_BINARY_OP_XOR,
    MP_BINARY_OP_AND,
    MP_BINARY_OP_LSHIFT,
    MP_BINARY_OP_RSHIFT,
360
    */
Damien George's avatar
Damien George committed
361
362
    [MP_BINARY_OP_ADD] = MP_QSTR___add__,
    [MP_BINARY_OP_SUBTRACT] = MP_QSTR___sub__,
363
    /*
Damien George's avatar
Damien George committed
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
    MP_BINARY_OP_MULTIPLY,
    MP_BINARY_OP_FLOOR_DIVIDE,
    MP_BINARY_OP_TRUE_DIVIDE,
    MP_BINARY_OP_MODULO,
    MP_BINARY_OP_POWER,
    MP_BINARY_OP_INPLACE_OR,
    MP_BINARY_OP_INPLACE_XOR,
    MP_BINARY_OP_INPLACE_AND,
    MP_BINARY_OP_INPLACE_LSHIFT,
    MP_BINARY_OP_INPLACE_RSHIFT,
    MP_BINARY_OP_INPLACE_ADD,
    MP_BINARY_OP_INPLACE_SUBTRACT,
    MP_BINARY_OP_INPLACE_MULTIPLY,
    MP_BINARY_OP_INPLACE_FLOOR_DIVIDE,
    MP_BINARY_OP_INPLACE_TRUE_DIVIDE,
    MP_BINARY_OP_INPLACE_MODULO,
380
381
382
    MP_BINARY_OP_INPLACE_POWER,*/
    [MP_BINARY_OP_LESS] = MP_QSTR___lt__,
    /*MP_BINARY_OP_MORE,
Damien George's avatar
Damien George committed
383
384
385
386
387
388
    MP_BINARY_OP_EQUAL,
    MP_BINARY_OP_LESS_EQUAL,
    MP_BINARY_OP_MORE_EQUAL,
    MP_BINARY_OP_NOT_EQUAL,
    MP_BINARY_OP_IN,
    MP_BINARY_OP_IS,
389
    */
Damien George's avatar
Damien George committed
390
    [MP_BINARY_OP_EXCEPTION_MATCH] = MP_QSTR_, // not implemented, used to make sure array has full size
391
392
};

393
394
395
// Given a member that was extracted from an instance, convert it correctly
// and put the result in the dest[] array for a possible method call.
// Conversion means dealing with static/class methods, callables, and values.
396
// see http://docs.python.org/3/howto/descriptor.html
397
STATIC void instance_convert_return_attr(mp_obj_t self, const mp_obj_type_t *type, mp_obj_t member, mp_obj_t *dest) {
398
    assert(dest[1] == NULL);
399
400
401
402
403
404
    if (MP_OBJ_IS_TYPE(member, &mp_type_staticmethod)) {
        // return just the function
        dest[0] = ((mp_obj_static_class_method_t*)member)->fun;
    } else if (MP_OBJ_IS_TYPE(member, &mp_type_classmethod)) {
        // return a bound method, with self being the type of this object
        dest[0] = ((mp_obj_static_class_method_t*)member)->fun;
405
        dest[1] = (mp_obj_t)type;
406
407
408
    } else if (MP_OBJ_IS_TYPE(member, &mp_type_type)) {
        // Don't try to bind types
        dest[0] = member;
409
410
411
412
413
414
415
416
417
418
    } else if (mp_obj_is_callable(member)) {
        // return a bound method, with self being this object
        dest[0] = member;
        dest[1] = self;
    } else {
        // class member is a value, so just return that value
        dest[0] = member;
    }
}

419
STATIC mp_obj_t instance_binary_op(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
420
421
    // Note: For ducktyping, CPython does not look in the instance members or use
    // __getattr__ or __getattribute__.  It only looks in the class dictionary.
422
    mp_obj_instance_t *lhs = lhs_in;
423
    qstr op_name = binary_op_method_name[op];
424
    /* Still try to lookup native slot
425
    if (op_name == 0) {
426
        return MP_OBJ_NULL;
427
    }
428
    */
429
    mp_obj_t dest[3] = {MP_OBJ_NULL};
430
431
432
433
434
435
436
    struct class_lookup_data lookup = {
        .obj = lhs,
        .attr = op_name,
        .meth_offset = offsetof(mp_obj_type_t, binary_op),
        .dest = dest,
    };
    mp_obj_class_lookup(&lookup, lhs->base.type);
437
    if (dest[0] == MP_OBJ_SENTINEL) {
438
        return mp_binary_op(op, lhs->subobj[0], rhs_in);
439
    } else if (dest[0] != MP_OBJ_NULL) {
440
441
        dest[2] = rhs_in;
        return mp_call_method_n_kw(1, 0, dest);
442
    } else {
443
        return MP_OBJ_NULL; // op not supported
444
445
446
    }
}

447
STATIC void instance_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
448
    // logic: look in obj members then class locals (TODO check this against CPython)
449
    assert(is_instance_type(mp_obj_get_type(self_in)));
450
    mp_obj_instance_t *self = self_in;
451

452
453
454
    mp_map_elem_t *elem = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP);
    if (elem != NULL) {
        // object member, always treated as a value
455
        // TODO should we check for properties?
456
        dest[0] = elem->value;
457
458
        return;
    }
459

460
461
462
463
464
465
466
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
467
    mp_obj_t member = dest[0];
468
    if (member != MP_OBJ_NULL) {
469
#if MICROPY_PY_BUILTINS_PROPERTY
470
        if (MP_OBJ_IS_TYPE(member, &mp_type_property)) {
471
472
            // object member is a property
            // delegate the store to the property
473
            // TODO should this be part of instance_convert_return_attr?
474
475
476
477
478
            const mp_obj_t *proxy = mp_obj_property_get(member);
            if (proxy[0] == mp_const_none) {
                // TODO
            } else {
                dest[0] = mp_call_function_n_kw(proxy[0], 1, 0, &self_in);
479
                // TODO should we convert the returned value using instance_convert_return_attr?
480
481
            }
        }
482
#endif
Damien George's avatar
Damien George committed
483
484
485
486
487
488
489
490
491
492
493
494
        return;
    }

    // try __getattr__
    if (attr != MP_QSTR___getattr__) {
        mp_obj_t dest2[3];
        mp_load_method_maybe(self_in, MP_QSTR___getattr__, dest2);
        if (dest2[0] != MP_OBJ_NULL) {
            // __getattr__ exists, call it and return its result
            // XXX if this fails to load the requested attr, should we catch the attribute error and return silently?
            dest2[2] = MP_OBJ_NEW_QSTR(attr);
            dest[0] = mp_call_method_n_kw(1, 0, dest2);
495
496
497
498
499
            return;
        }
    }
}

500
STATIC bool instance_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
501
    mp_obj_instance_t *self = self_in;
502

503
#if MICROPY_PY_BUILTINS_PROPERTY
504
505
    // for property, we need to do a lookup first in the class dict
    // this makes all stores slow... how to fix?
506
    mp_obj_t member[2] = {MP_OBJ_NULL};
507
508
509
510
511
512
513
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = member,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
514
    if (member[0] != MP_OBJ_NULL && MP_OBJ_IS_TYPE(member[0], &mp_type_property)) {
515
516
        // attribute already exists and is a property
        // delegate the store to the property
517
        const mp_obj_t *proxy = mp_obj_property_get(member[0]);
518
519
520
521
522
523
524
525
526
527
528
        if (proxy[1] == mp_const_none) {
            // TODO better error message
            return false;
        } else {
            mp_obj_t dest[2] = {self_in, value};
            mp_call_function_n_kw(proxy[1], 2, 0, dest);
            return true;
        }
    }
#endif

529
530
    if (value == MP_OBJ_NULL) {
        // delete attribute
531
532
        mp_map_elem_t *elem = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_REMOVE_IF_FOUND);
        return elem != NULL;
533
534
535
536
537
    } else {
        // store attribute
        mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_ADD_IF_NOT_FOUND)->value = value;
        return true;
    }
538
539
}

540
STATIC mp_obj_t instance_subscr(mp_obj_t self_in, mp_obj_t index, mp_obj_t value) {
541
    mp_obj_instance_t *self = self_in;
542
    mp_obj_t member[2] = {MP_OBJ_NULL};
543
544
545
546
547
    struct class_lookup_data lookup = {
        .obj = self,
        .meth_offset = offsetof(mp_obj_type_t, subscr),
        .dest = member,
    };
548
    uint meth_args;
549
550
    if (value == MP_OBJ_NULL) {
        // delete item
551
552
        lookup.attr = MP_QSTR___delitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
553
        meth_args = 2;
554
555
    } else if (value == MP_OBJ_SENTINEL) {
        // load item
556
557
        lookup.attr = MP_QSTR___getitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
558
        meth_args = 2;
559
    } else {
560
        // store item
561
562
        lookup.attr = MP_QSTR___setitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
563
        meth_args = 3;
564
    }
565
    if (member[0] == MP_OBJ_SENTINEL) {
566
        return mp_obj_subscr(self->subobj[0], index, value);
567
    } else if (member[0] != MP_OBJ_NULL) {
568
        mp_obj_t args[3] = {self_in, index, value};
569
        // TODO probably need to call instance_convert_return_attr, and use mp_call_method_n_kw
570
        mp_obj_t ret = mp_call_function_n_kw(member[0], meth_args, 0, args);
571
572
573
574
575
        if (value == MP_OBJ_SENTINEL) {
            return ret;
        } else {
            return mp_const_none;
        }
576
    } else {
577
        return MP_OBJ_NULL; // op not supported
578
579
580
    }
}

581
STATIC mp_obj_t instance_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
582
    mp_obj_instance_t *self = self_in;
583
    mp_obj_t member[2] = {MP_OBJ_NULL};
584
585
586
587
588
589
590
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = MP_QSTR___call__,
        .meth_offset = offsetof(mp_obj_type_t, call),
        .dest = member,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
591
    if (member[0] == MP_OBJ_NULL) {
592
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "'%s' object is not callable", mp_obj_get_type_str(self_in)));
593
    }
594
    if (member[0] == MP_OBJ_SENTINEL) {
595
596
        return mp_call_function_n_kw(self->subobj[0], n_args, n_kw, args);
    }
597
    mp_obj_t meth = mp_obj_new_bound_meth(member[0], self);
598
599
600
    return mp_call_function_n_kw(meth, n_args, n_kw, args);
}

601
602
603
STATIC mp_obj_t instance_getiter(mp_obj_t self_in) {
    mp_obj_instance_t *self = self_in;
    mp_obj_t member[2] = {MP_OBJ_NULL};
604
605
606
607
608
609
610
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = MP_QSTR___iter__,
        .meth_offset = offsetof(mp_obj_type_t, getiter),
        .dest = member,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
611
612
    if (member[0] == MP_OBJ_NULL) {
        // This kinda duplicates code in mp_getiter()
613
614
615
        lookup.attr = MP_QSTR___getitem__;
        lookup.meth_offset = 0; // TODO
        mp_obj_class_lookup(&lookup, self->base.type);
616
617
618
619
620
621
622
623
624
625
626
627
628
629
        if (member[0] != MP_OBJ_NULL) {
            // __getitem__ exists, create an iterator
            return mp_obj_new_getitem_iter(member);
        }
        return MP_OBJ_NULL;
    }
    if (member[0] == MP_OBJ_SENTINEL) {
        mp_obj_type_t *type = mp_obj_get_type(self->subobj[0]);
        return type->getiter(self->subobj[0]);
    }
    mp_obj_t meth = mp_obj_new_bound_meth(member[0], self);
    return mp_call_function_n_kw(meth, 0, 0, NULL);
}

630
631
632
/******************************************************************************/
// type object
//  - the struct is mp_obj_type_t and is defined in obj.h so const types can be made
633
//  - there is a constant mp_obj_type_t (called mp_type_type) for the 'type' object
634
//  - creating a new class (a new type) creates a new mp_obj_type_t
635

636
STATIC void type_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
637
    mp_obj_type_t *self = self_in;
638
    print(env, "<class '%s'>", qstr_str(self->name));
639
640
}

641
STATIC mp_obj_t type_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
642
    mp_arg_check_num(n_args, n_kw, 1, 3, false);
643

644
645
646
647
648
    switch (n_args) {
        case 1:
            return mp_obj_get_type(args[0]);

        case 3:
649
            // args[0] = name
650
            // args[1] = bases tuple
651
            // args[2] = locals dict
652
            return mp_obj_new_type(mp_obj_str_get_qstr(args[0]), args[1], args[2]);
653
654

        default:
655
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "type takes 1 or 3 arguments"));
656
657
658
    }
}

659
STATIC mp_obj_t type_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
660
661
    // instantiate an instance of a class

662
    mp_obj_type_t *self = self_in;
663
664

    if (self->make_new == NULL) {
665
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "cannot create '%s' instances", qstr_str(self->name)));
666
    }
667
668

    // make new instance
669
    mp_obj_t o = self->make_new(self, n_args, n_kw, args);
670
671
672
673
674

    // return new instance
    return o;
}

675
// for fail, do nothing; for attr, dest[0] = value; for method, dest[0] = method, dest[1] = self
676
STATIC void type_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
677
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
678
    mp_obj_type_t *self = self_in;
679
#if MICROPY_CPYTHON_COMPAT
680
681
682
683
    if (attr == MP_QSTR___name__) {
        dest[0] = MP_OBJ_NEW_QSTR(self->name);
        return;
    }
684
#endif
685
    struct class_lookup_data lookup = {
686
        .obj = self_in,
687
688
689
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
690
        .is_type = true,
691
692
    };
    mp_obj_class_lookup(&lookup, self);
693
694
}

695
STATIC bool type_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
696
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
697
698
    mp_obj_type_t *self = self_in;

699
700
    // TODO CPython allows STORE_ATTR to a class, but is this the correct implementation?

701
    if (self->locals_dict != NULL) {
702
        assert(MP_OBJ_IS_TYPE(self->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
703
        mp_map_t *locals_map = mp_obj_dict_get_map(self->locals_dict);
704
705
706
707
708
709
710
711
712
713
714
715
716
        if (value == MP_OBJ_NULL) {
            // delete attribute
            mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_REMOVE_IF_FOUND);
            // note that locals_map may be in ROM, so remove will fail in that case
            return elem != NULL;
        } else {
            // store attribute
            mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_ADD_IF_NOT_FOUND);
            // note that locals_map may be in ROM, so add will fail in that case
            if (elem != NULL) {
                elem->value = value;
                return true;
            }
717
        }
718
    }
719
720

    return false;
721
722
}

723
724
725
726
727
728
STATIC mp_obj_t type_binary_op(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
    switch (op) {
        case MP_BINARY_OP_EQUAL:
            // Types can be equal only if it's the same type structure,
            // we don't even need to check for 2nd arg type.
            return MP_BOOL(lhs_in == rhs_in);
729
730

        default:
731
            return MP_OBJ_NULL; // op not supported
732
733
734
    }
}

735
736
const mp_obj_type_t mp_type_type = {
    { &mp_type_type },
737
    .name = MP_QSTR_type,
738
    .print = type_print,
739
    .make_new = type_make_new,
740
    .call = type_call,
741
742
    .load_attr = type_load_attr,
    .store_attr = type_store_attr,
743
    .binary_op = type_binary_op,
744
};
745

746
mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict) {
747
    assert(MP_OBJ_IS_TYPE(bases_tuple, &mp_type_tuple)); // Micro Python restriction, for now
748
    assert(MP_OBJ_IS_TYPE(locals_dict, &mp_type_dict)); // Micro Python restriction, for now
749
750
751
752
753
754
755
756
757
758
759
760
761
762

    // Basic validation of base classes
    uint len;
    mp_obj_t *items;
    mp_obj_tuple_get(bases_tuple, &len, &items);
    for (uint i = 0; i < len; i++) {
        assert(MP_OBJ_IS_TYPE(items[i], &mp_type_type));
        mp_obj_type_t *t = items[i];
        // TODO: Verify with CPy, tested on function type
        if (t->make_new == NULL) {
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "type '%s' is not an acceptable base type", qstr_str(t->name)));
        }
    }

763
    mp_obj_type_t *o = m_new0(mp_obj_type_t, 1);
764
    o->base.type = &mp_type_type;
765
    o->name = name;
766
767
768
769
770
771
772
773
    o->print = instance_print;
    o->make_new = instance_make_new;
    o->unary_op = instance_unary_op;
    o->binary_op = instance_binary_op;
    o->load_attr = instance_load_attr;
    o->store_attr = instance_store_attr;
    o->subscr = instance_subscr;
    o->call = instance_call;
774
    o->getiter = instance_getiter;
775
776
    o->bases_tuple = bases_tuple;
    o->locals_dict = locals_dict;
777
778

    const mp_obj_type_t *native_base;
779
    uint num_native_bases = instance_count_native_bases(o, &native_base);
780
781
782
783
    if (num_native_bases > 1) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "multiple bases have instance lay-out conflict"));
    }

784
785
    return o;
}
786
787

/******************************************************************************/
Damien George's avatar
Damien George committed
788
789
790
791
792
793
794
795
// super object

typedef struct _mp_obj_super_t {
    mp_obj_base_t base;
    mp_obj_t type;
    mp_obj_t obj;
} mp_obj_super_t;

796
STATIC void super_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
Damien George's avatar
Damien George committed
797
798
799
800
801
802
803
804
    mp_obj_super_t *self = self_in;
    print(env, "<super: ");
    mp_obj_print_helper(print, env, self->type, PRINT_STR);
    print(env, ", ");
    mp_obj_print_helper(print, env, self->obj, PRINT_STR);
    print(env, ">");
}

805
STATIC mp_obj_t super_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
Damien George's avatar
Damien George committed
806
807
808
    if (n_args != 2 || n_kw != 0) {
        // 0 arguments are turned into 2 in the compiler
        // 1 argument is not yet implemented
809
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "super() requires 2 arguments"));
Damien George's avatar
Damien George committed
810
811
812
813
814
    }
    return mp_obj_new_super(args[0], args[1]);
}

// for fail, do nothing; for attr, dest[0] = value; for method, dest[0] = method, dest[1] = self
815
STATIC void super_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
816
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_super));
Damien George's avatar
Damien George committed
817
818
    mp_obj_super_t *self = self_in;

819
    assert(MP_OBJ_IS_TYPE(self->type, &mp_type_type));
Damien George's avatar
Damien George committed
820
821
822
823
824
825
826
827
828
829
830

    mp_obj_type_t *type = self->type;

    // for a const struct, this entry might be NULL
    if (type->bases_tuple == MP_OBJ_NULL) {
        return;
    }

    uint len;
    mp_obj_t *items;
    mp_obj_tuple_get(type->bases_tuple, &len, &items);
831
832
833
834
835
836
    struct class_lookup_data lookup = {
        .obj = self->obj,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
    };
Damien George's avatar
Damien George committed
837
    for (uint i = 0; i < len; i++) {
838
        assert(MP_OBJ_IS_TYPE(items[i], &mp_type_type));
839
        mp_obj_class_lookup(&lookup, (mp_obj_type_t*)items[i]);
840
841
842
        if (dest[0] != MP_OBJ_NULL) {
            return;
        }
Damien George's avatar
Damien George committed
843
    }
844
    mp_obj_class_lookup(&lookup, &mp_type_object);
Damien George's avatar
Damien George committed
845
846
}

847
const mp_obj_type_t mp_type_super = {
848
    { &mp_type_type },
849
    .name = MP_QSTR_super,
Damien George's avatar
Damien George committed
850
851
852
853
854
855
856
    .print = super_print,
    .make_new = super_make_new,
    .load_attr = super_load_attr,
};

mp_obj_t mp_obj_new_super(mp_obj_t type, mp_obj_t obj) {
    mp_obj_super_t *o = m_new_obj(mp_obj_super_t);
857
    *o = (mp_obj_super_t){{&mp_type_super}, type, obj};
Damien George's avatar
Damien George committed
858
859
860
861
    return o;
}

/******************************************************************************/
862
// subclassing and built-ins specific to types
863

864
865
// object and classinfo should be type objects
// (but the function will fail gracefully if they are not)
866
bool mp_obj_is_subclass_fast(mp_const_obj_t object, mp_const_obj_t classinfo) {
867
868
    for (;;) {
        if (object == classinfo) {
869
            return true;
870
871
872
873
        }

        // not equivalent classes, keep searching base classes

874
875
876
877
878
        // object should always be a type object, but just return false if it's not
        if (!MP_OBJ_IS_TYPE(object, &mp_type_type)) {
            return false;
        }

879
        const mp_obj_type_t *self = object;
880
881
882

        // for a const struct, this entry might be NULL
        if (self->bases_tuple == MP_OBJ_NULL) {
883
            return false;
884
885
        }

886
        // get the base objects (they should be type objects)
887
888
889
890
        uint len;
        mp_obj_t *items;
        mp_obj_tuple_get(self->bases_tuple, &len, &items);
        if (len == 0) {
891
            return false;
892
        }
893
894

        // iterate through the base objects
895
        for (uint i = 0; i < len - 1; i++) {
896
            if (mp_obj_is_subclass_fast(items[i], classinfo)) {
897
                return true;
898
899
900
901
902
903
904
905
            }
        }

        // search last base (simple tail recursion elimination)
        object = items[len - 1];
    }
}

906
907
908
909
910
911
STATIC mp_obj_t mp_obj_is_subclass(mp_obj_t object, mp_obj_t classinfo) {
    uint len;
    mp_obj_t *items;
    if (MP_OBJ_IS_TYPE(classinfo, &mp_type_type)) {
        len = 1;
        items = &classinfo;
912
    } else if (MP_OBJ_IS_TYPE(classinfo, &mp_type_tuple)) {
913
914
        mp_obj_tuple_get(classinfo, &len, &items);
    } else {
915
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "issubclass() arg 2 must be a class or a tuple of classes"));
916
917
    }

918
    for (uint i = 0; i < len; i++) {
919
920
        // We explicitly check for 'object' here since no-one explicitly derives from it
        if (items[i] == &mp_type_object || mp_obj_is_subclass_fast(object, items[i])) {
921
922
            return mp_const_true;
        }
923
    }
924
    return mp_const_false;
925
926
}

927
STATIC mp_obj_t mp_builtin_issubclass(mp_obj_t object, mp_obj_t classinfo) {
928
    if (!MP_OBJ_IS_TYPE(object, &mp_type_type)) {
929
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "issubclass() arg 1 must be a class"));
930
931
    }
    return mp_obj_is_subclass(object, classinfo);
932
933
}

934
935
MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_issubclass_obj, mp_builtin_issubclass);

936
STATIC mp_obj_t mp_builtin_isinstance(mp_obj_t object, mp_obj_t classinfo) {
937
    return mp_obj_is_subclass(mp_obj_get_type(object), classinfo);
Damien George's avatar