blob: 79a6d56fad01d334859459911dc7111160bf4a05 [file] [log] [blame]
Damien George04b91472014-05-03 23:27:38 +01001/*
2 * This file is part of the Micro Python project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
Damien George9ddbe292014-12-29 01:02:19 +000026#ifndef __MICROPY_INCLUDED_PY_OBJ_H__
27#define __MICROPY_INCLUDED_PY_OBJ_H__
28
29#include "py/mpconfig.h"
30#include "py/misc.h"
31#include "py/qstr.h"
Damien George7f9d1d62015-04-09 23:56:15 +010032#include "py/mpprint.h"
Damien George04b91472014-05-03 23:27:38 +010033
Damien George41fceae2016-08-15 10:56:55 +100034// This is the definition of the opaque MicroPython object type.
35// All concrete objects have an encoding within this type and the
36// particular encoding is specified by MICROPY_OBJ_REPR.
Damien Georgeb8cfb0d2015-11-27 17:09:11 +000037#if MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_D
38typedef uint64_t mp_obj_t;
39typedef uint64_t mp_const_obj_t;
40#else
Damien George41fceae2016-08-15 10:56:55 +100041typedef void *mp_obj_t;
42typedef const void *mp_const_obj_t;
Damien Georgeb8cfb0d2015-11-27 17:09:11 +000043#endif
Damiend99b0522013-12-21 18:17:45 +000044
Damien George5b3f0b72016-01-03 15:55:55 +000045// This mp_obj_type_t struct is a concrete MicroPython object which holds info
46// about a type. See below for actual definition of the struct.
47typedef struct _mp_obj_type_t mp_obj_type_t;
Damien660365e2013-12-17 18:27:24 +000048
Damien George5b3f0b72016-01-03 15:55:55 +000049// Anything that wants to be a concrete MicroPython object must have mp_obj_base_t
50// as its first member (small ints, qstr objs and inline floats are not concrete).
Damiend99b0522013-12-21 18:17:45 +000051struct _mp_obj_base_t {
Damien George5b3f0b72016-01-03 15:55:55 +000052 const mp_obj_type_t *type MICROPY_OBJ_BASE_ALIGNMENT;
Damiend99b0522013-12-21 18:17:45 +000053};
ian-v7a16fad2014-01-06 09:52:29 -080054typedef struct _mp_obj_base_t mp_obj_base_t;
Damiend99b0522013-12-21 18:17:45 +000055
Damien Georgeea8d06c2014-04-17 23:19:36 +010056// These fake objects are used to indicate certain things in arguments or return
57// values, and should only be used when explicitly allowed.
58//
Damien George6ac5dce2014-05-21 19:42:43 +010059// - MP_OBJ_NULL : used to indicate the absence of an object, or unsupported operation.
Damien Georgeea8d06c2014-04-17 23:19:36 +010060// - MP_OBJ_STOP_ITERATION : used instead of throwing a StopIteration, for efficiency.
61// - MP_OBJ_SENTINEL : used for various internal purposes where one needs
62// an object which is unique from all other objects, including MP_OBJ_NULL.
63//
64// For debugging purposes they are all different. For non-debug mode, we alias
65// as many as we can to MP_OBJ_NULL because it's cheaper to load/compare 0.
Damiend99b0522013-12-21 18:17:45 +000066
Damien George8788b132015-01-25 18:35:54 +000067#ifdef NDEBUG
Damien George999cedb2015-11-27 17:01:44 +000068#define MP_OBJ_NULL (MP_OBJ_FROM_PTR((void*)0))
69#define MP_OBJ_STOP_ITERATION (MP_OBJ_FROM_PTR((void*)0))
70#define MP_OBJ_SENTINEL (MP_OBJ_FROM_PTR((void*)4))
Damien Georgeea8d06c2014-04-17 23:19:36 +010071#else
Damien George999cedb2015-11-27 17:01:44 +000072#define MP_OBJ_NULL (MP_OBJ_FROM_PTR((void*)0))
73#define MP_OBJ_STOP_ITERATION (MP_OBJ_FROM_PTR((void*)4))
74#define MP_OBJ_SENTINEL (MP_OBJ_FROM_PTR((void*)8))
Damien Georgeea8d06c2014-04-17 23:19:36 +010075#endif
Damien George729f7b42014-04-17 22:10:53 +010076
Damien George567184e2015-03-29 14:05:46 +010077// These macros/inline functions operate on objects and depend on the
78// particular object representation. They are used to query, pack and
79// unpack small ints, qstrs and full object pointers.
Damiend99b0522013-12-21 18:17:45 +000080
Damien George567184e2015-03-29 14:05:46 +010081#if MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_A
Damien George38a2da62014-01-08 17:33:12 +000082
Damien George567184e2015-03-29 14:05:46 +010083static inline bool MP_OBJ_IS_SMALL_INT(mp_const_obj_t o)
84 { return ((((mp_int_t)(o)) & 1) != 0); }
Damien George40f3c022014-07-03 13:25:24 +010085#define MP_OBJ_SMALL_INT_VALUE(o) (((mp_int_t)(o)) >> 1)
Damien George2bddfd42016-04-26 09:51:37 +010086#define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)((((mp_uint_t)(small_int)) << 1) | 1))
Damien George38a2da62014-01-08 17:33:12 +000087
Damien George567184e2015-03-29 14:05:46 +010088static inline bool MP_OBJ_IS_QSTR(mp_const_obj_t o)
89 { return ((((mp_int_t)(o)) & 3) == 2); }
Damien George963a5a32015-01-16 17:47:07 +000090#define MP_OBJ_QSTR_VALUE(o) (((mp_uint_t)(o)) >> 2)
Damien George9ddbe292014-12-29 01:02:19 +000091#define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 2) | 2))
Damiend99b0522013-12-21 18:17:45 +000092
Damien Georgeaedb8592015-10-17 22:57:34 +010093#if MICROPY_PY_BUILTINS_FLOAT
Damien Georgecbf76742015-11-27 13:38:15 +000094#define mp_const_float_e MP_ROM_PTR(&mp_const_float_e_obj)
95#define mp_const_float_pi MP_ROM_PTR(&mp_const_float_pi_obj)
Damien Georgeaedb8592015-10-17 22:57:34 +010096extern const struct _mp_obj_float_t mp_const_float_e_obj;
97extern const struct _mp_obj_float_t mp_const_float_pi_obj;
98
99#define mp_obj_is_float(o) MP_OBJ_IS_TYPE((o), &mp_type_float)
100mp_float_t mp_obj_float_get(mp_obj_t self_in);
101mp_obj_t mp_obj_new_float(mp_float_t value);
102#endif
103
Damien George567184e2015-03-29 14:05:46 +0100104static inline bool MP_OBJ_IS_OBJ(mp_const_obj_t o)
105 { return ((((mp_int_t)(o)) & 3) == 0); }
106
107#elif MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_B
108
109static inline bool MP_OBJ_IS_SMALL_INT(mp_const_obj_t o)
110 { return ((((mp_int_t)(o)) & 3) == 1); }
111#define MP_OBJ_SMALL_INT_VALUE(o) (((mp_int_t)(o)) >> 2)
Damien George2bddfd42016-04-26 09:51:37 +0100112#define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)((((mp_uint_t)(small_int)) << 2) | 1))
Damien George567184e2015-03-29 14:05:46 +0100113
114static inline bool MP_OBJ_IS_QSTR(mp_const_obj_t o)
115 { return ((((mp_int_t)(o)) & 3) == 3); }
116#define MP_OBJ_QSTR_VALUE(o) (((mp_uint_t)(o)) >> 2)
117#define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 2) | 3))
118
Damien Georgeaedb8592015-10-17 22:57:34 +0100119#if MICROPY_PY_BUILTINS_FLOAT
Damien Georgecbf76742015-11-27 13:38:15 +0000120#define mp_const_float_e MP_ROM_PTR(&mp_const_float_e_obj)
121#define mp_const_float_pi MP_ROM_PTR(&mp_const_float_pi_obj)
Damien Georgeaedb8592015-10-17 22:57:34 +0100122extern const struct _mp_obj_float_t mp_const_float_e_obj;
123extern const struct _mp_obj_float_t mp_const_float_pi_obj;
124
125#define mp_obj_is_float(o) MP_OBJ_IS_TYPE((o), &mp_type_float)
126mp_float_t mp_obj_float_get(mp_obj_t self_in);
127mp_obj_t mp_obj_new_float(mp_float_t value);
128#endif
129
Damien George567184e2015-03-29 14:05:46 +0100130static inline bool MP_OBJ_IS_OBJ(mp_const_obj_t o)
131 { return ((((mp_int_t)(o)) & 1) == 0); }
132
Damien George183edef2015-10-17 23:20:57 +0100133#elif MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_C
134
135static inline bool MP_OBJ_IS_SMALL_INT(mp_const_obj_t o)
136 { return ((((mp_int_t)(o)) & 1) != 0); }
137#define MP_OBJ_SMALL_INT_VALUE(o) (((mp_int_t)(o)) >> 1)
Damien George2bddfd42016-04-26 09:51:37 +0100138#define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)((((mp_uint_t)(small_int)) << 1) | 1))
Damien George183edef2015-10-17 23:20:57 +0100139
Damien Georgefe03e7b2015-12-18 21:44:01 +0000140#define mp_const_float_e MP_ROM_PTR((mp_obj_t)(((0x402df854 & ~3) | 2) + 0x80800000))
141#define mp_const_float_pi MP_ROM_PTR((mp_obj_t)(((0x40490fdb & ~3) | 2) + 0x80800000))
Damien George183edef2015-10-17 23:20:57 +0100142
143static inline bool mp_obj_is_float(mp_const_obj_t o)
Damien George8b8d1892015-11-06 23:25:10 +0000144 { return (((mp_uint_t)(o)) & 3) == 2 && (((mp_uint_t)(o)) & 0xff800007) != 0x00000006; }
Damien George183edef2015-10-17 23:20:57 +0100145static inline mp_float_t mp_obj_float_get(mp_const_obj_t o) {
146 union {
147 mp_float_t f;
148 mp_uint_t u;
Damien George8b8d1892015-11-06 23:25:10 +0000149 } num = {.u = ((mp_uint_t)o - 0x80800000) & ~3};
Damien George183edef2015-10-17 23:20:57 +0100150 return num.f;
151}
152static inline mp_obj_t mp_obj_new_float(mp_float_t f) {
153 union {
154 mp_float_t f;
155 mp_uint_t u;
156 } num = {.f = f};
Damien George8b8d1892015-11-06 23:25:10 +0000157 return (mp_obj_t)(((num.u & ~0x3) | 2) + 0x80800000);
Damien George183edef2015-10-17 23:20:57 +0100158}
159
160static inline bool MP_OBJ_IS_QSTR(mp_const_obj_t o)
Damien George8b8d1892015-11-06 23:25:10 +0000161 { return (((mp_uint_t)(o)) & 0xff800007) == 0x00000006; }
162#define MP_OBJ_QSTR_VALUE(o) (((mp_uint_t)(o)) >> 3)
163#define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 3) | 0x00000006))
Damien George183edef2015-10-17 23:20:57 +0100164
165static inline bool MP_OBJ_IS_OBJ(mp_const_obj_t o)
166 { return ((((mp_int_t)(o)) & 3) == 0); }
167
Damien Georgeb8cfb0d2015-11-27 17:09:11 +0000168#elif MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_D
169
170static inline bool MP_OBJ_IS_SMALL_INT(mp_const_obj_t o)
171 { return ((((mp_int_t)(o)) & 0xffff000000000000) == 0x0001000000000000); }
172#define MP_OBJ_SMALL_INT_VALUE(o) (((intptr_t)(o)) >> 1)
173#define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)(((uintptr_t)(small_int)) << 1) | 0x0001000000000001)
174
175static inline bool MP_OBJ_IS_QSTR(mp_const_obj_t o)
176 { return ((((mp_int_t)(o)) & 0xffff000000000000) == 0x0002000000000000); }
Damien George1fa6be52016-01-08 13:43:13 +0000177#define MP_OBJ_QSTR_VALUE(o) ((((uint32_t)(o)) >> 1) & 0xffffffff)
Damien Georgeb8cfb0d2015-11-27 17:09:11 +0000178#define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 1) | 0x0002000000000001))
179
180#if MICROPY_PY_BUILTINS_FLOAT
181#define mp_const_float_e {((mp_obj_t)((uint64_t)0x4005bf0a8b125769 + 0x8004000000000000))}
182#define mp_const_float_pi {((mp_obj_t)((uint64_t)0x400921fb54442d18 + 0x8004000000000000))}
183
184static inline bool mp_obj_is_float(mp_const_obj_t o) {
185 return ((uint64_t)(o) & 0xfffc000000000000) != 0;
186}
187static inline mp_float_t mp_obj_float_get(mp_const_obj_t o) {
188 union {
189 mp_float_t f;
190 uint64_t r;
191 } num = {.r = o - 0x8004000000000000};
192 return num.f;
193}
194static inline mp_obj_t mp_obj_new_float(mp_float_t f) {
195 union {
196 mp_float_t f;
197 uint64_t r;
198 } num = {.f = f};
199 return num.r + 0x8004000000000000;
200}
201#endif
202
203static inline bool MP_OBJ_IS_OBJ(mp_const_obj_t o)
204 { return ((((uint64_t)(o)) & 0xffff000000000000) == 0x0000000000000000); }
205#define MP_OBJ_TO_PTR(o) ((void*)(uintptr_t)(o))
206#define MP_OBJ_FROM_PTR(p) ((mp_obj_t)((uintptr_t)(p)))
207
208// rom object storage needs special handling to widen 32-bit pointer to 64-bits
209typedef union _mp_rom_obj_t { uint64_t u64; struct { const void *lo, *hi; } u32; } mp_rom_obj_t;
210#define MP_ROM_INT(i) {MP_OBJ_NEW_SMALL_INT(i)}
211#define MP_ROM_QSTR(q) {MP_OBJ_NEW_QSTR(q)}
212#if MP_ENDIANNESS_LITTLE
213#define MP_ROM_PTR(p) {.u32 = {.lo = (p), .hi = NULL}}
214#else
215#define MP_ROM_PTR(p) {.u32 = {.lo = NULL, .hi = (p)}}
216#endif
217
Damien George567184e2015-03-29 14:05:46 +0100218#endif
219
Paul Sokolovsky3d598252015-03-25 09:25:41 +0200220// Macros to convert between mp_obj_t and concrete object types.
221// These are identity operations in MicroPython, but ability to override
222// these operations are provided to experiment with other methods of
223// object representation and memory management.
224
225// Cast mp_obj_t to object pointer
Damien George999cedb2015-11-27 17:01:44 +0000226#ifndef MP_OBJ_TO_PTR
227#define MP_OBJ_TO_PTR(o) ((void*)o)
Paul Sokolovsky3d598252015-03-25 09:25:41 +0200228#endif
229
230// Cast object pointer to mp_obj_t
Damien George999cedb2015-11-27 17:01:44 +0000231#ifndef MP_OBJ_FROM_PTR
232#define MP_OBJ_FROM_PTR(p) ((mp_obj_t)p)
Paul Sokolovsky3d598252015-03-25 09:25:41 +0200233#endif
234
Damien Georgecbf76742015-11-27 13:38:15 +0000235// Macros to create objects that are stored in ROM.
236
237#ifndef MP_ROM_INT
238typedef mp_const_obj_t mp_rom_obj_t;
239#define MP_ROM_INT(i) MP_OBJ_NEW_SMALL_INT(i)
240#define MP_ROM_QSTR(q) MP_OBJ_NEW_QSTR(q)
241#define MP_ROM_PTR(p) (p)
242/* for testing
243typedef struct _mp_rom_obj_t { mp_const_obj_t o; } mp_rom_obj_t;
244#define MP_ROM_INT(i) {MP_OBJ_NEW_SMALL_INT(i)}
245#define MP_ROM_QSTR(q) {MP_OBJ_NEW_QSTR(q)}
246#define MP_ROM_PTR(p) {.o = p}
247*/
248#endif
249
Damien George567184e2015-03-29 14:05:46 +0100250// The macros below are derived from the ones above and are used to
251// check for more specific object types.
252
Damien George999cedb2015-11-27 17:01:44 +0000253#define MP_OBJ_IS_TYPE(o, t) (MP_OBJ_IS_OBJ(o) && (((mp_obj_base_t*)MP_OBJ_TO_PTR(o))->type == (t))) // this does not work for checking int, str or fun; use below macros for that
Damien George567184e2015-03-29 14:05:46 +0100254#define MP_OBJ_IS_INT(o) (MP_OBJ_IS_SMALL_INT(o) || MP_OBJ_IS_TYPE(o, &mp_type_int))
255#define MP_OBJ_IS_STR(o) (MP_OBJ_IS_QSTR(o) || MP_OBJ_IS_TYPE(o, &mp_type_str))
Damien George999cedb2015-11-27 17:01:44 +0000256#define MP_OBJ_IS_STR_OR_BYTES(o) (MP_OBJ_IS_QSTR(o) || (MP_OBJ_IS_OBJ(o) && ((mp_obj_base_t*)MP_OBJ_TO_PTR(o))->type->binary_op == mp_obj_str_binary_op))
257#define MP_OBJ_IS_FUN(o) (MP_OBJ_IS_OBJ(o) && (((mp_obj_base_t*)MP_OBJ_TO_PTR(o))->type->name == MP_QSTR_function))
Damien George567184e2015-03-29 14:05:46 +0100258
259// Note: inline functions sometimes use much more code space than the
260// equivalent macros, depending on the compiler.
261//static inline bool MP_OBJ_IS_TYPE(mp_const_obj_t o, const mp_obj_type_t *t) { return (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
262//static inline bool MP_OBJ_IS_INT(mp_const_obj_t o) { return (MP_OBJ_IS_SMALL_INT(o) || MP_OBJ_IS_TYPE(o, &mp_type_int)); } // returns true if o is a small int or long int
263// Need to forward declare these for the inline function to compile.
Damien George5b3f0b72016-01-03 15:55:55 +0000264extern const mp_obj_type_t mp_type_int;
265extern const mp_obj_type_t mp_type_bool;
Damien George567184e2015-03-29 14:05:46 +0100266static inline bool mp_obj_is_integer(mp_const_obj_t o) { return MP_OBJ_IS_INT(o) || MP_OBJ_IS_TYPE(o, &mp_type_bool); } // returns true if o is bool, small int or long int
267//static inline bool MP_OBJ_IS_STR(mp_const_obj_t o) { return (MP_OBJ_IS_QSTR(o) || MP_OBJ_IS_TYPE(o, &mp_type_str)); }
268
269
Damiend99b0522013-12-21 18:17:45 +0000270// These macros are used to declare and define constant function objects
271// You can put "static" in front of the definitions to make them local
272
Damien George571e6f22016-10-18 11:49:27 +1100273#define MP_DECLARE_CONST_FUN_OBJ_0(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
274#define MP_DECLARE_CONST_FUN_OBJ_1(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
275#define MP_DECLARE_CONST_FUN_OBJ_2(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
276#define MP_DECLARE_CONST_FUN_OBJ_3(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
277#define MP_DECLARE_CONST_FUN_OBJ_VAR(obj_name) extern const mp_obj_fun_builtin_var_t obj_name
278#define MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(obj_name) extern const mp_obj_fun_builtin_var_t obj_name
279#define MP_DECLARE_CONST_FUN_OBJ_KW(obj_name) extern const mp_obj_fun_builtin_var_t obj_name
Damiend99b0522013-12-21 18:17:45 +0000280
Damien George1b0aab62016-01-03 11:53:44 +0000281#define MP_DEFINE_CONST_FUN_OBJ_0(obj_name, fun_name) \
Damien George571e6f22016-10-18 11:49:27 +1100282 const mp_obj_fun_builtin_fixed_t obj_name = \
283 {{&mp_type_fun_builtin_0}, .fun._0 = fun_name}
Damien George1b0aab62016-01-03 11:53:44 +0000284#define MP_DEFINE_CONST_FUN_OBJ_1(obj_name, fun_name) \
Damien George571e6f22016-10-18 11:49:27 +1100285 const mp_obj_fun_builtin_fixed_t obj_name = \
286 {{&mp_type_fun_builtin_1}, .fun._1 = fun_name}
Damien George1b0aab62016-01-03 11:53:44 +0000287#define MP_DEFINE_CONST_FUN_OBJ_2(obj_name, fun_name) \
Damien George571e6f22016-10-18 11:49:27 +1100288 const mp_obj_fun_builtin_fixed_t obj_name = \
289 {{&mp_type_fun_builtin_2}, .fun._2 = fun_name}
Damien George1b0aab62016-01-03 11:53:44 +0000290#define MP_DEFINE_CONST_FUN_OBJ_3(obj_name, fun_name) \
Damien George571e6f22016-10-18 11:49:27 +1100291 const mp_obj_fun_builtin_fixed_t obj_name = \
292 {{&mp_type_fun_builtin_3}, .fun._3 = fun_name}
Damien George1b0aab62016-01-03 11:53:44 +0000293#define MP_DEFINE_CONST_FUN_OBJ_VAR(obj_name, n_args_min, fun_name) \
Damien George571e6f22016-10-18 11:49:27 +1100294 const mp_obj_fun_builtin_var_t obj_name = \
295 {{&mp_type_fun_builtin_var}, false, n_args_min, MP_OBJ_FUN_ARGS_MAX, .fun.var = fun_name}
Damien George1b0aab62016-01-03 11:53:44 +0000296#define MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(obj_name, n_args_min, n_args_max, fun_name) \
Damien George571e6f22016-10-18 11:49:27 +1100297 const mp_obj_fun_builtin_var_t obj_name = \
298 {{&mp_type_fun_builtin_var}, false, n_args_min, n_args_max, .fun.var = fun_name}
Damien George1b0aab62016-01-03 11:53:44 +0000299#define MP_DEFINE_CONST_FUN_OBJ_KW(obj_name, n_args_min, fun_name) \
Damien George571e6f22016-10-18 11:49:27 +1100300 const mp_obj_fun_builtin_var_t obj_name = \
301 {{&mp_type_fun_builtin_var}, true, n_args_min, MP_OBJ_FUN_ARGS_MAX, .fun.kw = fun_name}
John R. Lentonc06763a2014-01-07 17:29:16 +0000302
Damien George78d702c2014-12-09 16:19:48 +0000303// These macros are used to define constant map/dict objects
Damien George9b196cd2014-03-26 21:47:19 +0000304// You can put "static" in front of the definition to make it local
305
Damien George78d702c2014-12-09 16:19:48 +0000306#define MP_DEFINE_CONST_MAP(map_name, table_name) \
307 const mp_map_t map_name = { \
308 .all_keys_are_qstrs = 1, \
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200309 .is_fixed = 1, \
310 .is_ordered = 1, \
Damien George78d702c2014-12-09 16:19:48 +0000311 .used = MP_ARRAY_SIZE(table_name), \
312 .alloc = MP_ARRAY_SIZE(table_name), \
Damien Georgecbf76742015-11-27 13:38:15 +0000313 .table = (mp_map_elem_t*)(mp_rom_map_elem_t*)table_name, \
Damien George78d702c2014-12-09 16:19:48 +0000314 }
315
Damien George9b196cd2014-03-26 21:47:19 +0000316#define MP_DEFINE_CONST_DICT(dict_name, table_name) \
317 const mp_obj_dict_t dict_name = { \
Damien George3e1a5c12014-03-29 13:43:38 +0000318 .base = {&mp_type_dict}, \
Damien George9b196cd2014-03-26 21:47:19 +0000319 .map = { \
320 .all_keys_are_qstrs = 1, \
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200321 .is_fixed = 1, \
322 .is_ordered = 1, \
Damien George3b603f22014-11-29 14:39:27 +0000323 .used = MP_ARRAY_SIZE(table_name), \
324 .alloc = MP_ARRAY_SIZE(table_name), \
Damien Georgecbf76742015-11-27 13:38:15 +0000325 .table = (mp_map_elem_t*)(mp_rom_map_elem_t*)table_name, \
Damien George9b196cd2014-03-26 21:47:19 +0000326 }, \
327 }
328
Damien Georgeeae16442014-01-11 19:22:29 +0000329// These macros are used to declare and define constant staticmethond and classmethod objects
330// You can put "static" in front of the definitions to make them local
331
Damien Georgecbf76742015-11-27 13:38:15 +0000332#define MP_DECLARE_CONST_STATICMETHOD_OBJ(obj_name) extern const mp_rom_obj_static_class_method_t obj_name
333#define MP_DECLARE_CONST_CLASSMETHOD_OBJ(obj_name) extern const mp_rom_obj_static_class_method_t obj_name
Damien Georgeeae16442014-01-11 19:22:29 +0000334
Damien Georgecbf76742015-11-27 13:38:15 +0000335#define MP_DEFINE_CONST_STATICMETHOD_OBJ(obj_name, fun_name) const mp_rom_obj_static_class_method_t obj_name = {{&mp_type_staticmethod}, fun_name}
336#define MP_DEFINE_CONST_CLASSMETHOD_OBJ(obj_name, fun_name) const mp_rom_obj_static_class_method_t obj_name = {{&mp_type_classmethod}, fun_name}
Damien Georgeeae16442014-01-11 19:22:29 +0000337
Damien Georgedf6567e2014-03-30 13:54:02 +0100338// Underlying map/hash table implementation (not dict object or map function)
339
340typedef struct _mp_map_elem_t {
341 mp_obj_t key;
342 mp_obj_t value;
343} mp_map_elem_t;
344
Damien Georgecbf76742015-11-27 13:38:15 +0000345typedef struct _mp_rom_map_elem_t {
346 mp_rom_obj_t key;
347 mp_rom_obj_t value;
348} mp_rom_map_elem_t;
349
Damien Georgedf6567e2014-03-30 13:54:02 +0100350// TODO maybe have a truncated mp_map_t for fixed tables, since alloc=used
351// put alloc last in the structure, so the truncated version does not need it
352// this would save 1 ROM word for all ROM objects that have a locals_dict
353// would also need a trucated dict structure
354
355typedef struct _mp_map_t {
Damien Georgeaf622eb2017-02-08 11:00:15 +1100356 size_t all_keys_are_qstrs : 1;
357 size_t is_fixed : 1; // a fixed array that can't be modified; must also be ordered
358 size_t is_ordered : 1; // an ordered array
359 size_t used : (8 * sizeof(size_t) - 3);
360 size_t alloc;
Damien Georgedf6567e2014-03-30 13:54:02 +0100361 mp_map_elem_t *table;
362} mp_map_t;
363
Damien Georged1cee022015-03-20 17:41:37 +0000364// mp_set_lookup requires these constants to have the values they do
Damien Georgedf6567e2014-03-30 13:54:02 +0100365typedef enum _mp_map_lookup_kind_t {
Damien Georged1cee022015-03-20 17:41:37 +0000366 MP_MAP_LOOKUP = 0,
367 MP_MAP_LOOKUP_ADD_IF_NOT_FOUND = 1,
368 MP_MAP_LOOKUP_REMOVE_IF_FOUND = 2,
369 MP_MAP_LOOKUP_ADD_IF_NOT_FOUND_OR_REMOVE_IF_FOUND = 3, // only valid for mp_set_lookup
Damien Georgedf6567e2014-03-30 13:54:02 +0100370} mp_map_lookup_kind_t;
371
Paul Sokolovskye5dbe1e2014-11-26 21:17:16 +0200372extern const mp_map_t mp_const_empty_map;
373
Damien Georgeaf622eb2017-02-08 11:00:15 +1100374static inline bool MP_MAP_SLOT_IS_FILLED(const mp_map_t *map, size_t pos) { return ((map)->table[pos].key != MP_OBJ_NULL && (map)->table[pos].key != MP_OBJ_SENTINEL); }
Damien George8b0535e2014-04-05 21:53:54 +0100375
Damien Georgeaf622eb2017-02-08 11:00:15 +1100376void mp_map_init(mp_map_t *map, size_t n);
377void mp_map_init_fixed_table(mp_map_t *map, size_t n, const mp_obj_t *table);
378mp_map_t *mp_map_new(size_t n);
Damien Georgedf6567e2014-03-30 13:54:02 +0100379void mp_map_deinit(mp_map_t *map);
380void mp_map_free(mp_map_t *map);
Damien George2801e6f2015-04-04 15:53:11 +0100381mp_map_elem_t *mp_map_lookup(mp_map_t *map, mp_obj_t index, mp_map_lookup_kind_t lookup_kind);
Damien Georgedf6567e2014-03-30 13:54:02 +0100382void mp_map_clear(mp_map_t *map);
Paul Sokolovskye3f58c82014-04-05 04:14:22 +0300383void mp_map_dump(mp_map_t *map);
Damien Georgedf6567e2014-03-30 13:54:02 +0100384
385// Underlying set implementation (not set object)
386
387typedef struct _mp_set_t {
Damien Georgeaf622eb2017-02-08 11:00:15 +1100388 size_t alloc;
389 size_t used;
Damien Georgedf6567e2014-03-30 13:54:02 +0100390 mp_obj_t *table;
391} mp_set_t;
392
Damien Georgeaf622eb2017-02-08 11:00:15 +1100393static inline bool MP_SET_SLOT_IS_FILLED(const mp_set_t *set, size_t pos) { return ((set)->table[pos] != MP_OBJ_NULL && (set)->table[pos] != MP_OBJ_SENTINEL); }
Damien George8b0535e2014-04-05 21:53:54 +0100394
Damien Georgeaf622eb2017-02-08 11:00:15 +1100395void mp_set_init(mp_set_t *set, size_t n);
Damien Georgedf6567e2014-03-30 13:54:02 +0100396mp_obj_t mp_set_lookup(mp_set_t *set, mp_obj_t index, mp_map_lookup_kind_t lookup_kind);
Damien George95004e52014-04-05 17:17:19 +0100397mp_obj_t mp_set_remove_first(mp_set_t *set);
Damien Georgedf6567e2014-03-30 13:54:02 +0100398void mp_set_clear(mp_set_t *set);
Damiend99b0522013-12-21 18:17:45 +0000399
400// Type definitions for methods
401
402typedef mp_obj_t (*mp_fun_0_t)(void);
403typedef mp_obj_t (*mp_fun_1_t)(mp_obj_t);
404typedef mp_obj_t (*mp_fun_2_t)(mp_obj_t, mp_obj_t);
John R. Lenton45a87442014-01-04 01:15:01 +0000405typedef mp_obj_t (*mp_fun_3_t)(mp_obj_t, mp_obj_t, mp_obj_t);
Damien George4b72b3a2016-01-03 14:21:40 +0000406typedef mp_obj_t (*mp_fun_var_t)(size_t n, const mp_obj_t *);
Paul Sokolovsky069654f2016-04-04 15:35:44 +0300407// mp_fun_kw_t takes mp_map_t* (and not const mp_map_t*) to ease passing
408// this arg to mp_map_lookup().
Damien George4b72b3a2016-01-03 14:21:40 +0000409typedef mp_obj_t (*mp_fun_kw_t)(size_t n, const mp_obj_t *, mp_map_t *);
Damiend99b0522013-12-21 18:17:45 +0000410
Paul Sokolovsky76d982e2014-01-13 19:19:16 +0200411typedef enum {
Paul Sokolovskyd8351ca2014-05-02 01:51:25 +0300412 PRINT_STR = 0,
413 PRINT_REPR = 1,
414 PRINT_EXC = 2, // Special format for printing exception in unhandled exception message
Damien George612045f2014-09-17 22:56:34 +0100415 PRINT_JSON = 3,
Paul Sokolovskyef63ab52015-12-20 16:44:36 +0200416 PRINT_RAW = 4, // Special format for printing bytes as an undercorated string
Damien George612045f2014-09-17 22:56:34 +0100417 PRINT_EXC_SUBCLASS = 0x80, // Internal flag for printing exception subclasses
Paul Sokolovsky76d982e2014-01-13 19:19:16 +0200418} mp_print_kind_t;
419
Damien Georgeae8d8672016-01-09 23:14:54 +0000420typedef struct _mp_obj_iter_buf_t {
421 mp_obj_base_t base;
422 mp_obj_t buf[3];
423} mp_obj_iter_buf_t;
424
Damien George7f9d1d62015-04-09 23:56:15 +0100425typedef void (*mp_print_fun_t)(const mp_print_t *print, mp_obj_t o, mp_print_kind_t kind);
Damien George5b3f0b72016-01-03 15:55:55 +0000426typedef mp_obj_t (*mp_make_new_fun_t)(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args);
Damien Georgea0c97812016-01-03 09:59:18 +0000427typedef mp_obj_t (*mp_call_fun_t)(mp_obj_t fun, size_t n_args, size_t n_kw, const mp_obj_t *args);
Damien Georgeecc88e92014-08-30 00:35:11 +0100428typedef mp_obj_t (*mp_unary_op_fun_t)(mp_uint_t op, mp_obj_t);
429typedef mp_obj_t (*mp_binary_op_fun_t)(mp_uint_t op, mp_obj_t, mp_obj_t);
Damien Georgeb1bbe962015-04-01 14:10:50 +0000430typedef void (*mp_attr_fun_t)(mp_obj_t self_in, qstr attr, mp_obj_t *dest);
Damien George729f7b42014-04-17 22:10:53 +0100431typedef mp_obj_t (*mp_subscr_fun_t)(mp_obj_t self_in, mp_obj_t index, mp_obj_t value);
Damien Georgeae8d8672016-01-09 23:14:54 +0000432typedef mp_obj_t (*mp_getiter_fun_t)(mp_obj_t self_in, mp_obj_iter_buf_t *iter_buf);
Damiend99b0522013-12-21 18:17:45 +0000433
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200434// Buffer protocol
Damien George57a4b4f2014-04-18 22:29:21 +0100435typedef struct _mp_buffer_info_t {
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200436 // if we'd bother to support various versions of structure
437 // (with different number of fields), we can distinguish
438 // them with ver = sizeof(struct). Cons: overkill for *micro*?
439 //int ver; // ?
440
Damien George42f3de92014-10-03 17:44:14 +0000441 void *buf; // can be NULL if len == 0
Damien George0d1f8862016-03-15 12:20:57 +0000442 size_t len; // in bytes
Damien George42f3de92014-10-03 17:44:14 +0000443 int typecode; // as per binary.h
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200444
445 // Rationale: to load arbitrary-sized sprites directly to LCD
446 // Cons: a bit adhoc usecase
447 // int stride;
Damien George57a4b4f2014-04-18 22:29:21 +0100448} mp_buffer_info_t;
449#define MP_BUFFER_READ (1)
450#define MP_BUFFER_WRITE (2)
451#define MP_BUFFER_RW (MP_BUFFER_READ | MP_BUFFER_WRITE)
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200452typedef struct _mp_buffer_p_t {
Damien George4d917232014-08-30 14:28:06 +0100453 mp_int_t (*get_buffer)(mp_obj_t obj, mp_buffer_info_t *bufinfo, mp_uint_t flags);
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200454} mp_buffer_p_t;
Damien George4d917232014-08-30 14:28:06 +0100455bool mp_get_buffer(mp_obj_t obj, mp_buffer_info_t *bufinfo, mp_uint_t flags);
456void mp_get_buffer_raise(mp_obj_t obj, mp_buffer_info_t *bufinfo, mp_uint_t flags);
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200457
458// Stream protocol
459typedef struct _mp_stream_p_t {
Damien Georgeadf0f2a2014-07-27 22:38:58 +0100460 // On error, functions should return MP_STREAM_ERROR and fill in *errcode (values
461 // are implementation-dependent, but will be exposed to user, e.g. via exception).
462 mp_uint_t (*read)(mp_obj_t obj, void *buf, mp_uint_t size, int *errcode);
463 mp_uint_t (*write)(mp_obj_t obj, const void *buf, mp_uint_t size, int *errcode);
Damien George999cedb2015-11-27 17:01:44 +0000464 mp_uint_t (*ioctl)(mp_obj_t obj, mp_uint_t request, uintptr_t arg, int *errcode);
Damien George4d917232014-08-30 14:28:06 +0100465 mp_uint_t is_text : 1; // default is bytes, set this for text stream
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200466} mp_stream_p_t;
467
Damiend99b0522013-12-21 18:17:45 +0000468struct _mp_obj_type_t {
469 mp_obj_base_t base;
Damien Georgea71c83a2014-02-15 11:34:50 +0000470 qstr name;
Damiend99b0522013-12-21 18:17:45 +0000471 mp_print_fun_t print;
Damien George71c51812014-01-04 20:21:15 +0000472 mp_make_new_fun_t make_new; // to make an instance of the type
Damiend99b0522013-12-21 18:17:45 +0000473
Damien George20006db2014-01-18 14:10:48 +0000474 mp_call_fun_t call;
Damien George6ac5dce2014-05-21 19:42:43 +0100475 mp_unary_op_fun_t unary_op; // can return MP_OBJ_NULL if op not supported
476 mp_binary_op_fun_t binary_op; // can return MP_OBJ_NULL if op not supported
Damiend99b0522013-12-21 18:17:45 +0000477
Damien Georgeb1bbe962015-04-01 14:10:50 +0000478 // implements load, store and delete attribute
479 //
480 // dest[0] = MP_OBJ_NULL means load
481 // return: for fail, do nothing
482 // for attr, dest[0] = value
483 // for method, dest[0] = method, dest[1] = self
484 //
485 // dest[0,1] = {MP_OBJ_SENTINEL, MP_OBJ_NULL} means delete
486 // dest[0,1] = {MP_OBJ_SENTINEL, object} means store
487 // return: for fail, do nothing
488 // for success set dest[0] = MP_OBJ_NULL
489 mp_attr_fun_t attr;
Damien Georgef4c9b332014-04-08 21:32:29 +0100490
Damien George729f7b42014-04-17 22:10:53 +0100491 mp_subscr_fun_t subscr; // implements load, store, delete subscripting
492 // value=MP_OBJ_NULL means delete, value=MP_OBJ_SENTINEL means load, else store
Damien George6ac5dce2014-05-21 19:42:43 +0100493 // can return MP_OBJ_NULL if op not supported
Damien Georgea71c83a2014-02-15 11:34:50 +0000494
Damien Georgeae8d8672016-01-09 23:14:54 +0000495 // corresponds to __iter__ special method
496 // can use given mp_obj_iter_buf_t to store iterator
497 // otherwise can return a pointer to an object on the heap
498 mp_getiter_fun_t getiter;
499
Damien Georged0a5bf32014-05-10 13:55:11 +0100500 mp_fun_1_t iternext; // may return MP_OBJ_STOP_ITERATION as an optimisation instead of raising StopIteration() (with no args)
Damiend99b0522013-12-21 18:17:45 +0000501
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200502 mp_buffer_p_t buffer_p;
Paul Sokolovsky07209f82016-06-18 18:19:24 +0300503 // One of disjoint protocols (interfaces), like mp_stream_p_t, etc.
504 const void *protocol;
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200505
Damien George004cdce2014-01-09 21:43:51 +0000506 // these are for dynamically created types (classes)
Damien George999cedb2015-11-27 17:01:44 +0000507 struct _mp_obj_tuple_t *bases_tuple;
508 struct _mp_obj_dict_t *locals_dict;
Damien George062478e2014-01-09 20:57:50 +0000509
Damiend99b0522013-12-21 18:17:45 +0000510 /*
511 What we might need to add here:
512
Damiend99b0522013-12-21 18:17:45 +0000513 len str tuple list map
514 abs float complex
515 hash bool int none str
516 equal int str
Damiend99b0522013-12-21 18:17:45 +0000517
518 unpack seq list tuple
Damiend99b0522013-12-21 18:17:45 +0000519 */
520};
521
Damien Georgec5966122014-02-15 16:10:44 +0000522// Constant types, globally accessible
Damien Georgec5966122014-02-15 16:10:44 +0000523extern const mp_obj_type_t mp_type_type;
Damien George3e1a5c12014-03-29 13:43:38 +0000524extern const mp_obj_type_t mp_type_object;
525extern const mp_obj_type_t mp_type_NoneType;
526extern const mp_obj_type_t mp_type_bool;
527extern const mp_obj_type_t mp_type_int;
528extern const mp_obj_type_t mp_type_str;
529extern const mp_obj_type_t mp_type_bytes;
Paul Sokolovsky4dcb6052014-04-08 22:09:14 +0300530extern const mp_obj_type_t mp_type_bytearray;
Damien Georgedd4f4532014-10-23 13:34:35 +0100531extern const mp_obj_type_t mp_type_memoryview;
Damien George3e1a5c12014-03-29 13:43:38 +0000532extern const mp_obj_type_t mp_type_float;
533extern const mp_obj_type_t mp_type_complex;
534extern const mp_obj_type_t mp_type_tuple;
535extern const mp_obj_type_t mp_type_list;
536extern const mp_obj_type_t mp_type_map; // map (the python builtin, not the dict implementation detail)
537extern const mp_obj_type_t mp_type_enumerate;
538extern const mp_obj_type_t mp_type_filter;
539extern const mp_obj_type_t mp_type_dict;
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200540extern const mp_obj_type_t mp_type_ordereddict;
Damien George71d31122014-04-17 18:18:55 +0100541extern const mp_obj_type_t mp_type_range;
Damien George3e1a5c12014-03-29 13:43:38 +0000542extern const mp_obj_type_t mp_type_set;
Paul Sokolovskyb181b582014-05-10 16:02:17 +0300543extern const mp_obj_type_t mp_type_frozenset;
Damien George3e1a5c12014-03-29 13:43:38 +0000544extern const mp_obj_type_t mp_type_slice;
545extern const mp_obj_type_t mp_type_zip;
546extern const mp_obj_type_t mp_type_array;
547extern const mp_obj_type_t mp_type_super;
548extern const mp_obj_type_t mp_type_gen_instance;
Damien George571e6f22016-10-18 11:49:27 +1100549extern const mp_obj_type_t mp_type_fun_builtin_0;
550extern const mp_obj_type_t mp_type_fun_builtin_1;
551extern const mp_obj_type_t mp_type_fun_builtin_2;
552extern const mp_obj_type_t mp_type_fun_builtin_3;
553extern const mp_obj_type_t mp_type_fun_builtin_var;
Damien George3e1a5c12014-03-29 13:43:38 +0000554extern const mp_obj_type_t mp_type_fun_bc;
555extern const mp_obj_type_t mp_type_module;
556extern const mp_obj_type_t mp_type_staticmethod;
557extern const mp_obj_type_t mp_type_classmethod;
Damien George777b0f32014-04-13 18:59:45 +0100558extern const mp_obj_type_t mp_type_property;
Paul Sokolovskycb9dc082014-04-26 20:26:14 +0300559extern const mp_obj_type_t mp_type_stringio;
Paul Sokolovskya47b64a2014-05-15 07:28:19 +0300560extern const mp_obj_type_t mp_type_bytesio;
Damien George4c03b3a2014-08-12 18:33:40 +0100561extern const mp_obj_type_t mp_type_reversed;
Paul Sokolovsky1a1ccea2015-12-14 23:48:12 +0200562extern const mp_obj_type_t mp_type_polymorph_iter;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000563
564// Exceptions
Damien Georgec5966122014-02-15 16:10:44 +0000565extern const mp_obj_type_t mp_type_BaseException;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000566extern const mp_obj_type_t mp_type_ArithmeticError;
567extern const mp_obj_type_t mp_type_AssertionError;
568extern const mp_obj_type_t mp_type_AttributeError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000569extern const mp_obj_type_t mp_type_EOFError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000570extern const mp_obj_type_t mp_type_Exception;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000571extern const mp_obj_type_t mp_type_GeneratorExit;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000572extern const mp_obj_type_t mp_type_ImportError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000573extern const mp_obj_type_t mp_type_IndentationError;
574extern const mp_obj_type_t mp_type_IndexError;
Damien George124df6f2014-10-25 18:19:55 +0100575extern const mp_obj_type_t mp_type_KeyboardInterrupt;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000576extern const mp_obj_type_t mp_type_KeyError;
577extern const mp_obj_type_t mp_type_LookupError;
578extern const mp_obj_type_t mp_type_MemoryError;
579extern const mp_obj_type_t mp_type_NameError;
580extern const mp_obj_type_t mp_type_NotImplementedError;
581extern const mp_obj_type_t mp_type_OSError;
Daniel Campora077812b2015-06-29 22:45:39 +0200582extern const mp_obj_type_t mp_type_TimeoutError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000583extern const mp_obj_type_t mp_type_OverflowError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000584extern const mp_obj_type_t mp_type_RuntimeError;
pohmelie81ebba72016-01-27 23:23:11 +0300585extern const mp_obj_type_t mp_type_StopAsyncIteration;
Damien Georgeffb5cfc2014-03-25 14:29:40 +0000586extern const mp_obj_type_t mp_type_StopIteration;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000587extern const mp_obj_type_t mp_type_SyntaxError;
Damien George7a4ddd22014-05-24 23:32:19 +0100588extern const mp_obj_type_t mp_type_SystemExit;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000589extern const mp_obj_type_t mp_type_TypeError;
Paul Sokolovsky71ebd4b2015-02-23 23:18:36 +0200590extern const mp_obj_type_t mp_type_UnicodeError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000591extern const mp_obj_type_t mp_type_ValueError;
Damien Georgec8b60f02015-04-20 13:29:31 +0000592extern const mp_obj_type_t mp_type_ViperTypeError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000593extern const mp_obj_type_t mp_type_ZeroDivisionError;
594
Damiend99b0522013-12-21 18:17:45 +0000595// Constant objects, globally accessible
Damien George07ddab52014-03-29 13:15:08 +0000596// The macros are for convenience only
Damien George999cedb2015-11-27 17:01:44 +0000597#define mp_const_none (MP_OBJ_FROM_PTR(&mp_const_none_obj))
598#define mp_const_false (MP_OBJ_FROM_PTR(&mp_const_false_obj))
599#define mp_const_true (MP_OBJ_FROM_PTR(&mp_const_true_obj))
600#define mp_const_empty_bytes (MP_OBJ_FROM_PTR(&mp_const_empty_bytes_obj))
601#define mp_const_empty_tuple (MP_OBJ_FROM_PTR(&mp_const_empty_tuple_obj))
Damien George07ddab52014-03-29 13:15:08 +0000602extern const struct _mp_obj_none_t mp_const_none_obj;
603extern const struct _mp_obj_bool_t mp_const_false_obj;
604extern const struct _mp_obj_bool_t mp_const_true_obj;
Damien George20f59e12014-10-11 17:56:43 +0100605extern const struct _mp_obj_str_t mp_const_empty_bytes_obj;
Damien George07ddab52014-03-29 13:15:08 +0000606extern const struct _mp_obj_tuple_t mp_const_empty_tuple_obj;
Paul Sokolovsky76677272015-05-05 22:18:07 +0300607extern const struct _mp_obj_singleton_t mp_const_ellipsis_obj;
608extern const struct _mp_obj_singleton_t mp_const_notimplemented_obj;
Damien George6902eed2014-04-04 10:52:59 +0000609extern const struct _mp_obj_exception_t mp_const_MemoryError_obj;
Damien George07ddab52014-03-29 13:15:08 +0000610extern const struct _mp_obj_exception_t mp_const_GeneratorExit_obj;
Damiend99b0522013-12-21 18:17:45 +0000611
Damiend99b0522013-12-21 18:17:45 +0000612// General API for objects
613
Damien Georgea71c83a2014-02-15 11:34:50 +0000614mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict);
Damiend99b0522013-12-21 18:17:45 +0000615mp_obj_t mp_obj_new_none(void);
Paul Sokolovsky1b586f32015-10-11 12:09:43 +0300616static inline mp_obj_t mp_obj_new_bool(mp_int_t x) { return x ? mp_const_true : mp_const_false; }
Damien George6baf76e2013-12-30 22:32:17 +0000617mp_obj_t mp_obj_new_cell(mp_obj_t obj);
Damien George40f3c022014-07-03 13:25:24 +0100618mp_obj_t mp_obj_new_int(mp_int_t value);
619mp_obj_t mp_obj_new_int_from_uint(mp_uint_t value);
Damien Georgeda36f522017-02-16 16:41:43 +1100620mp_obj_t mp_obj_new_int_from_str_len(const char **str, size_t len, bool neg, unsigned int base);
Damien George9d68e9c2014-03-12 15:38:15 +0000621mp_obj_t mp_obj_new_int_from_ll(long long val); // this must return a multi-precision integer object (or raise an overflow exception)
Damien George95307432014-09-10 22:10:33 +0100622mp_obj_t mp_obj_new_int_from_ull(unsigned long long val); // this must return a multi-precision integer object (or raise an overflow exception)
Damien Georgec0d95002017-02-16 16:26:48 +1100623mp_obj_t mp_obj_new_str(const char* data, size_t len, bool make_qstr_if_not_already);
Damien George0b9ee862015-01-21 19:14:25 +0000624mp_obj_t mp_obj_new_str_from_vstr(const mp_obj_type_t *type, vstr_t *vstr);
Damien Georgec0d95002017-02-16 16:26:48 +1100625mp_obj_t mp_obj_new_bytes(const byte* data, size_t len);
Damien Georgeccc52542017-02-16 16:31:43 +1100626mp_obj_t mp_obj_new_bytearray(size_t n, void *items);
627mp_obj_t mp_obj_new_bytearray_by_ref(size_t n, void *items);
Damien Georgefb510b32014-06-01 13:32:54 +0100628#if MICROPY_PY_BUILTINS_FLOAT
Paul Sokolovsky5f680942014-12-30 00:34:54 +0200629mp_obj_t mp_obj_new_int_from_float(mp_float_t val);
Damiend99b0522013-12-21 18:17:45 +0000630mp_obj_t mp_obj_new_complex(mp_float_t real, mp_float_t imag);
631#endif
Damien Georgec5966122014-02-15 16:10:44 +0000632mp_obj_t mp_obj_new_exception(const mp_obj_type_t *exc_type);
Paul Sokolovskydec31bb2014-04-22 00:01:13 +0300633mp_obj_t mp_obj_new_exception_arg1(const mp_obj_type_t *exc_type, mp_obj_t arg);
Damien Georgefa5a5912017-02-16 16:38:14 +1100634mp_obj_t mp_obj_new_exception_args(const mp_obj_type_t *exc_type, size_t n_args, const mp_obj_t *args);
Damien Georgec5966122014-02-15 16:10:44 +0000635mp_obj_t mp_obj_new_exception_msg(const mp_obj_type_t *exc_type, const char *msg);
636mp_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!)
Damien George713ea182015-10-23 01:23:11 +0100637mp_obj_t mp_obj_new_fun_bc(mp_obj_t def_args, mp_obj_t def_kw_args, const byte *code, const mp_uint_t *const_table);
638mp_obj_t mp_obj_new_fun_native(mp_obj_t def_args_in, mp_obj_t def_kw_args, const void *fun_data, const mp_uint_t *const_table);
Damien Georgedbcdb9f2017-02-16 16:34:53 +1100639mp_obj_t mp_obj_new_fun_viper(size_t n_args, void *fun_data, mp_uint_t type_sig);
640mp_obj_t mp_obj_new_fun_asm(size_t n_args, void *fun_data, mp_uint_t type_sig);
Damien Georged0691cc2014-01-29 20:30:52 +0000641mp_obj_t mp_obj_new_gen_wrap(mp_obj_t fun);
Damien Georgeefa62902017-02-16 16:36:04 +1100642mp_obj_t mp_obj_new_closure(mp_obj_t fun, size_t n_closed, const mp_obj_t *closed);
Damien George22982392017-02-16 16:09:51 +1100643mp_obj_t mp_obj_new_tuple(size_t n, const mp_obj_t *items);
Damien George58d9eeb2017-02-16 16:12:41 +1100644mp_obj_t mp_obj_new_list(size_t n, mp_obj_t *items);
Damien George1ea2f7a2017-02-16 16:15:04 +1100645mp_obj_t mp_obj_new_dict(size_t n_args);
Damien George68cd3a92017-02-16 16:16:33 +1100646mp_obj_t mp_obj_new_set(size_t n_args, mp_obj_t *items);
Paul Sokolovsky1c6de112014-01-03 02:41:17 +0200647mp_obj_t mp_obj_new_slice(mp_obj_t start, mp_obj_t stop, mp_obj_t step);
Damien George35e2a4e2014-02-05 00:51:47 +0000648mp_obj_t mp_obj_new_super(mp_obj_t type, mp_obj_t obj);
Damien George20006db2014-01-18 14:10:48 +0000649mp_obj_t mp_obj_new_bound_meth(mp_obj_t meth, mp_obj_t self);
Damien Georgeae8d8672016-01-09 23:14:54 +0000650mp_obj_t mp_obj_new_getitem_iter(mp_obj_t *args, mp_obj_iter_buf_t *iter_buf);
Damien George28708622014-01-02 21:30:26 +0000651mp_obj_t mp_obj_new_module(qstr module_name);
Damien Georgeccc52542017-02-16 16:31:43 +1100652mp_obj_t mp_obj_new_memoryview(byte typecode, size_t nitems, void *items);
Damiend99b0522013-12-21 18:17:45 +0000653
Paul Sokolovsky7aca1ca2014-05-11 02:26:42 +0300654mp_obj_type_t *mp_obj_get_type(mp_const_obj_t o_in);
655const char *mp_obj_get_type_str(mp_const_obj_t o_in);
Damien George9e6e9352014-03-26 18:37:06 +0000656bool mp_obj_is_subclass_fast(mp_const_obj_t object, mp_const_obj_t classinfo); // arguments should be type objects
Paul Sokolovskyea970802014-05-11 03:16:04 +0300657mp_obj_t mp_instance_cast_to_native_base(mp_const_obj_t self_in, mp_const_obj_t native_type);
Damiend99b0522013-12-21 18:17:45 +0000658
Damien George7f9d1d62015-04-09 23:56:15 +0100659void mp_obj_print_helper(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind);
Paul Sokolovsky76d982e2014-01-13 19:19:16 +0200660void mp_obj_print(mp_obj_t o, mp_print_kind_t kind);
Damien George7f9d1d62015-04-09 23:56:15 +0100661void mp_obj_print_exception(const mp_print_t *print, mp_obj_t exc);
Damiend99b0522013-12-21 18:17:45 +0000662
Damien George4d917232014-08-30 14:28:06 +0100663bool mp_obj_is_true(mp_obj_t arg);
Damiend99b0522013-12-21 18:17:45 +0000664bool mp_obj_is_callable(mp_obj_t o_in);
Damiend99b0522013-12-21 18:17:45 +0000665bool mp_obj_equal(mp_obj_t o1, mp_obj_t o2);
Damiend99b0522013-12-21 18:17:45 +0000666
Damien George40f3c022014-07-03 13:25:24 +0100667mp_int_t mp_obj_get_int(mp_const_obj_t arg);
Damien Georgec50772d2015-05-12 23:05:53 +0100668mp_int_t mp_obj_get_int_truncated(mp_const_obj_t arg);
Damien George40f3c022014-07-03 13:25:24 +0100669bool mp_obj_get_int_maybe(mp_const_obj_t arg, mp_int_t *value);
Damien Georgefb510b32014-06-01 13:32:54 +0100670#if MICROPY_PY_BUILTINS_FLOAT
Damiend99b0522013-12-21 18:17:45 +0000671mp_float_t mp_obj_get_float(mp_obj_t self_in);
672void mp_obj_get_complex(mp_obj_t self_in, mp_float_t *real, mp_float_t *imag);
673#endif
Damien George5fa93b62014-01-22 14:35:10 +0000674//qstr mp_obj_get_qstr(mp_obj_t arg);
Damien Georgeeb54e4d2016-05-04 10:19:08 +0100675void mp_obj_get_array(mp_obj_t o, mp_uint_t *len, mp_obj_t **items); // *items may point inside a GC block
676void mp_obj_get_array_fixed_n(mp_obj_t o, mp_uint_t len, mp_obj_t **items); // *items may point inside a GC block
Damien George9c4cbe22014-08-30 14:04:14 +0100677mp_uint_t mp_get_index(const mp_obj_type_t *type, mp_uint_t len, mp_obj_t index, bool is_slice);
Damien Georgec7687ad2014-08-22 21:48:30 +0100678mp_obj_t mp_obj_id(mp_obj_t o_in);
Damien George4c03b3a2014-08-12 18:33:40 +0100679mp_obj_t mp_obj_len(mp_obj_t o_in);
Damien George2801e6f2015-04-04 15:53:11 +0100680mp_obj_t mp_obj_len_maybe(mp_obj_t o_in); // may return MP_OBJ_NULL
Damien George729f7b42014-04-17 22:10:53 +0100681mp_obj_t mp_obj_subscr(mp_obj_t base, mp_obj_t index, mp_obj_t val);
Damien Georgec2a4e4e2015-05-11 12:25:19 +0000682mp_obj_t mp_generic_unary_op(mp_uint_t op, mp_obj_t o_in);
Damiend99b0522013-12-21 18:17:45 +0000683
Damiend99b0522013-12-21 18:17:45 +0000684// cell
685mp_obj_t mp_obj_cell_get(mp_obj_t self_in);
686void mp_obj_cell_set(mp_obj_t self_in, mp_obj_t obj);
687
Damien George71c51812014-01-04 20:21:15 +0000688// int
Damien George40f3c022014-07-03 13:25:24 +0100689// For long int, returns value truncated to mp_int_t
Damien Georgebe6d8be2014-12-05 23:13:52 +0000690mp_int_t mp_obj_int_get_truncated(mp_const_obj_t self_in);
691// Will raise exception if value doesn't fit into mp_int_t
692mp_int_t mp_obj_int_get_checked(mp_const_obj_t self_in);
Damien George71c51812014-01-04 20:21:15 +0000693
Damienb86e3f92013-12-29 17:17:43 +0000694// exception
Paul Sokolovskyd8351ca2014-05-02 01:51:25 +0300695#define mp_obj_is_native_exception_instance(o) (mp_obj_get_type(o)->make_new == mp_obj_exception_make_new)
Damien Georgec5966122014-02-15 16:10:44 +0000696bool mp_obj_is_exception_type(mp_obj_t self_in);
697bool mp_obj_is_exception_instance(mp_obj_t self_in);
Damien George4bcd04b2014-09-24 14:05:40 +0100698bool mp_obj_exception_match(mp_obj_t exc, mp_const_obj_t exc_type);
Damien Georgec5966122014-02-15 16:10:44 +0000699void mp_obj_exception_clear_traceback(mp_obj_t self_in);
Damien George3d2daa22016-01-02 22:04:12 +0000700void mp_obj_exception_add_traceback(mp_obj_t self_in, qstr file, size_t line, qstr block);
701void mp_obj_exception_get_traceback(mp_obj_t self_in, size_t *n, size_t **values);
Paul Sokolovskyaf1ae302014-03-26 19:17:20 +0200702mp_obj_t mp_obj_exception_get_value(mp_obj_t self_in);
Damien George5b3f0b72016-01-03 15:55:55 +0000703mp_obj_t mp_obj_exception_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args);
Dave Hylands5b7fd202014-07-01 23:46:53 -0700704mp_obj_t mp_alloc_emergency_exception_buf(mp_obj_t size_in);
705void mp_init_emergency_exception_buf(void);
Damienb86e3f92013-12-29 17:17:43 +0000706
Damiend99b0522013-12-21 18:17:45 +0000707// str
Damien George5fa93b62014-01-22 14:35:10 +0000708bool mp_obj_str_equal(mp_obj_t s1, mp_obj_t s2);
Damien Georgeb829b5c2014-01-25 13:51:19 +0000709qstr mp_obj_str_get_qstr(mp_obj_t self_in); // use this if you will anyway convert the string to a qstr
Damien George5fa93b62014-01-22 14:35:10 +0000710const char *mp_obj_str_get_str(mp_obj_t self_in); // use this only if you need the string to be null terminated
Damien Georged182b982014-08-30 14:19:41 +0100711const char *mp_obj_str_get_data(mp_obj_t self_in, mp_uint_t *len);
Paul Sokolovskyb4efac12014-06-08 01:13:35 +0300712mp_obj_t mp_obj_str_intern(mp_obj_t str);
Damien Georgec0d95002017-02-16 16:26:48 +1100713void mp_str_print_quoted(const mp_print_t *print, const byte *str_data, size_t str_len, bool is_bytes);
Damiend99b0522013-12-21 18:17:45 +0000714
Damien Georgefb510b32014-06-01 13:32:54 +0100715#if MICROPY_PY_BUILTINS_FLOAT
Damiend99b0522013-12-21 18:17:45 +0000716// float
Damien Georgeecc88e92014-08-30 00:35:11 +0100717mp_obj_t mp_obj_float_binary_op(mp_uint_t op, mp_float_t lhs_val, mp_obj_t rhs); // can return MP_OBJ_NULL if op not supported
Damiend99b0522013-12-21 18:17:45 +0000718
719// complex
Damiend99b0522013-12-21 18:17:45 +0000720void mp_obj_complex_get(mp_obj_t self_in, mp_float_t *real, mp_float_t *imag);
Damien Georgeecc88e92014-08-30 00:35:11 +0100721mp_obj_t mp_obj_complex_binary_op(mp_uint_t op, mp_float_t lhs_real, mp_float_t lhs_imag, mp_obj_t rhs_in); // can return MP_OBJ_NULL if op not supported
Paul Sokolovskydc3eb552016-02-14 19:12:57 +0200722#else
723#define mp_obj_is_float(o) (false)
Damiend99b0522013-12-21 18:17:45 +0000724#endif
725
726// tuple
Damien George9c4cbe22014-08-30 14:04:14 +0100727void mp_obj_tuple_get(mp_obj_t self_in, mp_uint_t *len, mp_obj_t **items);
John R. Lenton07205ec2014-01-13 02:31:00 +0000728void mp_obj_tuple_del(mp_obj_t self_in);
Damien George40f3c022014-07-03 13:25:24 +0100729mp_int_t mp_obj_tuple_hash(mp_obj_t self_in);
Damiend99b0522013-12-21 18:17:45 +0000730
731// list
Paul Sokolovsky18bef252014-04-13 06:17:29 +0300732struct _mp_obj_list_t;
Damien George58d9eeb2017-02-16 16:12:41 +1100733void mp_obj_list_init(struct _mp_obj_list_t *o, size_t n);
Damiend99b0522013-12-21 18:17:45 +0000734mp_obj_t mp_obj_list_append(mp_obj_t self_in, mp_obj_t arg);
Damien Georgeeff359e2015-02-21 14:47:02 +0000735mp_obj_t mp_obj_list_remove(mp_obj_t self_in, mp_obj_t value);
Damien George9c4cbe22014-08-30 14:04:14 +0100736void mp_obj_list_get(mp_obj_t self_in, mp_uint_t *len, mp_obj_t **items);
Damien George58d9eeb2017-02-16 16:12:41 +1100737void mp_obj_list_set_len(mp_obj_t self_in, size_t len);
Damiend99b0522013-12-21 18:17:45 +0000738void mp_obj_list_store(mp_obj_t self_in, mp_obj_t index, mp_obj_t value);
Damien George4b72b3a2016-01-03 14:21:40 +0000739mp_obj_t mp_obj_list_sort(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs);
Damiend99b0522013-12-21 18:17:45 +0000740
741// dict
Damien Georgedf6567e2014-03-30 13:54:02 +0100742typedef struct _mp_obj_dict_t {
743 mp_obj_base_t base;
744 mp_map_t map;
745} mp_obj_dict_t;
Damien George1ea2f7a2017-02-16 16:15:04 +1100746void mp_obj_dict_init(mp_obj_dict_t *dict, size_t n_args);
747size_t mp_obj_dict_len(mp_obj_t self_in);
Paul Sokolovsky75ce9252014-06-05 20:02:15 +0300748mp_obj_t mp_obj_dict_get(mp_obj_t self_in, mp_obj_t index);
Damiend99b0522013-12-21 18:17:45 +0000749mp_obj_t mp_obj_dict_store(mp_obj_t self_in, mp_obj_t key, mp_obj_t value);
Damien George66edc5d2014-04-05 13:25:13 +0100750mp_obj_t mp_obj_dict_delete(mp_obj_t self_in, mp_obj_t key);
Damien Georgedf6567e2014-03-30 13:54:02 +0100751mp_map_t *mp_obj_dict_get_map(mp_obj_t self_in);
Damiend99b0522013-12-21 18:17:45 +0000752
753// set
754void mp_obj_set_store(mp_obj_t self_in, mp_obj_t item);
755
Paul Sokolovsky1c6de112014-01-03 02:41:17 +0200756// slice
Paul Sokolovskyafaaf532014-05-25 01:39:27 +0300757void mp_obj_slice_get(mp_obj_t self_in, mp_obj_t *start, mp_obj_t *stop, mp_obj_t *step);
Paul Sokolovsky1c6de112014-01-03 02:41:17 +0200758
Damiend99b0522013-12-21 18:17:45 +0000759// functions
Damien George571e6f22016-10-18 11:49:27 +1100760
761typedef struct _mp_obj_fun_builtin_fixed_t {
Damiend99b0522013-12-21 18:17:45 +0000762 mp_obj_base_t base;
Damien George1b0aab62016-01-03 11:53:44 +0000763 union {
764 mp_fun_0_t _0;
765 mp_fun_1_t _1;
766 mp_fun_2_t _2;
767 mp_fun_3_t _3;
Damien George571e6f22016-10-18 11:49:27 +1100768 } fun;
769} mp_obj_fun_builtin_fixed_t;
770
771#define MP_OBJ_FUN_ARGS_MAX (0xffff) // to set maximum value in n_args_max below
772typedef struct _mp_obj_fun_builtin_var_t {
773 mp_obj_base_t base;
774 bool is_kw : 1;
775 mp_uint_t n_args_min : 15; // inclusive
776 mp_uint_t n_args_max : 16; // inclusive
777 union {
Damien George1b0aab62016-01-03 11:53:44 +0000778 mp_fun_var_t var;
779 mp_fun_kw_t kw;
780 } fun;
Damien George571e6f22016-10-18 11:49:27 +1100781} mp_obj_fun_builtin_var_t;
Damien George97209d32014-01-07 15:58:30 +0000782
stijn3cc17c62015-02-14 18:44:31 +0100783qstr mp_obj_fun_get_name(mp_const_obj_t fun);
784qstr mp_obj_code_get_name(const byte *code_info);
Damien660365e2013-12-17 18:27:24 +0000785
Paul Sokolovskydff3f892014-01-20 18:37:30 +0200786mp_obj_t mp_identity(mp_obj_t self);
Damien George4ebdb1f2016-10-18 11:06:20 +1100787MP_DECLARE_CONST_FUN_OBJ_1(mp_identity_obj);
Damien Georgeae8d8672016-01-09 23:14:54 +0000788mp_obj_t mp_identity_getiter(mp_obj_t self, mp_obj_iter_buf_t *iter_buf);
Paul Sokolovskydff3f892014-01-20 18:37:30 +0200789
Damien George28708622014-01-02 21:30:26 +0000790// module
Damien George0c36da02014-03-08 15:24:39 +0000791typedef struct _mp_obj_module_t {
792 mp_obj_base_t base;
Damien George8b0535e2014-04-05 21:53:54 +0100793 mp_obj_dict_t *globals;
Damien George0c36da02014-03-08 15:24:39 +0000794} mp_obj_module_t;
Damien George8b0535e2014-04-05 21:53:54 +0100795mp_obj_dict_t *mp_obj_module_get_globals(mp_obj_t self_in);
Paul Sokolovskye5a37592014-10-25 21:04:13 +0300796// check if given module object is a package
797bool mp_obj_is_package(mp_obj_t module);
Damien Georgeeae16442014-01-11 19:22:29 +0000798
799// staticmethod and classmethod types; defined here so we can make const versions
Damien George64131f32014-02-06 20:31:44 +0000800// this structure is used for instances of both staticmethod and classmethod
801typedef struct _mp_obj_static_class_method_t {
Damien Georgeeae16442014-01-11 19:22:29 +0000802 mp_obj_base_t base;
803 mp_obj_t fun;
Damien George64131f32014-02-06 20:31:44 +0000804} mp_obj_static_class_method_t;
Damien Georgecbf76742015-11-27 13:38:15 +0000805typedef struct _mp_rom_obj_static_class_method_t {
806 mp_obj_base_t base;
807 mp_rom_obj_t fun;
808} mp_rom_obj_static_class_method_t;
Paul Sokolovsky439542f2014-01-21 00:19:19 +0200809
Damien George777b0f32014-04-13 18:59:45 +0100810// property
811const mp_obj_t *mp_obj_property_get(mp_obj_t self_in);
812
Paul Sokolovsky439542f2014-01-21 00:19:19 +0200813// sequence helpers
Paul Sokolovskyde4b9322014-05-25 21:21:57 +0300814
815// slice indexes resolved to particular sequence
816typedef struct {
Damien George40f3c022014-07-03 13:25:24 +0100817 mp_uint_t start;
818 mp_uint_t stop;
819 mp_int_t step;
Paul Sokolovskyde4b9322014-05-25 21:21:57 +0300820} mp_bound_slice_t;
821
Damien Georged182b982014-08-30 14:19:41 +0100822void mp_seq_multiply(const void *items, mp_uint_t item_sz, mp_uint_t len, mp_uint_t times, void *dest);
Damien Georgec49ddb92014-06-01 13:49:35 +0100823#if MICROPY_PY_BUILTINS_SLICE
Damien George40f3c022014-07-03 13:25:24 +0100824bool mp_seq_get_fast_slice_indexes(mp_uint_t len, mp_obj_t slice, mp_bound_slice_t *indexes);
Damien Georgec49ddb92014-06-01 13:49:35 +0100825#endif
Paul Sokolovskyd915a522014-05-10 21:36:33 +0300826#define mp_seq_copy(dest, src, len, item_t) memcpy(dest, src, len * sizeof(item_t))
827#define mp_seq_cat(dest, src1, len1, src2, len2, item_t) { memcpy(dest, src1, (len1) * sizeof(item_t)); memcpy(dest + (len1), src2, (len2) * sizeof(item_t)); }
Damien George4d917232014-08-30 14:28:06 +0100828bool mp_seq_cmp_bytes(mp_uint_t op, const byte *data1, mp_uint_t len1, const byte *data2, mp_uint_t len2);
829bool mp_seq_cmp_objs(mp_uint_t op, const mp_obj_t *items1, mp_uint_t len1, const mp_obj_t *items2, mp_uint_t len2);
Damien Georged182b982014-08-30 14:19:41 +0100830mp_obj_t mp_seq_index_obj(const mp_obj_t *items, mp_uint_t len, mp_uint_t n_args, const mp_obj_t *args);
831mp_obj_t mp_seq_count_obj(const mp_obj_t *items, mp_uint_t len, mp_obj_t value);
832mp_obj_t mp_seq_extract_slice(mp_uint_t len, const mp_obj_t *seq, mp_bound_slice_t *indexes);
Paul Sokolovskya2240672014-04-28 00:16:57 +0300833// Helper to clear stale pointers from allocated, but unused memory, to preclude GC problems
834#define mp_seq_clear(start, len, alloc_len, item_sz) memset((byte*)(start) + (len) * (item_sz), 0, ((alloc_len) - (len)) * (item_sz))
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200835#define mp_seq_replace_slice_no_grow(dest, dest_len, beg, end, slice, slice_len, item_sz) \
836 /*printf("memcpy(%p, %p, %d)\n", dest + beg, slice, slice_len * (item_sz));*/ \
837 memcpy(((char*)dest) + (beg) * (item_sz), slice, slice_len * (item_sz)); \
838 /*printf("memmove(%p, %p, %d)\n", dest + (beg + slice_len), dest + end, (dest_len - end) * (item_sz));*/ \
839 memmove(((char*)dest) + (beg + slice_len) * (item_sz), ((char*)dest) + (end) * (item_sz), (dest_len - end) * (item_sz));
Paul Sokolovsky2705f4c2014-05-25 02:36:12 +0300840
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200841#define mp_seq_replace_slice_grow_inplace(dest, dest_len, beg, end, slice, slice_len, len_adj, item_sz) \
842 /*printf("memmove(%p, %p, %d)\n", dest + beg + len_adj, dest + beg, (dest_len - beg) * (item_sz));*/ \
843 memmove(((char*)dest) + (beg + len_adj) * (item_sz), ((char*)dest) + (beg) * (item_sz), (dest_len - beg) * (item_sz)); \
844 memcpy(((char*)dest) + (beg) * (item_sz), slice, slice_len * (item_sz));
Damien George9ddbe292014-12-29 01:02:19 +0000845
846#endif // __MICROPY_INCLUDED_PY_OBJ_H__