From e91eeb4c20506a95f4697eb1d35774a8fb61d4bb Mon Sep 17 00:00:00 2001 From: Christoph Cullmann Date: Sun, 2 Apr 2023 20:29:24 +0200 Subject: [PATCH] use https://stevep99.github.io/seniply/ --- ferris/achordion.c | 215 --------------------------------------------- ferris/achordion.h | 164 ---------------------------------- ferris/config.h | 23 ----- ferris/keymap.c | 80 +++++++---------- ferris/rules.mk | 14 --- 5 files changed, 30 insertions(+), 466 deletions(-) delete mode 100644 ferris/achordion.c delete mode 100644 ferris/achordion.h diff --git a/ferris/achordion.c b/ferris/achordion.c deleted file mode 100644 index a11e7a9..0000000 --- a/ferris/achordion.c +++ /dev/null @@ -1,215 +0,0 @@ -// Copyright 2022-2023 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -/** - * @file achordion.c - * @brief Achordion implementation - * - * For full documentation, see - * - */ - -#include "achordion.h" - -// Copy of the `record` and `keycode` args for the current active tap-hold key. -static keyrecord_t tap_hold_record; -static uint16_t tap_hold_keycode = KC_NO; -// Timeout timer. When it expires, the key is considered held. -static uint16_t hold_timer = 0; -// Eagerly applied mods, if any. -static uint8_t eager_mods = 0; - -// Achordion's current state. -enum { - // A tap-hold key is pressed, but hasn't yet been settled as tapped or held. - STATE_UNSETTLED, - // Achordion is inactive. - STATE_RELEASED, - // Active tap-hold key has been settled as tapped. - STATE_TAPPING, - // Active tap-hold key has been settled as held. - STATE_HOLDING, - // This state is set while calling `process_record()`, which will recursively - // call `process_achordion()`. This state is checked so that we don't process - // events generated by Achordion and potentially create an infinite loop. - STATE_RECURSING, -}; -static uint8_t achordion_state = STATE_RELEASED; - -// Calls `process_record()` with state set to RECURSING. -static void recursively_process_record(keyrecord_t* record, uint8_t state) { - achordion_state = STATE_RECURSING; - process_record(record); - achordion_state = state; -} - -// Clears eagerly-applied mods. -static void clear_eager_mods(void) { - unregister_mods(eager_mods); - eager_mods = 0; -} - -// Sends hold press event and settles the active tap-hold key as held. -static void settle_as_hold(void) { - clear_eager_mods(); - // Create hold press event. - recursively_process_record(&tap_hold_record, STATE_HOLDING); -} - -bool process_achordion(uint16_t keycode, keyrecord_t* record) { - // Don't process events that Achordion generated. - if (achordion_state == STATE_RECURSING) { - return true; - } - - // Determine whether the current event is for a mod-tap or layer-tap key. - const bool is_mt = IS_QK_MOD_TAP(keycode); - const bool is_tap_hold = is_mt || IS_QK_LAYER_TAP(keycode); - // Check key position to avoid acting on combos. - const bool is_physical_pos = (record->event.key.row < KEYLOC_COMBO && - record->event.key.col < KEYLOC_COMBO); - - if (achordion_state == STATE_RELEASED) { - if (is_tap_hold && record->tap.count == 0 && record->event.pressed && - is_physical_pos) { - // A tap-hold key is pressed and considered by QMK as "held". - const uint16_t timeout = achordion_timeout(keycode); - if (timeout > 0) { - achordion_state = STATE_UNSETTLED; - // Save info about this key. - tap_hold_keycode = keycode; - tap_hold_record = *record; - hold_timer = record->event.time + timeout; - - if (is_mt) { // Apply mods immediately if they are "eager." - uint8_t mod = mod_config(QK_MOD_TAP_GET_MODS(tap_hold_keycode)); - if (achordion_eager_mod(mod)) { - eager_mods = ((mod & 0x10) == 0) ? mod : (mod << 4); - register_mods(eager_mods); - } - } - - dprintf("Achordion: Key 0x%04X pressed.%s\n", keycode, - eager_mods ? " Set eager mods." : ""); - return false; // Skip default handling. - } - } - - return true; // Otherwise, continue with default handling. - } - - if (keycode == tap_hold_keycode && !record->event.pressed) { - // The active tap-hold key is being released. - if (achordion_state == STATE_HOLDING) { - dprintln("Achordion: Key released. Plumbing hold release."); - tap_hold_record.event.pressed = false; - // Plumb hold release event. - recursively_process_record(&tap_hold_record, STATE_RELEASED); - } else { - dprintf("Achordion: Key released.%s\n", - eager_mods ? " Clearing eager mods." : ""); - if (is_mt) { - clear_eager_mods(); - } - } - - achordion_state = STATE_RELEASED; - return false; - } - - if (achordion_state == STATE_UNSETTLED && record->event.pressed) { - // Press event occurred on a key other than the active tap-hold key. - - // If the other key is *also* a tap-hold key and considered by QMK to be - // held, then we settle the active key as held. This way, things like - // chording multiple home row modifiers will work, but let's our logic - // consider simply a single tap-hold key as "active" at a time. - // - // Otherwise, we call `achordion_chord()` to determine whether to settle the - // tap-hold key as tapped vs. held. We implement the tap or hold by plumbing - // events back into the handling pipeline so that QMK features and other - // user code can see them. This is done by calling `process_record()`, which - // in turn calls most handlers including `process_record_user()`. - if (!is_physical_pos || (is_tap_hold && record->tap.count == 0) || - achordion_chord(tap_hold_keycode, &tap_hold_record, keycode, record)) { - dprintln("Achordion: Plumbing hold press."); - settle_as_hold(); - } else { - clear_eager_mods(); // Clear in case eager mods were set. - - dprintln("Achordion: Plumbing tap press."); - tap_hold_record.tap.count = 1; // Revise event as a tap. - tap_hold_record.tap.interrupted = true; - // Plumb tap press event. - recursively_process_record(&tap_hold_record, STATE_TAPPING); - -#if TAP_CODE_DELAY > 0 - wait_ms(TAP_CODE_DELAY); -#endif // TAP_CODE_DELAY > 0 - - dprintln("Achordion: Plumbing tap release."); - tap_hold_record.event.pressed = false; - // Plumb tap release event. - recursively_process_record(&tap_hold_record, STATE_TAPPING); - } - - recursively_process_record(record, achordion_state); // Re-process event. - return false; // Block the original event. - } - - return true; -} - -void achordion_task(void) { - if (achordion_state == STATE_UNSETTLED && - timer_expired(timer_read(), hold_timer)) { - dprintln("Achordion: Timeout. Plumbing hold press."); - settle_as_hold(); // Timeout expired, settle the key as held. - } -} - -// Returns true if `pos` on the left hand of the keyboard, false if right. -static bool on_left_hand(keypos_t pos) { -#ifdef SPLIT_KEYBOARD - return pos.row < MATRIX_ROWS / 2; -#else - return (MATRIX_COLS > MATRIX_ROWS) ? pos.col < MATRIX_COLS / 2 - : pos.row < MATRIX_ROWS / 2; -#endif -} - -bool achordion_opposite_hands(const keyrecord_t* tap_hold_record, - const keyrecord_t* other_record) { - return on_left_hand(tap_hold_record->event.key) != - on_left_hand(other_record->event.key); -} - -// By default, use the BILATERAL_COMBINATIONS rule to consider the tap-hold key -// "held" only when it and the other key are on opposite hands. -__attribute__((weak)) bool achordion_chord(uint16_t tap_hold_keycode, - keyrecord_t* tap_hold_record, - uint16_t other_keycode, - keyrecord_t* other_record) { - return achordion_opposite_hands(tap_hold_record, other_record); -} - -// By default, the timeout is 1000 ms for all keys. -__attribute__((weak)) uint16_t achordion_timeout(uint16_t tap_hold_keycode) { - return 1000; -} - -// By default, Shift and Ctrl mods are eager, and Alt and GUI are not. -__attribute__((weak)) bool achordion_eager_mod(uint8_t mod) { - return (mod & (MOD_LALT | MOD_LGUI)) == 0; -} diff --git a/ferris/achordion.h b/ferris/achordion.h deleted file mode 100644 index e6bb534..0000000 --- a/ferris/achordion.h +++ /dev/null @@ -1,164 +0,0 @@ -// Copyright 2022-2023 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -/** - * @file achordion.h - * @brief Achordion: Customizing the tap-hold decision. - * - * Overview - * -------- - * - * This library customizes when tap-hold keys are considered held vs. tapped - * based on the next pressed key, like Manna Harbour's Bilateral Combinations or - * ZMK's positional hold. The library works on top of QMK's existing tap-hold - * implementation. You define mod-tap and layer-tap keys as usual and use - * Achordion to fine-tune the behavior. - * - * When QMK settles a tap-hold key as held, Achordion intercepts the event. - * Achordion then revises the event as a tap or passes it along as a hold: - * - * * Chord condition: On the next key press, a customizable `achordion_chord()` - * function is called, which takes the tap-hold key and the next key pressed - * as args. When the function returns true, the tap-hold key is settled as - * held, and otherwise as tapped. - * - * * Timeout: If no other key press occurs within a timeout, the tap-hold key - * is settled as held. This is customizable with `achordion_timeout()`. - * - * Achordion only changes the behavior when QMK considered the key held. It - * changes some would-be holds to taps, but no taps to holds. - * - * @note Some QMK features handle events before the point where Achordion can - * intercept them, particularly: Combos, Key Lock, and Dynamic Macros. It's - * still possible to use these features and Achordion in your keymap, but beware - * they might behave poorly when used simultaneously with tap-hold keys. - * - * - * For full documentation, see - * - */ - -#pragma once - -#include "quantum.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Handler function for Achordion. - * - * Call this function from `process_record_user()` as - * - * #include "features/achordion.h" - * - * bool process_record_user(uint16_t keycode, keyrecord_t* record) { - * if (!process_achordion(keycode, record)) { return false; } - * // Your macros... - * return true; - * } - */ -bool process_achordion(uint16_t keycode, keyrecord_t* record); - -/** - * Matrix task function for Achordion. - * - * Call this function from `matrix_scan_user()` as - * - * void matrix_scan_user(void) { - * achordion_task(); - * } - */ -void achordion_task(void); - -/** - * Optional callback to customize which key chords are considered "held". - * - * In your keymap.c, define the callback - * - * bool achordion_chord(uint16_t tap_hold_keycode, - * keyrecord_t* tap_hold_record, - * uint16_t other_keycode, - * keyrecord_t* other_record) { - * // Conditions... - * } - * - * This callback is called if while `tap_hold_keycode` is pressed, - * `other_keycode` is pressed. Return true if the tap-hold key should be - * considered held, or false to consider it tapped. - * - * @param tap_hold_keycode Keycode of the tap-hold key. - * @param tap_hold_record keyrecord_t from the tap-hold press event. - * @param other_keycode Keycode of the other key. - * @param other_record keyrecord_t from the other key's press event. - * @return True if the tap-hold key should be considered held. - */ -bool achordion_chord(uint16_t tap_hold_keycode, keyrecord_t* tap_hold_record, - uint16_t other_keycode, keyrecord_t* other_record); - -/** - * Optional callback to define a timeout duration per keycode. - * - * In your keymap.c, define the callback - * - * uint16_t achordion_timeout(uint16_t tap_hold_keycode) { - * // ... - * } - * - * The callback determines Achordion's timeout duration for `tap_hold_keycode` - * in units of milliseconds. The timeout be in the range 0 to 32767 ms (upper - * bound is due to 16-bit timer limitations). Use a timeout of 0 to bypass - * Achordion. - * - * @param tap_hold_keycode Keycode of the tap-hold key. - * @return Timeout duration in milliseconds in the range 0 to 32767. - */ -uint16_t achordion_timeout(uint16_t tap_hold_keycode); - -/** - * Optional callback defining which mods are "eagerly" applied. - * - * This callback defines which mods are "eagerly" applied while a mod-tap - * key is still being settled. This is helpful to reduce delay particularly when - * using mod-tap keys with an external mouse. - * - * Define this callback in your keymap.c. The default callback is eager for - * Shift and Ctrl, and not for Alt and GUI: - * - * bool achordion_eager_mod(uint8_t mod) { - * return (mod & (MOD_LALT | MOD_LGUI)) == 0; - * } - * - * @note `mod` should be compared with `MOD_` prefixed codes, not `KC_` codes, - * described at . - * - * @param mod Modifier `MOD_` code. - * @return True if the modifier should be eagerly applied. - */ -bool achordion_eager_mod(uint8_t mod); - -/** - * Returns true if the args come from keys on opposite hands. - * - * @param tap_hold_record keyrecord_t from the tap-hold key's event. - * @param other_record keyrecord_t from the other key's event. - * @return True if the keys are on opposite hands. - */ -bool achordion_opposite_hands(const keyrecord_t* tap_hold_record, - const keyrecord_t* other_record); - -#ifdef __cplusplus -} -#endif diff --git a/ferris/config.h b/ferris/config.h index ace550c..672f704 100644 --- a/ferris/config.h +++ b/ferris/config.h @@ -15,26 +15,3 @@ */ #pragma once - -// -// improve home row modifiers via achoridion -// - -// settings for home row modifiers -// details see https://precondition.github.io/home-row-mods - -// the default of 200 -#define TAPPING_TERM 200 - -// Prevent normal rollover on alphas from accidentally triggering mods. -#define IGNORE_MOD_TAP_INTERRUPT - -// Enable rapid switch from tap to hold, disables double tap hold auto-repeat. -#define QUICK_TAP_TERM 0 - -// try to be more permissive with holds, allows to trigger modifiers faster -// achordion will avoid the worst -#define PERMISSIVE_HOLD - -// caps word is great for defines -#define BOTH_SHIFTS_TURNS_ON_CAPS_WORD diff --git a/ferris/keymap.c b/ferris/keymap.c index e6b98f8..4a7a26b 100644 --- a/ferris/keymap.c +++ b/ferris/keymap.c @@ -16,26 +16,6 @@ #include QMK_KEYBOARD_H -// -// improve home row modifiers via achordion -// - -#include "achordion.h" - -bool process_record_user(uint16_t keycode, keyrecord_t* record) -{ - if (!process_achordion(keycode, record)) { - return false; - } - - return true; -} - -void matrix_scan_user(void) -{ - achordion_task(); -} - // layout helper macro, we just use 34 keys #define LAYOUT_cullmann(\ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\ @@ -52,48 +32,48 @@ K20, K21, K22, K23, K24, K25, K26, K27, K28, K29,\ // our layers, used as index in layers and rgb lights enum planck_layers { - _QWERTY, - _SYM, - _NUM, - _FN, - _NAV + L_CANARY, + L_EXT, + L_FUN, + L_SYM, + L_SYM2 }; const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { -[_QWERTY] = LAYOUT_cullmann( - KC_W, KC_L, KC_Y, KC_P, KC_B, KC_Z, KC_F, KC_O, KC_U, KC_QUOT, - LT(_NUM, KC_C), LALT_T(KC_R), LCTL_T(KC_S), LT(_SYM, KC_T), KC_G, KC_M, LT(_FN, KC_N), RCTL_T(KC_E), LALT_T(KC_I), LT(_NAV, KC_A), - LSFT_T(KC_Q), KC_J, LGUI_T(KC_V), RALT_T(KC_D), KC_K, KC_X, RALT_T(KC_H), RGUI_T(KC_SLSH), KC_COMM, RSFT_T(KC_DOT), - KC_TAB, KC_SPC, KC_ENT, KC_BSPC +[L_CANARY] = LAYOUT_cullmann( + KC_W, KC_L, KC_Y, KC_P, KC_B, KC_Z, KC_F, KC_O, KC_U, KC_QUOT, + KC_C, KC_R, KC_S, KC_T, KC_G, KC_M, KC_N, KC_E, KC_I, KC_A, + KC_Q, KC_J, KC_V, KC_D, KC_K, KC_X, KC_H, KC_SLSH, KC_COMM, KC_DOT, + MO(L_EXT), KC_SPC, KC_RSFT, MO(L_SYM) ), -[_SYM] = LAYOUT_cullmann( - XXXXXXX, C(KC_X), C(KC_C), C(KC_V), XXXXXXX, KC_LCBR, KC_AMPR, KC_ASTR, KC_LPRN, KC_RCBR, - KC_LSFT, KC_LALT, KC_LCTL, XXXXXXX, XXXXXXX, KC_PLUS, KC_DLR, KC_PERC, KC_CIRC, KC_COLN, - XXXXXXX, XXXXXXX, KC_LGUI, KC_RALT, XXXXXXX, KC_PIPE, KC_EXLM, KC_AT, KC_HASH, KC_TILD, - KC_TAB, KC_SPC, KC_UNDS, KC_RPRN +[L_EXT] = LAYOUT_cullmann( + KC_ESC, LALT(KC_LEFT), LCTL(KC_F), LALT(KC_RGHT), KC_INS, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_CAPS, + OSM(MOD_LALT), OSM(MOD_LGUI), OSM(MOD_LSFT), OSM(MOD_LCTL), OSM(MOD_RALT), KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_DEL, + LCTL(KC_Z), LCTL(KC_X), LCTL(KC_C), KC_LGUI, LCTL(KC_V), KC_PSCR, KC_BSPC, KC_TAB, KC_APP, KC_ENT, + KC_TRNS, KC_TRNS, KC_ENT, MO(L_FUN) ), -[_NUM] = LAYOUT_cullmann( - XXXXXXX, C(KC_X), C(KC_C), C(KC_V), XXXXXXX, KC_LBRC, KC_7, KC_8, KC_9, KC_RBRC, - XXXXXXX, KC_LALT, KC_LCTL, KC_LSFT, XXXXXXX, KC_EQL, KC_4, KC_5, KC_6, KC_SCLN, - XXXXXXX, XXXXXXX, KC_LGUI, KC_RALT, XXXXXXX, KC_BSLS, KC_1, KC_2, KC_3, KC_GRV, - KC_TAB, KC_SPC, KC_MINS, KC_0 +[L_FUN] = LAYOUT_cullmann( + KC_MSTP, KC_MPRV, KC_MPLY, KC_MNXT, KC_BRIU, KC_F12, KC_F7, KC_F8, KC_F9, LCTL(KC_PLUS), + OSM(MOD_LALT), OSM(MOD_LGUI), OSM(MOD_LSFT), OSM(MOD_LCTL), KC_BRID, KC_F11, KC_F4, KC_F5, KC_F6, LCTL(KC_MINS), + KC_MUTE, KC_VOLD, RCS(KC_C), KC_VOLU, RCS(KC_V), KC_F10, KC_F1, KC_F2, KC_F3, LCTL(KC_0), + KC_TRNS, KC_TRNS, KC_ENT, KC_TRNS ), -[_FN] = LAYOUT_cullmann( - KC_F12, KC_F7, KC_F8, KC_F9, KC_PSCR, QK_BOOT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, - KC_F11, KC_F4, KC_F5, KC_F6, KC_DEL, XXXXXXX, XXXXXXX, KC_RCTL, KC_LALT, KC_RSFT, - KC_F10, KC_F1, KC_F2, KC_F3, KC_INS, XXXXXXX, KC_RALT, KC_RGUI, XXXXXXX, XXXXXXX, - KC_TAB, KC_ESC, KC_ENT, KC_BSPC +[L_SYM] = LAYOUT_cullmann( + KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_EQL, KC_7, KC_8, KC_9, KC_PLUS, + KC_SCLN, KC_COLN, KC_LCBR, KC_LPRN, KC_LBRC, KC_ASTR, KC_4, KC_5, KC_6, KC_MINS, + KC_CIRC, KC_AMPR, KC_RCBR, KC_RPRN, KC_RBRC, KC_0, KC_1, KC_2, KC_3, KC_SLSH, + KC_TRNS, MO(L_SYM2), KC_TRNS, KC_TRNS ), -[_NAV] = LAYOUT_cullmann( - XXXXXXX, KC_PGUP, KC_UP, KC_PGDN, XXXXXXX, QK_BOOT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, - KC_HOME, KC_LEFT, KC_DOWN, KC_RGHT, KC_END, XXXXXXX, KC_RSFT, KC_RCTL, KC_LALT, XXXXXXX, - XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_RALT, KC_RGUI, XXXXXXX, XXXXXXX, - KC_TAB, KC_ESC, KC_ENT, KC_BSPC +[L_SYM2] = LAYOUT_cullmann( + RALT(KC_1), RALT(KC_2), RALT(KC_3), RALT(KC_4), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, QK_BOOT, + KC_NUBS, LSFT(KC_NUBS), KC_NUHS, LSFT(KC_NUHS), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, + KC_GRV, LSFT(KC_GRV), RALT(KC_C), LSFT(KC_MINS), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS ) }; diff --git a/ferris/rules.mk b/ferris/rules.mk index 108f55a..dd070e7 100644 --- a/ferris/rules.mk +++ b/ferris/rules.mk @@ -5,19 +5,5 @@ LTO_ENABLE = yes COMMAND_ENABLE = no CONSOLE_ENABLE = no -# we have some real mouse -MOUSEKEY_ENABLE = no - -# more features we not use -SPACE_CADET_ENABLE = no -GRAVE_ESC_ENABLE = no -MUSIC_ENABLE = no - -# caps word is great for defines -CAPS_WORD_ENABLE = yes - -# add achordion to improve home row modifiers -SRC += achordion.c - # per key debounce: https://github.com/qmk/qmk_firmware/blob/master/docs/feature_debounce_type.md DEBOUNCE_TYPE = sym_defer_pk