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