Don't output earcons when constructing output from descendants

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 51 matching lines @@
   this.speechBuffer_ = [];
   /** @type {!Array<!Spannable>} @private */
   this.brailleBuffer_ = [];
   /** @type {!Array<!Object>} @private */
   this.locations_ = [];
   /** @type {function(?)} @private */
   this.speechEndCallback_;
 
   /**
    * Current global options.
-   * @type {{speech: boolean, braille: boolean, auralStyle: boolean}}
+   * @type {{speech: boolean,
+   * braille: boolean,
+   * auralStyle: boolean,
+   * earcons: boolean}}
    * @private
    */
-  this.formatOptions_ = {speech: true, braille: false, auralStyle: false};
+  this.formatOptions_ =
+      {speech: true, braille: false, auralStyle: false, earcons: true};
 
   /**
    * The speech category for the generated speech utterance.
    * @type {cvox.TtsCategory}
    * @private
    */
   this.speechCategory_ = cvox.TtsCategory.NAV;
 
   /**
    * The speech queue mode for the generated speech utterance.
@@ skipping 344 matching lines @@
              '$name $role $checked $description $state'
     },
     date: {
       enter: '$nameFromNode $role $description'
     },
     dialog: {
       enter: '$nameFromNode $role $description'
     },
     div: {
       enter: '$nameFromNode',
-      speak: '$name $description $descendants'
+      speak: '$name $description $descendantsNoEarcons'
     },
     grid: {
       enter: '$nameFromNode $role $description'
     },
     group: {
       enter: '$nameFromNode $state $description',
       speak: '$nameOrDescendants $value $state $description',
       leave: ''
     },
     heading: {
@@ skipping 256 matching lines @@
   },
 
   /**
    * Specify ranges for speech.
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {EventType|Output.EventType} type
    * @return {!Output}
    */
   withSpeech: function(range, prevRange, type) {
-    this.formatOptions_ = {speech: true, braille: false, auralStyle: false};
+    this.formatOptions_ =
+        {speech: true, braille: false, auralStyle: false, earcons: true};
     this.render_(range, prevRange, type, this.speechBuffer_);
     return this;
   },
 
     /**
    * Specify ranges for aurally styled speech.
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {EventType|Output.EventType} type
    * @return {!Output}
    */
   withRichSpeech: function(range, prevRange, type) {
-    this.formatOptions_ = {speech: true, braille: false, auralStyle: true};
+    this.formatOptions_ =
+        {speech: true, braille: false, auralStyle: true, earcons: true};
     this.render_(range, prevRange, type, this.speechBuffer_);
     return this;
   },
 
   /**
    * Specify ranges for braille.
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {EventType|Output.EventType} type
    * @return {!Output}
    */
   withBraille: function(range, prevRange, type) {
-    this.formatOptions_ = {speech: false, braille: true, auralStyle: false};
+    this.formatOptions_ =
+        {speech: false, braille: true, auralStyle: false, earcons: false};
     this.render_(range, prevRange, type, this.brailleBuffer_);
     return this;
   },
 
   /**
    * Specify ranges for location.
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {EventType|Output.EventType} type
    * @return {!Output}
    */
   withLocation: function(range, prevRange, type) {
-    this.formatOptions_ = {speech: false, braille: false, auralStyle: false};
+    this.formatOptions_ =
+        {speech: false, braille: false, auralStyle: false, earcons: false};
     this.render_(range, prevRange, type, [] /*unused output*/);
     return this;
   },
 
   /**
    * Specify the same ranges for speech and braille.
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {EventType|Output.EventType} type
    * @return {!Output}
@@ skipping 76 matching lines @@
    * Apply a format string directly to the speech output buffer. This lets you
    * output a message directly to the buffer using the format syntax.
    * @param {string} formatStr
    * @param {!AutomationNode=} opt_node An optional node to apply the
    *     formatting to.
    * @return {!Output} |this| for chaining
    */
   formatForSpeech: function(formatStr, opt_node) {
     var node = opt_node || null;
 
-    this.formatOptions_ = {speech: true, braille: false, auralStyle: false};
+    this.formatOptions_ =
+        {speech: true, braille: false, auralStyle: false, earcons: true};
     this.format_(node, formatStr, this.speechBuffer_);
 
     return this;
   },
 
   /**
    * Apply a format string directly to the braille output buffer. This lets you
    * output a message directly to the buffer using the format syntax.
    * @param {string} formatStr
    * @param {!AutomationNode=} opt_node An optional node to apply the
    *     formatting to.
    * @return {!Output} |this| for chaining
    */
   formatForBraille: function(formatStr, opt_node) {
     var node = opt_node || null;
 
-    this.formatOptions_ = {speech: false, braille: true, auralStyle: false};
+    this.formatOptions_ =
+        {speech: false, braille: true, auralStyle: false, earcons: false};
     this.format_(node, formatStr, this.brailleBuffer_);
 
     return this;
   },
 
   /**
    * Triggers callback for a speech event.
    * @param {function()} callback
    * @return {Output}
    */
@@ skipping 236 matching lines @@
               new cursors.Cursor(leftmost, cursors.NODE_INDEX),
               new cursors.Cursor(rightmost, cursors.NODE_INDEX));
           var prev = null;
           if (node)
             prev = cursors.Range.fromNode(node);
           this.render_(subrange, prev, Output.EventType.NAVIGATE, buff);
         } else if (token == 'joinedDescendants') {
           var unjoined = [];
           this.format_(node, '$descendants', unjoined);
           this.append_(buff, unjoined.join(' '), options);
+        } else if (token == 'descendantsNoEarcons') {
+          var state = this.formatOptions_.earcons;
+          this.formatOptions_.earcons = false;
+          this.format_(node, '$descendants', buff);
+          this.formatOptions_.earcons = state;
         } else if (token == 'role') {
           if (localStorage['useVerboseMode'] == 'false')
             return;
 
           if (this.formatOptions_.auralStyle) {
             speechProps = new Output.SpeechProperties();
             speechProps['relativePitch'] = -0.3;
           }
           options.annotation.push(token);
           var msg = node.role;
@@ skipping 58 matching lines @@
           // Custom functions.
           if (token == 'if') {
             var cond = tree.firstChild;
             var attrib = cond.value.slice(1);
             if (node[attrib] || node.state[attrib])
               this.format_(node, cond.nextSibling, buff);
             else
               this.format_(node, cond.nextSibling.nextSibling, buff);
           } else if (token == 'earcon') {
             // Ignore unless we're generating speech output.
-            if (!this.formatOptions_.speech)
+            if (!this.formatOptions_.speech || !this.formatOptions_.earcons)
               return;
 
             options.annotation.push(
                 new Output.EarconAction(tree.firstChild.value));
             this.append_(buff, '', options);
           } else if (token == 'countChildren') {
             var role = tree.firstChild.value;
             var count = node.children.filter(function(e) {
               return e.role == role;
             }).length;
@@ skipping 432 matching lines @@
     return result;
   },
 
   /**
    * Find the earcon for a given node (including ancestry).
    * @param {!AutomationNode} node
    * @param {!AutomationNode=} opt_prevNode
    * @return {Output.Action}
    */
   findEarcon_: function(node, opt_prevNode) {
+    if (!this.formatOptions_.earcons)
+      return null;
     if (node === opt_prevNode)
       return null;
 
     if (this.formatOptions_.speech) {
       var earconFinder = node;
       var ancestors;
       if (opt_prevNode)
         ancestors = AutomationUtil.getUniqueAncestors(opt_prevNode, node);
       else
         ancestors = AutomationUtil.getAncestors(node);
@@ skipping 40 matching lines @@
   /**
    * Gets the output buffer for braille.
    * @return {!Spannable}
    */
   get brailleOutputForTest() {
     return this.createBrailleOutput_();
   }
 };
 
 });  // goog.scope