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 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 #ifndef MICROPY_INCLUDED_PY_OBJARRAY_H
28 #define MICROPY_INCLUDED_PY_OBJARRAY_H
29
30 #include "py/obj.h"
31
32 // Used only for memoryview types, set in "typecode" to indicate a writable memoryview
33 #define MP_OBJ_ARRAY_TYPECODE_FLAG_RW (0x80)
34
35 // This structure is used for all of bytearray, array.array, memoryview
36 // objects. Note that memoryview has different meaning for some fields,
37 // see comment at the beginning of objarray.c.
38 typedef struct _mp_obj_array_t {
39 mp_obj_base_t base;
40 size_t typecode : 8;
41 // free is number of unused elements after len used elements
42 // alloc size = len + free
43 // But for memoryview, 'free' is reused as offset (in elements) into the
44 // parent object. (Union is not used to not go into a complication of
45 // union-of-bitfields with different toolchains). See comments in
46 // objarray.c.
47 size_t free : (8 * sizeof(size_t) - 8);
48 size_t len; // in elements
49 void *items;
50 } mp_obj_array_t;
51
52 #if MICROPY_PY_BUILTINS_MEMORYVIEW
mp_obj_memoryview_init(mp_obj_array_t * self,size_t typecode,size_t offset,size_t len,void * items)53 static inline void mp_obj_memoryview_init(mp_obj_array_t *self, size_t typecode, size_t offset, size_t len, void *items) {
54 self->base.type = &mp_type_memoryview;
55 self->typecode = typecode;
56 self->free = offset;
57 self->len = len;
58 self->items = items;
59 }
60 #endif
61
62 #endif // MICROPY_INCLUDED_PY_OBJARRAY_H
63