Use category flush for focus events.

At times, we receive multiple focus events. This is technically fine, but it can cause lots of queued up chatter.

In the linke to bug, we are reading a focus event from a previous tab. Ideally the focus event shouldn't be fired (as it once was not), but ChromeVox should be robust enough to not over speak in this case.

Note that in braille, this results in a "shuffling" effect where one focus event flashes briefly before the expected event comes through.

BUG=646126

CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.linux:closure_compilation

Review-Url: https://codereview.chromium.org/2331253002
Cr-Commit-Position: refs/heads/master@{#419240}

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

@@ -127,10 +127,10 @@ Background = function() {
 
   cvox.ExtensionBridge.addMessageListener(this.onMessage_);
 
-  /** @type {!BackgroundKeyboardHandler} */
+  /** @type {!BackgroundKeyboardHandler} @private */
   this.keyboardHandler_ = new BackgroundKeyboardHandler();
 
-  /** @type {!LiveRegions} */
+  /** @type {!LiveRegions} @private */
   this.liveRegions_ = new LiveRegions(this);
 
   /** @type {boolean} @private */
@@ -139,6 +139,7 @@ Background = function() {
   /**
    * Stores the mode as computed the last time a current range was set.
    * @type {?ChromeVoxMode}
+   * @private
    */
   this.mode_ = null;
 
@@ -519,6 +520,7 @@ Background.prototype = {
    * 1. a url is blacklisted for Classic.
    * 2. the current range is not within web content.
    * @param {string} url
+   * @return {boolean}
    */
   isWhitelistedForCompat_: function(url) {
     return this.isBlacklistedForClassic_(url) || (this.getCurrentRange() &&
@@ -626,7 +628,7 @@ Background.prototype = {
         } else if (action == 'onCommand') {
           CommandHandler.onCommand(msg['command']);
         } else if (action == 'flushNextUtterance') {
-          Output.flushNextSpeechUtterance();
+          Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
         }
         break;
     }

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

@@ -176,7 +176,7 @@ DesktopAutomationHandler.prototype = {
    * @param {!AutomationEvent} evt
    */
   onEventWithFlushedOutput: function(evt) {
-    Output.flushNextSpeechUtterance();
+    Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
     this.onEventDefault(evt);
   },
 
@@ -187,7 +187,7 @@ DesktopAutomationHandler.prototype = {
     if (ChromeVoxState.instance.currentRange &&
         evt.target == ChromeVoxState.instance.currentRange.start.node)
       return;
-    Output.flushNextSpeechUtterance();
+    Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
     this.onEventDefault(evt);
   },
 
@@ -251,12 +251,10 @@ DesktopAutomationHandler.prototype = {
 
     this.createTextEditHandlerIfNeeded_(evt.target);
 
-    // Since we queue output mostly for live regions support and there isn't a
-    // reliable way to know if this focus event resulted from a user's explicit
-    // action, only flush when the focused node is not web content.
-    if (node.root.role == RoleType.desktop)
-      Output.flushNextSpeechUtterance();
-
+    // Category flush speech triggered by events with no source. This includes
+    // views.
+    if (evt.eventFrom == '')
+      Output.forceModeForNextSpeechUtterance(cvox.QueueMode.CATEGORY_FLUSH);
     this.onEventDefault(new chrome.automation.AutomationEvent(
         EventType.focus, node, evt.eventFrom));
   },
@@ -427,7 +425,7 @@ DesktopAutomationHandler.prototype = {
       var override = evt.target.role == RoleType.menuItem ||
           (evt.target.root == focus.root &&
               focus.root.role == RoleType.desktop);
-      Output.flushNextSpeechUtterance();
+      Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
       if (override || AutomationUtil.isDescendantOf(evt.target, focus))
         this.onEventDefault(evt);
     }.bind(this));

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

@@ -112,7 +112,7 @@ ISearch.prototype = {
  * @implements {ISearchHandler}
  */
 ISearchUI = function(input) {
-  /** @type {ChromeVoxState} */
+  /** @type {ChromeVoxState} @private */
   this.background_ =
       chrome.extension.getBackgroundPage()['ChromeVoxState']['instance'];
   this.iSearch_ = new ISearch(this.background_.currentRange.start.node);
@@ -204,7 +204,7 @@ ISearchUI.prototype = {
    * @private
    */
   output_: function(node) {
-    Output.flushNextSpeechUtterance();
+    Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
     var o = new Output().withRichSpeechAndBraille(
         cursors.Range.fromNode(node), null, Output.EventType.NAVIGATE).go();
 

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

@@ -38,7 +38,7 @@ BackgroundKeyboardHandler.prototype = {
       evt.preventDefault();
       evt.stopPropagation();
     }
-    Output.flushNextSpeechUtterance();
+    Output.forceModeForNextSpeechUtterance(cvox.QueueMode.FLUSH);
     return false;
   },
 

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

@@ -58,13 +58,13 @@ var RoleType = chrome.automation.RoleType;
  */
 Output = function() {
   // TODO(dtseng): Include braille specific rules.
-  /** @type {!Array<!Spannable>} */
+  /** @type {!Array<!Spannable>} @private */
   this.speechBuffer_ = [];
-  /** @type {!Array<!Spannable>} */
+  /** @type {!Array<!Spannable>} @private */
   this.brailleBuffer_ = [];
-  /** @type {!Array<!Object>} */
+  /** @type {!Array<!Object>} @private */
   this.locations_ = [];
-  /** @type {function(?)} */
+  /** @type {function(?)} @private */
   this.speechEndCallback_;
 
   /**
@@ -688,19 +688,21 @@ Output.EventType = {
 };
 
 /**
- * If true, the next speech utterance will flush instead of the normal
+ * If set, the next speech utterance will use this value instead of the normal
  * queueing mode.
- * @type {boolean}
+ * @type {cvox.QueueMode|undefined}
  * @private
  */
-Output.flushNextSpeechUtterance_ = false;
+Output.forceModeForNextSpeechUtterance_;
 
 /**
- * Calling this will make the next speech utterance flush even if it would
- * normally queue or do a category flush.
+ * Calling this will make the next speech utterance use |mode| even if it would
+ * normally queue or do a category flush. This differs from the |withQueueMode|
+ * instance method as it can apply to future output.
+   * @param {cvox.QueueMode} mode
  */
-Output.flushNextSpeechUtterance = function() {
-  Output.flushNextSpeechUtterance_ = true;
+Output.forceModeForNextSpeechUtterance = function(mode) {
+  Output.forceModeForNextSpeechUtterance_ = mode;
 };
 
 Output.prototype = {
@@ -907,6 +909,7 @@ Output.prototype = {
   /**
    * Triggers callback for a speech event.
    * @param {function()} callback
+   * @return {Output}
    */
   onSpeechEnd: function(callback) {
     this.speechEndCallback_ = function(opt_cleanupOnly) {
@@ -923,9 +926,10 @@ Output.prototype = {
     // Speech.
     var queueMode = this.queueMode_;
     this.speechBuffer_.forEach(function(buff, i, a) {
-      if (Output.flushNextSpeechUtterance_ && buff.length > 0) {
-        queueMode = cvox.QueueMode.FLUSH;
-        Output.flushNextSpeechUtterance_ = false;
+      if (Output.forceModeForNextSpeechUtterance_ !== undefined &&
+          buff.length > 0) {
+        queueMode = Output.forceModeForNextSpeechUtterance_;
+        Output.forceModeForNextSpeechUtterance_ = undefined;
       }
 
       var speechProps = {};