mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-03-13 03:15:47 +01:00
Recfactoring:
* Standard module format. All modules are explicitly declared as modules, they're created via a constructor and instantiated automatically. They're dependency aware. They stringify properly. * Classes are declared the same way (rather like Structs already were). They also stringify properly. Plus, each instance has a rather nifty closure member that closes all of its methods around 'this', so you can pass them to map, forEach, setTimeout, etc. Modules are themselves classes, with a special metaclass, as it were. * Doug Crockford is dead, metaphorically speaking. Closure-based classes just don't fit into any of the common JavaScript frameworks, and they're inefficient and confusing. Now, all class and module members are accessed explicitly via 'this', which makes it very clear that they're class members and not (e.g.) local variables, without anything nasty like Hungarian notation. * Strictly one module per file. Classes that belong to a module live in the same file. * For the moment, there are quite a few utility functions sitting in base.c, because my class implementation used them, and I haven't had the time or inclination to sort them out. I plan to reconcile them with the current mess that is the util namespace. * Changed bracing style.
This commit is contained in:
Kris Maglione
@@ -27,52 +27,50 @@
|
||||
* @optional
|
||||
* @private
|
||||
*/
|
||||
function Map(modes, keys, description, action, extraInfo) //{{{
|
||||
{
|
||||
modes = Array.concat(modes);
|
||||
const Map = Class("Map", {
|
||||
init: function (modes, keys, description, action, extraInfo) {
|
||||
modes = Array.concat(modes);
|
||||
|
||||
if (!extraInfo)
|
||||
extraInfo = {};
|
||||
if (!extraInfo)
|
||||
extraInfo = {};
|
||||
|
||||
/** @property {number[]} All of the modes for which this mapping applies. */
|
||||
this.modes = modes;
|
||||
/** @property {string[]} All of this mapping's names (key sequences). */
|
||||
this.names = keys.map(events.canonicalKeys);
|
||||
/** @property {function (number)} The function called to execute this mapping. */
|
||||
this.action = action;
|
||||
/** @property {string} This mapping's description, as shown in :viusage. */
|
||||
this.description = description || "";
|
||||
/** @property {number[]} All of the modes for which this mapping applies. */
|
||||
this.modes = modes;
|
||||
/** @property {string[]} All of this mapping's names (key sequences). */
|
||||
this.names = keys.map(events.canonicalKeys);
|
||||
/** @property {function (number)} The function called to execute this mapping. */
|
||||
this.action = action;
|
||||
/** @property {string} This mapping's description, as shown in :viusage. */
|
||||
this.description = description || "";
|
||||
|
||||
/** @property {boolean} Whether this mapping accepts an argument. */
|
||||
this.arg = extraInfo.arg || false;
|
||||
/** @property {boolean} Whether this mapping accepts a count. */
|
||||
this.count = extraInfo.count || false;
|
||||
/**
|
||||
* @property {boolean} Whether the mapping accepts a motion mapping
|
||||
* as an argument.
|
||||
*/
|
||||
this.motion = extraInfo.motion || false;
|
||||
/**
|
||||
* @property {boolean} Whether the mapping's key events should be
|
||||
* propagated to the host application.
|
||||
*/
|
||||
// TODO: I'm not sure this is the best name but it reflects that which it replaced. --djk
|
||||
this.route = extraInfo.route || false;
|
||||
/** @property {boolean} Whether the RHS of the mapping should expand mappings recursively. */
|
||||
this.noremap = extraInfo.noremap || false;
|
||||
/** @property {boolean} Whether any output from the mapping should be echoed on the command line. */
|
||||
this.silent = extraInfo.silent || false;
|
||||
/** @property {string} The literal RHS expansion of this mapping. */
|
||||
this.rhs = extraInfo.rhs || null;
|
||||
/**
|
||||
* @property {boolean} Specifies whether this is a user mapping. User
|
||||
* mappings may be created by plugins, or directly by users. Users and
|
||||
* plugin authors should create only user mappings.
|
||||
*/
|
||||
this.user = extraInfo.user || false;
|
||||
}
|
||||
|
||||
Map.prototype = {
|
||||
/** @property {boolean} Whether this mapping accepts an argument. */
|
||||
this.arg = extraInfo.arg || false;
|
||||
/** @property {boolean} Whether this mapping accepts a count. */
|
||||
this.count = extraInfo.count || false;
|
||||
/**
|
||||
* @property {boolean} Whether the mapping accepts a motion mapping
|
||||
* as an argument.
|
||||
*/
|
||||
this.motion = extraInfo.motion || false;
|
||||
/**
|
||||
* @property {boolean} Whether the mapping's key events should be
|
||||
* propagated to the host application.
|
||||
*/
|
||||
// TODO: I'm not sure this is the best name but it reflects that which it replaced. --djk
|
||||
this.route = extraInfo.route || false;
|
||||
/** @property {boolean} Whether the RHS of the mapping should expand mappings recursively. */
|
||||
this.noremap = extraInfo.noremap || false;
|
||||
/** @property {boolean} Whether any output from the mapping should be echoed on the command line. */
|
||||
this.silent = extraInfo.silent || false;
|
||||
/** @property {string} The literal RHS expansion of this mapping. */
|
||||
this.rhs = extraInfo.rhs || null;
|
||||
/**
|
||||
* @property {boolean} Specifies whether this is a user mapping. User
|
||||
* mappings may be created by plugins, or directly by users. Users and
|
||||
* plugin authors should create only user mappings.
|
||||
*/
|
||||
this.user = extraInfo.user || false;
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns whether this mapping can be invoked by a key sequence matching
|
||||
@@ -93,8 +91,7 @@ Map.prototype = {
|
||||
* @param {string} argument The normal argument if accepted by this
|
||||
* mapping. E.g. "a" for "ma"
|
||||
*/
|
||||
execute: function (motion, count, argument)
|
||||
{
|
||||
execute: function (motion, count, argument) {
|
||||
let args = [];
|
||||
|
||||
if (this.motion)
|
||||
@@ -112,60 +109,46 @@ Map.prototype = {
|
||||
return liberator.trapErrors(repeat);
|
||||
}
|
||||
|
||||
}; //}}}
|
||||
});
|
||||
|
||||
/**
|
||||
* @instance mappings
|
||||
*/
|
||||
function Mappings() //{{{
|
||||
{
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
////////////////////// PRIVATE SECTION /////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////{{{
|
||||
const Mappings = Module("mappings", {
|
||||
requires: ["modes"],
|
||||
|
||||
var main = []; // default mappings
|
||||
var user = []; // user created mappings
|
||||
init: function () {
|
||||
this._main = []; // default mappings
|
||||
this._user = []; // user created mappings
|
||||
},
|
||||
|
||||
for (let mode in modes)
|
||||
{
|
||||
main[mode] = [];
|
||||
user[mode] = [];
|
||||
}
|
||||
|
||||
function addMap(map)
|
||||
{
|
||||
let where = map.user ? user : main;
|
||||
_addMap: function (map) {
|
||||
let where = map.user ? this._user : this._main;
|
||||
map.modes.forEach(function (mode) {
|
||||
if (!(mode in where))
|
||||
where[mode] = [];
|
||||
where[mode].push(map);
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
function getMap(mode, cmd, stack)
|
||||
{
|
||||
_getMap: function (mode, cmd, stack) {
|
||||
let maps = stack[mode] || [];
|
||||
|
||||
for (let [, map] in Iterator(maps))
|
||||
{
|
||||
for (let [, map] in Iterator(maps)) {
|
||||
if (map.hasName(cmd))
|
||||
return map;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
},
|
||||
|
||||
function removeMap(mode, cmd)
|
||||
{
|
||||
let maps = user[mode] || [];
|
||||
_removeMap: function (mode, cmd) {
|
||||
let maps = this._user[mode] || [];
|
||||
let names;
|
||||
|
||||
for (let [i, map] in Iterator(maps))
|
||||
{
|
||||
for (let [j, name] in Iterator(map.names))
|
||||
{
|
||||
if (name == cmd)
|
||||
{
|
||||
for (let [i, map] in Iterator(maps)) {
|
||||
for (let [j, name] in Iterator(map.names)) {
|
||||
if (name == cmd) {
|
||||
map.names.splice(j, 1);
|
||||
if (map.names.length == 0)
|
||||
maps.splice(i, 1);
|
||||
@@ -173,152 +156,329 @@ function Mappings() //{{{
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
function expandLeader(keyString) keyString.replace(/<Leader>/i, mappings.getMapLeader())
|
||||
_expandLeader: function (keyString) keyString.replace(/<Leader>/i, mappings.getMapLeader()),
|
||||
|
||||
// Return all mappings present in all @modes
|
||||
function mappingsIterator(modes, stack)
|
||||
{
|
||||
_mappingsIterator: function (modes, stack) {
|
||||
modes = modes.slice();
|
||||
return (map for ([i, map] in Iterator(stack[modes.shift()]))
|
||||
if (modes.every(function (mode) stack[mode].some(
|
||||
function (m) m.rhs == map.rhs && m.names[0] == map.names[0]))))
|
||||
}
|
||||
},
|
||||
|
||||
function addMapCommands(ch, modes, modeDescription)
|
||||
{
|
||||
// 0 args -> list all maps
|
||||
// 1 arg -> list the maps starting with args
|
||||
// 2 args -> map arg1 to arg*
|
||||
function map(args, modes, noremap)
|
||||
{
|
||||
if (!args.length)
|
||||
{
|
||||
mappings.list(modes);
|
||||
return;
|
||||
}
|
||||
// NOTE: just normal mode for now
|
||||
/** @property {Iterator(Map)} @private */
|
||||
__iterator__: function () this._mappingsIterator([modes.NORMAL], this._main),
|
||||
|
||||
let [lhs, rhs] = args;
|
||||
// used by :mkvimperatorrc to save mappings
|
||||
/**
|
||||
* Returns a user-defined mappings iterator for the specified
|
||||
* <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to return mappings from.
|
||||
* @returns {Iterator(Map)}
|
||||
*/
|
||||
getUserIterator: function (mode) this._mappingsIterator(mode, this._user),
|
||||
|
||||
if (!rhs) // list the mapping
|
||||
mappings.list(modes, expandLeader(lhs));
|
||||
else
|
||||
{
|
||||
// this matches Vim's behaviour
|
||||
if (/^<Nop>$/i.test(rhs))
|
||||
noremap = true;
|
||||
addMode: function (mode) {
|
||||
if (!(mode in this._user || mode in this._main)) {
|
||||
this._main[mode] = [];
|
||||
this._user[mode] = [];
|
||||
}
|
||||
},
|
||||
|
||||
mappings.addUserMap(modes, [lhs],
|
||||
"User defined mapping",
|
||||
function (count) { events.feedkeys((count > -1 ? count : "") + this.rhs, this.noremap, this.silent); },
|
||||
{
|
||||
count: true,
|
||||
rhs: events.canonicalKeys(rhs),
|
||||
noremap: !!noremap,
|
||||
silent: "<silent>" in args
|
||||
});
|
||||
}
|
||||
/**
|
||||
* Adds a new default key mapping.
|
||||
*
|
||||
* @param {number[]} modes The modes that this mapping applies to.
|
||||
* @param {string[]} keys The key sequences which are bound to
|
||||
* <b>action</b>.
|
||||
* @param {string} description A description of the key mapping.
|
||||
* @param {function} action The action invoked by each key sequence.
|
||||
* @param {Object} extra An optional extra configuration hash.
|
||||
* @optional
|
||||
*/
|
||||
add: function (modes, keys, description, action, extra) {
|
||||
this._addMap(new Map(modes, keys, description, action, extra));
|
||||
},
|
||||
|
||||
/**
|
||||
* Adds a new user-defined key mapping.
|
||||
*
|
||||
* @param {number[]} modes The modes that this mapping applies to.
|
||||
* @param {string[]} keys The key sequences which are bound to
|
||||
* <b>action</b>.
|
||||
* @param {string} description A description of the key mapping.
|
||||
* @param {function} action The action invoked by each key sequence.
|
||||
* @param {Object} extra An optional extra configuration hash (see
|
||||
* {@link Map#extraInfo}).
|
||||
* @optional
|
||||
*/
|
||||
addUserMap: function (modes, keys, description, action, extra) {
|
||||
keys = keys.map(this._expandLeader);
|
||||
extra = extra || {};
|
||||
extra.user = true;
|
||||
let map = new Map(modes, keys, description || "User defined mapping", action, extra);
|
||||
|
||||
// remove all old mappings to this key sequence
|
||||
for (let [, name] in Iterator(map.names)) {
|
||||
for (let [, mode] in Iterator(map.modes))
|
||||
this._removeMap(mode, name);
|
||||
}
|
||||
|
||||
modeDescription = modeDescription ? " in " + modeDescription + " mode" : "";
|
||||
this._addMap(map);
|
||||
},
|
||||
|
||||
// :map, :noremap => NORMAL + VISUAL modes
|
||||
function isMultiMode(map, cmd)
|
||||
{
|
||||
return map.modes.indexOf(modules.modes.NORMAL) >= 0
|
||||
&& map.modes.indexOf(modules.modes.VISUAL) >= 0
|
||||
&& /^[nv](nore)?map$/.test(cmd);
|
||||
}
|
||||
/**
|
||||
* Returns the map from <b>mode</b> named <b>cmd</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The map name to match.
|
||||
* @returns {Map}
|
||||
*/
|
||||
get: function (mode, cmd) {
|
||||
mode = mode || modes.NORMAL;
|
||||
return this._getMap(mode, cmd, this._user) || this._getMap(mode, cmd, this._main);
|
||||
},
|
||||
|
||||
const opts = {
|
||||
completer: function (context, args) completion.userMapping(context, args, modes),
|
||||
options: [
|
||||
[["<silent>", "<Silent>"], commands.OPTION_NOARG]
|
||||
],
|
||||
literal: 1,
|
||||
serial: function ()
|
||||
{
|
||||
let noremap = this.name.indexOf("noremap") > -1;
|
||||
return [
|
||||
{
|
||||
command: this.name,
|
||||
options: map.silent ? { "<silent>": null } : {},
|
||||
arguments: [map.names[0]],
|
||||
literalArg: map.rhs
|
||||
}
|
||||
for (map in mappingsIterator(modes, user))
|
||||
if (map.rhs && map.noremap == noremap && !isMultiMode(map, this.name))
|
||||
];
|
||||
/**
|
||||
* Returns the default map from <b>mode</b> named <b>cmd</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The map name to match.
|
||||
* @returns {Map}
|
||||
*/
|
||||
getDefault: function (mode, cmd) {
|
||||
mode = mode || modes.NORMAL;
|
||||
return this._getMap(mode, cmd, this._main);
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns an array of maps with names starting with but not equal to
|
||||
* <b>prefix</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} prefix The map prefix string to match.
|
||||
* @returns {Map[]}
|
||||
*/
|
||||
getCandidates: function (mode, prefix) {
|
||||
let mappings = this._user[mode].concat(this._main[mode]);
|
||||
let matches = [];
|
||||
|
||||
for (let [, map] in Iterator(mappings)) {
|
||||
for (let [, name] in Iterator(map.names)) {
|
||||
if (name.indexOf(prefix) == 0 && name.length > prefix.length) {
|
||||
// for < only return a candidate if it doesn't look like a <c-x> mapping
|
||||
if (prefix != "<" || !/^<.+>/.test(name))
|
||||
matches.push(map);
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
commands.add([ch ? ch + "m[ap]" : "map"],
|
||||
"Map a key sequence" + modeDescription,
|
||||
function (args) { map(args, modes, false); },
|
||||
opts);
|
||||
return matches;
|
||||
},
|
||||
|
||||
commands.add([ch + "no[remap]"],
|
||||
"Map a key sequence without remapping keys" + modeDescription,
|
||||
function (args) { map(args, modes, true); },
|
||||
opts);
|
||||
/*
|
||||
* Returns the map leader string used to replace the special token
|
||||
* "<Leader>" when user mappings are defined.
|
||||
*
|
||||
* @returns {string}
|
||||
*/
|
||||
// FIXME: property
|
||||
getMapLeader: function () {
|
||||
let leaderRef = liberator.variableReference("mapleader");
|
||||
return leaderRef[0] ? leaderRef[0][leaderRef[1]] : "\\";
|
||||
},
|
||||
|
||||
commands.add([ch + "mapc[lear]"],
|
||||
"Remove all mappings" + modeDescription,
|
||||
function () { modes.forEach(function (mode) { mappings.removeAll(mode); }); },
|
||||
{ argCount: "0" });
|
||||
/**
|
||||
* Returns whether there is a user-defined mapping <b>cmd</b> for the
|
||||
* specified <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The candidate key mapping.
|
||||
* @returns {boolean}
|
||||
*/
|
||||
hasMap: function (mode, cmd) this._user[mode].some(function (map) map.hasName(cmd)),
|
||||
|
||||
commands.add([ch + "unm[ap]"],
|
||||
"Remove a mapping" + modeDescription,
|
||||
function (args)
|
||||
{
|
||||
args = args[0];
|
||||
/**
|
||||
* Remove the user-defined mapping named <b>cmd</b> for <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The map name to match.
|
||||
*/
|
||||
remove: function (mode, cmd) {
|
||||
this._removeMap(mode, cmd);
|
||||
},
|
||||
|
||||
let found = false;
|
||||
for (let [, mode] in Iterator(modes))
|
||||
/**
|
||||
* Remove all user-defined mappings for <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to remove all mappings from.
|
||||
*/
|
||||
removeAll: function (mode) {
|
||||
this._user[mode] = [];
|
||||
},
|
||||
|
||||
/**
|
||||
* Lists all user-defined mappings matching <b>filter</b> for the
|
||||
* specified <b>modes</b>.
|
||||
*
|
||||
* @param {number[]} modes An array of modes to search.
|
||||
* @param {string} filter The filter string to match.
|
||||
*/
|
||||
list: function (modes, filter) {
|
||||
let modeSign = "";
|
||||
|
||||
// TODO: Vim hides "nv" in a :map and "v" and "n" in :vmap and
|
||||
// :nmap respectively if the map is not exclusive.
|
||||
modes.forEach(function (mode) {
|
||||
for (let m in modules.modes.mainModes)
|
||||
if (mode == m.mask && modeSign.indexOf(m.char) == -1)
|
||||
modeSign += m.char;
|
||||
});
|
||||
|
||||
let maps = this._mappingsIterator(modes, this._user);
|
||||
if (filter)
|
||||
maps = [map for (map in maps) if (map.names[0] == filter)];
|
||||
|
||||
let list = <table>
|
||||
{
|
||||
if (mappings.hasMap(mode, args))
|
||||
{
|
||||
mappings.remove(mode, args);
|
||||
found = true;
|
||||
template.map(maps, function (map)
|
||||
template.map(map.names, function (name)
|
||||
<tr>
|
||||
<td>{modeSign} {name}</td>
|
||||
<td>{map.noremap ? "*" : " "}</td>
|
||||
<td>{map.rhs || "function () { ... }"}</td>
|
||||
</tr>))
|
||||
}
|
||||
</table>;
|
||||
|
||||
// TODO: Move this to an ItemList to show this automatically
|
||||
if (list.*.length() == list.text().length()) {
|
||||
liberator.echomsg("No mapping found");
|
||||
return;
|
||||
}
|
||||
commandline.echo(list, commandline.HL_NORMAL, commandline.FORCE_MULTILINE);
|
||||
}
|
||||
}, {
|
||||
}, {
|
||||
commands: function () {
|
||||
function addMapCommands(ch, modes, modeDescription) {
|
||||
// 0 args -> list all maps
|
||||
// 1 arg -> list the maps starting with args
|
||||
// 2 args -> map arg1 to arg*
|
||||
function map(args, modes, noremap) {
|
||||
if (!args.length) {
|
||||
mappings.list(modes);
|
||||
return;
|
||||
}
|
||||
|
||||
let [lhs, rhs] = args;
|
||||
|
||||
if (!rhs) // list the mapping
|
||||
mappings.list(modes, this._expandLeader(lhs));
|
||||
else {
|
||||
// this matches Vim's behaviour
|
||||
if (/^<Nop>$/i.test(rhs))
|
||||
noremap = true;
|
||||
|
||||
mappings.addUserMap(modes, [lhs],
|
||||
"User defined mapping",
|
||||
function (count) { events.feedkeys((count > -1 ? count : "") + this.rhs, this.noremap, this.silent); }, {
|
||||
count: true,
|
||||
rhs: events.canonicalKeys(rhs),
|
||||
noremap: !!noremap,
|
||||
silent: "<silent>" in args
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
modeDescription = modeDescription ? " in " + modeDescription + " mode" : "";
|
||||
|
||||
// :map, :noremap => NORMAL + VISUAL modes
|
||||
function isMultiMode(map, cmd) {
|
||||
return map.modes.indexOf(modules.modes.NORMAL) >= 0
|
||||
&& map.modes.indexOf(modules.modes.VISUAL) >= 0
|
||||
&& /^[nv](nore)?map$/.test(cmd);
|
||||
}
|
||||
|
||||
const opts = {
|
||||
completer: function (context, args) completion.userMapping(context, args, modes),
|
||||
options: [
|
||||
[["<silent>", "<Silent>"], commands.OPTION_NOARG]
|
||||
],
|
||||
literal: 1,
|
||||
serial: function () {
|
||||
let noremap = this.name.indexOf("noremap") > -1;
|
||||
return [
|
||||
{
|
||||
command: this.name,
|
||||
options: map.silent ? { "<silent>": null } : {},
|
||||
arguments: [map.names[0]],
|
||||
literalArg: map.rhs
|
||||
}
|
||||
for (map in this._mappingsIterator(modes, this._user))
|
||||
if (map.rhs && map.noremap == noremap && !isMultiMode(map, this.name))
|
||||
];
|
||||
}
|
||||
}
|
||||
if (!found)
|
||||
liberator.echoerr("E31: No such mapping");
|
||||
},
|
||||
{
|
||||
argCount: "1",
|
||||
completer: function (context, args) completion.userMapping(context, args, modes)
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////}}}
|
||||
////////////////////// COMMANDS ////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////{{{
|
||||
commands.add([ch ? ch + "m[ap]" : "map"],
|
||||
"Map a key sequence" + modeDescription,
|
||||
function (args) { map(args, modes, false); },
|
||||
opts);
|
||||
|
||||
addMapCommands("", [modes.NORMAL, modes.VISUAL], "");
|
||||
commands.add([ch + "no[remap]"],
|
||||
"Map a key sequence without remapping keys" + modeDescription,
|
||||
function (args) { map(args, modes, true); },
|
||||
opts);
|
||||
|
||||
for (let mode in modes.mainModes)
|
||||
if (mode.char && !commands.get(mode.char + "map"))
|
||||
addMapCommands(mode.char,
|
||||
[m.mask for (m in modes.mainModes) if (m.char == mode.char)],
|
||||
[mode.disp.toLowerCase()]);
|
||||
commands.add([ch + "mapc[lear]"],
|
||||
"Remove all mappings" + modeDescription,
|
||||
function () { modes.forEach(function (mode) { mappings.removeAll(mode); }); },
|
||||
{ argCount: "0" });
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////}}}
|
||||
////////////////////// COMPLETIONS /////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////{{{
|
||||
commands.add([ch + "unm[ap]"],
|
||||
"Remove a mapping" + modeDescription,
|
||||
function (args) {
|
||||
args = args[0];
|
||||
|
||||
liberator.registerObserver("load_completion", function () {
|
||||
let found = false;
|
||||
for (let [, mode] in Iterator(modes)) {
|
||||
if (mappings.hasMap(mode, args)) {
|
||||
mappings.remove(mode, args);
|
||||
found = true;
|
||||
}
|
||||
}
|
||||
if (!found)
|
||||
liberator.echoerr("E31: No such mapping");
|
||||
},
|
||||
{
|
||||
argCount: "1",
|
||||
completer: function (context, args) completion.userMapping(context, args, modes)
|
||||
});
|
||||
}
|
||||
|
||||
addMapCommands("", [modes.NORMAL, modes.VISUAL], "");
|
||||
|
||||
for (let mode in modes.mainModes)
|
||||
if (mode.char && !commands.get(mode.char + "map"))
|
||||
addMapCommands(mode.char,
|
||||
[m.mask for (m in modes.mainModes) if (m.char == mode.char)],
|
||||
[mode.disp.toLowerCase()]);
|
||||
},
|
||||
completion: function () {
|
||||
completion.setFunctionCompleter(mappings.get,
|
||||
[
|
||||
null,
|
||||
function (context, obj, args)
|
||||
{
|
||||
function (context, obj, args) {
|
||||
let mode = args[0];
|
||||
return util.Array.flatten(
|
||||
[
|
||||
[[name, map.description] for ([i, name] in Iterator(map.names))]
|
||||
for ([i, map] in Iterator(user[mode].concat(main[mode])))
|
||||
for ([i, map] in Iterator(this._user[mode].concat(this._main[mode])))
|
||||
]);
|
||||
}
|
||||
]);
|
||||
@@ -327,232 +487,18 @@ function Mappings() //{{{
|
||||
// FIXME: have we decided on a 'standard' way to handle this clash? --djk
|
||||
modes = modes || [modules.modes.NORMAL];
|
||||
|
||||
if (args.completeArg == 0)
|
||||
{
|
||||
if (args.completeArg == 0) {
|
||||
let maps = [[m.names[0], ""] for (m in mappings.getUserIterator(modes))];
|
||||
context.completions = maps;
|
||||
}
|
||||
};
|
||||
});
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////}}}
|
||||
////////////////////// PUBLIC SECTION //////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////{{{
|
||||
|
||||
return {
|
||||
|
||||
// NOTE: just normal mode for now
|
||||
/** @property {Iterator(Map)} @private */
|
||||
__iterator__: function () mappingsIterator([modes.NORMAL], main),
|
||||
|
||||
// used by :mkvimperatorrc to save mappings
|
||||
/**
|
||||
* Returns a user-defined mappings iterator for the specified
|
||||
* <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to return mappings from.
|
||||
* @returns {Iterator(Map)}
|
||||
*/
|
||||
getUserIterator: function (mode) mappingsIterator(mode, user),
|
||||
|
||||
addMode: function (mode)
|
||||
{
|
||||
if (!(mode in user || mode in main))
|
||||
{
|
||||
main[mode] = [];
|
||||
user[mode] = [];
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Adds a new default key mapping.
|
||||
*
|
||||
* @param {number[]} modes The modes that this mapping applies to.
|
||||
* @param {string[]} keys The key sequences which are bound to
|
||||
* <b>action</b>.
|
||||
* @param {string} description A description of the key mapping.
|
||||
* @param {function} action The action invoked by each key sequence.
|
||||
* @param {Object} extra An optional extra configuration hash.
|
||||
* @optional
|
||||
*/
|
||||
add: function (modes, keys, description, action, extra)
|
||||
{
|
||||
addMap(new Map(modes, keys, description, action, extra));
|
||||
},
|
||||
|
||||
/**
|
||||
* Adds a new user-defined key mapping.
|
||||
*
|
||||
* @param {number[]} modes The modes that this mapping applies to.
|
||||
* @param {string[]} keys The key sequences which are bound to
|
||||
* <b>action</b>.
|
||||
* @param {string} description A description of the key mapping.
|
||||
* @param {function} action The action invoked by each key sequence.
|
||||
* @param {Object} extra An optional extra configuration hash (see
|
||||
* {@link Map#extraInfo}).
|
||||
* @optional
|
||||
*/
|
||||
addUserMap: function (modes, keys, description, action, extra)
|
||||
{
|
||||
keys = keys.map(expandLeader);
|
||||
extra = extra || {};
|
||||
extra.user = true;
|
||||
let map = new Map(modes, keys, description || "User defined mapping", action, extra);
|
||||
|
||||
// remove all old mappings to this key sequence
|
||||
for (let [, name] in Iterator(map.names))
|
||||
{
|
||||
for (let [, mode] in Iterator(map.modes))
|
||||
removeMap(mode, name);
|
||||
}
|
||||
|
||||
addMap(map);
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns the map from <b>mode</b> named <b>cmd</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The map name to match.
|
||||
* @returns {Map}
|
||||
*/
|
||||
get: function (mode, cmd)
|
||||
{
|
||||
mode = mode || modes.NORMAL;
|
||||
return getMap(mode, cmd, user) || getMap(mode, cmd, main);
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns the default map from <b>mode</b> named <b>cmd</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The map name to match.
|
||||
* @returns {Map}
|
||||
*/
|
||||
getDefault: function (mode, cmd)
|
||||
{
|
||||
mode = mode || modes.NORMAL;
|
||||
return getMap(mode, cmd, main);
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns an array of maps with names starting with but not equal to
|
||||
* <b>prefix</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} prefix The map prefix string to match.
|
||||
* @returns {Map[]}
|
||||
*/
|
||||
getCandidates: function (mode, prefix)
|
||||
{
|
||||
let mappings = user[mode].concat(main[mode]);
|
||||
let matches = [];
|
||||
|
||||
for (let [, map] in Iterator(mappings))
|
||||
{
|
||||
for (let [, name] in Iterator(map.names))
|
||||
{
|
||||
if (name.indexOf(prefix) == 0 && name.length > prefix.length)
|
||||
{
|
||||
// for < only return a candidate if it doesn't look like a <c-x> mapping
|
||||
if (prefix != "<" || !/^<.+>/.test(name))
|
||||
matches.push(map);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return matches;
|
||||
},
|
||||
|
||||
/*
|
||||
* Returns the map leader string used to replace the special token
|
||||
* "<Leader>" when user mappings are defined.
|
||||
*
|
||||
* @returns {string}
|
||||
*/
|
||||
// FIXME: property
|
||||
getMapLeader: function ()
|
||||
{
|
||||
let leaderRef = liberator.variableReference("mapleader");
|
||||
return leaderRef[0] ? leaderRef[0][leaderRef[1]] : "\\";
|
||||
},
|
||||
|
||||
/**
|
||||
* Returns whether there is a user-defined mapping <b>cmd</b> for the
|
||||
* specified <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The candidate key mapping.
|
||||
* @returns {boolean}
|
||||
*/
|
||||
hasMap: function (mode, cmd) user[mode].some(function (map) map.hasName(cmd)),
|
||||
|
||||
/**
|
||||
* Remove the user-defined mapping named <b>cmd</b> for <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to search.
|
||||
* @param {string} cmd The map name to match.
|
||||
*/
|
||||
remove: function (mode, cmd)
|
||||
{
|
||||
removeMap(mode, cmd);
|
||||
},
|
||||
|
||||
/**
|
||||
* Remove all user-defined mappings for <b>mode</b>.
|
||||
*
|
||||
* @param {number} mode The mode to remove all mappings from.
|
||||
*/
|
||||
removeAll: function (mode)
|
||||
{
|
||||
user[mode] = [];
|
||||
},
|
||||
|
||||
/**
|
||||
* Lists all user-defined mappings matching <b>filter</b> for the
|
||||
* specified <b>modes</b>.
|
||||
*
|
||||
* @param {number[]} modes An array of modes to search.
|
||||
* @param {string} filter The filter string to match.
|
||||
*/
|
||||
list: function (modes, filter)
|
||||
{
|
||||
let modeSign = "";
|
||||
|
||||
// TODO: Vim hides "nv" in a :map and "v" and "n" in :vmap and
|
||||
// :nmap respectively if the map is not exclusive.
|
||||
modes.forEach(function (mode) {
|
||||
for (let m in modules.modes.mainModes)
|
||||
if (mode == m.mask && modeSign.indexOf(m.char) == -1)
|
||||
modeSign += m.char;
|
||||
});
|
||||
|
||||
let maps = mappingsIterator(modes, user);
|
||||
if (filter)
|
||||
maps = [map for (map in maps) if (map.names[0] == filter)];
|
||||
|
||||
let list = <table>
|
||||
{
|
||||
template.map(maps, function (map)
|
||||
template.map(map.names, function (name)
|
||||
<tr>
|
||||
<td>{modeSign} {name}</td>
|
||||
<td>{map.noremap ? "*" : " "}</td>
|
||||
<td>{map.rhs || "function () { ... }"}</td>
|
||||
</tr>))
|
||||
}
|
||||
</table>;
|
||||
|
||||
// TODO: Move this to an ItemList to show this automatically
|
||||
if (list.*.length() == list.text().length())
|
||||
{
|
||||
liberator.echomsg("No mapping found");
|
||||
return;
|
||||
}
|
||||
commandline.echo(list, commandline.HL_NORMAL, commandline.FORCE_MULTILINE);
|
||||
},
|
||||
modes: function () {
|
||||
for (let mode in modes) {
|
||||
this._main[mode] = [];
|
||||
this._user[mode] = [];
|
||||
}
|
||||
};
|
||||
//}}}
|
||||
} //}}}
|
||||
},
|
||||
});
|
||||
|
||||
// vim: set fdm=marker sw=4 ts=4 et:
|
||||
|
||||
Reference in New Issue
Block a user