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