Merge pull request #10184 from dhalbert/keypad-length-fix

dhalbert · web-flow · commit c27e0da5a8ee · 2025-03-26T10:22:25.000-04:00
Fix keypad EventQueue len(); improve doc
diff --git a/shared-bindings/keypad/EventQueue.c b/shared-bindings/keypad/EventQueue.c
@@ -23,7 +23,8 @@
 //|
 
 //|     def get(self) -> Optional[Event]:
-//|         """Return the next key transition event. Return ``None`` if no events are pending.
+//|         """Remove the next key transition event from the `EventQueue` and return it.
+//|         Return ``None`` if no events are pending.
 //|
 //|         Note that the queue size is limited; see ``max_events`` in the constructor of
 //|         a scanner such as `Keys` or `KeyMatrix`.
@@ -43,7 +44,7 @@ static mp_obj_t keypad_eventqueue_get(mp_obj_t self_in) {
 MP_DEFINE_CONST_FUN_OBJ_1(keypad_eventqueue_get_obj, keypad_eventqueue_get);
 
 //|     def get_into(self, event: Event) -> bool:
-//|         """Store the next key transition event in the supplied event, if available,
+//|         """Remove the next key transition event from the ``EventQueue`, store it in ``event``,
 //|         and return ``True``.
 //|         If there are no queued events, do not touch ``event`` and return ``False``.
 //|
diff --git a/shared-module/keypad/EventQueue.c b/shared-module/keypad/EventQueue.c
@@ -13,9 +13,11 @@
 #define EVENT_PRESSED (1 << 15)
 #define EVENT_KEY_NUM_MASK ((1 << 15) - 1)
 
+#define EVENT_SIZE_BYTES (sizeof(uint16_t) + sizeof(mp_obj_t))
+
 void common_hal_keypad_eventqueue_construct(keypad_eventqueue_obj_t *self, size_t max_events) {
     // Event queue is 16-bit values.
-    ringbuf_alloc(&self->encoded_events, max_events * (sizeof(uint16_t) + sizeof(mp_obj_t)));
+    ringbuf_alloc(&self->encoded_events, max_events * EVENT_SIZE_BYTES);
     self->overflowed = false;
     self->event_handler = NULL;
 }
@@ -63,7 +65,7 @@ void common_hal_keypad_eventqueue_clear(keypad_eventqueue_obj_t *self) {
 }
 
 size_t common_hal_keypad_eventqueue_get_length(keypad_eventqueue_obj_t *self) {
-    return ringbuf_num_filled(&self->encoded_events);
+    return ringbuf_num_filled(&self->encoded_events) / EVENT_SIZE_BYTES;
 }
 
 void common_hal_keypad_eventqueue_set_event_handler(keypad_eventqueue_obj_t *self, void (*event_handler)(keypad_eventqueue_obj_t *)) {

Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,11 @@`
`13`	`13`	`#define EVENT_PRESSED (1 << 15)`
`14`	`14`	`#define EVENT_KEY_NUM_MASK ((1 << 15) - 1)`
`15`	`15`
	`16`	`+#define EVENT_SIZE_BYTES (sizeof(uint16_t) + sizeof(mp_obj_t))`
	`17`	`+`
`16`	`18`	`void common_hal_keypad_eventqueue_construct(keypad_eventqueue_obj_t *self, size_t max_events) {`
`17`	`19`	`// Event queue is 16-bit values.`
`18`		`- ringbuf_alloc(&self->encoded_events, max_events * (sizeof(uint16_t) + sizeof(mp_obj_t)));`
	`20`	`+ ringbuf_alloc(&self->encoded_events, max_events * EVENT_SIZE_BYTES);`
`19`	`21`	`self->overflowed = false;`
`20`	`22`	`self->event_handler = NULL;`
`21`	`23`	`}`
`@@ -63,7 +65,7 @@ void common_hal_keypad_eventqueue_clear(keypad_eventqueue_obj_t *self) {`
`63`	`65`	`}`
`64`	`66`
`65`	`67`	`size_t common_hal_keypad_eventqueue_get_length(keypad_eventqueue_obj_t *self) {`
`66`		`- return ringbuf_num_filled(&self->encoded_events);`
	`68`	`+ return ringbuf_num_filled(&self->encoded_events) / EVENT_SIZE_BYTES;`
`67`	`69`	`}`
`68`	`70`
`69`	`71`	`void common_hal_keypad_eventqueue_set_event_handler(keypad_eventqueue_obj_t self, void (event_handler)(keypad_eventqueue_obj_t *)) {`