Better support ChromeVox list and list-like output.

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 88 matching lines @@
   dialog: {
     msgId: 'dialog'
   },
   heading: {
     msgId: 'aria_role_heading',
   },
   link: {
     msgId: 'tag_link',
     earcon: 'LINK'
   },
+  listBox: {
+    msgId: 'aria_role_listbox',
+    earcon: 'LISTBOX'
+  },
+  listBoxOption: {
+    msgId: 'aria_role_listitem',
+    earcon: 'LIST_ITEM'
+  },
   listItem: {
     msgId: 'ARIA_ROLE_LISTITEM',
     earcon: 'list_item'
   },
+  menu: {
+    msgId: 'aria_role_menu'
+  },
+  menuItem: {
+    msgId: 'aria_role_menuitem'
+  },
   menuListOption: {
     msgId: 'aria_role_menuitem'
   },
+  menuListPopup: {
+    msgId: 'aria_role_menu'
+  },
   popUpButton: {
     msgId: 'tag_button'
   },
   radioButton: {
     msgId: 'input_type_radio'
   },
   spinButton: {
     msgId: 'aria_role_combobox',
     earcon: 'LISTBOX'
   },
   textBox: {
     msgId: 'input_type_text',
     earcon: 'EDITABLE_TEXT'
   },
   textField: {
     msgId: 'input_type_text',
     earcon: 'EDITABLE_TEXT'
   },
   time: {
     msgId: 'tag_time'
   },
   toolbar: {
     msgId: 'aria_role_toolbar'
+  },
+  tree: {
+    msgId: 'aria_role_tree'
+  },
+  treeItem: {
+    msgId: 'aria_role_treeitem'
   }
 };
 
 /**
  * Metadata about supported automation states.
  * @const {!Object<string,
  *           {on: {msgId: string, earconId: string},
  *            off: {msgId: string, earconId: string}}>}
  * @private
  */
 Output.STATE_INFO_ = {
   checked: {
     on: {
       earconId: 'CHECK_ON',
       msgId: 'checkbox_checked_state'
     },
     off: {
       earconId: 'CHECK_OFF',
       msgId: 'checkbox_unchecked_state'
+    },
+    omitted: {
+      earconId: 'CHECK_OFF',
+      msgId: 'checkbox_unchecked_state'
+    }
+  },
+  collapsed: {
+    on: {
+      msgId: 'aria_expanded_false'
+    },
+    off: {
+      msgId: 'aria_expanded_true'
+    }
+  },
+  expanded: {
+    on: {
+      msgId: 'aria_expanded_true'
+    },
+    off: {
+      msgId: 'aria_expanded_false'
     }
   }
 };
 
 /**
  * Rules specifying format of AutomationNodes for output.
  * @type {!Object<string, Object<string, Object<string, string>>>}
  */
 Output.RULES = {
   navigate: {
@@ skipping 20 matching lines @@
     },
     inlineTextBox: {
       speak: '$value='
     },
     link: {
       enter: '$name $visited $role',
       stay: '$name= $visited $role',
       speak: '$name= $visited $role'
     },
     list: {
-      enter: '@aria_role_list @list_with_items($parentChildCount)'
+      enter: '$role @list_with_items($countChildren(listItem))'
+    },
+    listBox: {
+      enter: '$name $role @list_with_items($countChildren(listBoxOption))'
+    },
+    listBoxOption: {
+      speak: '$name $role @describe_index($indexInParent, $parentChildCount)'
     },
     listItem: {
       enter: '$role'

[dmazzoni, 2015/04/28 18:47:40]

Should this one have describe_index too?

[David Tseng, 2015/04/28 19:06:33]

No afaik because these are "normal" listitems (e.g. children of ul).

[dmazzoni, 2015/04/28 19:13:26]

Maybe when we add support for extra verbose "help" text we can add that there.
It seems potentially useful but maybe too verbose to announce by default for a
typical list.

[David Tseng, 2015/04/28 20:02:51]

Agreed on verbosity. I think most screen readers don't do this because listItems
of this type are not atomic. Also, the list prefix should depend on the
parenting list; if it's an ordered list or not.

     },
+    menu: {
+      enter: '$name $role @list_with_items($countChildren(menuItem))'
+    },
     menuItem: {
       speak: '$if($haspopup, @describe_menu_item_with_submenu($name), ' +
           '@describe_menu_item($name)) ' +
           '@describe_index($indexInParent, $parentChildCount)'
     },
     menuListOption: {

[dmazzoni, 2015/04/28 18:47:40]

Please add menuList also - it's <select> without multiple.

It will have one child, a menuListPopup, which will have menuListOption
children.

       speak: '$name $value @aria_role_menuitem ' +
           '@describe_index($indexInParent, $parentChildCount)'
     },
     paragraph: {
       speak: '$value'
     },
     popUpButton: {
       speak: '$value $name $role @aria_has_popup ' +
           '$if($collapsed, @aria_expanded_false, @aria_expanded_true)'
     },
@@ skipping 16 matching lines @@
           '$earcon(EDITABLE_TEXT)',
       braille: ''
     },
     time: {
       enter: '$name $role',
       leave: '@exited_container($role)'
     },
     toolbar: {
       enter: '$name $role'
     },
+    tree: {
+      enter: '$name $role @list_with_items($countChildren(treeItem))'
+    },
+    treeItem: {
+        enter: '$role $expanded $collapsed ' +
+            '@describe_index($indexInParent, $parentChildCount) ' +
+            '@describe_depth($hierarchicalLevel)'
+    },
     window: {
       enter: '$name',
       speak: '@describe_window($name) $earcon(OBJECT_OPEN)'
     }
   },
   menuStart: {
     'default': {
       speak: '@chrome_menu_opened($name)  $earcon(OBJECT_OPEN)'
     }
   },
@@ skipping 366 matching lines @@
               msg = cvox.ChromeVox.msgs.getMsg(info.msgId);
             earconId = info.earcon;
           } else {
             console.error('Missing role info for ' + node.role);
           }
           if (earconId)
             options.annotation.push(new Output.EarconAction(earconId));
           this.append_(buff, msg, options);
         } else if (node.attributes[token] !== undefined) {
           options.annotation.push(token);
-          this.append_(buff, node.attributes[token], options);
+          var value = node.attributes[token];
+          if (typeof value == 'number')
+            value = String(value);
+          this.append_(buff, value, options);
         } else if (Output.STATE_INFO_[token]) {
           options.annotation.push('state');
           var stateInfo = Output.STATE_INFO_[token];
-          var resolvedInfo = node.state[token] ? stateInfo.on : stateInfo.off;
-          options.annotation.push(
-              new Output.EarconAction(resolvedInfo.earconId));
+          var resolvedInfo = {};
+          if (node.state[token] === undefined)
+            resolvedInfo = stateInfo.omitted;
+          else
+            resolvedInfo = node.state[token] ? stateInfo.on : stateInfo.off;
+          if (!resolvedInfo)
+            return;
+          if (resolvedInfo.earconId) {
+            options.annotation.push(
+                new Output.EarconAction(resolvedInfo.earconId));
+          }
           var msgId =
               this.formatOptions_.braille ? resolvedInfo.msgId + '_brl' :
               resolvedInfo.msgId;
           var msg = cvox.ChromeVox.msgs.getMsg(msgId);
           this.append_(buff, msg, options);
         } else if (tree.firstChild) {
           // Custom functions.
           if (token == 'if') {
             var cond = tree.firstChild;
             var attrib = cond.value.slice(1);
             if (node.attributes[attrib] || node.state[attrib])
               this.format_(node, cond.nextSibling, buff);
             else
               this.format_(node, cond.nextSibling.nextSibling, buff);
           } else if (token == 'earcon') {
             // Assumes there's existing output in our buffer.
             var lastBuff = buff[buff.length - 1];
             if (!lastBuff)
               return;
 
             lastBuff.setSpan(
                 new Output.EarconAction(tree.firstChild.value), 0, 0);
+          } else if (token == 'countChildren') {
+            var role = tree.firstChild.value;
+            var count = node.children.filter(function(e) {
+              return e.role == role;
+            }).length;
+            this.append_(buff, String(count));
           }
         }
       } else if (prefix == '@') {
         // Tokens can have substitutions.
         var pieces = token.split('+');
         token = pieces.reduce(function(prev, cur) {
           var lookup = cur;
           if (cur[0] == '$')
             lookup = node.attributes[cur.slice(1)];
           return prev + lookup;
         }.bind(this), '');
         var msgId = token;
         var msgArgs = [];
         var curMsg = tree.firstChild;
 
         while (curMsg) {
           var arg = curMsg.value;
           if (arg[0] != '$') {
             console.error('Unexpected value: ' + arg);
             return;
           }
           var msgBuff = [];
-          this.format_(node, arg, msgBuff);
+          this.format_(node, curMsg, msgBuff);
           msgArgs = msgArgs.concat(msgBuff);
           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) {}
 
         if (msg) {
@@ skipping 211 matching lines @@
     }
 
     if (currentNode != root)
       throw 'Unbalanced parenthesis.';
 
     return root;
   }
 };
 
 });  // goog.scope