Add speech output rules for most of the remaining native views for ChromeVox Next.

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 26 matching lines @@
  *     $text_sel_end').
  * = suffix: used to specify substitution only if not previously appended.
  *     For example, $name= would insert the name attribute only if no name
  * attribute had been inserted previously.
  * @param {!cursors.Range} range
  * @param {cursors.Range} prevRange
  * @param {chrome.automation.EventType|Output.EventType} type
  * @constructor
  */
 Output = function(range, prevRange, type) {
-  // TODO(dtseng): Include brailleBuffer once we add rules for braille.
+  // 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_ = [];
 
+  /**
+   * Current global options.
+   * @type {{speech: boolean, braille: boolean, location: boolean}}
+   */
+  this.formatOptions_ = {speech: true, braille: false, location: true};
+
   this.render_(range, prevRange, type);
   this.handleSpeech();
   this.handleBraille();
   this.handleDisplay();
 };
 
 /**
  * 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)'
+    },
     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))'
     },
     heading: {
       enter: '@aria_role_heading',
       speak: '@aria_role_heading $name='
     },
     inlineTextBox: {
       speak: '$value='
     },
     link: {
       enter: '$name= $visited $earcon(LINK, @tag_link)=',
       stay: '$name= $visited @tag_link',
       speak: '$name= $visited $earcon(LINK, @tag_link)='
     },
     list: {
       enter: '$role'
     },
     listItem: {
       enter: '$role'
     },
+    menuItem: {
+      speak: '$or($haspopup, @describe_menu_item_with_submenu($name), ' +
+          '@describe_menu_item($name))'
+    },
+    menuListOption: {
+      speak: '$name $value @aria_role_menuitem ' +
+          '@describe_index($indexInParent, $parentChildCount)'
+    },
     paragraph: {
       speak: '$value'
     },
+    popUpButton: {
+      speak: '$value $name @tag_button @aria_has_popup $earcon(LISTBOX)'
+    },
+    radioButton: {
+      speak: '$or($checked, @describe_radio_selected($name), ' +
+          '@describe_radio_unselected($name)) ' +
+          '$or($checked, ' +
+              '$earcon(CHECK_ON, @input_type_radio), ' +
+              '$earcon(CHECK_OFF, @input_type_radio))'
+    },
+    slider: {
+      speak: '@describe_slider($value, $name)'
+    },
     staticText: {
       speak: '$value'
     },
     textBox: {
       speak: '$name $value $earcon(EDITABLE_TEXT, @input_type_text)'
     },
+    tab: {
+      speak: '@describe_tab($name)'
+    },
     textField: {
       speak: '$name $value $earcon(EDITABLE_TEXT, @input_type_text)'
     },
     window: {
-      enter: '$name $role= $earcon(OBJECT_OPEN)'
-      // TODO(dtseng): A leave event is not reliable because views does not fire
-      // focus events after closing windows.
+      speak: '@describe_window($name) $earcon(OBJECT_OPEN)'
     }
   },
   menuStart: {
     'default': {
       speak: '@chrome_menu_opened($name) $role $earcon(OBJECT_OPEN)'
     }
   },
     menuEnd: {
     'default': {
       speak: '$earcon(OBJECT_CLOSE)'
@@ skipping 60 matching lines @@
         a.run();
       });
     }
   },
 
   /**
    * Handles output to braille.
    */
   handleBraille: function() {
     cvox.ChromeVox.braille.write(
-        cvox.NavBraille.fromText(this.buffer_.toString()));
+        cvox.NavBraille.fromText(this.brailleBuffer_.toString()));
   },
 
   /**
    * Handles output to visual display.
    */
   handleDisplay: function() {
     chrome.accessibilityPrivate.setFocusRing(this.locations_);
   },
 
   /**
    * Renders the given range using optional context previous range and event
    * type.
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {chrome.automation.EventType|string} type
    * @private
    */
   render_: function(range, prevRange, type) {
     var buff = new cvox.Spannable();
+    var brailleBuff = new cvox.Spannable();
     if (range.isSubNode())
       this.subNode_(range, prevRange, type, buff);
     else
       this.range_(range, prevRange, type, buff);
 
+    this.formatOptions_.braille = true;
+    this.formatOptions_.location = false;
+        if (range.isSubNode())
+      this.subNode_(range, prevRange, type, brailleBuff);
+    else
+      this.range_(range, prevRange, type, brailleBuff);
+
     this.buffer_ = buff;
+    this.brailleBuffer_ = brailleBuff;
   },
 
   /**
    * Format the node given the format specifier.
    * @param {!chrome.automation.AutomationNode} node
    * @param {string|!Object} format The output format either specified as an
    * output template string or a parsed output format tree.
    * @param {!Object=} opt_exclude A set of attributes to exclude.
    * @private
    */
@@ skipping 37 matching lines @@
 
       if (opt_exclude[token])
         return;
 
       // All possible tokens based on prefix.
       if (prefix == '$') {
         options.annotation = token;
         if (token == 'role') {
           // Non-localized role and state obtained by default.
           this.addToSpannable_(buff, node.role, options);
+        } else if (token == 'indexInParent') {
+          this.addToSpannable_(buff, node.indexInParent + 1);
+        } else if (token == 'parentChildCount') {
+          if (node.parent())
+          this.addToSpannable_(buff, node.parent().children().length);
         } else if (token == 'state') {
           Object.getOwnPropertyNames(node.state).forEach(function(s) {
             this.addToSpannable_(buff, s, options);
           }.bind(this));
         } 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.
@@ skipping 19 matching lines @@
         var msgId = token;
         var msgArgs = [];
         var curMsg = tree.firstChild;
 
         while (curMsg) {
           var arg = curMsg.value;
           if (arg[0] != '$') {
             console.error('Unexpected value: ' + arg);
             return;
           }
-          arg = arg.slice(1);
-          if (!node.attributes[arg])
-            msgArgs.push('');
-          else
-            msgArgs.push(node.attributes[arg]);
+          var msgBuff = new cvox.Spannable();
+          this.format_(node, arg, msgBuff);
+          msgArgs.push(msgBuff.toString());
           curMsg = curMsg.nextSibling;
         }
+          var msg = cvox.ChromeVox.msgs.getMsg(msgId, msgArgs);
+        try {
+          if (this.formatOptions_.braille)
+            msg = cvox.ChromeVox.msgs.getMsg(msgId + '_brl', msgArgs) || msg;
+        } catch(e) {}
 
-        var msg = cvox.ChromeVox.msgs.getMsg(msgId, msgArgs);
         if (msg) {
           this.addToSpannable_(buff, msg, options);
         }
       }
     }.bind(this));
   },
 
   /**
    * @param {!cursors.Range} range
    * @param {cursors.Range} prevRange
    * @param {chrome.automation.EventType|string} type
    * @param {!cvox.Spannable} rangeBuff
    * @private
    */
   range_: function(range, prevRange, type, rangeBuff) {
     if (!prevRange)
       prevRange = range;
 
     var cursor = range.getStart();
     var prevNode = prevRange.getStart().getNode();
 
     var formatNodeAndAncestors = function(node, prevNode) {
       var buff = new cvox.Spannable();
       this.ancestry_(node, prevNode, type, buff);
       this.node_(node, prevNode, type, buff);
-      this.locations_.push(node.location);
+      if (this.formatOptions_.location)
+        this.locations_.push(node.location);
       return buff;
     }.bind(this);
 
     while (cursor.getNode() != range.getEnd().getNode()) {
       var node = cursor.getNode();
       this.addToSpannable_(
           rangeBuff, formatNodeAndAncestors(node, prevNode));
       prevNode = node;
       cursor = cursor.move(cursors.Unit.NODE,
                            cursors.Movement.DIRECTIONAL,
@@ skipping 145 matching lines @@
     }
 
     if (currentNode != root)
       throw 'Unbalanced parenthesis.';
 
     return root;
   }
 };
 
 });  // goog.scope