// TODO: document
function Map(mode, cmds, act, extra_info) //{{{
{
if (!mode || (!cmds || !cmds.length) || !act)
return null;
this.mode = mode;
this.commands = cmds;
this.action = act;
if (extra_info)
{
var flags = extra_info.flags || 0;
if (extra_info.usage)
this.usage = extra_info.usage;
else
{
this.usage = "";
if (flags & Mappings.flags.COUNT)
this.usage = "{count}";
this.usage += this.commands[0]; // only the first command name
if (flags & Mappings.flags.ARGUMENT)
this.usage += " {arg}";
}
if (extra_info.help)
this.help = extra_info.help;
else
this.help = null;
if (extra_info.short_help)
this.short_help = extra_info.short_help;
else
this.short_help = null;
}
}
// Since we will add many Map-objects, we add some functions as prototypes
// this will ensure we only have one copy of each function, not one for each object
Map.prototype.execute = function(count)
{
this.action.call(this, count);
}
Map.prototype.toString = function()
{
// FIXME: -- djk
return "Map {" +
"\nmode: " + this.mode +
"\ncommands: " + this.commands +
"\naction: " + this.action +
"\nusage: " + this.usage +
"\nshort_help: " + this.short_help +
"\nhelp: " + this.help +
"\n}"
} //}}}
function Mappings()//{{{
{
////////////////////////////////////////////////////////////////////////////////
////////////////////// PRIVATE SECTION /////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////{{{
var main = []; // array of default Map() objects
var user = []; // array of objects created by :map
function addDefaultMap(map)
{
if (!map)
return false;
if (!main[map.mode])
main[map.mode] = [];
main[map.mode].push(map);
return true;
}
function getFrom(mode, cmd, stack)
{
if (!stack || !stack[mode] || !stack[mode].length)
return;
var substack = stack[mode];
var stack_length = substack.length;
for (var i = 0; i < stack_length; i++)
{
for (var j = 0; j < substack[i].commands.length; j++)
if (substack[i].commands[j] == cmd)
return substack[i];
}
}
function mappingsIterator(mode)
{
var mappings;
// FIXME: initialize empty map tables -- djk
if (user[mode])
mappings = user[mode].concat(main[mode])
else
mappings = main[mode]
for (var i = 0; i < mappings.length; i++)
yield mappings[i];
throw StopIteration;
}
/////////////////////////////////////////////////////////////////////////////}}}
////////////////////// PUBLIC SECTION //////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////{{{
// TODO: change to Mappings.MOTION etc? -- djk
Mappings.flags = {
MOTION: 1 << 0,
COUNT: 1 << 1,
ARGUMENT: 1 << 2
};
// NOTE: just the main/default map for now -- djk
this.__iterator__ = function()
{
return mappingsIterator(vimperator.modes.NORMAL);
}
// TODO: remove duplication in addDefaultMap -- djk
this.add = function(map)
{
if (!map)
return false;
if (!user[map.mode])
user[map.mode] = [];
user[map.mode].push(map);
return true;
}
this.remove = function(map)
{
var index;
if (!map || !(index = user[map.mode].indexOf(map)))
return false;
user[map.mode].splice(index, 1);
return true;
}
this.get = function(mode, cmd)
{
if (!mode || !cmd)
return null;
var map = getFrom(mode, cmd, user);
if (!map)
map = getFrom(mode, cmd, main);
return map;
}
// same as this.get() but always returns an array of commands which start with "cmd"
this.getCandidates = function(mode, cmd)
{
var matching = [];
if (!mode || !cmd)
return matching;
// fill matching array with maps which have commands starting with cmd
for (var i = 0; i < main[mode].length; i++) // FIXME: just the main/default map space for now -- djk
{
var map = main[mode][i];
for (var j = 0; j < map.commands.length; j++)
{
if (map.commands[j].indexOf(cmd) == 0)
matching.push(map)
}
}
return matching;
}
/////////////////////////////////////////////////////////////////////////////}}}
////////////////////// DEFAULT MAPPINGS ////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////{{{
/*
* Normal mode
*/
addDefaultMap(new Map(vimperator.modes.NORMAL, ["]f"], focusNextFrame,
{
short_help: "Focus next frame",
help: "Flashes the next frame in order with a red color, to quickly show where keyboard focus is.
" +
"This may not work correctly for frames with lots of CSS code."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["b"], function (args) { vimperator.commandline.open(":", "buffer ", vimperator.modes.EX); },
{
short_help: "Open a prompt to switch buffers",
help: "Typing the corresponding number opens switches to this buffer."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["B"], toggleBufferList,
{
short_help: "Toggle buffer list",
help: "Toggles the display of the buffer list which shows all opened tabs."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["d"], function(count) { vimperator.tabs.remove(getBrowser().mCurrentTab, count, false, 0); },
{
short_help: "Delete current buffer (=tab)",
help: "Count WILL be supported in future releases, then 2d removes two tabs and the one the right is selected.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["D"], function(count) { vimperator.tabs.remove(getBrowser().mCurrentTab, count, true, 0); },
{
short_help: "Delete current buffer (=tab)",
help: "Count WILL be supported in future releases, then 2d removes two tabs and the one the right is selected.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gh"], BrowserHome,
{
short_help: "Go home",
help: "Opens the homepage in the current tab."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gH"], BrowserHome,
{
short_help: "Go home in a new tab",
help: "Opens the homepage in a new tab."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gP"], function(count) { openURLsInNewTab(readFromClipboard(), false); },
{
short_help: "Open (put) an URL based on the current clipboard contents in a new buffer",
help: "Works like P, but inverts the 'activate' setting."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gt", "", ""], function(count) { vimperator.tabs.select(count > 0 ? count -1: "+1", count > 0 ? false : true); },
{
short_help: "Go to the next tab",
help: "Cycles to the first tab, when the last is selected.
Count is supported, 3gt goes to the third tab.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gT", "", ""], function(count) { vimperator.tabs.select(count > 0 ? count -1: "-1", count > 0 ? false : true); },
{
short_help: "Go to the previous tab",
help: "Cycles to the last tab, when the first is selected.
Count is supported, 3gT goes to the third tab.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["m"], set_location_mark,
{
short_help: "Set mark at the cursor position",
usage: "m{a-zA-Z}",
help: "Marks a-z are local to the buffer, whereas A-Z are valid between buffers.",
flags: Mappings.flags.ARGUMENT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["o"], function(count) { vimperator.commandline.open(":", "open ", vimperator.modes.EX); },
{
short_help: "Open one or more URLs in the current tab",
help: "See :open for more details."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["O"], function(count) { vimperator.commandline.open(":", "open " + getCurrentLocation(), vimperator.modes.EX); },
{
short_help: "Open one or more URLs in the current tab, based on current location",
help: "Works like o, but preselects current URL in the :open query."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["p", ""], function(count) { openURLs(readFromClipboard()); },
{
short_help: "Open (put) an URL based on the current clipboard contents in the current buffer",
help: "You can also just select some non-URL text, and search for it with the default search engine or keyword (specified by the 'defsearch' setting) with p."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["P"], function(count) { openURLsInNewTab(readFromClipboard(), true); },
{
short_help: "Open (put) an URL based on the current clipboard contents in a new buffer",
help: "Works like p, but opens a new tab.
" +
"Whether the new buffer is activated, depends on the 'activate' setting."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["r"], function(count) { reload(getBrowser().mCurrentTab, false); },
{
short_help: "Reload",
help: "Forces reloading of the current page."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["R"], function(count) { reload(getBrowser().mCurrentTab, true); },
{
short_help: "Reload while skipping the cache",
help: "Forces reloading of the current page skipping the cache."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["t"], function(count) { vimperator.commandline.open(":", "tabopen ", vimperator.modes.EX); },
{
short_help: "Open one or more URLs in a new tab",
help: "Like o but open URLs in a new tab.
" +
"See :tabopen for more details."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["T"], function(count) { vimperator.commandline.open(":", "tabopen " + getCurrentLocation(), vimperator.modes.EX); },
{
short_help: "Open one ore more URLs in a new tab, based on current location",
help: "Works like t, but preselects current URL in the :tabopen query."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["u"], function(count) { execute_command(count, 'undo', false, ''); },
{
short_help: "Undo closing of a tab",
help: "If a count is given, don't close the last but the n'th last tab.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["y"], yankCurrentLocation,
{
short_help: "Yank current location to the clipboard",
help: "Under UNIX the location is also put into the selection, which can be pasted with the middle mouse button."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["Y"], yankCurrentSelection,
{
short_help: "Copy selected text",
help: "The currently selected text is copied to the system clipboard."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["zi", "+"], function(count) { zoom_in(1); },
{
short_help: "Zoom in current web page by 25%",
help: "Currently no count supported."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["zI"], function(count) { zoom_in(4); },
{
short_help: "Zoom in current web page by 100%",
help: "Currently no count supported."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["zo", "-"], function(count) { zoom_in(-1); },
{
short_help: "Zoom out current web page by 25%",
help: "Currently no count supported."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["zO"], function(count) { zoom_in(-4); },
{
short_help: "Zoom out current web page by 100%",
help: "Currently no count supported."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["zz"], zoom_to,
{
short_help: "Set zoom value of the webpage",
help: "Zoom value can be between 25 and 500%. If it is omitted, zoom is reset to 100%.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["ZQ"], function(count) { quit(false); },
{
short_help: "Quit and don't save the session",
help: "Works like :qall."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["ZZ"], function(count) { quit(true); },
{
short_help: "Quit and save the session",
help: "Quit Vimperator, no matter how many tabs/windows are open. The session is stored.
" +
"Works like :xall."
}
));
/* scrolling commands */
addDefaultMap(new Map(vimperator.modes.NORMAL, ["0", "^"], function(count) { scrollBufferAbsolute(0, -1); },
{
short_help: "Scroll to the absolute left of the document",
help: "Unlike in vim, 0 and ^ work exactly the same way."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["$"], function(count) { scrollBufferAbsolute(100, -1); },
{
short_help: "Scroll to the absolute right of the document",
help: null
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gg", ""], function(count) { scrollBufferAbsolute(-1, count > 0 ? count : 0); },
{
short_help: "Goto the top of the document",
help: "Count is supported, 35gg vertically goes to 35% of the document.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["G", ""], function(count) { scrollBufferAbsolute(-1, count >= 0 ? count : 100); },
{
short_help: "Goto the end of the document",
help: "Count is supported, 35G vertically goes to 35% of the document.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["h", ""], function(count) { scrollBufferRelative(-1, 0); },
{
short_help: "Scroll document to the left",
help: "Count is supported: 10h will move 10 times as much to the left.
" +
"If the document cannot scroll more, a beep is emmited (unless 'beep' is turned off).",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["j", "", ""], function(count) { scrollBufferRelative(0, 1); },
{
short_help: "Scroll document down",
help: "Count is supported: 10j will move 10 times as much down.
" +
"If the document cannot scroll more, a beep is emmited (unless 'beep' is turned off).",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["k", "", ""], function(count) { scrollBufferRelative(0, -1); },
{
short_help: "Scroll document up",
help: "Count is supported: 10k will move 10 times as much up.
" +
"If the document cannot scroll more, a beep is emmited (unless 'beep' is turned off).",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["l", ""], function(count) { scrollBufferRelative(1, 0); },
{
short_help: "Scroll document to the right",
help: "Count is supported: 10l will move 10 times as much to the right.
" +
"If the document cannot scroll more, a beep is emmited (unless 'beep' is turned off).",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["", "", "", ""], function(count) { goDoCommand('cmd_scrollPageUp'); },
{
short_help: "Scroll up a full page of the current document",
help: "No count support for now."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["", "", "", ""], function(count) { goDoCommand('cmd_scrollPageDown'); },
{
short_help: "Scroll down a full page of the current document",
help: "No count support for now."
}
));
/* history manipulation and jumplist */
addDefaultMap(new Map(vimperator.modes.NORMAL, [""], function(count) { stepInHistory(count > 0 ? -1 * count : -1); },
{
short_help: "Go to an older position in the jump list",
help: "The jump list is just the browser history for now.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, [""], function(count) { stepInHistory(count > 0 ? count : 1); },
{
short_help: "Go to a newer position in the jump list",
help: "The jump list is just the browser history for now.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["H", "", ""], function(count) { stepInHistory(count > 0 ? -1 * count : -1); },
{
short_help: "Go back in the browser history",
help: "Count is supported, 3H goes back 3 steps.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["L", "", ""], function(count) { stepInHistory(count > 0 ? count : 1); },
{
short_help: "Go forward in the browser history",
help: "Count is supported, 3L goes forward 3 steps.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gu", ""], goUp,
{
short_help: "Go to parent directory",
help: "Count is supported, 2gu on http://www.example.com/dir1/dir2/file.htm would open http://www.example.com/dir1/.",
flags: Mappings.flags.COUNT
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["gU", ""], function(count) { openURLs("..."); },
{
short_help: "Go to the root of the website",
help: "gU on http://www.example.com/dir1/dir2/file.htm opens http://www.example.com/.
" +
"When browsing a local directory, it goes to the root document."
}
));
/* hint managment */
addDefaultMap(new Map(vimperator.modes.NORMAL, ["f"], function(count) { hah.enableHahMode(vimperator.modes.QUICK_HINT); },
{
short_help: "Start QuickHint mode",
help: "In QuickHint mode, every hintable item (according to the 'hinttags' XPath query) is assigned a label.
" +
"If you then press the keys for a label, it is followed as soon as it can be uniquely identified and this mode is stopped. Or press <Esc> to stop this mode.
" +
"If you write the hint in ALLCAPS, the hint is followed in a background tab."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["F"], function(count) { hah.enableHahMode(vimperator.modes.ALWAYS_HINT); },
{
short_help: "Start AlwaysHint mode",
help: "In AlwaysHint mode, every hintable item (according to the 'hinttags' XPath query) is assigned a label.
" +
"If you then press the keys for a label, it is followed as soon as it can be uniquely identified. Labels stay active after following a hint in this mode, press <Esc> to stop this mode.
" +
"This hint mode is especially useful for browsing large sites like Forums as hints are automatically regenerated when switching to a new document.
" +
"Also, most Ctrl-prefixed short_helpcut keys are available in this mode for navigation."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, [";"], function(count) { hah.enableHahMode(vimperator.modes.EXTENDED_HINT); },
{
short_help: "Start ExtendedHint mode",
help: "ExtendedHint mode is useful, since in this mode you can yank link locations, or open them in a new window.
" +
"E.g., if you want to yank the location of hint AB, press ; to start this hint mode.
" +
"Then press AB to select the hint. Now press y to yank its location.
" +
"Actions for selected hints in ExtendedHint mode are:
" +
"y to yank its location " +
" Y to yank its text description " +
" o to open its location in the current tab " +
" t to open its location in a new tab " +
" O to open its location in an :open query (not implemented yet) " +
" T to open its location in an :tabopen query (not implemented yet) " +
" s to save its destination (not implemented yet) " +
" <C-w> to open its destination in a new window " +
"
" +
"Multiple hints can be seperated by commas where it makes sense. ;ab,ac,adt opens AB, AC and AD in a new tab.
" +
"Hintable elements for this mode can be set in the 'extendedhinttags' XPath string."
}
));
/* search managment */
addDefaultMap(new Map(vimperator.modes.NORMAL, ["g/"], function(count) { vimperator.search.openSearchDialog(); },
{
short_help: "Search forward for a pattern",
help: ""
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["n"], function(count) { vimperator.search.findNext(); },
{
short_help: "Find next",
help: "Repeat the last \"/\" 1 time (until count is supported)."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["N"], function(count) { vimperator.search.findPrevious(); },
{
short_help: "Find previous",
help: "Repeat the last \"/\" 1 time (until count is supported) in the opposite direction."
}
));
/* vimperator managment */
addDefaultMap(new Map(vimperator.modes.NORMAL, [""], function(count) { help(null); },
{
short_help: "Open help window",
help: "The default section is shown, if you need help for a specific topic, try :help <F1> (jumping to a specific section not implemented yet)."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, [":"], function(count) { vimperator.commandline.open(":", "", vimperator.modes.EX); },
{
short_help: "Start command line mode",
help: "In command line mode, you can perform extended commands, which may require arguments."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, ["I"], function(count) { vimperator.addMode(null, vimperator.modes.ESCAPE_ALL_KEYS);},
{
short_help: "Disable vimperator keys",
help: "Starts an 'ignorekeys' mode, where all keys except <Esc> are passed to the next event handler.
" +
"This is especially useful, if JavaScript controlled forms like the RichEdit form fields of GMail don't work anymore.
" +
"To exit this mode, press <Esc>. If you also need to pass <Esc>" +
"in this mode to the webpage, prepend it with <C-v>."
}
));
// if you ever add/remove keys here, also check them in the onVimperatorKeypress() function
addDefaultMap(new Map(vimperator.modes.NORMAL, [""], function(count) { vimperator.addMode(null, vimperator.modes.ESCAPE_ONE_KEY); },
{
short_help: "Escape next key",
help: "If you need to pass a certain key to a javascript form field or another extension prefix the key with <C-v>.
" +
"Also works to unshadow Firefox short_helpcuts like <C-o> which are otherwise hidden in Vimperator.
" +
"When in 'ignorekeys' mode (activated by <I>), <C-v> will pass the next key to Vimperator instead of the webpage."
}
));
addDefaultMap(new Map(vimperator.modes.NORMAL, [""], BrowserStop,
{
short_help: "Stop loading",
help: "Stops loading the current webpage."
}
));
// if you ever add/remove keys here, also check them in the onVimperatorKeypress()
addDefaultMap(new Map(vimperator.modes.NORMAL, ["", ""], onEscape,
{
short_help: "Cancel any operation",
help: "Exits any command line or hint mode and returns to browser mode.
" +
"Also focuses the web page, in case a form field has focus and eats our key presses."
}
));
//}}}
var hint_maps = [
/* hint action keys */
["o", "hah.openHints(false, false);", true, false],
["t", "hah.openHints(true, false);", true, false],
["", "hah.openHints(false, true );", true, false],
["s", "vimperator.echoerr('Saving of links not yet implemented');", true, false],
["y", "hah.yankUrlHints();", true, false],
["Y", "hah.yankTextHints();", true, false],
[",", "g_inputbuffer+=','; hah.setCurrentState(0);", false, true],
[":", "vimperator.commandline.open(':', '', vimperator.modes.EX);", false, true],
/* movement keys */
["", "scrollBufferRelative(0, 1);", false, true],
["", "scrollBufferRelative(0, -1);", false, true],
["", "scrollBufferAbsolute(-1, 0);", false, true],
["", "scrollBufferAbsolute(-1, 100);", false, true],
["", "goDoCommand('cmd_scrollPageUp');", false, true],
["", "goDoCommand('cmd_scrollPageUp');", false, true],
["", "goDoCommand('cmd_scrollPageDown');", false, true],
["", "goDoCommand('cmd_scrollPageDown');", false, true],
["", "scrollBufferRelative(-1, 0);", false, true],
["", "scrollBufferRelative(0, 1);", false, true],
["", "scrollBufferRelative(0, -1);", false, true],
["", "scrollBufferRelative(1, 0);", false, true],
/* tab managment */
["", "vimperator.tabs.select('+1', true)", true, true], // same as gt, but no count supported
["", "vimperator.tabs.select('-1', true)", true, true],
/* navigation */
["", "stepInHistory(g_count > 0 ? -1 * g_count : -1);", false, true],
["", "stepInHistory(g_count > 0 ? g_count : 1);", false, true],
["", "stepInHistory(g_count > 0 ? -1 * g_count : -1);", false, true],
["", "stepInHistory(g_count > 0 ? g_count : 1);", false, true],
["", "vimperator.tabs.remove(getBrowser().mCurrentTab, g_count, false, 0);", true, true],
/* cancel hint mode keys */
["", "", true, true],
["", "", true, true],
["", "", true, true],
["", "", true, true]
];
}//}}}
// vim: set fdm=marker sw=4 ts=4 et: