quantum/process_keycode/process_tap_dance.c

   1 /* Copyright 2016 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #include "quantum.h"
  17 #include "action_tapping.h"
  18
  19 uint8_t get_oneshot_mods(void);
  20
  21 static uint16_t last_td;
  22 static int8_t highest_td = -1;
  23
  24 void qk_tap_dance_pair_on_each_tap (qk_tap_dance_state_t *state, void *user_data) {
  25   qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
  26
  27   if (state->count == 2) {
  28     register_code16 (pair->kc2);
  29     state->finished = true;
  30   }
  31 }
  32
  33 void qk_tap_dance_pair_finished (qk_tap_dance_state_t *state, void *user_data) {
  34   qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
  35
  36   if (state->count == 1) {
  37     register_code16 (pair->kc1);
  38   } else if (state->count == 2) {
  39     register_code16 (pair->kc2);
  40   }
  41 }
  42
  43 void qk_tap_dance_pair_reset (qk_tap_dance_state_t *state, void *user_data) {
  44   qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
  45
  46   if (state->count == 1) {
  47     unregister_code16 (pair->kc1);
  48   } else if (state->count == 2) {
  49     unregister_code16 (pair->kc2);
  50   }
  51 }
  52
  53 void qk_tap_dance_dual_role_on_each_tap (qk_tap_dance_state_t *state, void *user_data) {
  54   qk_tap_dance_dual_role_t *pair = (qk_tap_dance_dual_role_t *)user_data;
  55
  56   if (state->count == 2) {
  57     layer_move (pair->layer);
  58     state->finished = true;
  59   }
  60 }
  61
  62 void qk_tap_dance_dual_role_finished (qk_tap_dance_state_t *state, void *user_data) {
  63   qk_tap_dance_dual_role_t *pair = (qk_tap_dance_dual_role_t *)user_data;
  64
  65   if (state->count == 1) {
  66     register_code16 (pair->kc);
  67   } else if (state->count == 2) {
  68     layer_move (pair->layer);
  69   }
  70 }
  71
  72 void qk_tap_dance_dual_role_reset (qk_tap_dance_state_t *state, void *user_data) {
  73   qk_tap_dance_dual_role_t *pair = (qk_tap_dance_dual_role_t *)user_data;
  74
  75   if (state->count == 1) {
  76     unregister_code16 (pair->kc);
  77   }
  78 }
  79
  80 static inline void _process_tap_dance_action_fn (qk_tap_dance_state_t *state,
  81                                                  void *user_data,
  82                                                  qk_tap_dance_user_fn_t fn)
  83 {
  84   if (fn) {
  85     fn(state, user_data);
  86   }
  87 }
  88
  89 static inline void process_tap_dance_action_on_each_tap (qk_tap_dance_action_t *action)
  90 {
  91   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_each_tap);
  92 }
  93
  94 static inline void process_tap_dance_action_on_dance_finished (qk_tap_dance_action_t *action)
  95 {
  96   if (action->state.finished)
  97     return;
  98   action->state.finished = true;
  99   add_mods(action->state.oneshot_mods);
 100   add_weak_mods(action->state.weak_mods);
 101   send_keyboard_report();
 102   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_dance_finished);
 103 }
 104
 105 static inline void process_tap_dance_action_on_reset (qk_tap_dance_action_t *action)
 106 {
 107   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_reset);
 108   del_mods(action->state.oneshot_mods);
 109   del_weak_mods(action->state.weak_mods);
 110   send_keyboard_report();
 111 }
 112
 113 void preprocess_tap_dance(uint16_t keycode, keyrecord_t *record) {
 114   qk_tap_dance_action_t *action;
 115
 116   if (!record->event.pressed)
 117     return;
 118
 119   if (highest_td == -1)
 120     return;
 121
 122   for (int i = 0; i <= highest_td; i++) {
 123     action = &tap_dance_actions[i];
 124     if (action->state.count) {
 125       if (keycode == action->state.keycode && keycode == last_td)
 126         continue;
 127       action->state.interrupted = true;
 128       process_tap_dance_action_on_dance_finished (action);
 129       reset_tap_dance (&action->state);
 130     }
 131   }
 132 }
 133
 134 bool process_tap_dance(uint16_t keycode, keyrecord_t *record) {
 135   uint16_t idx = keycode - QK_TAP_DANCE;
 136   qk_tap_dance_action_t *action;
 137
 138   switch(keycode) {
 139   case QK_TAP_DANCE ... QK_TAP_DANCE_MAX:
 140     if ((int16_t)idx > highest_td)
 141       highest_td = idx;
 142     action = &tap_dance_actions[idx];
 143
 144     action->state.pressed = record->event.pressed;
 145     if (record->event.pressed) {
 146       action->state.keycode = keycode;
 147       action->state.count++;
 148       action->state.timer = timer_read();
 149       action->state.oneshot_mods = get_oneshot_mods();
 150       action->state.weak_mods = get_mods();
 151       action->state.weak_mods |= get_weak_mods();
 152       process_tap_dance_action_on_each_tap (action);
 153
 154       last_td = keycode;
 155     } else {
 156       if (action->state.count && action->state.finished) {
 157         reset_tap_dance (&action->state);
 158       }
 159     }
 160
 161     break;
 162   }
 163
 164   return true;
 165 }
 166
 167
 168
 169 void matrix_scan_tap_dance () {
 170   if (highest_td == -1)
 171     return;
 172   uint16_t tap_user_defined;
 173
 174   for (uint8_t i = 0; i <= highest_td; i++) {
 175     qk_tap_dance_action_t *action = &tap_dance_actions[i];
 176     if(action->custom_tapping_term > 0 ) {
 177       tap_user_defined = action->custom_tapping_term;
 178     }
 179     else{
 180       tap_user_defined = TAPPING_TERM;
 181     }
 182     if (action->state.count && timer_elapsed (action->state.timer) > tap_user_defined) {
 183       process_tap_dance_action_on_dance_finished (action);
 184       reset_tap_dance (&action->state);
 185     }
 186   }
 187 }
 188
 189 void reset_tap_dance (qk_tap_dance_state_t *state) {
 190   qk_tap_dance_action_t *action;
 191
 192   if (state->pressed)
 193     return;
 194
 195   action = &tap_dance_actions[state->keycode - QK_TAP_DANCE];
 196
 197   process_tap_dance_action_on_reset (action);
 198
 199   state->count = 0;
 200   state->interrupted = false;
 201   state->finished = false;
 202   last_td = 0;
 203 }