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