1 /* Copyright 2016-2017 Jack Humbert
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #ifndef QUANTUM_KEYCODES_H
17 #define QUANTUM_KEYCODES_H
19 #ifndef MIDI_ENABLE_STRICT
20 #define MIDI_ENABLE_STRICT 0
23 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
24 #ifndef MIDI_TONE_KEYCODE_OCTAVES
25 #define MIDI_TONE_KEYCODE_OCTAVES 3
29 // Fillers to make layering more clear
30 #define _______ KC_TRNS
33 enum quantum_keycodes {
34 // Ranges used in shortucuts - not to be used directly
42 QK_RMODS_MIN = 0x1000,
49 QK_FUNCTION_MAX = 0x2FFF,
51 QK_MACRO_MAX = 0x3FFF,
52 QK_LAYER_TAP = 0x4000,
53 QK_LAYER_TAP_MAX = 0x4FFF,
56 QK_MOMENTARY = 0x5100,
57 QK_MOMENTARY_MAX = 0x51FF,
58 QK_DEF_LAYER = 0x5200,
59 QK_DEF_LAYER_MAX = 0x52FF,
60 QK_TOGGLE_LAYER = 0x5300,
61 QK_TOGGLE_LAYER_MAX = 0x53FF,
62 QK_ONE_SHOT_LAYER = 0x5400,
63 QK_ONE_SHOT_LAYER_MAX = 0x54FF,
64 QK_ONE_SHOT_MOD = 0x5500,
65 QK_ONE_SHOT_MOD_MAX = 0x55FF,
66 #ifndef DISABLE_CHORDING
68 QK_CHORDING_MAX = 0x56FF,
70 QK_TAP_DANCE = 0x5700,
71 QK_TAP_DANCE_MAX = 0x57FF,
72 QK_LAYER_TAP_TOGGLE = 0x5800,
73 QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
74 QK_LAYER_MOD = 0x5900,
75 QK_LAYER_MOD_MAX = 0x59FF,
78 QK_STENO_BOLT = 0x5A30,
79 QK_STENO_GEMINI = 0x5A31,
80 QK_STENO_MAX = 0x5A3F,
82 #ifdef SWAP_HANDS_ENABLE
83 QK_SWAP_HANDS = 0x5B00,
84 QK_SWAP_HANDS_MAX = 0x5BFF,
87 QK_MOD_TAP_MAX = 0x7FFF,
88 #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
89 #error "Cannot enable both UNICODEMAP && UNICODE"
93 QK_UNICODE_MAX = 0xFFFF,
95 #ifdef UNICODEMAP_ENABLE
96 QK_UNICODE_MAP = 0x8000,
97 QK_UNICODE_MAP_MAX = 0x83FF,
100 // Loose keycodes - to be used directly
104 MAGIC_SWAP_CONTROL_CAPSLOCK,
105 MAGIC_CAPSLOCK_TO_CONTROL,
106 MAGIC_SWAP_LALT_LGUI,
107 MAGIC_SWAP_RALT_RGUI,
109 MAGIC_SWAP_GRAVE_ESC,
110 MAGIC_SWAP_BACKSLASH_BACKSPACE,
113 MAGIC_UNSWAP_CONTROL_CAPSLOCK,
114 MAGIC_UNCAPSLOCK_TO_CONTROL,
115 MAGIC_UNSWAP_LALT_LGUI,
116 MAGIC_UNSWAP_RALT_RGUI,
118 MAGIC_UNSWAP_GRAVE_ESC,
119 MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
121 MAGIC_UNSWAP_ALT_GUI,
126 #ifndef DISABLE_LEADER
138 // Audio on/off/toggle
143 // Faux clicky as part of main audio feature
149 #ifdef FAUXCLICKY_ENABLE
156 // Music mode on/off/toggle
164 // Music voice iterate
169 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
175 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
178 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
179 MI_C = MIDI_TONE_MIN,
198 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
218 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
238 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
258 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
278 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
298 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
299 MIDI_TONE_MAX = MI_B_5,
300 #elif MIDI_TONE_KEYCODE_OCTAVES > 4
301 MIDI_TONE_MAX = MI_B_4,
302 #elif MIDI_TONE_KEYCODE_OCTAVES > 3
303 MIDI_TONE_MAX = MI_B_3,
304 #elif MIDI_TONE_KEYCODE_OCTAVES > 2
305 MIDI_TONE_MAX = MI_B_2,
306 #elif MIDI_TONE_KEYCODE_OCTAVES > 1
307 MIDI_TONE_MAX = MI_B_1,
308 #elif MIDI_TONE_KEYCODE_OCTAVES > 0
309 MIDI_TONE_MAX = MI_B,
313 MI_OCT_N2 = MIDI_OCTAVE_MIN,
323 MIDI_OCTAVE_MAX = MI_OCT_7,
324 MI_OCTD, // octave down
325 MI_OCTU, // octave up
328 MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
341 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
342 MI_TRNSD, // transpose down
343 MI_TRNSU, // transpose up
346 MI_VEL_1 = MIDI_VELOCITY_MIN,
356 MIDI_VELOCITY_MAX = MI_VEL_10,
357 MI_VELD, // velocity down
358 MI_VELU, // velocity up
361 MI_CH1 = MIDI_CHANNEL_MIN,
377 MIDI_CHANNEL_MAX = MI_CH16,
378 MI_CHD, // previous channel
379 MI_CHU, // next channel
381 MI_ALLOFF, // all notes off
384 MI_PORT, // portamento
385 MI_SOST, // sostenuto
386 MI_SOFT, // soft pedal
389 MI_MOD, // modulation
390 MI_MODSD, // decrease modulation speed
391 MI_MODSU, // increase modulation speed
393 MI_BENDD, // Bend down
395 #endif // MIDI_ADVANCED
397 // Backlight functionality
428 // Left shift, open paren
431 // Right shift, close paren
444 #ifdef BLUETOOTH_ENABLE
448 #ifdef KEY_LOCK_ENABLE
452 #ifdef TERMINAL_ENABLE
457 // always leave at the end
461 // Ability to use mods in layouts
462 #define LCTL(kc) (kc | QK_LCTL)
463 #define LSFT(kc) (kc | QK_LSFT)
464 #define LALT(kc) (kc | QK_LALT)
465 #define LGUI(kc) (kc | QK_LGUI)
466 #define LCMD(kc) LGUI(kc)
467 #define LWIN(kc) LGUI(kc)
468 #define RCTL(kc) (kc | QK_RCTL)
469 #define RSFT(kc) (kc | QK_RSFT)
470 #define RALT(kc) (kc | QK_RALT)
471 #define RGUI(kc) (kc | QK_RGUI)
472 #define RCMD(kc) RGUI(kc)
473 #define RWIN(kc) RGUI(kc)
475 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
476 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
477 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
478 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
479 #define SGUI(kc) (kc | QK_LGUI | QK_LSFT)
480 #define SCMD(kc) SGUI(kc)
481 #define SWIN(kc) SGUI(kc)
482 #define LCA(kc) (kc | QK_LCTL | QK_LALT)
488 // Aliases for shifted symbols
489 // Each key has a 4-letter code, and some have longer aliases too.
490 // While the long aliases are descriptive, the 4-letter codes
491 // make for nicer grid layouts (everything lines up), and are
492 // the preferred style for Quantum.
493 #define KC_TILD LSFT(KC_GRV) // ~
494 #define KC_TILDE KC_TILD
496 #define KC_EXLM LSFT(KC_1) // !
497 #define KC_EXCLAIM KC_EXLM
499 #define KC_AT LSFT(KC_2) // @
501 #define KC_HASH LSFT(KC_3) // #
503 #define KC_DLR LSFT(KC_4) // $
504 #define KC_DOLLAR KC_DLR
506 #define KC_PERC LSFT(KC_5) // %
507 #define KC_PERCENT KC_PERC
509 #define KC_CIRC LSFT(KC_6) // ^
510 #define KC_CIRCUMFLEX KC_CIRC
512 #define KC_AMPR LSFT(KC_7) // &
513 #define KC_AMPERSAND KC_AMPR
515 #define KC_ASTR LSFT(KC_8) // *
516 #define KC_ASTERISK KC_ASTR
518 #define KC_LPRN LSFT(KC_9) // (
519 #define KC_LEFT_PAREN KC_LPRN
521 #define KC_RPRN LSFT(KC_0) // )
522 #define KC_RIGHT_PAREN KC_RPRN
524 #define KC_UNDS LSFT(KC_MINS) // _
525 #define KC_UNDERSCORE KC_UNDS
527 #define KC_PLUS LSFT(KC_EQL) // +
529 #define KC_LCBR LSFT(KC_LBRC) // {
530 #define KC_LEFT_CURLY_BRACE KC_LCBR
532 #define KC_RCBR LSFT(KC_RBRC) // }
533 #define KC_RIGHT_CURLY_BRACE KC_RCBR
535 #define KC_LABK LSFT(KC_COMM) // <
536 #define KC_LEFT_ANGLE_BRACKET KC_LABK
538 #define KC_RABK LSFT(KC_DOT) // >
539 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
541 #define KC_COLN LSFT(KC_SCLN) // :
542 #define KC_COLON KC_COLN
544 #define KC_PIPE LSFT(KC_BSLS) // |
546 #define KC_LT LSFT(KC_COMM) // <
548 #define KC_GT LSFT(KC_DOT) // >
550 #define KC_QUES LSFT(KC_SLSH) // ?
551 #define KC_QUESTION KC_QUES
553 #define KC_DQT LSFT(KC_QUOT) // "
554 #define KC_DOUBLE_QUOTE KC_DQT
555 #define KC_DQUO KC_DQT
557 #define KC_DELT KC_DELETE // Del key (four letter code)
559 // Alias for function layers than expand past FN31
560 #define FUNC(kc) (kc | QK_FUNCTION)
563 #define S(kc) LSFT(kc)
564 #define F(kc) FUNC(kc)
566 #define M(kc) (kc | QK_MACRO)
568 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
569 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
571 #define KC_GESC GRAVE_ESC
573 #define CK_TOGG CLICKY_TOGGLE
574 #define CK_RST CLICKY_RESET
575 #define CK_UP CLICKY_UP
576 #define CK_DOWN CLICKY_DOWN
578 #define RGB_MOD RGB_MODE_FORWARD
579 #define RGB_SMOD RGB_MODE_FORWARD
580 #define RGB_RMOD RGB_MODE_REVERSE
582 #define RGB_M_P RGB_MODE_PLAIN
583 #define RGB_M_B RGB_MODE_BREATHE
584 #define RGB_M_R RGB_MODE_RAINBOW
585 #define RGB_M_SW RGB_MODE_SWIRL
586 #define RGB_M_SN RGB_MODE_SNAKE
587 #define RGB_M_K RGB_MODE_KNIGHT
588 #define RGB_M_X RGB_MODE_XMAS
589 #define RGB_M_G RGB_MODE_GRADIENT
590 #define RGB_M_T RGB_MODE_RGBTEST
592 // L-ayer, T-ap - 256 keycode max, 16 layer max
593 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
595 #define AG_SWAP MAGIC_SWAP_ALT_GUI
596 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
598 // GOTO layer - 16 layers max
602 // 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
604 // keycode modeled after the old version, kept below for this.
605 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
606 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
608 // Momentary switch layer - 256 layer max
609 #define MO(layer) (layer | QK_MOMENTARY)
611 // Set default layer - 256 layer max
612 #define DF(layer) (layer | QK_DEF_LAYER)
614 // Toggle to layer - 256 layer max
615 #define TG(layer) (layer | QK_TOGGLE_LAYER)
617 // One-shot layer - 256 layer max
618 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
620 // 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))
624 #define OSM(mod) ((mod) | QK_ONE_SHOT_MOD)
627 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
629 // M-od, T-ap - 256 keycode max
630 #define MT(mod, kc) (kc | QK_MOD_TAP | (((mod) & 0x1F) << 8))
632 #define CTL_T(kc) MT(MOD_LCTL, kc)
633 #define LCTL_T(kc) MT(MOD_LCTL, kc)
634 #define RCTL_T(kc) MT(MOD_RCTL, kc)
636 #define SFT_T(kc) MT(MOD_LSFT, kc)
637 #define LSFT_T(kc) MT(MOD_LSFT, kc)
638 #define RSFT_T(kc) MT(MOD_RSFT, kc)
640 #define ALT_T(kc) MT(MOD_LALT, kc)
641 #define LALT_T(kc) MT(MOD_LALT, kc)
642 #define RALT_T(kc) MT(MOD_RALT, kc)
643 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
645 #define GUI_T(kc) MT(MOD_LGUI, kc)
646 #define CMD_T(kc) GUI_T(kc)
647 #define WIN_T(kc) GUI_T(kc)
648 #define LGUI_T(kc) MT(MOD_LGUI, kc)
649 #define LCMD_T(kc) LGUI_T(kc)
650 #define LWIN_T(kc) LGUI_T(kc)
651 #define RGUI_T(kc) MT(MOD_RGUI, kc)
652 #define RCMD_T(kc) RGUI_T(kc)
653 #define RWIN_T(kc) RGUI_T(kc)
655 #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
657 #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
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/
660 #define SGUI_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
661 #define SCMD_T(kc) SGUI_T(kc)
662 #define SWIN_T(kc) SGUI_T(kc)
663 #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
665 // 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)
667 #define KC_MEH MEH(KC_NO)
669 #ifdef UNICODE_ENABLE
670 // For sending unicode codes.
671 // You may not send codes over 7FFF -- this supports most of UTF8.
672 // To have a key that sends out Œ, go UC(0x0152)
673 #define UNICODE(n) (n | QK_UNICODE)
674 #define UC(n) UNICODE(n)
677 #ifdef UNICODEMAP_ENABLE
678 #define X(n) (n | QK_UNICODE_MAP)
681 #ifdef SWAP_HANDS_ENABLE
682 #define SH_T(key) (QK_SWAP_HANDS | key)
683 #define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE)
684 #define SH_TT (QK_SWAP_HANDS | OP_SH_TAP_TOGGLE)
685 #define SH_MON (QK_SWAP_HANDS | OP_SH_ON_OFF)
686 #define SH_MOFF (QK_SWAP_HANDS | OP_SH_OFF_ON)
687 #define SH_ON (QK_SWAP_HANDS | OP_SH_ON)
688 #define SH_OFF (QK_SWAP_HANDS | OP_SH_OFF)
691 #endif // QUANTUM_KEYCODES_H