aboutsummaryrefslogtreecommitdiff
path: root/quantum/quantum_keycodes.h
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-04 19:43:45 +1100
committerAlex Ong <the.onga@gmail.com>2019-01-04 19:43:45 +1100
commit2bb2977c133646c4e056960e72029270d77cc1eb (patch)
tree235d491f992121ac1716c5bf2fafb80983748576 /quantum/quantum_keycodes.h
parenta55c838961c89097ab849ed6cb1f261791e6b9b4 (diff)
parent47c91fc7f75ae0a477e55b687aa0fc30da0a283c (diff)
downloadqmk_firmware-2bb2977c133646c4e056960e72029270d77cc1eb.tar.gz
qmk_firmware-2bb2977c133646c4e056960e72029270d77cc1eb.zip
Merge branch 'master' into debounce_refactor
# Conflicts: # tmk_core/common/keyboard.c
Diffstat (limited to 'quantum/quantum_keycodes.h')
-rw-r--r--quantum/quantum_keycodes.h129
1 files changed, 75 insertions, 54 deletions
diff --git a/quantum/quantum_keycodes.h b/quantum/quantum_keycodes.h
index f2cdb8a3b..2b309f4d5 100644
--- a/quantum/quantum_keycodes.h
+++ b/quantum/quantum_keycodes.h
@@ -63,10 +63,6 @@ enum quantum_keycodes {
63 QK_ONE_SHOT_LAYER_MAX = 0x54FF, 63 QK_ONE_SHOT_LAYER_MAX = 0x54FF,
64 QK_ONE_SHOT_MOD = 0x5500, 64 QK_ONE_SHOT_MOD = 0x5500,
65 QK_ONE_SHOT_MOD_MAX = 0x55FF, 65 QK_ONE_SHOT_MOD_MAX = 0x55FF,
66#ifndef DISABLE_CHORDING
67 QK_CHORDING = 0x5600,
68 QK_CHORDING_MAX = 0x56FF,
69#endif
70 QK_TAP_DANCE = 0x5700, 66 QK_TAP_DANCE = 0x5700,
71 QK_TAP_DANCE_MAX = 0x57FF, 67 QK_TAP_DANCE_MAX = 0x57FF,
72 QK_LAYER_TAP_TOGGLE = 0x5800, 68 QK_LAYER_TAP_TOGGLE = 0x5800,
@@ -85,9 +81,6 @@ enum quantum_keycodes {
85#endif 81#endif
86 QK_MOD_TAP = 0x6000, 82 QK_MOD_TAP = 0x6000,
87 QK_MOD_TAP_MAX = 0x7FFF, 83 QK_MOD_TAP_MAX = 0x7FFF,
88#if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
89 #error "Cannot enable both UNICODEMAP && UNICODE"
90#endif
91#ifdef UNICODE_ENABLE 84#ifdef UNICODE_ENABLE
92 QK_UNICODE = 0x8000, 85 QK_UNICODE = 0x8000,
93 QK_UNICODE_MAX = 0xFFFF, 86 QK_UNICODE_MAX = 0xFFFF,
@@ -120,10 +113,11 @@ enum quantum_keycodes {
120 MAGIC_UNHOST_NKRO, 113 MAGIC_UNHOST_NKRO,
121 MAGIC_UNSWAP_ALT_GUI, 114 MAGIC_UNSWAP_ALT_GUI,
122 MAGIC_TOGGLE_NKRO, 115 MAGIC_TOGGLE_NKRO,
116 MAGIC_TOGGLE_ALT_GUI,
123 GRAVE_ESC, 117 GRAVE_ESC,
124 118
125 // Leader key 119 // Leader key
126#ifndef DISABLE_LEADER 120#ifdef LEADER_ENABLE
127 KC_LEAD, 121 KC_LEAD,
128#endif 122#endif
129 123
@@ -142,10 +136,13 @@ enum quantum_keycodes {
142 136
143 // Faux clicky as part of main audio feature 137 // Faux clicky as part of main audio feature
144 CLICKY_TOGGLE, 138 CLICKY_TOGGLE,
139 CLICKY_ENABLE,
140 CLICKY_DISABLE,
145 CLICKY_UP, 141 CLICKY_UP,
146 CLICKY_DOWN, 142 CLICKY_DOWN,
147 CLICKY_RESET, 143 CLICKY_RESET,
148 144
145
149#ifdef FAUXCLICKY_ENABLE 146#ifdef FAUXCLICKY_ENABLE
150 // Faux clicky 147 // Faux clicky
151 FC_ON, 148 FC_ON,
@@ -454,32 +451,43 @@ enum quantum_keycodes {
454 TERM_OFF, 451 TERM_OFF,
455#endif 452#endif
456 453
454 EEPROM_RESET,
455
456 UNICODE_MODE_FORWARD,
457 UNICODE_MODE_REVERSE,
458
459 UNICODE_MODE_OSX,
460 UNICODE_MODE_LNX,
461 UNICODE_MODE_WIN,
462 UNICODE_MODE_BSD,
463 UNICODE_MODE_WINC,
464
457 // always leave at the end 465 // always leave at the end
458 SAFE_RANGE 466 SAFE_RANGE
459}; 467};
460 468
461// Ability to use mods in layouts 469// Ability to use mods in layouts
462#define LCTL(kc) (kc | QK_LCTL) 470#define LCTL(kc) (QK_LCTL | (kc))
463#define LSFT(kc) (kc | QK_LSFT) 471#define LSFT(kc) (QK_LSFT | (kc))
464#define LALT(kc) (kc | QK_LALT) 472#define LALT(kc) (QK_LALT | (kc))
465#define LGUI(kc) (kc | QK_LGUI) 473#define LGUI(kc) (QK_LGUI | (kc))
466#define LCMD(kc) LGUI(kc) 474#define LCMD(kc) LGUI(kc)
467#define LWIN(kc) LGUI(kc) 475#define LWIN(kc) LGUI(kc)
468#define RCTL(kc) (kc | QK_RCTL) 476#define RCTL(kc) (QK_RCTL | (kc))
469#define RSFT(kc) (kc | QK_RSFT) 477#define RSFT(kc) (QK_RSFT | (kc))
470#define RALT(kc) (kc | QK_RALT) 478#define RALT(kc) (QK_RALT | (kc))
471#define RGUI(kc) (kc | QK_RGUI) 479#define ALGR(kc) RALT(kc)
480#define RGUI(kc) (QK_RGUI | (kc))
472#define RCMD(kc) RGUI(kc) 481#define RCMD(kc) RGUI(kc)
473#define RWIN(kc) RGUI(kc) 482#define RWIN(kc) RGUI(kc)
474 483
475#define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI) 484#define HYPR(kc) (QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI | (kc))
476#define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT) 485#define MEH(kc) (QK_LCTL | QK_LSFT | QK_LALT | (kc))
477#define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI) 486#define LCAG(kc) (QK_LCTL | QK_LALT | QK_LGUI | (kc))
478#define ALTG(kc) (kc | QK_RCTL | QK_RALT) 487#define SGUI(kc) (QK_LGUI | QK_LSFT | (kc))
479#define SGUI(kc) (kc | QK_LGUI | QK_LSFT)
480#define SCMD(kc) SGUI(kc) 488#define SCMD(kc) SGUI(kc)
481#define SWIN(kc) SGUI(kc) 489#define SWIN(kc) SGUI(kc)
482#define LCA(kc) (kc | QK_LCTL | QK_LALT) 490#define LCA(kc) (QK_LCTL | QK_LALT | (kc))
483 491
484#define MOD_HYPR 0xf 492#define MOD_HYPR 0xf
485#define MOD_MEH 0x7 493#define MOD_MEH 0x7
@@ -557,26 +565,29 @@ enum quantum_keycodes {
557#define KC_DELT KC_DELETE // Del key (four letter code) 565#define KC_DELT KC_DELETE // Del key (four letter code)
558 566
559// Alias for function layers than expand past FN31 567// Alias for function layers than expand past FN31
560#define FUNC(kc) (kc | QK_FUNCTION) 568#define FUNC(kc) (QK_FUNCTION | (kc))
561 569
562// Aliases 570// Aliases
563#define S(kc) LSFT(kc) 571#define S(kc) LSFT(kc)
564#define F(kc) FUNC(kc) 572#define F(kc) FUNC(kc)
565 573
566#define M(kc) (kc | QK_MACRO) 574#define M(kc) (QK_MACRO | (kc))
567 575
568#define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8) 576#define MACROTAP(kc) (QK_MACRO | (FUNC_TAP << 8) | (kc))
569#define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE) 577#define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
570 578
571#define KC_GESC GRAVE_ESC 579#define KC_GESC GRAVE_ESC
572 580
581#define EEP_RST EEPROM_RESET
582
573#define CK_TOGG CLICKY_TOGGLE 583#define CK_TOGG CLICKY_TOGGLE
574#define CK_RST CLICKY_RESET 584#define CK_RST CLICKY_RESET
575#define CK_UP CLICKY_UP 585#define CK_UP CLICKY_UP
576#define CK_DOWN CLICKY_DOWN 586#define CK_DOWN CLICKY_DOWN
587#define CK_ON CLICKY_ENABLE
588#define CK_OFF CLICKY_DISABLE
577 589
578#define RGB_MOD RGB_MODE_FORWARD 590#define RGB_MOD RGB_MODE_FORWARD
579#define RGB_SMOD RGB_MODE_FORWARD
580#define RGB_RMOD RGB_MODE_REVERSE 591#define RGB_RMOD RGB_MODE_REVERSE
581 592
582#define RGB_M_P RGB_MODE_PLAIN 593#define RGB_M_P RGB_MODE_PLAIN
@@ -590,10 +601,11 @@ enum quantum_keycodes {
590#define RGB_M_T RGB_MODE_RGBTEST 601#define RGB_M_T RGB_MODE_RGBTEST
591 602
592// L-ayer, T-ap - 256 keycode max, 16 layer max 603// L-ayer, T-ap - 256 keycode max, 16 layer max
593#define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8)) 604#define LT(layer, kc) (QK_LAYER_TAP | ((layer & 0xF) << 8) | ((kc) & 0xFF))
594 605
595#define AG_SWAP MAGIC_SWAP_ALT_GUI 606#define AG_SWAP MAGIC_SWAP_ALT_GUI
596#define AG_NORM MAGIC_UNSWAP_ALT_GUI 607#define AG_NORM MAGIC_UNSWAP_ALT_GUI
608#define AG_TOGG MAGIC_TOGGLE_ALT_GUI
597 609
598// GOTO layer - 16 layers max 610// GOTO layer - 16 layers max
599// when: 611// when:
@@ -602,32 +614,32 @@ enum quantum_keycodes {
602// Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default. 614// Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
603// In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own 615// In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
604// keycode modeled after the old version, kept below for this. 616// keycode modeled after the old version, kept below for this.
605/* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */ 617/* #define TO(layer, when) (QK_TO | (when << 0x4) | (layer & 0xFF)) */
606#define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4)) 618#define TO(layer) (QK_TO | (ON_PRESS << 0x4) | (layer & 0xFF))
607 619
608// Momentary switch layer - 256 layer max 620// Momentary switch layer - 256 layer max
609#define MO(layer) (layer | QK_MOMENTARY) 621#define MO(layer) (QK_MOMENTARY | (layer & 0xFF))
610 622
611// Set default layer - 256 layer max 623// Set default layer - 256 layer max
612#define DF(layer) (layer | QK_DEF_LAYER) 624#define DF(layer) (QK_DEF_LAYER | (layer & 0xFF))
613 625
614// Toggle to layer - 256 layer max 626// Toggle to layer - 256 layer max
615#define TG(layer) (layer | QK_TOGGLE_LAYER) 627#define TG(layer) (QK_TOGGLE_LAYER | (layer & 0xFF))
616 628
617// One-shot layer - 256 layer max 629// One-shot layer - 256 layer max
618#define OSL(layer) (layer | QK_ONE_SHOT_LAYER) 630#define OSL(layer) (QK_ONE_SHOT_LAYER | (layer & 0xFF))
619 631
620// L-ayer M-od: Momentary switch layer with modifiers active - 16 layer max, left mods only 632// L-ayer M-od: Momentary switch layer with modifiers active - 16 layer max, left mods only
621#define LM(layer, mod) (QK_LAYER_MOD | (((layer) & 0xF) << 4) | ((mod) & 0xF)) 633#define LM(layer, mod) (QK_LAYER_MOD | ((layer & 0xF) << 4) | ((mod) & 0xF))
622 634
623// One-shot mod 635// One-shot mod
624#define OSM(mod) ((mod) | QK_ONE_SHOT_MOD) 636#define OSM(mod) (QK_ONE_SHOT_MOD | ((mod) & 0xFF))
625 637
626// Layer tap-toggle 638// Layer tap-toggle
627#define TT(layer) (layer | QK_LAYER_TAP_TOGGLE) 639#define TT(layer) (QK_LAYER_TAP_TOGGLE | (layer & 0xFF))
628 640
629// M-od, T-ap - 256 keycode max 641// M-od, T-ap - 256 keycode max
630#define MT(mod, kc) (kc | QK_MOD_TAP | (((mod) & 0x1F) << 8)) 642#define MT(mod, kc) (QK_MOD_TAP | (((mod) & 0x1F) << 8) | ((kc) & 0xFF))
631 643
632#define CTL_T(kc) MT(MOD_LCTL, kc) 644#define CTL_T(kc) MT(MOD_LCTL, kc)
633#define LCTL_T(kc) MT(MOD_LCTL, kc) 645#define LCTL_T(kc) MT(MOD_LCTL, kc)
@@ -640,7 +652,7 @@ enum quantum_keycodes {
640#define ALT_T(kc) MT(MOD_LALT, kc) 652#define ALT_T(kc) MT(MOD_LALT, kc)
641#define LALT_T(kc) MT(MOD_LALT, kc) 653#define LALT_T(kc) MT(MOD_LALT, kc)
642#define RALT_T(kc) MT(MOD_RALT, kc) 654#define RALT_T(kc) MT(MOD_RALT, kc)
643#define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR 655#define ALGR_T(kc) RALT_T(kc)
644 656
645#define GUI_T(kc) MT(MOD_LGUI, kc) 657#define GUI_T(kc) MT(MOD_LGUI, kc)
646#define CMD_T(kc) GUI_T(kc) 658#define CMD_T(kc) GUI_T(kc)
@@ -652,15 +664,15 @@ enum quantum_keycodes {
652#define RCMD_T(kc) RGUI_T(kc) 664#define RCMD_T(kc) RGUI_T(kc)
653#define RWIN_T(kc) RGUI_T(kc) 665#define RWIN_T(kc) RGUI_T(kc)
654 666
655#define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal 667#define C_S_T(kc) MT(MOD_LCTL | MOD_LSFT, kc) // Control + Shift e.g. for gnome-terminal
656#define MEH_T(kc) MT((MOD_LCTL | MOD_LSFT | MOD_LALT), kc) // Meh is a less hyper version of the Hyper key -- doesn't include Win or Cmd, so just alt+shift+ctrl 668#define MEH_T(kc) MT(MOD_LCTL | MOD_LSFT | MOD_LALT, kc) // Meh is a less hyper version of the Hyper key -- doesn't include Win or Cmd, so just alt+shift+ctrl
657#define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui 669#define LCAG_T(kc) MT(MOD_LCTL | MOD_LALT | MOD_LGUI, kc) // Left control alt and gui
658#define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui 670#define RCAG_T(kc) MT(MOD_RCTL | MOD_RALT | MOD_RGUI, kc) // Right control alt and gui
659#define ALL_T(kc) MT((MOD_LCTL | MOD_LSFT | MOD_LALT | MOD_LGUI), kc) // see http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/ 671#define ALL_T(kc) MT(MOD_LCTL | MOD_LSFT | MOD_LALT | MOD_LGUI, kc) // see http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/
660#define SGUI_T(kc) MT((MOD_LGUI | MOD_LSFT), kc) 672#define SGUI_T(kc) MT(MOD_LGUI | MOD_LSFT, kc)
661#define SCMD_T(kc) SGUI_T(kc) 673#define SCMD_T(kc) SGUI_T(kc)
662#define SWIN_T(kc) SGUI_T(kc) 674#define SWIN_T(kc) SGUI_T(kc)
663#define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt 675#define LCA_T(kc) MT(MOD_LCTL | MOD_LALT, kc) // Left control and left alt
664 676
665// Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap 677// Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
666#define KC_HYPR HYPR(KC_NO) 678#define KC_HYPR HYPR(KC_NO)
@@ -670,22 +682,31 @@ enum quantum_keycodes {
670 // For sending unicode codes. 682 // For sending unicode codes.
671 // You may not send codes over 7FFF -- this supports most of UTF8. 683 // You may not send codes over 7FFF -- this supports most of UTF8.
672 // To have a key that sends out Œ, go UC(0x0152) 684 // To have a key that sends out Œ, go UC(0x0152)
673 #define UNICODE(n) (n | QK_UNICODE) 685 #define UNICODE(n) (QK_UNICODE | (n))
674 #define UC(n) UNICODE(n) 686 #define UC(n) UNICODE(n)
675#endif 687#endif
676 688
677#ifdef UNICODEMAP_ENABLE 689#ifdef UNICODEMAP_ENABLE
678 #define X(n) (n | QK_UNICODE_MAP) 690 #define X(n) (QK_UNICODE_MAP | (n))
679#endif 691#endif
680 692
693#define UC_MOD UNICODE_MODE_FORWARD
694#define UC_RMOD UNICODE_MODE_REVERSE
695
696#define UC_M_OS UNICODE_MODE_OSX
697#define UC_M_LN UNICODE_MODE_LNX
698#define UC_M_WI UNICODE_MODE_WIN
699#define UC_M_BS UNICODE_MODE_BSD
700#define UC_M_WC UNICODE_MODE_WINC
701
681#ifdef SWAP_HANDS_ENABLE 702#ifdef SWAP_HANDS_ENABLE
682 #define SH_T(key) (QK_SWAP_HANDS | key) 703 #define SH_T(kc) (QK_SWAP_HANDS | (kc))
683 #define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE) 704 #define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE)
684 #define SH_TT (QK_SWAP_HANDS | OP_SH_TAP_TOGGLE) 705 #define SH_TT (QK_SWAP_HANDS | OP_SH_TAP_TOGGLE)
685 #define SH_MON (QK_SWAP_HANDS | OP_SH_ON_OFF) 706 #define SH_MON (QK_SWAP_HANDS | OP_SH_ON_OFF)
686 #define SH_MOFF (QK_SWAP_HANDS | OP_SH_OFF_ON) 707 #define SH_MOFF (QK_SWAP_HANDS | OP_SH_OFF_ON)
687 #define SH_ON (QK_SWAP_HANDS | OP_SH_ON) 708 #define SH_ON (QK_SWAP_HANDS | OP_SH_ON)
688 #define SH_OFF (QK_SWAP_HANDS | OP_SH_OFF) 709 #define SH_OFF (QK_SWAP_HANDS | OP_SH_OFF)
689#endif 710#endif
690 711
691#endif // QUANTUM_KEYCODES_H 712#endif // QUANTUM_KEYCODES_H