hook: Change file and func names(*_hook -> hook_*)

tmk · tmk · commit 3e97536a3412 · 2016-04-17T15:56:07.000+09:00
diff --git a/common.mk b/common.mk
@@ -10,7 +10,7 @@ SRC +=	$(COMMON_DIR)/host.c \
 	$(COMMON_DIR)/print.c \
 	$(COMMON_DIR)/debug.c \
 	$(COMMON_DIR)/util.c \
-	$(COMMON_DIR)/hooks.c \
+	$(COMMON_DIR)/hook.c \
 	$(COMMON_DIR)/avr/suspend.c \
 	$(COMMON_DIR)/avr/xprintf.S \
 	$(COMMON_DIR)/avr/timer.c \
diff --git a/common/action.c b/common/action.c
@@ -26,7 +26,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "action_macro.h"
 #include "action_util.h"
 #include "action.h"
-#include "hooks.h"
+#include "hook.h"
 
 #ifdef DEBUG_ACTION
 #include "debug.h"
@@ -40,7 +40,7 @@ void action_exec(keyevent_t event)
     if (!IS_NOEVENT(event)) {
         dprint("\n---- action_exec: start -----\n");
         dprint("EVENT: "); debug_event(event); dprintln();
-        matrix_change_hook(event);
+        hook_matrix_change(event);
     }
 
     keyrecord_t record = { .event = event };
diff --git a/common/action_layer.c b/common/action_layer.c
@@ -3,7 +3,7 @@
 #include "action.h"
 #include "util.h"
 #include "action_layer.h"
-#include "hooks.h"
+#include "hook.h"
 
 #ifdef DEBUG_ACTION
 #include "debug.h"
@@ -63,7 +63,7 @@ static void layer_state_set(uint32_t state)
     dprint("layer_state: ");
     layer_debug(); dprint(" to ");
     layer_state = state;
-    layer_change_hook(layer_state);
+    hook_layer_change(layer_state);
     layer_debug(); dprintln();
     clear_keyboard_but_mods(); // To avoid stuck keys
 }
diff --git a/common/bootmagic.c b/common/bootmagic.c
@@ -9,7 +9,7 @@
 #include "action_layer.h"
 #include "eeconfig.h"
 #include "bootmagic.h"
-#include "hooks.h"
+#include "hook.h"
 
 keymap_config_t keymap_config;
 
@@ -42,7 +42,7 @@ void bootmagic(void)
     }
 
     /* user-defined checks */
-    bootmagic_hook();
+    hook_bootmagic();
 
     /* debug enable */
     debug_config.raw = eeconfig_read_debug();
diff --git a/common/hook.c b/common/hook.c
@@ -16,7 +16,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "keyboard.h"
-#include "hooks.h"
+#include "hook.h"
 
 /* -------------------------------------------------
  * Definitions of hardware-independent default hooks
@@ -25,33 +25,33 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /* Called on layer state change event. */
 /* Default behaviour: do nothing. */
 __attribute__((weak))
-void layer_change_hook(uint8_t layer_state) {
+void hook_layer_change(uint8_t layer_state) {
     (void)layer_state;
 }
 
 /* Called periodically from the matrix scan loop (very often!) */
 /* Default behaviour: do nothing. */
 __attribute__((weak))
-void scan_loop_hook(void) {}
+void hook_keyboard_loop(void) {}
 
 /* Called on matrix state change event (every keypress => often!) */
 /* Default behaviour: do nothing. */
 __attribute__((weak))
-void matrix_change_hook(keyevent_t event) {
+void hook_matrix_change(keyevent_t event) {
 	(void)event;
 }
 
 /* Called on indicator LED update event (when reported from host). */
 /* Default behaviour: calls led_set (for compatibility). */
 __attribute__((weak))
-void led_update_hook(uint8_t led_status) {
+void hook_keyboard_leds_change(uint8_t led_status) {
     keyboard_set_leds(led_status);
 }
 
 /* Called once, on checking the bootmagic combos. */
 /* Default behaviour: do nothing. */
 __attribute__((weak))
-void bootmagic_hook(void) {
+void hook_bootmagic(void) {
 	/* An example: */
 	// #include "bootmagic.h"
 	// #include "keymap.h"
diff --git a/common/hook.h b/common/hook.h
@@ -27,58 +27,48 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 /* Called once, before initialising USB. */
 /* Default behaviour: do nothing. */
-void early_init_hook(void);
+void hook_early_init(void);
 
 /* Called once, after USB is connected and keyboard initialised. */
 /* Default behaviour: do nothing. */
-void late_init_hook(void);
+void hook_late_init(void);
 
 /* Called once, on getting SUSPEND event from USB. */
 /* Default behaviour: enables sleep LED breathing. */
-void suspend_entry_hook(void);
+void hook_suspend_entry(void);
 
 /* Called repeatedly during the SUSPENDed state. */
 /* Default behaviour: power down and periodically check
  * the matrix, cause wakeup if needed. */
-void suspend_loop_hook(void);
+void hook_suspend_loop(void);
 
 /* Called once, on getting WAKE event from USB. */
 /* Default behaviour: disables sleep LED breathing and restores 
  * the "normal" indicator LED status by default. */
-void wakeup_hook(void);
+void hook_wakeup(void);
 
 /* Called once, on checking the bootmagic combos. */
 /* Default behaviour: do nothing. */
-void bootmagic_hook(void);
+void hook_bootmagic(void);
 
 /* -------------------------------------
  *       Keyboard / periodic hooks
  * ------------------------------------- */
 
-/* Called periodically from the matrix scan loop (very often!) */
+/* Called periodically from the keyboard loop (very often!) */
 /* Default behaviour: do nothing. */
-void scan_loop_hook(void);
+void hook_keyboard_loop(void);
 
 /* Called on matrix state change event (every keypress => often!) */
 /* Default behaviour: do nothing. */
-void matrix_change_hook(keyevent_t event);
+void hook_matrix_change(keyevent_t event);
 
 /* Called on layer state change event. */
 /* Default behaviour: do nothing. */
-void layer_change_hook(uint8_t layer_state);
-
-/* Called on tap event. */
-/* Default behaviour: do nothing. */
-// void tap_event_hook(void);
-/* TODO */
-
-/* Called on hold event. */
-/* Default behaviour: do nothing. */
-// void hold_event_hook(void);
-/* TODO */
+void hook_layer_change(uint8_t layer_state);
 
 /* Called on indicator LED update event (when reported from host). */
-/* Default behaviour: calls led_set (for compatibility). */
-void led_update_hook(uint8_t led_status);
+/* Default behaviour: calls keyboard_set_leds (for compatibility). */
+void hook_keyboard_leds_change(uint8_t led_status);
 
 #endif /* _HOOKS_H_ */
diff --git a/common/keyboard.c b/common/keyboard.c
@@ -30,7 +30,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "bootmagic.h"
 #include "eeconfig.h"
 #include "backlight.h"
-#include "hooks.h"
+#include "hook.h"
 #ifdef MOUSEKEY_ENABLE
 #   include "mousekey.h"
 #endif
@@ -129,11 +129,13 @@ void keyboard_task(void)
             if (debug_matrix) matrix_print();
             for (uint8_t c = 0; c < MATRIX_COLS; c++) {
                 if (matrix_change & ((matrix_row_t)1<<c)) {
-                    action_exec((keyevent_t){
+                    keyevent_t e = (keyevent_t){
                         .key = (keypos_t){ .row = r, .col = c },
                         .pressed = (matrix_row & ((matrix_row_t)1<<c)),
                         .time = (timer_read() | 1) /* time should not be 0 */
-                    });
+                    };
+                    action_exec(e);
+                    hook_matrix_change(e);
                     // record a processed key
                     matrix_prev[r] ^= ((matrix_row_t)1<<c);
                     // process a key per task call
@@ -147,7 +149,7 @@ void keyboard_task(void)
 
 MATRIX_LOOP_END:
 
-    scan_loop_hook();
+    hook_keyboard_loop();
 
 #ifdef MOUSEKEY_ENABLE
     // mousekey repeat & acceleration
@@ -170,7 +172,7 @@ void keyboard_task(void)
     if (led_status != host_keyboard_leds()) {
         led_status = host_keyboard_leds();
         if (debug_keyboard) dprintf("LED: %02X\n", led_status);
-        led_update_hook(led_status);
+        hook_keyboard_leds_change(led_status);
     }
 }
 
diff --git a/protocol/chibios/main.c b/protocol/chibios/main.c
@@ -35,7 +35,7 @@
 #include "sleep_led.h"
 #endif
 #include "suspend.h"
-#include "hooks.h"
+#include "hook.h"
 
 
 /* -------------------------
@@ -61,13 +61,13 @@ host_driver_t chibios_driver = {
 
 /* Default hooks definitions. */
 __attribute__((weak))
-void early_init_hook(void) {}
+void hook_early_init(void) {}
 
 __attribute__((weak))
-void late_init_hook(void) {}
+void hook_late_init(void) {}
 
 __attribute__((weak))
-void suspend_loop_hook(void) {
+void hook_suspend_loop(void) {
   /* Do this in the suspended state */
   suspend_power_down(); // on AVR this deep sleeps for 15ms
   /* Remote wakeup */
@@ -108,7 +108,7 @@ int main(void) {
   // TESTING
   // chThdCreateStatic(waBlinkerThread, sizeof(waBlinkerThread), NORMALPRIO, blinkerThread, NULL);
 
-  early_init_hook();
+  hook_early_init();
 
   /* Init USB */
   init_usb_driver(&USB_DRIVER);
@@ -139,15 +139,15 @@ int main(void) {
 
   print("Keyboard start.\n");
 
-  late_init_hook();
+  hook_late_init();
 
   /* Main loop */
   while(true) {
 
     if(USB_DRIVER.state == USB_SUSPENDED) {
       print("[s]");
       while(USB_DRIVER.state == USB_SUSPENDED) {
-        suspend_loop_hook();
+        hook_suspend_loop();
       }
       /* Woken up */
       // variables have been already cleared
diff --git a/protocol/chibios/usb_main.c b/protocol/chibios/usb_main.c
@@ -27,11 +27,11 @@
 #include "sleep_led.h"
 #include "led.h"
 #endif
-#include "hooks.h"
+#include "hook.h"
 
 /* TMK hooks */
 __attribute__((weak))
-void wakeup_hook(void) {
+void hook_wakeup(void) {
 #ifdef SLEEP_LED_ENABLE
     sleep_led_disable();
     // NOTE: converters may not accept this
@@ -40,7 +40,7 @@ void wakeup_hook(void) {
 }
 
  __attribute__((weak))
-void suspend_entry_hook(void) {
+void hook_suspend_entry(void) {
 #ifdef SLEEP_LED_ENABLE
     sleep_led_enable();
 #endif /* SLEEP_LED_ENABLE */
@@ -814,13 +814,13 @@ static void usb_event_cb(USBDriver *usbp, usbevent_t event) {
 
   case USB_EVENT_SUSPEND:
     //TODO: from ISR! print("[S]");
-    suspend_entry_hook();
+    hook_suspend_entry();
     return;
 
   case USB_EVENT_WAKEUP:
     //TODO: from ISR! print("[W]");
     suspend_wakeup_init();
-    wakeup_hook();
+    hook_wakeup();
     return;
 
   case USB_EVENT_STALLED:
diff --git a/protocol/lufa/lufa.c b/protocol/lufa/lufa.c
@@ -48,7 +48,7 @@
 #include "sleep_led.h"
 #endif
 #include "suspend.h"
-#include "hooks.h"
+#include "hook.h"
 
 #include "descriptor.h"
 #include "lufa.h"
@@ -181,13 +181,13 @@ void EVENT_USB_Device_Reset(void)
 void EVENT_USB_Device_Suspend()
 {
     print("[S]");
-    suspend_entry_hook();
+    hook_suspend_entry();
 }
 
 void EVENT_USB_Device_WakeUp()
 {
     print("[W]");
-    wakeup_hook();
+    hook_wakeup();
 }
 
 #ifdef CONSOLE_ENABLE
@@ -586,7 +586,7 @@ int main(void)
 {
     setup_mcu();
     keyboard_setup();
-    early_init_hook();
+    hook_early_init();
     setup_usb();
     sei();
 
@@ -608,11 +608,11 @@ int main(void)
 #endif
 
     print("Keyboard start.\n");
-    late_init_hook();
+    hook_late_init();
     while (1) {
         while (USB_DeviceState == DEVICE_STATE_Suspended) {
             print("[s]");
-            suspend_loop_hook();
+            hook_suspend_loop();
         }
 
         keyboard_task();
@@ -626,21 +626,21 @@ int main(void)
 
 /* hooks */
 __attribute__((weak))
-void early_init_hook(void) {}
+void hook_early_init(void) {}
 
 __attribute__((weak))
-void late_init_hook(void) {}
+void hook_late_init(void) {}
 
  __attribute__((weak))
-void suspend_entry_hook(void)
+void hook_suspend_entry(void)
 {
 #ifdef SLEEP_LED_ENABLE
     sleep_led_enable();
 #endif
 }
 
 __attribute__((weak))
-void suspend_loop_hook(void)
+void hook_suspend_loop(void)
 {
     suspend_power_down();
     if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) {
@@ -649,7 +649,7 @@ void suspend_loop_hook(void)
 }
 
 __attribute__((weak))
-void wakeup_hook(void)
+void hook_wakeup(void)
 {
     suspend_wakeup_init();
 #ifdef SLEEP_LED_ENABLE
