Add support for packed structures on IAR and MSVC.
[apps/agl-service-can-low-level.git] / generator / nanopb_generator.py
index e38d382..5ef4ab7 100644 (file)
@@ -3,6 +3,7 @@ nanopb_version = "nanopb-0.2.1-dev"
 
 try:
     import google.protobuf.descriptor_pb2 as descriptor
+    import google.protobuf.text_format as text_format
 except:
     print
     print "*************************************************************"
@@ -54,9 +55,7 @@ datatypes = {
 }
 
 class Names:
-    '''Keeps a set of nested names and formats them to C identifier.
-    You can subclass this with your own implementation.
-    '''
+    '''Keeps a set of nested names and formats them to C identifier.'''
     def __init__(self, parts = ()):
         if isinstance(parts, Names):
             parts = parts.parts
@@ -286,7 +285,7 @@ class Message:
         self.fields = []
         
         for f in desc.field:
-            field_options = get_nanopb_suboptions(f, message_options)
+            field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
             if field_options.type != nanopb_pb2.FT_IGNORE:
                 self.fields.append(Field(self.name, f, field_options))
         
@@ -300,6 +299,12 @@ class Message:
     
     def __str__(self):
         result = 'typedef struct _%s {\n' % self.name
+
+        if not self.ordered_fields:
+            # Empty structs are not allowed in C standard.
+            # Therefore add a dummy field if an empty message occurs.
+            result += '    uint8_t dummy_field;'
+
         result += '\n'.join([str(f) for f in self.ordered_fields])
         result += '\n}'
         
@@ -307,6 +312,11 @@ class Message:
             result += ' pb_packed'
         
         result += ' %s;' % self.name
+        
+        if self.packed:
+            result = 'PB_PACKED_STRUCT_START\n' + result
+            result += '\nPB_PACKED_STRUCT_END'
+        
         return result
     
     def types(self):
@@ -377,14 +387,14 @@ def parse_file(fdesc, file_options):
         base_name = Names()
     
     for enum in fdesc.enum_type:
-        enum_options = get_nanopb_suboptions(enum, file_options)
+        enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
         enums.append(Enum(base_name, enum, enum_options))
     
     for names, message in iterate_messages(fdesc, base_name):
-        message_options = get_nanopb_suboptions(message, file_options)
+        message_options = get_nanopb_suboptions(message, file_options, names)
         messages.append(Message(names, message, message_options))
         for enum in message.enum_type:
-            enum_options = get_nanopb_suboptions(enum, message_options)
+            enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
             enums.append(Enum(names, enum, enum_options))
     
     # Fix field default values where enum short names are used.
@@ -450,12 +460,18 @@ def generate_header(dependencies, headername, enums, messages, options):
     symbol = make_identifier(headername)
     yield '#ifndef _PB_%s_\n' % symbol
     yield '#define _PB_%s_\n' % symbol
-    yield '#include <pb.h>\n\n'
+    try:
+        yield options.libformat % ('pb.h')
+    except TypeError:
+        # no %s specified - use whatever was passed in as options.libformat
+        yield options.libformat
+    yield '\n'
     
     for dependency in dependencies:
         noext = os.path.splitext(dependency)[0]
-        yield '#include "%s.%s.h"\n' % (noext,options.extension)
-    
+        yield options.genformat % (noext + '.' + options.extension + '.h')
+        yield '\n'
+
     yield '#ifdef __cplusplus\n'
     yield 'extern "C" {\n'
     yield '#endif\n\n'
@@ -490,7 +506,8 @@ def generate_source(headername, enums, messages):
     
     yield '/* Automatically generated nanopb constant definitions */\n'
     yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
-    yield '#include "%s"\n\n' % headername
+    yield options.genformat % (headername)
+    yield '\n'
     
     for msg in messages:
         yield msg.default_decl(False)
@@ -566,36 +583,46 @@ def generate_source(headername, enums, messages):
     
     yield '\n'
 
-
 # ---------------------------------------------------------------------------
-#                         Command line interface
+#                    Options parsing for the .proto files
 # ---------------------------------------------------------------------------
 
-import sys
-import os.path    
-from optparse import OptionParser
-import google.protobuf.text_format as text_format
+from fnmatch import fnmatch
 
-optparser = OptionParser(
-    usage = "Usage: nanopb_generator.py [options] file.pb ...",
-    epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
-             "Output will be written to file.pb.h and file.pb.c.")
-optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
-    help="Exclude file from generated #include list.")
-optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
-    help="use extension instead of 'pb' for generated files.")
-optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
-    help="Don't print anything except errors.")
-optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
-    help="Print more information.")
-optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
-    help="Set generator option (max_size, max_count etc.).")
+def read_options_file(infile):
+    '''Parse a separate options file to list:
+        [(namemask, options), ...]
+    '''
+    results = []
+    for line in infile:
+        line = line.strip()
+        if not line or line.startswith('//') or line.startswith('#'):
+            continue
+        
+        parts = line.split(None, 1)
+        opts = nanopb_pb2.NanoPBOptions()
+        text_format.Merge(parts[1], opts)
+        results.append((parts[0], opts))
 
-def get_nanopb_suboptions(subdesc, options):
+    return results
+
+class Globals:
+    '''Ugly global variables, should find a good way to pass these.'''
+    verbose_options = False
+    separate_options = []
+
+def get_nanopb_suboptions(subdesc, options, name):
     '''Get copy of options, and merge information from subdesc.'''
     new_options = nanopb_pb2.NanoPBOptions()
     new_options.CopyFrom(options)
     
+    # Handle options defined in a separate file
+    dotname = '.'.join(name.parts)
+    for namemask, options in Globals.separate_options:
+        if fnmatch(dotname, namemask):
+            new_options.MergeFrom(options)
+    
+    # Handle options defined in .proto
     if isinstance(subdesc.options, descriptor.FieldOptions):
         ext_type = nanopb_pb2.nanopb
     elif isinstance(subdesc.options, descriptor.FileOptions):
@@ -611,8 +638,44 @@ def get_nanopb_suboptions(subdesc, options):
         ext = subdesc.options.Extensions[ext_type]
         new_options.MergeFrom(ext)
     
+    if Globals.verbose_options:
+        print "Options for " + dotname + ":"
+        print text_format.MessageToString(new_options)
+    
     return new_options
 
+
+# ---------------------------------------------------------------------------
+#                         Command line interface
+# ---------------------------------------------------------------------------
+
+import sys
+import os.path    
+from optparse import OptionParser
+
+optparser = OptionParser(
+    usage = "Usage: nanopb_generator.py [options] file.pb ...",
+    epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
+             "Output will be written to file.pb.h and file.pb.c.")
+optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
+    help="Exclude file from generated #include list.")
+optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
+    help="Set extension to use instead of 'pb' for generated files. [default: %default]")
+optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
+    help="Set name of a separate generator options file.")
+optparser.add_option("-Q", "--generated-include-format", dest="genformat",
+    metavar="FORMAT", default='#include "%s"\n',
+    help="Set format string to use for including other .pb.h files. [default: %default]")
+optparser.add_option("-L", "--library-include-format", dest="libformat",
+    metavar="FORMAT", default='#include <%s>\n',
+    help="Set format string to use for including the nanopb pb.h header. [default: %default]")
+optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
+    help="Don't print anything except errors.")
+optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
+    help="Print more information.")
+optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
+    help="Set generator option (max_size, max_count etc.).")
+
 def process(filenames, options):
     '''Process the files given on the command line.'''
     
@@ -622,6 +685,8 @@ def process(filenames, options):
     
     if options.quiet:
         options.verbose = False
+
+    Globals.verbose_options = options.verbose
     
     toplevel_options = nanopb_pb2.NanoPBOptions()
     for s in options.settings:
@@ -631,12 +696,23 @@ def process(filenames, options):
         data = open(filename, 'rb').read()
         fdesc = descriptor.FileDescriptorSet.FromString(data)
         
-        file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options)
+        # Check if any separate options are specified
+        try:
+            optfilename = options.options_file % os.path.splitext(filename)[0]
+        except TypeError:
+            # No %s specified, use the filename as-is
+            optfilename = options.options_file
         
         if options.verbose:
-            print "Options for " + filename + ":"
-            print text_format.MessageToString(file_options)
+            print 'Reading options from ' + optfilename
+        
+        if os.path.isfile(optfilename):
+            Globals.separate_options = read_options_file(open(optfilename, "rU"))
+        else:
+            Globals.separate_options = []
         
+        # Parse the file
+        file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options, Names([filename]))
         enums, messages = parse_file(fdesc.file[0], file_options)
         
         noext = os.path.splitext(filename)[0]