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