2 Copyright 2012,2013 Jun Wako <wakojun@gmail.com>
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 /* Struct to record event and tap count */
32 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
33 * AVR looks like a little endian in avr-gcc.
35 * NOTE: not portable across compiler/endianness?
36 * Byte order and bit order of 0x1234:
37 * Big endian: 15 ... 8 7 ... 210
40 * Little endian: 012 ... 7 8 ... 15
65 struct action_command {
70 struct action_function {
79 /* Execute action per keyevent */
80 void action_exec(keyevent_t event);
83 action_t action_for_key(uint8_t layer, key_t key);
85 /* user defined special function */
86 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt);
89 * Utilities for actions.
91 void register_code(uint8_t code);
92 void unregister_code(uint8_t code);
93 void add_mods(uint8_t mods);
94 void del_mods(uint8_t mods);
95 void set_mods(uint8_t mods);
96 void clear_keyboard(void);
97 void clear_keyboard_but_mods(void);
98 bool sending_anykey(void);
99 void layer_switch(uint8_t new_layer);
100 bool is_tap_key(key_t key);
101 bool waiting_buffer_has_anykey_pressed(void);
108 * 16bit code: action_kind(4bit) + action_parameter(12bit)
113 * 0000|0000|000000|00 No action
114 * 0000|0000|000000|01 Transparent
115 * 0000|0000| keycode Key
116 * 0000|mods|000000|00 Left mods
117 * 0000|mods| keycode Key & Left mods
120 * 0001|0000|000000|00 No action(not used)
121 * 0001|0000|000000|01 Transparent(not used)
122 * 0001|0000| keycode Key(no used)
123 * 0001|mods|000000|00 Right mods
124 * 0001|mods| keycode Key & Right mods
126 * ACT_LMODS_TAP(0010):
127 * 0010|mods|000000|00 Left mods OneShot
128 * 0010|mods|000000|01 (reserved)
129 * 0010|mods|000000|10 (reserved)
130 * 0010|mods|000000|11 (reserved)
131 * 0010|mods| keycode Left mods + tap Key
133 * ACT_RMODS_TAP(0011):
134 * 0011|mods|000000|00 Right mods OneShot
135 * 0011|mods|000000|01 (reserved)
136 * 0011|mods|000000|10 (reserved)
137 * 0011|mods|000000|11 (reserved)
138 * 0011|mods| keycode Right mods + tap Key
143 * This action handles other usages than keyboard.
145 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
146 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
147 * 0100|10| usage(10) (reserved)
148 * 0100|11| usage(10) (reserved)
153 * ACT_MOUSEKEY(0110):
154 * 0101|XXXX| keycode Mouse key
160 * 1000|--xx|0000 0000 Clear keyamp and overlay
161 * 1000|LLLL|0000 00xx Reset default layer and clear keymap and overlay
162 * 1000|LLLL| keycode Invert with tap key
163 * 1000|LLLL|1111 0000 Invert with tap toggle
164 * 1000|LLLL|1111 00xx Invert[^= L]
165 * 1000|LLLL|1111 0100 On/Off
166 * 1000|LLLL|1111 01xx On[|= L]
167 * 1000|LLLL|1111 1000 Off/On
168 * 1000|LLLL|1111 10xx Off[&= ~L]
169 * 1000|LLLL|1111 1100 Set/Set(0)
170 * 1000|LLLL|1111 11xx Set[= L]
171 * default layer: 0-15(4bit)
172 * xx: On {00:for special use, 01:press, 10:release, 11:both}
175 * 1011|0000|0000 0000 Clear overlay
176 * 1011|LLLL|0000 00ss Invert 4-bit chunk [^= L<<(4*ss)]
177 * 1011|LLLL| keycode Invert with tap key
178 * 1011|LLLL|1111 0000 Invert with tap toggle
179 * 1011|LLLL|1111 00xx Invert[^= 1<<L]
180 * 1011|LLLL|1111 0100 On/Off(momentary)
181 * 1011|LLLL|1111 01xx On[|= 1<<L]
182 * 1011|LLLL|1111 1000 Off/On
183 * 1011|LLLL|1111 10xx Off[&= ~1<<L]
184 * 1011|LLLL|1111 1100 Set[= 1<<L]/Clear
185 * 1011|LLLL|1111 11xx Set[= 1<<L]
186 * overlays: 16-layer on/off status(16bit)
187 * xx: On {00:for special use, 01:press, 10:release, 11:both}
195 * 1100|opt | id(8) Macro play?
196 * 1100|1111| id(8) Macro record?
199 * 1110|opt | id(8) Built-in Command exec
201 * ACT_FUNCTION(1111):
202 * 1111| address(12) Function?
203 * 1111|opt | id(8) Function?
206 enum action_kind_id {
209 ACT_LMODS_TAP = 0b0010,
210 ACT_RMODS_TAP = 0b0011,
213 ACT_MOUSEKEY = 0b0101,
216 ACT_OVERLAY = 0b1001,
219 ACT_COMMAND = 0b1110,
220 ACT_FUNCTION = 0b1111
226 #define ACTION_TRANSPARENT 1
227 #define ACTION(kind, param) ((kind)<<12 | (param))
228 #define MODS4(mods) (((mods)>>4 | (mods)) & 0x0F)
233 #define ACTION_KEY(key) ACTION(ACT_LMODS, key)
235 #define ACTION_LMODS(mods) ACTION(ACT_LMODS, MODS4(mods)<<8 | 0x00)
236 #define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, MODS4(mods)<<8 | (key))
237 #define ACTION_RMODS(mods) ACTION(ACT_RMODS, MODS4(mods)<<8 | 0x00)
238 #define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, MODS4(mods)<<8 | (key))
239 #define ACTION_LMOD(mod) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | 0x00)
240 #define ACTION_LMOD_KEY(mod, key) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | (key))
241 #define ACTION_RMOD(mod) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | 0x00)
242 #define ACTION_RMOD_KEY(mod, key) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | (key))
247 #define ACTION_LMODS_TAP_KEY(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key))
248 #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT)
249 #define ACTION_RMODS_TAP_KEY(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key))
250 #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT)
251 #define ACTION_LMOD_TAP_KEY(mod, key) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
252 #define ACTION_LMOD_ONESHOT(mod) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT)
253 #define ACTION_RMOD_TAP_KEY(mod, key) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
254 #define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT)
258 * Invert layer ^= (1<<layer)
259 * On layer |= (1<<layer)
260 * Off layer &= ~(1<<layer)
261 * Set layer = (1<<layer)
280 #define ACTION_DEFAULT_LAYER ACTION(ACT_KEYMAP, 0<<8 | OP_RESET | 0)
281 #define ACTION_SET_DEFAULT_LAYER(layer) ACTION_KEYMAP_RESET(layer)
282 #define ACTION_SET_DEFAULT_LAYER_P(layer) ACTION_KEYMAP_RESET_P(layer)
283 #define ACTION_SET_DEFAULT_LAYER_R(layer) ACTION_KEYMAP_RESET_R(layer)
284 #define ACTION_SET_DEFAULT_LAYER_B(layer) ACTION_KEYMAP_RESET_B(layer)
288 #define ACTION_KEYMAP(layer) ACTION_KEYMAP_MOMENTARY(layer)
289 #define ACTION_KEYMAP_MOMENTARY(layer) ACTION_KEYMAP_ON_OFF(layer)
290 #define ACTION_KEYMAP_TOGGLE(layer) ACTION_KEYMAP_INV_R(layer)
291 /* Keymap Set and clear overaly */
292 #define ACTION_KEYMAP_RESET(layer) ACTION_KEYMAP_RESET_R(layer)
293 #define ACTION_KEYMAP_RESET_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_PRESS)
294 #define ACTION_KEYMAP_RESET_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_RELEASE)
295 #define ACTION_KEYMAP_RESET_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_BOTH)
297 #define ACTION_KEYMAP_INV(layer) ACTION_KEYMAP_INV_B(layer)
298 #define ACTION_KEYMAP_TAP_TOGGLE(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | 0)
299 #define ACTION_KEYMAP_INV_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_PRESS)
300 #define ACTION_KEYMAP_INV_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_RELEASE)
301 #define ACTION_KEYMAP_INV_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_BOTH)
303 #define ACTION_KEYMAP_ON(layer) ACTION_KEYMAP_ON_OFF(layer)
304 #define ACTION_KEYMAP_ON_OFF(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | 0)
305 #define ACTION_KEYMAP_ON_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_PRESS)
306 #define ACTION_KEYMAP_ON_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_RELEASE)
307 #define ACTION_KEYMAP_ON_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_BOTH)
309 #define ACTION_KEYMAP_OFF(layer) ACTION_KEYMAP_OFF_ON(layer)
310 #define ACTION_KEYMAP_OFF_ON(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | 0)
311 #define ACTION_KEYMAP_OFF_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_PRESS)
312 #define ACTION_KEYMAP_OFF_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_RELEASE)
313 #define ACTION_KEYMAP_OFF_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_BOTH)
315 #define ACTION_KEYMAP_SET(layer) ACTION_KEYMAP_SET_CLEAR(layer)
316 #define ACTION_KEYMAP_SET_CLEAR(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | 0)
317 #define ACTION_KEYMAP_SET_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_PRESS)
318 #define ACTION_KEYMAP_SET_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_RELEASE)
319 #define ACTION_KEYMAP_SET_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_BOTH)
320 /* Keymap Invert with tap key */
321 #define ACTION_KEYMAP_TAP_KEY(layer, key) ACTION(ACT_KEYMAP, (layer)<<8 | (key))
326 #define ACTION_OVERLAY(layer) ACTION_OVERLAY_MOMENTARY(layer)
327 #define ACTION_OVERLAY_MOMENTARY(layer) ACTION_OVERLAY_ON_OFF(layer)
328 #define ACTION_OVERLAY_TOGGLE(layer) ACTION_OVERLAY_INV_R(layer)
330 #define ACTION_OVERLAY_CLEAR ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | 0)
331 #define ACTION_OVERLAY_CLEAR_P ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_PRESS)
332 #define ACTION_OVERLAY_CLEAR_R ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_RELEASE)
333 #define ACTION_OVERLAY_CLEAR_B ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_BOTH)
334 /* Overlay Invert 4-bit chunk */
335 #define ACTION_OVERLAY_INV4(bits, shift) ACTION(ACT_OVERLAY, (bits)<<8 | OP_INV4 | shift)
337 #define ACTION_OVERLAY_INV(layer) ACTION_OVERLAY_INV_B(layer)
338 #define ACTION_OVERLAY_TAP_TOGGLE(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | 0)
339 #define ACTION_OVERLAY_INV_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_PRESS)
340 #define ACTION_OVERLAY_INV_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_RELEASE)
341 #define ACTION_OVERLAY_INV_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_BOTH)
343 #define ACTION_OVERLAY_ON(layer) ACTION_OVERLAY_ON_OFF(layer)
344 #define ACTION_OVERLAY_ON_OFF(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | 0)
345 #define ACTION_OVERLAY_ON_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_PRESS)
346 #define ACTION_OVERLAY_ON_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_RELEASE)
347 #define ACTION_OVERLAY_ON_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_BOTH)
349 #define ACTION_OVERLAY_OFF(layer) ACTION_OVERLAY_OFF_ON(layer)
350 #define ACTION_OVERLAY_OFF_ON(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | 0)
351 #define ACTION_OVERLAY_OFF_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_PRESS)
352 #define ACTION_OVERLAY_OFF_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_RELEASE)
353 #define ACTION_OVERLAY_OFF_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_BOTH)
355 #define ACTION_OVERLAY_SET(layer) ACTION_OVERLAY_SET_CLEAR(layer)
356 #define ACTION_OVERLAY_SET_CLEAR(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | 0)
357 #define ACTION_OVERLAY_SET_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_PRESS)
358 #define ACTION_OVERLAY_SET_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_RELEASE)
359 #define ACTION_OVERLAY_SET_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_BOTH)
360 /* Overlay Invert with tap key */
361 #define ACTION_OVERLAY_TAP_KEY(layer, key) ACTION(ACT_OVERLAY, (layer)<<8 | (key))
371 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
372 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
375 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
378 #define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
381 #define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
385 FUNC_TAP = 0x8, /* indciates function is tappable */
387 #define ACTION_FUNCTION(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | id)
388 #define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | id)
390 #endif /* ACTION_H */