quantum/quantum_keycodes.h

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