generator/nanopb_generator.py

   1 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
   2 nanopb_version = "nanopb-0.2.3-dev"
   3
   4 try:
   5     import google.protobuf.descriptor_pb2 as descriptor
   6     import google.protobuf.text_format as text_format
   7 except:
   8     print
   9     print "*************************************************************"
  10     print "*** Could not import the Google protobuf Python libraries ***"
  11     print "*** Try installing package 'python-protobuf' or similar.  ***"
  12     print "*************************************************************"
  13     print
  14     raise
  15
  16 try:
  17     import nanopb_pb2
  18 except:
  19     print
  20     print "***************************************************************"
  21     print "*** Could not import the precompiled nanopb_pb2.py.         ***"
  22     print "*** Run 'make' in the 'generator' folder to update the file.***"
  23     print "***************************************************************"
  24     print
  25     raise
  26
  27
  28
  29
  30
  31
  32 # ---------------------------------------------------------------------------
  33 #                     Generation of single fields
  34 # ---------------------------------------------------------------------------
  35
  36 import time
  37 import os.path
  38
  39 # Values are tuple (c type, pb type)
  40 FieldD = descriptor.FieldDescriptorProto
  41 datatypes = {
  42     FieldD.TYPE_BOOL:       ('bool',     'BOOL'),
  43     FieldD.TYPE_DOUBLE:     ('double',   'DOUBLE'),
  44     FieldD.TYPE_FIXED32:    ('uint32_t', 'FIXED32'),
  45     FieldD.TYPE_FIXED64:    ('uint64_t', 'FIXED64'),
  46     FieldD.TYPE_FLOAT:      ('float',    'FLOAT'),
  47     FieldD.TYPE_INT32:      ('int32_t',  'INT32'),
  48     FieldD.TYPE_INT64:      ('int64_t',  'INT64'),
  49     FieldD.TYPE_SFIXED32:   ('int32_t',  'SFIXED32'),
  50     FieldD.TYPE_SFIXED64:   ('int64_t',  'SFIXED64'),
  51     FieldD.TYPE_SINT32:     ('int32_t',  'SINT32'),
  52     FieldD.TYPE_SINT64:     ('int64_t',  'SINT64'),
  53     FieldD.TYPE_UINT32:     ('uint32_t', 'UINT32'),
  54     FieldD.TYPE_UINT64:     ('uint64_t', 'UINT64')
  55 }
  56
  57 class Names:
  58     '''Keeps a set of nested names and formats them to C identifier.'''
  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 __eq__(self, other):
  76         return isinstance(other, Names) and self.parts == other.parts
  77
  78 def names_from_type_name(type_name):
  79     '''Parse Names() from FieldDescriptorProto type_name'''
  80     if type_name[0] != '.':
  81         raise NotImplementedError("Lookup of non-absolute type names is not supported")
  82     return Names(type_name[1:].split('.'))
  83
  84 class Enum:
  85     def __init__(self, names, desc, enum_options):
  86         '''desc is EnumDescriptorProto'''
  87
  88         self.options = enum_options
  89         self.names = names + desc.name
  90
  91         if enum_options.long_names:
  92             self.values = [(self.names + x.name, x.number) for x in desc.value]
  93         else:
  94             self.values = [(names + x.name, x.number) for x in desc.value]
  95
  96         self.value_longnames = [self.names + x.name for x in desc.value]
  97
  98     def __str__(self):
  99         result = 'typedef enum _%s {\n' % self.names
 100         result += ',\n'.join(["    %s = %d" % x for x in self.values])
 101         result += '\n} %s;' % self.names
 102         return result
 103
 104 class Field:
 105     def __init__(self, struct_name, desc, field_options):
 106         '''desc is FieldDescriptorProto'''
 107         self.tag = desc.number
 108         self.struct_name = struct_name
 109         self.name = desc.name
 110         self.default = None
 111         self.max_size = None
 112         self.max_count = None
 113         self.array_decl = ""
 114
 115         # Parse field options
 116         if field_options.HasField("max_size"):
 117             self.max_size = field_options.max_size
 118
 119         if field_options.HasField("max_count"):
 120             self.max_count = field_options.max_count
 121
 122         if desc.HasField('default_value'):
 123             self.default = desc.default_value
 124
 125         # Check field rules, i.e. required/optional/repeated.
 126         can_be_static = True
 127         if desc.label == FieldD.LABEL_REQUIRED:
 128             self.rules = 'REQUIRED'
 129         elif desc.label == FieldD.LABEL_OPTIONAL:
 130             self.rules = 'OPTIONAL'
 131         elif desc.label == FieldD.LABEL_REPEATED:
 132             self.rules = 'REPEATED'
 133             if self.max_count is None:
 134                 can_be_static = False
 135             else:
 136                 self.array_decl = '[%d]' % self.max_count
 137         else:
 138             raise NotImplementedError(desc.label)
 139
 140         # Decide the C data type to use in the struct.
 141         if datatypes.has_key(desc.type):
 142             self.ctype, self.pbtype = datatypes[desc.type]
 143         elif desc.type == FieldD.TYPE_ENUM:
 144             self.pbtype = 'ENUM'
 145             self.ctype = names_from_type_name(desc.type_name)
 146             if self.default is not None:
 147                 self.default = self.ctype + self.default
 148         elif desc.type == FieldD.TYPE_STRING:
 149             self.pbtype = 'STRING'
 150             if self.max_size is None:
 151                 can_be_static = False
 152             else:
 153                 self.ctype = 'char'
 154                 self.array_decl += '[%d]' % self.max_size
 155         elif desc.type == FieldD.TYPE_BYTES:
 156             self.pbtype = 'BYTES'
 157             if self.max_size is None:
 158                 can_be_static = False
 159             else:
 160                 self.ctype = self.struct_name + self.name + 't'
 161         elif desc.type == FieldD.TYPE_MESSAGE:
 162             self.pbtype = 'MESSAGE'
 163             self.ctype = self.submsgname = names_from_type_name(desc.type_name)
 164         else:
 165             raise NotImplementedError(desc.type)
 166
 167         if field_options.type == nanopb_pb2.FT_DEFAULT:
 168             if can_be_static:
 169                 field_options.type = nanopb_pb2.FT_STATIC
 170             else:
 171                 field_options.type = nanopb_pb2.FT_CALLBACK
 172
 173         if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
 174             raise Exception("Field %s is defined as static, but max_size or max_count is not given." % self.name)
 175
 176         if field_options.type == nanopb_pb2.FT_STATIC:
 177             self.allocation = 'STATIC'
 178         elif field_options.type == nanopb_pb2.FT_CALLBACK:
 179             self.allocation = 'CALLBACK'
 180             self.ctype = 'pb_callback_t'
 181             self.array_decl = ''
 182         else:
 183             raise NotImplementedError(field_options.type)
 184
 185     def __cmp__(self, other):
 186         return cmp(self.tag, other.tag)
 187
 188     def __str__(self):
 189         if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
 190             result = '    bool has_' + self.name + ';\n'
 191         elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
 192             result = '    size_t ' + self.name + '_count;\n'
 193         else:
 194             result = ''
 195         result += '    %s %s%s;' % (self.ctype, self.name, self.array_decl)
 196         return result
 197
 198     def types(self):
 199         '''Return definitions for any special types this field might need.'''
 200         if self.pbtype == 'BYTES' and self.allocation == 'STATIC':
 201             result = 'typedef struct {\n'
 202             result += '    size_t size;\n'
 203             result += '    uint8_t bytes[%d];\n' % self.max_size
 204             result += '} %s;\n' % self.ctype
 205         else:
 206             result = None
 207         return result
 208
 209     def default_decl(self, declaration_only = False):
 210         '''Return definition for this field's default value.'''
 211         if self.default is None:
 212             return None
 213
 214         ctype, default = self.ctype, self.default
 215         array_decl = ''
 216
 217         if self.pbtype == 'STRING':
 218             if self.allocation != 'STATIC':
 219                 return None # Not implemented
 220
 221             array_decl = '[%d]' % self.max_size
 222             default = str(self.default).encode('string_escape')
 223             default = default.replace('"', '\\"')
 224             default = '"' + default + '"'
 225         elif self.pbtype == 'BYTES':
 226             if self.allocation != 'STATIC':
 227                 return None # Not implemented
 228
 229             data = self.default.decode('string_escape')
 230             data = ['0x%02x' % ord(c) for c in data]
 231             default = '{%d, {%s}}' % (len(data), ','.join(data))
 232
 233         if declaration_only:
 234             return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
 235         else:
 236             return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
 237
 238     def tags(self):
 239         '''Return the #define for the tag number of this field.'''
 240         identifier = '%s_%s_tag' % (self.struct_name, self.name)
 241         return '#define %-40s %d\n' % (identifier, self.tag)
 242
 243     def pb_field_t(self, prev_field_name):
 244         '''Return the pb_field_t initializer to use in the constant array.
 245         prev_field_name is the name of the previous field or None.
 246         '''
 247         result  = '    PB_FIELD(%3d, ' % self.tag
 248         result += '%-8s, ' % self.pbtype
 249         result += '%s, ' % self.rules
 250         result += '%s, ' % self.allocation
 251         result += '%s, ' % self.struct_name
 252         result += '%s, ' % self.name
 253         result += '%s, ' % (prev_field_name or self.name)
 254
 255         if self.pbtype == 'MESSAGE':
 256             result += '&%s_fields)' % self.submsgname
 257         elif self.default is None:
 258             result += '0)'
 259         elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
 260             result += '0)' # Arbitrary size default values not implemented
 261         else:
 262             result += '&%s_default)' % (self.struct_name + self.name)
 263
 264         return result
 265
 266     def largest_field_value(self):
 267         '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
 268         Returns numeric value or a C-expression for assert.'''
 269         if self.pbtype == 'MESSAGE':
 270             if self.rules == 'REPEATED' and self.allocation == 'STATIC':
 271                 return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
 272             else:
 273                 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
 274
 275         return max(self.tag, self.max_size, self.max_count)
 276
 277
 278 class ExtensionRange(Field):
 279     def __init__(self, struct_name, range_start, field_options):
 280         '''Implements a special pb_extension_t* field in an extensible message
 281         structure. The range_start signifies the index at which the extensions
 282         start. Not necessarily all tags above this are extensions, it is merely
 283         a speed optimization.
 284         '''
 285         self.tag = range_start
 286         self.struct_name = struct_name
 287         self.name = 'extensions'
 288         self.pbtype = 'EXTENSION'
 289         self.rules = 'OPTIONAL'
 290         self.allocation = 'CALLBACK'
 291         self.ctype = 'pb_extension_t'
 292         self.array_decl = ''
 293         self.default = None
 294         self.max_size = 0
 295         self.max_count = 0
 296
 297     def __str__(self):
 298         return '    pb_extension_t *extensions;'
 299
 300     def types(self):
 301         return None
 302
 303     def tags(self):
 304         return ''
 305
 306 class ExtensionField(Field):
 307     def __init__(self, struct_name, desc, field_options):
 308         self.fullname = struct_name + desc.name
 309         self.extendee_name = names_from_type_name(desc.extendee)
 310         Field.__init__(self, self.fullname + 'struct', desc, field_options)
 311
 312         if self.rules != 'OPTIONAL':
 313             raise NotImplementedError("Only 'optional' is supported for extension fields. "
 314                + "(%s.rules == %s)" % (self.fullname, self.rules))
 315
 316         self.rules = 'OPTEXT'
 317
 318     def extension_decl(self):
 319         '''Declaration of the extension type in the .pb.h file'''
 320         return 'extern const pb_extension_type_t %s;\n' % self.fullname
 321
 322     def extension_def(self):
 323         '''Definition of the extension type in the .pb.c file'''
 324
 325         result  = 'typedef struct {\n'
 326         result += str(self)
 327         result += '\n} %s;\n\n' % self.struct_name
 328         result += ('static const pb_field_t %s_field = \n  %s;\n\n' %
 329                     (self.fullname, self.pb_field_t(None)))
 330         result += 'const pb_extension_type_t %s = {\n' % self.fullname
 331         result += '    NULL,\n'
 332         result += '    NULL,\n'
 333         result += '    &%s_field\n' % self.fullname
 334         result += '};\n'
 335         return result
 336
 337
 338 # ---------------------------------------------------------------------------
 339 #                   Generation of messages (structures)
 340 # ---------------------------------------------------------------------------
 341
 342
 343 class Message:
 344     def __init__(self, names, desc, message_options):
 345         self.name = names
 346         self.fields = []
 347
 348         for f in desc.field:
 349             field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
 350             if field_options.type != nanopb_pb2.FT_IGNORE:
 351                 self.fields.append(Field(self.name, f, field_options))
 352
 353         if len(desc.extension_range) > 0:
 354             field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
 355             range_start = min([r.start for r in desc.extension_range])
 356             if field_options.type != nanopb_pb2.FT_IGNORE:
 357                 self.fields.append(ExtensionRange(self.name, range_start, field_options))
 358
 359         self.packed = message_options.packed_struct
 360         self.ordered_fields = self.fields[:]
 361         self.ordered_fields.sort()
 362
 363     def get_dependencies(self):
 364         '''Get list of type names that this structure refers to.'''
 365         return [str(field.ctype) for field in self.fields]
 366
 367     def __str__(self):
 368         result = 'typedef struct _%s {\n' % self.name
 369
 370         if not self.ordered_fields:
 371             # Empty structs are not allowed in C standard.
 372             # Therefore add a dummy field if an empty message occurs.
 373             result += '    uint8_t dummy_field;'
 374
 375         result += '\n'.join([str(f) for f in self.ordered_fields])
 376         result += '\n}'
 377
 378         if self.packed:
 379             result += ' pb_packed'
 380
 381         result += ' %s;' % self.name
 382
 383         if self.packed:
 384             result = 'PB_PACKED_STRUCT_START\n' + result
 385             result += '\nPB_PACKED_STRUCT_END'
 386
 387         return result
 388
 389     def types(self):
 390         result = ""
 391         for field in self.fields:
 392             types = field.types()
 393             if types is not None:
 394                 result += types + '\n'
 395         return result
 396
 397     def default_decl(self, declaration_only = False):
 398         result = ""
 399         for field in self.fields:
 400             default = field.default_decl(declaration_only)
 401             if default is not None:
 402                 result += default + '\n'
 403         return result
 404
 405     def fields_declaration(self):
 406         result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
 407         return result
 408
 409     def fields_definition(self):
 410         result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
 411
 412         prev = None
 413         for field in self.ordered_fields:
 414             result += field.pb_field_t(prev)
 415             result += ',\n'
 416             prev = field.name
 417
 418         result += '    PB_LAST_FIELD\n};'
 419         return result
 420
 421
 422
 423 # ---------------------------------------------------------------------------
 424 #                    Processing of entire .proto files
 425 # ---------------------------------------------------------------------------
 426
 427
 428 def iterate_messages(desc, names = Names()):
 429     '''Recursively find all messages. For each, yield name, DescriptorProto.'''
 430     if hasattr(desc, 'message_type'):
 431         submsgs = desc.message_type
 432     else:
 433         submsgs = desc.nested_type
 434
 435     for submsg in submsgs:
 436         sub_names = names + submsg.name
 437         yield sub_names, submsg
 438
 439         for x in iterate_messages(submsg, sub_names):
 440             yield x
 441
 442 def iterate_extensions(desc, names = Names()):
 443     '''Recursively find all extensions.
 444     For each, yield name, FieldDescriptorProto.
 445     '''
 446     for extension in desc.extension:
 447         yield names, extension
 448
 449     for subname, subdesc in iterate_messages(desc, names):
 450         for extension in subdesc.extension:
 451             yield subname, extension
 452
 453 def parse_file(fdesc, file_options):
 454     '''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).'''
 455
 456     enums = []
 457     messages = []
 458     extensions = []
 459
 460     if fdesc.package:
 461         base_name = Names(fdesc.package.split('.'))
 462     else:
 463         base_name = Names()
 464
 465     for enum in fdesc.enum_type:
 466         enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
 467         enums.append(Enum(base_name, enum, enum_options))
 468
 469     for names, message in iterate_messages(fdesc, base_name):
 470         message_options = get_nanopb_suboptions(message, file_options, names)
 471         messages.append(Message(names, message, message_options))
 472         for enum in message.enum_type:
 473             enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
 474             enums.append(Enum(names, enum, enum_options))
 475
 476     for names, extension in iterate_extensions(fdesc, base_name):
 477         field_options = get_nanopb_suboptions(extension, file_options, names)
 478         extensions.append(ExtensionField(names, extension, field_options))
 479
 480     # Fix field default values where enum short names are used.
 481     for enum in enums:
 482         if not enum.options.long_names:
 483             for message in messages:
 484                 for field in message.fields:
 485                     if field.default in enum.value_longnames:
 486                         idx = enum.value_longnames.index(field.default)
 487                         field.default = enum.values[idx][0]
 488
 489     return enums, messages, extensions
 490
 491 def toposort2(data):
 492     '''Topological sort.
 493     From http://code.activestate.com/recipes/577413-topological-sort/
 494     This function is under the MIT license.
 495     '''
 496     for k, v in data.items():
 497         v.discard(k) # Ignore self dependencies
 498     extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
 499     data.update(dict([(item, set()) for item in extra_items_in_deps]))
 500     while True:
 501         ordered = set(item for item,dep in data.items() if not dep)
 502         if not ordered:
 503             break
 504         for item in sorted(ordered):
 505             yield item
 506         data = dict([(item, (dep - ordered)) for item,dep in data.items()
 507                 if item not in ordered])
 508     assert not data, "A cyclic dependency exists amongst %r" % data
 509
 510 def sort_dependencies(messages):
 511     '''Sort a list of Messages based on dependencies.'''
 512     dependencies = {}
 513     message_by_name = {}
 514     for message in messages:
 515         dependencies[str(message.name)] = set(message.get_dependencies())
 516         message_by_name[str(message.name)] = message
 517
 518     for msgname in toposort2(dependencies):
 519         if msgname in message_by_name:
 520             yield message_by_name[msgname]
 521
 522 def make_identifier(headername):
 523     '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
 524     result = ""
 525     for c in headername.upper():
 526         if c.isalnum():
 527             result += c
 528         else:
 529             result += '_'
 530     return result
 531
 532 def generate_header(dependencies, headername, enums, messages, extensions, options):
 533     '''Generate content for a header file.
 534     Generates strings, which should be concatenated and stored to file.
 535     '''
 536
 537     yield '/* Automatically generated nanopb header */\n'
 538     yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
 539
 540     symbol = make_identifier(headername)
 541     yield '#ifndef _PB_%s_\n' % symbol
 542     yield '#define _PB_%s_\n' % symbol
 543     try:
 544         yield options.libformat % ('pb.h')
 545     except TypeError:
 546         # no %s specified - use whatever was passed in as options.libformat
 547         yield options.libformat
 548     yield '\n'
 549
 550     for dependency in dependencies:
 551         noext = os.path.splitext(dependency)[0]
 552         yield options.genformat % (noext + '.' + options.extension + '.h')
 553         yield '\n'
 554
 555     yield '#ifdef __cplusplus\n'
 556     yield 'extern "C" {\n'
 557     yield '#endif\n\n'
 558
 559     yield '/* Enum definitions */\n'
 560     for enum in enums:
 561         yield str(enum) + '\n\n'
 562
 563     yield '/* Struct definitions */\n'
 564     for msg in sort_dependencies(messages):
 565         yield msg.types()
 566         yield str(msg) + '\n\n'
 567
 568     if extensions:
 569         yield '/* Extensions */\n'
 570         for extension in extensions:
 571             yield extension.extension_decl()
 572         yield '\n'
 573
 574     yield '/* Default values for struct fields */\n'
 575     for msg in messages:
 576         yield msg.default_decl(True)
 577     yield '\n'
 578
 579     yield '/* Field tags (for use in manual encoding/decoding) */\n'
 580     for msg in sort_dependencies(messages):
 581         for field in msg.fields:
 582             yield field.tags()
 583     yield '\n'
 584
 585     yield '/* Struct field encoding specification for nanopb */\n'
 586     for msg in messages:
 587         yield msg.fields_declaration() + '\n'
 588
 589     yield '\n#ifdef __cplusplus\n'
 590     yield '} /* extern "C" */\n'
 591     yield '#endif\n'
 592
 593     # End of header
 594     yield '\n#endif\n'
 595
 596 def generate_source(headername, enums, messages, extensions):
 597     '''Generate content for a source file.'''
 598
 599     yield '/* Automatically generated nanopb constant definitions */\n'
 600     yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
 601     yield options.genformat % (headername)
 602     yield '\n'
 603
 604     for msg in messages:
 605         yield msg.default_decl(False)
 606
 607     yield '\n\n'
 608
 609     for msg in messages:
 610         yield msg.fields_definition() + '\n\n'
 611
 612     for ext in extensions:
 613         yield ext.extension_def() + '\n'
 614
 615     # Add checks for numeric limits
 616     if messages:
 617         count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
 618         largest_msg = max(messages, key = count_required_fields)
 619         largest_count = count_required_fields(largest_msg)
 620         if largest_count > 64:
 621             yield '\n/* Check that missing required fields will be properly detected */\n'
 622             yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
 623             yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
 624             yield '       setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
 625             yield '#endif\n'
 626
 627     worst = 0
 628     worst_field = ''
 629     checks = []
 630     checks_msgnames = []
 631     for msg in messages:
 632         checks_msgnames.append(msg.name)
 633         for field in msg.fields:
 634             status = field.largest_field_value()
 635             if isinstance(status, (str, unicode)):
 636                 checks.append(status)
 637             elif status > worst:
 638                 worst = status
 639                 worst_field = str(field.struct_name) + '.' + str(field.name)
 640
 641     if worst > 255 or checks:
 642         yield '\n/* Check that field information fits in pb_field_t */\n'
 643
 644         if worst < 65536:
 645             yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
 646             if worst > 255:
 647                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
 648             else:
 649                 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
 650                 msgs = '_'.join(str(n) for n in checks_msgnames)
 651                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
 652             yield '#endif\n\n'
 653
 654         if worst > 65535 or checks:
 655             yield '#if !defined(PB_FIELD_32BIT)\n'
 656             if worst > 65535:
 657                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
 658             else:
 659                 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
 660                 msgs = '_'.join(str(n) for n in checks_msgnames)
 661                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
 662             yield '#endif\n'
 663
 664     # Add check for sizeof(double)
 665     has_double = False
 666     for msg in messages:
 667         for field in msg.fields:
 668             if field.ctype == 'double':
 669                 has_double = True
 670
 671     if has_double:
 672         yield '\n'
 673         yield '/* On some platforms (such as AVR), double is really float.\n'
 674         yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
 675         yield ' * To get rid of this error, remove any double fields from your .proto.\n'
 676         yield ' */\n'
 677         yield 'STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
 678
 679     yield '\n'
 680
 681 # ---------------------------------------------------------------------------
 682 #                    Options parsing for the .proto files
 683 # ---------------------------------------------------------------------------
 684
 685 from fnmatch import fnmatch
 686
 687 def read_options_file(infile):
 688     '''Parse a separate options file to list:
 689         [(namemask, options), ...]
 690     '''
 691     results = []
 692     for line in infile:
 693         line = line.strip()
 694         if not line or line.startswith('//') or line.startswith('#'):
 695             continue
 696
 697         parts = line.split(None, 1)
 698         opts = nanopb_pb2.NanoPBOptions()
 699         text_format.Merge(parts[1], opts)
 700         results.append((parts[0], opts))
 701
 702     return results
 703
 704 class Globals:
 705     '''Ugly global variables, should find a good way to pass these.'''
 706     verbose_options = False
 707     separate_options = []
 708
 709 def get_nanopb_suboptions(subdesc, options, name):
 710     '''Get copy of options, and merge information from subdesc.'''
 711     new_options = nanopb_pb2.NanoPBOptions()
 712     new_options.CopyFrom(options)
 713
 714     # Handle options defined in a separate file
 715     dotname = '.'.join(name.parts)
 716     for namemask, options in Globals.separate_options:
 717         if fnmatch(dotname, namemask):
 718             new_options.MergeFrom(options)
 719
 720     # Handle options defined in .proto
 721     if isinstance(subdesc.options, descriptor.FieldOptions):
 722         ext_type = nanopb_pb2.nanopb
 723     elif isinstance(subdesc.options, descriptor.FileOptions):
 724         ext_type = nanopb_pb2.nanopb_fileopt
 725     elif isinstance(subdesc.options, descriptor.MessageOptions):
 726         ext_type = nanopb_pb2.nanopb_msgopt
 727     elif isinstance(subdesc.options, descriptor.EnumOptions):
 728         ext_type = nanopb_pb2.nanopb_enumopt
 729     else:
 730         raise Exception("Unknown options type")
 731
 732     if subdesc.options.HasExtension(ext_type):
 733         ext = subdesc.options.Extensions[ext_type]
 734         new_options.MergeFrom(ext)
 735
 736     if Globals.verbose_options:
 737         print "Options for " + dotname + ":"
 738         print text_format.MessageToString(new_options)
 739
 740     return new_options
 741
 742
 743 # ---------------------------------------------------------------------------
 744 #                         Command line interface
 745 # ---------------------------------------------------------------------------
 746
 747 import sys
 748 import os.path
 749 from optparse import OptionParser
 750
 751 optparser = OptionParser(
 752     usage = "Usage: nanopb_generator.py [options] file.pb ...",
 753     epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
 754              "Output will be written to file.pb.h and file.pb.c.")
 755 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
 756     help="Exclude file from generated #include list.")
 757 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
 758     help="Set extension to use instead of 'pb' for generated files. [default: %default]")
 759 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
 760     help="Set name of a separate generator options file.")
 761 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
 762     metavar="FORMAT", default='#include "%s"\n',
 763     help="Set format string to use for including other .pb.h files. [default: %default]")
 764 optparser.add_option("-L", "--library-include-format", dest="libformat",
 765     metavar="FORMAT", default='#include <%s>\n',
 766     help="Set format string to use for including the nanopb pb.h header. [default: %default]")
 767 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
 768     help="Don't print anything except errors.")
 769 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
 770     help="Print more information.")
 771 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
 772     help="Set generator option (max_size, max_count etc.).")
 773
 774 def process(filenames, options):
 775     '''Process the files given on the command line.'''
 776
 777     if not filenames:
 778         optparser.print_help()
 779         return False
 780
 781     if options.quiet:
 782         options.verbose = False
 783
 784     Globals.verbose_options = options.verbose
 785
 786     toplevel_options = nanopb_pb2.NanoPBOptions()
 787     for s in options.settings:
 788         text_format.Merge(s, toplevel_options)
 789
 790     for filename in filenames:
 791         data = open(filename, 'rb').read()
 792         fdesc = descriptor.FileDescriptorSet.FromString(data)
 793
 794         # Check if any separate options are specified
 795         try:
 796             optfilename = options.options_file % os.path.splitext(filename)[0]
 797         except TypeError:
 798             # No %s specified, use the filename as-is
 799             optfilename = options.options_file
 800
 801         if options.verbose:
 802             print 'Reading options from ' + optfilename
 803
 804         if os.path.isfile(optfilename):
 805             Globals.separate_options = read_options_file(open(optfilename, "rU"))
 806         else:
 807             Globals.separate_options = []
 808
 809         # Parse the file
 810         file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options, Names([filename]))
 811         enums, messages, extensions = parse_file(fdesc.file[0], file_options)
 812
 813         noext = os.path.splitext(filename)[0]
 814         headername = noext + '.' + options.extension + '.h'
 815         sourcename = noext + '.' + options.extension + '.c'
 816         headerbasename = os.path.basename(headername)
 817
 818         if not options.quiet:
 819             print "Writing to " + headername + " and " + sourcename
 820
 821         # List of .proto files that should not be included in the C header file
 822         # even if they are mentioned in the source .proto.
 823         excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
 824         dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
 825
 826         header = open(headername, 'w')
 827         for part in generate_header(dependencies, headerbasename, enums,
 828                                     messages, extensions, options):
 829             header.write(part)
 830
 831         source = open(sourcename, 'w')
 832         for part in generate_source(headerbasename, enums, messages, extensions):
 833             source.write(part)
 834
 835     return True
 836
 837 if __name__ == '__main__':
 838     options, filenames = optparser.parse_args()
 839     status = process(filenames, options)
 840
 841     if not status:
 842         sys.exit(1)
 843