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 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                 :            : // Bit size used for mp_obj_array_t.free member.
      36                 :            : #define MP_OBJ_ARRAY_FREE_SIZE_BITS (8 * sizeof(size_t) - 8)
      37                 :            : 
      38                 :            : // This structure is used for all of bytearray, array.array, memoryview
      39                 :            : // objects.  Note that memoryview has different meaning for some fields,
      40                 :            : // see comment at the beginning of objarray.c.
      41                 :            : typedef struct _mp_obj_array_t {
      42                 :            :     mp_obj_base_t base;
      43                 :            :     size_t typecode : 8;
      44                 :            :     // free is number of unused elements after len used elements
      45                 :            :     // alloc size = len + free
      46                 :            :     // But for memoryview, 'free' is reused as offset (in elements) into the
      47                 :            :     // parent object. (Union is not used to not go into a complication of
      48                 :            :     // union-of-bitfields with different toolchains). See comments in
      49                 :            :     // objarray.c.
      50                 :            :     size_t free : MP_OBJ_ARRAY_FREE_SIZE_BITS;
      51                 :            :     size_t len; // in elements
      52                 :            :     void *items;
      53                 :            : } mp_obj_array_t;
      54                 :            : 
      55                 :            : #if MICROPY_PY_BUILTINS_MEMORYVIEW
      56                 :        664 : static inline void mp_obj_memoryview_init(mp_obj_array_t *self, size_t typecode, size_t offset, size_t len, void *items) {
      57                 :        664 :     self->base.type = &mp_type_memoryview;
      58                 :        664 :     self->typecode = typecode;
      59                 :        664 :     self->free = offset;
      60                 :        664 :     self->len = len;
      61                 :        664 :     self->items = items;
      62                 :            : }
      63                 :            : #endif
      64                 :            : 
      65                 :            : #if MICROPY_PY_ARRAY || MICROPY_PY_BUILTINS_BYTEARRAY
      66                 :            : MP_DECLARE_CONST_FUN_OBJ_2(mp_obj_array_append_obj);
      67                 :            : MP_DECLARE_CONST_FUN_OBJ_2(mp_obj_array_extend_obj);
      68                 :            : #endif
      69                 :            : 
      70                 :            : #endif // MICROPY_INCLUDED_PY_OBJARRAY_H