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_finished (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 == 1) {
  28     register_code16 (pair->kc1);
  29   } else if (state->count == 2) {
  30     register_code16 (pair->kc2);
  31   }
  32 }
  33
  34 void qk_tap_dance_pair_reset (qk_tap_dance_state_t *state, void *user_data) {
  35   qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
  36
  37   if (state->count == 1) {
  38     unregister_code16 (pair->kc1);
  39   } else if (state->count == 2) {
  40     unregister_code16 (pair->kc2);
  41   }
  42 }
  43
  44 static inline void _process_tap_dance_action_fn (qk_tap_dance_state_t *state,
  45                                                  void *user_data,
  46                                                  qk_tap_dance_user_fn_t fn)
  47 {
  48   if (fn) {
  49     fn(state, user_data);
  50   }
  51 }
  52
  53 static inline void process_tap_dance_action_on_each_tap (qk_tap_dance_action_t *action)
  54 {
  55   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_each_tap);
  56 }
  57
  58 static inline void process_tap_dance_action_on_dance_finished (qk_tap_dance_action_t *action)
  59 {
  60   if (action->state.finished)
  61     return;
  62   action->state.finished = true;
  63   add_mods(action->state.oneshot_mods);
  64   send_keyboard_report();
  65   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_dance_finished);
  66 }
  67
  68 static inline void process_tap_dance_action_on_reset (qk_tap_dance_action_t *action)
  69 {
  70   _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_reset);
  71   del_mods(action->state.oneshot_mods);
  72   send_keyboard_report();
  73 }
  74
  75 bool process_tap_dance(uint16_t keycode, keyrecord_t *record) {
  76   uint16_t idx = keycode - QK_TAP_DANCE;
  77   qk_tap_dance_action_t *action;
  78
  79   if (last_td && last_td != keycode) {
  80     (&tap_dance_actions[last_td - QK_TAP_DANCE])->state.interrupted = true;
  81   }
  82
  83   switch(keycode) {
  84   case QK_TAP_DANCE ... QK_TAP_DANCE_MAX:
  85     if ((int16_t)idx > highest_td)
  86       highest_td = idx;
  87     action = &tap_dance_actions[idx];
  88
  89     action->state.pressed = record->event.pressed;
  90     if (record->event.pressed) {
  91       action->state.keycode = keycode;
  92       action->state.count++;
  93       action->state.timer = timer_read();
  94       action->state.oneshot_mods = get_oneshot_mods();
  95       process_tap_dance_action_on_each_tap (action);
  96
  97       if (last_td && last_td != keycode) {
  98         qk_tap_dance_action_t *paction = &tap_dance_actions[last_td - QK_TAP_DANCE];
  99         paction->state.interrupted = true;
 100         process_tap_dance_action_on_dance_finished (paction);
 101         reset_tap_dance (&paction->state);
 102       }
 103
 104       last_td = keycode;
 105     }
 106
 107     break;
 108
 109   default:
 110     if (!record->event.pressed)
 111       return true;
 112
 113     if (highest_td == -1)
 114       return true;
 115
 116     for (int i = 0; i <= highest_td; i++) {
 117       action = &tap_dance_actions[i];
 118       if (action->state.count == 0)
 119         continue;
 120       action->state.interrupted = true;
 121       process_tap_dance_action_on_dance_finished (action);
 122       reset_tap_dance (&action->state);
 123     }
 124     break;
 125   }
 126
 127   return true;
 128 }
 129
 130
 131
 132 void matrix_scan_tap_dance () {
 133   if (highest_td == -1)
 134     return;
 135   uint16_t tap_user_defined;
 136
 137 for (uint8_t i = 0; i <= highest_td; i++) {
 138     qk_tap_dance_action_t *action = &tap_dance_actions[i];
 139     if(action->custom_tapping_term > 0 ) {
 140       tap_user_defined = action->custom_tapping_term;
 141     }
 142     else{
 143       tap_user_defined = TAPPING_TERM;
 144     }
 145     if (action->state.count && timer_elapsed (action->state.timer) > tap_user_defined) {
 146       process_tap_dance_action_on_dance_finished (action);
 147       reset_tap_dance (&action->state);
 148     }
 149   }
 150 }
 151
 152 void reset_tap_dance (qk_tap_dance_state_t *state) {
 153   qk_tap_dance_action_t *action;
 154
 155   if (state->pressed)
 156     return;
 157
 158   action = &tap_dance_actions[state->keycode - QK_TAP_DANCE];
 159
 160   process_tap_dance_action_on_reset (action);
 161
 162   state->count = 0;
 163   state->interrupted = false;
 164   state->finished = false;
 165   last_td = 0;
 166 }