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,
110 #ifndef DISABLE_LEADER
114 // Audio on/off/toggle
119 #ifdef FAUXCLICKY_ENABLE
126 // Music mode on/off/toggle
131 // Music voice iterate
136 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
137 MI_ON, // send midi notes when music mode is enabled
138 MI_OFF, // don't send midi notes when music mode is enabled
141 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
144 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
145 MI_C = MIDI_TONE_MIN,
164 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
184 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
204 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
224 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
244 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
264 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
265 MIDI_TONE_MAX = MI_B_5,
266 #elif MIDI_TONE_KEYCODE_OCTAVES > 4
267 MIDI_TONE_MAX = MI_B_4,
268 #elif MIDI_TONE_KEYCODE_OCTAVES > 3
269 MIDI_TONE_MAX = MI_B_3,
270 #elif MIDI_TONE_KEYCODE_OCTAVES > 2
271 MIDI_TONE_MAX = MI_B_2,
272 #elif MIDI_TONE_KEYCODE_OCTAVES > 1
273 MIDI_TONE_MAX = MI_B_1,
274 #elif MIDI_TONE_KEYCODE_OCTAVES > 0
275 MIDI_TONE_MAX = MI_B,
279 MI_OCT_N2 = MIDI_OCTAVE_MIN,
289 MIDI_OCTAVE_MAX = MI_OCT_7,
290 MI_OCTD, // octave down
291 MI_OCTU, // octave up
294 MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
307 MIDI_TRANSPOSE_MAX = MI_TRNS_6,
308 MI_TRNSD, // transpose down
309 MI_TRNSU, // transpose up
312 MI_VEL_1 = MIDI_VELOCITY_MIN,
322 MIDI_VELOCITY_MAX = MI_VEL_10,
323 MI_VELD, // velocity down
324 MI_VELU, // velocity up
327 MI_CH1 = MIDI_CHANNEL_MIN,
343 MIDI_CHANNEL_MAX = MI_CH16,
344 MI_CHD, // previous channel
345 MI_CHU, // next channel
347 MI_ALLOFF, // all notes off
350 MI_PORT, // portamento
351 MI_SOST, // sostenuto
352 MI_SOFT, // soft pedal
355 MI_MOD, // modulation
356 MI_MODSD, // decrease modulation speed
357 MI_MODSU, // increase modulation speed
358 #endif // MIDI_ADVANCED
360 // Backlight functionality
392 // Left shift, open paren
395 // Right shift, close paren
405 #ifdef BLUETOOTH_ENABLE
409 // always leave at the end
413 // Ability to use mods in layouts
414 #define LCTL(kc) (kc | QK_LCTL)
415 #define LSFT(kc) (kc | QK_LSFT)
416 #define LALT(kc) (kc | QK_LALT)
417 #define LGUI(kc) (kc | QK_LGUI)
418 #define RCTL(kc) (kc | QK_RCTL)
419 #define RSFT(kc) (kc | QK_RSFT)
420 #define RALT(kc) (kc | QK_RALT)
421 #define RGUI(kc) (kc | QK_RGUI)
423 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
424 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
425 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
426 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
427 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
428 #define SWIN(kc) SCMD(kc)
429 #define LCA(kc) (kc | QK_LCTL | QK_LALT)
435 // Aliases for shifted symbols
436 // Each key has a 4-letter code, and some have longer aliases too.
437 // While the long aliases are descriptive, the 4-letter codes
438 // make for nicer grid layouts (everything lines up), and are
439 // the preferred style for Quantum.
440 #define KC_TILD LSFT(KC_GRV) // ~
441 #define KC_TILDE KC_TILD
443 #define KC_EXLM LSFT(KC_1) // !
444 #define KC_EXCLAIM KC_EXLM
446 #define KC_AT LSFT(KC_2) // @
448 #define KC_HASH LSFT(KC_3) // #
450 #define KC_DLR LSFT(KC_4) // $
451 #define KC_DOLLAR KC_DLR
453 #define KC_PERC LSFT(KC_5) // %
454 #define KC_PERCENT KC_PERC
456 #define KC_CIRC LSFT(KC_6) // ^
457 #define KC_CIRCUMFLEX KC_CIRC
459 #define KC_AMPR LSFT(KC_7) // &
460 #define KC_AMPERSAND KC_AMPR
462 #define KC_ASTR LSFT(KC_8) // *
463 #define KC_ASTERISK KC_ASTR
465 #define KC_LPRN LSFT(KC_9) // (
466 #define KC_LEFT_PAREN KC_LPRN
468 #define KC_RPRN LSFT(KC_0) // )
469 #define KC_RIGHT_PAREN KC_RPRN
471 #define KC_UNDS LSFT(KC_MINS) // _
472 #define KC_UNDERSCORE KC_UNDS
474 #define KC_PLUS LSFT(KC_EQL) // +
476 #define KC_LCBR LSFT(KC_LBRC) // {
477 #define KC_LEFT_CURLY_BRACE KC_LCBR
479 #define KC_RCBR LSFT(KC_RBRC) // }
480 #define KC_RIGHT_CURLY_BRACE KC_RCBR
482 #define KC_LABK LSFT(KC_COMM) // <
483 #define KC_LEFT_ANGLE_BRACKET KC_LABK
485 #define KC_RABK LSFT(KC_DOT) // >
486 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
488 #define KC_COLN LSFT(KC_SCLN) // :
489 #define KC_COLON KC_COLN
491 #define KC_PIPE LSFT(KC_BSLS) // |
493 #define KC_LT LSFT(KC_COMM) // <
495 #define KC_GT LSFT(KC_DOT) // >
497 #define KC_QUES LSFT(KC_SLSH) // ?
498 #define KC_QUESTION KC_QUES
500 #define KC_DQT LSFT(KC_QUOT) // "
501 #define KC_DOUBLE_QUOTE KC_DQT
502 #define KC_DQUO KC_DQT
504 #define KC_DELT KC_DELETE // Del key (four letter code)
506 // Alias for function layers than expand past FN31
507 #define FUNC(kc) (kc | QK_FUNCTION)
510 #define S(kc) LSFT(kc)
511 #define F(kc) FUNC(kc)
513 #define M(kc) (kc | QK_MACRO)
515 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
516 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
518 #define KC_GESC GRAVE_ESC
521 // L-ayer, T-ap - 256 keycode max, 16 layer max
522 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
524 #define AG_SWAP MAGIC_SWAP_ALT_GUI
525 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
530 // GOTO layer - 16 layers max
534 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
535 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
536 // keycode modeled after the old version, kept below for this.
537 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
538 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
540 // Momentary switch layer - 256 layer max
541 #define MO(layer) (layer | QK_MOMENTARY)
543 // Set default layer - 256 layer max
544 #define DF(layer) (layer | QK_DEF_LAYER)
546 // Toggle to layer - 256 layer max
547 #define TG(layer) (layer | QK_TOGGLE_LAYER)
549 // One-shot layer - 256 layer max
550 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
553 #define OSM(mod) ((mod) | QK_ONE_SHOT_MOD)
556 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
558 // M-od, T-ap - 256 keycode max
559 #define MT(mod, kc) (kc | QK_MOD_TAP | (((mod) & 0x1F) << 8))
561 #define CTL_T(kc) MT(MOD_LCTL, kc)
562 #define LCTL_T(kc) MT(MOD_LCTL, kc)
563 #define RCTL_T(kc) MT(MOD_RCTL, kc)
565 #define SFT_T(kc) MT(MOD_LSFT, kc)
566 #define LSFT_T(kc) MT(MOD_LSFT, kc)
567 #define RSFT_T(kc) MT(MOD_RSFT, kc)
569 #define ALT_T(kc) MT(MOD_LALT, kc)
570 #define LALT_T(kc) MT(MOD_LALT, kc)
571 #define RALT_T(kc) MT(MOD_RALT, kc)
572 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
574 #define GUI_T(kc) MT(MOD_LGUI, kc)
575 #define LGUI_T(kc) MT(MOD_LGUI, kc)
576 #define RGUI_T(kc) MT(MOD_RGUI, kc)
578 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
579 #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
580 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
581 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
582 #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/
583 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
584 #define SWIN_T(kc) SCMD_T(kc)
585 #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
587 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
588 #define KC_HYPR HYPR(KC_NO)
589 #define KC_MEH MEH(KC_NO)
591 #ifdef UNICODE_ENABLE
592 // For sending unicode codes.
593 // You may not send codes over 7FFF -- this supports most of UTF8.
594 // To have a key that sends out Œ, go UC(0x0152)
595 #define UNICODE(n) (n | QK_UNICODE)
596 #define UC(n) UNICODE(n)
599 #ifdef UNICODEMAP_ENABLE
600 #define X(n) (n | QK_UNICODE_MAP)
603 #endif // QUANTUM_KEYCODES_H