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 notation = require('vim-like-key-notation')
25 } = require('./prefs')
27 ADDON_ID = 'VimFx@akhodakivskiy.github.com'
29 { classes: Cc, interfaces: Ci, utils: Cu } = Components
31 Window = Ci.nsIDOMWindow
32 ChromeWindow = Ci.nsIDOMChromeWindow
33 Element = Ci.nsIDOMElement
34 HTMLDocument = Ci.nsIDOMHTMLDocument
35 HTMLAnchorElement = Ci.nsIDOMHTMLAnchorElement
36 HTMLButtonElement = Ci.nsIDOMHTMLButtonElement
37 HTMLInputElement = Ci.nsIDOMHTMLInputElement
38 HTMLTextAreaElement = Ci.nsIDOMHTMLTextAreaElement
39 HTMLSelectElement = Ci.nsIDOMHTMLSelectElement
40 XULDocument = Ci.nsIDOMXULDocument
41 XULButtonElement = Ci.nsIDOMXULButtonElement
42 XULControlElement = Ci.nsIDOMXULControlElement
43 XULMenuListElement = Ci.nsIDOMXULMenuListElement
44 XULTextBoxElement = Ci.nsIDOMXULTextBoxElement
47 constructor: (@newFunc) ->
48 @bucket = new WeakMap()
52 return @bucket.get(obj)
55 @bucket.set(obj, value)
61 getEventWindow = (event) ->
62 if event.originalTarget instanceof Window
63 return event.originalTarget
65 doc = event.originalTarget.ownerDocument or event.originalTarget
66 if doc instanceof HTMLDocument or doc instanceof XULDocument
67 return doc.defaultView
69 getEventRootWindow = (event) ->
70 return unless window = getEventWindow(event)
71 return getRootWindow(window)
73 getEventCurrentTabWindow = (event) ->
74 return unless rootWindow = getEventRootWindow(event)
75 return getCurrentTabWindow(rootWindow)
77 getRootWindow = (window) ->
79 .QueryInterface(Ci.nsIInterfaceRequestor)
80 .getInterface(Ci.nsIWebNavigation)
81 .QueryInterface(Ci.nsIDocShellTreeItem)
83 .QueryInterface(Ci.nsIInterfaceRequestor)
86 getCurrentTabWindow = (window) ->
87 return window.gBrowser.selectedTab.linkedBrowser.contentWindow
89 blurActiveElement = (window) ->
90 # Only blur focusable elements, in order to interfere with the browser as
92 { activeElement } = window.document
93 if activeElement and activeElement.tabIndex > -1
96 isProperLink = (element) ->
97 return (element instanceof HTMLAnchorElement or
98 (element.ownerDocument instanceof XULDocument and
99 element.hasAttribute('href'))) and
100 not element.href.endsWith('#') and
101 not element.href.startsWith('javascript:')
103 isTextInputElement = (element) ->
104 return (element instanceof HTMLInputElement and element.type in [
105 'text', 'search', 'tel', 'url', 'email', 'password', 'number'
107 element instanceof HTMLTextAreaElement or
108 # `<select>` elements can also receive text input: You may type the
109 # text of an item to select it.
110 element instanceof HTMLSelectElement or
111 element instanceof XULMenuListElement or
112 element instanceof XULTextBoxElement
114 isContentEditable = (element) ->
115 return element.isContentEditable or
116 isGoogleEditable(element)
118 isGoogleEditable = (element) ->
119 # `g_editable` is a non-standard attribute commonly used by Google.
120 return element.getAttribute?('g_editable') == 'true' or
121 element.ownerDocument.body?.getAttribute('g_editable') == 'true'
123 isActivatable = (element) ->
124 return element instanceof HTMLAnchorElement or
125 element instanceof HTMLButtonElement or
126 (element instanceof HTMLInputElement and element.type in [
127 'button', 'submit', 'reset', 'image'
129 element instanceof XULButtonElement
131 isAdjustable = (element) ->
132 return element instanceof HTMLInputElement and element.type in [
133 'checkbox', 'radio', 'file', 'color'
134 'date', 'time', 'datetime', 'datetime-local', 'month', 'week'
136 element instanceof XULControlElement
139 Cc['@mozilla.org/browser/sessionstore;1'].getService(Ci.nsISessionStore)
142 sss = Cc['@mozilla.org/content/style-sheet-service;1']
143 .getService(Ci.nsIStyleSheetService)
145 uri = getResourceURI("resources/#{ name }.css")
146 # `AGENT_SHEET` is used to override userContent.css and Stylish. Custom
147 # website themes installed by users often make the hint markers unreadable,
148 # for example. Just using `!important` in the CSS is not enough.
149 unless sss.sheetRegistered(uri, sss.AGENT_SHEET)
150 sss.loadAndRegisterSheet(uri, sss.AGENT_SHEET)
153 sss.unregisterSheet(uri, sss.AGENT_SHEET)
156 # Store events that we’ve simulated. A `WeakMap` is used in order not to leak
157 # memory. This approach is better than for example setting `event.simulated =
158 # true`, since that tells the sites that the click was simulated, and allows
160 simulated_events = new WeakMap()
162 # Simulate mouse click with a full chain of events. ('command' is for XUL
164 eventSequence = ['mouseover', 'mousedown', 'mouseup', 'click', 'command']
165 simulateClick = (element) ->
166 window = element.ownerDocument.defaultView
167 for type in eventSequence
168 mouseEvent = new window.MouseEvent(type)
169 element.dispatchEvent(mouseEvent)
171 isEventSimulated = (event) ->
172 return simulated_events.has(event)
174 WHEEL_MODE_PIXEL = Ci.nsIDOMWheelEvent.DOM_DELTA_PIXEL
175 WHEEL_MODE_LINE = Ci.nsIDOMWheelEvent.DOM_DELTA_LINE
176 WHEEL_MODE_PAGE = Ci.nsIDOMWheelEvent.DOM_DELTA_PAGE
178 # Simulate mouse scroll event by specific offsets given that mouse cursor is at
179 # specified position.
180 simulateWheel = (window, deltaX, deltaY, mode = WHEEL_MODE_PIXEL) ->
182 .QueryInterface(Ci.nsIInterfaceRequestor)
183 .getInterface(Ci.nsIDOMWindowUtils)
185 [pX, pY] = [window.innerWidth / 2, window.innerHeight / 2]
186 windowUtils.sendWheelEvent(
187 pX, pY, # Window offset (x, y) in pixels.
188 deltaX, deltaY, 0, # Deltas (x, y, z).
189 mode, # Mode (pixel, line, page).
191 0, 0, # Line or Page deltas (x, y).
195 # Write a string to the system clipboard.
196 writeToClipboard = (text) ->
197 clipboardHelper = Cc['@mozilla.org/widget/clipboardhelper;1']
198 .getService(Ci.nsIClipboardHelper)
199 clipboardHelper.copyString(text)
201 # Executes function `func` and mearues how much time it took.
202 timeIt = (func, name) ->
205 console.timeEnd(name)
208 isBlacklisted = (str) ->
209 matchingRules = getMatchingBlacklistRules(str)
210 return (matchingRules.length != 0)
212 # Returns all blacklisted keys in matching rules.
213 getBlacklistedKeys = (str) ->
214 matchingRules = getMatchingBlacklistRules(str)
216 for rule in matchingRules when /##/.test(rule)
217 blacklistedKeys.push(x) for x in rule.split('##')[1].split('#')
218 return blacklistedKeys
220 # Returns all rules in the blacklist that match the provided string.
221 getMatchingBlacklistRules = (str) ->
222 return getBlacklist().filter((rule) ->
223 /// ^#{ simpleWildcards(rule.split('##')[0]) }$ ///i.test(str)
227 return splitListString(getPref('black_list'))
229 setBlacklist = (blacklist) ->
230 setPref('black_list', blacklist.join(','))
232 updateBlacklist = ({ add, remove } = {}) ->
233 blacklist = getBlacklist()
236 blacklist.push(splitListString(add)...)
238 blacklist = blacklist.filter((rule) -> rule != '')
239 blacklist = removeDuplicates(blacklist)
242 for rule in splitListString(remove) when rule in blacklist
243 blacklist.splice(blacklist.indexOf(rule), 1)
245 setBlacklist(blacklist)
247 # Splits a comma/space separated list into an array.
248 splitListString = (str) ->
249 return str.split(/\s*,[\s,]*/)
251 # Prepares a string to be used in a regexp, where "*" matches zero or more
252 # characters and "!" matches one character.
253 simpleWildcards = (string) ->
254 return regexpEscape(string).replace(/\\\*/g, '.*').replace(/!/g, '.')
256 # Returns the first element that matches a pattern, favoring earlier patterns.
257 # The patterns are case insensitive `simpleWildcards`s and must match either in
258 # the beginning or at the end of a string. Moreover, a pattern does not match
259 # in the middle of words, so "previous" does not match "previously". If that is
260 # desired, a pattern such as "previous*" can be used instead. Note: We cannot
261 # use `\b` word boundaries, because they don’t work well with non-English
262 # characters. Instead we match a space as word boundary. Therefore we normalize
263 # the whitespace and add spaces at the edges of the element text.
264 getBestPatternMatch = (patterns, attrs, elements) ->
266 for pattern in patterns
267 wildcarded = simpleWildcards(pattern)
268 regexps.push(/// ^\s(?:#{ wildcarded })\s | \s(?:#{ wildcarded })\s$ ///i)
270 # Helper function that matches a string against all the patterns.
272 normalizedText = " #{ text } ".replace(/\s+/g, ' ')
274 if re.test(normalizedText)
278 # First search in attributes (favoring earlier attributes) as it's likely
279 # that they are more specific than text contexts.
281 for element in elements
282 if matches(element.getAttribute(attr))
285 # Then search in element contents.
286 for element in elements
287 if matches(element.textContent)
292 # Get VimFx verion. AddonManager only provides async API to access addon data,
293 # so it's a bit tricky...
298 Cu.import('resource://gre/modules/AddonManager.jsm', scope)
299 scope.AddonManager.getAddonByID(ADDON_ID, (addon) -> version = addon.version)
304 parseHTML = (document, html) ->
305 parser = Cc['@mozilla.org/parserutils;1'].getService(Ci.nsIParserUtils)
306 flags = parser.SanitizerAllowStyle
307 return parser.parseFragment(html, flags, false, null,
308 document.documentElement)
312 .replace(/&/g, '&')
313 .replace(/</g, '<')
314 .replace(/>/g, '>')
315 .replace(/"/g, '"')
316 .replace(/'/g, ''')
318 createElement = (document, type, attributes = {}) ->
319 element = document.createElement(type)
321 for attribute, value of attributes
322 element.setAttribute(attribute, value)
324 if document instanceof HTMLDocument
325 element.classList.add('VimFxReset')
329 getAllElements = (document) -> switch
330 when document instanceof HTMLDocument
331 return document.getElementsByTagName('*')
332 when document instanceof XULDocument
334 getAllRegular = (element) ->
335 for child in element.getElementsByTagName('*')
337 getAllAnonymous(child)
339 getAllAnonymous = (element) ->
340 for child in document.getAnonymousNodes(element) or []
341 continue unless child instanceof Element
345 getAllRegular(document.documentElement)
350 url = Cc['@mozilla.org/network/io-service;1']
351 .getService(Ci.nsIIOService)
352 .newURI(str, null, null)
353 .QueryInterface(Ci.nsIURL)
358 # Use Firefox services to search for a given string.
359 browserSearchSubmission = (str) ->
360 ss = Cc['@mozilla.org/browser/search-service;1']
361 .getService(Ci.nsIBrowserSearchService)
363 engine = ss.currentEngine or ss.defaultEngine
364 return engine.getSubmission(str, null)
366 normalizedKey = (key) -> key.map(notation.normalize).join('')
368 # Get hint characters, convert them to lower case, and filter duplicates.
370 hintChars = getPref('hint_chars')
371 # Make sure that hint chars contain at least two characters.
372 if not hintChars or hintChars.length < 2
375 return removeDuplicateCharacters(hintChars)
377 # Remove duplicate characters from string (case insensitive).
378 removeDuplicateCharacters = (str) ->
379 return removeDuplicates( str.toLowerCase().split('') ).join('')
381 # Return URI to some file in the extension packaged as resource.
382 getResourceURI = do ->
383 baseURI = Services.io.newURI(__SCRIPT_URI_SPEC__, null, null)
384 return (path) -> return Services.io.newURI(path, null, baseURI)
386 # Escape a string to render it usable in regular expressions.
387 regexpEscape = (s) -> s and s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&')
389 removeDuplicates = (array) ->
390 # coffeelint: disable=no_backticks
391 return `[...new Set(array)]`
392 # coffeelint: enable=no_backticks
394 exports.Bucket = Bucket
395 exports.getEventWindow = getEventWindow
396 exports.getEventRootWindow = getEventRootWindow
397 exports.getEventCurrentTabWindow = getEventCurrentTabWindow
398 exports.getRootWindow = getRootWindow
399 exports.getCurrentTabWindow = getCurrentTabWindow
401 exports.blurActiveElement = blurActiveElement
402 exports.isProperLink = isProperLink
403 exports.isTextInputElement = isTextInputElement
404 exports.isContentEditable = isContentEditable
405 exports.isActivatable = isActivatable
406 exports.isAdjustable = isAdjustable
407 exports.getSessionStore = getSessionStore
409 exports.loadCss = loadCss
411 exports.simulateClick = simulateClick
412 exports.isEventSimulated = isEventSimulated
413 exports.simulateWheel = simulateWheel
414 exports.WHEEL_MODE_PIXEL = WHEEL_MODE_PIXEL
415 exports.WHEEL_MODE_LINE = WHEEL_MODE_LINE
416 exports.WHEEL_MODE_PAGE = WHEEL_MODE_PAGE
417 exports.writeToClipboard = writeToClipboard
418 exports.timeIt = timeIt
420 exports.getMatchingBlacklistRules = getMatchingBlacklistRules
421 exports.isBlacklisted = isBlacklisted
422 exports.getBlacklistedKeys = getBlacklistedKeys
423 exports.updateBlacklist = updateBlacklist
424 exports.splitListString = splitListString
425 exports.getBestPatternMatch = getBestPatternMatch
427 exports.getVersion = getVersion
428 exports.parseHTML = parseHTML
429 exports.escapeHTML = escapeHTML
430 exports.createElement = createElement
431 exports.getAllElements = getAllElements
432 exports.isURL = isURL
433 exports.browserSearchSubmission = browserSearchSubmission
434 exports.normalizedKey = normalizedKey
435 exports.getHintChars = getHintChars
436 exports.removeDuplicates = removeDuplicates
437 exports.removeDuplicateCharacters = removeDuplicateCharacters
438 exports.getResourceURI = getResourceURI
439 exports.ADDON_ID = ADDON_ID