Improve speech contextual announcements and startCallback synchronization

chrome/browser/resources/chromeos/chromevox/cvox2/background/output.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 Provides output services for ChromeVox.
  */
 
 goog.provide('Output');
 goog.provide('Output.EventType');
@@ skipping 74 matching lines @@
    * The speech queue mode for the generated speech utterance.
    * @type {cvox.QueueMode}
    * @private
    */
   this.queueMode_ = cvox.QueueMode.QUEUE;
 
   /**
    * @type {boolean}
    * @private
    */
-  this.outputContextFirst_ = localStorage['outputContextFirst'] == 'true';
+  this.outputContextFirst_ = false;
 };
 
 /**
  * Delimiter to use between output values.
  * @type {string}
  */
 Output.SPACE = ' ';
 
 /**
  * Metadata about supported automation roles.
  * @const {Object<{msgId: string,
  *                 earconId: (string|undefined),
  *                 inherits: (string|undefined),
- *                 ignoreAncestry: (boolean|undefined)}>}
+ *                 outputContextFirst: (boolean|undefined)}>}
  * msgId: the message id of the role.
  * earconId: an optional earcon to play when encountering the role.
  * inherits: inherits rules from this role.
- * ignoreAncestry: don't output ancestry changes when encountering this role.
+ * outputContextFirst: where to place the context output.
  * @private
  */
 Output.ROLE_INFO_ = {
   alert: {
     msgId: 'role_alert',
     earconId: 'ALERT_NONMODAL'
   },
   alertDialog: {
-    msgId: 'role_alertdialog'
+    msgId: 'role_alertdialog',
+    outputContextFirst: true
   },
   article: {
     msgId: 'role_article',
     inherits: 'abstractContainer'
   },
   application: {
     msgId: 'role_application',
     inherits: 'abstractContainer'
   },
   banner: {
     msgId: 'role_banner',
     inherits: 'abstractContainer'
   },
   button: {
     msgId: 'role_button',
     earconId: 'BUTTON'
   },
   buttonDropDown: {
     msgId: 'role_button',
     earconId: 'BUTTON'
   },
   checkBox: {
     msgId: 'role_checkbox'
   },
   columnHeader: {
     msgId: 'role_columnheader',
     inherits: 'cell'
   },
   comboBox: {
-    msgId: 'role_combobox'
+    msgId: 'role_combobox',
+    earconId: 'LISTBOX'
   },
   complementary: {
     msgId: 'role_complementary',
     inherits: 'abstractContainer'
   },
   contentInfo: {
     msgId: 'role_contentinfo',
     inherits: 'abstractContainer'
   },
   date: {
     msgId: 'input_type_date',
     inherits: 'abstractContainer'
   },
   definition: {
     msgId: 'role_definition',
     inherits: 'abstractContainer'
   },
   dialog: {
-    msgId: 'role_dialog'
+    msgId: 'role_dialog',
+    outputContextFirst: true
   },
   directory: {
     msgId: 'role_directory',
     inherits: 'abstractContainer'
   },
   document: {
     msgId: 'role_document',
     inherits: 'abstractContainer'
   },
   form: {
@@ skipping 41 matching lines @@
     inherits: 'abstractContainer'
   },
   marquee: {
     msgId: 'role_marquee',
   },
   math: {
     msgId: 'role_math',
     inherits: 'abstractContainer'
   },
   menu: {
-    msgId: 'role_menu'
+    msgId: 'role_menu',
+    outputContextFirst: true
   },
   menuBar: {
     msgId: 'role_menubar',
   },
   menuItem: {
     msgId: 'role_menuitem'
   },
   menuItemCheckBox: {
     msgId: 'role_menuitemcheckbox'
   },
@@ skipping 17 matching lines @@
   popUpButton: {
     msgId: 'role_button',
     earconId: 'POP_UP_BUTTON'
   },
   radioButton: {
     msgId: 'role_radio'
   },
   radioGroup: {
     msgId: 'role_radiogroup',
   },
+  rootWebArea: {
+    outputContextFirst: true
+  },
   row: {
     msgId: 'role_row',
     inherits: 'abstractContainer'
   },
   rowHeader: {
     msgId: 'role_rowheader',
     inherits: 'cell'
   },
   scrollBar: {
     msgId: 'role_scrollbar',
@@ skipping 610 matching lines @@
         callback();
     }.bind(this);
     return this;
   },
 
   /**
    * Executes all specified output.
    */
   go: function() {
     // Speech.
-    var queueMode = this.queueMode_;
-    this.speechBuffer_.forEach(function(buff, i, a) {
-      if (Output.forceModeForNextSpeechUtterance_ !== undefined &&
-          buff.length > 0) {
-        queueMode = Output.forceModeForNextSpeechUtterance_;
-        Output.forceModeForNextSpeechUtterance_ = undefined;
-      }
+    var queueMode = cvox.QueueMode.FLUSH;
+    if (Output.forceModeForNextSpeechUtterance_ !== undefined)
+      queueMode = Output.forceModeForNextSpeechUtterance_;
+    else if (this.queueMode_ !== undefined)
+      queueMode = this.queueMode_;
 
-      var speechProps = {};
+    if (this.speechBuffer_.length > 0)
+      Output.forceModeForNextSpeechUtterance_ = undefined;
+
+    for (var i = 0; i < this.speechBuffer_.length; i++) {
+      var buff = this.speechBuffer_[i];
+      var speechProps = /** @type {Object} */(
+          buff.getSpanInstanceOf(Output.SpeechProperties)) || {};
+
+      speechProps.category = this.speechCategory_;
+
       (function() {
         var scopedBuff = buff;
-        speechProps =
-            scopedBuff.getSpanInstanceOf(Output.SpeechProperties) || {};
-        speechProps.category = this.speechCategory_;
-
         speechProps['startCallback'] = function() {
           var actions = scopedBuff.getSpansInstanceOf(Output.Action);
           if (actions) {
             actions.forEach(function(a) {
               a.run();
             });
           }
         };
-      }.bind(this)());
+      }());
 
-      if (this.speechEndCallback_ && i == a.length - 1)
+      if (i == this.speechBuffer_.length - 1)
         speechProps['endCallback'] = this.speechEndCallback_;
-      else
-        speechProps['endCallback'] = null;
+
       cvox.ChromeVox.tts.speak(
           buff.toString(), queueMode, speechProps);
       queueMode = cvox.QueueMode.QUEUE;
-    }.bind(this));
+    }
 
     // Braille.
     if (this.brailleBuffer_.length) {
       var buff = this.createBrailleOutput_();
       var selSpan =
           buff.getSpanInstanceOf(Output.SelectionSpan);
       var startIndex = -1, endIndex = -1;
       if (selSpan) {
         var valueStart = buff.getSpanStart(selSpan);
         var valueEnd = buff.getSpanEnd(selSpan);
@@ skipping 23 matching lines @@
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {EventType|Output.EventType} type
    * @param {!Array<Spannable>} buff Buffer to receive rendered output.
    * @private
    */
   render_: function(range, prevRange, type, buff) {
     if (prevRange && !prevRange.isValid())
       prevRange = null;
 
+    // Scan ancestors to get the value of |outputContextFirst|.
+    var parent = range.start.node;
+    while (parent && parent.root && parent.root.role != RoleType.desktop) {
+      if (Output.ROLE_INFO_[parent.role] &&
+          Output.ROLE_INFO_[parent.role].outputContextFirst) {
+        this.outputContextFirst_ = true;
+        break;
+      }
+      parent = parent.parent;
+    }
+
     if (range.isSubNode())
       this.subNode_(range, prevRange, type, buff);
     else
       this.range_(range, prevRange, type, buff);
   },
 
   /**
    * Format the node given the format specifier.
    * @param {AutomationNode} node
    * @param {string|!Object} format The output format either specified as an
@@ skipping 377 matching lines @@
   },
 
   /**
    * @param {!AutomationNode} node
    * @param {!AutomationNode} prevNode
    * @param {EventType|Output.EventType} type
    * @param {!Array<Spannable>} buff
    * @private
    */
   ancestry_: function(node, prevNode, type, buff) {
-    // Check to see if ancestry output is ignored.
-    if (Output.ROLE_INFO_[node.role] &&
-        Output.ROLE_INFO_[node.role].ignoreAncestry)
-      return;
-
     var prevUniqueAncestors =
         AutomationUtil.getUniqueAncestors(node, prevNode);
     var uniqueAncestors = AutomationUtil.getUniqueAncestors(prevNode, node);
 
     // First, look up the event type's format block.
     // Navigate is the default event.
     var eventBlock = Output.RULES[type] || Output.RULES['navigate'];
 
     var getMergedRoleBlock = function(role) {
       var parentRole = (Output.ROLE_INFO_[role] || {}).inherits;
@@ skipping 326 matching lines @@
   /**
    * Gets the output buffer for braille.
    * @return {!Spannable}
    */
   get brailleOutputForTest() {
     return this.createBrailleOutput_();
   }
 };
 
 });  // goog.scope