2 # Copyright Simon Lydell 2015.
4 # This file is part of VimFx.
6 # VimFx is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # VimFx is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with VimFx. If not, see <http://www.gnu.org/licenses/>.
20 # This file defines a top-level object to hold global state for VimFx. It keeps
21 # track of all `Vim` instances (vim.coffee), all options and all keyboard
22 # shortcuts. It can consume key presses according to its commands, and return
23 # the commands for UI presentation. There is only one `VimFx` instance.
25 notation = require('vim-like-key-notation')
26 prefs = require('./prefs')
27 utils = require('./utils')
28 Vim = require('./vim')
32 class VimFx extends utils.EventEmitter
33 constructor: (@modes, @options) ->
38 @on('modechange', ({mode}) => @reset(mode))
40 SPECIAL_KEYS: ['<force>', '<late>']
43 @vims.set(browser, new Vim(browser, this))
45 # NOTE: This method is often called in event handlers. Many events may fire
46 # before a `vim` object has been created for the current tab yet (such as when
47 # the browser is starting up). Therefore always check if anything was
50 # return unless vim = @vimfx.getCurrentVim(@window)
51 getCurrentVim: (window) -> @vims.get(window.gBrowser.selectedBrowser)
53 reset: (mode = null) ->
54 @currentKeyTree = if mode then @keyTrees[mode] else {}
61 @commandsWithSpecialKeys
63 } = createKeyTrees(@getGroupedCommands(), @SPECIAL_KEYS)
65 stringifyKeyEvent: (event) ->
66 return notation.stringify(event, {
67 ignoreKeyboardLayout: @options.ignore_keyboard_layout
68 translations: @options.translations
71 consumeKeyEvent: (event, vim, focusType) ->
73 return unless keyStr = @stringifyKeyEvent(event)
76 @reset(mode) if now - @lastInputTime >= @options.timeout
79 toplevel = (@currentKeyTree == @keyTrees[mode])
81 if toplevel and @options.keyValidator
82 unless @options.keyValidator(keyStr, mode)
90 when toplevel and DIGIT.test(keyStr) and
91 not (keyStr == '0' and @count == '')
95 when keyStr of @currentKeyTree
96 next = @currentKeyTree[keyStr]
97 if next instanceof Leaf
99 command = next.command
101 @currentKeyTree = next
107 count = if @count == '' then undefined else Number(@count)
108 specialKeys = @commandsWithSpecialKeys[command?.pref] ? {}
109 focus = @adjustFocusType(event, vim, focusType, keyStr)
110 unmodifiedKey = notation.parse(keyStr).key
111 @reset(mode) if type == 'full'
113 type, focus, command, count, specialKeys, keyStr, unmodifiedKey, toplevel
116 adjustFocusType: (event, vim, focusType, keyStr) ->
117 # Frame scripts and the tests don’t pass in `originalTarget`.
118 document = event.originalTarget?.ownerDocument
119 if focusType == null and document and
120 (vim.window.TabView.isVisible() or
121 document.fullscreenElement or document.mozFullScreenElement)
124 keys = @options["#{ focusType }_element_keys"]
125 return null if keys and keyStr not in keys
129 getGroupedCommands: (options = {}) ->
131 for modeName, mode of @modes
132 if options.enabledOnly
133 usedSequences = getUsedSequences(@keyTrees[modeName])
134 for commandName, command of mode.commands
135 enabledSequences = null
136 if options.enabledOnly
137 enabledSequences = utils.removeDuplicates(
138 command._sequences.filter((sequence) ->
139 return (usedSequences[sequence] == command.pref)
142 continue if enabledSequences.length == 0
143 categories = modes[modeName] ?= {}
144 category = categories[command.category] ?= []
146 {command, enabledSequences, order: command.order, name: commandName}
150 for modeName, categories of modes
151 categoriesSorted = []
152 for categoryName, commands of categories
153 category = @options.categories[categoryName]
154 categoriesSorted.push({
155 name: category.name()
157 order: category.order
158 commands: commands.sort(byOrder)
160 mode = @modes[modeName]
165 categories: categoriesSorted.sort(byOrder)
167 return modesSorted.sort(byOrder)
169 byOrder = (a, b) -> a.order - b.order
172 constructor: (@command, @originalSequence) ->
174 createKeyTrees = (groupedCommands, specialKeys) ->
177 commandsWithSpecialKeys = {}
179 pushError = (error, command) ->
180 (errors[command.pref] ?= []).push(error)
182 pushOverrideErrors = (command, tree) ->
183 { command: overridingCommand, originalSequence } = getFirstLeaf(tree)
186 subject: overridingCommand.description()
187 context: originalSequence
188 pushError(error, command)
190 pushSpecialKeyError = (command, originalSequence, key) ->
192 id: 'illegal_special_key'
194 context: originalSequence
195 pushError(error, command)
197 for mode in groupedCommands
198 keyTrees[mode._name] = {}
199 for category in mode.categories then for { command } in category.commands
200 { shortcuts, errors: parseErrors } = parseShortcutPref(command.pref)
201 pushError(error, command) for error in parseErrors
202 command._sequences = []
204 for shortcut in shortcuts
205 [ prefixKeys..., lastKey ] = shortcut.normalized
206 tree = keyTrees[mode._name]
207 command._sequences.push(shortcut.original)
208 seenNonSpecialKey = false
211 for prefixKey, index in prefixKeys
212 if prefixKey in specialKeys
214 pushSpecialKeyError(command, shortcut.original, prefixKey)
218 (commandsWithSpecialKeys[command.pref] ?= {})[prefixKey] = true
221 seenNonSpecialKey = true
224 next = tree[prefixKey]
225 if next instanceof Leaf
226 pushOverrideErrors(command, next)
232 tree = tree[prefixKey] = {}
235 if lastKey in specialKeys
236 subject = if seenNonSpecialKey then lastKey else shortcut.original
237 pushSpecialKeyError(command, shortcut.original, subject)
240 pushOverrideErrors(command, tree[lastKey])
242 tree[lastKey] = new Leaf(command, shortcut.original)
244 return {keyTrees, commandsWithSpecialKeys, errors}
246 parseShortcutPref = (pref) ->
250 # The shorcut prefs are read from root in order to support other extensions to
251 # extend VimFx with custom commands.
252 prefValue = prefs.root.get(pref).trim()
254 unless prefValue == ''
255 for sequence in prefValue.split(/\s+/)
258 for key in notation.parseSequence(sequence)
260 shortcut.push(notation.normalize(key))
262 throw error unless error.id?
266 shortcuts.push({normalized: shortcut, original: sequence}) unless errored
268 return {shortcuts, errors}
270 getFirstLeaf = (node) ->
271 if node instanceof Leaf
273 for key, value of node
274 return getFirstLeaf(value)
276 getLeaves = (node) ->
277 if node instanceof Leaf
280 for key, value of node
281 leaves.push(getLeaves(value)...)
284 getUsedSequences = (tree) ->
286 for leaf in getLeaves(tree)
287 usedSequences[leaf.originalSequence] = leaf.command.pref
290 module.exports = VimFx