Update json_schema_compiler to handle the Automation extension API

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 12 matching lines @@
 goog.require('cvox.TtsCategory');
 goog.require('cvox.ValueSelectionSpan');
 goog.require('cvox.ValueSpan');
 goog.require('goog.i18n.MessageFormat');
 
 goog.scope(function() {
 var AutomationNode = chrome.automation.AutomationNode;
 var Dir = constants.Dir;
 var EventType = chrome.automation.EventType;
 var RoleType = chrome.automation.RoleType;
+var StateType = chrome.automation.StateType;
 
 /**
  * An Output object formats a cursors.Range into speech, braille, or both
  * representations. This is typically a |Spannable|.
  *
  * The translation from Range to these output representations rely upon format
  * rules which specify how to convert AutomationNode objects into annotated
  * strings.
  * The format of these rules is as follows.
  *
@@ skipping 935 matching lines @@
     if (prevRange && !prevRange.isValid())
       prevRange = null;
 
     // Scan unique ancestors to get the value of |outputContextFirst|.
     var parent = range.start.node;
     var prevParent = prevRange ? prevRange.start.node : parent;
     if (!parent || !prevParent)
       return;
     var uniqueAncestors = AutomationUtil.getUniqueAncestors(prevParent, parent);
     for (var i = 0; parent = uniqueAncestors[i]; i++) {
-      if (parent.role == RoleType.window)
+      if (parent.role == RoleType.WINDOW)
         break;
       if (Output.ROLE_INFO_[parent.role] &&
           Output.ROLE_INFO_[parent.role].outputContextFirst) {
         this.outputContextFirst_ = true;
         break;
       }
     }
 
     if (range.isSubNode())
       this.subNode_(range, prevRange, type, buff);
@@ skipping 45 matching lines @@
       if (options.isUnique)
         token = token.substring(0, token.length - 1);
 
       // Process token based on prefix.
       var prefix = token[0];
       token = token.slice(1);
 
       // All possible tokens based on prefix.
       if (prefix == '$') {
         if (token == 'value') {
-          var text = node.value;
-          if (!node.state.editable && node.name == text)
+          var text = node.value || '';
+          if (!node.state[StateType.EDITABLE] && node.name == text)
             return;
 
           var selectedText = '';
-          if (text !== undefined) {
-            if (node.textSelStart !== undefined) {
-              options.annotation.push(new Output.SelectionSpan(
-                  node.textSelStart,
-                  node.textSelEnd));
+          if (node.textSelStart !== undefined) {
+            options.annotation.push(new Output.SelectionSpan(
+                node.textSelStart || 0,
+                node.textSelEnd || 0));
 
-              selectedText =
-                  node.value.substring(node.textSelStart, node.textSelEnd);
-            }
+            selectedText =
+                node.value.substring(node.textSelStart || 0,
+                                     node.textSelEnd || 0);
           }
           options.annotation.push(token);
           if (selectedText && !this.formatOptions_.braille) {
             this.append_(buff, selectedText, options);
             this.append_(buff, Msgs.getMsg('selected'));
           } else {
             this.append_(buff, text, options);
           }
         } else if (token == 'name') {
           options.annotation.push(token);
           var earcon = node ? this.findEarcon_(node, opt_prevNode) : null;
           if (earcon)
             options.annotation.push(earcon);
-          this.append_(buff, node.name, options);
+          this.append_(buff, node.name || '', options);
         } else if (token == 'urlFilename') {
           options.annotation.push('name');
-          var url = node.url;
+          var url = node.url || '';
           var filename = '';
           if (url.substring(0, 4) != 'data') {
             filename =
                 url.substring(url.lastIndexOf('/') + 1, url.lastIndexOf('.'));
 
             // Hack to not speak the filename if it's ridiculously long.
             if (filename.length >= 30)
             filename = filename.substring(0, 16) + '...';
           }
           this.append_(buff, filename, options);
         } else if (token == 'nameFromNode') {
-          if (chrome.automation.NameFromType[node.nameFrom] ==
-              'contents')
+          if (node.nameFrom == chrome.automation.NameFromType.CONTENTS)
             return;
 
           options.annotation.push('name');
-          this.append_(buff, node.name, options);
+          this.append_(buff, node.name || '', options);
         } else if (token == 'nameOrDescendants') {
           options.annotation.push(token);
           if (node.name)
-            this.append_(buff, node.name, options);
+            this.append_(buff, node.name || '', options);
           else
             this.format_(node, '$descendants', buff);
         } else if (token == 'description') {
           if (node.name == node.description || node.value == node.description)
             return;
           options.annotation.push(token);
-          this.append_(buff, node.description, options);
+          this.append_(buff, node.description || '', options);
         } else if (token == 'indexInParent') {
           if (node.parent) {
             options.annotation.push(token);
             var count = 0;
             for (var i = 0, child; child = node.parent.children[i]; i++) {
               if (node.role == child.role)
                 count++;
               if (node === child)
                 break;
             }
@@ skipping 14 matching lines @@
             case 'mixed':
               msg = 'aria_checked_mixed';
               break;
             case 'true':
               msg = 'aria_checked_true';
               break;
             case 'false':
               msg = 'aria_checked_false';
               break;
             default:
-            msg =
-                node.state.checked ? 'aria_checked_true' : 'aria_checked_false';
+              msg = node.state[StateType.CHECKED] ?
+                  'aria_checked_true' : 'aria_checked_false';
           }
           this.format_(node, '@' + msg, buff);
         } else if (token == 'state') {
-          Object.getOwnPropertyNames(node.state).forEach(function(s) {
-            var stateInfo = Output.STATE_INFO_[s];
-            if (stateInfo && !stateInfo.isRoleSpecific && stateInfo.on)
+          if (node.state) {
+            Object.getOwnPropertyNames(node.state).forEach(function(s) {
+              var stateInfo = Output.STATE_INFO_[s];
+              if (stateInfo && !stateInfo.isRoleSpecific && stateInfo.on)
               this.format_(node, '@' + stateInfo.on.msgId, buff);
-          }.bind(this));
+            }.bind(this));
+          }
         } 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)));
+                /** @type {chrome.automation.FindParams}*/(
+                    JSON.parse(jsonQuery)));
             var formatString = tree.firstChild.nextSibling;
             if (node)
               this.format_(node, formatString, buff);
           }
         } else if (token == 'descendants') {
           if (!node || AutomationPredicate.leafOrStaticText(node))
             return;
 
           // Construct a range to the leftmost and rightmost leaves.
           var leftmost = AutomationUtil.findNodePre(
@@ skipping 26 matching lines @@
           var msg = node.role;
           var info = Output.ROLE_INFO_[node.role];
           if (info) {
             if (this.formatOptions_.braille)
               msg = Msgs.getMsg(info.msgId + '_brl');
             else
               msg = Msgs.getMsg(info.msgId);
           } else {
             console.error('Missing role info for ' + node.role);
           }
-          this.append_(buff, msg, options);
+          this.append_(buff, msg || '', options);
         } else if (token == 'inputType') {
           if (!node.inputType)
             return;
           options.annotation.push(token);
           var msgId = Output.INPUT_TYPE_MESSAGE_IDS_[node.inputType] ||
               'input_type_text';
           if (this.formatOptions_.braille)
             msgId = msgId + '_brl';
           this.append_(buff, Msgs.getMsg(msgId), options);
         } else if (token == 'tableCellRowIndex' ||
@@ skipping 34 matching lines @@
           this.append_(buff, value, options);
         } else if (Output.STATE_INFO_[token]) {
           options.annotation.push('state');
           var stateInfo = Output.STATE_INFO_[token];
           var resolvedInfo = {};
           resolvedInfo = node.state[token] ? stateInfo.on : stateInfo.off;
           if (!resolvedInfo)
             return;
           if (this.formatOptions_.speech && resolvedInfo.earconId) {
             options.annotation.push(
-                new Output.EarconAction(resolvedInfo.earconId), node.location);
+                new Output.EarconAction(resolvedInfo.earconId),
+                                        node.location || undefined);

[Dan Beam, 2017/01/11 23:04:26]

i'm not exactly sure why you need to do this.  is this to change from null to
undefined?

[dmazzoni, 2017/01/11 23:23:57]

Because the externs file says that node.location can be valid or null, but the
second argument to the function is *optional*,
and optional means valid or undefined.

           }
           var msgId =
               this.formatOptions_.braille ? resolvedInfo.msgId + '_brl' :
               resolvedInfo.msgId;
           var msg = 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[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)
               return;
 
             options.annotation.push(
-                new Output.EarconAction(tree.firstChild.value, node.location));
+                new Output.EarconAction(tree.firstChild.value,
+                                        node.location || undefined));
             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;
             this.append_(buff, String(count));
           }
         }
       } else if (prefix == '@') {
@@ skipping 146 matching lines @@
    */
   ancestry_: function(node, prevNode, type, buff) {
     // Expects |ancestors| to be ordered from root down to leaf. Outputs in
     // reverse; place context first nodes at the end.
     function byContextFirst(ancestors) {
       var contextFirst = [];
       var rest = [];
       for (i = 0; i < ancestors.length - 1; i++) {
         var node = ancestors[i];
         // Discard ancestors of deepest window.
-        if (node.role == RoleType.window) {
+        if (node.role == RoleType.WINDOW) {
           contextFirst = [];
           rest = [];
         }
         if ((Output.ROLE_INFO_[node.role] || {}).outputContextFirst)
           contextFirst.push(node);
         else
           rest.push(node);
       }
       return rest.concat(contextFirst.reverse());
     }
@@ skipping 143 matching lines @@
       }
     }
 
     if (this.outputContextFirst_)
       this.ancestry_(node, prevNode, type, buff);
     var earcon = this.findEarcon_(node, prevNode);
     if (earcon)
       options.annotation.push(earcon);
     var text = '';
 
-    if (this.formatOptions_.braille && !node.state.editable) {
+    if (this.formatOptions_.braille && !node.state[StateType.EDITABLE]) {
       // In braille, we almost always want to show the entire contents and
       // simply place the cursor under the SelectionSpan we set above.
       text = range.start.getText();
     } else {
       // This is output for speech or editable braille.
       text = range.start.getText().substring(rangeStart, rangeEnd);
     }
 
     this.append_(buff, text, options);
 
@@ skipping 122 matching lines @@
         return result;
       }
 
       // Keep track of if there's an inline node associated with
       // |cur|.
       var hasInlineNode = cur.getSpansInstanceOf(Output.NodeSpan)
           .some(function(s) {
             if (!s.node)
               return false;
             return s.node.display == 'inline' ||
-                s.node.role == RoleType.inlineTextBox;
+                s.node.role == RoleType.INLINE_TEXT_BOX;
           });
 
       var isName = cur.hasSpan('name');
 
       // Now, decide whether we should include separators between the previous
       // span and |cur|.
       // Never separate chunks without something already there at this point.
 
       // The only case where we know for certain that a separator is not needed
       // is when the previous and current values are in-lined and part of the
@@ skipping 30 matching lines @@
       var earconFinder = node;
       var ancestors;
       if (opt_prevNode)
         ancestors = AutomationUtil.getUniqueAncestors(opt_prevNode, node);
       else
         ancestors = AutomationUtil.getAncestors(node);
 
       while (earconFinder = ancestors.pop()) {
         var info = Output.ROLE_INFO_[earconFinder.role];
         if (info && info.earconId) {
-          return new Output.EarconAction(info.earconId, node.location);
+          return new Output.EarconAction(info.earconId,
+                                         node.location || undefined);
           break;
         }
         earconFinder = earconFinder.parent;
       }
     }
     return null;
   },
 
   /**
    * Gets a human friendly string with the contents of output.
@@ skipping 25 matching lines @@
   /**
    * Gets the output buffer for braille.
    * @return {!Spannable}
    */
   get brailleOutputForTest() {
     return this.mergeBraille_(this.brailleBuffer_);
   }
 };
 
 });  // goog.scope