1 /* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
3 * You can obtain one at http://mozilla.org/MPL/2.0/. */
7 const Ci = Components.interfaces;
8 const Cu = Components.utils;
12 Cu.import('resource://gre/modules/XPCOMUtils.jsm');
13 XPCOMUtils.defineLazyModuleGetter(this, 'Services',
14 'resource://gre/modules/Services.jsm');
15 XPCOMUtils.defineLazyModuleGetter(this, 'Utils',
16 'resource://gre/modules/accessibility/Utils.jsm');
17 XPCOMUtils.defineLazyModuleGetter(this, 'Logger',
18 'resource://gre/modules/accessibility/Utils.jsm');
19 XPCOMUtils.defineLazyModuleGetter(this, 'Presentation',
20 'resource://gre/modules/accessibility/Presentation.jsm');
21 XPCOMUtils.defineLazyModuleGetter(this, 'TraversalRules',
22 'resource://gre/modules/accessibility/TraversalRules.jsm');
23 XPCOMUtils.defineLazyModuleGetter(this, 'Roles',
24 'resource://gre/modules/accessibility/Constants.jsm');
25 XPCOMUtils.defineLazyModuleGetter(this, 'Events',
26 'resource://gre/modules/accessibility/Constants.jsm');
27 XPCOMUtils.defineLazyModuleGetter(this, 'States',
28 'resource://gre/modules/accessibility/Constants.jsm');
30 this.EXPORTED_SYMBOLS = ['EventManager'];
32 this.EventManager = function EventManager(aContentScope, aContentControl) {
33 this.contentScope = aContentScope;
34 this.contentControl = aContentControl;
35 this.addEventListener = this.contentScope.addEventListener.bind(
37 this.removeEventListener = this.contentScope.removeEventListener.bind(
39 this.sendMsgFunc = this.contentScope.sendAsyncMessage.bind(
41 this.webProgress = this.contentScope.docShell.
42 QueryInterface(Ci.nsIInterfaceRequestor).
43 getInterface(Ci.nsIWebProgress);
46 this.EventManager.prototype = {
47 editState: { editing: false },
49 start: function start() {
52 Logger.debug('EventManager.start');
56 AccessibilityEventObserver.addListener(this);
58 this.webProgress.addProgressListener(this,
59 (Ci.nsIWebProgress.NOTIFY_STATE_ALL |
60 Ci.nsIWebProgress.NOTIFY_LOCATION));
61 this.addEventListener('wheel', this, true);
62 this.addEventListener('scroll', this, true);
63 this.addEventListener('resize', this, true);
65 this.present(Presentation.tabStateChanged(null, 'newtab'));
68 Logger.logException(x, 'Failed to start EventManager');
72 // XXX: Stop is not called when the tab is closed (|TabClose| event is too
73 // late). It is only called when the AccessFu is disabled explicitly.
74 stop: function stop() {
78 Logger.debug('EventManager.stop');
79 AccessibilityEventObserver.removeListener(this);
81 this.webProgress.removeProgressListener(this);
82 this.removeEventListener('wheel', this, true);
83 this.removeEventListener('scroll', this, true);
84 this.removeEventListener('resize', this, true);
86 // contentScope is dead.
88 this._started = false;
92 handleEvent: function handleEvent(aEvent) {
94 return ['DOMEvent', aEvent.type];
98 switch (aEvent.type) {
102 let delta = aEvent.deltaX || aEvent.deltaY;
103 this.contentControl.autoMove(
105 { moveMethod: delta > 0 ? 'moveNext' : 'movePrevious',
106 onScreenOnly: true, noOpIfOnScreen: true, delay: 500 });
112 // the target could be an element, document or window
114 if (aEvent.target instanceof Ci.nsIDOMWindow)
115 window = aEvent.target;
116 else if (aEvent.target instanceof Ci.nsIDOMDocument)
117 window = aEvent.target.defaultView;
118 else if (aEvent.target instanceof Ci.nsIDOMElement)
119 window = aEvent.target.ownerDocument.defaultView;
120 this.present(Presentation.viewportChanged(window));
125 Logger.logException(x, 'Error handling DOM event');
129 handleAccEvent: function handleAccEvent(aEvent) {
131 return ['A11yEvent', Logger.eventToString(aEvent),
132 Logger.accessibleToString(aEvent.accessible)];
135 // Don't bother with non-content events in firefox.
136 if (Utils.MozBuildApp == 'browser' &&
137 aEvent.eventType != Events.VIRTUALCURSOR_CHANGED &&
138 // XXX Bug 442005 results in DocAccessible::getDocType returning
139 // NS_ERROR_FAILURE. Checking for aEvent.accessibleDocument.docType ==
140 // 'window' does not currently work.
141 (aEvent.accessibleDocument.DOMDocument.doctype &&
142 aEvent.accessibleDocument.DOMDocument.doctype.name === 'window')) {
146 switch (aEvent.eventType) {
147 case Events.VIRTUALCURSOR_CHANGED:
149 let pivot = aEvent.accessible.
150 QueryInterface(Ci.nsIAccessibleDocument).virtualCursor;
151 let position = pivot.position;
152 if (position && position.role == Roles.INTERNAL_FRAME)
155 QueryInterface(Ci.nsIAccessibleVirtualCursorChangeEvent);
156 let reason = event.reason;
157 let oldAccessible = event.oldAccessible;
159 if (this.editState.editing &&
160 !Utils.getState(position).contains(States.FOCUSED)) {
161 aEvent.accessibleDocument.takeFocus();
164 Presentation.pivotChanged(position, oldAccessible, reason,
165 pivot.startOffset, pivot.endOffset,
166 aEvent.isFromUserInput));
170 case Events.STATE_CHANGE:
172 let event = aEvent.QueryInterface(Ci.nsIAccessibleStateChangeEvent);
173 let state = Utils.getState(event);
174 if (state.contains(States.CHECKED)) {
177 actionInvoked(aEvent.accessible,
178 event.isEnabled ? 'check' : 'uncheck'));
179 } else if (state.contains(States.SELECTED)) {
182 actionInvoked(aEvent.accessible,
183 event.isEnabled ? 'select' : 'unselect'));
187 case Events.SCROLLING_START:
189 this.contentControl.autoMove(aEvent.accessible);
192 case Events.TEXT_CARET_MOVED:
194 let acc = aEvent.accessible.QueryInterface(Ci.nsIAccessibleText);
195 let caretOffset = aEvent.
196 QueryInterface(Ci.nsIAccessibleCaretMoveEvent).caretOffset;
198 // We could get a caret move in an accessible that is not focused,
199 // it doesn't mean we are not on any editable accessible. just not
201 let state = Utils.getState(acc);
202 if (state.contains(States.FOCUSED)) {
203 this._setEditingMode(aEvent, caretOffset);
204 if (state.contains(States.EDITABLE)) {
205 this.present(Presentation.textSelectionChanged(acc.getText(0, -1),
206 caretOffset, caretOffset, 0, 0, aEvent.isFromUserInput));
211 case Events.OBJECT_ATTRIBUTE_CHANGED:
213 let evt = aEvent.QueryInterface(
214 Ci.nsIAccessibleObjectAttributeChangedEvent);
215 if (evt.changedAttribute.toString() !== 'aria-hidden') {
216 // Only handle aria-hidden attribute change.
219 let hidden = Utils.isHidden(aEvent.accessible);
220 this[hidden ? '_handleHide' : '_handleShow'](evt);
222 this.sendMsgFunc("AccessFu:AriaHidden", { hidden: hidden });
228 this._handleShow(aEvent);
233 let evt = aEvent.QueryInterface(Ci.nsIAccessibleHideEvent);
234 this._handleHide(evt);
237 case Events.TEXT_INSERTED:
238 case Events.TEXT_REMOVED:
240 let {liveRegion, isPolite} = this._handleLiveRegion(aEvent,
242 if (aEvent.isFromUserInput || liveRegion) {
243 // Handle all text mutations coming from the user or if they happen
245 this._handleText(aEvent, liveRegion, isPolite);
251 // Put vc where the focus is at
252 let acc = aEvent.accessible;
253 let doc = aEvent.accessibleDocument;
254 this._setEditingMode(aEvent);
255 if ([Roles.CHROME_WINDOW,
257 Roles.APPLICATION].indexOf(acc.role) < 0) {
258 this.contentControl.autoMove(acc);
262 this.sendMsgFunc("AccessFu:Focused");
266 case Events.DOCUMENT_LOAD_COMPLETE:
268 let position = this.contentControl.vc.position;
269 if (aEvent.accessible === aEvent.accessibleDocument ||
270 (position && Utils.isInSubtree(position, aEvent.accessible))) {
271 // Do not automove into the document if the virtual cursor is already
272 // positioned inside it.
275 this.contentControl.autoMove(
276 aEvent.accessible, { delay: 500 });
279 case Events.VALUE_CHANGE:
281 let position = this.contentControl.vc.position;
282 let target = aEvent.accessible;
283 if (position === target ||
284 Utils.getEmbeddedControl(position) === target) {
285 this.present(Presentation.valueChanged(target));
291 _setEditingMode: function _setEditingMode(aEvent, aCaretOffset) {
292 let acc = aEvent.accessible;
293 let accText, characterCount;
294 let caretOffset = aCaretOffset;
297 accText = acc.QueryInterface(Ci.nsIAccessibleText);
299 // No text interface on this accessible.
303 characterCount = accText.characterCount;
304 if (caretOffset === undefined) {
305 caretOffset = accText.caretOffset;
309 // Update editing state, both for presenter and other things
310 let state = Utils.getState(acc);
313 editing: state.contains(States.EDITABLE) &&
314 state.contains(States.FOCUSED),
315 multiline: state.contains(States.MULTI_LINE),
316 atStart: caretOffset === 0,
317 atEnd: caretOffset === characterCount
321 if (!editState.editing && editState.editing === this.editState.editing) {
325 if (editState.editing !== this.editState.editing) {
326 this.present(Presentation.editingModeChanged(editState.editing));
329 if (editState.editing !== this.editState.editing ||
330 editState.multiline !== this.editState.multiline ||
331 editState.atEnd !== this.editState.atEnd ||
332 editState.atStart !== this.editState.atStart) {
333 this.sendMsgFunc("AccessFu:Input", editState);
336 this.editState = editState;
339 _handleShow: function _handleShow(aEvent) {
340 let {liveRegion, isPolite} = this._handleLiveRegion(aEvent,
341 ['additions', 'all']);
342 // Only handle show if it is a relevant live region.
346 // Show for text is handled by the EVENT_TEXT_INSERTED handler.
347 if (aEvent.accessible.role === Roles.TEXT_LEAF) {
350 this._dequeueLiveEvent(Events.HIDE, liveRegion);
351 this.present(Presentation.liveRegion(liveRegion, isPolite, false));
354 _handleHide: function _handleHide(aEvent) {
355 let {liveRegion, isPolite} = this._handleLiveRegion(
356 aEvent, ['removals', 'all']);
357 let acc = aEvent.accessible;
359 // Hide for text is handled by the EVENT_TEXT_REMOVED handler.
360 if (acc.role === Roles.TEXT_LEAF) {
363 this._queueLiveEvent(Events.HIDE, liveRegion, isPolite);
365 let vc = Utils.getVirtualCursor(this.contentScope.content.document);
367 (Utils.getState(vc.position).contains(States.DEFUNCT) ||
368 Utils.isInSubtree(vc.position, acc))) {
369 let position = aEvent.targetPrevSibling || aEvent.targetParent;
372 position = acc.previousSibling;
374 // Accessible is unattached from the accessible tree.
375 position = acc.parent;
378 this.contentControl.autoMove(position,
379 { moveToFocused: true, delay: 500 });
384 _handleText: function _handleText(aEvent, aLiveRegion, aIsPolite) {
385 let event = aEvent.QueryInterface(Ci.nsIAccessibleTextChangeEvent);
386 let isInserted = event.isInserted;
387 let txtIface = aEvent.accessible.QueryInterface(Ci.nsIAccessibleText);
391 text = txtIface.getText(0, Ci.nsIAccessibleText.TEXT_OFFSET_END_OF_TEXT);
393 // XXX we might have gotten an exception with of a
394 // zero-length text. If we did, ignore it (bug #749810).
395 if (txtIface.characterCount) {
399 // If there are embedded objects in the text, ignore them.
400 // Assuming changes to the descendants would already be handled by the
402 let modifiedText = event.modifiedText.replace(/\uFFFC/g, '').trim();
407 if (aEvent.eventType === Events.TEXT_REMOVED) {
408 this._queueLiveEvent(Events.TEXT_REMOVED, aLiveRegion, aIsPolite,
411 this._dequeueLiveEvent(Events.TEXT_REMOVED, aLiveRegion);
412 this.present(Presentation.liveRegion(aLiveRegion, aIsPolite, false,
416 this.present(Presentation.textChanged(isInserted, event.start,
417 event.length, text, modifiedText));
421 _handleLiveRegion: function _handleLiveRegion(aEvent, aRelevant) {
422 if (aEvent.isFromUserInput) {
425 let parseLiveAttrs = function parseLiveAttrs(aAccessible) {
426 let attrs = Utils.getAttributes(aAccessible);
427 if (attrs['container-live']) {
429 live: attrs['container-live'],
430 relevant: attrs['container-relevant'] || 'additions text',
431 busy: attrs['container-busy'],
432 atomic: attrs['container-atomic'],
433 memberOf: attrs['member-of']
438 // XXX live attributes are not set for hidden accessibles yet. Need to
439 // climb up the tree to check for them.
440 let getLiveAttributes = function getLiveAttributes(aEvent) {
441 let liveAttrs = parseLiveAttrs(aEvent.accessible);
445 let parent = aEvent.targetParent;
447 liveAttrs = parseLiveAttrs(parent);
451 parent = parent.parent
455 let {live, relevant, busy, atomic, memberOf} = getLiveAttributes(aEvent);
456 // If container-live is not present or is set to |off| ignore the event.
457 if (!live || live === 'off') {
460 // XXX: support busy and atomic.
462 // Determine if the type of the mutation is relevant. Default is additions
464 let isRelevant = Utils.matchAttributeValue(relevant, aRelevant);
469 liveRegion: aEvent.accessible,
470 isPolite: live === 'polite'
474 _dequeueLiveEvent: function _dequeueLiveEvent(aEventType, aLiveRegion) {
475 let domNode = aLiveRegion.DOMNode;
476 if (this._liveEventQueue && this._liveEventQueue.has(domNode)) {
477 let queue = this._liveEventQueue.get(domNode);
478 let nextEvent = queue[0];
479 if (nextEvent.eventType === aEventType) {
480 Utils.win.clearTimeout(nextEvent.timeoutID);
482 if (queue.length === 0) {
483 this._liveEventQueue.delete(domNode)
489 _queueLiveEvent: function _queueLiveEvent(aEventType, aLiveRegion, aIsPolite, aModifiedText) {
490 if (!this._liveEventQueue) {
491 this._liveEventQueue = new WeakMap();
494 eventType: aEventType,
495 timeoutID: Utils.win.setTimeout(this.present.bind(this),
496 20, // Wait for a possible EVENT_SHOW or EVENT_TEXT_INSERTED event.
497 Presentation.liveRegion(aLiveRegion, aIsPolite, true, aModifiedText))
500 let domNode = aLiveRegion.DOMNode;
501 if (this._liveEventQueue.has(domNode)) {
502 this._liveEventQueue.get(domNode).push(eventHandler);
504 this._liveEventQueue.set(domNode, [eventHandler]);
508 present: function present(aPresentationData) {
509 this.sendMsgFunc("AccessFu:Present", aPresentationData);
512 onStateChange: function onStateChange(aWebProgress, aRequest, aStateFlags, aStatus) {
515 let loadingState = Ci.nsIWebProgressListener.STATE_TRANSFERRING |
516 Ci.nsIWebProgressListener.STATE_IS_DOCUMENT;
517 let loadedState = Ci.nsIWebProgressListener.STATE_STOP |
518 Ci.nsIWebProgressListener.STATE_IS_NETWORK;
520 if ((aStateFlags & loadingState) == loadingState) {
521 tabstate = 'loading';
522 } else if ((aStateFlags & loadedState) == loadedState &&
523 !aWebProgress.isLoadingDocument) {
528 let docAcc = Utils.AccRetrieval.getAccessibleFor(aWebProgress.DOMWindow.document);
529 this.present(Presentation.tabStateChanged(docAcc, tabstate));
533 onProgressChange: function onProgressChange() {},
535 onLocationChange: function onLocationChange(aWebProgress, aRequest, aLocation, aFlags) {
536 let docAcc = Utils.AccRetrieval.getAccessibleFor(aWebProgress.DOMWindow.document);
537 this.present(Presentation.tabStateChanged(docAcc, 'newdoc'));
540 onStatusChange: function onStatusChange() {},
542 onSecurityChange: function onSecurityChange() {},
544 QueryInterface: XPCOMUtils.generateQI([Ci.nsIWebProgressListener,
545 Ci.nsISupportsWeakReference,
550 const AccessibilityEventObserver = {
553 * A WeakMap containing [content, EventManager] pairs.
555 eventManagers: new WeakMap(),
558 * A total number of registered eventManagers.
563 * An indicator of an active 'accessible-event' observer.
568 * Start an AccessibilityEventObserver.
570 start: function start() {
571 if (this.started || this.listenerCount === 0) {
574 Services.obs.addObserver(this, 'accessible-event', false);
579 * Stop an AccessibilityEventObserver.
581 stop: function stop() {
585 Services.obs.removeObserver(this, 'accessible-event');
586 // Clean up all registered event managers.
587 this.eventManagers.clear();
588 this.listenerCount = 0;
589 this.started = false;
593 * Register an EventManager and start listening to the
594 * 'accessible-event' messages.
596 * @param aEventManager EventManager
597 * An EventManager object that was loaded into the specific content.
599 addListener: function addListener(aEventManager) {
600 let content = aEventManager.contentScope.content;
601 if (!this.eventManagers.has(content)) {
602 this.listenerCount++;
604 this.eventManagers.set(content, aEventManager);
605 // Since at least one EventManager was registered, start listening.
606 Logger.debug('AccessibilityEventObserver.addListener. Total:',
612 * Unregister an EventManager and, optionally, stop listening to the
613 * 'accessible-event' messages.
615 * @param aEventManager EventManager
616 * An EventManager object that was stopped in the specific content.
618 removeListener: function removeListener(aEventManager) {
619 let content = aEventManager.contentScope.content;
620 if (!this.eventManagers.delete(content)) {
623 this.listenerCount--;
624 Logger.debug('AccessibilityEventObserver.removeListener. Total:',
626 if (this.listenerCount === 0) {
627 // If there are no EventManagers registered at the moment, stop listening
628 // to the 'accessible-event' messages.
634 * Lookup an EventManager for a specific content. If the EventManager is not
635 * found, walk up the hierarchy of parent windows.
636 * @param content Window
637 * A content Window used to lookup the corresponding EventManager.
639 getListener: function getListener(content) {
640 let eventManager = this.eventManagers.get(content);
644 let parent = content.parent;
645 if (parent === content) {
646 // There is no parent or the parent is of a different type.
649 return this.getListener(parent);
653 * Handle the 'accessible-event' message.
655 observe: function observe(aSubject, aTopic, aData) {
656 if (aTopic !== 'accessible-event') {
659 let event = aSubject.QueryInterface(Ci.nsIAccessibleEvent);
660 if (!event.accessibleDocument) {
662 'AccessibilityEventObserver.observe: no accessible document:',
663 Logger.eventToString(event), "accessible:",
664 Logger.accessibleToString(event.accessible));
667 let content = event.accessibleDocument.window;
668 // Match the content window to its EventManager.
669 let eventManager = this.getListener(content);
670 if (!eventManager || !eventManager._started) {
671 if (Utils.MozBuildApp === 'browser' &&
672 !(content instanceof Ci.nsIDOMChromeWindow)) {
674 'AccessibilityEventObserver.observe: ignored event:',
675 Logger.eventToString(event), "accessible:",
676 Logger.accessibleToString(event.accessible), "document:",
677 Logger.accessibleToString(event.accessibleDocument));
682 eventManager.handleAccEvent(event);
684 Logger.logException(x, 'Error handing accessible event');