1 #ifndef QUANTUM_KEYCODES_H
2 #define QUANTUM_KEYCODES_H
4 #ifndef MIDI_ENABLE_STRICT
5 #define MIDI_ENABLE_STRICT 0
8 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
9 #ifndef MIDI_TONE_KEYCODE_OCTAVES
10 #define MIDI_TONE_KEYCODE_OCTAVES 3
14 enum quantum_keycodes {
15 // Ranges used in shortucuts - not to be used directly
23 QK_RMODS_MIN = 0x1000,
30 QK_FUNCTION_MAX = 0x2FFF,
32 QK_MACRO_MAX = 0x3FFF,
33 QK_LAYER_TAP = 0x4000,
34 QK_LAYER_TAP_MAX = 0x4FFF,
37 QK_MOMENTARY = 0x5100,
38 QK_MOMENTARY_MAX = 0x51FF,
39 QK_DEF_LAYER = 0x5200,
40 QK_DEF_LAYER_MAX = 0x52FF,
41 QK_TOGGLE_LAYER = 0x5300,
42 QK_TOGGLE_LAYER_MAX = 0x53FF,
43 QK_ONE_SHOT_LAYER = 0x5400,
44 QK_ONE_SHOT_LAYER_MAX = 0x54FF,
45 QK_ONE_SHOT_MOD = 0x5500,
46 QK_ONE_SHOT_MOD_MAX = 0x55FF,
47 #ifndef DISABLE_CHORDING
49 QK_CHORDING_MAX = 0x56FF,
51 QK_TAP_DANCE = 0x5700,
52 QK_TAP_DANCE_MAX = 0x57FF,
53 QK_LAYER_TAP_TOGGLE = 0x5800,
54 QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
56 QK_MOD_TAP_MAX = 0x7FFF,
57 #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
58 #error "Cannot enable both UNICODEMAP && UNICODE"
62 QK_UNICODE_MAX = 0xFFFF,
64 #ifdef UNICODEMAP_ENABLE
65 QK_UNICODE_MAP = 0x8000,
66 QK_UNICODE_MAP_MAX = 0x83FF,
69 // Loose keycodes - to be used directly
73 MAGIC_SWAP_CONTROL_CAPSLOCK,
74 MAGIC_CAPSLOCK_TO_CONTROL,
79 MAGIC_SWAP_BACKSLASH_BACKSPACE,
82 MAGIC_UNSWAP_CONTROL_CAPSLOCK,
83 MAGIC_UNCAPSLOCK_TO_CONTROL,
84 MAGIC_UNSWAP_LALT_LGUI,
85 MAGIC_UNSWAP_RALT_RGUI,
87 MAGIC_UNSWAP_GRAVE_ESC,
88 MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
94 #ifndef DISABLE_LEADER
98 // Audio on/off/toggle
103 #ifdef FAUXCLICKY_ENABLE
110 // Music mode on/off/toggle
115 // Music voice iterate
120 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
121 MI_ON, // send midi notes when music mode is enabled
122 MI_OFF, // don't send midi notes when music mode is enabled
125 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
128 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
129 MI_C = MIDI_TONE_MIN,
148 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
168 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
188 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
208 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
228 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
248 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
249 MIDI_TONE_MAX = MI_B_5,
250 #elif MIDI_TONE_KEYCODE_OCTAVES > 4
251 MIDI_TONE_MAX = MI_B_4,
252 #elif MIDI_TONE_KEYCODE_OCTAVES > 3
253 MIDI_TONE_MAX = MI_B_3,
254 #elif MIDI_TONE_KEYCODE_OCTAVES > 2
255 MIDI_TONE_MAX = MI_B_2,
256 #elif MIDI_TONE_KEYCODE_OCTAVES > 1
257 MIDI_TONE_MAX = MI_B_1,
258 #elif MIDI_TONE_KEYCODE_OCTAVES > 0
259 MIDI_TONE_MAX = MI_B,
263 MI_OCT_N2 = MIDI_OCTAVE_MIN,
273 MIDI_OCTAVE_MAX = MI_OCT_7,
274 MI_OCTD, // octave down
275 MI_OCTU, // octave up
278 MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
291 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
292 MI_TRNSD, // transpose down
293 MI_TRNSU, // transpose up
296 MI_VEL_1 = MIDI_VELOCITY_MIN,
306 MIDI_VELOCITY_MAX = MI_VEL_10,
307 MI_VELD, // velocity down
308 MI_VELU, // velocity up
311 MI_CH1 = MIDI_CHANNEL_MIN,
327 MIDI_CHANNEL_MAX = MI_CH16,
328 MI_CHD, // previous channel
329 MI_CHU, // next channel
331 MI_ALLOFF, // all notes off
334 MI_PORT, // portamento
335 MI_SOST, // sostenuto
336 MI_SOFT, // soft pedal
339 MI_MOD, // modulation
340 MI_MODSD, // decrease modulation speed
341 MI_MODSU, // increase modulation speed
342 #endif // MIDI_ADVANCED
344 // Backlight functionality
376 // Left shift, open paren
379 // Right shift, close paren
389 #ifdef BLUETOOTH_ENABLE
392 #ifdef ADAFRUIT_BLE_ENABLE
396 // always leave at the end
400 // Ability to use mods in layouts
401 #define LCTL(kc) (kc | QK_LCTL)
402 #define LSFT(kc) (kc | QK_LSFT)
403 #define LALT(kc) (kc | QK_LALT)
404 #define LGUI(kc) (kc | QK_LGUI)
405 #define RCTL(kc) (kc | QK_RCTL)
406 #define RSFT(kc) (kc | QK_RSFT)
407 #define RALT(kc) (kc | QK_RALT)
408 #define RGUI(kc) (kc | QK_RGUI)
410 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
411 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
412 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
413 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
414 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
415 #define SWIN(kc) SCMD(kc)
421 // Aliases for shifted symbols
422 // Each key has a 4-letter code, and some have longer aliases too.
423 // While the long aliases are descriptive, the 4-letter codes
424 // make for nicer grid layouts (everything lines up), and are
425 // the preferred style for Quantum.
426 #define KC_TILD LSFT(KC_GRV) // ~
427 #define KC_TILDE KC_TILD
429 #define KC_EXLM LSFT(KC_1) // !
430 #define KC_EXCLAIM KC_EXLM
432 #define KC_AT LSFT(KC_2) // @
434 #define KC_HASH LSFT(KC_3) // #
436 #define KC_DLR LSFT(KC_4) // $
437 #define KC_DOLLAR KC_DLR
439 #define KC_PERC LSFT(KC_5) // %
440 #define KC_PERCENT KC_PERC
442 #define KC_CIRC LSFT(KC_6) // ^
443 #define KC_CIRCUMFLEX KC_CIRC
445 #define KC_AMPR LSFT(KC_7) // &
446 #define KC_AMPERSAND KC_AMPR
448 #define KC_ASTR LSFT(KC_8) // *
449 #define KC_ASTERISK KC_ASTR
451 #define KC_LPRN LSFT(KC_9) // (
452 #define KC_LEFT_PAREN KC_LPRN
454 #define KC_RPRN LSFT(KC_0) // )
455 #define KC_RIGHT_PAREN KC_RPRN
457 #define KC_UNDS LSFT(KC_MINS) // _
458 #define KC_UNDERSCORE KC_UNDS
460 #define KC_PLUS LSFT(KC_EQL) // +
462 #define KC_LCBR LSFT(KC_LBRC) // {
463 #define KC_LEFT_CURLY_BRACE KC_LCBR
465 #define KC_RCBR LSFT(KC_RBRC) // }
466 #define KC_RIGHT_CURLY_BRACE KC_RCBR
468 #define KC_LABK LSFT(KC_COMM) // <
469 #define KC_LEFT_ANGLE_BRACKET KC_LABK
471 #define KC_RABK LSFT(KC_DOT) // >
472 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
474 #define KC_COLN LSFT(KC_SCLN) // :
475 #define KC_COLON KC_COLN
477 #define KC_PIPE LSFT(KC_BSLS) // |
479 #define KC_LT LSFT(KC_COMM) // <
481 #define KC_GT LSFT(KC_DOT) // >
483 #define KC_QUES LSFT(KC_SLSH) // ?
484 #define KC_QUESTION KC_QUES
486 #define KC_DQT LSFT(KC_QUOT) // "
487 #define KC_DOUBLE_QUOTE KC_DQT
488 #define KC_DQUO KC_DQT
490 #define KC_DELT KC_DELETE // Del key (four letter code)
492 // Alias for function layers than expand past FN31
493 #define FUNC(kc) (kc | QK_FUNCTION)
496 #define S(kc) LSFT(kc)
497 #define F(kc) FUNC(kc)
499 #define M(kc) (kc | QK_MACRO)
501 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
502 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
505 // L-ayer, T-ap - 256 keycode max, 16 layer max
506 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
508 #define AG_SWAP MAGIC_SWAP_ALT_GUI
509 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
514 // GOTO layer - 16 layers max
518 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
519 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
520 // keycode modeled after the old version, kept below for this.
521 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
522 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
524 // Momentary switch layer - 256 layer max
525 #define MO(layer) (layer | QK_MOMENTARY)
527 // Set default layer - 256 layer max
528 #define DF(layer) (layer | QK_DEF_LAYER)
530 // Toggle to layer - 256 layer max
531 #define TG(layer) (layer | QK_TOGGLE_LAYER)
533 // One-shot layer - 256 layer max
534 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
537 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
540 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
542 // M-od, T-ap - 256 keycode max
543 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
545 #define CTL_T(kc) MT(MOD_LCTL, kc)
546 #define LCTL_T(kc) MT(MOD_LCTL, kc)
547 #define RCTL_T(kc) MT(MOD_RCTL, kc)
549 #define SFT_T(kc) MT(MOD_LSFT, kc)
550 #define LSFT_T(kc) MT(MOD_LSFT, kc)
551 #define RSFT_T(kc) MT(MOD_RSFT, kc)
553 #define ALT_T(kc) MT(MOD_LALT, kc)
554 #define LALT_T(kc) MT(MOD_LALT, kc)
555 #define RALT_T(kc) MT(MOD_RALT, kc)
556 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
558 #define GUI_T(kc) MT(MOD_LGUI, kc)
559 #define LGUI_T(kc) MT(MOD_LGUI, kc)
560 #define RGUI_T(kc) MT(MOD_RGUI, kc)
562 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
563 #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
564 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
565 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
566 #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/
567 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
568 #define SWIN_T(kc) SCMD_T(kc)
570 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
571 #define KC_HYPR HYPR(KC_NO)
572 #define KC_MEH MEH(KC_NO)
574 #ifdef UNICODE_ENABLE
575 // For sending unicode codes.
576 // You may not send codes over 7FFF -- this supports most of UTF8.
577 // To have a key that sends out Œ, go UC(0x0152)
578 #define UNICODE(n) (n | QK_UNICODE)
579 #define UC(n) UNICODE(n)
582 #ifdef UNICODEMAP_ENABLE
583 #define X(n) (n | QK_UNICODE_MAP)
586 #endif // QUANTUM_KEYCODES_H