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 #ifdef UNICODEMAP_ENABLE
45 QK_UNICODE_MAP = 0x5800,
46 QK_UNICODE_MAP_MAX = 0x5BFF,
49 QK_MOD_TAP_MAX = 0x7FFF,
52 QK_UNICODE_MAX = 0xFFFF,
55 // Loose keycodes - to be used directly
59 MAGIC_SWAP_CONTROL_CAPSLOCK,
60 MAGIC_CAPSLOCK_TO_CONTROL,
65 MAGIC_SWAP_BACKSLASH_BACKSPACE,
68 MAGIC_UNSWAP_CONTROL_CAPSLOCK,
69 MAGIC_UNCAPSLOCK_TO_CONTROL,
70 MAGIC_UNSWAP_LALT_LGUI,
71 MAGIC_UNSWAP_RALT_RGUI,
73 MAGIC_UNSWAP_GRAVE_ESC,
74 MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
80 #ifndef DISABLE_LEADER
84 // Audio on/off/toggle
89 #ifdef FAUXCLICKY_ENABLE
96 // Music mode on/off/toggle
101 // Music voice iterate
109 // Backlight functionality
141 // Left shift, open paren
144 // Right shift, close paren
154 #ifdef BLUETOOTH_ENABLE
157 #ifdef ADAFRUIT_BLE_ENABLE
161 // always leave at the end
165 // Ability to use mods in layouts
166 #define LCTL(kc) (kc | QK_LCTL)
167 #define LSFT(kc) (kc | QK_LSFT)
168 #define LALT(kc) (kc | QK_LALT)
169 #define LGUI(kc) (kc | QK_LGUI)
170 #define RCTL(kc) (kc | QK_RCTL)
171 #define RSFT(kc) (kc | QK_RSFT)
172 #define RALT(kc) (kc | QK_RALT)
173 #define RGUI(kc) (kc | QK_RGUI)
175 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
176 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
177 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
178 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
179 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
180 #define SWIN(kc) SCMD(kc)
186 // Aliases for shifted symbols
187 // Each key has a 4-letter code, and some have longer aliases too.
188 // While the long aliases are descriptive, the 4-letter codes
189 // make for nicer grid layouts (everything lines up), and are
190 // the preferred style for Quantum.
191 #define KC_TILD LSFT(KC_GRV) // ~
192 #define KC_TILDE KC_TILD
194 #define KC_EXLM LSFT(KC_1) // !
195 #define KC_EXCLAIM KC_EXLM
197 #define KC_AT LSFT(KC_2) // @
199 #define KC_HASH LSFT(KC_3) // #
201 #define KC_DLR LSFT(KC_4) // $
202 #define KC_DOLLAR KC_DLR
204 #define KC_PERC LSFT(KC_5) // %
205 #define KC_PERCENT KC_PERC
207 #define KC_CIRC LSFT(KC_6) // ^
208 #define KC_CIRCUMFLEX KC_CIRC
210 #define KC_AMPR LSFT(KC_7) // &
211 #define KC_AMPERSAND KC_AMPR
213 #define KC_ASTR LSFT(KC_8) // *
214 #define KC_ASTERISK KC_ASTR
216 #define KC_LPRN LSFT(KC_9) // (
217 #define KC_LEFT_PAREN KC_LPRN
219 #define KC_RPRN LSFT(KC_0) // )
220 #define KC_RIGHT_PAREN KC_RPRN
222 #define KC_UNDS LSFT(KC_MINS) // _
223 #define KC_UNDERSCORE KC_UNDS
225 #define KC_PLUS LSFT(KC_EQL) // +
227 #define KC_LCBR LSFT(KC_LBRC) // {
228 #define KC_LEFT_CURLY_BRACE KC_LCBR
230 #define KC_RCBR LSFT(KC_RBRC) // }
231 #define KC_RIGHT_CURLY_BRACE KC_RCBR
233 #define KC_LABK LSFT(KC_COMM) // <
234 #define KC_LEFT_ANGLE_BRACKET KC_LABK
236 #define KC_RABK LSFT(KC_DOT) // >
237 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
239 #define KC_COLN LSFT(KC_SCLN) // :
240 #define KC_COLON KC_COLN
242 #define KC_PIPE LSFT(KC_BSLS) // |
244 #define KC_LT LSFT(KC_COMM) // <
246 #define KC_GT LSFT(KC_DOT) // >
248 #define KC_QUES LSFT(KC_SLSH) // ?
249 #define KC_QUESTION KC_QUES
251 #define KC_DQT LSFT(KC_QUOT) // "
252 #define KC_DOUBLE_QUOTE KC_DQT
253 #define KC_DQUO KC_DQT
255 #define KC_DELT KC_DELETE // Del key (four letter code)
257 // Alias for function layers than expand past FN31
258 #define FUNC(kc) (kc | QK_FUNCTION)
261 #define S(kc) LSFT(kc)
262 #define F(kc) FUNC(kc)
264 #define M(kc) (kc | QK_MACRO)
266 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
267 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
270 // L-ayer, T-ap - 256 keycode max, 16 layer max
271 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
273 #define AG_SWAP MAGIC_SWAP_ALT_GUI
274 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
279 #define MI_ON MIDI_ON
280 #define MI_OFF MIDI_OFF
282 // GOTO layer - 16 layers max
286 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
287 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
288 // keycode modeled after the old version, kept below for this.
289 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
290 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
292 // Momentary switch layer - 256 layer max
293 #define MO(layer) (layer | QK_MOMENTARY)
295 // Set default layer - 256 layer max
296 #define DF(layer) (layer | QK_DEF_LAYER)
298 // Toggle to layer - 256 layer max
299 #define TG(layer) (layer | QK_TOGGLE_LAYER)
301 // One-shot layer - 256 layer max
302 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
305 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
307 // M-od, T-ap - 256 keycode max
308 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
310 #define CTL_T(kc) MT(MOD_LCTL, kc)
311 #define LCTL_T(kc) MT(MOD_LCTL, kc)
312 #define RCTL_T(kc) MT(MOD_RCTL, kc)
314 #define SFT_T(kc) MT(MOD_LSFT, kc)
315 #define LSFT_T(kc) MT(MOD_LSFT, kc)
316 #define RSFT_T(kc) MT(MOD_RSFT, kc)
318 #define ALT_T(kc) MT(MOD_LALT, kc)
319 #define LALT_T(kc) MT(MOD_LALT, kc)
320 #define RALT_T(kc) MT(MOD_RALT, kc)
321 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
323 #define GUI_T(kc) MT(MOD_LGUI, kc)
324 #define LGUI_T(kc) MT(MOD_LGUI, kc)
325 #define RGUI_T(kc) MT(MOD_RGUI, kc)
327 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
328 #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
329 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
330 #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
331 #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/
332 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
333 #define SWIN_T(kc) SCMD_T(kc)
335 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
336 #define KC_HYPR HYPR(KC_NO)
337 #define KC_MEH MEH(KC_NO)
339 #ifdef UNICODE_ENABLE
340 // For sending unicode codes.
341 // You may not send codes over 7FFF -- this supports most of UTF8.
342 // To have a key that sends out Œ, go UC(0x0152)
343 #define UNICODE(n) (n | QK_UNICODE)
344 #define UC(n) UNICODE(n)
347 #ifdef UNICODEMAP_ENABLE
348 #define X(n) (n | QK_UNICODE_MAP)
351 #endif // QUANTUM_KEYCODES_H