quantum/quantum_keycodes.h

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