objtype.c 34 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
106
107
108
109
110
struct class_lookup_data {
    mp_obj_instance_t *obj;
    qstr attr;
    machine_uint_t meth_offset;
    mp_obj_t *dest;
};

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);
111
    for (;;) {
112
113
114
115
        // 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.
116
117
118
119
        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;
120
                return;
121
122
123
            }
        }

124
        if (type->locals_dict != NULL) {
125
            // search locals_dict (the set of methods/attributes)
126
            assert(MP_OBJ_IS_TYPE(type->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
127
            mp_map_t *locals_map = mp_obj_dict_get_map(type->locals_dict);
128
            mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(lookup->attr), MP_MAP_LOOKUP);
129
            if (elem != NULL) {
130
131
132
                lookup->dest[0] = elem->value;
                if (lookup->obj != MP_OBJ_NULL && is_native_type(type)) {
                    instance_convert_return_attr(lookup->obj->subobj[0], type, elem->value, lookup->dest);
133
                } else {
134
                    instance_convert_return_attr(lookup->obj, type, elem->value, lookup->dest);
135
136
                }
                return;
137
            }
138
139
        }

140
        // Try this for completeness, but all native methods should be statically defined
141
        // in locals_dict, and would be handled by above.
142
143
144
        if (lookup->obj != MP_OBJ_NULL && is_native_type(type)) {
            mp_load_method_maybe(lookup->obj->subobj[0], lookup->attr, lookup->dest);
            if (lookup->dest[0] != MP_OBJ_NULL) {
145
                return;
146
147
148
            }
        }

149
150
151
        // attribute not found, keep searching base classes

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

        uint len;
        mp_obj_t *items;
158
        mp_obj_tuple_get(type->bases_tuple, &len, &items);
159
        if (len == 0) {
160
            return;
161
162
        }
        for (uint i = 0; i < len - 1; i++) {
163
            assert(MP_OBJ_IS_TYPE(items[i], &mp_type_type));
164
165
166
167
168
            mp_obj_type_t *bt = (mp_obj_type_t*)items[i];
            if (bt == &mp_type_object) {
                // Not a "real" type
                continue;
            }
169
170
            mp_obj_class_lookup(lookup, bt);
            if (lookup->dest[0] != MP_OBJ_NULL) {
171
                return;
172
173
174
175
            }
        }

        // search last base (simple tail recursion elimination)
176
        assert(MP_OBJ_IS_TYPE(items[len - 1], &mp_type_type));
177
        type = (mp_obj_type_t*)items[len - 1];
178
179
180
181
        if (type == &mp_type_object) {
            // Not a "real" type
            return;
        }
182
183
184
    }
}

185
STATIC void instance_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
186
    mp_obj_instance_t *self = self_in;
187
    qstr meth = (kind == PRINT_STR) ? MP_QSTR___str__ : MP_QSTR___repr__;
188
    mp_obj_t member[2] = {MP_OBJ_NULL};
189
190
191
192
193
194
195
    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);
196
    if (member[0] == MP_OBJ_NULL && kind == PRINT_STR) {
197
        // If there's no __str__, fall back to __repr__
198
199
200
        lookup.attr = MP_QSTR___repr__;
        lookup.meth_offset = 0;
        mp_obj_class_lookup(&lookup, self->base.type);
201
202
    }

203
    if (member[0] == MP_OBJ_SENTINEL) {
204
205
206
207
208
209
210
211
212
        // 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);
        }
213
        return;
214
215
    }

216
217
    if (member[0] != MP_OBJ_NULL) {
        mp_obj_t r = mp_call_function_1(member[0], self_in);
218
219
220
221
222
        mp_obj_print_helper(print, env, r, PRINT_STR);
        return;
    }

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

226
mp_obj_t instance_make_new(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
227
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
228
    mp_obj_type_t *self = self_in;
229

230
    const mp_obj_type_t *native_base;
231
    uint num_native_bases = instance_count_native_bases(self, &native_base);
232
    assert(num_native_bases < 2);
233

234
    mp_obj_instance_t *o = mp_obj_new_instance(self_in, num_native_bases);
235

236
237
238
239
240
241
242
243
    // 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;
    }

244
    // look for __new__ function
245
    mp_obj_t init_fn[2] = {MP_OBJ_NULL};
246
247
248
249
250
251
252
    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);
253

254
    mp_obj_t new_ret = o;
255
    if (init_fn[0] == MP_OBJ_SENTINEL) {
256
257
258
        // 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);
259
    } else if (init_fn[0] != MP_OBJ_NULL) {
260
        // now call Python class __new__ function with all args
261
        if (n_args == 0 && n_kw == 0) {
262
            new_ret = mp_call_function_n_kw(init_fn[0], 1, 0, (mp_obj_t*)(void*)&self_in);
263
        } else {
264
            mp_obj_t *args2 = m_new(mp_obj_t, 1 + n_args + 2 * n_kw);
265
            args2[0] = self_in;
266
            memcpy(args2 + 1, args, (n_args + 2 * n_kw) * sizeof(mp_obj_t));
267
            new_ret = mp_call_function_n_kw(init_fn[0], n_args + 1, n_kw, args2);
268
            m_del(mp_obj_t, args2, 1 + n_args + 2 * n_kw);
269
        }
270
271
272
273
274
275
276
277
278
279
280
281
282

    }

    // 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;
283
284
285
286
    lookup.obj = o;
    lookup.attr = MP_QSTR___init__;
    lookup.meth_offset = 0;
    mp_obj_class_lookup(&lookup, self);
287
288
289
290
291
292
293
294
295
296
297
298
    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);
        }
299
        if (init_ret != mp_const_none) {
300
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "__init__() should return None, not '%s'", mp_obj_get_type_str(init_ret)));
301
302
303
304
305
306
307
        }

    }

    return o;
}

308
STATIC const qstr unary_op_method_name[] = {
Damien George's avatar
Damien George committed
309
310
311
312
313
314
    [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
315
316
};

317
STATIC mp_obj_t instance_unary_op(int op, mp_obj_t self_in) {
318
    mp_obj_instance_t *self = self_in;
319
    qstr op_name = unary_op_method_name[op];
320
    /* Still try to lookup native slot
321
    if (op_name == 0) {
322
        return MP_OBJ_NULL;
323
    }
324
    */
325
    mp_obj_t member[2] = {MP_OBJ_NULL};
326
327
328
329
330
331
332
    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);
333
    if (member[0] == MP_OBJ_SENTINEL) {
334
        return mp_unary_op(op, self->subobj[0]);
335
336
    } else if (member[0] != MP_OBJ_NULL) {
        return mp_call_function_1(member[0], self_in);
337
    } else {
338
        return MP_OBJ_NULL; // op not supported
339
340
341
    }
}

342
STATIC const qstr binary_op_method_name[] = {
343
    /*
Damien George's avatar
Damien George committed
344
345
346
347
348
    MP_BINARY_OP_OR,
    MP_BINARY_OP_XOR,
    MP_BINARY_OP_AND,
    MP_BINARY_OP_LSHIFT,
    MP_BINARY_OP_RSHIFT,
349
    */
Damien George's avatar
Damien George committed
350
351
    [MP_BINARY_OP_ADD] = MP_QSTR___add__,
    [MP_BINARY_OP_SUBTRACT] = MP_QSTR___sub__,
352
    /*
Damien George's avatar
Damien George committed
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
    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,
369
370
371
    MP_BINARY_OP_INPLACE_POWER,*/
    [MP_BINARY_OP_LESS] = MP_QSTR___lt__,
    /*MP_BINARY_OP_MORE,
Damien George's avatar
Damien George committed
372
373
374
375
376
377
    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,
378
    */
Damien George's avatar
Damien George committed
379
    [MP_BINARY_OP_EXCEPTION_MATCH] = MP_QSTR_, // not implemented, used to make sure array has full size
380
381
};

382
383
384
// 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.
385
// see http://docs.python.org/3/howto/descriptor.html
386
STATIC void instance_convert_return_attr(mp_obj_t self, const mp_obj_type_t *type, mp_obj_t member, mp_obj_t *dest) {
387
    assert(dest[1] == NULL);
388
389
390
391
392
393
    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;
394
        dest[1] = (mp_obj_t)type;
395
396
397
    } else if (MP_OBJ_IS_TYPE(member, &mp_type_type)) {
        // Don't try to bind types
        dest[0] = member;
398
399
400
401
402
403
404
405
406
407
    } 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;
    }
}

408
STATIC mp_obj_t instance_binary_op(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
409
410
    // Note: For ducktyping, CPython does not look in the instance members or use
    // __getattr__ or __getattribute__.  It only looks in the class dictionary.
411
    mp_obj_instance_t *lhs = lhs_in;
412
    qstr op_name = binary_op_method_name[op];
413
    /* Still try to lookup native slot
414
    if (op_name == 0) {
415
        return MP_OBJ_NULL;
416
    }
417
    */
418
    mp_obj_t dest[3] = {MP_OBJ_NULL};
419
420
421
422
423
424
425
    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);
426
    if (dest[0] == MP_OBJ_SENTINEL) {
427
        return mp_binary_op(op, lhs->subobj[0], rhs_in);
428
    } else if (dest[0] != MP_OBJ_NULL) {
429
430
        dest[2] = rhs_in;
        return mp_call_method_n_kw(1, 0, dest);
431
    } else {
432
        return MP_OBJ_NULL; // op not supported
433
434
435
    }
}

436
STATIC void instance_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
437
    // logic: look in obj members then class locals (TODO check this against CPython)
438
    assert(is_instance_type(mp_obj_get_type(self_in)));
439
    mp_obj_instance_t *self = self_in;
440

441
442
443
    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
444
        // TODO should we check for properties?
445
        dest[0] = elem->value;
446
447
        return;
    }
448

449
450
451
452
453
454
455
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
456
    mp_obj_t member = dest[0];
457
    if (member != MP_OBJ_NULL) {
458
#if MICROPY_PY_BUILTINS_PROPERTY
459
        if (MP_OBJ_IS_TYPE(member, &mp_type_property)) {
460
461
            // object member is a property
            // delegate the store to the property
462
            // TODO should this be part of instance_convert_return_attr?
463
464
465
466
467
            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);
468
                // TODO should we convert the returned value using instance_convert_return_attr?
469
470
            }
        }
471
#endif
Damien George's avatar
Damien George committed
472
473
474
475
476
477
478
479
480
481
482
483
        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);
484
485
486
487
488
            return;
        }
    }
}

489
STATIC bool instance_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
490
    mp_obj_instance_t *self = self_in;
491

492
#if MICROPY_PY_BUILTINS_PROPERTY
493
494
    // for property, we need to do a lookup first in the class dict
    // this makes all stores slow... how to fix?
495
    mp_obj_t member[2] = {MP_OBJ_NULL};
496
497
498
499
500
501
502
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = member,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
503
    if (member[0] != MP_OBJ_NULL && MP_OBJ_IS_TYPE(member[0], &mp_type_property)) {
504
505
        // attribute already exists and is a property
        // delegate the store to the property
506
        const mp_obj_t *proxy = mp_obj_property_get(member[0]);
507
508
509
510
511
512
513
514
515
516
517
        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

518
519
    if (value == MP_OBJ_NULL) {
        // delete attribute
520
521
        mp_map_elem_t *elem = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_REMOVE_IF_FOUND);
        return elem != NULL;
522
523
524
525
526
    } else {
        // store attribute
        mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_ADD_IF_NOT_FOUND)->value = value;
        return true;
    }
527
528
}

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

570
STATIC mp_obj_t instance_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
571
    mp_obj_instance_t *self = self_in;
572
    mp_obj_t member[2] = {MP_OBJ_NULL};
573
574
575
576
577
578
579
    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);
580
    if (member[0] == MP_OBJ_NULL) {
581
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "'%s' object is not callable", mp_obj_get_type_str(self_in)));
582
    }
583
    if (member[0] == MP_OBJ_SENTINEL) {
584
585
        return mp_call_function_n_kw(self->subobj[0], n_args, n_kw, args);
    }
586
    mp_obj_t meth = mp_obj_new_bound_meth(member[0], self);
587
588
589
    return mp_call_function_n_kw(meth, n_args, n_kw, args);
}

590
591
592
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};
593
594
595
596
597
598
599
    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);
600
601
    if (member[0] == MP_OBJ_NULL) {
        // This kinda duplicates code in mp_getiter()
602
603
604
        lookup.attr = MP_QSTR___getitem__;
        lookup.meth_offset = 0; // TODO
        mp_obj_class_lookup(&lookup, self->base.type);
605
606
607
608
609
610
611
612
613
614
615
616
617
618
        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);
}

619
620
621
/******************************************************************************/
// type object
//  - the struct is mp_obj_type_t and is defined in obj.h so const types can be made
622
//  - there is a constant mp_obj_type_t (called mp_type_type) for the 'type' object
623
//  - creating a new class (a new type) creates a new mp_obj_type_t
624

625
STATIC void type_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
626
    mp_obj_type_t *self = self_in;
627
    print(env, "<class '%s'>", qstr_str(self->name));
628
629
}

630
STATIC mp_obj_t type_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
631
    mp_arg_check_num(n_args, n_kw, 1, 3, false);
632

633
634
635
636
637
    switch (n_args) {
        case 1:
            return mp_obj_get_type(args[0]);

        case 3:
638
            // args[0] = name
639
            // args[1] = bases tuple
640
            // args[2] = locals dict
641
            return mp_obj_new_type(mp_obj_str_get_qstr(args[0]), args[1], args[2]);
642
643

        default:
644
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "type takes 1 or 3 arguments"));
645
646
647
    }
}

648
STATIC mp_obj_t type_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
649
650
    // instantiate an instance of a class

651
    mp_obj_type_t *self = self_in;
652
653

    if (self->make_new == NULL) {
654
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "cannot create '%s' instances", qstr_str(self->name)));
655
    }
656
657

    // make new instance
658
    mp_obj_t o = self->make_new(self, n_args, n_kw, args);
659
660
661
662
663

    // return new instance
    return o;
}

664
// for fail, do nothing; for attr, dest[0] = value; for method, dest[0] = method, dest[1] = self
665
STATIC void type_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
666
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
667
    mp_obj_type_t *self = self_in;
668
#if MICROPY_CPYTHON_COMPAT
669
670
671
672
    if (attr == MP_QSTR___name__) {
        dest[0] = MP_OBJ_NEW_QSTR(self->name);
        return;
    }
673
#endif
674
675
676
677
678
679
680
    struct class_lookup_data lookup = {
        .obj = NULL,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
    };
    mp_obj_class_lookup(&lookup, self);
681
682
}

683
STATIC bool type_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
684
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
685
686
    mp_obj_type_t *self = self_in;

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

689
    if (self->locals_dict != NULL) {
690
        assert(MP_OBJ_IS_TYPE(self->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
691
        mp_map_t *locals_map = mp_obj_dict_get_map(self->locals_dict);
692
693
694
695
696
697
698
699
700
701
702
703
704
        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;
            }
705
        }
706
    }
707
708

    return false;
709
710
}

711
712
713
714
715
716
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);
717
718

        default:
719
            return MP_OBJ_NULL; // op not supported
720
721
722
    }
}

723
724
const mp_obj_type_t mp_type_type = {
    { &mp_type_type },
725
    .name = MP_QSTR_type,
726
    .print = type_print,
727
    .make_new = type_make_new,
728
    .call = type_call,
729
730
    .load_attr = type_load_attr,
    .store_attr = type_store_attr,
731
    .binary_op = type_binary_op,
732
};
733

734
mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict) {
735
    assert(MP_OBJ_IS_TYPE(bases_tuple, &mp_type_tuple)); // Micro Python restriction, for now
736
    assert(MP_OBJ_IS_TYPE(locals_dict, &mp_type_dict)); // Micro Python restriction, for now
737
738
739
740
741
742
743
744
745
746
747
748
749
750

    // 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)));
        }
    }

751
    mp_obj_type_t *o = m_new0(mp_obj_type_t, 1);
752
    o->base.type = &mp_type_type;
753
    o->name = name;
754
755
756
757
758
759
760
761
    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;
762
    o->getiter = instance_getiter;
763
764
    o->bases_tuple = bases_tuple;
    o->locals_dict = locals_dict;
765
766

    const mp_obj_type_t *native_base;
767
    uint num_native_bases = instance_count_native_bases(o, &native_base);
768
769
770
771
    if (num_native_bases > 1) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "multiple bases have instance lay-out conflict"));
    }

772
773
    return o;
}
774
775

/******************************************************************************/
Damien George's avatar
Damien George committed
776
777
778
779
780
781
782
783
// 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;

784
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
785
786
787
788
789
790
791
792
    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, ">");
}

793
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
794
795
796
    if (n_args != 2 || n_kw != 0) {
        // 0 arguments are turned into 2 in the compiler
        // 1 argument is not yet implemented
797
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "super() requires 2 arguments"));
Damien George's avatar
Damien George committed
798
799
800
801
802
    }
    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
803
STATIC void super_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
804
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_super));
Damien George's avatar
Damien George committed
805
806
    mp_obj_super_t *self = self_in;

807
    assert(MP_OBJ_IS_TYPE(self->type, &mp_type_type));
Damien George's avatar
Damien George committed
808
809
810
811
812
813
814
815
816
817
818

    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);
819
820
821
822
823
824
    struct class_lookup_data lookup = {
        .obj = self->obj,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
    };
Damien George's avatar
Damien George committed
825
    for (uint i = 0; i < len; i++) {
826
        assert(MP_OBJ_IS_TYPE(items[i], &mp_type_type));
827
        mp_obj_class_lookup(&lookup, (mp_obj_type_t*)items[i]);
828
829
830
        if (dest[0] != MP_OBJ_NULL) {
            return;
        }
Damien George's avatar
Damien George committed
831
    }
832
    mp_obj_class_lookup(&lookup, &mp_type_object);
Damien George's avatar
Damien George committed
833
834
}

835
const mp_obj_type_t mp_type_super = {
836
    { &mp_type_type },
837
    .name = MP_QSTR_super,
Damien George's avatar
Damien George committed
838
839
840
841
842
843
844
    .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);
845
    *o = (mp_obj_super_t){{&mp_type_super}, type, obj};
Damien George's avatar
Damien George committed
846
847
848
849
    return o;
}

/******************************************************************************/
850
// subclassing and built-ins specific to types
851

852
853
// object and classinfo should be type objects
// (but the function will fail gracefully if they are not)
854
bool mp_obj_is_subclass_fast(mp_const_obj_t object, mp_const_obj_t classinfo) {
855
856
    for (;;) {
        if (object == classinfo) {
857
            return true;
858
859
860
861
        }

        // not equivalent classes, keep searching base classes

862
863
864
865
866
        // 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;
        }

867
        const mp_obj_type_t *self = object;
868
869
870

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

874
        // get the base objects (they should be type objects)
875
876
877
878
        uint len;
        mp_obj_t *items;
        mp_obj_tuple_get(self->bases_tuple, &len, &items);
        if (len == 0) {
879
            return false;
880
        }
881
882

        // iterate through the base objects
883
        for (uint i = 0; i < len - 1; i++) {
884
            if (mp_obj_is_subclass_fast(items[i], classinfo)) {
885
                return true;
886
887
888
889
890
891
892
893
            }
        }

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

894
895
896
897
898
899
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;
900
    } else if (MP_OBJ_IS_TYPE(classinfo, &mp_type_tuple)) {
901
902
        mp_obj_tuple_get(classinfo, &len, &items);
    } else {
903
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "issubclass() arg 2 must be a class or a tuple of classes"));
904
905
    }

906
    for (uint i = 0; i < len; i++) {
907
908
        // 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])) {
909
910
            return mp_const_true;
        }
911
    }
912
    return mp_const_false;
913
914
}

915
STATIC mp_obj_t mp_builtin_issubclass(mp_obj_t object, mp_obj_t classinfo) {
916
    if (!MP_OBJ_IS_TYPE(object, &mp_type_type)) {
917
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "issubclass() arg 1 must be a class"));
918
919
    }
    return mp_obj_is_subclass(object, classinfo);
920
921
}

922
923
MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_issubclass_obj, mp_builtin_issubclass);

924
STATIC mp_obj_t mp_builtin_isinstance(mp_obj_t object, mp_obj_t classinfo) {
925
    return mp_obj_is_subclass(mp_obj_get_type(object), classinfo);
926
927
928
}

MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_isinstance_obj, mp_builtin_isinstance);
929

930
931
932
933
934
935
936
937
938
mp_obj_t mp_instance_cast_to_native_base(mp_const_obj_t self_in, mp_const_obj_t native_type) {
    mp_obj_type_t *self_type = mp_obj_get_type(self_in);
    if (!mp_obj_is_subclass_fast(self_type, native_type)) {
        return MP_OBJ_NULL;
    }
    mp_obj_instance_t *self = (mp_obj_instance_t*)self_in;
    return self->subobj[0];
}

939
940
941
/******************************************************************************/
// staticmethod and classmethod types (probably should go in a different file)

942
STATIC mp_obj_t static_class_method_make_new(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
943
944
945
    assert(self_in == &mp_type_staticmethod || self_in == &mp_type_classmethod);

    if (n_args != 1 || n_kw != 0) {
946
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "function takes 1 positional argument but %d were given", n_args));
947
948
949
950