quantum/process_keycode/process_tap_dance.h

   1 #ifndef PROCESS_TAP_DANCE_H
   2 #define PROCESS_TAP_DANCE_H
   3
   4 #ifdef TAP_DANCE_ENABLE
   5
   6 #include <stdbool.h>
   7 #include <inttypes.h>
   8
   9 typedef struct
  10 {
  11   uint8_t count;
  12   uint16_t keycode;
  13   uint16_t timer;
  14   bool active:1;
  15   bool pressed:1;
  16 } qk_tap_dance_state_t;
  17
  18 #define TD(n) (QK_TAP_DANCE + n)
  19
  20 typedef void (*qk_tap_dance_user_fn_t) (qk_tap_dance_state_t *state, void *user_data);
  21
  22 typedef struct
  23 {
  24   struct {
  25     qk_tap_dance_user_fn_t on_each_tap;
  26     qk_tap_dance_user_fn_t on_dance_finished;
  27     qk_tap_dance_user_fn_t on_reset;
  28   } fn;
  29   void *user_data;
  30 } qk_tap_dance_action_t;
  31
  32 typedef struct
  33 {
  34   uint16_t kc1;
  35   uint16_t kc2;
  36 } qk_tap_dance_pair_t;
  37
  38 #define ACTION_TAP_DANCE_DOUBLE(kc1, kc2) { \
  39     .fn = { NULL, qk_tap_dance_pair_finished, qk_tap_dance_pair_reset }, \
  40     .user_data = (void *)&((qk_tap_dance_pair_t) { kc1, kc2 })  \
  41   }
  42
  43 #define ACTION_TAP_DANCE_FN(user_fn) {  \
  44     .fn = { NULL, user_fn, NULL } \
  45   }
  46
  47 #define ACTION_TAP_DANCE_FN_ADVANCED(user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_reset) { \
  48     .fn = { user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_reset } \
  49   }
  50
  51 extern const qk_tap_dance_action_t tap_dance_actions[];
  52 extern bool td_debug_enable;
  53
  54 /* To be used internally */
  55
  56 bool process_tap_dance(uint16_t keycode, keyrecord_t *record);
  57 void matrix_scan_tap_dance (void);
  58 void reset_tap_dance (qk_tap_dance_state_t *state);
  59
  60 void qk_tap_dance_pair_finished (qk_tap_dance_state_t *state, void *user_data);
  61 void qk_tap_dance_pair_reset (qk_tap_dance_state_t *state, void *user_data);
  62
  63 #else
  64
  65 #define TD(n) KC_NO
  66
  67 #endif
  68
  69 #endif