extension/lib/vim-frame.coffee

   1 ###
   2 # Copyright Anton Khodakivskiy 2012, 2013.
   3 # Copyright Simon Lydell 2013, 2014.
   4 #
   5 # This file is part of VimFx.
   6 #
   7 # VimFx is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # VimFx is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with VimFx.  If not, see <http://www.gnu.org/licenses/>.
  19 ###
  20
  21 # This file is the equivalent to vim.coffee. `vim.window` is called
  22 # `vim.content` to be consistent with Firefox’s frame script terminology and to
  23 # avoid confusion about what it represents. There is one `VimFrame` instance for
  24 # each tab. It mostly tries to mimic the `Vim` class in vim.coffee, but also
  25 # keeps track of web page state. `VimFrame` is not part of the public API.
  26
  27 messageManager = require('./message-manager')
  28 utils          = require('./utils')
  29
  30 class VimFrame
  31   constructor: (@content) ->
  32     @mode = 'normal'
  33
  34     @resetState()
  35
  36     messageManager.listen('modeChange', ({ mode }) =>
  37       @mode = mode
  38     )
  39
  40     messageManager.listen('markPageInteraction',
  41                           @markPageInteraction.bind(this))
  42
  43   resetState: ->
  44     @state =
  45       hasInteraction:       false
  46       scrollableElements:   new WeakSet()
  47       lastFocusedTextInput: null
  48       shouldRefocus:        false
  49
  50   options: (prefs) -> messageManager.get('options', {prefs})
  51
  52   enterMode: (@mode, args...) ->
  53     messageManager.send('vimMethod', {
  54       method: 'enterMode'
  55       args: [@mode, args...]
  56     })
  57
  58   onInput: (event) ->
  59     focusType = utils.getFocusType(event)
  60     suppress = messageManager.get('consumeKeyEvent', {focusType})
  61     return suppress
  62
  63   notify: (args...) ->
  64     messageManager.send('vimMethod', {method: 'notify', args})
  65
  66   markPageInteraction: -> @state.hasInteraction = true
  67
  68 module.exports = VimFrame