Merge branch 'add_build_options'

README.md

@@ -171,6 +171,7 @@ Note that ***comment out*** to disable them.
     MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
     EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
     CONSOLE_ENABLE = yes        # Console for debug(+400)
+    COMMAND_ENABLE = yes        # Commands for debug and configuration
     SLEEP_LED_ENABLE = yes      # Breathing sleep LED during USB suspend
     #NKRO_ENABLE = yes          # USB Nkey Rollover - not yet supported in LUFA
     #PS2_MOUSE_ENABLE = yes     # PS/2 mouse(TrackPoint) support

common.mk

@@ -2,10 +2,10 @@ COMMON_DIR = common
 SRC +=	$(COMMON_DIR)/host.c \
 	$(COMMON_DIR)/keyboard.c \
 	$(COMMON_DIR)/action.c \
+	$(COMMON_DIR)/action_oneshot.c \
 	$(COMMON_DIR)/action_macro.c \
 	$(COMMON_DIR)/layer_switch.c \
 	$(COMMON_DIR)/keymap.c \
-	$(COMMON_DIR)/command.c \
 	$(COMMON_DIR)/timer.c \
 	$(COMMON_DIR)/print.c \
 	$(COMMON_DIR)/debug.c \
@@ -31,6 +31,14 @@ endif
 
 ifdef CONSOLE_ENABLE
     OPT_DEFS += -DCONSOLE_ENABLE
+else
+    OPT_DEFS += -DNO_PRINT
+    OPT_DEFS += -DNO_DEBUG
+endif
+
+ifdef COMMAND_ENABLE
+    SRC += $(COMMON_DIR)/command.c
+    OPT_DEFS += -DCOMMAND_ENABLE
 endif
 
 ifdef NKRO_ENABLE

common/action.c

@@ -25,21 +25,17 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "debug.h"
 #include "led.h"
 #include "layer_switch.h"
+#include "action_oneshot.h"
 #include "action_macro.h"
 #include "action.h"
 
 
 static void process_action(keyrecord_t *record);
-static bool process_tapping(keyrecord_t *record);
-static void waiting_buffer_scan_tap(void);
-
 static void debug_event(keyevent_t event);
 static void debug_record(keyrecord_t record);
 static void debug_action(action_t action);
-static void debug_tapping_key(void);
-static void debug_waiting_buffer(void);
-
 
+#ifndef NO_ACTION_TAPPING
 /*
  * Tapping
  */
@@ -70,94 +66,22 @@ static keyrecord_t tapping_key = {};
  */
 #define WAITING_BUFFER_SIZE 8
 static keyrecord_t waiting_buffer[WAITING_BUFFER_SIZE] = {};
-
 /* point to empty cell to enq */
 static uint8_t waiting_buffer_head = 0;
-
 /* point to the oldest data cell to deq */
 static uint8_t waiting_buffer_tail = 0;
 
-static bool waiting_buffer_enq(keyrecord_t record)
-{
-    if (IS_NOEVENT(record.event)) {
-        return true;
-    }
-
-    if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) {
-        debug("waiting_buffer_enq: Over flow.\n");
-        return false;
-    }
-
-    waiting_buffer[waiting_buffer_head] = record;
-    waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE;
-
-    debug("waiting_buffer_enq: "); debug_waiting_buffer();
-    return true;
-}
-
-static void waiting_buffer_clear(void)
-{
-    waiting_buffer_head = 0;
-    waiting_buffer_tail = 0;
-}
 
+static bool process_tapping(keyrecord_t *record);
+static bool waiting_buffer_enq(keyrecord_t record);
+static void waiting_buffer_clear(void);
 #if TAPPING_TERM >= 500
-static bool waiting_buffer_typed(keyevent_t event)
+static bool waiting_buffer_typed(keyevent_t event);
-{
+#endif
-    for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
+static void waiting_buffer_scan_tap(void);
-        if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed !=  waiting_buffer[i].event.pressed) {
+static void debug_tapping_key(void);
-            return true;
+static void debug_waiting_buffer(void);
-        }
-    }
-    return false;
-}
 #endif
-
-bool waiting_buffer_has_anykey_pressed(void)
-{
-    for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
-        if (waiting_buffer[i].event.pressed) return true;
-    }
-    return false;
-}
-
-
-/* Oneshot modifier
- *
- * Problem: Want to capitalize like 'The' but the result tends to be 'THe'.
- * Solution: Oneshot modifier have its effect on only one key coming next.
- *           Tap Shift, then type 't', 'h' and 'e'. Not need to hold Shift key.
- *
- *  Hold:       works as normal modifier.
- *  Tap:        one shot modifier.
- *  2 Tap:      cancel one shot modifier.
- *  5-Tap:      toggles enable/disable oneshot feature.
- */
-static struct {
-    uint8_t mods;
-    uint8_t time;
-    bool    ready;
-    bool    disabled;
-}   oneshot_state;
-
-static void oneshot_start(uint8_t mods, uint16_t time)
-{
-    oneshot_state.mods = mods;
-    oneshot_state.time = time;
-    oneshot_state.ready = true;
-}
-
-static void oneshot_cancel(void)
-{
-    oneshot_state.mods = 0;
-    oneshot_state.time = 0;
-    oneshot_state.ready = false;
-}
-
-static void oneshot_toggle(void)
-{
-    oneshot_state.disabled = !oneshot_state.disabled;
-}
 
 
 
@@ -170,13 +94,12 @@ void action_exec(keyevent_t event)
 
     keyrecord_t record = { .event = event };
 
-    // pre-process on tapping
+#ifndef NO_ACTION_TAPPING
     if (process_tapping(&record)) {
         if (!IS_NOEVENT(record.event)) {
             debug("processed: "); debug_record(record); debug("\n");
         }
     } else {
-        // enqueue
         if (!waiting_buffer_enq(record)) {
             // clear all in case of overflow.
             debug("OVERFLOW: CLEAR ALL STATES\n");
@@ -190,7 +113,6 @@ void action_exec(keyevent_t event)
     if (!IS_NOEVENT(event) && waiting_buffer_head != waiting_buffer_tail) {
         debug("---- action_exec: process waiting_buffer -----\n");
     }
-
     for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
         if (process_tapping(&waiting_buffer[waiting_buffer_tail])) {
             debug("processed: waiting_buffer["); debug_dec(waiting_buffer_tail); debug("] = ");
@@ -202,6 +124,12 @@ void action_exec(keyevent_t event)
     if (!IS_NOEVENT(event)) {
         debug("\n");
     }
+#else
+    process_action(&record);
+    if (!IS_NOEVENT(record.event)) {
+        debug("processed: "); debug_record(record); debug("\n");
+    }
+#endif
 }
 
 static void process_action(keyrecord_t *record)
@@ -244,12 +172,14 @@ static void process_action(keyrecord_t *record)
                 }
             }
             break;
+#ifndef NO_ACTION_TAPPING
         case ACT_LMODS_TAP:
         case ACT_RMODS_TAP:
             {
                 uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ?  action.key.mods :
                                                                     action.key.mods<<4;
                 switch (action.layer.code) {
+    #ifndef NO_ACTION_ONESHOT
                     case 0x00:
                         // Oneshot modifier
                         if (event.pressed) {
@@ -259,7 +189,7 @@ static void process_action(keyrecord_t *record)
                             }
                             else if (tap_count == 1) {
                                 debug("MODS_TAP: Oneshot: start\n");
-                                oneshot_start(mods, event.time);
+                                oneshot_start(mods);
                             }
                             else if (tap_count == TAPPING_TOGGLE) {
                                 debug("MODS_TAP: Oneshot: toggle\n");
@@ -290,6 +220,7 @@ static void process_action(keyrecord_t *record)
                             }
                         }
                         break;
+    #endif
                     default:
                         if (event.pressed) {
                             if (tap_count > 0) {
@@ -319,10 +250,10 @@ static void process_action(keyrecord_t *record)
                 }
             }
             break;
-
+#endif
+#ifdef EXTRAKEY_ENABLE
         /* other HID usage */
         case ACT_USAGE:
-#ifdef EXTRAKEY_ENABLE
             switch (action.usage.page) {
                 case PAGE_SYSTEM:
                     if (event.pressed) {
@@ -339,12 +270,11 @@ static void process_action(keyrecord_t *record)
                     }
                     break;
             }
-#endif
             break;
-
+#endif
+#ifdef MOUSEKEY_ENABLE
         /* Mouse key */
         case ACT_MOUSEKEY:
-#ifdef MOUSEKEY_ENABLE
             if (event.pressed) {
                 mousekey_on(action.key.code);
                 mousekey_send();
@@ -352,9 +282,9 @@ static void process_action(keyrecord_t *record)
                 mousekey_off(action.key.code);
                 mousekey_send();
             }
-#endif
             break;
-
+#endif
+#ifndef NO_ACTION_KEYMAP
         case ACT_KEYMAP:
             switch (action.layer.code) {
                 /* Keymap clear */
@@ -516,7 +446,8 @@ static void process_action(keyrecord_t *record)
                     break;
             }
             break;
-
+#endif
+#ifndef NO_ACTION_OVERLAY
         case ACT_OVERLAY:
             switch (action.layer.code) {
                 // Overlay Invert bit4
@@ -670,21 +601,218 @@ static void process_action(keyrecord_t *record)
                     break;
             }
             break;
-
+#endif
         /* Extentions */
+#ifndef NO_ACTION_MACRO
         case ACT_MACRO:
             action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
             break;
+#endif
         case ACT_COMMAND:
             break;
+#ifndef NO_ACTION_FUNCTION
         case ACT_FUNCTION:
             action_function(record, action.func.id, action.func.opt);
             break;
+#endif
         default:
             break;
     }
 }
 
+
+
+
+/*
+ * Utilities for actions.
+ */
+void register_code(uint8_t code)
+{
+    if (code == KC_NO) {
+        return;
+    }
+#ifdef CAPSLOCK_LOCKING_ENABLE
+    else if (KC_LOCKING_CAPS == code) {
+#ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
+        // Resync: ignore if caps lock already is on
+        if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
+#endif
+        host_add_key(KC_CAPSLOCK);
+        host_send_keyboard_report();
+        host_del_key(KC_CAPSLOCK);
+        host_send_keyboard_report();
+    }
+#endif
+    else if IS_KEY(code) {
+        // TODO: should push command_proc out of this block?
+        if (command_proc(code)) return;
+
+#ifndef NO_ACTION_ONESHOT
+        if (oneshot_state.mods && !oneshot_state.disabled) {
+            uint8_t tmp_mods = host_get_mods();
+            host_add_mods(oneshot_state.mods);
+
+            host_add_key(code);
+            host_send_keyboard_report();
+
+            host_set_mods(tmp_mods);
+            oneshot_cancel();
+        } else 
+#endif
+        {
+            host_add_key(code);
+            host_send_keyboard_report();
+        }
+    }
+    else if IS_MOD(code) {
+        host_add_mods(MOD_BIT(code));
+        host_send_keyboard_report();
+    }
+}
+
+void unregister_code(uint8_t code)
+{
+    if (code == KC_NO) {
+        return;
+    }
+#ifdef CAPSLOCK_LOCKING_ENABLE
+    else if (KC_LOCKING_CAPS == code) {
+#ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
+        // Resync: ignore if caps lock already is off
+        if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
+#endif
+        host_add_key(KC_CAPSLOCK);
+        host_send_keyboard_report();
+        host_del_key(KC_CAPSLOCK);
+        host_send_keyboard_report();
+    }
+#endif
+    else if IS_KEY(code) {
+        host_del_key(code);
+        host_send_keyboard_report();
+    }
+    else if IS_MOD(code) {
+        host_del_mods(MOD_BIT(code));
+        host_send_keyboard_report();
+    }
+}
+
+void add_mods(uint8_t mods)
+{
+    if (mods) {
+        host_add_mods(mods);
+        host_send_keyboard_report();
+    }
+}
+
+void del_mods(uint8_t mods)
+{
+    if (mods) {
+        host_del_mods(mods);
+        host_send_keyboard_report();
+    }
+}
+
+void set_mods(uint8_t mods)
+{
+    host_set_mods(mods);
+    host_send_keyboard_report();
+}
+
+void clear_keyboard(void)
+{
+    host_clear_mods();
+    clear_keyboard_but_mods();
+}
+
+void clear_keyboard_but_mods(void)
+{
+    host_clear_keys();
+    host_send_keyboard_report();
+#ifdef MOUSEKEY_ENABLE
+    mousekey_clear();
+    mousekey_send();
+#endif
+#ifdef EXTRAKEY_ENABLE
+    host_system_send(0);
+    host_consumer_send(0);
+#endif
+}
+
+bool sending_anykey(void)
+{
+    return (host_has_anykey() || host_mouse_in_use() ||
+            host_last_sysytem_report() || host_last_consumer_report());
+}
+
+bool is_tap_key(key_t key)
+{
+    action_t action = layer_switch_get_action(key);
+
+    switch (action.kind.id) {
+        case ACT_LMODS_TAP:
+        case ACT_RMODS_TAP:
+            return true;
+        case ACT_KEYMAP:
+        case ACT_OVERLAY:
+            switch (action.layer.code) {
+                case 0x04 ... 0xEF:    /* tap key */
+                case OP_INV:
+                    return true;
+                default:
+                    return false;
+            }
+        case ACT_MACRO:
+        case ACT_FUNCTION:
+            if (action.func.opt & FUNC_TAP) { return true; }
+            return false;
+    }
+    return false;
+}
+
+
+/*
+ * debug print
+ */
+static void debug_event(keyevent_t event)
+{
+    debug_hex16((event.key.row<<8) | event.key.col);
+    if (event.pressed) debug("d("); else debug("u(");
+    debug_dec(event.time); debug(")");
+}
+
+static void debug_record(keyrecord_t record)
+{
+    debug_event(record.event); debug(":"); debug_dec(record.tap.count);
+    if (record.tap.interrupted) debug("-");
+}
+
+static void debug_action(action_t action)
+{
+    switch (action.kind.id) {
+        case ACT_LMODS:             debug("ACT_LMODS");             break;
+        case ACT_RMODS:             debug("ACT_RMODS");             break;
+        case ACT_LMODS_TAP:         debug("ACT_LMODS_TAP");         break;
+        case ACT_RMODS_TAP:         debug("ACT_RMODS_TAP");         break;
+        case ACT_USAGE:             debug("ACT_USAGE");             break;
+        case ACT_MOUSEKEY:          debug("ACT_MOUSEKEY");          break;
+        case ACT_KEYMAP:            debug("ACT_KEYMAP");            break;
+        case ACT_OVERLAY:           debug("ACT_OVERLAY");           break;
+        case ACT_MACRO:             debug("ACT_MACRO");             break;
+        case ACT_COMMAND:           debug("ACT_COMMAND");           break;
+        case ACT_FUNCTION:          debug("ACT_FUNCTION");          break;
+        default:                    debug("UNKNOWN");               break;
+    }
+    debug("[");
+    debug_hex4(action.kind.param>>8);
+    debug(":");
+    debug_hex8(action.kind.param & 0xff);
+    debug("]");
+}
+
+
+
+#ifndef NO_ACTION_TAPPING
 /* Tapping
  *
  * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
@@ -857,215 +985,85 @@ static bool process_tapping(keyrecord_t *keyp)
     }
 }
 
-/* scan buffer for tapping */
-static void waiting_buffer_scan_tap(void)
-{
-    // tapping already is settled
-    if (tapping_key.tap.count > 0) return;
-    // invalid state: tapping_key released && tap.count == 0
-    if (!tapping_key.event.pressed) return;
-
-    for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
-        if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
-                !waiting_buffer[i].event.pressed &&
-                WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
-            tapping_key.tap.count = 1;
-            waiting_buffer[i].tap.count = 1;
-            process_action(&tapping_key);
-
-            debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
-            debug_waiting_buffer();
-            return;
-        }
-    }
-}
-
-
 
 /*
- * Utilities for actions.
+ * Waiting buffer
  */
-void register_code(uint8_t code)
+static bool waiting_buffer_enq(keyrecord_t record)
 {
-    if (code == KC_NO) {
+    if (IS_NOEVENT(record.event)) {
-        return;
+        return true;
     }
-#ifdef CAPSLOCK_LOCKING_ENABLE
+
-    else if (KC_LOCKING_CAPS == code) {
+    if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) {
-#ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
+        debug("waiting_buffer_enq: Over flow.\n");
-        // Resync: ignore if caps lock already is on
+        return false;
-        if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
-#endif
-        host_add_key(KC_CAPSLOCK);
-        host_send_keyboard_report();
-        host_del_key(KC_CAPSLOCK);
-        host_send_keyboard_report();
     }
-#endif
-    else if IS_KEY(code) {
-        // TODO: should push command_proc out of this block?
-        if (command_proc(code)) return;
 
-        if (oneshot_state.mods && oneshot_state.ready && !oneshot_state.disabled) {
+    waiting_buffer[waiting_buffer_head] = record;
-            uint8_t tmp_mods = host_get_mods();
+    waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE;
-            host_add_mods(oneshot_state.mods);
-            host_add_key(code);
-            host_send_keyboard_report();
 
-            host_set_mods(tmp_mods);
+    debug("waiting_buffer_enq: "); debug_waiting_buffer();
-            oneshot_state.ready = false;
+    return true;
-        } else {
-            host_add_key(code);
-            host_send_keyboard_report();
-        }
-    }
-    else if IS_MOD(code) {
-        host_add_mods(MOD_BIT(code));
-        host_send_keyboard_report();
-    }
 }
 
-void unregister_code(uint8_t code)
+static void waiting_buffer_clear(void)
 {
-    if (code == KC_NO) {
+    waiting_buffer_head = 0;
-        return;
+    waiting_buffer_tail = 0;
-    }
-#ifdef CAPSLOCK_LOCKING_ENABLE
-    else if (KC_LOCKING_CAPS == code) {
-#ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
-        // Resync: ignore if caps lock already is off
-        if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
-#endif
-        host_add_key(KC_CAPSLOCK);
-        host_send_keyboard_report();
-        host_del_key(KC_CAPSLOCK);
-        host_send_keyboard_report();
-    }
-#endif
-    else if IS_KEY(code) {
-        host_del_key(code);
-        host_send_keyboard_report();
-    }
-    else if IS_MOD(code) {
-        host_del_mods(MOD_BIT(code));
-        host_send_keyboard_report();
-    }
 }
 
-void add_mods(uint8_t mods)
+#if TAPPING_TERM >= 500
+static bool waiting_buffer_typed(keyevent_t event)
 {
-    if (mods) {
+    for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
-        host_add_mods(mods);
+        if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed !=  waiting_buffer[i].event.pressed) {
-        host_send_keyboard_report();
+            return true;
+        }
     }
+    return false;
 }
+#endif
 
-void del_mods(uint8_t mods)
+bool waiting_buffer_has_anykey_pressed(void)
 {
-    if (mods) {
+    for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
-        host_del_mods(mods);
+        if (waiting_buffer[i].event.pressed) return true;
-        host_send_keyboard_report();
     }
+    return false;
 }
-
+/* scan buffer for tapping */
-void set_mods(uint8_t mods)
+static void waiting_buffer_scan_tap(void)
-{
-    host_set_mods(mods);
-    host_send_keyboard_report();
-}
-
-void clear_keyboard(void)
-{
-    host_clear_mods();
-    clear_keyboard_but_mods();
-}
-
-void clear_keyboard_but_mods(void)
-{
-    host_clear_keys();
-    host_send_keyboard_report();
-#ifdef MOUSEKEY_ENABLE
-    mousekey_clear();
-    mousekey_send();
-#endif
-#ifdef EXTRAKEY_ENABLE
-    host_system_send(0);
-    host_consumer_send(0);
-#endif
-}
-
-bool sending_anykey(void)
 {
-    return (host_has_anykey() || host_mouse_in_use() ||
+    // tapping already is settled
-            host_last_sysytem_report() || host_last_consumer_report());
+    if (tapping_key.tap.count > 0) return;
-}
+    // invalid state: tapping_key released && tap.count == 0
+    if (!tapping_key.event.pressed) return;
 
-bool is_tap_key(key_t key)
+    for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
-{
+        if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
-    action_t action = layer_switch_get_action(key);
+                !waiting_buffer[i].event.pressed &&
+                WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
+            tapping_key.tap.count = 1;
+            waiting_buffer[i].tap.count = 1;
+            process_action(&tapping_key);
 
-    switch (action.kind.id) {
+            debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
-        case ACT_LMODS_TAP:
+            debug_waiting_buffer();
-        case ACT_RMODS_TAP:
+            return;
-            return true;
+        }
-        case ACT_KEYMAP:
-        case ACT_OVERLAY:
-            switch (action.layer.code) {
-                case 0x04 ... 0xEF:    /* tap key */
-                case OP_INV:
-                    return true;
-                default:
-                    return false;
-            }
-        case ACT_MACRO:
-        case ACT_FUNCTION:
-            if (action.func.opt & FUNC_TAP) { return true; }
-            return false;
     }
-    return false;
 }
 
 
 /*
  * debug print
  */
-static void debug_event(keyevent_t event)
-{
-    debug_hex16((event.key.row<<8) | event.key.col);
-    if (event.pressed) debug("d("); else debug("u(");
-    debug_dec(event.time); debug(")");
-}
-static void debug_record(keyrecord_t record)
-{
-    debug_event(record.event); debug(":"); debug_dec(record.tap.count);
-    if (record.tap.interrupted) debug("-");
-}
-static void debug_action(action_t action)
-{
-    switch (action.kind.id) {
-        case ACT_LMODS:             debug("ACT_LMODS");             break;
-        case ACT_RMODS:             debug("ACT_RMODS");             break;
-        case ACT_LMODS_TAP:         debug("ACT_LMODS_TAP");         break;
-        case ACT_RMODS_TAP:         debug("ACT_RMODS_TAP");         break;
-        case ACT_USAGE:             debug("ACT_USAGE");             break;
-        case ACT_MOUSEKEY:          debug("ACT_MOUSEKEY");          break;
-        case ACT_KEYMAP:            debug("ACT_KEYMAP");            break;
-        case ACT_OVERLAY:           debug("ACT_OVERLAY");           break;
-        case ACT_MACRO:             debug("ACT_MACRO");             break;
-        case ACT_COMMAND:           debug("ACT_COMMAND");           break;
-        case ACT_FUNCTION:          debug("ACT_FUNCTION");          break;
-        default:                    debug("UNKNOWN");               break;
-    }
-    debug("[");
-    debug_hex4(action.kind.param>>8);
-    debug(":");
-    debug_hex8(action.kind.param & 0xff);
-    debug("]");
-}
 static void debug_tapping_key(void)
 {
     debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n");
 }
+
 static void debug_waiting_buffer(void)
 {
     debug("{ ");
@@ -1074,3 +1072,4 @@ static void debug_waiting_buffer(void)
     }
     debug("}\n");
 }
+#endif

common/action_macro.c

@@ -20,6 +20,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "action_macro.h"
 
 
+#ifndef NO_ACTION_MACRO
+
 #define MACRO_READ()  (macro = pgm_read_byte(macro_p++))
 void action_macro_play(const prog_macro_t *macro_p)
 {
@@ -64,3 +66,4 @@ void action_macro_play(const prog_macro_t *macro_p)
         { uint8_t ms = interval; while (ms--) _delay_ms(1); }
     }
 }
+#endif

common/action_macro.h

@@ -28,7 +28,11 @@ typedef uint8_t macro_t;
 typedef macro_t prog_macro_t PROGMEM;
 
 
+#ifndef NO_ACTION_MACRO
 void action_macro_play(const prog_macro_t *macro);
+#else
+#define action_macro_play(macro)
+#endif
 
 
 

common/action_oneshot.c

@@ -0,0 +1,21 @@
+#include "action_oneshot.h"
+
+
+#ifndef NO_ACTION_ONESHOT
+oneshot_state_t oneshot_state;
+
+void oneshot_start(uint8_t mods)
+{
+    oneshot_state.mods = mods;
+}
+
+void oneshot_cancel(void)
+{
+    oneshot_state.mods = 0;
+}
+
+void oneshot_toggle(void)
+{
+    oneshot_state.disabled = !oneshot_state.disabled;
+}
+#endif

common/action_oneshot.h

@@ -0,0 +1,52 @@
+/*
+Copyright 2013 Jun Wako <wakojun@gmail.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+#ifndef ACTION_ONESHOT_H
+#define ACTION_ONESHOT_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#ifdef NO_ACTION_TAPPING
+    #define NO_ACTION_ONESHOT
+#endif
+
+#ifndef NO_ACTION_ONESHOT
+/* Oneshot modifier
+ *
+ * Problem: Want to capitalize like 'The' but the result tends to be 'THe'.
+ * Solution: Oneshot modifier have its effect on only one key coming next.
+ *           Tap Shift, then type 't', 'h' and 'e'. Not need to hold Shift key.
+ *
+ *  Hold:       works as normal modifier.
+ *  Tap:        one shot modifier.
+ *  2 Tap:      cancel one shot modifier.
+ *  5-Tap:      toggles enable/disable oneshot feature.
+ */
+typedef struct {
+    uint8_t mods;
+    bool    disabled;
+}   oneshot_state_t;
+
+
+oneshot_state_t oneshot_state;
+
+void oneshot_start(uint8_t mods);
+void oneshot_cancel(void);
+void oneshot_toggle(void);
+#endif
+
+#endif

common/command.c

@@ -98,7 +98,6 @@ bool command_extra(uint8_t code)
  ***********************************************************/
 static void command_common_help(void)
 {
-    print_enable = true;
     print("\n\n----- Command Help -----\n");
     print("c:	enter console mode\n");
     print("d:	toggle debug enable\n");
@@ -137,7 +136,8 @@ static void print_eeprom_config(void)
     eebyte = eeconfig_read_keyconf();
     print("keyconf: "); print_hex8(eebyte); print("\n");
 
-    keyconf kc = (keyconf){ .raw = eebyte };
+    keyconf kc;
+    kc = (keyconf){ .raw = eebyte };
     print("keyconf.swap_control_capslock: "); print_hex8(kc.swap_control_capslock); print("\n");
     print("keyconf.capslock_to_control: "); print_hex8(kc.capslock_to_control); print("\n");
     print("keyconf.swap_lalt_lgui: "); print_hex8(kc.swap_lalt_lgui); print("\n");
@@ -173,7 +173,6 @@ static bool command_common(uint8_t code)
             command_common_help();
             break;
         case KC_C:
-            print_enable = true;
             debug_matrix   = false;
             debug_keyboard = false;
             debug_mouse    = false;
@@ -239,15 +238,6 @@ static bool command_common(uint8_t code)
         case KC_T: // print timer
             print_val_hex32(timer_count);
             break;
-        case KC_P: // print toggle
-            if (print_enable) {
-                print("print disabled.\n");
-                print_enable = false;
-            } else {
-                print_enable = true;
-                print("print enabled.\n");
-            }
-            break;
         case KC_S:
             print("\n\n----- Status -----\n");
             print_val_hex8(host_keyboard_leds());
@@ -320,7 +310,6 @@ static bool command_common(uint8_t code)
  ***********************************************************/
 static void command_console_help(void)
 {
-    print_enable = true;
     print("\n\n----- Console Help -----\n");
     print("ESC/q:	quit\n");
 #ifdef MOUSEKEY_ENABLE

common/command.h

@@ -18,8 +18,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef COMMAND_H
 #define COMMAND
 
+#ifdef COMMAND_ENABLE
 bool command_proc(uint8_t code);
 /* This allows to extend commands. Return 0 when command is not processed. */
 bool command_extra(uint8_t code);
+#else
+#define command_proc(code)      false
+#endif
 
 #endif

common/debug.h

@@ -22,6 +22,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "print.h"
 
 
+#ifndef NO_DEBUG
+
 #define debug(s)                  do { if (debug_enable) print(s); } while (0)
 #define debugln(s)                do { if (debug_enable) println(s); } while (0)
 #define debug_S(s)                do { if (debug_enable) print_S(s); } while (0)
@@ -31,9 +33,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
         print(__FILE__); print(" at "); print_dec(__LINE__); print(" in "); print(": "); print(s); \
     } \
 } while (0)
-
-    
-
 #define debug_dec(data)           do { if (debug_enable) print_dec(data); } while (0)
 #define debug_decs(data)          do { if (debug_enable) print_decs(data); } while (0)
 #define debug_hex4(data)          do { if (debug_enable) print_hex4(data); } while (0)
@@ -46,11 +45,35 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define debug_bin_reverse8(data)  do { if (debug_enable) print_bin_reverse8(data); } while (0)
 #define debug_bin_reverse16(data) do { if (debug_enable) print_bin_reverse16(data); } while (0)
 #define debug_bin_reverse32(data) do { if (debug_enable) print_bin_reverse32(data); } while (0)
-
 #define debug_hex(data)           debug_hex8(data)
 #define debug_bin(data)           debug_bin8(data)
 #define debug_bin_reverse(data)   debug_bin8(data)
 
+#else
+
+#define debug(s)
+#define debugln(s)
+#define debug_S(s)
+#define debug_P(s)
+#define debug_msg(s)
+#define debug_dec(data)
+#define debug_decs(data)
+#define debug_hex4(data)
+#define debug_hex8(data)
+#define debug_hex16(data)
+#define debug_hex32(data)
+#define debug_bin8(data)
+#define debug_bin16(data)
+#define debug_bin32(data)
+#define debug_bin_reverse8(data)
+#define debug_bin_reverse16(data)
+#define debug_bin_reverse32(data)
+#define debug_hex(data)
+#define debug_bin(data)
+#define debug_bin_reverse(data)
+
+#endif
+
 
 #ifdef __cplusplus
 extern "C" {

common/keyboard.c

@@ -54,7 +54,7 @@ static bool has_ghost_in_row(uint8_t row)
 void keyboard_init(void)
 {
     // TODO: configuration of sendchar impl
-    print_sendchar_func = sendchar;
+    print_set_sendchar(sendchar);
 
     timer_init();
     matrix_init();

common/layer_switch.c

@@ -24,6 +24,7 @@ void default_layer_set(uint8_t layer)
 }
 
 
+#ifndef NO_ACTION_KEYMAP
 /* 
  * Keymap Layer (0-15)
  */
@@ -95,9 +96,11 @@ void keymap_debug(void)
 {
     debug_hex16(keymap_stat); debug("("); debug_dec(keymap_get_layer()); debug(")");
 }
+#endif
 
 
 
+#ifndef NO_ACTION_OVERLAY
 /* 
  * Overlay Layer (16-31 = 0-15|0x10)
  */
@@ -169,12 +172,14 @@ void overlay_debug(void)
 {
     debug_hex16(overlay_stat); debug("("); debug_dec(overlay_get_layer()); debug(")");
 }
+#endif
 
 action_t layer_switch_get_action(key_t key)
 {
     action_t action;
     action.code = ACTION_TRANSPARENT;
 
+#ifndef NO_ACTION_OVERLAY
     /* overlay: top layer first */
     for (int8_t i = 15; i >= 0; i--) {
         if (overlay_stat & (1<<i)) {
@@ -184,7 +189,9 @@ action_t layer_switch_get_action(key_t key)
             }
         }
     }
+#endif
 
+#ifndef NO_ACTION_KEYMAP
     /* keymap: top layer first */
     for (int8_t i = 15; i >= 0; i--) {
         if (keymap_stat & (1<<i)) {
@@ -194,6 +201,7 @@ action_t layer_switch_get_action(key_t key)
             }
         }
     }
+#endif
 
     /* default layer */
     action = action_for_key(default_layer, key);

common/layer_switch.h

@@ -38,6 +38,7 @@ void default_layer_set(uint8_t layer);
 /*
  * Keymap Layer
  */
+#ifndef NO_ACTION_KEYMAP
 extern uint16_t keymap_stat;
 /* return current active layer */
 uint8_t keymap_get_layer(void);
@@ -52,11 +53,26 @@ void keymap_or(uint16_t stat);
 void keymap_and(uint16_t stat);
 void keymap_xor(uint16_t stat);
 void keymap_debug(void);
+#else
+#define keymap_stat             0
+#define keymap_get_layer()
+#define keymap_clear()
+#define keymap_set(stat)
+#define keymap_move(layer)
+#define keymap_on(layer)
+#define keymap_off(layer)
+#define keymap_invert(layer)
+#define keymap_or(stat)
+#define keymap_and(stat)
+#define keymap_xor(stat)
+#define keymap_debug()
+#endif
 
 
 /*
  * Overlay Layer
  */
+#ifndef NO_ACTION_OVERLAY
 extern uint16_t overlay_stat;
 /* return current active layer */
 uint8_t overlay_get_layer(void);
@@ -71,6 +87,20 @@ void overlay_or(uint16_t stat);
 void overlay_and(uint16_t stat);
 void overlay_xor(uint16_t stat);
 void overlay_debug(void);
+#else
+#define overlay_stat            0
+#define overlay_get_layer()
+#define overlay_clear()
+#define overlay_set(stat)
+#define overlay_move(layer)
+#define overlay_on(layer)
+#define overlay_off(layer)
+#define overlay_invert(layer)
+#define overlay_or(stat)
+#define overlay_and(stat)
+#define overlay_xor(stat)
+#define overlay_debug()
+#endif
 
 
 

common/print.c

@@ -27,12 +27,17 @@
 #include "print.h"
 
 
-#define sendchar(c)    do { if (print_enable && print_sendchar_func) (print_sendchar_func)(c); } while (0)
+#ifndef NO_PRINT
 
+#define sendchar(c)    do { if (print_sendchar_func) (print_sendchar_func)(c); } while (0)
 
-int8_t (*print_sendchar_func)(uint8_t) = 0;
-bool print_enable = true;
 
+static int8_t (*print_sendchar_func)(uint8_t) = 0;
+
+void print_set_sendchar(int8_t (*sendchar_func)(uint8_t))
+{
+    print_sendchar_func = sendchar_func;
+}
 
 /* print string stored in data memory(SRAM)
  *     print_P("hello world");
@@ -184,3 +189,5 @@ void print_bin_reverse32(uint32_t data)
     print_bin_reverse8(data>>16);
     print_bin_reverse8(data>>24);
 }
+
+#endif

common/print.h

@@ -30,13 +30,12 @@
 #include <avr/pgmspace.h>
 
 
-// avoid collision with arduino/Print.h
-#ifndef __cplusplus
 // this macro allows you to write print("some text") and
 // the string is automatically placed into flash memory :)
+// TODO: avoid collision with arduino/Print.h
+#ifndef __cplusplus
 #define print(s)                print_P(PSTR(s))
 #endif
-
 #define println(s)              print_P(PSTR(s "\n"))
 
 /* for old name */
@@ -49,15 +48,12 @@
 #define pbin_reverse(data)      print_bin_reverse8(data)
 #define pbin_reverse16(data)    print_bin_reverse16(data)
 
-
 /* print value utility */
-#define print_val_dec(v)          do { print_P(PSTR(#v ": ")); print_dec(v);  print_P(PSTR("\n")); } while (0)
+#define print_val_dec(v)           do { print_P(PSTR(#v ": ")); print_dec(v);  print_P(PSTR("\n")); } while (0)
 #define print_val_decs(v)          do { print_P(PSTR(#v ": ")); print_decs(v);  print_P(PSTR("\n")); } while (0)
-
 #define print_val_hex8(v)          do { print_P(PSTR(#v ": ")); print_hex8(v);  print_P(PSTR("\n")); } while (0)
 #define print_val_hex16(v)         do { print_P(PSTR(#v ": ")); print_hex16(v); print_P(PSTR("\n")); } while (0)
 #define print_val_hex32(v)         do { print_P(PSTR(#v ": ")); print_hex32(v); print_P(PSTR("\n")); } while (0)
-
 #define print_val_bin8(v)          do { print_P(PSTR(#v ": ")); print_bin8(v);  print_P(PSTR("\n")); } while (0)
 #define print_val_bin16(v)         do { print_P(PSTR(#v ": ")); print_bin16(v); print_P(PSTR("\n")); } while (0)
 #define print_val_bin32(v)         do { print_P(PSTR(#v ": ")); print_bin32(v); print_P(PSTR("\n")); } while (0)
@@ -67,13 +63,13 @@
 
 
 
+#ifndef NO_PRINT
+
 #ifdef __cplusplus
 extern "C" {
 #endif
-
 /* function pointer of sendchar to be used by print utility */
-extern int8_t (*print_sendchar_func)(uint8_t);
+void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
-extern bool print_enable;
 
 /* print string stored in data memory(SRAM) */
 void print_S(const char *s);
@@ -100,9 +96,31 @@ void print_bin32(uint32_t data);
 void print_bin_reverse8(uint8_t data);
 void print_bin_reverse16(uint16_t data);
 void print_bin_reverse32(uint32_t data);
-
 #ifdef __cplusplus
 }
 #endif
 
+#else
+
+#define print_set_sendchar(func)
+#define print_S(s)
+#define print_P(s)
+#define print_CRLF()
+#define print_dec(data)
+#define print_decs(data)
+#define print_hex4(data)
+#define print_hex8(data)
+#define print_hex16(data)
+#define print_hex32(data)
+#define print_bin4(data)
+#define print_bin8(data)
+#define print_bin16(data)
+#define print_bin32(data)
+#define print_bin_reverse8(data)
+#define print_bin_reverse16(data)
+#define print_bin_reverse32(data)
+
+#endif
+
+
 #endif

keyboard/gh60/Makefile.lufa

@@ -103,13 +103,14 @@ BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration(+1000)
 MOUSEKEY_ENABLE = yes	# Mouse keys(+4700)
 EXTRAKEY_ENABLE = yes	# Audio control and System control(+450)
 CONSOLE_ENABLE = yes	# Console for debug(+400)
+COMMAND_ENABLE = yes    # Commands for debug and configuration
 SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
 #NKRO_ENABLE = yes	# USB Nkey Rollover - not yet supported in LUFA
 #PS2_MOUSE_ENABLE = yes	# PS/2 mouse(TrackPoint) support
 
 
 # Optimize size but this may cause error "relocation truncated to fit"
-EXTRALDFLAGS = -Wl,--relax
+#EXTRALDFLAGS = -Wl,--relax
 
 # Search Path
 VPATH += $(TARGET_DIR)

keyboard/gh60/Makefile.pjrc

@@ -80,8 +80,9 @@ OPT_DEFS += -DBOOT_SIZE=4096
 BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration(+1000)
 MOUSEKEY_ENABLE = yes	# Mouse keys(+5000)
 EXTRAKEY_ENABLE = yes	# Audio control and System control(+600)
-NKRO_ENABLE = yes	# USB Nkey Rollover(+500)
 CONSOLE_ENABLE = yes    # Console for debug
+COMMAND_ENABLE = yes    # Commands for debug and configuration
+NKRO_ENABLE = yes	# USB Nkey Rollover(+500)
 #PS2_MOUSE_ENABLE = yes	# PS/2 mouse(TrackPoint) support
 
 

keyboard/gh60/config.h

@@ -57,4 +57,24 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define BOOTLOADER_SIZE 4096
 
 
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_KEYMAP
+//#define NO_ACTION_OVERLAY
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
+
 #endif

keyboard/hhkb/Makefile.iwrap

@@ -44,8 +44,11 @@ F_CPU = 12000000
 # Build Options
 #   comment out to disable the options.
 #
+BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration
 MOUSEKEY_ENABLE = yes	# Mouse keys
 EXTRAKEY_ENABLE = yes	# Audio control and System control
+CONSOLE_ENABLE = yes	# Console for debug
+COMMAND_ENABLE = yes    # Commands for debug and configuration
 #NKRO_ENABLE = yes	# USB Nkey Rollover
 
 
@@ -83,7 +86,7 @@ PROGRAM_CMD = $(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) $(AVRDUDE_WRITE
 
 
 # Search Path
-VPATH = $(TARGET_DIR)
+VPATH += $(TARGET_DIR)
 VPATH += $(TOP_DIR)
 
 #include $(TOP_DIR)/protocol/iwrap.mk

keyboard/hhkb/Makefile.lufa

@@ -104,6 +104,7 @@ BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration
 MOUSEKEY_ENABLE = yes	# Mouse keys
 EXTRAKEY_ENABLE = yes	# Audio control and System control
 CONSOLE_ENABLE = yes	# Console for debug
+COMMAND_ENABLE = yes    # Commands for debug and configuration
 #NKRO_ENABLE = yes	# USB Nkey Rollover
 
 

keyboard/hhkb/Makefile.pjrc

@@ -38,9 +38,12 @@ F_CPU = 16000000
 
 # Build Options
 #   comment out to disable the options.
+#
+BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration
 MOUSEKEY_ENABLE = yes	# Mouse keys
-#PS2_MOUSE_ENABLE = yes	# PS/2 mouse(TrackPoint) support
 EXTRAKEY_ENABLE = yes	# Audio control and System control
+CONSOLE_ENABLE = yes	# Console for debug
+COMMAND_ENABLE = yes    # Commands for debug and configuration
 NKRO_ENABLE = yes	# USB Nkey Rollover
 
 
@@ -51,8 +54,8 @@ PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
 
 
 # Search Path
-VPATH = $(TARGET_DIR)
+VPATH += $(TARGET_DIR)
-VPATH = $(TOP_DIR)
+VPATH += $(TOP_DIR)
 
 include $(TOP_DIR)/protocol/pjrc.mk
 include $(TOP_DIR)/common.mk

keyboard/hhkb/Makefile.vusb

@@ -44,8 +44,11 @@ F_CPU = 12000000
 # Build Options
 #   comment out to disable the options.
 #
+BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration
 MOUSEKEY_ENABLE = yes	# Mouse keys
 EXTRAKEY_ENABLE = yes	# Audio control and System control
+CONSOLE_ENABLE = yes	# Console for debug
+COMMAND_ENABLE = yes    # Commands for debug and configuration
 #NKRO_ENABLE = yes	# USB Nkey Rollover
 
 
@@ -83,7 +86,7 @@ PROGRAM_CMD = $(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) $(AVRDUDE_WRITE
 
 
 # Search Path
-VPATH  = $(TARGET_DIR)
+VPATH += $(TARGET_DIR)
 VPATH += $(TOP_DIR)
 
 include $(TOP_DIR)/protocol/vusb.mk

keyboard/hhkb/config.h

@@ -71,18 +71,24 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /* tap count needed for toggling a feature */
 #define TAPPING_TOGGLE  5
 
-/* PS/2 mouse */
+
-#ifdef PS2_MOUSE_ENABLE
 /*
-#   define PS2_CLOCK_PORT  PORTF
+ * Feature disable options
-#   define PS2_CLOCK_PIN   PINF
+ *  These options are also useful to firmware size reduction.
-#   define PS2_CLOCK_DDR   DDRF
+ */
-#   define PS2_CLOCK_BIT   0
+
-#   define PS2_DATA_PORT   PORTF
+/* disable debug print */
-#   define PS2_DATA_PIN    PINF
+//#define NO_DEBUG
-#   define PS2_DATA_DDR    DDRF
+
-#   define PS2_DATA_BIT    1
+/* disable print */
-*/
+//#define NO_PRINT
-#endif
+
+/* disable action features */
+//#define NO_ACTION_KEYMAP
+//#define NO_ACTION_OVERLAY
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
 
 #endif