extension/packages/events.coffee

   1 utils                   = require 'utils'
   2 keyUtils                = require 'key-utils'
   3 { Vim }                 = require 'vim'
   4 { getPref }             = require 'prefs'
   5 { updateToolbarButton } = require 'button'
   6 { unload }              = require 'unload'
   7
   8 { interfaces: Ci } = Components
   9
  10 vimBucket = new utils.Bucket(utils.getWindowId, (w) -> new Vim(w))
  11
  12 keyStrFromEvent = (event) ->
  13   { ctrlKey: ctrl, metaKey: meta, altKey: alt, shiftKey: shift } = event
  14
  15   if !meta and !alt
  16     return unless keyChar = keyUtils.keyCharFromCode(event.keyCode, shift)
  17     keyStr = keyUtils.applyModifiers(keyChar, ctrl, alt, meta)
  18     return keyStr
  19
  20   return null
  21
  22 # Passthrough mode is activated when VimFx should temporarily stop processing keyboard input, for
  23 # example when a menu is shown.
  24 passthrough = false
  25 checkPassthrough = (event) ->
  26   if event.target.nodeName in ['menupopup', 'panel']
  27     passthrough = switch event.type
  28       when 'popupshown'  then true
  29       when 'popuphidden' then false
  30
  31 suppress = false
  32 keyListener = (event) ->
  33   try
  34     return if passthrough or getPref('disabled')
  35     return unless window = utils.getEventCurrentTabWindow(event)
  36     return unless vim = vimBucket.get(window)
  37     return if vim.blacklisted
  38
  39     if event.type == 'keydown'
  40       suppress = false
  41
  42       return unless keyStr = keyStrFromEvent(event)
  43
  44       suppress = vim.onInput(keyStr, event)
  45
  46     if suppress
  47       event.preventDefault()
  48       event.stopPropagation()
  49
  50   catch error
  51     console.log("#{ error } (in #{ event.type })\n#{ error.stack.replace(/@.+-> /g, '@') }")
  52
  53 removeVimFromTab = (tab, gBrowser) ->
  54   return unless browser = gBrowser.getBrowserForTab(tab)
  55   vimBucket.forget(browser.contentWindow)
  56
  57 updateButton = (vim) ->
  58   return unless rootWindow = utils.getRootWindow(vim.window)
  59   updateToolbarButton(rootWindow, {blacklisted: vim.blacklisted, insertMode: vim.mode == 'insert'})
  60
  61 # The following listeners are installed on every top level Chrome window
  62 windowsListeners =
  63   keydown:     keyListener
  64   keypress:    keyListener
  65   keyup:       keyListener
  66   popupshown:  checkPassthrough
  67   popuphidden: checkPassthrough
  68
  69   # When the top level window closes we should release all Vims that were
  70   # associated with tabs in this window
  71   DOMWindowClose: (event) ->
  72     return unless { gBrowser } = event.originalTarget
  73     for tab in gBrowser.tabs
  74       removeVimFromTab(tab, gBrowser)
  75
  76   TabClose: (event) ->
  77     return unless { gBrowser } = utils.getEventRootWindow(event) ? {}
  78     tab = event.originalTarget
  79     removeVimFromTab(tab, gBrowser)
  80
  81   # Update the toolbar button icon to reflect the blacklisted state
  82   TabSelect: (event) ->
  83     return unless window = event.originalTarget?.linkedBrowser?.contentDocument?.defaultView
  84     return unless vim = vimBucket.get(window)
  85     updateButton(vim)
  86
  87 # This listener works on individual tabs within Chrome Window
  88 tabsListener =
  89   # Listenfor location changes and disable the extension on blacklisted urls
  90   onLocationChange: (browser, webProgress, request, location) ->
  91     return unless vim = vimBucket.get(browser.contentWindow)
  92
  93     # If the location changes when in hints mode (for example because the reload button has been
  94     # clicked), we're going to end up in hints mode without any markers. So switch back to normal
  95     # mode in that case.
  96     if vim.mode == 'hints'
  97       vim.enterMode('normal')
  98
  99     vim.blacklisted = utils.isBlacklisted(location.spec)
 100     updateButton(vim)
 101
 102 addEventListeners = (window) ->
 103   for name, listener of windowsListeners
 104     window.addEventListener(name, listener, true)
 105
 106   window.gBrowser.addTabsProgressListener(tabsListener)
 107
 108   unload ->
 109     for name, listener of windowsListeners
 110       window.removeEventListener(name, listener, true)
 111
 112     window.gBrowser.removeTabsProgressListener(tabsListener)
 113
 114 exports.addEventListeners = addEventListeners
 115 exports.vimBucket         = vimBucket