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 #ifndef NO_ACTION_ONESHOT
  20 uint8_t get_oneshot_mods(void);
  21 #endif
  22
  23 static uint16_t last_td;
  24 static int8_t highest_td = -1;
  25
  26 void qk_tap_dance_pair_on_each_tap (qk_tap_dance_state_t *state, void *user_data) {
  27   qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
  28
  29   if (state->count == 2) {
  30     register_code16 (pair->kc2);
  31     state->finished = true;
  32   }
  33 }
  34
  35 void qk_tap_dance_pair_finished (qk_tap_dance_state_t *state, void *user_data) {
  36   qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
  37
  38   if (state->count == 1) {
  39     register_code16 (pair->kc1);
  40   } else if (state->count == 2) {
  41     register_code16 (pair->kc2);
  42   }
  43 }
  44
  45 void qk_tap_dance_pair_reset (qk_tap_dance_state_t *state, void *user_data) {
  46   qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
  47
  48   if (state->count == 1) {
  49     unregister_code16 (pair->kc1);
  50   } else if (state->count == 2) {
  51     unregister_code16 (pair->kc2);
  52   }
  53 }
  54
  55 void qk_tap_dance_dual_role_on_each_tap (qk_tap_dance_state_t *state, void *user_data) {
  56   qk_tap_dance_dual_role_t *pair = (qk_tap_dance_dual_role_t *)user_data;
  57
  58   if (state->count == 2) {
  59     layer_move (pair->layer);
  60     state->finished = true;
  61   }
  62 }
  63
  64 void qk_tap_dance_dual_role_finished (qk_tap_dance_state_t *state, void *user_data) {
  65   qk_tap_dance_dual_role_t *pair = (qk_tap_dance_dual_role_t *)user_data;
  66
  67   if (state->count == 1) {
  68     register_code16 (pair->kc);
  69   } else if (state->count == 2) {
  70     layer_move (pair->layer);
  71   }
  72 }
  73
  74 void qk_tap_dance_dual_role_reset (qk_tap_dance_state_t *state, void *user_data) {
  75   qk_tap_dance_dual_role_t *pair = (qk_tap_dance_dual_role_t *)user_data;
  76
  77   if (state->count == 1) {
  78     unregister_code16 (pair->kc);
  79   }
  80 }
  81
  82 static inline void _process_tap_dance_action_fn (qk_tap_dance_state_t *state,
  83                                                  void *user_data,
  84                                                  qk_tap_dance_user_fn_t fn)
  85 {
  86   if (fn) {
  87     fn(state, user_data);
  88   }
  89 }
  90
  91 static inline void process_tap_dance_action_on_each_tap (qk_tap_dance_action_t *action)
  92 {
  93   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_each_tap);
  94 }
  95
  96 static inline void process_tap_dance_action_on_dance_finished (qk_tap_dance_action_t *action)
  97 {
  98   if (action->state.finished)
  99     return;
 100   action->state.finished = true;
 101   add_mods(action->state.oneshot_mods);
 102   add_weak_mods(action->state.weak_mods);
 103   send_keyboard_report();
 104   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_dance_finished);
 105 }
 106
 107 static inline void process_tap_dance_action_on_reset (qk_tap_dance_action_t *action)
 108 {
 109   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_reset);
 110   del_mods(action->state.oneshot_mods);
 111   del_weak_mods(action->state.weak_mods);
 112   send_keyboard_report();
 113 }
 114
 115 void preprocess_tap_dance(uint16_t keycode, keyrecord_t *record) {
 116   qk_tap_dance_action_t *action;
 117
 118   if (!record->event.pressed)
 119     return;
 120
 121   if (highest_td == -1)
 122     return;
 123
 124   for (int i = 0; i <= highest_td; i++) {
 125     action = &tap_dance_actions[i];
 126     if (action->state.count) {
 127       if (keycode == action->state.keycode && keycode == last_td)
 128         continue;
 129       action->state.interrupted = true;
 130       process_tap_dance_action_on_dance_finished (action);
 131       reset_tap_dance (&action->state);
 132     }
 133   }
 134 }
 135
 136 bool process_tap_dance(uint16_t keycode, keyrecord_t *record) {
 137   uint16_t idx = keycode - QK_TAP_DANCE;
 138   qk_tap_dance_action_t *action;
 139
 140   switch(keycode) {
 141   case QK_TAP_DANCE ... QK_TAP_DANCE_MAX:
 142     if ((int16_t)idx > highest_td)
 143       highest_td = idx;
 144     action = &tap_dance_actions[idx];
 145
 146     action->state.pressed = record->event.pressed;
 147     if (record->event.pressed) {
 148       action->state.keycode = keycode;
 149       action->state.count++;
 150       action->state.timer = timer_read();
 151 #ifndef NO_ACTION_ONESHOT
 152       action->state.oneshot_mods = get_oneshot_mods();
 153 #else
 154       action->state.oneshot_mods = 0;
 155 #endif
 156       action->state.weak_mods = get_mods();
 157       action->state.weak_mods |= get_weak_mods();
 158       process_tap_dance_action_on_each_tap (action);
 159
 160       last_td = keycode;
 161     } else {
 162       if (action->state.count && action->state.finished) {
 163         reset_tap_dance (&action->state);
 164       }
 165     }
 166
 167     break;
 168   }
 169
 170   return true;
 171 }
 172
 173
 174
 175 void matrix_scan_tap_dance () {
 176   if (highest_td == -1)
 177     return;
 178   uint16_t tap_user_defined;
 179
 180   for (uint8_t i = 0; i <= highest_td; i++) {
 181     qk_tap_dance_action_t *action = &tap_dance_actions[i];
 182     if(action->custom_tapping_term > 0 ) {
 183       tap_user_defined = action->custom_tapping_term;
 184     }
 185     else{
 186       tap_user_defined = TAPPING_TERM;
 187     }
 188     if (action->state.count && timer_elapsed (action->state.timer) > tap_user_defined) {
 189       process_tap_dance_action_on_dance_finished (action);
 190       reset_tap_dance (&action->state);
 191     }
 192   }
 193 }
 194
 195 void reset_tap_dance (qk_tap_dance_state_t *state) {
 196   qk_tap_dance_action_t *action;
 197
 198   if (state->pressed)
 199     return;
 200
 201   action = &tap_dance_actions[state->keycode - QK_TAP_DANCE];
 202
 203   process_tap_dance_action_on_reset (action);
 204
 205   state->count = 0;
 206   state->interrupted = false;
 207   state->finished = false;
 208   last_td = 0;
 209 }