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   uint8_t oneshot_mods;
  13   uint16_t keycode;
  14   uint16_t timer;
  15   bool interrupted;
  16   bool pressed;
  17   bool finished;
  18 } qk_tap_dance_state_t;
  19
  20 #define TD(n) (QK_TAP_DANCE + n)
  21
  22 typedef void (*qk_tap_dance_user_fn_t) (qk_tap_dance_state_t *state, void *user_data);
  23
  24 typedef struct
  25 {
  26   struct {
  27     qk_tap_dance_user_fn_t on_each_tap;
  28     qk_tap_dance_user_fn_t on_dance_finished;
  29     qk_tap_dance_user_fn_t on_reset;
  30   } fn;
  31   qk_tap_dance_state_t state;
  32   void *user_data;
  33 } qk_tap_dance_action_t;
  34
  35 typedef struct
  36 {
  37   uint16_t kc1;
  38   uint16_t kc2;
  39 } qk_tap_dance_pair_t;
  40
  41 #define ACTION_TAP_DANCE_DOUBLE(kc1, kc2) { \
  42     .fn = { NULL, qk_tap_dance_pair_finished, qk_tap_dance_pair_reset }, \
  43     .user_data = (void *)&((qk_tap_dance_pair_t) { kc1, kc2 }),  \
  44   }
  45
  46 #define ACTION_TAP_DANCE_FN(user_fn) {  \
  47     .fn = { NULL, user_fn, NULL }, \
  48     .user_data = NULL, \
  49   }
  50
  51 #define ACTION_TAP_DANCE_FN_ADVANCED(user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset) { \
  52     .fn = { user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset }, \
  53     .user_data = NULL, \
  54   }
  55
  56 extern qk_tap_dance_action_t tap_dance_actions[];
  57
  58 /* To be used internally */
  59
  60 bool process_tap_dance(uint16_t keycode, keyrecord_t *record);
  61 void matrix_scan_tap_dance (void);
  62 void reset_tap_dance (qk_tap_dance_state_t *state);
  63
  64 void qk_tap_dance_pair_finished (qk_tap_dance_state_t *state, void *user_data);
  65 void qk_tap_dance_pair_reset (qk_tap_dance_state_t *state, void *user_data);
  66
  67 #else
  68
  69 #define TD(n) KC_NO
  70
  71 #endif
  72
  73 #endif