obj.h 19.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
// All Micro Python objects are at least this type
// It must be of pointer size

typedef machine_ptr_t mp_obj_t;
typedef machine_const_ptr_t mp_const_obj_t;

// Integers that fit in a pointer have this type
// (do we need to expose this in the public API?)

typedef machine_int_t mp_small_int_t;

12
13
// Anything that wants to be a Micro Python object must have
// mp_obj_base_t as its first member (except NULL and small ints)
14

ian-v's avatar
ian-v committed
15
struct _mp_obj_type_t;
16
struct _mp_obj_base_t {
ian-v's avatar
ian-v committed
17
    const struct _mp_obj_type_t *type;
18
};
ian-v's avatar
ian-v committed
19
typedef struct _mp_obj_base_t mp_obj_base_t;
20
21
22
23
24
25

// The NULL object is used to indicate the absence of an object
// It *cannot* be used when an mp_obj_t is expected, except where explicitly allowed

#define MP_OBJ_NULL ((mp_obj_t)NULL)

26
27
28
29
// These macros check for small int, qstr or object, and access small int and qstr values
//  - xxxx...xxx1: a small int, bits 1 and above are the value
//  - xxxx...xx10: a qstr, bits 2 and above are the value
//  - xxxx...xx00: a pointer to an mp_obj_base_t
30

31
// In SMALL_INT, next-to-highest bits is used as sign, so both must match for value in range
32
33
#define MP_SMALL_INT_MIN ((mp_small_int_t)(((machine_int_t)WORD_MSBIT_HIGH) >> 1))
#define MP_SMALL_INT_MAX ((mp_small_int_t)(~(MP_SMALL_INT_MIN)))
34
#define MP_OBJ_FITS_SMALL_INT(n) ((((n) ^ ((n) << 1)) & WORD_MSBIT_HIGH) == 0)
35
#define MP_OBJ_IS_SMALL_INT(o) ((((mp_small_int_t)(o)) & 1) != 0)
36
37
#define MP_OBJ_IS_QSTR(o) ((((mp_small_int_t)(o)) & 3) == 2)
#define MP_OBJ_IS_OBJ(o) ((((mp_small_int_t)(o)) & 3) == 0)
38
#define MP_OBJ_IS_TYPE(o, t) (MP_OBJ_IS_OBJ(o) && (((mp_obj_base_t*)(o))->type == (t))) // this does not work for checking a string, use below macro for that
39
#define MP_OBJ_IS_INT(o) (MP_OBJ_IS_SMALL_INT(o) || MP_OBJ_IS_TYPE(o, &int_type))
40
#define MP_OBJ_IS_STR(o) (MP_OBJ_IS_QSTR(o) || MP_OBJ_IS_TYPE(o, &str_type))
41

42
#define MP_OBJ_SMALL_INT_VALUE(o) (((mp_small_int_t)(o)) >> 1)
43
44
45
46
#define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)(((small_int) << 1) | 1))

#define MP_OBJ_QSTR_VALUE(o) (((mp_small_int_t)(o)) >> 2)
#define MP_OBJ_NEW_QSTR(qstr) ((mp_obj_t)((((machine_uint_t)qstr) << 2) | 2))
47
48
49
50
51

// These macros are used to declare and define constant function objects
// You can put "static" in front of the definitions to make them local

#define MP_DECLARE_CONST_FUN_OBJ(obj_name) extern const mp_obj_fun_native_t obj_name
52

53
#define MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, is_kw, n_args_min, n_args_max, fun_name) const mp_obj_fun_native_t obj_name = {{&fun_native_type}, is_kw, n_args_min, n_args_max, (void *)fun_name}
54
55
56
57
#define MP_DEFINE_CONST_FUN_OBJ_0(obj_name, fun_name) MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, false, 0, 0, (mp_fun_0_t)fun_name)
#define MP_DEFINE_CONST_FUN_OBJ_1(obj_name, fun_name) MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, false, 1, 1, (mp_fun_1_t)fun_name)
#define MP_DEFINE_CONST_FUN_OBJ_2(obj_name, fun_name) MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, false, 2, 2, (mp_fun_2_t)fun_name)
#define MP_DEFINE_CONST_FUN_OBJ_3(obj_name, fun_name) MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, false, 3, 3, (mp_fun_3_t)fun_name)
58
#define MP_DEFINE_CONST_FUN_OBJ_VAR(obj_name, n_args_min, fun_name) MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, false, n_args_min, MP_OBJ_FUN_ARGS_MAX, (mp_fun_var_t)fun_name)
59
#define MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(obj_name, n_args_min, n_args_max, fun_name) MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, false, n_args_min, n_args_max, (mp_fun_var_t)fun_name)
60
#define MP_DEFINE_CONST_FUN_OBJ_KW(obj_name, n_args_min, fun_name) MP_DEFINE_CONST_FUN_OBJ_VOID_PTR(obj_name, true, n_args_min, MP_OBJ_FUN_ARGS_MAX, (mp_fun_kw_t)fun_name)
61

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// This macro is used to define constant dict objects
// You can put "static" in front of the definition to make it local

#define MP_DEFINE_CONST_DICT(dict_name, table_name) \
    const mp_obj_dict_t dict_name = { \
        .base = {&dict_type}, \
        .map = { \
            .all_keys_are_qstrs = 1, \
            .table_is_fixed_array = 1, \
            .used = sizeof(table_name) / sizeof(mp_map_elem_t), \
            .alloc = sizeof(table_name) / sizeof(mp_map_elem_t), \
            .table = (mp_map_elem_t*)table_name, \
        }, \
    }

77
78
79
// These macros are used to declare and define constant staticmethond and classmethod objects
// You can put "static" in front of the definitions to make them local

80
81
#define MP_DECLARE_CONST_STATICMETHOD_OBJ(obj_name) extern const mp_obj_static_class_method_t obj_name
#define MP_DECLARE_CONST_CLASSMETHOD_OBJ(obj_name) extern const mp_obj_static_class_method_t obj_name
82

83
84
#define MP_DEFINE_CONST_STATICMETHOD_OBJ(obj_name, fun_name) const mp_obj_static_class_method_t obj_name = {{&mp_type_staticmethod}, fun_name}
#define MP_DEFINE_CONST_CLASSMETHOD_OBJ(obj_name, fun_name) const mp_obj_static_class_method_t obj_name = {{&mp_type_classmethod}, fun_name}
85

86
87
// Need to declare this here so we are not dependent on map.h
struct _mp_map_t;
88
struct _mp_map_elem_t;
89
90
91
92
93
94

// Type definitions for methods

typedef mp_obj_t (*mp_fun_0_t)(void);
typedef mp_obj_t (*mp_fun_1_t)(mp_obj_t);
typedef mp_obj_t (*mp_fun_2_t)(mp_obj_t, mp_obj_t);
95
typedef mp_obj_t (*mp_fun_3_t)(mp_obj_t, mp_obj_t, mp_obj_t);
96
typedef mp_obj_t (*mp_fun_t)(void);
97
typedef mp_obj_t (*mp_fun_var_t)(uint n, const mp_obj_t *);
98
typedef mp_obj_t (*mp_fun_kw_t)(uint n, const mp_obj_t *, struct _mp_map_t *);
99

100
101
102
103
104
typedef enum {
    PRINT_STR, PRINT_REPR
} mp_print_kind_t;

typedef void (*mp_print_fun_t)(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o, mp_print_kind_t kind);
105
106
typedef mp_obj_t (*mp_make_new_fun_t)(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args);
typedef mp_obj_t (*mp_call_fun_t)(mp_obj_t fun, uint n_args, uint n_kw, const mp_obj_t *args);
107
108
typedef mp_obj_t (*mp_unary_op_fun_t)(int op, mp_obj_t);
typedef mp_obj_t (*mp_binary_op_fun_t)(int op, mp_obj_t, mp_obj_t);
109
typedef void (*mp_load_attr_fun_t)(mp_obj_t self_in, qstr attr, mp_obj_t *dest); // for fail, do nothing; for attr, dest[0] = value; for method, dest[0] = method, dest[1] = self
110
typedef bool (*mp_store_attr_fun_t)(mp_obj_t self_in, qstr attr, mp_obj_t value); // return true if store succeeded
111
typedef bool (*mp_store_item_fun_t)(mp_obj_t self_in, mp_obj_t index, mp_obj_t value); // return true if store succeeded
112
113

typedef struct _mp_method_t {
114
    qstr name;
115
116
117
    mp_const_obj_t fun;
} mp_method_t;

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
// Buffer protocol
typedef struct _buffer_info_t {
    // if we'd bother to support various versions of structure
    // (with different number of fields), we can distinguish
    // them with ver = sizeof(struct). Cons: overkill for *micro*?
    //int ver; // ?

    void *buf;
    machine_int_t len;

    // Rationale: have array.array and have SIMD operations on them
    // Cons: users can pass item size to processing functions themselves,
    // though that's not "plug&play"
    // int itemsize;

    // Rationale: to load arbitrary-sized sprites directly to LCD
    // Cons: a bit adhoc usecase
    // int stride;
} buffer_info_t;
#define BUFFER_READ  (1)
#define BUFFER_WRITE (2)
#define BUFFER_RW (BUFFER_READ | BUFFER_WRITE)
typedef struct _mp_buffer_p_t {
    machine_int_t (*get_buffer)(mp_obj_t obj, buffer_info_t *bufinfo, int flags);
} mp_buffer_p_t;

// Stream protocol
typedef struct _mp_stream_p_t {
    // On error, functions should return -1 and fill in *errcode (values are
    // implementation-dependent, but will be exposed to user, e.g. via exception).
    machine_int_t (*read)(mp_obj_t obj, void *buf, machine_uint_t size, int *errcode);
    machine_int_t (*write)(mp_obj_t obj, const void *buf, machine_uint_t size, int *errcode);
    // add seek() ?
} mp_stream_p_t;

153
154
struct _mp_obj_type_t {
    mp_obj_base_t base;
155
    qstr name;
156
    mp_print_fun_t print;
157
    mp_make_new_fun_t make_new;     // to make an instance of the type
158

159
    mp_call_fun_t call;
160
161
162
    mp_unary_op_fun_t unary_op;     // can return NULL if op not supported
    mp_binary_op_fun_t binary_op;   // can return NULL if op not supported

163
164
165
166
167
168
    mp_load_attr_fun_t load_attr;
    mp_store_attr_fun_t store_attr;
    // Implements container[index] = val; note that load_item is implemented
    // by binary_op(RT_BINARY_OP_SUBSCR)
    mp_store_item_fun_t store_item;

169
    mp_fun_1_t getiter;
170
    mp_fun_1_t iternext; // may return MP_OBJ_NULL as an optimisation instead of raising StopIteration() (with no args)
171

172
173
174
175
176
177
    // Alternatively, pointer(s) to interfaces to save space
    // in mp_obj_type_t at the expense of extra pointer and extra dereference
    // when actually used.
    mp_buffer_p_t buffer_p;
    mp_stream_p_t stream_p;

178
179
180
    // these are for dynamically created types (classes)
    mp_obj_t bases_tuple;
    mp_obj_t locals_dict;
181

182
183
184
185
    /*
    What we might need to add here:

    store_subscr    list dict
186

187
188
189
190
191
192
193
194
195
    len             str tuple list map
    abs             float complex
    hash            bool int none str
    equal           int str

    unpack seq      list tuple
    */
};

ian-v's avatar
ian-v committed
196
typedef struct _mp_obj_type_t mp_obj_type_t;
197

198
199
// Constant types, globally accessible
extern const mp_obj_type_t mp_type_type;
200
201

// Exceptions
202
extern const mp_obj_type_t mp_type_BaseException;
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
extern const mp_obj_type_t mp_type_ArithmeticError;
extern const mp_obj_type_t mp_type_AssertionError;
extern const mp_obj_type_t mp_type_AttributeError;
extern const mp_obj_type_t mp_type_EOFError;
extern const mp_obj_type_t mp_type_Exception;
extern const mp_obj_type_t mp_type_GeneratorExit;
extern const mp_obj_type_t mp_type_IOError;
extern const mp_obj_type_t mp_type_ImportError;
extern const mp_obj_type_t mp_type_IndentationError;
extern const mp_obj_type_t mp_type_IndexError;
extern const mp_obj_type_t mp_type_KeyError;
extern const mp_obj_type_t mp_type_LookupError;
extern const mp_obj_type_t mp_type_MemoryError;
extern const mp_obj_type_t mp_type_NameError;
extern const mp_obj_type_t mp_type_NotImplementedError;
extern const mp_obj_type_t mp_type_OSError;
extern const mp_obj_type_t mp_type_OverflowError;
extern const mp_obj_type_t mp_type_RuntimeError;
221
extern const mp_obj_type_t mp_type_StopIteration;
222
223
224
225
226
227
extern const mp_obj_type_t mp_type_SyntaxError;
extern const mp_obj_type_t mp_type_SystemError;
extern const mp_obj_type_t mp_type_TypeError;
extern const mp_obj_type_t mp_type_ValueError;
extern const mp_obj_type_t mp_type_ZeroDivisionError;

228
229
230
231
// Constant objects, globally accessible
extern const mp_obj_t mp_const_none;
extern const mp_obj_t mp_const_false;
extern const mp_obj_t mp_const_true;
232
extern const mp_obj_t mp_const_empty_tuple;
Damien George's avatar
Damien George committed
233
extern const mp_obj_t mp_const_ellipsis;
234
extern const mp_obj_t mp_const_GeneratorExit;
235
236
237

// General API for objects

238
mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict);
239
240
mp_obj_t mp_obj_new_none(void);
mp_obj_t mp_obj_new_bool(bool value);
Damien George's avatar
Damien George committed
241
mp_obj_t mp_obj_new_cell(mp_obj_t obj);
242
mp_obj_t mp_obj_new_int(machine_int_t value);
243
244
mp_obj_t mp_obj_new_int_from_uint(machine_uint_t value);
mp_obj_t mp_obj_new_int_from_long_str(const char *s);
245
mp_obj_t mp_obj_new_int_from_ll(long long val); // this must return a multi-precision integer object (or raise an overflow exception)
246
mp_obj_t mp_obj_new_str(const byte* data, uint len, bool make_qstr_if_not_already);
247
mp_obj_t mp_obj_new_bytes(const byte* data, uint len);
248
#if MICROPY_ENABLE_FLOAT
249
250
mp_obj_t mp_obj_new_float(mp_float_t val);
mp_obj_t mp_obj_new_complex(mp_float_t real, mp_float_t imag);
251
#endif
252
mp_obj_t mp_obj_new_exception(const mp_obj_type_t *exc_type);
253
mp_obj_t mp_obj_new_exception_args(const mp_obj_type_t *exc_type, uint n_args, const mp_obj_t *args);
254
255
mp_obj_t mp_obj_new_exception_msg(const mp_obj_type_t *exc_type, const char *msg);
mp_obj_t mp_obj_new_exception_msg_varg(const mp_obj_type_t *exc_type, const char *fmt, ...); // counts args by number of % symbols in fmt, excluding %%; can only handle void* sizes (ie no float/double!)
256
257
mp_obj_t mp_obj_new_range(int start, int stop, int step);
mp_obj_t mp_obj_new_range_iterator(int cur, int stop, int step);
258
mp_obj_t mp_obj_new_fun_bc(uint scope_flags, qstr *args, uint n_args, mp_obj_t def_args, const byte *code);
259
mp_obj_t mp_obj_new_fun_asm(uint n_args, void *fun);
260
mp_obj_t mp_obj_new_gen_wrap(mp_obj_t fun);
261
mp_obj_t mp_obj_new_gen_instance(const byte *bytecode, int n_args, const mp_obj_t *args);
262
mp_obj_t mp_obj_new_closure(mp_obj_t fun, mp_obj_t closure_tuple);
263
mp_obj_t mp_obj_new_tuple(uint n, const mp_obj_t *items);
264
265
266
mp_obj_t mp_obj_new_list(uint n, mp_obj_t *items);
mp_obj_t mp_obj_new_dict(int n_args);
mp_obj_t mp_obj_new_set(int n_args, mp_obj_t *items);
267
mp_obj_t mp_obj_new_slice(mp_obj_t start, mp_obj_t stop, mp_obj_t step);
Damien George's avatar
Damien George committed
268
mp_obj_t mp_obj_new_super(mp_obj_t type, mp_obj_t obj);
269
mp_obj_t mp_obj_new_bound_meth(mp_obj_t meth, mp_obj_t self);
270
mp_obj_t mp_obj_new_getitem_iter(mp_obj_t *args);
271
mp_obj_t mp_obj_new_module(qstr module_name);
272

273
mp_obj_type_t *mp_obj_get_type(mp_obj_t o_in);
274
const char *mp_obj_get_type_str(mp_obj_t o_in);
275
bool mp_obj_is_subclass_fast(mp_const_obj_t object, mp_const_obj_t classinfo); // arguments should be type objects
276

277
278
void mp_obj_print_helper(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o_in, mp_print_kind_t kind);
void mp_obj_print(mp_obj_t o, mp_print_kind_t kind);
279
void mp_obj_print_exception(mp_obj_t exc);
280

281
282
283
284
bool mp_obj_is_callable(mp_obj_t o_in);
machine_int_t mp_obj_hash(mp_obj_t o_in);
bool mp_obj_equal(mp_obj_t o1, mp_obj_t o2);
bool mp_obj_less(mp_obj_t o1, mp_obj_t o2);
285

286
machine_int_t mp_obj_get_int(mp_obj_t arg);
287
#if MICROPY_ENABLE_FLOAT
288
289
mp_float_t mp_obj_get_float(mp_obj_t self_in);
void mp_obj_get_complex(mp_obj_t self_in, mp_float_t *real, mp_float_t *imag);
290
#endif
291
//qstr mp_obj_get_qstr(mp_obj_t arg);
292
293
void mp_obj_get_array(mp_obj_t o, uint *len, mp_obj_t **items);
void mp_obj_get_array_fixed_n(mp_obj_t o, uint len, mp_obj_t **items);
294
uint mp_get_index(const mp_obj_type_t *type, machine_uint_t len, mp_obj_t index, bool is_slice);
295
mp_obj_t mp_obj_len_maybe(mp_obj_t o_in); /* may return NULL */
296

Damien George's avatar
Damien George committed
297
298
299
// object
extern const mp_obj_type_t mp_type_object;

300
301
302
303
304
// none
extern const mp_obj_type_t none_type;

// bool
extern const mp_obj_type_t bool_type;
John R. Lenton's avatar
John R. Lenton committed
305
#define MP_BOOL(x) (x ? mp_const_true : mp_const_false)
306
307
308
309
310

// cell
mp_obj_t mp_obj_cell_get(mp_obj_t self_in);
void mp_obj_cell_set(mp_obj_t self_in, mp_obj_t obj);

311
312
// int
extern const mp_obj_type_t int_type;
313
314
// For long int, returns value truncated to machine_int_t
machine_int_t mp_obj_int_get(mp_obj_t self_in);
315
316
317
#if MICROPY_ENABLE_FLOAT
mp_float_t mp_obj_int_as_float(mp_obj_t self_in);
#endif
318
319
// Will rains exception if value doesn't fit into machine_int_t
machine_int_t mp_obj_int_get_checked(mp_obj_t self_in);
320

321
// exception
322
323
bool mp_obj_is_exception_type(mp_obj_t self_in);
bool mp_obj_is_exception_instance(mp_obj_t self_in);
324
bool mp_obj_exception_match(mp_obj_t exc, const mp_obj_type_t *exc_type);
325
void mp_obj_exception_clear_traceback(mp_obj_t self_in);
326
327
void mp_obj_exception_add_traceback(mp_obj_t self_in, qstr file, machine_uint_t line, qstr block);
void mp_obj_exception_get_traceback(mp_obj_t self_in, machine_uint_t *n, machine_uint_t **values);
328
mp_obj_t mp_obj_exception_get_value(mp_obj_t self_in);
329

330
331
// str
extern const mp_obj_type_t str_type;
332
mp_obj_t mp_obj_str_builder_start(const mp_obj_type_t *type, uint len, byte **data);
333
334
335
336
mp_obj_t mp_obj_str_builder_end(mp_obj_t o_in);
bool mp_obj_str_equal(mp_obj_t s1, mp_obj_t s2);
uint mp_obj_str_get_hash(mp_obj_t self_in);
uint mp_obj_str_get_len(mp_obj_t self_in);
337
qstr mp_obj_str_get_qstr(mp_obj_t self_in); // use this if you will anyway convert the string to a qstr
338
const char *mp_obj_str_get_str(mp_obj_t self_in); // use this only if you need the string to be null terminated
339
const char *mp_obj_str_get_data(mp_obj_t self_in, uint *len);
340
void mp_str_print_quoted(void (*print)(void *env, const char *fmt, ...), void *env, const byte *str_data, uint str_len);
341

342
343
344
// bytes
extern const mp_obj_type_t bytes_type;

345
346
#if MICROPY_ENABLE_FLOAT
// float
347
348
349
350
351
typedef struct _mp_obj_float_t {
    mp_obj_base_t base;
    mp_float_t value;
} mp_obj_float_t;
extern const mp_obj_type_t mp_type_float;
352
mp_float_t mp_obj_float_get(mp_obj_t self_in);
353
mp_obj_t mp_obj_float_binary_op(int op, mp_float_t lhs_val, mp_obj_t rhs);
354
355

// complex
356
extern const mp_obj_type_t mp_type_complex;
357
void mp_obj_complex_get(mp_obj_t self_in, mp_float_t *real, mp_float_t *imag);
358
mp_obj_t mp_obj_complex_binary_op(int op, mp_float_t lhs_real, mp_float_t lhs_imag, mp_obj_t rhs_in);
359
360
361
362
363
#endif

// tuple
extern const mp_obj_type_t tuple_type;
void mp_obj_tuple_get(mp_obj_t self_in, uint *len, mp_obj_t **items);
John R. Lenton's avatar
John R. Lenton committed
364
void mp_obj_tuple_del(mp_obj_t self_in);
365
machine_int_t mp_obj_tuple_hash(mp_obj_t self_in);
366
367
368
369
370
371

// list
extern const mp_obj_type_t list_type;
mp_obj_t mp_obj_list_append(mp_obj_t self_in, mp_obj_t arg);
void mp_obj_list_get(mp_obj_t self_in, uint *len, mp_obj_t **items);
void mp_obj_list_store(mp_obj_t self_in, mp_obj_t index, mp_obj_t value);
372
mp_obj_t mp_obj_list_sort(uint n_args, const mp_obj_t *args, struct _mp_map_t *kwargs);
373

John R. Lenton's avatar
John R. Lenton committed
374
375
376
// map (the python builtin, not the dict implementation detail)
extern const mp_obj_type_t map_type;

John R. Lenton's avatar
John R. Lenton committed
377
378
379
// enumerate
extern const mp_obj_type_t enumerate_type;

John R. Lenton's avatar
John R. Lenton committed
380
381
382
// filter
extern const mp_obj_type_t filter_type;

383
384
// dict
extern const mp_obj_type_t dict_type;
385
uint mp_obj_dict_len(mp_obj_t self_in);
386
mp_obj_t mp_obj_dict_store(mp_obj_t self_in, mp_obj_t key, mp_obj_t value);
387
struct _mp_map_t *mp_obj_dict_get_map(mp_obj_t self_in);
388
389

// set
390
extern const mp_obj_type_t set_type;
391
392
void mp_obj_set_store(mp_obj_t self_in, mp_obj_t item);

393
394
395
396
// slice
extern const mp_obj_type_t slice_type;
void mp_obj_slice_get(mp_obj_t self_in, machine_int_t *start, machine_int_t *stop, machine_int_t *step);

John R. Lenton's avatar
John R. Lenton committed
397
398
399
// zip
extern const mp_obj_type_t zip_type;

400
// array
401
extern const mp_obj_type_t mp_type_array;
402
uint mp_obj_array_len(mp_obj_t self_in);
403
mp_obj_t mp_obj_new_bytearray_by_ref(uint n, void *items);
John R. Lenton's avatar
John R. Lenton committed
404

405
// functions
406
#define MP_OBJ_FUN_ARGS_MAX (0xffff) // to set maximum value in n_args_max below
407
typedef struct _mp_obj_fun_native_t { // need this so we can define const objects (to go in ROM)
408
    mp_obj_base_t base;
409
    bool is_kw : 1;
410
411
    uint n_args_min : 15; // inclusive
    uint n_args_max : 16; // inclusive
412
    void *fun;
413
414
415
    // TODO add mp_map_t *globals
    // for const function objects, make an empty, const map
    // such functions won't be able to access the global scope, but that's probably okay
416
} mp_obj_fun_native_t;
417

418
419
extern const mp_obj_type_t fun_native_type;
extern const mp_obj_type_t fun_bc_type;
420
void mp_obj_fun_bc_get(mp_obj_t self_in, int *n_args, const byte **code);
421

422
mp_obj_t mp_identity(mp_obj_t self);
423
MP_DECLARE_CONST_FUN_OBJ(mp_identity_obj);
424

Damien George's avatar
Damien George committed
425
426
427
// super
extern const mp_obj_type_t super_type;

428
429
430
// generator
extern const mp_obj_type_t gen_instance_type;

431
// module
432
433
434
435
436
437
typedef struct _mp_obj_module_t {
    mp_obj_base_t base;
    qstr name;
    struct _mp_map_t *globals;
} mp_obj_module_t;
extern const mp_obj_type_t mp_type_module;
438
struct _mp_map_t *mp_obj_module_get_globals(mp_obj_t self_in);
439
440
441
442
443
444

// staticmethod and classmethod types; defined here so we can make const versions

extern const mp_obj_type_t mp_type_staticmethod;
extern const mp_obj_type_t mp_type_classmethod;

445
446
// this structure is used for instances of both staticmethod and classmethod
typedef struct _mp_obj_static_class_method_t {
447
448
    mp_obj_base_t base;
    mp_obj_t fun;
449
} mp_obj_static_class_method_t;
450
451
452

// sequence helpers
void mp_seq_multiply(const void *items, uint item_sz, uint len, uint times, void *dest);
453
bool m_seq_get_fast_slice_indexes(machine_uint_t len, mp_obj_t slice, machine_uint_t *begin, machine_uint_t *end);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
454
455
#define m_seq_copy(dest, src, len, item_t) memcpy(dest, src, len * sizeof(item_t))
#define m_seq_cat(dest, src1, len1, src2, len2, item_t) { memcpy(dest, src1, len1 * sizeof(item_t)); memcpy(dest + len1, src2, len2 * sizeof(item_t)); }
456
bool mp_seq_cmp_bytes(int op, const byte *data1, uint len1, const byte *data2, uint len2);
457
bool mp_seq_cmp_objs(int op, const mp_obj_t *items1, uint len1, const mp_obj_t *items2, uint len2);
458
mp_obj_t mp_seq_index_obj(const mp_obj_t *items, uint len, uint n_args, const mp_obj_t *args);
459
mp_obj_t mp_seq_count_obj(const mp_obj_t *items, uint len, mp_obj_t value);