logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

action_tapping.c (37557B)

    

  1. #include <stdint.h>
  2. #include <stdbool.h>
  4. #include "action.h"
  5. #include "action_layer.h"
  6. #include "action_tapping.h"
  7. #include "action_util.h"
  8. #include "keycode.h"
  9. #include "quantum_keycodes.h"
  10. #include "timer.h"
  12. #ifndef NO_ACTION_TAPPING
  14. #    if defined(IGNORE_MOD_TAP_INTERRUPT_PER_KEY)
  15. #        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."
  16. #    elif defined(IGNORE_MOD_TAP_INTERRUPT)
  17. #        error "IGNORE_MOD_TAP_INTERRUPT is no longer necessary as it is now the default behavior of mod-tap keys. Please remove it from your config."
  18. #    endif
  20. #    ifndef COMBO_ENABLE
  21. #        define IS_TAPPING_RECORD(r) (KEYEQ(tapping_key.event.key, (r->event.key)))
  22. #    else
  23. #        define IS_TAPPING_RECORD(r) (KEYEQ(tapping_key.event.key, (r->event.key)) && tapping_key.keycode == r->keycode)
  24. #    endif
  25. #    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))
  26. #    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))
  28. #    ifdef DYNAMIC_TAPPING_TERM_ENABLE
  29. uint16_t g_tapping_term = TAPPING_TERM;
  30. #    endif
  32. #    ifdef TAPPING_TERM_PER_KEY
  33. __attribute__((weak)) uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record) {
  34. #        ifdef DYNAMIC_TAPPING_TERM_ENABLE
  35.     return g_tapping_term;
  36. #        else
  37.     return TAPPING_TERM;
  38. #        endif
  39. }
  40. #    endif
  42. #    ifdef QUICK_TAP_TERM_PER_KEY
  43. __attribute__((weak)) uint16_t get_quick_tap_term(uint16_t keycode, keyrecord_t *record) {
  44.     return QUICK_TAP_TERM;
  45. }
  46. #    endif
  48. #    ifdef PERMISSIVE_HOLD_PER_KEY
  49. __attribute__((weak)) bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) {
  50.     return false;
  51. }
  52. #    endif
  54. #    if defined(CHORDAL_HOLD) || defined(FLOW_TAP_TERM)
  55. #        define REGISTERED_TAPS_SIZE 8
  56. // Array of tap-hold keys that have been settled as tapped but not yet released.
  57. static keypos_t registered_taps[REGISTERED_TAPS_SIZE] = {};
  58. static uint8_t  num_registered_taps                   = 0;
  60. /** Adds `key` to the registered_taps array. */
  61. static void registered_taps_add(keypos_t key);
  62. /** Returns the index of `key` in registered_taps, or -1 if not found. */
  63. static int8_t registered_tap_find(keypos_t key);
  64. /** Removes index `i` from the registered_taps array. */
  65. static void registered_taps_del_index(uint8_t i);
  66. /** Logs the registered_taps array for debugging. */
  67. static void debug_registered_taps(void);
  69. static bool is_mt_or_lt(uint16_t keycode) {
  70.     return IS_QK_MOD_TAP(keycode) || IS_QK_LAYER_TAP(keycode);
  71. }
  72. #    endif // defined(CHORDAL_HOLD) || defined(FLOW_TAP_TERM)
  74. #    if defined(CHORDAL_HOLD)
  75. extern const char chordal_hold_layout[MATRIX_ROWS][MATRIX_COLS] PROGMEM;
  77. /** \brief Finds which queued events should be held according to Chordal Hold.
  78.  *
  79.  * In a situation with multiple unsettled tap-hold key presses, scan the queue
  80.  * up until the first release, non-tap-hold, or one-shot event and find the
  81.  * latest event in the queue that settles as held according to
  82.  * get_chordal_hold().
  83.  *
  84.  * \return Index of the first tap, or equivalently, one past the latest hold.
  85.  */
  86. static uint8_t waiting_buffer_find_chordal_hold_tap(void);
  88. /** Processes queued events up to and including `key` as tapped. */
  89. static void waiting_buffer_chordal_hold_taps_until(keypos_t key);
  91. /** \brief Processes and pops buffered events until the first tap-hold event. */
  92. static void waiting_buffer_process_regular(void);
  93. #    endif // CHORDAL_HOLD
  95. #    ifdef HOLD_ON_OTHER_KEY_PRESS_PER_KEY
  96. __attribute__((weak)) bool get_hold_on_other_key_press(uint16_t keycode, keyrecord_t *record) {
  97.     return false;
  98. }
  99. #    endif
  101. #    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)
  102. #        include "process_auto_shift.h"
  103. #    endif
  105. #    if defined(FLOW_TAP_TERM)
  106. static uint16_t flow_tap_prev_keycode = KC_NO;
  107. static uint16_t flow_tap_prev_time    = 0;
  108. static bool     flow_tap_expired      = true;
  110. static bool flow_tap_key_if_within_term(keyrecord_t *record, uint16_t prev_time);
  111. #    endif // defined(FLOW_TAP_TERM)
  113. static keyrecord_t tapping_key                         = {};
  114. static keyrecord_t waiting_buffer[WAITING_BUFFER_SIZE] = {};
  115. static uint8_t     waiting_buffer_head                 = 0;
  116. static uint8_t     waiting_buffer_tail                 = 0;
  118. static bool process_tapping(keyrecord_t *record);
  119. static bool waiting_buffer_enq(keyrecord_t record);
  120. static void waiting_buffer_clear(void);
  121. static bool waiting_buffer_typed(keyevent_t event);
  122. static bool waiting_buffer_has_anykey_pressed(void);
  123. static void waiting_buffer_scan_tap(void);
  124. static void debug_tapping_key(void);
  125. static void debug_waiting_buffer(void);
  127. /** \brief Action Tapping Process
  128.  *
  129.  * FIXME: Needs doc
  130.  */
  131. void action_tapping_process(keyrecord_t record) {
  132.     if (process_tapping(&record)) {
  133.         if (IS_EVENT(record.event)) {
  134.             ac_dprintf("processed: ");
  135.             debug_record(record);
  136.             ac_dprintf("\n");
  137.         }
  138.     } else {
  139.         if (!waiting_buffer_enq(record)) {
  140.             // clear all in case of overflow.
  141.             ac_dprintf("OVERFLOW: CLEAR ALL STATES\n");
  142.             clear_keyboard();
  143.             waiting_buffer_clear();
  144.             tapping_key = (keyrecord_t){0};
  145.         }
  146.     }
  148.     // process waiting_buffer
  149.     if (IS_EVENT(record.event) && waiting_buffer_head != waiting_buffer_tail) {
  150.         ac_dprintf("---- action_exec: process waiting_buffer -----\n");
  151.     }
  152.     for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
  153.         if (process_tapping(&waiting_buffer[waiting_buffer_tail])) {
  154.             ac_dprintf("processed: waiting_buffer[%u] =", waiting_buffer_tail);
  155.             debug_record(waiting_buffer[waiting_buffer_tail]);
  156.             ac_dprintf("\n\n");
  157.         } else {
  158.             break;
  159.         }
  160.     }
  161.     if (IS_EVENT(record.event)) {
  162.         ac_dprintf("\n");
  163.     } else {
  164. #    ifdef FLOW_TAP_TERM
  165.         if (!flow_tap_expired && TIMER_DIFF_16(record.event.time, flow_tap_prev_time) >= INT16_MAX / 2) {
  166.             flow_tap_expired = true;
  167.         }
  168. #    endif // FLOW_TAP_TERM
  169.     }
  170. }
  172. /* Some conditionally defined helper macros to keep process_tapping more
  173.  * readable. The conditional definition of tapping_keycode and all the
  174.  * conditional uses of it are hidden inside macros named TAP_...
  175.  */
  176. #    define TAP_DEFINE_KEYCODE const uint16_t tapping_keycode = get_record_keycode(&tapping_key, false)
  178. #    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)
  179. #        ifdef RETRO_TAPPING_PER_KEY
  180. #            define TAP_GET_RETRO_TAPPING(keyp) get_auto_shifted_key(tapping_keycode, keyp) && get_retro_tapping(tapping_keycode, &tapping_key)
  181. #        else
  182. #            define TAP_GET_RETRO_TAPPING(keyp) get_auto_shifted_key(tapping_keycode, keyp)
  183. #        endif
  184. /* Used to extend TAPPING_TERM:
  185.  *     indefinitely if RETRO_SHIFT does not have a value
  186.  *     to RETRO_SHIFT if RETRO_SHIFT is set
  187.  * for possibly retro shifted keys.
  188.  */
  189. #        define MAYBE_RETRO_SHIFTING(ev, keyp) (get_auto_shifted_key(tapping_keycode, keyp) && TAP_GET_RETRO_TAPPING(keyp) && ((RETRO_SHIFT + 0) == 0 || TIMER_DIFF_16((ev).time, tapping_key.event.time) < (RETRO_SHIFT + 0)))
  190. #        define TAP_IS_LT IS_QK_LAYER_TAP(tapping_keycode)
  191. #        define TAP_IS_MT IS_QK_MOD_TAP(tapping_keycode)
  192. #        define TAP_IS_RETRO IS_RETRO(tapping_keycode)
  193. #    else
  194. #        define TAP_GET_RETRO_TAPPING(keyp) false
  195. #        define MAYBE_RETRO_SHIFTING(ev, kp) false
  196. #        define TAP_IS_LT false
  197. #        define TAP_IS_MT false
  198. #        define TAP_IS_RETRO false
  199. #    endif
  201. #    ifdef PERMISSIVE_HOLD_PER_KEY
  202. #        define TAP_GET_PERMISSIVE_HOLD get_permissive_hold(tapping_keycode, &tapping_key)
  203. #    elif defined(PERMISSIVE_HOLD)
  204. #        define TAP_GET_PERMISSIVE_HOLD true
  205. #    else
  206. #        define TAP_GET_PERMISSIVE_HOLD false
  207. #    endif
  209. #    ifdef HOLD_ON_OTHER_KEY_PRESS_PER_KEY
  210. #        define TAP_GET_HOLD_ON_OTHER_KEY_PRESS get_hold_on_other_key_press(tapping_keycode, &tapping_key)
  211. #    elif defined(HOLD_ON_OTHER_KEY_PRESS)
  212. #        define TAP_GET_HOLD_ON_OTHER_KEY_PRESS true
  213. #    else
  214. #        define TAP_GET_HOLD_ON_OTHER_KEY_PRESS false
  215. #    endif
  217. /** \brief Tapping
  218.  *
  219.  * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
  220.  *       (without interfering by typing other key)
  221.  */
  222. /* return true when key event is processed or consumed. */
  223. bool process_tapping(keyrecord_t *keyp) {
  224.     const keyevent_t event = keyp->event;
  226. #    if defined(CHORDAL_HOLD) || defined(FLOW_TAP_TERM)
  227.     if (!event.pressed) {
  228.         const int8_t i = registered_tap_find(event.key);
  229.         if (i != -1) {
  230.             // If a tap-hold key was previously settled as tapped, set its
  231.             // tap.count correspondingly on release.
  232.             keyp->tap.count = 1;
  233.             registered_taps_del_index(i);
  234.             ac_dprintf("Found tap release for [%d]\n", i);
  235.             debug_registered_taps();
  236.         }
  237.     }
  238. #    endif // defined(CHORDAL_HOLD) || defined(FLOW_TAP_TERM)
  240.     // state machine is in the "reset" state, no tapping key is to be
  241.     // processed
  242.     if (IS_NOEVENT(tapping_key.event)) {
  243.         if (!IS_EVENT(event)) {
  244.             // early return for tick events
  245.         } else if (event.pressed && is_tap_record(keyp)) {
  246.             // the currently pressed key is a tapping key, therefore transition
  247.             // into the "pressed" tapping key state
  249. #    if defined(FLOW_TAP_TERM)
  250.             if (flow_tap_key_if_within_term(keyp, flow_tap_prev_time)) {
  251.                 return true;
  252.             }
  253. #    endif // defined(FLOW_TAP_TERM)
  255.             ac_dprintf("Tapping: Start(Press tap key).\n");
  256.             tapping_key = *keyp;
  257.             process_record_tap_hint(&tapping_key);
  258.             waiting_buffer_scan_tap();
  259.             debug_tapping_key();
  260.         } else {
  261.             // the current key is just a regular key, pass it on for regular
  262.             // processing
  263.             process_record(keyp);
  264.         }
  266.         return true;
  267.     }
  269. #    if (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)) || defined(PERMISSIVE_HOLD_PER_KEY) || defined(CHORDAL_HOLD) || defined(HOLD_ON_OTHER_KEY_PRESS_PER_KEY)
  270.     TAP_DEFINE_KEYCODE;
  271. #    endif
  273.     // process "pressed" tapping key state
  274.     if (tapping_key.event.pressed) {
  275.         if (WITHIN_TAPPING_TERM(event) || MAYBE_RETRO_SHIFTING(event, keyp)) {
  276.             if (IS_NOEVENT(event)) {
  277.                 // early return for tick events
  278.                 return true;
  279.             }
  281.             if (tapping_key.tap.count == 0) {
  282.                 if (IS_TAPPING_RECORD(keyp) && !event.pressed) {
  283.                     // first tap!
  284.                     ac_dprintf("Tapping: First tap(0->1).\n");
  285.                     tapping_key.tap.count = 1;
  286.                     debug_tapping_key();
  287.                     process_record(&tapping_key);
  289.                     // copy tapping state
  290.                     keyp->tap = tapping_key.tap;
  292. #    if defined(FLOW_TAP_TERM)
  293.                     // Now that tapping_key has settled as tapped, check whether
  294.                     // Flow Tap applies to following yet-unsettled keys.
  295.                     uint16_t prev_time = tapping_key.event.time;
  296.                     for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
  297.                         keyrecord_t *record = &waiting_buffer[waiting_buffer_tail];
  298.                         if (!record->event.pressed) {
  299.                             break;
  300.                         }
  301.                         const int16_t next_time = record->event.time;
  302.                         if (!is_tap_record(record)) {
  303.                             process_record(record);
  304.                         } else if (!flow_tap_key_if_within_term(record, prev_time)) {
  305.                             break;
  306.                         }
  307.                         prev_time = next_time;
  308.                     }
  309.                     debug_waiting_buffer();
  310. #    endif // defined(FLOW_TAP_TERM)
  312.                     // enqueue
  313.                     return false;
  314.                 }
  315. #    if defined(CHORDAL_HOLD)
  316.                 else if (is_mt_or_lt(tapping_keycode) && !event.pressed && waiting_buffer_typed(event) && !get_chordal_hold(tapping_keycode, &tapping_key, get_record_keycode(keyp, false), keyp)) {
  317.                     // Key release that is not a chord with the tapping key.
  318.                     // Settle the tapping key and any other pending tap-hold
  319.                     // keys preceding the press of this key as tapped.
  321.                     ac_dprintf("Tapping: End. Chord considered a tap\n");
  322.                     tapping_key.tap.count = 1;
  323.                     registered_taps_add(tapping_key.event.key);
  324.                     process_record(&tapping_key);
  325.                     tapping_key = (keyrecord_t){0};
  327.                     waiting_buffer_chordal_hold_taps_until(event.key);
  328.                     debug_registered_taps();
  329.                     debug_waiting_buffer();
  330.                     // enqueue
  331.                     return false;
  332.                 }
  333. #    endif      // CHORDAL_HOLD
  334.                 /* Process a key typed within TAPPING_TERM
  335.                  * This can register the key before settlement of tapping,
  336.                  * useful for long TAPPING_TERM but may prevent fast typing.
  337.                  */
  338.                 // clang-format off
  339.                 else if (
  340.                     !event.pressed && waiting_buffer_typed(event) &&
  341.                     (
  342.                         TAP_GET_PERMISSIVE_HOLD ||
  343.                         // Causes nested taps to not wait past TAPPING_TERM/RETRO_SHIFT
  344.                         // unnecessarily and fixes them for Layer Taps.
  345.                         TAP_GET_RETRO_TAPPING(keyp)
  346.                     )
  347.                 ) {
  348.                     // clang-format on
  349.                     ac_dprintf("Tapping: End. No tap. Interfered by typing key\n");
  350.                     process_record(&tapping_key);
  352. #    if defined(CHORDAL_HOLD)
  353.                     uint8_t first_tap = waiting_buffer_find_chordal_hold_tap();
  354.                     ac_dprintf("first_tap = %u\n", first_tap);
  355.                     if (first_tap < WAITING_BUFFER_SIZE) {
  356.                         for (; waiting_buffer_tail != first_tap; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
  357.                             ac_dprintf("Processing [%u]\n", waiting_buffer_tail);
  358.                             process_record(&waiting_buffer[waiting_buffer_tail]);
  359.                         }
  360.                     }
  362.                     waiting_buffer_chordal_hold_taps_until(event.key);
  363.                     debug_registered_taps();
  364.                     debug_waiting_buffer();
  365. #    endif // CHORDAL_HOLD
  367.                     tapping_key = (keyrecord_t){0};
  368.                     debug_tapping_key();
  369.                     // enqueue
  370.                     return false;
  371.                 }
  372.                 /* Process release event of a key pressed before tapping starts
  373.                  * Without this unexpected repeating will occur with having fast repeating setting
  374.                  * https://github.com/tmk/tmk_keyboard/issues/60
  375.                  *
  376.                  * NOTE: This workaround causes events to process out of order,
  377.                  * e.g. in a rolled press of three tap-hold keys like
  378.                  *
  379.                  *   "A down, B down, C down, A up, B up, C up"
  380.                  *
  381.                  * events are processed as
  382.                  *
  383.                  *   "A down, B down, A up, B up, C down, C up"
  384.                  *
  385.                  * It seems incorrect to process keyp before the tapping key.
  386.                  * This workaround is old, from 2013. This might no longer
  387.                  * be needed for the original problem it was meant to address.
  388.                  */
  389.                 else if (!event.pressed && !waiting_buffer_typed(event)) {
  390.                     // Modifier/Layer should be retained till end of this tapping.
  391.                     action_t action = layer_switch_get_action(event.key);
  392.                     switch (action.kind.id) {
  393.                         case ACT_LMODS:
  394.                         case ACT_RMODS:
  395.                             if (action.key.mods && !action.key.code) return false;
  396.                             if (IS_MODIFIER_KEYCODE(action.key.code)) return false;
  397.                             break;
  398.                         case ACT_LMODS_TAP:
  399.                         case ACT_RMODS_TAP:
  400.                             if (action.key.mods && keyp->tap.count == 0) return false;
  401.                             if (IS_MODIFIER_KEYCODE(action.key.code)) return false;
  402.                             break;
  403.                         case ACT_LAYER_TAP:
  404.                         case ACT_LAYER_TAP_EXT:
  405.                             switch (action.layer_tap.code) {
  406.                                 case 0 ...(OP_TAP_TOGGLE - 1):
  407.                                 case OP_ON_OFF:
  408.                                 case OP_OFF_ON:
  409.                                 case OP_SET_CLEAR:
  410.                                     return false;
  411.                             }
  412.                             break;
  413.                     }
  414.                     // Release of key should be process immediately.
  415.                     ac_dprintf("Tapping: release event of a key pressed before tapping\n");
  416.                     process_record(keyp);
  417.                     return true;
  418.                 } else {
  419.                     // set interrupted flag when other key pressed during tapping
  420.                     if (event.pressed) {
  421.                         tapping_key.tap.interrupted = true;
  423. #    if defined(CHORDAL_HOLD)
  424.                         if (is_mt_or_lt(tapping_keycode) && !get_chordal_hold(tapping_keycode, &tapping_key, get_record_keycode(keyp, false), keyp)) {
  425.                             // In process_action(), HOLD_ON_OTHER_KEY_PRESS
  426.                             // will revert interrupted events to holds, so
  427.                             // this needs to be set false.
  428.                             tapping_key.tap.interrupted = false;
  430.                             if (!is_tap_record(keyp)) {
  431.                                 ac_dprintf("Tapping: End. Chord considered a tap\n");
  432.                                 tapping_key.tap.count = 1;
  433.                                 registered_taps_add(tapping_key.event.key);
  434.                                 debug_registered_taps();
  435.                                 process_record(&tapping_key);
  436.                                 tapping_key = (keyrecord_t){0};
  437.                             }
  438.                         } else
  439. #    endif // CHORDAL_HOLD
  440.                             if (TAP_GET_HOLD_ON_OTHER_KEY_PRESS
  441. #    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)
  442.                                 // Auto Shift cannot evaluate this early
  443.                                 // Retro Shift uses the hold action for all nested taps even without HOLD_ON_OTHER_KEY_PRESS, so this is fine to skip
  444.                                 && !(MAYBE_RETRO_SHIFTING(event, keyp) && get_auto_shifted_key(get_record_keycode(keyp, false), keyp))
  445. #    endif
  446.                             ) {
  447.                             // Settle the tapping key as *held*, since
  448.                             // HOLD_ON_OTHER_KEY_PRESS is enabled for this key.
  449.                             ac_dprintf("Tapping: End. No tap. Interfered by pressed key\n");
  450.                             process_record(&tapping_key);
  452. #    if defined(CHORDAL_HOLD)
  453.                             if (waiting_buffer_tail != waiting_buffer_head && is_tap_record(&waiting_buffer[waiting_buffer_tail])) {
  454.                                 tapping_key = waiting_buffer[waiting_buffer_tail];
  455.                                 // Pop tail from the queue.
  456.                                 waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE;
  457.                                 debug_waiting_buffer();
  458.                             } else
  459. #    endif // CHORDAL_HOLD
  460.                             {
  461.                                 tapping_key = (keyrecord_t){0};
  462.                             }
  463.                             debug_tapping_key();
  465. #    if defined(CHORDAL_HOLD)
  466.                             waiting_buffer_process_regular();
  467. #    endif // CHORDAL_HOLD
  468.                         }
  469.                     }
  470.                     // enqueue
  471.                     return false;
  472.                 }
  473.             }
  474.             // tap_count > 0
  475.             else {
  476.                 if (IS_TAPPING_RECORD(keyp) && !event.pressed) {
  477.                     ac_dprintf("Tapping: Tap release(%u)\n", tapping_key.tap.count);
  478.                     keyp->tap = tapping_key.tap;
  479.                     process_record(keyp);
  480.                     tapping_key = *keyp;
  481.                     debug_tapping_key();
  482.                     return true;
  483.                 } else if (is_tap_record(keyp) && event.pressed) {
  484.                     if (tapping_key.tap.count > 1) {
  485.                         ac_dprintf("Tapping: Start new tap with releasing last tap(>1).\n");
  486.                         // unregister key
  487.                         process_record(&(keyrecord_t){
  488.                             .tap           = tapping_key.tap,
  489.                             .event.key     = tapping_key.event.key,
  490.                             .event.time    = event.time,
  491.                             .event.pressed = false,
  492.                             .event.type    = tapping_key.event.type,
  493. #    ifdef COMBO_ENABLE
  494.                             .keycode = tapping_key.keycode,
  495. #    endif
  496.                         });
  497.                     } else {
  498.                         ac_dprintf("Tapping: Start while last tap(1).\n");
  499.                     }
  500.                     tapping_key = *keyp;
  501.                     waiting_buffer_scan_tap();
  502.                     debug_tapping_key();
  503.                     return true;
  504.                 } else {
  505.                     ac_dprintf("Tapping: key event while last tap(>0).\n");
  506. #    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)
  507.                     retroshift_swap_times();
  508. #    endif
  509.                     process_record(keyp);
  510.                     return true;
  511.                 }
  512.             }
  513.         }
  514.         // after TAPPING_TERM
  515.         else {
  516.             if (tapping_key.tap.count == 0) {
  517.                 ac_dprintf("Tapping: End. Timeout. Not tap(0): ");
  518.                 debug_event(event);
  519.                 ac_dprintf("\n");
  520.                 process_record(&tapping_key);
  521.                 tapping_key = (keyrecord_t){0};
  522.                 debug_tapping_key();
  523.                 return false;
  524.             } else {
  525.                 if (IS_NOEVENT(event)) {
  526.                     return true;
  527.                 }
  528.                 if (IS_TAPPING_RECORD(keyp) && !event.pressed) {
  529.                     ac_dprintf("Tapping: End. last timeout tap release(>0).");
  530.                     keyp->tap = tapping_key.tap;
  531.                     process_record(keyp);
  532.                     tapping_key = (keyrecord_t){0};
  533.                     return true;
  534.                 } else if (is_tap_record(keyp) && event.pressed) {
  535.                     if (tapping_key.tap.count > 1) {
  536.                         ac_dprintf("Tapping: Start new tap with releasing last timeout tap(>1).\n");
  537.                         // unregister key
  538.                         process_record(&(keyrecord_t){
  539.                             .tap           = tapping_key.tap,
  540.                             .event.key     = tapping_key.event.key,
  541.                             .event.time    = event.time,
  542.                             .event.pressed = false,
  543.                             .event.type    = tapping_key.event.type,
  544. #    ifdef COMBO_ENABLE
  545.                             .keycode = tapping_key.keycode,
  546. #    endif
  547.                         });
  548.                     } else {
  549.                         ac_dprintf("Tapping: Start while last timeout tap(1).\n");
  550.                     }
  551.                     tapping_key = *keyp;
  552.                     waiting_buffer_scan_tap();
  553.                     debug_tapping_key();
  554.                     return true;
  555.                 } else {
  556.                     ac_dprintf("Tapping: key event while last timeout tap(>0).\n");
  557.                     process_record(keyp);
  558.                     return true;
  559.                 }
  560.             }
  561.         }
  562.     }
  563.     // process "released" tapping key state
  564.     else {
  565.         if (WITHIN_TAPPING_TERM(event) || MAYBE_RETRO_SHIFTING(event, keyp)) {
  566.             if (IS_NOEVENT(event)) {
  567.                 // early return for tick events
  568.                 return true;
  569.             }
  570.             if (event.pressed) {
  571.                 if (IS_TAPPING_RECORD(keyp)) {
  572.                     if (WITHIN_QUICK_TAP_TERM(event) && !tapping_key.tap.interrupted && tapping_key.tap.count > 0) {
  573.                         // sequential tap.
  574.                         keyp->tap = tapping_key.tap;
  575.                         if (keyp->tap.count < 15) keyp->tap.count += 1;
  576.                         ac_dprintf("Tapping: Tap press(%u)\n", keyp->tap.count);
  577.                         process_record(keyp);
  578.                         tapping_key = *keyp;
  579.                         debug_tapping_key();
  580.                         return true;
  581.                     }
  582.                     // FIX: start new tap again
  583.                     tapping_key = *keyp;
  584.                     return true;
  585.                 } else if (is_tap_record(keyp)) {
  586.                     // Sequential tap can be interfered with other tap key.
  587. #    if defined(FLOW_TAP_TERM)
  588.                     if (flow_tap_key_if_within_term(keyp, flow_tap_prev_time)) {
  589.                         tapping_key = (keyrecord_t){0};
  590.                         debug_tapping_key();
  591.                         return true;
  592.                     }
  593. #    endif // defined(FLOW_TAP_TERM)
  594.                     ac_dprintf("Tapping: Start with interfering other tap.\n");
  595.                     tapping_key = *keyp;
  596.                     waiting_buffer_scan_tap();
  597.                     debug_tapping_key();
  598.                     return true;
  599.                 } else {
  600.                     // should none in buffer
  601.                     // FIX: interrupted when other key is pressed
  602.                     tapping_key.tap.interrupted = true;
  603.                     process_record(keyp);
  604.                     return true;
  605.                 }
  606.             } else {
  607.                 ac_dprintf("Tapping: other key just after tap.\n");
  608.                 process_record(keyp);
  609.                 return true;
  610.             }
  611.         } else {
  612.             // Timeout - reset state machine.
  613.             ac_dprintf("Tapping: End(Timeout after releasing last tap): ");
  614.             debug_event(event);
  615.             ac_dprintf("\n");
  616.             tapping_key = (keyrecord_t){0};
  617.             debug_tapping_key();
  618.             return false;
  619.         }
  620.     }
  621. }
  623. /** \brief Waiting buffer enq
  624.  *
  625.  * FIXME: Needs docs
  626.  */
  627. bool waiting_buffer_enq(keyrecord_t record) {
  628.     if (IS_NOEVENT(record.event)) {
  629.         return true;
  630.     }
  632.     if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) {
  633.         ac_dprintf("waiting_buffer_enq: Over flow.\n");
  634.         return false;
  635.     }
  637.     waiting_buffer[waiting_buffer_head] = record;
  638.     waiting_buffer_head                 = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE;
  640.     ac_dprintf("waiting_buffer_enq: ");
  641.     debug_waiting_buffer();
  642.     return true;
  643. }
  645. /** \brief Waiting buffer clear
  646.  *
  647.  * FIXME: Needs docs
  648.  */
  649. void waiting_buffer_clear(void) {
  650.     waiting_buffer_head = 0;
  651.     waiting_buffer_tail = 0;
  652. }
  654. /** \brief Waiting buffer typed
  655.  *
  656.  * FIXME: Needs docs
  657.  */
  658. bool waiting_buffer_typed(keyevent_t event) {
  659.     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
  660.         if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed != waiting_buffer[i].event.pressed) {
  661.             return true;
  662.         }
  663.     }
  664.     return false;
  665. }
  667. /** \brief Waiting buffer has anykey pressed
  668.  *
  669.  * FIXME: Needs docs
  670.  */
  671. __attribute__((unused)) bool waiting_buffer_has_anykey_pressed(void) {
  672.     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
  673.         if (waiting_buffer[i].event.pressed) return true;
  674.     }
  675.     return false;
  676. }
  678. /** \brief Scan buffer for tapping
  679.  *
  680.  * FIXME: Needs docs
  681.  */
  682. void waiting_buffer_scan_tap(void) {
  683.     // early return if:
  684.     // - tapping already is settled
  685.     // - invalid state: tapping_key released && tap.count == 0
  686.     if ((tapping_key.tap.count > 0) || !tapping_key.event.pressed) {
  687.         return;
  688.     }
  690. #    if (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT))
  691.     TAP_DEFINE_KEYCODE;
  692. #    endif
  693.     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
  694.         keyrecord_t *candidate = &waiting_buffer[i];
  695.         // clang-format off
  696.         if (IS_EVENT(candidate->event) && KEYEQ(candidate->event.key, tapping_key.event.key) && !candidate->event.pressed && (
  697.             WITHIN_TAPPING_TERM(waiting_buffer[i].event) || MAYBE_RETRO_SHIFTING(waiting_buffer[i].event, &tapping_key)
  698.         )) {
  699.             // clang-format on
  700.             tapping_key.tap.count = 1;
  701.             candidate->tap.count  = 1;
  702.             process_record(&tapping_key);
  704.             ac_dprintf("waiting_buffer_scan_tap: found at [%u]\n", i);
  705.             debug_waiting_buffer();
  706.             return;
  707.         }
  708.     }
  709. }
  711. #    if defined(CHORDAL_HOLD) || defined(FLOW_TAP_TERM)
  712. static void registered_taps_add(keypos_t key) {
  713.     if (num_registered_taps >= REGISTERED_TAPS_SIZE) {
  714.         ac_dprintf("TAPS OVERFLOW: CLEAR ALL STATES\n");
  715.         clear_keyboard();
  716.         num_registered_taps = 0;
  717.     }
  719.     registered_taps[num_registered_taps] = key;
  720.     ++num_registered_taps;
  721. }
  723. static int8_t registered_tap_find(keypos_t key) {
  724.     for (int8_t i = 0; i < num_registered_taps; ++i) {
  725.         if (KEYEQ(registered_taps[i], key)) {
  726.             return i;
  727.         }
  728.     }
  729.     return -1;
  730. }
  732. static void registered_taps_del_index(uint8_t i) {
  733.     if (i < num_registered_taps) {
  734.         --num_registered_taps;
  735.         if (i < num_registered_taps) {
  736.             registered_taps[i] = registered_taps[num_registered_taps];
  737.         }
  738.     }
  739. }
  741. static void debug_registered_taps(void) {
  742.     ac_dprintf("registered_taps = { ");
  743.     for (int8_t i = 0; i < num_registered_taps; ++i) {
  744.         ac_dprintf("%02X%02X ", registered_taps[i].row, registered_taps[i].col);
  745.     }
  746.     ac_dprintf("}\n");
  747. }
  749. #    endif // defined(CHORDAL_HOLD) || defined(FLOW_TAP_TERM)
  751. #    ifdef CHORDAL_HOLD
  752. __attribute__((weak)) bool get_chordal_hold(uint16_t tap_hold_keycode, keyrecord_t *tap_hold_record, uint16_t other_keycode, keyrecord_t *other_record) {
  753.     return get_chordal_hold_default(tap_hold_record, other_record);
  754. }
  756. bool get_chordal_hold_default(keyrecord_t *tap_hold_record, keyrecord_t *other_record) {
  757.     if (tap_hold_record->event.type != KEY_EVENT || other_record->event.type != KEY_EVENT) {
  758.         return true; // Return true on combos or other non-key events.
  759.     }
  761.     char tap_hold_hand = chordal_hold_handedness(tap_hold_record->event.key);
  762.     if (tap_hold_hand == '*') {
  763.         return true;
  764.     }
  765.     char other_hand = chordal_hold_handedness(other_record->event.key);
  766.     return other_hand == '*' || tap_hold_hand != other_hand;
  767. }
  769. __attribute__((weak)) char chordal_hold_handedness(keypos_t key) {
  770.     return (char)pgm_read_byte(&chordal_hold_layout[key.row][key.col]);
  771. }
  773. static uint8_t waiting_buffer_find_chordal_hold_tap(void) {
  774.     keyrecord_t *prev         = &tapping_key;
  775.     uint16_t     prev_keycode = get_record_keycode(&tapping_key, false);
  776.     uint8_t      first_tap    = WAITING_BUFFER_SIZE;
  777.     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
  778.         keyrecord_t *  cur         = &waiting_buffer[i];
  779.         const uint16_t cur_keycode = get_record_keycode(cur, false);
  780.         if (!cur->event.pressed || !is_mt_or_lt(prev_keycode)) {
  781.             break;
  782.         } else if (get_chordal_hold(prev_keycode, prev, cur_keycode, cur)) {
  783.             first_tap = i; // Track one index past the latest hold.
  784.         }
  785.         prev         = cur;
  786.         prev_keycode = cur_keycode;
  787.     }
  788.     return first_tap;
  789. }
  791. static void waiting_buffer_chordal_hold_taps_until(keypos_t key) {
  792.     while (waiting_buffer_tail != waiting_buffer_head) {
  793.         keyrecord_t *record = &waiting_buffer[waiting_buffer_tail];
  794.         ac_dprintf("waiting_buffer_chordal_hold_taps_until: processing [%u]\n", waiting_buffer_tail);
  795.         if (record->event.pressed && is_tap_record(record)) {
  796.             record->tap.count = 1;
  797.             registered_taps_add(record->event.key);
  798.         }
  799.         process_record(record);
  800.         waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE;
  802.         if (KEYEQ(key, record->event.key) && record->event.pressed) {
  803.             break;
  804.         }
  805.     }
  806. }
  808. static void waiting_buffer_process_regular(void) {
  809.     for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
  810.         if (is_tap_record(&waiting_buffer[waiting_buffer_tail])) {
  811.             break; // Stop once a tap-hold key event is reached.
  812.         }
  813.         ac_dprintf("waiting_buffer_process_regular: processing [%u]\n", waiting_buffer_tail);
  814.         process_record(&waiting_buffer[waiting_buffer_tail]);
  815.     }
  816.     debug_waiting_buffer();
  817. }
  818. #    endif // CHORDAL_HOLD
  820. #    ifdef FLOW_TAP_TERM
  821. void flow_tap_update_last_event(keyrecord_t *record) {
  822.     const uint16_t keycode = get_record_keycode(record, false);
  823.     // Don't update while a tap-hold key is unsettled.
  824.     if (record->tap.count == 0 && (waiting_buffer_tail != waiting_buffer_head || (tapping_key.event.pressed && tapping_key.tap.count == 0))) {
  825.         return;
  826.     }
  827.     // Ignore releases of modifiers and held layer switches.
  828.     if (!record->event.pressed) {
  829.         switch (keycode) {
  830.             case MODIFIER_KEYCODE_RANGE:
  831.             case QK_MOMENTARY ... QK_MOMENTARY_MAX:
  832.             case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX:
  833. #        ifndef NO_ACTION_ONESHOT // Ignore one-shot keys.
  834.             case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX:
  835.             case QK_ONE_SHOT_LAYER ... QK_ONE_SHOT_LAYER_MAX:
  836. #        endif                  // NO_ACTION_ONESHOT
  837. #        ifdef TRI_LAYER_ENABLE // Ignore Tri Layer keys.
  838.             case QK_TRI_LAYER_LOWER:
  839.             case QK_TRI_LAYER_UPPER:
  840. #        endif // TRI_LAYER_ENABLE
  841.                 return;
  842.             case QK_MODS ... QK_MODS_MAX:
  843.                 if (QK_MODS_GET_BASIC_KEYCODE(keycode) == KC_NO) {
  844.                     return;
  845.                 }
  846.                 break;
  847.             case QK_MOD_TAP ... QK_MOD_TAP_MAX:
  848.             case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
  849.                 if (record->tap.count == 0) {
  850.                     return;
  851.                 }
  852.                 break;
  853.         }
  854.     }
  856.     flow_tap_prev_keycode = keycode;
  857.     flow_tap_prev_time    = record->event.time;
  858.     flow_tap_expired      = false;
  859. }
  861. static bool flow_tap_key_if_within_term(keyrecord_t *record, uint16_t prev_time) {
  862.     const uint16_t idle_time = TIMER_DIFF_16(record->event.time, prev_time);
  863.     if (flow_tap_expired || idle_time >= 500) {
  864.         return false;
  865.     }
  867.     const uint16_t keycode = get_record_keycode(record, false);
  868.     if (is_mt_or_lt(keycode)) {
  869.         uint16_t term = get_flow_tap_term(keycode, record, flow_tap_prev_keycode);
  870.         if (term > 500) {
  871.             term = 500;
  872.         }
  873.         if (idle_time < term) {
  874.             debug_event(record->event);
  875.             ac_dprintf(" within flow tap term (%u < %u) considered a tap\n", idle_time, term);
  876.             record->tap.count = 1;
  877.             registered_taps_add(record->event.key);
  878.             debug_registered_taps();
  879.             process_record(record);
  880.             return true;
  881.         }
  882.     }
  883.     return false;
  884. }
  886. // By default, enable Flow Tap for the keys in the main alphas area and Space.
  887. // This should work reasonably even if the layout is remapped on the host to an
  888. // alt layout or international layout (e.g. Dvorak or AZERTY), where these same
  889. // key positions are mostly used for typing letters.
  890. __attribute__((weak)) bool is_flow_tap_key(uint16_t keycode) {
  891.     if ((get_mods() & (MOD_MASK_CG | MOD_BIT_LALT)) != 0) {
  892.         return false; // Disable Flow Tap on hotkeys.
  893.     }
  894.     switch (get_tap_keycode(keycode)) {
  895.         case KC_SPC:
  896.         case KC_A ... KC_Z:
  897.         case KC_DOT:
  898.         case KC_COMM:
  899.         case KC_SCLN:
  900.         case KC_SLSH:
  901.             return true;
  902.     }
  903.     return false;
  904. }
  906. __attribute__((weak)) uint16_t get_flow_tap_term(uint16_t keycode, keyrecord_t *record, uint16_t prev_keycode) {
  907.     if (is_flow_tap_key(keycode) && is_flow_tap_key(prev_keycode)) {
  908.         return FLOW_TAP_TERM;
  909.     }
  910.     return 0;
  911. }
  912. #    endif // FLOW_TAP_TERM
  914. /** \brief Logs tapping key if ACTION_DEBUG is enabled. */
  915. static void debug_tapping_key(void) {
  916.     ac_dprintf("TAPPING_KEY=");
  917.     debug_record(tapping_key);
  918.     ac_dprintf("\n");
  919. }
  921. /** \brief Logs waiting buffer if ACTION_DEBUG is enabled. */
  922. static void debug_waiting_buffer(void) {
  923.     ac_dprintf("{");
  924.     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
  925.         ac_dprintf(" [%u]=", i);
  926.         debug_record(waiting_buffer[i]);
  927.     }
  928.     ac_dprintf("}\n");
  929. }
  931. #endif