]> git.donarmstrong.com Git - dactyl.git/blobdiff - common/content/hints.js
Import r6948 from upstream hg supporting Firefox up to 24.*
[dactyl.git] / common / content / hints.js
index a30ef295057f33655020e429bf58aacb61b918f0..d151c2c3d688f439cc802ea732309d23ec896495 100644 (file)
@@ -1,6 +1,6 @@
 // Copyright (c) 2006-2008 by Martin Stubenschrott <stubenschrott@vimperator.org>
 // Copyright (c) 2007-2011 by Doug Kearns <dougkearns@gmail.com>
-// Copyright (c) 2008-2011 by Kris Maglione <maglione.k@gmail.com>
+// Copyright (c) 2008-2012 Kris Maglione <maglione.k@gmail.com>
 //
 // This work is licensed for reuse under an MIT license. Details are
 // given in the LICENSE.txt file included with this file.
@@ -17,9 +17,8 @@ var HintSession = Class("HintSession", CommandMode, {
 
         opts = opts || {};
 
-        // Hack.
-        if (!opts.window && modes.main == modes.OUTPUT_MULTILINE)
-            opts.window = commandline.widgets.multilineOutput.contentWindow;
+        if (!opts.window)
+            opts.window = modes.getStack(0).params.window;
 
         this.hintMode = hints.modes[mode];
         dactyl.assert(this.hintMode);
@@ -27,7 +26,7 @@ var HintSession = Class("HintSession", CommandMode, {
         this.activeTimeout = null; // needed for hinttimeout > 0
         this.continue = Boolean(opts.continue);
         this.docs = [];
-        this.hintKeys = events.fromString(options["hintkeys"]).map(events.closure.toString);
+        this.hintKeys = DOM.Event.parse(options["hintkeys"]).map(DOM.Event.closure.stringify);
         this.hintNumber = 0;
         this.hintString = opts.filter || "";
         this.pageHints = [];
@@ -35,6 +34,7 @@ var HintSession = Class("HintSession", CommandMode, {
         this.usedTabKey = false;
         this.validHints = []; // store the indices of the "hints" array with valid elements
 
+        mappings.pushCommand();
         this.open();
 
         this.top = opts.window || content;
@@ -98,6 +98,8 @@ var HintSession = Class("HintSession", CommandMode, {
         leave.superapply(this, arguments);
 
         if (!stack.push) {
+            mappings.popCommand();
+
             if (hints.hintSession == this)
                 hints.hintSession = null;
             if (this.top) {
@@ -255,7 +257,7 @@ var HintSession = Class("HintSession", CommandMode, {
     getContainerOffsets: function _getContainerOffsets(doc) {
         let body = doc.body || doc.documentElement;
         // TODO: getComputedStyle returns null for Facebook channel_iframe doc - probable Gecko bug.
-        let style = util.computedStyle(body);
+        let style = DOM(body).style;
 
         if (style && /^(absolute|fixed|relative)$/.test(style.position)) {
             let rect = body.getClientRects()[0];
@@ -298,8 +300,9 @@ var HintSession = Class("HintSession", CommandMode, {
                 return false;
 
             if (!rect.width || !rect.height)
-                if (!Array.some(elem.childNodes, function (elem) elem instanceof Element && util.computedStyle(elem).float != "none" && isVisible(elem)))
-                    return false;
+                if (!Array.some(elem.childNodes, function (elem) elem instanceof Element && DOM(elem).style.float != "none" && isVisible(elem)))
+                    if (elem.textContent || !elem.name)
+                        return false;
 
             let computedStyle = doc.defaultView.getComputedStyle(elem, null);
             if (computedStyle.visibility != "visible" || computedStyle.display == "none")
@@ -309,12 +312,11 @@ var HintSession = Class("HintSession", CommandMode, {
 
         let body = doc.body || doc.querySelector("body");
         if (body) {
-            let fragment = util.xmlToDom(<div highlight="hints"/>, doc);
-            body.appendChild(fragment);
-            util.computedStyle(fragment).height; // Force application of binding.
-            let container = doc.getAnonymousElementByAttribute(fragment, "anonid", "hints") || fragment;
+            let fragment = DOM(["div", { highlight: "hints" }], doc).appendTo(body);
+            fragment.style.height; // Force application of binding.
+            let container = doc.getAnonymousElementByAttribute(fragment[0], "anonid", "hints") || fragment[0];
 
-            let baseNodeAbsolute = util.xmlToDom(<span highlight="Hint" style="display: none;"/>, doc);
+            let baseNode = DOM(["span", { highlight: "Hint", style: "display: none;" }], doc)[0];
 
             let mode = this.hintMode;
             let res = mode.matcher(doc);
@@ -335,19 +337,21 @@ var HintSession = Class("HintSession", CommandMode, {
 
                 if (elem.hasAttributeNS(NS, "hint"))
                     [hint.text, hint.showText] = [elem.getAttributeNS(NS, "hint"), true];
-                else if (isinstance(elem, [HTMLInputElement, HTMLSelectElement, HTMLTextAreaElement]))
+                else if (isinstance(elem, [Ci.nsIDOMHTMLInputElement,
+                                           Ci.nsIDOMHTMLSelectElement,
+                                           Ci.nsIDOMHTMLTextAreaElement]))
                     [hint.text, hint.showText] = hints.getInputHint(elem, doc);
-                else if (elem.firstElementChild instanceof HTMLImageElement && /^\s*$/.test(elem.textContent))
+                else if (elem.firstElementChild instanceof Ci.nsIDOMHTMLImageElement && /^\s*$/.test(elem.textContent))
                     [hint.text, hint.showText] = [elem.firstElementChild.alt || elem.firstElementChild.title, true];
                 else
                     hint.text = elem.textContent.toLowerCase();
 
-                hint.span = baseNodeAbsolute.cloneNode(false);
+                hint.span = baseNode.cloneNode(false);
 
                 let leftPos = Math.max((rect.left + offsetX), offsetX);
                 let topPos  = Math.max((rect.top + offsetY), offsetY);
 
-                if (elem instanceof HTMLAreaElement)
+                if (elem instanceof Ci.nsIDOMHTMLAreaElement)
                     [leftPos, topPos] = this.getAreaOffset(elem, leftPos, topPos);
 
                 hint.span.setAttribute("style", ["display: none; left:", leftPos, "px; top:", topPos, "px"].join(""));
@@ -402,7 +406,7 @@ var HintSession = Class("HintSession", CommandMode, {
      */
     onKeyPress: function onKeyPress(eventList) {
         const KILL = false, PASS = true;
-        let key = events.toString(eventList[0]);
+        let key = DOM.Event.stringify(eventList[0]);
 
         this.clearTimeout();
 
@@ -488,6 +492,10 @@ var HintSession = Class("HintSession", CommandMode, {
 
         let n = 5;
         (function next() {
+            if (Cu.isDeadWrapper && Cu.isDeadWrapper(elem))
+                // Hint document has been unloaded.
+                return;
+
             let hinted = n || this.validHints.some(function (h) h.elem === elem);
             if (!hinted)
                 hints.setClass(elem, null);
@@ -500,6 +508,7 @@ var HintSession = Class("HintSession", CommandMode, {
                 this.timeout(next, 50);
         }).call(this);
 
+        mappings.pushCommand();
         if (!this.continue) {
             modes.pop();
             if (timeout)
@@ -509,6 +518,7 @@ var HintSession = Class("HintSession", CommandMode, {
         dactyl.trapErrors("action", this.hintMode,
                           elem, elem.href || elem.src || "",
                           this.extendedhintCount, top);
+        mappings.popCommand();
 
         this.timeout(function () {
             if (modes.main == modes.IGNORE && !this.continue)
@@ -529,10 +539,11 @@ var HintSession = Class("HintSession", CommandMode, {
      */
     removeHints: function _removeHints(timeout) {
         for (let { doc, start, end } in values(this.docs)) {
+            DOM(doc.documentElement).highlight.remove("Hinting");
             // Goddamn stupid fucking Gecko 1.x security manager bullshit.
             try { delete doc.dactylLabels; } catch (e) { doc.dactylLabels = undefined; }
 
-            for (let elem in util.evaluateXPath("//*[@dactyl:highlight='hints']", doc))
+            for (let elem in DOM.XPath("//*[@dactyl:highlight='hints']", doc))
                 elem.parentNode.removeChild(elem);
             for (let i in util.range(start, end + 1)) {
                 this.pageHints[i].ambiguous = false;
@@ -564,42 +575,48 @@ var HintSession = Class("HintSession", CommandMode, {
     /**
      * Display the hints in pageHints that are still valid.
      */
+    showCount: 0,
     show: function _show() {
+        let count = ++this.showCount;
         let hintnum = 1;
         let validHint = hints.hintMatcher(this.hintString.toLowerCase());
         let activeHint = this.hintNumber || 1;
         this.validHints = [];
 
         for (let { doc, start, end } in values(this.docs)) {
+            DOM(doc.documentElement).highlight.add("Hinting");
             let [offsetX, offsetY] = this.getContainerOffsets(doc);
 
         inner:
             for (let i in (util.interruptibleRange(start, end + 1, 500))) {
+                if (this.showCount != count)
+                    return;
+
                 let hint = this.pageHints[i];
 
                 hint.valid = validHint(hint.text);
                 if (!hint.valid)
                     continue inner;
 
-                if (hint.text == "" && hint.elem.firstChild && hint.elem.firstChild instanceof HTMLImageElement) {
+                if (hint.text == "" && hint.elem.firstChild && hint.elem.firstChild instanceof Ci.nsIDOMHTMLImageElement) {
                     if (!hint.imgSpan) {
                         let rect = hint.elem.firstChild.getBoundingClientRect();
                         if (!rect)
                             continue;
 
-                        hint.imgSpan = util.xmlToDom(<span highlight="Hint" dactyl:hl="HintImage" xmlns:dactyl={NS}/>, doc);
-                        hint.imgSpan.style.display = "none";
-                        hint.imgSpan.style.left = (rect.left + offsetX) + "px";
-                        hint.imgSpan.style.top = (rect.top + offsetY) + "px";
-                        hint.imgSpan.style.width = (rect.right - rect.left) + "px";
-                        hint.imgSpan.style.height = (rect.bottom - rect.top) + "px";
-                        hint.span.parentNode.appendChild(hint.imgSpan);
+                        hint.imgSpan = DOM(["span", { highlight: "Hint", "dactyl:hl": "HintImage" }], doc).css({
+                            display: "none",
+                            left: (rect.left + offsetX) + "px",
+                            top: (rect.top + offsetY) + "px",
+                            width: (rect.right - rect.left) + "px",
+                            height: (rect.bottom - rect.top) + "px"
+                        }).appendTo(hint.span.parentNode)[0];
                     }
                 }
 
                 let str = this.getHintString(hintnum);
                 let text = [];
-                if (hint.elem instanceof HTMLInputElement)
+                if (hint.elem instanceof Ci.nsIDOMHTMLInputElement)
                     if (hint.elem.type === "radio")
                         text.push(UTF8(hint.elem.checked ? "⊙" : "○"));
                     else if (hint.elem.type === "checkbox")
@@ -717,7 +734,7 @@ var HintSession = Class("HintSession", CommandMode, {
      * Display the current status to the user.
      */
     updateStatusline: function _updateStatusline() {
-        statusline.inputBuffer = (this.escapeNumbers ? options["mapleader"] : "") +
+        statusline.inputBuffer = (this.escapeNumbers ? "\\" : "") +
                                  (this.hintNumber ? this.getHintString(this.hintNumber) : "");
     },
 });
@@ -740,6 +757,7 @@ var Hints = Module("hints", {
         this.modes = {};
         this.addMode(";", "Focus hint",                           buffer.closure.focusElement);
         this.addMode("?", "Show information for hint",            function (elem) buffer.showElementInfo(elem));
+        // TODO: allow for ! override to overwrite existing paths -- where? --djk
         this.addMode("s", "Save hint",                            function (elem) buffer.saveLink(elem, false));
         this.addMode("f", "Focus frame",                          function (elem) dactyl.focus(elem.ownerDocument.defaultView));
         this.addMode("F", "Focus frame or pseudo-frame",          buffer.closure.focusElement, isScrollable);
@@ -754,13 +772,19 @@ var Hints = Module("hints", {
         this.addMode("S", "Add a search keyword",                 function (elem) bookmarks.addSearchKeyword(elem));
         this.addMode("v", "View hint source",                     function (elem, loc) buffer.viewSource(loc, false));
         this.addMode("V", "View hint source in external editor",  function (elem, loc) buffer.viewSource(loc, true));
-        this.addMode("y", "Yank hint location",                   function (elem, loc) dactyl.clipboardWrite(loc, true));
-        this.addMode("Y", "Yank hint description",                function (elem) dactyl.clipboardWrite(elem.textContent || "", true));
-        this.addMode("c", "Open context menu",                    function (elem) buffer.openContextMenu(elem));
+        this.addMode("y", "Yank hint location",                   function (elem, loc) editor.setRegister(null, loc, true));
+        this.addMode("Y", "Yank hint description",                function (elem) editor.setRegister(null, elem.textContent || "", true));
+        this.addMode("A", "Yank hint anchor url",                 function (elem) {
+            let uri = elem.ownerDocument.documentURIObject.clone();
+            uri.ref = elem.id || elem.name;
+            dactyl.clipboardWrite(uri.spec, true);
+        });
+        this.addMode("c", "Open context menu",                    function (elem) DOM(elem).contextmenu());
         this.addMode("i", "Show image",                           function (elem) dactyl.open(elem.src));
         this.addMode("I", "Show image in a new tab",              function (elem) dactyl.open(elem.src, dactyl.NEW_TAB));
 
-        function isScrollable(elem) isinstance(elem, [HTMLFrameElement, HTMLIFrameElement]) ||
+        function isScrollable(elem) isinstance(elem, [Ci.nsIDOMHTMLFrameElement,
+                                                      Ci.nsIDOMHTMLIFrameElement]) ||
             Buffer.isScrollable(elem, 0, true) || Buffer.isScrollable(elem, 0, false);
     },
 
@@ -824,12 +848,12 @@ var Hints = Module("hints", {
 
         let type = elem.type;
 
-        if (elem instanceof HTMLInputElement && Set.has(util.editableInputs, elem.type))
+        if (DOM(elem).isInput)
             return [elem.value, false];
         else {
             for (let [, option] in Iterator(options["hintinputs"])) {
                 if (option == "value") {
-                    if (elem instanceof HTMLSelectElement) {
+                    if (elem instanceof Ci.nsIDOMHTMLSelectElement) {
                         if (elem.selectedIndex >= 0)
                             return [elem.item(elem.selectedIndex).text.toLowerCase(), false];
                     }
@@ -845,7 +869,8 @@ var Hints = Module("hints", {
                 }
                 else if (option == "label") {
                     if (elem.id) {
-                        let label = elem.ownerDocument.dactylLabels[elem.id];
+                        let label = (elem.ownerDocument.dactylLabels || {})[elem.id];
+                        // Urgh.
                         if (label)
                             return [label.textContent.toLowerCase(), true];
                     }
@@ -1017,7 +1042,7 @@ var Hints = Module("hints", {
 
         let indexOf = String.indexOf;
         if (options.get("hintmatching").has("transliterated"))
-            indexOf = Hints.indexOf;
+            indexOf = Hints.closure.indexOf;
 
         switch (options["hintmatching"][0]) {
         case "contains"      : return containsMatcher(hintString);
@@ -1031,15 +1056,21 @@ var Hints = Module("hints", {
 
     open: function open(mode, opts) {
         this._extendedhintCount = opts.count;
-        commandline.input(["Normal", mode], "", {
+
+        opts = opts || {};
+
+        mappings.pushCommand();
+        commandline.input(["Normal", mode], null, {
             autocomplete: false,
             completer: function (context) {
                 context.compare = function () 0;
                 context.completions = [[k, v.prompt] for ([k, v] in Iterator(hints.modes))];
             },
+            onCancel: mappings.closure.popCommand,
             onSubmit: function (arg) {
                 if (arg)
                     hints.show(arg, opts);
+                mappings.popCommand();
             },
             onChange: function (arg) {
                 if (Object.keys(hints.modes).some(function (m) m != arg && m.indexOf(arg) == 0))
@@ -1077,7 +1108,24 @@ var Hints = Module("hints", {
         this.hintSession = HintSession(mode, opts);
     }
 }, {
-    translitTable: Class.memoize(function () {
+    isVisible: function isVisible(elem, offScreen) {
+        let rect = elem.getBoundingClientRect();
+        if (!rect.width || !rect.height)
+            if (!Array.some(elem.childNodes, function (elem) elem instanceof Element && DOM(elem).style.float != "none" && isVisible(elem)))
+                return false;
+
+        let win = elem.ownerDocument.defaultView;
+        if (offScreen && (rect.top + win.scrollY < 0 || rect.left + win.scrollX < 0 ||
+                          rect.bottom + win.scrollY > win.scrolMaxY + win.innerHeight ||
+                          rect.right + win.scrollX > win.scrolMaxX + win.innerWidth))
+            return false;
+
+        if (!DOM(elem).isVisible)
+            return false;
+        return true;
+    },
+
+    translitTable: Class.Memoize(function () {
         const table = {};
         [
             [0x00c0, 0x00c6, ["A"]], [0x00c7, 0x00c7, ["C"]],
@@ -1143,7 +1191,7 @@ var Hints = Module("hints", {
             [0x24d0, 0x24e9, "a"],
             [0xfb00, 0xfb06, ["ff", "fi", "fl", "ffi", "ffl", "st", "st"]],
             [0xff21, 0xff3a, "A"], [0xff41, 0xff5a, "a"]
-        ].forEach(function (start, stop, val) {
+        ].forEach(function ([start, stop, val]) {
             if (typeof val != "string")
                 for (let i = start; i <= stop; i++)
                     table[String.fromCharCode(i)] = val[(i - start) % val.length];
@@ -1161,7 +1209,7 @@ var Hints = Module("hints", {
         if (src.length == 0)
             return 0;
     outer:
-        for (var i = 0; i < end; i++) {
+        for (var i = 0; i <= end; i++) {
                 var j = i;
                 for (var k = 0; k < src.length;) {
                     var s = dest[j++];
@@ -1191,53 +1239,60 @@ var Hints = Module("hints", {
         });
     },
     mappings: function () {
-        var myModes = config.browserModes.concat(modes.OUTPUT_MULTILINE);
-        mappings.add(myModes, ["f"],
+        let bind = function bind(names, description, action, params)
+            mappings.add(config.browserModes, names, description,
+                         action, params);
+
+        bind(["f"],
             "Start Hints mode",
             function () { hints.show("o"); });
 
-        mappings.add(myModes, ["F"],
+        bind(["F"],
             "Start Hints mode, but open link in a new tab",
             function () { hints.show(options.get("activate").has("links") ? "t" : "b"); });
 
-        mappings.add(myModes, [";"],
+        bind([";"],
             "Start an extended hints mode",
             function ({ count }) { hints.open(";", { count: count }); },
             { count: true });
 
-        mappings.add(myModes, ["g;"],
+        bind(["g;"],
             "Start an extended hints mode and stay there until <Esc> is pressed",
             function ({ count }) { hints.open("g;", { continue: true, count: count }); },
             { count: true });
 
-        mappings.add(modes.HINTS, ["<Return>"],
+        let bind = function bind(names, description, action, params)
+            mappings.add([modes.HINTS], names, description,
+                         action, params);
+
+        bind(["<Return>"],
             "Follow the selected hint",
             function ({ self }) { self.update(true); });
 
-        mappings.add(modes.HINTS, ["<Tab>"],
+        bind(["<Tab>"],
             "Focus the next matching hint",
             function ({ self }) { self.tab(false); });
 
-        mappings.add(modes.HINTS, ["<S-Tab>"],
+        bind(["<S-Tab>"],
             "Focus the previous matching hint",
             function ({ self }) { self.tab(true); });
 
-        mappings.add(modes.HINTS, ["<BS>", "<C-h>"],
+        bind(["<BS>", "<C-h>"],
             "Delete the previous character",
             function ({ self }) self.backspace());
 
-        mappings.add(modes.HINTS, ["<Leader>"],
+        bind(["\\"],
             "Toggle hint filtering",
             function ({ self }) { self.escapeNumbers = !self.escapeNumbers; });
     },
     options: function () {
-        function xpath(arg) util.makeXPath(arg);
-
         options.add(["extendedhinttags", "eht"],
             "XPath or CSS selector strings of hintable elements for extended hint modes",
             "regexpmap", {
+                // Make sure to update the docs when you change this.
                 "[iI]": "img",
-                "[asOTvVWy]": ["a[href]", "area[href]", "img[src]", "iframe[src]"],
+                "[asOTvVWy]": [":-moz-any-link", "area[href]", "img[src]", "iframe[src]"],
+                "[A]": ["[id]", "a[name]"],
                 "[f]": "body",
                 "[F]": ["body", "code", "div", "html", "p", "pre", "span"],
                 "[S]": ["input:not([type=hidden])", "textarea", "button", "select"]
@@ -1247,25 +1302,28 @@ var Hints = Module("hints", {
                 getKey: function (val, default_)
                     let (res = array.nth(this.value, function (re) let (match = re.exec(val)) match && match[0] == val, 0))
                         res ? res.matcher : default_,
-                setter: function (vals) {
+                parse: function parse(val) {
+                    let vals = parse.supercall(this, val);
                     for (let value in values(vals))
-                        value.matcher = util.compileMatcher(Option.splitList(value.result));
+                        value.matcher = DOM.compileMatcher(Option.splitList(value.result));
                     return vals;
                 },
-                validator: util.validateMatcher
+                testValues: function testValues(vals, validator) vals.every(function (re) Option.splitList(re).every(validator)),
+                validator: DOM.validateMatcher
             });
 
         options.add(["hinttags", "ht"],
             "XPath or CSS selector strings of hintable elements for Hints mode",
-            "stringlist", "input:not([type=hidden]),a[href],area,iframe,textarea,button,select," +
+            // Make sure to update the docs when you change this.
+            "stringlist", ":-moz-any-link,area,button,iframe,input:not([type=hidden]),label[for],select,textarea," +
                           "[onclick],[onmouseover],[onmousedown],[onmouseup],[oncommand]," +
                           "[tabindex],[role=link],[role=button],[contenteditable=true]",
             {
                 setter: function (values) {
-                    this.matcher = util.compileMatcher(values);
+                    this.matcher = DOM.compileMatcher(values);
                     return values;
                 },
-                validator: util.validateMatcher
+                validator: DOM.validateMatcher
             });
 
         options.add(["hintkeys", "hk"],
@@ -1277,7 +1335,7 @@ var Hints = Module("hints", {
                     "asdfg;lkjh": "Home Row"
                 },
                 validator: function (value) {
-                    let values = events.fromString(value).map(events.closure.toString);
+                    let values = DOM.Event.parse(value).map(DOM.Event.closure.stringify);
                     return Option.validIf(array.uniq(values).length === values.length && values.length > 1,
                                           _("option.hintkeys.duplicate"));
                 }
@@ -1294,7 +1352,7 @@ var Hints = Module("hints", {
             {
                 values: {
                     "0": "Follow the first hint as soon as typed text uniquely identifies it. Follow the selected hint on <Return>.",
-                    "1": "Follow the selected hint on <Return>.",
+                    "1": "Follow the selected hint on <Return>."
                 }
             });
 
@@ -1331,4 +1389,4 @@ var Hints = Module("hints", {
     }
 });
 
-// vim: set fdm=marker sw=4 ts=4 et:
+// vim: set fdm=marker sw=4 sts=4 ts=8 et: