objtype.c 37.3 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
34
35
36
#include "py/nlr.h"
#include "py/objtype.h"
#include "py/runtime0.h"
#include "py/runtime.h"
37

38
39
40
41
#if 0 // print debugging info
#define DEBUG_PRINT (1)
#define DEBUG_printf DEBUG_printf
#else // don't print debugging info
42
#define DEBUG_PRINT (0)
43
44
45
#define DEBUG_printf(...) (void)0
#endif

46
STATIC mp_obj_t static_class_method_make_new(mp_obj_t self_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args);
47

48
/******************************************************************************/
49
// instance object
50

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

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

64
STATIC int instance_count_native_bases(const mp_obj_type_t *type, const mp_obj_type_t **last_native_base) {
65
    mp_uint_t len;
66
67
68
69
70
71
    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));
72
73
74
75
76
77
        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)) {
78
79
80
            *last_native_base = items[i];
            count++;
        } else {
81
            count += instance_count_native_bases(items[i], last_native_base);
82
83
84
85
86
87
88
89
90
91
92
        }
    }

    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/
//
93
// will return MP_OBJ_NULL if not found
94
95
96
97
98
// 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
99
// instance->subobj[0]. This case is handled via instance_count_native_bases() though.
100
101
102
struct class_lookup_data {
    mp_obj_instance_t *obj;
    qstr attr;
103
    mp_uint_t meth_offset;
104
    mp_obj_t *dest;
105
    bool is_type;
106
107
108
109
110
};

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
                lookup->dest[0] = elem->value;
131
132
133
134
135
                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);
136
                } else if (lookup->obj != MP_OBJ_NULL && !lookup->is_type && is_native_type(type) && type != &mp_type_object /* object is not a real type */) {
137
                    instance_convert_return_attr(lookup->obj->subobj[0], type, elem->value, lookup->dest);
138
                } else {
139
                    instance_convert_return_attr(lookup->obj, type, elem->value, lookup->dest);
140
                }
141
142
143
144
145
#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
146
                return;
147
            }
148
149
        }

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

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

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

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

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

195
STATIC void instance_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
196
    mp_obj_instance_t *self = self_in;
197
    qstr meth = (kind == PRINT_STR) ? MP_QSTR___str__ : MP_QSTR___repr__;
198
    mp_obj_t member[2] = {MP_OBJ_NULL};
199
200
201
202
203
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = meth,
        .meth_offset = offsetof(mp_obj_type_t, print),
        .dest = member,
204
        .is_type = false,
205
206
    };
    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, mp_uint_t n_args, mp_uint_t 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
    struct class_lookup_data lookup = {
        .obj = NULL,
        .attr = MP_QSTR___new__,
        .meth_offset = offsetof(mp_obj_type_t, make_new),
        .dest = init_fn,
262
        .is_type = false,
263
264
    };
    mp_obj_class_lookup(&lookup, self);
265

266
    mp_obj_t new_ret = o;
267
    if (init_fn[0] == MP_OBJ_SENTINEL) {
268
269
270
        // 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);
271
    } else if (init_fn[0] != MP_OBJ_NULL) {
272
        // now call Python class __new__ function with all args
273
        if (n_args == 0 && n_kw == 0) {
274
            new_ret = mp_call_function_n_kw(init_fn[0], 1, 0, (mp_obj_t*)(void*)&self_in);
275
        } else {
276
            mp_obj_t *args2 = m_new(mp_obj_t, 1 + n_args + 2 * n_kw);
277
            args2[0] = self_in;
278
            memcpy(args2 + 1, args, (n_args + 2 * n_kw) * sizeof(mp_obj_t));
279
            new_ret = mp_call_function_n_kw(init_fn[0], n_args + 1, n_kw, args2);
280
            m_del(mp_obj_t, args2, 1 + n_args + 2 * n_kw);
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
294
    init_fn[0] = init_fn[1] = MP_OBJ_NULL;
295
296
297
298
    lookup.obj = o;
    lookup.attr = MP_QSTR___init__;
    lookup.meth_offset = 0;
    mp_obj_class_lookup(&lookup, self);
299
300
301
302
303
304
305
306
307
308
309
310
    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);
        }
311
        if (init_ret != mp_const_none) {
312
313
314
315
316
317
318
            if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
                nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                    "__init__() should return None"));
            } else {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                    "__init__() should return None, not '%s'", mp_obj_get_type_str(init_ret)));
            }
319
320
321
322
323
324
325
        }

    }

    return o;
}

326
const qstr mp_unary_op_method_name[] = {
Damien George's avatar
Damien George committed
327
328
329
330
331
332
    [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
333
334
};

335
STATIC mp_obj_t instance_unary_op(mp_uint_t op, mp_obj_t self_in) {
336
    mp_obj_instance_t *self = self_in;
337
    qstr op_name = mp_unary_op_method_name[op];
338
    /* Still try to lookup native slot
339
    if (op_name == 0) {
340
        return MP_OBJ_NULL;
341
    }
342
    */
343
    mp_obj_t member[2] = {MP_OBJ_NULL};
344
345
346
347
348
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = op_name,
        .meth_offset = offsetof(mp_obj_type_t, unary_op),
        .dest = member,
349
        .is_type = false,
350
351
    };
    mp_obj_class_lookup(&lookup, self->base.type);
352
    if (member[0] == MP_OBJ_SENTINEL) {
353
        return mp_unary_op(op, self->subobj[0]);
354
355
    } else if (member[0] != MP_OBJ_NULL) {
        return mp_call_function_1(member[0], self_in);
356
    } else {
357
        return MP_OBJ_NULL; // op not supported
358
359
360
    }
}

361
const qstr mp_binary_op_method_name[] = {
362
    /*
Damien George's avatar
Damien George committed
363
364
365
366
367
    MP_BINARY_OP_OR,
    MP_BINARY_OP_XOR,
    MP_BINARY_OP_AND,
    MP_BINARY_OP_LSHIFT,
    MP_BINARY_OP_RSHIFT,
368
    */
Damien George's avatar
Damien George committed
369
370
    [MP_BINARY_OP_ADD] = MP_QSTR___add__,
    [MP_BINARY_OP_SUBTRACT] = MP_QSTR___sub__,
371
372
373
374
375
    #if MICROPY_PY_ALL_SPECIAL_METHODS
    [MP_BINARY_OP_MULTIPLY] = MP_QSTR___mul__,
    [MP_BINARY_OP_FLOOR_DIVIDE] = MP_QSTR___floordiv__,
    [MP_BINARY_OP_TRUE_DIVIDE] = MP_QSTR___truediv__,
    #endif
376
    /*
Damien George's avatar
Damien George committed
377
378
379
380
381
382
    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,
383
384
385
    MP_BINARY_OP_INPLACE_RSHIFT,*/
    #if MICROPY_PY_ALL_SPECIAL_METHODS
    [MP_BINARY_OP_INPLACE_ADD] = MP_QSTR___iadd__,
386
    [MP_BINARY_OP_INPLACE_SUBTRACT] = MP_QSTR___isub__,
387
    #endif
388
    /*MP_BINARY_OP_INPLACE_MULTIPLY,
Damien George's avatar
Damien George committed
389
390
391
    MP_BINARY_OP_INPLACE_FLOOR_DIVIDE,
    MP_BINARY_OP_INPLACE_TRUE_DIVIDE,
    MP_BINARY_OP_INPLACE_MODULO,
392
393
    MP_BINARY_OP_INPLACE_POWER,*/
    [MP_BINARY_OP_LESS] = MP_QSTR___lt__,
394
395
396
397
398
399
    [MP_BINARY_OP_MORE] = MP_QSTR___gt__,
    [MP_BINARY_OP_EQUAL] = MP_QSTR___eq__,
    [MP_BINARY_OP_LESS_EQUAL] = MP_QSTR___le__,
    [MP_BINARY_OP_MORE_EQUAL] = MP_QSTR___ge__,
    /*
    MP_BINARY_OP_NOT_EQUAL, // a != b calls a == b and inverts result
400
401
402
    */
    [MP_BINARY_OP_IN] = MP_QSTR___contains__,
    /*
Damien George's avatar
Damien George committed
403
    MP_BINARY_OP_IS,
404
    */
Damien George's avatar
Damien George committed
405
    [MP_BINARY_OP_EXCEPTION_MATCH] = MP_QSTR_, // not implemented, used to make sure array has full size
406
407
};

408
409
410
// 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.
411
// see http://docs.python.org/3/howto/descriptor.html
412
STATIC void instance_convert_return_attr(mp_obj_t self, const mp_obj_type_t *type, mp_obj_t member, mp_obj_t *dest) {
413
    assert(dest[1] == NULL);
414
415
416
417
418
419
    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;
420
        dest[1] = (mp_obj_t)type;
421
422
423
    } else if (MP_OBJ_IS_TYPE(member, &mp_type_type)) {
        // Don't try to bind types
        dest[0] = member;
424
425
426
427
428
429
430
431
432
433
    } 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;
    }
}

434
STATIC mp_obj_t instance_binary_op(mp_uint_t op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
435
436
    // Note: For ducktyping, CPython does not look in the instance members or use
    // __getattr__ or __getattribute__.  It only looks in the class dictionary.
437
    mp_obj_instance_t *lhs = lhs_in;
438
    qstr op_name = mp_binary_op_method_name[op];
439
    /* Still try to lookup native slot
440
    if (op_name == 0) {
441
        return MP_OBJ_NULL;
442
    }
443
    */
444
    mp_obj_t dest[3] = {MP_OBJ_NULL};
445
446
447
448
449
    struct class_lookup_data lookup = {
        .obj = lhs,
        .attr = op_name,
        .meth_offset = offsetof(mp_obj_type_t, binary_op),
        .dest = dest,
450
        .is_type = false,
451
452
    };
    mp_obj_class_lookup(&lookup, lhs->base.type);
453
    if (dest[0] == MP_OBJ_SENTINEL) {
454
        return mp_binary_op(op, lhs->subobj[0], rhs_in);
455
    } else if (dest[0] != MP_OBJ_NULL) {
456
457
        dest[2] = rhs_in;
        return mp_call_method_n_kw(1, 0, dest);
458
    } else {
459
        return MP_OBJ_NULL; // op not supported
460
461
462
    }
}

463
void mp_obj_instance_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
464
    // logic: look in instance members then class locals
465
    assert(is_instance_type(mp_obj_get_type(self_in)));
466
    mp_obj_instance_t *self = self_in;
467

468
469
470
    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
471
        // TODO should we check for properties?
472
        dest[0] = elem->value;
473
474
        return;
    }
475

476
477
478
479
480
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
481
        .is_type = false,
482
483
    };
    mp_obj_class_lookup(&lookup, self->base.type);
484
    mp_obj_t member = dest[0];
485
    if (member != MP_OBJ_NULL) {
486
#if MICROPY_PY_BUILTINS_PROPERTY
487
        if (MP_OBJ_IS_TYPE(member, &mp_type_property)) {
488
489
            // object member is a property
            // delegate the store to the property
490
            // TODO should this be part of instance_convert_return_attr?
491
492
493
494
495
            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);
496
                // TODO should we convert the returned value using instance_convert_return_attr?
497
498
            }
        }
499
#endif
Damien George's avatar
Damien George committed
500
501
502
503
504
505
506
507
508
509
510
511
        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);
512
513
514
515
516
            return;
        }
    }
}

517
bool mp_obj_instance_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
518
    mp_obj_instance_t *self = self_in;
519

520
#if MICROPY_PY_BUILTINS_PROPERTY
521
522
    // for property, we need to do a lookup first in the class dict
    // this makes all stores slow... how to fix?
523
    mp_obj_t member[2] = {MP_OBJ_NULL};
524
525
526
527
528
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = member,
529
        .is_type = false,
530
531
    };
    mp_obj_class_lookup(&lookup, self->base.type);
532
    if (member[0] != MP_OBJ_NULL && MP_OBJ_IS_TYPE(member[0], &mp_type_property)) {
533
534
        // attribute already exists and is a property
        // delegate the store to the property
535
        const mp_obj_t *proxy = mp_obj_property_get(member[0]);
536
537
538
539
540
541
542
543
544
545
546
        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

547
548
    if (value == MP_OBJ_NULL) {
        // delete attribute
549
550
        mp_map_elem_t *elem = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_REMOVE_IF_FOUND);
        return elem != NULL;
551
552
553
554
555
    } else {
        // store attribute
        mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_ADD_IF_NOT_FOUND)->value = value;
        return true;
    }
556
557
}

558
STATIC mp_obj_t instance_subscr(mp_obj_t self_in, mp_obj_t index, mp_obj_t value) {
559
    mp_obj_instance_t *self = self_in;
560
    mp_obj_t member[2] = {MP_OBJ_NULL};
561
562
563
564
    struct class_lookup_data lookup = {
        .obj = self,
        .meth_offset = offsetof(mp_obj_type_t, subscr),
        .dest = member,
565
        .is_type = false,
566
    };
567
    uint meth_args;
568
569
    if (value == MP_OBJ_NULL) {
        // delete item
570
571
        lookup.attr = MP_QSTR___delitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
572
        meth_args = 2;
573
574
    } else if (value == MP_OBJ_SENTINEL) {
        // load item
575
576
        lookup.attr = MP_QSTR___getitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
577
        meth_args = 2;
578
    } else {
579
        // store item
580
581
        lookup.attr = MP_QSTR___setitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
582
        meth_args = 3;
583
    }
584
    if (member[0] == MP_OBJ_SENTINEL) {
585
        return mp_obj_subscr(self->subobj[0], index, value);
586
    } else if (member[0] != MP_OBJ_NULL) {
587
        mp_obj_t args[3] = {self_in, index, value};
588
        // TODO probably need to call instance_convert_return_attr, and use mp_call_method_n_kw
589
        mp_obj_t ret = mp_call_function_n_kw(member[0], meth_args, 0, args);
590
591
592
593
594
        if (value == MP_OBJ_SENTINEL) {
            return ret;
        } else {
            return mp_const_none;
        }
595
    } else {
596
        return MP_OBJ_NULL; // op not supported
597
598
599
    }
}

600
STATIC mp_obj_t mp_obj_instance_get_call(mp_obj_t self_in) {
601
    mp_obj_instance_t *self = self_in;
602
    mp_obj_t member[2] = {MP_OBJ_NULL, MP_OBJ_NULL};
603
604
605
606
607
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = MP_QSTR___call__,
        .meth_offset = offsetof(mp_obj_type_t, call),
        .dest = member,
608
        .is_type = false,
609
610
    };
    mp_obj_class_lookup(&lookup, self->base.type);
611
612
613
614
615
    return member[0];
}

bool mp_obj_instance_is_callable(mp_obj_t self_in) {
    return mp_obj_instance_get_call(self_in) != MP_OBJ_NULL;
616
617
618
}

mp_obj_t mp_obj_instance_call(mp_obj_t self_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
619
620
    mp_obj_t call = mp_obj_instance_get_call(self_in);
    if (call == MP_OBJ_NULL) {
621
622
623
624
625
626
627
        if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                "object not callable"));
        } else {
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                "'%s' object is not callable", mp_obj_get_type_str(self_in)));
        }
628
    }
629
630
    mp_obj_instance_t *self = self_in;
    if (call == MP_OBJ_SENTINEL) {
631
632
        return mp_call_function_n_kw(self->subobj[0], n_args, n_kw, args);
    }
633
    mp_obj_t meth = mp_obj_new_bound_meth(call, self);
634
635
636
    return mp_call_function_n_kw(meth, n_args, n_kw, args);
}

637
638
639
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};
640
641
642
643
644
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = MP_QSTR___iter__,
        .meth_offset = offsetof(mp_obj_type_t, getiter),
        .dest = member,
645
        .is_type = false,
646
647
    };
    mp_obj_class_lookup(&lookup, self->base.type);
648
649
    if (member[0] == MP_OBJ_NULL) {
        return MP_OBJ_NULL;
650
    } else if (member[0] == MP_OBJ_SENTINEL) {
651
652
        mp_obj_type_t *type = mp_obj_get_type(self->subobj[0]);
        return type->getiter(self->subobj[0]);
653
654
    } else {
        return mp_call_method_n_kw(0, 0, member);
655
656
657
    }
}

658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
STATIC mp_int_t instance_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
    mp_obj_instance_t *self = self_in;
    mp_obj_t member[2] = {MP_OBJ_NULL};
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = MP_QSTR_, // don't actually look for a method
        .meth_offset = offsetof(mp_obj_type_t, buffer_p.get_buffer),
        .dest = member,
        .is_type = false,
    };
    mp_obj_class_lookup(&lookup, self->base.type);
    if (member[0] == MP_OBJ_SENTINEL) {
        mp_obj_type_t *type = mp_obj_get_type(self->subobj[0]);
        return type->buffer_p.get_buffer(self->subobj[0], bufinfo, flags);
    } else {
        return 1; // object does not support buffer protocol
    }
}

677
678
679
/******************************************************************************/
// type object
//  - the struct is mp_obj_type_t and is defined in obj.h so const types can be made
680
//  - there is a constant mp_obj_type_t (called mp_type_type) for the 'type' object
681
//  - creating a new class (a new type) creates a new mp_obj_type_t
682

683
STATIC void type_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
684
    (void)kind;
685
    mp_obj_type_t *self = self_in;
686
    print(env, "<class '%s'>", qstr_str(self->name));
687
688
}

689
STATIC mp_obj_t type_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
690
691
    (void)type_in;

692
    mp_arg_check_num(n_args, n_kw, 1, 3, false);
693

694
695
696
697
698
    switch (n_args) {
        case 1:
            return mp_obj_get_type(args[0]);

        case 3:
699
            // args[0] = name
700
            // args[1] = bases tuple
701
            // args[2] = locals dict
702
            return mp_obj_new_type(mp_obj_str_get_qstr(args[0]), args[1], args[2]);
703
704

        default:
705
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "type takes 1 or 3 arguments"));
706
707
708
    }
}

709
STATIC mp_obj_t type_call(mp_obj_t self_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
710
711
    // instantiate an instance of a class

712
    mp_obj_type_t *self = self_in;
713
714

    if (self->make_new == NULL) {
715
716
717
718
719
720
        if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "cannot create instance"));
        } else {
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                "cannot create '%s' instances", qstr_str(self->name)));
        }
721
    }
722
723

    // make new instance
724
    mp_obj_t o = self->make_new(self, n_args, n_kw, args);
725
726
727
728
729

    // return new instance
    return o;
}

730
// for fail, do nothing; for attr, dest[0] = value; for method, dest[0] = method, dest[1] = self
731
STATIC void type_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
732
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
733
    mp_obj_type_t *self = self_in;
734
#if MICROPY_CPYTHON_COMPAT
735
736
737
738
    if (attr == MP_QSTR___name__) {
        dest[0] = MP_OBJ_NEW_QSTR(self->name);
        return;
    }
739
#endif
740
    struct class_lookup_data lookup = {
741
        .obj = self_in,
742
743
744
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
745
        .is_type = true,
746
747
    };
    mp_obj_class_lookup(&lookup, self);
748
749
}

750
STATIC bool type_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
751
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
752
753
    mp_obj_type_t *self = self_in;

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

756
    if (self->locals_dict != NULL) {
757
        assert(MP_OBJ_IS_TYPE(self->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
758
        mp_map_t *locals_map = mp_obj_dict_get_map(self->locals_dict);
759
760
761
762
763
764
765
766
767
768
769
770
771
        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;
            }
772
        }
773
    }
774
775

    return false;
776
777
}

778
779
const mp_obj_type_t mp_type_type = {
    { &mp_type_type },
780
    .name = MP_QSTR_type,
781
    .print = type_print,
782
    .make_new = type_make_new,
783
    .call = type_call,
784
785
    .load_attr = type_load_attr,
    .store_attr = type_store_attr,
786
};
787

788
mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict) {
789
    assert(MP_OBJ_IS_TYPE(bases_tuple, &mp_type_tuple)); // Micro Python restriction, for now
790
    assert(MP_OBJ_IS_TYPE(locals_dict, &mp_type_dict)); // Micro Python restriction, for now
791

792
793
    // TODO might need to make a copy of locals_dict; at least that's how CPython does it

794
    // Basic validation of base classes
795
    mp_uint_t len;
796
797
798
799
800
801
802
    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) {
803
804
805
806
807
808
809
            if (MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE) {
                nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError,
                    "type is not an acceptable base type"));
            } else {
                nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
                    "type '%s' is not an acceptable base type", qstr_str(t->name)));
            }
810
811
812
        }
    }

813
    mp_obj_type_t *o = m_new0(mp_obj_type_t, 1);
814
    o->base.type = &mp_type_type;
815
    o->name = name;
816
817
    o->print = instance_print;
    o->make_new = instance_make_new;
818
    o->call = mp_obj_instance_call;
819
820
    o->unary_op = instance_unary_op;
    o->binary_op = instance_binary_op;
821
822
    o->load_attr = mp_obj_instance_load_attr;
    o->store_attr = mp_obj_instance_store_attr;
823
    o->subscr = instance_subscr;
824
    o->getiter = instance_getiter;
825
826
827
    //o->iternext = ; not implemented
    o->buffer_p.get_buffer = instance_get_buffer;
    //o->stream_p = ; not implemented
828
829
    o->bases_tuple = bases_tuple;
    o->locals_dict = locals_dict;
830
831

    const mp_obj_type_t *native_base;
832
    uint num_native_bases = instance_count_native_bases(o, &native_base);
833
834
835
836
    if (num_native_bases > 1) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "multiple bases have instance lay-out conflict"));
    }

837
838
839
840
    mp_map_t *locals_map = mp_obj_dict_get_map(o->locals_dict);
    mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(MP_QSTR___new__), MP_MAP_LOOKUP);
    if (elem != NULL) {
        // __new__ slot exists; check if it is a function
841
        if (MP_OBJ_IS_FUN(elem->value)) {
842
843
844
845
846
            // __new__ is a function, wrap it in a staticmethod decorator
            elem->value = static_class_method_make_new((mp_obj_t)&mp_type_staticmethod, 1, 0, &elem->value);
        }
    }

847
848
    return o;
}
849
850

/******************************************************************************/
Damien George's avatar
Damien George committed
851
852
853
854
855
856
857
858
// 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;

859
STATIC void super_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
860
    (void)kind;
Damien George's avatar
Damien George committed
861
862
863
864
865
866
867
868
    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, ">");
}

869
STATIC mp_obj_t super_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
870
    (void)type_in;
871
872
873
    // 0 arguments are turned into 2 in the compiler
    // 1 argument is not yet implemented
    mp_arg_check_num(n_args, n_kw, 2, 2, false);
Damien George's avatar
Damien George committed
874
875
876
877
    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
878
STATIC void super_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
879
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_super));
Damien George's avatar
Damien George committed
880
881
    mp_obj_super_t *self = self_in;

882
    assert(MP_OBJ_IS_TYPE(self->type, &mp_type_type));
Damien George's avatar
Damien George committed
883
884
885
886
887
888
889
890

    mp_obj_type_t *type = self->type;

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

891
    mp_uint_t len;
Damien George's avatar
Damien George committed
892
893
    mp_obj_t *items;
    mp_obj_tuple_get(type->bases_tuple, &len, &items);
894
895
896
897
898
    struct class_lookup_data lookup = {
        .obj = self->obj,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
899
        .is_type = false,
900
    };
Damien George's avatar
Damien George committed
901
    for (uint i = 0; i < len; i++) {
902
        assert(MP_OBJ_IS_TYPE(items[i], &mp_type_type));
903
        mp_obj_class_lookup(&lookup, (mp_obj_type_t*)items[i]);
904
905
906
        if (dest[0] != MP_OBJ_NULL) {
            return;
        }
Damien George's avatar
Damien George committed
907
    }