diff options
Diffstat (limited to 'quantum/action_tapping.c')
| -rw-r--r-- | quantum/action_tapping.c | 166 | 
1 files changed, 86 insertions, 80 deletions
| diff --git a/quantum/action_tapping.c b/quantum/action_tapping.c index df3317ac05..507b8144aa 100644 --- a/quantum/action_tapping.c +++ b/quantum/action_tapping.c @@ -15,6 +15,14 @@  #ifndef NO_ACTION_TAPPING +#    if defined(IGNORE_MOD_TAP_INTERRUPT_PER_KEY) +#        error "IGNORE_MOD_TAP_INTERRUPT_PER_KEY has been removed; the code needs to be ported to use HOLD_ON_OTHER_KEY_PRESS_PER_KEY instead." +#    elif !defined(IGNORE_MOD_TAP_INTERRUPT) +#        if !defined(PERMISSIVE_HOLD) && !defined(PERMISSIVE_HOLD_PER_KEY) && !defined(HOLD_ON_OTHER_KEY_PRESS) && !defined(HOLD_ON_OTHER_KEY_PRESS_PER_KEY) +#            pragma message "The default behavior of mod-taps will change to mimic IGNORE_MOD_TAP_INTERRUPT in the future.\nIf you wish to keep the old default behavior of mod-taps, please use HOLD_ON_OTHER_KEY_PRESS." +#        endif +#    endif +  #    define IS_TAPPING() !IS_NOEVENT(tapping_key.event)  #    define IS_TAPPING_PRESSED() (IS_TAPPING() && tapping_key.event.pressed)  #    define IS_TAPPING_RELEASED() (IS_TAPPING() && !tapping_key.event.pressed) @@ -25,6 +33,7 @@  #        define IS_TAPPING_RECORD(r) (IS_TAPPING() && KEYEQ(tapping_key.event.key, (r->event.key)) && tapping_key.keycode == r->keycode)  #    endif  #    define WITHIN_TAPPING_TERM(e) (TIMER_DIFF_16(e.time, tapping_key.event.time) < GET_TAPPING_TERM(get_record_keycode(&tapping_key, false), &tapping_key)) +#    define WITHIN_QUICK_TAP_TERM(e) (TIMER_DIFF_16(e.time, tapping_key.event.time) < GET_QUICK_TAP_TERM(get_record_keycode(&tapping_key, false), &tapping_key))  #    ifdef DYNAMIC_TAPPING_TERM_ENABLE  uint16_t g_tapping_term = TAPPING_TERM; @@ -40,9 +49,9 @@ __attribute__((weak)) uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *r  }  #    endif -#    ifdef TAPPING_FORCE_HOLD_PER_KEY -__attribute__((weak)) bool get_tapping_force_hold(uint16_t keycode, keyrecord_t *record) { -    return false; +#    ifdef QUICK_TAP_TERM_PER_KEY +__attribute__((weak)) uint16_t get_quick_tap_term(uint16_t keycode, keyrecord_t *record) { +    return QUICK_TAP_TERM;  }  #    endif @@ -117,6 +126,56 @@ void action_tapping_process(keyrecord_t record) {      }  } +/* Some conditionally defined helper macros to keep process_tapping more + * readable. The conditional definition of tapping_keycode and all the + * conditional uses of it are hidden inside macros named TAP_... + */ +#    if (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)) || defined(PERMISSIVE_HOLD_PER_KEY) || defined(QUICK_TAP_TERM_PER_KEY) || defined(HOLD_ON_OTHER_KEY_PRESS_PER_KEY) +#        define TAP_DEFINE_KEYCODE uint16_t tapping_keycode = get_record_keycode(&tapping_key, false) +#    else +#        define TAP_DEFINE_KEYCODE +#    endif + +#    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT) +#        ifdef RETRO_TAPPING_PER_KEY +#            define TAP_GET_RETRO_TAPPING get_retro_tapping(tapping_keycode, &tapping_key) +#        else +#            define TAP_GET_RETRO_TAPPING true +#        endif +#        define MAYBE_RETRO_SHIFTING(ev) (TAP_GET_RETRO_TAPPING && (RETRO_SHIFT + 0) != 0 && TIMER_DIFF_16((ev).time, tapping_key.event.time) < (RETRO_SHIFT + 0)) +#        define TAP_IS_LT IS_QK_LAYER_TAP(tapping_keycode) +#        define TAP_IS_MT IS_QK_MOD_TAP(tapping_keycode) +#        define TAP_IS_RETRO IS_RETRO(tapping_keycode) +#    else +#        define TAP_GET_RETRO_TAPPING false +#        define MAYBE_RETRO_SHIFTING(ev) false +#        define TAP_IS_LT false +#        define TAP_IS_MT false +#        define TAP_IS_RETRO false +#    endif + +#    ifdef PERMISSIVE_HOLD_PER_KEY +#        define TAP_GET_PERMISSIVE_HOLD get_permissive_hold(tapping_keycode, &tapping_key) +#    elif defined(PERMISSIVE_HOLD) +#        define TAP_GET_PERMISSIVE_HOLD true +#    else +#        define TAP_GET_PERMISSIVE_HOLD false +#    endif + +#    ifdef HOLD_ON_OTHER_KEY_PRESS_PER_KEY +#        define TAP_GET_HOLD_ON_OTHER_KEY_PRESS get_hold_on_other_key_press(tapping_keycode, &tapping_key) +#    elif defined(HOLD_ON_OTHER_KEY_PRESS) +#        define TAP_GET_HOLD_ON_OTHER_KEY_PRESS true +#    else +#        define TAP_GET_HOLD_ON_OTHER_KEY_PRESS false +#    endif + +#    if defined(IGNORE_MOD_TAP_INTERRUPT) +#        define TAP_GET_IGNORE_MOD_TAP_INTERRUPT true +#    else +#        define TAP_GET_IGNORE_MOD_TAP_INTERRUPT false +#    endif +  /** \brief Tapping   *   * Rule: Tap key is typed(pressed and released) within TAPPING_TERM. @@ -125,24 +184,11 @@ void action_tapping_process(keyrecord_t record) {  /* return true when key event is processed or consumed. */  bool process_tapping(keyrecord_t *keyp) {      keyevent_t event = keyp->event; -#    if (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)) || defined(PERMISSIVE_HOLD_PER_KEY) || defined(TAPPING_FORCE_HOLD_PER_KEY) || defined(HOLD_ON_OTHER_KEY_PRESS_PER_KEY) -    uint16_t tapping_keycode = get_record_keycode(&tapping_key, false); -#    endif +    TAP_DEFINE_KEYCODE;      // if tapping      if (IS_TAPPING_PRESSED()) { -        // clang-format off -        if (WITHIN_TAPPING_TERM(event) -#    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT) -            || ( -#        ifdef RETRO_TAPPING_PER_KEY -                get_retro_tapping(tapping_keycode, &tapping_key) && -#        endif -                (RETRO_SHIFT + 0) != 0 && TIMER_DIFF_16(event.time, tapping_key.event.time) < (RETRO_SHIFT + 0) -            ) -#    endif -        ) { -            // clang-format on +        if (WITHIN_TAPPING_TERM(event) || MAYBE_RETRO_SHIFTING(event)) {              if (tapping_key.tap.count == 0) {                  if (IS_TAPPING_RECORD(keyp) && !event.pressed) {  #    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT) @@ -164,57 +210,31 @@ bool process_tapping(keyrecord_t *keyp) {                   * useful for long TAPPING_TERM but may prevent fast typing.                   */                  // clang-format off -#    if defined(PERMISSIVE_HOLD) || defined(PERMISSIVE_HOLD_PER_KEY) || (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT))                  else if (                      ( -                        IS_RELEASED(event) && waiting_buffer_typed(event) -#        ifdef PERMISSIVE_HOLD_PER_KEY -                            && get_permissive_hold(tapping_keycode, &tapping_key) -#        elif defined(PERMISSIVE_HOLD) -                            && true -#        endif +                        IS_RELEASED(event) && waiting_buffer_typed(event) && +                        TAP_GET_PERMISSIVE_HOLD                      )                      // Causes nested taps to not wait past TAPPING_TERM/RETRO_SHIFT                      // unnecessarily and fixes them for Layer Taps. -#        if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT) -                    || ( -#            ifdef RETRO_TAPPING_PER_KEY -                        get_retro_tapping(tapping_keycode, &tapping_key) && -#            endif +                    || (TAP_GET_RETRO_TAPPING &&                          (                              // Rolled over the two keys. -                            ( -                                ( -                                    false -#            if defined(HOLD_ON_OTHER_KEY_PRESS) || defined(HOLD_ON_OTHER_KEY_PRESS_PER_KEY) -                                    || ( -                                        IS_LT(tapping_keycode) -#                ifdef HOLD_ON_OTHER_KEY_PRESS_PER_KEY -                                        && get_hold_on_other_key_press(tapping_keycode, &tapping_key) -#                endif -                                    ) -#            endif -#            if !defined(IGNORE_MOD_TAP_INTERRUPT) || defined(IGNORE_MOD_TAP_INTERRUPT_PER_KEY) -                                    || ( -                                        IS_MT(tapping_keycode) -#                ifdef IGNORE_MOD_TAP_INTERRUPT_PER_KEY -                                        && !get_ignore_mod_tap_interrupt(tapping_keycode, &tapping_key) -#                endif -                                    ) -#            endif -                                ) && tapping_key.tap.interrupted == true +                            (tapping_key.tap.interrupted == true && ( +                                (TAP_IS_LT && TAP_GET_HOLD_ON_OTHER_KEY_PRESS) || +                                (TAP_IS_MT && TAP_GET_HOLD_ON_OTHER_KEY_PRESS) +                                )                              )                              // Makes Retro Shift ignore [IGNORE_MOD_TAP_INTERRUPT's                              // effects on nested taps for MTs and the default                              // behavior of LTs] below TAPPING_TERM or RETRO_SHIFT.                              || ( -                                IS_RETRO(tapping_keycode) +                                TAP_IS_RETRO                                  && (event.key.col != tapping_key.event.key.col || event.key.row != tapping_key.event.key.row)                                  && IS_RELEASED(event) && waiting_buffer_typed(event)                              )                          )                      ) -#        endif                  ) {                      // clang-format on                      debug("Tapping: End. No tap. Interfered by typing key\n"); @@ -224,13 +244,12 @@ bool process_tapping(keyrecord_t *keyp) {                      // enqueue                      return false;                  } -#    endif                  /* Process release event of a key pressed before tapping starts                   * Without this unexpected repeating will occur with having fast repeating setting                   * https://github.com/tmk/tmk_keyboard/issues/60                   */                  else if (IS_RELEASED(event) && !waiting_buffer_typed(event)) { -                    // Modifier should be retained till end of this tapping. +                    // Modifier/Layer should be retained till end of this tapping.                      action_t action = layer_switch_get_action(event.key);                      switch (action.kind.id) {                          case ACT_LMODS: @@ -243,6 +262,16 @@ bool process_tapping(keyrecord_t *keyp) {                              if (action.key.mods && keyp->tap.count == 0) return false;                              if (IS_MOD(action.key.code)) return false;                              break; +                        case ACT_LAYER_TAP: +                        case ACT_LAYER_TAP_EXT: +                            switch (action.layer_tap.code) { +                                case 0 ...(OP_TAP_TOGGLE - 1): +                                case OP_ON_OFF: +                                case OP_OFF_ON: +                                case OP_SET_CLEAR: +                                    return false; +                            } +                            break;                      }                      // Release of key should be process immediately.                      debug("Tapping: release event of a key pressed before tapping\n"); @@ -252,11 +281,7 @@ bool process_tapping(keyrecord_t *keyp) {                      // set interrupted flag when other key preesed during tapping                      if (event.pressed) {                          tapping_key.tap.interrupted = true; -#    if defined(HOLD_ON_OTHER_KEY_PRESS) || defined(HOLD_ON_OTHER_KEY_PRESS_PER_KEY) -#        if defined(HOLD_ON_OTHER_KEY_PRESS_PER_KEY) -                        if (get_hold_on_other_key_press(tapping_keycode, &tapping_key)) -#        endif -                        { +                        if (TAP_GET_HOLD_ON_OTHER_KEY_PRESS) {                              debug("Tapping: End. No tap. Interfered by pressed key\n");                              process_record(&tapping_key);                              tapping_key = (keyrecord_t){}; @@ -264,7 +289,6 @@ bool process_tapping(keyrecord_t *keyp) {                              // enqueue                              return false;                          } -#    endif                      }                      // enqueue                      return false; @@ -357,27 +381,10 @@ bool process_tapping(keyrecord_t *keyp) {              }          }      } else if (IS_TAPPING_RELEASED()) { -        // clang-format off -        if (WITHIN_TAPPING_TERM(event) -#    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT) -            || ( -#        ifdef RETRO_TAPPING_PER_KEY -                get_retro_tapping(tapping_keycode, &tapping_key) && -#        endif -                (RETRO_SHIFT + 0) != 0 && TIMER_DIFF_16(event.time, tapping_key.event.time) < (RETRO_SHIFT + 0) -            ) -#    endif -        ) { -            // clang-format on +        if (WITHIN_TAPPING_TERM(event) || MAYBE_RETRO_SHIFTING(event)) {              if (event.pressed) {                  if (IS_TAPPING_RECORD(keyp)) { -//#    ifndef TAPPING_FORCE_HOLD -#    if !defined(TAPPING_FORCE_HOLD) || defined(TAPPING_FORCE_HOLD_PER_KEY) -                    if ( -#        ifdef TAPPING_FORCE_HOLD_PER_KEY -                        !get_tapping_force_hold(tapping_keycode, &tapping_key) && -#        endif -                        !tapping_key.tap.interrupted && tapping_key.tap.count > 0) { +                    if (WITHIN_QUICK_TAP_TERM(event) && !tapping_key.tap.interrupted && tapping_key.tap.count > 0) {                          // sequential tap.                          keyp->tap = tapping_key.tap;                          if (keyp->tap.count < 15) keyp->tap.count += 1; @@ -389,7 +396,6 @@ bool process_tapping(keyrecord_t *keyp) {                          debug_tapping_key();                          return true;                      } -#    endif                      // FIX: start new tap again                      tapping_key = *keyp;                      return true; | 
