2014-05-03 22:27:38 +00:00
/*
* This file is part of the Micro Python project , http : //micropython.org/
*
* The MIT License ( MIT )
*
* Copyright ( c ) 2013 , 2014 Damien P . George
*
* Permission is hereby granted , free of charge , to any person obtaining a copy
* of this software and associated documentation files ( the " Software " ) , to deal
* in the Software without restriction , including without limitation the rights
* to use , copy , modify , merge , publish , distribute , sublicense , and / or sell
* copies of the Software , and to permit persons to whom the Software is
* furnished to do so , subject to the following conditions :
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software .
*
* THE SOFTWARE IS PROVIDED " AS IS " , WITHOUT WARRANTY OF ANY KIND , EXPRESS OR
* IMPLIED , INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY ,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT . IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM , DAMAGES OR OTHER
* LIABILITY , WHETHER IN AN ACTION OF CONTRACT , TORT OR OTHERWISE , ARISING FROM ,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE .
*/
2014-12-29 01:02:19 +00:00
# ifndef __MICROPY_INCLUDED_PY_OBJ_H__
# define __MICROPY_INCLUDED_PY_OBJ_H__
# include "py/mpconfig.h"
# include "py/misc.h"
# include "py/qstr.h"
2015-04-09 22:56:15 +00:00
# include "py/mpprint.h"
2014-05-03 22:27:38 +00:00
2016-08-15 00:56:55 +00:00
// This is the definition of the opaque MicroPython object type.
// All concrete objects have an encoding within this type and the
// particular encoding is specified by MICROPY_OBJ_REPR.
2015-11-27 17:09:11 +00:00
# if MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_D
typedef uint64_t mp_obj_t ;
typedef uint64_t mp_const_obj_t ;
# else
2016-08-15 00:56:55 +00:00
typedef void * mp_obj_t ;
typedef const void * mp_const_obj_t ;
2015-11-27 17:09:11 +00:00
# endif
2013-12-21 18:17:45 +00:00
2016-01-03 15:55:55 +00:00
// This mp_obj_type_t struct is a concrete MicroPython object which holds info
// about a type. See below for actual definition of the struct.
typedef struct _mp_obj_type_t mp_obj_type_t ;
2013-12-21 18:17:45 +00:00
2016-01-03 15:55:55 +00:00
// Anything that wants to be a concrete MicroPython object must have mp_obj_base_t
// as its first member (small ints, qstr objs and inline floats are not concrete).
2013-12-21 18:17:45 +00:00
struct _mp_obj_base_t {
2016-01-03 15:55:55 +00:00
const mp_obj_type_t * type MICROPY_OBJ_BASE_ALIGNMENT ;
2013-12-21 18:17:45 +00:00
} ;
2014-01-06 17:52:29 +00:00
typedef struct _mp_obj_base_t mp_obj_base_t ;
2013-12-21 18:17:45 +00:00
2014-04-17 22:19:36 +00:00
// These fake objects are used to indicate certain things in arguments or return
// values, and should only be used when explicitly allowed.
//
2014-05-21 18:42:43 +00:00
// - MP_OBJ_NULL : used to indicate the absence of an object, or unsupported operation.
2014-04-17 22:19:36 +00:00
// - MP_OBJ_STOP_ITERATION : used instead of throwing a StopIteration, for efficiency.
// - MP_OBJ_SENTINEL : used for various internal purposes where one needs
// an object which is unique from all other objects, including MP_OBJ_NULL.
//
// For debugging purposes they are all different. For non-debug mode, we alias
// as many as we can to MP_OBJ_NULL because it's cheaper to load/compare 0.
2015-01-25 18:35:54 +00:00
# ifdef NDEBUG
2015-11-27 17:01:44 +00:00
# define MP_OBJ_NULL (MP_OBJ_FROM_PTR((void*)0))
# define MP_OBJ_STOP_ITERATION (MP_OBJ_FROM_PTR((void*)0))
# define MP_OBJ_SENTINEL (MP_OBJ_FROM_PTR((void*)4))
2014-04-17 22:19:36 +00:00
# else
2015-11-27 17:01:44 +00:00
# define MP_OBJ_NULL (MP_OBJ_FROM_PTR((void*)0))
# define MP_OBJ_STOP_ITERATION (MP_OBJ_FROM_PTR((void*)4))
# define MP_OBJ_SENTINEL (MP_OBJ_FROM_PTR((void*)8))
2014-04-17 22:19:36 +00:00
# endif
2014-04-17 21:10:53 +00:00
2015-03-29 13:05:46 +00:00
// These macros/inline functions operate on objects and depend on the
// particular object representation. They are used to query, pack and
// unpack small ints, qstrs and full object pointers.
2013-12-21 18:17:45 +00:00
2015-03-29 13:05:46 +00:00
# if MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_A
2014-01-08 17:33:12 +00:00
2015-03-29 13:05:46 +00:00
static inline bool MP_OBJ_IS_SMALL_INT ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 1 ) ! = 0 ) ; }
2014-07-03 12:25:24 +00:00
# define MP_OBJ_SMALL_INT_VALUE(o) (((mp_int_t)(o)) >> 1)
2016-04-26 08:51:37 +00:00
# define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)((((mp_uint_t)(small_int)) << 1) | 1))
2014-01-08 17:33:12 +00:00
2015-03-29 13:05:46 +00:00
static inline bool MP_OBJ_IS_QSTR ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 3 ) = = 2 ) ; }
2015-01-16 17:47:07 +00:00
# define MP_OBJ_QSTR_VALUE(o) (((mp_uint_t)(o)) >> 2)
2014-12-29 01:02:19 +00:00
# define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 2) | 2))
2013-12-21 18:17:45 +00:00
2015-10-17 21:57:34 +00:00
# if MICROPY_PY_BUILTINS_FLOAT
2015-11-27 13:38:15 +00:00
# define mp_const_float_e MP_ROM_PTR(&mp_const_float_e_obj)
# define mp_const_float_pi MP_ROM_PTR(&mp_const_float_pi_obj)
2015-10-17 21:57:34 +00:00
extern const struct _mp_obj_float_t mp_const_float_e_obj ;
extern const struct _mp_obj_float_t mp_const_float_pi_obj ;
# define mp_obj_is_float(o) MP_OBJ_IS_TYPE((o), &mp_type_float)
mp_float_t mp_obj_float_get ( mp_obj_t self_in ) ;
mp_obj_t mp_obj_new_float ( mp_float_t value ) ;
# endif
2015-03-29 13:05:46 +00:00
static inline bool MP_OBJ_IS_OBJ ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 3 ) = = 0 ) ; }
# elif MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_B
static inline bool MP_OBJ_IS_SMALL_INT ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 3 ) = = 1 ) ; }
# define MP_OBJ_SMALL_INT_VALUE(o) (((mp_int_t)(o)) >> 2)
2016-04-26 08:51:37 +00:00
# define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)((((mp_uint_t)(small_int)) << 2) | 1))
2015-03-29 13:05:46 +00:00
static inline bool MP_OBJ_IS_QSTR ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 3 ) = = 3 ) ; }
# define MP_OBJ_QSTR_VALUE(o) (((mp_uint_t)(o)) >> 2)
# define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 2) | 3))
2015-10-17 21:57:34 +00:00
# if MICROPY_PY_BUILTINS_FLOAT
2015-11-27 13:38:15 +00:00
# define mp_const_float_e MP_ROM_PTR(&mp_const_float_e_obj)
# define mp_const_float_pi MP_ROM_PTR(&mp_const_float_pi_obj)
2015-10-17 21:57:34 +00:00
extern const struct _mp_obj_float_t mp_const_float_e_obj ;
extern const struct _mp_obj_float_t mp_const_float_pi_obj ;
# define mp_obj_is_float(o) MP_OBJ_IS_TYPE((o), &mp_type_float)
mp_float_t mp_obj_float_get ( mp_obj_t self_in ) ;
mp_obj_t mp_obj_new_float ( mp_float_t value ) ;
# endif
2015-03-29 13:05:46 +00:00
static inline bool MP_OBJ_IS_OBJ ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 1 ) = = 0 ) ; }
2015-10-17 22:20:57 +00:00
# elif MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_C
static inline bool MP_OBJ_IS_SMALL_INT ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 1 ) ! = 0 ) ; }
# define MP_OBJ_SMALL_INT_VALUE(o) (((mp_int_t)(o)) >> 1)
2016-04-26 08:51:37 +00:00
# define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)((((mp_uint_t)(small_int)) << 1) | 1))
2015-10-17 22:20:57 +00:00
2015-12-18 21:44:01 +00:00
# define mp_const_float_e MP_ROM_PTR((mp_obj_t)(((0x402df854 & ~3) | 2) + 0x80800000))
# define mp_const_float_pi MP_ROM_PTR((mp_obj_t)(((0x40490fdb & ~3) | 2) + 0x80800000))
2015-10-17 22:20:57 +00:00
static inline bool mp_obj_is_float ( mp_const_obj_t o )
2015-11-06 23:25:10 +00:00
{ return ( ( ( mp_uint_t ) ( o ) ) & 3 ) = = 2 & & ( ( ( mp_uint_t ) ( o ) ) & 0xff800007 ) ! = 0x00000006 ; }
2015-10-17 22:20:57 +00:00
static inline mp_float_t mp_obj_float_get ( mp_const_obj_t o ) {
union {
mp_float_t f ;
mp_uint_t u ;
2015-11-06 23:25:10 +00:00
} num = { . u = ( ( mp_uint_t ) o - 0x80800000 ) & ~ 3 } ;
2015-10-17 22:20:57 +00:00
return num . f ;
}
static inline mp_obj_t mp_obj_new_float ( mp_float_t f ) {
union {
mp_float_t f ;
mp_uint_t u ;
} num = { . f = f } ;
2015-11-06 23:25:10 +00:00
return ( mp_obj_t ) ( ( ( num . u & ~ 0x3 ) | 2 ) + 0x80800000 ) ;
2015-10-17 22:20:57 +00:00
}
static inline bool MP_OBJ_IS_QSTR ( mp_const_obj_t o )
2015-11-06 23:25:10 +00:00
{ return ( ( ( mp_uint_t ) ( o ) ) & 0xff800007 ) = = 0x00000006 ; }
# define MP_OBJ_QSTR_VALUE(o) (((mp_uint_t)(o)) >> 3)
# define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 3) | 0x00000006))
2015-10-17 22:20:57 +00:00
static inline bool MP_OBJ_IS_OBJ ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 3 ) = = 0 ) ; }
2015-11-27 17:09:11 +00:00
# elif MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_D
static inline bool MP_OBJ_IS_SMALL_INT ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 0xffff000000000000 ) = = 0x0001000000000000 ) ; }
# define MP_OBJ_SMALL_INT_VALUE(o) (((intptr_t)(o)) >> 1)
# define MP_OBJ_NEW_SMALL_INT(small_int) ((mp_obj_t)(((uintptr_t)(small_int)) << 1) | 0x0001000000000001)
static inline bool MP_OBJ_IS_QSTR ( mp_const_obj_t o )
{ return ( ( ( ( mp_int_t ) ( o ) ) & 0xffff000000000000 ) = = 0x0002000000000000 ) ; }
2016-01-08 13:43:13 +00:00
# define MP_OBJ_QSTR_VALUE(o) ((((uint32_t)(o)) >> 1) & 0xffffffff)
2015-11-27 17:09:11 +00:00
# define MP_OBJ_NEW_QSTR(qst) ((mp_obj_t)((((mp_uint_t)(qst)) << 1) | 0x0002000000000001))
# if MICROPY_PY_BUILTINS_FLOAT
# define mp_const_float_e {((mp_obj_t)((uint64_t)0x4005bf0a8b125769 + 0x8004000000000000))}
# define mp_const_float_pi {((mp_obj_t)((uint64_t)0x400921fb54442d18 + 0x8004000000000000))}
static inline bool mp_obj_is_float ( mp_const_obj_t o ) {
return ( ( uint64_t ) ( o ) & 0xfffc000000000000 ) ! = 0 ;
}
static inline mp_float_t mp_obj_float_get ( mp_const_obj_t o ) {
union {
mp_float_t f ;
uint64_t r ;
} num = { . r = o - 0x8004000000000000 } ;
return num . f ;
}
static inline mp_obj_t mp_obj_new_float ( mp_float_t f ) {
union {
mp_float_t f ;
uint64_t r ;
} num = { . f = f } ;
return num . r + 0x8004000000000000 ;
}
# endif
static inline bool MP_OBJ_IS_OBJ ( mp_const_obj_t o )
{ return ( ( ( ( uint64_t ) ( o ) ) & 0xffff000000000000 ) = = 0x0000000000000000 ) ; }
# define MP_OBJ_TO_PTR(o) ((void*)(uintptr_t)(o))
# define MP_OBJ_FROM_PTR(p) ((mp_obj_t)((uintptr_t)(p)))
// rom object storage needs special handling to widen 32-bit pointer to 64-bits
typedef union _mp_rom_obj_t { uint64_t u64 ; struct { const void * lo , * hi ; } u32 ; } mp_rom_obj_t ;
# define MP_ROM_INT(i) {MP_OBJ_NEW_SMALL_INT(i)}
# define MP_ROM_QSTR(q) {MP_OBJ_NEW_QSTR(q)}
# if MP_ENDIANNESS_LITTLE
# define MP_ROM_PTR(p) {.u32 = {.lo = (p), .hi = NULL}}
# else
# define MP_ROM_PTR(p) {.u32 = {.lo = NULL, .hi = (p)}}
# endif
2015-03-29 13:05:46 +00:00
# endif
2015-03-25 07:25:41 +00:00
// Macros to convert between mp_obj_t and concrete object types.
// These are identity operations in MicroPython, but ability to override
// these operations are provided to experiment with other methods of
// object representation and memory management.
// Cast mp_obj_t to object pointer
2015-11-27 17:01:44 +00:00
# ifndef MP_OBJ_TO_PTR
# define MP_OBJ_TO_PTR(o) ((void*)o)
2015-03-25 07:25:41 +00:00
# endif
// Cast object pointer to mp_obj_t
2015-11-27 17:01:44 +00:00
# ifndef MP_OBJ_FROM_PTR
# define MP_OBJ_FROM_PTR(p) ((mp_obj_t)p)
2015-03-25 07:25:41 +00:00
# endif
2015-11-27 13:38:15 +00:00
// Macros to create objects that are stored in ROM.
# ifndef MP_ROM_INT
typedef mp_const_obj_t mp_rom_obj_t ;
# define MP_ROM_INT(i) MP_OBJ_NEW_SMALL_INT(i)
# define MP_ROM_QSTR(q) MP_OBJ_NEW_QSTR(q)
# define MP_ROM_PTR(p) (p)
/* for testing
typedef struct _mp_rom_obj_t { mp_const_obj_t o ; } mp_rom_obj_t ;
# define MP_ROM_INT(i) {MP_OBJ_NEW_SMALL_INT(i)}
# define MP_ROM_QSTR(q) {MP_OBJ_NEW_QSTR(q)}
# define MP_ROM_PTR(p) {.o = p}
*/
# endif
2015-03-29 13:05:46 +00:00
// The macros below are derived from the ones above and are used to
// check for more specific object types.
2015-11-27 17:01:44 +00:00
# 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
2015-03-29 13:05:46 +00:00
# define MP_OBJ_IS_INT(o) (MP_OBJ_IS_SMALL_INT(o) || MP_OBJ_IS_TYPE(o, &mp_type_int))
# define MP_OBJ_IS_STR(o) (MP_OBJ_IS_QSTR(o) || MP_OBJ_IS_TYPE(o, &mp_type_str))
2015-11-27 17:01:44 +00:00
# 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))
# 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))
2015-03-29 13:05:46 +00:00
// Note: inline functions sometimes use much more code space than the
// equivalent macros, depending on the compiler.
//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
//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
// Need to forward declare these for the inline function to compile.
2016-01-03 15:55:55 +00:00
extern const mp_obj_type_t mp_type_int ;
extern const mp_obj_type_t mp_type_bool ;
2015-03-29 13:05:46 +00:00
static 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
//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)); }
2013-12-21 18:17:45 +00:00
// These macros are used to declare and define constant function objects
// You can put "static" in front of the definitions to make them local
2016-10-18 00:49:27 +00:00
# define MP_DECLARE_CONST_FUN_OBJ_0(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
# define MP_DECLARE_CONST_FUN_OBJ_1(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
# define MP_DECLARE_CONST_FUN_OBJ_2(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
# define MP_DECLARE_CONST_FUN_OBJ_3(obj_name) extern const mp_obj_fun_builtin_fixed_t obj_name
# define MP_DECLARE_CONST_FUN_OBJ_VAR(obj_name) extern const mp_obj_fun_builtin_var_t obj_name
# define MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(obj_name) extern const mp_obj_fun_builtin_var_t obj_name
# define MP_DECLARE_CONST_FUN_OBJ_KW(obj_name) extern const mp_obj_fun_builtin_var_t obj_name
2013-12-17 18:27:24 +00:00
2016-01-03 11:53:44 +00:00
# define MP_DEFINE_CONST_FUN_OBJ_0(obj_name, fun_name) \
2016-10-18 00:49:27 +00:00
const mp_obj_fun_builtin_fixed_t obj_name = \
{ { & mp_type_fun_builtin_0 } , . fun . _0 = fun_name }
2016-01-03 11:53:44 +00:00
# define MP_DEFINE_CONST_FUN_OBJ_1(obj_name, fun_name) \
2016-10-18 00:49:27 +00:00
const mp_obj_fun_builtin_fixed_t obj_name = \
{ { & mp_type_fun_builtin_1 } , . fun . _1 = fun_name }
2016-01-03 11:53:44 +00:00
# define MP_DEFINE_CONST_FUN_OBJ_2(obj_name, fun_name) \
2016-10-18 00:49:27 +00:00
const mp_obj_fun_builtin_fixed_t obj_name = \
{ { & mp_type_fun_builtin_2 } , . fun . _2 = fun_name }
2016-01-03 11:53:44 +00:00
# define MP_DEFINE_CONST_FUN_OBJ_3(obj_name, fun_name) \
2016-10-18 00:49:27 +00:00
const mp_obj_fun_builtin_fixed_t obj_name = \
{ { & mp_type_fun_builtin_3 } , . fun . _3 = fun_name }
2016-01-03 11:53:44 +00:00
# define MP_DEFINE_CONST_FUN_OBJ_VAR(obj_name, n_args_min, fun_name) \
2016-10-18 00:49:27 +00:00
const mp_obj_fun_builtin_var_t obj_name = \
{ { & mp_type_fun_builtin_var } , false , n_args_min , MP_OBJ_FUN_ARGS_MAX , . fun . var = fun_name }
2016-01-03 11:53:44 +00:00
# define MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(obj_name, n_args_min, n_args_max, fun_name) \
2016-10-18 00:49:27 +00:00
const mp_obj_fun_builtin_var_t obj_name = \
{ { & mp_type_fun_builtin_var } , false , n_args_min , n_args_max , . fun . var = fun_name }
2016-01-03 11:53:44 +00:00
# define MP_DEFINE_CONST_FUN_OBJ_KW(obj_name, n_args_min, fun_name) \
2016-10-18 00:49:27 +00:00
const mp_obj_fun_builtin_var_t obj_name = \
{ { & mp_type_fun_builtin_var } , true , n_args_min , MP_OBJ_FUN_ARGS_MAX , . fun . kw = fun_name }
2014-01-07 17:29:16 +00:00
2014-12-09 16:19:48 +00:00
// These macros are used to define constant map/dict objects
2014-03-26 21:47:19 +00:00
// You can put "static" in front of the definition to make it local
2014-12-09 16:19:48 +00:00
# define MP_DEFINE_CONST_MAP(map_name, table_name) \
const mp_map_t map_name = { \
. all_keys_are_qstrs = 1 , \
2015-03-17 23:25:04 +00:00
. is_fixed = 1 , \
. is_ordered = 1 , \
2014-12-09 16:19:48 +00:00
. used = MP_ARRAY_SIZE ( table_name ) , \
. alloc = MP_ARRAY_SIZE ( table_name ) , \
2015-11-27 13:38:15 +00:00
. table = ( mp_map_elem_t * ) ( mp_rom_map_elem_t * ) table_name , \
2014-12-09 16:19:48 +00:00
}
2014-03-26 21:47:19 +00:00
# define MP_DEFINE_CONST_DICT(dict_name, table_name) \
const mp_obj_dict_t dict_name = { \
2014-03-29 13:43:38 +00:00
. base = { & mp_type_dict } , \
2014-03-26 21:47:19 +00:00
. map = { \
. all_keys_are_qstrs = 1 , \
2015-03-17 23:25:04 +00:00
. is_fixed = 1 , \
. is_ordered = 1 , \
2014-11-29 14:39:27 +00:00
. used = MP_ARRAY_SIZE ( table_name ) , \
. alloc = MP_ARRAY_SIZE ( table_name ) , \
2015-11-27 13:38:15 +00:00
. table = ( mp_map_elem_t * ) ( mp_rom_map_elem_t * ) table_name , \
2014-03-26 21:47:19 +00:00
} , \
}
2014-01-11 19:22:29 +00:00
// 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
2015-11-27 13:38:15 +00:00
# define MP_DECLARE_CONST_STATICMETHOD_OBJ(obj_name) extern const mp_rom_obj_static_class_method_t obj_name
# define MP_DECLARE_CONST_CLASSMETHOD_OBJ(obj_name) extern const mp_rom_obj_static_class_method_t obj_name
2014-01-11 19:22:29 +00:00
2015-11-27 13:38:15 +00:00
# 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}
# 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}
2014-01-11 19:22:29 +00:00
2014-03-30 12:54:02 +00:00
// Underlying map/hash table implementation (not dict object or map function)
typedef struct _mp_map_elem_t {
mp_obj_t key ;
mp_obj_t value ;
} mp_map_elem_t ;
2015-11-27 13:38:15 +00:00
typedef struct _mp_rom_map_elem_t {
mp_rom_obj_t key ;
mp_rom_obj_t value ;
} mp_rom_map_elem_t ;
2014-03-30 12:54:02 +00:00
// TODO maybe have a truncated mp_map_t for fixed tables, since alloc=used
// put alloc last in the structure, so the truncated version does not need it
// this would save 1 ROM word for all ROM objects that have a locals_dict
// would also need a trucated dict structure
typedef struct _mp_map_t {
2014-07-03 12:25:24 +00:00
mp_uint_t all_keys_are_qstrs : 1 ;
2015-03-17 23:25:04 +00:00
mp_uint_t is_fixed : 1 ; // a fixed array that can't be modified; must also be ordered
mp_uint_t is_ordered : 1 ; // an ordered array
mp_uint_t used : ( 8 * sizeof ( mp_uint_t ) - 3 ) ;
2014-07-03 12:25:24 +00:00
mp_uint_t alloc ;
2014-03-30 12:54:02 +00:00
mp_map_elem_t * table ;
} mp_map_t ;
2015-03-20 17:41:37 +00:00
// mp_set_lookup requires these constants to have the values they do
2014-03-30 12:54:02 +00:00
typedef enum _mp_map_lookup_kind_t {
2015-03-20 17:41:37 +00:00
MP_MAP_LOOKUP = 0 ,
MP_MAP_LOOKUP_ADD_IF_NOT_FOUND = 1 ,
MP_MAP_LOOKUP_REMOVE_IF_FOUND = 2 ,
MP_MAP_LOOKUP_ADD_IF_NOT_FOUND_OR_REMOVE_IF_FOUND = 3 , // only valid for mp_set_lookup
2014-03-30 12:54:02 +00:00
} mp_map_lookup_kind_t ;
2014-11-26 19:17:16 +00:00
extern const mp_map_t mp_const_empty_map ;
2014-07-03 12:25:24 +00:00
static inline bool MP_MAP_SLOT_IS_FILLED ( const mp_map_t * map , mp_uint_t pos ) { return ( ( map ) - > table [ pos ] . key ! = MP_OBJ_NULL & & ( map ) - > table [ pos ] . key ! = MP_OBJ_SENTINEL ) ; }
2014-04-05 20:53:54 +00:00
2014-08-30 12:23:35 +00:00
void mp_map_init ( mp_map_t * map , mp_uint_t n ) ;
void mp_map_init_fixed_table ( mp_map_t * map , mp_uint_t n , const mp_obj_t * table ) ;
mp_map_t * mp_map_new ( mp_uint_t n ) ;
2014-03-30 12:54:02 +00:00
void mp_map_deinit ( mp_map_t * map ) ;
void mp_map_free ( mp_map_t * map ) ;
2015-04-04 14:53:11 +00:00
mp_map_elem_t * mp_map_lookup ( mp_map_t * map , mp_obj_t index , mp_map_lookup_kind_t lookup_kind ) ;
2014-03-30 12:54:02 +00:00
void mp_map_clear ( mp_map_t * map ) ;
2014-04-05 01:14:22 +00:00
void mp_map_dump ( mp_map_t * map ) ;
2014-03-30 12:54:02 +00:00
// Underlying set implementation (not set object)
typedef struct _mp_set_t {
2014-07-03 12:25:24 +00:00
mp_uint_t alloc ;
mp_uint_t used ;
2014-03-30 12:54:02 +00:00
mp_obj_t * table ;
} mp_set_t ;
2014-07-03 12:25:24 +00:00
static inline bool MP_SET_SLOT_IS_FILLED ( const mp_set_t * set , mp_uint_t pos ) { return ( ( set ) - > table [ pos ] ! = MP_OBJ_NULL & & ( set ) - > table [ pos ] ! = MP_OBJ_SENTINEL ) ; }
2014-04-05 20:53:54 +00:00
2014-08-30 12:23:35 +00:00
void mp_set_init ( mp_set_t * set , mp_uint_t n ) ;
2014-03-30 12:54:02 +00:00
mp_obj_t mp_set_lookup ( mp_set_t * set , mp_obj_t index , mp_map_lookup_kind_t lookup_kind ) ;
2014-04-05 16:17:19 +00:00
mp_obj_t mp_set_remove_first ( mp_set_t * set ) ;
2014-03-30 12:54:02 +00:00
void mp_set_clear ( mp_set_t * set ) ;
2013-12-21 18:17:45 +00:00
// 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 ) ;
2014-01-04 01:15:01 +00:00
typedef mp_obj_t ( * mp_fun_3_t ) ( mp_obj_t , mp_obj_t , mp_obj_t ) ;
2016-01-03 14:21:40 +00:00
typedef mp_obj_t ( * mp_fun_var_t ) ( size_t n , const mp_obj_t * ) ;
2016-04-04 12:35:44 +00:00
// mp_fun_kw_t takes mp_map_t* (and not const mp_map_t*) to ease passing
// this arg to mp_map_lookup().
2016-01-03 14:21:40 +00:00
typedef mp_obj_t ( * mp_fun_kw_t ) ( size_t n , const mp_obj_t * , mp_map_t * ) ;
2013-12-21 18:17:45 +00:00
2014-01-13 17:19:16 +00:00
typedef enum {
2014-05-01 22:51:25 +00:00
PRINT_STR = 0 ,
PRINT_REPR = 1 ,
PRINT_EXC = 2 , // Special format for printing exception in unhandled exception message
2014-09-17 21:56:34 +00:00
PRINT_JSON = 3 ,
2015-12-20 14:44:36 +00:00
PRINT_RAW = 4 , // Special format for printing bytes as an undercorated string
2014-09-17 21:56:34 +00:00
PRINT_EXC_SUBCLASS = 0x80 , // Internal flag for printing exception subclasses
2014-01-13 17:19:16 +00:00
} mp_print_kind_t ;
2015-04-09 22:56:15 +00:00
typedef void ( * mp_print_fun_t ) ( const mp_print_t * print , mp_obj_t o , mp_print_kind_t kind ) ;
2016-01-03 15:55:55 +00:00
typedef 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 ) ;
2016-01-03 09:59:18 +00:00
typedef mp_obj_t ( * mp_call_fun_t ) ( mp_obj_t fun , size_t n_args , size_t n_kw , const mp_obj_t * args ) ;
2014-08-29 23:35:11 +00:00
typedef mp_obj_t ( * mp_unary_op_fun_t ) ( mp_uint_t op , mp_obj_t ) ;
typedef mp_obj_t ( * mp_binary_op_fun_t ) ( mp_uint_t op , mp_obj_t , mp_obj_t ) ;
2015-04-01 14:10:50 +00:00
typedef void ( * mp_attr_fun_t ) ( mp_obj_t self_in , qstr attr , mp_obj_t * dest ) ;
2014-04-17 21:10:53 +00:00
typedef mp_obj_t ( * mp_subscr_fun_t ) ( mp_obj_t self_in , mp_obj_t index , mp_obj_t value ) ;
2013-12-21 18:17:45 +00:00
2014-01-07 18:12:26 +00:00
// Buffer protocol
2014-04-18 21:29:21 +00:00
typedef struct _mp_buffer_info_t {
2014-01-07 18:12:26 +00:00
// 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; // ?
2014-10-03 17:44:14 +00:00
void * buf ; // can be NULL if len == 0
2016-03-15 12:20:57 +00:00
size_t len ; // in bytes
2014-10-03 17:44:14 +00:00
int typecode ; // as per binary.h
2014-01-07 18:12:26 +00:00
// Rationale: to load arbitrary-sized sprites directly to LCD
// Cons: a bit adhoc usecase
// int stride;
2014-04-18 21:29:21 +00:00
} mp_buffer_info_t ;
# define MP_BUFFER_READ (1)
# define MP_BUFFER_WRITE (2)
# define MP_BUFFER_RW (MP_BUFFER_READ | MP_BUFFER_WRITE)
2014-01-07 18:12:26 +00:00
typedef struct _mp_buffer_p_t {
2014-08-30 13:28:06 +00:00
mp_int_t ( * get_buffer ) ( mp_obj_t obj , mp_buffer_info_t * bufinfo , mp_uint_t flags ) ;
2014-01-07 18:12:26 +00:00
} mp_buffer_p_t ;
2014-08-30 13:28:06 +00:00
bool mp_get_buffer ( mp_obj_t obj , mp_buffer_info_t * bufinfo , mp_uint_t flags ) ;
void mp_get_buffer_raise ( mp_obj_t obj , mp_buffer_info_t * bufinfo , mp_uint_t flags ) ;
2014-01-07 18:12:26 +00:00
// Stream protocol
typedef struct _mp_stream_p_t {
2014-07-27 21:38:58 +00:00
// On error, functions should return MP_STREAM_ERROR and fill in *errcode (values
// are implementation-dependent, but will be exposed to user, e.g. via exception).
mp_uint_t ( * read ) ( mp_obj_t obj , void * buf , mp_uint_t size , int * errcode ) ;
mp_uint_t ( * write ) ( mp_obj_t obj , const void * buf , mp_uint_t size , int * errcode ) ;
2015-11-27 17:01:44 +00:00
mp_uint_t ( * ioctl ) ( mp_obj_t obj , mp_uint_t request , uintptr_t arg , int * errcode ) ;
2014-08-30 13:28:06 +00:00
mp_uint_t is_text : 1 ; // default is bytes, set this for text stream
2014-01-07 18:12:26 +00:00
} mp_stream_p_t ;
2013-12-21 18:17:45 +00:00
struct _mp_obj_type_t {
mp_obj_base_t base ;
2014-02-15 11:34:50 +00:00
qstr name ;
2013-12-21 18:17:45 +00:00
mp_print_fun_t print ;
2014-01-04 20:21:15 +00:00
mp_make_new_fun_t make_new ; // to make an instance of the type
2013-12-21 18:17:45 +00:00
2014-01-18 14:10:48 +00:00
mp_call_fun_t call ;
2014-05-21 18:42:43 +00:00
mp_unary_op_fun_t unary_op ; // can return MP_OBJ_NULL if op not supported
mp_binary_op_fun_t binary_op ; // can return MP_OBJ_NULL if op not supported
2013-12-21 18:17:45 +00:00
2015-04-01 14:10:50 +00:00
// implements load, store and delete attribute
//
// dest[0] = MP_OBJ_NULL means load
// return: for fail, do nothing
// for attr, dest[0] = value
// for method, dest[0] = method, dest[1] = self
//
// dest[0,1] = {MP_OBJ_SENTINEL, MP_OBJ_NULL} means delete
// dest[0,1] = {MP_OBJ_SENTINEL, object} means store
// return: for fail, do nothing
// for success set dest[0] = MP_OBJ_NULL
mp_attr_fun_t attr ;
2014-04-08 20:32:29 +00:00
2014-04-17 21:10:53 +00:00
mp_subscr_fun_t subscr ; // implements load, store, delete subscripting
// value=MP_OBJ_NULL means delete, value=MP_OBJ_SENTINEL means load, else store
2014-05-21 18:42:43 +00:00
// can return MP_OBJ_NULL if op not supported
2014-02-15 11:34:50 +00:00
2015-02-15 01:10:13 +00:00
mp_fun_1_t getiter ; // corresponds to __iter__ special method
2014-05-10 12:55:11 +00:00
mp_fun_1_t iternext ; // may return MP_OBJ_STOP_ITERATION as an optimisation instead of raising StopIteration() (with no args)
2013-12-21 18:17:45 +00:00
2014-01-07 18:12:26 +00:00
mp_buffer_p_t buffer_p ;
2016-06-18 15:19:24 +00:00
// One of disjoint protocols (interfaces), like mp_stream_p_t, etc.
const void * protocol ;
2014-01-07 18:12:26 +00:00
2014-01-09 21:43:51 +00:00
// these are for dynamically created types (classes)
2015-11-27 17:01:44 +00:00
struct _mp_obj_tuple_t * bases_tuple ;
struct _mp_obj_dict_t * locals_dict ;
2014-01-09 20:57:50 +00:00
2013-12-21 18:17:45 +00:00
/*
What we might need to add here :
len str tuple list map
abs float complex
hash bool int none str
equal int str
unpack seq list tuple
*/
} ;
2014-02-15 16:10:44 +00:00
// Constant types, globally accessible
extern const mp_obj_type_t mp_type_type ;
2014-03-29 13:43:38 +00:00
extern const mp_obj_type_t mp_type_object ;
extern const mp_obj_type_t mp_type_NoneType ;
extern const mp_obj_type_t mp_type_bool ;
extern const mp_obj_type_t mp_type_int ;
extern const mp_obj_type_t mp_type_str ;
extern const mp_obj_type_t mp_type_bytes ;
2014-04-08 19:09:14 +00:00
extern const mp_obj_type_t mp_type_bytearray ;
2014-10-23 12:34:35 +00:00
extern const mp_obj_type_t mp_type_memoryview ;
2014-03-29 13:43:38 +00:00
extern const mp_obj_type_t mp_type_float ;
extern const mp_obj_type_t mp_type_complex ;
extern const mp_obj_type_t mp_type_tuple ;
extern const mp_obj_type_t mp_type_list ;
extern const mp_obj_type_t mp_type_map ; // map (the python builtin, not the dict implementation detail)
extern const mp_obj_type_t mp_type_enumerate ;
extern const mp_obj_type_t mp_type_filter ;
extern const mp_obj_type_t mp_type_dict ;
2015-03-17 23:25:04 +00:00
extern const mp_obj_type_t mp_type_ordereddict ;
2014-04-17 17:18:55 +00:00
extern const mp_obj_type_t mp_type_range ;
2014-03-29 13:43:38 +00:00
extern const mp_obj_type_t mp_type_set ;
2014-05-10 13:02:17 +00:00
extern const mp_obj_type_t mp_type_frozenset ;
2014-03-29 13:43:38 +00:00
extern const mp_obj_type_t mp_type_slice ;
extern const mp_obj_type_t mp_type_zip ;
extern const mp_obj_type_t mp_type_array ;
extern const mp_obj_type_t mp_type_super ;
extern const mp_obj_type_t mp_type_gen_instance ;
2016-10-18 00:49:27 +00:00
extern const mp_obj_type_t mp_type_fun_builtin_0 ;
extern const mp_obj_type_t mp_type_fun_builtin_1 ;
extern const mp_obj_type_t mp_type_fun_builtin_2 ;
extern const mp_obj_type_t mp_type_fun_builtin_3 ;
extern const mp_obj_type_t mp_type_fun_builtin_var ;
2014-03-29 13:43:38 +00:00
extern const mp_obj_type_t mp_type_fun_bc ;
extern const mp_obj_type_t mp_type_module ;
extern const mp_obj_type_t mp_type_staticmethod ;
extern const mp_obj_type_t mp_type_classmethod ;
2014-04-13 17:59:45 +00:00
extern const mp_obj_type_t mp_type_property ;
2014-04-26 17:26:14 +00:00
extern const mp_obj_type_t mp_type_stringio ;
2014-05-15 04:28:19 +00:00
extern const mp_obj_type_t mp_type_bytesio ;
2014-08-12 17:33:40 +00:00
extern const mp_obj_type_t mp_type_reversed ;
2015-12-14 21:48:12 +00:00
extern const mp_obj_type_t mp_type_polymorph_iter ;
2014-03-22 15:28:16 +00:00
// Exceptions
2014-02-15 16:10:44 +00:00
extern const mp_obj_type_t mp_type_BaseException ;
2014-03-22 15:28:16 +00:00
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_ImportError ;
extern const mp_obj_type_t mp_type_IndentationError ;
extern const mp_obj_type_t mp_type_IndexError ;
2014-10-25 17:19:55 +00:00
extern const mp_obj_type_t mp_type_KeyboardInterrupt ;
2014-03-22 15:28:16 +00:00
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 ;
2015-06-29 20:45:39 +00:00
extern const mp_obj_type_t mp_type_TimeoutError ;
2014-03-22 15:28:16 +00:00
extern const mp_obj_type_t mp_type_OverflowError ;
extern const mp_obj_type_t mp_type_RuntimeError ;
2016-01-27 20:23:11 +00:00
extern const mp_obj_type_t mp_type_StopAsyncIteration ;
2014-03-25 14:29:40 +00:00
extern const mp_obj_type_t mp_type_StopIteration ;
2014-03-22 15:28:16 +00:00
extern const mp_obj_type_t mp_type_SyntaxError ;
2014-05-24 22:32:19 +00:00
extern const mp_obj_type_t mp_type_SystemExit ;
2014-03-22 15:28:16 +00:00
extern const mp_obj_type_t mp_type_TypeError ;
2015-02-23 21:18:36 +00:00
extern const mp_obj_type_t mp_type_UnicodeError ;
2014-03-22 15:28:16 +00:00
extern const mp_obj_type_t mp_type_ValueError ;
2015-04-20 13:29:31 +00:00
extern const mp_obj_type_t mp_type_ViperTypeError ;
2014-03-22 15:28:16 +00:00
extern const mp_obj_type_t mp_type_ZeroDivisionError ;
2013-12-21 18:17:45 +00:00
// Constant objects, globally accessible
2014-03-29 13:15:08 +00:00
// The macros are for convenience only
2015-11-27 17:01:44 +00:00
# define mp_const_none (MP_OBJ_FROM_PTR(&mp_const_none_obj))
# define mp_const_false (MP_OBJ_FROM_PTR(&mp_const_false_obj))
# define mp_const_true (MP_OBJ_FROM_PTR(&mp_const_true_obj))
# define mp_const_empty_bytes (MP_OBJ_FROM_PTR(&mp_const_empty_bytes_obj))
# define mp_const_empty_tuple (MP_OBJ_FROM_PTR(&mp_const_empty_tuple_obj))
2014-03-29 13:15:08 +00:00
extern const struct _mp_obj_none_t mp_const_none_obj ;
extern const struct _mp_obj_bool_t mp_const_false_obj ;
extern const struct _mp_obj_bool_t mp_const_true_obj ;
2014-10-11 16:56:43 +00:00
extern const struct _mp_obj_str_t mp_const_empty_bytes_obj ;
2014-03-29 13:15:08 +00:00
extern const struct _mp_obj_tuple_t mp_const_empty_tuple_obj ;
2015-05-05 19:18:07 +00:00
extern const struct _mp_obj_singleton_t mp_const_ellipsis_obj ;
extern const struct _mp_obj_singleton_t mp_const_notimplemented_obj ;
2014-04-04 10:52:59 +00:00
extern const struct _mp_obj_exception_t mp_const_MemoryError_obj ;
2014-03-29 13:15:08 +00:00
extern const struct _mp_obj_exception_t mp_const_GeneratorExit_obj ;
2013-12-21 18:17:45 +00:00
// General API for objects
2014-02-15 11:34:50 +00:00
mp_obj_t mp_obj_new_type ( qstr name , mp_obj_t bases_tuple , mp_obj_t locals_dict ) ;
2013-12-21 18:17:45 +00:00
mp_obj_t mp_obj_new_none ( void ) ;
2015-10-11 09:09:43 +00:00
static inline mp_obj_t mp_obj_new_bool ( mp_int_t x ) { return x ? mp_const_true : mp_const_false ; }
2013-12-30 22:32:17 +00:00
mp_obj_t mp_obj_new_cell ( mp_obj_t obj ) ;
2014-07-03 12:25:24 +00:00
mp_obj_t mp_obj_new_int ( mp_int_t value ) ;
mp_obj_t mp_obj_new_int_from_uint ( mp_uint_t value ) ;
2014-08-30 13:19:41 +00:00
mp_obj_t mp_obj_new_int_from_str_len ( const char * * str , mp_uint_t len , bool neg , mp_uint_t base ) ;
2014-03-12 15:38:15 +00:00
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)
2014-09-10 21:10:33 +00:00
mp_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)
2014-08-30 13:19:41 +00:00
mp_obj_t mp_obj_new_str ( const char * data , mp_uint_t len , bool make_qstr_if_not_already ) ;
2015-01-21 19:14:25 +00:00
mp_obj_t mp_obj_new_str_from_vstr ( const mp_obj_type_t * type , vstr_t * vstr ) ;
2014-08-30 13:19:41 +00:00
mp_obj_t mp_obj_new_bytes ( const byte * data , mp_uint_t len ) ;
2014-12-10 22:37:07 +00:00
mp_obj_t mp_obj_new_bytearray ( mp_uint_t n , void * items ) ;
mp_obj_t mp_obj_new_bytearray_by_ref ( mp_uint_t n , void * items ) ;
2014-06-01 12:32:54 +00:00
# if MICROPY_PY_BUILTINS_FLOAT
2014-12-29 22:34:54 +00:00
mp_obj_t mp_obj_new_int_from_float ( mp_float_t val ) ;
2013-12-21 18:17:45 +00:00
mp_obj_t mp_obj_new_complex ( mp_float_t real , mp_float_t imag ) ;
2013-12-17 18:27:24 +00:00
# endif
2014-02-15 16:10:44 +00:00
mp_obj_t mp_obj_new_exception ( const mp_obj_type_t * exc_type ) ;
2014-04-21 21:01:13 +00:00
mp_obj_t mp_obj_new_exception_arg1 ( const mp_obj_type_t * exc_type , mp_obj_t arg ) ;
2014-08-30 13:19:41 +00:00
mp_obj_t mp_obj_new_exception_args ( const mp_obj_type_t * exc_type , mp_uint_t n_args , const mp_obj_t * args ) ;
2014-02-15 16:10:44 +00:00
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!)
2015-10-23 00:23:11 +00:00
mp_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 ) ;
mp_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 ) ;
2014-08-24 15:28:17 +00:00
mp_obj_t mp_obj_new_fun_viper ( mp_uint_t n_args , void * fun_data , mp_uint_t type_sig ) ;
2016-01-15 15:20:43 +00:00
mp_obj_t mp_obj_new_fun_asm ( mp_uint_t n_args , void * fun_data , mp_uint_t type_sig ) ;
2014-01-29 20:30:52 +00:00
mp_obj_t mp_obj_new_gen_wrap ( mp_obj_t fun ) ;
2014-08-30 13:19:41 +00:00
mp_obj_t mp_obj_new_closure ( mp_obj_t fun , mp_uint_t n_closed , const mp_obj_t * closed ) ;
2014-08-30 13:04:14 +00:00
mp_obj_t mp_obj_new_tuple ( mp_uint_t n , const mp_obj_t * items ) ;
mp_obj_t mp_obj_new_list ( mp_uint_t n , mp_obj_t * items ) ;
2014-08-30 12:23:35 +00:00
mp_obj_t mp_obj_new_dict ( mp_uint_t n_args ) ;
mp_obj_t mp_obj_new_set ( mp_uint_t n_args , mp_obj_t * items ) ;
2014-01-03 00:41:17 +00:00
mp_obj_t mp_obj_new_slice ( mp_obj_t start , mp_obj_t stop , mp_obj_t step ) ;
2014-02-05 00:51:47 +00:00
mp_obj_t mp_obj_new_super ( mp_obj_t type , mp_obj_t obj ) ;
2014-01-18 14:10:48 +00:00
mp_obj_t mp_obj_new_bound_meth ( mp_obj_t meth , mp_obj_t self ) ;
2014-01-25 00:17:36 +00:00
mp_obj_t mp_obj_new_getitem_iter ( mp_obj_t * args ) ;
2014-01-02 21:30:26 +00:00
mp_obj_t mp_obj_new_module ( qstr module_name ) ;
2015-03-06 19:35:26 +00:00
mp_obj_t mp_obj_new_memoryview ( byte typecode , mp_uint_t nitems , void * items ) ;
2013-12-17 18:27:24 +00:00
2014-05-10 23:26:42 +00:00
mp_obj_type_t * mp_obj_get_type ( mp_const_obj_t o_in ) ;
const char * mp_obj_get_type_str ( mp_const_obj_t o_in ) ;
2014-03-26 18:37:06 +00:00
bool mp_obj_is_subclass_fast ( mp_const_obj_t object , mp_const_obj_t classinfo ) ; // arguments should be type objects
2014-05-11 00:16:04 +00:00
mp_obj_t mp_instance_cast_to_native_base ( mp_const_obj_t self_in , mp_const_obj_t native_type ) ;
2013-12-17 18:27:24 +00:00
2015-04-09 22:56:15 +00:00
void mp_obj_print_helper ( const mp_print_t * print , mp_obj_t o_in , mp_print_kind_t kind ) ;
2014-01-13 17:19:16 +00:00
void mp_obj_print ( mp_obj_t o , mp_print_kind_t kind ) ;
2015-04-09 22:56:15 +00:00
void mp_obj_print_exception ( const mp_print_t * print , mp_obj_t exc ) ;
2013-12-17 18:27:24 +00:00
2014-08-30 13:28:06 +00:00
bool mp_obj_is_true ( mp_obj_t arg ) ;
2013-12-21 18:17:45 +00:00
bool mp_obj_is_callable ( mp_obj_t o_in ) ;
bool mp_obj_equal ( mp_obj_t o1 , mp_obj_t o2 ) ;
2013-12-17 18:27:24 +00:00
2014-07-03 12:25:24 +00:00
mp_int_t mp_obj_get_int ( mp_const_obj_t arg ) ;
2015-05-12 22:05:53 +00:00
mp_int_t mp_obj_get_int_truncated ( mp_const_obj_t arg ) ;
2014-07-03 12:25:24 +00:00
bool mp_obj_get_int_maybe ( mp_const_obj_t arg , mp_int_t * value ) ;
2014-06-01 12:32:54 +00:00
# if MICROPY_PY_BUILTINS_FLOAT
2013-12-21 18:17:45 +00:00
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 ) ;
2013-12-17 18:27:24 +00:00
# endif
2014-01-22 14:35:10 +00:00
//qstr mp_obj_get_qstr(mp_obj_t arg);
2016-05-04 09:19:08 +00:00
void mp_obj_get_array ( mp_obj_t o , mp_uint_t * len , mp_obj_t * * items ) ; // *items may point inside a GC block
void 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
2014-08-30 13:04:14 +00:00
mp_uint_t mp_get_index ( const mp_obj_type_t * type , mp_uint_t len , mp_obj_t index , bool is_slice ) ;
2014-08-22 20:48:30 +00:00
mp_obj_t mp_obj_id ( mp_obj_t o_in ) ;
2014-08-12 17:33:40 +00:00
mp_obj_t mp_obj_len ( mp_obj_t o_in ) ;
2015-04-04 14:53:11 +00:00
mp_obj_t mp_obj_len_maybe ( mp_obj_t o_in ) ; // may return MP_OBJ_NULL
2014-04-17 21:10:53 +00:00
mp_obj_t mp_obj_subscr ( mp_obj_t base , mp_obj_t index , mp_obj_t val ) ;
2015-05-11 12:25:19 +00:00
mp_obj_t mp_generic_unary_op ( mp_uint_t op , mp_obj_t o_in ) ;
2013-12-21 18:17:45 +00:00
// 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 ) ;
2014-01-04 20:21:15 +00:00
// int
2014-07-03 12:25:24 +00:00
// For long int, returns value truncated to mp_int_t
2014-12-05 23:13:52 +00:00
mp_int_t mp_obj_int_get_truncated ( mp_const_obj_t self_in ) ;
// Will raise exception if value doesn't fit into mp_int_t
mp_int_t mp_obj_int_get_checked ( mp_const_obj_t self_in ) ;
2014-01-04 20:21:15 +00:00
2013-12-29 17:17:43 +00:00
// exception
2014-05-01 22:51:25 +00:00
# define mp_obj_is_native_exception_instance(o) (mp_obj_get_type(o)->make_new == mp_obj_exception_make_new)
2014-02-15 16:10:44 +00:00
bool mp_obj_is_exception_type ( mp_obj_t self_in ) ;
bool mp_obj_is_exception_instance ( mp_obj_t self_in ) ;
2014-09-24 13:05:40 +00:00
bool mp_obj_exception_match ( mp_obj_t exc , mp_const_obj_t exc_type ) ;
2014-02-15 16:10:44 +00:00
void mp_obj_exception_clear_traceback ( mp_obj_t self_in ) ;
2016-01-02 22:04:12 +00:00
void mp_obj_exception_add_traceback ( mp_obj_t self_in , qstr file , size_t line , qstr block ) ;
void mp_obj_exception_get_traceback ( mp_obj_t self_in , size_t * n , size_t * * values ) ;
2014-03-26 17:17:20 +00:00
mp_obj_t mp_obj_exception_get_value ( mp_obj_t self_in ) ;
2016-01-03 15:55:55 +00:00
mp_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 ) ;
2014-07-02 06:46:53 +00:00
mp_obj_t mp_alloc_emergency_exception_buf ( mp_obj_t size_in ) ;
void mp_init_emergency_exception_buf ( void ) ;
2013-12-29 17:17:43 +00:00
2013-12-21 18:17:45 +00:00
// str
2014-01-22 14:35:10 +00:00
bool mp_obj_str_equal ( mp_obj_t s1 , mp_obj_t s2 ) ;
2014-01-25 13:51:19 +00:00
qstr mp_obj_str_get_qstr ( mp_obj_t self_in ) ; // use this if you will anyway convert the string to a qstr
2014-01-22 14:35:10 +00:00
const char * mp_obj_str_get_str ( mp_obj_t self_in ) ; // use this only if you need the string to be null terminated
2014-08-30 13:19:41 +00:00
const char * mp_obj_str_get_data ( mp_obj_t self_in , mp_uint_t * len ) ;
2014-06-07 22:13:35 +00:00
mp_obj_t mp_obj_str_intern ( mp_obj_t str ) ;
2015-04-09 22:56:15 +00:00
void mp_str_print_quoted ( const mp_print_t * print , const byte * str_data , mp_uint_t str_len , bool is_bytes ) ;
2013-12-21 18:17:45 +00:00
2014-06-01 12:32:54 +00:00
# if MICROPY_PY_BUILTINS_FLOAT
2013-12-21 18:17:45 +00:00
// float
2014-08-29 23:35:11 +00:00
mp_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
2013-12-21 18:17:45 +00:00
// complex
void mp_obj_complex_get ( mp_obj_t self_in , mp_float_t * real , mp_float_t * imag ) ;
2014-08-29 23:35:11 +00:00
mp_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
2016-02-14 17:12:57 +00:00
# else
# define mp_obj_is_float(o) (false)
2013-12-21 18:17:45 +00:00
# endif
// tuple
2014-08-30 13:04:14 +00:00
void mp_obj_tuple_get ( mp_obj_t self_in , mp_uint_t * len , mp_obj_t * * items ) ;
2014-01-13 02:31:00 +00:00
void mp_obj_tuple_del ( mp_obj_t self_in ) ;
2014-07-03 12:25:24 +00:00
mp_int_t mp_obj_tuple_hash ( mp_obj_t self_in ) ;
2013-12-21 18:17:45 +00:00
// list
2014-04-13 03:17:29 +00:00
struct _mp_obj_list_t ;
2014-08-30 13:04:14 +00:00
void mp_obj_list_init ( struct _mp_obj_list_t * o , mp_uint_t n ) ;
2013-12-21 18:17:45 +00:00
mp_obj_t mp_obj_list_append ( mp_obj_t self_in , mp_obj_t arg ) ;
2015-02-21 14:47:02 +00:00
mp_obj_t mp_obj_list_remove ( mp_obj_t self_in , mp_obj_t value ) ;
2014-08-30 13:04:14 +00:00
void mp_obj_list_get ( mp_obj_t self_in , mp_uint_t * len , mp_obj_t * * items ) ;
void mp_obj_list_set_len ( mp_obj_t self_in , mp_uint_t len ) ;
2013-12-21 18:17:45 +00:00
void mp_obj_list_store ( mp_obj_t self_in , mp_obj_t index , mp_obj_t value ) ;
2016-01-03 14:21:40 +00:00
mp_obj_t mp_obj_list_sort ( size_t n_args , const mp_obj_t * args , mp_map_t * kwargs ) ;
2013-12-21 18:17:45 +00:00
// dict
2014-03-30 12:54:02 +00:00
typedef struct _mp_obj_dict_t {
mp_obj_base_t base ;
mp_map_t map ;
} mp_obj_dict_t ;
2014-08-30 12:23:35 +00:00
void mp_obj_dict_init ( mp_obj_dict_t * dict , mp_uint_t n_args ) ;
mp_uint_t mp_obj_dict_len ( mp_obj_t self_in ) ;
2014-06-05 17:02:15 +00:00
mp_obj_t mp_obj_dict_get ( mp_obj_t self_in , mp_obj_t index ) ;
2013-12-21 18:17:45 +00:00
mp_obj_t mp_obj_dict_store ( mp_obj_t self_in , mp_obj_t key , mp_obj_t value ) ;
2014-04-05 12:25:13 +00:00
mp_obj_t mp_obj_dict_delete ( mp_obj_t self_in , mp_obj_t key ) ;
2014-03-30 12:54:02 +00:00
mp_map_t * mp_obj_dict_get_map ( mp_obj_t self_in ) ;
2013-12-21 18:17:45 +00:00
// set
void mp_obj_set_store ( mp_obj_t self_in , mp_obj_t item ) ;
2014-01-03 00:41:17 +00:00
// slice
2014-05-24 22:39:27 +00:00
void mp_obj_slice_get ( mp_obj_t self_in , mp_obj_t * start , mp_obj_t * stop , mp_obj_t * step ) ;
2014-01-03 00:41:17 +00:00
2013-12-21 18:17:45 +00:00
// functions
2016-10-18 00:49:27 +00:00
typedef struct _mp_obj_fun_builtin_fixed_t {
2013-12-21 18:17:45 +00:00
mp_obj_base_t base ;
2016-01-03 11:53:44 +00:00
union {
mp_fun_0_t _0 ;
mp_fun_1_t _1 ;
mp_fun_2_t _2 ;
mp_fun_3_t _3 ;
2016-10-18 00:49:27 +00:00
} fun ;
} mp_obj_fun_builtin_fixed_t ;
# define MP_OBJ_FUN_ARGS_MAX (0xffff) // to set maximum value in n_args_max below
typedef struct _mp_obj_fun_builtin_var_t {
mp_obj_base_t base ;
bool is_kw : 1 ;
mp_uint_t n_args_min : 15 ; // inclusive
mp_uint_t n_args_max : 16 ; // inclusive
union {
2016-01-03 11:53:44 +00:00
mp_fun_var_t var ;
mp_fun_kw_t kw ;
} fun ;
2016-10-18 00:49:27 +00:00
} mp_obj_fun_builtin_var_t ;
2014-01-07 15:58:30 +00:00
2015-02-14 17:44:31 +00:00
qstr mp_obj_fun_get_name ( mp_const_obj_t fun ) ;
qstr mp_obj_code_get_name ( const byte * code_info ) ;
2013-12-21 18:17:45 +00:00
2014-01-20 16:37:30 +00:00
mp_obj_t mp_identity ( mp_obj_t self ) ;
2016-10-18 00:06:20 +00:00
MP_DECLARE_CONST_FUN_OBJ_1 ( mp_identity_obj ) ;
2014-01-20 16:37:30 +00:00
2014-01-02 21:30:26 +00:00
// module
2014-03-08 15:24:39 +00:00
typedef struct _mp_obj_module_t {
mp_obj_base_t base ;
2014-04-05 20:53:54 +00:00
mp_obj_dict_t * globals ;
2014-03-08 15:24:39 +00:00
} mp_obj_module_t ;
2014-04-05 20:53:54 +00:00
mp_obj_dict_t * mp_obj_module_get_globals ( mp_obj_t self_in ) ;
2014-10-25 18:04:13 +00:00
// check if given module object is a package
bool mp_obj_is_package ( mp_obj_t module ) ;
2014-01-11 19:22:29 +00:00
// staticmethod and classmethod types; defined here so we can make const versions
2014-02-06 20:31:44 +00:00
// this structure is used for instances of both staticmethod and classmethod
typedef struct _mp_obj_static_class_method_t {
2014-01-11 19:22:29 +00:00
mp_obj_base_t base ;
mp_obj_t fun ;
2014-02-06 20:31:44 +00:00
} mp_obj_static_class_method_t ;
2015-11-27 13:38:15 +00:00
typedef struct _mp_rom_obj_static_class_method_t {
mp_obj_base_t base ;
mp_rom_obj_t fun ;
} mp_rom_obj_static_class_method_t ;
2014-01-20 22:19:19 +00:00
2014-04-13 17:59:45 +00:00
// property
const mp_obj_t * mp_obj_property_get ( mp_obj_t self_in ) ;
2014-01-20 22:19:19 +00:00
// sequence helpers
2014-05-25 18:21:57 +00:00
// slice indexes resolved to particular sequence
typedef struct {
2014-07-03 12:25:24 +00:00
mp_uint_t start ;
mp_uint_t stop ;
mp_int_t step ;
2014-05-25 18:21:57 +00:00
} mp_bound_slice_t ;
2014-08-30 13:19:41 +00:00
void mp_seq_multiply ( const void * items , mp_uint_t item_sz , mp_uint_t len , mp_uint_t times , void * dest ) ;
2014-06-01 12:49:35 +00:00
# if MICROPY_PY_BUILTINS_SLICE
2014-07-03 12:25:24 +00:00
bool mp_seq_get_fast_slice_indexes ( mp_uint_t len , mp_obj_t slice , mp_bound_slice_t * indexes ) ;
2014-06-01 12:49:35 +00:00
# endif
2014-05-10 18:36:33 +00:00
# define mp_seq_copy(dest, src, len, item_t) memcpy(dest, src, len * sizeof(item_t))
# 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)); }
2014-08-30 13:28:06 +00:00
bool mp_seq_cmp_bytes ( mp_uint_t op , const byte * data1 , mp_uint_t len1 , const byte * data2 , mp_uint_t len2 ) ;
bool 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 ) ;
2014-08-30 13:19:41 +00:00
mp_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 ) ;
mp_obj_t mp_seq_count_obj ( const mp_obj_t * items , mp_uint_t len , mp_obj_t value ) ;
mp_obj_t mp_seq_extract_slice ( mp_uint_t len , const mp_obj_t * seq , mp_bound_slice_t * indexes ) ;
2014-04-27 21:16:57 +00:00
// Helper to clear stale pointers from allocated, but unused memory, to preclude GC problems
# define mp_seq_clear(start, len, alloc_len, item_sz) memset((byte*)(start) + (len) * (item_sz), 0, ((alloc_len) - (len)) * (item_sz))
2015-02-27 20:16:05 +00:00
# define mp_seq_replace_slice_no_grow(dest, dest_len, beg, end, slice, slice_len, item_sz) \
/*printf("memcpy(%p, %p, %d)\n", dest + beg, slice, slice_len * (item_sz));*/ \
memcpy ( ( ( char * ) dest ) + ( beg ) * ( item_sz ) , slice , slice_len * ( item_sz ) ) ; \
/*printf("memmove(%p, %p, %d)\n", dest + (beg + slice_len), dest + end, (dest_len - end) * (item_sz));*/ \
memmove ( ( ( char * ) dest ) + ( beg + slice_len ) * ( item_sz ) , ( ( char * ) dest ) + ( end ) * ( item_sz ) , ( dest_len - end ) * ( item_sz ) ) ;
# define mp_seq_replace_slice_grow_inplace(dest, dest_len, beg, end, slice, slice_len, len_adj, item_sz) \
/*printf("memmove(%p, %p, %d)\n", dest + beg + len_adj, dest + beg, (dest_len - beg) * (item_sz));*/ \
memmove ( ( ( char * ) dest ) + ( beg + len_adj ) * ( item_sz ) , ( ( char * ) dest ) + ( beg ) * ( item_sz ) , ( dest_len - beg ) * ( item_sz ) ) ; \
memcpy ( ( ( char * ) dest ) + ( beg ) * ( item_sz ) , slice , slice_len * ( item_sz ) ) ;
2014-12-29 01:02:19 +00:00
# endif // __MICROPY_INCLUDED_PY_OBJ_H__