Add oneshot modifier action.

1 files changed, 95 insertions, 103 deletions

diff --git a/common/action.h b/common/action.h
index 327a009ef9..1b5b30d865 100644
--- a/common/action.h
+++ b/common/action.h
@@ -3,10 +3,79 @@
 
 #include "keyboard.h"
 
+
+/* Action struct.
+ *
+ * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15). 
+ * AVR looks like a little endian in avr-gcc.
+ *
+ * TODO: not portable across compiler/endianness?
+ * Byte order and bit order of 0x1234:
+ * Big endian:     15 ...  8 7 ... 210
+ *                |  0x12   |  0x34   |
+ *                 0001 0010 0011 0100
+ * Little endian:  012 ... 7  8 ... 15
+ *                |  0x34   |  0x12   |
+ *                 0010 1100 0100 1000
+ */
+typedef union {
+    uint16_t code;
+    struct action_kind {
+        uint16_t param  :12;
+        uint16_t id     :4;
+    } kind;
+    struct action_key {
+        uint16_t code   :8;
+        uint16_t mods   :4;
+        uint16_t kind   :4;
+    } key;
+    struct action_layer {
+        uint16_t code   :8;
+        uint16_t opt    :4;
+        uint16_t kind   :4;
+    } layer;
+    struct action_usage {
+        uint16_t code   :10;
+        uint16_t page   :2;
+        uint16_t kind   :4;
+    } usage;
+    struct action_command {
+        uint16_t id     :8;
+        uint16_t option :4;
+        uint16_t kind   :4;
+    } command;
+    struct action_function {
+        uint8_t  id     :8;
+        uint8_t  opt    :4;
+        uint8_t  kind   :4;
+    } func;
+} action_t;
+
+/* Action record. For internal use. */
+typedef struct {
+    keyevent_t  event;
+    uint8_t     tap_count;
+} keyrecord_t;
+
+
+/* Tap count: Tap is comprised of press and release within TAP_TERM.
+ * 0    means no tap.
+ * >1   means tap.
+ */
 extern uint8_t tap_count;
+
+/* current tap key event */
 extern keyevent_t tapping_event;
 
 
+/* action function */
+typedef void (*action_func_t)(keyevent_t event, uint8_t opt);
+
+// TODO: legacy keymap support
+void action_exec(keyevent_t event);
+void action_call_function(keyevent_t event, uint8_t id);
+
+
 /*
  * Utilities for actions.
  */
@@ -25,33 +94,36 @@ bool is_tap_key(key_t key);
 
 
 /*
-Action codes
-16bit code: action_kind(4bit) + action_parameter(12bit)
-
+ * Action codes
+ * ============
+ * 16bit code: action_kind(4bit) + action_parameter(12bit)
+ *
 Keyboard Keys
 -------------
 ACT_LMODS(0000):
 0000|0000|000000|00    No action
-0000|mods|000000|00    Left mods Momentary
-0000|mods|000000|01    Left mods OneShot
-0000|mods|000000|10    (reserved)
-0000|mods|000000|11    (reserved)
 0000|0000| keycode     Key
+0010|mods|000000|00    Left mods Momentary
 0000|mods| keycode     Key+Left mods
 
 ACT_RMODS(0001):
 0001|0000|000000|00    No action
+0001|0000| keycode     Key(no used)
 0001|mods|000000|00    Right mods Momentary
-0001|mods|000000|01    Right mods OneShot
-0001|mods|000000|10    (reserved)
-0001|mods|000000|11    (reserved)
-0001|0000| keycode     Key
 0001|mods| keycode     Key+Right mods
 
 ACT_LMODS_TAP(0010):
+0010|mods|000000|00    Left mods OneShot
+0010|mods|000000|01    (reserved)
+0010|mods|000000|10    (reserved)
+0010|mods|000000|11    (reserved)
 0010|mods| keycode     Left mods+tap Key
 
 ACT_RMODS_TAP(0011):
+0011|mods|000000|00    Right mods OneShot
+0011|mods|000000|01    (reserved)
+0011|mods|000000|10    (reserved)
+0011|mods|000000|11    (reserved)
 0011|mods| keycode     Right mods+tap Key
  
 
@@ -108,24 +180,22 @@ Extensions(11XX)
 NOTE: NOT FIXED
 
 ACT_MACRO(1100):
-1100|opt | id(8)      Macro play
-1100|1111| id(8)      Macro record
+1100|opt | id(8)      Macro play?
+1100|1111| id(8)      Macro record?
 
 ACT_COMMAND(1110):
 1110|opt | id(8)      Built-in Command exec
 
 ACT_FUNCTION(1111):
-1111| address(12)     Function
-1111|opt | id(8)      Function
-                                                    Macro record(dynamicly)
-                                                    Macro play(dynamicly)
-TODO: modifier + [tap key /w mod]
-    : layerkey + [tap key /w mod]
+1111| address(12)     Function?
+1111|opt | id(8)      Function?
+
+TODO: modifier + function by tap?
     for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
     http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
-*/
+ */
 
-enum action_id {
+enum action_kind_id {
     ACT_LMODS           = 0b0000,
     ACT_RMODS           = 0b0001,
     ACT_LMODS_TAP       = 0b0010,
@@ -144,74 +214,11 @@ enum action_id {
     ACT_FUNCTION        = 0b1111
 };
 
-// TODO: not portable across compiler/endianness?
-/*
-In avr-gcc bit fields seems to be assigned from LSB(bit0) to MSB(bit15). 
-AVR looks like a little endian in avr-gcc.
-
-Byte order and bit order of 0x1234:
-Big endian:     15 ...  8 7 ... 210
-               |  0x12   |  0x34   |
-                0001 0010 0011 0100
-Little endian:  012 ... 7  8 ... 15
-               |  0x34   |  0x12   |
-                0010 1100 0100 1000
-*/
-typedef union {
-    uint16_t code;
-    struct action_kind {
-        uint16_t param  :12;
-        uint16_t id     :4;
-    } kind;
-    struct action_key {
-        uint16_t code   :8;
-        uint16_t mods   :4;
-        uint16_t kind   :4;
-    } key;
-    struct action_layer {
-        uint16_t code   :8;
-        uint16_t opt    :4;
-        uint16_t kind   :4;
-    } layer;
-    struct action_usage {
-        uint16_t code   :10;
-        uint16_t page   :2;
-        uint16_t kind   :4;
-    } usage;
-    struct action_command {
-        uint16_t id     :8;
-        uint16_t option :4;
-        uint16_t kind   :4;
-    } command;
-    struct action_function {
-        uint8_t  id     :8;
-        uint8_t  opt    :4;
-        uint8_t  kind   :4;
-    } func;
-} action_t;
-
-
-enum stroke_cmd {
-    STROKE_DOWN,
-    STROKE_UP,
-    STROKE_ALLUP, /* release all keys in reverse order */
+enum acion_param {
+    ONE_SHOT            = 0x00,
 };
 
-typedef struct {
-    keyevent_t  event;
-    uint8_t     tap_count;
-} keyrecord_t;
-
-/* action function */
-typedef void (*action_func_t)(keyevent_t event, uint8_t opt);
 
-
-// TODO: legacy keymap support
-void action_exec(keyevent_t event);
-void action_call_function(keyevent_t event, uint8_t id);
-
-
-// TODO: proper names
 /* action_t utility */
 #define ACTION_NO                       0
 #define ACTION(kind, param)             ((kind)<<12 | (param))
@@ -221,16 +228,12 @@ void action_call_function(keyevent_t event, uint8_t id);
 #define ACTION_KEY(key)                 ACTION(ACT_LMODS,    key)
 #define ACTION_LMODS(mods)              ACTION(ACT_LMODS,    (mods)<<8 | 0x00)
 #define ACTION_LMODS_KEY(mods, key)     ACTION(ACT_LMODS,    (mods)<<8 | (key))
-#define ACTION_LMODS_ONESHOT(mods)      ACTION(ACT_LMODS,    (mods)<<8 | 0x01)
-#define ACTION_LMODS_SWITCH(mods, tap)  ACTION(ACT_LMODS,    (mods)<<8 | 0xF0 | (tap))
-#define ACTION_LMODS_TOGGLE(mods, tap)  ACTION(ACT_LMODS,    (mods)<<8 | 0xF1 | (tap))
 #define ACTION_RMODS(mods)              ACTION(ACT_RMODS,    (mods)<<8 | 0x00)
 #define ACTION_RMODS_KEY(mods, key)     ACTION(ACT_RMODS,    (mods)<<8 | (key))
-#define ACTION_RMODS_ONESHOT(mods)      ACTION(ACT_RMODS,    (mods)<<8 | 0x01)
-#define ACTION_RMODS_SWITCH(mods, tap)  ACTION(ACT_RMODS,    (mods)<<8 | 0xF0 | (tap))
-#define ACTION_RMODS_TOGGLE(mods, tap)  ACTION(ACT_RMODS,    (mods)<<8 | 0xF1 | (tap))
+
 /* Mods + Tap key */
 #define ACTION_LMODS_TAP(mods, key)     ACTION(ACT_LMODS_TAP, MOD_BITS(mods)<<8 | (key))
+#define ACTION_LMODS_ONESHOT(mods)      ACTION(ACT_LMODS_TAP, MOD_BITS(mods)<<8 | ONE_SHOT)
 #define ACTION_RMODS_TAP(mods, key)     ACTION(ACT_RMODS_TAP, MOD_BITS(mods)<<8 | (key))
 
 /* Layer Switch */
@@ -268,15 +271,4 @@ void action_call_function(keyevent_t event, uint8_t id);
 /* Function */
 #define ACTION_FUNCTION(id, opt)        ACTION(ACT_FUNCTION, (opt)<<8 | id)
 
-
-/* helpers for readability */
-#define LAYER(layer)    (layer)
-#define TAP(tap)        (tap)
-#define DOUBLE_TAP      2
-#define TRIPLE_TAP      3
-#define QUADRUPLE_TAP   4
-#define QUINTUPLE_TAP   5
-#define DOWN(key)       (key)
-#define UP(key)         STROKE_UP, (key)
-
 #endif  /* ACTION_H */