Pepper IDL: Check for structs in callbacks.

ppapi/generators/idl_c_header.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.
 
 """ Generator for C style prototypes and definitions """
 
 import glob
 import os
 import re
@@ skipping 121 matching lines @@
           form = 'PP_COMPILE_ASSERT_SIZE_IN_BYTES(%s, %s);\n'
       else:
         form = 'PP_COMPILE_ASSERT_SIZE_IN_BYTES(%s, %s);\n'
       item += form % (name, asize[0])
 
     if item: out.Write(item)
   if last_group:
     out.Write(CommentLines(['*',' @}', '']) + '\n')
 
 
+def CheckTypedefs(filenode, releases):
+  """Checks that typedefs don't specify callbacks that take some structs.
+
+  See http://crbug.com/233439 for details.
+  """
+  cgen = CGen()
+  # TODO(teravest): Allow PP_Var structs to be passed as callback parameters.

[Mark Seaborn, 2013/04/23 15:08:47]

We don't want to allow PP_Var to be passed by value in typedef'd callbacks. 
Maybe write "Fix the following callback to pass PP_Var by pointer rather than by
value".

+  node_whitelist = ('PP_Ext_Alarms_OnAlarm_Func_Dev_0_1',)

[Mark Seaborn, 2013/04/23 15:08:47]

Nit: '[]' lists are a little neater than '(,)' tuples for variable-length lists
since there's no odd trailing comma in the singleton case.

+  for node in filenode.GetListOf('Typedef'):
+    if node.GetName() in node_whitelist:
+      continue
+    build_list = node.GetUniqueReleases(releases)
+    callnode = node.GetOneOf('Callspec')
+    if callnode:
+      for param in callnode.GetListOf('Param'):
+        if param.GetListOf('Array'):
+          continue
+        if cgen.GetParamMode(param) != 'in':
+          continue
+        t = param.GetType(build_list[0])
+        if t.IsA('Struct'):

[Mark Seaborn, 2013/04/23 15:08:47]

How about:

while t.IsA('Typedef'):
  t = t.GetType(build_list[0])

I don't know if you need to handle multiple levels of typedefs, but this at
least means you don't have to duplicate the struct check + error message.

+          raise Exception('%s is a struct in callback %s. '
+                          'See http://crbug.com/233439' %
+                          (t.GetName(), node.GetName()))
+        elif t.IsA('Typedef'):
+          if t.GetType(build_list[0]).IsA('Struct'):
+            raise Exception('%s is a struct in callback %s. '
+                            'See http://crbug.com/233439' %
+                            (t.GetName(), node.GetName()))
+
 class HGen(GeneratorByFile):
   def __init__(self):
     Generator.__init__(self, 'C Header', 'cgen', 'Generate the C headers.')
 
   def GenerateFile(self, filenode, releases, options):
+    CheckTypedefs(filenode, releases)
     savename = GetHeaderFromNode(filenode, GetOption('dstroot'))
     my_min, my_max = filenode.GetMinMax(releases)
     if my_min > releases[-1] or my_max < releases[0]:
       if os.path.isfile(savename):
         print "Removing stale %s for this range." % filenode.GetName()
         os.remove(os.path.realpath(savename))
       return False
 
     out = IDLOutFile(savename)
     self.GenerateHead(out, filenode, releases, options)
@@ skipping 133 matching lines @@
     print "Golden file for M13-M15 failed."
     failed =1
   else:
     print "Golden file for M13-M15 passed."
 
   return failed
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv[1:]))