Support alert nodes by introducing $descendant and !ttsProps.

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 33 matching lines @@
  */
 Output = function() {
   // TODO(dtseng): Include braille specific rules.
   /** @type {!cvox.Spannable} */
   this.buffer_ = new cvox.Spannable();
   /** @type {!cvox.Spannable} */
   this.brailleBuffer_ = new cvox.Spannable();
   /** @type {!Array.<Object>} */
   this.locations_ = [];
   /** @type {function()} */
-  this.speechStartCallback_ = function() {};
+  this.speechStartCallback_;
   /** @type {function()} */
-  this.speechEndCallback_ = function() {};
+  this.speechEndCallback_;
   /** @type {function()} */
-  this.speechInterruptedCallback_ = function() {};
+  this.speechInterruptedCallback_;
 
   /**
    * Current global options.
    * @type {{speech: boolean, braille: boolean, location: boolean}}
    */
   this.formatOptions_ = {speech: true, braille: false, location: true};
+
+  /**
+   * Speech properties to apply to the entire output.
+   * @type {!Object.<string, *>}
+   */
+  this.speechProperties_ = {};
 };
 
 /**
  * Delimiter to use between output values.
  * @type {string}
  */
 Output.SPACE = ' ';
 
 /**
  * Rules specifying format of AutomationNodes for output.
  * @type {!Object.<string, Object.<string, Object.<string, string>>>}
  */
 Output.RULES = {
   navigate: {
     'default': {
       speak: '$name $role $value',
       braille: ''
     },
     alert: {
-      speak: '@aria_role_alert $name $earcon(ALERT_NONMODAL)'
+      speak: '!doNotInterrupt' +

[dmazzoni, 2015/02/04 08:50:16]

is there supposed to be a space after the !doNotInterrupt and before the
@aira_role_alert or does the parser break on a '@'?

[David Tseng, 2015/02/04 16:57:13]

Good catch! The parser splits expressions on spaces.

+          '@aria_role_alert $name $earcon(ALERT_NONMODAL) $descendants'
     },
     button: {
       speak: '$name $earcon(BUTTON, @tag_button)'
     },
     checkBox: {
       speak: '$or($checked, @describe_checkbox_checked($name), ' +
           '@describe_checkbox_unchecked($name)) ' +
           '$or($checked, ' +
               '$earcon(CHECK_ON, @input_type_checkbox), ' +
               '$earcon(CHECK_OFF, @input_type_checkbox))'
@@ skipping 205 matching lines @@
 
   /**
    * Executes all specified output.
    */
   go: function() {
     // Speech.
     var buff = this.buffer_;
 
     var onEvent = function(evt) {
       switch (evt.type) {
-        case 'start': this.speechStartCallback_(); break;
-        case 'end': this.speechEndCallback_(); break;
-        case 'interrupted': this.speechInterruptedCallback_(); break;
+        case 'start':
+          this.speechStartCallback_();
+          break;
+        case 'end':
+          this.speechEndCallback_();
+          break;
+        case 'interrupted':
+          this.speechInterruptedCallback_ && this.speechInterruptedCallback_();
+          break;
       }
     }.bind(this);
 
     if (buff.toString()) {
+      if (this.speechStartCallback_ ||
+          this.speechEndCallback_ ||
+          this.speechInterruptedCallback_)
+        this.speechProperties_['onEvent'] = onEvent;
+
       cvox.ChromeVox.tts.speak(
-          buff.toString(), cvox.QueueMode.FLUSH, {onEvent: onEvent});
+          buff.toString(), cvox.QueueMode.FLUSH, this.speechProperties_);
     }
 
     var actions = buff.getSpansInstanceOf(Output.Action);
     if (actions) {
       actions.forEach(function(a) {
         a.run();
       });
     }
 
     // Braille.
@@ skipping 121 matching lines @@
         } else if (token == 'find') {
           // Find takes two arguments: JSON query string and format string.
           if (tree.firstChild) {
             var jsonQuery = tree.firstChild.value;
             node = node.find(
                 /** @type {Object}*/(JSON.parse(jsonQuery)));
             var formatString = tree.firstChild.nextSibling;
             if (node)
               this.format_(node, formatString, buff);
           }
+        } else if (token == 'descendants') {
+          // Construct a range to the leftmost and rightmost leaves.
+          var leftmost = AutomationUtil.findNodePre(
+              node, Dir.FORWARD, AutomationPredicate.leaf);
+          var rightmost = AutomationUtil.findNodePre(
+              node, Dir.BACKWARD, AutomationPredicate.leaf);
+          if (!leftmost || !rightmost)
+            return;
+
+          var subrange = new cursors.Range(
+              new cursors.Cursor(leftmost, 0),
+              new cursors.Cursor(rightmost, 0));
+          this.range_(subrange, null, 'navigate', buff);
         } else if (node.attributes[token]) {
           this.addToSpannable_(buff, node.attributes[token], options);
         } else if (node.state[token]) {
           this.addToSpannable_(buff, token, options);
         } else if (tree.firstChild) {
           // Custom functions.
           if (token == 'or') {
             var cond = tree.firstChild;
             var attrib = cond.value.slice(1);
             if (node.attributes[attrib] || node.state[attrib])
@@ skipping 29 matching lines @@
         }
           var msg = cvox.ChromeVox.msgs.getMsg(msgId, msgArgs);
         try {
           if (this.formatOptions_.braille)
             msg = cvox.ChromeVox.msgs.getMsg(msgId + '_brl', msgArgs) || msg;
         } catch(e) {}
 
         if (msg) {
           this.addToSpannable_(buff, msg, options);
         }
+      } else if (prefix == '!') {
+        this.speechProperties_[token] = true;
       }
     }.bind(this));
   },
 
   /**
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {chrome.automation.EventType|string} type
    * @param {!cvox.Spannable} rangeBuff
    * @private
@@ skipping 187 matching lines @@
     }
 
     if (currentNode != root)
       throw 'Unbalanced parenthesis.';
 
     return root;
   }
 };
 
 });  // goog.scope