1 /*
2  * This file is part of the MicroPython 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  */
26 #ifndef MICROPY_INCLUDED_PY_OBJTYPE_H
27 #define MICROPY_INCLUDED_PY_OBJTYPE_H
28 
29 #include "py/obj.h"
30 
31 // instance object
32 // creating an instance of a class makes one of these objects
33 typedef struct _mp_obj_instance_t {
34     mp_obj_base_t base;
35     mp_map_t members;
36     mp_obj_t subobj[];
37     // TODO maybe cache __getattr__ and __setattr__ for efficient lookup of them
38 } mp_obj_instance_t;
39 
40 #if MICROPY_CPYTHON_COMPAT
41 // this is needed for object.__new__
42 mp_obj_instance_t *mp_obj_new_instance(const mp_obj_type_t *cls, const mp_obj_type_t **native_base);
43 #endif
44 
45 // these need to be exposed so mp_obj_is_callable can work correctly
46 bool mp_obj_instance_is_callable(mp_obj_t self_in);
47 mp_obj_t mp_obj_instance_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args);
48 
49 #define mp_obj_is_instance_type(type) ((type)->make_new == mp_obj_instance_make_new)
50 #define mp_obj_is_native_type(type) ((type)->make_new != mp_obj_instance_make_new)
51 // this needs to be exposed for the above macros to work correctly
52 mp_obj_t mp_obj_instance_make_new(const mp_obj_type_t *self_in, size_t n_args, size_t n_kw, const mp_obj_t *args);
53 
54 // this needs to be exposed for mp_getiter
55 mp_obj_t mp_obj_instance_getiter(mp_obj_t self_in, mp_obj_iter_buf_t *iter_buf);
56 
57 #endif // MICROPY_INCLUDED_PY_OBJTYPE_H
58