blob: f816b8544ded294ab486ae96a055ff2ed4bdfeff [file] [log] [blame]
Damiend99b0522013-12-21 18:17:45 +00001// All Micro Python objects are at least this type
2// It must be of pointer size
3
4typedef machine_ptr_t mp_obj_t;
5typedef machine_const_ptr_t mp_const_obj_t;
6
7// Integers that fit in a pointer have this type
8// (do we need to expose this in the public API?)
9
10typedef machine_int_t mp_small_int_t;
11
Damien George97209d32014-01-07 15:58:30 +000012// Anything that wants to be a Micro Python object must have
13// mp_obj_base_t as its first member (except NULL and small ints)
Damien660365e2013-12-17 18:27:24 +000014
ian-v7a16fad2014-01-06 09:52:29 -080015struct _mp_obj_type_t;
Damiend99b0522013-12-21 18:17:45 +000016struct _mp_obj_base_t {
ian-v7a16fad2014-01-06 09:52:29 -080017 const struct _mp_obj_type_t *type;
Damiend99b0522013-12-21 18:17:45 +000018};
ian-v7a16fad2014-01-06 09:52:29 -080019typedef struct _mp_obj_base_t mp_obj_base_t;
Damiend99b0522013-12-21 18:17:45 +000020
21// The NULL object is used to indicate the absence of an object
22// It *cannot* be used when an mp_obj_t is expected, except where explicitly allowed
23
24#define MP_OBJ_NULL ((mp_obj_t)NULL)
25
Damien George38a2da62014-01-08 17:33:12 +000026// These macros check for small int, qstr or object, and access small int and qstr values
27// - xxxx...xxx1: a small int, bits 1 and above are the value
28// - xxxx...xx10: a qstr, bits 2 and above are the value
29// - xxxx...xx00: a pointer to an mp_obj_base_t
Damiend99b0522013-12-21 18:17:45 +000030
Paul Sokolovsky757ac812014-01-12 17:06:25 +020031// In SMALL_INT, next-to-highest bits is used as sign, so both must match for value in range
Damien George9d68e9c2014-03-12 15:38:15 +000032#define MP_SMALL_INT_MIN ((mp_small_int_t)(((machine_int_t)WORD_MSBIT_HIGH) >> 1))
33#define MP_SMALL_INT_MAX ((mp_small_int_t)(~(MP_SMALL_INT_MIN)))
Paul Sokolovsky757ac812014-01-12 17:06:25 +020034#define MP_OBJ_FITS_SMALL_INT(n) ((((n) ^ ((n) << 1)) & WORD_MSBIT_HIGH) == 0)
Damiend99b0522013-12-21 18:17:45 +000035#define MP_OBJ_IS_SMALL_INT(o) ((((mp_small_int_t)(o)) & 1) != 0)
Damien George38a2da62014-01-08 17:33:12 +000036#define MP_OBJ_IS_QSTR(o) ((((mp_small_int_t)(o)) & 3) == 2)
37#define MP_OBJ_IS_OBJ(o) ((((mp_small_int_t)(o)) & 3) == 0)
Damien George7c9c6672014-01-25 00:17:36 +000038#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
Paul Sokolovsky2ca84aa2014-01-26 01:57:48 +020039#define MP_OBJ_IS_INT(o) (MP_OBJ_IS_SMALL_INT(o) || MP_OBJ_IS_TYPE(o, &int_type))
Damien George5fa93b62014-01-22 14:35:10 +000040#define MP_OBJ_IS_STR(o) (MP_OBJ_IS_QSTR(o) || MP_OBJ_IS_TYPE(o, &str_type))
Damien George38a2da62014-01-08 17:33:12 +000041
Damiend99b0522013-12-21 18:17:45 +000042#define MP_OBJ_SMALL_INT_VALUE(o) (((mp_small_int_t)(o)) >> 1)
Damien George38a2da62014-01-08 17:33:12 +000043#define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)(((small_int) << 1) | 1))
44
45#define MP_OBJ_QSTR_VALUE(o) (((mp_small_int_t)(o)) >> 2)
46#define MP_OBJ_NEW_QSTR(qstr) ((mp_obj_t)((((machine_uint_t)qstr) << 2) | 2))
Damiend99b0522013-12-21 18:17:45 +000047
48// These macros are used to declare and define constant function objects
49// You can put "static" in front of the definitions to make them local
50
51#define MP_DECLARE_CONST_FUN_OBJ(obj_name) extern const mp_obj_fun_native_t obj_name
52
Damien George51047752014-02-26 17:40:52 +000053#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}
John R. Lenton270112f2014-01-07 18:01:08 +000054#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)
55#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)
56#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)
57#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)
Damien Georged5e81822014-02-26 17:47:05 +000058#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)
John R. Lenton270112f2014-01-07 18:01:08 +000059#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)
Damien Georged5e81822014-02-26 17:47:05 +000060#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)
John R. Lentonc06763a2014-01-07 17:29:16 +000061
Damien George9b196cd2014-03-26 21:47:19 +000062// This macro is used to define constant dict objects
63// You can put "static" in front of the definition to make it local
64
65#define MP_DEFINE_CONST_DICT(dict_name, table_name) \
66 const mp_obj_dict_t dict_name = { \
67 .base = {&dict_type}, \
68 .map = { \
69 .all_keys_are_qstrs = 1, \
70 .table_is_fixed_array = 1, \
71 .used = sizeof(table_name) / sizeof(mp_map_elem_t), \
72 .alloc = sizeof(table_name) / sizeof(mp_map_elem_t), \
73 .table = (mp_map_elem_t*)table_name, \
74 }, \
75 }
76
Damien Georgeeae16442014-01-11 19:22:29 +000077// These macros are used to declare and define constant staticmethond and classmethod objects
78// You can put "static" in front of the definitions to make them local
79
Damien George64131f32014-02-06 20:31:44 +000080#define MP_DECLARE_CONST_STATICMETHOD_OBJ(obj_name) extern const mp_obj_static_class_method_t obj_name
81#define MP_DECLARE_CONST_CLASSMETHOD_OBJ(obj_name) extern const mp_obj_static_class_method_t obj_name
Damien Georgeeae16442014-01-11 19:22:29 +000082
Damien George64131f32014-02-06 20:31:44 +000083#define MP_DEFINE_CONST_STATICMETHOD_OBJ(obj_name, fun_name) const mp_obj_static_class_method_t obj_name = {{&mp_type_staticmethod}, fun_name}
84#define MP_DEFINE_CONST_CLASSMETHOD_OBJ(obj_name, fun_name) const mp_obj_static_class_method_t obj_name = {{&mp_type_classmethod}, fun_name}
Damien Georgeeae16442014-01-11 19:22:29 +000085
John R. Lentonc06763a2014-01-07 17:29:16 +000086// Need to declare this here so we are not dependent on map.h
87struct _mp_map_t;
Damien George062478e2014-01-09 20:57:50 +000088struct _mp_map_elem_t;
Damiend99b0522013-12-21 18:17:45 +000089
90// Type definitions for methods
91
92typedef mp_obj_t (*mp_fun_0_t)(void);
93typedef mp_obj_t (*mp_fun_1_t)(mp_obj_t);
94typedef mp_obj_t (*mp_fun_2_t)(mp_obj_t, mp_obj_t);
John R. Lenton45a87442014-01-04 01:15:01 +000095typedef mp_obj_t (*mp_fun_3_t)(mp_obj_t, mp_obj_t, mp_obj_t);
Damiend99b0522013-12-21 18:17:45 +000096typedef mp_obj_t (*mp_fun_t)(void);
Damien Georgea11ceca2014-01-19 16:02:09 +000097typedef mp_obj_t (*mp_fun_var_t)(uint n, const mp_obj_t *);
Damien George20006db2014-01-18 14:10:48 +000098typedef mp_obj_t (*mp_fun_kw_t)(uint n, const mp_obj_t *, struct _mp_map_t *);
Damiend99b0522013-12-21 18:17:45 +000099
Paul Sokolovsky76d982e2014-01-13 19:19:16 +0200100typedef enum {
101 PRINT_STR, PRINT_REPR
102} mp_print_kind_t;
103
104typedef void (*mp_print_fun_t)(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o, mp_print_kind_t kind);
Damien George20006db2014-01-18 14:10:48 +0000105typedef mp_obj_t (*mp_make_new_fun_t)(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args);
106typedef mp_obj_t (*mp_call_fun_t)(mp_obj_t fun, uint n_args, uint n_kw, const mp_obj_t *args);
Damiend99b0522013-12-21 18:17:45 +0000107typedef mp_obj_t (*mp_unary_op_fun_t)(int op, mp_obj_t);
108typedef mp_obj_t (*mp_binary_op_fun_t)(int op, mp_obj_t, mp_obj_t);
Damien George20006db2014-01-18 14:10:48 +0000109typedef 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
Damien George062478e2014-01-09 20:57:50 +0000110typedef bool (*mp_store_attr_fun_t)(mp_obj_t self_in, qstr attr, mp_obj_t value); // return true if store succeeded
Paul Sokolovsky6d8edf62014-01-18 13:10:51 +0200111typedef bool (*mp_store_item_fun_t)(mp_obj_t self_in, mp_obj_t index, mp_obj_t value); // return true if store succeeded
Damiend99b0522013-12-21 18:17:45 +0000112
113typedef struct _mp_method_t {
Damien Georgec12b2212014-03-26 20:15:40 +0000114 qstr name;
Damiend99b0522013-12-21 18:17:45 +0000115 mp_const_obj_t fun;
116} mp_method_t;
117
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200118// Buffer protocol
119typedef struct _buffer_info_t {
120 // if we'd bother to support various versions of structure
121 // (with different number of fields), we can distinguish
122 // them with ver = sizeof(struct). Cons: overkill for *micro*?
123 //int ver; // ?
124
125 void *buf;
126 machine_int_t len;
127
128 // Rationale: have array.array and have SIMD operations on them
129 // Cons: users can pass item size to processing functions themselves,
130 // though that's not "plug&play"
131 // int itemsize;
132
133 // Rationale: to load arbitrary-sized sprites directly to LCD
134 // Cons: a bit adhoc usecase
135 // int stride;
136} buffer_info_t;
137#define BUFFER_READ (1)
138#define BUFFER_WRITE (2)
139#define BUFFER_RW (BUFFER_READ | BUFFER_WRITE)
140typedef struct _mp_buffer_p_t {
141 machine_int_t (*get_buffer)(mp_obj_t obj, buffer_info_t *bufinfo, int flags);
142} mp_buffer_p_t;
143
144// Stream protocol
145typedef struct _mp_stream_p_t {
146 // On error, functions should return -1 and fill in *errcode (values are
147 // implementation-dependent, but will be exposed to user, e.g. via exception).
148 machine_int_t (*read)(mp_obj_t obj, void *buf, machine_uint_t size, int *errcode);
149 machine_int_t (*write)(mp_obj_t obj, const void *buf, machine_uint_t size, int *errcode);
150 // add seek() ?
151} mp_stream_p_t;
152
Damiend99b0522013-12-21 18:17:45 +0000153struct _mp_obj_type_t {
154 mp_obj_base_t base;
Damien Georgea71c83a2014-02-15 11:34:50 +0000155 qstr name;
Damiend99b0522013-12-21 18:17:45 +0000156 mp_print_fun_t print;
Damien George71c51812014-01-04 20:21:15 +0000157 mp_make_new_fun_t make_new; // to make an instance of the type
Damiend99b0522013-12-21 18:17:45 +0000158
Damien George20006db2014-01-18 14:10:48 +0000159 mp_call_fun_t call;
Damiend99b0522013-12-21 18:17:45 +0000160 mp_unary_op_fun_t unary_op; // can return NULL if op not supported
161 mp_binary_op_fun_t binary_op; // can return NULL if op not supported
162
Damien Georgea71c83a2014-02-15 11:34:50 +0000163 mp_load_attr_fun_t load_attr;
164 mp_store_attr_fun_t store_attr;
165 // Implements container[index] = val; note that load_item is implemented
166 // by binary_op(RT_BINARY_OP_SUBSCR)
167 mp_store_item_fun_t store_item;
168
Damiend99b0522013-12-21 18:17:45 +0000169 mp_fun_1_t getiter;
Damien George66eaf842014-03-26 19:27:58 +0000170 mp_fun_1_t iternext; // may return MP_OBJ_NULL as an optimisation instead of raising StopIteration() (with no args)
Damiend99b0522013-12-21 18:17:45 +0000171
Paul Sokolovsky5b15daf2014-01-07 20:12:26 +0200172 // Alternatively, pointer(s) to interfaces to save space
173 // in mp_obj_type_t at the expense of extra pointer and extra dereference
174 // when actually used.
175 mp_buffer_p_t buffer_p;
176 mp_stream_p_t stream_p;
177
Damien George004cdce2014-01-09 21:43:51 +0000178 // these are for dynamically created types (classes)
179 mp_obj_t bases_tuple;
180 mp_obj_t locals_dict;
Damien George062478e2014-01-09 20:57:50 +0000181
Damiend99b0522013-12-21 18:17:45 +0000182 /*
183 What we might need to add here:
184
Damiend99b0522013-12-21 18:17:45 +0000185 store_subscr list dict
186
187 len str tuple list map
188 abs float complex
189 hash bool int none str
190 equal int str
Damiend99b0522013-12-21 18:17:45 +0000191
192 unpack seq list tuple
Damiend99b0522013-12-21 18:17:45 +0000193 */
194};
195
ian-v7a16fad2014-01-06 09:52:29 -0800196typedef struct _mp_obj_type_t mp_obj_type_t;
Damiend99b0522013-12-21 18:17:45 +0000197
Damien Georgec5966122014-02-15 16:10:44 +0000198// Constant types, globally accessible
Damien Georgec5966122014-02-15 16:10:44 +0000199extern const mp_obj_type_t mp_type_type;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000200
201// Exceptions
Damien Georgec5966122014-02-15 16:10:44 +0000202extern const mp_obj_type_t mp_type_BaseException;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000203extern const mp_obj_type_t mp_type_ArithmeticError;
204extern const mp_obj_type_t mp_type_AssertionError;
205extern const mp_obj_type_t mp_type_AttributeError;
206extern const mp_obj_type_t mp_type_BufferError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000207extern const mp_obj_type_t mp_type_EOFError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000208extern const mp_obj_type_t mp_type_Exception;
209extern const mp_obj_type_t mp_type_FloatingPointError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000210extern const mp_obj_type_t mp_type_GeneratorExit;
211extern const mp_obj_type_t mp_type_IOError;
212extern const mp_obj_type_t mp_type_ImportError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000213extern const mp_obj_type_t mp_type_IndentationError;
214extern const mp_obj_type_t mp_type_IndexError;
215extern const mp_obj_type_t mp_type_KeyError;
216extern const mp_obj_type_t mp_type_LookupError;
217extern const mp_obj_type_t mp_type_MemoryError;
218extern const mp_obj_type_t mp_type_NameError;
219extern const mp_obj_type_t mp_type_NotImplementedError;
220extern const mp_obj_type_t mp_type_OSError;
221extern const mp_obj_type_t mp_type_OverflowError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000222extern const mp_obj_type_t mp_type_RuntimeError;
Damien Georgeffb5cfc2014-03-25 14:29:40 +0000223extern const mp_obj_type_t mp_type_StopIteration;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000224extern const mp_obj_type_t mp_type_SyntaxError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000225extern const mp_obj_type_t mp_type_SystemError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000226extern const mp_obj_type_t mp_type_TypeError;
227extern const mp_obj_type_t mp_type_UnboundLocalError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000228extern const mp_obj_type_t mp_type_ValueError;
Rachel Dowdall721c55d2014-03-22 15:28:16 +0000229extern const mp_obj_type_t mp_type_ZeroDivisionError;
230
Damiend99b0522013-12-21 18:17:45 +0000231// Constant objects, globally accessible
Damiend99b0522013-12-21 18:17:45 +0000232extern const mp_obj_t mp_const_none;
233extern const mp_obj_t mp_const_false;
234extern const mp_obj_t mp_const_true;
Damien George71c51812014-01-04 20:21:15 +0000235extern const mp_obj_t mp_const_empty_tuple;
Damien Georgee9906ac2014-01-04 18:44:46 +0000236extern const mp_obj_t mp_const_ellipsis;
Damiend99b0522013-12-21 18:17:45 +0000237
Damiend99b0522013-12-21 18:17:45 +0000238// General API for objects
239
Damien Georgea71c83a2014-02-15 11:34:50 +0000240mp_obj_t mp_obj_new_type(qstr name, mp_obj_t bases_tuple, mp_obj_t locals_dict);
Damiend99b0522013-12-21 18:17:45 +0000241mp_obj_t mp_obj_new_none(void);
242mp_obj_t mp_obj_new_bool(bool value);
Damien George6baf76e2013-12-30 22:32:17 +0000243mp_obj_t mp_obj_new_cell(mp_obj_t obj);
Damiend99b0522013-12-21 18:17:45 +0000244mp_obj_t mp_obj_new_int(machine_int_t value);
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200245mp_obj_t mp_obj_new_int_from_uint(machine_uint_t value);
246mp_obj_t mp_obj_new_int_from_long_str(const char *s);
Damien George9d68e9c2014-03-12 15:38:15 +0000247mp_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 George5fa93b62014-01-22 14:35:10 +0000248mp_obj_t mp_obj_new_str(const byte* data, uint len, bool make_qstr_if_not_already);
Paul Sokolovsky91fb1c92014-01-24 22:50:40 +0200249mp_obj_t mp_obj_new_bytes(const byte* data, uint len);
Damiend99b0522013-12-21 18:17:45 +0000250#if MICROPY_ENABLE_FLOAT
251mp_obj_t mp_obj_new_float(mp_float_t val);
252mp_obj_t mp_obj_new_complex(mp_float_t real, mp_float_t imag);
253#endif
Damien Georgec5966122014-02-15 16:10:44 +0000254mp_obj_t mp_obj_new_exception(const mp_obj_type_t *exc_type);
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200255mp_obj_t mp_obj_new_exception_args(const mp_obj_type_t *exc_type, uint n_args, const mp_obj_t *args);
Damien Georgec5966122014-02-15 16:10:44 +0000256mp_obj_t mp_obj_new_exception_msg(const mp_obj_type_t *exc_type, const char *msg);
257mp_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!)
Damiend99b0522013-12-21 18:17:45 +0000258mp_obj_t mp_obj_new_range(int start, int stop, int step);
259mp_obj_t mp_obj_new_range_iterator(int cur, int stop, int step);
Damien Georgebee17b02014-03-27 11:07:04 +0000260mp_obj_t mp_obj_new_fun_bc(uint scope_flags, qstr *args, uint n_args, mp_obj_t def_args, const byte *code);
Damiend99b0522013-12-21 18:17:45 +0000261mp_obj_t mp_obj_new_fun_asm(uint n_args, void *fun);
Damien Georged0691cc2014-01-29 20:30:52 +0000262mp_obj_t mp_obj_new_gen_wrap(mp_obj_t fun);
Damien Georgebee17b02014-03-27 11:07:04 +0000263mp_obj_t mp_obj_new_gen_instance(const byte *bytecode, int n_args, const mp_obj_t *args);
Damiend99b0522013-12-21 18:17:45 +0000264mp_obj_t mp_obj_new_closure(mp_obj_t fun, mp_obj_t closure_tuple);
John R. Lentonc06763a2014-01-07 17:29:16 +0000265mp_obj_t mp_obj_new_tuple(uint n, const mp_obj_t *items);
Damiend99b0522013-12-21 18:17:45 +0000266mp_obj_t mp_obj_new_list(uint n, mp_obj_t *items);
Damiend99b0522013-12-21 18:17:45 +0000267mp_obj_t mp_obj_new_dict(int n_args);
268mp_obj_t mp_obj_new_set(int n_args, mp_obj_t *items);
Paul Sokolovsky1c6de112014-01-03 02:41:17 +0200269mp_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 +0000270mp_obj_t mp_obj_new_super(mp_obj_t type, mp_obj_t obj);
Damien George20006db2014-01-18 14:10:48 +0000271mp_obj_t mp_obj_new_bound_meth(mp_obj_t meth, mp_obj_t self);
Damien George7c9c6672014-01-25 00:17:36 +0000272mp_obj_t mp_obj_new_getitem_iter(mp_obj_t *args);
Damien George28708622014-01-02 21:30:26 +0000273mp_obj_t mp_obj_new_module(qstr module_name);
Damiend99b0522013-12-21 18:17:45 +0000274
Damien George5fa93b62014-01-22 14:35:10 +0000275mp_obj_type_t *mp_obj_get_type(mp_obj_t o_in);
Damiend99b0522013-12-21 18:17:45 +0000276const char *mp_obj_get_type_str(mp_obj_t o_in);
Damien George9e6e9352014-03-26 18:37:06 +0000277bool mp_obj_is_subclass_fast(mp_const_obj_t object, mp_const_obj_t classinfo); // arguments should be type objects
Damiend99b0522013-12-21 18:17:45 +0000278
Paul Sokolovsky76d982e2014-01-13 19:19:16 +0200279void mp_obj_print_helper(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o_in, mp_print_kind_t kind);
280void mp_obj_print(mp_obj_t o, mp_print_kind_t kind);
Damien George136b1492014-01-19 12:38:49 +0000281void mp_obj_print_exception(mp_obj_t exc);
Damiend99b0522013-12-21 18:17:45 +0000282
283bool mp_obj_is_callable(mp_obj_t o_in);
284machine_int_t mp_obj_hash(mp_obj_t o_in);
285bool mp_obj_equal(mp_obj_t o1, mp_obj_t o2);
286bool mp_obj_less(mp_obj_t o1, mp_obj_t o2);
287
288machine_int_t mp_obj_get_int(mp_obj_t arg);
289#if MICROPY_ENABLE_FLOAT
290mp_float_t mp_obj_get_float(mp_obj_t self_in);
291void mp_obj_get_complex(mp_obj_t self_in, mp_float_t *real, mp_float_t *imag);
292#endif
Damien George5fa93b62014-01-22 14:35:10 +0000293//qstr mp_obj_get_qstr(mp_obj_t arg);
Damien George24ff0632014-03-24 10:47:13 +0000294void mp_obj_get_array(mp_obj_t o, uint *len, mp_obj_t **items);
295void mp_obj_get_array_fixed_n(mp_obj_t o, uint len, mp_obj_t **items);
xbe9e1e8cd2014-03-12 22:57:16 -0700296uint mp_get_index(const mp_obj_type_t *type, machine_uint_t len, mp_obj_t index, bool is_slice);
John R. Lenton4bee76e2014-01-10 11:25:03 +0000297mp_obj_t mp_obj_len_maybe(mp_obj_t o_in); /* may return NULL */
Damiend99b0522013-12-21 18:17:45 +0000298
Damien George3ec0a1a2014-03-22 21:31:28 +0000299// object
300extern const mp_obj_type_t mp_type_object;
301
Damiend99b0522013-12-21 18:17:45 +0000302// none
303extern const mp_obj_type_t none_type;
304
305// bool
306extern const mp_obj_type_t bool_type;
John R. Lentonb8698fc2014-01-11 00:58:59 +0000307#define MP_BOOL(x) (x ? mp_const_true : mp_const_false)
Damiend99b0522013-12-21 18:17:45 +0000308
309// cell
310mp_obj_t mp_obj_cell_get(mp_obj_t self_in);
311void mp_obj_cell_set(mp_obj_t self_in, mp_obj_t obj);
312
Damien George71c51812014-01-04 20:21:15 +0000313// int
314extern const mp_obj_type_t int_type;
Paul Sokolovskyd26b3792014-01-18 16:07:16 +0200315// For long int, returns value truncated to machine_int_t
316machine_int_t mp_obj_int_get(mp_obj_t self_in);
Damien Georgeeabdf672014-03-22 20:54:01 +0000317#if MICROPY_ENABLE_FLOAT
318mp_float_t mp_obj_int_as_float(mp_obj_t self_in);
319#endif
Paul Sokolovskyd26b3792014-01-18 16:07:16 +0200320// Will rains exception if value doesn't fit into machine_int_t
321machine_int_t mp_obj_int_get_checked(mp_obj_t self_in);
Damien George71c51812014-01-04 20:21:15 +0000322
Damienb86e3f92013-12-29 17:17:43 +0000323// exception
Damien Georgec5966122014-02-15 16:10:44 +0000324bool mp_obj_is_exception_type(mp_obj_t self_in);
325bool mp_obj_is_exception_instance(mp_obj_t self_in);
Paul Sokolovsky962b1cd2014-03-23 21:48:29 +0200326bool mp_obj_exception_match(mp_obj_t exc, const mp_obj_type_t *exc_type);
Damien Georgec5966122014-02-15 16:10:44 +0000327void mp_obj_exception_clear_traceback(mp_obj_t self_in);
Damien George136b1492014-01-19 12:38:49 +0000328void mp_obj_exception_add_traceback(mp_obj_t self_in, qstr file, machine_uint_t line, qstr block);
329void mp_obj_exception_get_traceback(mp_obj_t self_in, machine_uint_t *n, machine_uint_t **values);
Paul Sokolovskyaf1ae302014-03-26 19:17:20 +0200330mp_obj_t mp_obj_exception_get_value(mp_obj_t self_in);
Damienb86e3f92013-12-29 17:17:43 +0000331
Damiend99b0522013-12-21 18:17:45 +0000332// str
333extern const mp_obj_type_t str_type;
Paul Sokolovsky91fb1c92014-01-24 22:50:40 +0200334mp_obj_t mp_obj_str_builder_start(const mp_obj_type_t *type, uint len, byte **data);
Damien George5fa93b62014-01-22 14:35:10 +0000335mp_obj_t mp_obj_str_builder_end(mp_obj_t o_in);
336bool mp_obj_str_equal(mp_obj_t s1, mp_obj_t s2);
337uint mp_obj_str_get_hash(mp_obj_t self_in);
338uint mp_obj_str_get_len(mp_obj_t self_in);
Damien Georgeb829b5c2014-01-25 13:51:19 +0000339qstr 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 +0000340const char *mp_obj_str_get_str(mp_obj_t self_in); // use this only if you need the string to be null terminated
Damien George698ec212014-02-08 18:17:23 +0000341const char *mp_obj_str_get_data(mp_obj_t self_in, uint *len);
Paul Sokolovsky0b7e29c2014-01-28 03:40:06 +0200342void mp_str_print_quoted(void (*print)(void *env, const char *fmt, ...), void *env, const byte *str_data, uint str_len);
Damiend99b0522013-12-21 18:17:45 +0000343
Paul Sokolovsky91fb1c92014-01-24 22:50:40 +0200344// bytes
345extern const mp_obj_type_t bytes_type;
346
Damiend99b0522013-12-21 18:17:45 +0000347#if MICROPY_ENABLE_FLOAT
348// float
Damien George0c36da02014-03-08 15:24:39 +0000349typedef struct _mp_obj_float_t {
350 mp_obj_base_t base;
351 mp_float_t value;
352} mp_obj_float_t;
353extern const mp_obj_type_t mp_type_float;
Damiend99b0522013-12-21 18:17:45 +0000354mp_float_t mp_obj_float_get(mp_obj_t self_in);
Damien Georgee2e3d112014-01-06 22:13:00 +0000355mp_obj_t mp_obj_float_binary_op(int op, mp_float_t lhs_val, mp_obj_t rhs);
Damiend99b0522013-12-21 18:17:45 +0000356
357// complex
Damien George0c36da02014-03-08 15:24:39 +0000358extern const mp_obj_type_t mp_type_complex;
Damiend99b0522013-12-21 18:17:45 +0000359void mp_obj_complex_get(mp_obj_t self_in, mp_float_t *real, mp_float_t *imag);
Damien Georgee2e3d112014-01-06 22:13:00 +0000360mp_obj_t mp_obj_complex_binary_op(int op, mp_float_t lhs_real, mp_float_t lhs_imag, mp_obj_t rhs_in);
Damiend99b0522013-12-21 18:17:45 +0000361#endif
362
363// tuple
364extern const mp_obj_type_t tuple_type;
365void mp_obj_tuple_get(mp_obj_t self_in, uint *len, mp_obj_t **items);
John R. Lenton07205ec2014-01-13 02:31:00 +0000366void mp_obj_tuple_del(mp_obj_t self_in);
Damien George7f8be592014-03-20 19:20:59 +0000367machine_int_t mp_obj_tuple_hash(mp_obj_t self_in);
Damiend99b0522013-12-21 18:17:45 +0000368
369// list
370extern const mp_obj_type_t list_type;
371mp_obj_t mp_obj_list_append(mp_obj_t self_in, mp_obj_t arg);
372void mp_obj_list_get(mp_obj_t self_in, uint *len, mp_obj_t **items);
373void mp_obj_list_store(mp_obj_t self_in, mp_obj_t index, mp_obj_t value);
Damien George20006db2014-01-18 14:10:48 +0000374mp_obj_t mp_obj_list_sort(uint n_args, const mp_obj_t *args, struct _mp_map_t *kwargs);
Damiend99b0522013-12-21 18:17:45 +0000375
John R. Lenton39b174e2014-01-15 01:10:09 +0000376// map (the python builtin, not the dict implementation detail)
377extern const mp_obj_type_t map_type;
378
John R. Lenton9daa7892014-01-14 23:55:01 +0000379// enumerate
380extern const mp_obj_type_t enumerate_type;
381
John R. Lentonfca456b2014-01-15 01:37:08 +0000382// filter
383extern const mp_obj_type_t filter_type;
384
Damiend99b0522013-12-21 18:17:45 +0000385// dict
386extern const mp_obj_type_t dict_type;
Damiendae7eb72013-12-29 22:32:51 +0000387uint mp_obj_dict_len(mp_obj_t self_in);
Damiend99b0522013-12-21 18:17:45 +0000388mp_obj_t mp_obj_dict_store(mp_obj_t self_in, mp_obj_t key, mp_obj_t value);
Damien George062478e2014-01-09 20:57:50 +0000389struct _mp_map_t *mp_obj_dict_get_map(mp_obj_t self_in);
Damiend99b0522013-12-21 18:17:45 +0000390
391// set
Damien George71c51812014-01-04 20:21:15 +0000392extern const mp_obj_type_t set_type;
Damiend99b0522013-12-21 18:17:45 +0000393void mp_obj_set_store(mp_obj_t self_in, mp_obj_t item);
394
Paul Sokolovsky1c6de112014-01-03 02:41:17 +0200395// slice
396extern const mp_obj_type_t slice_type;
397void mp_obj_slice_get(mp_obj_t self_in, machine_int_t *start, machine_int_t *stop, machine_int_t *step);
398
John R. Lenton07205ec2014-01-13 02:31:00 +0000399// zip
400extern const mp_obj_type_t zip_type;
401
Paul Sokolovsky427905c2014-01-18 19:24:47 +0200402// array
Damien Georgecaac5422014-03-25 14:18:18 +0000403extern const mp_obj_type_t mp_type_array;
Paul Sokolovsky33996682014-01-21 23:30:10 +0200404uint mp_obj_array_len(mp_obj_t self_in);
Paul Sokolovsky7f11c792014-01-29 00:21:41 +0200405mp_obj_t mp_obj_new_bytearray_by_ref(uint n, void *items);
John R. Lenton07205ec2014-01-13 02:31:00 +0000406
Damiend99b0522013-12-21 18:17:45 +0000407// functions
Damien Georged5e81822014-02-26 17:47:05 +0000408#define MP_OBJ_FUN_ARGS_MAX (0xffff) // to set maximum value in n_args_max below
Damien George66028ab2014-01-03 14:03:48 +0000409typedef struct _mp_obj_fun_native_t { // need this so we can define const objects (to go in ROM)
Damiend99b0522013-12-21 18:17:45 +0000410 mp_obj_base_t base;
Damien George51047752014-02-26 17:40:52 +0000411 bool is_kw : 1;
Damien Georged5e81822014-02-26 17:47:05 +0000412 uint n_args_min : 15; // inclusive
413 uint n_args_max : 16; // inclusive
Damien660365e2013-12-17 18:27:24 +0000414 void *fun;
Damien George66028ab2014-01-03 14:03:48 +0000415 // TODO add mp_map_t *globals
416 // for const function objects, make an empty, const map
417 // such functions won't be able to access the global scope, but that's probably okay
Damiend99b0522013-12-21 18:17:45 +0000418} mp_obj_fun_native_t;
Damien George97209d32014-01-07 15:58:30 +0000419
Damiend99b0522013-12-21 18:17:45 +0000420extern const mp_obj_type_t fun_native_type;
421extern const mp_obj_type_t fun_bc_type;
Damien Georgebee17b02014-03-27 11:07:04 +0000422void mp_obj_fun_bc_get(mp_obj_t self_in, int *n_args, const byte **code);
Damien660365e2013-12-17 18:27:24 +0000423
Paul Sokolovskydff3f892014-01-20 18:37:30 +0200424mp_obj_t mp_identity(mp_obj_t self);
Paul Sokolovsky557c9d52014-02-08 21:57:19 +0200425MP_DECLARE_CONST_FUN_OBJ(mp_identity_obj);
Paul Sokolovskydff3f892014-01-20 18:37:30 +0200426
Damien George35e2a4e2014-02-05 00:51:47 +0000427// super
428extern const mp_obj_type_t super_type;
429
Damiend99b0522013-12-21 18:17:45 +0000430// generator
431extern const mp_obj_type_t gen_instance_type;
Damien660365e2013-12-17 18:27:24 +0000432
Damien George28708622014-01-02 21:30:26 +0000433// module
Damien George0c36da02014-03-08 15:24:39 +0000434typedef struct _mp_obj_module_t {
435 mp_obj_base_t base;
436 qstr name;
437 struct _mp_map_t *globals;
438} mp_obj_module_t;
439extern const mp_obj_type_t mp_type_module;
Damien George28708622014-01-02 21:30:26 +0000440struct _mp_map_t *mp_obj_module_get_globals(mp_obj_t self_in);
Damien Georgeeae16442014-01-11 19:22:29 +0000441
442// staticmethod and classmethod types; defined here so we can make const versions
443
444extern const mp_obj_type_t mp_type_staticmethod;
445extern const mp_obj_type_t mp_type_classmethod;
446
Damien George64131f32014-02-06 20:31:44 +0000447// this structure is used for instances of both staticmethod and classmethod
448typedef struct _mp_obj_static_class_method_t {
Damien Georgeeae16442014-01-11 19:22:29 +0000449 mp_obj_base_t base;
450 mp_obj_t fun;
Damien George64131f32014-02-06 20:31:44 +0000451} mp_obj_static_class_method_t;
Paul Sokolovsky439542f2014-01-21 00:19:19 +0200452
453// sequence helpers
454void mp_seq_multiply(const void *items, uint item_sz, uint len, uint times, void *dest);
Paul Sokolovsky7364af22014-02-02 02:38:22 +0200455bool m_seq_get_fast_slice_indexes(machine_uint_t len, mp_obj_t slice, machine_uint_t *begin, machine_uint_t *end);
Paul Sokolovskyee4aaf72014-02-08 23:17:51 +0200456#define m_seq_copy(dest, src, len, item_t) memcpy(dest, src, len * sizeof(item_t))
457#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)); }
Paul Sokolovsky87e85b72014-02-02 08:24:07 +0200458bool mp_seq_cmp_bytes(int op, const byte *data1, uint len1, const byte *data2, uint len2);
Paul Sokolovsky1a996c42014-02-08 22:49:46 +0200459bool mp_seq_cmp_objs(int op, const mp_obj_t *items1, uint len1, const mp_obj_t *items2, uint len2);
Paul Sokolovsky0cd1dc02014-02-10 06:37:11 +0200460mp_obj_t mp_seq_index_obj(const mp_obj_t *items, uint len, uint n_args, const mp_obj_t *args);
Paul Sokolovskyac0134d2014-02-10 07:10:55 +0200461mp_obj_t mp_seq_count_obj(const mp_obj_t *items, uint len, mp_obj_t value);