include variables and .h files as pp directives

add description of new option to docs and add option (commented out) into template.
add short comment to grave_esc_ctrl_override
2017-08-12 21:53:59 -04:00 · 2017-08-11 16:54:10 -04:00 · 2017-08-11 16:54:10 -04:00 · 2017-08-11 16:54:10 -04:00
6 changed files with 21 additions and 3 deletions
--- a/build_keyboard.mk
+++ b/build_keyboard.mk
@@ -157,7 +157,10 @@ endif

 OUTPUTS := $(KEYMAP_OUTPUT) $(KEYBOARD_OUTPUT)
 $(KEYMAP_OUTPUT)_SRC := $(SRC)
-$(KEYMAP_OUTPUT)_DEFS := $(OPT_DEFS) $(GFXDEFS) -DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYMAP=\"$(KEYMAP)\"
+$(KEYMAP_OUTPUT)_DEFS := $(OPT_DEFS) $(GFXDEFS) \
+-DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(KEYBOARD).h\" \
+-DQMK_KEYMAP=\"$(KEYMAP)\" -DQMK_KEYMAP_H=\"$(KEYMAP).h\" \
+-DQMK_SUBPROJECT=\"$(SUBPROJECT)\" -DQMK_SUBPROJECT_H=\"$(SUBPROJECT).h\"
 $(KEYMAP_OUTPUT)_INC :=  $(VPATH) $(EXTRAINCDIRS)
 $(KEYMAP_OUTPUT)_CONFIG := $(CONFIG_H)
 $(KEYBOARD_OUTPUT)_SRC := $(CHIBISRC) $(GFXSRC)
--- a/docs/faq_keymap.md
+++ b/docs/faq_keymap.md
@@ -116,7 +116,9 @@ https://github.com/tekezo/Karabiner/issues/403

 ## Esc and `~ on a key

-Use `GRAVE_ESC` or `KC_GESC` in your keymap.
+Use `GRAVE_ESC` or `KC_GESC` in your keymap. `GUI`+`GRAVE_ESC` results in `\`` and `SHIFT`+`GRAVE_ESC` results in `~`.
+
+Note that this will break the CTRL+SHIFT+ESC shortcut to the Windows task manager. Use `#define GRAVE_ESC_CTRL_OVERRIDE` in your `config.h` to get the shortcut back. With this option, `ESC_GRAVE` results in `ESC` if `CTRL` is held, even if `SHIFT` or `GUI` are also held.

 ## Arrow on Right Modifier keys with Dual-Role
 This turns right modifer keys into arrow keys when the keys are tapped while still modifiers when the keys are hold. In TMK the dual-role function is dubbed **TAP**.
--- a/keyboards/bananasplit/keymaps/coloneljesus/config.h
+++ b/keyboards/bananasplit/keymaps/coloneljesus/config.h
@@ -20,5 +20,6 @@
 #include "../../config.h"

 // place overrides here
+#define GRAVE_ESC_CTRL_OVERRIDE

 #endif
--- a/keyboards/planck/planck.c
+++ b/keyboards/planck/planck.c
@@ -1,4 +1,4 @@
-#include "planck.h"
+#include QMK_KEYBOARD_H

 #ifdef ONEHAND_ENABLE
 __attribute__ ((weak))
--- a/quantum/quantum.c
+++ b/quantum/quantum.c
@@ -478,6 +478,13 @@ bool process_record_quantum(keyrecord_t *record) {
      void (*method)(uint8_t) = (record->event.pressed) ? &add_key : &del_key;
      uint8_t shifted = get_mods() & ((MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)
                                      |MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)));
+      
+#ifdef GRAVE_ESC_CTRL_OVERRIDE
+      // if CTRL is pressed, ESC is always read as ESC, even if SHIFT or GUI is pressed.
+      // this is handy for the ctrl+shift+esc shortcut on windows, among other things.
+      if (get_mods() & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_RCTL)))
+        shifted = 0;
+#endif

      method(shifted ? KC_GRAVE : KC_ESCAPE);
      send_keyboard_report(); 
--- a/quantum/template/config.h
+++ b/quantum/template/config.h
@@ -67,6 +67,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE

+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
+
 /*
 * Force NKRO
 *
Author	SHA1	Message	Date
Jack Humbert	9791919c9b	include variables and .h files as pp directives	2017-08-12 21:53:59 -04:00
Balz Guenat	5ad103fa51	add description of new option to docs and add option (commented out) into template.	2017-08-11 16:54:10 -04:00
Balz Guenat	188ed682e3	add short comment to grave_esc_ctrl_override	2017-08-11 16:54:10 -04:00
Balz Guenat	897ceac26c	add option to let ctrl override shift/gui for the GRAVE_ESC. This enables the ctrl+shift+esc shortcut to task manager on windows.	2017-08-11 16:54:10 -04:00