extension/packages/commands.coffee

   1 utils = require 'utils'
   2 help  = require 'help'
   3 { _ } = require 'l10n'
   4 { getPref
   5 , getComplexPref
   6 , setPref
   7 , isPrefSet
   8 , getFirefoxPref } = require 'prefs'
   9
  10 { classes: Cc, interfaces: Ci, utils: Cu } = Components
  11
  12 # “Selecting an element” means “focusing and selecting the text, if any, of an
  13 # element”.
  14
  15 # Select the Address Bar
  16 command_focus = (vim) ->
  17   # This function works even if the Address Bar has been removed.
  18   vim.rootWindow.focusAndSelectUrlBar()
  19
  20 # Select the Search Bar
  21 command_focus_search = (vim) ->
  22   # The `.webSearch()` method opens a search engine in a tab if the Search Bar
  23   # has been removed. Therefore we first check if it exists.
  24   if vim.rootWindow.BrowserSearch.searchBar
  25     vim.rootWindow.BrowserSearch.webSearch()
  26
  27 helper_paste = (vim) ->
  28   url = utils.readFromClipboard(vim.window)
  29   postData = null
  30   if not utils.isURL(url) and submission = utils.browserSearchSubmission(url)
  31     url = submission.uri.spec
  32     { postData } = submission
  33   return { url, postData }
  34
  35 # Go to or search for the contents of the system clipboard
  36 command_paste = (vim) ->
  37   { url, postData } = helper_paste(vim)
  38   vim.rootWindow.gBrowser.loadURIWithFlags(url, null, null, null, postData)
  39
  40 # Go to or search for the contents of the system clipboard in a new tab
  41 command_paste_tab = (vim) ->
  42   { url, postData } = helper_paste(vim)
  43   vim.rootWindow.gBrowser.selectedTab = vim.rootWindow.gBrowser.addTab(url, null, null, postData, null, false)
  44
  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)
  53
  54   vim.enterMode('hints', callback)
  55
  56 # Focus element
  57 command_marker_focus = (vim) ->
  58   callback = (marker) -> marker.element.focus()
  59
  60   vim.enterMode('hints', callback)
  61
  62 # Copy the current URL to the system clipboard
  63 command_yank = (vim) ->
  64   utils.writeToClipboard(vim.window.location.href)
  65
  66 # Reload the current tab, possibly from cache
  67 command_reload = (vim) ->
  68   vim.rootWindow.BrowserReload()
  69
  70 # Reload the current tab, skipping cache
  71 command_reload_force = (vim) ->
  72   vim.rootWindow.BrowserReloadSkipCache()
  73
  74 # Reload all tabs, possibly from cache
  75 command_reload_all = (vim) ->
  76   vim.rootWindow.gBrowser.reloadAllTabs()
  77
  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)
  83
  84 # Stop loading the current tab
  85 command_stop = (vim) ->
  86   vim.window.stop()
  87
  88 # Stop loading all tabs
  89 command_stop_all = (vim) ->
  90   for tab in vim.rootWindow.gBrowser.visibleTabs
  91     window = tab.linkedBrowser.contentWindow
  92     window.stop()
  93
  94 # Scroll to the top of the page
  95 command_scroll_to_top = (vim) ->
  96   vim.rootWindow.goDoCommand('cmd_scrollTop')
  97
  98 # Scroll to the bottom of the page
  99 command_scroll_to_bottom = (vim) ->
 100   vim.rootWindow.goDoCommand('cmd_scrollBottom')
 101
 102 # Scroll down a bit
 103 command_scroll_down = (vim) ->
 104   utils.simulateWheel(vim.window, 0, getPref('scroll_step_lines'), utils.WHEEL_MODE_LINE)
 105
 106 # Scroll up a bit
 107 command_scroll_up = (vim) ->
 108   utils.simulateWheel(vim.window, 0, -getPref('scroll_step_lines'), utils.WHEEL_MODE_LINE)
 109
 110 # Scroll left a bit
 111 command_scroll_left = (vim) ->
 112   utils.simulateWheel(vim.window, -getPref('scroll_step_lines'), 0, utils.WHEEL_MODE_LINE)
 113
 114 # Scroll right a bit
 115 command_scroll_right = (vim) ->
 116   utils.simulateWheel(vim.window, getPref('scroll_step_lines'), 0, utils.WHEEL_MODE_LINE)
 117
 118 # Scroll down half a page
 119 command_scroll_half_page_down = (vim) ->
 120   utils.simulateWheel(vim.window, 0, 0.5, utils.WHEEL_MODE_PAGE)
 121
 122 # Scroll up half a page
 123 command_scroll_half_page_up = (vim) ->
 124   utils.simulateWheel(vim.window, 0, -0.5, utils.WHEEL_MODE_PAGE)
 125
 126 # Scroll down full a page
 127 command_scroll_page_down = (vim) ->
 128   utils.simulateWheel(vim.window, 0, 1, utils.WHEEL_MODE_PAGE)
 129
 130 # Scroll up full a page
 131 command_scroll_page_up = (vim) ->
 132   utils.simulateWheel(vim.window, 0, -1, utils.WHEEL_MODE_PAGE)
 133
 134 # Open a new tab and select the Address Bar
 135 command_open_tab = (vim) ->
 136   vim.rootWindow.BrowserOpenTab()
 137
 138 # Switch to the previous tab
 139 command_tab_prev = (vim) ->
 140   vim.rootWindow.gBrowser.tabContainer.advanceSelectedTab(-1, true) # `true` to allow wrapping
 141
 142 # Switch to the next tab
 143 command_tab_next = (vim) ->
 144   vim.rootWindow.gBrowser.tabContainer.advanceSelectedTab(1, true) # `true` to allow wrapping
 145
 146 # Move the current tab backward
 147 command_tab_move_left = (vim) ->
 148   { gBrowser } = vim.rootWindow
 149   lastIndex = gBrowser.tabContainer.selectedIndex
 150   gBrowser.moveTabBackward()
 151   if gBrowser.tabContainer.selectedIndex == lastIndex
 152     gBrowser.moveTabToEnd()
 153
 154 # Move the current tab forward
 155 command_tab_move_right = (vim) ->
 156   { gBrowser } = vim.rootWindow
 157   lastIndex = gBrowser.tabContainer.selectedIndex
 158   gBrowser.moveTabForward()
 159   if gBrowser.tabContainer.selectedIndex == lastIndex
 160     gBrowser.moveTabToStart()
 161
 162 # Load the home page
 163 command_home = (vim) ->
 164   vim.rootWindow.BrowserHome()
 165
 166 # Switch to the first tab
 167 command_tab_first = (vim) ->
 168   vim.rootWindow.gBrowser.selectTabAtIndex(0)
 169
 170 # Switch to the last tab
 171 command_tab_last = (vim) ->
 172   vim.rootWindow.gBrowser.selectTabAtIndex(-1)
 173
 174 # Close current tab
 175 command_close_tab = (vim) ->
 176   unless vim.rootWindow.gBrowser.selectedTab.pinned
 177     vim.rootWindow.gBrowser.removeCurrentTab()
 178
 179 # Restore last closed tab
 180 command_restore_tab = (vim) ->
 181   vim.rootWindow.undoCloseTab()
 182
 183 helper_follow = ({ inTab, multiple }, vim) ->
 184   callback = (matchedMarker, markers) ->
 185     matchedMarker.element.focus()
 186     utils.simulateClick(matchedMarker.element, {metaKey: inTab, ctrlKey: inTab})
 187     isEditable = utils.isElementEditable(matchedMarker.element)
 188     if multiple and not isEditable
 189       # By not resetting immediately one is able to see the last char being matched, which gives
 190       # some nice visual feedback that you've typed the right char.
 191       vim.window.setTimeout((-> marker.reset() for marker in markers), 100)
 192       return true
 193
 194   vim.enterMode('hints', callback)
 195
 196 # Follow links with hint markers
 197 command_follow = helper_follow.bind(undefined, {inTab: false})
 198
 199 # Follow links in a new Tab with hint markers
 200 command_follow_in_tab = helper_follow.bind(undefined, {inTab: true})
 201
 202 # Follow multiple links with hint markers
 203 command_follow_multiple = helper_follow.bind(undefined, {inTab: true, multiple: true})
 204
 205 helper_follow_pattern = (type, vim) ->
 206   links = utils.getMarkableElements(vim.window.document, {type: 'action'})
 207     .filter(utils.isElementVisible)
 208   patterns = utils.splitListString(getComplexPref("#{ type }_patterns"))
 209   matchingLink = utils.getBestPatternMatch(patterns, links)
 210
 211   if matchingLink
 212     utils.simulateClick(matchingLink, {metaKey: false, ctrlKey: false})
 213
 214 # Follow previous page
 215 command_follow_prev = helper_follow_pattern.bind(undefined, 'prev')
 216
 217 # Follow next page
 218 command_follow_next = helper_follow_pattern.bind(undefined, 'next')
 219
 220 # Go up one level in the URL hierarchy
 221 command_go_up_path = (vim) ->
 222   path = vim.window.location.pathname
 223   vim.window.location.pathname = path.replace(/// / [^/]+ /?$ ///, '')
 224
 225 # Go up to root of the URL hierarchy
 226 command_go_to_root = (vim) ->
 227   vim.window.location.href = vim.window.location.origin
 228
 229 # Go back in history
 230 command_back = (vim) ->
 231   vim.rootWindow.BrowserBack()
 232
 233 # Go forward in history
 234 command_forward = (vim) ->
 235   vim.rootWindow.BrowserForward()
 236
 237 findStorage = { lastSearchString: '' }
 238
 239 # Switch into find mode
 240 command_find = (vim) ->
 241   vim.enterMode('find', { highlight: false })
 242
 243 # Switch into find mode with highlighting
 244 command_find_hl = (vim) ->
 245   vim.enterMode('find', { highlight: true })
 246
 247 # Search for the last pattern
 248 command_find_next = (vim) ->
 249   if findBar = vim.rootWindow.gBrowser.getFindBar()
 250     if findStorage.lastSearchString.length > 0
 251       findBar._findField.value = findStorage.lastSearchString
 252       findBar.onFindAgainCommand(false)
 253
 254 # Search for the last pattern backwards
 255 command_find_prev = (vim) ->
 256   if findBar = vim.rootWindow.gBrowser.getFindBar()
 257     if findStorage.lastSearchString.length > 0
 258       findBar._findField.value = findStorage.lastSearchString
 259       findBar.onFindAgainCommand(true)
 260
 261 # Enter insert mode
 262 command_insert_mode = (vim) ->
 263   vim.enterMode('insert')
 264
 265 # Display the Help Dialog
 266 command_help = (vim) ->
 267   help.injectHelp(vim.window.document, commands)
 268
 269 # Open and select the Developer Toolbar
 270 command_dev = (vim) ->
 271   vim.rootWindow.DeveloperToolbar.show(true)
 272   vim.rootWindow.DeveloperToolbar.focus()
 273
 274 command_Esc = (vim, event) ->
 275   utils.blurActiveElement(vim.window)
 276
 277   # Blur active XUL control
 278   callback = -> event.originalTarget?.ownerDocument?.activeElement?.blur()
 279   vim.window.setTimeout(callback, 0)
 280
 281   help.removeHelp(vim.window.document)
 282
 283   vim.rootWindow.DeveloperToolbar.hide()
 284
 285   vim.rootWindow.gBrowser.getFindBar()?.close()
 286
 287
 288 class Command
 289   constructor: (@group, @name, @func, keys) ->
 290     @defaultKeys = keys
 291     if isPrefSet(@prefName('keys'))
 292       try @keyValues = JSON.parse(getPref(@prefName('keys')))
 293     else
 294       @keyValues = keys
 295
 296   # Name of the preference for a given property
 297   prefName: (value) -> "commands.#{ @name }.#{ value }"
 298
 299   keys: (value) ->
 300     if value is undefined
 301       return @keyValues
 302     else
 303       @keyValues = value or @defaultKeyValues
 304       setPref(@prefName('keys'), value and JSON.stringify(value))
 305
 306   help: -> _("help_command_#{ @name }")
 307
 308 commands = [
 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'])
 322
 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'])
 333
 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'])
 344
 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'])
 354
 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,                    [':'])
 362
 363   escapeCommand =
 364   new Command('misc',   'Esc',                    command_Esc,                    ['Esc'])
 365 ]
 366
 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}
 376
 377   return {match: false}
 378
 379 isEscCommandKey = (keyStr) -> keyStr in escapeCommand.keys()
 380
 381 isReturnCommandKey = (keyStr) -> keyStr.contains('Return')
 382
 383 exports.commands                  = commands
 384 exports.searchForMatchingCommand  = searchForMatchingCommand
 385 exports.isEscCommandKey           = isEscCommandKey
 386 exports.isReturnCommandKey        = isReturnCommandKey
 387 exports.findStorage               = findStorage