]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/quantum_keycodes.h
Merge remote-tracking branch 'refs/remotes/qmk/master'
[qmk_firmware.git] / quantum / quantum_keycodes.h
1 #ifndef QUANTUM_KEYCODES_H
2 #define QUANTUM_KEYCODES_H
3
4 #ifndef MIDI_ENABLE_STRICT
5 #define MIDI_ENABLE_STRICT 0
6 #endif
7
8 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
9 #ifndef MIDI_TONE_KEYCODE_OCTAVES
10 #define MIDI_TONE_KEYCODE_OCTAVES 3
11 #endif
12 #endif
13
14 enum quantum_keycodes {
15     // Ranges used in shortucuts - not to be used directly
16     QK_TMK                = 0x0000,
17     QK_TMK_MAX            = 0x00FF,
18     QK_MODS               = 0x0100,
19     QK_LCTL               = 0x0100,
20     QK_LSFT               = 0x0200,
21     QK_LALT               = 0x0400,
22     QK_LGUI               = 0x0800,
23     QK_RMODS_MIN          = 0x1000,
24     QK_RCTL               = 0x1100,
25     QK_RSFT               = 0x1200,
26     QK_RALT               = 0x1400,
27     QK_RGUI               = 0x1800,
28     QK_MODS_MAX           = 0x1FFF,
29     QK_FUNCTION           = 0x2000,
30     QK_FUNCTION_MAX       = 0x2FFF,
31     QK_MACRO              = 0x3000,
32     QK_MACRO_MAX          = 0x3FFF,
33     QK_LAYER_TAP          = 0x4000,
34     QK_LAYER_TAP_MAX      = 0x4FFF,
35     QK_TO                 = 0x5000,
36     QK_TO_MAX             = 0x50FF,
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
48     QK_CHORDING           = 0x5600,
49     QK_CHORDING_MAX       = 0x56FF,
50 #endif
51     QK_TAP_DANCE          = 0x5700,
52     QK_TAP_DANCE_MAX      = 0x57FF,
53     QK_LAYER_TAP_TOGGLE   = 0x5800,
54     QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
55     QK_MOD_TAP            = 0x6000,
56     QK_MOD_TAP_MAX        = 0x7FFF,
57 #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
58     #error "Cannot enable both UNICODEMAP && UNICODE"
59 #endif
60 #ifdef UNICODE_ENABLE
61     QK_UNICODE            = 0x8000,
62     QK_UNICODE_MAX        = 0xFFFF,
63 #endif
64 #ifdef UNICODEMAP_ENABLE
65     QK_UNICODE_MAP        = 0x8000,
66     QK_UNICODE_MAP_MAX    = 0x83FF,
67 #endif
68
69     // Loose keycodes - to be used directly
70
71     RESET = 0x5C00,
72     DEBUG,
73     MAGIC_SWAP_CONTROL_CAPSLOCK,
74     MAGIC_CAPSLOCK_TO_CONTROL,
75     MAGIC_SWAP_LALT_LGUI,
76     MAGIC_SWAP_RALT_RGUI,
77     MAGIC_NO_GUI,
78     MAGIC_SWAP_GRAVE_ESC,
79     MAGIC_SWAP_BACKSLASH_BACKSPACE,
80     MAGIC_HOST_NKRO,
81     MAGIC_SWAP_ALT_GUI,
82     MAGIC_UNSWAP_CONTROL_CAPSLOCK,
83     MAGIC_UNCAPSLOCK_TO_CONTROL,
84     MAGIC_UNSWAP_LALT_LGUI,
85     MAGIC_UNSWAP_RALT_RGUI,
86     MAGIC_UNNO_GUI,
87     MAGIC_UNSWAP_GRAVE_ESC,
88     MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
89     MAGIC_UNHOST_NKRO,
90     MAGIC_UNSWAP_ALT_GUI,
91     MAGIC_TOGGLE_NKRO,
92
93     // Leader key
94 #ifndef DISABLE_LEADER
95     KC_LEAD,
96 #endif
97
98     // Audio on/off/toggle
99     AU_ON,
100     AU_OFF,
101     AU_TOG,
102
103 #ifdef FAUXCLICKY_ENABLE
104     // Faux clicky
105     FC_ON,
106     FC_OFF,
107     FC_TOG,
108 #endif
109
110     // Music mode on/off/toggle
111     MU_ON,
112     MU_OFF,
113     MU_TOG,
114
115     // Music voice iterate
116     MUV_IN,
117     MUV_DE,
118
119     // Midi
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
123 #endif
124
125 #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
126     MIDI_TONE_MIN,
127
128 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
129     MI_C = MIDI_TONE_MIN,
130     MI_Cs,
131     MI_Db = MI_Cs,
132     MI_D,
133     MI_Ds,
134     MI_Eb = MI_Ds,
135     MI_E,
136     MI_F,
137     MI_Fs,
138     MI_Gb = MI_Fs,
139     MI_G,
140     MI_Gs,
141     MI_Ab = MI_Gs,
142     MI_A,
143     MI_As,
144     MI_Bb = MI_As,
145     MI_B,
146 #endif
147
148 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
149     MI_C_1,
150     MI_Cs_1,
151     MI_Db_1 = MI_Cs_1,
152     MI_D_1,
153     MI_Ds_1,
154     MI_Eb_1 = MI_Ds_1,
155     MI_E_1,
156     MI_F_1,
157     MI_Fs_1,
158     MI_Gb_1 = MI_Fs_1,
159     MI_G_1,
160     MI_Gs_1,
161     MI_Ab_1 = MI_Gs_1,
162     MI_A_1,
163     MI_As_1,
164     MI_Bb_1 = MI_As_1,
165     MI_B_1,
166 #endif
167
168 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
169     MI_C_2,
170     MI_Cs_2,
171     MI_Db_2 = MI_Cs_2,
172     MI_D_2,
173     MI_Ds_2,
174     MI_Eb_2 = MI_Ds_2,
175     MI_E_2,
176     MI_F_2,
177     MI_Fs_2,
178     MI_Gb_2 = MI_Fs_2,
179     MI_G_2,
180     MI_Gs_2,
181     MI_Ab_2 = MI_Gs_2,
182     MI_A_2,
183     MI_As_2,
184     MI_Bb_2 = MI_As_2,
185     MI_B_2,
186 #endif
187
188 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
189     MI_C_3,
190     MI_Cs_3,
191     MI_Db_3 = MI_Cs_3,
192     MI_D_3,
193     MI_Ds_3,
194     MI_Eb_3 = MI_Ds_3,
195     MI_E_3,
196     MI_F_3,
197     MI_Fs_3,
198     MI_Gb_3 = MI_Fs_3,
199     MI_G_3,
200     MI_Gs_3,
201     MI_Ab_3 = MI_Gs_3,
202     MI_A_3,
203     MI_As_3,
204     MI_Bb_3 = MI_As_3,
205     MI_B_3,
206 #endif
207
208 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
209     MI_C_4,
210     MI_Cs_4,
211     MI_Db_4 = MI_Cs_4,
212     MI_D_4,
213     MI_Ds_4,
214     MI_Eb_4 = MI_Ds_4,
215     MI_E_4,
216     MI_F_4,
217     MI_Fs_4,
218     MI_Gb_4 = MI_Fs_4,
219     MI_G_4,
220     MI_Gs_4,
221     MI_Ab_4 = MI_Gs_4,
222     MI_A_4,
223     MI_As_4,
224     MI_Bb_4 = MI_As_4,
225     MI_B_4,
226 #endif
227
228 #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
229     MI_C_5,
230     MI_Cs_5,
231     MI_Db_5 = MI_Cs_5,
232     MI_D_5,
233     MI_Ds_5,
234     MI_Eb_5 = MI_Ds_5,
235     MI_E_5,
236     MI_F_5,
237     MI_Fs_5,
238     MI_Gb_5 = MI_Fs_5,
239     MI_G_5,
240     MI_Gs_5,
241     MI_Ab_5 = MI_Gs_5,
242     MI_A_5,
243     MI_As_5,
244     MI_Bb_5 = MI_As_5,
245     MI_B_5,
246 #endif
247
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,
260 #endif
261
262     MIDI_OCTAVE_MIN,
263     MI_OCT_N2 = MIDI_OCTAVE_MIN,
264     MI_OCT_N1,
265     MI_OCT_0,
266     MI_OCT_1,
267     MI_OCT_2,
268     MI_OCT_3,
269     MI_OCT_4,
270     MI_OCT_5,
271     MI_OCT_6,
272     MI_OCT_7,
273     MIDI_OCTAVE_MAX = MI_OCT_7,
274     MI_OCTD, // octave down
275     MI_OCTU, // octave up
276
277     MIDI_TRANSPOSE_MIN,
278     MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
279     MI_TRNS_N5,
280     MI_TRNS_N4,
281     MI_TRNS_N3,
282     MI_TRNS_N2,
283     MI_TRNS_N1,
284     MI_TRNS_0,
285     MI_TRNS_1,
286     MI_TRNS_2,
287     MI_TRNS_3,
288     MI_TRNS_4,
289     MI_TRNS_5,
290     MI_TRNS_6,
291     MIDI_TRANSPOSE_MAX = MI_TRNS_6,
292     MI_TRNSD, // transpose down
293     MI_TRNSU, // transpose up
294
295     MIDI_VELOCITY_MIN,
296     MI_VEL_1 = MIDI_VELOCITY_MIN,
297     MI_VEL_2,
298     MI_VEL_3,
299     MI_VEL_4,
300     MI_VEL_5,
301     MI_VEL_6,
302     MI_VEL_7,
303     MI_VEL_8,
304     MI_VEL_9,
305     MI_VEL_10,
306     MIDI_VELOCITY_MAX = MI_VEL_10,
307     MI_VELD, // velocity down
308     MI_VELU, // velocity up
309
310     MIDI_CHANNEL_MIN,
311     MI_CH1 = MIDI_CHANNEL_MIN,
312     MI_CH2,
313     MI_CH3,
314     MI_CH4,
315     MI_CH5,
316     MI_CH6,
317     MI_CH7,
318     MI_CH8,
319     MI_CH9,
320     MI_CH10,
321     MI_CH11,
322     MI_CH12,
323     MI_CH13,
324     MI_CH14,
325     MI_CH15,
326     MI_CH16,
327     MIDI_CHANNEL_MAX = MI_CH16,
328     MI_CHD, // previous channel
329     MI_CHU, // next channel
330
331     MI_ALLOFF, // all notes off
332
333     MI_SUS, // sustain
334     MI_PORT, // portamento
335     MI_SOST, // sostenuto
336     MI_SOFT, // soft pedal
337     MI_LEG,  // legato
338
339     MI_MOD, // modulation
340     MI_MODSD, // decrease modulation speed
341     MI_MODSU, // increase modulation speed
342 #endif // MIDI_ADVANCED
343
344     // Backlight functionality
345     BL_0,
346     BL_1,
347     BL_2,
348     BL_3,
349     BL_4,
350     BL_5,
351     BL_6,
352     BL_7,
353     BL_8,
354     BL_9,
355     BL_10,
356     BL_11,
357     BL_12,
358     BL_13,
359     BL_14,
360     BL_15,
361     BL_DEC,
362     BL_INC,
363     BL_TOGG,
364     BL_STEP,
365
366     // RGB functionality
367     RGB_TOG,
368     RGB_MOD,
369     RGB_HUI,
370     RGB_HUD,
371     RGB_SAI,
372     RGB_SAD,
373     RGB_VAI,
374     RGB_VAD,
375
376     // Left shift, open paren
377     KC_LSPO,
378
379     // Right shift, close paren
380     KC_RSPC,
381
382     // Printing
383     PRINT_ON,
384     PRINT_OFF,
385
386     // output selection
387     OUT_AUTO,
388     OUT_USB,
389 #ifdef BLUETOOTH_ENABLE
390     OUT_BT,
391 #endif
392
393     // always leave at the end
394     SAFE_RANGE
395 };
396
397 // Ability to use mods in layouts
398 #define LCTL(kc) (kc | QK_LCTL)
399 #define LSFT(kc) (kc | QK_LSFT)
400 #define LALT(kc) (kc | QK_LALT)
401 #define LGUI(kc) (kc | QK_LGUI)
402 #define RCTL(kc) (kc | QK_RCTL)
403 #define RSFT(kc) (kc | QK_RSFT)
404 #define RALT(kc) (kc | QK_RALT)
405 #define RGUI(kc) (kc | QK_RGUI)
406
407 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
408 #define MEH(kc)  (kc | QK_LCTL | QK_LSFT | QK_LALT)
409 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
410 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
411 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
412 #define SWIN(kc) SCMD(kc)
413 #define LCA(kc) (kc | QK_LCTL | QK_LALT)
414
415 #define MOD_HYPR 0xf
416 #define MOD_MEH 0x7
417
418
419 // Aliases for shifted symbols
420 // Each key has a 4-letter code, and some have longer aliases too.
421 // While the long aliases are descriptive, the 4-letter codes
422 // make for nicer grid layouts (everything lines up), and are
423 // the preferred style for Quantum.
424 #define KC_TILD LSFT(KC_GRV)    // ~
425 #define KC_TILDE    KC_TILD
426
427 #define KC_EXLM LSFT(KC_1)      // !
428 #define KC_EXCLAIM  KC_EXLM
429
430 #define KC_AT   LSFT(KC_2)      // @
431
432 #define KC_HASH LSFT(KC_3)      // #
433
434 #define KC_DLR  LSFT(KC_4)      // $
435 #define KC_DOLLAR   KC_DLR
436
437 #define KC_PERC LSFT(KC_5)      // %
438 #define KC_PERCENT  KC_PERC
439
440 #define KC_CIRC LSFT(KC_6)      // ^
441 #define KC_CIRCUMFLEX   KC_CIRC
442
443 #define KC_AMPR LSFT(KC_7)      // &
444 #define KC_AMPERSAND    KC_AMPR
445
446 #define KC_ASTR LSFT(KC_8)      // *
447 #define KC_ASTERISK KC_ASTR
448
449 #define KC_LPRN LSFT(KC_9)      // (
450 #define KC_LEFT_PAREN   KC_LPRN
451
452 #define KC_RPRN LSFT(KC_0)      // )
453 #define KC_RIGHT_PAREN  KC_RPRN
454
455 #define KC_UNDS LSFT(KC_MINS)   // _
456 #define KC_UNDERSCORE   KC_UNDS
457
458 #define KC_PLUS LSFT(KC_EQL)    // +
459
460 #define KC_LCBR LSFT(KC_LBRC)   // {
461 #define KC_LEFT_CURLY_BRACE KC_LCBR
462
463 #define KC_RCBR LSFT(KC_RBRC)   // }
464 #define KC_RIGHT_CURLY_BRACE    KC_RCBR
465
466 #define KC_LABK LSFT(KC_COMM)   // <
467 #define KC_LEFT_ANGLE_BRACKET   KC_LABK
468
469 #define KC_RABK LSFT(KC_DOT)    // >
470 #define KC_RIGHT_ANGLE_BRACKET  KC_RABK
471
472 #define KC_COLN LSFT(KC_SCLN)   // :
473 #define KC_COLON    KC_COLN
474
475 #define KC_PIPE LSFT(KC_BSLS)   // |
476
477 #define KC_LT LSFT(KC_COMM)     // <
478
479 #define KC_GT LSFT(KC_DOT)      // >
480
481 #define KC_QUES LSFT(KC_SLSH)   // ?
482 #define KC_QUESTION KC_QUES
483
484 #define KC_DQT LSFT(KC_QUOT)   // "
485 #define KC_DOUBLE_QUOTE KC_DQT
486 #define KC_DQUO KC_DQT
487
488 #define KC_DELT KC_DELETE // Del key (four letter code)
489
490 // Alias for function layers than expand past FN31
491 #define FUNC(kc) (kc | QK_FUNCTION)
492
493 // Aliases
494 #define S(kc) LSFT(kc)
495 #define F(kc) FUNC(kc)
496
497 #define M(kc) (kc | QK_MACRO)
498
499 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
500 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
501
502
503 // L-ayer, T-ap - 256 keycode max, 16 layer max
504 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
505
506 #define AG_SWAP MAGIC_SWAP_ALT_GUI
507 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
508
509 #define BL_ON  BL_9
510 #define BL_OFF BL_0
511
512 // GOTO layer - 16 layers max
513 // when:
514 // ON_PRESS    = 1
515 // ON_RELEASE  = 2
516 // Unless you have a good reason not to do so, prefer  ON_PRESS (1) as your default.
517 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
518 // keycode modeled after the old version, kept below for this.
519 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
520 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
521
522 // Momentary switch layer - 256 layer max
523 #define MO(layer) (layer | QK_MOMENTARY)
524
525 // Set default layer - 256 layer max
526 #define DF(layer) (layer | QK_DEF_LAYER)
527
528 // Toggle to layer - 256 layer max
529 #define TG(layer) (layer | QK_TOGGLE_LAYER)
530
531 // One-shot layer - 256 layer max
532 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
533
534 // One-shot mod
535 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
536
537 // Layer tap-toggle
538 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
539
540 // M-od, T-ap - 256 keycode max
541 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
542
543 #define CTL_T(kc) MT(MOD_LCTL, kc)
544 #define LCTL_T(kc) MT(MOD_LCTL, kc)
545 #define RCTL_T(kc) MT(MOD_RCTL, kc)
546
547 #define SFT_T(kc) MT(MOD_LSFT, kc)
548 #define LSFT_T(kc) MT(MOD_LSFT, kc)
549 #define RSFT_T(kc) MT(MOD_RSFT, kc)
550
551 #define ALT_T(kc) MT(MOD_LALT, kc)
552 #define LALT_T(kc) MT(MOD_LALT, kc)
553 #define RALT_T(kc) MT(MOD_RALT, kc)
554 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
555
556 #define GUI_T(kc) MT(MOD_LGUI, kc)
557 #define LGUI_T(kc) MT(MOD_LGUI, kc)
558 #define RGUI_T(kc) MT(MOD_RGUI, kc)
559
560 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
561 #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
562 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
563 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
564 #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/
565 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
566 #define SWIN_T(kc) SCMD_T(kc)
567 #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
568
569 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
570 #define KC_HYPR HYPR(KC_NO)
571 #define KC_MEH  MEH(KC_NO)
572
573 #ifdef UNICODE_ENABLE
574     // For sending unicode codes.
575     // You may not send codes over 7FFF -- this supports most of UTF8.
576     // To have a key that sends out Œ, go UC(0x0152)
577     #define UNICODE(n) (n | QK_UNICODE)
578     #define UC(n) UNICODE(n)
579 #endif
580
581 #ifdef UNICODEMAP_ENABLE
582     #define X(n) (n | QK_UNICODE_MAP)
583 #endif
584
585 #endif // QUANTUM_KEYCODES_H