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