Branch data Line data Source code
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 : : * Copyright (c) 2014-2017 Paul Sokolovsky
8 : : *
9 : : * Permission is hereby granted, free of charge, to any person obtaining a copy
10 : : * of this software and associated documentation files (the "Software"), to deal
11 : : * in the Software without restriction, including without limitation the rights
12 : : * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 : : * copies of the Software, and to permit persons to whom the Software is
14 : : * furnished to do so, subject to the following conditions:
15 : : *
16 : : * The above copyright notice and this permission notice shall be included in
17 : : * all copies or substantial portions of the Software.
18 : : *
19 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 : : * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 : : * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 : : * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 : : * THE SOFTWARE.
26 : : */
27 : :
28 : : #include <string.h>
29 : : #include <assert.h>
30 : :
31 : : #include "py/objtuple.h"
32 : : #include "py/runtime.h"
33 : :
34 : : // type check is done on getiter method to allow tuple, namedtuple, attrtuple
35 : : #define mp_obj_is_tuple_compatible(o) (MP_OBJ_TYPE_GET_SLOT_OR_NULL(mp_obj_get_type(o), iter) == mp_obj_tuple_getiter)
36 : :
37 : : /******************************************************************************/
38 : : /* tuple */
39 : :
40 : 2832 : void mp_obj_tuple_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind) {
41 : 2832 : mp_obj_tuple_t *o = MP_OBJ_TO_PTR(o_in);
42 : 2832 : const char *item_separator = ", ";
43 [ + + ]: 2832 : if (MICROPY_PY_JSON && kind == PRINT_JSON) {
44 : 112 : mp_print_str(print, "[");
45 : : #if MICROPY_PY_JSON_SEPARATORS
46 : 112 : item_separator = MP_PRINT_GET_EXT(print)->item_separator;
47 : : #endif
48 : : } else {
49 : 2720 : mp_print_str(print, "(");
50 : 2720 : kind = PRINT_REPR;
51 : : }
52 [ + + ]: 9112 : for (size_t i = 0; i < o->len; i++) {
53 [ + + ]: 6280 : if (i > 0) {
54 : 3710 : mp_print_str(print, item_separator);
55 : : }
56 : 6280 : mp_obj_print_helper(print, o->items[i], kind);
57 : : }
58 [ + + ]: 2832 : if (MICROPY_PY_JSON && kind == PRINT_JSON) {
59 : 112 : mp_print_str(print, "]");
60 : : } else {
61 [ + + ]: 2720 : if (o->len == 1) {
62 : 472 : mp_print_str(print, ",");
63 : : }
64 : 2720 : mp_print_str(print, ")");
65 : : }
66 : 2832 : }
67 : :
68 : 96 : static mp_obj_t mp_obj_tuple_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
69 : 96 : (void)type_in;
70 : :
71 : 96 : mp_arg_check_num(n_args, n_kw, 0, 1, false);
72 : :
73 [ + + ]: 96 : switch (n_args) {
74 : : case 0:
75 : : // return a empty tuple
76 : : return mp_const_empty_tuple;
77 : :
78 : : case 1:
79 : : default: {
80 : : // 1 argument, an iterable from which we make a new tuple
81 [ + - + + ]: 80 : if (mp_obj_is_type(args[0], &mp_type_tuple)) {
82 : : return args[0];
83 : : }
84 : :
85 : : // TODO optimise for cases where we know the length of the iterator
86 : :
87 : 76 : size_t alloc = 4;
88 : 76 : size_t len = 0;
89 : 76 : mp_obj_t *items = m_new(mp_obj_t, alloc);
90 : :
91 : 76 : mp_obj_t iterable = mp_getiter(args[0], NULL);
92 : 76 : mp_obj_t item;
93 [ + + ]: 288 : while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
94 [ + + ]: 212 : if (len >= alloc) {
95 : 16 : items = m_renew(mp_obj_t, items, alloc, alloc * 2);
96 : 16 : alloc *= 2;
97 : : }
98 : 212 : items[len++] = item;
99 : : }
100 : :
101 : 64 : mp_obj_t tuple = mp_obj_new_tuple(len, items);
102 : 64 : m_del(mp_obj_t, items, alloc);
103 : :
104 : 64 : return tuple;
105 : : }
106 : : }
107 : : }
108 : :
109 : : // Don't pass MP_BINARY_OP_NOT_EQUAL here
110 : 628 : static mp_obj_t tuple_cmp_helper(mp_uint_t op, mp_obj_t self_in, mp_obj_t another_in) {
111 : 628 : mp_check_self(mp_obj_is_tuple_compatible(self_in));
112 : 628 : const mp_obj_type_t *another_type = mp_obj_get_type(another_in);
113 : 628 : mp_obj_tuple_t *self = MP_OBJ_TO_PTR(self_in);
114 [ + - + + ]: 628 : if (MP_OBJ_TYPE_GET_SLOT_OR_NULL(another_type, iter) != mp_obj_tuple_getiter) {
115 : : // Slow path for user subclasses
116 : 12 : another_in = mp_obj_cast_to_native_base(another_in, MP_OBJ_FROM_PTR(&mp_type_tuple));
117 [ + + ]: 12 : if (another_in == MP_OBJ_NULL) {
118 : : return MP_OBJ_NULL;
119 : : }
120 : : }
121 : 624 : mp_obj_tuple_t *another = MP_OBJ_TO_PTR(another_in);
122 : :
123 [ + + ]: 624 : return mp_obj_new_bool(mp_seq_cmp_objs(op, self->items, self->len, another->items, another->len));
124 : : }
125 : :
126 : 5959 : mp_obj_t mp_obj_tuple_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
127 : 5959 : mp_obj_tuple_t *self = MP_OBJ_TO_PTR(self_in);
128 [ + + + + ]: 5959 : switch (op) {
129 : 254 : case MP_UNARY_OP_BOOL:
130 [ + + ]: 254 : return mp_obj_new_bool(self->len != 0);
131 : 232 : case MP_UNARY_OP_HASH: {
132 : : // start hash with pointer to empty tuple, to make it fairly unique
133 : 232 : mp_int_t hash = (mp_int_t)mp_const_empty_tuple;
134 [ + + ]: 2252 : for (size_t i = 0; i < self->len; i++) {
135 : 2020 : hash += MP_OBJ_SMALL_INT_VALUE(mp_unary_op(MP_UNARY_OP_HASH, self->items[i]));
136 : : }
137 : 232 : return MP_OBJ_NEW_SMALL_INT(hash);
138 : : }
139 : 5469 : case MP_UNARY_OP_LEN:
140 : 5469 : return MP_OBJ_NEW_SMALL_INT(self->len);
141 : : default:
142 : : return MP_OBJ_NULL; // op not supported
143 : : }
144 : : }
145 : :
146 : 1010 : mp_obj_t mp_obj_tuple_binary_op(mp_binary_op_t op, mp_obj_t lhs, mp_obj_t rhs) {
147 : 1010 : mp_obj_tuple_t *o = MP_OBJ_TO_PTR(lhs);
148 [ + + + + ]: 1010 : switch (op) {
149 : 88 : case MP_BINARY_OP_ADD:
150 : : case MP_BINARY_OP_INPLACE_ADD: {
151 [ + + ]: 88 : if (!mp_obj_is_subclass_fast(MP_OBJ_FROM_PTR(mp_obj_get_type(rhs)), MP_OBJ_FROM_PTR(&mp_type_tuple))) {
152 : : return MP_OBJ_NULL; // op not supported
153 : : }
154 : 84 : mp_obj_tuple_t *p = MP_OBJ_TO_PTR(rhs);
155 : 84 : mp_obj_tuple_t *s = MP_OBJ_TO_PTR(mp_obj_new_tuple(o->len + p->len, NULL));
156 : 84 : mp_seq_cat(s->items, o->items, o->len, p->items, p->len, mp_obj_t);
157 : 84 : return MP_OBJ_FROM_PTR(s);
158 : : }
159 : 64 : case MP_BINARY_OP_MULTIPLY:
160 : : case MP_BINARY_OP_INPLACE_MULTIPLY: {
161 : 64 : mp_int_t n;
162 [ + + ]: 64 : if (!mp_obj_get_int_maybe(rhs, &n)) {
163 : : return MP_OBJ_NULL; // op not supported
164 : : }
165 [ + + ]: 60 : if (n <= 0) {
166 : : return mp_const_empty_tuple;
167 : : }
168 : 36 : mp_obj_tuple_t *s = MP_OBJ_TO_PTR(mp_obj_new_tuple(o->len * n, NULL));
169 : 36 : mp_seq_multiply(o->items, sizeof(*o->items), o->len, n, s->items);
170 : 36 : return MP_OBJ_FROM_PTR(s);
171 : : }
172 : 628 : case MP_BINARY_OP_EQUAL:
173 : : case MP_BINARY_OP_LESS:
174 : : case MP_BINARY_OP_LESS_EQUAL:
175 : : case MP_BINARY_OP_MORE:
176 : : case MP_BINARY_OP_MORE_EQUAL:
177 : 628 : return tuple_cmp_helper(op, lhs, rhs);
178 : :
179 : : default:
180 : : return MP_OBJ_NULL; // op not supported
181 : : }
182 : : }
183 : :
184 : 116956 : mp_obj_t mp_obj_tuple_subscr(mp_obj_t self_in, mp_obj_t index, mp_obj_t value) {
185 [ + + ]: 116956 : if (value == MP_OBJ_SENTINEL) {
186 : : // load
187 : 116948 : mp_obj_tuple_t *self = MP_OBJ_TO_PTR(self_in);
188 : : #if MICROPY_PY_BUILTINS_SLICE
189 [ - + - + : 116948 : if (mp_obj_is_type(index, &mp_type_slice)) {
- + - + +
+ + - ]
190 : 47 : mp_bound_slice_t slice;
191 [ + + ]: 47 : if (!mp_seq_get_fast_slice_indexes(self->len, index, &slice)) {
192 : 2 : mp_raise_NotImplementedError(MP_ERROR_TEXT("only slices with step=1 (aka None) are supported"));
193 : : }
194 : 45 : mp_obj_tuple_t *res = MP_OBJ_TO_PTR(mp_obj_new_tuple(slice.stop - slice.start, NULL));
195 : 45 : mp_seq_copy(res->items, self->items + slice.start, res->len, mp_obj_t);
196 : 45 : return MP_OBJ_FROM_PTR(res);
197 : : }
198 : : #endif
199 : 116901 : size_t index_value = mp_get_index(self->base.type, self->len, index, false);
200 : 116901 : return self->items[index_value];
201 : : } else {
202 : : return MP_OBJ_NULL; // op not supported
203 : : }
204 : : }
205 : :
206 : 8 : static mp_obj_t tuple_count(mp_obj_t self_in, mp_obj_t value) {
207 : 8 : mp_check_self(mp_obj_is_type(self_in, &mp_type_tuple));
208 : 8 : mp_obj_tuple_t *self = MP_OBJ_TO_PTR(self_in);
209 : 8 : return mp_seq_count_obj(self->items, self->len, value);
210 : : }
211 : : static MP_DEFINE_CONST_FUN_OBJ_2(tuple_count_obj, tuple_count);
212 : :
213 : 36 : static mp_obj_t tuple_index(size_t n_args, const mp_obj_t *args) {
214 : 36 : mp_check_self(mp_obj_is_type(args[0], &mp_type_tuple));
215 : 36 : mp_obj_tuple_t *self = MP_OBJ_TO_PTR(args[0]);
216 : 36 : return mp_seq_index_obj(self->items, self->len, n_args, args);
217 : : }
218 : : static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(tuple_index_obj, 2, 4, tuple_index);
219 : :
220 : : static const mp_rom_map_elem_t tuple_locals_dict_table[] = {
221 : : { MP_ROM_QSTR(MP_QSTR_count), MP_ROM_PTR(&tuple_count_obj) },
222 : : { MP_ROM_QSTR(MP_QSTR_index), MP_ROM_PTR(&tuple_index_obj) },
223 : : };
224 : :
225 : : static MP_DEFINE_CONST_DICT(tuple_locals_dict, tuple_locals_dict_table);
226 : :
227 : : MP_DEFINE_CONST_OBJ_TYPE(
228 : : mp_type_tuple,
229 : : MP_QSTR_tuple,
230 : : MP_TYPE_FLAG_ITER_IS_GETITER,
231 : : make_new, mp_obj_tuple_make_new,
232 : : print, mp_obj_tuple_print,
233 : : unary_op, mp_obj_tuple_unary_op,
234 : : binary_op, mp_obj_tuple_binary_op,
235 : : subscr, mp_obj_tuple_subscr,
236 : : iter, mp_obj_tuple_getiter,
237 : : locals_dict, &tuple_locals_dict
238 : : );
239 : :
240 : : // the zero-length tuple
241 : : const mp_obj_tuple_t mp_const_empty_tuple_obj = {{&mp_type_tuple}, 0};
242 : :
243 : 167507 : mp_obj_t mp_obj_new_tuple(size_t n, const mp_obj_t *items) {
244 [ + + ]: 167507 : if (n == 0) {
245 : : return mp_const_empty_tuple;
246 : : }
247 : 163944 : mp_obj_tuple_t *o = mp_obj_malloc_var(mp_obj_tuple_t, items, mp_obj_t, n, &mp_type_tuple);
248 : 163940 : o->len = n;
249 [ + + ]: 163940 : if (items) {
250 [ + + ]: 699024 : for (size_t i = 0; i < n; i++) {
251 : 590194 : o->items[i] = items[i];
252 : : }
253 : : }
254 : : return MP_OBJ_FROM_PTR(o);
255 : : }
256 : :
257 : 154041 : void mp_obj_tuple_get(mp_obj_t self_in, size_t *len, mp_obj_t **items) {
258 [ + - - + ]: 154041 : assert(mp_obj_is_tuple_compatible(self_in));
259 : 154041 : mp_obj_tuple_t *self = MP_OBJ_TO_PTR(self_in);
260 : 154041 : *len = self->len;
261 : 154041 : *items = &self->items[0];
262 : 154041 : }
263 : :
264 : 8 : void mp_obj_tuple_del(mp_obj_t self_in) {
265 [ + - - + ]: 8 : assert(mp_obj_is_type(self_in, &mp_type_tuple));
266 : 8 : mp_obj_tuple_t *self = MP_OBJ_TO_PTR(self_in);
267 : 8 : m_del_var(mp_obj_tuple_t, items, mp_obj_t, self->len, self);
268 : 8 : }
269 : :
270 : : /******************************************************************************/
271 : : /* tuple iterator */
272 : :
273 : : typedef struct _mp_obj_tuple_it_t {
274 : : mp_obj_base_t base;
275 : : mp_fun_1_t iternext;
276 : : mp_obj_tuple_t *tuple;
277 : : size_t cur;
278 : : } mp_obj_tuple_it_t;
279 : :
280 : 17099 : static mp_obj_t tuple_it_iternext(mp_obj_t self_in) {
281 : 17099 : mp_obj_tuple_it_t *self = MP_OBJ_TO_PTR(self_in);
282 [ + + ]: 17099 : if (self->cur < self->tuple->len) {
283 : 14003 : mp_obj_t o_out = self->tuple->items[self->cur];
284 : 14003 : self->cur += 1;
285 : 14003 : return o_out;
286 : : } else {
287 : : return MP_OBJ_STOP_ITERATION;
288 : : }
289 : : }
290 : :
291 : 5347 : mp_obj_t mp_obj_tuple_getiter(mp_obj_t o_in, mp_obj_iter_buf_t *iter_buf) {
292 : 5347 : assert(sizeof(mp_obj_tuple_it_t) <= sizeof(mp_obj_iter_buf_t));
293 : 5347 : mp_obj_tuple_it_t *o = (mp_obj_tuple_it_t *)iter_buf;
294 : 5347 : o->base.type = &mp_type_polymorph_iter;
295 : 5347 : o->iternext = tuple_it_iternext;
296 : 5347 : o->tuple = MP_OBJ_TO_PTR(o_in);
297 : 5347 : o->cur = 0;
298 : 5347 : return MP_OBJ_FROM_PTR(o);
299 : : }
|