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