Skip to content

Commit

Permalink
Merge branch 'feature/1386-wait-for-sequence-trigger-timeout' into de…
Browse files Browse the repository at this point in the history 
…velop
  • Loading branch information
@sds100
sds100 committed Feb 18, 2025
2 parents 5214096 + 71044e4 commit a069c89
Show file tree
Hide file tree
Showing 2 changed files with 288 additions and 29 deletions.
130 changes: 101 additions & 29 deletions app/src/free/java/io/github/sds100/keymapper/mappings/keymaps/detection/KeyMapController.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ class KeyMapController(
MutableList(triggers.size) { mutableSetOf<Int>() }

for (triggerIndex in parallelTriggers) {
val trigger = triggers[triggerIndex]
val parallelTrigger = triggers[triggerIndex]

otherTriggerLoop@ for (otherTriggerIndex in sequenceTriggers) {
val otherTrigger = triggers[otherTriggerIndex]
Expand All @@ -259,7 +259,7 @@ class KeyMapController(
continue@otherTriggerLoop
}

for ((keyIndex, key) in trigger.keys.withIndex()) {
for ((keyIndex, key) in parallelTrigger.keys.withIndex()) {
var lastMatchedIndex: Int? = null

for ((otherKeyIndex, otherKey) in otherTrigger.keys.withIndex()) {
Expand All @@ -271,7 +271,7 @@ class KeyMapController(
continue@otherTriggerLoop
}

if (keyIndex == trigger.keys.lastIndex) {
if (keyIndex == parallelTrigger.keys.lastIndex) {
sequenceTriggersOverlappingParallelTriggers[triggerIndex].add(
otherTriggerIndex,
)
Expand Down Expand Up @@ -489,30 +489,36 @@ class KeyMapController(

private var modifierKeyEventActions: Boolean = false
private var notModifierKeyEventActions: Boolean = false
private var keyCodesToImitateUpAction: MutableSet<Int> = mutableSetOf<Int>()
private var keyCodesToImitateUpAction: MutableSet<Int> = mutableSetOf()
private var metaStateFromActions: Int = 0
private var metaStateFromKeyEvent: Int = 0

private val eventDownTimeMap: MutableMap<Event, Long> = mutableMapOf<Event, Long>()
private val eventDownTimeMap: MutableMap<Event, Long> = mutableMapOf()

/**
* This solves issue #1386. This stores the jobs that will wait until the sequence trigger
* times out and check whether the overlapping sequence trigger was indeed triggered.
*/
private val performActionsAfterSequenceTriggerTimeout: MutableMap<Int, Job> = mutableMapOf()

/**
* The indexes of parallel triggers that didn't have their actions performed because there is a matching trigger but
* for a long-press. These actions should only be performed if the long-press fails, otherwise when the user
* holds down the trigger keys for the long-press trigger, actions from both triggers will be performed.
*/
private val performActionsOnFailedLongPress: MutableSet<Int> = mutableSetOf<Int>()
private val performActionsOnFailedLongPress: MutableSet<Int> = mutableSetOf()

/**
* The indexes of parallel triggers that didn't have their actions performed because there is a matching trigger but
* for a double-press. These actions should only be performed if the double-press fails, otherwise each time the user
* presses the keys for the double press, actions from both triggers will be performed.
*/
private val performActionsOnFailedDoublePress: MutableSet<Int> = mutableSetOf<Int>()
private val performActionsOnFailedDoublePress: MutableSet<Int> = mutableSetOf()

/**
* Maps jobs to perform an action after a long press to their corresponding parallel trigger index
*/
private val parallelTriggerLongPressJobs: SparseArrayCompat<Job> = SparseArrayCompat<Job>()
private val parallelTriggerLongPressJobs: SparseArrayCompat<Job> = SparseArrayCompat()

/**
* Keys that are detected through an input method will potentially send multiple DOWN key events
Expand Down Expand Up @@ -849,31 +855,63 @@ class KeyMapController(
mappedToParallelTriggerAction = true
parallelTriggersAwaitingReleaseAfterBeingTriggered[triggerIndex] = true

val actionKeys = triggerActions[triggerIndex]
// See issue #1386.
val overlappingSequenceTrigger =
sequenceTriggersOverlappingParallelTriggers[triggerIndex]
// Only consider the sequence triggers where this
// short press trigger has been already pressed
// or will be pressed next.
.filter {
for (i in 0..(lastMatchedEventIndices[it] + 1)) {
val matchingEvent = triggers[it].matchingEventAtIndex(
event.withShortPress,
i,
)

if (matchingEvent) {
return@filter true
}
}

return@filter false
}
.maxByOrNull { sequenceTriggerTimeout(triggers[it]) }

if (overlappingSequenceTrigger == null) {
val actionKeys = triggerActions[triggerIndex]

actionKeys.forEach { actionKey ->
val action = actionMap[actionKey] ?: return@forEach
actionKeys.forEach { actionKey ->
val action = actionMap[actionKey] ?: return@forEach

if (action.data is ActionData.InputKeyEvent) {
val actionKeyCode = action.data.keyCode
if (action.data is ActionData.InputKeyEvent) {
val actionKeyCode = action.data.keyCode

if (isModifierKey(actionKeyCode)) {
val actionMetaState =
InputEventUtils.modifierKeycodeToMetaState(actionKeyCode)
metaStateFromActions =
metaStateFromActions.withFlag(actionMetaState)
if (isModifierKey(actionKeyCode)) {
val actionMetaState =
InputEventUtils.modifierKeycodeToMetaState(actionKeyCode)
metaStateFromActions =
metaStateFromActions.withFlag(actionMetaState)
}
}
}

detectedShortPressTriggers.add(triggerIndex)
detectedShortPressTriggers.add(triggerIndex)

val vibrateDuration = when {
trigger.vibrate -> vibrateDuration(trigger)
forceVibrate.value -> defaultVibrateDuration.value
else -> -1L
val vibrateDuration = when {
trigger.vibrate -> vibrateDuration(trigger)
forceVibrate.value -> defaultVibrateDuration.value
else -> -1L
}

vibrateDurations.add(vibrateDuration)
}
} else {
performActionsAfterSequenceTriggerTimeout[triggerIndex]?.cancel()

vibrateDurations.add(vibrateDuration)
performActionsAfterSequenceTriggerTimeout[triggerIndex] =
performActionsAfterSequenceTriggerTimeout(
triggerIndex,
overlappingSequenceTrigger,
)
}
}
}
Expand Down Expand Up @@ -1443,14 +1481,14 @@ class KeyMapController(
metaStateFromKeyEvent = 0
keyCodesToImitateUpAction = mutableSetOf()

parallelTriggerLongPressJobs.valueIterator().forEach {
it.cancel()
}

parallelTriggerLongPressJobs.valueIterator().forEach { it.cancel() }
parallelTriggerLongPressJobs.clear()

parallelTriggerActionPerformers.values.forEach { it.reset() }
sequenceTriggerActionPerformers.values.forEach { it.reset() }

performActionsAfterSequenceTriggerTimeout.forEach { (_, job) -> job.cancel() }
performActionsAfterSequenceTriggerTimeout.clear()
}

/**
Expand Down Expand Up @@ -1499,6 +1537,40 @@ class KeyMapController(
return detectedTriggerIndexes.isNotEmpty()
}

/**
* For parallel triggers only.
*/
private fun performActionsAfterSequenceTriggerTimeout(
triggerIndex: Int,
sequenceTriggerIndex: Int,
) = coroutineScope.launch {
val timeout = sequenceTriggerTimeout(triggers[sequenceTriggerIndex])

delay(timeout)

// If it equals -1 then it means the sequence trigger was triggered
// and it reset the counter.
if (lastMatchedEventIndices[sequenceTriggerIndex] == -1) {
return@launch
}

parallelTriggerActionPerformers[triggerIndex]?.onTriggered(
calledOnTriggerRelease = true,
metaState = metaStateFromActions.withFlag(metaStateFromKeyEvent),
)

if (triggers[triggerIndex].vibrate ||
forceVibrate.value ||
triggers[triggerIndex].longPressDoubleVibration
) {
useCase.vibrate(vibrateDuration(triggers[triggerIndex]))
}

if (triggers[triggerIndex].showToast) {
useCase.showTriggeredToast()
}
}

private fun encodeActionList(actions: List<KeyMapAction>): IntArray = actions.map { getActionKey(it) }.toIntArray()

/**
Expand Down
Loading

0 comments on commit a069c89

Please # to comment.