generator/nanopb_generator.py

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