quantum/quantum_keycodes.h

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