Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to engage hold behaviour immediately #10

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add option to engage hold behaviour immediately #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d39be6
feat(hold): Add option to engage hold behaviour immediately
Gazareth Nov 13, 2022
37314e1
fix(quickhold)
Gazareth Jan 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions lib/TapHoldManager.ahk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ keyName The name of the key to declare a hotkey to
*/
class KeyManager {
state := 0 ; Current state of the key
sequence := 0 ; Number of taps so far
sequence := 0 ; Number of presses so far

holdWatcherState := 0 ; Are we potentially in a hold state?
tapWatcherState := 0 ; Has a tap release occurred and another could possibly happen?

holdActive := 0 ; A hold was activated and we are waiting for the release
fullHoldActive := 0

__New(manager, keyName, Callback, tapTime := -1, holdTime := -1, maxTaps := -1, prefixes := -1, window := ""){
this.manager := manager
this.Callback := Callback
Expand Down Expand Up @@ -80,6 +80,7 @@ class KeyManager {
this.keyName := keyName

this.HoldWatcherFn := this.HoldWatcher.Bind(this)
this.FullHoldWatcherFn := this.FullHoldWatcher.Bind(this)
this.TapWatcherFn := this.TapWatcher.Bind(this)
this.JoyReleaseFn := this.JoyButtonRelease.Bind(this)
this.JoyWatcherFn := this.JoyButtonWatcher.Bind(this)
Expand Down Expand Up @@ -142,15 +143,16 @@ class KeyManager {
; Key went down
this.sequence++
this.SetHoldWatcherState(1)
this.SetFullHoldWatcherState(1)
} else {
; Key went up
this.SetHoldWatcherState(0)
if (this.holdActive){
fn := this.FireCallback.Bind(this, this.sequence, 0)
if (this.fullHoldActive){
fn := this.FireCallback.Bind(this, 0, 0)
SetTimer, % fn, -0
this.ResetSequence()
} else {
if (this.maxTaps > 0 && this.Sequence == this.maxTaps){
if (this.maxTaps > 0 && this.sequence == this.maxTaps){
fn := this.FireCallback.Bind(this, this.sequence, -1)
SetTimer, % fn, -0
this.ResetSequence()
Expand All @@ -163,9 +165,10 @@ class KeyManager {

ResetSequence(){
this.SetHoldWatcherState(0)
this.SetFullHoldWatcherState(0)
this.SetTapWatcherState(0)
this.sequence := 0
this.holdActive := 0
this.fullHoldActive := 0
}

; When a key is pressed, if it is not released within tapTime, then it is considered a hold
Expand All @@ -175,23 +178,34 @@ class KeyManager {
SetTimer, % fn, % (state ? "-" this.holdTime : "Off")
}

; When a key has been held long enough to also breach the tapTime
SetFullHoldWatcherState(state){
this.fullHoldWatcherState := state
fn := this.FullHoldWatcherFn
SetTimer, % fn, % (state ? "-" this.tapTime : "Off")
}

; When a key is released, if it is re-pressed within tapTime, the sequence increments
SetTapWatcherState(state){
this.tapWatcherState := state
fn := this.TapWatcherFn
SetTimer, % fn, % (state ? "-" this.tapTime : "Off")
}

; If this function fires, a key was held for longer than the tap timeout, so engage hold mode
; If this function fires, a key was held for longer than the hold timeout, so engage hold mode
HoldWatcher(){
if (this.sequence > 0 && this.state == 1){
; Got to end of tapTime after first press, and still held.
; HOLD PRESS
fn := this.FireCallback.Bind(this, this.sequence, 1)
SetTimer, % fn, -0
this.holdActive := 1
}
}

; if this function fires, a key was held for longer than the tap timeout, so engage FULL hold mode
FullHoldWatcher(){
this.fullHoldActive := this.state == 1
}

; If this function fires, a key was released and we got to the end of the tap timeout, but no press was seen
TapWatcher(){
Expand Down