tridactyl/src/controller.ts

import { MsgSafeKeyboardEvent, MsgSafeNode } from "./msgsafe"
import { isTextEditable } from "./dom"
import { isSimpleKey } from "./keyseq"
import state from "./state"
import { repeat } from "./excmds_background"
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
            console.error("Tridactyl ParserController fatally wounded:", 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)
}

/** Parse and execute ExCmds */
export function acceptExCmd(exstr: string) {
    // TODO: Errors should go to CommandLine.
    try {
        let [func, args] = exmode_parser(exstr)
        // Stop the repeat excmd from recursing.
        if (func !== repeat) state.last_ex_str = exstr
        try {
            func(...args)
        } catch (e) {
            // Errors from func are caught here (e.g. no next tab)
            console.error(e)
        }
    } catch (e) {
        // Errors from parser caught here
        console.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"))