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