#ifndef ACTION_H
#define ACTION_H
+#include <stdint.h>
+#include <stdbool.h>
#include "keyboard.h"
#include "keycode.h"
#include "action_macro.h"
-/* Struct to record event and tap count */
-typedef union {
+typedef struct {
+ keyevent_t event;
+#ifndef NO_ACTION_TAPPING
+ /* tapping count and state */
struct {
bool interrupted :1;
bool reserved2 :1;
bool reserved1 :1;
bool reserved0 :1;
uint8_t count :4;
- };
-} tap_t;
-
-typedef struct {
- keyevent_t event;
- tap_t tap;
+ } tap;
+#endif
} keyrecord_t;
/* Action struct.
uint8_t mods :4;
uint8_t kind :4;
} key;
- struct action_layer {
- uint8_t code :8;
- uint8_t val :4;
+ struct action_layer_bitop {
+ uint8_t bits :4;
+ uint8_t xbit :1;
+ uint8_t part :3;
+ uint8_t on :2;
+ uint8_t op :2;
uint8_t kind :4;
- } layer;
+ } layer_bitop;
+ struct action_layer_tap {
+ uint8_t code :8;
+ uint8_t val :5;
+ uint8_t kind :3;
+ } layer_tap;
struct action_usage {
uint16_t code :10;
uint8_t page :2;
/* user defined special function */
void action_function(keyrecord_t *record, uint8_t id, uint8_t opt);
-/*
- * Utilities for actions.
- */
+/* Utilities for actions. */
+void process_action(keyrecord_t *record);
void register_code(uint8_t code);
void unregister_code(uint8_t code);
void add_mods(uint8_t mods);
bool sending_anykey(void);
void layer_switch(uint8_t new_layer);
bool is_tap_key(key_t key);
-bool waiting_buffer_has_anykey_pressed(void);
+
+/* debug */
+void debug_event(keyevent_t event);
+void debug_record(keyrecord_t record);
+void debug_action(action_t action);
*
* Layer Actions(10XX)
* -------------------
- * ACT_KEYMAP:
- * 1000|--xx|0000 0000 Clear keyamp and overlay
- * 1000|LLLL|0000 00xx Reset default layer and clear keymap and overlay
- * 1000|LLLL| keycode Invert with tap key
- * 1000|LLLL|1111 0000 Invert with tap toggle
- * 1000|LLLL|1111 00xx Invert[^= 1<<L]
- * 1000|LLLL|1111 0100 On/Off
- * 1000|LLLL|1111 01xx On[|= 1<<L]
- * 1000|LLLL|1111 1000 Off/On
- * 1000|LLLL|1111 10xx Off[&= ~(1<<L)]
- * 1000|LLLL|1111 1100 Set/Clear
- * 1000|LLLL|1111 11xx Set[= 1<<L]
- * default layer: 0-15(4bit)
- * xx: On {00:for special use, 01:press, 10:release, 11:both}
+ * ACT_LAYER:
+ * 1000|oo00|pppx BBBB Default Layer Bitwise operation
+ * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
+ * ppp: 4-bit chunk part(0-7)
+ * xBBBB: bits and extra bit
+ * 1000|ooee|pppx BBBB Layer Bitwise Operation
+ * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
+ * ppp: 4-bit chunk part(0-7)
+ * xBBBB: bits and extra bit
+ * ee: on event(00:default layer, 01:press, 10:release, 11:both)
+ *
+ * ACT_LAYER_TAP:
+ * 101x|LLLL| keycode Invert with tap key
+ * 101x|LLLL|1110 xxxx Reserved(0xE0-EF)
+ * 101x|LLLL|1111 0000 Invert with tap toggle(0xF0)
+ * 101x|LLLL|1111 0001 On Off
+ * 101x|LLLL|1111 0010 Off On
+ * 101x|LLLL|1111 0011 Set Clear
+ * 101x|LLLL|1111 xxxx Reserved(0xF4-FF)
+ * xLLLL: layer(0-31)
+ *
+ *
*
- * ACT_OVERLAY:
- * 1011|0000|0000 0000 Clear overlay
- * 1011|LLLL|0000 00ss Invert 4-bit chunk [^= L<<(4*ss)]
- * 1011|LLLL| keycode Invert with tap key
- * 1011|LLLL|1111 0000 Invert with tap toggle
- * 1011|LLLL|1111 00xx Invert[^= 1<<L]
- * 1011|LLLL|1111 0100 On/Off(momentary)
- * 1011|LLLL|1111 01xx On[|= 1<<L]
- * 1011|LLLL|1111 1000 Off/On
- * 1011|LLLL|1111 10xx Off[&= ~(1<<L)]
- * 1011|LLLL|1111 1100 Set/Clear
- * 1011|LLLL|1111 11xx Set[= 1<<L]
- * overlays: 16-layer on/off status(16bit)
- * xx: On {00:for special use, 01:press, 10:release, 11:both}
*
*
* Extensions(11XX)
*
*/
enum action_kind_id {
+ ACT_MODS = 0b0000,
ACT_LMODS = 0b0000,
ACT_RMODS = 0b0001,
+ ACT_MODS_TAP = 0b0010,
ACT_LMODS_TAP = 0b0010,
ACT_RMODS_TAP = 0b0011,
ACT_USAGE = 0b0100,
ACT_MOUSEKEY = 0b0101,
- ACT_KEYMAP = 0b1000,
- ACT_OVERLAY = 0b1001,
+ ACT_LAYER = 0b1000,
+ ACT_LAYER_TAP = 0b1010,
+ ACT_LAYER_TAP1 = 0b1011,
ACT_MACRO = 0b1100,
ACT_COMMAND = 0b1110,
-/* Layer Actions:
- * Invert layer ^= (1<<layer)
- * On layer |= (1<<layer)
- * Off layer &= ~(1<<layer)
- * Set layer = (1<<layer)
- * Clear layer = 0
- */
-enum layer_params {
+/* Layer Actions */
+enum layer_param_on {
ON_PRESS = 1,
ON_RELEASE = 2,
ON_BOTH = 3,
+};
- OP_RESET = 0x00,
- OP_INV4 = 0x00,
- OP_INV = 0xF0,
- OP_ON = 0xF4,
- OP_OFF = 0xF8,
- OP_SET = 0xFC,
+enum layer_param_op {
+ OP_DEFAULT_LAYER = 0,
};
-/*
- * Default Layer
- */
-#define ACTION_DEFAULT_LAYER ACTION(ACT_KEYMAP, 0<<8 | OP_RESET | 0)
-#define ACTION_DEFAULT_LAYER_SET(layer) ACTION_KEYMAP_RESET(layer)
-#define ACTION_DEFAULT_LAYER_SET_P(layer) ACTION_KEYMAP_RESET_P(layer)
-#define ACTION_DEFAULT_LAYER_SET_R(layer) ACTION_KEYMAP_RESET_R(layer)
-#define ACTION_DEFAULT_LAYER_SET_B(layer) ACTION_KEYMAP_RESET_B(layer)
-#define ACTION_SET_DEFAULT_LAYER(layer) ACTION_KEYMAP_RESET(layer)
-#define ACTION_SET_DEFAULT_LAYER_P(layer) ACTION_KEYMAP_RESET_P(layer)
-#define ACTION_SET_DEFAULT_LAYER_R(layer) ACTION_KEYMAP_RESET_R(layer)
-#define ACTION_SET_DEFAULT_LAYER_B(layer) ACTION_KEYMAP_RESET_B(layer)
-/*
- * Keymap Layer
- */
-#define ACTION_KEYMAP(layer) ACTION_KEYMAP_MOMENTARY(layer)
-#define ACTION_KEYMAP_MOMENTARY(layer) ACTION_KEYMAP_ON_OFF(layer)
-#define ACTION_KEYMAP_TOGGLE(layer) ACTION_KEYMAP_INV_R(layer)
-/* Keymap Set and clear overaly */
-#define ACTION_KEYMAP_RESET(layer) ACTION_KEYMAP_RESET_R(layer)
-#define ACTION_KEYMAP_RESET_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_PRESS)
-#define ACTION_KEYMAP_RESET_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_RELEASE)
-#define ACTION_KEYMAP_RESET_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_BOTH)
-/* Keymap Invert */
-#define ACTION_KEYMAP_INV(layer) ACTION_KEYMAP_INV_B(layer)
-#define ACTION_KEYMAP_TAP_TOGGLE(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | 0)
-#define ACTION_KEYMAP_INV_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_PRESS)
-#define ACTION_KEYMAP_INV_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_RELEASE)
-#define ACTION_KEYMAP_INV_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_BOTH)
-/* Keymap On */
-#define ACTION_KEYMAP_ON(layer) ACTION_KEYMAP_ON_OFF(layer)
-#define ACTION_KEYMAP_ON_OFF(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | 0)
-#define ACTION_KEYMAP_ON_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_PRESS)
-#define ACTION_KEYMAP_ON_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_RELEASE)
-#define ACTION_KEYMAP_ON_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_BOTH)
-/* Keymap Off */
-#define ACTION_KEYMAP_OFF(layer) ACTION_KEYMAP_OFF_ON(layer)
-#define ACTION_KEYMAP_OFF_ON(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | 0)
-#define ACTION_KEYMAP_OFF_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_PRESS)
-#define ACTION_KEYMAP_OFF_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_RELEASE)
-#define ACTION_KEYMAP_OFF_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_BOTH)
-/* Keymap Set */
-#define ACTION_KEYMAP_SET(layer) ACTION_KEYMAP_SET_CLEAR(layer)
-#define ACTION_KEYMAP_SET_CLEAR(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | 0)
-#define ACTION_KEYMAP_SET_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_PRESS)
-#define ACTION_KEYMAP_SET_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_RELEASE)
-#define ACTION_KEYMAP_SET_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_BOTH)
-/* Keymap Invert with tap key */
-#define ACTION_KEYMAP_TAP_KEY(layer, key) ACTION(ACT_KEYMAP, (layer)<<8 | (key))
+enum layer_param_bit_op {
+ OP_BIT_AND = 0,
+ OP_BIT_OR,
+ OP_BIT_XOR,
+ OP_BIT_SET,
+};
-/*
- * Overlay Layer
- */
-#define ACTION_OVERLAY(layer) ACTION_OVERLAY_MOMENTARY(layer)
-#define ACTION_OVERLAY_MOMENTARY(layer) ACTION_OVERLAY_ON_OFF(layer)
-#define ACTION_OVERLAY_TOGGLE(layer) ACTION_OVERLAY_INV_R(layer)
-/* Overlay Clear */
-#define ACTION_OVERLAY_CLEAR ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | 0)
-#define ACTION_OVERLAY_CLEAR_P ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_PRESS)
-#define ACTION_OVERLAY_CLEAR_R ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_RELEASE)
-#define ACTION_OVERLAY_CLEAR_B ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_BOTH)
-/* Overlay Invert 4-bit chunk */
-#define ACTION_OVERLAY_INV4(bits, shift) ACTION(ACT_OVERLAY, (bits)<<8 | OP_INV4 | shift)
-/* Overlay Invert */
-#define ACTION_OVERLAY_INV(layer) ACTION_OVERLAY_INV_B(layer)
-#define ACTION_OVERLAY_TAP_TOGGLE(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | 0)
-#define ACTION_OVERLAY_INV_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_PRESS)
-#define ACTION_OVERLAY_INV_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_RELEASE)
-#define ACTION_OVERLAY_INV_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_BOTH)
-/* Overlay On */
-#define ACTION_OVERLAY_ON(layer) ACTION_OVERLAY_ON_OFF(layer)
-#define ACTION_OVERLAY_ON_OFF(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | 0)
-#define ACTION_OVERLAY_ON_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_PRESS)
-#define ACTION_OVERLAY_ON_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_RELEASE)
-#define ACTION_OVERLAY_ON_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_BOTH)
-/* Overlay Off */
-#define ACTION_OVERLAY_OFF(layer) ACTION_OVERLAY_OFF_ON(layer)
-#define ACTION_OVERLAY_OFF_ON(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | 0)
-#define ACTION_OVERLAY_OFF_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_PRESS)
-#define ACTION_OVERLAY_OFF_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_RELEASE)
-#define ACTION_OVERLAY_OFF_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_BOTH)
-/* Overlay Set */
-#define ACTION_OVERLAY_SET(layer) ACTION_OVERLAY_SET_CLEAR(layer)
-#define ACTION_OVERLAY_SET_CLEAR(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | 0)
-#define ACTION_OVERLAY_SET_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_PRESS)
-#define ACTION_OVERLAY_SET_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_RELEASE)
-#define ACTION_OVERLAY_SET_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_BOTH)
-/* Overlay Invert with tap key */
-#define ACTION_OVERLAY_TAP_KEY(layer, key) ACTION(ACT_OVERLAY, (layer)<<8 | (key))
+enum layer_pram_tap_op {
+ OP_TAP_TOGGLE = 0xF0,
+ OP_ON_OFF,
+ OP_OFF_ON,
+ OP_SET_CLEAR,
+};
+
+/* Layer Operation 1000|ee00|ooov vvvv */
+#define ACTION_LAYER(op, val, on) (ACT_LAYER<<12 | (on)<<10 | (op)<<5 | val)
+/* Layer Bitwise Operation 1000|ooee|pppx BBBB */
+#define ACTION_LAYER_BITOP(op, part, bits, on) (ACT_LAYER<<12 | (op)<<10 | (on)<<8 | (part)<<5 | (bits)&0x1f)
+/* Layer with Tapping 101x|LLLL| keycode */
+#define ACTION_LAYER_TAP(layer, key) (ACT_LAYER_TAP<<12 | (layer)<<8 | (key))
+
+/* Default Layer Operation */
+#define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER(layer, ON_RELEASE)
+#define ACTION_DEFAULT_LAYER(layer, on) ACTION_LAYER(OP_DEFAULT_LAYER, layer, on)
+/* Layer Operation */
+#define ACTION_LAYER_CLEAR(on) ACTION_LAYER_AND(0x1f, (on))
+#define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
+#define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
+#define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
+#define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR((layer)/4, 1<<((layer)%4), (on))
+#define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
+#define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
+#define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
+#define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
+#define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
+/* Bitwise Operation */
+#define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, part, bits)
+#define ACTION_LAYER_BIT_OR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, part, bits)
+#define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, part, bits)
+#define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, part, bits)
+/* with Tapping */
+#define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
+#define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
/*
projects / qmk_firmware.git / blobdiff