156 lines
5.1 KiB
Python
156 lines
5.1 KiB
Python
from micropython import const
|
|
|
|
from kmk.modules import Module
|
|
|
|
|
|
class ActivationType:
|
|
NOT_ACTIVATED = const(0)
|
|
HOLD_TIMEOUT = const(1)
|
|
INTERRUPTED = const(2)
|
|
|
|
|
|
class HoldTapKeyState:
|
|
def __init__(self, timeout_key, *args, **kwargs):
|
|
self.timeout_key = timeout_key
|
|
self.args = args
|
|
self.kwargs = kwargs
|
|
self.activated = ActivationType.NOT_ACTIVATED
|
|
|
|
|
|
class HoldTap(Module):
|
|
tap_time = 300
|
|
|
|
def __init__(self):
|
|
self.key_buffer = set()
|
|
self.key_states = {}
|
|
|
|
def during_bootup(self, keyboard):
|
|
return
|
|
|
|
def before_matrix_scan(self, keyboard):
|
|
return
|
|
|
|
def after_matrix_scan(self, keyboard):
|
|
return
|
|
|
|
def process_key(self, keyboard, key, is_pressed):
|
|
'''Handle holdtap being interrupted by another key press/release.'''
|
|
current_key = key
|
|
for key, state in self.key_states.items():
|
|
if key == current_key:
|
|
continue
|
|
if state.activated != ActivationType.NOT_ACTIVATED:
|
|
continue
|
|
|
|
# holdtap is interrupted by another key event.
|
|
if (is_pressed and not key.meta.tap_interrupted) or (
|
|
not is_pressed and key.meta.tap_interrupted and self.key_buffer
|
|
):
|
|
|
|
keyboard.cancel_timeout(state.timeout_key)
|
|
self.key_states[key].activated = ActivationType.INTERRUPTED
|
|
self.ht_activate_on_interrupt(
|
|
key, keyboard, *state.args, **state.kwargs
|
|
)
|
|
|
|
keyboard._send_hid()
|
|
|
|
self.send_key_buffer(keyboard)
|
|
|
|
# if interrupt on release: store interrupting keys until one of them
|
|
# is released.
|
|
if key.meta.tap_interrupted:
|
|
if is_pressed:
|
|
self.key_buffer.add(current_key)
|
|
current_key = None
|
|
|
|
return current_key
|
|
|
|
def before_hid_send(self, keyboard):
|
|
return
|
|
|
|
def after_hid_send(self, keyboard):
|
|
return
|
|
|
|
def on_powersave_enable(self, keyboard):
|
|
return
|
|
|
|
def on_powersave_disable(self, keyboard):
|
|
return
|
|
|
|
def ht_pressed(self, key, keyboard, *args, **kwargs):
|
|
'''Do nothing yet, action resolves when key is released, timer expires or other key is pressed.'''
|
|
if key.meta.tap_time is None:
|
|
tap_time = self.tap_time
|
|
else:
|
|
tap_time = key.meta.tap_time
|
|
timeout_key = keyboard.set_timeout(
|
|
tap_time,
|
|
lambda: self.on_tap_time_expired(key, keyboard, *args, **kwargs),
|
|
)
|
|
self.key_states[key] = HoldTapKeyState(timeout_key, *args, **kwargs)
|
|
return keyboard
|
|
|
|
def ht_released(self, key, keyboard, *args, **kwargs):
|
|
'''On keyup, release mod or tap key.'''
|
|
if key in self.key_states:
|
|
state = self.key_states[key]
|
|
keyboard.cancel_timeout(state.timeout_key)
|
|
if state.activated == ActivationType.HOLD_TIMEOUT:
|
|
# release hold
|
|
self.ht_deactivate_hold(key, keyboard, *args, **kwargs)
|
|
elif state.activated == ActivationType.INTERRUPTED:
|
|
# release tap
|
|
self.ht_deactivate_on_interrupt(key, keyboard, *args, **kwargs)
|
|
else:
|
|
# press and release tap because key released within tap time
|
|
self.ht_activate_tap(key, keyboard, *args, **kwargs)
|
|
keyboard.set_timeout(
|
|
False,
|
|
lambda: self.ht_deactivate_tap(key, keyboard, *args, **kwargs),
|
|
)
|
|
self.send_key_buffer(keyboard)
|
|
del self.key_states[key]
|
|
return keyboard
|
|
|
|
def on_tap_time_expired(self, key, keyboard, *args, **kwargs):
|
|
'''When tap time expires activate mod if key is still being pressed.'''
|
|
if (
|
|
key in self.key_states
|
|
and self.key_states[key].activated == ActivationType.NOT_ACTIVATED
|
|
):
|
|
# press hold because timer expired after tap time
|
|
self.key_states[key].activated = ActivationType.HOLD_TIMEOUT
|
|
self.ht_activate_hold(key, keyboard, *args, **kwargs)
|
|
self.send_key_buffer(keyboard)
|
|
|
|
def send_key_buffer(self, keyboard):
|
|
for key in self.key_buffer:
|
|
key.on_press(keyboard)
|
|
keyboard._send_hid()
|
|
self.key_buffer.clear()
|
|
|
|
def ht_activate_hold(self, key, keyboard, *args, **kwargs):
|
|
pass
|
|
|
|
def ht_deactivate_hold(self, key, keyboard, *args, **kwargs):
|
|
pass
|
|
|
|
def ht_activate_tap(self, key, keyboard, *args, **kwargs):
|
|
pass
|
|
|
|
def ht_deactivate_tap(self, key, keyboard, *args, **kwargs):
|
|
pass
|
|
|
|
def ht_activate_on_interrupt(self, key, keyboard, *args, **kwargs):
|
|
if key.meta.prefer_hold:
|
|
self.ht_activate_hold(key, keyboard, *args, **kwargs)
|
|
else:
|
|
self.ht_activate_tap(key, keyboard, *args, **kwargs)
|
|
|
|
def ht_deactivate_on_interrupt(self, key, keyboard, *args, **kwargs):
|
|
if key.meta.prefer_hold:
|
|
self.ht_deactivate_hold(key, keyboard, *args, **kwargs)
|
|
else:
|
|
self.ht_deactivate_tap(key, keyboard, *args, **kwargs)
|