Normalise Joystick and Programmable Button keycodes (#18832)

4 files changed, 204 insertions, 105 deletions

diff --git a/quantum/process_keycode/process_joystick.c b/quantum/process_keycode/process_joystick.c
index af69d3aa05..c4c6fb59a8 100644
--- a/quantum/process_keycode/process_joystick.c
+++ b/quantum/process_keycode/process_joystick.c
@@ -19,11 +19,11 @@
 
 bool process_joystick(uint16_t keycode, keyrecord_t *record) {
     switch (keycode) {
-        case JS_BUTTON0 ... JS_BUTTON_MAX:
+        case QK_JOYSTICK_BUTTON_MIN ... QK_JOYSTICK_BUTTON_MAX:
             if (record->event.pressed) {
-                register_joystick_button(keycode - JS_BUTTON0);
+                register_joystick_button(keycode - QK_JOYSTICK_BUTTON_MIN);
             } else {
-                unregister_joystick_button(keycode - JS_BUTTON0);
+                unregister_joystick_button(keycode - QK_JOYSTICK_BUTTON_MIN);
             }
             return false;
     }
diff --git a/quantum/process_keycode/process_programmable_button.c b/quantum/process_keycode/process_programmable_button.c
index 6379698848..d6a14e120c 100644
--- a/quantum/process_keycode/process_programmable_button.c
+++ b/quantum/process_keycode/process_programmable_button.c
@@ -19,8 +19,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "programmable_button.h"
 
 bool process_programmable_button(uint16_t keycode, keyrecord_t *record) {
-    if (keycode >= PROGRAMMABLE_BUTTON_MIN && keycode <= PROGRAMMABLE_BUTTON_MAX) {
-        uint8_t button = keycode - PROGRAMMABLE_BUTTON_MIN + 1;
+    if (keycode >= QK_PROGRAMMABLE_BUTTON_MIN && keycode <= QK_PROGRAMMABLE_BUTTON_MAX) {
+        uint8_t button = keycode - QK_PROGRAMMABLE_BUTTON_MIN + 1;
         if (record->event.pressed) {
             programmable_button_register(button);
         } else {
diff --git a/quantum/quantum_keycodes.h b/quantum/quantum_keycodes.h
index 44702a362d..ac3968895b 100644
--- a/quantum/quantum_keycodes.h
+++ b/quantum/quantum_keycodes.h
@@ -431,38 +431,38 @@ enum quantum_keycodes {
     DYN_MACRO_PLAY2, // 5D08
 
     // Joystick
-    JS_BUTTON0,  // 5D09
-    JS_BUTTON1,  // 5D0A
-    JS_BUTTON2,  // 5D0B
-    JS_BUTTON3,  // 5D0C
-    JS_BUTTON4,  // 5D0D
-    JS_BUTTON5,  // 5D0E
-    JS_BUTTON6,  // 5D0F
-    JS_BUTTON7,  // 5D10
-    JS_BUTTON8,  // 5D11
-    JS_BUTTON9,  // 5D12
-    JS_BUTTON10, // 5D13
-    JS_BUTTON11, // 5D14
-    JS_BUTTON12, // 5D15
-    JS_BUTTON13, // 5D16
-    JS_BUTTON14, // 5D17
-    JS_BUTTON15, // 5D18
-    JS_BUTTON16, // 5D19
-    JS_BUTTON17, // 5D1A
-    JS_BUTTON18, // 5D1B
-    JS_BUTTON19, // 5D1C
-    JS_BUTTON20, // 5D1D
-    JS_BUTTON21, // 5D1E
-    JS_BUTTON22, // 5D1F
-    JS_BUTTON23, // 5D20
-    JS_BUTTON24, // 5D21
-    JS_BUTTON25, // 5D22
-    JS_BUTTON26, // 5D23
-    JS_BUTTON27, // 5D24
-    JS_BUTTON28, // 5D25
-    JS_BUTTON29, // 5D26
-    JS_BUTTON30, // 5D27
-    JS_BUTTON31, // 5D28
+    QK_JOYSTICK_BUTTON_0,  // 5D09
+    QK_JOYSTICK_BUTTON_1,  // 5D0A
+    QK_JOYSTICK_BUTTON_2,  // 5D0B
+    QK_JOYSTICK_BUTTON_3,  // 5D0C
+    QK_JOYSTICK_BUTTON_4,  // 5D0D
+    QK_JOYSTICK_BUTTON_5,  // 5D0E
+    QK_JOYSTICK_BUTTON_6,  // 5D0F
+    QK_JOYSTICK_BUTTON_7,  // 5D10
+    QK_JOYSTICK_BUTTON_8,  // 5D11
+    QK_JOYSTICK_BUTTON_9,  // 5D12
+    QK_JOYSTICK_BUTTON_10, // 5D13
+    QK_JOYSTICK_BUTTON_11, // 5D14
+    QK_JOYSTICK_BUTTON_12, // 5D15
+    QK_JOYSTICK_BUTTON_13, // 5D16
+    QK_JOYSTICK_BUTTON_14, // 5D17
+    QK_JOYSTICK_BUTTON_15, // 5D18
+    QK_JOYSTICK_BUTTON_16, // 5D19
+    QK_JOYSTICK_BUTTON_17, // 5D1A
+    QK_JOYSTICK_BUTTON_18, // 5D1B
+    QK_JOYSTICK_BUTTON_19, // 5D1C
+    QK_JOYSTICK_BUTTON_20, // 5D1D
+    QK_JOYSTICK_BUTTON_21, // 5D1E
+    QK_JOYSTICK_BUTTON_22, // 5D1F
+    QK_JOYSTICK_BUTTON_23, // 5D20
+    QK_JOYSTICK_BUTTON_24, // 5D21
+    QK_JOYSTICK_BUTTON_25, // 5D22
+    QK_JOYSTICK_BUTTON_26, // 5D23
+    QK_JOYSTICK_BUTTON_27, // 5D24
+    QK_JOYSTICK_BUTTON_28, // 5D25
+    QK_JOYSTICK_BUTTON_29, // 5D26
+    QK_JOYSTICK_BUTTON_30, // 5D27
+    QK_JOYSTICK_BUTTON_31, // 5D28
 
     // Leader Key
     QK_LEADER, // 5D29
@@ -526,38 +526,38 @@ enum quantum_keycodes {
     DT_DOWN,
 
     // Programmable Button
-    PROGRAMMABLE_BUTTON_1,
-    PROGRAMMABLE_BUTTON_2,
-    PROGRAMMABLE_BUTTON_3,
-    PROGRAMMABLE_BUTTON_4,
-    PROGRAMMABLE_BUTTON_5,
-    PROGRAMMABLE_BUTTON_6,
-    PROGRAMMABLE_BUTTON_7,
-    PROGRAMMABLE_BUTTON_8,
-    PROGRAMMABLE_BUTTON_9,
-    PROGRAMMABLE_BUTTON_10,
-    PROGRAMMABLE_BUTTON_11,
-    PROGRAMMABLE_BUTTON_12,
-    PROGRAMMABLE_BUTTON_13,
-    PROGRAMMABLE_BUTTON_14,
-    PROGRAMMABLE_BUTTON_15,
-    PROGRAMMABLE_BUTTON_16,
-    PROGRAMMABLE_BUTTON_17,
-    PROGRAMMABLE_BUTTON_18,
-    PROGRAMMABLE_BUTTON_19,
-    PROGRAMMABLE_BUTTON_20,
-    PROGRAMMABLE_BUTTON_21,
-    PROGRAMMABLE_BUTTON_22,
-    PROGRAMMABLE_BUTTON_23,
-    PROGRAMMABLE_BUTTON_24,
-    PROGRAMMABLE_BUTTON_25,
-    PROGRAMMABLE_BUTTON_26,
-    PROGRAMMABLE_BUTTON_27,
-    PROGRAMMABLE_BUTTON_28,
-    PROGRAMMABLE_BUTTON_29,
-    PROGRAMMABLE_BUTTON_30,
-    PROGRAMMABLE_BUTTON_31,
-    PROGRAMMABLE_BUTTON_32,
+    QK_PROGRAMMABLE_BUTTON_1,
+    QK_PROGRAMMABLE_BUTTON_2,
+    QK_PROGRAMMABLE_BUTTON_3,
+    QK_PROGRAMMABLE_BUTTON_4,
+    QK_PROGRAMMABLE_BUTTON_5,
+    QK_PROGRAMMABLE_BUTTON_6,
+    QK_PROGRAMMABLE_BUTTON_7,
+    QK_PROGRAMMABLE_BUTTON_8,
+    QK_PROGRAMMABLE_BUTTON_9,
+    QK_PROGRAMMABLE_BUTTON_10,
+    QK_PROGRAMMABLE_BUTTON_11,
+    QK_PROGRAMMABLE_BUTTON_12,
+    QK_PROGRAMMABLE_BUTTON_13,
+    QK_PROGRAMMABLE_BUTTON_14,
+    QK_PROGRAMMABLE_BUTTON_15,
+    QK_PROGRAMMABLE_BUTTON_16,
+    QK_PROGRAMMABLE_BUTTON_17,
+    QK_PROGRAMMABLE_BUTTON_18,
+    QK_PROGRAMMABLE_BUTTON_19,
+    QK_PROGRAMMABLE_BUTTON_20,
+    QK_PROGRAMMABLE_BUTTON_21,
+    QK_PROGRAMMABLE_BUTTON_22,
+    QK_PROGRAMMABLE_BUTTON_23,
+    QK_PROGRAMMABLE_BUTTON_24,
+    QK_PROGRAMMABLE_BUTTON_25,
+    QK_PROGRAMMABLE_BUTTON_26,
+    QK_PROGRAMMABLE_BUTTON_27,
+    QK_PROGRAMMABLE_BUTTON_28,
+    QK_PROGRAMMABLE_BUTTON_29,
+    QK_PROGRAMMABLE_BUTTON_30,
+    QK_PROGRAMMABLE_BUTTON_31,
+    QK_PROGRAMMABLE_BUTTON_32,
 
     // Dedicated macro keys for Configurator and VIA
     MACRO_0,
@@ -876,8 +876,40 @@ enum quantum_keycodes {
 #define DM_PLY2 DYN_MACRO_PLAY2
 
 // Joystick aliases
-#define JS_BUTTON_MIN JS_BUTTON0
-#define JS_BUTTON_MAX JS_BUTTON31
+#define JS_0 QK_JOYSTICK_BUTTON_0
+#define JS_1 QK_JOYSTICK_BUTTON_1
+#define JS_2 QK_JOYSTICK_BUTTON_2
+#define JS_3 QK_JOYSTICK_BUTTON_3
+#define JS_4 QK_JOYSTICK_BUTTON_4
+#define JS_5 QK_JOYSTICK_BUTTON_5
+#define JS_6 QK_JOYSTICK_BUTTON_6
+#define JS_7 QK_JOYSTICK_BUTTON_7
+#define JS_8 QK_JOYSTICK_BUTTON_8
+#define JS_9 QK_JOYSTICK_BUTTON_9
+#define JS_10 QK_JOYSTICK_BUTTON_10
+#define JS_11 QK_JOYSTICK_BUTTON_11
+#define JS_12 QK_JOYSTICK_BUTTON_12
+#define JS_13 QK_JOYSTICK_BUTTON_13
+#define JS_14 QK_JOYSTICK_BUTTON_14
+#define JS_15 QK_JOYSTICK_BUTTON_15
+#define JS_16 QK_JOYSTICK_BUTTON_16
+#define JS_17 QK_JOYSTICK_BUTTON_17
+#define JS_18 QK_JOYSTICK_BUTTON_18
+#define JS_19 QK_JOYSTICK_BUTTON_19
+#define JS_20 QK_JOYSTICK_BUTTON_20
+#define JS_21 QK_JOYSTICK_BUTTON_21
+#define JS_22 QK_JOYSTICK_BUTTON_22
+#define JS_23 QK_JOYSTICK_BUTTON_23
+#define JS_24 QK_JOYSTICK_BUTTON_24
+#define JS_25 QK_JOYSTICK_BUTTON_25
+#define JS_26 QK_JOYSTICK_BUTTON_26
+#define JS_27 QK_JOYSTICK_BUTTON_27
+#define JS_28 QK_JOYSTICK_BUTTON_28
+#define JS_29 QK_JOYSTICK_BUTTON_29
+#define JS_30 QK_JOYSTICK_BUTTON_30
+#define JS_31 QK_JOYSTICK_BUTTON_31
+#define QK_JOYSTICK_BUTTON_MIN QK_JOYSTICK_BUTTON_0
+#define QK_JOYSTICK_BUTTON_MAX QK_JOYSTICK_BUTTON_31
 
 // One Shot aliases
 #define OS_TOGG ONESHOT_TOGGLE
@@ -885,40 +917,41 @@ enum quantum_keycodes {
 #define OS_OFF ONESHOT_DISABLE
 
 // Programmable Button aliases
-#define PB_1 PROGRAMMABLE_BUTTON_1
-#define PB_2 PROGRAMMABLE_BUTTON_2
-#define PB_3 PROGRAMMABLE_BUTTON_3
-#define PB_4 PROGRAMMABLE_BUTTON_4
-#define PB_5 PROGRAMMABLE_BUTTON_5
-#define PB_6 PROGRAMMABLE_BUTTON_6
-#define PB_7 PROGRAMMABLE_BUTTON_7
-#define PB_8 PROGRAMMABLE_BUTTON_8
-#define PB_9 PROGRAMMABLE_BUTTON_9
-#define PB_10 PROGRAMMABLE_BUTTON_10
-#define PB_11 PROGRAMMABLE_BUTTON_11
-#define PB_12 PROGRAMMABLE_BUTTON_12
-#define PB_13 PROGRAMMABLE_BUTTON_13
-#define PB_14 PROGRAMMABLE_BUTTON_14
-#define PB_15 PROGRAMMABLE_BUTTON_15
-#define PB_16 PROGRAMMABLE_BUTTON_16
-#define PB_17 PROGRAMMABLE_BUTTON_17
-#define PB_18 PROGRAMMABLE_BUTTON_18
-#define PB_19 PROGRAMMABLE_BUTTON_19
-#define PB_20 PROGRAMMABLE_BUTTON_20
-#define PB_21 PROGRAMMABLE_BUTTON_21
-#define PB_22 PROGRAMMABLE_BUTTON_22
-#define PB_23 PROGRAMMABLE_BUTTON_23
-#define PB_24 PROGRAMMABLE_BUTTON_24
-#define PB_25 PROGRAMMABLE_BUTTON_25
-#define PB_26 PROGRAMMABLE_BUTTON_26
-#define PB_27 PROGRAMMABLE_BUTTON_27
-#define PB_28 PROGRAMMABLE_BUTTON_28
-#define PB_29 PROGRAMMABLE_BUTTON_29
-#define PB_30 PROGRAMMABLE_BUTTON_30
-#define PB_31 PROGRAMMABLE_BUTTON_31
-#define PB_32 PROGRAMMABLE_BUTTON_32
-#define PROGRAMMABLE_BUTTON_MIN PROGRAMMABLE_BUTTON_1
-#define PROGRAMMABLE_BUTTON_MAX PROGRAMMABLE_BUTTON_32
+#define PB_1 QK_PROGRAMMABLE_BUTTON_1
+#define PB_2 QK_PROGRAMMABLE_BUTTON_2
+#define PB_3 QK_PROGRAMMABLE_BUTTON_3
+#define PB_4 QK_PROGRAMMABLE_BUTTON_4
+#define PB_5 QK_PROGRAMMABLE_BUTTON_5
+#define PB_6 QK_PROGRAMMABLE_BUTTON_6
+#define PB_7 QK_PROGRAMMABLE_BUTTON_7
+#define PB_8 QK_PROGRAMMABLE_BUTTON_8
+#define PB_9 QK_PROGRAMMABLE_BUTTON_9
+#define PB_10 QK_PROGRAMMABLE_BUTTON_10
+#define PB_11 QK_PROGRAMMABLE_BUTTON_11
+#define PB_12 QK_PROGRAMMABLE_BUTTON_12
+#define PB_13 QK_PROGRAMMABLE_BUTTON_13
+#define PB_14 QK_PROGRAMMABLE_BUTTON_14
+#define PB_15 QK_PROGRAMMABLE_BUTTON_15
+#define PB_16 QK_PROGRAMMABLE_BUTTON_16
+#define PB_17 QK_PROGRAMMABLE_BUTTON_17
+#define PB_18 QK_PROGRAMMABLE_BUTTON_18
+#define PB_19 QK_PROGRAMMABLE_BUTTON_19
+#define PB_20 QK_PROGRAMMABLE_BUTTON_20
+#define PB_21 QK_PROGRAMMABLE_BUTTON_21
+#define PB_22 QK_PROGRAMMABLE_BUTTON_22
+#define PB_23 QK_PROGRAMMABLE_BUTTON_23
+#define PB_24 QK_PROGRAMMABLE_BUTTON_24
+#define PB_25 QK_PROGRAMMABLE_BUTTON_25
+#define PB_26 QK_PROGRAMMABLE_BUTTON_26
+#define PB_27 QK_PROGRAMMABLE_BUTTON_27
+#define PB_28 QK_PROGRAMMABLE_BUTTON_28
+#define PB_29 QK_PROGRAMMABLE_BUTTON_29
+#define PB_30 QK_PROGRAMMABLE_BUTTON_30
+#define PB_31 QK_PROGRAMMABLE_BUTTON_31
+#define PB_32 QK_PROGRAMMABLE_BUTTON_32
+#define QK_PROGRAMMABLE_BUTTON_MIN QK_PROGRAMMABLE_BUTTON_1
+#define QK_PROGRAMMABLE_BUTTON_MAX QK_PROGRAMMABLE_BUTTON_32
+
 #define CAPSWRD CAPS_WORD
 
 #include "quantum_keycodes_legacy.h"
diff --git a/quantum/quantum_keycodes_legacy.h b/quantum/quantum_keycodes_legacy.h
index db13d5973d..bab34025cf 100644
--- a/quantum/quantum_keycodes_legacy.h
+++ b/quantum/quantum_keycodes_legacy.h
@@ -8,6 +8,72 @@
 
 #define VLK_TOG QK_VELOCIKEY_TOGGLE
 
+#define PROGRAMMABLE_BUTTON_1 QK_PROGRAMMABLE_BUTTON_1
+#define PROGRAMMABLE_BUTTON_2 QK_PROGRAMMABLE_BUTTON_2
+#define PROGRAMMABLE_BUTTON_3 QK_PROGRAMMABLE_BUTTON_3
+#define PROGRAMMABLE_BUTTON_4 QK_PROGRAMMABLE_BUTTON_4
+#define PROGRAMMABLE_BUTTON_5 QK_PROGRAMMABLE_BUTTON_5
+#define PROGRAMMABLE_BUTTON_6 QK_PROGRAMMABLE_BUTTON_6
+#define PROGRAMMABLE_BUTTON_7 QK_PROGRAMMABLE_BUTTON_7
+#define PROGRAMMABLE_BUTTON_8 QK_PROGRAMMABLE_BUTTON_8
+#define PROGRAMMABLE_BUTTON_9 QK_PROGRAMMABLE_BUTTON_9
+#define PROGRAMMABLE_BUTTON_10 QK_PROGRAMMABLE_BUTTON_10
+#define PROGRAMMABLE_BUTTON_11 QK_PROGRAMMABLE_BUTTON_11
+#define PROGRAMMABLE_BUTTON_12 QK_PROGRAMMABLE_BUTTON_12
+#define PROGRAMMABLE_BUTTON_13 QK_PROGRAMMABLE_BUTTON_13
+#define PROGRAMMABLE_BUTTON_14 QK_PROGRAMMABLE_BUTTON_14
+#define PROGRAMMABLE_BUTTON_15 QK_PROGRAMMABLE_BUTTON_15
+#define PROGRAMMABLE_BUTTON_16 QK_PROGRAMMABLE_BUTTON_16
+#define PROGRAMMABLE_BUTTON_17 QK_PROGRAMMABLE_BUTTON_17
+#define PROGRAMMABLE_BUTTON_18 QK_PROGRAMMABLE_BUTTON_18
+#define PROGRAMMABLE_BUTTON_19 QK_PROGRAMMABLE_BUTTON_19
+#define PROGRAMMABLE_BUTTON_20 QK_PROGRAMMABLE_BUTTON_20
+#define PROGRAMMABLE_BUTTON_21 QK_PROGRAMMABLE_BUTTON_21
+#define PROGRAMMABLE_BUTTON_22 QK_PROGRAMMABLE_BUTTON_22
+#define PROGRAMMABLE_BUTTON_23 QK_PROGRAMMABLE_BUTTON_23
+#define PROGRAMMABLE_BUTTON_24 QK_PROGRAMMABLE_BUTTON_24
+#define PROGRAMMABLE_BUTTON_25 QK_PROGRAMMABLE_BUTTON_25
+#define PROGRAMMABLE_BUTTON_26 QK_PROGRAMMABLE_BUTTON_26
+#define PROGRAMMABLE_BUTTON_27 QK_PROGRAMMABLE_BUTTON_27
+#define PROGRAMMABLE_BUTTON_28 QK_PROGRAMMABLE_BUTTON_28
+#define PROGRAMMABLE_BUTTON_29 QK_PROGRAMMABLE_BUTTON_29
+#define PROGRAMMABLE_BUTTON_30 QK_PROGRAMMABLE_BUTTON_30
+#define PROGRAMMABLE_BUTTON_31 QK_PROGRAMMABLE_BUTTON_31
+#define PROGRAMMABLE_BUTTON_32 QK_PROGRAMMABLE_BUTTON_32
+
+#define JS_BUTTON0 QK_JOYSTICK_BUTTON_0
+#define JS_BUTTON1 QK_JOYSTICK_BUTTON_1
+#define JS_BUTTON2 QK_JOYSTICK_BUTTON_2
+#define JS_BUTTON3 QK_JOYSTICK_BUTTON_3
+#define JS_BUTTON4 QK_JOYSTICK_BUTTON_4
+#define JS_BUTTON5 QK_JOYSTICK_BUTTON_5
+#define JS_BUTTON6 QK_JOYSTICK_BUTTON_6
+#define JS_BUTTON7 QK_JOYSTICK_BUTTON_7
+#define JS_BUTTON8 QK_JOYSTICK_BUTTON_8
+#define JS_BUTTON9 QK_JOYSTICK_BUTTON_9
+#define JS_BUTTON10 QK_JOYSTICK_BUTTON_10
+#define JS_BUTTON11 QK_JOYSTICK_BUTTON_11
+#define JS_BUTTON12 QK_JOYSTICK_BUTTON_12
+#define JS_BUTTON13 QK_JOYSTICK_BUTTON_13
+#define JS_BUTTON14 QK_JOYSTICK_BUTTON_14
+#define JS_BUTTON15 QK_JOYSTICK_BUTTON_15
+#define JS_BUTTON16 QK_JOYSTICK_BUTTON_16
+#define JS_BUTTON17 QK_JOYSTICK_BUTTON_17
+#define JS_BUTTON18 QK_JOYSTICK_BUTTON_18
+#define JS_BUTTON19 QK_JOYSTICK_BUTTON_19
+#define JS_BUTTON20 QK_JOYSTICK_BUTTON_20
+#define JS_BUTTON21 QK_JOYSTICK_BUTTON_21
+#define JS_BUTTON22 QK_JOYSTICK_BUTTON_22
+#define JS_BUTTON23 QK_JOYSTICK_BUTTON_23
+#define JS_BUTTON24 QK_JOYSTICK_BUTTON_24
+#define JS_BUTTON25 QK_JOYSTICK_BUTTON_25
+#define JS_BUTTON26 QK_JOYSTICK_BUTTON_26
+#define JS_BUTTON27 QK_JOYSTICK_BUTTON_27
+#define JS_BUTTON28 QK_JOYSTICK_BUTTON_28
+#define JS_BUTTON29 QK_JOYSTICK_BUTTON_29
+#define JS_BUTTON30 QK_JOYSTICK_BUTTON_30
+#define JS_BUTTON31 QK_JOYSTICK_BUTTON_31
+
 #define TERM_ON _Static_assert(false, "The Terminal feature has been removed from QMK. Please remove use of TERM_ON/TERM_OFF from your keymap.")
 #define TERM_OFF _Static_assert(false, "The Terminal feature has been removed from QMK.. Please remove use of TERM_ON/TERM_OFF from your keymap.")
 // #define RESET _Static_assert(false, "The RESET keycode has been removed from QMK.. Please remove use from your keymap.")