logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

process_tap_dance.h (3693B)

    

  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.  */
  17. #pragma once
  19. #include <stdint.h>
  20. #include <stdbool.h>
  21. #include "action.h"
  22. #include "quantum_keycodes.h"
  24. typedef struct {
  25.     uint16_t interrupting_keycode;
  26.     uint8_t  count;
  27.     uint8_t  weak_mods;
  28. #ifndef NO_ACTION_ONESHOT
  29.     uint8_t oneshot_mods;
  30. #endif
  31.     bool pressed : 1;
  32.     bool finished : 1;
  33.     bool interrupted : 1;
  34. } tap_dance_state_t;
  36. typedef void (*tap_dance_user_fn_t)(tap_dance_state_t *state, void *user_data);
  38. typedef struct tap_dance_action_t {
  39.     tap_dance_state_t state;
  40.     struct {
  41.         tap_dance_user_fn_t on_each_tap;
  42.         tap_dance_user_fn_t on_dance_finished;
  43.         tap_dance_user_fn_t on_reset;
  44.         tap_dance_user_fn_t on_each_release;
  45.     } fn;
  46.     void *user_data;
  47. } tap_dance_action_t;
  49. typedef struct {
  50.     uint16_t kc1;
  51.     uint16_t kc2;
  52. } tap_dance_pair_t;
  54. typedef struct {
  55.     uint16_t kc;
  56.     uint8_t  layer;
  57.     void (*layer_function)(uint8_t);
  58. } tap_dance_dual_role_t;
  60. #define ACTION_TAP_DANCE_DOUBLE(kc1, kc2) \
  61.     { .fn = {tap_dance_pair_on_each_tap, tap_dance_pair_finished, tap_dance_pair_reset, NULL}, .user_data = (void *)&((tap_dance_pair_t){kc1, kc2}), }
  63. #define ACTION_TAP_DANCE_LAYER_MOVE(kc, layer) \
  64.     { .fn = {tap_dance_dual_role_on_each_tap, tap_dance_dual_role_finished, tap_dance_dual_role_reset, NULL}, .user_data = (void *)&((tap_dance_dual_role_t){kc, layer, layer_move}), }
  66. #define ACTION_TAP_DANCE_LAYER_TOGGLE(kc, layer) \
  67.     { .fn = {NULL, tap_dance_dual_role_finished, tap_dance_dual_role_reset, NULL}, .user_data = (void *)&((tap_dance_dual_role_t){kc, layer, layer_invert}), }
  69. #define ACTION_TAP_DANCE_FN(user_fn) \
  70.     { .fn = {NULL, user_fn, NULL, NULL}, .user_data = NULL, }
  72. #define ACTION_TAP_DANCE_FN_ADVANCED(user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset) \
  73.     { .fn = {user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset, NULL}, .user_data = NULL, }
  75. #define ACTION_TAP_DANCE_FN_ADVANCED_WITH_RELEASE(user_fn_on_each_tap, user_fn_on_each_release, user_fn_on_dance_finished, user_fn_on_dance_reset) \
  76.     { .fn = {user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset, user_fn_on_each_release}, .user_data = NULL, }
  78. #define TD_INDEX(code) QK_TAP_DANCE_GET_INDEX(code)
  79. #define TAP_DANCE_KEYCODE(state) TD(((tap_dance_action_t *)state) - tap_dance_actions)
  81. void reset_tap_dance(tap_dance_state_t *state);
  83. /* To be used internally */
  85. bool preprocess_tap_dance(uint16_t keycode, keyrecord_t *record);
  86. bool process_tap_dance(uint16_t keycode, keyrecord_t *record);
  87. void tap_dance_task(void);
  89. void tap_dance_pair_on_each_tap(tap_dance_state_t *state, void *user_data);
  90. void tap_dance_pair_finished(tap_dance_state_t *state, void *user_data);
  91. void tap_dance_pair_reset(tap_dance_state_t *state, void *user_data);
  93. void tap_dance_dual_role_on_each_tap(tap_dance_state_t *state, void *user_data);
  94. void tap_dance_dual_role_finished(tap_dance_state_t *state, void *user_data);
  95. void tap_dance_dual_role_reset(tap_dance_state_t *state, void *user_data);