mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-27 13:40:14 +00:00
d28b2c395b
This adds the `ACTION_TAP_DANCE_DUAL_ROLE` helper, which makes it easy to have keys that act as a key on the first tap, and as a layer toggle on the second. Fixes #1532, reported by @Ptomerty. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
110 lines
3.1 KiB
C
110 lines
3.1 KiB
C
/* Copyright 2016 Jack Humbert
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#ifndef PROCESS_TAP_DANCE_H
|
|
#define PROCESS_TAP_DANCE_H
|
|
|
|
#ifdef TAP_DANCE_ENABLE
|
|
|
|
#include <stdbool.h>
|
|
#include <inttypes.h>
|
|
|
|
typedef struct
|
|
{
|
|
uint8_t count;
|
|
uint8_t oneshot_mods;
|
|
uint16_t keycode;
|
|
uint16_t timer;
|
|
bool interrupted;
|
|
bool pressed;
|
|
bool finished;
|
|
} qk_tap_dance_state_t;
|
|
|
|
#define TD(n) (QK_TAP_DANCE + n)
|
|
|
|
typedef void (*qk_tap_dance_user_fn_t) (qk_tap_dance_state_t *state, void *user_data);
|
|
|
|
typedef struct
|
|
{
|
|
struct {
|
|
qk_tap_dance_user_fn_t on_each_tap;
|
|
qk_tap_dance_user_fn_t on_dance_finished;
|
|
qk_tap_dance_user_fn_t on_reset;
|
|
} fn;
|
|
qk_tap_dance_state_t state;
|
|
uint16_t custom_tapping_term;
|
|
void *user_data;
|
|
} qk_tap_dance_action_t;
|
|
|
|
typedef struct
|
|
{
|
|
uint16_t kc1;
|
|
uint16_t kc2;
|
|
} qk_tap_dance_pair_t;
|
|
|
|
typedef struct
|
|
{
|
|
uint16_t kc;
|
|
uint8_t layer;
|
|
} qk_tap_dance_dual_role_t;
|
|
|
|
#define ACTION_TAP_DANCE_DOUBLE(kc1, kc2) { \
|
|
.fn = { NULL, qk_tap_dance_pair_finished, qk_tap_dance_pair_reset }, \
|
|
.user_data = (void *)&((qk_tap_dance_pair_t) { kc1, kc2 }), \
|
|
}
|
|
|
|
#define ACTION_TAP_DANCE_DUAL_ROLE(kc, layer) { \
|
|
.fn = { NULL, qk_tap_dance_dual_role_finished, qk_tap_dance_dual_role_reset }, \
|
|
.user_data = (void *)&((qk_tap_dance_dual_role_t) { kc, layer }), \
|
|
}
|
|
|
|
#define ACTION_TAP_DANCE_FN(user_fn) { \
|
|
.fn = { NULL, user_fn, NULL }, \
|
|
.user_data = NULL, \
|
|
}
|
|
|
|
#define ACTION_TAP_DANCE_FN_ADVANCED(user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset) { \
|
|
.fn = { user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset }, \
|
|
.user_data = NULL, \
|
|
}
|
|
|
|
#define ACTION_TAP_DANCE_FN_ADVANCED_TIME(user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset, tap_specific_tapping_term) { \
|
|
.fn = { user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_dance_reset }, \
|
|
.user_data = NULL, \
|
|
.custom_tapping_term = tap_specific_tapping_term, \
|
|
}
|
|
|
|
extern qk_tap_dance_action_t tap_dance_actions[];
|
|
|
|
/* To be used internally */
|
|
|
|
bool process_tap_dance(uint16_t keycode, keyrecord_t *record);
|
|
void matrix_scan_tap_dance (void);
|
|
void reset_tap_dance (qk_tap_dance_state_t *state);
|
|
|
|
void qk_tap_dance_pair_finished (qk_tap_dance_state_t *state, void *user_data);
|
|
void qk_tap_dance_pair_reset (qk_tap_dance_state_t *state, void *user_data);
|
|
|
|
void qk_tap_dance_dual_role_finished (qk_tap_dance_state_t *state, void *user_data);
|
|
void qk_tap_dance_dual_role_reset (qk_tap_dance_state_t *state, void *user_data);
|
|
|
|
#else
|
|
|
|
#define TD(n) KC_NO
|
|
|
|
#endif
|
|
|
|
#endif
|