Switch the downloads API over to IDL/json_schema_compiler

tools/json_schema_compiler/idl_schema.py

 #! /usr/bin/env python
 # Copyright (c) 2012 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.
 
 import itertools
 import json
 import os.path
 import re
 import sys
@@ skipping 37 matching lines @@
       {
         'parameter_name_1': "The comment that followed |parameter_name_1|:",
         ...
       }
     )
   '''
 
   # Escape double quotes.
   comment = comment.replace('"', '\\"');
 
-  # Find all the parameter comments of the form "|name|: comment".
+  # Find all the parameter comments of the form '|name|: comment'.
   parameter_starts = list(re.finditer(r'\n *\|([^|]*)\| *: *', comment))
 
   # Get the parent comment (everything before the first parameter comment.
   first_parameter_location = (parameter_starts[0].start()
                               if parameter_starts else len(comment))
   parent_comment = comment[:first_parameter_location]
   parent_comment = parent_comment.replace('\n', '').strip()
 
   params = {}
   for (cur_param, next_param) in itertools.izip_longest(parameter_starts,
@@ skipping 28 matching lines @@
 
 class Param(object):
   '''
   Given a Param node representing a function parameter, converts into a Python
   dictionary that the JSON schema compiler expects to see.
   '''
   def __init__(self, param_node):
     self.node = param_node
 
   def process(self, callbacks):
-    return Typeref(self.node.GetProperty( 'TYPEREF'),
+    return Typeref(self.node.GetProperty('TYPEREF'),
                    self.node,
-                   { 'name': self.node.GetName() }).process(callbacks)
+                   {'name': self.node.GetName()}).process(callbacks)
 
 class Dictionary(object):
   '''
   Given an IDL Dictionary node, converts into a Python dictionary that the JSON
   schema compiler expects to see.
   '''
   def __init__(self, dictionary_node):
     self.node = dictionary_node
 
   def process(self, callbacks):
     properties = {}
     for node in self.node.children:
       if node.cls == 'Member':
         k, v = Member(node).process(callbacks)
         properties[k] = v
-    return { 'id': self.node.GetName(),
-             'properties': properties,
-             'type': 'object' }
-
-class Enum(object):
-  '''
-  Given an IDL Enum node, converts into a Python dictionary that the JSON
-  schema compiler expects to see.
-  '''
-  def __init__(self, enum_node):
-    self.node = enum_node
-
-  def process(self, callbacks):
-    enum = []
-    for node in self.node.children:
-      if node.cls == 'EnumItem':
-        name = node.GetName()
-        enum.append(name)
-      else:
-        sys.exit("Did not process %s %s" % (node.cls, node))
-    return { "id" : self.node.GetName(),
-             'enum': enum,
-             'type': 'string' }
-
+    result = {'id': self.node.GetName(),
+              'properties': properties,
+              'type': 'object'}
+    if self.node.GetProperty('inline_doc'):
+      result['inline_doc'] = True
+    return result
 
 
 class Member(object):
   '''
   Given an IDL dictionary or interface member, converts into a name/value pair
   where the value is a Python dictionary that the JSON schema compiler expects
   to see.
   '''
   def __init__(self, member_node):
     self.node = member_node
 
   def process(self, callbacks):
     properties = {}
     name = self.node.GetName()
     for property_name in ('OPTIONAL', 'nodoc', 'nocompile'):
       if self.node.GetProperty(property_name):
         properties[property_name.lower()] = True
     is_function = False
     parameter_comments = {}
     for node in self.node.children:
       if node.cls == 'Comment':
         (parent_comment, parameter_comments) = ProcessComment(node.GetName())
         properties['description'] = parent_comment
-    for node in self.node.children:
-      if node.cls == 'Callspec':
+      elif node.cls == 'Callspec':
         is_function = True
         name, parameters = Callspec(node, parameter_comments).process(callbacks)
         properties['parameters'] = parameters
     properties['name'] = name
     if is_function:
       properties['type'] = 'function'
     else:
       properties = Typeref(self.node.GetProperty('TYPEREF'),
                            self.node, properties).process(callbacks)
+    enum_values = self.node.GetProperty('legalValues')
+    if enum_values:
+      if properties['type'] == 'integer':
+        enum_values = map(int, enum_values)
+      elif properties['type'] == 'double':
+        enum_values = map(float, enum_values)
+      properties['enum'] = enum_values
     return name, properties
 
 class Typeref(object):
   '''
   Given a TYPEREF property representing the type of dictionary member or
   function parameter, converts into a Python dictionary that the JSON schema
   compiler expects to see.
   '''
   def __init__(self, typeref, parent, additional_properties={}):
     self.typeref = typeref
@@ skipping 40 matching lines @@
     elif self.typeref is None:
       properties['type'] = 'function'
     else:
       if self.typeref in callbacks:
         properties.update(callbacks[self.typeref])
       else:
         properties['$ref'] = self.typeref
 
     return result
 
+
+class Enum(object):
+  '''
+  Given an IDL Enum node, converts into a Python dictionary that the JSON
+  schema compiler expects to see.
+  '''
+  def __init__(self, enum_node):
+    self.node = enum_node
+    self.description = ''
+
+  def process(self, callbacks):
+    enum = []
+    for node in self.node.children:
+      if node.cls == 'EnumItem':
+        enum.append(node.GetName())
+      elif node.cls == 'Comment':
+        self.description = ProcessComment(node.GetName())[0]
+      else:
+        sys.exit('Did not process %s %s' % (node.cls, node))
+    result = {'id' : self.node.GetName(),
+              'description': self.description,
+              'type': 'string',
+              'enum': enum}
+    if self.node.GetProperty('inline_doc'):
+      result['inline_doc'] = True
+    return result
+
+
 class Namespace(object):
   '''
   Given an IDLNode representing an IDL namespace, converts into a Python
   dictionary that the JSON schema compiler expects to see.
   '''
 
-  def __init__(self, namespace_node, nodoc=False):
+  def __init__(self, namespace_node, nodoc=False, permissions=None):
     self.namespace = namespace_node
     self.nodoc = nodoc
     self.events = []
     self.functions = []
     self.types = []
     self.callbacks = {}
+    self.permissions = permissions or []
 
   def process(self):
     for node in self.namespace.children:
-      cls = node.cls
-      if cls == "Dictionary":
+      if node.cls == 'Dictionary':
         self.types.append(Dictionary(node).process(self.callbacks))
-      elif cls == "Callback":
+      elif node.cls == 'Callback':
         k, v = Member(node).process(self.callbacks)
         self.callbacks[k] = v
-      elif cls == "Interface" and node.GetName() == "Functions":
+      elif node.cls == 'Interface' and node.GetName() == 'Functions':
         self.functions = self.process_interface(node)
-      elif cls == "Interface" and node.GetName() == "Events":
+      elif node.cls == 'Interface' and node.GetName() == 'Events':
         self.events = self.process_interface(node)
-      elif cls == "Enum":
+      elif node.cls == 'Enum':
         self.types.append(Enum(node).process(self.callbacks))
       else:
-        sys.exit("Did not process %s %s" % (node.cls, node))
-
-    return { 'events': self.events,
-             'functions': self.functions,
-             'types': self.types,
-             'namespace': self.namespace.GetName(),
-             'nodoc': self.nodoc }
+        sys.exit('Did not process %s %s' % (node.cls, node))
+    return {'namespace': self.namespace.GetName(),
+            'nodoc': self.nodoc,
+            'documentation_permissions_required': self.permissions,
+            'types': self.types,
+            'functions': self.functions,
+            'events': self.events}
 
   def process_interface(self, node):
     members = []
     for member in node.children:
       if member.cls == 'Member':
         name, properties = Member(member).process(self.callbacks)
         members.append(properties)
     return members
 
 class IDLSchema(object):
   '''
   Given a list of IDLNodes and IDLAttributes, converts into a Python list
   of api_defs that the JSON schema compiler expects to see.
   '''
 
   def __init__(self, idl):
     self.idl = idl
 
   def process(self):
     namespaces = []
+    nodoc = False
+    permissions = None
     for node in self.idl:
-      nodoc = False
-      cls = node.cls
-      if cls == 'Namespace':
-        namespace = Namespace(node, nodoc)
+      if node.cls == 'Namespace':
+        namespace = Namespace(node, nodoc, permissions)
         namespaces.append(namespace.process())
-      elif cls == 'Copyright':
+      elif node.cls == 'Copyright':
         continue
-      elif cls == 'Comment':
+      elif node.cls == 'Comment':
         continue
-      elif cls == 'ExtAttribute':
+      elif node.cls == 'ExtAttribute':
         if node.name == 'nodoc':
           nodoc = bool(node.value)
+        elif node.name == 'permissions':
+          permission = node.value.split(',')
         else:
           continue
       else:
-        sys.exit("Did not process %s %s" % (node.cls, node))
+        sys.exit('Did not process %s %s' % (node.cls, node))
     schema_util.PrefixSchemasWithNamespace(namespaces)
     return namespaces
 
 def Load(filename):
   '''
   Given the filename of an IDL file, parses it and returns an equivalent
   Python dictionary in a format that the JSON schema compiler expects to see.
   '''
 
   f = open(filename, 'r')
   contents = f.read()
   f.close()
 
   idl = idl_parser.IDLParser().ParseData(contents, filename)
   idl_schema = IDLSchema(idl)
   return idl_schema.process()
 
 def Main():
   '''
   Dump a json serialization of parse result for the IDL files whose names
   were passed in on the command line.
   '''
   for filename in sys.argv[1:]:
     schema = Load(filename)
     print json.dumps(schema, indent=2)
 
 if __name__ == '__main__':
   Main()