Add support for Chrome Apps to IDL lexer/parser

ppapi/generators/idl_parser.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.
 
 """ Parser for PPAPI IDL """
 
 #
 # IDL Parser
 #
@@ skipping 195 matching lines @@
 #
 # We force all input files to start with two comments.  The first comment is a
 # Copyright notice followed by a set of file wide Extended Attributes, followed
 # by the file comment and finally by file level patterns.
 #
   # Find the Copyright, File comment, and optional file wide attributes.  We
   # use a match with COMMENT instead of comments to force the token to be
   # present.  The extended attributes and the top_list become siblings which
   # in turn are children of the file object created from the results of top.
   def p_top(self, p):
-    """top : COMMENT COMMENT ext_attr_block top_list"""
+    """top : top_list
+           | namespace"""

[noelallen1, 2012/02/28 22:31:33]

I would encourage us to use the copyright notice consistently, however I agree
with the rest.

It would be nice if we can find a way to keep the ability of associating a
comment and attributes with the entire file.   One possibility is a specialized
Copyright regex in the lexer for that particular case.

[asargent_no_longer_on_chrome, 2012/03/03 01:12:02]

I fell back to leaving this as-is for now, and will look into future changes to
allow a file-level comment but still require a copyright. 

+    # TODO(noelallen) - push the expectation of copyright/filedoc comments out
+    # of the parser and into the PPAPI-specific codegen.
+    if len(p[1]) > 0 and p[1][0].cls != 'Namespace':
+      # Hack to pull out the first two comments from the children of |top_list|

[noelallen1, 2012/02/28 22:31:33]

Lets find a better solution for this hack.

[asargent_no_longer_on_chrome, 2012/03/03 01:12:02]

Removed it per above comment.

+      # and insert them into the top-level list we return in p[0]
+      assert len(p[1][0].children) >= 2
+      for i in (0, 1):
+        assert p[1][0].children[i].cls == 'Comment'
+      copyright_comment = p[1][0].children.pop(0)
+      copyright_comment.cls = 'Copyright'
+      filedoc_comment = p[1][0].children.pop(0)
+      p[0] = ListFromConcat(copyright_comment, filedoc_comment, p[1])
+    else:
+      p[0] = ListFromConcat(p[1])
+    if self.parse_debug: DumpReduction('top', p)
 
-    Copyright = self.BuildComment('Copyright', p, 1)
-    Filedoc = self.BuildComment('Comment', p, 2)
+  def p_namespace(self, p):
+    """namespace : modifiers NAMESPACE namespace_name '{' top_list '}' ';'"""
+    children = ListFromConcat(p[1], p[5])
+    p[0] = self.BuildNamed('Namespace', p, 3, children)
 
-    p[0] = ListFromConcat(Copyright, Filedoc, p[3], p[4])
-    if self.parse_debug: DumpReduction('top', p)
+  # We allow namespace names of the form foo.bar.baz.
+  def p_namespace_name(self, p):
+    """namespace_name : SYMBOL
+                      | SYMBOL '.' namespace_name"""
+    p[0] = "".join(p[1:])
+
+  def p_dictionary_block(self, p):
+    """dictionary_block : modifiers DICTIONARY SYMBOL '{' struct_list '}' ';'"""
+    p[0] = self.BuildNamed('Dictionary', p, 3, ListFromConcat(p[5]))
+
+  def p_callback_decl(self, p):
+    """callback_decl : modifiers CALLBACK SYMBOL '=' SYMBOL param_list ';'"""
+    children = ListFromConcat(p[1], p[6])
+    p[0] = self.BuildNamed('Callback', p, 3, children)
 
   # Build a list of top level items.
   def p_top_list(self, p):
-    """top_list : describe_block top_list
+    """top_list : dictionary_block top_list
+                | describe_block top_list
                 | enum_block top_list
                 | inline top_list
                 | interface_block top_list
                 | label_block top_list
                 | struct_block top_list
                 | typedef_decl top_list
+                | callback_decl top_list
                 | """
     if len(p) > 2:
       p[0] = ListFromConcat(p[1], p[2])
     if self.parse_debug: DumpReduction('top_list', p)
 
   # Recover from error and continue parsing at the next top match.
   def p_top_error(self, p):
     """top_list : error top_list"""
     p[0] = p[2]
 
@@ skipping 232 matching lines @@
       p[0] = ListFromConcat(array, p[3])
     # If there are 4 tokens plus a return slot it is a fixed array
     elif len(p) == 5:
       count = self.BuildAttribute('FIXED', p[2])
       array = self.BuildProduction('Array', p, 2, [count])
       p[0] = ListFromConcat(array, p[4])
     # If there is only a return slot, do not fill it for this terminator.
     elif len(p) == 1: return
     if self.parse_debug: DumpReduction('arrays', p)
 
+
+# An identifier is a legal value for a parameter or attribute name.
+  def p_identifier(self, p):
+    """identifier : SYMBOL
+                  | CALLBACK"""
+    p[0] = p[1]
+
 #
 # Parameter List
 #
 # A parameter list is a collection of arguments which are passed to a
 # function.
 #
   def p_param_list(self, p):
     """param_list : '(' param_item param_cont ')'
                   | '(' ')' """
     if len(p) > 3:
       args = ListFromConcat(p[2], p[3])
     else:
       args = []
     p[0] = self.BuildProduction('Callspec', p, 1, args)
     if self.parse_debug: DumpReduction('param_list', p)
 
   def p_param_item(self, p):
-    """param_item : modifiers SYMBOL arrays SYMBOL"""
-    typeref = self.BuildAttribute('TYPEREF', p[2])
-    children = ListFromConcat(p[1],typeref, p[3])
-    p[0] = self.BuildNamed('Param', p, 4, children)
+    """param_item : modifiers optional SYMBOL arrays identifier"""
+    typeref = self.BuildAttribute('TYPEREF', p[3])
+    children = ListFromConcat(p[1],p[2], typeref, p[4])
+    p[0] = self.BuildNamed('Param', p, 5, children)
     if self.parse_debug: DumpReduction('param_item', p)
 
+  def p_optional(self, p):
+    """optional : OPTIONAL
+                | """
+    if len(p) == 2:
+      p[0] = self.BuildAttribute('OPTIONAL', True)
+
+
   def p_param_cont(self, p):
     """param_cont : ',' param_item param_cont
                   | """
     if len(p) > 1:
       p[0] = ListFromConcat(p[2], p[3])
       if self.parse_debug: DumpReduction('param_cont', p)
 
   def p_param_error(self, p):
     """param_cont : error param_cont"""
     p[0] = p[2]
 
 
 #
 # Typedef
 #
-# A typedef creates a new referencable type.  The tyepdef can specify an array
+# A typedef creates a new referencable type.  The typedef can specify an array
 # definition as well as a function declaration.
 #
   def p_typedef_data(self, p):
     """typedef_decl : modifiers TYPEDEF SYMBOL SYMBOL ';' """
     typeref = self.BuildAttribute('TYPEREF', p[3])
     children = ListFromConcat(p[1], typeref)
     p[0] = self.BuildNamed('Typedef', p, 4, children)
     if self.parse_debug: DumpReduction('typedef_data', p)
 
   def p_typedef_array(self, p):
@@ skipping 74 matching lines @@
     p[0] = p[2]
     if self.parse_debug: DumpReduction('label_error', p)
 
 
 #
 # Members
 #
 # A member attribute or function of a struct or interface.
 #
   def p_member_attribute(self, p):
-    """member_attribute : modifiers SYMBOL SYMBOL """
+    """member_attribute : modifiers SYMBOL arrays questionmark identifier"""
     typeref = self.BuildAttribute('TYPEREF', p[2])
-    children = ListFromConcat(p[1], typeref)
-    p[0] = self.BuildNamed('Member', p, 3, children)
-    if self.parse_debug: DumpReduction('attribute', p)
-
-  def p_member_attribute_array(self, p):
-    """member_attribute : modifiers SYMBOL arrays SYMBOL """
-    typeref = self.BuildAttribute('TYPEREF', p[2])
-    children = ListFromConcat(p[1], typeref, p[3])
-    p[0] = self.BuildNamed('Member', p, 4, children)
+    children = ListFromConcat(p[1], typeref, p[3], p[4])
+    p[0] = self.BuildNamed('Member', p, 5, children)
     if self.parse_debug: DumpReduction('attribute', p)
 
   def p_member_function(self, p):
-    """member_function : modifiers SYMBOL SYMBOL param_list"""
-    typeref = self.BuildAttribute('TYPEREF', p[2])
-    children = ListFromConcat(p[1], typeref, p[4])
-    p[0] = self.BuildNamed('Member', p, 3, children)
+    """member_function : modifiers static SYMBOL SYMBOL param_list"""
+    typeref = self.BuildAttribute('TYPEREF', p[3])
+    children = ListFromConcat(p[1], p[2], typeref, p[5])
+    p[0] = self.BuildNamed('Member', p, 4, children)
     if self.parse_debug: DumpReduction('function', p)
 
+  def p_static(self, p):
+    """static : STATIC
+              | """
+    if len(p) == 2:
+      p[0] = self.BuildAttribute('STATIC', True)
+
+  def p_questionmark(self, p):
+    """questionmark : '?'
+                    | """
+    if len(p) == 2:
+      p[0] = self.BuildAttribute('OPTIONAL', True)
+
 #
 # Interface
 #
 # An interface is a named collection of functions.
 #
   def p_interface_block(self, p):
     """interface_block : modifiers INTERFACE SYMBOL '{' interface_list '}' ';'"""
     p[0] = self.BuildNamed('Interface', p, 3, ListFromConcat(p[1], p[5]))
     if self.parse_debug: DumpReduction('interface_block', p)
 
@@ skipping 400 matching lines @@
   ast = ParseFiles(filenames)
   errs = ast.GetProperty('ERRORS')
   if errs:
     ErrOut.Log('Found %d error(s).' % errs);
   InfoOut.Log("%d files processed." % len(filenames))
   return errs
 
 
 if __name__ == '__main__':
   sys.exit(Main(sys.argv[1:]))