Revert "Remove |mode| from ChromeVox"

This reverts commit 613ce4af.

Reason for revert: Breaks linux-chromeos-dbg bot (https://ci.chromium.org/buildbot/chromium.chromiumos/linux-chromeos-dbg/3205)

Original change's description:
> Remove |mode| from ChromeVox
> 
> ChromeVox Classic is no longer available to users.
> This allows us to remove some complexity surrounding the idea of the various modes for ChromeVox (classic, next, etc).
> 
> This change mostly is meant to be cleanup, but it also addresses some bugs. Namely, we unintentionally relied upon onModeChanged to trigger specific behaviors such as installing command handlers. This made sense when mode changes had to be supported. However, with this in a limbo state now that there is no classic mode, we can no longer invoke commands with an empty desktop.
> 
> 
> Bug: 
> Cq-Include-Trybots: master.tryserver.chromium.linux:closure_compilation
> Change-Id: Ic9270ab7e3cc3ba734f21bc84c00738bb0d43e56
> Reviewed-on: https://chromium-review.googlesource.com/825169
> Commit-Queue: David Tseng <dtseng@chromium.org>
> Reviewed-by: Dominic Mazzoni <dmazzoni@chromium.org>
> Cr-Commit-Position: refs/heads/master@{#524343}

TBR=dmazzoni@chromium.org,dtseng@chromium.org

Change-Id: Ic60ba55115d1788dd392fde31997beee13f5fe3f
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Cq-Include-Trybots: master.tryserver.chromium.linux:closure_compilation
Reviewed-on: https://chromium-review.googlesource.com/828735Reviewed-by: Henrik Grunell <grunell@chromium.org>
Commit-Queue: Henrik Grunell <grunell@chromium.org>
Cr-Commit-Position: refs/heads/master@{#524358}

chrome/browser/resources/chromeos/chromevox/BUILD.gn

@@ -148,6 +148,7 @@ chromevox_modules = [
   "cvox2/background/panel_menu.js",
   "cvox2/background/panel_menu_item.js",
   "cvox2/background/recovery_strategy.js",
+  "cvox2/background/tabs_automation_handler.js",
   "cvox2/background/tree_walker.js",
   "cvox2/background/tutorial.js",
   "cvox2/injected/keyboard_handler.js",

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

@@ -9,6 +9,7 @@
 
 goog.provide('cvox.TabsApiHandler');
 
+goog.require('TabsAutomationHandler');
 goog.require('cvox.AbstractEarcons');
 goog.require('cvox.AbstractTts');
 goog.require('cvox.BrailleInterface');
@@ -72,6 +73,9 @@ cvox.TabsApiHandler.prototype = {
           cvox.NavBraille.fromText(this.msg_('chrome_tab_created')));
     }
     cvox.ChromeVox.earcons.playEarcon(cvox.Earcon.OBJECT_OPEN);
+    if (tab) {
+      this.refreshAutomationHandler_(tab.id);
+    }
   },
 
   /**
@@ -111,6 +115,7 @@ cvox.TabsApiHandler.prototype = {
             this.msg_('chrome_tab_selected', [title])));
       }
       cvox.ChromeVox.earcons.playEarcon(cvox.Earcon.OBJECT_SELECT);
+      this.refreshAutomationHandler_(tab.id);
     }.bind(this));
   },
 
@@ -156,6 +161,7 @@ cvox.TabsApiHandler.prototype = {
         cvox.ChromeVox.earcons.playEarcon(cvox.Earcon.PAGE_FINISH_LOADING);
         this.cancelPageLoadTimer_();
       }
+      this.refreshAutomationHandler_(tabId);
     }.bind(this));
   },
 
@@ -187,10 +193,29 @@ cvox.TabsApiHandler.prototype = {
               cvox.NavBraille.fromText(this.msg_(msgId, [title])));
         }
         cvox.ChromeVox.earcons.playEarcon(cvox.Earcon.OBJECT_SELECT);
+        this.refreshAutomationHandler_(tab.id);
       }.bind(this));
     }.bind(this));
   },
 
+  /**
+   * Installs a new automation handler for the given tab.
+   * @param {number} tabId
+   * @private
+   */
+  refreshAutomationHandler_: function(tabId) {
+    if (!cvox.ChromeVox.isMac ||
+        ChromeVoxState.instance.mode == ChromeVoxMode.CLASSIC)
+      return;
+
+    chrome.automation.getTree(tabId, function(node) {
+      if (this.handler_)
+        this.handler_.removeAllListeners();
+
+      this.handler_ = new TabsAutomationHandler(node);
+    }.bind(this));
+  },
+
   /**
    * The chrome.tabs API doesn't always fire an onUpdated event when a
    * page finishes loading, so we poll it.

chrome/browser/resources/chromeos/chromevox/cvox2/background/background_test.extjs

@@ -25,6 +25,8 @@ BackgroundTest.prototype = {
     window.RoleType = chrome.automation.RoleType;
     window.doCmd = this.doCmd;
 
+    // Reset notifications so only explicit mode changes can cause them to trigger.
+    Notifications.reset();
     this.forceContextualLastOutput();
   },
 
@@ -512,6 +514,78 @@ TEST_F('BackgroundTest', 'DISABLED_ActiveOrInactive', function() {
     });
 });
 
+TEST_F('BackgroundTest', 'ModeSwitching', function() {
+  this.runWithLoadedTree('<button></button>', function(root) {
+    var fakeDesktop = {};
+    fakeDesktop.role = 'desktop';
+    fakeDesktop.root = fakeDesktop;
+
+    var fakeWebRoot = {};
+    fakeWebRoot.root = fakeWebRoot;
+    fakeWebRoot.parent = fakeDesktop;
+    fakeWebRoot.role = RoleType.ROOT_WEB_AREA;
+    fakeWebRoot.makeVisible = function() {};
+    fakeWebRoot.unclippedLocation = {left: 1, top: 1, width: 1, height: 1};
+    var fakeSubRoot = {};
+    fakeSubRoot.root = fakeSubRoot;
+    fakeSubRoot.parent = fakeWebRoot;
+    fakeSubRoot.role = RoleType.ROOT_WEB_AREA;
+    fakeSubRoot.makeVisible = function() {};
+    fakeSubRoot.unclippedLocation = {left: 1, top: 1, width: 1, height: 1};
+    var bk = ChromeVoxState.instance;
+
+    // Tests default to force next mode.
+    assertEquals('force_next', bk.mode);
+
+    // Force next mode stays set regardless of where the range lands.
+    fakeWebRoot.docUrl = 'http://google.com';
+    bk.setCurrentRange(cursors.Range.fromNode(fakeWebRoot));
+    assertEquals('force_next', bk.mode);
+    // Empty urls occur before document load or when root is desktop.
+    fakeWebRoot.docUrl = '';
+    bk.setCurrentRange(cursors.Range.fromNode(fakeWebRoot));
+    assertEquals('force_next', bk.mode);
+
+    // Verify force next -> classic compat switching.
+    localStorage['useClassic'] = true;
+    fakeWebRoot.docUrl = 'chrome://foobar';
+    bk.setCurrentRange(cursors.Range.fromNode(fakeWebRoot));
+    assertEquals('classic_compat', bk.mode);
+
+    // Classic compat -> classic.
+    fakeWebRoot.docUrl = 'http://google.com';
+    bk.setCurrentRange(cursors.Range.fromNode(fakeWebRoot));
+    assertEquals('classic', bk.mode);
+
+    // Ensure we switch to classic compat if our current range has focused
+    // state set and is not in web content.
+    assertTrue(root.parent.state.focused);
+    bk.setCurrentRange(cursors.Range.fromNode(root.parent));
+    assertEquals('classic_compat', bk.mode);
+
+    // And back to classic.
+    bk.setCurrentRange(cursors.Range.fromNode(root));
+    assertEquals('classic', bk.mode);
+
+    // Now, verify mode switching uses the top level root.
+    fakeWebRoot.docUrl = 'http://google.com/#chromevox_next_test';
+    fakeSubRoot.docUrl = 'http://chromevox.com';
+    bk.setCurrentRange(cursors.Range.fromNode(fakeWebRoot));
+    assertEquals('next', bk.mode);
+
+    // Next compat switching.
+    localStorage['useClassic'] = false;
+    fakeWebRoot.docUrl = 'http://docs.google.com/document/#123123';
+    bk.setCurrentRange(cursors.Range.fromNode(fakeWebRoot));
+    assertEquals('force_next', bk.mode);
+
+    // And, back to force next.
+    fakeWebRoot.docUrl = 'http://docs.google.com/form/123';
+    bk.setCurrentRange(cursors.Range.fromNode(fakeWebRoot));
+    assertEquals('force_next', bk.mode);
+  }.bind(this));
+});
+
 TEST_F('BackgroundTest', 'ShouldNotFocusIframe', function() {
   this.runWithLoadedTree(  function() {/*!
     <iframe tabindex=0 src="data:text/html,<p>Inside</p>"></iframe>

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

@@ -8,12 +8,24 @@
  *     object and to facilitate mocking for tests.
  */
 
+goog.provide('ChromeVoxMode');
 goog.provide('ChromeVoxState');
 goog.provide('ChromeVoxStateObserver');
 
 goog.require('cursors.Cursor');
 goog.require('cursors.Range');
 
+/**
+ * All possible modes ChromeVox can run.
+ * @enum {string}
+ */
+ChromeVoxMode = {
+  CLASSIC: 'classic',
+  CLASSIC_COMPAT: 'classic_compat',
+  NEXT: 'next',
+  FORCE_NEXT: 'force_next'
+};
+
 /**
  * An interface implemented by objects that want to observe ChromeVox state
  * changes.
@@ -55,6 +67,19 @@ ChromeVoxState.backgroundTts;
 ChromeVoxState.isReadingContinuously;
 
 ChromeVoxState.prototype = {
+  /** @type {ChromeVoxMode} */
+  get mode() {
+    return this.getMode();
+  },
+
+  /**
+   * @return {ChromeVoxMode} The current mode.
+   * @protected
+   */
+  getMode: function() {
+    return ChromeVoxMode.NEXT;
+  },
+
   /** @type {cursors.Range} */
   get currentRange() {
     return this.getCurrentRange();

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

@@ -12,7 +12,6 @@ goog.require('ChromeVoxState');
 goog.require('CustomAutomationEvent');
 goog.require('Output');
 goog.require('cvox.ChromeVoxBackground');
-goog.require('cvox.ChromeVoxKbHandler');
 
 goog.scope(function() {
 var AutomationEvent = chrome.automation.AutomationEvent;
@@ -40,7 +39,7 @@ CommandHandler.onCommand = function(command) {
       ChromeVoxState.instance.setCurrentRange(null);
   });
 
-  // These commands don't require a current range.
+  // These commands don't require a current range and work in all modes.
   switch (command) {
     case 'speakTimeAndDate':
       chrome.automation.getDesktop(function(d) {
@@ -238,6 +237,10 @@ CommandHandler.onCommand = function(command) {
   if (!ChromeVoxState.instance.currentRange_)
     return true;
 
+  // Next/classic compat commands hereafter.
+  if (ChromeVoxState.instance.mode == ChromeVoxMode.CLASSIC)
+    return true;
+
   var current = ChromeVoxState.instance.currentRange_;
   var dir = Dir.FORWARD;
   var pred = null;
@@ -809,6 +812,24 @@ CommandHandler.onCommand = function(command) {
   return false;
 };
 
+/**
+ * React to mode changes.
+ * @param {ChromeVoxMode} newMode
+ * @param {ChromeVoxMode?} oldMode
+ */
+CommandHandler.onModeChanged = function(newMode, oldMode) {
+  // Previously uninitialized.
+  if (!oldMode)
+    cvox.ChromeVoxKbHandler.commandHandler = CommandHandler.onCommand;
+
+  var hasListener =
+      chrome.commands.onCommand.hasListener(CommandHandler.onCommand);
+  if (newMode == ChromeVoxMode.CLASSIC && hasListener)
+    chrome.commands.onCommand.removeListener(CommandHandler.onCommand);
+  else if (newMode == ChromeVoxMode.CLASSIC && !hasListener)
+    chrome.commands.onCommand.addListener(CommandHandler.onCommand);
+};
+
 /**
  * Increase or decrease a speech property and make an announcement.
  * @param {string} propertyName The name of the property to change.
@@ -906,9 +927,9 @@ CommandHandler.viewGraphicAsBraille_ = function(current) {
 
 /**
  * Performs global initialization.
+ * @private
  */
-CommandHandler.init = function() {
-  cvox.ChromeVoxKbHandler.commandHandler = CommandHandler.onCommand;
+CommandHandler.init_ = function() {
   var firstRunId = 'jdgcneonijmofocbhmijhacgchbihela';
   chrome.runtime.onMessageExternal.addListener(function(
       request, sender, sendResponse) {
@@ -934,4 +955,6 @@ CommandHandler.init = function() {
   });
 };
 
+CommandHandler.init_();
+
 });  //  goog.scope

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

@@ -81,6 +81,9 @@ DesktopAutomationHandler = function(node) {
   AutomationObjectConstructorInstaller.init(node, function() {
     chrome.automation.getFocus(
         (function(focus) {
+          if (ChromeVoxState.instance.mode != ChromeVoxMode.FORCE_NEXT)
+            return;
+
           if (focus) {
             var event =
                 new CustomAutomationEvent(EventType.FOCUS, focus, 'page');
@@ -134,6 +137,9 @@ DesktopAutomationHandler.prototype = {
 
     ChromeVoxState.instance.setCurrentRange(cursors.Range.fromNode(node));
 
+    if (!this.shouldOutput_(evt))
+      return;
+
     // Don't output if focused node hasn't changed.
     if (prevRange && evt.type == 'focus' &&
         ChromeVoxState.instance.currentRange.equals(prevRange))
@@ -156,6 +162,9 @@ DesktopAutomationHandler.prototype = {
    * @param {!AutomationEvent} evt
    */
   onEventIfInRange: function(evt) {
+    if (!this.shouldOutput_(evt))
+      return;
+
     var prev = ChromeVoxState.instance.currentRange;
     if (prev.contentEquals(cursors.Range.fromNode(evt.target)) ||
         evt.target.state.focused) {
@@ -236,6 +245,9 @@ DesktopAutomationHandler.prototype = {
    */
   onAlert: function(evt) {
     var node = evt.target;
+    if (!node || !this.shouldOutput_(evt))
+      return;
+
     var range = cursors.Range.fromNode(node);
 
     new Output().withSpeechAndBraille(range, null, evt.type).go();
@@ -267,6 +279,9 @@ DesktopAutomationHandler.prototype = {
    * @param {!AutomationEvent} evt
    */
   onChildrenChanged: function(evt) {
+    if (!this.shouldOutput_(evt))
+      return;
+
     var curRange = ChromeVoxState.instance.currentRange;
 
     // Always refresh the braille contents.
@@ -403,6 +418,9 @@ DesktopAutomationHandler.prototype = {
       return;
     }
 
+    if (!this.shouldOutput_(evt))
+      return;
+
     var t = evt.target;
     var fromDesktop = t.root.role == RoleType.DESKTOP;
     if (t.state.focused || fromDesktop ||
@@ -436,7 +454,7 @@ DesktopAutomationHandler.prototype = {
    */
   onScrollPositionChanged: function(evt) {
     var currentRange = ChromeVoxState.instance.currentRange;
-    if (currentRange && currentRange.isValid())
+    if (currentRange && currentRange.isValid() && this.shouldOutput_(evt))
       new Output().withLocation(currentRange, null, evt.type).go();
   },
 
@@ -540,6 +558,19 @@ DesktopAutomationHandler.prototype = {
     return !!this.textEditHandler_;
   },
 
+  /**
+   * Once an event handler updates ChromeVox's range based on |evt|
+   * which updates mode, returns whether |evt| should be outputted.
+   * @return {boolean}
+   */
+  shouldOutput_: function(evt) {
+    var mode = ChromeVoxState.instance.mode;
+    // Only output desktop rooted nodes or web nodes for next engine modes.
+    return evt.target.root.role == RoleType.DESKTOP ||
+        (mode == ChromeVoxMode.NEXT || mode == ChromeVoxMode.FORCE_NEXT ||
+         mode == ChromeVoxMode.CLASSIC_COMPAT);
+  },
+
   /**
    * @param {AutomationEvent} evt
    * @private
@@ -580,6 +611,8 @@ DesktopAutomationHandler.prototype = {
       }
 
       ChromeVoxState.instance.setCurrentRange(cursors.Range.fromNode(focus));
+      if (!this.shouldOutput_(evt))
+        return;
 
       Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
       o.withRichSpeechAndBraille(

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

@@ -11,10 +11,24 @@ goog.require('Output');
 goog.scope(function() {
 var TreeChangeObserverFilter = chrome.automation.TreeChangeObserverFilter;
 
+/**
+ * Responds to mode changes.
+ * @param {ChromeVoxMode} newMode
+ * @param {?ChromeVoxMode} oldMode Can be null at startup when no range was
+ *  previously set.
+ */
+FindHandler.onModeChanged = function(newMode, oldMode) {
+  if (newMode == ChromeVoxMode.FORCE_NEXT)
+    FindHandler.init_();
+  else
+    FindHandler.uninit_();
+};
+
 /**
  * Initializes this module.
+ * @private
  */
-FindHandler.init = function() {
+FindHandler.init_ = function() {
   chrome.automation.addTreeChangeObserver(
       TreeChangeObserverFilter.TEXT_MARKER_CHANGES, FindHandler.onTextMatch_);
 };

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

@@ -12,6 +12,9 @@ goog.require('cvox.ChromeVoxKbHandler');
 
 /** @constructor */
 BackgroundKeyboardHandler = function() {
+  // Classic keymap.
+  cvox.ChromeVoxKbHandler.handlerKeyMap = cvox.KeyMap.fromDefaults();
+
   /** @type {number} @private */
   this.passThroughKeyUpCount_ = 0;
 
@@ -21,9 +24,7 @@ BackgroundKeyboardHandler = function() {
   document.addEventListener('keydown', this.onKeyDown.bind(this), false);
   document.addEventListener('keyup', this.onKeyUp.bind(this), false);
 
-  chrome.accessibilityPrivate.setKeyboardListener(
-      true, cvox.ChromeVox.isStickyPrefOn);
-  window['prefs'].switchToKeyMap('keymap_next');
+  chrome.accessibilityPrivate.setKeyboardListener(true, false);
 };
 
 BackgroundKeyboardHandler.prototype = {
@@ -37,7 +38,8 @@ BackgroundKeyboardHandler.prototype = {
     if (cvox.ChromeVox.passThroughMode)
       return false;
 
-    if (cvox.ChromeVoxKbHandler.basicKeyDownActionsListener(evt)) {
+    if (ChromeVoxState.instance.mode != ChromeVoxMode.CLASSIC &&
+        !cvox.ChromeVoxKbHandler.basicKeyDownActionsListener(evt)) {
       evt.preventDefault();
       evt.stopPropagation();
       this.eatenKeyDowns_.add(evt.keyCode);
@@ -70,5 +72,32 @@ BackgroundKeyboardHandler.prototype = {
     }
 
     return false;
+  },
+
+  /**
+   * React to mode changes.
+   * @param {ChromeVoxMode} newMode
+   * @param {ChromeVoxMode?} oldMode
+   */
+  onModeChanged: function(newMode, oldMode) {
+    if (newMode == ChromeVoxMode.CLASSIC) {
+      chrome.accessibilityPrivate.setKeyboardListener(false, false);
+    } else {
+      chrome.accessibilityPrivate.setKeyboardListener(
+          true, cvox.ChromeVox.isStickyPrefOn);
+    }
+
+    if (newMode === ChromeVoxMode.NEXT ||
+        newMode === ChromeVoxMode.FORCE_NEXT) {
+      // Switching out of classic, classic compat, or uninitialized
+      // (on startup).
+      window['prefs'].switchToKeyMap('keymap_next');
+    } else if (
+        oldMode && oldMode != ChromeVoxMode.CLASSIC &&
+        oldMode != ChromeVoxMode.CLASSIC_COMPAT) {
+      // Switching out of next. Intentionally do nothing when switching out of
+      // an uninitialized |oldMode|.
+      window['prefs'].switchToKeyMap('keymap_classic');
+    }
   }
 };

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

@@ -84,7 +84,7 @@ LiveRegions.prototype = {
     var mode = this.chromeVoxState_.mode;
     var currentRange = this.chromeVoxState_.currentRange;
 
-    if (!cvox.ChromeVox.isActive)
+    if (mode === ChromeVoxMode.CLASSIC || !cvox.ChromeVox.isActive)
       return;
 
     if (!currentRange)

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

+// Copyright 2015 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 Handles automation from a tabs automation node.
+ */
+
+goog.provide('TabsAutomationHandler');
+
+goog.require('CustomAutomationEvent');
+goog.require('DesktopAutomationHandler');
+
+goog.scope(function() {
+var EventType = chrome.automation.EventType;
+var RoleType = chrome.automation.RoleType;
+var StateType = chrome.automation.StateType;
+
+/**
+ * @param {!chrome.automation.AutomationNode} tabRoot
+ * @constructor
+ * @extends {DesktopAutomationHandler}
+ */
+TabsAutomationHandler = function(tabRoot) {
+  DesktopAutomationHandler.call(this, tabRoot);
+
+  if (tabRoot.role != RoleType.ROOT_WEB_AREA)
+    throw new Error('Expected rootWebArea node but got ' + tabRoot.role);
+
+  // When the root is focused, simulate what happens on a load complete.
+  if (tabRoot.state[StateType.FOCUSED]) {
+    var event =
+        new CustomAutomationEvent(EventType.LOAD_COMPLETE, tabRoot, 'page');
+    this.onLoadComplete(event);
+  }
+};
+
+TabsAutomationHandler.prototype = {
+  __proto__: DesktopAutomationHandler.prototype,
+
+  /** @override */
+  didHandleEvent_: function(evt) {
+    evt.stopPropagation();
+  },
+
+  /** @override */
+  onLoadComplete: function(evt) {
+    var focused = evt.target.find({state: {focused: true}}) || evt.target;
+    var event =
+        new CustomAutomationEvent(EventType.FOCUS, focused, evt.eventFrom);
+    this.onFocus(event);
+  }
+};
+
+});  // goog.scope