generator/nanopb_generator.py

   1 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
   2 nanopb_version = "nanopb-0.2.2-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, desc, field_options):
 280         '''desc is ExtensionRange'''
 281         self.tag = desc.start
 282         self.struct_name = struct_name
 283         self.name = 'extensions'
 284         self.pbtype = 'EXTENSION'
 285         self.rules = 'OPTIONAL'
 286         self.allocation = 'CALLBACK'
 287         self.ctype = 'pb_extension_t'
 288         self.array_decl = ''
 289         self.default = None
 290         self.max_size = 0
 291         self.max_count = 0
 292
 293     def __str__(self):
 294         return '    pb_extension_t *extensions;'
 295
 296     def types(self):
 297         return None
 298
 299     def tags(self):
 300         return ''
 301
 302 class ExtensionField(Field):
 303     def __init__(self, struct_name, desc, field_options):
 304         self.fullname = struct_name + desc.name
 305         self.extendee_name = names_from_type_name(desc.extendee)
 306         Field.__init__(self, self.fullname + 'struct', desc, field_options)
 307
 308     def extension_decl(self):
 309         '''Declaration of the extension type in the .pb.h file'''
 310         return 'extern const pb_extension_type_t %s;' % self.fullname
 311
 312     def extension_def(self):
 313         '''Definition of the extension type in the .pb.c file'''
 314         result  = 'typedef struct {\n'
 315         result += str(self)
 316         result += '} %s;\n' % self.struct_name
 317         result += ('static const pb_field_t %s_field = %s;\n' %
 318                     (self.fullname, self.pb_field_t(None)))
 319         result += 'const pb_extension_type_t %s = {\n' % self.fullname
 320         result += '    NULL,\n'
 321         result += '    NULL,\n'
 322         result += '    &%s_field\n' % self.fullname
 323         result += '};\n'
 324         return result
 325
 326
 327 # ---------------------------------------------------------------------------
 328 #                   Generation of messages (structures)
 329 # ---------------------------------------------------------------------------
 330
 331
 332 class Message:
 333     def __init__(self, names, desc, message_options):
 334         self.name = names
 335         self.fields = []
 336
 337         for f in desc.field:
 338             field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
 339             if field_options.type != nanopb_pb2.FT_IGNORE:
 340                 self.fields.append(Field(self.name, f, field_options))
 341
 342         if len(desc.extension_range) > 0:
 343             field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
 344             if field_options.type != nanopb_pb2.FT_IGNORE:
 345                 self.fields.append(ExtensionRange(self.name, desc.extension_range[0], field_options))
 346
 347         self.packed = message_options.packed_struct
 348         self.ordered_fields = self.fields[:]
 349         self.ordered_fields.sort()
 350
 351     def get_dependencies(self):
 352         '''Get list of type names that this structure refers to.'''
 353         return [str(field.ctype) for field in self.fields]
 354
 355     def __str__(self):
 356         result = 'typedef struct _%s {\n' % self.name
 357
 358         if not self.ordered_fields:
 359             # Empty structs are not allowed in C standard.
 360             # Therefore add a dummy field if an empty message occurs.
 361             result += '    uint8_t dummy_field;'
 362
 363         result += '\n'.join([str(f) for f in self.ordered_fields])
 364         result += '\n}'
 365
 366         if self.packed:
 367             result += ' pb_packed'
 368
 369         result += ' %s;' % self.name
 370
 371         if self.packed:
 372             result = 'PB_PACKED_STRUCT_START\n' + result
 373             result += '\nPB_PACKED_STRUCT_END'
 374
 375         return result
 376
 377     def types(self):
 378         result = ""
 379         for field in self.fields:
 380             types = field.types()
 381             if types is not None:
 382                 result += types + '\n'
 383         return result
 384
 385     def default_decl(self, declaration_only = False):
 386         result = ""
 387         for field in self.fields:
 388             default = field.default_decl(declaration_only)
 389             if default is not None:
 390                 result += default + '\n'
 391         return result
 392
 393     def fields_declaration(self):
 394         result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
 395         return result
 396
 397     def fields_definition(self):
 398         result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
 399
 400         prev = None
 401         for field in self.ordered_fields:
 402             result += field.pb_field_t(prev)
 403             result += ',\n'
 404             prev = field.name
 405
 406         result += '    PB_LAST_FIELD\n};'
 407         return result
 408
 409
 410
 411 # ---------------------------------------------------------------------------
 412 #                    Processing of entire .proto files
 413 # ---------------------------------------------------------------------------
 414
 415
 416 def iterate_messages(desc, names = Names()):
 417     '''Recursively find all messages. For each, yield name, DescriptorProto.'''
 418     if hasattr(desc, 'message_type'):
 419         submsgs = desc.message_type
 420     else:
 421         submsgs = desc.nested_type
 422
 423     for submsg in submsgs:
 424         sub_names = names + submsg.name
 425         yield sub_names, submsg
 426
 427         for x in iterate_messages(submsg, sub_names):
 428             yield x
 429
 430 def iterate_extensions(desc, names = Names()):
 431     '''Recursively find all extensions.
 432     For each, yield name, FieldDescriptorProto.
 433     '''
 434     for extension in desc.extension:
 435         yield names, extension
 436
 437     for subname, subdesc in iterate_messages(desc, names):
 438         for extension in subdesc.extension:
 439             yield subname, extension
 440
 441 def parse_file(fdesc, file_options):
 442     '''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).'''
 443
 444     enums = []
 445     messages = []
 446     extensions = []
 447
 448     if fdesc.package:
 449         base_name = Names(fdesc.package.split('.'))
 450     else:
 451         base_name = Names()
 452
 453     for enum in fdesc.enum_type:
 454         enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
 455         enums.append(Enum(base_name, enum, enum_options))
 456
 457     for names, message in iterate_messages(fdesc, base_name):
 458         message_options = get_nanopb_suboptions(message, file_options, names)
 459         messages.append(Message(names, message, message_options))
 460         for enum in message.enum_type:
 461             enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
 462             enums.append(Enum(names, enum, enum_options))
 463
 464     for names, extension in iterate_extensions(fdesc, base_name):
 465         field_options = get_nanopb_suboptions(extension, file_options, names)
 466         extensions.append(ExtensionField(names, extension, field_options))
 467
 468     # Fix field default values where enum short names are used.
 469     for enum in enums:
 470         if not enum.options.long_names:
 471             for message in messages:
 472                 for field in message.fields:
 473                     if field.default in enum.value_longnames:
 474                         idx = enum.value_longnames.index(field.default)
 475                         field.default = enum.values[idx][0]
 476
 477     return enums, messages, extensions
 478
 479 def toposort2(data):
 480     '''Topological sort.
 481     From http://code.activestate.com/recipes/577413-topological-sort/
 482     This function is under the MIT license.
 483     '''
 484     for k, v in data.items():
 485         v.discard(k) # Ignore self dependencies
 486     extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
 487     data.update(dict([(item, set()) for item in extra_items_in_deps]))
 488     while True:
 489         ordered = set(item for item,dep in data.items() if not dep)
 490         if not ordered:
 491             break
 492         for item in sorted(ordered):
 493             yield item
 494         data = dict([(item, (dep - ordered)) for item,dep in data.items()
 495                 if item not in ordered])
 496     assert not data, "A cyclic dependency exists amongst %r" % data
 497
 498 def sort_dependencies(messages):
 499     '''Sort a list of Messages based on dependencies.'''
 500     dependencies = {}
 501     message_by_name = {}
 502     for message in messages:
 503         dependencies[str(message.name)] = set(message.get_dependencies())
 504         message_by_name[str(message.name)] = message
 505
 506     for msgname in toposort2(dependencies):
 507         if msgname in message_by_name:
 508             yield message_by_name[msgname]
 509
 510 def make_identifier(headername):
 511     '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
 512     result = ""
 513     for c in headername.upper():
 514         if c.isalnum():
 515             result += c
 516         else:
 517             result += '_'
 518     return result
 519
 520 def generate_header(dependencies, headername, enums, messages, extensions, options):
 521     '''Generate content for a header file.
 522     Generates strings, which should be concatenated and stored to file.
 523     '''
 524
 525     yield '/* Automatically generated nanopb header */\n'
 526     yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
 527
 528     symbol = make_identifier(headername)
 529     yield '#ifndef _PB_%s_\n' % symbol
 530     yield '#define _PB_%s_\n' % symbol
 531     try:
 532         yield options.libformat % ('pb.h')
 533     except TypeError:
 534         # no %s specified - use whatever was passed in as options.libformat
 535         yield options.libformat
 536     yield '\n'
 537
 538     for dependency in dependencies:
 539         noext = os.path.splitext(dependency)[0]
 540         yield options.genformat % (noext + '.' + options.extension + '.h')
 541         yield '\n'
 542
 543     yield '#ifdef __cplusplus\n'
 544     yield 'extern "C" {\n'
 545     yield '#endif\n\n'
 546
 547     yield '/* Enum definitions */\n'
 548     for enum in enums:
 549         yield str(enum) + '\n\n'
 550
 551     yield '/* Struct definitions */\n'
 552     for msg in sort_dependencies(messages):
 553         yield msg.types()
 554         yield str(msg) + '\n\n'
 555
 556     if extensions:
 557         yield '/* Extensions */\n'
 558         for extension in extensions:
 559             yield extension.extension_decl()
 560         yield '\n'
 561
 562     yield '/* Default values for struct fields */\n'
 563     for msg in messages:
 564         yield msg.default_decl(True)
 565     yield '\n'
 566
 567     yield '/* Field tags (for use in manual encoding/decoding) */\n'
 568     for msg in sort_dependencies(messages):
 569         for field in msg.fields:
 570             yield field.tags()
 571     yield '\n'
 572
 573     yield '/* Struct field encoding specification for nanopb */\n'
 574     for msg in messages:
 575         yield msg.fields_declaration() + '\n'
 576
 577     yield '\n#ifdef __cplusplus\n'
 578     yield '} /* extern "C" */\n'
 579     yield '#endif\n'
 580
 581     # End of header
 582     yield '\n#endif\n'
 583
 584 def generate_source(headername, enums, messages, extensions):
 585     '''Generate content for a source file.'''
 586
 587     yield '/* Automatically generated nanopb constant definitions */\n'
 588     yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
 589     yield options.genformat % (headername)
 590     yield '\n'
 591
 592     for msg in messages:
 593         yield msg.default_decl(False)
 594
 595     yield '\n\n'
 596
 597     for msg in messages:
 598         yield msg.fields_definition() + '\n\n'
 599
 600     for ext in extensions:
 601         yield ext.extension_def() + '\n'
 602
 603     # Add checks for numeric limits
 604     if messages:
 605         count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
 606         largest_msg = max(messages, key = count_required_fields)
 607         largest_count = count_required_fields(largest_msg)
 608         if largest_count > 64:
 609             yield '\n/* Check that missing required fields will be properly detected */\n'
 610             yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
 611             yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
 612             yield '       setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
 613             yield '#endif\n'
 614
 615     worst = 0
 616     worst_field = ''
 617     checks = []
 618     checks_msgnames = []
 619     for msg in messages:
 620         checks_msgnames.append(msg.name)
 621         for field in msg.fields:
 622             status = field.largest_field_value()
 623             if isinstance(status, (str, unicode)):
 624                 checks.append(status)
 625             elif status > worst:
 626                 worst = status
 627                 worst_field = str(field.struct_name) + '.' + str(field.name)
 628
 629     if worst > 255 or checks:
 630         yield '\n/* Check that field information fits in pb_field_t */\n'
 631
 632         if worst < 65536:
 633             yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
 634             if worst > 255:
 635                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
 636             else:
 637                 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
 638                 msgs = '_'.join(str(n) for n in checks_msgnames)
 639                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
 640             yield '#endif\n\n'
 641
 642         if worst > 65535 or checks:
 643             yield '#if !defined(PB_FIELD_32BIT)\n'
 644             if worst > 65535:
 645                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
 646             else:
 647                 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
 648                 msgs = '_'.join(str(n) for n in checks_msgnames)
 649                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
 650             yield '#endif\n'
 651
 652     # Add check for sizeof(double)
 653     has_double = False
 654     for msg in messages:
 655         for field in msg.fields:
 656             if field.ctype == 'double':
 657                 has_double = True
 658
 659     if has_double:
 660         yield '\n'
 661         yield '/* On some platforms (such as AVR), double is really float.\n'
 662         yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
 663         yield ' * To get rid of this error, remove any double fields from your .proto.\n'
 664         yield ' */\n'
 665         yield 'STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
 666
 667     yield '\n'
 668
 669 # ---------------------------------------------------------------------------
 670 #                    Options parsing for the .proto files
 671 # ---------------------------------------------------------------------------
 672
 673 from fnmatch import fnmatch
 674
 675 def read_options_file(infile):
 676     '''Parse a separate options file to list:
 677         [(namemask, options), ...]
 678     '''
 679     results = []
 680     for line in infile:
 681         line = line.strip()
 682         if not line or line.startswith('//') or line.startswith('#'):
 683             continue
 684
 685         parts = line.split(None, 1)
 686         opts = nanopb_pb2.NanoPBOptions()
 687         text_format.Merge(parts[1], opts)
 688         results.append((parts[0], opts))
 689
 690     return results
 691
 692 class Globals:
 693     '''Ugly global variables, should find a good way to pass these.'''
 694     verbose_options = False
 695     separate_options = []
 696
 697 def get_nanopb_suboptions(subdesc, options, name):
 698     '''Get copy of options, and merge information from subdesc.'''
 699     new_options = nanopb_pb2.NanoPBOptions()
 700     new_options.CopyFrom(options)
 701
 702     # Handle options defined in a separate file
 703     dotname = '.'.join(name.parts)
 704     for namemask, options in Globals.separate_options:
 705         if fnmatch(dotname, namemask):
 706             new_options.MergeFrom(options)
 707
 708     # Handle options defined in .proto
 709     if isinstance(subdesc.options, descriptor.FieldOptions):
 710         ext_type = nanopb_pb2.nanopb
 711     elif isinstance(subdesc.options, descriptor.FileOptions):
 712         ext_type = nanopb_pb2.nanopb_fileopt
 713     elif isinstance(subdesc.options, descriptor.MessageOptions):
 714         ext_type = nanopb_pb2.nanopb_msgopt
 715     elif isinstance(subdesc.options, descriptor.EnumOptions):
 716         ext_type = nanopb_pb2.nanopb_enumopt
 717     else:
 718         raise Exception("Unknown options type")
 719
 720     if subdesc.options.HasExtension(ext_type):
 721         ext = subdesc.options.Extensions[ext_type]
 722         new_options.MergeFrom(ext)
 723
 724     if Globals.verbose_options:
 725         print "Options for " + dotname + ":"
 726         print text_format.MessageToString(new_options)
 727
 728     return new_options
 729
 730
 731 # ---------------------------------------------------------------------------
 732 #                         Command line interface
 733 # ---------------------------------------------------------------------------
 734
 735 import sys
 736 import os.path
 737 from optparse import OptionParser
 738
 739 optparser = OptionParser(
 740     usage = "Usage: nanopb_generator.py [options] file.pb ...",
 741     epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
 742              "Output will be written to file.pb.h and file.pb.c.")
 743 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
 744     help="Exclude file from generated #include list.")
 745 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
 746     help="Set extension to use instead of 'pb' for generated files. [default: %default]")
 747 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
 748     help="Set name of a separate generator options file.")
 749 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
 750     metavar="FORMAT", default='#include "%s"\n',
 751     help="Set format string to use for including other .pb.h files. [default: %default]")
 752 optparser.add_option("-L", "--library-include-format", dest="libformat",
 753     metavar="FORMAT", default='#include <%s>\n',
 754     help="Set format string to use for including the nanopb pb.h header. [default: %default]")
 755 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
 756     help="Don't print anything except errors.")
 757 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
 758     help="Print more information.")
 759 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
 760     help="Set generator option (max_size, max_count etc.).")
 761
 762 def process(filenames, options):
 763     '''Process the files given on the command line.'''
 764
 765     if not filenames:
 766         optparser.print_help()
 767         return False
 768
 769     if options.quiet:
 770         options.verbose = False
 771
 772     Globals.verbose_options = options.verbose
 773
 774     toplevel_options = nanopb_pb2.NanoPBOptions()
 775     for s in options.settings:
 776         text_format.Merge(s, toplevel_options)
 777
 778     for filename in filenames:
 779         data = open(filename, 'rb').read()
 780         fdesc = descriptor.FileDescriptorSet.FromString(data)
 781
 782         # Check if any separate options are specified
 783         try:
 784             optfilename = options.options_file % os.path.splitext(filename)[0]
 785         except TypeError:
 786             # No %s specified, use the filename as-is
 787             optfilename = options.options_file
 788
 789         if options.verbose:
 790             print 'Reading options from ' + optfilename
 791
 792         if os.path.isfile(optfilename):
 793             Globals.separate_options = read_options_file(open(optfilename, "rU"))
 794         else:
 795             Globals.separate_options = []
 796
 797         # Parse the file
 798         file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options, Names([filename]))
 799         enums, messages, extensions = parse_file(fdesc.file[0], file_options)
 800
 801         noext = os.path.splitext(filename)[0]
 802         headername = noext + '.' + options.extension + '.h'
 803         sourcename = noext + '.' + options.extension + '.c'
 804         headerbasename = os.path.basename(headername)
 805
 806         if not options.quiet:
 807             print "Writing to " + headername + " and " + sourcename
 808
 809         # List of .proto files that should not be included in the C header file
 810         # even if they are mentioned in the source .proto.
 811         excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
 812         dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
 813
 814         header = open(headername, 'w')
 815         for part in generate_header(dependencies, headerbasename, enums,
 816                                     messages, extensions, options):
 817             header.write(part)
 818
 819         source = open(sourcename, 'w')
 820         for part in generate_source(headerbasename, enums, messages, extensions):
 821             source.write(part)
 822
 823     return True
 824
 825 if __name__ == '__main__':
 826     options, filenames = optparser.parse_args()
 827     status = process(filenames, options)
 828
 829     if not status:
 830         sys.exit(1)
 831