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     // Midi mode on/off
 111     MIDI_ON,
 112     MIDI_OFF,
 113
 114     // Backlight functionality
 115     BL_0,
 116     BL_1,
 117     BL_2,
 118     BL_3,
 119     BL_4,
 120     BL_5,
 121     BL_6,
 122     BL_7,
 123     BL_8,
 124     BL_9,
 125     BL_10,
 126     BL_11,
 127     BL_12,
 128     BL_13,
 129     BL_14,
 130     BL_15,
 131     BL_DEC,
 132     BL_INC,
 133     BL_TOGG,
 134     BL_STEP,
 135
 136     // RGB functionality
 137     RGB_TOG,
 138     RGB_MOD,
 139     RGB_HUI,
 140     RGB_HUD,
 141     RGB_SAI,
 142     RGB_SAD,
 143     RGB_VAI,
 144     RGB_VAD,
 145
 146     // Left shift, open paren
 147     KC_LSPO,
 148
 149     // Right shift, close paren
 150     KC_RSPC,
 151
 152     // Printing
 153     PRINT_ON,
 154     PRINT_OFF,
 155
 156     // output selection
 157     OUT_AUTO,
 158     OUT_USB,
 159 #ifdef BLUETOOTH_ENABLE
 160     OUT_BT,
 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 #define LCA(kc) (kc | QK_LCTL | QK_LALT)
 184
 185 #define MOD_HYPR 0xf
 186 #define MOD_MEH 0x7
 187
 188
 189 // Aliases for shifted symbols
 190 // Each key has a 4-letter code, and some have longer aliases too.
 191 // While the long aliases are descriptive, the 4-letter codes
 192 // make for nicer grid layouts (everything lines up), and are
 193 // the preferred style for Quantum.
 194 #define KC_TILD LSFT(KC_GRV)    // ~
 195 #define KC_TILDE    KC_TILD
 196
 197 #define KC_EXLM LSFT(KC_1)      // !
 198 #define KC_EXCLAIM  KC_EXLM
 199
 200 #define KC_AT   LSFT(KC_2)      // @
 201
 202 #define KC_HASH LSFT(KC_3)      // #
 203
 204 #define KC_DLR  LSFT(KC_4)      // $
 205 #define KC_DOLLAR   KC_DLR
 206
 207 #define KC_PERC LSFT(KC_5)      // %
 208 #define KC_PERCENT  KC_PERC
 209
 210 #define KC_CIRC LSFT(KC_6)      // ^
 211 #define KC_CIRCUMFLEX   KC_CIRC
 212
 213 #define KC_AMPR LSFT(KC_7)      // &
 214 #define KC_AMPERSAND    KC_AMPR
 215
 216 #define KC_ASTR LSFT(KC_8)      // *
 217 #define KC_ASTERISK KC_ASTR
 218
 219 #define KC_LPRN LSFT(KC_9)      // (
 220 #define KC_LEFT_PAREN   KC_LPRN
 221
 222 #define KC_RPRN LSFT(KC_0)      // )
 223 #define KC_RIGHT_PAREN  KC_RPRN
 224
 225 #define KC_UNDS LSFT(KC_MINS)   // _
 226 #define KC_UNDERSCORE   KC_UNDS
 227
 228 #define KC_PLUS LSFT(KC_EQL)    // +
 229
 230 #define KC_LCBR LSFT(KC_LBRC)   // {
 231 #define KC_LEFT_CURLY_BRACE KC_LCBR
 232
 233 #define KC_RCBR LSFT(KC_RBRC)   // }
 234 #define KC_RIGHT_CURLY_BRACE    KC_RCBR
 235
 236 #define KC_LABK LSFT(KC_COMM)   // <
 237 #define KC_LEFT_ANGLE_BRACKET   KC_LABK
 238
 239 #define KC_RABK LSFT(KC_DOT)    // >
 240 #define KC_RIGHT_ANGLE_BRACKET  KC_RABK
 241
 242 #define KC_COLN LSFT(KC_SCLN)   // :
 243 #define KC_COLON    KC_COLN
 244
 245 #define KC_PIPE LSFT(KC_BSLS)   // |
 246
 247 #define KC_LT LSFT(KC_COMM)     // <
 248
 249 #define KC_GT LSFT(KC_DOT)      // >
 250
 251 #define KC_QUES LSFT(KC_SLSH)   // ?
 252 #define KC_QUESTION KC_QUES
 253
 254 #define KC_DQT LSFT(KC_QUOT)   // "
 255 #define KC_DOUBLE_QUOTE KC_DQT
 256 #define KC_DQUO KC_DQT
 257
 258 #define KC_DELT KC_DELETE // Del key (four letter code)
 259
 260 // Alias for function layers than expand past FN31
 261 #define FUNC(kc) (kc | QK_FUNCTION)
 262
 263 // Aliases
 264 #define S(kc) LSFT(kc)
 265 #define F(kc) FUNC(kc)
 266
 267 #define M(kc) (kc | QK_MACRO)
 268
 269 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
 270 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
 271
 272
 273 // L-ayer, T-ap - 256 keycode max, 16 layer max
 274 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
 275
 276 #define AG_SWAP MAGIC_SWAP_ALT_GUI
 277 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
 278
 279 #define BL_ON  BL_9
 280 #define BL_OFF BL_0
 281
 282 #define MI_ON MIDI_ON
 283 #define MI_OFF MIDI_OFF
 284
 285 // GOTO layer - 16 layers max
 286 // when:
 287 // ON_PRESS    = 1
 288 // ON_RELEASE  = 2
 289 // Unless you have a good reason not to do so, prefer  ON_PRESS (1) as your default.
 290 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
 291 // keycode modeled after the old version, kept below for this.
 292 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
 293 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
 294
 295 // Momentary switch layer - 256 layer max
 296 #define MO(layer) (layer | QK_MOMENTARY)
 297
 298 // Set default layer - 256 layer max
 299 #define DF(layer) (layer | QK_DEF_LAYER)
 300
 301 // Toggle to layer - 256 layer max
 302 #define TG(layer) (layer | QK_TOGGLE_LAYER)
 303
 304 // One-shot layer - 256 layer max
 305 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
 306
 307 // One-shot mod
 308 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
 309
 310 // Layer tap-toggle
 311 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
 312
 313 // M-od, T-ap - 256 keycode max
 314 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
 315
 316 #define CTL_T(kc) MT(MOD_LCTL, kc)
 317 #define LCTL_T(kc) MT(MOD_LCTL, kc)
 318 #define RCTL_T(kc) MT(MOD_RCTL, kc)
 319
 320 #define SFT_T(kc) MT(MOD_LSFT, kc)
 321 #define LSFT_T(kc) MT(MOD_LSFT, kc)
 322 #define RSFT_T(kc) MT(MOD_RSFT, kc)
 323
 324 #define ALT_T(kc) MT(MOD_LALT, kc)
 325 #define LALT_T(kc) MT(MOD_LALT, kc)
 326 #define RALT_T(kc) MT(MOD_RALT, kc)
 327 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
 328
 329 #define GUI_T(kc) MT(MOD_LGUI, kc)
 330 #define LGUI_T(kc) MT(MOD_LGUI, kc)
 331 #define RGUI_T(kc) MT(MOD_RGUI, kc)
 332
 333 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
 334 #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
 335 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
 336 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
 337 #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/
 338 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
 339 #define SWIN_T(kc) SCMD_T(kc)
 340 #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
 341
 342 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
 343 #define KC_HYPR HYPR(KC_NO)
 344 #define KC_MEH  MEH(KC_NO)
 345
 346 #ifdef UNICODE_ENABLE
 347     // For sending unicode codes.
 348     // You may not send codes over 7FFF -- this supports most of UTF8.
 349     // To have a key that sends out Œ, go UC(0x0152)
 350     #define UNICODE(n) (n | QK_UNICODE)
 351     #define UC(n) UNICODE(n)
 352 #endif
 353
 354 #ifdef UNICODEMAP_ENABLE
 355     #define X(n) (n | QK_UNICODE_MAP)
 356 #endif
 357
 358 #endif // QUANTUM_KEYCODES_H