mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-02-22 05:25:46 +01:00
Because I can.
This commit is contained in:
Kris Maglione
326
common/modules/help.jsm
Normal file
326
common/modules/help.jsm
Normal file
@@ -0,0 +1,326 @@
|
||||
// Copyright (c) 2008-2011 by 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.
|
||||
"use strict";
|
||||
|
||||
Components.utils.import("resource://dactyl/bootstrap.jsm");
|
||||
defineModule("help", {
|
||||
exports: ["help"],
|
||||
require: ["protocol", "services", "util"],
|
||||
use: ["config", "highlight", "messages", "template"]
|
||||
}, this);
|
||||
|
||||
var Help = Module("Help", {
|
||||
init: function init() {
|
||||
this.initialized = false;
|
||||
this.files = {};
|
||||
this.overlays = {};
|
||||
this.tags = {};
|
||||
|
||||
function Loop(fn)
|
||||
function (uri, path) {
|
||||
if (!help.initialized)
|
||||
return RedirectChannel(uri.spec, uri, 1);
|
||||
return fn.apply(this, arguments);
|
||||
}
|
||||
|
||||
update(services["dactyl:"].providers, {
|
||||
"help": Loop(function (uri, path) help.files[path]),
|
||||
"help-overlay": Loop(function (uri, path) help.overlays[path]),
|
||||
"help-tag": Loop(function (uri, path) {
|
||||
let tag = decodeURIComponent(path);
|
||||
if (tag in help.files)
|
||||
return RedirectChannel("dactyl://help/" + tag, uri);
|
||||
if (tag in help.tags)
|
||||
return RedirectChannel("dactyl://help/" + help.tags[tag] + "#" + tag.replace(/#/g, encodeURIComponent), uri);
|
||||
})
|
||||
});
|
||||
},
|
||||
|
||||
Local: function Local(dactyl, modules, window) ({
|
||||
init: function init() {
|
||||
dactyl.commands["dactyl.help"] = function (event) {
|
||||
let elem = event.originalTarget;
|
||||
help.help(elem.getAttribute("tag") || elem.textContent);
|
||||
};
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns the URL of the specified help *topic* if it exists.
|
||||
*
|
||||
* @param {string} topic The help topic to look up.
|
||||
* @param {boolean} consolidated Whether to search the consolidated help page.
|
||||
* @returns {string}
|
||||
*/
|
||||
findHelp: function (topic, consolidated) {
|
||||
if (!consolidated && Set.has(help.files, topic))
|
||||
return topic;
|
||||
let items = modules.completion._runCompleter("help", topic, null, !!consolidated).items;
|
||||
let partialMatch = null;
|
||||
|
||||
function format(item) item.description + "#" + encodeURIComponent(item.text);
|
||||
|
||||
for (let [i, item] in Iterator(items)) {
|
||||
if (item.text == topic)
|
||||
return format(item);
|
||||
else if (!partialMatch && topic)
|
||||
partialMatch = item;
|
||||
}
|
||||
|
||||
if (partialMatch)
|
||||
return format(partialMatch);
|
||||
return null;
|
||||
},
|
||||
|
||||
/**
|
||||
* Opens the help page containing the specified *topic* if it exists.
|
||||
*
|
||||
* @param {string} topic The help topic to open.
|
||||
* @param {boolean} consolidated Whether to use the consolidated help page.
|
||||
*/
|
||||
help: function (topic, consolidated) {
|
||||
dactyl.initHelp();
|
||||
if (!topic) {
|
||||
let helpFile = consolidated ? "all" : modules.options["helpfile"];
|
||||
|
||||
if (Set.has(help.files, helpFile))
|
||||
dactyl.open("dactyl://help/" + helpFile, { from: "help" });
|
||||
else
|
||||
dactyl.echomsg(_("help.noFile", helpFile.quote()));
|
||||
return;
|
||||
}
|
||||
|
||||
let page = this.findHelp(topic, consolidated);
|
||||
dactyl.assert(page != null, _("help.noTopic", topic));
|
||||
|
||||
dactyl.open("dactyl://help/" + page, { from: "help" });
|
||||
}
|
||||
|
||||
}),
|
||||
|
||||
// Find the tags in the document.
|
||||
addTags: function addTags(file, doc) {
|
||||
for (let elem in DOM.XPath("//@tag|//dactyl:tags/text()|//dactyl:tag/text()", doc))
|
||||
for (let tag in values((elem.value || elem.textContent).split(/\s+/)))
|
||||
this.tags[tag] = file;
|
||||
},
|
||||
|
||||
namespaces: ["locale-local", "locale"],
|
||||
|
||||
// Find help and overlay files with the given name.
|
||||
findHelpFile: function findHelpFile(file) {
|
||||
let result = [];
|
||||
for (let namespace in values(this.namespaces)) {
|
||||
let url = ["dactyl://", namespace, "/", file, ".xml"].join("");
|
||||
let res = util.httpGet(url);
|
||||
if (res) {
|
||||
if (res.responseXML.documentElement.localName == "document")
|
||||
this.files[file] = url;
|
||||
if (res.responseXML.documentElement.localName == "overlay")
|
||||
this.overlays[file] = url;
|
||||
result.push(res.responseXML);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
},
|
||||
|
||||
initialize: function initialize(force) {
|
||||
// Waits for the add-on to become available, if necessary.
|
||||
config.addon;
|
||||
config.version;
|
||||
|
||||
if (force || !this.initialized) {
|
||||
|
||||
this.files["versions"] = function () {
|
||||
let NEWS = util.httpGet(config.addon.getResourceURI("NEWS").spec,
|
||||
{ mimeType: "text/plain;charset=UTF-8" })
|
||||
.responseText;
|
||||
|
||||
let re = util.regexp(<![CDATA[
|
||||
^ (?P<comment> \s* # .*\n)
|
||||
|
||||
| ^ (?P<space> \s*)
|
||||
(?P<char> [-•*+]) \ //
|
||||
(?P<content> .*\n
|
||||
(?: \2\ \ .*\n | \s*\n)* )
|
||||
|
||||
| (?P<par>
|
||||
(?: ^ [^\S\n]*
|
||||
(?:[^-•*+\s] | [-•*+]\S)
|
||||
.*\n
|
||||
)+
|
||||
)
|
||||
|
||||
| (?: ^ [^\S\n]* \n) +
|
||||
]]>, "gmxy");
|
||||
|
||||
let betas = util.regexp(/\[(b\d)\]/, "gx");
|
||||
|
||||
let beta = array(betas.iterate(NEWS))
|
||||
.map(function (m) m[1]).uniq().slice(-1)[0];
|
||||
|
||||
|
||||
default xml namespace = NS;
|
||||
function rec(text, level, li) {
|
||||
XML.ignoreWhitespace = XML.prettyPrinting = false;
|
||||
|
||||
let res = <></>;
|
||||
let list, space, i = 0;
|
||||
|
||||
|
||||
for (let match in re.iterate(text)) {
|
||||
if (match.comment)
|
||||
continue;
|
||||
else if (match.char) {
|
||||
if (!list)
|
||||
res += list = <ul/>;
|
||||
let li = <li/>;
|
||||
li.* += rec(match.content.replace(RegExp("^" + match.space, "gm"), ""), level + 1, li);
|
||||
list.* += li;
|
||||
}
|
||||
else if (match.par) {
|
||||
let [, par, tags] = /([^]*?)\s*((?:\[[^\]]+\])*)\n*$/.exec(match.par);
|
||||
let t = tags;
|
||||
tags = array(betas.iterate(tags)).map(function (m) m[1]);
|
||||
|
||||
let group = !tags.length ? "" :
|
||||
!tags.some(function (t) t == beta) ? "HelpNewsOld" : "HelpNewsNew";
|
||||
if (i === 0 && li) {
|
||||
li.@highlight = group;
|
||||
group = "";
|
||||
}
|
||||
|
||||
list = null;
|
||||
if (level == 0 && /^.*:\n$/.test(match.par)) {
|
||||
let text = par.slice(0, -1);
|
||||
res += <h2 tag={"news-" + text}>{template.linkifyHelp(text, true)}</h2>;
|
||||
}
|
||||
else {
|
||||
let [, a, b] = /^(IMPORTANT:?)?([^]*)/.exec(par);
|
||||
res += <p highlight={group + " HelpNews"}>{
|
||||
!tags.length ? "" :
|
||||
<hl key="HelpNewsTag">{tags.join(" ")}</hl>
|
||||
}{
|
||||
a ? <hl key="HelpWarning">{a}</hl> : ""
|
||||
}{
|
||||
template.linkifyHelp(b, true)
|
||||
}</p>;
|
||||
}
|
||||
}
|
||||
i++;
|
||||
}
|
||||
for each (let attr in res..@highlight) {
|
||||
attr.parent().@NS::highlight = attr;
|
||||
delete attr.parent().@highlight;
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
XML.ignoreWhitespace = XML.prettyPrinting = false;
|
||||
let body = rec(NEWS, 0);
|
||||
for each (let li in body..li) {
|
||||
let list = li..li.(@NS::highlight == "HelpNewsOld");
|
||||
if (list.length() && list.length() == li..li.(@NS::highlight != "").length()) {
|
||||
for each (let li in list)
|
||||
li.@NS::highlight = "";
|
||||
li.@NS::highlight = "HelpNewsOld";
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
return ["application/xml",
|
||||
'<?xml version="1.0"?>\n' +
|
||||
'<?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>\n' +
|
||||
'<!DOCTYPE document SYSTEM "resource://dactyl-content/dactyl.dtd">\n' +
|
||||
<document xmlns={NS} xmlns:dactyl={NS}
|
||||
name="versions" title={config.appName + " Versions"}>
|
||||
<h1 tag="versions news NEWS">{config.appName} Versions</h1>
|
||||
<toc start="2"/>
|
||||
|
||||
{body}
|
||||
</document>.toXMLString()
|
||||
];
|
||||
}
|
||||
|
||||
|
||||
|
||||
// Scrape the list of help files from all.xml
|
||||
// Manually process main and overlay files, since XSLTProcessor and
|
||||
// XMLHttpRequest don't allow access to chrome documents.
|
||||
this.tags["all"] = this.tags["all.xml"] = "all";
|
||||
let files = this.findHelpFile("all").map(function (doc)
|
||||
[f.value for (f in DOM.XPath("//dactyl:include/@href", doc))]);
|
||||
|
||||
// Scrape the tags from the rest of the help files.
|
||||
array.flatten(files).forEach(function (file) {
|
||||
this.tags[file + ".xml"] = file;
|
||||
this.findHelpFile(file).forEach(function (doc) {
|
||||
this.addTags(file, doc);
|
||||
}, this);
|
||||
}, this);
|
||||
|
||||
this.tags["versions"] = this.tags["versions.xml"] = "versions";
|
||||
|
||||
this.addTags("versions", util.httpGet("dactyl://help/versions").responseXML);
|
||||
|
||||
help.initialized = true;
|
||||
}
|
||||
},
|
||||
}, {
|
||||
}, {
|
||||
commands: function init_commands(dactyl, modules, window) {
|
||||
const { commands, completion, help } = modules;
|
||||
|
||||
[
|
||||
{
|
||||
name: "h[elp]",
|
||||
description: "Open the introductory help page"
|
||||
}, {
|
||||
name: "helpa[ll]",
|
||||
description: "Open the single consolidated help page"
|
||||
}
|
||||
].forEach(function (command) {
|
||||
let consolidated = command.name == "helpa[ll]";
|
||||
|
||||
commands.add([command.name],
|
||||
command.description,
|
||||
function (args) {
|
||||
dactyl.assert(!args.bang, _("help.dontPanic"));
|
||||
help.help(args.literalArg, consolidated);
|
||||
}, {
|
||||
argCount: "?",
|
||||
bang: true,
|
||||
completer: function (context) completion.help(context, consolidated),
|
||||
literal: 0
|
||||
});
|
||||
});
|
||||
},
|
||||
completion: function init_completion(dactyl, modules, window) {
|
||||
const { completion } = modules;
|
||||
|
||||
completion.help = function completion_help(context, consolidated) {
|
||||
dactyl.initHelp();
|
||||
context.title = ["Help"];
|
||||
context.anchored = false;
|
||||
context.completions = help.tags;
|
||||
if (consolidated)
|
||||
context.keys = { text: 0, description: function () "all" };
|
||||
};
|
||||
},
|
||||
mappings: function init_mappings(dactyl, modules, window) {
|
||||
const { help, mappings, modes } = modules;
|
||||
|
||||
mappings.add([modes.MAIN], ["<open-help>", "<F1>"],
|
||||
"Open the introductory help page",
|
||||
function () { help.help(); });
|
||||
|
||||
mappings.add([modes.MAIN], ["<open-single-help>", "<A-F1>"],
|
||||
"Open the single, consolidated help page",
|
||||
function () { modules.ex.helpall(); });
|
||||
}
|
||||
});
|
||||
|
||||
endModule();
|
||||
|
||||
// vim: set fdm=marker sw=4 ts=4 et:
|
||||
Reference in New Issue
Block a user