More multi-version support

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
 import sys
 
 from idl_log import ErrOut, InfoOut, WarnOut
 from idl_node import IDLNode
 from idl_ast import IDLAst
 from idl_option import GetOption, Option, ParseOptions
 from idl_parser import ParseFiles
 
 Option('cgen_debug', 'Debug generate.')
 
 class CGenError(Exception):
   def __init__(self, msg):
     self.value = value
 
   def __str__(self):
     return repr(self.value)
 
 
+def CommentLines(lines, tabs=0):
+  tab = '  ' * tabs
+  if lines[-1] == '':

[dmichael (off chromium), 2011/08/24 20:49:11]

I guess my python-fu is weak. What does indexing at -1 do? Is there a clearer
way to do it?

[noelallen1, 2011/08/24 22:43:06]

[-n] is the standard way to notate the 'nth' to last element.  But a more
correct way may be to do:
if not lines[-1]
Either way I will comment.

+    out = '%s/*' % tab + ('\n%s *' % tab).join(lines) + '/\n'
+  else:
+    out = '%s/*' % tab + ('\n%s *' % tab).join(lines) + ' */\n'

[dmichael (off chromium), 2011/08/24 20:49:11]

Maybe a comment on what's going on here? And maybe do the common stuff in one
place, and only do the last part in a conditional.

[noelallen1, 2011/08/24 22:43:06]

Done.

+  return out
+
+def Comment(node, prefix=None, tabs=0):

[dmichael (off chromium), 2011/08/24 20:49:11]

Speaking of comments...  Could we have some here? :-) I don't find it obvious
what is happening here. The comment is the name of the node? prefix can have
carriage returns? What does that do?

[noelallen1, 2011/08/24 22:43:06]

Done.

+  comment = node.GetName()
+  lines = comment.split('\n')
+  if prefix:
+    prefix = prefix.split('\n')

[dmichael (off chromium), 2011/08/24 20:49:11]

I'd prefer you use a different variable name for the list instead of
over-writing prefix (which was presumably passed as a string)

[noelallen1, 2011/08/24 22:43:06]

Done.

+    if prefix[0] == '*' and lines[0] == '*':
+      lines = prefix + lines[1:]
+    else:
+      lines = prefix + lines;
+  return CommentLines(lines, tabs)
+
+def GetNodeComments(node, prefix=None, tabs=0):
+  comment_txt = ''
+  for doc in node.GetListOf('Comment'):
+    comment_txt += Comment(doc, tabs=tabs)
+  return comment_txt
+
+
 class CGen(object):
   # TypeMap
   #
   # TypeMap modifies how an object is stored or passed, for example pointers
   # are passed as 'const' if they are 'in' parameters, and structures are
   # preceeded by the keyword 'struct' as well as using a pointer.
   #
   TypeMap = {
     'Array': {
       'in': 'const %s',
@@ skipping 57 matching lines @@
   'float_t': 'float',
   'double_t': 'double',
   'handle_t': 'int',
   'mem_t': 'void*',
   'str_t': 'char*',
   'interface_t' : 'const void*'
   }
 
   def __init__(self):
     self.dbg_depth = 0
-    self.vmin = 0.0
-    self.vmax = 1e100
-    self.release = GetOption('release')
+#    self.vmin = 0.0
+#    self.vmax = 1e100
+#    self.release = GetOption('release')

[dmichael (off chromium), 2011/08/24 20:49:11]

Why are these just commented out? If they're dead, please delete them. Same
below.

[noelallen1, 2011/08/24 22:43:06]

Done.

 
-  def SetVersionMap(self, node):
-    self.vmin = 0.0
-    self.vmax = 1e100
-    for version in node.GetListOf('LabelItem'):
-      if version.GetName() == GetOption('release'):
-        self.vmin = float(version.GetProperty('VALUE'))
-        self.vmax = float(version.GetProperty('VALUE'))
+  def SetVersionMap(self, node): pass
+#    self.vmin = 0.0
+#    self.vmax = 1e100
+#    for version in node.GetListOf('LabelItem'):
+#      if version.GetName() == GetOption('release'):
+#        self.vmin = float(version.GetProperty('VALUE'))
+#        self.vmax = float(version.GetProperty('VALUE'))
 
   #
   # Debug Logging functions
   #
   def Log(self, txt):
     if not GetOption('cgen_debug'): return
     tabs = ''
     for tab in range(self.dbg_depth): tabs += '  '
     print '%s%s' % (tabs, txt)
 
@@ skipping 18 matching lines @@
       return '[]'
 
   #
   # GetTypeName
   #
   # For any valid 'typed' object such as Member or Typedef
   # the typenode object contains the typename
   #
   # For a given node return the type name by passing mode.
   #
-  def GetTypeName(self, node, prefix=''):
-    self.LogEnter('GetTypeName of %s' % node)
+  def GetTypeName(self, node, release, prefix=''):
+    self.LogEnter('GetTypeName of %s rel=%s' % (node, release))
 
     # For Members, Params, and Typedef's your want type it refers to

[dmichael (off chromium), 2011/08/24 20:49:11]

Typedef's->Typedefs
and not sure what 'your want type it refers to' is supposed to say.

[noelallen1, 2011/08/24 22:43:06]

Done.

     if node.IsA('Member', 'Param', 'Typedef'):
-      typeref = node.GetType(self.release)
+      typeref = node.GetType(release)
     else:
       typeref = node
 
     if typeref is None:
       raise CGenError('No type for %s' % node)
 
     # If the type is a (BuiltIn) Type then return it's name
     # remapping as needed
     if typeref.IsA('Type'):
       name = CGen.RemapName.get(typeref.GetName(), None)
@@ skipping 16 matching lines @@
     self.LogExit('GetTypeName %s is %s' % (node, name))
     return name
 
 
   #
   # GetRootType
   #
   # For a given node return basic type of that object.  This is
   # either a 'Type', 'Callspec', or 'Array'
   #
-  def GetRootTypeMode(self, node, mode):
+  def GetRootTypeMode(self, node, release, mode):
     self.LogEnter('GetRootType of %s' % node)
     # If it has an array spec, then treat it as an array regardless of type
     if node.GetOneOf('Array'):
       rootType = 'Array'
     # Or if it has a callspec, treat it as a function
     elif node.GetOneOf('Callspec'):
-      rootType, mode = self.GetRootTypeMode(node.GetType(self.release),
+      rootType, mode = self.GetRootTypeMode(node.GetType(release), release,
                                             'return')
 
     # If it's a plain typedef, try that object's root type
     elif node.IsA('Member', 'Param', 'Typedef'):
-      rootType, mode = self.GetRootTypeMode(node.GetType(self.release), mode)
+      rootType, mode = self.GetRootTypeMode(node.GetType(release),
+                                            release, mode)
 
     # If it's an Enum, then it's normal passing rules
     elif node.IsA('Enum'):
       rootType = node.cls
 
     # If it's an Interface or Struct, we may be passing by value
     elif node.IsA('Interface', 'Struct'):
       if mode == 'return':
         if node.GetProperty('returnByValue'):
           rootType = 'TypeValue'
@@ skipping 10 matching lines @@
       if node.GetName() in CGen.TypeMap:
         rootType = node.GetName()
       else:
         rootType = 'TypeValue'
     else:
       raise RuntimeError('Getting root type of non-type %s.' % node)
     self.LogExit('RootType is "%s"' % rootType)
     return rootType, mode
 
 
-  def GetTypeByMode(self, node, mode):
-    self.LogEnter('GetTypeByMode of %s mode=%s' % (node, mode))
-    name = self.GetTypeName(node)
-    ntype, mode = self.GetRootTypeMode(node, mode)
+  def GetTypeByMode(self, node, release, mode):
+    self.LogEnter('GetTypeByMode of %s mode=%s release=%s' %
+                  (node, mode, release))
+    name = self.GetTypeName(node, release)
+    ntype, mode = self.GetRootTypeMode(node, release, mode)
     out = CGen.TypeMap[ntype][mode] % name
     self.LogExit('GetTypeByMode %s = %s' % (node, out))
     return out
 
 
   # Get the passing mode of the object (in, out, inout).
   def GetParamMode(self, node):
     self.Log('GetParamMode for %s' % node)
     if node.GetProperty('in'): return 'in'
     if node.GetProperty('out'): return 'out'
     if node.GetProperty('inout'): return 'inout'
     return 'return'
 
   #
   # GetComponents
   #
   # Returns the signature components of an object as a tuple of
   # (rtype, name, arrays, callspec) where:
   #   rtype - The store or return type of the object.
   #   name - The name of the object.
   #   arrays - A list of array dimensions as [] or [<fixed_num>].
   #   args -  None of not a function, otherwise  a list of parameters.
   #
-  def GetComponents(self, node, mode):
-    self.LogEnter('GetComponents mode %s for %s' % (mode, node))
+  def GetComponents(self, node, release, mode):
+    self.LogEnter('GetComponents mode %s for %s %s' % (mode, node, release))
 
     # Generate passing type by modifying root type
-    rtype = self.GetTypeByMode(node, mode)
+    rtype = self.GetTypeByMode(node, release, mode)
     if node.IsA('Enum', 'Interface', 'Struct'):
       rname = node.GetName()
     else:
-      rname = node.GetType(self.release).GetName()
+      rname = node.GetType(release).GetName()
 
     if rname in CGen.RemapName:
       rname = CGen.RemapName[rname]
     if '%' in rtype:
       rtype = rtype % rname
     name = node.GetName()
     arrayspec = [self.GetArraySpec(array) for array in node.GetListOf('Array')]
     callnode = node.GetOneOf('Callspec')
     if callnode:
       callspec = []
       for param in callnode.GetListOf('Param'):
         mode = self.GetParamMode(param)
-        ptype, pname, parray, pspec = self.GetComponents(param, mode)
+        ptype, pname, parray, pspec = self.GetComponents(param, release, mode)
         callspec.append((ptype, pname, parray, pspec))
     else:
       callspec = None
 
     self.LogExit('GetComponents: %s, %s, %s, %s' %
                  (rtype, name, arrayspec, callspec))
     return (rtype, name, arrayspec, callspec)
 
 
   def Compose(self, rtype, name, arrayspec, callspec, prefix, func_as_ptr):
@@ skipping 11 matching lines @@
     self.LogExit('Exit Compose: %s' % out)
     return out
 
   #
   # GetSignature
   #
   # Returns the 'C' style signature of the object
   #  prefix - A prefix for the object's name
   #  func_as_ptr - Formats a function as a function pointer
   #
-  def GetSignature(self, node, mode, prefix='', func_as_ptr=True):
+  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, mode)
+    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
 
-  def GetMacro(self, node):
-    name = node.GetName()
-    name = name.upper()
-    return "%s_INTERFACE" % name
-
-  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
-
   # Define an Typedef.

[dmichael (off chromium), 2011/08/24 20:49:11]

nit: an->a

-  def DefineTypedef(self, node, prefix='', comment=False):
-    out = 'typedef %s;\n' % self.GetSignature(node, 'return', prefix, True)
+  def DefineTypedef(self, node, releases, prefix='', comment=False):

[dmichael (off chromium), 2011/08/24 20:49:11]

Why are you passing an array here if you only use the first element? Is this
transitional?

[noelallen1, 2011/08/24 22:43:06]

Yes.  This is waiting on name mangling based on version which will be the next
CL.

+    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, prefix='', comment=False):
+  def DefineEnum(self, node, releases, prefix='', comment=False):

[dmichael (off chromium), 2011/08/24 20:49:11]

releases appears to be unused here

[noelallen1, 2011/08/24 22:43:06]

Transitional (same as above)

     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 = ''
-      if comment:
-        for comment_node in child.GetListOf('Comment'):
-          comment_txt += self.Comment(comment_node, tabs=1)
-        if comment_txt:
-          comment_txt = '%s' % comment_txt
+      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, prefix='', comment=False):
+  def DefineMember(self, node, releases, prefix='', comment=False):
+    release = releases[0]

[dmichael (off chromium), 2011/08/24 20:49:11]

Again, is this just temporary?

[noelallen1, 2011/08/24 22:43:06]

Yes.   All Define<X> functions take an array of releases to generate.

     self.LogEnter('DefineMember %s' % node)
-
-#    out = ''
-#    if comment:
-#      for doc in node.GetListOf('Comment'):
-#        out += self.Comment(doc)
-    out = '%s;' % self.GetSignature(node, 'store', '', True)
+    out = '%s;' % self.GetSignature(node, release, 'store', '', True)
     self.LogExit('Exit DefineMember')
     return out
 
-  def InterfaceDefs(self, node):
-    out = ''
-    name = node.GetName()
-    macro = node.GetProperty('macro')
-    if not macro:
-      macro = self.GetMacro(node)
-    label = node.GetLabel()
-    if label:
-      for vers in label.versions:
-        strver = str(vers).replace('.', '_')
-        out += self.GetDefine('%s_%s' % (macro, strver),
-                              '"%s;%s"' % (name, vers))
-        if label.GetRelease(vers) == self.release:
-          out += self.GetDefine(macro, '%s_%s' % (macro, strver))
-      out += '\n'
-    return out
-
   # Define a Struct.
-  def DefineStruct(self, node, prefix='', comment=False):
+  def DefineStruct(self, node, releases, prefix='', comment=False):
     out = ''
 
     self.LogEnter('DefineStruct %s' % node)
     if node.GetProperty('union'):
       out += 'union %s%s {\n' % (prefix, node.GetName())
     else:
       out += 'struct %s%s {\n' % (prefix, node.GetName())
 
     # Generate Member Functions
     members = []
     for child in node.GetListOf('Member'):
-      member = self.Define(child, tabs=1, comment=comment)
+      member = self.Define(child, releases, tabs=1, comment=comment)
       if not member:
         continue
       members.append(member)
     out += '%s\n};\n' % '\n'.join(members)
     self.LogExit('Exit DefineStruct')
     return out
 
-  def DefineType(self, node, prefix='', comment=False):
+  def DefineType(self, node, releases, prefix='', comment=False):

[dmichael (off chromium), 2011/08/24 20:49:11]

Why the trivial function? Is this speculative coding that should be deleted?

[noelallen1, 2011/08/24 22:43:06]

A 'type' doesn't have anything to emit for C header generator, but would be
needed for the C Test generator.  I will remove for now and add it back if/when
I need it for a different generator.

     return ''
 
   #
   # Copyright and Comment
   #
   # Generate a comment or copyright block
   #
   def Copyright(self, node, tabs=0):
     lines = node.GetName().split('\n')
-    return self.CommentLines(lines, tabs)
-
-  def Comment(self, node, prefix=None, tabs=0):
-    comment = node.GetName()
-
-    # Ignore comments that do not have a '*' marker
-#    if comment[0] != '*' and not prefix: return ''
-
-    lines = comment.split('\n')
-    if prefix:
-      prefix = prefix.split('\n')
-      if prefix[0] == '*' and lines[0] == '*':
-        lines = prefix + lines[1:]
-      else:
-        lines = prefix + lines;
-    return self.CommentLines(lines, tabs)
-
-  def CommentLines(self, lines, tabs=0):
-    tab = ''.join(['  ' for i in range(tabs)])
-    if lines[-1] == '':
-      return '%s/*' % tab + ('\n%s *' % tab).join(lines) + '/\n'
-    else:
-      return '%s/*' % tab + ('\n%s *' % tab).join(lines) + ' */\n'
+    return CommentLines(lines, tabs)
 
 
   # Define a top level object.
-  def Define(self, node, tabs=0, prefix='', comment=False):
-    if True:
-#    try:
-      self.LogEnter('Define %s tab=%d prefix="%s"' % (node,tabs,prefix))
+  def Define(self, node, releases, tabs=0, prefix='', comment=False):
+    if not node.InReleases(releases):
+      return ''
 
-      node_nim = node.GetProperty('version')
-      node_max = node.GetProperty('deprecate')
+    self.LogEnter('Define %s tab=%d prefix="%s"' % (node,tabs,prefix))
+    declmap = {
+      'Describe' : CGen.DefineType,
+      'Enum' : CGen.DefineEnum,
+      'Function' : CGen.DefineMember,
+      'Interface' : CGen.DefineStruct,
+      'Member' : CGen.DefineMember,
+      'Struct' : CGen.DefineStruct,
+      'Type' : CGen.DefineType,
+      'Typedef' : CGen.DefineTypedef,
+    }
 
-      if node_nim is not None:
-        node_nim = float(node_nim)
+    out = ''
+    func = declmap.get(node.cls)
+    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 += '%s%s' % (comment_txt, define_txt)

[dmichael (off chromium), 2011/08/24 20:49:11]

Doesn't the % operator seem like overkill here?
out += comment_txt + define_text

Or the whole thing could be:
if comment_txt and comment:
  out += comment_txt
out += define_txt

Maybe this is a matter of preference, but it seems simpler to me to do the
unconditional stuff unconditionally.

[noelallen1, 2011/08/24 22:43:06]

Done.

+    else:
+      out += define_txt
+
+    tab = '  ' * tabs
+    lines = []
+    for line in out.split('\n'):
+      # Add indentation
+      line = '%s%s' % (tab, line)

[dmichael (off chromium), 2011/08/24 20:49:11]

again with the percent operator for just concatenation...  is this a
Google/Python style thing I just haven't been indoctrinated in to yet? If it's
the 'normal' way, then fine. Just seems strange to me.

[noelallen1, 2011/08/24 22:43:06]

Done.

+      if len(line) > 80:
+        left = line.rfind('(') + 1
+        args = line[left:].split(',')
+        line_max = 0
+        for arg in args:
+          if len(arg) > line_max: line_max = len(arg)
+
+        if left + line_max >= 80:
+          space = '%s    ' % tab
+          args =  (',\n%s' % space).join([arg.strip() for arg in args])
+          lines.append('%s\n%s%s' % (line[:left], space, args))
+        else:
+          space = ' '.join(['' for i in range(left)])

[dmichael (off chromium), 2011/08/24 20:49:11]

Why not just
' ' * (left-1)
Seems clearer to me, anyway.

+          args =  (',\n%s' % space).join(args)
+          lines.append('%s%s' % (line[:left], args))
       else:
-        node_nim = 0.0
-
-      if node_max is not None:
-        node_max = float(node_max)
-      else:
-        node_max = 1.0e100
-
-      label = node.GetLabel()
-      if label:
-        lver = label.GetVersion(self.release)
-
-        # Verify that we are in a valid version.
-        if node_max <= lver: return ''
-        if node_nim > lver: return ''
-
-      declmap = {
-        'Describe' : CGen.DefineType,
-        'Enum' : CGen.DefineEnum,
-        'Function' : CGen.DefineMember,
-        'Interface' : CGen.DefineStruct,
-        'Member' : CGen.DefineMember,
-        'Struct' : CGen.DefineStruct,
-        'Type' : CGen.DefineType,
-        'Typedef' : CGen.DefineTypedef,
-      }
-
-      if node.cls == 'Inline':
-        return node.GetProperty('VALUE')
-
-      if node.cls == 'Label':
-        return ''
-
-      out = ''
-      comment_txt = ''
-      if comment:
-        for doc in node.GetListOf('Comment'):
-          comment_txt += self.Comment(doc)
-
-      func = declmap.get(node.cls)
-      if not func:
-        ErrOut.Log('Failed to define %s named %s' % (node.cls, node.GetName()))
-
-      define_txt = func(self, node, prefix=prefix, comment=comment)
-      if comment_txt:
-        out += '%s%s' % (comment_txt, define_txt)
-      else:
-        out += define_txt
-
-      tab = ''
-      for i in range(tabs):
-        tab += '  '
-
-      lines = []
-      for line in out.split('\n'):
-        # Add indentation
-        line = '%s%s' % (tab, line)
-        if len(line) > 80:
-          left = line.rfind('(') + 1
-          args = line[left:].split(',')
-          line_max = 0
-          for arg in args:
-            if len(arg) > line_max: line_max = len(arg)
-
-          if left + line_max >= 80:
-            space = '%s    ' % tab
-            args =  (',\n%s' % space).join([arg.strip() for arg in args])
-            lines.append('%s\n%s%s' % (line[:left], space, args))
-          else:
-            space = ' '.join(['' for i in range(left)])
-            args =  (',\n%s' % space).join(args)
-            lines.append('%s%s' % (line[:left], args))
-        else:
-          lines.append(line.rstrip())
-
-  #    out = tab + ('\n%s' % tab).join(out.split('\n')) + '\n'
-      self.LogExit('Exit Define')
-      return '\n'.join(lines)
-#    except:
-    if False:
-      node.Error('Failed to resolve.')
-      return ''
+        lines.append(line.rstrip())
+    self.LogExit('Exit Define')
+    return '\n'.join(lines)
 
 # Clean a string representing an object definition and return then string
 # as a single space delimited set of tokens.
 def CleanString(instr):
   instr = instr.strip()
   instr = instr.split()
   return ' '.join(instr)
 
 
 # Test a file, by comparing all it's objects, with their comments.
 def TestFile(filenode):
   cgen = CGen()
 
   errors = 0
   for node in filenode.GetChildren()[2:]:
     instr = node.GetOneOf('Comment')
     if not instr: continue
     instr.Dump()
     instr = CleanString(instr.GetName())
 
-    outstr = cgen.Define(node)
+    outstr = cgen.Define(node, releases=['M14'])
     if GetOption('verbose'):
       print outstr + '\n'
     outstr = CleanString(outstr)
 
     if instr != outstr:
       ErrOut.Log('Failed match of\n>>%s<<\n>>%s<<\nto:' % (instr, outstr))
       node.Dump(1, comments=True)
       errors += 1
   return errors
 
@@ skipping 32 matching lines @@
       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:]))