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_OBJTUPLE_H
27 #define MICROPY_INCLUDED_PY_OBJTUPLE_H
28 
29 #include "py/obj.h"
30 
31 typedef struct _mp_obj_tuple_t {
32     mp_obj_base_t base;
33     size_t len;
34     mp_obj_t items[];
35 } mp_obj_tuple_t;
36 
37 typedef struct _mp_rom_obj_tuple_t {
38     mp_obj_base_t base;
39     size_t len;
40     mp_rom_obj_t items[];
41 } mp_rom_obj_tuple_t;
42 
43 void mp_obj_tuple_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind);
44 mp_obj_t mp_obj_tuple_unary_op(mp_unary_op_t op, mp_obj_t self_in);
45 mp_obj_t mp_obj_tuple_binary_op(mp_binary_op_t op, mp_obj_t lhs, mp_obj_t rhs);
46 mp_obj_t mp_obj_tuple_subscr(mp_obj_t base, mp_obj_t index, mp_obj_t value);
47 mp_obj_t mp_obj_tuple_getiter(mp_obj_t o_in, mp_obj_iter_buf_t *iter_buf);
48 
49 extern const mp_obj_type_t mp_type_attrtuple;
50 
51 #define MP_DEFINE_ATTRTUPLE(tuple_obj_name, fields, nitems, ...) \
52     const mp_rom_obj_tuple_t tuple_obj_name = { \
53         .base = {&mp_type_attrtuple}, \
54         .len = nitems, \
55         .items = { __VA_ARGS__, MP_ROM_PTR((void *)fields) } \
56     }
57 
58 #if MICROPY_PY_COLLECTIONS
59 void mp_obj_attrtuple_print_helper(const mp_print_t *print, const qstr *fields, mp_obj_tuple_t *o);
60 #endif
61 
62 mp_obj_t mp_obj_new_attrtuple(const qstr *fields, size_t n, const mp_obj_t *items);
63 
64 #endif // MICROPY_INCLUDED_PY_OBJTUPLE_H
65