Deprecate CAPS_WORD/CAPSWRD for CW_TOGG (qmk#18834)

ramonimbao · Nov 28, 2022 · f4caf9a · f4caf9a
1 parent 5f24275
commit f4caf9a
Show file tree

Hide file tree

Showing 19 changed files with 31 additions and 34 deletions.
diff --git a/docs/feature_caps_word.md b/docs/feature_caps_word.md
@@ -42,8 +42,8 @@ CAPS_WORD_ENABLE = yes
 
 Next, use one the following methods to activate Caps Word:
 
-* **Activate by pressing a key**: Use the `CAPS_WORD` keycode (short
-  alias `CAPSWRD`) in your keymap.
+* **Activate by pressing a key**: Use the `QK_CAPS_WORD_TOGGLE` keycode (short
+  alias `CW_TOGG`) in your keymap.
 
 * **Activate by pressing Left Shift + Right Shift**: Add `#define
   BOTH_SHIFTS_TURNS_ON_CAPS_WORD` to config.h. You may also need to disable or

diff --git a/docs/keycodes.md b/docs/keycodes.md
@@ -275,9 +275,9 @@ See also: [Bluetooth](feature_bluetooth.md)
 
 See also: [Caps Word](feature_caps_word.md)
 
-|Key        |Aliases  |Description                   |
-|-----------|---------|------------------------------|
-|`CAPS_WORD`|`CAPSWRD`|Toggles Caps Word             |
+|Key                  |Aliases  |Description                   |
+|---------------------|---------|------------------------------|
+|`QK_CAPS_WORD_TOGGLE`|`CW_TOGG`|Toggles Caps Word             |
 
 ## Dynamic Macros :id=dynamic-macros
 

diff --git a/keyboards/bastardkb/dilemma/keymaps/default/keymap.c b/keyboards/bastardkb/dilemma/keymaps/default/keymap.c
@@ -37,7 +37,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   // ├─────────────────────────────────────────────┤ ├─────────────────────────────────────────────┤
           KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,       KC_N,    KC_M, KC_COMM,  KC_DOT, KC_SLSH,
   // ╰─────────────────────────────────────────────┤ ├─────────────────────────────────────────────╯
-                                      NAV, CAPSWRD,     KC_SPC,     SYM
+                                      NAV, CW_TOGG,     KC_SPC,     SYM
   //                            ╰──────────────────╯ ╰──────────────────╯
   ),
 

diff --git a/keyboards/handwired/hillside/46/keymaps/default/keymap.json b/keyboards/handwired/hillside/46/keymaps/default/keymap.json
@@ -12,7 +12,7 @@
          "KC_H"        , "KC_J"    , "KC_K"         , "KC_L"   , "KC_SCLN", "KC_ENT",
 
          "KC_LCTL"     , "KC_Z"    , "KC_X"         , "KC_C"   , "KC_V"   , "KC_B"      , "KC_ESC",
-         "ANY(CAPSWRD)", "KC_N"    , "KC_M"         , "KC_COMM", "KC_DOT" , "KC_SLSH"   , "KC_QUOT",
+         "ANY(CW_TOGG)", "KC_N"    , "KC_M"         , "KC_COMM", "KC_DOT" , "KC_SLSH"   , "KC_QUOT",
 
          "KC_LGUI"     , "KC_LALT" , "OSM(MOD_LSFT)", "MO(3)",
          "MO(4)"       , "KC_SPC"  , "KC_LALT"      , "KC_RGUI"
@@ -25,7 +25,7 @@
          "KC_D"        , "KC_H"    , "KC_T"         , "KC_N"   , "KC_S"   , "KC_ENT",
 
          "KC_LCTL"     , "KC_SCLN" , "KC_Q"         , "KC_J"   , "KC_K"   , "KC_X"      , "KC_ESC",
-         "ANY(CAPSWRD)", "KC_B"    , "KC_M"         , "KC_W"   , "KC_V"   , "KC_Z"      , "KC_SLSH",
+         "ANY(CW_TOGG)", "KC_B"    , "KC_M"         , "KC_W"   , "KC_V"   , "KC_Z"      , "KC_SLSH",
 
          "KC_LGUI"     , "KC_LALT" , "OSM(MOD_LSFT)", "MO(3)",
          "MO(4)"       , "KC_SPC"  , "KC_LALT"      , "KC_RGUI"
@@ -38,7 +38,7 @@
          "KC_M"        , "KC_N"    , "KC_E"         , "KC_I"   , "KC_O"   , "KC_ENT",
 
          "KC_LCTL"     , "KC_Z"    , "KC_TRNS"      , "KC_C"   , "KC_D"   , "KC_V"      , "KC_ESC",
-         "ANY(CAPSWRD)", "KC_K"    , "KC_H"         , "KC_COMM", "KC_DOT" , "KC_SLSH"   , "KC_QUOT",
+         "ANY(CW_TOGG)", "KC_K"    , "KC_H"         , "KC_COMM", "KC_DOT" , "KC_SLSH"   , "KC_QUOT",
 
          "KC_LGUI"     , "KC_LALT" , "OSM(MOD_LSFT)", "MO(3)",
          "MO(4)"       , "KC_SPC"  , "KC_LALT"      , "KC_RGUI"

diff --git a/keyboards/handwired/hillside/46/keymaps/default_dot_c/keymap.c b/keyboards/handwired/hillside/46/keymaps/default_dot_c/keymap.c
@@ -32,7 +32,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     [_QWERTY] = LAYOUT(
      KC_GRV,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,                                           KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
      KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,                                           KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT,
-     KC_LCTL, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_ESC,                       CAPSWRD, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_QUOT,
+     KC_LCTL, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_ESC,                       CW_TOGG, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_QUOT,
                                          KC_LGUI, KC_LALT, OSM_SFT, LY_NAV ,    LY_SYM , KC_SPC , KC_LALT, KC_RGUI
     ),
     [_NAV] = LAYOUT(

diff --git a/keyboards/handwired/hillside/46/keymaps/via/keymap.c b/keyboards/handwired/hillside/46/keymaps/via/keymap.c
@@ -32,7 +32,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     [_QWERTY] = LAYOUT(
      KC_GRV,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,                                           KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
      KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,                                           KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT,
-     KC_LCTL, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_ESC,                       CAPSWRD, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_QUOT,
+     KC_LCTL, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_ESC,                       CW_TOGG, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_QUOT,
                                          KC_LGUI, KC_LALT, OSM_SFT, LY_NAV ,    LY_SYM , KC_SPC , KC_LALT, KC_RGUI
     ),
     [_NAV] = LAYOUT(

diff --git a/keyboards/handwired/hillside/48/keymaps/default/keymap.json b/keyboards/handwired/hillside/48/keymaps/default/keymap.json
@@ -12,7 +12,7 @@
          "KC_H"      , "KC_J"    , "KC_K"   , "KC_L"   , "KC_SCLN"      , "KC_ENT",
 
          "KC_LSFT"   , "KC_Z"    , "KC_X"   , "KC_C"   , "KC_V"         , "KC_B"      , "KC_ESC",
-         "CAPS_WORD" , "KC_N"    , "KC_M"   , "KC_COMM", "KC_DOT"       , "KC_SLSH"   , "KC_RSFT",
+         "CW_TOGG"   , "KC_N"    , "KC_M"   , "KC_COMM", "KC_DOT"       , "KC_SLSH"   , "KC_RSFT",
 
          "KC_LCTL"   , "KC_LGUI" , "KC_LALT", "MO(3)"  , "OSM(MOD_LSFT)",
          "MO(4)"     , "KC_SPC"  , "KC_LALT", "KC_RGUI", "KC_QUOT"
@@ -25,7 +25,7 @@
          "KC_D"      , "KC_H"    , "KC_T"   , "KC_N"   , "KC_S"         , "KC_ENT",
 
          "KC_LSFT"   , "KC_SCLN" , "KC_Q"   , "KC_J"   , "KC_K"         , "KC_X"      , "KC_ESC",
-         "CAPS_WORD"   , "KC_B"    , "KC_M"   , "KC_W"   , "KC_V"         , "KC_Z"      , "KC_RSFT",
+         "CW_TOGG"   , "KC_B"    , "KC_M"   , "KC_W"   , "KC_V"         , "KC_Z"      , "KC_RSFT",
 
          "KC_LCTL"   , "KC_LGUI" , "KC_LALT", "MO(3)"  , "OSM(MOD_LSFT)",
          "MO(4)"     , "KC_SPC"  , "KC_LALT", "KC_RGUI", "KC_SLSH"
@@ -38,7 +38,7 @@
          "KC_M"      , "KC_N"    , "KC_E"   , "KC_I"   , "KC_O"         , "KC_ENT",
 
          "KC_LSFT"   , "KC_Z"    , "KC_X"   , "KC_C"   , "KC_D"         , "KC_V"      , "KC_ESC",
-         "CAPS_WORD"   , "KC_K"    , "KC_H"   , "KC_COMM", "KC_DOT"       , "KC_SLSH"   , "KC_RSFT",
+         "CW_TOGG"   , "KC_K"    , "KC_H"   , "KC_COMM", "KC_DOT"       , "KC_SLSH"   , "KC_RSFT",
 
          "KC_LCTL"   , "KC_LGUI" , "KC_LALT", "MO(3)"  , "OSM(MOD_LSFT)",
          "MO(4)"     , "KC_SPC"  , "KC_LALT", "KC_RGUI", "KC_QUOT"

diff --git a/keyboards/handwired/hillside/52/keymaps/default/keymap.json b/keyboards/handwired/hillside/52/keymaps/default/keymap.json
@@ -60,7 +60,7 @@
         ["KC_INS"      , "KC_EXLM" , "KC_AT"  , "KC_HASH", "KC_DLR" , "KC_PERC",
          "KC_CIRC"     , "KC_AMPR" , "KC_ASTR", "KC_LPRN", "KC_RPRN", "KC_DEL",
 
-         "ANY(CAPSWRD)", "KC_BSLS" , "KC_MINS", "KC_EQL" , "KC_LBRC", "KC_RBRC",
+         "ANY(CW_TOGG)", "KC_BSLS" , "KC_MINS", "KC_EQL" , "KC_LBRC", "KC_RBRC",
          "KC_VOLU"     , "KC_RSFT" , "KC_RCTL", "KC_LALT", "KC_RGUI", "KC_TRNS",
 
          "KC_TRNS"     , "KC_PIPE" , "KC_UNDS", "KC_PLUS", "KC_LCBR", "KC_RCBR"      , "KC_MPLY",

diff --git a/keyboards/handwired/hillside/52/keymaps/default_dot_c/keymap.c b/keyboards/handwired/hillside/52/keymaps/default_dot_c/keymap.c
@@ -43,7 +43,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     ),
     [_SYM] = LAYOUT(
      KC_INS,  KC_EXLM, KC_AT  , KC_HASH, KC_DLR , KC_PERC,                                        KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL,
-     CAPSWRD, KC_BSLS, KC_MINS, KC_EQL , KC_LBRC, KC_RBRC,                                        KC_VOLU, KC_RSFT, KC_RCTL, KC_LALT, KC_RGUI, _______,
+     CW_TOGG, KC_BSLS, KC_MINS, KC_EQL , KC_LBRC, KC_RBRC,                                        KC_VOLU, KC_RSFT, KC_RCTL, KC_LALT, KC_RGUI, _______,
      _______, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_MPLY,                      KC_MUTE, KC_VOLD, KC_0   , KC_1   , KC_2   , xxxxxxx, _______,   
      xxxxxxx, xxxxxxx, _______,          _______, _______, _______, LY_ADJ ,    _______, _______, _______, _______,          KC_RCTL, KC_APP, ALT_GR
     ),

diff --git a/keyboards/handwired/hillside/52/keymaps/via/keymap.c b/keyboards/handwired/hillside/52/keymaps/via/keymap.c
@@ -43,7 +43,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     ),
     [_SYM] = LAYOUT(
      KC_INS,  KC_EXLM, KC_AT  , KC_HASH, KC_DLR , KC_PERC,                                        KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL,
-     CAPSWRD, KC_BSLS, KC_MINS, KC_EQL , KC_LBRC, KC_RBRC,                                        KC_VOLU, KC_RSFT, KC_RCTL, KC_LALT, KC_RGUI, _______,
+     CW_TOGG, KC_BSLS, KC_MINS, KC_EQL , KC_LBRC, KC_RBRC,                                        KC_VOLU, KC_RSFT, KC_RCTL, KC_LALT, KC_RGUI, _______,
      _______, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_MPLY,                      KC_MUTE, KC_VOLD, KC_0   , KC_1   , KC_2   , xxxxxxx, _______,   
      xxxxxxx, xxxxxxx, _______,          _______, _______, _______, LY_ADJ ,    _______, _______, _______, _______,          KC_RCTL, KC_APP, ALT_GR
     ),

diff --git a/keyboards/handwired/stef9998/split_5x7/keymaps/stef9998/keymap.c b/keyboards/handwired/stef9998/split_5x7/keymaps/stef9998/keymap.c
@@ -134,7 +134,7 @@ _______ ,_______ ,RALT_T(KC_S),LCTL_T(KC_D),LSFT_T(KC_F),LT(_SYM,KC_G),_______ ,
 // ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤                         ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤
     _______ ,KC_EXLM ,KC_AT   ,KC_HASH ,KC_DLR  ,KC_PERC ,_______ ,                          _______ ,KC_CIRC ,KC_AMPR ,KC_ASTR ,KC_LPRN ,KC_RPRN ,XXXXXXX ,
 // ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤                         ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤
-    CAPSWRD ,KC_1    ,KC_2    ,KC_3    ,KC_4    ,KC_5    ,_______ ,                          _______ ,KC_6    ,KC_7    ,KC_8    ,KC_9    ,KC_0    ,KC_QUOT ,
+    CW_TOGG ,KC_1    ,KC_2    ,KC_3    ,KC_4    ,KC_5    ,_______ ,                          _______ ,KC_6    ,KC_7    ,KC_8    ,KC_9    ,KC_0    ,KC_QUOT ,
 // ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤                         ├────────┼────────┼────────┼────────┼────────┼────────┼────────┤
     _______ ,KC_MSEL ,KC_MPLY ,XXXXXXX ,KC_EQL  ,KC_PLUS ,_______ ,                          _______ ,KC_UNDS ,KC_MINS , KC_MPRV, KC_MNXT,KC_MPLY ,_______ ,
 // ├────────┼────────┼────────┴─┬──────┴───┬────┴────────┼────────┤                         ├────────┼────────┴────┬───┴──────┬─┴────────┼────────┼────────┤

diff --git a/keyboards/planck/keymaps/muppetjones/keymap.c b/keyboards/planck/keymaps/muppetjones/keymap.c
@@ -59,7 +59,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  */
 [_CLMK_DH] = LAYOUT_planck_wrapper(
     __COLEMAK_MOD_DH_L1________________________, KC_DEL,  KC_BSPC, __COLEMAK_MOD_DH_R1_W_QUOT_________________,
-    __COLEMAK_MOD_DH_L2_W_GACS_________________, CAPSWRD, KC_QUOT, __COLEMAK_MOD_DH_R2_W_SCAG_________________,
+    __COLEMAK_MOD_DH_L2_W_GACS_________________, CW_TOGG, KC_QUOT, __COLEMAK_MOD_DH_R2_W_SCAG_________________,
     __COLEMAK_MOD_DH_L3_W_SFTV_________________, KC_ENT,  KC_TAB,  __COLEMAK_MOD_DH_R3________________________,
     TD_LAYR,  XXXXXXX, XXXXXXX, HY_ESC, LOW_ENT, KC_BSPC, KC_BSPC, RAI_SPC, HY_ESC,  KC_BSPC, XXXXXXX, XXXXXXX
 ),

diff --git a/keyboards/splitkb/kyria/keymaps/muppetjones/keymap.c b/keyboards/splitkb/kyria/keymaps/muppetjones/keymap.c
@@ -57,7 +57,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                        `----------------------------------'  `----------------------------------'
  */
 [_CLMK_DH] = LAYOUT_wrapper(
-    CAPSWRD, __COLEMAK_MOD_DH_L1________________________,                                     __COLEMAK_MOD_DH_R1_W_QUOT_________________, KC_BSLS,
+    CW_TOGG, __COLEMAK_MOD_DH_L1________________________,                                     __COLEMAK_MOD_DH_R1_W_QUOT_________________, KC_BSLS,
     HY_ESC,  __COLEMAK_MOD_DH_L2_W_GACS_________________,                                     __COLEMAK_MOD_DH_R2_W_SCAG_________________, KC_QUOT,
     TD_LAYR, __COLEMAK_MOD_DH_L3________________________, KC_LSFT, QK_LEAD, KC_DEL,  KC_TAB,  __COLEMAK_MOD_DH_R3________________________, KC_SFTENT,
                                KC_MUTE, KC_DEL,  HY_ESC,  LOW_BSP, RAI_ENT, KC_BSPC, NAV_SPC, HY_ESC,  RAI_TAB, KC_RALT

diff --git a/quantum/process_keycode/process_caps_word.c b/quantum/process_keycode/process_caps_word.c
@@ -15,7 +15,7 @@
 #include "process_caps_word.h"
 
 bool process_caps_word(uint16_t keycode, keyrecord_t* record) {
-    if (keycode == CAPSWRD) { // Pressing CAPSWRD toggles Caps Word.
+    if (keycode == QK_CAPS_WORD_TOGGLE) {
         if (record->event.pressed) {
             caps_word_toggle();
         }

diff --git a/quantum/quantum_keycodes.h b/quantum/quantum_keycodes.h
@@ -603,7 +603,7 @@ enum quantum_keycodes {
     SECURE_TOGGLE,
     SECURE_REQUEST,
 
-    CAPS_WORD,
+    QK_CAPS_WORD_TOGGLE,
 
     MAGIC_SWAP_ESCAPE_CAPSLOCK,
     MAGIC_UNSWAP_ESCAPE_CAPSLOCK,
@@ -846,6 +846,9 @@ enum quantum_keycodes {
 // Leader key
 #define QK_LEAD QK_LEADER
 
+// Caps Word
+#define CW_TOGG QK_CAPS_WORD_TOGGLE
+
 // Swap Hands
 #define SH_T(kc) (QK_SWAP_HANDS | (kc))
 #define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE)
@@ -952,6 +955,4 @@ enum quantum_keycodes {
 #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
@@ -7,6 +7,8 @@
 #define KC_LOCK QK_LOCK
 
 #define VLK_TOG QK_VELOCIKEY_TOGGLE
+#define CAPSWRD QK_CAPS_WORD_TOGGLE
+#define CAPS_WORD QK_CAPS_WORD_TOGGLE
 
 #define PROGRAMMABLE_BUTTON_1 QK_PROGRAMMABLE_BUTTON_1
 #define PROGRAMMABLE_BUTTON_2 QK_PROGRAMMABLE_BUTTON_2

diff --git a/tests/caps_word/test_caps_word.cpp b/tests/caps_word/test_caps_word.cpp
@@ -118,19 +118,19 @@ TEST_F(CapsWord, DefaultCapsWordPressUserFun) {
     }
 }
 
-// Tests that `CAPSWRD` key toggles Caps Word.
+// Tests that `QK_CAPS_WORD_TOGGLE` key toggles Caps Word.
 TEST_F(CapsWord, CapswrdKey) {
     TestDriver driver;
-    KeymapKey  key_capswrd(0, 0, 0, CAPSWRD);
+    KeymapKey  key_capswrd(0, 0, 0, QK_CAPS_WORD_TOGGLE);
     set_keymap({key_capswrd});
 
     // No keyboard reports should be sent.
     EXPECT_NO_REPORT(driver);
 
-    tap_key(key_capswrd); // Tap the CAPSWRD key.
+    tap_key(key_capswrd); // Tap the QK_CAPS_WORD_TOGGLE key.
     EXPECT_EQ(is_caps_word_on(), true);
 
-    tap_key(key_capswrd); // Tap the CAPSWRD key again.
+    tap_key(key_capswrd); // Tap the QK_CAPS_WORD_TOGGLE key again.
     EXPECT_EQ(is_caps_word_on(), false);
 
     testing::Mock::VerifyAndClearExpectations(&driver);

diff --git a/users/muppetjones/muppetjones.c b/users/muppetjones/muppetjones.c
@@ -45,11 +45,6 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
             }
             return false;
             break;
-        case CAPSWRD:
-            if (record->event.pressed) {
-                toggle_caps_word();
-            }
-            return false;
         default:
             break;
     }

diff --git a/users/muppetjones/muppetjones.h b/users/muppetjones/muppetjones.h
@@ -52,5 +52,4 @@ enum userspace_layers {
 enum custom_keycodes {
     CLMK_DH = SAFE_RANGE,
     QWERTY,
-    CAPSWRD,
 };