Remove requirement for keymap_steno.h include in keymaps (qmk#22423)

* Remove requirement for `keymap_steno.h` include in keymaps * Add back keymap_steno.h with a note for the time being
future-figs · Nov 12, 2023 · 786ebf8 · 786ebf8
1 parent 87d69ae
commit 786ebf8
Show file tree

Hide file tree

Showing 46 changed files with 125 additions and 175 deletions.
diff --git a/docs/feature_stenography.md b/docs/feature_stenography.md
@@ -104,7 +104,7 @@ After enabling stenography and optionally selecting a protocol, you may also nee
 
 !> If you had *explicitly* set `VIRSTER_ENABLE = no`, none of the serial stenography protocols (GeminiPR, TX Bolt) will work properly. You are expected to either set it to `yes`, remove the line from your `rules.mk` or send the steno chords yourself in an alternative way using the [provided interceptable hooks](#interfacing-with-the-code).
 
-In your keymap, create a new layer for Plover, that you can fill in with the [steno keycodes](#keycode-reference) (you will need to include `keymap_steno.h`, see `planck/keymaps/steno/keymap.c` for an example). Remember to create a key to switch to the layer as well as a key for exiting the layer.
+In your keymap, create a new layer for Plover, that you can fill in with the [steno keycodes](#keycode-reference). Remember to create a key to switch to the layer as well as a key for exiting the layer.
 
 Once you have your keyboard flashed, launch Plover. Click the 'Configure...' button. In the 'Machine' tab, select the Stenotype Machine that corresponds to your desired protocol. Click the 'Configure...' button on this tab and enter the serial port or click 'Scan'. Baud rate is fine at 9600 (although you should be able to set as high as 115200 with no issues). Use the default settings for everything else (Data Bits: 8, Stop Bits: 1, Parity: N, no flow control).
 
@@ -149,8 +149,6 @@ At the end of this scenario given as an example, `chord` would have five bits se
 
 ## Keycode Reference :id=keycode-reference
 
-You must include `keymap_steno.h` to your `keymap.c` with `#include "keymap_steno.h"` before you can use these keycodes
-
 > Note: TX Bolt does not support the full set of keys. The TX Bolt implementation in QMK will map the GeminiPR keys to the nearest TX Bolt key so that one key map will work for both.
 
 |GeminiPR|TX Bolt|Steno Key|
@@ -198,7 +196,7 @@ You must include `keymap_steno.h` to your `keymap.c` with `#include "keymap_sten
 |`STN_RES2`||(Reset 2)|
 |`STN_PWR`||(Power)|
 
-If you do not want to hit two keys with one finger combined keycodes can be used. These are also defined in `keymap_steno.h`, and causes both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file.
+If you do not want to hit two keys with one finger combined keycodes can be used. These cause both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file.
 
 |Combined key | Key1 | Key 2 |
 |---------------|--------|----------|

diff --git a/docs/reference_keymap_extras.md b/docs/reference_keymap_extras.md
@@ -87,6 +87,5 @@ There are also a few which are not quite language-specific, but useful if you ar
 |Norman |`keymap_norman.h` |`sendstring_norman.h` |
 |Plover |`keymap_plover.h` | |
 |Plover (Dvorak) |`keymap_plover_dvorak.h` | |
-|Steno |`keymap_steno.h` | |
 |Workman |`keymap_workman.h` |`sendstring_workman.h` |
 |Workman (ZXCVM) |`keymap_workman_zxcvm.h` |`sendstring_workman_zxcvm.h` |
diff --git a/keyboards/40percentclub/gherkin/keymaps/steno/keymap.c b/keyboards/40percentclub/gherkin/keymaps/steno/keymap.c
@@ -1,5 +1,4 @@
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  LAYOUT_ortho_3x10(

diff --git a/keyboards/40percentclub/gherkin/keymaps/talljoe-gherkin/keymap.c b/keyboards/40percentclub/gherkin/keymaps/talljoe-gherkin/keymap.c
@@ -1,5 +1,4 @@
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 #define ST_BOLT QK_STENO_BOLT
 #define ST_GEM QK_STENO_GEMINI

diff --git a/keyboards/chord/zero/keymaps/default/keymap.c b/keyboards/chord/zero/keymaps/default/keymap.c
@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [0] = LAYOUT(

diff --git a/keyboards/ergodox_ez/keymaps/steno/keymap.c b/keyboards/ergodox_ez/keymaps/steno/keymap.c
@@ -1,7 +1,4 @@
 #include QMK_KEYBOARD_H
-#include "debug.h"
-#include "action_layer.h"
-#include "keymap_steno.h"
 
 #define BASE 0 // default layer
 #define SYMB 1 // symbols

diff --git a/keyboards/eyeohdesigns/babyv/keymaps/bghull/keymap.c b/keyboards/eyeohdesigns/babyv/keymaps/bghull/keymap.c
@@ -14,7 +14,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 #include "g/keymap_combo.h"
 
 

diff --git a/keyboards/gboards/butterstick/sten.h b/keyboards/gboards/butterstick/sten.h
@@ -8,7 +8,6 @@
 #pragma once
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 extern size_t keymapsCount; // Total keymaps
 extern uint32_t cChord; // Current Chord

diff --git a/keyboards/gboards/georgi/keymaps/colemak-dh/keymap.c b/keyboards/gboards/georgi/keymaps/colemak-dh/keymap.c
@@ -12,7 +12,6 @@
 
 #include QMK_KEYBOARD_H
 #include "sten.h"
-#include "keymap_steno.h"
 
 // Steno Layers
 #define FUNCT ( LSD | LK | LP | LH )

diff --git a/keyboards/gboards/georgi/keymaps/default-flipped/keymap.c b/keyboards/gboards/georgi/keymaps/default-flipped/keymap.c
@@ -12,7 +12,6 @@
 
 #include QMK_KEYBOARD_H
 #include "sten.h"
-#include "keymap_steno.h"
 
 // Proper Layers
 #define FUNCT (LSD | LK | LP | LH)

diff --git a/keyboards/gboards/georgi/keymaps/default/keymap.c b/keyboards/gboards/georgi/keymaps/default/keymap.c
@@ -12,7 +12,6 @@
 
 #include QMK_KEYBOARD_H
 #include "sten.h"
-#include "keymap_steno.h"
 
 // Proper Layers
 #define FUNCT (LSD | LK | LP | LH)

diff --git a/keyboards/gboards/georgi/keymaps/minimal/keymap.c b/keyboards/gboards/georgi/keymaps/minimal/keymap.c
@@ -12,7 +12,6 @@
 
 #include QMK_KEYBOARD_H
 #include "sten.h"
-#include "keymap_steno.h"
 
 // Proper Layers
 #define FUNCT (LSD | LK | LP | LH)

diff --git a/keyboards/gboards/georgi/keymaps/norman/keymap.c b/keyboards/gboards/georgi/keymaps/norman/keymap.c
@@ -12,7 +12,6 @@
 
 #include QMK_KEYBOARD_H
 #include "sten.h"
-#include "keymap_steno.h"
 
 // Proper Layers
 #define FUNCT (LSD | LK | LP | LH)

diff --git a/keyboards/gboards/georgi/sten.h b/keyboards/gboards/georgi/sten.h
@@ -7,7 +7,6 @@
 #pragma once
 
 #include "georgi.h"
-#include "keymap_steno.h"
 
 extern size_t keymapsCount; // Total keymaps
 extern uint32_t cChord; // Current Chord

diff --git a/keyboards/handwired/split_cloud/keymaps/default/keymap.c b/keyboards/handwired/split_cloud/keymaps/default/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 // clang-format off
 

diff --git a/keyboards/input_club/ergodox_infinity/keymaps/halfkeyboard/keymap.c b/keyboards/input_club/ergodox_infinity/keymaps/halfkeyboard/keymap.c
@@ -1,8 +1,5 @@
 #include QMK_KEYBOARD_H
-#include "debug.h"
-#include "action_layer.h"
 #include "version.h"
-#include "keymap_steno.h"
 #ifndef MIDI_ENABLE
 #error "Midi is not enabled"
 #endif

diff --git a/keyboards/jian/keymaps/advanced/keymap.c b/keyboards/jian/keymaps/advanced/keymap.c
@@ -11,7 +11,6 @@ typedef union {
 user_config_t user_config;
 
 #ifdef STENO_ENABLE
-#include "keymap_steno.h"
 #endif // STENO_ENABLE
 
 

diff --git a/keyboards/kbdfans/niu_mini/keymaps/yttyx/keymap.c b/keyboards/kbdfans/niu_mini/keymaps/yttyx/keymap.c
@@ -1,6 +1,5 @@
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum layers {
  _BA, // Base (Balance Twelve mirror variant)

diff --git a/keyboards/keebio/levinson/keymaps/dcompact/keymap.c b/keyboards/keebio/levinson/keymaps/dcompact/keymap.c
@@ -1,7 +1,5 @@
 #include QMK_KEYBOARD_H
 
-#include "keymap_steno.h"
-
 // Custom Keycodes and Combinations Used
 #define DEL_SHF SFT_T(KC_DEL)
 #define QUAKE LCTL(KC_GRV)

diff --git a/keyboards/keebio/levinson/keymaps/steno/keymap.c b/keyboards/keebio/levinson/keymaps/steno/keymap.c
@@ -1,5 +1,4 @@
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 extern keymap_config_t keymap_config;
 

diff --git a/keyboards/lily58/keymaps/narze/keymap.c b/keyboards/lily58/keymaps/narze/keymap.c
@@ -1,7 +1,6 @@
 #include QMK_KEYBOARD_H
 #include "narze.h"
 #include "keymap_colemak.h"
-#include "keymap_steno.h"
 
 
 #ifdef RGBLIGHT_ENABLE

diff --git a/keyboards/mechwild/bbs/keymaps/default/keymap.c b/keyboards/mechwild/bbs/keymaps/default/keymap.c
@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 // Defines names for use in layer keycodes and the keymap
 enum layer_names {

diff --git a/keyboards/mechwild/sugarglider/keymaps/default/keymap.c b/keyboards/mechwild/sugarglider/keymaps/default/keymap.c
@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 // Defines names for use in layer keycodes and the keymap
 enum layer_names {

diff --git a/keyboards/planck/keymaps/altgr/keymap.c b/keyboards/planck/keymaps/altgr/keymap.c
@@ -67,9 +67,6 @@
 
 
 #include QMK_KEYBOARD_H
-#ifdef STENO_ENABLE
-#include "keymap_steno.h"
-#endif
 
 extern keymap_config_t keymap_config;
 

diff --git a/keyboards/planck/keymaps/bghull/keymap.c b/keyboards/planck/keymaps/bghull/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 #include "g/keymap_combo.h"
 #include "muse.h"
 

diff --git a/keyboards/planck/keymaps/dcompact/keymap.c b/keyboards/planck/keymaps/dcompact/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 // Custom Keycodes and Combinations Used
 #define DEL_SHF SFT_T(KC_DEL)

diff --git a/keyboards/planck/keymaps/experimental/keymap.c b/keyboards/planck/keymaps/experimental/keymap.c
@@ -1,6 +1,5 @@
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 #include "version.h"
 
 extern keymap_config_t keymap_config;

diff --git a/keyboards/planck/keymaps/hiea/keymap.c b/keyboards/planck/keymaps/hiea/keymap.c
@@ -67,9 +67,6 @@
 
 
 #include QMK_KEYBOARD_H
-#ifdef STENO_ENABLE
-#include "keymap_steno.h"
-#endif
 
 extern keymap_config_t keymap_config;
 

diff --git a/keyboards/planck/keymaps/hieax/keymap.c b/keyboards/planck/keymaps/hieax/keymap.c
@@ -67,9 +67,6 @@
 
 
 #include QMK_KEYBOARD_H
-#ifdef STENO_ENABLE
-#include "keymap_steno.h"
-#endif
 
 extern keymap_config_t keymap_config;
 

diff --git a/keyboards/planck/keymaps/sdothum/keymap.c b/keyboards/planck/keymaps/sdothum/keymap.c
@@ -67,9 +67,6 @@
 
 
 #include QMK_KEYBOARD_H
-#ifdef STENO_ENABLE
-#include "keymap_steno.h"
-#endif
 
 extern keymap_config_t keymap_config;
 

diff --git a/keyboards/planck/keymaps/steno/keymap.c b/keyboards/planck/keymaps/steno/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 extern keymap_config_t keymap_config;
 

diff --git a/keyboards/planck/keymaps/yttyx/keymap.c b/keyboards/planck/keymaps/yttyx/keymap.c
@@ -1,6 +1,5 @@
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum layers {
  _BA, // Base (Balance Twelve mirror variant)

diff --git a/keyboards/preonic/keymaps/bghull/keymap.c b/keyboards/preonic/keymaps/bghull/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum preonic_layers {
  _QWERTY,

diff --git a/keyboards/splitography/keymaps/default/keymap.c b/keyboards/splitography/keymaps/default/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum keyboard_layers {
  _QWERTY = 0,

diff --git a/keyboards/splitography/keymaps/default_with_ctl_shft_alt_switched/keymap.c b/keyboards/splitography/keymaps/default_with_ctl_shft_alt_switched/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum keyboard_layers {
  _QWERTY = 0,

diff --git a/keyboards/splitography/keymaps/dvorak/keymap.c b/keyboards/splitography/keymaps/dvorak/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum keyboard_layers {
  _DVORAK = 0,

diff --git a/keyboards/splitography/keymaps/jeandeaual/keymap.c b/keyboards/splitography/keymaps/jeandeaual/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum keyboard_layers {
  _GEMINI = 0,

diff --git a/keyboards/splitography/keymaps/multi/keymap.c b/keyboards/splitography/keymaps/multi/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum keyboard_layers {
  _QWERTY = 0,

diff --git a/keyboards/stenokeyboards/the_uni/keymaps/default/keymap.c b/keyboards/stenokeyboards/the_uni/keymaps/default/keymap.c
@@ -16,7 +16,6 @@ along with this program. If not, see <http:https://www.gnu.org/licenses/>.
 */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum uni_layers {
  _PLOVER,

diff --git a/keyboards/stenokeyboards/the_uni/keymaps/utility_belt/keymap.c b/keyboards/stenokeyboards/the_uni/keymaps/utility_belt/keymap.c
@@ -16,7 +16,6 @@ along with this program. If not, see <http:https://www.gnu.org/licenses/>.
 */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 enum uni_layers {
  _PLOVER,

diff --git a/keyboards/thevankeyboards/minivan/keymaps/dcompact/keymap.c b/keyboards/thevankeyboards/minivan/keymaps/dcompact/keymap.c
@@ -15,7 +15,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 // Custom Keycodes and Combinations Used
 #define DEL_SHF SFT_T(KC_DEL)

diff --git a/keyboards/xiudi/xd75/keymaps/raoeus/keymap.c b/keyboards/xiudi/xd75/keymaps/raoeus/keymap.c
@@ -16,7 +16,6 @@
  */
 
 #include QMK_KEYBOARD_H
-#include "keymap_steno.h"
 
 void matrix_init_user(void) {
  steno_set_mode(STENO_MODE_GEMINI);