IDL: Autogenerate thunk for PPB_Gamepad.

ppapi/generators/idl_thunk.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 thunks """
 
 import glob
 import os
 import re
@@ skipping 17 matching lines @@
     self.value = msg
 
   def __str__(self):
     return repr(self.value)
 
 
 class ThunkBodyMetadata(object):
   """Metadata about thunk body. Used for selecting which headers to emit."""
   def __init__(self):
     self._apis = set()
+    self._builtin_includes = set()
     self._includes = set()
 
   def AddApi(self, api):
     self._apis.add(api)
 
   def Apis(self):
     return self._apis
 
   def AddInclude(self, include):
     self._includes.add(include)
 
   def Includes(self):
     return self._includes
 
+  def AddBuiltinInclude(self, include):
+    self._builtin_includes.add(include)
+
+  def BuiltinIncludes(self):
+    return self._builtin_includes
+
 
 def _GetBaseFileName(filenode):
   """Returns the base name for output files, given the filenode.
 
   Examples:
     'dev/ppb_find_dev.h' -> 'ppb_find_dev'
     'trusted/ppb_buffer_trusted.h' -> 'ppb_buffer_trusted'
   """
   path, name = os.path.split(filenode.GetProperty('NAME'))
   name = os.path.splitext(name)[0]
@@ skipping 14 matching lines @@
 def _GetThunkFileName(filenode, relpath):
   """Returns the thunk file name."""
   path = os.path.split(filenode.GetProperty('NAME'))[0]
   name = _GetBaseFileName(filenode)
   # We don't reattach the path for thunk.
   if relpath: name = os.path.join(relpath, name)
   name = '%s%s' % (name, '_thunk.cc')
   return name
 
 
+def _AddApiHeader(filenode, meta):
+  """Adds an API header for the given file to the ThunkBodyMetadata."""
+  # The API header matches the file name, not the interface name.
+  api_basename = _GetBaseFileName(filenode)
+  if api_basename.endswith('_dev'):
+    api_basename = api_basename[:-len('_dev')]
+  if api_basename.endswith('_trusted'):
+    api_basename = api_basename[:-len('_trusted')]
+  meta.AddApi(api_basename + '_api')
+
+
 def _MakeEnterLine(filenode, interface, arg, handle_errors, callback, meta):
   """Returns an EnterInstance/EnterResource string for a function."""
+  api_name = interface.GetName()
+  if api_name.endswith('Trusted'):
+    api_name = api_name[:-len('Trusted')]
+  if api_name.endswith('_Dev'):
+    api_name = api_name[:-len('_Dev')]
+  api_name += '_API'
+
   if arg[0] == 'PP_Instance':
     if callback is None:
-      return 'EnterInstance enter(%s);' % arg[1]
+      arg_string = arg[1]
     else:
-      return 'EnterInstance enter(%s, %s);' % (arg[1], callback)
+      arg_string = '%s, %s' % (arg[1], callback)
+    if interface.GetProperty('singleton_resource'):
+      _AddApiHeader(filenode, meta)
+      return 'EnterInstanceAPI<%s> enter(%s);' % (api_name, arg_string)
+    else:
+      return 'EnterInstance enter(%s);' % arg_string
   elif arg[0] == 'PP_Resource':
-    api_name = interface.GetName()
-    if api_name.endswith('Trusted'):
-      api_name = api_name[:-len('Trusted')]
-    if api_name.endswith('_Dev'):
-      api_name = api_name[:-len('_Dev')]
-    api_name += '_API'
-
     enter_type = 'EnterResource<%s>' % api_name
-    # The API header matches the file name, not the interface name.
-    api_basename = _GetBaseFileName(filenode)
-    if api_basename.endswith('_dev'):
-      # Clip off _dev suffix.
-      api_basename = api_basename[:-len('_dev')]
-    if api_basename.endswith('_trusted'):
-      # Clip off _trusted suffix.
-      api_basename = api_basename[:-len('_trusted')]
-    meta.AddApi(api_basename + '_api')
-
+    _AddApiHeader(filenode, meta)
     if callback is None:
       return '%s enter(%s, %s);' % (enter_type, arg[1],
                                     str(handle_errors).lower())
     else:
       return '%s enter(%s, %s, %s);' % (enter_type, arg[1],
                                         callback,
                                         str(handle_errors).lower())
   else:
     raise TGenError("Unknown type for _MakeEnterLine: %s" % arg[0])
 
@@ skipping 111 matching lines @@
   if is_callback_func:
     body = '%s\n' % _MakeEnterLine(filenode, node, args[0], handle_errors,
                                    args[len(args) - 1][1], meta)
     body += 'if (enter.failed())\n'
     value = member.GetProperty('on_failure')
     if value is None:
       value = 'enter.retval()'
     body += '  return %s;\n' % value
     body += 'return enter.SetResult(%s);' % invocation
   elif rtype == 'void':
+    # On failure, zero out all output parameters.
+    out_params = []
+    callnode = member.GetOneOf('Callspec')
+    if callnode:
+      cgen = CGen()
+      for param in callnode.GetListOf('Param'):
+        mode = cgen.GetParamMode(param)
+        if mode == 'out':
+          # We use the 'store' mode when getting the parameter type, since we
+          # need to call sizeof() for memset().
+          ptype, pname, _, _ = cgen.GetComponents(param, release, 'store')
+          out_params.append((pname, ptype))
+
     body = '%s\n' % _MakeEnterLine(filenode, node, args[0], handle_errors,
                                    None, meta)
-    body += 'if (enter.succeeded())\n'
-    body += '  %s;' % invocation
+    if not out_params:
+      body += 'if (enter.succeeded())\n'
+      body += '  %s;' % invocation
+    else:
+      body += 'if (enter.succeeded()) {\n'
+      body += '  %s;\n' % invocation
+      body += '  return;\n'
+      body += '}'
+      for param in out_params:
+        body += '\nmemset(%s, 0, sizeof(%s));' % param
+      meta.AddBuiltinInclude('string.h')
+
   else:
     value = member.GetProperty('on_failure')
     if value is None:
       value = _GetDefaultFailureValue(rtype)
     if value is None:
       raise TGenError('No default value for rtype %s' % rtype)
 
     body = '%s\n' % _MakeEnterLine(filenode, node, args[0], handle_errors,
                                    None, meta)
     body += 'if (enter.failed())\n'
@@ skipping 96 matching lines @@
     # Wrap the From ... modified ... comment if it would be >80 characters.
     from_text = 'From %s' % (
         filenode.GetProperty('NAME').replace(os.sep,'/'))
     modified_text = 'modified %s.' % (
         filenode.GetProperty('DATETIME'))
     if len(from_text) + len(modified_text) < 74:
       out.Write('// %s %s\n\n' % (from_text, modified_text))
     else:
       out.Write('// %s,\n//   %s\n\n' % (from_text, modified_text))
 
+    if meta.BuiltinIncludes():
+      for include in sorted(meta.BuiltinIncludes()):
+        out.Write('#include <%s>\n' % include)
+      out.Write('\n')
 
     # TODO(teravest): Don't emit includes we don't need.
     includes = ['ppapi/c/pp_errors.h',
                 'ppapi/shared_impl/tracked_callback.h',
                 'ppapi/thunk/enter.h',
                 'ppapi/thunk/ppb_instance_api.h',
                 'ppapi/thunk/resource_creation_api.h',
                 'ppapi/thunk/thunk.h']
     includes.append(_GetHeaderFileName(filenode))
     for api in meta.Apis():
@@ skipping 110 matching lines @@
     print "Golden file for M13-M14 failed."
     failed = 1
   else:
     print "Golden file for M13-M14 passed."
 
   return failed
 
 
 if __name__ == '__main__':
   sys.exit(Main(sys.argv[1:]))