2 #ifndef QUANTUM_KEYCODES_H
3 #define QUANTUM_KEYCODES_H
5 enum quantum_keycodes {
6 // Ranges used in shortucuts - not to be used directly
14 QK_RMODS_MIN = 0x1000,
21 QK_FUNCTION_MAX = 0x2FFF,
23 QK_MACRO_MAX = 0x3FFF,
24 QK_LAYER_TAP = 0x4000,
25 QK_LAYER_TAP_MAX = 0x4FFF,
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
40 QK_CHORDING_MAX = 0x56FF,
42 QK_TAP_DANCE = 0x5700,
43 QK_TAP_DANCE_MAX = 0x57FF,
44 QK_LAYER_TAP_TOGGLE = 0x5800,
45 QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
47 QK_MOD_TAP_MAX = 0x7FFF,
48 #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
49 #error "Cannot enable both UNICODEMAP && UNICODE"
53 QK_UNICODE_MAX = 0xFFFF,
55 #ifdef UNICODEMAP_ENABLE
56 QK_UNICODE_MAP = 0x8000,
57 QK_UNICODE_MAP_MAX = 0x83FF,
60 // Loose keycodes - to be used directly
64 MAGIC_SWAP_CONTROL_CAPSLOCK,
65 MAGIC_CAPSLOCK_TO_CONTROL,
70 MAGIC_SWAP_BACKSLASH_BACKSPACE,
73 MAGIC_UNSWAP_CONTROL_CAPSLOCK,
74 MAGIC_UNCAPSLOCK_TO_CONTROL,
75 MAGIC_UNSWAP_LALT_LGUI,
76 MAGIC_UNSWAP_RALT_RGUI,
78 MAGIC_UNSWAP_GRAVE_ESC,
79 MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
85 #ifndef DISABLE_LEADER
89 // Audio on/off/toggle
94 #ifdef FAUXCLICKY_ENABLE
101 // Music mode on/off/toggle
106 // Music voice iterate
114 // Backlight functionality
146 // Left shift, open paren
149 // Right shift, close paren
159 #ifdef BLUETOOTH_ENABLE
162 #ifdef ADAFRUIT_BLE_ENABLE
166 // always leave at the end
170 // Ability to use mods in layouts
171 #define LCTL(kc) (kc | QK_LCTL)
172 #define LSFT(kc) (kc | QK_LSFT)
173 #define LALT(kc) (kc | QK_LALT)
174 #define LGUI(kc) (kc | QK_LGUI)
175 #define RCTL(kc) (kc | QK_RCTL)
176 #define RSFT(kc) (kc | QK_RSFT)
177 #define RALT(kc) (kc | QK_RALT)
178 #define RGUI(kc) (kc | QK_RGUI)
180 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
181 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
182 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
183 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
184 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
185 #define SWIN(kc) SCMD(kc)
191 // Aliases for shifted symbols
192 // Each key has a 4-letter code, and some have longer aliases too.
193 // While the long aliases are descriptive, the 4-letter codes
194 // make for nicer grid layouts (everything lines up), and are
195 // the preferred style for Quantum.
196 #define KC_TILD LSFT(KC_GRV) // ~
197 #define KC_TILDE KC_TILD
199 #define KC_EXLM LSFT(KC_1) // !
200 #define KC_EXCLAIM KC_EXLM
202 #define KC_AT LSFT(KC_2) // @
204 #define KC_HASH LSFT(KC_3) // #
206 #define KC_DLR LSFT(KC_4) // $
207 #define KC_DOLLAR KC_DLR
209 #define KC_PERC LSFT(KC_5) // %
210 #define KC_PERCENT KC_PERC
212 #define KC_CIRC LSFT(KC_6) // ^
213 #define KC_CIRCUMFLEX KC_CIRC
215 #define KC_AMPR LSFT(KC_7) // &
216 #define KC_AMPERSAND KC_AMPR
218 #define KC_ASTR LSFT(KC_8) // *
219 #define KC_ASTERISK KC_ASTR
221 #define KC_LPRN LSFT(KC_9) // (
222 #define KC_LEFT_PAREN KC_LPRN
224 #define KC_RPRN LSFT(KC_0) // )
225 #define KC_RIGHT_PAREN KC_RPRN
227 #define KC_UNDS LSFT(KC_MINS) // _
228 #define KC_UNDERSCORE KC_UNDS
230 #define KC_PLUS LSFT(KC_EQL) // +
232 #define KC_LCBR LSFT(KC_LBRC) // {
233 #define KC_LEFT_CURLY_BRACE KC_LCBR
235 #define KC_RCBR LSFT(KC_RBRC) // }
236 #define KC_RIGHT_CURLY_BRACE KC_RCBR
238 #define KC_LABK LSFT(KC_COMM) // <
239 #define KC_LEFT_ANGLE_BRACKET KC_LABK
241 #define KC_RABK LSFT(KC_DOT) // >
242 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
244 #define KC_COLN LSFT(KC_SCLN) // :
245 #define KC_COLON KC_COLN
247 #define KC_PIPE LSFT(KC_BSLS) // |
249 #define KC_LT LSFT(KC_COMM) // <
251 #define KC_GT LSFT(KC_DOT) // >
253 #define KC_QUES LSFT(KC_SLSH) // ?
254 #define KC_QUESTION KC_QUES
256 #define KC_DQT LSFT(KC_QUOT) // "
257 #define KC_DOUBLE_QUOTE KC_DQT
258 #define KC_DQUO KC_DQT
260 #define KC_DELT KC_DELETE // Del key (four letter code)
262 // Alias for function layers than expand past FN31
263 #define FUNC(kc) (kc | QK_FUNCTION)
266 #define S(kc) LSFT(kc)
267 #define F(kc) FUNC(kc)
269 #define M(kc) (kc | QK_MACRO)
271 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
272 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
275 // L-ayer, T-ap - 256 keycode max, 16 layer max
276 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
278 #define AG_SWAP MAGIC_SWAP_ALT_GUI
279 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
284 #define MI_ON MIDI_ON
285 #define MI_OFF MIDI_OFF
287 // GOTO layer - 16 layers max
291 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
292 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
293 // keycode modeled after the old version, kept below for this.
294 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
295 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
297 // Momentary switch layer - 256 layer max
298 #define MO(layer) (layer | QK_MOMENTARY)
300 // Set default layer - 256 layer max
301 #define DF(layer) (layer | QK_DEF_LAYER)
303 // Toggle to layer - 256 layer max
304 #define TG(layer) (layer | QK_TOGGLE_LAYER)
306 // One-shot layer - 256 layer max
307 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
310 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
313 #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
315 // M-od, T-ap - 256 keycode max
316 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
318 #define CTL_T(kc) MT(MOD_LCTL, kc)
319 #define LCTL_T(kc) MT(MOD_LCTL, kc)
320 #define RCTL_T(kc) MT(MOD_RCTL, kc)
322 #define SFT_T(kc) MT(MOD_LSFT, kc)
323 #define LSFT_T(kc) MT(MOD_LSFT, kc)
324 #define RSFT_T(kc) MT(MOD_RSFT, kc)
326 #define ALT_T(kc) MT(MOD_LALT, kc)
327 #define LALT_T(kc) MT(MOD_LALT, kc)
328 #define RALT_T(kc) MT(MOD_RALT, kc)
329 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
331 #define GUI_T(kc) MT(MOD_LGUI, kc)
332 #define LGUI_T(kc) MT(MOD_LGUI, kc)
333 #define RGUI_T(kc) MT(MOD_RGUI, kc)
335 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
336 #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
337 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
338 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
339 #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/
340 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
341 #define SWIN_T(kc) SCMD_T(kc)
343 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
344 #define KC_HYPR HYPR(KC_NO)
345 #define KC_MEH MEH(KC_NO)
347 #ifdef UNICODE_ENABLE
348 // For sending unicode codes.
349 // You may not send codes over 7FFF -- this supports most of UTF8.
350 // To have a key that sends out Œ, go UC(0x0152)
351 #define UNICODE(n) (n | QK_UNICODE)
352 #define UC(n) UNICODE(n)
355 #ifdef UNICODEMAP_ENABLE
356 #define X(n) (n | QK_UNICODE_MAP)
359 #endif // QUANTUM_KEYCODES_H