quantum/quantum_keycodes.h

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