From fcf8b804ed95a98561bd4c1d6c85604be0f7cc7b Mon Sep 17 00:00:00 2001
From: Stefan Kerkmann <karlk90@pm.me>
Date: Mon, 3 Apr 2023 10:33:45 +0200
Subject: [Core] Refactor `keyevent_t` for 1ms timing resolution (#15847)

---
 quantum/keyboard.h | 59 +++++++++++++++++++++++++++---------------------------
 1 file changed, 29 insertions(+), 30 deletions(-)

(limited to 'quantum/keyboard.h')

diff --git a/quantum/keyboard.h b/quantum/keyboard.h
index f82f2fa58a..bf1890d10b 100644
--- a/quantum/keyboard.h
+++ b/quantum/keyboard.h
@@ -30,65 +30,64 @@ typedef struct {
     uint8_t row;
 } keypos_t;
 
+typedef enum keyevent_type_t { TICK_EVENT = 0, KEY_EVENT = 1, ENCODER_CW_EVENT = 2, ENCODER_CCW_EVENT = 3, COMBO_EVENT = 4 } keyevent_type_t;
+
 /* key event */
 typedef struct {
-    keypos_t key;
-    bool     pressed;
-    uint16_t time;
+    keypos_t        key;
+    uint16_t        time;
+    keyevent_type_t type;
+    bool            pressed;
 } keyevent_t;
 
 /* equivalent test of keypos_t */
 #define KEYEQ(keya, keyb) ((keya).row == (keyb).row && (keya).col == (keyb).col)
 
 /* special keypos_t entries */
-#define KEYLOC_TICK 255
-#define KEYLOC_COMBO 254
 #define KEYLOC_ENCODER_CW 253
 #define KEYLOC_ENCODER_CCW 252
 
-/* Rules for No Event:
- * 1) (time == 0) to handle (keyevent_t){} as empty event
- * 2) Matrix(255, 255) to make TICK event available
- */
-static inline bool IS_NOEVENT(keyevent_t event) {
-    return event.time == 0 || (event.key.row == KEYLOC_TICK && event.key.col == KEYLOC_TICK);
-}
-static inline bool IS_EVENT(keyevent_t event) {
-    return !IS_NOEVENT(event);
-}
-static inline bool IS_KEYEVENT(keyevent_t event) {
-    return event.key.row < MATRIX_ROWS && event.key.col < MATRIX_COLS;
+static inline bool IS_NOEVENT(const keyevent_t event) {
+    return event.type == TICK_EVENT;
 }
-static inline bool IS_COMBOEVENT(keyevent_t event) {
-    return event.key.row == KEYLOC_COMBO;
+static inline bool IS_EVENT(const keyevent_t event) {
+    return event.type != TICK_EVENT;
 }
-static inline bool IS_ENCODEREVENT(keyevent_t event) {
-    return event.key.row == KEYLOC_ENCODER_CW || event.key.row == KEYLOC_ENCODER_CCW;
+static inline bool IS_KEYEVENT(const keyevent_t event) {
+    return event.type == KEY_EVENT;
 }
-static inline bool IS_PRESSED(keyevent_t event) {
-    return IS_EVENT(event) && event.pressed;
+static inline bool IS_COMBOEVENT(const keyevent_t event) {
+    return event.type == COMBO_EVENT;
 }
-static inline bool IS_RELEASED(keyevent_t event) {
-    return IS_EVENT(event) && !event.pressed;
+static inline bool IS_ENCODEREVENT(const keyevent_t event) {
+    return event.type == ENCODER_CW_EVENT || event.type == ENCODER_CCW_EVENT;
 }
 
-/* Common keyevent object factory */
+/* Common keypos_t object factory */
 #define MAKE_KEYPOS(row_num, col_num) ((keypos_t){.row = (row_num), .col = (col_num)})
 
+/* Common keyevent_t object factory */
+#define MAKE_EVENT(row_num, col_num, press, event_type) ((keyevent_t){.key = MAKE_KEYPOS((row_num), (col_num)), .pressed = (press), .time = timer_read(), .type = (event_type)})
+
 /**
  * @brief Constructs a key event for a pressed or released key.
  */
-#define MAKE_KEYEVENT(row_num, col_num, press) ((keyevent_t){.key = MAKE_KEYPOS((row_num), (col_num)), .pressed = (press), .time = (timer_read() | 1)})
+#define MAKE_KEYEVENT(row_num, col_num, press) MAKE_EVENT((row_num), (col_num), (press), KEY_EVENT)
+
+/**
+ * @brief Constructs a combo event.
+ */
+#define MAKE_COMBOEVENT(press) MAKE_EVENT(0, 0, (press), COMBO_EVENT)
 
 /**
  * @brief Constructs a internal tick event that is used to drive the internal QMK state machine.
  */
-#define TICK_EVENT MAKE_KEYEVENT(KEYLOC_TICK, KEYLOC_TICK, false)
+#define MAKE_TICK_EVENT MAKE_EVENT(0, 0, false, TICK_EVENT)
 
 #ifdef ENCODER_MAP_ENABLE
 /* Encoder events */
-#    define ENCODER_CW_EVENT(enc_id, press) MAKE_KEYEVENT(KEYLOC_ENCODER_CW, (enc_id), (press))
-#    define ENCODER_CCW_EVENT(enc_id, press) MAKE_KEYEVENT(KEYLOC_ENCODER_CCW, (enc_id), (press))
+#    define MAKE_ENCODER_CW_EVENT(enc_id, press) MAKE_EVENT(KEYLOC_ENCODER_CW, (enc_id), (press), ENCODER_CW_EVENT)
+#    define MAKE_ENCODER_CCW_EVENT(enc_id, press) MAKE_EVENT(KEYLOC_ENCODER_CCW, (enc_id), (press), ENCODER_CCW_EVENT)
 #endif // ENCODER_MAP_ENABLE
 
 /* it runs once at early stage of startup before keyboard_init. */
-- 
cgit v1.2.3