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) 2018 Paul Sokolovsky
7 : : *
8 : : * Permission is hereby granted, free of charge, to any person obtaining a copy
9 : : * of this software and associated documentation files (the "Software"), to deal
10 : : * in the Software without restriction, including without limitation the rights
11 : : * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 : : * copies of the Software, and to permit persons to whom the Software is
13 : : * furnished to do so, subject to the following conditions:
14 : : *
15 : : * The above copyright notice and this permission notice shall be included in
16 : : * all copies or substantial portions of the Software.
17 : : *
18 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 : : * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 : : * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 : : * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 : : * THE SOFTWARE.
25 : : */
26 : :
27 : : #include <unistd.h> // for ssize_t
28 : : #include <string.h>
29 : :
30 : : #include "py/mpconfig.h"
31 : : #if MICROPY_PY_COLLECTIONS_DEQUE
32 : :
33 : : #include "py/runtime.h"
34 : :
35 : : typedef struct _mp_obj_deque_t {
36 : : mp_obj_base_t base;
37 : : size_t alloc;
38 : : size_t i_get;
39 : : size_t i_put;
40 : : mp_obj_t *items;
41 : : uint32_t flags;
42 : : #define FLAG_CHECK_OVERFLOW 1
43 : : } mp_obj_deque_t;
44 : :
45 : 32 : STATIC mp_obj_t deque_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
46 : 32 : mp_arg_check_num(n_args, n_kw, 2, 3, false);
47 : :
48 : : /* Initialization from existing sequence is not supported, so an empty
49 : : tuple must be passed as such. */
50 [ + + ]: 28 : if (args[0] != mp_const_empty_tuple) {
51 : 8 : mp_raise_ValueError(NULL);
52 : : }
53 : :
54 : : // Protect against -1 leading to zero-length allocation and bad array access
55 : 20 : mp_int_t maxlen = mp_obj_get_int(args[1]);
56 [ + + ]: 20 : if (maxlen < 0) {
57 : 4 : mp_raise_ValueError(NULL);
58 : : }
59 : :
60 : 16 : mp_obj_deque_t *o = mp_obj_malloc(mp_obj_deque_t, type);
61 : 16 : o->alloc = maxlen + 1;
62 : 16 : o->i_get = o->i_put = 0;
63 : 16 : o->items = m_new0(mp_obj_t, o->alloc);
64 : :
65 [ + + ]: 16 : if (n_args > 2) {
66 : 4 : o->flags = mp_obj_get_int(args[2]);
67 : : }
68 : :
69 : 16 : return MP_OBJ_FROM_PTR(o);
70 : : }
71 : :
72 : 52 : STATIC mp_obj_t deque_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
73 : 52 : mp_obj_deque_t *self = MP_OBJ_TO_PTR(self_in);
74 [ + + + + ]: 52 : switch (op) {
75 : 8 : case MP_UNARY_OP_BOOL:
76 [ + + ]: 8 : return mp_obj_new_bool(self->i_get != self->i_put);
77 : 36 : case MP_UNARY_OP_LEN: {
78 : 36 : ssize_t len = self->i_put - self->i_get;
79 [ + + ]: 36 : if (len < 0) {
80 : 16 : len += self->alloc;
81 : : }
82 : 36 : return MP_OBJ_NEW_SMALL_INT(len);
83 : : }
84 : : #if MICROPY_PY_SYS_GETSIZEOF
85 : 4 : case MP_UNARY_OP_SIZEOF: {
86 : 4 : size_t sz = sizeof(*self) + sizeof(mp_obj_t) * self->alloc;
87 : 4 : return MP_OBJ_NEW_SMALL_INT(sz);
88 : : }
89 : : #endif
90 : : default:
91 : : return MP_OBJ_NULL; // op not supported
92 : : }
93 : : }
94 : :
95 : 76 : STATIC mp_obj_t mp_obj_deque_append(mp_obj_t self_in, mp_obj_t arg) {
96 : 76 : mp_obj_deque_t *self = MP_OBJ_TO_PTR(self_in);
97 : :
98 : 76 : size_t new_i_put = self->i_put + 1;
99 [ + + ]: 76 : if (new_i_put == self->alloc) {
100 : 20 : new_i_put = 0;
101 : : }
102 : :
103 [ + + + + ]: 76 : if (self->flags & FLAG_CHECK_OVERFLOW && new_i_put == self->i_get) {
104 : 4 : mp_raise_msg(&mp_type_IndexError, MP_ERROR_TEXT("full"));
105 : : }
106 : :
107 : 72 : self->items[self->i_put] = arg;
108 : 72 : self->i_put = new_i_put;
109 : :
110 [ + + ]: 72 : if (self->i_get == new_i_put) {
111 [ + + ]: 16 : if (++self->i_get == self->alloc) {
112 : 4 : self->i_get = 0;
113 : : }
114 : : }
115 : :
116 : 72 : return mp_const_none;
117 : : }
118 : : STATIC MP_DEFINE_CONST_FUN_OBJ_2(deque_append_obj, mp_obj_deque_append);
119 : :
120 : 80 : STATIC mp_obj_t deque_popleft(mp_obj_t self_in) {
121 : 80 : mp_obj_deque_t *self = MP_OBJ_TO_PTR(self_in);
122 : :
123 [ + + ]: 80 : if (self->i_get == self->i_put) {
124 : 24 : mp_raise_msg(&mp_type_IndexError, MP_ERROR_TEXT("empty"));
125 : : }
126 : :
127 : 56 : mp_obj_t ret = self->items[self->i_get];
128 : 56 : self->items[self->i_get] = MP_OBJ_NULL;
129 : :
130 [ + + ]: 56 : if (++self->i_get == self->alloc) {
131 : 16 : self->i_get = 0;
132 : : }
133 : :
134 : 56 : return ret;
135 : : }
136 : : STATIC MP_DEFINE_CONST_FUN_OBJ_1(deque_popleft_obj, deque_popleft);
137 : :
138 : : #if 0
139 : : STATIC mp_obj_t deque_clear(mp_obj_t self_in) {
140 : : mp_obj_deque_t *self = MP_OBJ_TO_PTR(self_in);
141 : : self->i_get = self->i_put = 0;
142 : : mp_seq_clear(self->items, 0, self->alloc, sizeof(*self->items));
143 : : return mp_const_none;
144 : : }
145 : : STATIC MP_DEFINE_CONST_FUN_OBJ_1(deque_clear_obj, deque_clear);
146 : : #endif
147 : :
148 : : STATIC const mp_rom_map_elem_t deque_locals_dict_table[] = {
149 : : { MP_ROM_QSTR(MP_QSTR_append), MP_ROM_PTR(&deque_append_obj) },
150 : : #if 0
151 : : { MP_ROM_QSTR(MP_QSTR_clear), MP_ROM_PTR(&deque_clear_obj) },
152 : : #endif
153 : : { MP_ROM_QSTR(MP_QSTR_popleft), MP_ROM_PTR(&deque_popleft_obj) },
154 : : };
155 : :
156 : : STATIC MP_DEFINE_CONST_DICT(deque_locals_dict, deque_locals_dict_table);
157 : :
158 : : MP_DEFINE_CONST_OBJ_TYPE(
159 : : mp_type_deque,
160 : : MP_QSTR_deque,
161 : : MP_TYPE_FLAG_NONE,
162 : : make_new, deque_make_new,
163 : : unary_op, deque_unary_op,
164 : : locals_dict, &deque_locals_dict
165 : : );
166 : :
167 : : #endif // MICROPY_PY_COLLECTIONS_DEQUE
|