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 QK_TAP_DANCE = 0x5700,
67 QK_TAP_DANCE_MAX = 0x57FF,
68 QK_LAYER_TAP_TOGGLE = 0x5800,
69 QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
70 QK_LAYER_MOD = 0x5900,
71 QK_LAYER_MOD_MAX = 0x59FF,
74 QK_STENO_BOLT = 0x5A30,
75 QK_STENO_GEMINI = 0x5A31,
76 QK_STENO_MAX = 0x5A3F,
78 #ifdef SWAP_HANDS_ENABLE
79 QK_SWAP_HANDS = 0x5B00,
80 QK_SWAP_HANDS_MAX = 0x5BFF,
83 QK_MOD_TAP_MAX = 0x7FFF,
84 #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
85 #error "Cannot enable both UNICODEMAP && UNICODE"
89 QK_UNICODE_MAX = 0xFFFF,
91 #ifdef UNICODEMAP_ENABLE
92 QK_UNICODE_MAP = 0x8000,
93 QK_UNICODE_MAP_MAX = 0x83FF,
96 // Loose keycodes - to be used directly
100 MAGIC_SWAP_CONTROL_CAPSLOCK,
101 MAGIC_CAPSLOCK_TO_CONTROL,
102 MAGIC_SWAP_LALT_LGUI,
103 MAGIC_SWAP_RALT_RGUI,
105 MAGIC_SWAP_GRAVE_ESC,
106 MAGIC_SWAP_BACKSLASH_BACKSPACE,
109 MAGIC_UNSWAP_CONTROL_CAPSLOCK,
110 MAGIC_UNCAPSLOCK_TO_CONTROL,
111 MAGIC_UNSWAP_LALT_LGUI,
112 MAGIC_UNSWAP_RALT_RGUI,
114 MAGIC_UNSWAP_GRAVE_ESC,
115 MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
117 MAGIC_UNSWAP_ALT_GUI,
134 // Audio on/off/toggle
139 // Faux clicky as part of main audio feature
145 #ifdef FAUXCLICKY_ENABLE
152 // Music mode on/off/toggle
160 // Music voice iterate
165 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
171 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
174 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
175 MI_C = MIDI_TONE_MIN,
194 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
214 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
234 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
254 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
274 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
294 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
295 MIDI_TONE_MAX = MI_B_5,
296 #elif MIDI_TONE_KEYCODE_OCTAVES > 4
297 MIDI_TONE_MAX = MI_B_4,
298 #elif MIDI_TONE_KEYCODE_OCTAVES > 3
299 MIDI_TONE_MAX = MI_B_3,
300 #elif MIDI_TONE_KEYCODE_OCTAVES > 2
301 MIDI_TONE_MAX = MI_B_2,
302 #elif MIDI_TONE_KEYCODE_OCTAVES > 1
303 MIDI_TONE_MAX = MI_B_1,
304 #elif MIDI_TONE_KEYCODE_OCTAVES > 0
305 MIDI_TONE_MAX = MI_B,
309 MI_OCT_N2 = MIDI_OCTAVE_MIN,
319 MIDI_OCTAVE_MAX = MI_OCT_7,
320 MI_OCTD, // octave down
321 MI_OCTU, // octave up
324 MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
337 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
338 MI_TRNSD, // transpose down
339 MI_TRNSU, // transpose up
342 MI_VEL_1 = MIDI_VELOCITY_MIN,
352 MIDI_VELOCITY_MAX = MI_VEL_10,
353 MI_VELD, // velocity down
354 MI_VELU, // velocity up
357 MI_CH1 = MIDI_CHANNEL_MIN,
373 MIDI_CHANNEL_MAX = MI_CH16,
374 MI_CHD, // previous channel
375 MI_CHU, // next channel
377 MI_ALLOFF, // all notes off
380 MI_PORT, // portamento
381 MI_SOST, // sostenuto
382 MI_SOFT, // soft pedal
385 MI_MOD, // modulation
386 MI_MODSD, // decrease modulation speed
387 MI_MODSU, // increase modulation speed
389 MI_BENDD, // Bend down
391 #endif // MIDI_ADVANCED
393 // Backlight functionality
424 // Left shift, open paren
427 // Right shift, close paren
440 #ifdef BLUETOOTH_ENABLE
444 #ifdef KEY_LOCK_ENABLE
448 #ifdef TERMINAL_ENABLE
453 // always leave at the end
457 // Ability to use mods in layouts
458 #define LCTL(kc) (QK_LCTL | (kc))
459 #define LSFT(kc) (QK_LSFT | (kc))
460 #define LALT(kc) (QK_LALT | (kc))
461 #define LGUI(kc) (QK_LGUI | (kc))
462 #define LCMD(kc) LGUI(kc)
463 #define LWIN(kc) LGUI(kc)
464 #define RCTL(kc) (QK_RCTL | (kc))
465 #define RSFT(kc) (QK_RSFT | (kc))
466 #define RALT(kc) (QK_RALT | (kc))
467 #define RGUI(kc) (QK_RGUI | (kc))
468 #define RCMD(kc) RGUI(kc)
469 #define RWIN(kc) RGUI(kc)
471 #define HYPR(kc) (QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI | (kc))
472 #define MEH(kc) (QK_LCTL | QK_LSFT | QK_LALT | (kc))
473 #define LCAG(kc) (QK_LCTL | QK_LALT | QK_LGUI | (kc))
474 #define ALTG(kc) (QK_RCTL | QK_RALT | (kc))
475 #define SGUI(kc) (QK_LGUI | QK_LSFT | (kc))
476 #define SCMD(kc) SGUI(kc)
477 #define SWIN(kc) SGUI(kc)
478 #define LCA(kc) (QK_LCTL | QK_LALT | (kc))
484 // Aliases for shifted symbols
485 // Each key has a 4-letter code, and some have longer aliases too.
486 // While the long aliases are descriptive, the 4-letter codes
487 // make for nicer grid layouts (everything lines up), and are
488 // the preferred style for Quantum.
489 #define KC_TILD LSFT(KC_GRV) // ~
490 #define KC_TILDE KC_TILD
492 #define KC_EXLM LSFT(KC_1) // !
493 #define KC_EXCLAIM KC_EXLM
495 #define KC_AT LSFT(KC_2) // @
497 #define KC_HASH LSFT(KC_3) // #
499 #define KC_DLR LSFT(KC_4) // $
500 #define KC_DOLLAR KC_DLR
502 #define KC_PERC LSFT(KC_5) // %
503 #define KC_PERCENT KC_PERC
505 #define KC_CIRC LSFT(KC_6) // ^
506 #define KC_CIRCUMFLEX KC_CIRC
508 #define KC_AMPR LSFT(KC_7) // &
509 #define KC_AMPERSAND KC_AMPR
511 #define KC_ASTR LSFT(KC_8) // *
512 #define KC_ASTERISK KC_ASTR
514 #define KC_LPRN LSFT(KC_9) // (
515 #define KC_LEFT_PAREN KC_LPRN
517 #define KC_RPRN LSFT(KC_0) // )
518 #define KC_RIGHT_PAREN KC_RPRN
520 #define KC_UNDS LSFT(KC_MINS) // _
521 #define KC_UNDERSCORE KC_UNDS
523 #define KC_PLUS LSFT(KC_EQL) // +
525 #define KC_LCBR LSFT(KC_LBRC) // {
526 #define KC_LEFT_CURLY_BRACE KC_LCBR
528 #define KC_RCBR LSFT(KC_RBRC) // }
529 #define KC_RIGHT_CURLY_BRACE KC_RCBR
531 #define KC_LABK LSFT(KC_COMM) // <
532 #define KC_LEFT_ANGLE_BRACKET KC_LABK
534 #define KC_RABK LSFT(KC_DOT) // >
535 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
537 #define KC_COLN LSFT(KC_SCLN) // :
538 #define KC_COLON KC_COLN
540 #define KC_PIPE LSFT(KC_BSLS) // |
542 #define KC_LT LSFT(KC_COMM) // <
544 #define KC_GT LSFT(KC_DOT) // >
546 #define KC_QUES LSFT(KC_SLSH) // ?
547 #define KC_QUESTION KC_QUES
549 #define KC_DQT LSFT(KC_QUOT) // "
550 #define KC_DOUBLE_QUOTE KC_DQT
551 #define KC_DQUO KC_DQT
553 #define KC_DELT KC_DELETE // Del key (four letter code)
555 // Alias for function layers than expand past FN31
556 #define FUNC(kc) (QK_FUNCTION | (kc))
559 #define S(kc) LSFT(kc)
560 #define F(kc) FUNC(kc)
562 #define M(kc) (QK_MACRO | (kc))
564 #define MACROTAP(kc) (QK_MACRO | (FUNC_TAP << 8) | (kc))
565 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
567 #define KC_GESC GRAVE_ESC
569 #define CK_TOGG CLICKY_TOGGLE
570 #define CK_RST CLICKY_RESET
571 #define CK_UP CLICKY_UP
572 #define CK_DOWN CLICKY_DOWN
574 #define RGB_MOD RGB_MODE_FORWARD
575 #define RGB_SMOD RGB_MODE_FORWARD
576 #define RGB_RMOD RGB_MODE_REVERSE
578 #define RGB_M_P RGB_MODE_PLAIN
579 #define RGB_M_B RGB_MODE_BREATHE
580 #define RGB_M_R RGB_MODE_RAINBOW
581 #define RGB_M_SW RGB_MODE_SWIRL
582 #define RGB_M_SN RGB_MODE_SNAKE
583 #define RGB_M_K RGB_MODE_KNIGHT
584 #define RGB_M_X RGB_MODE_XMAS
585 #define RGB_M_G RGB_MODE_GRADIENT
586 #define RGB_M_T RGB_MODE_RGBTEST
588 // L-ayer, T-ap - 256 keycode max, 16 layer max
589 #define LT(layer, kc) (QK_LAYER_TAP | ((layer & 0xF) << 8) | ((kc) & 0xFF))
591 #define AG_SWAP MAGIC_SWAP_ALT_GUI
592 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
594 // GOTO layer - 16 layers max
598 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
599 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
600 // keycode modeled after the old version, kept below for this.
601 /* #define TO(layer, when) (QK_TO | (when << 0x4) | (layer & 0xFF)) */
602 #define TO(layer) (QK_TO | (ON_PRESS << 0x4) | (layer & 0xFF))
604 // Momentary switch layer - 256 layer max
605 #define MO(layer) (QK_MOMENTARY | (layer & 0xFF))
607 // Set default layer - 256 layer max
608 #define DF(layer) (QK_DEF_LAYER | (layer & 0xFF))
610 // Toggle to layer - 256 layer max
611 #define TG(layer) (QK_TOGGLE_LAYER | (layer & 0xFF))
613 // One-shot layer - 256 layer max
614 #define OSL(layer) (QK_ONE_SHOT_LAYER | (layer & 0xFF))
616 // L-ayer M-od: Momentary switch layer with modifiers active - 16 layer max, left mods only
617 #define LM(layer, mod) (QK_LAYER_MOD | ((layer & 0xF) << 4) | ((mod) & 0xF))
620 #define OSM(mod) (QK_ONE_SHOT_MOD | ((mod) & 0xFF))
623 #define TT(layer) (QK_LAYER_TAP_TOGGLE | (layer & 0xFF))
625 // M-od, T-ap - 256 keycode max
626 #define MT(mod, kc) (QK_MOD_TAP | (((mod) & 0x1F) << 8) | ((kc) & 0xFF))
628 #define CTL_T(kc) MT(MOD_LCTL, kc)
629 #define LCTL_T(kc) MT(MOD_LCTL, kc)
630 #define RCTL_T(kc) MT(MOD_RCTL, kc)
632 #define SFT_T(kc) MT(MOD_LSFT, kc)
633 #define LSFT_T(kc) MT(MOD_LSFT, kc)
634 #define RSFT_T(kc) MT(MOD_RSFT, kc)
636 #define ALT_T(kc) MT(MOD_LALT, kc)
637 #define LALT_T(kc) MT(MOD_LALT, kc)
638 #define RALT_T(kc) MT(MOD_RALT, kc)
639 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
641 #define GUI_T(kc) MT(MOD_LGUI, kc)
642 #define CMD_T(kc) GUI_T(kc)
643 #define WIN_T(kc) GUI_T(kc)
644 #define LGUI_T(kc) MT(MOD_LGUI, kc)
645 #define LCMD_T(kc) LGUI_T(kc)
646 #define LWIN_T(kc) LGUI_T(kc)
647 #define RGUI_T(kc) MT(MOD_RGUI, kc)
648 #define RCMD_T(kc) RGUI_T(kc)
649 #define RWIN_T(kc) RGUI_T(kc)
651 #define C_S_T(kc) MT(MOD_LCTL | MOD_LSFT, kc) // Control + Shift e.g. for gnome-terminal
652 #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
653 #define LCAG_T(kc) MT(MOD_LCTL | MOD_LALT | MOD_LGUI, kc) // Left control alt and gui
654 #define RCAG_T(kc) MT(MOD_RCTL | MOD_RALT | MOD_RGUI, kc) // Right control alt and gui
655 #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/
656 #define SGUI_T(kc) MT(MOD_LGUI | MOD_LSFT, kc)
657 #define SCMD_T(kc) SGUI_T(kc)
658 #define SWIN_T(kc) SGUI_T(kc)
659 #define LCA_T(kc) MT(MOD_LCTL | MOD_LALT, kc) // Left control and left alt
661 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
662 #define KC_HYPR HYPR(KC_NO)
663 #define KC_MEH MEH(KC_NO)
665 #ifdef UNICODE_ENABLE
666 // For sending unicode codes.
667 // You may not send codes over 7FFF -- this supports most of UTF8.
668 // To have a key that sends out Œ, go UC(0x0152)
669 #define UNICODE(n) (QK_UNICODE | (n))
670 #define UC(n) UNICODE(n)
673 #ifdef UNICODEMAP_ENABLE
674 #define X(n) (QK_UNICODE_MAP | (n))
677 #ifdef SWAP_HANDS_ENABLE
678 #define SH_T(kc) (QK_SWAP_HANDS | (kc))
679 #define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE)
680 #define SH_TT (QK_SWAP_HANDS | OP_SH_TAP_TOGGLE)
681 #define SH_MON (QK_SWAP_HANDS | OP_SH_ON_OFF)
682 #define SH_MOFF (QK_SWAP_HANDS | OP_SH_OFF_ON)
683 #define SH_ON (QK_SWAP_HANDS | OP_SH_ON)
684 #define SH_OFF (QK_SWAP_HANDS | OP_SH_OFF)
687 #endif // QUANTUM_KEYCODES_H