From b0b2e5e53321b4b3db23fb208d0e53814621f19a Mon Sep 17 00:00:00 2001 From: Void Your Warranty Date: Tue, 28 Nov 2023 15:48:33 +0100 Subject: [PATCH] Multiple antecedent morph compiles. --- .../zmk,behavior-antecedent-morph.yaml | 4 + app/src/behaviors/behavior_antecedent_morph.c | 160 ++++++++++++------ 2 files changed, 108 insertions(+), 56 deletions(-) diff --git a/app/dts/bindings/behaviors/zmk,behavior-antecedent-morph.yaml b/app/dts/bindings/behaviors/zmk,behavior-antecedent-morph.yaml index cf156463..2e61b1af 100644 --- a/app/dts/bindings/behaviors/zmk,behavior-antecedent-morph.yaml +++ b/app/dts/bindings/behaviors/zmk,behavior-antecedent-morph.yaml @@ -8,6 +8,10 @@ compatible: "zmk,behavior-antecedent-morph" include: zero_param.yaml properties: + defaults: + type: phandle-array + required: true + specifier-space: binding bindings: type: phandle-array required: true diff --git a/app/src/behaviors/behavior_antecedent_morph.c b/app/src/behaviors/behavior_antecedent_morph.c index b78c04fc..9e84e023 100644 --- a/app/src/behaviors/behavior_antecedent_morph.c +++ b/app/src/behaviors/behavior_antecedent_morph.c @@ -11,6 +11,7 @@ #include #include +#include #include #include #include @@ -19,22 +20,24 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); #if DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT) -// Configuration struct per instance +// configuration struct per instance struct behavior_antecedent_morph_config { - int serial; - int max_delay_ms; - struct zmk_behavior_binding normal_binding; - struct zmk_behavior_binding morph_binding; - int32_t antecedents_len; - int32_t antecedents[]; + int serial; // serial number of the instance of this behavior + uint32_t max_delay_ms; // maximum delay between key release and successive key press for the adaptive behavior + size_t defaults_len; // length of the array of default behaviors (must be 1) + struct zmk_behavior_binding *defaults; // array of default behaviors + size_t bindings_len; // length of the array of morphed behaviors + struct zmk_behavior_binding *bindings; // array of morphed behaviors + int32_t antecedents_len; // length of the array of antecedents (key codes) + int32_t antecedents[]; // array of antecedents (key codes) }; -// Data struct per instance +// data struct per instance struct behavior_antecedent_morph_data { - struct zmk_behavior_binding *pressed_binding; + struct zmk_behavior_binding *pressed_binding; // the actual behavior that was pressed by the adaptive behavior }; -// Data shared by all instances +// data shared by all instances static int32_t code_pressed; // most recently pressed key code (with implicit mods, usage page and keycode) static int64_t time_pressed; // time stamp in milli-seconds of that key press @@ -43,22 +46,31 @@ static int antecedent_morph_keycode_state_changed_listener(const zmk_event_t *eh ZMK_LISTENER(behavior_antecedent_morph, antecedent_morph_keycode_state_changed_listener); ZMK_SUBSCRIPTION(behavior_antecedent_morph,zmk_keycode_state_changed); -// Capture all key press and release events in order to record the most recently pressed key code. -// Note that the event structure gives us the keycode (16 bit), the usage page (8 bit) and the implicit modifiers (8 bit), -// but not the explicit modifiers. If the keymap contains the binding "&kp RA(Y)", for example, then right-alt is an -// implicit modifier so that instead of the Y, the special character Ü is sent (US International layout). -// Whether the user is holding down a shift key at that moment, however, i.e. the explicit modifiers, is not known. We could -// reconstruct this information by tracking the press and release events of the modifier keys (keycodes higher than 0xe0) -// though. -// We here record all key press events of non-modifier keys (keycodes less than 0xe0). +// Capture all key press and release events in order to record the most recently released key code. +// +// Note that the event structure gives us the keycode (16 bit), the usage page (8 bit) and the implicit modifiers (8 +// bit), but not the explicit modifiers. If the keymap contains the binding "&kp RA(Y)", for example, then right-alt is +// an implicit modifier so that instead of the Y, the special character Ü is sent (US International layout). +// +// Whether the user is holding down a shift key at that moment, however, i.e. the explicit modifiers, is not known. We +// could reconstruct this information by tracking the press and release events of the modifier keys (keycodes higher +// than 0xe0) though, but in the present version, the potential antecedents are recorded without modifiers. +// +// We here record all key release events of non-modifier keys (keycodes less than 0xe0). +// +// If someone somewhere triggers a key down event with an illegal key code (beyond 0xff), this key code is recorded as a +// potential antecedent, but is then discarded. This way, it is possible to trigger 'silent antecedents', e.g. in order +// to create new dead keys. + static int antecedent_morph_keycode_state_changed_listener(const zmk_event_t *eh) { + struct zmk_keycode_state_changed *ev = as_zmk_keycode_state_changed(eh); int32_t code = ((ev->implicit_modifiers & 0xff) << 24) | ((ev->usage_page & 0xff) << 16) | (ev->keycode & 0xffff); - LOG_DBG("%s keycode %d page %d implicit mods %d explicit mods %d code 0x%08x",ev->state ? "down" : "up",ev->keycode,ev->usage_page,ev->implicit_modifiers,ev->explicit_modifiers,code); + LOG_DBG("%s keycode %d; page %d; implicit mods %d; explicit mods %d; key code 0x%08x",ev->state ? "down" : "up",ev->keycode,ev->usage_page,ev->implicit_modifiers,ev->explicit_modifiers,code); if ((ev->state) && ((ev->keycode < 0xe0) || (ev->keycode > 0xff))) { - LOG_DBG("code_pressed changes from 0x%08x to 0x%08x",code_pressed,code); + LOG_DBG("global variable changes from 0x%08x to 0x%08x",code_pressed,code); code_pressed = code; time_pressed = ev->timestamp; } @@ -71,36 +83,66 @@ static int antecedent_morph_keycode_state_changed_listener(const zmk_event_t *eh } } -// When an antecedent morph binding is pressed, we test whether the most recently pressed key code -// is among the configured antecedents and whether the corresponding key press event was no more -// than the configured delay time ago. +// When an antecedent morph binding is pressed, we test whether the most recently released key code is among the +// configured antecedents and whether the corresponding key release event was no more than the configured delay time +// ago. + static int on_antecedent_morph_binding_pressed(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event) { const struct device *dev = device_get_binding(binding->behavior_dev); const struct behavior_antecedent_morph_config *cfg = dev->config; struct behavior_antecedent_morph_data *data = dev->data; - bool morph = false; + int morph = -1; if (data->pressed_binding != NULL) { LOG_ERR("Can't press the same antecedent-morph twice"); return -ENOTSUP; } - LOG_DBG("press serial no. %d when code_pressed 0x%08x delay %dms explicit_mods 0x%02x",cfg->serial,code_pressed,(int32_t)(event.timestamp-time_pressed),zmk_hid_get_explicit_mods()); + LOG_DBG("press zmk,behavior-antecedent-morph serial no. %d when is 0x%08x; delay %dms; and explicit_mods 0x%02x", + cfg->serial,code_pressed,(int32_t)(event.timestamp-time_pressed),zmk_hid_get_explicit_mods()); for (int i=0;iantecedents_len;i++) { if (code_pressed == cfg->antecedents[i]) { - morph = true; + morph = i; } } - if ((morph) && ((int32_t)(event.timestamp-time_pressed)) < cfg->max_delay_ms) { + + if ((morph >= 0) && ((int32_t)(event.timestamp-time_pressed)) < cfg->max_delay_ms) { + + // If the the delay between the most recent key release and the pressing of the current behavior is less than the + // configured maximum delay and if the most recently released key is among the recorded antecedents, issue the + // behavior among the 'bindings' that is at the corresponding position to the antecedent among the 'antecedents'. + // + // Note that should one of the arrays 'bindings' or 'defaults' are too short, an error is triggered and the behavior + // never pressed. + LOG_DBG("morph condition satisfied"); - data->pressed_binding = (struct zmk_behavior_binding *)&cfg->morph_binding; + + if (morph < cfg->bindings_len) { + data->pressed_binding = (struct zmk_behavior_binding *)&cfg->bindings[morph]; + } else { + LOG_ERR("Property 'bindings' must be an array at least of length %d.",morph+1); + return -ENOTSUP; + } + } else { - data->pressed_binding = (struct zmk_behavior_binding *)&cfg->normal_binding; + + // Otherwise, issue the first behavior of the 'defaults' array. + + if (0 < cfg->defaults_len) { + data->pressed_binding = (struct zmk_behavior_binding *)&cfg->defaults[0]; + } else { + LOG_ERR("Property 'defaults' must be an array at least of length 1."); + return -ENOTSUP; + } } + return behavior_keymap_binding_pressed(data->pressed_binding, event); } +// The release of the antecedent morph behavior considers the behavior that was recorded in the instance data and +// releases it. + static int on_antecedent_morph_binding_released(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event) { const struct device *dev = device_get_binding(binding->behavior_dev); @@ -112,13 +154,12 @@ static int on_antecedent_morph_binding_released(struct zmk_behavior_binding *bin return -ENOTSUP; } - LOG_DBG("release serial %d",cfg->serial); + LOG_DBG("release zmk,behavior-antecedent-morph serial no. %d",cfg->serial); struct zmk_behavior_binding *pressed_binding = data->pressed_binding; data->pressed_binding = NULL; - int err; - err = behavior_keymap_binding_released(pressed_binding, event); - return err; + + return behavior_keymap_binding_released(pressed_binding, event); } static const struct behavior_driver_api behavior_antecedent_morph_driver_api = { @@ -130,38 +171,45 @@ static int behavior_antecedent_morph_init(const struct device *dev) { const struct behavior_antecedent_morph_config *cfg = dev->config; - LOG_DBG("serial no. %d has got %d antecedents.",cfg->serial,cfg->antecedents_len); + LOG_DBG("zmk,behavior-antecedent-morph serial no. %d defined with %d defaults, %d bindings and %d antecedents.",cfg->serial,cfg->defaults_len,cfg->bindings_len,cfg->antecedents_len); for (int i=0; iantecedents_len;i++) { LOG_DBG("antedecent no. %d is 0x%08x.",i,cfg->antecedents[i]); } code_pressed = 0; - return 0; } -#define _TRANSFORM_ENTRY(idx, node) \ - { \ - .behavior_dev = DT_PROP(DT_INST_PHANDLE_BY_IDX(node, bindings, idx), label), \ - .param1 = COND_CODE_0(DT_INST_PHA_HAS_CELL_AT_IDX(node, bindings, idx, param1), (0), \ - (DT_INST_PHA_BY_IDX(node, bindings, idx, param1))), \ - .param2 = COND_CODE_0(DT_INST_PHA_HAS_CELL_AT_IDX(node, bindings, idx, param2), (0), \ - (DT_INST_PHA_BY_IDX(node, bindings, idx, param2))), \ - } +#define _TRANSFORM_ENTRY(idx, node) ZMK_KEYMAP_EXTRACT_BINDING(idx, node) -#define KP_INST(n) \ - static struct behavior_antecedent_morph_config behavior_antecedent_morph_config_##n = { \ - .serial = n, \ - .max_delay_ms = DT_INST_PROP(n, max_delay_ms), \ - .normal_binding = _TRANSFORM_ENTRY(0, n), \ - .morph_binding = _TRANSFORM_ENTRY(1, n), \ - .antecedents = DT_INST_PROP(n, antecedents), \ - .antecedents_len = DT_INST_PROP_LEN(n, antecedents), \ - }; \ - static struct behavior_antecedent_morph_data behavior_antecedent_morph_data_##n = {}; \ - DEVICE_DT_INST_DEFINE(n, behavior_antecedent_morph_init, NULL, &behavior_antecedent_morph_data_##n, \ - &behavior_antecedent_morph_config_##n, APPLICATION, \ - CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, &behavior_antecedent_morph_driver_api); +#define TRANSFORMED_DEFAULTS(node) \ + { LISTIFY(DT_INST_PROP_LEN(node, defaults), _TRANSFORM_ENTRY, (, ), DT_DRV_INST(node)) } + +#define TRANSFORMED_BINDINGS(node) \ + { LISTIFY(DT_INST_PROP_LEN(node, bindings), _TRANSFORM_ENTRY, (, ), DT_DRV_INST(node)) } + +#define KP_INST(n) \ + static struct zmk_behavior_binding behavior_antecedent_morph_config_##n##_defaults[DT_INST_PROP_LEN(n, defaults)] = \ + TRANSFORMED_DEFAULTS(n); \ + static struct zmk_behavior_binding behavior_antecedent_morph_config_##n##_bindings[DT_INST_PROP_LEN(n, bindings)] = \ + TRANSFORMED_BINDINGS(n); \ + static struct behavior_antecedent_morph_config behavior_antecedent_morph_config_##n = { \ + .serial = n, \ + .max_delay_ms = DT_INST_PROP(n, max_delay_ms), \ + .defaults = behavior_antecedent_morph_config_##n##_defaults, \ + .defaults_len = DT_INST_PROP_LEN(n, defaults), \ + .bindings = behavior_antecedent_morph_config_##n##_bindings, \ + .bindings_len = DT_INST_PROP_LEN(n, bindings), \ + .antecedents = DT_INST_PROP(n, antecedents), \ + .antecedents_len = DT_INST_PROP_LEN(n, antecedents) \ + }; \ + static struct behavior_antecedent_morph_data behavior_antecedent_morph_data_##n = { \ + .pressed_binding = NULL \ + }; \ + DEVICE_DT_INST_DEFINE(n,behavior_antecedent_morph_init,NULL,NULL, \ + &behavior_antecedent_morph_config_##n, \ + APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, \ + &behavior_antecedent_morph_driver_api); DT_INST_FOREACH_STATUS_OKAY(KP_INST)