2 # Copyright Anton Khodakivskiy 2012, 2013, 2014.
3 # Copyright Simon Lydell 2013, 2014.
4 # Copyright Wang Zhuochun 2013.
6 # This file is part of VimFx.
8 # VimFx is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # VimFx is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with VimFx. If not, see <http://www.gnu.org/licenses/>.
22 # This file contains lots of different helper functions.
24 HTMLAnchorElement = Ci.nsIDOMHTMLAnchorElement
25 HTMLButtonElement = Ci.nsIDOMHTMLButtonElement
26 HTMLInputElement = Ci.nsIDOMHTMLInputElement
27 HTMLTextAreaElement = Ci.nsIDOMHTMLTextAreaElement
28 HTMLSelectElement = Ci.nsIDOMHTMLSelectElement
29 HTMLFrameElement = Ci.nsIDOMHTMLFrameElement
30 HTMLIFrameElement = Ci.nsIDOMHTMLIFrameElement
31 XULDocument = Ci.nsIDOMXULDocument
32 XULButtonElement = Ci.nsIDOMXULButtonElement
33 XULControlElement = Ci.nsIDOMXULControlElement
34 XULMenuListElement = Ci.nsIDOMXULMenuListElement
35 XULTextBoxElement = Ci.nsIDOMXULTextBoxElement
41 # Element classification helpers
43 isActivatable = (element) ->
44 return element instanceof HTMLAnchorElement or
45 element instanceof HTMLButtonElement or
46 (element instanceof HTMLInputElement and element.type in [
47 'button', 'submit', 'reset', 'image'
49 element instanceof XULButtonElement
51 isAdjustable = (element) ->
52 return element instanceof HTMLInputElement and element.type in [
53 'checkbox', 'radio', 'file', 'color'
54 'date', 'time', 'datetime', 'datetime-local', 'month', 'week'
56 element instanceof XULControlElement or
57 # Youtube special case.
58 element.classList?.contains('html5-video-player') or
59 element.classList?.contains('ytp-button')
61 isContentEditable = (element) ->
62 return element.isContentEditable or
63 # `g_editable` is a non-standard attribute commonly used by Google.
64 element.getAttribute?('g_editable') == 'true' or
65 element.ownerDocument?.body?.getAttribute('g_editable') == 'true'
67 isProperLink = (element) ->
68 # `.getAttribute` is used below instead of `.hasAttribute` to exclude `<a
69 # href="">`s used as buttons on some sites.
70 return element.getAttribute('href') and
71 (element instanceof HTMLAnchorElement or
72 element.ownerDocument instanceof XULDocument) and
73 not element.href.endsWith('#') and
74 not element.href.startsWith('javascript:')
76 isTextInputElement = (element) ->
77 return (element instanceof HTMLInputElement and element.type in [
78 'text', 'search', 'tel', 'url', 'email', 'password', 'number'
80 element instanceof HTMLTextAreaElement or
81 # `<select>` elements can also receive text input: You may type the
82 # text of an item to select it.
83 element instanceof HTMLSelectElement or
84 element instanceof XULMenuListElement or
85 element instanceof XULTextBoxElement
89 # Active/focused element helpers
91 getActiveElement = (window) ->
92 { activeElement } = window.document
93 if activeElement instanceof HTMLFrameElement or
94 activeElement instanceof HTMLIFrameElement
95 return getActiveElement(activeElement.contentWindow)
99 blurActiveElement = (window) ->
100 # Only blur focusable elements, in order to interfere with the browser as
101 # little as possible.
102 activeElement = getActiveElement(window)
103 if activeElement and activeElement.tabIndex > -1
106 blurActiveBrowserElement = (window) ->
107 # - Some browser UI elements, such as the web console, are not marked as
108 # focusable, so we can’t check if the element is focusable as in
109 # `blurActiveElement`.
110 # - Blurring in the next tick allows to pass `<escape>` to the location bar to
111 # reset it, for example.
112 # - Focusing the current browser afterwards allows to pass `<escape>` as well
113 # as unbound keys to the page.
114 activeElement = getActiveElement(window)
117 window.gBrowser.selectedBrowser.focus()
118 window.setTimeout(callback, 0)
120 # Focus an element and tell Firefox that the focus happened because of a user
121 # keypress (not just because some random programmatic focus).
122 focusElement = (element, options = {}) ->
123 focusManager = Cc['@mozilla.org/focus-manager;1']
124 .getService(Ci.nsIFocusManager)
125 focusManager.setFocus(element, focusManager.FLAG_BYKEY)
126 element.select?() if options.select
128 getFocusType = (event) ->
129 target = event.originalTarget
131 when isTextInputElement(target) or isContentEditable(target)
133 when isActivatable(target)
135 when isAdjustable(target)
144 listen = (element, eventName, listener) ->
145 element.addEventListener(eventName, listener, USE_CAPTURE)
147 element.removeEventListener(eventName, listener, USE_CAPTURE)
150 listenOnce = (element, eventName, listener) ->
153 element.removeEventListener(eventName, fn, USE_CAPTURE)
154 listen(element, eventName, fn)
156 suppressEvent = (event) ->
157 event.preventDefault()
158 event.stopPropagation()
160 # Simulate mouse click with a full chain of events. ('command' is for XUL
162 eventSequence = ['mouseover', 'mousedown', 'mouseup', 'click', 'command']
163 simulateClick = (element) ->
164 window = element.ownerDocument.defaultView
166 for type in eventSequence
167 mouseEvent = new window.MouseEvent(type, {
168 # Let the event bubble in order to trigger delegated event listeners.
170 # Make the event cancelable so that `<a href="#">` can be used as a
171 # JavaScript-powered button without scrolling to the top of the page.
174 element.dispatchEvent(mouseEvent)
175 simulatedEvents[type] = mouseEvent
176 return simulatedEvents
183 return element.clientWidth * element.clientHeight
185 createBox = (document, className, parent = null, text = null) ->
186 box = document.createElement('box')
187 box.className = className
188 box.textContent = text if text?
189 parent.appendChild(box) if parent?
192 insertText = (input, value) ->
193 { selectionStart, selectionEnd } = input
195 input.value[0...selectionStart] + value + input.value[selectionEnd..]
196 input.selectionStart = input.selectionEnd = selectionStart + value.length
198 setAttributes = (element, attributes) ->
199 for attribute, value of attributes
200 element.setAttribute(attribute, value)
208 constructor: ({ start: @value = 0, @step = 1 }) ->
209 tick: -> @value += @step
215 on: (event, listener) ->
216 (@listeners[event] ?= []).push(listener)
218 emit: (event, data) ->
219 for listener in @listeners[event] ? []
223 has = Function::call.bind(Object::hasOwnProperty)
225 regexEscape = (s) -> s.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
227 removeDuplicates = (array) ->
228 # coffeelint: disable=no_backticks
229 return `[...new Set(array)]`
230 # coffeelint: enable=no_backticks
232 # Remove duplicate characters from string (case insensitive).
233 removeDuplicateCharacters = (str) ->
234 return removeDuplicates( str.toLowerCase().split('') ).join('')
240 formatError = (error) ->
241 stack = String(error.stack?.formattedStack ? error.stack ? '')
243 .filter((line) -> line.includes('.xpi!'))
244 .map((line) -> ' ' + line.replace(/(?:\/<)*@.+\.xpi!/g, '@'))
246 return "#{ error }\n#{ stack }"
248 getCurrentLocation = ->
249 window = getCurrentWindow()
250 return new window.URL(window.gBrowser.selectedBrowser.currentURI.spec)
252 getCurrentWindow = ->
253 windowMediator = Cc['@mozilla.org/appshell/window-mediator;1']
254 .getService(Components.interfaces.nsIWindowMediator)
255 return windowMediator.getMostRecentWindow('navigator:browser')
258 sss = Cc['@mozilla.org/content/style-sheet-service;1']
259 .getService(Ci.nsIStyleSheetService)
260 uri = Services.io.newURI("chrome://vimfx/skin/#{ name }.css", null, null)
261 method = sss.AUTHOR_SHEET
262 unless sss.sheetRegistered(uri, method)
263 sss.loadAndRegisterSheet(uri, method)
265 sss.unregisterSheet(uri, method)
268 observe = (topic, observer) ->
269 observer = {observe: observer} if typeof observer == 'function'
270 Services.obs.addObserver(observer, topic, false)
272 Services.obs.removeObserver(observer, topic, false)
275 openTab = (window, url, options) ->
276 { gBrowser } = window
277 window.TreeStyleTabService?.readyToOpenChildTab(gBrowser.selectedTab)
278 gBrowser.loadOneTab(url, options)
280 # Executes `fn` and measures how much time it took.
281 timeIt = (fn, name) ->
284 console.timeEnd(name)
287 writeToClipboard = (text) ->
288 clipboardHelper = Cc['@mozilla.org/widget/clipboardhelper;1']
289 .getService(Ci.nsIClipboardHelper)
290 clipboardHelper.copyString(text)
303 blurActiveBrowserElement
322 removeDuplicateCharacters