alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adapt TapDance to active keys cache

Browse Source 
This is a major rewrite of TapDance, taking advantage of the active keys cache
and the `KeyAddrEventQueue` class originally written for Qukeys.

fixes #806
fixes #922
fixes #908
fixes #985

Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
f/keymap-cache-redesign
Michael Richters 4 years ago committed by Jesse Vincent
parent b13aaba529
commit b06afda760
No known key found for this signature in database
GPG Key ID: 122F5DF7108E4046
3 changed files with 127 additions and 147 deletions
Show Stats Download Patch File Download Diff File

13
src/kaleidoscope/plugin/Qukeys/KeyAddrEventQueue.h
Unescape View File

@ -105,6 +105,19 @@ class KeyAddrEventQueue {
release_event_bits_ >>= 1; release_event_bits_ >>= 1;
} }
void shift(uint8_t n) {
if (n >= length_) {
clear();
return;
}
length_ -= n;
for (uint8_t i{0}; i < length_; ++i) {
addrs_[i] = addrs_[i + n];
timestamps_[i] = timestamps_[i + n];
}
release_event_bits_ >>= n;
}
// Empty the queue entirely. // Empty the queue entirely.
void clear() { void clear() {
length_ = 0; length_ = 0;

228
src/kaleidoscope/plugin/TapDance.cpp
Unescape View File

@ -17,70 +17,21 @@
#include <Kaleidoscope-TapDance.h> #include <Kaleidoscope-TapDance.h>
#include "kaleidoscope/keyswitch_state.h" #include "kaleidoscope/keyswitch_state.h"
#include "kaleidoscope/layers.h"
namespace kaleidoscope { namespace kaleidoscope {
namespace plugin { namespace plugin {
// --- state --- // --- config ---
uint16_t TapDance::start_time_;
uint16_t TapDance::time_out = 200;
TapDance::TapDanceState TapDance::state_[TapDance::TAPDANCE_KEY_COUNT];
Key TapDance::last_tap_dance_key_ = Key_NoKey;
KeyAddr TapDance::last_tap_dance_addr_;
// --- actions ---
void TapDance::interrupt(KeyAddr key_addr) {
uint8_t idx = last_tap_dance_key_.getRaw() - ranges::TD_FIRST;
tapDanceAction(idx, last_tap_dance_addr_, state_[idx].count, Interrupt);
state_[idx].triggered = true;
last_tap_dance_key_ = Key_NoKey;
Runtime.hid().keyboard().sendReport();
Runtime.hid().keyboard().releaseAllKeys();
if (state_[idx].pressed)
return;
release(idx);
}
void TapDance::timeout(void) {
uint8_t idx = last_tap_dance_key_.getRaw() - ranges::TD_FIRST;
tapDanceAction(idx, last_tap_dance_addr_, state_[idx].count, Timeout);
state_[idx].triggered = true;
if (state_[idx].pressed)
return;
last_tap_dance_key_ = Key_NoKey;
release(idx);
}
void TapDance::release(uint8_t tap_dance_index) {
last_tap_dance_key_ = Key_NoKey;
state_[tap_dance_index].pressed = false; uint16_t TapDance::time_out = 200;
state_[tap_dance_index].triggered = false; KeyAddr TapDance::release_addr_ = KeyAddr{KeyAddr::invalid_state};
state_[tap_dance_index].release_next = true;
}
void TapDance::tap(void) {
uint8_t idx = last_tap_dance_key_.getRaw() - ranges::TD_FIRST;
state_[idx].count++;
start_time_ = Runtime.millisAtCycleStart();
tapDanceAction(idx, last_tap_dance_addr_, state_[idx].count, Tap);
}
// --- api --- // --- api ---
void TapDance::actionKeys(uint8_t tap_count,
void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_t max_keys, const Key tap_keys[]) { ActionType tap_dance_action,
uint8_t max_keys,
const Key tap_keys[]) {
if (tap_count > max_keys) if (tap_count > max_keys)
tap_count = max_keys; tap_count = max_keys;
@ -91,108 +42,127 @@ void TapDance::actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_
break; break;
case Interrupt: case Interrupt:
case Timeout: case Timeout:
handleKeyswitchEvent(key, last_tap_dance_addr_, IS_PRESSED | INJECTED); if (event_queue_.isEmpty())
break; break;
case Hold: {
handleKeyswitchEvent(key, last_tap_dance_addr_, IS_PRESSED | WAS_PRESSED | INJECTED); KeyAddr td_addr = event_queue_.addr(0);
bool key_released = (Runtime.activeKey(td_addr) == Key_Transparent);
handleKeyswitchEvent(key, td_addr, IS_PRESSED | INJECTED);
if (key_released)
release_addr_ = td_addr;
}
break; break;
case Hold:
case Release: case Release:
kaleidoscope::Runtime.hid().keyboard().sendReport();
handleKeyswitchEvent(key, last_tap_dance_addr_, WAS_PRESSED | INJECTED);
break; break;
} }
} }
// --- hooks ---
EventHandlerResult TapDance::onKeyswitchEvent(Key &mapped_key, KeyAddr key_addr, uint8_t keyState) { // --- hooks ---
if (keyState & INJECTED)
return EventHandlerResult::OK;
if (mapped_key.getRaw() < ranges::TD_FIRST || mapped_key.getRaw() > ranges::TD_LAST) { EventHandlerResult TapDance::onKeyswitchEvent(Key &key,
if (last_tap_dance_key_ == Key_NoKey) KeyAddr key_addr,
uint8_t key_state) {
if (key_state & INJECTED)
return EventHandlerResult::OK; return EventHandlerResult::OK;
if (keyToggledOn(keyState)) { if (event_queue_.isEmpty()) {
interrupt(key_addr); if (keyToggledOn(key_state) && isTapDanceKey(key)) {
mapped_key = Key_NoKey; // Begin a new TapDance sequence:
uint8_t td_id = key.getRaw() - ranges::TD_FIRST;
tapDanceAction(td_id, key_addr, 1, Tap);
event_queue_.append(key_addr, key_state);
return EventHandlerResult::EVENT_CONSUMED;
} }
return EventHandlerResult::OK; return EventHandlerResult::OK;
} }
uint8_t tap_dance_index = mapped_key.getRaw() - ranges::TD_FIRST; uint8_t td_count = event_queue_.length();
KeyAddr td_addr = event_queue_.addr(0);
Key td_key = Layer.lookup(td_addr);
uint8_t td_id = td_key.getRaw() - ranges::TD_FIRST;
if (keyToggledOff(keyState)) if (keyToggledOn(key_state)) {
state_[tap_dance_index].pressed = false; if (key_addr == td_addr) {
// The same TapDance key was pressed again; continue the sequence:
if (last_tap_dance_key_ != mapped_key) { tapDanceAction(td_id, td_addr, ++td_count, Tap);
if (last_tap_dance_key_ == Key_NoKey) {
if (state_[tap_dance_index].triggered) {
if (keyToggledOff(keyState)) {
release(tap_dance_index);
}
return EventHandlerResult::EVENT_CONSUMED;
}
last_tap_dance_key_ = mapped_key;
last_tap_dance_addr_ = key_addr;
tap();
return EventHandlerResult::EVENT_CONSUMED;
} else { } else {
if (keyToggledOff(keyState) && state_[tap_dance_index].count) { // A different key was pressed; interrupt the sequeunce:
release(tap_dance_index); tapDanceAction(td_id, td_addr, td_count, Interrupt);
return EventHandlerResult::EVENT_CONSUMED; event_queue_.clear();
} // If the sequence was interrupted by another TapDance key, start the new
// sequence:
if (!keyToggledOn(keyState)) { if (isTapDanceKey(Layer.lookup(key_addr))) {
return EventHandlerResult::EVENT_CONSUMED; td_id = key.getRaw() - ranges::TD_FIRST;
} tapDanceAction(td_id, key_addr, 1, Tap);
interrupt(key_addr);
} }
} }
// Any key that toggles on while a TapDance sequence is live gets added to
// in sequence // the queue. If it interrupted the queue, we need to hold off on processing
// that event until the next cycle to guarantee that the events appear in
if (keyToggledOff(keyState)) { // order on the host.
event_queue_.append(key_addr, key_state);
if (isTapDanceKey(key))
return EventHandlerResult::EVENT_CONSUMED; return EventHandlerResult::EVENT_CONSUMED;
return EventHandlerResult::ABORT;
} else if (keyIsPressed(key_state)) {
// Until a key press event has been released from the queue, its "hold
// event" must be suppressed every cycle.
for (uint8_t i{0}; i < event_queue_.length(); ++i) {
if (event_queue_.addr(i) == key_addr) {
return EventHandlerResult::ABORT;
} }
last_tap_dance_key_ = mapped_key;
last_tap_dance_addr_ = key_addr;
state_[tap_dance_index].pressed = true;
if (keyToggledOn(keyState)) {
tap();
return EventHandlerResult::EVENT_CONSUMED;
} }
}
if (state_[tap_dance_index].triggered) // We always indicate that other plugins don't need to handle TapDance keys,
tapDanceAction(tap_dance_index, key_addr, state_[tap_dance_index].count, Hold); // but we do allow them to show up as active keys when they're held. This way,
// when one times out, if it's not being held any longer, we can send the
// release event.
if (isTapDanceKey(key))
return EventHandlerResult::EVENT_CONSUMED; return EventHandlerResult::EVENT_CONSUMED;
// This key is being held, but is not in the queue, or it toggled off, but is
// not (currently) a TapDance key.
return EventHandlerResult::OK;
} }
EventHandlerResult TapDance::afterEachCycle() { EventHandlerResult TapDance::afterEachCycle() {
for (uint8_t i = 0; i < TAPDANCE_KEY_COUNT; i++) { if (release_addr_.isValid()) {
if (!state_[i].release_next) handleKeyswitchEvent(Key_NoKey, release_addr_, WAS_PRESSED | INJECTED);
continue; release_addr_ = KeyAddr{KeyAddr::invalid_state};
}
tapDanceAction(i, last_tap_dance_addr_, state_[i].count, Release); Key event_key;
state_[i].count = 0; // Purge any non-TapDance key events from the front of the queue.
state_[i].release_next = false; while (! event_queue_.isEmpty()) {
KeyAddr event_addr = event_queue_.addr(0);
event_key = Layer.lookup(event_addr);
if (isTapDanceKey(event_key)) {
break;
}
handleKeyswitchEvent(event_key, event_addr, IS_PRESSED | INJECTED);
event_queue_.shift();
} }
if (last_tap_dance_key_ == Key_NoKey) if (event_queue_.isEmpty())
return EventHandlerResult::OK; return EventHandlerResult::OK;
if (Runtime.hasTimeExpired(start_time_, time_out)) // The first event in the queue is now guaranteed to be a TapDance key.
timeout(); uint8_t td_id = event_key.getRaw() - ranges::TD_FIRST;
KeyAddr td_addr = event_queue_.addr(0);
// Check for timeout
uint8_t td_count = event_queue_.length();
uint16_t start_time = event_queue_.timestamp(td_count - 1);
if (Runtime.hasTimeExpired(start_time, time_out)) {
tapDanceAction(td_id, td_addr, td_count, Timeout);
event_queue_.clear();
// There's still a race condition here, but it's a minor one. If a TapDance
// sequence times out in the `afterEachCycle()` handler, then another key
// toggles on in the following scan cycle, and that key is handled first,
// the two events could show up out of order on the host. The probability of
// this happening is low, and event-driven Kaleidoscope will fix it
// completely, so I'm willing to accept the risk for now.
}
return EventHandlerResult::OK; return EventHandlerResult::OK;
} }

31
src/kaleidoscope/plugin/TapDance.h
Unescape View File

@ -19,6 +19,7 @@
#include "kaleidoscope/Runtime.h" #include "kaleidoscope/Runtime.h"
#include <Kaleidoscope-Ranges.h> #include <Kaleidoscope-Ranges.h>
#include "kaleidoscope/plugin/Qukeys/KeyAddrEventQueue.h"
#define TD(n) Key(kaleidoscope::ranges::TD_FIRST + n) #define TD(n) Key(kaleidoscope::ranges::TD_FIRST + n)
@ -49,24 +50,20 @@ class TapDance : public kaleidoscope::Plugin {
EventHandlerResult onKeyswitchEvent(Key &mapped_key, KeyAddr key_addr, uint8_t keyState); EventHandlerResult onKeyswitchEvent(Key &mapped_key, KeyAddr key_addr, uint8_t keyState);
EventHandlerResult afterEachCycle(); EventHandlerResult afterEachCycle();
static constexpr bool isTapDanceKey(Key key) {
return (key.getRaw() >= ranges::TD_FIRST &&
key.getRaw() <= ranges::TD_LAST);
}
private: private:
static constexpr uint8_t TAPDANCE_KEY_COUNT = 16; // The maximum number of events in the queue at a time.
struct TapDanceState { static constexpr uint8_t queue_capacity_{8};
bool pressed: 1;
bool triggered: 1; // The event queue stores a series of press and release events.
bool release_next: 1; KeyAddrEventQueue<queue_capacity_> event_queue_;
uint8_t count;
}; static KeyAddr release_addr_;
static TapDanceState state_[TAPDANCE_KEY_COUNT];
static uint16_t start_time_;
static Key last_tap_dance_key_;
static KeyAddr last_tap_dance_addr_;
static void tap(void);
static void interrupt(KeyAddr key_addr);
static void timeout(void);
static void release(uint8_t tap_dance_index);
}; };
} }

Write Preview
Loading…
Cancel
Save