Devided #3856, split Space Cadet process, trying fix at #3701

common_features.mk

@@ -227,6 +227,12 @@ ifeq ($(strip $(HD44780_ENABLE)), yes)
     OPT_DEFS += -DHD44780_ENABLE
 endif
 
+# space cadet shift process enable
+ifeq ($(strip $(SPACE_CADET_ENABLE)), yes)
+    SRC += $(QUANTUM_DIR)/process_keycode/process_space_cadet.c
+    OPT_DEFS += -DSPACE_CADET_ENABLE
+endif
+
 QUANTUM_SRC:= \
     $(QUANTUM_DIR)/quantum.c \
     $(QUANTUM_DIR)/keymap_common.c \
@@ -246,5 +252,5 @@ ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
     QUANTUM_SRC += $(QUANTUM_DIR)/split_common/split_flags.c \
                 $(QUANTUM_DIR)/split_common/split_util.c \
                 $(QUANTUM_DIR)/split_common/i2c.c \
-                $(QUANTUM_DIR)/split_common/serial.c  
+                $(QUANTUM_DIR)/split_common/serial.c
 endif

docs/feature_grave_esc.md

@@ -1,24 +1,54 @@
 # Grave Escape
 
-If you're using a 60% keyboard, or any other layout with no F-row, you will have noticed that there is no dedicated Escape key. Grave Escape is a feature that allows you to share the grave key (<code>&#96;</code> and `~`) with Escape.
+If you're using a 60% keyboard, or any other layout with no F-row, you will have noticed that there is no dedicated Escape key. 
+Grave Escape is a feature that allows you to share the grave key (<code>&#96;</code> and `~`) with Escape.
 
 ## Usage
 
-Replace the `KC_GRAVE` key in your keymap (usually to the left of the `1` key) with `KC_GESC`. When pressed it will behave like `KC_ESC`, but with Shift or GUI held it will send `KC_GRAVE`.
+Replace the `KC_GRAVE` key in your keymap (usually to the left of the `1` key) with `KC_GESC`. 
+When pressed it will behave like `KC_ESC`, but with Shift or GUI held it will send `KC_GRAVE`.
 
 ## Keycodes
 
-|Key      |Aliases    |Description                                                       |
-|---------|-----------|------------------------------------------------------------------|
-|`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held|
+| Key       | Aliases     | Description                                                        |
+|-----------|-------------|--------------------------------------------------------------------|
+| `KC_GESC` | `GRAVE_ESC` | Escape when pressed, <code>&#96;</code> when Shift or GUI are held |
 
 ## Configuration
 
-There are several possible key combinations this will break, among them Control+Shift+Escape on Windows and Command+Option+Escape on macOS. To work around this, you can `#define` these options in your `config.h`:
+### Overrides
 
-|Define                    |Description                              |
-|--------------------------|-----------------------------------------|
-|`GRAVE_ESC_ALT_OVERRIDE`  |Always send Escape if Alt is pressed     |
-|`GRAVE_ESC_CTRL_OVERRIDE` |Always send Escape if Control is pressed |
-|`GRAVE_ESC_GUI_OVERRIDE`  |Always send Escape if GUI is pressed     |
-|`GRAVE_ESC_SHIFT_OVERRIDE`|Always send Escape if Shift is pressed   |
+There are several possible key combinations this will break, among them Control + Shift + Escape on Windows 
+and Command + Option + Escape on macOS. 
+To work around this, you can `#define` these options in your `config.h`:
+
+| Define                     | Default       | Description                              |
+|----------------------------|---------------|------------------------------------------|
+| `GRAVE_ESC_ALT_OVERRIDE`   | *Not defined* | Always send Escape if Alt is pressed     |
+| `GRAVE_ESC_CTRL_OVERRIDE`  | *Not defined* | Always send Escape if Control is pressed |
+| `GRAVE_ESC_GUI_OVERRIDE`   | *Not defined* | Always send Escape if GUI is pressed     |
+| `GRAVE_ESC_SHIFT_OVERRIDE` | *Not defined* | Always send Escape if Shift is pressed   |
+
+### Ignore mods
+
+Also you can customize ignore mod combination. It assumes these situations:
+
+* left Shift uses for `~` ( Shift +  <code>&#96;</code>, it is normal behavior ), but right Shift want to use <code>&#96;</code>
+* want to send just <code>&#96;</code> , when pressed GUI + `KC_GESC`
+    * depend on enviroment, it will be sent GUI + <code>&#96;</code> message
+* apply above both sides
+
+They provided these options, add `#define` in your `(keymap|keyboard)/config.h`.
+
+| Define                    | Default       | Description                                                                                                              |
+|---------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------|
+| `GESC_GR_IGNORED_MOD`     | *Not defined* | when defined mod keycode, will be passed mod when pressed <code>&#96;</code>, if mod is enabled                          |
+| `GESC_GR_IGNORED_MOD_BIT` | *Not defined* | when defined mod bit, will be passed correspond mods when pressed <code>&#96;</code>, if any correspond mods are enabled |
+
+
+#### example
+
+* passed left Shift
+    * `#define GESC_GR_IGNORED_MOD KC_LSFT`
+* passed both GUI
+    * `#define GESC_GR_IGNORED_MOD_BIT ( MOD_BIT( KC_LGUI ) | MOD_BIT( KC_RGUI ) )`

docs/feature_space_cadet_shift.md

@@ -4,14 +4,20 @@ Steve Losh described the [Space Cadet Shift](http://stevelosh.com/blog/2012/10/a
 
 ## Usage
 
-Replace the Left Shift key in your keymap with `KC_LSPO` (Left Shift, Parenthesis Open), and Right Shift with `KC_RSPC` (Right Shift, Parenthesis Close).
+First, you need to enable Space Cadet Shift feature. Add a flag in your `(keymap|keyboard)/rules.mk` like this:
+
+```make
+SPACE_CADET_ENABLE = yes
+```
+
+Then, replace the Left Shift key in your keymap with `KC_LSPO` (Left Shift, Parenthesis Open), and Right Shift with `KC_RSPC` (Right Shift, Parenthesis Close).
 
 ## Keycodes
 
-|Keycode  |Description                           |
-|---------|--------------------------------------|
-|`KC_LSPO`|Left Shift when held, `(` when tapped |
-|`KC_RSPC`|Right Shift when held, `)` when tapped|
+| Keycode   | Description                            |
+|-----------|----------------------------------------|
+| `KC_LSPO` | Left Shift when held, `(` when tapped  |
+| `KC_RSPC` | Right Shift when held, `)` when tapped |
 
 ## Caveats
 
@@ -25,9 +31,13 @@ COMMAND_ENABLE = no
 
 By default Space Cadet assumes a US ANSI layout, but if your layout uses different keys for parentheses, you can redefine them in your `config.h`.
 You can also disable the rollover, allowing you to use the opposite Shift key to cancel the Space Cadet state in the event of an erroneous press, instead of emitting a pair of parentheses when the keys are released.
-
-|Define                        |Default      |Description                                                 |
-|------------------------------|-------------|------------------------------------------------------------|
-|`LSPO_KEY`                    |`KC_9`       |The keycode to send when Left Shift is tapped               |
-|`RSPC_KEY`                    |`KC_0`       |The keycode to send when Right Shift is tapped              |
-|`DISABLE_SPACE_CADET_ROLLOVER`|*Not defined*|If defined, use the opposite Shift key to cancel Space Cadet|
+Also, by default, the Space Cadet applies modifiers LSPO_MOD and RSPC_MOD to keys defined by LSPO_KEY and RSPC_KEY. You can override this behavior by redefining those variables in your `config.h`. You can also prevent the Space Cadet to apply a modifier by defining DISABLE_SPACE_CADET_MODIFIER in your `config.h`.
+
+| Define                         | Default       | Description                                                                      |
+|--------------------------------|---------------|----------------------------------------------------------------------------------|
+| `LSPO_KEY`                     | `KC_9`        | The keycode to send when Left Shift is tapped                                    |
+| `RSPC_KEY`                     | `KC_0`        | The keycode to send when Right Shift is tapped                                   |
+| `LSPO_MOD`                     | `KC_LSFT`     | The keycode to send when Left Shift is tapped                                    |
+| `RSPC_MOD`                     | `KC_RSFT`     | The keycode to send when Right Shift is tapped                                   |
+| `DISABLE_SPACE_CADET_ROLLOVER` | *Not defined* | If defined, use the opposite Shift key to cancel Space Cadet                     |
+| `DISABLE_SPACE_CADET_MODIFIER` | *Not defined* | If defined, prevent the Space Cadet to apply a modifier to LSPO_KEY and RSPC_KEY |

docs/feature_space_cadet_shift_enter.md

@@ -4,7 +4,13 @@ Based on the [Space Cadet Shift](feature_space_cadet_shift.md) feature. Tap the
 
 ## Usage
 
-Replace any Shift key in your keymap with `KC_SFTENT` (Shift, Enter), and you're done.
+First, you need to enable Space Cadet Shift feature. Add a flag in your `(keymap|keyboard)/rules.mk` like this:
+
+```make
+SPACE_CADET_ENABLE = yes
+```
+
+Then, replace any Shift key in your keymap with `KC_SFTENT` (Shift, Enter), and you're done.
 
 ## Keycodes
 

keyboards/alu84/keymaps/default/rules.mk

@@ -0,0 +1 @@
+SPACE_CADET_ENABLE = yes

keyboards/chimera_ergo/keymaps/default/rules.mk

@@ -0,0 +1 @@
+SPACE_CADET_ENABLE = yes

keyboards/chimera_ls/keymaps/default/rules.mk

@@ -0,0 +1 @@
+SPACE_CADET_ENABLE = yes

keyboards/chimera_ortho/keymaps/default/rules.mk

@@ -0,0 +1 @@
+SPACE_CADET_ENABLE = yes

keyboards/handwired/magicforce61/keymaps/default/rules.mk

@@ -0,0 +1 @@
+SPACE_CADET_ENABLE = yes

keyboards/handwired/terminus_mini/keymaps/default/rules.mk

@@ -31,4 +31,5 @@ UNICODE_ENABLE = no         # Unicode
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
 SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
-TAP_DANCE_ENABLE = no      # Enable Tap Dance
+TAP_DANCE_ENABLE = no       # Enable Tap Dance
+SPACE_CADET_ENABLE = yes    # Enable Space Cadet Shifts

keyboards/mt40/keymaps/default/rules.mk

@@ -0,0 +1 @@
+SPACE_CADET_ENABLE = yes

keyboards/qwertyydox/keymaps/default/rules.mk

@@ -1 +1 @@
-
+SPACE_CADET_ENABLE = yes