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