objarray.c 14.2 KB
Newer Older
1
2
3
4
5
6
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
7
 * Copyright (c) 2014 Paul Sokolovsky
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 *
 * 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.
 */

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

31
#include "mpconfig.h"
32
33
#include "nlr.h"
#include "misc.h"
34
#include "qstr.h"
35
36
37
#include "obj.h"
#include "runtime0.h"
#include "runtime.h"
38
#include "binary.h"
39

40
#if MICROPY_PY_ARRAY || MICROPY_PY_BUILTINS_BYTEARRAY || MICROPY_PY_BUILTINS_MEMORYVIEW
41

42
43
typedef struct _mp_obj_array_t {
    mp_obj_base_t base;
44
    mp_uint_t typecode : 8;
45
46
    // free is number of unused elements after len used elements
    // alloc size = len + free
47
    // for memoryview, free=0 is read-only, free=1 is read-write
48
49
    mp_uint_t free : (8 * sizeof(mp_uint_t) - 8);
    mp_uint_t len; // in elements
50
51
52
    void *items;
} mp_obj_array_t;

53
54
STATIC mp_obj_t array_iterator_new(mp_obj_t array_in);
STATIC mp_obj_t array_append(mp_obj_t self_in, mp_obj_t arg);
55
STATIC mp_int_t array_get_buffer(mp_obj_t o_in, mp_buffer_info_t *bufinfo, mp_uint_t flags);
56
57

/******************************************************************************/
58
// array
59

60
#if MICROPY_PY_BUILTINS_BYTEARRAY || MICROPY_PY_ARRAY
61
STATIC void array_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o_in, mp_print_kind_t kind) {
62
63
    mp_obj_array_t *o = o_in;
    if (o->typecode == BYTEARRAY_TYPECODE) {
64
        print(env, "bytearray(b");
65
        mp_str_print_quoted(print, env, o->items, o->len, true);
66
    } else {
67
        print(env, "array('%c'", o->typecode);
68
        if (o->len > 0) {
69
            print(env, ", [");
70
            for (mp_uint_t i = 0; i < o->len; i++) {
71
72
73
                if (i > 0) {
                    print(env, ", ");
                }
74
                mp_obj_print_helper(print, env, mp_binary_get_val_array(o->typecode, o->items, i), PRINT_REPR);
75
            }
76
            print(env, "]");
77
78
        }
    }
79
    print(env, ")");
80
}
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
#endif

#if MICROPY_PY_BUILTINS_BYTEARRAY || MICROPY_PY_ARRAY
STATIC mp_obj_array_t *array_new(char typecode, mp_uint_t n) {
    int typecode_size = mp_binary_get_size('@', typecode, NULL);
    if (typecode_size <= 0) {
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "bad typecode"));
    }
    mp_obj_array_t *o = m_new_obj(mp_obj_array_t);
    #if MICROPY_PY_BUILTINS_BYTEARRAY && MICROPY_PY_ARRAY
    o->base.type = (typecode == BYTEARRAY_TYPECODE) ? &mp_type_bytearray : &mp_type_array;
    #elif MICROPY_PY_BUILTINS_BYTEARRAY
    o->base.type = &mp_type_bytearray;
    #else
    o->base.type = &mp_type_array;
    #endif
    o->typecode = typecode;
    o->free = 0;
    o->len = n;
    o->items = m_malloc(typecode_size * o->len);
    return o;
}
#endif
104

105
#if MICROPY_PY_BUILTINS_BYTEARRAY || MICROPY_PY_ARRAY
106
STATIC mp_obj_t array_construct(char typecode, mp_obj_t initializer) {
107
108
109
110
111
112
113
114
115
116
117
    uint len;
    // Try to create array of exact len if initializer len is known
    mp_obj_t len_in = mp_obj_len_maybe(initializer);
    if (len_in == MP_OBJ_NULL) {
        len = 0;
    } else {
        len = MP_OBJ_SMALL_INT_VALUE(len_in);
    }

    mp_obj_array_t *array = array_new(typecode, len);

Damien George's avatar
Damien George committed
118
    mp_obj_t iterable = mp_getiter(initializer);
119
    mp_obj_t item;
120
    mp_uint_t i = 0;
121
    while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
122
123
124
        if (len == 0) {
            array_append(array, item);
        } else {
125
            mp_binary_set_val_array(typecode, array->items, i++, item);
126
127
128
129
130
        }
    }

    return array;
}
131
#endif
132

133
#if MICROPY_PY_ARRAY
134
STATIC mp_obj_t array_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
135
    mp_arg_check_num(n_args, n_kw, 1, 2, false);
136
137

    // get typecode
138
    mp_uint_t l;
139
    const char *typecode = mp_obj_str_get_data(args[0], &l);
140

141
    if (n_args == 1) {
142
        // 1 arg: make an empty array
143
        return array_new(*typecode, 0);
144
145
146
    } else {
        // 2 args: construct the array from the given iterator
        return array_construct(*typecode, args[1]);
147
    }
148
}
149
#endif
150

151
#if MICROPY_PY_BUILTINS_BYTEARRAY
152
STATIC mp_obj_t bytearray_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
153
    mp_arg_check_num(n_args, n_kw, 0, 1, false);
154

155
156
157
158
159
    if (n_args == 0) {
        // no args: construct an empty bytearray
        return array_new(BYTEARRAY_TYPECODE, 0);
    } else if (MP_OBJ_IS_SMALL_INT(args[0])) {
        // 1 arg, an integer: construct a blank bytearray of that length
160
        uint len = MP_OBJ_SMALL_INT_VALUE(args[0]);
161
162
163
        mp_obj_array_t *o = array_new(BYTEARRAY_TYPECODE, len);
        memset(o->items, 0, len);
        return o;
164
165
166
    } else {
        // 1 arg, an iterator: construct the bytearray from that
        return array_construct(BYTEARRAY_TYPECODE, args[0]);
167
    }
168
}
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
#endif

#if MICROPY_PY_BUILTINS_MEMORYVIEW
STATIC mp_obj_t memoryview_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
    // TODO possibly allow memoryview constructor to take start/stop so that one
    // can do memoryview(b, 4, 8) instead of memoryview(b)[4:8] (uses less RAM)

    mp_arg_check_num(n_args, n_kw, 1, 1, false);

    mp_buffer_info_t bufinfo;
    mp_get_buffer_raise(args[0], &bufinfo, MP_BUFFER_READ);

    mp_obj_array_t *self = m_new_obj(mp_obj_array_t);
    self->base.type = type_in;
    self->typecode = bufinfo.typecode;
    self->free = 0;
    self->len = bufinfo.len / mp_binary_get_size('@', bufinfo.typecode, NULL); // element len
    self->items = bufinfo.buf;

    // test if the object can be written to
    if (mp_get_buffer(args[0], &bufinfo, MP_BUFFER_RW)) {
        self->free = 1; // used to indicate writable buffer
    }

    return self;
}
#endif
196

197
STATIC mp_obj_t array_unary_op(mp_uint_t op, mp_obj_t o_in) {
198
199
    mp_obj_array_t *o = o_in;
    switch (op) {
Damien George's avatar
Damien George committed
200
201
        case MP_UNARY_OP_BOOL: return MP_BOOL(o->len != 0);
        case MP_UNARY_OP_LEN: return MP_OBJ_NEW_SMALL_INT(o->len);
202
        default: return MP_OBJ_NULL; // op not supported
203
204
205
    }
}

206
STATIC mp_obj_t array_binary_op(mp_uint_t op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    switch (op) {
        case MP_BINARY_OP_EQUAL: {
            mp_buffer_info_t lhs_bufinfo;
            mp_buffer_info_t rhs_bufinfo;
            array_get_buffer(lhs_in, &lhs_bufinfo, MP_BUFFER_READ);
            if (!mp_get_buffer(rhs_in, &rhs_bufinfo, MP_BUFFER_READ)) {
                    return mp_const_false;
            }
            return MP_BOOL(mp_seq_cmp_bytes(op, lhs_bufinfo.buf, lhs_bufinfo.len, rhs_bufinfo.buf, rhs_bufinfo.len));
        }
        default:
            return MP_OBJ_NULL; // op not supported
    }
}

222
STATIC mp_obj_t array_append(mp_obj_t self_in, mp_obj_t arg) {
223
    assert(MP_OBJ_IS_TYPE(self_in, &mp_type_array) || MP_OBJ_IS_TYPE(self_in, &mp_type_bytearray));
224
225
    mp_obj_array_t *self = self_in;
    if (self->free == 0) {
226
        int item_sz = mp_binary_get_size('@', self->typecode, NULL);
227
228
229
        // TODO: alloc policy
        self->free = 8;
        self->items = m_realloc(self->items,  item_sz * self->len, item_sz * (self->len + self->free));
230
        mp_seq_clear(self->items, self->len + 1, self->len + self->free, item_sz);
231
    }
232
    mp_binary_set_val_array(self->typecode, self->items, self->len++, arg);
233
234
235
    self->free--;
    return mp_const_none; // return None, as per CPython
}
236
STATIC MP_DEFINE_CONST_FUN_OBJ_2(array_append_obj, array_append);
237

238
STATIC mp_obj_t array_subscr(mp_obj_t self_in, mp_obj_t index_in, mp_obj_t value) {
239
    if (value == MP_OBJ_NULL) {
240
241
        // delete item
        // TODO implement
242
243
        // TODO: confirmed that both bytearray and array.array support
        // slice deletion
244
        return MP_OBJ_NULL; // op not supported
245
246
    } else {
        mp_obj_array_t *o = self_in;
247
248
249
        if (0) {
#if MICROPY_PY_BUILTINS_SLICE
        } else if (MP_OBJ_IS_TYPE(index_in, &mp_type_slice)) {
250
251
252
253
            if (value != MP_OBJ_SENTINEL) {
                // Only getting a slice is suported so far, not assignment
                // TODO: confirmed that both bytearray and array.array support
                // slice assignment (incl. of different size)
254
                return MP_OBJ_NULL; // op not supported
255
            }
256
257
            mp_bound_slice_t slice;
            if (!mp_seq_get_fast_slice_indexes(o->len, index_in, &slice)) {
258
                nlr_raise(mp_obj_new_exception_msg(&mp_type_NotImplementedError,
259
                    "only slices with step=1 (aka None) are supported"));
260
            }
261
            mp_obj_array_t *res;
262
263
            int sz = mp_binary_get_size('@', o->typecode, NULL);
            assert(sz > 0);
264
265
266
267
268
269
270
271
272
273
274
275
276
            if (0) {
                // dummy
            #if MICROPY_PY_BUILTINS_MEMORYVIEW
            } else if (o->base.type == &mp_type_memoryview) {
                res = m_new_obj(mp_obj_array_t);
                *res = *o;
                res->len = slice.stop - slice.start;
                res->items += slice.start * sz;
            #endif
            } else {
                res = array_new(o->typecode, slice.stop - slice.start);
                memcpy(res->items, o->items + slice.start * sz, (slice.stop - slice.start) * sz);
            }
277
            return res;
278
#endif
279
        } else {
280
            mp_uint_t index = mp_get_index(o->base.type, o->len, index_in, false);
281
282
283
284
285
            if (value == MP_OBJ_SENTINEL) {
                // load
                return mp_binary_get_val_array(o->typecode, o->items, index);
            } else {
                // store
286
287
288
289
290
291
                #if MICROPY_PY_BUILTINS_MEMORYVIEW
                if (o->base.type == &mp_type_memoryview && o->free == 0) {
                    // read-only memoryview
                    return MP_OBJ_NULL;
                }
                #endif
292
293
294
                mp_binary_set_val_array(o->typecode, o->items, index, value);
                return mp_const_none;
            }
295
        }
296
    }
297
298
}

299
STATIC mp_int_t array_get_buffer(mp_obj_t o_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
300
    mp_obj_array_t *o = o_in;
301
302
303
304
305
306
    #if MICROPY_PY_BUILTINS_MEMORYVIEW
    if (o->base.type == &mp_type_memoryview && o->free == 0 && (flags & MP_BUFFER_WRITE)) {
        // read-only memoryview
        return 1;
    }
    #endif
307
    bufinfo->buf = o->items;
308
    bufinfo->len = o->len * mp_binary_get_size('@', o->typecode, NULL);
309
    bufinfo->typecode = o->typecode;
310
311
312
    return 0;
}

313
#if MICROPY_PY_BUILTINS_BYTEARRAY || MICROPY_PY_ARRAY
314
315
STATIC const mp_map_elem_t array_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_append), (mp_obj_t)&array_append_obj },
316
317
};

318
STATIC MP_DEFINE_CONST_DICT(array_locals_dict, array_locals_dict_table);
319
#endif
320

321
#if MICROPY_PY_ARRAY
322
const mp_obj_type_t mp_type_array = {
323
    { &mp_type_type },
324
    .name = MP_QSTR_array,
325
326
    .print = array_print,
    .make_new = array_make_new,
Paul Sokolovsky's avatar
Paul Sokolovsky committed
327
    .getiter = array_iterator_new,
328
    .unary_op = array_unary_op,
329
    .binary_op = array_binary_op,
330
    .subscr = array_subscr,
331
    .buffer_p = { .get_buffer = array_get_buffer },
332
    .locals_dict = (mp_obj_t)&array_locals_dict,
333
};
334
#endif
335

336
#if MICROPY_PY_BUILTINS_BYTEARRAY
337
338
339
340
341
342
343
const mp_obj_type_t mp_type_bytearray = {
    { &mp_type_type },
    .name = MP_QSTR_bytearray,
    .print = array_print,
    .make_new = bytearray_make_new,
    .getiter = array_iterator_new,
    .unary_op = array_unary_op,
344
    .binary_op = array_binary_op,
345
    .subscr = array_subscr,
346
347
348
    .buffer_p = { .get_buffer = array_get_buffer },
    .locals_dict = (mp_obj_t)&array_locals_dict,
};
349
#endif
350

351
352
353
354
355
356
357
358
359
360
361
362
#if MICROPY_PY_BUILTINS_MEMORYVIEW
const mp_obj_type_t mp_type_memoryview = {
    { &mp_type_type },
    .name = MP_QSTR_memoryview,
    .make_new = memoryview_make_new,
    .getiter = array_iterator_new,
    .unary_op = array_unary_op,
    .binary_op = array_binary_op,
    .subscr = array_subscr,
    .buffer_p = { .get_buffer = array_get_buffer },
};
#endif
363

364
/* unused
365
mp_uint_t mp_obj_array_len(mp_obj_t self_in) {
366
367
    return ((mp_obj_array_t *)self_in)->len;
}
368
*/
369

370
#if MICROPY_PY_BUILTINS_BYTEARRAY
371
mp_obj_t mp_obj_new_bytearray(mp_uint_t n, void *items) {
372
373
374
375
    mp_obj_array_t *o = array_new(BYTEARRAY_TYPECODE, n);
    memcpy(o->items, items, n);
    return o;
}
Paul Sokolovsky's avatar
Paul Sokolovsky committed
376

377
// Create bytearray which references specified memory area
378
mp_obj_t mp_obj_new_bytearray_by_ref(mp_uint_t n, void *items) {
379
    mp_obj_array_t *o = m_new_obj(mp_obj_array_t);
380
    o->base.type = &mp_type_bytearray;
381
382
383
384
385
386
    o->typecode = BYTEARRAY_TYPECODE;
    o->free = 0;
    o->len = n;
    o->items = items;
    return o;
}
387
#endif
388

Paul Sokolovsky's avatar
Paul Sokolovsky committed
389
/******************************************************************************/
390
// array iterator
Paul Sokolovsky's avatar
Paul Sokolovsky committed
391
392
393
394

typedef struct _mp_obj_array_it_t {
    mp_obj_base_t base;
    mp_obj_array_t *array;
395
    mp_uint_t cur;
Paul Sokolovsky's avatar
Paul Sokolovsky committed
396
397
} mp_obj_array_it_t;

398
STATIC mp_obj_t array_it_iternext(mp_obj_t self_in) {
Paul Sokolovsky's avatar
Paul Sokolovsky committed
399
400
    mp_obj_array_it_t *self = self_in;
    if (self->cur < self->array->len) {
401
        return mp_binary_get_val_array(self->array->typecode, self->array->items, self->cur++);
Paul Sokolovsky's avatar
Paul Sokolovsky committed
402
    } else {
403
        return MP_OBJ_STOP_ITERATION;
Paul Sokolovsky's avatar
Paul Sokolovsky committed
404
405
406
    }
}

407
STATIC const mp_obj_type_t array_it_type = {
408
    { &mp_type_type },
409
    .name = MP_QSTR_iterator,
410
    .getiter = mp_identity,
Paul Sokolovsky's avatar
Paul Sokolovsky committed
411
412
413
    .iternext = array_it_iternext,
};

414
STATIC mp_obj_t array_iterator_new(mp_obj_t array_in) {
Paul Sokolovsky's avatar
Paul Sokolovsky committed
415
416
417
418
419
420
421
    mp_obj_array_t *array = array_in;
    mp_obj_array_it_t *o = m_new_obj(mp_obj_array_it_t);
    o->base.type = &array_it_type;
    o->array = array;
    o->cur = 0;
    return o;
}
422

423
#endif // MICROPY_PY_ARRAY || MICROPY_PY_BUILTINS_BYTEARRAY || MICROPY_PY_BUILTINS_MEMORYVIEW