common/content/events.js

   1 // Copyright (c) 2006-2008 by Martin Stubenschrott <stubenschrott@vimperator.org>
   2 // Copyright (c) 2007-2011 by Doug Kearns <dougkearns@gmail.com>
   3 // Copyright (c) 2008-2011 by Kris Maglione <maglione.k at Gmail>
   4 //
   5 // This work is licensed for reuse under an MIT license. Details are
   6 // given in the LICENSE.txt file included with this file.
   7 /* use strict */
   8
   9 /** @scope modules */
  10
  11 /**
  12  * A hive used mainly for tracking event listeners and cleaning them up when a
  13  * group is destroyed.
  14  */
  15 var EventHive = Class("EventHive", Contexts.Hive, {
  16     init: function init(group) {
  17         init.supercall(this, group);
  18         this.sessionListeners = [];
  19     },
  20
  21     cleanup: function cleanup() {
  22         this.unlisten(null);
  23     },
  24
  25     _events: function _events(event, callback) {
  26         if (!isObject(event))
  27             var [self, events] = [null, array.toObject([[event, callback]])];
  28         else
  29             [self, events] = [event, event[callback || "events"]];
  30
  31         if (Set.has(events, "input") && !Set.has(events, "dactyl-input"))
  32             events["dactyl-input"] = events.input;
  33
  34         return [self, events];
  35     },
  36
  37     /**
  38      * Adds an event listener for this session and removes it on
  39      * dactyl shutdown.
  40      *
  41      * @param {Element} target The element on which to listen.
  42      * @param {string} event The event to listen for.
  43      * @param {function} callback The function to call when the event is received.
  44      * @param {boolean} capture When true, listen during the capture
  45      *      phase, otherwise during the bubbling phase.
  46      * @param {boolean} allowUntrusted When true, allow capturing of
  47      *      untrusted events.
  48      */
  49     listen: function (target, event, callback, capture, allowUntrusted) {
  50         var [self, events] = this._events(event, callback);
  51
  52         for (let [event, callback] in Iterator(events)) {
  53             let args = [util.weakReference(target),
  54                         util.weakReference(self),
  55                         event,
  56                         this.wrapListener(callback, self),
  57                         capture,
  58                         allowUntrusted];
  59
  60             target.addEventListener.apply(target, args.slice(2));
  61             this.sessionListeners.push(args);
  62         }
  63     },
  64
  65     /**
  66      * Remove an event listener.
  67      *
  68      * @param {Element} target The element on which to listen.
  69      * @param {string} event The event to listen for.
  70      * @param {function} callback The function to call when the event is received.
  71      * @param {boolean} capture When true, listen during the capture
  72      *      phase, otherwise during the bubbling phase.
  73      */
  74     unlisten: function (target, event, callback, capture) {
  75         if (target != null)
  76             var [self, events] = this._events(event, callback);
  77
  78         this.sessionListeners = this.sessionListeners.filter(function (args) {
  79             let elem = args[0].get();
  80             if (target == null || elem == target
  81                                && self == args[1].get()
  82                                && Set.has(events, args[2])
  83                                && args[3].wrapped == events[args[2]]
  84                                && args[4] == capture) {
  85
  86                 elem.removeEventListener.apply(elem, args.slice(2));
  87                 return false;
  88             }
  89             return elem;
  90         });
  91     },
  92
  93     get wrapListener() events.closure.wrapListener
  94 });
  95
  96 /**
  97  * @instance events
  98  */
  99 var Events = Module("events", {
 100     dbg: function () {},
 101
 102     init: function () {
 103         this.keyEvents = [];
 104
 105         XML.ignoreWhitespace = true;
 106         overlay.overlayWindow(window, {
 107             append: <e4x xmlns={XUL}>
 108                 <window id={document.documentElement.id}>
 109                     <!-- http://developer.mozilla.org/en/docs/XUL_Tutorial:Updating_Commands -->
 110                     <commandset id="dactyl-onfocus" commandupdater="true" events="focus"
 111                                 oncommandupdate="dactyl.modules.events.onFocusChange(event);"/>
 112                     <commandset id="dactyl-onselect" commandupdater="true" events="select"
 113                                 oncommandupdate="dactyl.modules.events.onSelectionChange(event);"/>
 114                 </window>
 115             </e4x>.elements()
 116         });
 117
 118         this._fullscreen = window.fullScreen;
 119         this._lastFocus = null;
 120         this._macroKeys = [];
 121         this._lastMacro = "";
 122
 123         this._macros = storage.newMap("registers", { privateData: true, store: true });
 124         if (storage.exists("macros")) {
 125             for (let [k, m] in storage.newMap("macros", { store: true }))
 126                 this._macros.set(k, { text: m.keys, timestamp: m.timeRecorded * 1000 });
 127             storage.remove("macros");
 128         }
 129
 130         this.popups = {
 131             active: [],
 132
 133             activeMenubar: null,
 134
 135             update: function update(elem) {
 136                 if (elem) {
 137                     if (elem instanceof Ci.nsIAutoCompletePopup
 138                             || elem.localName == "tooltip"
 139                             || !elem.popupBoxObject)
 140                         return;
 141
 142                     if (!~this.active.indexOf(elem))
 143                         this.active.push(elem);
 144                 }
 145
 146                 this.active = this.active.filter(function (e) e.popupBoxObject.popupState != "closed");
 147
 148                 if (!this.active.length && !this.activeMenubar)
 149                     modes.remove(modes.MENU, true);
 150                 else if (modes.main != modes.MENU)
 151                     modes.push(modes.MENU);
 152             },
 153
 154             events: {
 155                 DOMMenuBarActive: function onDOMMenuBarActive(event) {
 156                     this.activeMenubar = event.target;
 157                     if (modes.main != modes.MENU)
 158                         modes.push(modes.MENU);
 159                 },
 160
 161                 DOMMenuBarInactive: function onDOMMenuBarInactive(event) {
 162                     this.activeMenubar = null;
 163                     modes.remove(modes.MENU, true);
 164                 },
 165
 166                 popupshowing: function onPopupShowing(event) {
 167                     this.update(event.originalTarget);
 168                 },
 169
 170                 popupshown: function onPopupShown(event) {
 171                     let elem = event.originalTarget;
 172                     this.update(elem);
 173
 174                     if (elem instanceof Ci.nsIAutoCompletePopup) {
 175                         if (modes.main != modes.AUTOCOMPLETE)
 176                             modes.push(modes.AUTOCOMPLETE);
 177                     }
 178                     else if (elem.hidePopup && elem.localName !== "tooltip"
 179                                 && Events.isHidden(elem)
 180                                 && Events.isHidden(elem.parentNode)) {
 181                         elem.hidePopup();
 182                     }
 183                 },
 184
 185                 popuphidden: function onPopupHidden(event) {
 186                     this.update();
 187                     modes.remove(modes.AUTOCOMPLETE);
 188                 }
 189             }
 190         };
 191
 192         this.listen(window, this, "events", true);
 193         this.listen(window, this.popups, "events", true);
 194     },
 195
 196     cleanup: function cleanup() {
 197         let elem = dactyl.focusedElement;
 198         if (DOM(elem).isEditable)
 199             util.trapErrors("removeEditActionListener",
 200                             DOM(elem).editor, editor);
 201     },
 202
 203     signals: {
 204         "browser.locationChange": function (webProgress, request, uri) {
 205             options.get("passkeys").flush();
 206         },
 207         "modes.change": function (oldMode, newMode) {
 208             delete this.processor;
 209         }
 210     },
 211
 212     get listen() this.builtin.closure.listen,
 213     addSessionListener: deprecated("events.listen", { get: function addSessionListener() this.listen }),
 214
 215     /**
 216      * Wraps an event listener to ensure that errors are reported.
 217      */
 218     wrapListener: function wrapListener(method, self) {
 219         self = self || this;
 220         method.wrapper = wrappedListener;
 221         wrappedListener.wrapped = method;
 222         function wrappedListener(event) {
 223             try {
 224                 method.apply(self, arguments);
 225             }
 226             catch (e) {
 227                 dactyl.reportError(e);
 228                 if (e.message == "Interrupted")
 229                     dactyl.echoerr(_("error.interrupted"), commandline.FORCE_SINGLELINE);
 230                 else
 231                     dactyl.echoerr(_("event.error", event.type, e.echoerr || e),
 232                                    commandline.FORCE_SINGLELINE);
 233             }
 234         };
 235         return wrappedListener;
 236     },
 237
 238     /**
 239      * @property {boolean} Whether synthetic key events are currently being
 240      *     processed.
 241      */
 242     feedingKeys: false,
 243
 244     /**
 245      * Initiates the recording of a key event macro.
 246      *
 247      * @param {string} macro The name for the macro.
 248      */
 249     _recording: null,
 250     get recording() this._recording,
 251
 252     set recording(macro) {
 253         dactyl.assert(macro == null || /[a-zA-Z0-9]/.test(macro),
 254                       _("macro.invalid", macro));
 255
 256         modes.recording = macro;
 257
 258         if (/[A-Z]/.test(macro)) { // Append.
 259             macro = macro.toLowerCase();
 260             this._macroKeys = DOM.Event.iterKeys(editor.getRegister(macro))
 261                                  .toArray();
 262         }
 263         else if (macro) { // Record afresh.
 264             this._macroKeys = [];
 265         }
 266         else if (this.recording) { // Save.
 267             editor.setRegister(this.recording, this._macroKeys.join(""));
 268
 269             dactyl.log(_("macro.recorded", this.recording, this._macroKeys.join("")), 9);
 270             dactyl.echomsg(_("macro.recorded", this.recording));
 271         }
 272         this._recording = macro || null;
 273     },
 274
 275     /**
 276      * Replays a macro.
 277      *
 278      * @param {string} The name of the macro to replay.
 279      * @returns {boolean}
 280      */
 281     playMacro: function (macro) {
 282         dactyl.assert(/^[a-zA-Z0-9@]$/.test(macro),
 283                       _("macro.invalid", macro));
 284
 285         if (macro == "@")
 286             dactyl.assert(this._lastMacro, _("macro.noPrevious"));
 287         else
 288             this._lastMacro = macro.toLowerCase(); // XXX: sets last played macro, even if it does not yet exist
 289
 290         let keys = editor.getRegister(this._lastMacro);
 291         if (keys)
 292             return modes.withSavedValues(["replaying"], function () {
 293                 this.replaying = true;
 294                 return events.feedkeys(keys, { noremap: true });
 295             });
 296
 297         // TODO: ignore this like Vim?
 298         dactyl.echoerr(_("macro.noSuch", this._lastMacro));
 299         return false;
 300     },
 301
 302     /**
 303      * Returns all macros matching *filter*.
 304      *
 305      * @param {string} filter A regular expression filter string. A null
 306      *     filter selects all macros.
 307      */
 308     getMacros: function (filter) {
 309         let re = RegExp(filter || "");
 310         return ([k, m.text] for ([k, m] in editor.registers) if (re.test(k)));
 311     },
 312
 313     /**
 314      * Deletes all macros matching *filter*.
 315      *
 316      * @param {string} filter A regular expression filter string. A null
 317      *     filter deletes all macros.
 318      */
 319     deleteMacros: function (filter) {
 320         let re = RegExp(filter || "");
 321         for (let [item, ] in editor.registers) {
 322             if (!filter || re.test(item))
 323                 editor.registers.remove(item);
 324         }
 325     },
 326
 327     /**
 328      * Feeds a list of events to *target* or the originalTarget member
 329      * of each event if *target* is null.
 330      *
 331      * @param {EventTarget} target The destination node for the events.
 332      *      @optional
 333      * @param {[Event]} list The events to dispatch.
 334      * @param {object} extra Extra properties for processing by dactyl.
 335      *      @optional
 336      */
 337     feedevents: function feedevents(target, list, extra) {
 338         list.forEach(function _feedevent(event, i) {
 339             let elem = target || event.originalTarget;
 340             if (elem) {
 341                 let doc = elem.ownerDocument || elem.document || elem;
 342                 let evt = DOM.Event(doc, event.type, event);
 343                 DOM.Event.dispatch(elem, evt, extra);
 344             }
 345             else if (i > 0 && event.type === "keypress")
 346                 events.events.keypress.call(events, event);
 347         });
 348     },
 349
 350     /**
 351      * Pushes keys onto the event queue from dactyl. It is similar to
 352      * Vim's feedkeys() method, but cannot cope with 2 partially-fed
 353      * strings, you have to feed one parseable string.
 354      *
 355      * @param {string} keys A string like "2<C-f>" to push onto the event
 356      *     queue. If you want "<" to be taken literally, prepend it with a
 357      *     "\\".
 358      * @param {boolean} noremap Whether recursive mappings should be
 359      *     disallowed.
 360      * @param {boolean} silent Whether the command should be echoed to the
 361      *     command line.
 362      * @returns {boolean}
 363      */
 364     feedkeys: function (keys, noremap, quiet, mode) {
 365         try {
 366             var savedEvents = this._processor && this._processor.keyEvents;
 367
 368             var wasFeeding = this.feedingKeys;
 369             this.feedingKeys = true;
 370
 371             var wasQuiet = commandline.quiet;
 372             if (quiet)
 373                 commandline.quiet = quiet;
 374
 375             keys = mappings.expandLeader(keys);
 376
 377             for (let [, evt_obj] in Iterator(DOM.Event.parse(keys))) {
 378                 let now = Date.now();
 379                 let key = DOM.Event.stringify(evt_obj);
 380                 for (let type in values(["keydown", "keypress", "keyup"])) {
 381                     let evt = update({}, evt_obj, { type: type });
 382                     if (type !== "keypress" && !evt.keyCode)
 383                         evt.keyCode = evt._keyCode || 0;
 384
 385                     if (isObject(noremap))
 386                         update(evt, noremap);
 387                     else
 388                         evt.noremap = !!noremap;
 389                     evt.isMacro = true;
 390                     evt.dactylMode = mode;
 391                     evt.dactylSavedEvents = savedEvents;
 392                     DOM.Event.feedingEvent = evt;
 393
 394                     let doc = document.commandDispatcher.focusedWindow.document;
 395
 396                     let target = dactyl.focusedElement
 397                               || ["complete", "interactive"].indexOf(doc.readyState) >= 0 && doc.documentElement
 398                               || doc.defaultView;
 399
 400                     if (target instanceof Element && !Events.isInputElement(target) &&
 401                         ["<Return>", "<Space>"].indexOf(key) == -1)
 402                         target = target.ownerDocument.documentElement;
 403
 404                     let event = DOM.Event(doc, type, evt);
 405                     if (!evt_obj.dactylString && !mode)
 406                         DOM.Event.dispatch(target, event, evt);
 407                     else if (type === "keypress")
 408                         events.events.keypress.call(events, event);
 409                 }
 410
 411                 if (!this.feedingKeys)
 412                     return false;
 413             }
 414         }
 415         catch (e) {
 416             util.reportError(e);
 417         }
 418         finally {
 419             DOM.Event.feedingEvent = null;
 420             this.feedingKeys = wasFeeding;
 421             if (quiet)
 422                 commandline.quiet = wasQuiet;
 423             dactyl.triggerObserver("events.doneFeeding");
 424         }
 425         return true;
 426     },
 427
 428     canonicalKeys: deprecated("DOM.Event.canonicalKeys", { get: function canonicalKeys() DOM.Event.closure.canonicalKeys }),
 429     create:        deprecated("DOM.Event", function create() DOM.Event.apply(null, arguments)),
 430     dispatch:      deprecated("DOM.Event.dispatch", function dispatch() DOM.Event.dispatch.apply(DOM.Event, arguments)),
 431     fromString:    deprecated("DOM.Event.parse", { get: function fromString() DOM.Event.closure.parse }),
 432     iterKeys:      deprecated("DOM.Event.iterKeys", { get: function iterKeys() DOM.Event.closure.iterKeys }),
 433
 434     toString: function toString() {
 435         if (!arguments.length)
 436             return toString.supercall(this);
 437
 438         deprecated.warn(toString, "toString", "DOM.Event.stringify");
 439         return DOM.Event.stringify.apply(DOM.Event, arguments);
 440     },
 441
 442     get defaultTarget() dactyl.focusedElement || content.document.body || document.documentElement,
 443
 444     /**
 445      * Returns true if there's a known native key handler for the given
 446      * event in the given mode.
 447      *
 448      * @param {Event} event A keypress event.
 449      * @param {Modes.Mode} mode The main mode.
 450      * @param {boolean} passUnknown Whether unknown keys should be passed.
 451      */
 452     hasNativeKey: function hasNativeKey(event, mode, passUnknown) {
 453         if (mode.input && event.charCode && !(event.ctrlKey || event.metaKey))
 454             return true;
 455
 456         if (!passUnknown)
 457             return false;
 458
 459         var elements = document.getElementsByTagNameNS(XUL, "key");
 460         var filters = [];
 461
 462         if (event.keyCode)
 463             filters.push(["keycode", this._code_nativeKey[event.keyCode]]);
 464         if (event.charCode) {
 465             let key = String.fromCharCode(event.charCode);
 466             filters.push(["key", key.toUpperCase()],
 467                          ["key", key.toLowerCase()]);
 468         }
 469
 470         let accel = config.OS.isMacOSX ? "metaKey" : "ctrlKey";
 471
 472         let access = iter({ 1: "shiftKey", 2: "ctrlKey", 4: "altKey", 8: "metaKey" })
 473                         .filter(function ([k, v]) this & k, prefs.get("ui.key.chromeAccess"))
 474                         .map(function ([k, v]) [v, true])
 475                         .toObject();
 476
 477     outer:
 478         for (let [, key] in iter(elements))
 479             if (filters.some(function ([k, v]) key.getAttribute(k) == v)) {
 480                 let keys = { ctrlKey: false, altKey: false, shiftKey: false, metaKey: false };
 481                 let needed = { ctrlKey: event.ctrlKey, altKey: event.altKey, shiftKey: event.shiftKey, metaKey: event.metaKey };
 482
 483                 let modifiers = (key.getAttribute("modifiers") || "").trim().split(/[\s,]+/);
 484                 for (let modifier in values(modifiers))
 485                     switch (modifier) {
 486                         case "access": update(keys, access); break;
 487                         case "accel":  keys[accel] = true; break;
 488                         default:       keys[modifier + "Key"] = true; break;
 489                         case "any":
 490                             if (!iter.some(keys, function ([k, v]) v && needed[k]))
 491                                 continue outer;
 492                             for (let [k, v] in iter(keys)) {
 493                                 if (v)
 494                                     needed[k] = false;
 495                                 keys[k] = false;
 496                             }
 497                             break;
 498                     }
 499
 500                 if (iter(needed).every(function ([k, v]) v == keys[k]))
 501                     return key;
 502             }
 503
 504         return false;
 505     },
 506
 507     /**
 508      * Returns true if *key* is a key code defined to accept/execute input on
 509      * the command line.
 510      *
 511      * @param {string} key The key code to test.
 512      * @returns {boolean}
 513      */
 514     isAcceptKey: function (key) key == "<Return>" || key == "<C-j>" || key == "<C-m>",
 515
 516     /**
 517      * Returns true if *key* is a key code defined to reject/cancel input on
 518      * the command line.
 519      *
 520      * @param {string} key The key code to test.
 521      * @returns {boolean}
 522      */
 523     isCancelKey: function (key) key == "<Esc>" || key == "<C-[>" || key == "<C-c>",
 524
 525     /**
 526      * Returns true if *node* belongs to the current content document or any
 527      * sub-frame thereof.
 528      *
 529      * @param {Node|Document|Window} node The node to test.
 530      * @returns {boolean}
 531      */
 532     isContentNode: function isContentNode(node) {
 533         let win = (node.ownerDocument || node).defaultView || node;
 534         return XPCNativeWrapper(win).top == content;
 535     },
 536
 537     /**
 538      * Waits for the current buffer to successfully finish loading. Returns
 539      * true for a successful page load otherwise false.
 540      *
 541      * @returns {boolean}
 542      */
 543     waitForPageLoad: function (time) {
 544         if (buffer.loaded)
 545             return true;
 546
 547         dactyl.echo(_("macro.loadWaiting"), commandline.FORCE_SINGLELINE);
 548
 549         const maxWaitTime = (time || 25);
 550         util.waitFor(function () buffer.loaded, this, maxWaitTime * 1000, true);
 551
 552         dactyl.echo("", commandline.FORCE_SINGLELINE);
 553         if (!buffer.loaded)
 554             dactyl.echoerr(_("macro.loadFailed", maxWaitTime));
 555
 556         return buffer.loaded;
 557     },
 558
 559     /**
 560      * Ensures that the currently focused element is visible and blurs
 561      * it if it's not.
 562      */
 563     checkFocus: function () {
 564         if (dactyl.focusedElement) {
 565             let rect = dactyl.focusedElement.getBoundingClientRect();
 566             if (!rect.width || !rect.height) {
 567                 services.focus.clearFocus(window);
 568                 document.commandDispatcher.focusedWindow = content;
 569                 // onFocusChange needs to die.
 570                 this.onFocusChange();
 571             }
 572         }
 573     },
 574
 575     events: {
 576         blur: function onBlur(event) {
 577             let elem = event.originalTarget;
 578             if (DOM(elem).isEditable)
 579                 util.trapErrors("removeEditActionListener",
 580                                 DOM(elem).editor, editor);
 581
 582             if (elem instanceof Window && services.focus.activeWindow == null
 583                 && document.commandDispatcher.focusedWindow !== window) {
 584                 // Deals with circumstances where, after the main window
 585                 // blurs while a collapsed frame has focus, re-activating
 586                 // the main window does not restore focus and we lose key
 587                 // input.
 588                 services.focus.clearFocus(window);
 589                 document.commandDispatcher.focusedWindow = Editor.getEditor(content) ? window : content;
 590             }
 591
 592             let hold = modes.topOfStack.params.holdFocus;
 593             if (elem == hold) {
 594                 dactyl.focus(hold);
 595                 this.timeout(function () { dactyl.focus(hold); });
 596             }
 597         },
 598
 599         // TODO: Merge with onFocusChange
 600         focus: function onFocus(event) {
 601             let elem = event.originalTarget;
 602             if (DOM(elem).isEditable)
 603                 util.trapErrors("addEditActionListener",
 604                                 DOM(elem).editor, editor);
 605
 606             if (elem == window)
 607                 overlay.activeWindow = window;
 608
 609             overlay.setData(elem, "had-focus", true);
 610             if (event.target instanceof Ci.nsIDOMXULTextBoxElement)
 611                 if (Events.isHidden(elem, true))
 612                     elem.blur();
 613
 614             let win = (elem.ownerDocument || elem).defaultView || elem;
 615
 616             if (!(services.focus.getLastFocusMethod(win) & 0x3000)
 617                 && events.isContentNode(elem)
 618                 && !buffer.focusAllowed(elem)
 619                 && isinstance(elem, [HTMLInputElement, HTMLSelectElement, HTMLTextAreaElement, Window])) {
 620
 621                 if (elem.frameElement)
 622                     dactyl.focusContent(true);
 623                 else if (!(elem instanceof Window) || Editor.getEditor(elem))
 624                     dactyl.focus(window);
 625             }
 626
 627             if (elem instanceof Element)
 628                 elem.dactylFocusAllowed = undefined;
 629         },
 630
 631         /*
 632         onFocus: function onFocus(event) {
 633             let elem = event.originalTarget;
 634             if (!(elem instanceof Element))
 635                 return;
 636             let win = elem.ownerDocument.defaultView;
 637
 638             try {
 639                 util.dump(elem, services.focus.getLastFocusMethod(win) & (0x7000));
 640                 if (buffer.focusAllowed(win))
 641                     win.dactylLastFocus = elem;
 642                 else if (isinstance(elem, [HTMLInputElement, HTMLSelectElement, HTMLTextAreaElement])) {
 643                     if (win.dactylLastFocus)
 644                         dactyl.focus(win.dactylLastFocus);
 645                     else
 646                         elem.blur();
 647                 }
 648             }
 649             catch (e) {
 650                 util.dump(win, String(elem.ownerDocument), String(elem.ownerDocument && elem.ownerDocument.defaultView));
 651                 util.reportError(e);
 652             }
 653         },
 654         */
 655
 656         input: function onInput(event) {
 657             event.originalTarget.dactylKeyPress = undefined;
 658         },
 659
 660         // this keypress handler gets always called first, even if e.g.
 661         // the command-line has focus
 662         // TODO: ...help me...please...
 663         keypress: function onKeyPress(event) {
 664             event.dactylDefaultPrevented = event.getPreventDefault();
 665
 666             let duringFeed = this.duringFeed || [];
 667             this.duringFeed = [];
 668             try {
 669                 if (DOM.Event.feedingEvent)
 670                     for (let [k, v] in Iterator(DOM.Event.feedingEvent))
 671                         if (!(k in event))
 672                             event[k] = v;
 673                 DOM.Event.feedingEvent = null;
 674
 675                 let key = DOM.Event.stringify(event);
 676
 677                 // Hack to deal with <BS> and so forth not dispatching input
 678                 // events
 679                 if (key && event.originalTarget instanceof HTMLInputElement && !modes.main.passthrough) {
 680                     let elem = event.originalTarget;
 681                     elem.dactylKeyPress = elem.value;
 682                     util.timeout(function () {
 683                         if (elem.dactylKeyPress !== undefined && elem.value !== elem.dactylKeyPress)
 684                             DOM(elem).dactylInput();
 685                         elem.dactylKeyPress = undefined;
 686                     });
 687                 }
 688
 689                 if (!key)
 690                      return null;
 691
 692                 if (modes.recording && !event.isReplay)
 693                     events._macroKeys.push(key);
 694
 695                 // feedingKeys needs to be separate from interrupted so
 696                 // we can differentiate between a recorded <C-c>
 697                 // interrupting whatever it's started and a real <C-c>
 698                 // interrupting our playback.
 699                 if (events.feedingKeys && !event.isMacro) {
 700                     if (key == "<C-c>") {
 701                         events.feedingKeys = false;
 702                         if (modes.replaying) {
 703                             modes.replaying = false;
 704                             this.timeout(function () { dactyl.echomsg(_("macro.canceled", this._lastMacro)); }, 100);
 705                         }
 706                     }
 707                     else
 708                         duringFeed.push(event);
 709
 710                     return Events.kill(event);
 711                 }
 712
 713                 if (!this.processor) {
 714                     let mode = modes.getStack(0);
 715                     if (event.dactylMode)
 716                         mode = Modes.StackElement(event.dactylMode);
 717
 718                     let ignore = false;
 719
 720                     if (mode.main == modes.PASS_THROUGH)
 721                         ignore = !Events.isEscape(key) && key != "<C-v>";
 722                     else if (mode.main == modes.QUOTE) {
 723                         if (modes.getStack(1).main == modes.PASS_THROUGH) {
 724                             mode = Modes.StackElement(modes.getStack(2).main);
 725                             ignore = Events.isEscape(key);
 726                         }
 727                         else if (events.shouldPass(event))
 728                             mode = Modes.StackElement(modes.getStack(1).main);
 729                         else
 730                             ignore = true;
 731
 732                         modes.pop();
 733                     }
 734                     else if (!event.isMacro && !event.noremap && events.shouldPass(event))
 735                         ignore = true;
 736
 737                     events.dbg("\n\n");
 738                     events.dbg("ON KEYPRESS " + key + " ignore: " + ignore,
 739                                event.originalTarget instanceof Element ? event.originalTarget : String(event.originalTarget));
 740
 741                     if (ignore)
 742                         return null;
 743
 744                     // FIXME: Why is this hard coded? --Kris
 745                     if (key == "<C-c>")
 746                         util.interrupted = true;
 747
 748                     this.processor = ProcessorStack(mode, mappings.hives.array, event.noremap);
 749                     this.processor.keyEvents = this.keyEvents;
 750                 }
 751
 752                 let { keyEvents, processor } = this;
 753                 this._processor = processor;
 754                 this.processor = null;
 755                 this.keyEvents = [];
 756
 757                 if (!processor.process(event)) {
 758                     this.keyEvents = keyEvents;
 759                     this.processor = processor;
 760                 }
 761
 762             }
 763             catch (e) {
 764                 dactyl.reportError(e);
 765             }
 766             finally {
 767                 [duringFeed, this.duringFeed] = [this.duringFeed, duringFeed];
 768                 if (this.feedingKeys)
 769                     this.duringFeed = this.duringFeed.concat(duringFeed);
 770                 else
 771                     for (let event in values(duringFeed))
 772                         try {
 773                             DOM.Event.dispatch(event.originalTarget, event, event);
 774                         }
 775                         catch (e) {
 776                             util.reportError(e);
 777                         }
 778             }
 779         },
 780
 781         keyup: function onKeyUp(event) {
 782             if (event.type == "keydown")
 783                 this.keyEvents.push(event);
 784             else if (!this.processor)
 785                 this.keyEvents = [];
 786
 787             let pass = this.passing && !event.isMacro ||
 788                     DOM.Event.feedingEvent && DOM.Event.feedingEvent.isReplay ||
 789                     event.isReplay ||
 790                     modes.main == modes.PASS_THROUGH ||
 791                     modes.main == modes.QUOTE
 792                         && modes.getStack(1).main !== modes.PASS_THROUGH
 793                         && !this.shouldPass(event) ||
 794                     !modes.passThrough && this.shouldPass(event) ||
 795                     !this.processor && event.type === "keydown"
 796                         && options.get("passunknown").getKey(modes.main.allBases)
 797                         && let (key = DOM.Event.stringify(event))
 798                             !modes.main.allBases.some(
 799                                 function (mode) mappings.hives.some(
 800                                     function (hive) hive.get(mode, key) || hive.getCandidates(mode, key)));
 801
 802             events.dbg("ON " + event.type.toUpperCase() + " " + DOM.Event.stringify(event) +
 803                        " passing: " + this.passing + " " +
 804                        " pass: " + pass +
 805                        " replay: " + event.isReplay +
 806                        " macro: " + event.isMacro);
 807
 808             if (event.type === "keydown")
 809                 this.passing = pass;
 810
 811             // Prevents certain sites from transferring focus to an input box
 812             // before we get a chance to process our key bindings on the
 813             // "keypress" event.
 814             if (!pass)
 815                 event.stopPropagation();
 816         },
 817         keydown: function onKeyDown(event) {
 818             if (!event.isMacro)
 819                 this.passing = false;
 820             this.events.keyup.call(this, event);
 821         },
 822
 823         mousedown: function onMouseDown(event) {
 824             let elem = event.target;
 825             let win = elem.ownerDocument && elem.ownerDocument.defaultView || elem;
 826
 827             for (; win; win = win != win.parent && win.parent) {
 828                 for (; elem instanceof Element; elem = elem.parentNode)
 829                     overlay.setData(elem, "focus-allowed", true);
 830                 overlay.setData(win.document, "focus-allowed", true);
 831             }
 832         },
 833
 834         resize: function onResize(event) {
 835             if (window.fullScreen != this._fullscreen) {
 836                 statusline.statusBar.removeAttribute("moz-collapsed");
 837                 this._fullscreen = window.fullScreen;
 838                 dactyl.triggerObserver("fullscreen", this._fullscreen);
 839                 autocommands.trigger("Fullscreen", { url: this._fullscreen ? "on" : "off", state: this._fullscreen });
 840             }
 841             statusline.updateZoomLevel();
 842         }
 843     },
 844
 845     // argument "event" is deliberately not used, as i don't seem to have
 846     // access to the real focus target
 847     // Huh? --djk
 848     onFocusChange: util.wrapCallback(function onFocusChange(event) {
 849         function hasHTMLDocument(win) win && win.document && win.document instanceof HTMLDocument
 850         if (dactyl.ignoreFocus)
 851             return;
 852
 853         let win  = window.document.commandDispatcher.focusedWindow;
 854         let elem = window.document.commandDispatcher.focusedElement;
 855
 856         if (elem == null && Editor.getEditor(win))
 857             elem = win;
 858
 859         if (win && win.top == content && dactyl.has("tabs"))
 860             buffer.focusedFrame = win;
 861
 862         try {
 863             if (elem && elem.readOnly)
 864                 return;
 865
 866             if (isinstance(elem, [HTMLEmbedElement, HTMLEmbedElement])) {
 867                 if (!modes.main.passthrough && modes.main != modes.EMBED)
 868                     modes.push(modes.EMBED);
 869                 return;
 870             }
 871
 872             let haveInput = modes.stack.some(function (m) m.main.input);
 873
 874             if (DOM(elem || win).isEditable) {
 875                 if (!haveInput)
 876                     if (!isinstance(modes.main, [modes.INPUT, modes.TEXT_EDIT, modes.VISUAL]))
 877                         if (options["insertmode"])
 878                             modes.push(modes.INSERT);
 879                         else {
 880                             modes.push(modes.TEXT_EDIT);
 881                             if (elem.selectionEnd - elem.selectionStart > 0)
 882                                 modes.push(modes.VISUAL);
 883                         }
 884
 885                 if (hasHTMLDocument(win))
 886                     buffer.lastInputField = elem || win;
 887                 return;
 888             }
 889
 890             if (elem && Events.isInputElement(elem)) {
 891                 if (!haveInput)
 892                     modes.push(modes.INSERT);
 893
 894                 if (hasHTMLDocument(win))
 895                     buffer.lastInputField = elem;
 896                 return;
 897             }
 898
 899             if (config.focusChange) {
 900                 config.focusChange(win);
 901                 return;
 902             }
 903
 904             let urlbar = document.getElementById("urlbar");
 905             if (elem == null && urlbar && urlbar.inputField == this._lastFocus)
 906                 util.threadYield(true); // Why? --Kris
 907
 908             while (modes.main.ownsFocus
 909                     && modes.topOfStack.params.ownsFocus != elem
 910                     && modes.topOfStack.params.ownsFocus != win
 911                     && !modes.topOfStack.params.holdFocus)
 912                  modes.pop(null, { fromFocus: true });
 913         }
 914         finally {
 915             this._lastFocus = elem;
 916
 917             if (modes.main.ownsFocus)
 918                 modes.topOfStack.params.ownsFocus = elem;
 919         }
 920     }),
 921
 922     onSelectionChange: function onSelectionChange(event) {
 923         // Ignore selection events caused by editor commands.
 924         if (editor.inEditMap || modes.main == modes.OPERATOR)
 925             return;
 926
 927         let controller = document.commandDispatcher.getControllerForCommand("cmd_copy");
 928         let couldCopy = controller && controller.isCommandEnabled("cmd_copy");
 929
 930         if (couldCopy) {
 931             if (modes.main == modes.TEXT_EDIT)
 932                 modes.push(modes.VISUAL);
 933             else if (modes.main == modes.CARET)
 934                 modes.push(modes.VISUAL);
 935         }
 936     },
 937
 938     shouldPass: function shouldPass(event)
 939         !event.noremap && (!dactyl.focusedElement || events.isContentNode(dactyl.focusedElement)) &&
 940         options.get("passkeys").has(DOM.Event.stringify(event))
 941 }, {
 942     ABORT: {},
 943     KILL: true,
 944     PASS: false,
 945     PASS_THROUGH: {},
 946     WAIT: null,
 947
 948     isEscape: function isEscape(event)
 949         let (key = isString(event) ? event : DOM.Event.stringify(event))
 950             key === "<Esc>" || key === "<C-[>",
 951
 952     isHidden: function isHidden(elem, aggressive) {
 953         if (DOM(elem).style.visibility !== "visible")
 954             return true;
 955
 956         if (aggressive)
 957             for (let e = elem; e instanceof Element; e = e.parentNode) {
 958                 if (!/set$/.test(e.localName) && e.boxObject && e.boxObject.height === 0)
 959                     return true;
 960                 else if (e.namespaceURI == XUL && e.localName === "panel")
 961                     break;
 962             }
 963         return false;
 964     },
 965
 966     isInputElement: function isInputElement(elem) {
 967         return DOM(elem).isEditable ||
 968                isinstance(elem, [HTMLEmbedElement, HTMLObjectElement,
 969                                  HTMLSelectElement])
 970     },
 971
 972     kill: function kill(event) {
 973         event.stopPropagation();
 974         event.preventDefault();
 975     }
 976 }, {
 977     contexts: function initContexts(dactyl, modules, window) {
 978         update(Events.prototype, {
 979             hives: contexts.Hives("events", EventHive),
 980             user: contexts.hives.events.user,
 981             builtin: contexts.hives.events.builtin
 982         });
 983     },
 984
 985     commands: function () {
 986         commands.add(["delmac[ros]"],
 987             "Delete macros",
 988             function (args) {
 989                 dactyl.assert(!args.bang || !args[0], _("error.invalidArgument"));
 990
 991                 if (args.bang)
 992                     events.deleteMacros();
 993                 else if (args[0])
 994                     events.deleteMacros(args[0]);
 995                 else
 996                     dactyl.echoerr(_("error.argumentRequired"));
 997             }, {
 998                 argCount: "?",
 999                 bang: true,
1000                 completer: function (context) completion.macro(context),
1001                 literal: 0
1002             });
1003
1004         commands.add(["mac[ros]"],
1005             "List all macros",
1006             function (args) { completion.listCompleter("macro", args[0]); }, {
1007                 argCount: "?",
1008                 completer: function (context) completion.macro(context)
1009             });
1010     },
1011     completion: function () {
1012         completion.macro = function macro(context) {
1013             context.title = ["Macro", "Keys"];
1014             context.completions = [item for (item in events.getMacros())];
1015         };
1016     },
1017     mappings: function () {
1018
1019         mappings.add([modes.MAIN],
1020             ["<A-b>", "<pass-next-key-builtin>"], "Process the next key as a builtin mapping",
1021             function () {
1022                 events.processor = ProcessorStack(modes.getStack(0), mappings.hives.array, true);
1023                 events.processor.keyEvents = events.keyEvents;
1024             });
1025
1026         mappings.add([modes.MAIN],
1027             ["<C-z>", "<pass-all-keys>"], "Temporarily ignore all " + config.appName + " key bindings",
1028             function () {
1029                 if (modes.main != modes.PASS_THROUGH)
1030                     modes.push(modes.PASS_THROUGH);
1031             });
1032
1033         mappings.add([modes.MAIN, modes.PASS_THROUGH, modes.QUOTE],
1034             ["<C-v>", "<pass-next-key>"], "Pass through next key",
1035             function () {
1036                 if (modes.main == modes.QUOTE)
1037                     return Events.PASS;
1038                 modes.push(modes.QUOTE);
1039             });
1040
1041         mappings.add([modes.BASE],
1042             ["<CapsLock>"], "Do Nothing",
1043             function () {});
1044
1045         mappings.add([modes.BASE],
1046             ["<Nop>"], "Do nothing",
1047             function () {});
1048
1049         mappings.add([modes.BASE],
1050             ["<Pass>"], "Pass the events consumed by the last executed mapping",
1051             function ({ keypressEvents: [event] }) {
1052                 dactyl.assert(event.dactylSavedEvents,
1053                               _("event.nothingToPass"));
1054                 return function () {
1055                     events.feedevents(null, event.dactylSavedEvents,
1056                                       { skipmap: true, isMacro: true, isReplay: true });
1057                 };
1058             });
1059
1060         // macros
1061         mappings.add([modes.COMMAND],
1062             ["q", "<record-macro>"], "Record a key sequence into a macro",
1063             function ({ arg }) {
1064                 util.assert(arg == null || /^[a-z]$/i.test(arg));
1065                 events._macroKeys.pop();
1066                 events.recording = arg;
1067             },
1068             { get arg() !modes.recording });
1069
1070         mappings.add([modes.COMMAND],
1071             ["@", "<play-macro>"], "Play a macro",
1072             function ({ arg, count }) {
1073                 count = Math.max(count, 1);
1074                 while (count--)
1075                     events.playMacro(arg);
1076             },
1077             { arg: true, count: true });
1078
1079         mappings.add([modes.COMMAND],
1080             ["<A-m>s", "<sleep>"], "Sleep for {count} milliseconds before continuing macro playback",
1081             function ({ command, count }) {
1082                 let now = Date.now();
1083                 dactyl.assert(count, _("error.countRequired", command));
1084                 if (events.feedingKeys)
1085                     util.sleep(count);
1086             },
1087             { count: true });
1088
1089         mappings.add([modes.COMMAND],
1090             ["<A-m>l", "<wait-for-page-load>"], "Wait for the current page to finish loading before continuing macro playback",
1091             function ({ count }) {
1092                 if (events.feedingKeys && !events.waitForPageLoad(count)) {
1093                     util.interrupted = true;
1094                     throw Error("Interrupted");
1095                 }
1096             },
1097             { count: true });
1098     },
1099     options: function () {
1100         const Hive = Class("Hive", {
1101             init: function init(values, map) {
1102                 this.name = "passkeys:" + map;
1103                 this.stack = MapHive.Stack(values.map(function (v) Map(v[map + "Keys"])));
1104                 function Map(keys) ({
1105                     execute: function () Events.PASS_THROUGH,
1106                     keys: keys
1107                 });
1108             },
1109
1110             get active() this.stack.length,
1111
1112             get: function get(mode, key) this.stack.mappings[key],
1113
1114             getCandidates: function getCandidates(mode, key) this.stack.candidates[key]
1115         });
1116         options.add(["passkeys", "pk"],
1117             "Pass certain keys through directly for the given URLs",
1118             "sitemap", "", {
1119                 flush: function flush() {
1120                     memoize(this, "filters", function () this.value.filter(function (f) f(buffer.documentURI)));
1121                     memoize(this, "pass", function () Set(array.flatten(this.filters.map(function (f) f.keys))));
1122                     memoize(this, "commandHive", function hive() Hive(this.filters, "command"));
1123                     memoize(this, "inputHive", function hive() Hive(this.filters, "input"));
1124                 },
1125
1126                 has: function (key) Set.has(this.pass, key) || Set.has(this.commandHive.stack.mappings, key),
1127
1128                 get pass() (this.flush(), this.pass),
1129
1130                 parse: function parse() {
1131                     let value = parse.superapply(this, arguments);
1132                     value.forEach(function (filter) {
1133                         let vals = Option.splitList(filter.result);
1134                         filter.keys = DOM.Event.parse(vals[0]).map(DOM.Event.closure.stringify);
1135
1136                         filter.commandKeys = vals.slice(1).map(DOM.Event.closure.canonicalKeys);
1137                         filter.inputKeys = filter.commandKeys.filter(bind("test", /^<[ACM]-/));
1138                     });
1139                     return value;
1140                 },
1141
1142                 keepQuotes: true,
1143
1144                 setter: function (value) {
1145                     this.flush();
1146                     return value;
1147                 }
1148             });
1149
1150         options.add(["strictfocus", "sf"],
1151             "Prevent scripts from focusing input elements without user intervention",
1152             "sitemap", "'chrome:*':laissez-faire,*:moderate",
1153             {
1154                 values: {
1155                     despotic: "Only allow focus changes when explicitly requested by the user",
1156                     moderate: "Allow focus changes after user-initiated focus change",
1157                     "laissez-faire": "Always allow focus changes"
1158                 }
1159             });
1160
1161         options.add(["timeout", "tmo"],
1162             "Whether to execute a shorter key command after a timeout when a longer command exists",
1163             "boolean", true);
1164
1165         options.add(["timeoutlen", "tmol"],
1166             "Maximum time (milliseconds) to wait for a longer key command when a shorter one exists",
1167             "number", 1000);
1168     }
1169 });
1170
1171 // vim: set fdm=marker sw=4 ts=4 et: