1 utils = require 'utils'
7 , isPrefSet } = require 'prefs'
9 { classes: Cc, interfaces: Ci, utils: Cu } = Components
11 # “Selecting an element” means “focusing and selecting the text, if any, of an
14 # Select the Address Bar.
15 command_focus = (vim) ->
16 # This function works even if the Address Bar has been removed.
17 vim.rootWindow.focusAndSelectUrlBar()
19 # Select the Search Bar.
20 command_focus_search = (vim) ->
21 # The `.webSearch()` method opens a search engine in a tab if the Search Bar
22 # has been removed. Therefore we first check if it exists.
23 if vim.rootWindow.BrowserSearch.searchBar
24 vim.rootWindow.BrowserSearch.webSearch()
26 helper_paste = (vim) ->
27 url = utils.readFromClipboard(vim.window)
29 if not utils.isURL(url) and submission = utils.browserSearchSubmission(url)
30 url = submission.uri.spec
31 { postData } = submission
32 return {url, postData}
34 # Go to or search for the contents of the system clipboard.
35 command_paste = (vim) ->
36 { url, postData } = helper_paste(vim)
37 vim.rootWindow.gBrowser.loadURIWithFlags(url, null, null, null, postData)
39 # Go to or search for the contents of the system clipboard in a new tab.
40 command_paste_tab = (vim) ->
41 { url, postData } = helper_paste(vim)
42 vim.rootWindow.gBrowser.selectedTab =
43 vim.rootWindow.gBrowser.addTab(url, null, null, postData, null, false)
45 # Copy the URL or text of a marker element to the system clipboard.
46 command_marker_yank = (vim) ->
47 callback = (marker) ->
48 if url = marker.element.href
49 marker.element.focus()
50 utils.writeToClipboard(url)
51 else if utils.isTextInputElement(marker.element)
52 utils.writeToClipboard(marker.element.value)
54 vim.enterMode('hints', callback)
57 command_marker_focus = (vim) ->
58 callback = (marker) -> marker.element.focus()
60 vim.enterMode('hints', callback)
62 # Copy the current URL to the system clipboard.
63 command_yank = (vim) ->
64 utils.writeToClipboard(vim.window.location.href)
66 # Reload the current tab, possibly from cache.
67 command_reload = (vim) ->
68 vim.rootWindow.BrowserReload()
70 # Reload the current tab, skipping cache.
71 command_reload_force = (vim) ->
72 vim.rootWindow.BrowserReloadSkipCache()
74 # Reload all tabs, possibly from cache.
75 command_reload_all = (vim) ->
76 vim.rootWindow.gBrowser.reloadAllTabs()
78 # Reload all tabs, skipping cache.
79 command_reload_all_force = (vim) ->
80 for tab in vim.rootWindow.gBrowser.visibleTabs
81 window = tab.linkedBrowser.contentWindow
82 window.location.reload(true)
84 # Stop loading the current tab.
85 command_stop = (vim) ->
88 # Stop loading all tabs.
89 command_stop_all = (vim) ->
90 for tab in vim.rootWindow.gBrowser.visibleTabs
91 window = tab.linkedBrowser.contentWindow
94 # Scroll to the top of the page.
95 command_scroll_to_top = (vim) ->
96 vim.rootWindow.goDoCommand('cmd_scrollTop')
98 # Scroll to the bottom of the page.
99 command_scroll_to_bottom = (vim) ->
100 vim.rootWindow.goDoCommand('cmd_scrollBottom')
103 command_scroll_down = (vim) ->
104 step = getPref('scroll_step_lines')
105 utils.simulateWheel(vim.window, 0, +step, utils.WHEEL_MODE_LINE)
108 command_scroll_up = (vim) ->
109 step = getPref('scroll_step_lines')
110 utils.simulateWheel(vim.window, 0, -step, utils.WHEEL_MODE_LINE)
113 command_scroll_left = (vim) ->
114 step = getPref('scroll_step_lines')
115 utils.simulateWheel(vim.window, -step, 0, utils.WHEEL_MODE_LINE)
117 # Scroll right a bit.
118 command_scroll_right = (vim) ->
119 step = getPref('scroll_step_lines')
120 utils.simulateWheel(vim.window, +step, 0, utils.WHEEL_MODE_LINE)
122 # Scroll down half a page.
123 command_scroll_half_page_down = (vim) ->
124 utils.simulateWheel(vim.window, 0, +0.5, utils.WHEEL_MODE_PAGE)
126 # Scroll up half a page.
127 command_scroll_half_page_up = (vim) ->
128 utils.simulateWheel(vim.window, 0, -0.5, utils.WHEEL_MODE_PAGE)
130 # Scroll down full a page.
131 command_scroll_page_down = (vim) ->
132 utils.simulateWheel(vim.window, 0, +1, utils.WHEEL_MODE_PAGE)
134 # Scroll up full a page.
135 command_scroll_page_up = (vim) ->
136 utils.simulateWheel(vim.window, 0, -1, utils.WHEEL_MODE_PAGE)
138 # Open a new tab and select the Address Bar.
139 command_open_tab = (vim) ->
140 vim.rootWindow.BrowserOpenTab()
142 # Switch to the previous tab.
143 command_tab_prev = (vim) ->
145 vim.rootWindow.gBrowser.tabContainer.advanceSelectedTab(-1, true) # wrap
147 # Switch to the next tab.
148 command_tab_next = (vim) ->
150 vim.rootWindow.gBrowser.tabContainer.advanceSelectedTab(+1, true) # wrap
152 # Move the current tab backward.
153 command_tab_move_left = (vim) ->
154 { gBrowser } = vim.rootWindow
155 lastIndex = gBrowser.tabContainer.selectedIndex
156 gBrowser.moveTabBackward()
157 if gBrowser.tabContainer.selectedIndex == lastIndex
158 gBrowser.moveTabToEnd()
160 # Move the current tab forward.
161 command_tab_move_right = (vim) ->
162 { gBrowser } = vim.rootWindow
163 lastIndex = gBrowser.tabContainer.selectedIndex
164 gBrowser.moveTabForward()
165 if gBrowser.tabContainer.selectedIndex == lastIndex
166 gBrowser.moveTabToStart()
168 # Load the home page.
169 command_home = (vim) ->
170 vim.rootWindow.BrowserHome()
172 # Switch to the first tab.
173 command_tab_first = (vim) ->
174 vim.rootWindow.gBrowser.selectTabAtIndex(0)
176 # Switch to the last tab.
177 command_tab_last = (vim) ->
178 vim.rootWindow.gBrowser.selectTabAtIndex(-1)
181 command_close_tab = (vim) ->
182 unless vim.rootWindow.gBrowser.selectedTab.pinned
183 vim.rootWindow.gBrowser.removeCurrentTab()
185 # Restore last closed tab.
186 command_restore_tab = (vim) ->
187 vim.rootWindow.undoCloseTab()
189 helper_follow = ({ inTab, multiple }, vim) ->
190 callback = (matchedMarker, markers) ->
191 if matchedMarker.element.target == '_blank'
192 targetReset = matchedMarker.element.target
193 matchedMarker.element.target = ''
195 matchedMarker.element.focus()
196 utils.simulateClick(matchedMarker.element, {metaKey: inTab, ctrlKey: inTab})
198 matchedMarker.element.target = targetReset if targetReset
200 isEditable = utils.isElementEditable(matchedMarker.element)
201 if multiple and not isEditable
202 # By not resetting immediately one is able to see the last char being
203 # matched, which gives some nice visual feedback that you've typed the
205 vim.window.setTimeout((-> marker.reset() for marker in markers), 100)
208 vim.enterMode('hints', callback)
210 # Follow links with hint markers.
211 command_follow = helper_follow.bind(undefined, {inTab: false})
213 # Follow links in a new Tab with hint markers.
214 command_follow_in_tab = helper_follow.bind(undefined, {inTab: true})
216 # Follow multiple links with hint markers.
217 command_follow_multiple = helper_follow.bind(undefined, {inTab: true, multiple: true})
219 helper_follow_pattern = do ->
220 # Search for the prev/next patterns in the following attributes of the
221 # element. `rel` should be kept as the first attribute, since the standard
222 # way of marking up prev/next links (`rel="prev"` and `rel="next"`) should be
223 # favored. Even though some of these attributes only allow a fixed set of
224 # keywords, we pattern-match them anyways since lots of sites don’t follow
225 # the spec and use the attributes arbitrarily.
226 attrs = ['rel', 'role', 'data-tooltip', 'aria-label']
228 return (type, vim) ->
229 links = utils.getMarkableElements(vim.window.document, {type: 'action'})
230 .filter(utils.isElementVisible)
232 patterns = utils.splitListString(getComplexPref("#{ type }_patterns"))
234 if matchingLink = utils.getBestPatternMatch(patterns, attrs, links)
235 utils.simulateClick(matchingLink, {metaKey: false, ctrlKey: false})
237 # Follow previous page.
238 command_follow_prev = helper_follow_pattern.bind(undefined, 'prev')
241 command_follow_next = helper_follow_pattern.bind(undefined, 'next')
243 # Go up one level in the URL hierarchy.
244 command_go_up_path = (vim) ->
245 path = vim.window.location.pathname
246 vim.window.location.pathname = path.replace(/// / [^/]+ /?$ ///, '')
248 # Go up to root of the URL hierarchy.
249 command_go_to_root = (vim) ->
250 vim.window.location.href = vim.window.location.origin
252 # Go back in history.
253 command_back = (vim) ->
254 vim.rootWindow.BrowserBack()
256 # Go forward in history.
257 command_forward = (vim) ->
258 vim.rootWindow.BrowserForward()
260 findStorage = {lastSearchString: ''}
262 helper_find = (highlight, vim) ->
263 findBar = vim.rootWindow.gBrowser.getFindBar()
265 findBar.onFindCommand()
266 findBar._findField.focus()
267 findBar._findField.select()
269 return unless highlightButton = findBar.getElement('highlight')
270 if highlightButton.checked != highlight
271 highlightButton.click()
273 # Open the find bar, making sure that hightlighting is off.
274 command_find = helper_find.bind(undefined, false)
276 # Open the find bar, making sure that hightlighting is on.
277 command_find_hl = helper_find.bind(undefined, true)
279 helper_find_again = (direction, vim) ->
280 findBar = vim.rootWindow.gBrowser.getFindBar()
281 if findStorage.lastSearchString.length > 0
282 findBar._findField.value = findStorage.lastSearchString
283 findBar.onFindAgainCommand(direction)
285 # Search for the last pattern.
286 command_find_next = helper_find_again.bind(undefined, false)
288 # Search for the last pattern backwards.
289 command_find_prev = helper_find_again.bind(undefined, true)
292 command_insert_mode = (vim) ->
293 vim.enterMode('insert')
295 # Display the Help Dialog.
296 command_help = (vim) ->
297 help.injectHelp(vim.window.document, commands)
299 # Open and select the Developer Toolbar.
300 command_dev = (vim) ->
301 vim.rootWindow.DeveloperToolbar.show(true) # focus
303 command_Esc = (vim, event) ->
304 utils.blurActiveElement(vim.window)
306 # Blur active XUL control.
307 callback = -> event.originalTarget?.ownerDocument?.activeElement?.blur()
308 vim.window.setTimeout(callback, 0)
310 help.removeHelp(vim.window.document)
312 vim.rootWindow.DeveloperToolbar.hide()
314 vim.rootWindow.gBrowser.getFindBar().close()
316 vim.rootWindow.TabView.hide()
320 constructor: (@group, @name, @func, keys) ->
322 if isPrefSet(@prefName('keys'))
323 try @keyValues = JSON.parse(getPref(@prefName('keys')))
327 # Name of the preference for a given property.
328 prefName: (value) -> "commands.#{ @name }.#{ value }"
331 if value is undefined
334 @keyValues = value or @defaultKeyValues
335 setPref(@prefName('keys'), value and JSON.stringify(value))
337 help: -> _("help_command_#{ @name }")
340 new Command('urls', 'focus', command_focus, ['o'])
341 new Command('urls', 'focus_search', command_focus_search, ['O'])
342 new Command('urls', 'paste', command_paste, ['p'])
343 new Command('urls', 'paste_tab', command_paste_tab, ['P'])
344 new Command('urls', 'marker_yank', command_marker_yank, ['y,f'])
345 new Command('urls', 'marker_focus', command_marker_focus, ['v,f'])
346 new Command('urls', 'yank', command_yank, ['y,y'])
347 new Command('urls', 'reload', command_reload, ['r'])
348 new Command('urls', 'reload_force', command_reload_force, ['R'])
349 new Command('urls', 'reload_all', command_reload_all, ['a,r'])
350 new Command('urls', 'reload_all_force', command_reload_all_force, ['a,R'])
351 new Command('urls', 'stop', command_stop, ['s'])
352 new Command('urls', 'stop_all', command_stop_all, ['a,s'])
354 new Command('nav', 'scroll_to_top', command_scroll_to_top , ['g,g'])
355 new Command('nav', 'scroll_to_bottom', command_scroll_to_bottom, ['G'])
356 new Command('nav', 'scroll_down', command_scroll_down, ['j', 'c-e'])
357 new Command('nav', 'scroll_up', command_scroll_up, ['k', 'c-y'])
358 new Command('nav', 'scroll_left', command_scroll_left, ['h'])
359 new Command('nav', 'scroll_right', command_scroll_right , ['l'])
360 new Command('nav', 'scroll_half_page_down', command_scroll_half_page_down, ['d'])
361 new Command('nav', 'scroll_half_page_up', command_scroll_half_page_up, ['u'])
362 new Command('nav', 'scroll_page_down', command_scroll_page_down, ['c-f'])
363 new Command('nav', 'scroll_page_up', command_scroll_page_up, ['c-b'])
365 new Command('tabs', 'open_tab', command_open_tab, ['t'])
366 new Command('tabs', 'tab_prev', command_tab_prev, ['J', 'g,T'])
367 new Command('tabs', 'tab_next', command_tab_next, ['K', 'g,t'])
368 new Command('tabs', 'tab_move_left', command_tab_move_left, ['c-J'])
369 new Command('tabs', 'tab_move_right', command_tab_move_right, ['c-K'])
370 new Command('tabs', 'home', command_home, ['g,h'])
371 new Command('tabs', 'tab_first', command_tab_first, ['g,H', 'g,^'])
372 new Command('tabs', 'tab_last', command_tab_last, ['g,L', 'g,$'])
373 new Command('tabs', 'close_tab', command_close_tab, ['x'])
374 new Command('tabs', 'restore_tab', command_restore_tab, ['X'])
376 new Command('browse', 'follow', command_follow, ['f'])
377 new Command('browse', 'follow_in_tab', command_follow_in_tab, ['F'])
378 new Command('browse', 'follow_multiple', command_follow_multiple, ['a,f'])
379 new Command('browse', 'follow_previous', command_follow_prev, ['['])
380 new Command('browse', 'follow_next', command_follow_next, [']'])
381 new Command('browse', 'go_up_path', command_go_up_path, ['g,u'])
382 new Command('browse', 'go_to_root', command_go_to_root, ['g,U'])
383 new Command('browse', 'back', command_back, ['H'])
384 new Command('browse', 'forward', command_forward, ['L'])
386 new Command('misc', 'find', command_find, ['/'])
387 new Command('misc', 'find_hl', command_find_hl, ['a,/'])
388 new Command('misc', 'find_next', command_find_next, ['n'])
389 new Command('misc', 'find_prev', command_find_prev, ['N'])
390 new Command('misc', 'insert_mode', command_insert_mode, ['i'])
391 new Command('misc', 'help', command_help, ['?'])
392 new Command('misc', 'dev', command_dev, [':'])
395 new Command('misc', 'Esc', command_Esc, ['Esc'])
398 searchForMatchingCommand = (keys) ->
399 for index in [0...keys.length] by 1
400 str = keys[index..].join(',')
401 for command in commands
402 for key in command.keys()
403 # The following hack is a workaround for the issue where letter `c` is
404 # considered a start of command with control modifier `c-xxx`.
405 if "#{ key },".startsWith("#{ str },")
406 return {match: true, exact: (key == str), command}
408 return {match: false}
410 isEscCommandKey = (keyStr) -> keyStr in escapeCommand.keys()
412 exports.commands = commands
413 exports.searchForMatchingCommand = searchForMatchingCommand
414 exports.isEscCommandKey = isEscCommandKey
415 exports.findStorage = findStorage