// Copyright (c) 2006-2008 by Martin Stubenschrott // Copyright (c) 2007-2009 by Doug Kearns // Copyright (c) 2008-2010 by Kris Maglione // // This work is licensed for reuse under an MIT license. Details are // given in the LICENSE.txt file included with this file. "use strict"; /** @scope modules */ const Modes = Module("modes", { init: function () { this.modeChars = {}; this._main = 1; // NORMAL this._extended = 0; // NONE this._lastShown = null; this._passNextKey = false; this._passAllKeys = false; this._isRecording = false; this._isReplaying = false; // playing a macro this._modeStack = update([], { pop: function pop() { if (this.length <= 1) { util.dumpStack("Trying to pop last element in mode stack"); throw Error("Trying to pop last element in mode stack"); } return pop.superapply(this, arguments); } }); this._mainModes = [this.NONE]; this._lastMode = 0; this._modeMap = {}; this.boundProperties = {}; // main modes, only one should ever be active this.addMode("NORMAL", { char: "n", display: function () null }); this.addMode("INSERT", { char: "i", input: true, ownsFocus: true }); this.addMode("VISUAL", { char: "v", ownsFocus: true, display: function () "VISUAL" + (this._extended & modes.LINE ? " LINE" : "") }, { leave: function (stack, newMode) { if (newMode.main == modes.CARET) { let selection = window.content.getSelection(); if (selection && !selection.isCollapsed) selection.collapseToStart(); } else editor.unselectText(); } }); this.addMode("COMMAND_LINE", { char: "c", input: true, display: function () modes.extended & modes.OUTPUT_MULTILINE ? null : this.disp }); this.addMode("CARET", {}, { get pref() options.getPref("accessibility.browsewithcaret"), set pref(val) options.setPref("accessibility.browsewithcaret", val), enter: function (stack) { if (stack.pop && !this.pref) modes.pop(); else if (!stack.pop && !this.pref) this.pref = true; }, leave: function (stack) { if (!stack.push && this.pref) this.pref = false; } }); this.addMode("TEXT_EDIT", { char: "t", ownsFocus: true }); this.addMode("EMBED", { input: true, ownsFocus: true }); this.addMode("PASS_THROUGH"); this.addMode("QUOTE", { display: function () modes.getStack(1).main == modes.PASS_THROUGH ? (modes.getStack(2).mainMode.display() || modes.getStack(2).mainMode.name) + " (next)" : "PASS THROUGH (next)" }); // this._extended modes, can include multiple modes, and even main modes this.addMode("EX", true); this.addMode("HINTS", true); this.addMode("INPUT_MULTILINE", true); this.addMode("OUTPUT_MULTILINE", true); this.addMode("SEARCH_FORWARD", true); this.addMode("SEARCH_BACKWARD", true); this.addMode("MENU", true); // a popupmenu is active this.addMode("LINE", true); // linewise visual mode this.addMode("PROMPT", true); this.push(this.NORMAL, 0, { enter: function (stack, prev) { if (options.getPref("accessibility.browsewithcaret")) options.setPref("accessibility.browsewithcaret", false); statusline.updateUrl(); if (prev.mainMode.input || prev.mainMode.ownsFocus) dactyl.focusContent(true); if (prev.main === modes.NORMAL) { dactyl.focusContent(true); // clear any selection made let selection = window.content.getSelection(); if (selection && !selection.isCollapsed) selection.collapseToStart(); } } }); }, _getModeMessage: function () { // when recording a macro let macromode = ""; if (modes.isRecording) macromode = "recording"; else if (modes.isReplaying) macromode = "replaying"; let ext = ""; if (this._extended & modes.MENU) // TODO: desirable? ext += " (menu)"; ext += " --" + macromode; let val = this._modeMap[this._main].display(); if (val) return "-- " + val + ext; return macromode; }, NONE: 0, __iterator__: function () array.iterValues(this.all), get all() this._mainModes.slice(), get mainModes() (mode for ([k, mode] in Iterator(modes._modeMap)) if (!mode.extended && mode.name == k)), get mainMode() this._modeMap[this._main], get topOfStack() this._modeStack[this._modeStack.length - 1], addMode: function (name, extended, options, params) { let disp = name.replace("_", " ", "g"); this[name] = 1 << this._lastMode++; if (typeof extended == "object") { params = options; options = extended; extended = false; } let mode = util.extend({ count: true, disp: disp, extended: extended, input: false, mask: this[name], name: name, params: params || {} }, options); if (mode.char) { this.modeChars[mode.char] = this.modeChars[mode.char] || []; this.modeChars[mode.char].push(mode); } if (mode.display == null) mode.display = function () disp; this._modeMap[name] = mode; this._modeMap[this[name]] = mode; if (!extended) this._mainModes.push(this[name]); dactyl.triggerObserver("mode-add", mode); }, getMode: function (name) this._modeMap[name], getStack: function (idx) this._modeStack[this._modeStack.length - idx - 1] || this._modeStack[0], getCharModes: function (chr) [m for (m in values(this._modeMap)) if (m.char == chr)], matchModes: function (obj) [m for (m in values(this._modeMap)) if (Object.keys(obj).every(function (k) obj[k] == (m[k] || false)))], // show the current mode string in the command line show: function () { let msg = null; if (options["showmode"]) msg = this._getModeMessage(); if (loaded.commandline) commandline.widgets.mode = msg || null; }, // add/remove always work on the this._extended mode only add: function (mode) { this._extended |= mode; this.show(); }, delayed: [], delay: function (callback, self) { this.delayed.push([callback, self]) }, save: function (id, obj, prop) { if (!(id in this.boundProperties)) for (let elem in array.iterValues(this._modeStack)) elem.saved[id] = { obj: obj, prop: prop, value: obj[prop] }; this.boundProperties[id] = { obj: Cu.getWeakReference(obj), prop: prop }; }, // helper function to set both modes in one go // if silent == true, you also need to take care of the mode handling changes yourself set: function (mainMode, extendedMode, params, stack) { params = params || this.getMode(mainMode || this.main).params; if (!stack && mainMode != null && this._modeStack.length > 1) this.reset(); let oldMain = this._main, oldExtended = this._extended; if (typeof extendedMode === "number") this._extended = extendedMode; if (typeof mainMode === "number") { this._main = mainMode; if (!extendedMode) this._extended = this.NONE; } if (stack && stack.pop && stack.pop.params.leave) stack.pop.params.leave(stack, this.topOfStack); let push = mainMode != null && !(stack && stack.pop) && Modes.StackElem(this._main, this._extended, params, {}); if (push && this.topOfStack) { if (this.topOfStack.params.leave) this.topOfStack.params.leave({ push: push }, push); for (let [id, { obj, prop }] in Iterator(this.boundProperties)) { if (!obj.get()) delete this.boundProperties(id); else this.topOfStack.saved[id] = { obj: obj.get(), prop: prop, value: obj.get()[prop] }; } } this.delayed.forEach(function ([fn, self]) fn.call(self)); this.delayed = []; let prev = stack && stack.pop || this.topOfStack; if (push) this._modeStack.push(push); if (stack && stack.pop) { for (let [k, { obj, prop, value }] in Iterator(this.topOfStack.saved)) obj[prop] = value; } if (this.topOfStack.params.enter && prev) this.topOfStack.params.enter(push ? { push: push } : stack || {}, prev); dactyl.triggerObserver("modeChange", [oldMain, oldExtended], [this._main, this._extended], stack); this.show(); }, push: function (mainMode, extendedMode, params) { this.set(mainMode, extendedMode, params, { push: this.topOfStack }); }, pop: function (mode) { while (this._modeStack.length > 1 && this.main != mode) { let a = this._modeStack.pop(); this.set(this.topOfStack.main, this.topOfStack.extended, this.topOfStack.params, { pop: a }); if (mode == null) return; } }, replace: function (mode, oldMode) { while (oldMode && this._modeStack.length > 1 && this.main != oldMode) this.pop(); if (this._modeStack.length > 1) this.set(mode, null, null, { push: this.topOfStack, pop: this._modeStack.pop() }); this.push(mode); }, reset: function () { if (this._modeStack.length == 1 && this.topOfStack.params.enter) this.topOfStack.params.enter({}, this.topOfStack); while (this._modeStack.length > 1) this.pop(); }, remove: function (mode) { if (this._extended & mode) { this._extended &= ~mode; this.show(); } }, get isRecording() this._isRecording, set isRecording(value) { this._isRecording = value; this.show(); }, get isReplaying() this._isReplaying, set isReplaying(value) { this._isReplaying = value; this.show(); }, get main() this._main, set main(value) { this.set(value); }, get extended() this._extended, set extended(value) { this.set(null, value); } }, { StackElem: (function () { let struct = Struct("main", "extended", "params", "saved"); struct.prototype.__defineGetter__("mainMode", function () modes.getMode(this.main)); struct.prototype.toString = function () !loaded.modes ? this.main : "[mode " + modes.getMode(this.main).name + (!this.extended ? "" : "(" + [modes.getMode(1<