objtuple.c 10.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*
 * 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.
 */

27
#include <string.h>
28
29
#include <assert.h>

30
31
32
33
#include "py/nlr.h"
#include "py/objtuple.h"
#include "py/runtime0.h"
#include "py/runtime.h"
34

35
STATIC mp_obj_t mp_obj_new_tuple_iterator(mp_obj_tuple_t *tuple, mp_uint_t cur);
36
37
38
39

/******************************************************************************/
/* tuple                                                                      */

40
void mp_obj_tuple_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o_in, mp_print_kind_t kind) {
41
    mp_obj_tuple_t *o = o_in;
42
43
44
45
46
47
    if (MICROPY_PY_UJSON && kind == PRINT_JSON) {
        print(env, "[");
    } else {
        print(env, "(");
        kind = PRINT_REPR;
    }
48
    for (mp_uint_t i = 0; i < o->len; i++) {
49
50
51
        if (i > 0) {
            print(env, ", ");
        }
52
        mp_obj_print_helper(print, env, o->items[i], kind);
53
    }
54
55
56
57
58
59
60
    if (MICROPY_PY_UJSON && kind == PRINT_JSON) {
        print(env, "]");
    } else {
        if (o->len == 1) {
            print(env, ",");
        }
        print(env, ")");
61
62
63
    }
}

64
STATIC mp_obj_t mp_obj_tuple_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
65
    mp_arg_check_num(n_args, n_kw, 0, 1, false);
66

67
68
69
70
71
    switch (n_args) {
        case 0:
            // return a empty tuple
            return mp_const_empty_tuple;

72
73
        case 1:
        default: {
74
            // 1 argument, an iterable from which we make a new tuple
75
            if (MP_OBJ_IS_TYPE(args[0], &mp_type_tuple)) {
76
77
78
79
80
                return args[0];
            }

            // TODO optimise for cases where we know the length of the iterator

81
82
            mp_uint_t alloc = 4;
            mp_uint_t len = 0;
83
84
            mp_obj_t *items = m_new(mp_obj_t, alloc);

Damien George's avatar
Damien George committed
85
            mp_obj_t iterable = mp_getiter(args[0]);
86
            mp_obj_t item;
87
            while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
                if (len >= alloc) {
                    items = m_renew(mp_obj_t, items, alloc, alloc * 2);
                    alloc *= 2;
                }
                items[len++] = item;
            }

            mp_obj_t tuple = mp_obj_new_tuple(len, items);
            m_free(items, alloc);

            return tuple;
        }
    }
}

Damien George's avatar
Damien George committed
103
// Don't pass MP_BINARY_OP_NOT_EQUAL here
104
STATIC bool tuple_cmp_helper(mp_uint_t op, mp_obj_t self_in, mp_obj_t another_in) {
105
    mp_obj_type_t *self_type = mp_obj_get_type(self_in);
106
    if (self_type->getiter != mp_obj_tuple_getiter) {
107
        assert(0);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
108
    }
109
    mp_obj_type_t *another_type = mp_obj_get_type(another_in);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
110
111
    mp_obj_tuple_t *self = self_in;
    mp_obj_tuple_t *another = another_in;
112
    if (another_type->getiter != mp_obj_tuple_getiter) {
113
114
115
116
117
118
        // Slow path for user subclasses
        another = mp_instance_cast_to_native_base(another, &mp_type_tuple);
        if (another == MP_OBJ_NULL) {
            return false;
        }
    }
Paul Sokolovsky's avatar
Paul Sokolovsky committed
119
120
121
122

    return mp_seq_cmp_objs(op, self->items, self->len, another->items, another->len);
}

123
mp_obj_t mp_obj_tuple_unary_op(mp_uint_t op, mp_obj_t self_in) {
124
125
    mp_obj_tuple_t *self = self_in;
    switch (op) {
Damien George's avatar
Damien George committed
126
127
        case MP_UNARY_OP_BOOL: return MP_BOOL(self->len != 0);
        case MP_UNARY_OP_LEN: return MP_OBJ_NEW_SMALL_INT(self->len);
128
        default: return MP_OBJ_NULL; // op not supported
129
130
131
    }
}

132
mp_obj_t mp_obj_tuple_binary_op(mp_uint_t op, mp_obj_t lhs, mp_obj_t rhs) {
133
134
    mp_obj_tuple_t *o = lhs;
    switch (op) {
135
        case MP_BINARY_OP_ADD: {
136
            if (!mp_obj_is_subclass_fast(mp_obj_get_type(rhs), (mp_obj_t)&mp_type_tuple)) {
137
                return MP_OBJ_NULL; // op not supported
Paul Sokolovsky's avatar
Paul Sokolovsky committed
138
139
140
            }
            mp_obj_tuple_t *p = rhs;
            mp_obj_tuple_t *s = mp_obj_new_tuple(o->len + p->len, NULL);
141
            mp_seq_cat(s->items, o->items, o->len, p->items, p->len, mp_obj_t);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
142
143
            return s;
        }
144
        case MP_BINARY_OP_MULTIPLY: {
145
146
            mp_int_t n;
            if (!mp_obj_get_int_maybe(rhs, &n)) {
147
                return MP_OBJ_NULL; // op not supported
148
            }
149
150
151
            if (n <= 0) {
                return mp_const_empty_tuple;
            }
152
153
154
155
            mp_obj_tuple_t *s = mp_obj_new_tuple(o->len * n, NULL);
            mp_seq_multiply(o->items, sizeof(*o->items), o->len, n, s->items);
            return s;
        }
Damien George's avatar
Damien George committed
156
157
158
159
160
        case MP_BINARY_OP_EQUAL:
        case MP_BINARY_OP_LESS:
        case MP_BINARY_OP_LESS_EQUAL:
        case MP_BINARY_OP_MORE:
        case MP_BINARY_OP_MORE_EQUAL:
Paul Sokolovsky's avatar
Paul Sokolovsky committed
161
162
            return MP_BOOL(tuple_cmp_helper(op, lhs, rhs));

163
        default:
164
            return MP_OBJ_NULL; // op not supported
165
166
167
    }
}

168
mp_obj_t mp_obj_tuple_subscr(mp_obj_t self_in, mp_obj_t index, mp_obj_t value) {
169
170
171
    if (value == MP_OBJ_SENTINEL) {
        // load
        mp_obj_tuple_t *self = self_in;
172
#if MICROPY_PY_BUILTINS_SLICE
173
        if (MP_OBJ_IS_TYPE(index, &mp_type_slice)) {
174
175
            mp_bound_slice_t slice;
            if (!mp_seq_get_fast_slice_indexes(self->len, index, &slice)) {
176
                nlr_raise(mp_obj_new_exception_msg(&mp_type_NotImplementedError,
177
                    "only slices with step=1 (aka None) are supported"));
178
            }
179
180
            mp_obj_tuple_t *res = mp_obj_new_tuple(slice.stop - slice.start, NULL);
            mp_seq_copy(res->items, self->items + slice.start, res->len, mp_obj_t);
181
182
183
            return res;
        }
#endif
184
        mp_uint_t index_value = mp_get_index(self->base.type, self->len, index, false);
185
186
        return self->items[index_value];
    } else {
187
        return MP_OBJ_NULL; // op not supported
188
189
190
    }
}

191
mp_obj_t mp_obj_tuple_getiter(mp_obj_t o_in) {
192
193
194
    return mp_obj_new_tuple_iterator(o_in, 0);
}

195
STATIC mp_obj_t tuple_count(mp_obj_t self_in, mp_obj_t value) {
196
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_tuple));
197
198
199
    mp_obj_tuple_t *self = self_in;
    return mp_seq_count_obj(self->items, self->len, value);
}
200
STATIC MP_DEFINE_CONST_FUN_OBJ_2(tuple_count_obj, tuple_count);
201

202
STATIC mp_obj_t tuple_index(mp_uint_t n_args, const mp_obj_t *args) {
203
    assert(MP_OBJ_IS_TYPE(args[0], &mp_type_tuple));
Paul Sokolovsky's avatar
Paul Sokolovsky committed
204
205
206
    mp_obj_tuple_t *self = args[0];
    return mp_seq_index_obj(self->items, self->len, n_args, args);
}
207
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(tuple_index_obj, 2, 4, tuple_index);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
208

209
210
211
STATIC const mp_map_elem_t tuple_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_count), (mp_obj_t)&tuple_count_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_index), (mp_obj_t)&tuple_index_obj },
Paul Sokolovsky's avatar
Paul Sokolovsky committed
212
213
};

214
215
STATIC MP_DEFINE_CONST_DICT(tuple_locals_dict, tuple_locals_dict_table);

216
const mp_obj_type_t mp_type_tuple = {
217
    { &mp_type_type },
218
    .name = MP_QSTR_tuple,
219
    .print = mp_obj_tuple_print,
220
    .make_new = mp_obj_tuple_make_new,
221
222
223
224
    .unary_op = mp_obj_tuple_unary_op,
    .binary_op = mp_obj_tuple_binary_op,
    .subscr = mp_obj_tuple_subscr,
    .getiter = mp_obj_tuple_getiter,
225
    .locals_dict = (mp_obj_t)&tuple_locals_dict,
226
227
};

228
// the zero-length tuple
229
const mp_obj_tuple_t mp_const_empty_tuple_obj = {{&mp_type_tuple}, 0};
230

231
mp_obj_t mp_obj_new_tuple(mp_uint_t n, const mp_obj_t *items) {
232
233
234
    if (n == 0) {
        return mp_const_empty_tuple;
    }
235
    mp_obj_tuple_t *o = m_new_obj_var(mp_obj_tuple_t, mp_obj_t, n);
236
    o->base.type = &mp_type_tuple;
237
    o->len = n;
John R. Lenton's avatar
John R. Lenton committed
238
    if (items) {
239
        for (mp_uint_t i = 0; i < n; i++) {
John R. Lenton's avatar
John R. Lenton committed
240
241
            o->items[i] = items[i];
        }
242
243
244
245
    }
    return o;
}

246
void mp_obj_tuple_get(mp_obj_t self_in, mp_uint_t *len, mp_obj_t **items) {
247
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_tuple));
248
    mp_obj_tuple_t *self = self_in;
249
250
    *len = self->len;
    *items = &self->items[0];
John R. Lenton's avatar
John R. Lenton committed
251
252
253
}

void mp_obj_tuple_del(mp_obj_t self_in) {
254
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_tuple));
John R. Lenton's avatar
John R. Lenton committed
255
256
    mp_obj_tuple_t *self = self_in;
    m_del_var(mp_obj_tuple_t, mp_obj_t, self->len, self);
257
258
}

259
mp_int_t mp_obj_tuple_hash(mp_obj_t self_in) {
260
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_tuple));
261
262
    mp_obj_tuple_t *self = self_in;
    // start hash with pointer to empty tuple, to make it fairly unique
263
    mp_int_t hash = (mp_int_t)mp_const_empty_tuple;
264
    for (mp_uint_t i = 0; i < self->len; i++) {
265
266
267
268
269
        hash += mp_obj_hash(self->items[i]);
    }
    return hash;
}

270
271
272
273
274
275
/******************************************************************************/
/* tuple iterator                                                             */

typedef struct _mp_obj_tuple_it_t {
    mp_obj_base_t base;
    mp_obj_tuple_t *tuple;
276
    mp_uint_t cur;
277
278
} mp_obj_tuple_it_t;

279
STATIC mp_obj_t tuple_it_iternext(mp_obj_t self_in) {
280
281
282
283
284
285
    mp_obj_tuple_it_t *self = self_in;
    if (self->cur < self->tuple->len) {
        mp_obj_t o_out = self->tuple->items[self->cur];
        self->cur += 1;
        return o_out;
    } else {
286
        return MP_OBJ_STOP_ITERATION;
287
288
289
    }
}

290
STATIC const mp_obj_type_t mp_type_tuple_it = {
291
    { &mp_type_type },
292
    .name = MP_QSTR_iterator,
293
    .getiter = mp_identity,
294
    .iternext = tuple_it_iternext,
295
296
};

297
STATIC mp_obj_t mp_obj_new_tuple_iterator(mp_obj_tuple_t *tuple, mp_uint_t cur) {
298
    mp_obj_tuple_it_t *o = m_new_obj(mp_obj_tuple_it_t);
299
    o->base.type = &mp_type_tuple_it;
300
301
302
303
    o->tuple = tuple;
    o->cur = cur;
    return o;
}