1 utils = require 'utils'
8 , getFirefoxPref } = require 'prefs'
10 { classes: Cc, interfaces: Ci, utils: Cu } = Components
12 # “Selecting an element” means “focusing and selecting the text, if any, of an
15 # Open and select the Developer Toolbar
16 command_dev = (vim) ->
17 vim.rootWindow.DeveloperToolbar.show(true)
18 vim.rootWindow.DeveloperToolbar.focus()
20 # Select the Address Bar
21 command_focus = (vim) ->
22 # This function works even if the Address Bar has been removed.
23 vim.rootWindow.focusAndSelectUrlBar()
25 # Select the Search Bar
26 command_focus_search = (vim) ->
27 # A `?` is used since the Search Bar might have been removed.
28 vim.BrowserSearch.searchBar?.select()
30 helper_paste = (vim) ->
31 url = utils.readFromClipboard(vim.window)
33 if not utils.isURL(url) and submission = utils.browserSearchSubmission(url)
34 url = submission.uri.spec
35 { postData } = submission
36 return { url, postData }
38 # Go to or search for the contents of the system clipboard
39 command_paste = (vim) ->
40 { url, postData } = helper_paste(vim)
41 vim.rootWindow.gBrowser.loadURIWithFlags(url, null, null, null, postData)
43 # Go to or search for the contents of the system clipboard in a new tab
44 command_paste_tab = (vim) ->
45 { url, postData } = helper_paste(vim)
46 vim.rootWindow.gBrowser.selectedTab = vim.rootWindow.gBrowser.addTab(url, null, null, postData, null, false)
48 # Open a new tab and select the Address Bar
49 command_open_tab = (vim) ->
50 vim.rootWindow.BrowserOpenTab()
52 # Copy the URL or text of a marker element to the system clipboard
53 command_marker_yank = (vim) ->
54 callback = (marker) ->
55 if url = marker.element.href
56 marker.element.focus()
57 utils.writeToClipboard(url)
58 else if utils.isTextInputElement(marker.element)
59 utils.writeToClipboard(marker.element.value)
61 vim.enterMode('hints', callback)
64 command_marker_focus = (vim) ->
65 callback = (marker) -> marker.element.focus()
67 vim.enterMode('hints', callback)
69 # Copy the current URL to the system clipboard
70 command_yank = (vim) ->
71 utils.writeToClipboard(vim.window.location.href)
73 # Reload the current tab, possibly from cache
74 command_reload = (vim) ->
75 vim.rootWindow.BrowserReload()
77 # Reload the current tab, skipping cache
78 command_reload_force = (vim) ->
79 vim.rootWindow.BrowserReloadSkipCache()
81 # Reload all tabs, possibly from cache
82 command_reload_all = (vim) ->
83 vim.rootWindow.gBrowser.reloadAllTabs()
85 # Reload all tabs, skipping cache
86 command_reload_all_force = (vim) ->
87 for tab in vim.rootWindow.gBrowser.visibleTabs
88 window = tab.linkedBrowser.contentWindow
89 window.location.reload(true)
91 # Stop loading the current tab
92 command_stop = (vim) ->
95 # Stop loading all tabs
96 command_stop_all = (vim) ->
97 for tab in vim.rootWindow.gBrowser.visibleTabs
98 window = tab.linkedBrowser.contentWindow
101 # Scroll to the top of the page
102 command_scroll_to_top = (vim) ->
103 vim.rootWindow.goDoCommand('cmd_scrollTop')
105 # Scroll to the bottom of the page
106 command_scroll_to_bottom = (vim) ->
107 vim.rootWindow.goDoCommand('cmd_scrollBottom')
110 command_scroll_down = (vim) ->
111 utils.simulateWheel(vim.window, 0, getPref('scroll_step_lines'), utils.WHEEL_MODE_LINE)
114 command_scroll_up = (vim) ->
115 utils.simulateWheel(vim.window, 0, -getPref('scroll_step_lines'), utils.WHEEL_MODE_LINE)
118 command_scroll_left = (vim) ->
119 utils.simulateWheel(vim.window, -getPref('scroll_step_lines'), 0, utils.WHEEL_MODE_LINE)
122 command_scroll_right = (vim) ->
123 utils.simulateWheel(vim.window, getPref('scroll_step_lines'), 0, utils.WHEEL_MODE_LINE)
125 # Scroll down half a page
126 command_scroll_half_page_down = (vim) ->
127 utils.simulateWheel(vim.window, 0, 0.5, utils.WHEEL_MODE_PAGE)
129 # Scroll up half a page
130 command_scroll_half_page_up = (vim) ->
131 utils.simulateWheel(vim.window, 0, -0.5, utils.WHEEL_MODE_PAGE)
133 # Scroll down full a page
134 command_scroll_page_down = (vim) ->
135 utils.simulateWheel(vim.window, 0, 1, utils.WHEEL_MODE_PAGE)
137 # Scroll up full a page
138 command_scroll_page_up = (vim) ->
139 utils.simulateWheel(vim.window, 0, -1, utils.WHEEL_MODE_PAGE)
141 # Switch to the previous tab
142 command_tab_prev = (vim) ->
143 vim.rootWindow.gBrowser.tabContainer.advanceSelectedTab(-1, true) # `true` to allow wrapping
145 # Switch to the next tab
146 command_tab_next = (vim) ->
147 vim.rootWindow.gBrowser.tabContainer.advanceSelectedTab(1, true) # `true` to allow wrapping
150 command_home = (vim) ->
151 vim.rootWindow.BrowserHome()
153 # Switch to the first tab
154 command_tab_first = (vim) ->
155 vim.rootWindow.gBrowser.selectTabAtIndex(0)
157 # Switch to the last tab
158 command_tab_last = (vim) ->
159 vim.rootWindow.gBrowser.selectTabAtIndex(-1)
162 command_back = (vim) ->
163 vim.rootWindow.BrowserBack()
165 # Go forward in history
166 command_forward = (vim) ->
167 vim.rootWindow.BrowserForward()
170 command_close_tab = (vim) ->
171 unless vim.rootWindow.gBrowser.selectedTab.pinned
172 vim.rootWindow.gBrowser.removeCurrentTab()
174 # Restore last closed tab
175 command_restore_tab = (vim) ->
176 vim.rootWindow.undoCloseTab()
178 helper_follow = ({ inTab, multiple }, vim) ->
179 callback = (matchedMarker, markers) ->
180 matchedMarker.element.focus()
181 utils.simulateClick(matchedMarker.element, {metaKey: inTab, ctrlKey: inTab})
182 isEditable = utils.isElementEditable(matchedMarker.element)
183 if multiple and not isEditable
184 # By not resetting immediately one is able to see the last char being matched, which gives
185 # some nice visual feedback that you've typed the right char.
186 vim.window.setTimeout((-> marker.reset() for marker in markers), 100)
189 vim.enterMode('hints', callback)
191 # Follow links with hint markers
192 command_follow = helper_follow.bind(undefined, {inTab: false})
194 # Follow links in a new Tab with hint markers
195 command_follow_in_tab = helper_follow.bind(undefined, {inTab: true})
197 # Follow multiple links with hint markers
198 command_follow_multiple = helper_follow.bind(undefined, {inTab: true, multiple: true})
200 helper_follow_pattern = (type, vim) ->
201 links = utils.getMarkableElements(vim.window.document, {type: 'action'})
202 .filter(utils.isElementVisible)
203 patterns = utils.splitListString(getComplexPref("#{ type }_patterns"))
204 matchingLink = utils.getBestPatternMatch(patterns, links)
207 utils.simulateClick(matchingLink, {metaKey: false, ctrlKey: false})
209 # Follow previous page
210 command_follow_prev = helper_follow_pattern.bind(undefined, 'prev')
213 command_follow_next = helper_follow_pattern.bind(undefined, 'next')
215 # Go up one level in the URL hierarchy
216 command_go_up_path = (vim) ->
217 path = vim.window.location.pathname
218 vim.window.location.pathname = path.replace(/// / [^/]+ /?$ ///, '')
220 # Go up to root of the URL hierarchy
221 command_go_to_root = (vim) ->
222 vim.window.location.href = vim.window.location.origin
224 # Move current tab to the left
225 command_tab_move_left = (vim) ->
226 if { gBrowser } = vim.rootWindow
227 if tab = gBrowser.selectedTab
228 index = gBrowser.tabContainer.selectedIndex
229 total = gBrowser.tabContainer.itemCount
231 # `total` is added to deal with negative offset
232 gBrowser.moveTabTo(tab, (total + index - 1) % total)
234 # Move current tab to the right
235 command_tab_move_right = (vim) ->
236 if { gBrowser } = vim.window
237 if tab = gBrowser.selectedTab
238 index = gBrowser.tabContainer.selectedIndex
239 total = gBrowser.tabContainer.itemCount
241 gBrowser.moveTabTo(tab, (index + 1) % total)
243 # Display the Help Dialog
244 command_help = (vim) ->
245 help.injectHelp(vim.window.document, commands)
247 findStorage = { lastSearchString: '' }
249 # Switch into find mode
250 command_find = (vim) ->
251 vim.enterMode('find', { highlight: false })
253 # Switch into find mode with highlighting
254 command_find_hl = (vim) ->
255 vim.enterMode('find', { highlight: true })
257 # Search for the last pattern
258 command_find_next = (vim) ->
259 if findBar = vim.rootWindow.gBrowser.getFindBar()
260 if findStorage.lastSearchString.length > 0
261 findBar._findField.value = findStorage.lastSearchString
262 findBar.onFindAgainCommand(false)
264 # Search for the last pattern backwards
265 command_find_prev = (vim) ->
266 if findBar = vim.rootWindow.gBrowser.getFindBar()
267 if findStorage.lastSearchString.length > 0
268 findBar._findField.value = findStorage.lastSearchString
269 findBar.onFindAgainCommand(true)
271 command_insert_mode = (vim) ->
272 vim.enterMode('insert')
274 command_Esc = (vim, event) ->
275 utils.blurActiveElement(vim.window)
277 # Blur active XUL control
278 callback = -> event.originalTarget?.ownerDocument?.activeElement?.blur()
279 vim.window.setTimeout(callback, 0)
281 help.removeHelp(vim.window.document)
283 vim.rootWindow.DeveloperToolbar.hide()
285 vim.rootWindow.gBrowser.getFindBar()?.close()
289 constructor: (@group, @name, @func, keys) ->
291 if isPrefSet(@prefName('keys'))
292 try @keyValues = JSON.parse(getPref(@prefName('keys')))
296 # Name of the preference for a given property
297 prefName: (value) -> "commands.#{ @name }.#{ value }"
300 if value is undefined
303 @keyValues = value or @defaultKeyValues
304 setPref(@prefName('keys'), value and JSON.stringify(value))
306 help: -> _("help_command_#{ @name }")
309 new Command('urls', 'focus', command_focus, ['o'])
310 new Command('urls', 'focus_search', command_focus_search, ['O'])
311 new Command('urls', 'paste', command_paste, ['p'])
312 new Command('urls', 'paste_tab', command_paste_tab, ['P'])
313 new Command('urls', 'marker_yank', command_marker_yank, ['y,f'])
314 new Command('urls', 'marker_focus', command_marker_focus, ['v,f'])
315 new Command('urls', 'yank', command_yank, ['y,y'])
316 new Command('urls', 'reload', command_reload, ['r'])
317 new Command('urls', 'reload_force', command_reload_force, ['R'])
318 new Command('urls', 'reload_all', command_reload_all, ['a,r'])
319 new Command('urls', 'reload_all_force', command_reload_all_force, ['a,R'])
320 new Command('urls', 'stop', command_stop, ['s'])
321 new Command('urls', 'stop_all', command_stop_all, ['a,s'])
323 new Command('nav', 'scroll_to_top', command_scroll_to_top , ['g,g'])
324 new Command('nav', 'scroll_to_bottom', command_scroll_to_bottom, ['G'])
325 new Command('nav', 'scroll_down', command_scroll_down, ['j', 'c-e'])
326 new Command('nav', 'scroll_up', command_scroll_up, ['k', 'c-y'])
327 new Command('nav', 'scroll_left', command_scroll_left, ['h'])
328 new Command('nav', 'scroll_right', command_scroll_right , ['l'])
329 new Command('nav', 'scroll_half_page_down', command_scroll_half_page_down, ['d'])
330 new Command('nav', 'scroll_half_page_up', command_scroll_half_page_up, ['u'])
331 new Command('nav', 'scroll_page_down', command_scroll_page_down, ['c-f'])
332 new Command('nav', 'scroll_page_up', command_scroll_page_up, ['c-b'])
334 new Command('tabs', 'open_tab', command_open_tab, ['t'])
335 new Command('tabs', 'tab_prev', command_tab_prev, ['J', 'g,T'])
336 new Command('tabs', 'tab_next', command_tab_next, ['K', 'g,t'])
337 new Command('tabs', 'tab_move_left', command_tab_move_left, ['c-J'])
338 new Command('tabs', 'tab_move_right', command_tab_move_right, ['c-K'])
339 new Command('tabs', 'home', command_home, ['g,h'])
340 new Command('tabs', 'tab_first', command_tab_first, ['g,H', 'g,^'])
341 new Command('tabs', 'tab_last', command_tab_last, ['g,L', 'g,$'])
342 new Command('tabs', 'close_tab', command_close_tab, ['x'])
343 new Command('tabs', 'restore_tab', command_restore_tab, ['X'])
345 new Command('browse', 'follow', command_follow, ['f'])
346 new Command('browse', 'follow_in_tab', command_follow_in_tab, ['F'])
347 new Command('browse', 'follow_multiple', command_follow_multiple, ['a,f'])
348 new Command('browse', 'follow_previous', command_follow_prev, ['['])
349 new Command('browse', 'follow_next', command_follow_next, [']'])
350 new Command('browse', 'go_up_path', command_go_up_path, ['g,u'])
351 new Command('browse', 'go_to_root', command_go_to_root, ['g,U'])
352 new Command('browse', 'back', command_back, ['H'])
353 new Command('browse', 'forward', command_forward, ['L'])
355 new Command('misc', 'find', command_find, ['/'])
356 new Command('misc', 'find_hl', command_find_hl, ['a,/'])
357 new Command('misc', 'find_next', command_find_next, ['n'])
358 new Command('misc', 'find_prev', command_find_prev, ['N'])
359 new Command('misc', 'insert_mode', command_insert_mode, ['i'])
360 new Command('misc', 'help', command_help, ['?'])
361 new Command('misc', 'dev', command_dev, [':'])
364 new Command('misc', 'Esc', command_Esc, ['Esc'])
367 searchForMatchingCommand = (keys) ->
368 for index in [0...keys.length] by 1
369 str = keys[index..].join(',')
370 for command in commands
371 for key in command.keys()
372 # The following hack is a workaround for the issue where # letter `c`
373 # is considered a start of command with control modifier `c-xxx`
374 if "#{key},".startsWith("#{str},")
375 return {match: true, exact: (key == str), command}
377 return {match: false}
379 isEscCommandKey = (keyStr) -> keyStr in escapeCommand.keys()
381 isReturnCommandKey = (keyStr) -> keyStr.contains('Return')
383 exports.commands = commands
384 exports.searchForMatchingCommand = searchForMatchingCommand
385 exports.isEscCommandKey = isEscCommandKey
386 exports.isReturnCommandKey = isReturnCommandKey
387 exports.findStorage = findStorage