mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2025-12-20 04:27:59 +01:00
3800f10144
If <label> elements are found use them, else use the value in the box (current behaviour) or if you add 'name' to 'hintinputs' then it will allow you to select by the name of the field. For values that are not displayed on the input field, it adds the value to the red hint icon.
931 lines
37 KiB
JavaScript
931 lines
37 KiB
JavaScript
/***** BEGIN LICENSE BLOCK ***** {{{
|
|
Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
The contents of this file are subject to the Mozilla Public License Version
|
|
1.1 (the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
http://www.mozilla.org/MPL/
|
|
|
|
Software distributed under the License is distributed on an "AS IS" basis,
|
|
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
for the specific language governing rights and limitations under the
|
|
License.
|
|
|
|
Copyright (c) 2006-2009 by Martin Stubenschrott <stubenschrott@vimperator.org>
|
|
|
|
Alternatively, the contents of this file may be used under the terms of
|
|
either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
in which case the provisions of the GPL or the LGPL are applicable instead
|
|
of those above. If you wish to allow use of your version of this file only
|
|
under the terms of either the GPL or the LGPL, and not to allow others to
|
|
use your version of this file under the terms of the MPL, indicate your
|
|
decision by deleting the provisions above and replace them with the notice
|
|
and other provisions required by the GPL or the LGPL. If you do not delete
|
|
the provisions above, a recipient may use your version of this file under
|
|
the terms of any one of the MPL, the GPL or the LGPL.
|
|
}}} ***** END LICENSE BLOCK *****/
|
|
|
|
/** @scope modules */
|
|
|
|
/**
|
|
* @instance hints
|
|
*/
|
|
function Hints() //{{{
|
|
{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
////////////////////// PRIVATE SECTION /////////////////////////////////////////
|
|
/////////////////////////////////////////////////////////////////////////////{{{
|
|
|
|
const ELEM = 0, TEXT = 1, SPAN = 2, IMGSPAN = 3;
|
|
|
|
var myModes = config.browserModes;
|
|
|
|
var hintMode;
|
|
var submode = ""; // used for extended mode, can be "o", "t", "y", etc.
|
|
var hintString = ""; // the typed string part of the hint is in this string
|
|
var hintNumber = 0; // only the numerical part of the hint
|
|
var usedTabKey = false; // when we used <Tab> to select an element
|
|
var prevInput = ""; // record previous user input type, "text" || "number"
|
|
var extendedhintCount; // for the count argument of Mode#action (extended hint only)
|
|
|
|
// hints[] = [elem, text, span, imgspan, elem.style.backgroundColor, elem.style.color]
|
|
var pageHints = [];
|
|
var validHints = []; // store the indices of the "hints" array with valid elements
|
|
|
|
var activeTimeout = null; // needed for hinttimeout > 0
|
|
var canUpdate = false;
|
|
|
|
// keep track of the documents which we generated the hints for
|
|
// docs = { doc: document, start: start_index in hints[], end: end_index in hints[] }
|
|
var docs = [];
|
|
|
|
const Mode = new Struct("prompt", "action", "tags");
|
|
Mode.defaultValue("tags", function () function () options.hinttags);
|
|
function extended() options.extendedhinttags;
|
|
const hintModes = {
|
|
";": Mode("Focus hint", function (elem) buffer.focusElement(elem), extended),
|
|
"?": Mode("Show information for hint", function (elem) buffer.showElementInfo(elem), extended),
|
|
s: Mode("Save hint", function (elem) buffer.saveLink(elem, true)),
|
|
a: Mode("Save hint with prompt", function (elem) buffer.saveLink(elem, false)),
|
|
f: Mode("Focus frame", function (elem) elem.ownerDocument.defaultView.focus(), function () "//body | //xhtml:body"),
|
|
o: Mode("Follow hint", function (elem) buffer.followLink(elem, liberator.CURRENT_TAB)),
|
|
t: Mode("Follow hint in a new tab", function (elem) buffer.followLink(elem, liberator.NEW_TAB)),
|
|
b: Mode("Follow hint in a background tab", function (elem) buffer.followLink(elem, liberator.NEW_BACKGROUND_TAB)),
|
|
w: Mode("Follow hint in a new window", function (elem) buffer.followLink(elem, liberator.NEW_WINDOW), extended),
|
|
F: Mode("Open multiple hints in tabs", hintAction_F),
|
|
O: Mode("Generate an ':open URL' using hint", function (elem, loc) commandline.open(":", "open " + loc, modes.EX)),
|
|
T: Mode("Generate a ':tabopen URL' using hint",function (elem, loc) commandline.open(":", "tabopen " + loc, modes.EX)),
|
|
W: Mode("Generate a ':winopen URL' using hint",function (elem, loc) commandline.open(":", "winopen " + loc, modes.EX)),
|
|
v: Mode("View hint source", function (elem, loc) buffer.viewSource(loc, false), extended),
|
|
V: Mode("View hint source in external editor", function (elem, loc) buffer.viewSource(loc, true), extended),
|
|
y: Mode("Yank hint location", function (elem, loc) util.copyToClipboard(loc, true)),
|
|
Y: Mode("Yank hint description", function (elem) util.copyToClipboard(elem.textContent || "", true), extended)
|
|
};
|
|
|
|
// Used to open multiple hints
|
|
function hintAction_F(elem)
|
|
{
|
|
buffer.followLink(elem, liberator.NEW_BACKGROUND_TAB);
|
|
|
|
// TODO: Maybe we find a *simple* way to keep the hints displayed rather than
|
|
// showing them again, or is this short flash actually needed as a "usability
|
|
// feature"? --mst
|
|
hints.show("F");
|
|
}
|
|
|
|
// reset all important variables
|
|
function reset()
|
|
{
|
|
statusline.updateInputBuffer("");
|
|
hintString = "";
|
|
hintNumber = 0;
|
|
usedTabKey = false;
|
|
prevInput = "";
|
|
pageHints = [];
|
|
validHints = [];
|
|
canUpdate = false;
|
|
docs = [];
|
|
hints.escNumbers = false;
|
|
|
|
if (activeTimeout)
|
|
clearTimeout(activeTimeout);
|
|
activeTimeout = null;
|
|
}
|
|
|
|
function updateStatusline()
|
|
{
|
|
statusline.updateInputBuffer((hints.escNumbers ? mappings.getMapLeader() : "") + (hintNumber || ""));
|
|
}
|
|
|
|
function generate(win)
|
|
{
|
|
if (!win)
|
|
win = window.content;
|
|
|
|
let doc = win.document;
|
|
let height = win.innerHeight;
|
|
let width = win.innerWidth;
|
|
let scrollX = doc.defaultView.scrollX;
|
|
let scrollY = doc.defaultView.scrollY;
|
|
|
|
let baseNodeAbsolute = util.xmlToDom(<span highlight="Hint"/>, doc);
|
|
|
|
let elem, tagname, text, span, rect, showtext;
|
|
let res = buffer.evaluateXPath(hintMode.tags(), doc, null, true);
|
|
|
|
let fragment = util.xmlToDom(<div highlight="hints"/>, doc);
|
|
let start = pageHints.length;
|
|
for (let elem in res)
|
|
{
|
|
showtext = false;
|
|
|
|
// TODO: for iframes, this calculation is wrong
|
|
rect = elem.getBoundingClientRect();
|
|
if (!rect || rect.top > height || rect.bottom < 0 || rect.left > width || rect.right < 0)
|
|
continue;
|
|
|
|
rect = elem.getClientRects()[0];
|
|
if (!rect)
|
|
continue;
|
|
|
|
let computedStyle = doc.defaultView.getComputedStyle(elem, null);
|
|
if (computedStyle.getPropertyValue("visibility") != "visible" || computedStyle.getPropertyValue("display") == "none")
|
|
continue;
|
|
|
|
tagname = elem.localName.toLowerCase();
|
|
if (tagname == "input" || tagname == "select" || tagname == "textarea")
|
|
{
|
|
//TODO: Split this out somewhere...
|
|
// <input type="submit|button|reset"> Always use the value
|
|
// <input type="radio|checkbox"> Use the value if it is not numeric or label or name
|
|
// <input type="password"> Never use the value, use label or name
|
|
// <input type="text|file"> <textarea> Use value if set or label or name
|
|
// <input type="image"> Use the alt text if present (showtext) or label or name
|
|
// <input type="hidden"> Never gets here
|
|
// <select> Use the text of the selected item or label or name
|
|
text = "";
|
|
let type = elem.type ? elem.type.toLowerCase() : "";
|
|
|
|
if (tagname == "input" && (type == "submit" || type == "button" || type == "reset"))
|
|
{
|
|
text = elem.value
|
|
}
|
|
else
|
|
{
|
|
for each (let option in options["hintinputs"].split(","))
|
|
{
|
|
if (option == "value")
|
|
{
|
|
if (tagname == "select")
|
|
{
|
|
if (elem.selectedIndex >= 0)
|
|
text = elem.item(elem.selectedIndex).text;
|
|
}
|
|
else if (type == "image")
|
|
{
|
|
if (elem.alt)
|
|
{
|
|
text = elem.alt;
|
|
showtext = true;
|
|
}
|
|
}
|
|
else if (elem.value && type != "password")
|
|
{
|
|
// radio's and checkboxes often use internal ids as values - maybe make this an option too...
|
|
if (! ((type == "radio" || type == "checkbox") && !isNaN(elem.value)))
|
|
{
|
|
text = elem.value
|
|
showtext = true;
|
|
}
|
|
}
|
|
}
|
|
else if (option == "label")
|
|
{
|
|
if (elem.id)
|
|
{
|
|
//TODO: (possibly) do some guess work for label-like objects
|
|
let label = buffer.evaluateXPath("//label[@for='"+elem.id+"']", doc).snapshotItem(0);
|
|
if (label)
|
|
{
|
|
text = label.textContent.toLowerCase();
|
|
showtext = true;
|
|
}
|
|
}
|
|
}
|
|
else if (option == "name")
|
|
{
|
|
text = elem.name;
|
|
showtext = true;
|
|
}
|
|
|
|
if(text)
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
text = elem.textContent.toLowerCase();
|
|
|
|
span = baseNodeAbsolute.cloneNode(true);
|
|
|
|
let leftpos = Math.max((rect.left + scrollX), scrollX);
|
|
let toppos = Math.max((rect.top + scrollY), scrollY);
|
|
|
|
if (tagname == "area")
|
|
{
|
|
// TODO: Maybe put the following into a seperate function
|
|
try
|
|
{
|
|
// Need to add the offset to the area element.
|
|
// Always try to find the top-left point, as per vimperator default.
|
|
let shape = elem.getAttribute("shape").toLowerCase();
|
|
let coordstr = elem.getAttribute("coords");
|
|
// Technically it should be only commas, but hey
|
|
coordstr = coordstr.replace(/\s+[;,]\s+/g, ",").replace(/\s+/g, ",");
|
|
let coords = coordstr.split(",").map(Number);
|
|
|
|
if ((shape == "rect" || shape == "rectangle") && coords.length == 4)
|
|
{
|
|
leftpos += coords[0];
|
|
toppos += coords[1];
|
|
}
|
|
else if (shape == "circle" && coords.length == 3)
|
|
{
|
|
leftpos += coords[0] - coords[2] / Math.sqrt(2);
|
|
toppos += coords[1] - coords[2] / Math.sqrt(2);
|
|
}
|
|
else if ((shape == "poly" || shape == "polygon") && coords.length % 2 == 0)
|
|
{
|
|
let leftbound = Infinity;
|
|
let topbound = Infinity;
|
|
|
|
// First find the top-left corner of the bounding rectangle (offset from image topleft can be noticably suboptimal)
|
|
for (let i = 0; i < coords.length; i += 2)
|
|
{
|
|
leftbound = Math.min(coords[i], leftbound);
|
|
topbound = Math.min(coords[i+1], topbound);
|
|
}
|
|
|
|
let curtop = null;
|
|
let curleft = null;
|
|
let curdist = Infinity;
|
|
|
|
// Then find the closest vertex. (we could generalise to nearest point on an edge, but I doubt there is a need)
|
|
for (let i = 0; i < coords.length; i += 2)
|
|
{
|
|
let leftoffset = coords[i] - leftbound;
|
|
let topoffset = coords[i+1] - topbound;
|
|
let dist = Math.sqrt(leftoffset * leftoffset + topoffset * topoffset);
|
|
if (dist < curdist)
|
|
{
|
|
curdist = dist;
|
|
curleft = coords[i];
|
|
curtop = coords[i+1];
|
|
}
|
|
}
|
|
|
|
// If we found a satisfactory offset, let's use it.
|
|
if (curdist < Infinity)
|
|
{
|
|
leftpos += curleft;
|
|
toppos += curtop;
|
|
}
|
|
}
|
|
}
|
|
catch (e) {} //badly formed document, or shape == "default" in which case we don't move the hint
|
|
}
|
|
|
|
span.style.left = leftpos + "px";
|
|
span.style.top = toppos + "px";
|
|
fragment.appendChild(span);
|
|
|
|
pageHints.push([elem, text, span, null, elem.style.backgroundColor, elem.style.color, showtext]);
|
|
}
|
|
|
|
if (doc.body)
|
|
{
|
|
doc.body.appendChild(fragment);
|
|
docs.push({ doc: doc, start: start, end: pageHints.length - 1 });
|
|
}
|
|
|
|
// also generate hints for frames
|
|
Array.forEach(win.frames, generate);
|
|
|
|
return true;
|
|
}
|
|
|
|
// TODO: make it aware of imgspans
|
|
function showActiveHint(newID, oldID)
|
|
{
|
|
let oldElem = validHints[oldID - 1];
|
|
if (oldElem)
|
|
setClass(oldElem, false);
|
|
|
|
let newElem = validHints[newID - 1];
|
|
if (newElem)
|
|
setClass(newElem, true);
|
|
}
|
|
|
|
function setClass(elem, active)
|
|
{
|
|
let prefix = (elem.getAttributeNS(NS.uri, "class") || "") + " ";
|
|
if (active)
|
|
elem.setAttributeNS(NS.uri, "highlight", prefix + "HintActive");
|
|
else
|
|
elem.setAttributeNS(NS.uri, "highlight", prefix + "HintElem");
|
|
}
|
|
|
|
function showHints()
|
|
{
|
|
|
|
let elem, tagname, text, rect, span, imgspan, _a, _b, showtext;
|
|
let hintnum = 1;
|
|
let validHint = hintMatcher(hintString.toLowerCase());
|
|
let activeHint = hintNumber || 1;
|
|
validHints = [];
|
|
|
|
for (let [,{ doc: doc, start: start, end: end }] in Iterator(docs))
|
|
{
|
|
let scrollX = doc.defaultView.scrollX;
|
|
let scrollY = doc.defaultView.scrollY;
|
|
|
|
inner:
|
|
for (let i in (util.interruptibleRange(start, end + 1, 500)))
|
|
{
|
|
let hint = pageHints[i];
|
|
[elem, text, span, imgspan, _a, _b, showtext] = hint;
|
|
|
|
let valid = validHint(text);
|
|
span.style.display = (valid ? "" : "none");
|
|
if (imgspan)
|
|
imgspan.style.display = (valid ? "" : "none");
|
|
|
|
if (!valid)
|
|
{
|
|
elem.removeAttributeNS(NS.uri, "highlight");
|
|
continue inner;
|
|
}
|
|
|
|
if (text == "" && elem.firstChild && elem.firstChild.tagName == "IMG")
|
|
{
|
|
if (!imgspan)
|
|
{
|
|
rect = elem.firstChild.getBoundingClientRect();
|
|
if (!rect)
|
|
continue;
|
|
|
|
imgspan = util.xmlToDom(<span highlight="Hint"/>, doc);
|
|
imgspan.setAttributeNS(NS.uri, "class", "HintImage");
|
|
imgspan.style.left = (rect.left + scrollX) + "px";
|
|
imgspan.style.top = (rect.top + scrollY) + "px";
|
|
imgspan.style.width = (rect.right - rect.left) + "px";
|
|
imgspan.style.height = (rect.bottom - rect.top) + "px";
|
|
hint[IMGSPAN] = imgspan;
|
|
span.parentNode.appendChild(imgspan);
|
|
}
|
|
setClass(imgspan, activeHint == hintnum);
|
|
}
|
|
|
|
span.setAttribute("number", showtext ? hintnum + ": " + text.substr(0,50): hintnum);
|
|
if (imgspan)
|
|
imgspan.setAttribute("number", hintnum);
|
|
else
|
|
setClass(elem, activeHint == hintnum);
|
|
validHints.push(elem);
|
|
hintnum++;
|
|
}
|
|
}
|
|
|
|
// TODO: is it better to set up an observer for this property and set
|
|
// 'usermode' appropriately? We're generally not very well integrated
|
|
// into FF so having menu items toggle Vimperator options may be
|
|
// confusing. --djk
|
|
if (getBrowser().markupDocumentViewer.authorStyleDisabled)
|
|
{
|
|
let css = [];
|
|
// FIXME: Broken for imgspans.
|
|
for (let [,{ doc: doc }] in Iterator(docs))
|
|
{
|
|
for (let elem in buffer.evaluateXPath("//*[@liberator:highlight and @number]", doc))
|
|
{
|
|
let group = elem.getAttributeNS(NS.uri, "highlight");
|
|
css.push(highlight.selector(group) + "[number='" + elem.getAttribute("number") + "'] { " + elem.style.cssText + " }");
|
|
}
|
|
}
|
|
styles.addSheet(true, "hint-positions", "*", css.join("\n"));
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
function removeHints(timeout)
|
|
{
|
|
let firstElem = validHints[0] || null;
|
|
|
|
for (let [,{ doc: doc, start: start, end: end }] in Iterator(docs))
|
|
{
|
|
for (let elem in buffer.evaluateXPath("//*[@liberator:highlight='hints']", doc))
|
|
elem.parentNode.removeChild(elem);
|
|
for (let i in util.range(start, end + 1))
|
|
{
|
|
let hint = pageHints[i];
|
|
if (!timeout || hint[ELEM] != firstElem)
|
|
hint[ELEM].removeAttributeNS(NS.uri, "highlight");
|
|
}
|
|
|
|
// animate the disappearance of the first hint
|
|
if (timeout && firstElem)
|
|
setTimeout(function () { firstElem.removeAttributeNS(NS.uri, "highlight"); }, timeout);
|
|
}
|
|
styles.removeSheet(true, "hint-positions");
|
|
|
|
reset();
|
|
}
|
|
|
|
function processHints(followFirst)
|
|
{
|
|
if (validHints.length == 0)
|
|
{
|
|
liberator.beep();
|
|
return false;
|
|
}
|
|
|
|
if (options["followhints"] > 0)
|
|
{
|
|
if (!followFirst)
|
|
return false; // no return hit; don't examine uniqueness
|
|
|
|
// OK. return hit. But there's more than one hint, and
|
|
// there's no tab-selected current link. Do not follow in mode 2
|
|
if (options["followhints"] == 2 && validHints.length > 1 && !hintNumber)
|
|
return liberator.beep();
|
|
}
|
|
|
|
if (!followFirst)
|
|
{
|
|
let firstHref = validHints[0].getAttribute("href") || null;
|
|
if (firstHref)
|
|
{
|
|
if (validHints.some(function (e) e.getAttribute("href") != firstHref))
|
|
return false;
|
|
}
|
|
else if (validHints.length > 1)
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
let timeout = followFirst || events.feedingKeys ? 0 : 500;
|
|
let activeIndex = (hintNumber ? hintNumber - 1 : 0);
|
|
let elem = validHints[activeIndex];
|
|
removeHints(timeout);
|
|
|
|
if (timeout == 0)
|
|
// force a possible mode change, based on whether an input field has focus
|
|
events.onFocusChange();
|
|
setTimeout(function () {
|
|
if (modes.extended & modes.HINTS)
|
|
modes.reset();
|
|
hintMode.action(elem, elem.href || "", extendedhintCount);
|
|
}, timeout);
|
|
return true;
|
|
}
|
|
|
|
function onInput (event)
|
|
{
|
|
prevInput = "text";
|
|
|
|
// clear any timeout which might be active after pressing a number
|
|
if (activeTimeout)
|
|
{
|
|
clearTimeout(activeTimeout);
|
|
activeTimeout = null;
|
|
}
|
|
|
|
hintNumber = 0;
|
|
hintString = commandline.command;
|
|
updateStatusline();
|
|
showHints();
|
|
if (validHints.length == 1)
|
|
processHints(false);
|
|
}
|
|
|
|
function hintMatcher(hintString) //{{{
|
|
{
|
|
function tokenize(pat, string) string.split(pat).map(String.toLowerCase);
|
|
function containsMatcher(hintString) //{{{
|
|
{
|
|
let tokens = tokenize(/\s+/, hintString);
|
|
return function (linkText)
|
|
{
|
|
linkText = linkText.toLowerCase();
|
|
return tokens.every(function (token) linkText.indexOf(token) >= 0);
|
|
};
|
|
} //}}}
|
|
|
|
function wordStartsWithMatcher(hintString, allowWordOverleaping) //{{{
|
|
{
|
|
let hintStrings = tokenize(/\s+/, hintString);
|
|
let wordSplitRegex = RegExp(options["wordseparators"]);
|
|
|
|
// What the **** does this do? --Kris
|
|
//
|
|
// This function matches hintStrings like 'hekho' to links like 'Hey Kris, how are you?' -> [HE]y [K]ris [HO]w are you --Daniel
|
|
function charsAtBeginningOfWords(chars, words, allowWordOverleaping)
|
|
{
|
|
function charMatches(charIdx, chars, wordIdx, words, inWordIdx, allowWordOverleaping)
|
|
{
|
|
let matches = (chars[charIdx] == words[wordIdx][inWordIdx]);
|
|
if ((matches == false && allowWordOverleaping) || words[wordIdx].length == 0)
|
|
{
|
|
let nextWordIdx = wordIdx + 1;
|
|
if (nextWordIdx == words.length)
|
|
return false;
|
|
|
|
return charMatches(charIdx, chars, nextWordIdx, words, 0, allowWordOverleaping);
|
|
}
|
|
|
|
if (matches)
|
|
{
|
|
let nextCharIdx = charIdx + 1;
|
|
if (nextCharIdx == chars.length)
|
|
return true;
|
|
|
|
let nextWordIdx = wordIdx + 1;
|
|
let beyondLastWord = (nextWordIdx == words.length);
|
|
let charMatched = false;
|
|
if (beyondLastWord == false)
|
|
charMatched = charMatches(nextCharIdx, chars, nextWordIdx, words, 0, allowWordOverleaping)
|
|
|
|
if (charMatched)
|
|
return true;
|
|
|
|
if (charMatched == false || beyondLastWord == true)
|
|
{
|
|
let nextInWordIdx = inWordIdx + 1;
|
|
if (nextInWordIdx == words[wordIdx].length)
|
|
return false;
|
|
|
|
return charMatches(nextCharIdx, chars, wordIdx, words, nextInWordIdx, allowWordOverleaping);
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return charMatches(0, chars, 0, words, 0, allowWordOverleaping);
|
|
}
|
|
|
|
function stringsAtBeginningOfWords(strings, words, allowWordOverleaping)
|
|
{
|
|
let strIdx = 0;
|
|
for (let [,word] in Iterator(words))
|
|
{
|
|
if (word.length == 0)
|
|
continue;
|
|
|
|
let str = strings[strIdx];
|
|
if (str.length == 0 || word.indexOf(str) == 0)
|
|
strIdx++;
|
|
else if (!allowWordOverleaping)
|
|
return false;
|
|
|
|
if (strIdx == strings.length)
|
|
return true;
|
|
}
|
|
|
|
for (; strIdx < strings.length; strIdx++)
|
|
{
|
|
if (strings[strIdx].length != 0)
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
return function (linkText)
|
|
{
|
|
if (hintStrings.length == 1 && hintStrings[0].length == 0)
|
|
return true;
|
|
|
|
let words = tokenize(wordSplitRegex, linkText);
|
|
if (hintStrings.length == 1)
|
|
return charsAtBeginningOfWords(hintStrings[0], words, allowWordOverleaping);
|
|
else
|
|
return stringsAtBeginningOfWords(hintStrings, words, allowWordOverleaping);
|
|
};
|
|
} //}}}
|
|
|
|
switch (options["hintmatching"])
|
|
{
|
|
case "contains" : return containsMatcher(hintString);
|
|
case "wordstartswith": return wordStartsWithMatcher(hintString, /*allowWordOverleaping=*/ true);
|
|
case "firstletters" : return wordStartsWithMatcher(hintString, /*allowWordOverleaping=*/ false);
|
|
case "custom" : return liberator.plugins.customHintMatcher(hintString);
|
|
default : liberator.echoerr("Invalid hintmatching type: " + hintMatching);
|
|
}
|
|
return null;
|
|
} //}}}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////}}}
|
|
////////////////////// OPTIONS /////////////////////////////////////////////////
|
|
/////////////////////////////////////////////////////////////////////////////{{{
|
|
|
|
const DEFAULT_HINTTAGS = "//*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or @class='lk' or @role='link'] | " +
|
|
"//input[not(@type='hidden')] | //a | //area | //iframe | //textarea | //button | //select | " +
|
|
"//xhtml:input[not(@type='hidden')] | //xhtml:a | //xhtml:area | //xhtml:iframe | //xhtml:textarea | //xhtml:button | //xhtml:select";
|
|
|
|
options.add(["extendedhinttags", "eht"],
|
|
"XPath string of hintable elements activated by ';'",
|
|
"string", DEFAULT_HINTTAGS);
|
|
|
|
options.add(["hinttags", "ht"],
|
|
"XPath string of hintable elements activated by 'f' and 'F'",
|
|
"string", DEFAULT_HINTTAGS);
|
|
|
|
options.add(["hinttimeout", "hto"],
|
|
"Timeout before automatically following a non-unique numerical hint",
|
|
"number", 0,
|
|
{ validator: function (value) value >= 0 });
|
|
|
|
options.add(["followhints", "fh"],
|
|
// FIXME: this description isn't very clear but I can't think of a
|
|
// better one right now.
|
|
"Change the behaviour of <Return> in hint mode",
|
|
"number", 0,
|
|
{
|
|
completer: function () [
|
|
["0", "Follow the first hint as soon as typed text uniquely identifies it. Follow the selected hint on [m]<Return>[m]."],
|
|
["1", "Follow the selected hint on [m]<Return>[m]."],
|
|
["2", "Follow the selected hint on [m]<Return>[m] only it's been [m]<Tab>[m]-selected."]
|
|
],
|
|
validator: function (value) Option.validateCompleter
|
|
});
|
|
|
|
options.add(["hintmatching", "hm"],
|
|
"How links are matched",
|
|
"string", "contains",
|
|
{
|
|
completer: function (context) [
|
|
["contains", "The typed characters are split on whitespace. The resulting groups must all appear in the hint."],
|
|
["wordstartswith", "The typed characters are split on whitespace. The resulting groups must all match the beginings of words, in order."],
|
|
["firstletters", "Behaves like wordstartswith, but all groups much match a sequence of words."],
|
|
["custom", "Delegate to a custom function: liberator.plugins.customHintMatcher(hintString)"],
|
|
],
|
|
validator: Option.validateCompleter
|
|
});
|
|
|
|
options.add(["wordseparators", "wsp"],
|
|
"How words are split for hintmatching",
|
|
"string", '[.,!?:;/"^$%&?()[\\]{}<>#*+|=~ _-]');
|
|
|
|
options.add(["hintinputs", "hi"],
|
|
"How text inputs are hinted",
|
|
"stringlist", "label,value",
|
|
{
|
|
completer: function (context) [
|
|
["value", "Match against the value contained by the input field"],
|
|
["label", "Match against the value of a label for the input field, if one can be found"],
|
|
["name", "Match against the name of an input field, only if neither a name or value could be found."]
|
|
],
|
|
validator: Option.validateCompleter
|
|
});
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////////}}}
|
|
////////////////////// MAPPINGS ////////////////////////////////////////////////
|
|
/////////////////////////////////////////////////////////////////////////////{{{
|
|
|
|
mappings.add(myModes, ["f"],
|
|
"Start QuickHint mode",
|
|
function () { hints.show("o"); });
|
|
|
|
// At the moment, "F" calls
|
|
// buffer.followLink(clicked_element, DO_WHAT_FIREFOX_DOES_WITH_CNTRL_CLICK)
|
|
// It is not clear that it shouldn't be:
|
|
// buffer.followLink(clicked_element, !DO_WHAT_FIREFOX_DOES_WITH_CNTRL_CLICK)
|
|
// In fact, it might be nice if there was a "dual" to F (like H and
|
|
// gH, except that gF is already taken). --tpp
|
|
//
|
|
// Likewise, it might be nice to have a liberator.NEW_FOREGROUND_TAB
|
|
// and then make liberator.NEW_TAB always do what a Cntrl+Click
|
|
// does. --tpp
|
|
mappings.add(myModes, ["F"],
|
|
"Start QuickHint mode, but open link in a new tab",
|
|
function () { hints.show(options.getPref("browser.tabs.loadInBackground") ? "b" : "t"); });
|
|
|
|
mappings.add(myModes, [";"],
|
|
"Start an extended hint mode",
|
|
function (count)
|
|
{
|
|
extendedhintCount = count;
|
|
commandline.input(";", null,
|
|
{
|
|
promptHighlight: "Normal",
|
|
completer: function (context)
|
|
{
|
|
context.compare = function () 0;
|
|
context.completions = [[k, v.prompt] for ([k, v] in Iterator(hintModes))];
|
|
},
|
|
onChange: function () { modes.pop() },
|
|
onCancel: function (arg) { arg && setTimeout(function () hints.show(arg), 0); },
|
|
});
|
|
}, { flags: Mappings.flags.COUNT });
|
|
|
|
/////////////////////////////////////////////////////////////////////////////}}}
|
|
////////////////////// PUBLIC SECTION //////////////////////////////////////////
|
|
/////////////////////////////////////////////////////////////////////////////{{{
|
|
|
|
return {
|
|
|
|
addMode: function (mode)
|
|
{
|
|
hintModes[mode] = Mode.apply(Mode, Array.slice(arguments, 1));
|
|
},
|
|
|
|
show: function (minor, filter, win)
|
|
{
|
|
hintMode = hintModes[minor];
|
|
if (!hintMode)
|
|
{
|
|
liberator.beep();
|
|
return;
|
|
}
|
|
commandline.input(hintMode.prompt + ": ", null, { onChange: onInput });
|
|
modes.extended = modes.HINTS;
|
|
|
|
submode = minor;
|
|
hintString = filter || "";
|
|
hintNumber = 0;
|
|
usedTab = false;
|
|
prevInput = "";
|
|
canUpdate = false;
|
|
|
|
generate(win);
|
|
|
|
// get all keys from the input queue
|
|
liberator.threadYield(true);
|
|
|
|
canUpdate = true;
|
|
showHints();
|
|
|
|
if (validHints.length == 0)
|
|
{
|
|
liberator.beep();
|
|
modes.reset();
|
|
return false;
|
|
}
|
|
else if (validHints.length == 1)
|
|
{
|
|
processHints(true);
|
|
return false;
|
|
}
|
|
else // still hints visible
|
|
return true;
|
|
},
|
|
|
|
hide: function ()
|
|
{
|
|
removeHints(0);
|
|
},
|
|
|
|
onEvent: function (event)
|
|
{
|
|
let key = events.toString(event);
|
|
let followFirst = false;
|
|
|
|
// clear any timeout which might be active after pressing a number
|
|
if (activeTimeout)
|
|
{
|
|
clearTimeout(activeTimeout);
|
|
activeTimeout = null;
|
|
}
|
|
|
|
switch (key)
|
|
{
|
|
case "<Return>":
|
|
followFirst = true;
|
|
break;
|
|
|
|
case "<Tab>":
|
|
case "<S-Tab>":
|
|
usedTabKey = true;
|
|
if (hintNumber == 0)
|
|
hintNumber = 1;
|
|
|
|
let oldID = hintNumber;
|
|
if (key == "<Tab>")
|
|
{
|
|
if (++hintNumber > validHints.length)
|
|
hintNumber = 1;
|
|
}
|
|
else
|
|
{
|
|
if (--hintNumber < 1)
|
|
hintNumber = validHints.length;
|
|
}
|
|
showActiveHint(hintNumber, oldID);
|
|
updateStatusline();
|
|
return;
|
|
|
|
case "<BS>":
|
|
if (hintNumber > 0 && !usedTabKey)
|
|
{
|
|
hintNumber = Math.floor(hintNumber / 10);
|
|
if (hintNumber == 0)
|
|
prevInput = "text";
|
|
}
|
|
else
|
|
{
|
|
usedTabKey = false;
|
|
hintNumber = 0;
|
|
liberator.beep();
|
|
return;
|
|
}
|
|
break;
|
|
|
|
case mappings.getMapLeader():
|
|
hints.escNumbers = !hints.escNumbers;
|
|
if (hints.escNumbers && usedTabKey) // hintNumber not used normally, but someone may wants to toggle
|
|
hintNumber = 0; // <tab>s ? reset. Prevent to show numbers not entered.
|
|
|
|
updateStatusline();
|
|
return;
|
|
|
|
default:
|
|
if (/^\d$/.test(key))
|
|
{
|
|
prevInput = "number";
|
|
|
|
let oldHintNumber = hintNumber;
|
|
if (hintNumber == 0 || usedTabKey)
|
|
{
|
|
usedTabKey = false;
|
|
hintNumber = parseInt(key, 10);
|
|
}
|
|
else
|
|
hintNumber = (hintNumber * 10) + parseInt(key, 10);
|
|
|
|
updateStatusline();
|
|
|
|
if (!canUpdate)
|
|
return;
|
|
|
|
if (docs.length == 0)
|
|
{
|
|
generate();
|
|
showHints();
|
|
}
|
|
showActiveHint(hintNumber, oldHintNumber || 1);
|
|
|
|
if (hintNumber == 0 || hintNumber > validHints.length)
|
|
{
|
|
liberator.beep();
|
|
return;
|
|
}
|
|
|
|
// if we write a numeric part like 3, but we have 45 hints, only follow
|
|
// the hint after a timeout, as the user might have wanted to follow link 34
|
|
if (hintNumber > 0 && hintNumber * 10 <= validHints.length)
|
|
{
|
|
let timeout = options["hinttimeout"];
|
|
if (timeout > 0)
|
|
activeTimeout = setTimeout(function () { processHints(true); }, timeout);
|
|
|
|
return false;
|
|
}
|
|
// we have a unique hint
|
|
processHints(true);
|
|
return;
|
|
}
|
|
}
|
|
|
|
updateStatusline();
|
|
|
|
if (canUpdate)
|
|
{
|
|
if (docs.length == 0 && hintString.length > 0)
|
|
generate();
|
|
|
|
showHints();
|
|
processHints(followFirst);
|
|
}
|
|
}
|
|
};
|
|
|
|
// FIXME: add resize support
|
|
// window.addEventListener("resize", onResize, null);
|
|
|
|
// function onResize(event)
|
|
// {
|
|
// if (event)
|
|
// doc = event.originalTarget;
|
|
// else
|
|
// doc = window.content.document;
|
|
// }
|
|
|
|
//}}}
|
|
}; //}}}
|
|
|
|
// vim: set fdm=marker sw=4 ts=4 et:
|