di0ib
/
tmk_keyboard
Suivre 1
Ajouter aux favoris 0
Bifurcation 0
Code Versions 4 Activité
Parcourir la source

Add user defined function to action.

tags/v1.9
tmk il y a 11 ans
Parent
d95463f2e0
révision
1d7962ba8a
6 fichiers modifiés avec 167 ajouts et 100 suppressions
Vue unifiée Afficher les stats Diff
  1. 23
    23
      common/action.c
  2. 24
    23
      common/action.h
  3. 1
    0
      common/keyboard.h
  4. 1
    1
      common/keymap.c
  5. 5
    3
      common/keymap.h
  6. 113
    50
      keyboard/hhkb/keymap.c

+ 23
- 23
common/action.c Voir le fichier

} }
#endif #endif


static bool waiting_buffer_has_anykey_pressed(void)
bool waiting_buffer_has_anykey_pressed(void)
{ {
for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
if (waiting_buffer[i].event.pressed) return true; if (waiting_buffer[i].event.pressed) return true;
debug("MODS_TAP: Oneshot: start\n"); debug("MODS_TAP: Oneshot: start\n");
oneshot_start(mods, event.time); oneshot_start(mods, event.time);
} }
else if (tap_count == 5) {
else if (tap_count == TAPPING_TOGGLE) {
debug("MODS_TAP: Oneshot: toggle\n"); debug("MODS_TAP: Oneshot: toggle\n");
oneshot_toggle(); oneshot_toggle();
} }
switch (action.layer.code) { switch (action.layer.code) {
case 0x00: case 0x00:
if (event.pressed) { if (event.pressed) {
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
//TODO: this is ok? //TODO: this is ok?
else { else {
// tap toggle // tap toggle
if (event.pressed) { if (event.pressed) {
if (tap_count < TAPPING_TOGGLE) { if (tap_count < TAPPING_TOGGLE) {
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
} else { } else {
if (tap_count >= TAPPING_TOGGLE) { if (tap_count >= TAPPING_TOGGLE) {
debug("LAYER_PRESSED: tap toggle.\n"); debug("LAYER_PRESSED: tap toggle.\n");
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
} }
break; break;
case 0xFF: case 0xFF:
// change default layer // change default layer
if (event.pressed) { if (event.pressed) {
default_layer = action.layer.opt;
default_layer = action.layer.val;
layer_switch(default_layer); layer_switch(default_layer);
} }
break; break;
register_code(action.layer.code); register_code(action.layer.code);
} else { } else {
debug("LAYER_PRESSED: No tap: layer_switch\n"); debug("LAYER_PRESSED: No tap: layer_switch\n");
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
} else { } else {
if (tap_count > 0) { if (tap_count > 0) {
switch (action.layer.code) { switch (action.layer.code) {
case 0x00: case 0x00:
if (!event.pressed) { if (!event.pressed) {
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
break; break;
case 0xF0: case 0xF0:
if (event.pressed) { if (event.pressed) {
if (tap_count >= TAPPING_TOGGLE) { if (tap_count >= TAPPING_TOGGLE) {
debug("LAYER_RELEASED: tap toggle.\n"); debug("LAYER_RELEASED: tap toggle.\n");
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
} else { } else {
if (tap_count < TAPPING_TOGGLE) { if (tap_count < TAPPING_TOGGLE) {
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
} }
break; break;
case 0xFF: case 0xFF:
// change default layer // change default layer
if (!event.pressed) { if (!event.pressed) {
default_layer = action.layer.opt;
default_layer = action.layer.val;
layer_switch(default_layer); layer_switch(default_layer);
} }
break; break;
unregister_code(action.layer.code); unregister_code(action.layer.code);
} else { } else {
debug("LAYER_RELEASED: No tap: layer_switch\n"); debug("LAYER_RELEASED: No tap: layer_switch\n");
layer_switch(action.layer.opt);
layer_switch(action.layer.val);
} }
} }
break; break;
switch (action.layer.code) { switch (action.layer.code) {
case 0x00: case 0x00:
if (event.pressed) { if (event.pressed) {
layer_switch(current_layer ^ action.layer.opt);
layer_switch(current_layer ^ action.layer.val);
} else { } else {
layer_switch(current_layer ^ action.layer.opt);
layer_switch(current_layer ^ action.layer.val);
} }
break; break;
case 0xF0: case 0xF0:
if (event.pressed) { if (event.pressed) {
if (tap_count < TAPPING_TOGGLE) { if (tap_count < TAPPING_TOGGLE) {
debug("LAYER_BIT: tap toggle(press).\n"); debug("LAYER_BIT: tap toggle(press).\n");
layer_switch(current_layer ^ action.layer.opt);
layer_switch(current_layer ^ action.layer.val);
} }
} else { } else {
if (tap_count <= TAPPING_TOGGLE) { if (tap_count <= TAPPING_TOGGLE) {
debug("LAYER_BIT: tap toggle(release).\n"); debug("LAYER_BIT: tap toggle(release).\n");
layer_switch(current_layer ^ action.layer.opt);
layer_switch(current_layer ^ action.layer.val);
} }
} }
break; break;
case 0xFF: case 0xFF:
// change default layer // change default layer
if (event.pressed) { if (event.pressed) {
default_layer = current_layer ^ action.layer.opt;
default_layer = current_layer ^ action.layer.val;
layer_switch(default_layer); layer_switch(default_layer);
} else { } else {
default_layer = current_layer ^ action.layer.opt;
default_layer = current_layer ^ action.layer.val;
layer_switch(default_layer); layer_switch(default_layer);
} }
break; break;
register_code(action.layer.code); register_code(action.layer.code);
} else { } else {
debug("LAYER_BIT: No tap: layer_switch(bit on)\n"); debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
layer_switch(current_layer ^ action.layer.opt);
layer_switch(current_layer ^ action.layer.val);
} }
} else { } else {
if (IS_TAPPING_KEY(event.key) && tap_count > 0) { if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
unregister_code(action.layer.code); unregister_code(action.layer.code);
} else { } else {
debug("LAYER_BIT: No tap: layer_switch(bit off)\n"); debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
layer_switch(current_layer ^ action.layer.opt);
layer_switch(current_layer ^ action.layer.val);
} }
} }
break; break;
} }
break; break;
case ACT_LAYER_EXT: case ACT_LAYER_EXT:
switch (action.layer.opt) {
switch (action.layer.val) {
case 0x00: case 0x00:
// set default layer when pressed // set default layer when pressed
switch (action.layer.code) { switch (action.layer.code) {
break; break;
case ACT_FUNCTION: case ACT_FUNCTION:
// TODO // TODO
action_call_function(event, action.func.id);
keymap_call_function(record, action.func.id);
break; break;
default: default:
break; break;
} }
return false; return false;
case ACT_FUNCTION: case ACT_FUNCTION:
if (action.func.opt & 0x1) {
if (action.func.opt & O_TAP) {
return true; return true;
} }
return false; return false;

+ 24
- 23
common/action.h Voir le fichier

#include "keycode.h" #include "keycode.h"




/* Execute action per keyevent */
void action_exec(keyevent_t event);


/* Struct to record event and tap count */
typedef struct {
keyevent_t event;
uint8_t tap_count;
} keyrecord_t;

/* Action struct. /* Action struct.
* *
* In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15). * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
} key; } key;
struct action_layer { struct action_layer {
uint16_t code :8; uint16_t code :8;
uint16_t opt :4;
uint16_t val :4;
uint16_t kind :4; uint16_t kind :4;
} layer; } layer;
struct action_usage { struct action_usage {
} usage; } usage;
struct action_command { struct action_command {
uint16_t id :8; uint16_t id :8;
uint16_t option :4;
uint16_t opt :4;
uint16_t kind :4; uint16_t kind :4;
} command; } command;
struct action_function { struct action_function {
} func; } func;
} action_t; } action_t;


/* Struct to record action and tap count */
typedef struct {
keyevent_t event;
uint8_t tap_count;
} keyrecord_t;


/* execute action per keyevent */
void action_exec(keyevent_t event);
typedef void (*action_func_t)(keyevent_t event, uint8_t opt); // TODO:no need?
void action_call_function(keyevent_t event, uint8_t id); // TODO: action function



/* /*
* Utilities for actions. * Utilities for actions.
bool sending_anykey(void); bool sending_anykey(void);
void layer_switch(uint8_t new_layer); void layer_switch(uint8_t new_layer);
bool is_tap_key(key_t key); bool is_tap_key(key_t key);
bool waiting_buffer_has_anykey_pressed(void);






1111| address(12) Function? 1111| address(12) Function?
1111|opt | id(8) Function? 1111|opt | id(8) Function?


TODO: modifier + function by tap?
for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
*/ */
enum action_kind_id { enum action_kind_id {
ACT_LMODS = 0b0000, ACT_LMODS = 0b0000,
ACT_FUNCTION = 0b1111 ACT_FUNCTION = 0b1111
}; };


enum acion_param {
ONE_SHOT = 0x00,
enum params {
P_ONESHOT = 0x00,
};

enum options {
O_TAP = 0x8,
}; };






/* Mods + Tap key */ /* Mods + Tap key */
#define ACTION_LMODS_TAP_KEY(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key)) #define ACTION_LMODS_TAP_KEY(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key))
#define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | ONE_SHOT)
#define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | P_ONESHOT)
#define ACTION_RMODS_TAP_KEY(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key)) #define ACTION_RMODS_TAP_KEY(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key))
#define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | ONE_SHOT)
#define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | P_ONESHOT)
/* Mod + Tap key */ /* Mod + Tap key */
#define ACTION_LMOD_TAP_KEY(mod, key) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_LMOD_TAP_KEY(mod, key) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
#define ACTION_LMOD_ONESHOT(mod) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | ONE_SHOT)
#define ACTION_LMOD_ONESHOT(mod) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | P_ONESHOT)
#define ACTION_RMOD_TAP_KEY(mod, key) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_RMOD_TAP_KEY(mod, key) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
#define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | ONE_SHOT)
#define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | P_ONESHOT)


// TODO: contemplate about layer action // TODO: contemplate about layer action
/* Switch current layer */ /* Switch current layer */


/* Function */ /* Function */
#define ACTION_FUNCTION(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | id) #define ACTION_FUNCTION(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | id)
#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, O_TAP<<8 | id)


#endif /* ACTION_H */ #endif /* ACTION_H */

+ 1
- 0
common/keyboard.h Voir le fichier

uint8_t row; uint8_t row;
} keypos_t; } keypos_t;


// TODO: need raw? keypos_t -> key_t?
typedef union { typedef union {
uint16_t raw; uint16_t raw;
keypos_t pos; keypos_t pos;

+ 1
- 1
common/keymap.c Voir le fichier

#endif #endif


__attribute__ ((weak)) __attribute__ ((weak))
void action_call_function(keyevent_t event, uint8_t id)
void keymap_call_function(keyrecord_t *event, uint8_t id)
{ {
} }

+ 5
- 3
common/keymap.h Voir le fichier

extern uint8_t default_layer; extern uint8_t default_layer;




/*
* new keymap interface: action
*/
/* action for key */
// TODO: should use struct key_t?
action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col); action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col);


/* user defined special function */
void keymap_call_function(keyrecord_t *record, uint8_t id);



#ifndef NO_LEGACY_KEYMAP_SUPPORT #ifndef NO_LEGACY_KEYMAP_SUPPORT
/* keycode of key */ /* keycode of key */

+ 113
- 50
keyboard/hhkb/keymap.c Voir le fichier

} }




static const uint16_t PROGMEM fn_actions[] = {
ACTION_LAYER_TO_DEFAULT_ON_RELEASED, // Fn0
ACTION_LAYER_SET_ON_PRESSED(1), // Fn1
ACTION_LAYER_SET_TAP_KEY(2, KC_SLASH), // Fn2
ACTION_LAYER_SET_TAP_KEY(3, KC_SCLN), // Fn3
//ACTION_LAYER_SET_ON_PRESSED(3), // Fn4
ACTION_FUNCTION(0x01, 0xA), // Fn4
ACTION_LAYER_SET_TAP_KEY(5, KC_SPC), // Fn5
ACTION_LMODS_TAP(MOD_BIT(KC_LCTL), KC_BSPC), // Fn6
ACTION_RMODS_TAP(MOD_BIT(KC_RCTL), KC_ENT), // Fn7

ACTION_LMODS_TAP(MOD_BIT(KC_LSFT), ONE_SHOT), // Fn8
ACTION_LAYER_SET_ON_RELEASED_TAP_TOGGLE(1), // Fn9
ACTION_LAYER_BIT_TAP_TOGGLE(1), // Fn10
};


static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Layer 0: Default Layer /* Layer 0: Default Layer
* ,-----------------------------------------------------------. * ,-----------------------------------------------------------.
KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \ KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \
TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSPC, \ TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSPC, \
FN6, A, S, D, F, G, H, J, K, L, FN3, QUOT,FN7, \ FN6, A, S, D, F, G, H, J, K, L, FN3, QUOT,FN7, \
FN8, Z, X, C, V, B, N, M, COMM,DOT, FN2, RSFT,FN10, \
FN8, Z, X, C, V, B, N, M, COMM,DOT, FN2, FN12,FN10, \
LGUI,LALT, FN5, RALT,FN4), LGUI,LALT, FN5, RALT,FN4),


/* Layer 1: HHKB mode (HHKB Fn) /* Layer 1: HHKB mode (HHKB Fn)
LGUI,LALT, FN0, RALT,RGUI), LGUI,LALT, FN0, RALT,RGUI),
}; };


#define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))




/* legacy interface */
uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col) { return 0; }
uint8_t keymap_fn_layer(uint8_t fn_bits) { return 0; }
uint8_t keymap_fn_keycode(uint8_t fn_bits) { return 0; }
/* id for user defined functions */
enum function_id {
LSHIFT_LPAREN,
RSHIFT_RPAREN,
};

/*
* Fn action definition
*/
static const uint16_t PROGMEM fn_actions[] = {
ACTION_LAYER_RETURN_DEFAULT, // FN0
ACTION_LAYER_SET(1), // FN1
ACTION_LAYER_SET_TAP_KEY(2, KC_SLASH), // FN2
ACTION_LAYER_SET_TAP_KEY(3, KC_SCLN), // FN3
ACTION_LAYER_SET(3), // FN4
ACTION_LAYER_SET_TAP_KEY(5, KC_SPC), // FN5
ACTION_LMOD_TAP_KEY(KC_LCTL, KC_BSPC), // FN6
ACTION_RMOD_TAP_KEY(KC_RCTL, KC_ENT), // FN7
ACTION_LMOD_ONESHOT(KC_LSFT), // FN8 Oneshot Shift
ACTION_LAYER_SET_ON_RELEASED_TAP_TOGGLE(1), // FN9
ACTION_LAYER_BIT_TAP_KEY(1, KC_GRV), // FN10
//ACTION_LAYER_BIT(1), // FN10
//ACTION_LAYER_BIT_TAP_TOGGLE(1), // FN10
ACTION_FUNCTION_TAP(LSHIFT_LPAREN), // FN11
ACTION_FUNCTION_TAP(RSHIFT_RPAREN), // FN12
};

/*
* user defined action function
*/
void keymap_call_function(keyrecord_t *record, uint8_t id)
{
keyevent_t event = record->event;
uint8_t tap_count = record->tap_count;

debug("action_call_function: ");
if (event.pressed) debug("pressed"); else debug("released");
debug(" id: "); debug_hex(id);
debug(" tap_count: "); debug_dec(tap_count);
debug("\n");


switch (id) {
case LSHIFT_LPAREN:
// LShft + tap '('
if (event.pressed) {
if (tap_count == 0) {
add_mods(MOD_BIT(KC_LSHIFT));
} else {
if (waiting_buffer_has_anykey_pressed()) {
// ad hoc: set 0 to cancel tap
record->tap_count = 0;
add_mods(MOD_BIT(KC_LSHIFT));
} else {
// NOTE to avoid conflicting command key bind(LShift+RShift)
//register_code(KC_LSHIFT);
//register_code(KC_9);
host_add_mods(MOD_BIT(KC_LSHIFT));
host_add_key(KC_9);
host_send_keyboard_report();
}
}
} else {
if (tap_count == 0) {
del_mods(MOD_BIT(KC_LSHIFT));
} else {
//unregister_code(KC_9);
//unregister_code(KC_LSHIFT);
host_del_mods(MOD_BIT(KC_LSHIFT));
host_del_key(KC_9);
host_send_keyboard_report();
}
}
break;
case RSHIFT_RPAREN:
// RShift + tap ')'
if (event.pressed) {
if (tap_count == 0) {
add_mods(MOD_BIT(KC_RSHIFT));
} else {
if (waiting_buffer_has_anykey_pressed()) {
// ad hoc: set 0 to cancel tap
record->tap_count = 0;
add_mods(MOD_BIT(KC_RSHIFT));
} else {
//register_code(KC_RSHIFT);
//register_code(KC_0);
host_add_mods(MOD_BIT(KC_RSHIFT));
host_add_key(KC_0);
host_send_keyboard_report();
}
}
} else {
if (tap_count == 0) {
del_mods(MOD_BIT(KC_RSHIFT));
} else {
//unregister_code(KC_0);
//unregister_code(KC_RSHIFT);
host_del_mods(MOD_BIT(KC_RSHIFT));
host_del_key(KC_0);
host_send_keyboard_report();
}
}
break;
}
}


/* convert keycode to action */
action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col) { action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col) {
/* convert from legacy keycode to action */
uint8_t key = KEYCODE(layer, row, col);
uint8_t key = (pgm_read_byte(&keymaps[(layer)][(row)][(col)]));
action_t action; action_t action;
switch (key) { switch (key) {
case KC_A ... KC_EXSEL: case KC_A ... KC_EXSEL:
action.code = ACTION_KEY(key);
break;
case KC_LCTRL ... KC_LGUI: case KC_LCTRL ... KC_LGUI:
action.code = ACTION_LMOD(key);
break;
case KC_RCTRL ... KC_RGUI: case KC_RCTRL ... KC_RGUI:
action.code = ACTION_KEY(key);
action.code = ACTION_RMOD(key);
break; break;
case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE: case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(key)); action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(key));
case KC_MS_UP ... KC_MS_ACCEL2: case KC_MS_UP ... KC_MS_ACCEL2:
action.code = ACTION_MOUSEKEY(key); action.code = ACTION_MOUSEKEY(key);
break; break;
/* TODO
case KC_LCTRL ... KC_LGUI:
action.code = ACTION_LMODS(MOD_BIT(key));
break;
case KC_RCTRL ... KC_RGUI:
action.code = ACTION_RMODS(MOD_BIT(key)>>4);
break;
*/
case KC_FN0 ... FN_MAX:
case KC_FN0 ... KC_FN31:
if (FN_INDEX(key) < sizeof(fn_actions) / sizeof(fn_actions[0])) { if (FN_INDEX(key) < sizeof(fn_actions) / sizeof(fn_actions[0])) {
action.code = pgm_read_word(&fn_actions[FN_INDEX(key)]); action.code = pgm_read_word(&fn_actions[FN_INDEX(key)]);
} else { } else {
} }
return action; return action;
} }

// TODO: how to define action function
void action_call_function(keyevent_t event, uint8_t id)
{
// '(' Shift+9
if (event.pressed) {
register_code(KC_LSHIFT);
register_code(KC_9);
debug("action_call_function: pressed: id: "); debug_hex(id); debug("\n");
} else {
unregister_code(KC_9);
unregister_code(KC_LSHIFT);
debug("action_call_function: released: id: "); debug_hex(id); debug("\n");
}
}

Écrire Aperçu
Chargement…
Annuler
Enregistrer