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,
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,
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 // Music mode on/off/toggle
94 // Music voice iterate
102 // Backlight functionality
134 // Left shift, open paren
137 // Right shift, close paren
147 #ifdef BLUETOOTH_ENABLE
150 #ifdef ADAFRUIT_BLE_ENABLE
154 // always leave at the end
158 // Ability to use mods in layouts
159 #define LCTL(kc) (kc | QK_LCTL)
160 #define LSFT(kc) (kc | QK_LSFT)
161 #define LALT(kc) (kc | QK_LALT)
162 #define LGUI(kc) (kc | QK_LGUI)
163 #define RCTL(kc) (kc | QK_RCTL)
164 #define RSFT(kc) (kc | QK_RSFT)
165 #define RALT(kc) (kc | QK_RALT)
166 #define RGUI(kc) (kc | QK_RGUI)
168 #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
169 #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
170 #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
171 #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
172 #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
173 #define SWIN(kc) SCMD(kc)
179 // Aliases for shifted symbols
180 // Each key has a 4-letter code, and some have longer aliases too.
181 // While the long aliases are descriptive, the 4-letter codes
182 // make for nicer grid layouts (everything lines up), and are
183 // the preferred style for Quantum.
184 #define KC_TILD LSFT(KC_GRV) // ~
185 #define KC_TILDE KC_TILD
187 #define KC_EXLM LSFT(KC_1) // !
188 #define KC_EXCLAIM KC_EXLM
190 #define KC_AT LSFT(KC_2) // @
192 #define KC_HASH LSFT(KC_3) // #
194 #define KC_DLR LSFT(KC_4) // $
195 #define KC_DOLLAR KC_DLR
197 #define KC_PERC LSFT(KC_5) // %
198 #define KC_PERCENT KC_PERC
200 #define KC_CIRC LSFT(KC_6) // ^
201 #define KC_CIRCUMFLEX KC_CIRC
203 #define KC_AMPR LSFT(KC_7) // &
204 #define KC_AMPERSAND KC_AMPR
206 #define KC_ASTR LSFT(KC_8) // *
207 #define KC_ASTERISK KC_ASTR
209 #define KC_LPRN LSFT(KC_9) // (
210 #define KC_LEFT_PAREN KC_LPRN
212 #define KC_RPRN LSFT(KC_0) // )
213 #define KC_RIGHT_PAREN KC_RPRN
215 #define KC_UNDS LSFT(KC_MINS) // _
216 #define KC_UNDERSCORE KC_UNDS
218 #define KC_PLUS LSFT(KC_EQL) // +
220 #define KC_LCBR LSFT(KC_LBRC) // {
221 #define KC_LEFT_CURLY_BRACE KC_LCBR
223 #define KC_RCBR LSFT(KC_RBRC) // }
224 #define KC_RIGHT_CURLY_BRACE KC_RCBR
226 #define KC_LABK LSFT(KC_COMM) // <
227 #define KC_LEFT_ANGLE_BRACKET KC_LABK
229 #define KC_RABK LSFT(KC_DOT) // >
230 #define KC_RIGHT_ANGLE_BRACKET KC_RABK
232 #define KC_COLN LSFT(KC_SCLN) // :
233 #define KC_COLON KC_COLN
235 #define KC_PIPE LSFT(KC_BSLS) // |
237 #define KC_LT LSFT(KC_COMM) // <
239 #define KC_GT LSFT(KC_DOT) // >
241 #define KC_QUES LSFT(KC_SLSH) // ?
242 #define KC_QUESTION KC_QUES
244 #define KC_DQT LSFT(KC_QUOT) // "
245 #define KC_DOUBLE_QUOTE KC_DQT
246 #define KC_DQUO KC_DQT
248 #define KC_DELT KC_DELETE // Del key (four letter code)
250 // Alias for function layers than expand past FN31
251 #define FUNC(kc) (kc | QK_FUNCTION)
254 #define S(kc) LSFT(kc)
255 #define F(kc) FUNC(kc)
257 #define M(kc) (kc | QK_MACRO)
259 #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
260 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
263 // L-ayer, T-ap - 256 keycode max, 16 layer max
264 #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
266 #define AG_SWAP MAGIC_SWAP_ALT_GUI
267 #define AG_NORM MAGIC_UNSWAP_ALT_GUI
272 #define MI_ON MIDI_ON
273 #define MI_OFF MIDI_OFF
275 // GOTO layer - 16 layers max
279 // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
280 // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
281 // keycode modeled after the old version, kept below for this.
282 /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
283 #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
285 // Momentary switch layer - 256 layer max
286 #define MO(layer) (layer | QK_MOMENTARY)
288 // Set default layer - 256 layer max
289 #define DF(layer) (layer | QK_DEF_LAYER)
291 // Toggle to layer - 256 layer max
292 #define TG(layer) (layer | QK_TOGGLE_LAYER)
294 // One-shot layer - 256 layer max
295 #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
298 #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
300 // M-od, T-ap - 256 keycode max
301 #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0xF) << 8))
302 #define CTL_T(kc) MT(MOD_LCTL, kc)
303 #define SFT_T(kc) MT(MOD_LSFT, kc)
304 #define ALT_T(kc) MT(MOD_LALT, kc)
305 #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
306 #define GUI_T(kc) MT(MOD_LGUI, kc)
307 #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
308 #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
309 #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
310 #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/
311 #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
312 #define SWIN_T(kc) SCMD_T(kc)
314 // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
315 #define KC_HYPR HYPR(KC_NO)
316 #define KC_MEH MEH(KC_NO)
318 #ifdef UNICODE_ENABLE
319 // For sending unicode codes.
320 // You may not send codes over 7FFF -- this supports most of UTF8.
321 // To have a key that sends out Œ, go UC(0x0152)
322 #define UNICODE(n) (n | QK_UNICODE)
323 #define UC(n) UNICODE(n)
326 #ifdef UNICODEMAP_ENABLE
327 #define X(n) (n | QK_UNICODE_MAP)
330 #endif // QUANTUM_KEYCODES_H