2 # Copyright Anton Khodakivskiy 2012, 2013, 2014.
3 # Copyright Simon Lydell 2013, 2014, 2015, 2016.
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 HTMLBodyElement = Ci.nsIDOMHTMLBodyElement
30 XULDocument = Ci.nsIDOMXULDocument
31 XULButtonElement = Ci.nsIDOMXULButtonElement
32 XULControlElement = Ci.nsIDOMXULControlElement
33 XULMenuListElement = Ci.nsIDOMXULMenuListElement
34 XULTextBoxElement = Ci.nsIDOMXULTextBoxElement
36 # Full chains of events for different mouse actions. ('command' is for XUL
38 EVENTS_CLICK = ['mousedown', 'mouseup', 'click', 'command']
39 EVENTS_HOVER_START = ['mouseover', 'mouseenter', 'mousemove']
40 EVENTS_HOVER_END = ['mouseout', 'mouseleave']
44 # Element classification helpers
46 isActivatable = (element) ->
47 return element instanceof HTMLAnchorElement or
48 element instanceof HTMLButtonElement or
49 (element instanceof HTMLInputElement and element.type in [
50 'button', 'submit', 'reset', 'image'
52 element instanceof XULButtonElement
54 isAdjustable = (element) ->
55 return element instanceof HTMLInputElement and element.type in [
56 'checkbox', 'radio', 'file', 'color'
57 'date', 'time', 'datetime', 'datetime-local', 'month', 'week'
59 element instanceof XULControlElement or
60 # Youtube special case.
61 element.classList?.contains('html5-video-player') or
62 element.classList?.contains('ytp-button')
64 isContentEditable = (element) ->
65 return element.isContentEditable or
66 isIframeEditor(element) or
68 element.getAttribute?('g_editable') == 'true' or
69 element.ownerDocument?.body?.getAttribute('g_editable') == 'true'
71 isIframeEditor = (element) ->
72 return false unless element instanceof HTMLBodyElement
75 element.id == 'innerdocbody' or
77 (element.classList.contains('xe_content') and
78 element.classList.contains('editable')) or
80 element.classList.contains('wysiwyg')
82 isProperLink = (element) ->
83 # `.getAttribute` is used below instead of `.hasAttribute` to exclude `<a
84 # href="">`s used as buttons on some sites.
85 return element.getAttribute('href') and
86 (element instanceof HTMLAnchorElement or
87 element.ownerDocument instanceof XULDocument) and
88 not element.href.endsWith('#') and
89 not element.href.endsWith('#?') and
90 not element.href.startsWith('javascript:')
92 isTextInputElement = (element) ->
93 return (element instanceof HTMLInputElement and element.type in [
94 'text', 'search', 'tel', 'url', 'email', 'password', 'number'
96 element instanceof HTMLTextAreaElement or
97 element instanceof XULTextBoxElement or
98 isContentEditable(element)
100 isTypingElement = (element) ->
101 return isTextInputElement(element) or
102 # `<select>` elements can also receive text input: You may type the
103 # text of an item to select it.
104 element instanceof HTMLSelectElement or
105 element instanceof XULMenuListElement
109 # Active/focused element helpers
111 # NOTE: In frame scripts, `document.activeElement` may be `null` when the page
112 # is loading. Therefore always check if anything was returned, such as:
114 # return unless activeElement = utils.getActiveElement(window)
115 getActiveElement = (window) ->
116 {activeElement} = window.document
117 return null unless activeElement
118 # If the active element is a frame, recurse into it. The easiest way to detect
119 # a frame that works both in browser UI and in web page content is to check
120 # for the presence of `.contentWindow`. However, in non-multi-process
121 # `<browser>` (sometimes `<xul:browser>`) elements have a `.contentWindow`
122 # pointing to the web page content `window`, which we don’t want to recurse
123 # into. `.localName` is `.nodeName` without `xul:` (if it exists). This seems
124 # to be the only way to detect such elements.
125 if activeElement.localName != 'browser' and activeElement.contentWindow
126 return getActiveElement(activeElement.contentWindow)
130 blurActiveElement = (window) ->
131 # Blurring a frame element also blurs any active elements inside it. Recursing
132 # into the frames and blurring the “real” active element directly would give
133 # focus to the `<body>` of its containing frame, while blurring the top-most
134 # frame gives focus to the top-most `<body>`. This allows to blur fancy text
135 # editors which use an `<iframe>` as their text area.
136 window.document.activeElement?.blur()
138 blurActiveBrowserElement = (vim) ->
139 # - Blurring in the next tick allows to pass `<escape>` to the location bar to
140 # reset it, for example.
141 # - Focusing the current browser afterwards allows to pass `<escape>` as well
142 # as unbound keys to the page. However, focusing the browser also triggers
143 # focus events on `document` and `window` in the current page. Many pages
144 # re-focus some text input on those events, making it impossible to blur
145 # those! Therefore we tell the frame script to suppress those events.
147 activeElement = getActiveElement(window)
148 vim._send('browserRefocus')
151 window.gBrowser.selectedBrowser.focus()
154 # Focus an element and tell Firefox that the focus happened because of a user
155 # action (not just because some random programmatic focus). `.FLAG_BYKEY` might
156 # look more appropriate, but it unconditionally selects all text, which
157 # `.FLAG_BYMOUSE` does not.
158 focusElement = (element, options = {}) ->
159 focusManager = Cc['@mozilla.org/focus-manager;1']
160 .getService(Ci.nsIFocusManager)
161 focusManager.setFocus(element, options.flag ? 'FLAG_BYMOUSE')
162 element.select?() if options.select
164 getFocusType = (element) -> switch
165 when isTypingElement(element)
167 when isActivatable(element)
169 when isAdjustable(element)
178 listen = (element, eventName, listener, useCapture = true) ->
179 element.addEventListener(eventName, listener, useCapture)
181 element.removeEventListener(eventName, listener, useCapture)
184 listenOnce = (element, eventName, listener, useCapture = true) ->
187 element.removeEventListener(eventName, fn, useCapture)
188 listen(element, eventName, fn, useCapture)
190 onRemoved = (window, element, fn) ->
191 mutationObserver = new window.MutationObserver((changes) ->
192 for change in changes then for removedElement in change.removedNodes
193 if removedElement == element
194 mutationObserver.disconnect()
198 mutationObserver.observe(element.parentNode, {childList: true})
199 module.onShutdown(mutationObserver.disconnect.bind(mutationObserver))
201 suppressEvent = (event) ->
202 event.preventDefault()
203 event.stopPropagation()
205 simulateMouseEvents = (element, sequenceType) ->
206 window = element.ownerGlobal
207 rect = element.getBoundingClientRect()
209 eventSequence = switch sequenceType
210 when 'click' then EVENTS_CLICK
211 when 'hover-start' then EVENTS_HOVER_START
212 when 'hover-end' then EVENTS_HOVER_END
214 for type in eventSequence
215 mouseEvent = new window.MouseEvent(type, {
216 # Let the event bubble in order to trigger delegated event listeners.
217 bubbles: type not in ['mouseenter', 'mouseleave']
218 # Make the event cancelable so that `<a href="#">` can be used as a
219 # JavaScript-powered button without scrolling to the top of the page.
220 cancelable: type not in ['mouseenter', 'mouseleave']
221 # These properties are just here for mimicing a real click as much as
223 buttons: if type in EVENTS_CLICK then 1 else 0
224 detail: if type in EVENTS_CLICK then 1 else 0
226 # `page{X,Y}` are set automatically to the correct values when setting
227 # `client{X,Y}`. `{offset,layer,movement}{X,Y}` are not worth the trouble
231 # To exactly calculate `screen{X,Y}` one has to to check where the web
232 # page content area is inside the browser chrome and go through all parent
233 # frames as well. This is good enough. YAGNI for now.
234 screenX: window.screenX + rect.left
235 screenY: window.screenY + rect.top
237 element.dispatchEvent(mouseEvent)
246 return element.clientWidth * element.clientHeight
248 containsDeep = (parent, element) ->
249 parentWindow = parent.ownerGlobal
250 elementWindow = element.ownerGlobal
252 while elementWindow != parentWindow and elementWindow.top != elementWindow
253 element = elementWindow.frameElement
254 elementWindow = element.ownerGlobal
256 return parent.contains(element)
258 createBox = (document, className = '', parent = null, text = null) ->
259 box = document.createElement('box')
260 box.className = "#{className} vimfx-box"
261 box.textContent = text if text?
262 parent.appendChild(box) if parent?
265 injectTemporaryPopup = (document, contents) ->
266 popup = document.createElement('menupopup')
267 popup.appendChild(contents)
268 document.getElementById('mainPopupSet').appendChild(popup)
269 listenOnce(popup, 'popuphidden', popup.remove.bind(popup))
272 insertText = (input, value) ->
273 {selectionStart, selectionEnd} = input
275 input.value[0...selectionStart] + value + input.value[selectionEnd..]
276 input.selectionStart = input.selectionEnd = selectionStart + value.length
278 querySelectorAllDeep = (window, selector) ->
279 elements = Array.from(window.document.querySelectorAll(selector))
280 for frame in window.frames
281 elements.push(querySelectorAllDeep(frame, selector)...)
284 scroll = (element, args) ->
285 {method, type, directions, amounts, properties, adjustment, smooth} = args
287 for direction, index in directions
288 amount = amounts[index]
289 options[direction] = -Math.sign(amount) * adjustment + switch type
290 when 'lines' then amount
291 when 'pages' then amount * element[properties[index]]
292 when 'other' then Math.min(amount, element[properties[index]])
293 options.behavior = 'smooth' if smooth
294 element[method](options)
296 setAttributes = (element, attributes) ->
297 for attribute, value of attributes
298 element.setAttribute(attribute, value)
301 setHover = (element, hover) ->
302 method = if hover then 'addPseudoClassLock' else 'removePseudoClassLock'
303 domUtils = Cc['@mozilla.org/inspector/dom-utils;1'].getService(Ci.inIDOMUtils)
304 while element.parentElement
305 domUtils[method](element, ':hover')
306 element = element.parentElement
314 constructor: ({start: @value = 0, @step = 1}) ->
315 tick: -> @value += @step
321 on: (event, listener) ->
322 (@listeners[event] ?= []).push(listener)
324 emit: (event, data) ->
325 for listener in @listeners[event] ? []
329 has = (obj, prop) -> Object::hasOwnProperty.call(obj, prop)
331 nextTick = (window, fn) -> window.setTimeout(fn, 0)
333 regexEscape = (s) -> s.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
335 removeDuplicates = (array) -> Array.from(new Set(array))
337 # Remove duplicate characters from string (case insensitive).
338 removeDuplicateCharacters = (str) ->
339 return removeDuplicates( str.toLowerCase().split('') ).join('')
341 # Calls `fn` repeatedly, with at least `interval` ms between each call.
342 setInterval = (window, interval, fn) ->
344 currentIntervalId = null
347 currentIntervalId = window.setTimeout((-> fn(next)), interval)
350 window.clearTimeout(currentIntervalId)
358 formatError = (error) ->
359 stack = String(error.stack?.formattedStack ? error.stack ? '')
361 .filter((line) -> line.includes('.xpi!'))
362 .map((line) -> ' ' + line.replace(/(?:\/<)*@.+\.xpi!/g, '@'))
364 return "#{error}\n#{stack}"
366 getCurrentLocation = ->
367 window = getCurrentWindow()
368 return new window.URL(window.gBrowser.selectedBrowser.currentURI.spec)
370 getCurrentWindow = ->
371 windowMediator = Cc['@mozilla.org/appshell/window-mediator;1']
372 .getService(Components.interfaces.nsIWindowMediator)
373 return windowMediator.getMostRecentWindow('navigator:browser')
376 sss = Cc['@mozilla.org/content/style-sheet-service;1']
377 .getService(Ci.nsIStyleSheetService)
378 uri = Services.io.newURI("chrome://vimfx/skin/#{name}.css", null, null)
379 method = sss.AUTHOR_SHEET
380 unless sss.sheetRegistered(uri, method)
381 sss.loadAndRegisterSheet(uri, method)
383 sss.unregisterSheet(uri, method)
386 observe = (topic, observer) ->
387 observer = {observe: observer} if typeof observer == 'function'
388 Services.obs.addObserver(observer, topic, false)
390 Services.obs.removeObserver(observer, topic, false)
393 openPopup = (popup) ->
394 window = popup.ownerGlobal
395 # Show the popup so it gets a height and width.
396 popup.openPopupAtScreen(0, 0)
397 # Center the popup inside the window.
399 window.screenX + window.outerWidth / 2 - popup.clientWidth / 2,
400 window.screenY + window.outerHeight / 2 - popup.clientHeight / 2
403 openTab = (window, url, options) ->
405 window.TreeStyleTabService?.readyToOpenChildTab(gBrowser.selectedTab)
406 gBrowser.loadOneTab(url, options)
408 writeToClipboard = (text) ->
409 clipboardHelper = Cc['@mozilla.org/widget/clipboardhelper;1']
410 .getService(Ci.nsIClipboardHelper)
411 clipboardHelper.copyString(text)
425 blurActiveBrowserElement
451 removeDuplicateCharacters