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 enum quantum_keycodes {
30 // Ranges used in shortucuts - not to be used directly
38 QK_RMODS_MIN = 0x1000,
45 QK_FUNCTION_MAX = 0x2FFF,
47 QK_MACRO_MAX = 0x3FFF,
48 QK_LAYER_TAP = 0x4000,
49 QK_LAYER_TAP_MAX = 0x4FFF,
52 QK_MOMENTARY = 0x5100,
53 QK_MOMENTARY_MAX = 0x51FF,
54 QK_DEF_LAYER = 0x5200,
55 QK_DEF_LAYER_MAX = 0x52FF,
56 QK_TOGGLE_LAYER = 0x5300,
57 QK_TOGGLE_LAYER_MAX = 0x53FF,
58 QK_ONE_SHOT_LAYER = 0x5400,
59 QK_ONE_SHOT_LAYER_MAX = 0x54FF,
60 QK_ONE_SHOT_MOD = 0x5500,
61 QK_ONE_SHOT_MOD_MAX = 0x55FF,
62 #ifndef DISABLE_CHORDING
64 QK_CHORDING_MAX = 0x56FF,
66 QK_TAP_DANCE = 0x5700,
67 QK_TAP_DANCE_MAX = 0x57FF,
68 QK_LAYER_TAP_TOGGLE = 0x5800,
69 QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
71 QK_MOD_TAP_MAX = 0x7FFF,
72 #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
73 #error "Cannot enable both UNICODEMAP && UNICODE"
77 QK_UNICODE_MAX = 0xFFFF,
79 #ifdef UNICODEMAP_ENABLE
80 QK_UNICODE_MAP = 0x8000,
81 QK_UNICODE_MAP_MAX = 0x83FF,
84 // Loose keycodes - to be used directly
88 MAGIC_SWAP_CONTROL_CAPSLOCK,
89 MAGIC_CAPSLOCK_TO_CONTROL,
94 MAGIC_SWAP_BACKSLASH_BACKSPACE,
97 MAGIC_UNSWAP_CONTROL_CAPSLOCK,
98 MAGIC_UNCAPSLOCK_TO_CONTROL,
99 MAGIC_UNSWAP_LALT_LGUI,
100 MAGIC_UNSWAP_RALT_RGUI,
102 MAGIC_UNSWAP_GRAVE_ESC,
103 MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
105 MAGIC_UNSWAP_ALT_GUI,
109 #ifndef DISABLE_LEADER
113 // Audio on/off/toggle
118 #ifdef FAUXCLICKY_ENABLE
125 // Music mode on/off/toggle
130 // Music voice iterate
135 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
136 MI_ON, // send midi notes when music mode is enabled
137 MI_OFF, // don't send midi notes when music mode is enabled
140 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
143 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
144 MI_C = MIDI_TONE_MIN,
163 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
183 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
203 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
223 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
243 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
263 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
264 MIDI_TONE_MAX = MI_B_5,
265 #elif MIDI_TONE_KEYCODE_OCTAVES > 4
266 MIDI_TONE_MAX = MI_B_4,
267 #elif MIDI_TONE_KEYCODE_OCTAVES > 3
268 MIDI_TONE_MAX = MI_B_3,
269 #elif MIDI_TONE_KEYCODE_OCTAVES > 2
270 MIDI_TONE_MAX = MI_B_2,
271 #elif MIDI_TONE_KEYCODE_OCTAVES > 1
272 MIDI_TONE_MAX = MI_B_1,
273 #elif MIDI_TONE_KEYCODE_OCTAVES > 0
274 MIDI_TONE_MAX = MI_B,
278 MI_OCT_N2 = MIDI_OCTAVE_MIN,
288 MIDI_OCTAVE_MAX = MI_OCT_7,
289 MI_OCTD, // octave down
290 MI_OCTU, // octave up
293 MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
306 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
307 MI_TRNSD, // transpose down
308 MI_TRNSU, // transpose up
311 MI_VEL_1 = MIDI_VELOCITY_MIN,
321 MIDI_VELOCITY_MAX = MI_VEL_10,
322 MI_VELD, // velocity down
323 MI_VELU, // velocity up
326 MI_CH1 = MIDI_CHANNEL_MIN,
342 MIDI_CHANNEL_MAX = MI_CH16,
343 MI_CHD, // previous channel
344 MI_CHU, // next channel
346 MI_ALLOFF, // all notes off
349 MI_PORT, // portamento
350 MI_SOST, // sostenuto
351 MI_SOFT, // soft pedal
354 MI_MOD, // modulation
355 MI_MODSD, // decrease modulation speed
356 MI_MODSU, // increase modulation speed
357 #endif // MIDI_ADVANCED
359 // Backlight functionality
391 // Left shift, open paren
394 // Right shift, close paren
404 #ifdef BLUETOOTH_ENABLE
408 // always leave at the end
412 // Ability to use mods in layouts
413 #define LCTL(kc) (kc | QK_LCTL)
414 #define LSFT(kc) (kc | QK_LSFT)
415 #define LALT(kc) (kc | QK_LALT)
416 #define LGUI(kc) (kc | QK_LGUI)
417 #define RCTL(kc) (kc | QK_RCTL)
418 #define RSFT(kc) (kc | QK_RSFT)
419 #define RALT(kc) (kc | QK_RALT)
420 #define RGUI(kc) (kc | QK_RGUI)
422 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
423 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
424 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
425 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
426 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
427 #define SWIN(kc) SCMD(kc)
428 #define LCA(kc) (kc | QK_LCTL | QK_LALT)
434 // Aliases for shifted symbols
435 // Each key has a 4-letter code, and some have longer aliases too.
436 // While the long aliases are descriptive, the 4-letter codes
437 // make for nicer grid layouts (everything lines up), and are
438 // the preferred style for Quantum.
439 #define KC_TILD LSFT(KC_GRV) // ~
440 #define KC_TILDE KC_TILD
442 #define KC_EXLM LSFT(KC_1) // !
443 #define KC_EXCLAIM KC_EXLM
445 #define KC_AT LSFT(KC_2) // @
447 #define KC_HASH LSFT(KC_3) // #
449 #define KC_DLR LSFT(KC_4) // $
450 #define KC_DOLLAR KC_DLR
452 #define KC_PERC LSFT(KC_5) // %
453 #define KC_PERCENT KC_PERC
455 #define KC_CIRC LSFT(KC_6) // ^
456 #define KC_CIRCUMFLEX KC_CIRC
458 #define KC_AMPR LSFT(KC_7) // &
459 #define KC_AMPERSAND KC_AMPR
461 #define KC_ASTR LSFT(KC_8) // *
462 #define KC_ASTERISK KC_ASTR
464 #define KC_LPRN LSFT(KC_9) // (
465 #define KC_LEFT_PAREN KC_LPRN
467 #define KC_RPRN LSFT(KC_0) // )
468 #define KC_RIGHT_PAREN KC_RPRN
470 #define KC_UNDS LSFT(KC_MINS) // _
471 #define KC_UNDERSCORE KC_UNDS
473 #define KC_PLUS LSFT(KC_EQL) // +
475 #define KC_LCBR LSFT(KC_LBRC) // {
476 #define KC_LEFT_CURLY_BRACE KC_LCBR
478 #define KC_RCBR LSFT(KC_RBRC) // }
479 #define KC_RIGHT_CURLY_BRACE KC_RCBR
481 #define KC_LABK LSFT(KC_COMM) // <
482 #define KC_LEFT_ANGLE_BRACKET KC_LABK
484 #define KC_RABK LSFT(KC_DOT) // >
485 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
487 #define KC_COLN LSFT(KC_SCLN) // :
488 #define KC_COLON KC_COLN
490 #define KC_PIPE LSFT(KC_BSLS) // |
492 #define KC_LT LSFT(KC_COMM) // <
494 #define KC_GT LSFT(KC_DOT) // >
496 #define KC_QUES LSFT(KC_SLSH) // ?
497 #define KC_QUESTION KC_QUES
499 #define KC_DQT LSFT(KC_QUOT) // "
500 #define KC_DOUBLE_QUOTE KC_DQT
501 #define KC_DQUO KC_DQT
503 #define KC_DELT KC_DELETE // Del key (four letter code)
505 // Alias for function layers than expand past FN31
506 #define FUNC(kc) (kc | QK_FUNCTION)
509 #define S(kc) LSFT(kc)
510 #define F(kc) FUNC(kc)
512 #define M(kc) (kc | QK_MACRO)
514 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
515 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
518 // L-ayer, T-ap - 256 keycode max, 16 layer max
519 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
521 #define AG_SWAP MAGIC_SWAP_ALT_GUI
522 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
527 // GOTO layer - 16 layers max
531 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
532 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
533 // keycode modeled after the old version, kept below for this.
534 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
535 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
537 // Momentary switch layer - 256 layer max
538 #define MO(layer) (layer | QK_MOMENTARY)
540 // Set default layer - 256 layer max
541 #define DF(layer) (layer | QK_DEF_LAYER)
543 // Toggle to layer - 256 layer max
544 #define TG(layer) (layer | QK_TOGGLE_LAYER)
546 // One-shot layer - 256 layer max
547 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
550 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
553 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
555 // M-od, T-ap - 256 keycode max
556 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
558 #define CTL_T(kc) MT(MOD_LCTL, kc)
559 #define LCTL_T(kc) MT(MOD_LCTL, kc)
560 #define RCTL_T(kc) MT(MOD_RCTL, kc)
562 #define SFT_T(kc) MT(MOD_LSFT, kc)
563 #define LSFT_T(kc) MT(MOD_LSFT, kc)
564 #define RSFT_T(kc) MT(MOD_RSFT, kc)
566 #define ALT_T(kc) MT(MOD_LALT, kc)
567 #define LALT_T(kc) MT(MOD_LALT, kc)
568 #define RALT_T(kc) MT(MOD_RALT, kc)
569 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
571 #define GUI_T(kc) MT(MOD_LGUI, kc)
572 #define LGUI_T(kc) MT(MOD_LGUI, kc)
573 #define RGUI_T(kc) MT(MOD_RGUI, kc)
575 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
576 #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
577 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
578 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
579 #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/
580 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
581 #define SWIN_T(kc) SCMD_T(kc)
582 #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
584 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
585 #define KC_HYPR HYPR(KC_NO)
586 #define KC_MEH MEH(KC_NO)
588 #ifdef UNICODE_ENABLE
589 // For sending unicode codes.
590 // You may not send codes over 7FFF -- this supports most of UTF8.
591 // To have a key that sends out Œ, go UC(0x0152)
592 #define UNICODE(n) (n | QK_UNICODE)
593 #define UC(n) UNICODE(n)
596 #ifdef UNICODEMAP_ENABLE
597 #define X(n) (n | QK_UNICODE_MAP)
600 #endif // QUANTUM_KEYCODES_H