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,
76 QK_STENO_BOLT = 0x5A30,
77 QK_STENO_GEMINI = 0x5A31,
78 QK_STENO_MAX = 0x5A3F,
81 QK_MOD_TAP_MAX = 0x7FFF,
82 #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
83 #error "Cannot enable both UNICODEMAP && UNICODE"
87 QK_UNICODE_MAX = 0xFFFF,
89 #ifdef UNICODEMAP_ENABLE
90 QK_UNICODE_MAP = 0x8000,
91 QK_UNICODE_MAP_MAX = 0x83FF,
94 // Loose keycodes - to be used directly
98 MAGIC_SWAP_CONTROL_CAPSLOCK,
99 MAGIC_CAPSLOCK_TO_CONTROL,
100 MAGIC_SWAP_LALT_LGUI,
101 MAGIC_SWAP_RALT_RGUI,
103 MAGIC_SWAP_GRAVE_ESC,
104 MAGIC_SWAP_BACKSLASH_BACKSPACE,
107 MAGIC_UNSWAP_CONTROL_CAPSLOCK,
108 MAGIC_UNCAPSLOCK_TO_CONTROL,
109 MAGIC_UNSWAP_LALT_LGUI,
110 MAGIC_UNSWAP_RALT_RGUI,
112 MAGIC_UNSWAP_GRAVE_ESC,
113 MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
115 MAGIC_UNSWAP_ALT_GUI,
120 #ifndef DISABLE_LEADER
129 // Audio on/off/toggle
134 #ifdef FAUXCLICKY_ENABLE
141 // Music mode on/off/toggle
149 // Music voice iterate
154 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
155 MI_ON, // send midi notes when music mode is enabled
156 MI_OFF, // don't send midi notes when music mode is enabled
159 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
162 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
163 MI_C = MIDI_TONE_MIN,
182 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
202 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
222 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
242 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
262 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
282 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
283 MIDI_TONE_MAX = MI_B_5,
284 #elif MIDI_TONE_KEYCODE_OCTAVES > 4
285 MIDI_TONE_MAX = MI_B_4,
286 #elif MIDI_TONE_KEYCODE_OCTAVES > 3
287 MIDI_TONE_MAX = MI_B_3,
288 #elif MIDI_TONE_KEYCODE_OCTAVES > 2
289 MIDI_TONE_MAX = MI_B_2,
290 #elif MIDI_TONE_KEYCODE_OCTAVES > 1
291 MIDI_TONE_MAX = MI_B_1,
292 #elif MIDI_TONE_KEYCODE_OCTAVES > 0
293 MIDI_TONE_MAX = MI_B,
297 MI_OCT_N2 = MIDI_OCTAVE_MIN,
307 MIDI_OCTAVE_MAX = MI_OCT_7,
308 MI_OCTD, // octave down
309 MI_OCTU, // octave up
312 MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
325 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
326 MI_TRNSD, // transpose down
327 MI_TRNSU, // transpose up
330 MI_VEL_1 = MIDI_VELOCITY_MIN,
340 MIDI_VELOCITY_MAX = MI_VEL_10,
341 MI_VELD, // velocity down
342 MI_VELU, // velocity up
345 MI_CH1 = MIDI_CHANNEL_MIN,
361 MIDI_CHANNEL_MAX = MI_CH16,
362 MI_CHD, // previous channel
363 MI_CHU, // next channel
365 MI_ALLOFF, // all notes off
368 MI_PORT, // portamento
369 MI_SOST, // sostenuto
370 MI_SOFT, // soft pedal
373 MI_MOD, // modulation
374 MI_MODSD, // decrease modulation speed
375 MI_MODSU, // increase modulation speed
376 #endif // MIDI_ADVANCED
378 // Backlight functionality
418 // Left shift, open paren
421 // Right shift, close paren
431 #ifdef BLUETOOTH_ENABLE
435 #ifdef KEY_LOCK_ENABLE
439 #ifdef TERMINAL_ENABLE
444 // always leave at the end
448 // Ability to use mods in layouts
449 #define LCTL(kc) (kc | QK_LCTL)
450 #define LSFT(kc) (kc | QK_LSFT)
451 #define LALT(kc) (kc | QK_LALT)
452 #define LGUI(kc) (kc | QK_LGUI)
453 #define RCTL(kc) (kc | QK_RCTL)
454 #define RSFT(kc) (kc | QK_RSFT)
455 #define RALT(kc) (kc | QK_RALT)
456 #define RGUI(kc) (kc | QK_RGUI)
458 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
459 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
460 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
461 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
462 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
463 #define SWIN(kc) SCMD(kc)
464 #define LCA(kc) (kc | QK_LCTL | QK_LALT)
470 // Aliases for shifted symbols
471 // Each key has a 4-letter code, and some have longer aliases too.
472 // While the long aliases are descriptive, the 4-letter codes
473 // make for nicer grid layouts (everything lines up), and are
474 // the preferred style for Quantum.
475 #define KC_TILD LSFT(KC_GRV) // ~
476 #define KC_TILDE KC_TILD
478 #define KC_EXLM LSFT(KC_1) // !
479 #define KC_EXCLAIM KC_EXLM
481 #define KC_AT LSFT(KC_2) // @
483 #define KC_HASH LSFT(KC_3) // #
485 #define KC_DLR LSFT(KC_4) // $
486 #define KC_DOLLAR KC_DLR
488 #define KC_PERC LSFT(KC_5) // %
489 #define KC_PERCENT KC_PERC
491 #define KC_CIRC LSFT(KC_6) // ^
492 #define KC_CIRCUMFLEX KC_CIRC
494 #define KC_AMPR LSFT(KC_7) // &
495 #define KC_AMPERSAND KC_AMPR
497 #define KC_ASTR LSFT(KC_8) // *
498 #define KC_ASTERISK KC_ASTR
500 #define KC_LPRN LSFT(KC_9) // (
501 #define KC_LEFT_PAREN KC_LPRN
503 #define KC_RPRN LSFT(KC_0) // )
504 #define KC_RIGHT_PAREN KC_RPRN
506 #define KC_UNDS LSFT(KC_MINS) // _
507 #define KC_UNDERSCORE KC_UNDS
509 #define KC_PLUS LSFT(KC_EQL) // +
511 #define KC_LCBR LSFT(KC_LBRC) // {
512 #define KC_LEFT_CURLY_BRACE KC_LCBR
514 #define KC_RCBR LSFT(KC_RBRC) // }
515 #define KC_RIGHT_CURLY_BRACE KC_RCBR
517 #define KC_LABK LSFT(KC_COMM) // <
518 #define KC_LEFT_ANGLE_BRACKET KC_LABK
520 #define KC_RABK LSFT(KC_DOT) // >
521 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
523 #define KC_COLN LSFT(KC_SCLN) // :
524 #define KC_COLON KC_COLN
526 #define KC_PIPE LSFT(KC_BSLS) // |
528 #define KC_LT LSFT(KC_COMM) // <
530 #define KC_GT LSFT(KC_DOT) // >
532 #define KC_QUES LSFT(KC_SLSH) // ?
533 #define KC_QUESTION KC_QUES
535 #define KC_DQT LSFT(KC_QUOT) // "
536 #define KC_DOUBLE_QUOTE KC_DQT
537 #define KC_DQUO KC_DQT
539 #define KC_DELT KC_DELETE // Del key (four letter code)
541 // Alias for function layers than expand past FN31
542 #define FUNC(kc) (kc | QK_FUNCTION)
545 #define S(kc) LSFT(kc)
546 #define F(kc) FUNC(kc)
548 #define M(kc) (kc | QK_MACRO)
550 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
551 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
553 #define KC_GESC GRAVE_ESC
555 #define RGB_M_P RGB_MODE_PLAIN
556 #define RGB_M_B RGB_MODE_BREATHE
557 #define RGB_M_R RGB_MODE_RAINBOW
558 #define RGB_M_SW RGB_MODE_SWIRL
559 #define RGB_M_SN RGB_MODE_SNAKE
560 #define RGB_M_K RGB_MODE_KNIGHT
561 #define RGB_M_X RGB_MODE_XMAS
562 #define RGB_M_G RGB_MODE_GRADIENT
564 // L-ayer, T-ap - 256 keycode max, 16 layer max
565 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
567 #define AG_SWAP MAGIC_SWAP_ALT_GUI
568 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
573 // GOTO layer - 16 layers max
577 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
578 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
579 // keycode modeled after the old version, kept below for this.
580 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
581 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
583 // Momentary switch layer - 256 layer max
584 #define MO(layer) (layer | QK_MOMENTARY)
586 // Set default layer - 256 layer max
587 #define DF(layer) (layer | QK_DEF_LAYER)
589 // Toggle to layer - 256 layer max
590 #define TG(layer) (layer | QK_TOGGLE_LAYER)
592 // One-shot layer - 256 layer max
593 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
596 #define OSM(mod) ((mod) | QK_ONE_SHOT_MOD)
599 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
601 // M-od, T-ap - 256 keycode max
602 #define MT(mod, kc) (kc | QK_MOD_TAP | (((mod) & 0x1F) << 8))
604 #define CTL_T(kc) MT(MOD_LCTL, kc)
605 #define LCTL_T(kc) MT(MOD_LCTL, kc)
606 #define RCTL_T(kc) MT(MOD_RCTL, kc)
608 #define SFT_T(kc) MT(MOD_LSFT, kc)
609 #define LSFT_T(kc) MT(MOD_LSFT, kc)
610 #define RSFT_T(kc) MT(MOD_RSFT, kc)
612 #define ALT_T(kc) MT(MOD_LALT, kc)
613 #define LALT_T(kc) MT(MOD_LALT, kc)
614 #define RALT_T(kc) MT(MOD_RALT, kc)
615 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
617 #define GUI_T(kc) MT(MOD_LGUI, kc)
618 #define LGUI_T(kc) MT(MOD_LGUI, kc)
619 #define RGUI_T(kc) MT(MOD_RGUI, kc)
621 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
622 #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
623 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
624 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
625 #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/
626 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
627 #define SWIN_T(kc) SCMD_T(kc)
628 #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
630 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
631 #define KC_HYPR HYPR(KC_NO)
632 #define KC_MEH MEH(KC_NO)
634 #ifdef UNICODE_ENABLE
635 // For sending unicode codes.
636 // You may not send codes over 7FFF -- this supports most of UTF8.
637 // To have a key that sends out Œ, go UC(0x0152)
638 #define UNICODE(n) (n | QK_UNICODE)
639 #define UC(n) UNICODE(n)
642 #ifdef UNICODEMAP_ENABLE
643 #define X(n) (n | QK_UNICODE_MAP)
646 #endif // QUANTUM_KEYCODES_H