objtuple.c 10.2 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
#include "mpconfig.h"
31
32
#include "nlr.h"
#include "misc.h"
33
#include "qstr.h"
34
35
#include "obj.h"
#include "runtime0.h"
36
#include "runtime.h"
37
#include "objtuple.h"
38

39
STATIC mp_obj_t mp_obj_new_tuple_iterator(mp_obj_tuple_t *tuple, mp_uint_t cur);
40
41
42
43

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

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

68
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) {
69
    mp_arg_check_num(n_args, n_kw, 0, 1, false);
70

71
72
73
74
75
    switch (n_args) {
        case 0:
            // return a empty tuple
            return mp_const_empty_tuple;

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

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

85
86
            mp_uint_t alloc = 4;
            mp_uint_t len = 0;
87
88
            mp_obj_t *items = m_new(mp_obj_t, alloc);

Damien George's avatar
Damien George committed
89
            mp_obj_t iterable = mp_getiter(args[0]);
90
            mp_obj_t item;
91
            while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
                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
107
// Don't pass MP_BINARY_OP_NOT_EQUAL here
108
STATIC bool tuple_cmp_helper(mp_uint_t op, mp_obj_t self_in, mp_obj_t another_in) {
109
    mp_obj_type_t *self_type = mp_obj_get_type(self_in);
110
    if (self_type->getiter != mp_obj_tuple_getiter) {
111
        assert(0);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
112
    }
113
    mp_obj_type_t *another_type = mp_obj_get_type(another_in);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
114
115
    mp_obj_tuple_t *self = self_in;
    mp_obj_tuple_t *another = another_in;
116
    if (another_type->getiter != mp_obj_tuple_getiter) {
117
118
119
120
121
122
        // 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
123
124
125
126

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

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

136
mp_obj_t mp_obj_tuple_binary_op(mp_uint_t op, mp_obj_t lhs, mp_obj_t rhs) {
137
138
    mp_obj_tuple_t *o = lhs;
    switch (op) {
139
        case MP_BINARY_OP_ADD: {
140
            if (!mp_obj_is_subclass_fast(mp_obj_get_type(rhs), (mp_obj_t)&mp_type_tuple)) {
141
                return MP_OBJ_NULL; // op not supported
Paul Sokolovsky's avatar
Paul Sokolovsky committed
142
143
144
            }
            mp_obj_tuple_t *p = rhs;
            mp_obj_tuple_t *s = mp_obj_new_tuple(o->len + p->len, NULL);
145
            mp_seq_cat(s->items, o->items, o->len, p->items, p->len, mp_obj_t);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
146
147
            return s;
        }
148
        case MP_BINARY_OP_MULTIPLY: {
149
150
            mp_int_t n;
            if (!mp_obj_get_int_maybe(rhs, &n)) {
151
                return MP_OBJ_NULL; // op not supported
152
            }
153
154
155
            if (n <= 0) {
                return mp_const_empty_tuple;
            }
156
157
158
159
            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
160
161
162
163
164
        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
165
166
            return MP_BOOL(tuple_cmp_helper(op, lhs, rhs));

167
        default:
168
            return MP_OBJ_NULL; // op not supported
169
170
171
    }
}

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

195
mp_obj_t mp_obj_tuple_getiter(mp_obj_t o_in) {
196
197
198
    return mp_obj_new_tuple_iterator(o_in, 0);
}

199
STATIC mp_obj_t tuple_count(mp_obj_t self_in, mp_obj_t value) {
200
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_tuple));
201
202
203
    mp_obj_tuple_t *self = self_in;
    return mp_seq_count_obj(self->items, self->len, value);
}
204
STATIC MP_DEFINE_CONST_FUN_OBJ_2(tuple_count_obj, tuple_count);
205

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

213
214
215
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
216
217
};

218
219
STATIC MP_DEFINE_CONST_DICT(tuple_locals_dict, tuple_locals_dict_table);

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

232
// the zero-length tuple
233
const mp_obj_tuple_t mp_const_empty_tuple_obj = {{&mp_type_tuple}, 0};
234

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

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

void mp_obj_tuple_del(mp_obj_t self_in) {
258
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_tuple));
John R. Lenton's avatar
John R. Lenton committed
259
260
    mp_obj_tuple_t *self = self_in;
    m_del_var(mp_obj_tuple_t, mp_obj_t, self->len, self);
261
262
}

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

274
275
276
277
278
279
/******************************************************************************/
/* tuple iterator                                                             */

typedef struct _mp_obj_tuple_it_t {
    mp_obj_base_t base;
    mp_obj_tuple_t *tuple;
280
    mp_uint_t cur;
281
282
} mp_obj_tuple_it_t;

283
STATIC mp_obj_t tuple_it_iternext(mp_obj_t self_in) {
284
285
286
287
288
289
    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 {
290
        return MP_OBJ_STOP_ITERATION;
291
292
293
    }
}

294
STATIC const mp_obj_type_t mp_type_tuple_it = {
295
    { &mp_type_type },
296
    .name = MP_QSTR_iterator,
297
    .getiter = mp_identity,
298
    .iternext = tuple_it_iternext,
299
300
};

301
STATIC mp_obj_t mp_obj_new_tuple_iterator(mp_obj_tuple_t *tuple, mp_uint_t cur) {
302
    mp_obj_tuple_it_t *o = m_new_obj(mp_obj_tuple_it_t);
303
    o->base.type = &mp_type_tuple_it;
304
305
306
307
    o->tuple = tuple;
    o->cur = cur;
    return o;
}