refactor(behaviors): Convert state dependent params.

* Allow each behavior to map a relative binding, e.g. "toggle",
  to an absolute one, e.g. "on", before being invoked.

1 files changed, 25 insertions, 0 deletions

diff --git a/app/include/drivers/behavior.h b/app/include/drivers/behavior.h
index bc135fd..2bdffea 100644
--- a/app/include/drivers/behavior.h
+++ b/app/include/drivers/behavior.h
@@ -27,6 +27,7 @@ typedef int (*behavior_sensor_keymap_binding_callback_t)(struct zmk_behavior_bin
                                                          int64_t timestamp);
 
 __subsystem struct behavior_driver_api {
+    behavior_keymap_binding_callback_t binding_convert_central_state_dependent_params;
     behavior_keymap_binding_callback_t binding_pressed;
     behavior_keymap_binding_callback_t binding_released;
     behavior_sensor_keymap_binding_callback_t sensor_binding_triggered;
@@ -36,6 +37,30 @@ __subsystem struct behavior_driver_api {
  */
 
 /**
+ * @brief Handle the keymap binding which needs to be converted from relative "toggle" to absolute
+ * "turn on"
+ * @param binding Pointer to the details so of the binding
+ * @param event The event that triggered use of the binding
+ *
+ * @retval 0 If successful.
+ * @retval Negative errno code if failure.
+ */
+__syscall int behavior_keymap_binding_convert_central_state_dependent_params(
+    struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event);
+
+static inline int z_impl_behavior_keymap_binding_convert_central_state_dependent_params(
+    struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event) {
+    const struct device *dev = device_get_binding(binding->behavior_dev);
+    const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->api;
+
+    if (api->binding_convert_central_state_dependent_params == NULL) {
+        return 0;
+    }
+
+    return api->binding_convert_central_state_dependent_params(binding, event);
+}
+
+/**
  * @brief Handle the keymap binding being pressed
  * @param dev Pointer to the device structure for the driver instance.
  * @param param1 User parameter specified at time of behavior binding.