Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

tap-dance: Support user_data for the callbacks

Browse source 
Refactored the code a little, so all callbacks now receive a `user_data`
pointer, which can be anything. As an example, the key pairs from
`ACTION_TAP_DANCE_DOUBLE` now use this, and custom, built-in functions.

This makes it easier to extend the tap dance functionality, and also
simplifies the code a little.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
This commit is contained in:
Gergely Nagy 2016-07-20 11:34:45 +02:00
parent 70e42489de
commit ce8cc9219f
2 changed files with 38 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
quantum/process_keycode/process_tap_dance.c
View file

@ -2,28 +2,32 @@
static qk_tap_dance_state_t qk_tap_dance_state; static qk_tap_dance_state_t qk_tap_dance_state;
static void _process_tap_dance_action_pair (qk_tap_dance_state_t *state, void qk_tap_dance_pair_finished (qk_tap_dance_state_t *state, void *user_data) {
uint16_t kc1, uint16_t kc2) { qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
uint16_t kc;
if (state->count == 0) if (state->count == 1) {
return; register_code (pair->kc1);
} else if (state->count == 2) {
register_code (pair->kc2);
}
}
kc = (state->count == 1) ? kc1 : kc2; void qk_tap_dance_pair_reset (qk_tap_dance_state_t *state, void *user_data) {
qk_tap_dance_pair_t *pair = (qk_tap_dance_pair_t *)user_data;
register_code (kc); if (state->count == 1) {
unregister_code (kc); unregister_code (pair->kc1);
} else if (state->count == 2) {
if (state->count >= 2) { unregister_code (pair->kc2);
reset_tap_dance (state);
} }
} }
static void _process_tap_dance_action_fn (qk_tap_dance_state_t *state, static void _process_tap_dance_action_fn (qk_tap_dance_state_t *state,
void *user_data,
qk_tap_dance_user_fn_t fn) qk_tap_dance_user_fn_t fn)
{ {
if (fn) { if (fn) {
fn(state); fn(state, user_data);
} }
} }
@ -34,14 +38,7 @@ void process_tap_dance_action_on_each_tap (uint16_t keycode)
action = tap_dance_actions[idx]; action = tap_dance_actions[idx];
switch (action.type) { _process_tap_dance_action_fn (&qk_tap_dance_state, action.user_data, action.fn.on_each_tap);
case QK_TAP_DANCE_TYPE_FN:
_process_tap_dance_action_fn (&qk_tap_dance_state, action.fn.on_each_tap);
break;
default:
break;
}
} }
void process_tap_dance_action_on_dance_finished (uint16_t keycode) void process_tap_dance_action_on_dance_finished (uint16_t keycode)
@ -51,18 +48,7 @@ void process_tap_dance_action_on_dance_finished (uint16_t keycode)
action = tap_dance_actions[idx]; action = tap_dance_actions[idx];
switch (action.type) { _process_tap_dance_action_fn (&qk_tap_dance_state, action.user_data, action.fn.on_dance_finished);
case QK_TAP_DANCE_TYPE_PAIR:
_process_tap_dance_action_pair (&qk_tap_dance_state,
action.pair.kc1, action.pair.kc2);
break;
case QK_TAP_DANCE_TYPE_FN:
_process_tap_dance_action_fn (&qk_tap_dance_state, action.fn.on_dance_finished);
break;
default:
break;
}
} }
bool process_tap_dance(uint16_t keycode, keyrecord_t *record) { bool process_tap_dance(uint16_t keycode, keyrecord_t *record) {
@ -118,15 +104,8 @@ void reset_tap_dance (qk_tap_dance_state_t *state) {
return; return;
action = tap_dance_actions[idx]; action = tap_dance_actions[idx];
switch (action.type) { if (action.fn.on_reset) {
case QK_TAP_DANCE_TYPE_FN: action.fn.on_reset(state, action.user_data);
if (action.fn.on_reset) {
action.fn.on_reset(state);
}
break;
default:
break;
} }
state->keycode = 0; state->keycode = 0;

41
quantum/process_keycode/process_tap_dance.h
View file

@ -17,42 +17,34 @@ typedef struct
#define TD(n) (QK_TAP_DANCE + n) #define TD(n) (QK_TAP_DANCE + n)
typedef enum typedef void (*qk_tap_dance_user_fn_t) (qk_tap_dance_state_t *state, void *user_data);
{
QK_TAP_DANCE_TYPE_PAIR,
QK_TAP_DANCE_TYPE_FN,
} qk_tap_dance_type_t;
typedef void (*qk_tap_dance_user_fn_t) (qk_tap_dance_state_t *state);
typedef struct typedef struct
{ {
qk_tap_dance_type_t type; struct {
union { qk_tap_dance_user_fn_t on_each_tap;
struct { qk_tap_dance_user_fn_t on_dance_finished;
uint16_t kc1; qk_tap_dance_user_fn_t on_reset;
uint16_t kc2; } fn;
} pair; void *user_data;
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_action_t; } qk_tap_dance_action_t;
typedef struct
{
uint16_t kc1;
uint16_t kc2;
} qk_tap_dance_pair_t;
#define ACTION_TAP_DANCE_DOUBLE(kc1, kc2) { \ #define ACTION_TAP_DANCE_DOUBLE(kc1, kc2) { \
.type = QK_TAP_DANCE_TYPE_PAIR, \ .fn = { NULL, qk_tap_dance_pair_finished, qk_tap_dance_pair_reset }, \
.pair = { kc1, kc2 } \ .user_data = (void *)&((qk_tap_dance_pair_t) { kc1, kc2 }) \
} }
#define ACTION_TAP_DANCE_FN(user_fn) { \ #define ACTION_TAP_DANCE_FN(user_fn) { \
.type = QK_TAP_DANCE_TYPE_FN, \
.fn = { NULL, user_fn, NULL } \ .fn = { NULL, user_fn, NULL } \
} }
#define ACTION_TAP_DANCE_FN_ADVANCED(user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_reset) { \ #define ACTION_TAP_DANCE_FN_ADVANCED(user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_reset) { \
.type = QK_TAP_DANCE_TYPE_FN, \
.fn = { user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_reset } \ .fn = { user_fn_on_each_tap, user_fn_on_dance_finished, user_fn_on_reset } \
} }
@ -64,6 +56,9 @@ bool process_tap_dance(uint16_t keycode, keyrecord_t *record);
void matrix_scan_tap_dance (void); void matrix_scan_tap_dance (void);
void reset_tap_dance (qk_tap_dance_state_t *state); 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);
#else #else
#define TD(n) KC_NO #define TD(n) KC_NO