generator/nanopb_generator.py

   1 #!/usr/bin/python
   2
   3 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
   4 nanopb_version = "nanopb-0.3.0-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_array_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 += '    pb_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 in ['STRING', 'BYTES']:
 270                 # String/bytes 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 += '    pb_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 PB_BYTES_ARRAY_T(%d) %s;\n' % (self.max_size, self.ctype)
 288         else:
 289             result = None
 290         return result
 291
 292     def get_initializer(self, null_init):
 293         '''Return literal expression for this field's default value.'''
 294
 295         if self.pbtype == 'MESSAGE':
 296             if null_init:
 297                 return '%s_init_zero' % self.ctype
 298             else:
 299                 return '%s_init_default' % self.ctype
 300
 301         if self.default is None or null_init:
 302             if self.pbtype == 'STRING':
 303                 return '""'
 304             elif self.pbtype == 'BYTES':
 305                 return '{0, {0}}'
 306             elif self.pbtype == 'ENUM':
 307                 return '(%s)0' % self.ctype
 308             else:
 309                 return '0'
 310
 311         default = str(self.default)
 312
 313         if self.pbtype == 'STRING':
 314             default = default.encode('utf-8').encode('string_escape')
 315             default = default.replace('"', '\\"')
 316             default = '"' + default + '"'
 317         elif self.pbtype == 'BYTES':
 318             data = default.decode('string_escape')
 319             data = ['0x%02x' % ord(c) for c in data]
 320             if len(data) == 0:
 321                 default = '{0, {0}}'
 322             else:
 323                 default = '{%d, {%s}}' % (len(data), ','.join(data))
 324         elif self.pbtype in ['FIXED32', 'UINT32']:
 325             default += 'u'
 326         elif self.pbtype in ['FIXED64', 'UINT64']:
 327             default += 'ull'
 328         elif self.pbtype in ['SFIXED64', 'INT64']:
 329             default += 'll'
 330
 331         return default
 332
 333     def default_decl(self, declaration_only = False):
 334         '''Return definition for this field's default value.'''
 335         if self.default is None:
 336             return None
 337
 338         ctype = self.ctype
 339         default = self.get_initializer(False)
 340         array_decl = ''
 341
 342         if self.pbtype == 'STRING':
 343             if self.allocation != 'STATIC':
 344                 return None # Not implemented
 345             array_decl = '[%d]' % self.max_size
 346         elif self.pbtype == 'BYTES':
 347             if self.allocation != 'STATIC':
 348                 return None # Not implemented
 349
 350         if declaration_only:
 351             return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
 352         else:
 353             return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
 354
 355     def tags(self):
 356         '''Return the #define for the tag number of this field.'''
 357         identifier = '%s_%s_tag' % (self.struct_name, self.name)
 358         return '#define %-40s %d\n' % (identifier, self.tag)
 359
 360     def pb_field_t(self, prev_field_name):
 361         '''Return the pb_field_t initializer to use in the constant array.
 362         prev_field_name is the name of the previous field or None.
 363         '''
 364         result  = '    PB_FIELD2(%3d, ' % self.tag
 365         result += '%-8s, ' % self.pbtype
 366         result += '%s, ' % self.rules
 367         result += '%-8s, ' % self.allocation
 368         result += '%s, ' % ("FIRST" if not prev_field_name else "OTHER")
 369         result += '%s, ' % self.struct_name
 370         result += '%s, ' % self.name
 371         result += '%s, ' % (prev_field_name or self.name)
 372
 373         if self.pbtype == 'MESSAGE':
 374             result += '&%s_fields)' % self.submsgname
 375         elif self.default is None:
 376             result += '0)'
 377         elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
 378             result += '0)' # Arbitrary size default values not implemented
 379         elif self.rules == 'OPTEXT':
 380             result += '0)' # Default value for extensions is not implemented
 381         else:
 382             result += '&%s_default)' % (self.struct_name + self.name)
 383
 384         return result
 385
 386     def largest_field_value(self):
 387         '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
 388         Returns numeric value or a C-expression for assert.'''
 389         if self.pbtype == 'MESSAGE':
 390             if self.rules == 'REPEATED' and self.allocation == 'STATIC':
 391                 return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
 392             else:
 393                 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
 394
 395         return max(self.tag, self.max_size, self.max_count)
 396
 397     def encoded_size(self, allmsgs):
 398         '''Return the maximum size that this field can take when encoded,
 399         including the field tag. If the size cannot be determined, returns
 400         None.'''
 401
 402         if self.allocation != 'STATIC':
 403             return None
 404
 405         if self.pbtype == 'MESSAGE':
 406             for msg in allmsgs:
 407                 if msg.name == self.submsgname:
 408                     encsize = msg.encoded_size(allmsgs)
 409                     if encsize is None:
 410                         return None # Submessage size is indeterminate
 411
 412                     # Include submessage length prefix
 413                     encsize += varint_max_size(encsize.upperlimit())
 414                     break
 415             else:
 416                 # Submessage cannot be found, this currently occurs when
 417                 # the submessage type is defined in a different file.
 418                 # Instead of direct numeric value, reference the size that
 419                 # has been #defined in the other file.
 420                 encsize = EncodedSize(self.submsgname + 'size')
 421
 422                 # We will have to make a conservative assumption on the length
 423                 # prefix size, though.
 424                 encsize += 5
 425
 426         elif self.enc_size is None:
 427             raise RuntimeError("Could not determine encoded size for %s.%s"
 428                                % (self.struct_name, self.name))
 429         else:
 430             encsize = EncodedSize(self.enc_size)
 431
 432         encsize += varint_max_size(self.tag << 3) # Tag + wire type
 433
 434         if self.rules == 'REPEATED':
 435             # Decoders must be always able to handle unpacked arrays.
 436             # Therefore we have to reserve space for it, even though
 437             # we emit packed arrays ourselves.
 438             encsize *= self.max_count
 439
 440         return encsize
 441
 442
 443 class ExtensionRange(Field):
 444     def __init__(self, struct_name, range_start, field_options):
 445         '''Implements a special pb_extension_t* field in an extensible message
 446         structure. The range_start signifies the index at which the extensions
 447         start. Not necessarily all tags above this are extensions, it is merely
 448         a speed optimization.
 449         '''
 450         self.tag = range_start
 451         self.struct_name = struct_name
 452         self.name = 'extensions'
 453         self.pbtype = 'EXTENSION'
 454         self.rules = 'OPTIONAL'
 455         self.allocation = 'CALLBACK'
 456         self.ctype = 'pb_extension_t'
 457         self.array_decl = ''
 458         self.default = None
 459         self.max_size = 0
 460         self.max_count = 0
 461
 462     def __str__(self):
 463         return '    pb_extension_t *extensions;'
 464
 465     def types(self):
 466         return None
 467
 468     def tags(self):
 469         return ''
 470
 471     def encoded_size(self, allmsgs):
 472         # We exclude extensions from the count, because they cannot be known
 473         # until runtime. Other option would be to return None here, but this
 474         # way the value remains useful if extensions are not used.
 475         return EncodedSize(0)
 476
 477 class ExtensionField(Field):
 478     def __init__(self, struct_name, desc, field_options):
 479         self.fullname = struct_name + desc.name
 480         self.extendee_name = names_from_type_name(desc.extendee)
 481         Field.__init__(self, self.fullname + 'struct', desc, field_options)
 482
 483         if self.rules != 'OPTIONAL':
 484             self.skip = True
 485         else:
 486             self.skip = False
 487             self.rules = 'OPTEXT'
 488
 489     def tags(self):
 490         '''Return the #define for the tag number of this field.'''
 491         identifier = '%s_tag' % self.fullname
 492         return '#define %-40s %d\n' % (identifier, self.tag)
 493
 494     def extension_decl(self):
 495         '''Declaration of the extension type in the .pb.h file'''
 496         if self.skip:
 497             msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname
 498             msg +='   type of extension fields is currently supported. */\n'
 499             return msg
 500
 501         return 'extern const pb_extension_type_t %s;\n' % self.fullname
 502
 503     def extension_def(self):
 504         '''Definition of the extension type in the .pb.c file'''
 505
 506         if self.skip:
 507             return ''
 508
 509         result  = 'typedef struct {\n'
 510         result += str(self)
 511         result += '\n} %s;\n\n' % self.struct_name
 512         result += ('static const pb_field_t %s_field = \n  %s;\n\n' %
 513                     (self.fullname, self.pb_field_t(None)))
 514         result += 'const pb_extension_type_t %s = {\n' % self.fullname
 515         result += '    NULL,\n'
 516         result += '    NULL,\n'
 517         result += '    &%s_field\n' % self.fullname
 518         result += '};\n'
 519         return result
 520
 521
 522 # ---------------------------------------------------------------------------
 523 #                   Generation of messages (structures)
 524 # ---------------------------------------------------------------------------
 525
 526
 527 class Message:
 528     def __init__(self, names, desc, message_options):
 529         self.name = names
 530         self.fields = []
 531
 532         for f in desc.field:
 533             field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
 534             if field_options.type != nanopb_pb2.FT_IGNORE:
 535                 self.fields.append(Field(self.name, f, field_options))
 536
 537         if len(desc.extension_range) > 0:
 538             field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
 539             range_start = min([r.start for r in desc.extension_range])
 540             if field_options.type != nanopb_pb2.FT_IGNORE:
 541                 self.fields.append(ExtensionRange(self.name, range_start, field_options))
 542
 543         self.packed = message_options.packed_struct
 544         self.ordered_fields = self.fields[:]
 545         self.ordered_fields.sort()
 546
 547     def get_dependencies(self):
 548         '''Get list of type names that this structure refers to.'''
 549         return [str(field.ctype) for field in self.fields]
 550
 551     def __str__(self):
 552         result = 'typedef struct _%s {\n' % self.name
 553
 554         if not self.ordered_fields:
 555             # Empty structs are not allowed in C standard.
 556             # Therefore add a dummy field if an empty message occurs.
 557             result += '    uint8_t dummy_field;'
 558
 559         result += '\n'.join([str(f) for f in self.ordered_fields])
 560         result += '\n}'
 561
 562         if self.packed:
 563             result += ' pb_packed'
 564
 565         result += ' %s;' % self.name
 566
 567         if self.packed:
 568             result = 'PB_PACKED_STRUCT_START\n' + result
 569             result += '\nPB_PACKED_STRUCT_END'
 570
 571         return result
 572
 573     def types(self):
 574         result = ""
 575         for field in self.fields:
 576             types = field.types()
 577             if types is not None:
 578                 result += types + '\n'
 579         return result
 580
 581     def get_initializer(self, null_init):
 582         if not self.ordered_fields:
 583             return '{0}'
 584
 585         parts = []
 586         for field in self.ordered_fields:
 587             if field.allocation == 'STATIC':
 588                 if field.rules == 'REPEATED':
 589                     parts.append('0')
 590                     parts.append('{'
 591                                  + ', '.join([field.get_initializer(null_init)] * field.max_count)
 592                                  + '}')
 593                 elif field.rules == 'OPTIONAL':
 594                     parts.append('false')
 595                     parts.append(field.get_initializer(null_init))
 596                 else:
 597                     parts.append(field.get_initializer(null_init))
 598             elif field.allocation == 'POINTER':
 599                 parts.append('NULL')
 600             elif field.allocation == 'CALLBACK':
 601                 if field.pbtype == 'EXTENSION':
 602                     parts.append('NULL')
 603                 else:
 604                     parts.append('{{NULL}, NULL}')
 605         return '{' + ', '.join(parts) + '}'
 606
 607     def default_decl(self, declaration_only = False):
 608         result = ""
 609         for field in self.fields:
 610             default = field.default_decl(declaration_only)
 611             if default is not None:
 612                 result += default + '\n'
 613         return result
 614
 615     def fields_declaration(self):
 616         result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
 617         return result
 618
 619     def fields_definition(self):
 620         result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
 621
 622         prev = None
 623         for field in self.ordered_fields:
 624             result += field.pb_field_t(prev)
 625             result += ',\n'
 626             prev = field.name
 627
 628         result += '    PB_LAST_FIELD\n};'
 629         return result
 630
 631     def encoded_size(self, allmsgs):
 632         '''Return the maximum size that this message can take when encoded.
 633         If the size cannot be determined, returns None.
 634         '''
 635         size = EncodedSize(0)
 636         for field in self.fields:
 637             fsize = field.encoded_size(allmsgs)
 638             if fsize is None:
 639                 return None
 640             size += fsize
 641
 642         return size
 643
 644
 645 # ---------------------------------------------------------------------------
 646 #                    Processing of entire .proto files
 647 # ---------------------------------------------------------------------------
 648
 649
 650 def iterate_messages(desc, names = Names()):
 651     '''Recursively find all messages. For each, yield name, DescriptorProto.'''
 652     if hasattr(desc, 'message_type'):
 653         submsgs = desc.message_type
 654     else:
 655         submsgs = desc.nested_type
 656
 657     for submsg in submsgs:
 658         sub_names = names + submsg.name
 659         yield sub_names, submsg
 660
 661         for x in iterate_messages(submsg, sub_names):
 662             yield x
 663
 664 def iterate_extensions(desc, names = Names()):
 665     '''Recursively find all extensions.
 666     For each, yield name, FieldDescriptorProto.
 667     '''
 668     for extension in desc.extension:
 669         yield names, extension
 670
 671     for subname, subdesc in iterate_messages(desc, names):
 672         for extension in subdesc.extension:
 673             yield subname, extension
 674
 675 def parse_file(fdesc, file_options):
 676     '''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).'''
 677
 678     enums = []
 679     messages = []
 680     extensions = []
 681
 682     if fdesc.package:
 683         base_name = Names(fdesc.package.split('.'))
 684     else:
 685         base_name = Names()
 686
 687     for enum in fdesc.enum_type:
 688         enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
 689         enums.append(Enum(base_name, enum, enum_options))
 690
 691     for names, message in iterate_messages(fdesc, base_name):
 692         message_options = get_nanopb_suboptions(message, file_options, names)
 693
 694         if message_options.skip_message:
 695             continue
 696
 697         messages.append(Message(names, message, message_options))
 698         for enum in message.enum_type:
 699             enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
 700             enums.append(Enum(names, enum, enum_options))
 701
 702     for names, extension in iterate_extensions(fdesc, base_name):
 703         field_options = get_nanopb_suboptions(extension, file_options, names + extension.name)
 704         if field_options.type != nanopb_pb2.FT_IGNORE:
 705             extensions.append(ExtensionField(names, extension, field_options))
 706
 707     # Fix field default values where enum short names are used.
 708     for enum in enums:
 709         if not enum.options.long_names:
 710             for message in messages:
 711                 for field in message.fields:
 712                     if field.default in enum.value_longnames:
 713                         idx = enum.value_longnames.index(field.default)
 714                         field.default = enum.values[idx][0]
 715
 716     return enums, messages, extensions
 717
 718 def toposort2(data):
 719     '''Topological sort.
 720     From http://code.activestate.com/recipes/577413-topological-sort/
 721     This function is under the MIT license.
 722     '''
 723     for k, v in data.items():
 724         v.discard(k) # Ignore self dependencies
 725     extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
 726     data.update(dict([(item, set()) for item in extra_items_in_deps]))
 727     while True:
 728         ordered = set(item for item,dep in data.items() if not dep)
 729         if not ordered:
 730             break
 731         for item in sorted(ordered):
 732             yield item
 733         data = dict([(item, (dep - ordered)) for item,dep in data.items()
 734                 if item not in ordered])
 735     assert not data, "A cyclic dependency exists amongst %r" % data
 736
 737 def sort_dependencies(messages):
 738     '''Sort a list of Messages based on dependencies.'''
 739     dependencies = {}
 740     message_by_name = {}
 741     for message in messages:
 742         dependencies[str(message.name)] = set(message.get_dependencies())
 743         message_by_name[str(message.name)] = message
 744
 745     for msgname in toposort2(dependencies):
 746         if msgname in message_by_name:
 747             yield message_by_name[msgname]
 748
 749 def make_identifier(headername):
 750     '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
 751     result = ""
 752     for c in headername.upper():
 753         if c.isalnum():
 754             result += c
 755         else:
 756             result += '_'
 757     return result
 758
 759 def generate_header(dependencies, headername, enums, messages, extensions, options):
 760     '''Generate content for a header file.
 761     Generates strings, which should be concatenated and stored to file.
 762     '''
 763
 764     yield '/* Automatically generated nanopb header */\n'
 765     if options.notimestamp:
 766         yield '/* Generated by %s */\n\n' % (nanopb_version)
 767     else:
 768         yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
 769
 770     symbol = make_identifier(headername)
 771     yield '#ifndef PB_%s_INCLUDED\n' % symbol
 772     yield '#define PB_%s_INCLUDED\n' % symbol
 773     try:
 774         yield options.libformat % ('pb.h')
 775     except TypeError:
 776         # no %s specified - use whatever was passed in as options.libformat
 777         yield options.libformat
 778     yield '\n'
 779
 780     for dependency in dependencies:
 781         noext = os.path.splitext(dependency)[0]
 782         yield options.genformat % (noext + options.extension + '.h')
 783         yield '\n'
 784
 785     yield '#ifdef __cplusplus\n'
 786     yield 'extern "C" {\n'
 787     yield '#endif\n\n'
 788
 789     yield '/* Enum definitions */\n'
 790     for enum in enums:
 791         yield str(enum) + '\n\n'
 792
 793     yield '/* Struct definitions */\n'
 794     for msg in sort_dependencies(messages):
 795         yield msg.types()
 796         yield str(msg) + '\n\n'
 797
 798     if extensions:
 799         yield '/* Extensions */\n'
 800         for extension in extensions:
 801             yield extension.extension_decl()
 802         yield '\n'
 803
 804     yield '/* Default values for struct fields */\n'
 805     for msg in messages:
 806         yield msg.default_decl(True)
 807     yield '\n'
 808
 809     yield '/* Initializer values for message structs */\n'
 810     for msg in messages:
 811         identifier = '%s_init_default' % msg.name
 812         yield '#define %-40s %s\n' % (identifier, msg.get_initializer(False))
 813     for msg in messages:
 814         identifier = '%s_init_zero' % msg.name
 815         yield '#define %-40s %s\n' % (identifier, msg.get_initializer(True))
 816     yield '\n'
 817
 818     yield '/* Field tags (for use in manual encoding/decoding) */\n'
 819     for msg in sort_dependencies(messages):
 820         for field in msg.fields:
 821             yield field.tags()
 822     for extension in extensions:
 823         yield extension.tags()
 824     yield '\n'
 825
 826     yield '/* Struct field encoding specification for nanopb */\n'
 827     for msg in messages:
 828         yield msg.fields_declaration() + '\n'
 829     yield '\n'
 830
 831     yield '/* Maximum encoded size of messages (where known) */\n'
 832     for msg in messages:
 833         msize = msg.encoded_size(messages)
 834         if msize is not None:
 835             identifier = '%s_size' % msg.name
 836             yield '#define %-40s %s\n' % (identifier, msize)
 837     yield '\n'
 838
 839     yield '#ifdef __cplusplus\n'
 840     yield '} /* extern "C" */\n'
 841     yield '#endif\n'
 842
 843     # End of header
 844     yield '\n#endif\n'
 845
 846 def generate_source(headername, enums, messages, extensions, options):
 847     '''Generate content for a source file.'''
 848
 849     yield '/* Automatically generated nanopb constant definitions */\n'
 850     if options.notimestamp:
 851         yield '/* Generated by %s */\n\n' % (nanopb_version)
 852     else:
 853         yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
 854     yield options.genformat % (headername)
 855     yield '\n'
 856
 857     for msg in messages:
 858         yield msg.default_decl(False)
 859
 860     yield '\n\n'
 861
 862     for msg in messages:
 863         yield msg.fields_definition() + '\n\n'
 864
 865     for ext in extensions:
 866         yield ext.extension_def() + '\n'
 867
 868     # Add checks for numeric limits
 869     if messages:
 870         count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
 871         largest_msg = max(messages, key = count_required_fields)
 872         largest_count = count_required_fields(largest_msg)
 873         if largest_count > 64:
 874             yield '\n/* Check that missing required fields will be properly detected */\n'
 875             yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
 876             yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
 877             yield '       setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
 878             yield '#endif\n'
 879
 880     worst = 0
 881     worst_field = ''
 882     checks = []
 883     checks_msgnames = []
 884     for msg in messages:
 885         checks_msgnames.append(msg.name)
 886         for field in msg.fields:
 887             status = field.largest_field_value()
 888             if isinstance(status, (str, unicode)):
 889                 checks.append(status)
 890             elif status > worst:
 891                 worst = status
 892                 worst_field = str(field.struct_name) + '.' + str(field.name)
 893
 894     if worst > 255 or checks:
 895         yield '\n/* Check that field information fits in pb_field_t */\n'
 896
 897         if worst > 65535 or checks:
 898             yield '#if !defined(PB_FIELD_32BIT)\n'
 899             if worst > 65535:
 900                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
 901             else:
 902                 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
 903                 msgs = '_'.join(str(n) for n in checks_msgnames)
 904                 yield '/* If you get an error here, it means that you need to define PB_FIELD_32BIT\n'
 905                 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
 906                 yield ' * \n'
 907                 yield ' * The reason you need to do this is that some of your messages contain tag\n'
 908                 yield ' * numbers or field sizes that are larger than what can fit in 8 or 16 bit\n'
 909                 yield ' * field descriptors.\n'
 910                 yield ' */\n'
 911                 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
 912             yield '#endif\n\n'
 913
 914         if worst < 65536:
 915             yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
 916             if worst > 255:
 917                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
 918             else:
 919                 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
 920                 msgs = '_'.join(str(n) for n in checks_msgnames)
 921                 yield '/* If you get an error here, it means that you need to define PB_FIELD_16BIT\n'
 922                 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
 923                 yield ' * \n'
 924                 yield ' * The reason you need to do this is that some of your messages contain tag\n'
 925                 yield ' * numbers or field sizes that are larger than what can fit in the default\n'
 926                 yield ' * 8 bit descriptors.\n'
 927                 yield ' */\n'
 928                 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
 929             yield '#endif\n\n'
 930
 931     # Add check for sizeof(double)
 932     has_double = False
 933     for msg in messages:
 934         for field in msg.fields:
 935             if field.ctype == 'double':
 936                 has_double = True
 937
 938     if has_double:
 939         yield '\n'
 940         yield '/* On some platforms (such as AVR), double is really float.\n'
 941         yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
 942         yield ' * To get rid of this error, remove any double fields from your .proto.\n'
 943         yield ' */\n'
 944         yield 'PB_STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
 945
 946     yield '\n'
 947
 948 # ---------------------------------------------------------------------------
 949 #                    Options parsing for the .proto files
 950 # ---------------------------------------------------------------------------
 951
 952 from fnmatch import fnmatch
 953
 954 def read_options_file(infile):
 955     '''Parse a separate options file to list:
 956         [(namemask, options), ...]
 957     '''
 958     results = []
 959     for line in infile:
 960         line = line.strip()
 961         if not line or line.startswith('//') or line.startswith('#'):
 962             continue
 963
 964         parts = line.split(None, 1)
 965         opts = nanopb_pb2.NanoPBOptions()
 966         text_format.Merge(parts[1], opts)
 967         results.append((parts[0], opts))
 968
 969     return results
 970
 971 class Globals:
 972     '''Ugly global variables, should find a good way to pass these.'''
 973     verbose_options = False
 974     separate_options = []
 975     matched_namemasks = set()
 976
 977 def get_nanopb_suboptions(subdesc, options, name):
 978     '''Get copy of options, and merge information from subdesc.'''
 979     new_options = nanopb_pb2.NanoPBOptions()
 980     new_options.CopyFrom(options)
 981
 982     # Handle options defined in a separate file
 983     dotname = '.'.join(name.parts)
 984     for namemask, options in Globals.separate_options:
 985         if fnmatch(dotname, namemask):
 986             Globals.matched_namemasks.add(namemask)
 987             new_options.MergeFrom(options)
 988
 989     # Handle options defined in .proto
 990     if isinstance(subdesc.options, descriptor.FieldOptions):
 991         ext_type = nanopb_pb2.nanopb
 992     elif isinstance(subdesc.options, descriptor.FileOptions):
 993         ext_type = nanopb_pb2.nanopb_fileopt
 994     elif isinstance(subdesc.options, descriptor.MessageOptions):
 995         ext_type = nanopb_pb2.nanopb_msgopt
 996     elif isinstance(subdesc.options, descriptor.EnumOptions):
 997         ext_type = nanopb_pb2.nanopb_enumopt
 998     else:
 999         raise Exception("Unknown options type")
1000
1001     if subdesc.options.HasExtension(ext_type):
1002         ext = subdesc.options.Extensions[ext_type]
1003         new_options.MergeFrom(ext)
1004
1005     if Globals.verbose_options:
1006         sys.stderr.write("Options for " + dotname + ": ")
1007         sys.stderr.write(text_format.MessageToString(new_options) + "\n")
1008
1009     return new_options
1010
1011
1012 # ---------------------------------------------------------------------------
1013 #                         Command line interface
1014 # ---------------------------------------------------------------------------
1015
1016 import sys
1017 import os.path
1018 from optparse import OptionParser
1019
1020 optparser = OptionParser(
1021     usage = "Usage: nanopb_generator.py [options] file.pb ...",
1022     epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
1023              "Output will be written to file.pb.h and file.pb.c.")
1024 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
1025     help="Exclude file from generated #include list.")
1026 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default=".pb",
1027     help="Set extension to use instead of '.pb' for generated files. [default: %default]")
1028 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
1029     help="Set name of a separate generator options file.")
1030 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
1031     metavar="FORMAT", default='#include "%s"\n',
1032     help="Set format string to use for including other .pb.h files. [default: %default]")
1033 optparser.add_option("-L", "--library-include-format", dest="libformat",
1034     metavar="FORMAT", default='#include <%s>\n',
1035     help="Set format string to use for including the nanopb pb.h header. [default: %default]")
1036 optparser.add_option("-T", "--no-timestamp", dest="notimestamp", action="store_true", default=False,
1037     help="Don't add timestamp to .pb.h and .pb.c preambles")
1038 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
1039     help="Don't print anything except errors.")
1040 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
1041     help="Print more information.")
1042 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
1043     help="Set generator option (max_size, max_count etc.).")
1044
1045 def process_file(filename, fdesc, options):
1046     '''Process a single file.
1047     filename: The full path to the .proto or .pb source file, as string.
1048     fdesc: The loaded FileDescriptorSet, or None to read from the input file.
1049     options: Command line options as they come from OptionsParser.
1050
1051     Returns a dict:
1052         {'headername': Name of header file,
1053          'headerdata': Data for the .h header file,
1054          'sourcename': Name of the source code file,
1055          'sourcedata': Data for the .c source code file
1056         }
1057     '''
1058     toplevel_options = nanopb_pb2.NanoPBOptions()
1059     for s in options.settings:
1060         text_format.Merge(s, toplevel_options)
1061
1062     if not fdesc:
1063         data = open(filename, 'rb').read()
1064         fdesc = descriptor.FileDescriptorSet.FromString(data).file[0]
1065
1066     # Check if there is a separate .options file
1067     had_abspath = False
1068     try:
1069         optfilename = options.options_file % os.path.splitext(filename)[0]
1070     except TypeError:
1071         # No %s specified, use the filename as-is
1072         optfilename = options.options_file
1073         had_abspath = True
1074
1075     if os.path.isfile(optfilename):
1076         if options.verbose:
1077             sys.stderr.write('Reading options from ' + optfilename + '\n')
1078
1079         Globals.separate_options = read_options_file(open(optfilename, "rU"))
1080     else:
1081         # If we are given a full filename and it does not exist, give an error.
1082         # However, don't give error when we automatically look for .options file
1083         # with the same name as .proto.
1084         if options.verbose or had_abspath:
1085             sys.stderr.write('Options file not found: ' + optfilename)
1086
1087         Globals.separate_options = []
1088
1089     Globals.matched_namemasks = set()
1090
1091     # Parse the file
1092     file_options = get_nanopb_suboptions(fdesc, toplevel_options, Names([filename]))
1093     enums, messages, extensions = parse_file(fdesc, file_options)
1094
1095     # Decide the file names
1096     noext = os.path.splitext(filename)[0]
1097     headername = noext + options.extension + '.h'
1098     sourcename = noext + options.extension + '.c'
1099     headerbasename = os.path.basename(headername)
1100
1101     # List of .proto files that should not be included in the C header file
1102     # even if they are mentioned in the source .proto.
1103     excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
1104     dependencies = [d for d in fdesc.dependency if d not in excludes]
1105
1106     headerdata = ''.join(generate_header(dependencies, headerbasename, enums,
1107                                          messages, extensions, options))
1108
1109     sourcedata = ''.join(generate_source(headerbasename, enums,
1110                                          messages, extensions, options))
1111
1112     # Check if there were any lines in .options that did not match a member
1113     unmatched = [n for n,o in Globals.separate_options if n not in Globals.matched_namemasks]
1114     if unmatched and not options.quiet:
1115         sys.stderr.write("Following patterns in " + optfilename + " did not match any fields: "
1116                          + ', '.join(unmatched) + "\n")
1117         if not Globals.verbose_options:
1118             sys.stderr.write("Use  protoc --nanopb-out=-v:.   to see a list of the field names.\n")
1119
1120     return {'headername': headername, 'headerdata': headerdata,
1121             'sourcename': sourcename, 'sourcedata': sourcedata}
1122
1123 def main_cli():
1124     '''Main function when invoked directly from the command line.'''
1125
1126     options, filenames = optparser.parse_args()
1127
1128     if not filenames:
1129         optparser.print_help()
1130         sys.exit(1)
1131
1132     if options.quiet:
1133         options.verbose = False
1134
1135     Globals.verbose_options = options.verbose
1136
1137     for filename in filenames:
1138         results = process_file(filename, None, options)
1139
1140         if not options.quiet:
1141             sys.stderr.write("Writing to " + results['headername'] + " and "
1142                              + results['sourcename'] + "\n")
1143
1144         open(results['headername'], 'w').write(results['headerdata'])
1145         open(results['sourcename'], 'w').write(results['sourcedata'])
1146
1147 def main_plugin():
1148     '''Main function when invoked as a protoc plugin.'''
1149
1150     import sys
1151     if sys.platform == "win32":
1152         import os, msvcrt
1153         # Set stdin and stdout to binary mode
1154         msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
1155         msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
1156
1157     data = sys.stdin.read()
1158     request = plugin_pb2.CodeGeneratorRequest.FromString(data)
1159
1160     import shlex
1161     args = shlex.split(request.parameter)
1162     options, dummy = optparser.parse_args(args)
1163
1164     Globals.verbose_options = options.verbose
1165
1166     response = plugin_pb2.CodeGeneratorResponse()
1167
1168     for filename in request.file_to_generate:
1169         for fdesc in request.proto_file:
1170             if fdesc.name == filename:
1171                 results = process_file(filename, fdesc, options)
1172
1173                 f = response.file.add()
1174                 f.name = results['headername']
1175                 f.content = results['headerdata']
1176
1177                 f = response.file.add()
1178                 f.name = results['sourcename']
1179                 f.content = results['sourcedata']
1180
1181     sys.stdout.write(response.SerializeToString())
1182
1183 if __name__ == '__main__':
1184     # Check if we are running as a plugin under protoc
1185     if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv:
1186         main_plugin()
1187     else:
1188         main_cli()
1189