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