objtype.c 13.4 KB
Newer Older
1
2
#include <stdlib.h>
#include <stdint.h>
3
4
#include <string.h>
#include <assert.h>
5
6
7
8

#include "nlr.h"
#include "misc.h"
#include "mpconfig.h"
9
#include "mpqstr.h"
10
#include "obj.h"
11
#include "map.h"
12
#include "runtime0.h"
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#include "runtime.h"

/******************************************************************************/
// class object
// creating an instance of a class makes one of these objects

typedef struct _mp_obj_class_t {
    mp_obj_base_t base;
    mp_map_t members;
} mp_obj_class_t;

static mp_obj_t mp_obj_new_class(mp_obj_t class) {
    mp_obj_class_t *o = m_new_obj(mp_obj_class_t);
    o->base.type = class;
    mp_map_init(&o->members, 0);
    return o;
}

31
static mp_map_elem_t *mp_obj_class_lookup(const mp_obj_type_t *type, qstr attr, mp_map_lookup_kind_t lookup_kind) {
32
    for (;;) {
33
        if (type->locals_dict == NULL) {
34
35
            return NULL;
        }
36
37
        assert(MP_OBJ_IS_TYPE(type->locals_dict, &dict_type)); // Micro Python restriction, for now
        mp_map_t *locals_map = ((void*)type->locals_dict + sizeof(mp_obj_base_t)); // XXX hack to get map object from dict object
38
39
40
41
42
43
44
45
        mp_map_elem_t *elem = mp_map_lookup(locals_map, MP_OBJ_NEW_QSTR(attr), lookup_kind);
        if (elem != NULL) {
            return elem;
        }

        // attribute not found, keep searching base classes

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

        uint len;
        mp_obj_t *items;
52
        mp_obj_tuple_get(type->bases_tuple, &len, &items);
53
54
55
56
        if (len == 0) {
            return NULL;
        }
        for (uint i = 0; i < len - 1; i++) {
57
58
            assert(MP_OBJ_IS_TYPE(items[i], &mp_const_type));
            elem = mp_obj_class_lookup((mp_obj_type_t*)items[i], attr, lookup_kind);
59
60
61
62
63
64
            if (elem != NULL) {
                return elem;
            }
        }

        // search last base (simple tail recursion elimination)
65
66
        assert(MP_OBJ_IS_TYPE(items[len - 1], &mp_const_type));
        type = (mp_obj_type_t*)items[len - 1];
67
68
69
    }
}

70
static void class_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
71
72
73
    print(env, "<%s object at %p>", mp_obj_get_type_str(self_in), self_in);
}

74
static mp_obj_t class_make_new(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
75
    assert(MP_OBJ_IS_TYPE(self_in, &mp_const_type));
76
    mp_obj_type_t *self = self_in;
77
78
79
80

    mp_obj_t o = mp_obj_new_class(self_in);

    // look for __init__ function
81
    mp_map_elem_t *init_fn = mp_obj_class_lookup(self, MP_QSTR___init__, MP_MAP_LOOKUP);
82
83
84
85

    if (init_fn != NULL) {
        // call __init__ function
        mp_obj_t init_ret;
86
87
        if (n_args == 0 && n_kw == 0) {
            init_ret = rt_call_function_n_kw(init_fn->value, 1, 0, (mp_obj_t*)&o);
88
        } else {
89
90
91
92
93
            mp_obj_t *args2 = m_new(mp_obj_t, 1 + n_args + 2 * n_kw);
            args2[0] = o;
            memcpy(args2 + 1, args, (n_args + 2 * n_kw) * sizeof(mp_obj_t));
            init_ret = rt_call_function_n_kw(init_fn->value, n_args + 1, n_kw, args2);
            m_del(mp_obj_t, args2, 1 + n_args + 2 * n_kw);
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
        }
        if (init_ret != mp_const_none) {
            nlr_jump(mp_obj_new_exception_msg_1_arg(MP_QSTR_TypeError, "__init__() should return None, not '%s'", mp_obj_get_type_str(init_ret)));
        }

    } else {
        // TODO
        if (n_args != 0) {
            nlr_jump(mp_obj_new_exception_msg_1_arg(MP_QSTR_TypeError, "function takes 0 positional arguments but %d were given", (void*)(machine_int_t)n_args));
        }
    }

    return o;
}

109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
// TODO somehow replace const char * with a qstr
static const char *binary_op_method_name[] = {
    [RT_BINARY_OP_SUBSCR] = "__getitem__",
    /*
    RT_BINARY_OP_OR,
    RT_BINARY_OP_XOR,
    RT_BINARY_OP_AND,
    RT_BINARY_OP_LSHIFT,
    RT_BINARY_OP_RSHIFT,
    */
    [RT_BINARY_OP_ADD] = "__add__",
    [RT_BINARY_OP_SUBTRACT] = "__sub__",
    /*
    RT_BINARY_OP_MULTIPLY,
    RT_BINARY_OP_FLOOR_DIVIDE,
    RT_BINARY_OP_TRUE_DIVIDE,
    RT_BINARY_OP_MODULO,
    RT_BINARY_OP_POWER,
    RT_BINARY_OP_INPLACE_OR,
    RT_BINARY_OP_INPLACE_XOR,
    RT_BINARY_OP_INPLACE_AND,
    RT_BINARY_OP_INPLACE_LSHIFT,
    RT_BINARY_OP_INPLACE_RSHIFT,
    RT_BINARY_OP_INPLACE_ADD,
    RT_BINARY_OP_INPLACE_SUBTRACT,
    RT_BINARY_OP_INPLACE_MULTIPLY,
    RT_BINARY_OP_INPLACE_FLOOR_DIVIDE,
    RT_BINARY_OP_INPLACE_TRUE_DIVIDE,
    RT_BINARY_OP_INPLACE_MODULO,
    RT_BINARY_OP_INPLACE_POWER,
    RT_COMPARE_OP_LESS,
    RT_COMPARE_OP_MORE,
    RT_COMPARE_OP_EQUAL,
    RT_COMPARE_OP_LESS_EQUAL,
    RT_COMPARE_OP_MORE_EQUAL,
    RT_COMPARE_OP_NOT_EQUAL,
    RT_COMPARE_OP_IN,
    RT_COMPARE_OP_NOT_IN,
    RT_COMPARE_OP_IS,
    RT_COMPARE_OP_IS_NOT,
    */
    [RT_COMPARE_OP_EXCEPTION_MATCH] = "__not_implemented__",
};

static mp_obj_t class_binary_op(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
    mp_obj_class_t *lhs = lhs_in;
    const char *op_name = binary_op_method_name[op];
    if (op_name == NULL) {
        return MP_OBJ_NULL;
    }
    mp_map_elem_t *elem = mp_obj_class_lookup(lhs->base.type, qstr_from_str_static(op_name), MP_MAP_LOOKUP);
    if (elem != NULL) {
        return rt_call_function_2(elem->value, lhs_in, rhs_in);
    } else {
        return MP_OBJ_NULL;
    }
}

167
168
169
170
171
172
static void class_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
    // logic: look in obj members then class locals (TODO check this against CPython)
    mp_obj_class_t *self = self_in;
    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
173
        dest[0] = elem->value;
174
175
        return;
    }
176
    elem = mp_obj_class_lookup(self->base.type, attr, MP_MAP_LOOKUP);
177
178
179
    if (elem != NULL) {
        if (mp_obj_is_callable(elem->value)) {
            // class member is callable so build a bound method
180
181
            dest[0] = elem->value;
            dest[1] = self_in;
182
183
184
            return;
        } else {
            // class member is a value, so just return that value
185
            dest[0] = elem->value;
186
187
188
189
190
191
192
193
            return;
        }
    }
}

static bool class_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
    // logic: look in class locals (no add) then obj members (add) (TODO check this against CPython)
    mp_obj_class_t *self = self_in;
194
    mp_map_elem_t *elem = mp_obj_class_lookup(self->base.type, attr, MP_MAP_LOOKUP);
195
196
197
198
199
200
201
202
    if (elem != NULL) {
        elem->value = value;
    } else {
        mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_ADD_IF_NOT_FOUND)->value = value;
    }
    return true;
}

203
204
205
206
207
208
209
210
211
212
213
bool class_store_item(mp_obj_t self_in, mp_obj_t index, mp_obj_t value) {
    mp_obj_class_t *self = self_in;
    mp_map_elem_t *elem = mp_obj_class_lookup(self->base.type, qstr_from_str_static("__setitem__"), MP_MAP_LOOKUP);
    if (elem != NULL) {
        mp_obj_t args[3] = {self_in, index, value};
        return rt_call_function_n_kw(elem->value, 3, 0, args);
    } else {
        return MP_OBJ_NULL;
    }
}

214
215
216
217
218
/******************************************************************************/
// type object
//  - the struct is mp_obj_type_t and is defined in obj.h so const types can be made
//  - there is a constant mp_obj_type_t (called mp_const_type) for the 'type' object
//  - creating a new class (a new type) creates a new mp_obj_type_t
219

220
static void type_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
221
222
223
224
    mp_obj_type_t *self = self_in;
    print(env, "<class '%s'>", self->name);
}

225
226
227
static mp_obj_t type_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
    // TODO check n_kw == 0

228
229
230
231
232
    switch (n_args) {
        case 1:
            return mp_obj_get_type(args[0]);

        case 3:
233
            // args[0] = name
234
            // args[1] = bases tuple
235
236
            // args[2] = locals dict
            return mp_obj_new_type(mp_obj_get_qstr(args[0]), args[1], args[2]);
237
238
239
240
241
242

        default:
            nlr_jump(mp_obj_new_exception_msg(MP_QSTR_TypeError, "type takes at 1 or 3 arguments"));
    }
}

243
static mp_obj_t type_call(mp_obj_t self_in, uint n_args, uint n_kw, const mp_obj_t *args) {
244
245
    // instantiate an instance of a class

246
    mp_obj_type_t *self = self_in;
247
248

    if (self->make_new == NULL) {
249
250
        nlr_jump(mp_obj_new_exception_msg_1_arg(MP_QSTR_TypeError, "cannot create '%s' instances", self->name));
    }
251
252

    // make new instance
253
    mp_obj_t o = self->make_new(self, n_args, n_kw, args);
254
255
256
257
258

    // return new instance
    return o;
}

259
// for fail, do nothing; for attr, dest[0] = value; for method, dest[0] = method, dest[1] = self
260
static void type_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
261
262
263
    assert(MP_OBJ_IS_TYPE(self_in, &mp_const_type));
    mp_obj_type_t *self = self_in;
    mp_map_elem_t *elem = mp_obj_class_lookup(self, attr, MP_MAP_LOOKUP);
264
    if (elem != NULL) {
265
        dest[0] = elem->value;
266
267
        return;
    }
268
269
270
271
272
273
274
275
276
277
278

    // generic method lookup
    // this is a lookup in the class itself (ie not the classes type or instance)
    const mp_method_t *meth = self->methods;
    if (meth != NULL) {
        for (; meth->name != NULL; meth++) {
            if (strcmp(meth->name, qstr_str(attr)) == 0) {
                // check if the methods are functions, static or class methods
                // see http://docs.python.org/3.3/howto/descriptor.html
                if (MP_OBJ_IS_TYPE(meth->fun, &mp_type_staticmethod)) {
                    // return just the function
279
                    dest[0] = ((mp_obj_staticmethod_t*)meth->fun)->fun;
280
281
                } else if (MP_OBJ_IS_TYPE(meth->fun, &mp_type_classmethod)) {
                    // return a bound method, with self being this class
282
283
                    dest[0] = ((mp_obj_classmethod_t*)meth->fun)->fun;
                    dest[1] = self_in;
284
285
286
                } else {
                    // return just the function
                    // TODO need to wrap in a type check for the first argument; eg list.append(1,1) needs to throw an exception
287
                    dest[0] = (mp_obj_t)meth->fun;
288
289
290
291
292
                }
                return;
            }
        }
    }
293
294
295
}

static bool type_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
296
297
298
    assert(MP_OBJ_IS_TYPE(self_in, &mp_const_type));
    mp_obj_type_t *self = self_in;

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

301
    mp_map_elem_t *elem = mp_obj_class_lookup(self, attr, MP_MAP_LOOKUP_ADD_IF_NOT_FOUND);
302
303
304
305
306
307
    if (elem != NULL) {
        elem->value = value;
        return true;
    } else {
        return false;
    }
308
309
310
311
}

const mp_obj_type_t mp_const_type = {
    { &mp_const_type },
312
    "type",
313
    .print = type_print,
314
    .make_new = type_make_new,
315
    .call = type_call,
316
317
    .load_attr = type_load_attr,
    .store_attr = type_store_attr,
318
};
319

320
321
322
mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict) {
    assert(MP_OBJ_IS_TYPE(bases_tuple, &tuple_type)); // Micro Python restriction, for now
    assert(MP_OBJ_IS_TYPE(locals_dict, &dict_type)); // Micro Python restriction, for now
323
324
325
326
327
    mp_obj_type_t *o = m_new0(mp_obj_type_t, 1);
    o->base.type = &mp_const_type;
    o->name = qstr_str(name);
    o->print = class_print;
    o->make_new = class_make_new;
328
    o->binary_op = class_binary_op;
329
330
    o->load_attr = class_load_attr;
    o->store_attr = class_store_attr;
331
    o->store_item = class_store_item;
332
333
    o->bases_tuple = bases_tuple;
    o->locals_dict = locals_dict;
334
335
    return o;
}
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388

/******************************************************************************/
// built-ins specific to types

static mp_obj_t mp_builtin_issubclass(mp_obj_t object, mp_obj_t classinfo) {
    if (!MP_OBJ_IS_TYPE(object, &mp_const_type)) {
        nlr_jump(mp_obj_new_exception_msg(MP_QSTR_TypeError, "issubclass() arg 1 must be a class"));
    }

    // TODO support a tuple of classes for second argument
    if (!MP_OBJ_IS_TYPE(classinfo, &mp_const_type)) {
        nlr_jump(mp_obj_new_exception_msg(MP_QSTR_TypeError, "issubclass() arg 2 must be a class"));
    }

    for (;;) {
        if (object == classinfo) {
            return mp_const_true;
        }

        // not equivalent classes, keep searching base classes

        assert(MP_OBJ_IS_TYPE(object, &mp_const_type));
        mp_obj_type_t *self = object;

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

        uint len;
        mp_obj_t *items;
        mp_obj_tuple_get(self->bases_tuple, &len, &items);
        if (len == 0) {
            return mp_const_false;
        }
        for (uint i = 0; i < len - 1; i++) {
            if (mp_builtin_issubclass(items[i], classinfo) == mp_const_true) {
                return mp_const_true;
            }
        }

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

MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_issubclass_obj, mp_builtin_issubclass);

static mp_obj_t mp_builtin_isinstance(mp_obj_t object, mp_obj_t classinfo) {
    return mp_builtin_issubclass(mp_obj_get_type(object), classinfo);
}

MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_isinstance_obj, mp_builtin_isinstance);
389
390
391
392
393
394
395
396
397
398
399
400
401

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

const mp_obj_type_t mp_type_staticmethod = {
    { &mp_const_type },
    "staticmethod",
};

const mp_obj_type_t mp_type_classmethod = {
    { &mp_const_type },
    "classmethod",
};