Cleanup IDL Generator

ppapi/generators/idl_c_proto.py

 #!/usr/bin/python
 #
 # Copyright (c) 2011 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
@@ skipping 40 matching lines @@
   if prefix:
     prefix_lines = prefix.split('\n')
     # If both the prefix and comment start with a blank line ('*') remove
     # the extra one.
     if prefix_lines[0] == '*' and lines[0] == '*':
       lines = prefix_lines + lines[1:]
     else:
       lines = prefix_lines + lines;
   return CommentLines(lines, tabs)
 
-def GetNodeComments(node, prefix=None, tabs=0):
+def GetNodeComments(node, tabs=0):
   # Generate a comment block joining all comment nodes which are children of
   # the provided node.
   comment_txt = ''
   for doc in node.GetListOf('Comment'):
     comment_txt += Comment(doc, tabs=tabs)
   return comment_txt
 
 
 class CGen(object):
   # TypeMap
@@ skipping 79 matching lines @@
   }
 
   def __init__(self):
     self.dbg_depth = 0
 
   #
   # Debug Logging functions
   #
   def Log(self, txt):
     if not GetOption('cgen_debug'): return
-    tabs = ''
-    for tab in range(self.dbg_depth): tabs += '  '
+    tabs = '  ' * self.dbg_depth
     print '%s%s' % (tabs, txt)
 
   def LogEnter(self, txt):
     if txt: self.Log(txt)
     self.dbg_depth += 1
 
   def LogExit(self, txt):
     self.dbg_depth -= 1
     if txt: self.Log(txt)
 
+
+  def GetDefine(self, name, value):
+    out = '#define %s %s' % (name, value)
+    if len(out) > 80:
+      out = '#define %s \\\n    %s' % (name, value)
+    return '%s\n' % out
+
+  #
+  # Interface strings
+  #
+  def GetMacroHelper(self, node):
+    macro = node.GetProperty('macro')
+    if macro: return macro
+    name = node.GetName()
+    name = name.upper()
+    return "%s_INTERFACE" % name
+
+  def GetInterfaceMacro(self, node, version = None):
+    name = self.GetMacroHelper(node)
+    if version is None:
+      return name
+    return '%s_%s' % (name, str(version).replace('.', '_'))
+
+  def GetInterfaceString(self, node, version = None):
+    # If an interface name is specified, use that
+    name = node.GetProperty('iname')
+    if not name:
+      # Otherwise, the interface name is the object's name
+      # With '_Dev' replaced by '(Dev)' if it's a Dev interface.
+      name = node.GetName()
+      if name.endswith('_Dev'):
+        name = '%s(Dev)' % name[:-4]
+    if version is None:
+      return name
+    return "%s;%s" % (name, version)
+
+
   #
   # Return the array specification of the object.
   #
   def GetArraySpec(self, node):
     assert(node.cls == 'Array')
-    out = ''
     fixed = node.GetProperty('FIXED')
     if fixed:
       return '[%s]' % fixed
     else:
       return '[]'
 
   #
   # GetTypeName
   #
   # For any valid 'typed' object such as Member or Typedef
@@ skipping 171 matching lines @@
   #
   def GetSignature(self, node, release, mode, prefix='', func_as_ptr=True):
     self.LogEnter('GetSignature %s %s as func=%s' % (node, mode, func_as_ptr))
     rtype, name, arrayspec, callspec = self.GetComponents(node, release, mode)
     out = self.Compose(rtype, name, arrayspec, callspec, prefix, func_as_ptr)
     self.LogExit('Exit GetSignature: %s' % out)
     return out
 
   # Define a Typedef.
   def DefineTypedef(self, node, releases, prefix='', comment=False):
+    __pychecker__ = 'unusednames=comment'
     release = releases[0]
     out = 'typedef %s;\n' % self.GetSignature(node, release, 'return',
                                               prefix, True)
     self.Log('DefineTypedef: %s' % out)
     return out
 
   # Define an Enum.
   def DefineEnum(self, node, releases, prefix='', comment=False):
+    __pychecker__ = 'unusednames=comment,releases'
     self.LogEnter('DefineEnum %s' % node)
     unnamed =  node.GetProperty('unnamed')
     if unnamed:
       out = 'enum {'
     else:
       out = 'typedef enum {'
     name = '%s%s' % (prefix, node.GetName())
     enumlist = []
     for child in node.GetListOf('EnumItem'):
       value = child.GetProperty('VALUE')
       comment_txt = GetNodeComments(child, tabs=1)
       if value:
         item_txt = '%s%s = %s' % (prefix, child.GetName(), value)
       else:
         item_txt = '%s%s' % (prefix, child.GetName())
       enumlist.append('%s  %s' % (comment_txt, item_txt))
     self.LogExit('Exit DefineEnum')
 
     if unnamed:
       out = '%s\n%s\n};\n' % (out, ',\n'.join(enumlist))
     else:
       out = '%s\n%s\n} %s;\n' % (out, ',\n'.join(enumlist), name)
     return out
 
   def DefineMember(self, node, releases, prefix='', comment=False):
+    __pychecker__ = 'unusednames=prefix,comment'
     release = releases[0]
     self.LogEnter('DefineMember %s' % node)
     out = '%s;' % self.GetSignature(node, release, 'store', '', True)
     self.LogExit('Exit DefineMember')
     return out
 
   def DefineStructInternals(self, node, release, suffix='', comment=True):
     out = ''
     if node.GetProperty('union'):
       out += 'union %s%s {\n' % (node.GetName(), suffix)
     else:
       out += 'struct %s%s {\n' % (node.GetName(), suffix)
 
     # Generate Member Functions
     members = []
     for child in node.GetListOf('Member'):
       member = self.Define(child, [release], tabs=1, comment=comment)
       if not member:
         continue
       members.append(member)
     out += '%s\n};\n' % '\n'.join(members)
     return out
 
 
   def DefineStruct(self, node, releases, prefix='', comment=False):
+    __pychecker__ = 'unusednames=comment,prefix'
     self.LogEnter('DefineStruct %s' % node)
     out = ''
     build_list = node.GetUniqueReleases(releases)
 
     # Build the most recent one with comments
     out = self.DefineStructInternals(node, build_list[-1], comment=True)
 
     # Build the rest without comments and with the version number appended
     for rel in build_list[0:-1]:
       ver_num = node.GetVersion(rel)
@@ skipping 14 matching lines @@
     lines = node.GetName().split('\n')
     return CommentLines(lines, tabs)
 
 
   # Define a top level object.
   def Define(self, node, releases, tabs=0, prefix='', comment=False):
     if not node.InReleases(releases):
       return ''
 
     self.LogEnter('Define %s tab=%d prefix="%s"' % (node,tabs,prefix))
-    declmap = {
-      'Enum' : CGen.DefineEnum,
-      'Function' : CGen.DefineMember,
-      'Interface' : CGen.DefineStruct,
-      'Member' : CGen.DefineMember,
-      'Struct' : CGen.DefineStruct,
-      'Typedef' : CGen.DefineTypedef,
-    }
+    declmap = dict({
+      'Enum': CGen.DefineEnum,
+      'Function': CGen.DefineMember,
+      'Interface': CGen.DefineStruct,
+      'Member': CGen.DefineMember,
+      'Struct': CGen.DefineStruct,
+      'Typedef': CGen.DefineTypedef
+    })
 
     out = ''
-    func = declmap.get(node.cls)
+    func = declmap.get(node.cls, None)
     if not func:
       ErrOut.Log('Failed to define %s named %s' % (node.cls, node.GetName()))
     define_txt = func(self, node, releases, prefix=prefix, comment=comment)
 
     comment_txt = GetNodeComments(node, tabs=0)
     if comment_txt and comment:
       out += comment_txt
     out += define_txt
 
     tab = '  ' * tabs
@@ skipping 85 matching lines @@
     if f.GetProperty('ERRORS') > 0:
       print 'Skipping %s' % f.GetName()
       continue
     print DefineDepends(node)
     for node in f.GetChildren()[2:]:
       print Define(node, comment=True, prefix='tst_')
 
 
 if __name__ == '__main__':
   sys.exit(Main(sys.argv[1:]))