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 #ifdef UNICODE_ENABLE
  49     QK_UNICODE            = 0x8000,
  50     QK_UNICODE_MAX        = 0xFFFF,
  51 #endif
  52 #ifdef UNICODEMAP_ENABLE
  53     QK_UNICODE_MAP        = 0x8000,
  54     QK_UNICODE_MAP_MAX    = 0x83FF,
  55 #endif
  56
  57     // Loose keycodes - to be used directly
  58
  59     RESET = 0x5C00,
  60     DEBUG,
  61     MAGIC_SWAP_CONTROL_CAPSLOCK,
  62     MAGIC_CAPSLOCK_TO_CONTROL,
  63     MAGIC_SWAP_LALT_LGUI,
  64     MAGIC_SWAP_RALT_RGUI,
  65     MAGIC_NO_GUI,
  66     MAGIC_SWAP_GRAVE_ESC,
  67     MAGIC_SWAP_BACKSLASH_BACKSPACE,
  68     MAGIC_HOST_NKRO,
  69     MAGIC_SWAP_ALT_GUI,
  70     MAGIC_UNSWAP_CONTROL_CAPSLOCK,
  71     MAGIC_UNCAPSLOCK_TO_CONTROL,
  72     MAGIC_UNSWAP_LALT_LGUI,
  73     MAGIC_UNSWAP_RALT_RGUI,
  74     MAGIC_UNNO_GUI,
  75     MAGIC_UNSWAP_GRAVE_ESC,
  76     MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
  77     MAGIC_UNHOST_NKRO,
  78     MAGIC_UNSWAP_ALT_GUI,
  79     MAGIC_TOGGLE_NKRO,
  80
  81     // Leader key
  82 #ifndef DISABLE_LEADER
  83     KC_LEAD,
  84 #endif
  85
  86     // Audio on/off/toggle
  87     AU_ON,
  88     AU_OFF,
  89     AU_TOG,
  90
  91 #ifdef FAUXCLICKY_ENABLE
  92     // Faux clicky
  93     FC_ON,
  94     FC_OFF,
  95     FC_TOG,
  96 #endif
  97
  98     // Music mode on/off/toggle
  99     MU_ON,
 100     MU_OFF,
 101     MU_TOG,
 102
 103     // Music voice iterate
 104     MUV_IN,
 105     MUV_DE,
 106
 107     // Midi mode on/off
 108     MIDI_ON,
 109     MIDI_OFF,
 110
 111     // Backlight functionality
 112     BL_0,
 113     BL_1,
 114     BL_2,
 115     BL_3,
 116     BL_4,
 117     BL_5,
 118     BL_6,
 119     BL_7,
 120     BL_8,
 121     BL_9,
 122     BL_10,
 123     BL_11,
 124     BL_12,
 125     BL_13,
 126     BL_14,
 127     BL_15,
 128     BL_DEC,
 129     BL_INC,
 130     BL_TOGG,
 131     BL_STEP,
 132
 133     // RGB functionality
 134     RGB_TOG,
 135     RGB_MOD,
 136     RGB_HUI,
 137     RGB_HUD,
 138     RGB_SAI,
 139     RGB_SAD,
 140     RGB_VAI,
 141     RGB_VAD,
 142
 143     // Left shift, open paren
 144     KC_LSPO,
 145
 146     // Right shift, close paren
 147     KC_RSPC,
 148
 149     // Printing
 150     PRINT_ON,
 151     PRINT_OFF,
 152
 153     // output selection
 154     OUT_AUTO,
 155     OUT_USB,
 156 #ifdef BLUETOOTH_ENABLE
 157     OUT_BT,
 158 #endif
 159 #ifdef ADAFRUIT_BLE_ENABLE
 160     OUT_BLE,
 161 #endif
 162
 163     // always leave at the end
 164     SAFE_RANGE
 165 };
 166
 167 // Ability to use mods in layouts
 168 #define LCTL(kc) (kc | QK_LCTL)
 169 #define LSFT(kc) (kc | QK_LSFT)
 170 #define LALT(kc) (kc | QK_LALT)
 171 #define LGUI(kc) (kc | QK_LGUI)
 172 #define RCTL(kc) (kc | QK_RCTL)
 173 #define RSFT(kc) (kc | QK_RSFT)
 174 #define RALT(kc) (kc | QK_RALT)
 175 #define RGUI(kc) (kc | QK_RGUI)
 176
 177 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
 178 #define MEH(kc)  (kc | QK_LCTL | QK_LSFT | QK_LALT)
 179 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
 180 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
 181 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
 182 #define SWIN(kc) SCMD(kc)
 183
 184 #define MOD_HYPR 0xf
 185 #define MOD_MEH 0x7
 186
 187
 188 // Aliases for shifted symbols
 189 // Each key has a 4-letter code, and some have longer aliases too.
 190 // While the long aliases are descriptive, the 4-letter codes
 191 // make for nicer grid layouts (everything lines up), and are
 192 // the preferred style for Quantum.
 193 #define KC_TILD LSFT(KC_GRV)    // ~
 194 #define KC_TILDE    KC_TILD
 195
 196 #define KC_EXLM LSFT(KC_1)      // !
 197 #define KC_EXCLAIM  KC_EXLM
 198
 199 #define KC_AT   LSFT(KC_2)      // @
 200
 201 #define KC_HASH LSFT(KC_3)      // #
 202
 203 #define KC_DLR  LSFT(KC_4)      // $
 204 #define KC_DOLLAR   KC_DLR
 205
 206 #define KC_PERC LSFT(KC_5)      // %
 207 #define KC_PERCENT  KC_PERC
 208
 209 #define KC_CIRC LSFT(KC_6)      // ^
 210 #define KC_CIRCUMFLEX   KC_CIRC
 211
 212 #define KC_AMPR LSFT(KC_7)      // &
 213 #define KC_AMPERSAND    KC_AMPR
 214
 215 #define KC_ASTR LSFT(KC_8)      // *
 216 #define KC_ASTERISK KC_ASTR
 217
 218 #define KC_LPRN LSFT(KC_9)      // (
 219 #define KC_LEFT_PAREN   KC_LPRN
 220
 221 #define KC_RPRN LSFT(KC_0)      // )
 222 #define KC_RIGHT_PAREN  KC_RPRN
 223
 224 #define KC_UNDS LSFT(KC_MINS)   // _
 225 #define KC_UNDERSCORE   KC_UNDS
 226
 227 #define KC_PLUS LSFT(KC_EQL)    // +
 228
 229 #define KC_LCBR LSFT(KC_LBRC)   // {
 230 #define KC_LEFT_CURLY_BRACE KC_LCBR
 231
 232 #define KC_RCBR LSFT(KC_RBRC)   // }
 233 #define KC_RIGHT_CURLY_BRACE    KC_RCBR
 234
 235 #define KC_LABK LSFT(KC_COMM)   // <
 236 #define KC_LEFT_ANGLE_BRACKET   KC_LABK
 237
 238 #define KC_RABK LSFT(KC_DOT)    // >
 239 #define KC_RIGHT_ANGLE_BRACKET  KC_RABK
 240
 241 #define KC_COLN LSFT(KC_SCLN)   // :
 242 #define KC_COLON    KC_COLN
 243
 244 #define KC_PIPE LSFT(KC_BSLS)   // |
 245
 246 #define KC_LT LSFT(KC_COMM)     // <
 247
 248 #define KC_GT LSFT(KC_DOT)      // >
 249
 250 #define KC_QUES LSFT(KC_SLSH)   // ?
 251 #define KC_QUESTION KC_QUES
 252
 253 #define KC_DQT LSFT(KC_QUOT)   // "
 254 #define KC_DOUBLE_QUOTE KC_DQT
 255 #define KC_DQUO KC_DQT
 256
 257 #define KC_DELT KC_DELETE // Del key (four letter code)
 258
 259 // Alias for function layers than expand past FN31
 260 #define FUNC(kc) (kc | QK_FUNCTION)
 261
 262 // Aliases
 263 #define S(kc) LSFT(kc)
 264 #define F(kc) FUNC(kc)
 265
 266 #define M(kc) (kc | QK_MACRO)
 267
 268 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
 269 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
 270
 271
 272 // L-ayer, T-ap - 256 keycode max, 16 layer max
 273 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
 274
 275 #define AG_SWAP MAGIC_SWAP_ALT_GUI
 276 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
 277
 278 #define BL_ON  BL_9
 279 #define BL_OFF BL_0
 280
 281 #define MI_ON MIDI_ON
 282 #define MI_OFF MIDI_OFF
 283
 284 // GOTO layer - 16 layers max
 285 // when:
 286 // ON_PRESS    = 1
 287 // ON_RELEASE  = 2
 288 // Unless you have a good reason not to do so, prefer  ON_PRESS (1) as your default.
 289 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
 290 // keycode modeled after the old version, kept below for this.
 291 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
 292 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
 293
 294 // Momentary switch layer - 256 layer max
 295 #define MO(layer) (layer | QK_MOMENTARY)
 296
 297 // Set default layer - 256 layer max
 298 #define DF(layer) (layer | QK_DEF_LAYER)
 299
 300 // Toggle to layer - 256 layer max
 301 #define TG(layer) (layer | QK_TOGGLE_LAYER)
 302
 303 // One-shot layer - 256 layer max
 304 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
 305
 306 // One-shot mod
 307 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
 308
 309 // Layer tap-toggle
 310 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
 311
 312 // M-od, T-ap - 256 keycode max
 313 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
 314
 315 #define CTL_T(kc) MT(MOD_LCTL, kc)
 316 #define LCTL_T(kc) MT(MOD_LCTL, kc)
 317 #define RCTL_T(kc) MT(MOD_RCTL, kc)
 318
 319 #define SFT_T(kc) MT(MOD_LSFT, kc)
 320 #define LSFT_T(kc) MT(MOD_LSFT, kc)
 321 #define RSFT_T(kc) MT(MOD_RSFT, kc)
 322
 323 #define ALT_T(kc) MT(MOD_LALT, kc)
 324 #define LALT_T(kc) MT(MOD_LALT, kc)
 325 #define RALT_T(kc) MT(MOD_RALT, kc)
 326 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
 327
 328 #define GUI_T(kc) MT(MOD_LGUI, kc)
 329 #define LGUI_T(kc) MT(MOD_LGUI, kc)
 330 #define RGUI_T(kc) MT(MOD_RGUI, kc)
 331
 332 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
 333 #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
 334 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
 335 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
 336 #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/
 337 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
 338 #define SWIN_T(kc) SCMD_T(kc)
 339
 340 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
 341 #define KC_HYPR HYPR(KC_NO)
 342 #define KC_MEH  MEH(KC_NO)
 343
 344 #ifdef UNICODE_ENABLE
 345     // For sending unicode codes.
 346     // You may not send codes over 7FFF -- this supports most of UTF8.
 347     // To have a key that sends out Œ, go UC(0x0152)
 348     #define UNICODE(n) (n | QK_UNICODE)
 349     #define UC(n) UNICODE(n)
 350 #endif
 351
 352 #ifdef UNICODEMAP_ENABLE
 353     #define X(n) (n | QK_UNICODE_MAP)
 354 #endif
 355
 356 #endif // QUANTUM_KEYCODES_H