Recovery: Implement focus recovery across root AutomationNodes

chrome/browser/resources/chromeos/chromevox/cvox2/background/background.js

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * @fileoverview The entry point for all ChromeVox2 related code for the
  * background page.
  */
 
 goog.provide('Background');
@@ skipping 136 matching lines @@
 
   /**
    * Stores the mode as computed the last time a current range was set.
    * @type {?ChromeVoxMode}
    * @private
    */
   this.mode_ = null;
 
   chrome.accessibilityPrivate.onAccessibilityGesture.addListener(
       this.onAccessibilityGesture_);
+
+  /**
+   * @type {WeakMap<AutomationNode>}

[dmazzoni, 2016/10/11 17:41:18]

I think it should be WeakMap<AutomationNode, AutomationNode>, right?

Please document the meaning of the key and value in the map

[David Tseng, 2016/10/11 21:24:32]

Yup; you're right.
Done (Closure doesn't seem to care either way).

+   * @private
+   */
+  this.focusRecoveryMap_ = new WeakMap();
 };
 
 /**
  * @const {string}
  */
 Background.ISSUE_URL = 'https://code.google.com/p/chromium/issues/entry?' +
     'labels=Type-Bug,Pri-2,cvox2,OS-Chrome&' +
     'components=UI>accessibility&' +
     'description=';
 
@@ skipping 24 matching lines @@
   'swipeUp1': 'previousLine',
   'swipeDown1': 'nextLine',
   'swipeLeft1': 'previousObject',
   'swipeRight1': 'nextObject',
   'swipeUp2': 'jumpToTop',
   'swipeDown2': 'readFromHere',
 };
 
 Background.prototype = {
   __proto__: ChromeVoxState.prototype,
+  /**
+   * Maps the last node with range in a given root.
+   * @type {WeakMap<AutomationNode>}
+   */
+  get focusRecoveryMap() {
+    return this.focusRecoveryMap_;
+  },
 
   /**
    * @override
    */
   getMode: function() {
     if (localStorage['useNext'] == 'true')
       return ChromeVoxMode.FORCE_NEXT;
 
     var target;
     if (!this.getCurrentRange()) {
@@ skipping 426 matching lines @@
         } else if (action == 'onCommand') {
           CommandHandler.onCommand(msg['command']);
         } else if (action == 'flushNextUtterance') {
           Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
         }
         break;
     }
   },
 
   /**
-   * Restore the range to the last range that was *not* in the ChromeVox
-   * panel. This is used when the ChromeVox Panel closes.
-   * @param {function()=} opt_callback
-   * @private
+   * Save the current ChromeVox range.
    */
-  restoreCurrentRange_: function(opt_callback) {
-    if (this.savedRange_) {
-      var node = this.savedRange_.start.node;
-      var containingWebView = node;
-      while (containingWebView && containingWebView.role != RoleType.webView)
-        containingWebView = containingWebView.parent;
+  markCurrentRange: function() {
+    if (!this.currentRange)
+      return;
 
-      if (containingWebView) {
-        // Focusing the webView causes a focus change event which steals focus
-        // away from the saved range.
-        var saved = this.savedRange_;
-        var setSavedRange = function(e) {
-          if (e.target.root == saved.start.node.root) {
-          this.navigateToRange(saved, false);
-          opt_callback && opt_callback();
-        }
-          node.root.removeEventListener(EventType.focus, setSavedRange, true);
-        }.bind(this);
-        node.root.addEventListener(EventType.focus, setSavedRange, true);
-        containingWebView.focus();
-      }
-      this.navigateToRange(this.savedRange_);
-      this.savedRange_ = null;
-    }
+    var root = AutomationUtil.getTopLevelRoot(this.currentRange.start.node);
+    if (root)
+      this.focusRecoveryMap_.set(root, this.currentRange.start.node);

[dmazzoni, 2016/10/11 17:41:18]

Why not store and recover the whole range?

[David Tseng, 2016/10/11 21:24:32]

Done.

   },
 
   /**
-   * Move ChromeVox without saving any ranges.
-   */
-  startExcursion: function() {
-    this.inExcursion_ = true;
-  },
-
-  /**
-   * Move ChromeVox back to the last saved range.
-   * @param {function()=} opt_callback Called when range has been restored.
-   */
-  endExcursion: function(opt_callback) {
-    this.inExcursion_ = false;
-    this.restoreCurrentRange_(opt_callback);
-  },
-
-  /**
-   * Move ChromeVox back to the last saved range.
-   */
-  saveExcursion: function() {
-    this.savedRange_ =
-        new cursors.Range(this.currentRange_.start, this.currentRange_.end);
-  },
-
-  /**
    * Handles accessibility gestures from the touch screen.
    * @param {string} gesture The gesture to handle, based on the AXGesture enum
    *     defined in ui/accessibility/ax_enums.idl
    * @private
    */
   onAccessibilityGesture_: function(gesture) {
     // If we're in classic mode, some gestures need to be handled by the
     // content script. Other gestures are universal and will be handled in
     // this function.
     if (this.mode == ChromeVoxMode.CLASSIC) {
@@ skipping 49 matching lines @@
   return new RegExp('^(' + globs.map(function(glob) {
     return glob.replace(/[.+^$(){}|[\]\\]/g, '\\$&')
         .replace(/\*/g, '.*')
         .replace(/\?/g, '.');
   }).join('|') + ')$');
 };
 
 new Background();
 
 });  // goog.scope