generator/nanopb_generator.py

   1 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
   2
   3 try:
   4     import google.protobuf.descriptor_pb2 as descriptor
   5 except:
   6     print
   7     print "*************************************************************"
   8     print "*** Could not import the Google protobuf Python libraries ***"
   9     print "*** Try installing package 'python-protobuf' or similar.  ***"
  10     print "*************************************************************"
  11     print
  12     raise
  13
  14 try:
  15     import nanopb_pb2
  16 except:
  17     print
  18     print "***************************************************************"
  19     print "*** Could not import the precompiled nanopb_pb2.py.         ***"
  20     print "*** Run 'make' in the 'generator' folder to update the file.***"
  21     print "***************************************************************"
  22     print
  23     raise
  24
  25
  26
  27
  28
  29
  30 # ---------------------------------------------------------------------------
  31 #                     Generation of single fields
  32 # ---------------------------------------------------------------------------
  33
  34
  35 import os.path
  36
  37 # Values are tuple (c type, pb ltype)
  38 FieldD = descriptor.FieldDescriptorProto
  39 datatypes = {
  40     FieldD.TYPE_BOOL: ('bool', 'PB_LTYPE_VARINT'),
  41     FieldD.TYPE_DOUBLE: ('double', 'PB_LTYPE_FIXED64'),
  42     FieldD.TYPE_FIXED32: ('uint32_t', 'PB_LTYPE_FIXED32'),
  43     FieldD.TYPE_FIXED64: ('uint64_t', 'PB_LTYPE_FIXED64'),
  44     FieldD.TYPE_FLOAT: ('float', 'PB_LTYPE_FIXED32'),
  45     FieldD.TYPE_INT32: ('int32_t', 'PB_LTYPE_VARINT'),
  46     FieldD.TYPE_INT64: ('int64_t', 'PB_LTYPE_VARINT'),
  47     FieldD.TYPE_SFIXED32: ('int32_t', 'PB_LTYPE_FIXED32'),
  48     FieldD.TYPE_SFIXED64: ('int64_t', 'PB_LTYPE_FIXED64'),
  49     FieldD.TYPE_SINT32: ('int32_t', 'PB_LTYPE_SVARINT'),
  50     FieldD.TYPE_SINT64: ('int64_t', 'PB_LTYPE_SVARINT'),
  51     FieldD.TYPE_UINT32: ('uint32_t', 'PB_LTYPE_VARINT'),
  52     FieldD.TYPE_UINT64: ('uint64_t', 'PB_LTYPE_VARINT')
  53 }
  54
  55 class Names:
  56     '''Keeps a set of nested names and formats them to C identifier.
  57     You can subclass this with your own implementation.
  58     '''
  59     def __init__(self, parts = ()):
  60         if isinstance(parts, Names):
  61             parts = parts.parts
  62         self.parts = tuple(parts)
  63
  64     def __str__(self):
  65         return '_'.join(self.parts)
  66
  67     def __add__(self, other):
  68         if isinstance(other, (str, unicode)):
  69             return Names(self.parts + (other,))
  70         elif isinstance(other, tuple):
  71             return Names(self.parts + other)
  72         else:
  73             raise ValueError("Name parts should be of type str")
  74
  75 def names_from_type_name(type_name):
  76     '''Parse Names() from FieldDescriptorProto type_name'''
  77     if type_name[0] != '.':
  78         raise NotImplementedError("Lookup of non-absolute type names is not supported")
  79     return Names(type_name[1:].split('.'))
  80
  81 class Enum:
  82     def __init__(self, names, desc, enum_options):
  83         '''desc is EnumDescriptorProto'''
  84         self.names = names + desc.name
  85         self.values = [(self.names + x.name, x.number) for x in desc.value]
  86
  87     def __str__(self):
  88         result = 'typedef enum _%s {\n' % self.names
  89         result += ',\n'.join(["    %s = %d" % x for x in self.values])
  90         result += '\n} %s;' % self.names
  91         return result
  92
  93 class Field:
  94     def __init__(self, struct_name, desc, field_options):
  95         '''desc is FieldDescriptorProto'''
  96         self.tag = desc.number
  97         self.struct_name = struct_name
  98         self.name = desc.name
  99         self.default = None
 100         self.max_size = None
 101         self.max_count = None
 102         self.array_decl = ""
 103
 104         # Parse field options
 105         if field_options.HasField("max_size"):
 106             self.max_size = field_options.max_size
 107
 108         if field_options.HasField("max_count"):
 109             self.max_count = field_options.max_count
 110
 111         if desc.HasField('default_value'):
 112             self.default = desc.default_value
 113
 114         # Decide HTYPE
 115         # HTYPE is the high-order nibble of nanopb field description,
 116         # defining whether value is required/optional/repeated.
 117         is_callback = False
 118         if desc.label == FieldD.LABEL_REQUIRED:
 119             self.htype = 'PB_HTYPE_REQUIRED'
 120         elif desc.label == FieldD.LABEL_OPTIONAL:
 121             self.htype = 'PB_HTYPE_OPTIONAL'
 122         elif desc.label == FieldD.LABEL_REPEATED:
 123             if self.max_count is None:
 124                 is_callback = True
 125             else:
 126                 self.htype = 'PB_HTYPE_ARRAY'
 127                 self.array_decl = '[%d]' % self.max_count
 128         else:
 129             raise NotImplementedError(desc.label)
 130
 131         # Decide LTYPE and CTYPE
 132         # LTYPE is the low-order nibble of nanopb field description,
 133         # defining how to decode an individual value.
 134         # CTYPE is the name of the c type to use in the struct.
 135         if datatypes.has_key(desc.type):
 136             self.ctype, self.ltype = datatypes[desc.type]
 137         elif desc.type == FieldD.TYPE_ENUM:
 138             self.ltype = 'PB_LTYPE_VARINT'
 139             self.ctype = names_from_type_name(desc.type_name)
 140             if self.default is not None:
 141                 self.default = self.ctype + self.default
 142         elif desc.type == FieldD.TYPE_STRING:
 143             self.ltype = 'PB_LTYPE_STRING'
 144             if self.max_size is None:
 145                 is_callback = True
 146             else:
 147                 self.ctype = 'char'
 148                 self.array_decl += '[%d]' % self.max_size
 149         elif desc.type == FieldD.TYPE_BYTES:
 150             self.ltype = 'PB_LTYPE_BYTES'
 151             if self.max_size is None:
 152                 is_callback = True
 153             else:
 154                 self.ctype = self.struct_name + self.name + 't'
 155         elif desc.type == FieldD.TYPE_MESSAGE:
 156             self.ltype = 'PB_LTYPE_SUBMESSAGE'
 157             self.ctype = self.submsgname = names_from_type_name(desc.type_name)
 158         else:
 159             raise NotImplementedError(desc.type)
 160
 161         if is_callback:
 162             self.htype = 'PB_HTYPE_CALLBACK'
 163             self.ctype = 'pb_callback_t'
 164             self.array_decl = ''
 165
 166     def __cmp__(self, other):
 167         return cmp(self.tag, other.tag)
 168
 169     def __str__(self):
 170         if self.htype == 'PB_HTYPE_OPTIONAL':
 171             result = '    bool has_' + self.name + ';\n'
 172         elif self.htype == 'PB_HTYPE_ARRAY':
 173             result = '    size_t ' + self.name + '_count;\n'
 174         else:
 175             result = ''
 176         result += '    %s %s%s;' % (self.ctype, self.name, self.array_decl)
 177         return result
 178
 179     def types(self):
 180         '''Return definitions for any special types this field might need.'''
 181         if self.ltype == 'PB_LTYPE_BYTES' and self.max_size is not None:
 182             result = 'typedef struct {\n'
 183             result += '    size_t size;\n'
 184             result += '    uint8_t bytes[%d];\n' % self.max_size
 185             result += '} %s;\n' % self.ctype
 186         else:
 187             result = None
 188         return result
 189
 190     def default_decl(self, declaration_only = False):
 191         '''Return definition for this field's default value.'''
 192         if self.default is None:
 193             return None
 194
 195         if self.ltype == 'PB_LTYPE_STRING':
 196             ctype = 'char'
 197             if self.max_size is None:
 198                 return None # Not implemented
 199             else:
 200                 array_decl = '[%d]' % (self.max_size + 1)
 201             default = str(self.default).encode('string_escape')
 202             default = default.replace('"', '\\"')
 203             default = '"' + default + '"'
 204         elif self.ltype == 'PB_LTYPE_BYTES':
 205             data = self.default.decode('string_escape')
 206             data = ['0x%02x' % ord(c) for c in data]
 207
 208             if self.max_size is None:
 209                 return None # Not implemented
 210             else:
 211                 ctype = self.ctype
 212
 213             default = '{%d, {%s}}' % (len(data), ','.join(data))
 214             array_decl = ''
 215         else:
 216             ctype, default = self.ctype, self.default
 217             array_decl = ''
 218
 219         if declaration_only:
 220             return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
 221         else:
 222             return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
 223
 224     def pb_field_t(self, prev_field_name):
 225         '''Return the pb_field_t initializer to use in the constant array.
 226         prev_field_name is the name of the previous field or None.
 227         '''
 228         result = '    {%d, ' % self.tag
 229         result += '(pb_type_t) ((int) ' + self.htype
 230         if self.ltype is not None:
 231             result += ' | (int) ' + self.ltype
 232         result += '),\n'
 233
 234         if prev_field_name is None:
 235             result += '    offsetof(%s, %s),' % (self.struct_name, self.name)
 236         else:
 237             result += '    pb_delta_end(%s, %s, %s),' % (self.struct_name, self.name, prev_field_name)
 238
 239         if self.htype == 'PB_HTYPE_OPTIONAL':
 240             result += '\n    pb_delta(%s, has_%s, %s),' % (self.struct_name, self.name, self.name)
 241         elif self.htype == 'PB_HTYPE_ARRAY':
 242             result += '\n    pb_delta(%s, %s_count, %s),' % (self.struct_name, self.name, self.name)
 243         else:
 244             result += ' 0,'
 245
 246
 247         if self.htype == 'PB_HTYPE_ARRAY':
 248             result += '\n    pb_membersize(%s, %s[0]),' % (self.struct_name, self.name)
 249             result += ('\n    pb_membersize(%s, %s) / pb_membersize(%s, %s[0]),'
 250                        % (self.struct_name, self.name, self.struct_name, self.name))
 251         else:
 252             result += '\n    pb_membersize(%s, %s),' % (self.struct_name, self.name)
 253             result += ' 0,'
 254
 255         if self.ltype == 'PB_LTYPE_SUBMESSAGE':
 256             result += '\n    &%s_fields}' % self.submsgname
 257         elif self.default is None or self.htype == 'PB_HTYPE_CALLBACK':
 258             result += ' 0}'
 259         else:
 260             result += '\n    &%s_default}' % (self.struct_name + self.name)
 261
 262         return result
 263
 264     def largest_field_value(self):
 265         '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
 266         Returns numeric value or a C-expression for assert.'''
 267         if self.ltype == 'PB_LTYPE_SUBMESSAGE':
 268             if self.htype == 'PB_HTYPE_ARRAY':
 269                 return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
 270             else:
 271                 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
 272
 273         return max(self.tag, self.max_size, self.max_count)
 274
 275
 276
 277
 278
 279
 280 # ---------------------------------------------------------------------------
 281 #                   Generation of messages (structures)
 282 # ---------------------------------------------------------------------------
 283
 284
 285 class Message:
 286     def __init__(self, names, desc, message_options):
 287         self.name = names
 288         self.fields = [Field(self.name, f, get_nanopb_suboptions(f, message_options)) for f in desc.field]
 289         self.ordered_fields = self.fields[:]
 290         self.ordered_fields.sort()
 291
 292     def get_dependencies(self):
 293         '''Get list of type names that this structure refers to.'''
 294         return [str(field.ctype) for field in self.fields]
 295
 296     def __str__(self):
 297         result = 'typedef struct _%s {\n' % self.name
 298         result += '\n'.join([str(f) for f in self.ordered_fields])
 299         result += '\n} %s;' % self.name
 300         return result
 301
 302     def types(self):
 303         result = ""
 304         for field in self.fields:
 305             types = field.types()
 306             if types is not None:
 307                 result += types + '\n'
 308         return result
 309
 310     def default_decl(self, declaration_only = False):
 311         result = ""
 312         for field in self.fields:
 313             default = field.default_decl(declaration_only)
 314             if default is not None:
 315                 result += default + '\n'
 316         return result
 317
 318     def fields_declaration(self):
 319         result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
 320         return result
 321
 322     def fields_definition(self):
 323         result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
 324
 325         prev = None
 326         for field in self.ordered_fields:
 327             result += field.pb_field_t(prev)
 328             result += ',\n\n'
 329             prev = field.name
 330
 331         result += '    PB_LAST_FIELD\n};'
 332         return result
 333
 334
 335
 336
 337
 338
 339 # ---------------------------------------------------------------------------
 340 #                    Processing of entire .proto files
 341 # ---------------------------------------------------------------------------
 342
 343
 344 def iterate_messages(desc, names = Names()):
 345     '''Recursively find all messages. For each, yield name, DescriptorProto.'''
 346     if hasattr(desc, 'message_type'):
 347         submsgs = desc.message_type
 348     else:
 349         submsgs = desc.nested_type
 350
 351     for submsg in submsgs:
 352         sub_names = names + submsg.name
 353         yield sub_names, submsg
 354
 355         for x in iterate_messages(submsg, sub_names):
 356             yield x
 357
 358 def parse_file(fdesc, file_options):
 359     '''Takes a FileDescriptorProto and returns tuple (enum, messages).'''
 360
 361     enums = []
 362     messages = []
 363
 364     if fdesc.package:
 365         base_name = Names(fdesc.package.split('.'))
 366     else:
 367         base_name = Names()
 368
 369     for enum in fdesc.enum_type:
 370         enums.append(Enum(base_name, enum, file_options))
 371
 372     for names, message in iterate_messages(fdesc, base_name):
 373         message_options = get_nanopb_suboptions(message, file_options)
 374         messages.append(Message(names, message, message_options))
 375         for enum in message.enum_type:
 376             enums.append(Enum(names, enum, message_options))
 377
 378     return enums, messages
 379
 380 def toposort2(data):
 381     '''Topological sort.
 382     From http://code.activestate.com/recipes/577413-topological-sort/
 383     This function is under the MIT license.
 384     '''
 385     for k, v in data.items():
 386         v.discard(k) # Ignore self dependencies
 387     extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
 388     data.update(dict([(item, set()) for item in extra_items_in_deps]))
 389     while True:
 390         ordered = set(item for item,dep in data.items() if not dep)
 391         if not ordered:
 392             break
 393         for item in sorted(ordered):
 394             yield item
 395         data = dict([(item, (dep - ordered)) for item,dep in data.items()
 396                 if item not in ordered])
 397     assert not data, "A cyclic dependency exists amongst %r" % data
 398
 399 def sort_dependencies(messages):
 400     '''Sort a list of Messages based on dependencies.'''
 401     dependencies = {}
 402     message_by_name = {}
 403     for message in messages:
 404         dependencies[str(message.name)] = set(message.get_dependencies())
 405         message_by_name[str(message.name)] = message
 406
 407     for msgname in toposort2(dependencies):
 408         if msgname in message_by_name:
 409             yield message_by_name[msgname]
 410
 411 def generate_header(dependencies, headername, enums, messages):
 412     '''Generate content for a header file.
 413     Generates strings, which should be concatenated and stored to file.
 414     '''
 415
 416     yield '/* Automatically generated nanopb header */\n'
 417
 418     symbol = headername.replace('.', '_').upper()
 419     yield '#ifndef _PB_%s_\n' % symbol
 420     yield '#define _PB_%s_\n' % symbol
 421     yield '#include <pb.h>\n\n'
 422
 423     for dependency in dependencies:
 424         noext = os.path.splitext(dependency)[0]
 425         yield '#include "%s.pb.h"\n' % noext
 426     yield '\n'
 427
 428     yield '/* Enum definitions */\n'
 429     for enum in enums:
 430         yield str(enum) + '\n\n'
 431
 432     yield '/* Struct definitions */\n'
 433     for msg in sort_dependencies(messages):
 434         yield msg.types()
 435         yield str(msg) + '\n\n'
 436
 437     yield '/* Default values for struct fields */\n'
 438     for msg in messages:
 439         yield msg.default_decl(True)
 440     yield '\n'
 441
 442     yield '/* Struct field encoding specification for nanopb */\n'
 443     for msg in messages:
 444         yield msg.fields_declaration() + '\n'
 445
 446     if messages:
 447         count_required_fields = lambda m: len([f for f in msg.fields if f.htype == 'PB_HTYPE_REQUIRED'])
 448         largest_msg = max(messages, key = count_required_fields)
 449         largest_count = count_required_fields(largest_msg)
 450         if largest_count > 64:
 451             yield '\n/* Check that missing required fields will be properly detected */\n'
 452             yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
 453             yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
 454             yield '       setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
 455             yield '#endif\n'
 456
 457     worst = 0
 458     worst_field = ''
 459     checks = []
 460     for msg in messages:
 461         for field in msg.fields:
 462             status = field.largest_field_value()
 463             if isinstance(status, (str, unicode)):
 464                 checks.append(status)
 465             elif status > worst:
 466                 worst = status
 467                 worst_field = str(field.struct_name) + '.' + str(field.name)
 468
 469     if worst > 255 or checks:
 470         yield '\n/* Check that field information fits in pb_field_t */\n'
 471
 472         if worst < 65536:
 473             yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
 474             if worst > 255:
 475                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
 476             else:
 477                 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
 478                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT)\n' % assertion
 479             yield '#endif\n\n'
 480
 481         if worst > 65535 or checks:
 482             yield '#if !defined(PB_FIELD_32BIT)\n'
 483             if worst > 65535:
 484                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
 485             else:
 486                 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
 487                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT)\n' % assertion
 488             yield '#endif\n'
 489
 490     # End of header
 491     yield '\n#endif\n'
 492
 493 def generate_source(headername, enums, messages):
 494     '''Generate content for a source file.'''
 495
 496     yield '/* Automatically generated nanopb constant definitions */\n'
 497     yield '#include "%s"\n\n' % headername
 498
 499     for msg in messages:
 500         yield msg.default_decl(False)
 501
 502     yield '\n\n'
 503
 504     for msg in messages:
 505         yield msg.fields_definition() + '\n\n'
 506
 507
 508
 509 # ---------------------------------------------------------------------------
 510 #                         Command line interface
 511 # ---------------------------------------------------------------------------
 512
 513 import sys
 514 import os.path
 515 from optparse import OptionParser
 516 import google.protobuf.text_format as text_format
 517
 518 optparser = OptionParser(
 519     usage = "Usage: nanopb_generator.py [options] file.pb ...",
 520     epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
 521              "Output will be written to file.pb.h and file.pb.c.")
 522 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
 523     help="Exclude file from generated #include list.")
 524 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
 525     help="Don't print anything except errors.")
 526 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
 527     help="Print more information.")
 528 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
 529     help="Set generator option (max_size, max_count etc.).")
 530
 531 def get_nanopb_suboptions(subdesc, options):
 532     '''Get copy of options, and merge information from subdesc.'''
 533     new_options = nanopb_pb2.NanoPBOptions()
 534     new_options.CopyFrom(options)
 535
 536     if isinstance(subdesc.options, descriptor.FieldOptions):
 537         ext_type = nanopb_pb2.nanopb
 538     elif isinstance(subdesc.options, descriptor.FileOptions):
 539         ext_type = nanopb_pb2.nanopb_fileopt
 540     elif isinstance(subdesc.options, descriptor.MessageOptions):
 541         ext_type = nanopb_pb2.nanopb_msgopt
 542     else:
 543         raise Exception("Unknown options type")
 544
 545     if subdesc.options.HasExtension(ext_type):
 546         ext = subdesc.options.Extensions[ext_type]
 547         new_options.MergeFrom(ext)
 548
 549     return new_options
 550
 551 def process(filenames, options):
 552     '''Process the files given on the command line.'''
 553
 554     if not filenames:
 555         optparser.print_help()
 556         return False
 557
 558     if options.quiet:
 559         options.verbose = False
 560
 561     toplevel_options = nanopb_pb2.NanoPBOptions()
 562     for s in options.settings:
 563         text_format.Merge(s, toplevel_options)
 564
 565     for filename in filenames:
 566         data = open(filename, 'rb').read()
 567         fdesc = descriptor.FileDescriptorSet.FromString(data)
 568
 569         file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options)
 570
 571         if options.verbose:
 572             print "Options for " + filename + ":"
 573             print text_format.MessageToString(file_options)
 574
 575         enums, messages = parse_file(fdesc.file[0], file_options)
 576
 577         noext = os.path.splitext(filename)[0]
 578         headername = noext + '.pb.h'
 579         sourcename = noext + '.pb.c'
 580         headerbasename = os.path.basename(headername)
 581
 582         if not options.quiet:
 583             print "Writing to " + headername + " and " + sourcename
 584
 585         # List of .proto files that should not be included in the C header file
 586         # even if they are mentioned in the source .proto.
 587         excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
 588         dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
 589
 590         header = open(headername, 'w')
 591         for part in generate_header(dependencies, headerbasename, enums, messages):
 592             header.write(part)
 593
 594         source = open(sourcename, 'w')
 595         for part in generate_source(headerbasename, enums, messages):
 596             source.write(part)
 597
 598     return True
 599
 600 if __name__ == '__main__':
 601     options, filenames = optparser.parse_args()
 602     status = process(filenames, options)
 603
 604     if not status:
 605         sys.exit(1)
 606