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