Merge pull request #4233 from pewpew-game/displayio-group-list

displayio: make Group use a python list internally

Author: tannewt

ports/atmel-samd/boards/ugame10/mpconfigboard.mk

@@ -18,6 +18,7 @@ CIRCUITPY_ANALOGIO = 1
 CIRCUITPY_GAMEPAD = 1
 CIRCUITPY_DISPLAYIO = 1
 
+CIRCUITPY_PULSEIO = 0
 CIRCUITPY_AUDIOBUSIO = 0
 CIRCUITPY_BITBANGIO = 0
 CIRCUITPY_BITMAPTOOLS = 0

py/objlist.c

@@ -270,13 +270,10 @@ STATIC mp_obj_t list_extend(mp_obj_t self_in, mp_obj_t arg_in) {
     return mp_const_none; // return None, as per CPython
 }
 
-STATIC mp_obj_t list_pop(size_t n_args, const mp_obj_t *args) {
-    mp_check_self(MP_OBJ_IS_TYPE(args[0], &mp_type_list));
-    mp_obj_list_t *self = mp_instance_cast_to_native_base(args[0], &mp_type_list);
+inline mp_obj_t mp_obj_list_pop(mp_obj_list_t *self, size_t index) {
     if (self->len == 0) {
         mp_raise_IndexError_varg(translate("pop from empty %q"), MP_QSTR_list);
     }
-    size_t index = mp_get_index(self->base.type, self->len, n_args == 1 ? MP_OBJ_NEW_SMALL_INT(-1) : args[1], false);
     mp_obj_t ret = self->items[index];
     self->len -= 1;
     memmove(self->items + index, self->items + index + 1, (self->len - index) * sizeof(mp_obj_t));
@@ -289,6 +286,13 @@ STATIC mp_obj_t list_pop(size_t n_args, const mp_obj_t *args) {
     return ret;
 }
 
+STATIC mp_obj_t list_pop(size_t n_args, const mp_obj_t *args) {
+    mp_check_self(MP_OBJ_IS_TYPE(args[0], &mp_type_list));
+    mp_obj_list_t *self = mp_instance_cast_to_native_base(args[0], &mp_type_list);
+    size_t index = mp_get_index(self->base.type, self->len, n_args == 1 ? MP_OBJ_NEW_SMALL_INT(-1) : args[1], false);
+    return mp_obj_list_pop(self, index);
+}
+
 STATIC void mp_quicksort(mp_obj_t *head, mp_obj_t *tail, mp_obj_t key_fn, mp_obj_t binop_less_result) {
     MP_STACK_CHECK();
     while (head < tail) {
@@ -371,6 +375,15 @@ STATIC mp_obj_t list_index(size_t n_args, const mp_obj_t *args) {
     return mp_seq_index_obj(self->items, self->len, n_args, args);
 }
 
+inline void mp_obj_list_insert(mp_obj_list_t *self, size_t index, mp_obj_t obj) {
+    mp_obj_list_append(MP_OBJ_FROM_PTR(self), mp_const_none);
+
+    for (size_t i = self->len - 1; i > index; --i) {
+         self->items[i] = self->items[i - 1];
+    }
+    self->items[index] = obj;
+}
+
 STATIC mp_obj_t list_insert(mp_obj_t self_in, mp_obj_t idx, mp_obj_t obj) {
     mp_check_self(MP_OBJ_IS_TYPE(self_in, &mp_type_list));
     mp_obj_list_t *self = mp_instance_cast_to_native_base(self_in, &mp_type_list);
@@ -385,14 +398,7 @@ STATIC mp_obj_t list_insert(mp_obj_t self_in, mp_obj_t idx, mp_obj_t obj) {
     if ((size_t)index > self->len) {
          index = self->len;
     }
-
-    mp_obj_list_append(self_in, mp_const_none);
-
-    for (mp_int_t i = self->len-1; i > index; i--) {
-         self->items[i] = self->items[i-1];
-    }
-    self->items[index] = obj;
-
+    mp_obj_list_insert(self, index, obj);
     return mp_const_none;
 }
 

py/objlist.h

@@ -36,5 +36,7 @@ typedef struct _mp_obj_list_t {
 } mp_obj_list_t;
 
 void mp_obj_list_init(mp_obj_list_t *o, size_t n);
+mp_obj_t mp_obj_list_pop(mp_obj_list_t *self, size_t index);
+void mp_obj_list_insert(mp_obj_list_t *self, size_t index, mp_obj_t obj);
 
 #endif // MICROPY_INCLUDED_PY_OBJLIST_H

shared-bindings/displayio/Group.c

@@ -42,7 +42,7 @@
 //|         """Create a Group of a given size and scale. Scale is in one dimension. For example, scale=2
 //|         leads to a layer's pixel being 2x2 pixels when in the group.
 //|
-//|         :param int max_size: The maximum group size.
+//|         :param int max_size: Ignored. Will be removed in 7.x.
 //|         :param int scale: Scale of layer pixels in one dimension.
 //|         :param int x: Initial x position within the parent.
 //|         :param int y: Initial y position within the parent."""
@@ -59,19 +59,14 @@ STATIC mp_obj_t displayio_group_make_new(const mp_obj_type_t *type, size_t n_arg
     mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
     mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
 
-    mp_int_t max_size = args[ARG_max_size].u_int;
-    if (max_size < 1) {
-        mp_raise_ValueError_varg(translate("%q must be >= 1"), MP_QSTR_max_size);
-    }
-
     mp_int_t scale = args[ARG_scale].u_int;
     if (scale < 1) {
         mp_raise_ValueError_varg(translate("%q must be >= 1"), MP_QSTR_scale);
     }
 
     displayio_group_t *self = m_new_obj(displayio_group_t);
     self->base.type = &displayio_group_type;
-    common_hal_displayio_group_construct(self, max_size, scale, args[ARG_x].u_int, args[ARG_y].u_int);
+    common_hal_displayio_group_construct(self, scale, args[ARG_x].u_int, args[ARG_y].u_int);
 
     return MP_OBJ_FROM_PTR(self);
 }
@@ -328,6 +323,21 @@ STATIC mp_obj_t group_subscr(mp_obj_t self_in, mp_obj_t index_obj, mp_obj_t valu
     return mp_const_none;
 }
 
+//|     def sort(self, key: function, reverse: bool) -> None:
+//|         """Sort the members of the group."""
+//|         ...
+//|
+STATIC mp_obj_t displayio_group_obj_sort(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    displayio_group_t *self = native_group(pos_args[0]);
+    mp_obj_t *args = m_new(mp_obj_t, n_args);
+    for (size_t i = 1; i < n_args; ++i) {
+        args[i] = pos_args[i];
+    }
+    args[0] = MP_OBJ_FROM_PTR(self->members);
+    return mp_obj_list_sort(n_args, pos_args, kw_args);
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(displayio_group_sort_obj, 1, displayio_group_obj_sort);
+
 STATIC const mp_rom_map_elem_t displayio_group_locals_dict_table[] = {
     { MP_ROM_QSTR(MP_QSTR_hidden), MP_ROM_PTR(&displayio_group_hidden_obj) },
     { MP_ROM_QSTR(MP_QSTR_scale), MP_ROM_PTR(&displayio_group_scale_obj) },
@@ -338,6 +348,7 @@ STATIC const mp_rom_map_elem_t displayio_group_locals_dict_table[] = {
     { MP_ROM_QSTR(MP_QSTR_index), MP_ROM_PTR(&displayio_group_index_obj) },
     { MP_ROM_QSTR(MP_QSTR_pop), MP_ROM_PTR(&displayio_group_pop_obj) },
     { MP_ROM_QSTR(MP_QSTR_remove), MP_ROM_PTR(&displayio_group_remove_obj) },
+    { MP_ROM_QSTR(MP_QSTR_sort), MP_ROM_PTR(&displayio_group_sort_obj) },
 };
 STATIC MP_DEFINE_CONST_DICT(displayio_group_locals_dict, displayio_group_locals_dict_table);
 

shared-bindings/displayio/Group.h

@@ -33,7 +33,7 @@ extern const mp_obj_type_t displayio_group_type;
 
 displayio_group_t* native_group(mp_obj_t group_obj);
 
-void common_hal_displayio_group_construct(displayio_group_t* self, uint32_t max_size, uint32_t scale, mp_int_t x, mp_int_t y);
+void common_hal_displayio_group_construct(displayio_group_t* self, uint32_t scale, mp_int_t x, mp_int_t y);
 uint32_t common_hal_displayio_group_get_scale(displayio_group_t* self);
 void common_hal_displayio_group_set_scale(displayio_group_t* self, uint32_t scale);
 bool common_hal_displayio_group_get_hidden(displayio_group_t* self);