2 # Copyright Anton Khodakivskiy 2012, 2013, 2014.
3 # Copyright Simon Lydell 2013, 2014, 2015, 2016.
5 # This file is part of VimFx.
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.
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.
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/>.
21 # This file pulls in all the different parts of VimFx, initializes them, and
22 # stiches them together.
24 button = require('./button')
25 config = require('./config')
26 defaults = require('./defaults')
27 help = require('./help')
28 {applyMigrations} = require('./legacy')
29 MarkerContainer = require('./marker-container')
30 messageManager = require('./message-manager')
31 migrations = require('./migrations')
32 modes = require('./modes')
33 options = require('./options')
34 parsePref = require('./parse-prefs')
35 prefs = require('./prefs')
36 UIEventManager = require('./events')
37 utils = require('./utils')
38 VimFx = require('./vimfx')
40 test = require('../test/index')
43 {AddonManager} = Cu.import('resource://gre/modules/AddonManager.jsm', {})
45 module.exports = (data, reason) ->
46 # Set default prefs and apply migrations as early as possible.
48 applyMigrations(migrations)
51 for pref of defaults.all_options
52 parsedOptions[pref] = parsePref(pref)
53 vimfx = new VimFx(modes, parsedOptions)
55 vimfx.version = data.version
56 AddonManager.getAddonByID(vimfx.id, (info) -> vimfx.info = info)
58 utils.loadCss("#{ADDON_PATH}/skin/style.css")
60 options.observe(vimfx)
62 prefs.observe('', (pref) ->
63 if pref.startsWith('mode.') or pref.startsWith('custom.')
64 vimfx.createKeyTrees()
65 else if pref of defaults.all_options
66 value = parsePref(pref)
67 vimfx.options[pref] = value
70 button.injectButton(vimfx)
72 setWindowAttribute = (window, name, value) ->
73 window.document.documentElement.setAttribute("vimfx-#{name}", value)
75 onModeDisplayChange = (data) ->
76 window = data.vim?.window ? data.event.originalTarget.ownerGlobal
78 # The 'modeChange' event provides the `vim` object that changed mode, but
79 # it might not be the current `vim` anymore so always get the current one.
80 return unless vim = vimfx.getCurrentVim(window)
82 setWindowAttribute(window, 'mode', vim.mode)
83 vimfx.emit('modeDisplayChange', {vim})
85 vimfx.on('modeChange', onModeDisplayChange)
86 vimfx.on('TabSelect', onModeDisplayChange)
88 vimfx.on('focusTypeChange', ({vim}) ->
89 setWindowAttribute(vim.window, 'focus-type', vim.focusType)
92 # `config.load` sends a 'loadConfig' message to all frame scripts, but it is
93 # intenionally run _before_ the frame scripts are loaded. Even if it is run
94 # after the frame scripts have been `messageManager.load`ed, we cannot know
95 # when it is ready to receive messages. Instead, the frame scripts trigger
96 # their 'loadConfig' code manually.
98 vimfx.on('shutdown', -> messageManager.send('unloadConfig'))
100 # Make sure to run the below lines in this order. The second line results in
101 # removing all message listeners in frame scripts, including the one for
102 # 'unloadConfig' (see above).
103 vimfx.emit('shutdown')
104 messageManager.send('shutdown')
107 windows = new WeakSet()
108 messageManager.listen('tabCreated', (data, callback, browser) ->
109 # Frame scripts are run in more places than we need. Tell those not to do
111 unless browser.getAttribute('messagemanagergroup') == 'browsers'
115 window = browser.ownerGlobal
116 vimfx.addVim(browser)
118 unless windows.has(window)
120 eventManager = new UIEventManager(vimfx, window)
121 eventManager.addListeners(vimfx, window)
122 setWindowAttribute(window, 'mode', 'normal')
123 setWindowAttribute(window, 'focus-type', 'none')
125 MarkerContainer.remove(window)
126 help.removeHelp(window)
132 # For tabs not visited yet since a session restore (“pending” tabs), Firefox
133 # seems to not load the frame script immediately, but instead remember the URI
134 # and load it when the user eventually visits that tab. If VimFx is updated
135 # during that time this means that the below URI is saved several times, and
136 # will be loaded that many times. Therefore the URI is changed with each
137 # build, causing remembered URIs to point to non-existent files.
138 messageManager.load("#{ADDON_PATH}/content/bootstrap-frame-#{BUILD_TIME}.js")
143 messageManager.listen('runTests', (data, callback) ->
144 callback(runFrameTests)
145 runFrameTests = false