objtype.c 40.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
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
STATIC mp_obj_t mp_obj_new_instance(mp_obj_t class, uint subobjs) {
52
    mp_obj_instance_t *o = m_new_obj_var(mp_obj_instance_t, mp_obj_t, subobjs);
53
54
    o->base.type = class;
    mp_map_init(&o->members, 0);
55
    mp_seq_clear(o->subobj, 0, subobjs, sizeof(*o->subobj));
56
57
58
    return o;
}

59
STATIC int instance_count_native_bases(const mp_obj_type_t *type, const mp_obj_type_t **last_native_base) {
60
    mp_uint_t len;
61
62
63
64
65
66
    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));
67
68
69
70
71
        const mp_obj_type_t *bt = (const mp_obj_type_t *)items[i];
        if (bt == &mp_type_object) {
            // Not a "real" type
            continue;
        }
72
        if (mp_obj_is_native_type(bt)) {
73
            *last_native_base = bt;
74
75
            count++;
        } else {
76
            count += instance_count_native_bases(bt, last_native_base);
77
78
79
80
81
82
83
84
85
86
87
        }
    }

    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/
//
88
89
90
91
92
93
94
95
96
// will keep lookup->dest[0]'s value (should be MP_OBJ_NULL on invocation) if attribute
// is not found
// will set lookup->dest[0] to MP_OBJ_SENTINEL if special method was found in a native
// type base via slot id (as specified by lookup->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 its instance->subobj[0] from. But this case is handled via
// instance_count_native_bases(), which returns a native base which it saw.
97
98
99
struct class_lookup_data {
    mp_obj_instance_t *obj;
    qstr attr;
100
    mp_uint_t meth_offset;
101
    mp_obj_t *dest;
102
    bool is_type;
103
104
105
106
107
};

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);
108
    for (;;) {
109
110
111
112
        // 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.
113
        if (lookup->meth_offset != 0 && mp_obj_is_native_type(type)) {
114
115
116
            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;
117
                return;
118
119
120
            }
        }

121
        if (type->locals_dict != NULL) {
122
            // search locals_dict (the set of methods/attributes)
123
            assert(MP_OBJ_IS_TYPE(type->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
124
            mp_map_t *locals_map = mp_obj_dict_get_map(type->locals_dict);
125
            mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(lookup->attr), MP_MAP_LOOKUP);
126
            if (elem != NULL) {
127
                if (lookup->is_type) {
128
129
                    // If we look up a class method, we need to return original type for which we
                    // do a lookup, not a (base) type in which we found the class method.
130
                    const mp_obj_type_t *org_type = (const mp_obj_type_t*)lookup->obj;
131
                    mp_convert_member_lookup(NULL, org_type, elem->value, lookup->dest);
132
                } else {
133
                    mp_obj_instance_t *obj = lookup->obj;
134
                    if (obj != MP_OBJ_NULL && mp_obj_is_native_type(type) && type != &mp_type_object /* object is not a real type */) {
135
136
137
                        // If we're dealing with native base class, then it applies to native sub-object
                        obj = obj->subobj[0];
                    }
138
                    mp_convert_member_lookup(obj, type, elem->value, lookup->dest);
139
                }
140
141
142
143
144
#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
145
                return;
146
            }
147
148
        }

149
150
151
        // Previous code block takes care about attributes defined in .locals_dict,
        // but some attributes of native types may be handled using .load_attr method,
        // so make sure we try to lookup those too.
152
        if (lookup->obj != MP_OBJ_NULL && !lookup->is_type && mp_obj_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(const mp_print_t *print, 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
        // Handle Exception subclasses specially
        if (mp_obj_is_native_exception_instance(self->subobj[0])) {
            if (kind != PRINT_STR) {
218
                mp_print_str(print, qstr_str(self->base.type->name));
219
            }
220
            mp_obj_print_helper(print, self->subobj[0], kind | PRINT_EXC_SUBCLASS);
221
        } else {
222
            mp_obj_print_helper(print, self->subobj[0], kind);
223
        }
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
        mp_obj_print_helper(print, r, PRINT_STR);
230
231
232
233
        return;
    }

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

237
mp_obj_t mp_obj_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
    assert(mp_obj_is_instance_type(self));
241

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

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

248
249
250
251
252
253
254
255
    // 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;
    }

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

267
    mp_obj_t new_ret = o;
268
    if (init_fn[0] == MP_OBJ_SENTINEL) {
269
270
271
        // 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);
272
    } else if (init_fn[0] != MP_OBJ_NULL) {
273
        // now call Python class __new__ function with all args
274
        if (n_args == 0 && n_kw == 0) {
275
            new_ret = mp_call_function_n_kw(init_fn[0], 1, 0, (mp_obj_t*)(void*)&self_in);
276
        } else {
277
            mp_obj_t *args2 = m_new(mp_obj_t, 1 + n_args + 2 * n_kw);
278
            args2[0] = self_in;
279
            memcpy(args2 + 1, args, (n_args + 2 * n_kw) * sizeof(mp_obj_t));
280
            new_ret = mp_call_function_n_kw(init_fn[0], n_args + 1, n_kw, args2);
281
            m_del(mp_obj_t, args2, 1 + n_args + 2 * n_kw);
282
        }
283
284
285
286
287
288
289
290
291
292
293
294

    }

    // 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
295
    init_fn[0] = init_fn[1] = MP_OBJ_NULL;
296
297
298
299
    lookup.obj = o;
    lookup.attr = MP_QSTR___init__;
    lookup.meth_offset = 0;
    mp_obj_class_lookup(&lookup, self);
300
301
302
303
304
305
306
307
308
309
310
311
    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);
        }
312
        if (init_ret != mp_const_none) {
313
314
315
316
317
318
319
            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)));
            }
320
321
322
323
324
325
326
        }

    }

    return o;
}

327
const qstr mp_unary_op_method_name[] = {
Damien George's avatar
Damien George committed
328
329
    [MP_UNARY_OP_BOOL] = MP_QSTR___bool__,
    [MP_UNARY_OP_LEN] = MP_QSTR___len__,
330
    [MP_UNARY_OP_HASH] = MP_QSTR___hash__,
331
332
333
334
335
    #if MICROPY_PY_ALL_SPECIAL_METHODS
    [MP_UNARY_OP_POSITIVE] = MP_QSTR___pos__,
    [MP_UNARY_OP_NEGATIVE] = MP_QSTR___neg__,
    [MP_UNARY_OP_INVERT] = MP_QSTR___invert__,
    #endif
Damien George's avatar
Damien George committed
336
    [MP_UNARY_OP_NOT] = MP_QSTR_, // don't need to implement this, used to make sure array has full size
337
338
};

339
STATIC mp_obj_t instance_unary_op(mp_uint_t op, mp_obj_t self_in) {
340
    mp_obj_instance_t *self = self_in;
341
    qstr op_name = mp_unary_op_method_name[op];
342
    /* Still try to lookup native slot
343
    if (op_name == 0) {
344
        return MP_OBJ_NULL;
345
    }
346
    */
347
    mp_obj_t member[2] = {MP_OBJ_NULL};
348
349
350
351
352
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = op_name,
        .meth_offset = offsetof(mp_obj_type_t, unary_op),
        .dest = member,
353
        .is_type = false,
354
355
    };
    mp_obj_class_lookup(&lookup, self->base.type);
356
    if (member[0] == MP_OBJ_SENTINEL) {
357
        return mp_unary_op(op, self->subobj[0]);
358
    } else if (member[0] != MP_OBJ_NULL) {
359
360
361
        mp_obj_t val = mp_call_function_1(member[0], self_in);
        // __hash__ must return a small int
        if (op == MP_UNARY_OP_HASH) {
362
            val = MP_OBJ_NEW_SMALL_INT(mp_obj_get_int_truncated(val));
363
364
        }
        return val;
365
    } else {
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
        if (op == MP_UNARY_OP_HASH) {
            lookup.attr = MP_QSTR___eq__;
            mp_obj_class_lookup(&lookup, self->base.type);
            if (member[0] == MP_OBJ_NULL) {
                // https://docs.python.org/3/reference/datamodel.html#object.__hash__
                // "User-defined classes have __eq__() and __hash__() methods by default;
                // with them, all objects compare unequal (except with themselves) and 
                // x.__hash__() returns an appropriate value such that x == y implies
                // both that x is y and hash(x) == hash(y)."
                return MP_OBJ_NEW_SMALL_INT((mp_uint_t)self_in);
            }
            // "A class that overrides __eq__() and does not define __hash__() will have its __hash__() implicitly set to None.
            // When the __hash__() method of a class is None, instances of the class will raise an appropriate TypeError"
        }

381
        return MP_OBJ_NULL; // op not supported
382
383
384
    }
}

385
const qstr mp_binary_op_method_name[] = {
386
    /*
Damien George's avatar
Damien George committed
387
388
389
390
391
    MP_BINARY_OP_OR,
    MP_BINARY_OP_XOR,
    MP_BINARY_OP_AND,
    MP_BINARY_OP_LSHIFT,
    MP_BINARY_OP_RSHIFT,
392
    */
Damien George's avatar
Damien George committed
393
394
    [MP_BINARY_OP_ADD] = MP_QSTR___add__,
    [MP_BINARY_OP_SUBTRACT] = MP_QSTR___sub__,
395
396
397
398
399
    #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
400
    /*
Damien George's avatar
Damien George committed
401
402
403
404
405
406
    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,
407
408
409
    MP_BINARY_OP_INPLACE_RSHIFT,*/
    #if MICROPY_PY_ALL_SPECIAL_METHODS
    [MP_BINARY_OP_INPLACE_ADD] = MP_QSTR___iadd__,
410
    [MP_BINARY_OP_INPLACE_SUBTRACT] = MP_QSTR___isub__,
411
    #endif
412
    /*MP_BINARY_OP_INPLACE_MULTIPLY,
Damien George's avatar
Damien George committed
413
414
415
    MP_BINARY_OP_INPLACE_FLOOR_DIVIDE,
    MP_BINARY_OP_INPLACE_TRUE_DIVIDE,
    MP_BINARY_OP_INPLACE_MODULO,
416
417
    MP_BINARY_OP_INPLACE_POWER,*/
    [MP_BINARY_OP_LESS] = MP_QSTR___lt__,
418
419
420
421
422
423
    [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
424
425
426
    */
    [MP_BINARY_OP_IN] = MP_QSTR___contains__,
    /*
Damien George's avatar
Damien George committed
427
    MP_BINARY_OP_IS,
428
    */
Damien George's avatar
Damien George committed
429
    [MP_BINARY_OP_EXCEPTION_MATCH] = MP_QSTR_, // not implemented, used to make sure array has full size
430
431
};

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

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

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

474
475
476
477
478
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = dest,
479
        .is_type = false,
480
481
    };
    mp_obj_class_lookup(&lookup, self->base.type);
482
    mp_obj_t member = dest[0];
483
    if (member != MP_OBJ_NULL) {
484
        #if MICROPY_PY_BUILTINS_PROPERTY
485
        if (MP_OBJ_IS_TYPE(member, &mp_type_property)) {
486
487
488
489
490
491
492
            // object member is a property; delegate the load to the property
            // Note: This is an optimisation for code size and execution time.
            // The proper way to do it is have the functionality just below
            // in a __get__ method of the property object, and then it would
            // be called by the descriptor code down below.  But that way
            // requires overhead for the nested mp_call's and overhead for
            // the code.
493
494
            const mp_obj_t *proxy = mp_obj_property_get(member);
            if (proxy[0] == mp_const_none) {
495
                nlr_raise(mp_obj_new_exception_msg(&mp_type_AttributeError, "unreadable attribute"));
496
497
498
            } else {
                dest[0] = mp_call_function_n_kw(proxy[0], 1, 0, &self_in);
            }
499
            return;
500
        }
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
        #endif

        #if MICROPY_PY_DESCRIPTORS
        // found a class attribute; if it has a __get__ method then call it with the
        // class instance and class as arguments and return the result
        // Note that this is functionally correct but very slow: each load_attr
        // requires an extra mp_load_method_maybe to check for the __get__.
        mp_obj_t attr_get_method[4];
        mp_load_method_maybe(member, MP_QSTR___get__, attr_get_method);
        if (attr_get_method[0] != MP_OBJ_NULL) {
            attr_get_method[2] = self_in;
            attr_get_method[3] = mp_obj_get_type(self_in);
            dest[0] = mp_call_method_n_kw(2, 0, attr_get_method);
        }
        #endif
Damien George's avatar
Damien George committed
516
517
518
519
520
521
522
523
524
525
526
527
        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);
528
529
530
531
532
            return;
        }
    }
}

533
STATIC bool mp_obj_instance_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
534
    mp_obj_instance_t *self = self_in;
535

536
537
538
539
540
    #if MICROPY_PY_BUILTINS_PROPERTY || MICROPY_PY_DESCRIPTORS
    // With property and/or descriptors enabled we need to do a lookup
    // first in the class dict for the attribute to see if the store should
    // be delegated.
    // Note: this makes all stores slow... how to fix?
541
    mp_obj_t member[2] = {MP_OBJ_NULL};
542
543
544
545
546
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = attr,
        .meth_offset = 0,
        .dest = member,
547
        .is_type = false,
548
549
    };
    mp_obj_class_lookup(&lookup, self->base.type);
550
551
552
553

    if (member[0] != MP_OBJ_NULL) {
        #if MICROPY_PY_BUILTINS_PROPERTY
        if (MP_OBJ_IS_TYPE(member[0], &mp_type_property)) {
554
            // attribute exists and is a property; delegate the store/delete
555
            // Note: This is an optimisation for code size and execution time.
556
557
558
            // The proper way to do it is have the functionality just below in
            // a __set__/__delete__ method of the property object, and then it
            // would be called by the descriptor code down below.  But that way
559
560
561
            // requires overhead for the nested mp_call's and overhead for
            // the code.
            const mp_obj_t *proxy = mp_obj_property_get(member[0]);
562
563
564
565
566
567
568
569
570
571
            mp_obj_t dest[2] = {self_in, value};
            if (value == MP_OBJ_NULL) {
                // delete attribute
                if (proxy[2] == mp_const_none) {
                    // TODO better error message?
                    return false;
                } else {
                    mp_call_function_n_kw(proxy[2], 1, 0, dest);
                    return true;
                }
572
            } else {
573
574
575
576
577
578
579
580
                // store attribute
                if (proxy[1] == mp_const_none) {
                    // TODO better error message?
                    return false;
                } else {
                    mp_call_function_n_kw(proxy[1], 2, 0, dest);
                    return true;
                }
581
582
583
584
585
            }
        }
        #endif

        #if MICROPY_PY_DESCRIPTORS
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
        // found a class attribute; if it has a __set__/__delete__ method then
        // call it with the class instance (and value) as arguments
        if (value == MP_OBJ_NULL) {
            // delete attribute
            mp_obj_t attr_delete_method[3];
            mp_load_method_maybe(member[0], MP_QSTR___delete__, attr_delete_method);
            if (attr_delete_method[0] != MP_OBJ_NULL) {
                attr_delete_method[2] = self_in;
                mp_call_method_n_kw(1, 0, attr_delete_method);
                return true;
            }
        } else {
            // store attribute
            mp_obj_t attr_set_method[4];
            mp_load_method_maybe(member[0], MP_QSTR___set__, attr_set_method);
            if (attr_set_method[0] != MP_OBJ_NULL) {
                attr_set_method[2] = self_in;
                attr_set_method[3] = value;
                mp_call_method_n_kw(2, 0, attr_set_method);
                return true;
            }
607
        }
608
        #endif
609
    }
610
    #endif
611

612
613
    if (value == MP_OBJ_NULL) {
        // delete attribute
614
615
        mp_map_elem_t *elem = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_REMOVE_IF_FOUND);
        return elem != NULL;
616
617
618
619
620
    } else {
        // store attribute
        mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_ADD_IF_NOT_FOUND)->value = value;
        return true;
    }
621
622
}

623
624
625
626
627
628
629
630
631
632
void mp_obj_instance_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
    if (dest[0] == MP_OBJ_NULL) {
        mp_obj_instance_load_attr(self_in, attr, dest);
    } else {
        if (mp_obj_instance_store_attr(self_in, attr, dest[1])) {
            dest[0] = MP_OBJ_NULL; // indicate success
        }
    }
}

633
STATIC mp_obj_t instance_subscr(mp_obj_t self_in, mp_obj_t index, mp_obj_t value) {
634
    mp_obj_instance_t *self = self_in;
635
    mp_obj_t member[2] = {MP_OBJ_NULL};
636
637
638
639
    struct class_lookup_data lookup = {
        .obj = self,
        .meth_offset = offsetof(mp_obj_type_t, subscr),
        .dest = member,
640
        .is_type = false,
641
    };
642
    uint meth_args;
643
644
    if (value == MP_OBJ_NULL) {
        // delete item
645
646
        lookup.attr = MP_QSTR___delitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
647
        meth_args = 2;
648
649
    } else if (value == MP_OBJ_SENTINEL) {
        // load item
650
651
        lookup.attr = MP_QSTR___getitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
652
        meth_args = 2;
653
    } else {
654
        // store item
655
656
        lookup.attr = MP_QSTR___setitem__;
        mp_obj_class_lookup(&lookup, self->base.type);
657
        meth_args = 3;
658
    }
659
    if (member[0] == MP_OBJ_SENTINEL) {
660
        return mp_obj_subscr(self->subobj[0], index, value);
661
    } else if (member[0] != MP_OBJ_NULL) {
662
        mp_obj_t args[3] = {self_in, index, value};
663
        // TODO probably need to call mp_convert_member_lookup, and use mp_call_method_n_kw
664
        mp_obj_t ret = mp_call_function_n_kw(member[0], meth_args, 0, args);
665
666
667
668
669
        if (value == MP_OBJ_SENTINEL) {
            return ret;
        } else {
            return mp_const_none;
        }
670
    } else {
671
        return MP_OBJ_NULL; // op not supported
672
673
674
    }
}

675
STATIC mp_obj_t mp_obj_instance_get_call(mp_obj_t self_in) {
676
    mp_obj_instance_t *self = self_in;
677
    mp_obj_t member[2] = {MP_OBJ_NULL, MP_OBJ_NULL};
678
679
680
681
682
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = MP_QSTR___call__,
        .meth_offset = offsetof(mp_obj_type_t, call),
        .dest = member,
683
        .is_type = false,
684
685
    };
    mp_obj_class_lookup(&lookup, self->base.type);
686
687
688
689
690
    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;
691
692
693
}

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) {
694
695
    mp_obj_t call = mp_obj_instance_get_call(self_in);
    if (call == MP_OBJ_NULL) {
696
697
698
699
700
701
702
        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)));
        }
703
    }
704
705
    mp_obj_instance_t *self = self_in;
    if (call == MP_OBJ_SENTINEL) {
706
707
        return mp_call_function_n_kw(self->subobj[0], n_args, n_kw, args);
    }
708
    mp_obj_t meth = mp_obj_new_bound_meth(call, self);
709
710
711
    return mp_call_function_n_kw(meth, n_args, n_kw, args);
}

712
713
714
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};
715
716
717
718
719
    struct class_lookup_data lookup = {
        .obj = self,
        .attr = MP_QSTR___iter__,
        .meth_offset = offsetof(mp_obj_type_t, getiter),
        .dest = member,
720
        .is_type = false,
721
722
    };
    mp_obj_class_lookup(&lookup, self->base.type);
723
724
    if (member[0] == MP_OBJ_NULL) {
        return MP_OBJ_NULL;
725
    } else if (member[0] == MP_OBJ_SENTINEL) {
726
727
        mp_obj_type_t *type = mp_obj_get_type(self->subobj[0]);
        return type->getiter(self->subobj[0]);
728
729
    } else {
        return mp_call_method_n_kw(0, 0, member);
730
731
732
    }
}

733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
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
    }
}

752
753
754
/******************************************************************************/
// type object
//  - the struct is mp_obj_type_t and is defined in obj.h so const types can be made
755
//  - there is a constant mp_obj_type_t (called mp_type_type) for the 'type' object
756
//  - creating a new class (a new type) creates a new mp_obj_type_t
757

758
STATIC void type_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
759
    (void)kind;
760
    mp_obj_type_t *self = self_in;
761
    mp_printf(print, "<class '%q'>", self->name);
762
763
}

764
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) {
765
766
    (void)type_in;

767
    mp_arg_check_num(n_args, n_kw, 1, 3, false);
768

769
770
771
772
773
    switch (n_args) {
        case 1:
            return mp_obj_get_type(args[0]);

        case 3:
774
            // args[0] = name
775
            // args[1] = bases tuple
776
            // args[2] = locals dict
777
            return mp_obj_new_type(mp_obj_str_get_qstr(args[0]), args[1], args[2]);
778
779

        default:
780
            nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "type takes 1 or 3 arguments"));
781
782
783
    }
}

784
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) {
785
786
    // instantiate an instance of a class

787
    mp_obj_type_t *self = self_in;
788
789

    if (self->make_new == NULL) {
790
791
792
793
        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,
794
                "cannot create '%q' instances", self->name));
795
        }
796
    }
797
798

    // make new instance
799
    mp_obj_t o = self->make_new(self, n_args, n_kw, args);
800
801
802
803
804

    // return new instance
    return o;
}

805
STATIC void type_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
806
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_type));
807
    mp_obj_type_t *self = self_in;
808

809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
    if (dest[0] == MP_OBJ_NULL) {
        // load attribute
        #if MICROPY_CPYTHON_COMPAT
        if (attr == MP_QSTR___name__) {
            dest[0] = MP_OBJ_NEW_QSTR(self->name);
            return;
        }
        #endif
        struct class_lookup_data lookup = {
            .obj = self_in,
            .attr = attr,
            .meth_offset = 0,
            .dest = dest,
            .is_type = true,
        };
        mp_obj_class_lookup(&lookup, self);
    } else {
        // delete/store attribute
827

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

830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
        if (self->locals_dict != NULL) {
            assert(MP_OBJ_IS_TYPE(self->locals_dict, &mp_type_dict)); // Micro Python restriction, for now
            mp_map_t *locals_map = mp_obj_dict_get_map(self->locals_dict);
            if (dest[1] == 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
                if (elem != NULL) {
                    dest[0] = MP_OBJ_NULL; // indicate success
                }
            } 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 = dest[1];
                    dest[0] = MP_OBJ_NULL; // indicate success
                }
848
            }
849
        }
850
    }
851
852
}

853
854
const mp_obj_type_t mp_type_type = {
    { &mp_type_type },
855
    .name = MP_QSTR_type,
856
    .print = type_print,
857
    .make_new = type_make_new,
858
    .call = type_call,
859
    .unary_op = mp_generic_unary_op,
860
    .attr = type_attr,
861
};
862

863
mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict) {
864
    assert(MP_OBJ_IS_TYPE(bases_tuple, &mp_type_tuple)); // Micro Python restriction, for now
865
    assert(MP_OBJ_IS_TYPE(locals_dict, &mp_type_dict)); // Micro Python restriction, for now
866

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

869
    // Basic validation of base classes
870
    mp_uint_t len;
871
872
873
874
875
876
877
    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) {
878
879
880
881
882
            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,
883
                    "type '%q' is not an acceptable base type", t->name));
884
            }
885
886
887
        }
    }

888
    mp_obj_type_t *o = m_new0(mp_obj_type_t, 1);
889
    o->base.type = &mp_type_type;
890
    o->name = name;
891
    o->print = instance_print;
892
    o->make_new = mp_obj_instance_make_new;
893
    o->call = mp_obj_instance_call;
894
895
    o->unary_op = instance_unary_op;
    o->binary_op = instance_binary_op;
896
    o->attr = mp_obj_instance_attr;
897
    o->subscr = instance_subscr;
898
    o->getiter = instance_getiter;
899
900
901
    //o->iternext = ; not implemented
    o->buffer_p.get_buffer = instance_get_buffer;
    //o->stream_p = ; not implemented
902
903
    o->bases_tuple = bases_tuple;
    o->locals_dict = locals_dict;
904
905

    const mp_obj_type_t *native_base;
906
    uint num_native_bases = instance_count_native_bases(o, &native_base);
907
908
909
910
    if (num_native_bases > 1) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "multiple bases have instance lay-out conflict"));
    }

911
912
913
914
    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
915
        if (MP_OBJ_IS_FUN(elem->value)) {
916
917
918
919
920
            // __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);
        }
    }

921
922
    return o;
}
923
924

/******************************************************************************/
Damien George's avatar
Damien George committed
925
926
927
928
929
930
931
932
// 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;

933
STATIC void super_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
934
    (void)kind;
Damien George's avatar
Damien George committed
935
    mp_obj_super_t *self = self_in;
936
937
938
939
940
    mp_print_str(print, "<super: ");
    mp_obj_print_helper(print, self->type, PRINT_STR);
    mp_print_str(print, ", ");
    mp_obj_print_helper(print, self->obj, PRINT_STR);
    mp_print_str(print, ">");
Damien George's avatar
Damien George committed
941
942
}

943
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)