mirror of
https://github.com/vale981/tridactyl
synced 2025-03-10 04:36:39 -04:00
b9ff5703a2
This fixes https://github.com/cmcaine/tridactyl/issues/613. This was a really fun bug. What happened was this: - First, the content script set state.mode to "hint", which was then synchronized - The event listener in the background script noticed the update and set state.mode to "hint" in the background script - Then, the content script translated the hint selection into an excmd that needed to be executed in the background script and sent said command to the controller, which lives in the background script - The content script then set state.mode to "normal" - The background script executed the command and saved it in state.last_ex_str, which was then synchronized - The event listener in the content script noticed the update and set last_ex_str to the last executed str and "state.mode" to "hint" So basically, the problem was that the background script didn't notice the state.mode update right after it happened. I fixed this by moving last_ex_str out of "state" since it doesn't need to be synchronized with the content script. This means that the same kind of race condition can still happen. I'm not sure how to fix this. We could just kill state completely and instead have state be updated through message passing, but this probably wouldn't be very ergonomic. Another solution, the one envisioned for Tridactylv2, is to move to the content script entirely. This is probably the best option.
130 lines
4.4 KiB
TypeScript
130 lines
4.4 KiB
TypeScript
import { MsgSafeKeyboardEvent, MsgSafeNode } from "./msgsafe"
|
|
import { isTextEditable } from "./dom"
|
|
import { isSimpleKey } from "./keyseq"
|
|
import state from "./state"
|
|
import { repeat } from "./.excmds_background.generated"
|
|
import Logger from "./logging"
|
|
|
|
import { parser as exmode_parser } from "./parsers/exmode"
|
|
import { parser as hintmode_parser } from "./hinting_background"
|
|
import { parser as findmode_parser } from "./finding_background"
|
|
import * as normalmode from "./parsers/normalmode"
|
|
import * as insertmode from "./parsers/insertmode"
|
|
import * as ignoremode from "./parsers/ignoremode"
|
|
import * as gobblemode from "./parsers/gobblemode"
|
|
import * as inputmode from "./parsers/inputmode"
|
|
|
|
const logger = new Logger("controller")
|
|
|
|
/** Accepts keyevents, resolves them to maps, maps to exstrs, executes exstrs */
|
|
function* ParserController() {
|
|
const parsers = {
|
|
normal: normalmode.parser,
|
|
insert: insertmode.parser,
|
|
ignore: ignoremode.parser,
|
|
hint: hintmode_parser,
|
|
find: findmode_parser,
|
|
gobble: gobblemode.parser,
|
|
input: inputmode.parser,
|
|
}
|
|
|
|
while (true) {
|
|
let exstr = ""
|
|
let keyEvents = []
|
|
try {
|
|
while (true) {
|
|
let keyevent: MsgSafeKeyboardEvent = yield
|
|
|
|
// This code was sort of the cause of the most serious bug in Tridactyl
|
|
// to date (March 2018).
|
|
// https://github.com/cmcaine/tridactyl/issues/311
|
|
if (
|
|
state.mode != "ignore" &&
|
|
state.mode != "hint" &&
|
|
state.mode != "input" &&
|
|
state.mode != "find"
|
|
) {
|
|
if (isTextEditable(keyevent.target)) {
|
|
if (state.mode !== "insert") {
|
|
state.mode = "insert"
|
|
}
|
|
} else if (state.mode === "insert") {
|
|
state.mode = "normal"
|
|
}
|
|
} else if (
|
|
state.mode === "input" &&
|
|
!isTextEditable(keyevent.target)
|
|
) {
|
|
state.mode = "normal"
|
|
}
|
|
logger.debug(keyevent, state.mode)
|
|
|
|
keyEvents.push(keyevent)
|
|
let response = undefined
|
|
switch (state.mode) {
|
|
case "normal":
|
|
response = (parsers[state.mode] as any)(keyEvents)
|
|
// Compatibility with other parsers.
|
|
response.exstr = response.value
|
|
break
|
|
default:
|
|
response = (parsers[state.mode] as any)([keyevent])
|
|
break
|
|
}
|
|
logger.debug(keyEvents, response)
|
|
|
|
if (response.exstr) {
|
|
exstr = response.exstr
|
|
break
|
|
} else {
|
|
keyEvents = response.keys
|
|
}
|
|
}
|
|
acceptExCmd(exstr)
|
|
} catch (e) {
|
|
// Rumsfeldian errors are caught here
|
|
logger.error(
|
|
"An error occurred in the controller: ",
|
|
e,
|
|
" ¯\\_(ツ)_/¯",
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
let generator = ParserController() // var rather than let stops weirdness in repl.
|
|
generator.next()
|
|
|
|
/** Feed keys to the ParserController */
|
|
export function acceptKey(keyevent: MsgSafeKeyboardEvent) {
|
|
generator.next(keyevent)
|
|
}
|
|
|
|
export let last_ex_str = ""
|
|
|
|
/** Parse and execute ExCmds */
|
|
export async function acceptExCmd(exstr: string): Promise<any> {
|
|
// TODO: Errors should go to CommandLine.
|
|
try {
|
|
let [func, args] = exmode_parser(exstr)
|
|
// Stop the repeat excmd from recursing.
|
|
if (func !== repeat) last_ex_str = exstr
|
|
try {
|
|
return await func(...args)
|
|
} catch (e) {
|
|
// Errors from func are caught here (e.g. no next tab)
|
|
logger.error(e)
|
|
}
|
|
} catch (e) {
|
|
// Errors from parser caught here
|
|
logger.error(e)
|
|
}
|
|
}
|
|
|
|
import { activeTabId } from "./lib/webext"
|
|
browser.webNavigation.onBeforeNavigate.addListener(async function(details) {
|
|
if (details.frameId === 0 && details.tabId === (await activeTabId())) {
|
|
state.mode = "normal"
|
|
}
|
|
})
|
|
browser.tabs.onActivated.addListener(() => (state.mode = "normal"))
|