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