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