generator/nanopb_generator.py

   1 #!/usr/bin/env python
   2
   3 from __future__ import unicode_literals
   4
   5 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
   6 nanopb_version = "nanopb-0.3.7-dev"
   7
   8 import sys
   9 import re
  10 from functools import reduce
  11
  12 try:
  13     # Add some dummy imports to keep packaging tools happy.
  14     import google, distutils.util # bbfreeze seems to need these
  15     import pkg_resources # pyinstaller / protobuf 2.5 seem to need these
  16 except:
  17     # Don't care, we will error out later if it is actually important.
  18     pass
  19
  20 try:
  21     import google.protobuf.text_format as text_format
  22     import google.protobuf.descriptor_pb2 as descriptor
  23 except:
  24     sys.stderr.write('''
  25          *************************************************************
  26          *** Could not import the Google protobuf Python libraries ***
  27          *** Try installing package 'python-protobuf' or similar.  ***
  28          *************************************************************
  29     ''' + '\n')
  30     raise
  31
  32 try:
  33     import proto.nanopb_pb2 as nanopb_pb2
  34     import proto.plugin_pb2 as plugin_pb2
  35 except:
  36     sys.stderr.write('''
  37          ********************************************************************
  38          *** Failed to import the protocol definitions for generator.     ***
  39          *** You have to run 'make' in the nanopb/generator/proto folder. ***
  40          ********************************************************************
  41     ''' + '\n')
  42     raise
  43
  44 # ---------------------------------------------------------------------------
  45 #                     Generation of single fields
  46 # ---------------------------------------------------------------------------
  47
  48 import time
  49 import os.path
  50
  51 # Values are tuple (c type, pb type, encoded size, int_size_allowed)
  52 FieldD = descriptor.FieldDescriptorProto
  53 datatypes = {
  54     FieldD.TYPE_BOOL:       ('bool',     'BOOL',        1,  False),
  55     FieldD.TYPE_DOUBLE:     ('double',   'DOUBLE',      8,  False),
  56     FieldD.TYPE_FIXED32:    ('uint32_t', 'FIXED32',     4,  False),
  57     FieldD.TYPE_FIXED64:    ('uint64_t', 'FIXED64',     8,  False),
  58     FieldD.TYPE_FLOAT:      ('float',    'FLOAT',       4,  False),
  59     FieldD.TYPE_INT32:      ('int32_t',  'INT32',      10,  True),
  60     FieldD.TYPE_INT64:      ('int64_t',  'INT64',      10,  True),
  61     FieldD.TYPE_SFIXED32:   ('int32_t',  'SFIXED32',    4,  False),
  62     FieldD.TYPE_SFIXED64:   ('int64_t',  'SFIXED64',    8,  False),
  63     FieldD.TYPE_SINT32:     ('int32_t',  'SINT32',      5,  True),
  64     FieldD.TYPE_SINT64:     ('int64_t',  'SINT64',     10,  True),
  65     FieldD.TYPE_UINT32:     ('uint32_t', 'UINT32',      5,  True),
  66     FieldD.TYPE_UINT64:     ('uint64_t', 'UINT64',     10,  True)
  67 }
  68
  69 # Integer size overrides (from .proto settings)
  70 intsizes = {
  71     nanopb_pb2.IS_8:     'int8_t',
  72     nanopb_pb2.IS_16:    'int16_t',
  73     nanopb_pb2.IS_32:    'int32_t',
  74     nanopb_pb2.IS_64:    'int64_t',
  75 }
  76
  77 # String types (for python 2 / python 3 compatibility)
  78 try:
  79     strtypes = (unicode, str)
  80 except NameError:
  81     strtypes = (str, )
  82
  83 class Names:
  84     '''Keeps a set of nested names and formats them to C identifier.'''
  85     def __init__(self, parts = ()):
  86         if isinstance(parts, Names):
  87             parts = parts.parts
  88         self.parts = tuple(parts)
  89
  90     def __str__(self):
  91         return '_'.join(self.parts)
  92
  93     def __add__(self, other):
  94         if isinstance(other, strtypes):
  95             return Names(self.parts + (other,))
  96         elif isinstance(other, tuple):
  97             return Names(self.parts + other)
  98         else:
  99             raise ValueError("Name parts should be of type str")
 100
 101     def __eq__(self, other):
 102         return isinstance(other, Names) and self.parts == other.parts
 103
 104 def names_from_type_name(type_name):
 105     '''Parse Names() from FieldDescriptorProto type_name'''
 106     if type_name[0] != '.':
 107         raise NotImplementedError("Lookup of non-absolute type names is not supported")
 108     return Names(type_name[1:].split('.'))
 109
 110 def varint_max_size(max_value):
 111     '''Returns the maximum number of bytes a varint can take when encoded.'''
 112     if max_value < 0:
 113         max_value = 2**64 - max_value
 114     for i in range(1, 11):
 115         if (max_value >> (i * 7)) == 0:
 116             return i
 117     raise ValueError("Value too large for varint: " + str(max_value))
 118
 119 assert varint_max_size(-1) == 10
 120 assert varint_max_size(0) == 1
 121 assert varint_max_size(127) == 1
 122 assert varint_max_size(128) == 2
 123
 124 class EncodedSize:
 125     '''Class used to represent the encoded size of a field or a message.
 126     Consists of a combination of symbolic sizes and integer sizes.'''
 127     def __init__(self, value = 0, symbols = []):
 128         if isinstance(value, EncodedSize):
 129             self.value = value.value
 130             self.symbols = value.symbols
 131         elif isinstance(value, strtypes + (Names,)):
 132             self.symbols = [str(value)]
 133             self.value = 0
 134         else:
 135             self.value = value
 136             self.symbols = symbols
 137
 138     def __add__(self, other):
 139         if isinstance(other, int):
 140             return EncodedSize(self.value + other, self.symbols)
 141         elif isinstance(other, strtypes + (Names,)):
 142             return EncodedSize(self.value, self.symbols + [str(other)])
 143         elif isinstance(other, EncodedSize):
 144             return EncodedSize(self.value + other.value, self.symbols + other.symbols)
 145         else:
 146             raise ValueError("Cannot add size: " + repr(other))
 147
 148     def __mul__(self, other):
 149         if isinstance(other, int):
 150             return EncodedSize(self.value * other, [str(other) + '*' + s for s in self.symbols])
 151         else:
 152             raise ValueError("Cannot multiply size: " + repr(other))
 153
 154     def __str__(self):
 155         if not self.symbols:
 156             return str(self.value)
 157         else:
 158             return '(' + str(self.value) + ' + ' + ' + '.join(self.symbols) + ')'
 159
 160     def upperlimit(self):
 161         if not self.symbols:
 162             return self.value
 163         else:
 164             return 2**32 - 1
 165
 166 class Enum:
 167     def __init__(self, names, desc, enum_options):
 168         '''desc is EnumDescriptorProto'''
 169
 170         self.options = enum_options
 171         self.names = names + desc.name
 172
 173         if enum_options.long_names:
 174             self.values = [(self.names + x.name, x.number) for x in desc.value]
 175         else:
 176             self.values = [(names + x.name, x.number) for x in desc.value]
 177
 178         self.value_longnames = [self.names + x.name for x in desc.value]
 179         self.packed = enum_options.packed_enum
 180
 181     def has_negative(self):
 182         for n, v in self.values:
 183             if v < 0:
 184                 return True
 185         return False
 186
 187     def encoded_size(self):
 188         return max([varint_max_size(v) for n,v in self.values])
 189
 190     def __str__(self):
 191         result = 'typedef enum _%s {\n' % self.names
 192         result += ',\n'.join(["    %s = %d" % x for x in self.values])
 193         result += '\n}'
 194
 195         if self.packed:
 196             result += ' pb_packed'
 197
 198         result += ' %s;' % self.names
 199
 200         result += '\n#define _%s_MIN %s' % (self.names, self.values[0][0])
 201         result += '\n#define _%s_MAX %s' % (self.names, self.values[-1][0])
 202         result += '\n#define _%s_ARRAYSIZE ((%s)(%s+1))' % (self.names, self.names, self.values[-1][0])
 203
 204         if not self.options.long_names:
 205             # Define the long names always so that enum value references
 206             # from other files work properly.
 207             for i, x in enumerate(self.values):
 208                 result += '\n#define %s %s' % (self.value_longnames[i], x[0])
 209
 210         return result
 211
 212 class FieldMaxSize:
 213     def __init__(self, worst = 0, checks = [], field_name = 'undefined'):
 214         if isinstance(worst, list):
 215             self.worst = max(i for i in worst if i is not None)
 216         else:
 217             self.worst = worst
 218
 219         self.worst_field = field_name
 220         self.checks = list(checks)
 221
 222     def extend(self, extend, field_name = None):
 223         self.worst = max(self.worst, extend.worst)
 224
 225         if self.worst == extend.worst:
 226             self.worst_field = extend.worst_field
 227
 228         self.checks.extend(extend.checks)
 229
 230 class Field:
 231     def __init__(self, struct_name, desc, field_options):
 232         '''desc is FieldDescriptorProto'''
 233         self.tag = desc.number
 234         self.struct_name = struct_name
 235         self.union_name = None
 236         self.name = desc.name
 237         self.default = None
 238         self.max_size = None
 239         self.max_count = None
 240         self.array_decl = ""
 241         self.enc_size = None
 242         self.ctype = None
 243
 244         self.inline = None
 245         if field_options.type == nanopb_pb2.FT_INLINE:
 246             field_options.type = nanopb_pb2.FT_STATIC
 247             self.inline = nanopb_pb2.FT_INLINE
 248
 249         # Parse field options
 250         if field_options.HasField("max_size"):
 251             self.max_size = field_options.max_size
 252
 253         if field_options.HasField("max_count"):
 254             self.max_count = field_options.max_count
 255
 256         if desc.HasField('default_value'):
 257             self.default = desc.default_value
 258
 259         # Check field rules, i.e. required/optional/repeated.
 260         can_be_static = True
 261         if desc.label == FieldD.LABEL_REPEATED:
 262             self.rules = 'REPEATED'
 263             if self.max_count is None:
 264                 can_be_static = False
 265             else:
 266                 self.array_decl = '[%d]' % self.max_count
 267         elif field_options.HasField("proto3"):
 268             self.rules = 'SINGULAR'
 269         elif desc.label == FieldD.LABEL_REQUIRED:
 270             self.rules = 'REQUIRED'
 271         elif desc.label == FieldD.LABEL_OPTIONAL:
 272             self.rules = 'OPTIONAL'
 273         else:
 274             raise NotImplementedError(desc.label)
 275
 276         # Check if the field can be implemented with static allocation
 277         # i.e. whether the data size is known.
 278         if desc.type == FieldD.TYPE_STRING and self.max_size is None:
 279             can_be_static = False
 280
 281         if desc.type == FieldD.TYPE_BYTES and self.max_size is None:
 282             can_be_static = False
 283
 284         # Decide how the field data will be allocated
 285         if field_options.type == nanopb_pb2.FT_DEFAULT:
 286             if can_be_static:
 287                 field_options.type = nanopb_pb2.FT_STATIC
 288             else:
 289                 field_options.type = nanopb_pb2.FT_CALLBACK
 290
 291         if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
 292             raise Exception("Field %s is defined as static, but max_size or "
 293                             "max_count is not given." % self.name)
 294
 295         if field_options.type == nanopb_pb2.FT_STATIC:
 296             self.allocation = 'STATIC'
 297         elif field_options.type == nanopb_pb2.FT_POINTER:
 298             self.allocation = 'POINTER'
 299         elif field_options.type == nanopb_pb2.FT_CALLBACK:
 300             self.allocation = 'CALLBACK'
 301         else:
 302             raise NotImplementedError(field_options.type)
 303
 304         # Decide the C data type to use in the struct.
 305         if desc.type in datatypes:
 306             self.ctype, self.pbtype, self.enc_size, isa = datatypes[desc.type]
 307
 308             # Override the field size if user wants to use smaller integers
 309             if isa and field_options.int_size != nanopb_pb2.IS_DEFAULT:
 310                 self.ctype = intsizes[field_options.int_size]
 311                 if desc.type == FieldD.TYPE_UINT32 or desc.type == FieldD.TYPE_UINT64:
 312                     self.ctype = 'u' + self.ctype;
 313         elif desc.type == FieldD.TYPE_ENUM:
 314             self.pbtype = 'ENUM'
 315             self.ctype = names_from_type_name(desc.type_name)
 316             if self.default is not None:
 317                 self.default = self.ctype + self.default
 318             self.enc_size = None # Needs to be filled in when enum values are known
 319         elif desc.type == FieldD.TYPE_STRING:
 320             self.pbtype = 'STRING'
 321             self.ctype = 'char'
 322             if self.allocation == 'STATIC':
 323                 self.ctype = 'char'
 324                 self.array_decl += '[%d]' % self.max_size
 325                 self.enc_size = varint_max_size(self.max_size) + self.max_size
 326         elif desc.type == FieldD.TYPE_BYTES:
 327             self.pbtype = 'BYTES'
 328             if self.allocation == 'STATIC':
 329                 # Inline STATIC for BYTES is like STATIC for STRING.
 330                 if self.inline:
 331                     self.ctype = 'pb_byte_t'
 332                     self.array_decl += '[%d]' % self.max_size
 333                 else:
 334                     self.ctype = self.struct_name + self.name + 't'
 335                 self.enc_size = varint_max_size(self.max_size) + self.max_size
 336             elif self.allocation == 'POINTER':
 337                 self.ctype = 'pb_bytes_array_t'
 338         elif desc.type == FieldD.TYPE_MESSAGE:
 339             self.pbtype = 'MESSAGE'
 340             self.ctype = self.submsgname = names_from_type_name(desc.type_name)
 341             self.enc_size = None # Needs to be filled in after the message type is available
 342         else:
 343             raise NotImplementedError(desc.type)
 344
 345     def __lt__(self, other):
 346         return self.tag < other.tag
 347
 348     def __str__(self):
 349         result = ''
 350         if self.allocation == 'POINTER':
 351             if self.rules == 'REPEATED':
 352                 result += '    pb_size_t ' + self.name + '_count;\n'
 353
 354             if self.pbtype == 'MESSAGE':
 355                 # Use struct definition, so recursive submessages are possible
 356                 result += '    struct _%s *%s;' % (self.ctype, self.name)
 357             elif self.rules == 'REPEATED' and self.pbtype in ['STRING', 'BYTES']:
 358                 # String/bytes arrays need to be defined as pointers to pointers
 359                 result += '    %s **%s;' % (self.ctype, self.name)
 360             else:
 361                 result += '    %s *%s;' % (self.ctype, self.name)
 362         elif self.allocation == 'CALLBACK':
 363             result += '    pb_callback_t %s;' % self.name
 364         else:
 365             if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
 366                 result += '    bool has_' + self.name + ';\n'
 367             elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
 368                 result += '    pb_size_t ' + self.name + '_count;\n'
 369             result += '    %s %s%s;' % (self.ctype, self.name, self.array_decl)
 370         return result
 371
 372     def types(self):
 373         '''Return definitions for any special types this field might need.'''
 374         if self.pbtype == 'BYTES' and self.allocation == 'STATIC' and not self.inline:
 375             result = 'typedef PB_BYTES_ARRAY_T(%d) %s;\n' % (self.max_size, self.ctype)
 376         else:
 377             result = ''
 378         return result
 379
 380     def get_dependencies(self):
 381         '''Get list of type names used by this field.'''
 382         if self.allocation == 'STATIC':
 383             return [str(self.ctype)]
 384         else:
 385             return []
 386
 387     def get_initializer(self, null_init, inner_init_only = False):
 388         '''Return literal expression for this field's default value.
 389         null_init: If True, initialize to a 0 value instead of default from .proto
 390         inner_init_only: If True, exclude initialization for any count/has fields
 391         '''
 392
 393         inner_init = None
 394         if self.pbtype == 'MESSAGE':
 395             if null_init:
 396                 inner_init = '%s_init_zero' % self.ctype
 397             else:
 398                 inner_init = '%s_init_default' % self.ctype
 399         elif self.default is None or null_init:
 400             if self.pbtype == 'STRING':
 401                 inner_init = '""'
 402             elif self.pbtype == 'BYTES':
 403                 if self.inline:
 404                     inner_init = '{0}'
 405                 else:
 406                     inner_init = '{0, {0}}'
 407             elif self.pbtype in ('ENUM', 'UENUM'):
 408                 inner_init = '(%s)0' % self.ctype
 409             else:
 410                 inner_init = '0'
 411         else:
 412             if self.pbtype == 'STRING':
 413                 inner_init = self.default.replace('"', '\\"')
 414                 inner_init = '"' + inner_init + '"'
 415             elif self.pbtype == 'BYTES':
 416                 data = ['0x%02x' % ord(c) for c in self.default]
 417                 if len(data) == 0:
 418                     if self.inline:
 419                         inner_init = '{0}'
 420                     else:
 421                         inner_init = '{0, {0}}'
 422                 else:
 423                     if self.inline:
 424                         inner_init = '{%s}' % ','.join(data)
 425                     else:
 426                         inner_init = '{%d, {%s}}' % (len(data), ','.join(data))
 427             elif self.pbtype in ['FIXED32', 'UINT32']:
 428                 inner_init = str(self.default) + 'u'
 429             elif self.pbtype in ['FIXED64', 'UINT64']:
 430                 inner_init = str(self.default) + 'ull'
 431             elif self.pbtype in ['SFIXED64', 'INT64']:
 432                 inner_init = str(self.default) + 'll'
 433             else:
 434                 inner_init = str(self.default)
 435
 436         if inner_init_only:
 437             return inner_init
 438
 439         outer_init = None
 440         if self.allocation == 'STATIC':
 441             if self.rules == 'REPEATED':
 442                 outer_init = '0, {'
 443                 outer_init += ', '.join([inner_init] * self.max_count)
 444                 outer_init += '}'
 445             elif self.rules == 'OPTIONAL':
 446                 outer_init = 'false, ' + inner_init
 447             else:
 448                 outer_init = inner_init
 449         elif self.allocation == 'POINTER':
 450             if self.rules == 'REPEATED':
 451                 outer_init = '0, NULL'
 452             else:
 453                 outer_init = 'NULL'
 454         elif self.allocation == 'CALLBACK':
 455             if self.pbtype == 'EXTENSION':
 456                 outer_init = 'NULL'
 457             else:
 458                 outer_init = '{{NULL}, NULL}'
 459
 460         return outer_init
 461
 462     def default_decl(self, declaration_only = False):
 463         '''Return definition for this field's default value.'''
 464         if self.default is None:
 465             return None
 466
 467         ctype = self.ctype
 468         default = self.get_initializer(False, True)
 469         array_decl = ''
 470
 471         if self.pbtype == 'STRING':
 472             if self.allocation != 'STATIC':
 473                 return None # Not implemented
 474             array_decl = '[%d]' % self.max_size
 475         elif self.pbtype == 'BYTES':
 476             if self.allocation != 'STATIC':
 477                 return None # Not implemented
 478             if self.inline:
 479                 array_decl = '[%d]' % self.max_size
 480
 481         if declaration_only:
 482             return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
 483         else:
 484             return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
 485
 486     def tags(self):
 487         '''Return the #define for the tag number of this field.'''
 488         identifier = '%s_%s_tag' % (self.struct_name, self.name)
 489         return '#define %-40s %d\n' % (identifier, self.tag)
 490
 491     def pb_field_t(self, prev_field_name):
 492         '''Return the pb_field_t initializer to use in the constant array.
 493         prev_field_name is the name of the previous field or None.
 494         '''
 495
 496         if self.rules == 'ONEOF':
 497             if self.anonymous:
 498                 result = '    PB_ANONYMOUS_ONEOF_FIELD(%s, ' % self.union_name
 499             else:
 500                 result = '    PB_ONEOF_FIELD(%s, ' % self.union_name
 501         else:
 502             result = '    PB_FIELD('
 503
 504         result += '%3d, ' % self.tag
 505         result += '%-8s, ' % self.pbtype
 506         result += '%s, ' % self.rules
 507         result += '%-8s, ' % (self.allocation if not self.inline else "INLINE")
 508         result += '%s, ' % ("FIRST" if not prev_field_name else "OTHER")
 509         result += '%s, ' % self.struct_name
 510         result += '%s, ' % self.name
 511         result += '%s, ' % (prev_field_name or self.name)
 512
 513         if self.pbtype == 'MESSAGE':
 514             result += '&%s_fields)' % self.submsgname
 515         elif self.default is None:
 516             result += '0)'
 517         elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
 518             result += '0)' # Arbitrary size default values not implemented
 519         elif self.rules == 'OPTEXT':
 520             result += '0)' # Default value for extensions is not implemented
 521         else:
 522             result += '&%s_default)' % (self.struct_name + self.name)
 523
 524         return result
 525
 526     def get_last_field_name(self):
 527         return self.name
 528
 529     def largest_field_value(self):
 530         '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
 531         Returns numeric value or a C-expression for assert.'''
 532         check = []
 533         if self.pbtype == 'MESSAGE':
 534             if self.rules == 'REPEATED' and self.allocation == 'STATIC':
 535                 check.append('pb_membersize(%s, %s[0])' % (self.struct_name, self.name))
 536             elif self.rules == 'ONEOF':
 537                 if self.anonymous:
 538                     check.append('pb_membersize(%s, %s)' % (self.struct_name, self.name))
 539                 else:
 540                     check.append('pb_membersize(%s, %s.%s)' % (self.struct_name, self.union_name, self.name))
 541             else:
 542                 check.append('pb_membersize(%s, %s)' % (self.struct_name, self.name))
 543
 544         return FieldMaxSize([self.tag, self.max_size, self.max_count],
 545                             check,
 546                             ('%s.%s' % (self.struct_name, self.name)))
 547
 548     def encoded_size(self, dependencies):
 549         '''Return the maximum size that this field can take when encoded,
 550         including the field tag. If the size cannot be determined, returns
 551         None.'''
 552
 553         if self.allocation != 'STATIC':
 554             return None
 555
 556         if self.pbtype == 'MESSAGE':
 557             encsize = None
 558             if str(self.submsgname) in dependencies:
 559                 submsg = dependencies[str(self.submsgname)]
 560                 encsize = submsg.encoded_size(dependencies)
 561                 if encsize is not None:
 562                     # Include submessage length prefix
 563                     encsize += varint_max_size(encsize.upperlimit())
 564
 565             if encsize is None:
 566                 # Submessage or its size cannot be found.
 567                 # This can occur if submessage is defined in different
 568                 # file, and it or its .options could not be found.
 569                 # Instead of direct numeric value, reference the size that
 570                 # has been #defined in the other file.
 571                 encsize = EncodedSize(self.submsgname + 'size')
 572
 573                 # We will have to make a conservative assumption on the length
 574                 # prefix size, though.
 575                 encsize += 5
 576
 577         elif self.pbtype in ['ENUM', 'UENUM']:
 578             if str(self.ctype) in dependencies:
 579                 enumtype = dependencies[str(self.ctype)]
 580                 encsize = enumtype.encoded_size()
 581             else:
 582                 # Conservative assumption
 583                 encsize = 10
 584
 585         elif self.enc_size is None:
 586             raise RuntimeError("Could not determine encoded size for %s.%s"
 587                                % (self.struct_name, self.name))
 588         else:
 589             encsize = EncodedSize(self.enc_size)
 590
 591         encsize += varint_max_size(self.tag << 3) # Tag + wire type
 592
 593         if self.rules == 'REPEATED':
 594             # Decoders must be always able to handle unpacked arrays.
 595             # Therefore we have to reserve space for it, even though
 596             # we emit packed arrays ourselves.
 597             encsize *= self.max_count
 598
 599         return encsize
 600
 601
 602 class ExtensionRange(Field):
 603     def __init__(self, struct_name, range_start, field_options):
 604         '''Implements a special pb_extension_t* field in an extensible message
 605         structure. The range_start signifies the index at which the extensions
 606         start. Not necessarily all tags above this are extensions, it is merely
 607         a speed optimization.
 608         '''
 609         self.tag = range_start
 610         self.struct_name = struct_name
 611         self.name = 'extensions'
 612         self.pbtype = 'EXTENSION'
 613         self.rules = 'OPTIONAL'
 614         self.allocation = 'CALLBACK'
 615         self.ctype = 'pb_extension_t'
 616         self.array_decl = ''
 617         self.default = None
 618         self.max_size = 0
 619         self.max_count = 0
 620         self.inline = None
 621
 622     def __str__(self):
 623         return '    pb_extension_t *extensions;'
 624
 625     def types(self):
 626         return ''
 627
 628     def tags(self):
 629         return ''
 630
 631     def encoded_size(self, dependencies):
 632         # We exclude extensions from the count, because they cannot be known
 633         # until runtime. Other option would be to return None here, but this
 634         # way the value remains useful if extensions are not used.
 635         return EncodedSize(0)
 636
 637 class ExtensionField(Field):
 638     def __init__(self, struct_name, desc, field_options):
 639         self.fullname = struct_name + desc.name
 640         self.extendee_name = names_from_type_name(desc.extendee)
 641         Field.__init__(self, self.fullname + 'struct', desc, field_options)
 642
 643         if self.rules != 'OPTIONAL':
 644             self.skip = True
 645         else:
 646             self.skip = False
 647             self.rules = 'OPTEXT'
 648
 649     def tags(self):
 650         '''Return the #define for the tag number of this field.'''
 651         identifier = '%s_tag' % self.fullname
 652         return '#define %-40s %d\n' % (identifier, self.tag)
 653
 654     def extension_decl(self):
 655         '''Declaration of the extension type in the .pb.h file'''
 656         if self.skip:
 657             msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname
 658             msg +='   type of extension fields is currently supported. */\n'
 659             return msg
 660
 661         return ('extern const pb_extension_type_t %s; /* field type: %s */\n' %
 662             (self.fullname, str(self).strip()))
 663
 664     def extension_def(self):
 665         '''Definition of the extension type in the .pb.c file'''
 666
 667         if self.skip:
 668             return ''
 669
 670         result  = 'typedef struct {\n'
 671         result += str(self)
 672         result += '\n} %s;\n\n' % self.struct_name
 673         result += ('static const pb_field_t %s_field = \n  %s;\n\n' %
 674                     (self.fullname, self.pb_field_t(None)))
 675         result += 'const pb_extension_type_t %s = {\n' % self.fullname
 676         result += '    NULL,\n'
 677         result += '    NULL,\n'
 678         result += '    &%s_field\n' % self.fullname
 679         result += '};\n'
 680         return result
 681
 682
 683 # ---------------------------------------------------------------------------
 684 #                   Generation of oneofs (unions)
 685 # ---------------------------------------------------------------------------
 686
 687 class OneOf(Field):
 688     def __init__(self, struct_name, oneof_desc):
 689         self.struct_name = struct_name
 690         self.name = oneof_desc.name
 691         self.ctype = 'union'
 692         self.pbtype = 'oneof'
 693         self.fields = []
 694         self.allocation = 'ONEOF'
 695         self.default = None
 696         self.rules = 'ONEOF'
 697         self.anonymous = False
 698         self.inline = None
 699
 700     def add_field(self, field):
 701         if field.allocation == 'CALLBACK':
 702             raise Exception("Callback fields inside of oneof are not supported"
 703                             + " (field %s)" % field.name)
 704
 705         field.union_name = self.name
 706         field.rules = 'ONEOF'
 707         field.anonymous = self.anonymous
 708         self.fields.append(field)
 709         self.fields.sort(key = lambda f: f.tag)
 710
 711         # Sort by the lowest tag number inside union
 712         self.tag = min([f.tag for f in self.fields])
 713
 714     def __str__(self):
 715         result = ''
 716         if self.fields:
 717             result += '    pb_size_t which_' + self.name + ";\n"
 718             result += '    union {\n'
 719             for f in self.fields:
 720                 result += '    ' + str(f).replace('\n', '\n    ') + '\n'
 721             if self.anonymous:
 722                 result += '    };'
 723             else:
 724                 result += '    } ' + self.name + ';'
 725         return result
 726
 727     def types(self):
 728         return ''.join([f.types() for f in self.fields])
 729
 730     def get_dependencies(self):
 731         deps = []
 732         for f in self.fields:
 733             deps += f.get_dependencies()
 734         return deps
 735
 736     def get_initializer(self, null_init):
 737         return '0, {' + self.fields[0].get_initializer(null_init) + '}'
 738
 739     def default_decl(self, declaration_only = False):
 740         return None
 741
 742     def tags(self):
 743         return ''.join([f.tags() for f in self.fields])
 744
 745     def pb_field_t(self, prev_field_name):
 746         result = ',\n'.join([f.pb_field_t(prev_field_name) for f in self.fields])
 747         return result
 748
 749     def get_last_field_name(self):
 750         if self.anonymous:
 751             return self.fields[-1].name
 752         else:
 753             return self.name + '.' + self.fields[-1].name
 754
 755     def largest_field_value(self):
 756         largest = FieldMaxSize()
 757         for f in self.fields:
 758             largest.extend(f.largest_field_value())
 759         return largest
 760
 761     def encoded_size(self, dependencies):
 762         '''Returns the size of the largest oneof field.'''
 763         largest = EncodedSize(0)
 764         for f in self.fields:
 765             size = EncodedSize(f.encoded_size(dependencies))
 766             if size.value is None:
 767                 return None
 768             elif size.symbols:
 769                 return None # Cannot resolve maximum of symbols
 770             elif size.value > largest.value:
 771                 largest = size
 772
 773         return largest
 774
 775 # ---------------------------------------------------------------------------
 776 #                   Generation of messages (structures)
 777 # ---------------------------------------------------------------------------
 778
 779
 780 class Message:
 781     def __init__(self, names, desc, message_options):
 782         self.name = names
 783         self.fields = []
 784         self.oneofs = {}
 785         no_unions = []
 786
 787         if message_options.msgid:
 788             self.msgid = message_options.msgid
 789
 790         if hasattr(desc, 'oneof_decl'):
 791             for i, f in enumerate(desc.oneof_decl):
 792                 oneof_options = get_nanopb_suboptions(desc, message_options, self.name + f.name)
 793                 if oneof_options.no_unions:
 794                     no_unions.append(i) # No union, but add fields normally
 795                 elif oneof_options.type == nanopb_pb2.FT_IGNORE:
 796                     pass # No union and skip fields also
 797                 else:
 798                     oneof = OneOf(self.name, f)
 799                     if oneof_options.anonymous_oneof:
 800                         oneof.anonymous = True
 801                     self.oneofs[i] = oneof
 802                     self.fields.append(oneof)
 803
 804         for f in desc.field:
 805             field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
 806             if field_options.type == nanopb_pb2.FT_IGNORE:
 807                 continue
 808
 809             field = Field(self.name, f, field_options)
 810             if (hasattr(f, 'oneof_index') and
 811                 f.HasField('oneof_index') and
 812                 f.oneof_index not in no_unions):
 813                 if f.oneof_index in self.oneofs:
 814                     self.oneofs[f.oneof_index].add_field(field)
 815             else:
 816                 self.fields.append(field)
 817
 818         if len(desc.extension_range) > 0:
 819             field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
 820             range_start = min([r.start for r in desc.extension_range])
 821             if field_options.type != nanopb_pb2.FT_IGNORE:
 822                 self.fields.append(ExtensionRange(self.name, range_start, field_options))
 823
 824         self.packed = message_options.packed_struct
 825         self.ordered_fields = self.fields[:]
 826         self.ordered_fields.sort()
 827
 828     def get_dependencies(self):
 829         '''Get list of type names that this structure refers to.'''
 830         deps = []
 831         for f in self.fields:
 832             deps += f.get_dependencies()
 833         return deps
 834
 835     def __str__(self):
 836         result = 'typedef struct _%s {\n' % self.name
 837
 838         if not self.ordered_fields:
 839             # Empty structs are not allowed in C standard.
 840             # Therefore add a dummy field if an empty message occurs.
 841             result += '    char dummy_field;'
 842
 843         result += '\n'.join([str(f) for f in self.ordered_fields])
 844         result += '\n/* @@protoc_insertion_point(struct:%s) */' % self.name
 845         result += '\n}'
 846
 847         if self.packed:
 848             result += ' pb_packed'
 849
 850         result += ' %s;' % self.name
 851
 852         if self.packed:
 853             result = 'PB_PACKED_STRUCT_START\n' + result
 854             result += '\nPB_PACKED_STRUCT_END'
 855
 856         return result
 857
 858     def types(self):
 859         return ''.join([f.types() for f in self.fields])
 860
 861     def get_initializer(self, null_init):
 862         if not self.ordered_fields:
 863             return '{0}'
 864
 865         parts = []
 866         for field in self.ordered_fields:
 867             parts.append(field.get_initializer(null_init))
 868         return '{' + ', '.join(parts) + '}'
 869
 870     def default_decl(self, declaration_only = False):
 871         result = ""
 872         for field in self.fields:
 873             default = field.default_decl(declaration_only)
 874             if default is not None:
 875                 result += default + '\n'
 876         return result
 877
 878     def count_required_fields(self):
 879         '''Returns number of required fields inside this message'''
 880         count = 0
 881         for f in self.fields:
 882             if not isinstance(f, OneOf):
 883                 if f.rules == 'REQUIRED':
 884                     count += 1
 885         return count
 886
 887     def count_all_fields(self):
 888         count = 0
 889         for f in self.fields:
 890             if isinstance(f, OneOf):
 891                 count += len(f.fields)
 892             else:
 893                 count += 1
 894         return count
 895
 896     def fields_declaration(self):
 897         result = 'extern const pb_field_t %s_fields[%d];' % (self.name, self.count_all_fields() + 1)
 898         return result
 899
 900     def fields_definition(self):
 901         result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, self.count_all_fields() + 1)
 902
 903         prev = None
 904         for field in self.ordered_fields:
 905             result += field.pb_field_t(prev)
 906             result += ',\n'
 907             prev = field.get_last_field_name()
 908
 909         result += '    PB_LAST_FIELD\n};'
 910         return result
 911
 912     def encoded_size(self, dependencies):
 913         '''Return the maximum size that this message can take when encoded.
 914         If the size cannot be determined, returns None.
 915         '''
 916         size = EncodedSize(0)
 917         for field in self.fields:
 918             fsize = field.encoded_size(dependencies)
 919             if fsize is None:
 920                 return None
 921             size += fsize
 922
 923         return size
 924
 925
 926 # ---------------------------------------------------------------------------
 927 #                    Processing of entire .proto files
 928 # ---------------------------------------------------------------------------
 929
 930 def iterate_messages(desc, names = Names()):
 931     '''Recursively find all messages. For each, yield name, DescriptorProto.'''
 932     if hasattr(desc, 'message_type'):
 933         submsgs = desc.message_type
 934     else:
 935         submsgs = desc.nested_type
 936
 937     for submsg in submsgs:
 938         sub_names = names + submsg.name
 939         yield sub_names, submsg
 940
 941         for x in iterate_messages(submsg, sub_names):
 942             yield x
 943
 944 def iterate_extensions(desc, names = Names()):
 945     '''Recursively find all extensions.
 946     For each, yield name, FieldDescriptorProto.
 947     '''
 948     for extension in desc.extension:
 949         yield names, extension
 950
 951     for subname, subdesc in iterate_messages(desc, names):
 952         for extension in subdesc.extension:
 953             yield subname, extension
 954
 955 def toposort2(data):
 956     '''Topological sort.
 957     From http://code.activestate.com/recipes/577413-topological-sort/
 958     This function is under the MIT license.
 959     '''
 960     for k, v in list(data.items()):
 961         v.discard(k) # Ignore self dependencies
 962     extra_items_in_deps = reduce(set.union, list(data.values()), set()) - set(data.keys())
 963     data.update(dict([(item, set()) for item in extra_items_in_deps]))
 964     while True:
 965         ordered = set(item for item,dep in list(data.items()) if not dep)
 966         if not ordered:
 967             break
 968         for item in sorted(ordered):
 969             yield item
 970         data = dict([(item, (dep - ordered)) for item,dep in list(data.items())
 971                 if item not in ordered])
 972     assert not data, "A cyclic dependency exists amongst %r" % data
 973
 974 def sort_dependencies(messages):
 975     '''Sort a list of Messages based on dependencies.'''
 976     dependencies = {}
 977     message_by_name = {}
 978     for message in messages:
 979         dependencies[str(message.name)] = set(message.get_dependencies())
 980         message_by_name[str(message.name)] = message
 981
 982     for msgname in toposort2(dependencies):
 983         if msgname in message_by_name:
 984             yield message_by_name[msgname]
 985
 986 def make_identifier(headername):
 987     '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
 988     result = ""
 989     for c in headername.upper():
 990         if c.isalnum():
 991             result += c
 992         else:
 993             result += '_'
 994     return result
 995
 996 class ProtoFile:
 997     def __init__(self, fdesc, file_options):
 998         '''Takes a FileDescriptorProto and parses it.'''
 999         self.fdesc = fdesc
1000         self.file_options = file_options
1001         self.dependencies = {}
1002         self.parse()
1003
1004         # Some of types used in this file probably come from the file itself.
1005         # Thus it has implicit dependency on itself.
1006         self.add_dependency(self)
1007
1008     def parse(self):
1009         self.enums = []
1010         self.messages = []
1011         self.extensions = []
1012
1013         if self.fdesc.package:
1014             base_name = Names(self.fdesc.package.split('.'))
1015         else:
1016             base_name = Names()
1017
1018         for enum in self.fdesc.enum_type:
1019             enum_options = get_nanopb_suboptions(enum, self.file_options, base_name + enum.name)
1020             self.enums.append(Enum(base_name, enum, enum_options))
1021
1022         for names, message in iterate_messages(self.fdesc, base_name):
1023             message_options = get_nanopb_suboptions(message, self.file_options, names)
1024
1025             if message_options.skip_message:
1026                 continue
1027
1028             self.messages.append(Message(names, message, message_options))
1029             for enum in message.enum_type:
1030                 enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
1031                 self.enums.append(Enum(names, enum, enum_options))
1032
1033         for names, extension in iterate_extensions(self.fdesc, base_name):
1034             field_options = get_nanopb_suboptions(extension, self.file_options, names + extension.name)
1035             if field_options.type != nanopb_pb2.FT_IGNORE:
1036                 self.extensions.append(ExtensionField(names, extension, field_options))
1037
1038     def add_dependency(self, other):
1039         for enum in other.enums:
1040             self.dependencies[str(enum.names)] = enum
1041
1042         for msg in other.messages:
1043             self.dependencies[str(msg.name)] = msg
1044
1045         # Fix field default values where enum short names are used.
1046         for enum in other.enums:
1047             if not enum.options.long_names:
1048                 for message in self.messages:
1049                     for field in message.fields:
1050                         if field.default in enum.value_longnames:
1051                             idx = enum.value_longnames.index(field.default)
1052                             field.default = enum.values[idx][0]
1053
1054         # Fix field data types where enums have negative values.
1055         for enum in other.enums:
1056             if not enum.has_negative():
1057                 for message in self.messages:
1058                     for field in message.fields:
1059                         if field.pbtype == 'ENUM' and field.ctype == enum.names:
1060                             field.pbtype = 'UENUM'
1061
1062     def generate_header(self, includes, headername, options):
1063         '''Generate content for a header file.
1064         Generates strings, which should be concatenated and stored to file.
1065         '''
1066
1067         yield '/* Automatically generated nanopb header */\n'
1068         if options.notimestamp:
1069             yield '/* Generated by %s */\n\n' % (nanopb_version)
1070         else:
1071             yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
1072
1073         if self.fdesc.package:
1074             symbol = make_identifier(self.fdesc.package + '_' + headername)
1075         else:
1076             symbol = make_identifier(headername)
1077         yield '#ifndef PB_%s_INCLUDED\n' % symbol
1078         yield '#define PB_%s_INCLUDED\n' % symbol
1079         try:
1080             yield options.libformat % ('pb.h')
1081         except TypeError:
1082             # no %s specified - use whatever was passed in as options.libformat
1083             yield options.libformat
1084         yield '\n'
1085
1086         for incfile in includes:
1087             noext = os.path.splitext(incfile)[0]
1088             yield options.genformat % (noext + options.extension + '.h')
1089             yield '\n'
1090
1091         yield '/* @@protoc_insertion_point(includes) */\n'
1092
1093         yield '#if PB_PROTO_HEADER_VERSION != 30\n'
1094         yield '#error Regenerate this file with the current version of nanopb generator.\n'
1095         yield '#endif\n'
1096         yield '\n'
1097
1098         yield '#ifdef __cplusplus\n'
1099         yield 'extern "C" {\n'
1100         yield '#endif\n\n'
1101
1102         if self.enums:
1103             yield '/* Enum definitions */\n'
1104             for enum in self.enums:
1105                 yield str(enum) + '\n\n'
1106
1107         if self.messages:
1108             yield '/* Struct definitions */\n'
1109             for msg in sort_dependencies(self.messages):
1110                 yield msg.types()
1111                 yield str(msg) + '\n\n'
1112
1113         if self.extensions:
1114             yield '/* Extensions */\n'
1115             for extension in self.extensions:
1116                 yield extension.extension_decl()
1117             yield '\n'
1118
1119         if self.messages:
1120             yield '/* Default values for struct fields */\n'
1121             for msg in self.messages:
1122                 yield msg.default_decl(True)
1123             yield '\n'
1124
1125             yield '/* Initializer values for message structs */\n'
1126             for msg in self.messages:
1127                 identifier = '%s_init_default' % msg.name
1128                 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(False))
1129             for msg in self.messages:
1130                 identifier = '%s_init_zero' % msg.name
1131                 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(True))
1132             yield '\n'
1133
1134             yield '/* Field tags (for use in manual encoding/decoding) */\n'
1135             for msg in sort_dependencies(self.messages):
1136                 for field in msg.fields:
1137                     yield field.tags()
1138             for extension in self.extensions:
1139                 yield extension.tags()
1140             yield '\n'
1141
1142             yield '/* Struct field encoding specification for nanopb */\n'
1143             for msg in self.messages:
1144                 yield msg.fields_declaration() + '\n'
1145             yield '\n'
1146
1147             yield '/* Maximum encoded size of messages (where known) */\n'
1148             for msg in self.messages:
1149                 msize = msg.encoded_size(self.dependencies)
1150                 identifier = '%s_size' % msg.name
1151                 if msize is not None:
1152                     yield '#define %-40s %s\n' % (identifier, msize)
1153                 else:
1154                     yield '/* %s depends on runtime parameters */\n' % identifier
1155             yield '\n'
1156
1157             yield '/* Message IDs (where set with "msgid" option) */\n'
1158
1159             yield '#ifdef PB_MSGID\n'
1160             for msg in self.messages:
1161                 if hasattr(msg,'msgid'):
1162                     yield '#define PB_MSG_%d %s\n' % (msg.msgid, msg.name)
1163             yield '\n'
1164
1165             symbol = make_identifier(headername.split('.')[0])
1166             yield '#define %s_MESSAGES \\\n' % symbol
1167
1168             for msg in self.messages:
1169                 m = "-1"
1170                 msize = msg.encoded_size(self.dependencies)
1171                 if msize is not None:
1172                     m = msize
1173                 if hasattr(msg,'msgid'):
1174                     yield '\tPB_MSG(%d,%s,%s) \\\n' % (msg.msgid, m, msg.name)
1175             yield '\n'
1176
1177             for msg in self.messages:
1178                 if hasattr(msg,'msgid'):
1179                     yield '#define %s_msgid %d\n' % (msg.name, msg.msgid)
1180             yield '\n'
1181
1182             yield '#endif\n\n'
1183
1184         yield '#ifdef __cplusplus\n'
1185         yield '} /* extern "C" */\n'
1186         yield '#endif\n'
1187
1188         # End of header
1189         yield '/* @@protoc_insertion_point(eof) */\n'
1190         yield '\n#endif\n'
1191
1192     def generate_source(self, headername, options):
1193         '''Generate content for a source file.'''
1194
1195         yield '/* Automatically generated nanopb constant definitions */\n'
1196         if options.notimestamp:
1197             yield '/* Generated by %s */\n\n' % (nanopb_version)
1198         else:
1199             yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
1200         yield options.genformat % (headername)
1201         yield '\n'
1202         yield '/* @@protoc_insertion_point(includes) */\n'
1203
1204         yield '#if PB_PROTO_HEADER_VERSION != 30\n'
1205         yield '#error Regenerate this file with the current version of nanopb generator.\n'
1206         yield '#endif\n'
1207         yield '\n'
1208
1209         for msg in self.messages:
1210             yield msg.default_decl(False)
1211
1212         yield '\n\n'
1213
1214         for msg in self.messages:
1215             yield msg.fields_definition() + '\n\n'
1216
1217         for ext in self.extensions:
1218             yield ext.extension_def() + '\n'
1219
1220         # Add checks for numeric limits
1221         if self.messages:
1222             largest_msg = max(self.messages, key = lambda m: m.count_required_fields())
1223             largest_count = largest_msg.count_required_fields()
1224             if largest_count > 64:
1225                 yield '\n/* Check that missing required fields will be properly detected */\n'
1226                 yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
1227                 yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
1228                 yield '       setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
1229                 yield '#endif\n'
1230
1231         max_field = FieldMaxSize()
1232         checks_msgnames = []
1233         for msg in self.messages:
1234             checks_msgnames.append(msg.name)
1235             for field in msg.fields:
1236                 max_field.extend(field.largest_field_value())
1237
1238         worst = max_field.worst
1239         worst_field = max_field.worst_field
1240         checks = max_field.checks
1241
1242         if worst > 255 or checks:
1243             yield '\n/* Check that field information fits in pb_field_t */\n'
1244
1245             if worst > 65535 or checks:
1246                 yield '#if !defined(PB_FIELD_32BIT)\n'
1247                 if worst > 65535:
1248                     yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
1249                 else:
1250                     assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
1251                     msgs = '_'.join(str(n) for n in checks_msgnames)
1252                     yield '/* If you get an error here, it means that you need to define PB_FIELD_32BIT\n'
1253                     yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
1254                     yield ' * \n'
1255                     yield ' * The reason you need to do this is that some of your messages contain tag\n'
1256                     yield ' * numbers or field sizes that are larger than what can fit in 8 or 16 bit\n'
1257                     yield ' * field descriptors.\n'
1258                     yield ' */\n'
1259                     yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
1260                 yield '#endif\n\n'
1261
1262             if worst < 65536:
1263                 yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
1264                 if worst > 255:
1265                     yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
1266                 else:
1267                     assertion = ' && '.join(str(c) + ' < 256' for c in checks)
1268                     msgs = '_'.join(str(n) for n in checks_msgnames)
1269                     yield '/* If you get an error here, it means that you need to define PB_FIELD_16BIT\n'
1270                     yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
1271                     yield ' * \n'
1272                     yield ' * The reason you need to do this is that some of your messages contain tag\n'
1273                     yield ' * numbers or field sizes that are larger than what can fit in the default\n'
1274                     yield ' * 8 bit descriptors.\n'
1275                     yield ' */\n'
1276                     yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
1277                 yield '#endif\n\n'
1278
1279         # Add check for sizeof(double)
1280         has_double = False
1281         for msg in self.messages:
1282             for field in msg.fields:
1283                 if field.ctype == 'double':
1284                     has_double = True
1285
1286         if has_double:
1287             yield '\n'
1288             yield '/* On some platforms (such as AVR), double is really float.\n'
1289             yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
1290             yield ' * To get rid of this error, remove any double fields from your .proto.\n'
1291             yield ' */\n'
1292             yield 'PB_STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
1293
1294         yield '\n'
1295         yield '/* @@protoc_insertion_point(eof) */\n'
1296
1297 # ---------------------------------------------------------------------------
1298 #                    Options parsing for the .proto files
1299 # ---------------------------------------------------------------------------
1300
1301 from fnmatch import fnmatch
1302
1303 def read_options_file(infile):
1304     '''Parse a separate options file to list:
1305         [(namemask, options), ...]
1306     '''
1307     results = []
1308     data = infile.read()
1309     data = re.sub('/\*.*?\*/', '', data, flags = re.MULTILINE)
1310     data = re.sub('//.*?$', '', data, flags = re.MULTILINE)
1311     data = re.sub('#.*?$', '', data, flags = re.MULTILINE)
1312     for i, line in enumerate(data.split('\n')):
1313         line = line.strip()
1314         if not line:
1315             continue
1316
1317         parts = line.split(None, 1)
1318
1319         if len(parts) < 2:
1320             sys.stderr.write("%s:%d: " % (infile.name, i + 1) +
1321                              "Option lines should have space between field name and options. " +
1322                              "Skipping line: '%s'\n" % line)
1323             continue
1324
1325         opts = nanopb_pb2.NanoPBOptions()
1326
1327         try:
1328             text_format.Merge(parts[1], opts)
1329         except Exception as e:
1330             sys.stderr.write("%s:%d: " % (infile.name, i + 1) +
1331                              "Unparseable option line: '%s'. " % line +
1332                              "Error: %s\n" % str(e))
1333             continue
1334         results.append((parts[0], opts))
1335
1336     return results
1337
1338 class Globals:
1339     '''Ugly global variables, should find a good way to pass these.'''
1340     verbose_options = False
1341     separate_options = []
1342     matched_namemasks = set()
1343
1344 def get_nanopb_suboptions(subdesc, options, name):
1345     '''Get copy of options, and merge information from subdesc.'''
1346     new_options = nanopb_pb2.NanoPBOptions()
1347     new_options.CopyFrom(options)
1348
1349     # Handle options defined in a separate file
1350     dotname = '.'.join(name.parts)
1351     for namemask, options in Globals.separate_options:
1352         if fnmatch(dotname, namemask):
1353             Globals.matched_namemasks.add(namemask)
1354             new_options.MergeFrom(options)
1355
1356     # Handle options defined in .proto
1357     if isinstance(subdesc.options, descriptor.FieldOptions):
1358         ext_type = nanopb_pb2.nanopb
1359     elif isinstance(subdesc.options, descriptor.FileOptions):
1360         ext_type = nanopb_pb2.nanopb_fileopt
1361     elif isinstance(subdesc.options, descriptor.MessageOptions):
1362         ext_type = nanopb_pb2.nanopb_msgopt
1363     elif isinstance(subdesc.options, descriptor.EnumOptions):
1364         ext_type = nanopb_pb2.nanopb_enumopt
1365     else:
1366         raise Exception("Unknown options type")
1367
1368     if subdesc.options.HasExtension(ext_type):
1369         ext = subdesc.options.Extensions[ext_type]
1370         new_options.MergeFrom(ext)
1371
1372     if Globals.verbose_options:
1373         sys.stderr.write("Options for " + dotname + ": ")
1374         sys.stderr.write(text_format.MessageToString(new_options) + "\n")
1375
1376     return new_options
1377
1378
1379 # ---------------------------------------------------------------------------
1380 #                         Command line interface
1381 # ---------------------------------------------------------------------------
1382
1383 import sys
1384 import os.path
1385 from optparse import OptionParser
1386
1387 optparser = OptionParser(
1388     usage = "Usage: nanopb_generator.py [options] file.pb ...",
1389     epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
1390              "Output will be written to file.pb.h and file.pb.c.")
1391 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
1392     help="Exclude file from generated #include list.")
1393 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default=".pb",
1394     help="Set extension to use instead of '.pb' for generated files. [default: %default]")
1395 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
1396     help="Set name of a separate generator options file.")
1397 optparser.add_option("-I", "--options-path", dest="options_path", metavar="DIR",
1398     action="append", default = [],
1399     help="Search for .options files additionally in this path")
1400 optparser.add_option("-D", "--output-dir", dest="output_dir",
1401                      metavar="OUTPUTDIR", default=None,
1402                      help="Output directory of .pb.h and .pb.c files")
1403 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
1404     metavar="FORMAT", default='#include "%s"\n',
1405     help="Set format string to use for including other .pb.h files. [default: %default]")
1406 optparser.add_option("-L", "--library-include-format", dest="libformat",
1407     metavar="FORMAT", default='#include <%s>\n',
1408     help="Set format string to use for including the nanopb pb.h header. [default: %default]")
1409 optparser.add_option("-T", "--no-timestamp", dest="notimestamp", action="store_true", default=False,
1410     help="Don't add timestamp to .pb.h and .pb.c preambles")
1411 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
1412     help="Don't print anything except errors.")
1413 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
1414     help="Print more information.")
1415 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
1416     help="Set generator option (max_size, max_count etc.).")
1417
1418 def parse_file(filename, fdesc, options):
1419     '''Parse a single file. Returns a ProtoFile instance.'''
1420     toplevel_options = nanopb_pb2.NanoPBOptions()
1421     for s in options.settings:
1422         text_format.Merge(s, toplevel_options)
1423
1424     if not fdesc:
1425         data = open(filename, 'rb').read()
1426         fdesc = descriptor.FileDescriptorSet.FromString(data).file[0]
1427
1428     # Check if there is a separate .options file
1429     had_abspath = False
1430     try:
1431         optfilename = options.options_file % os.path.splitext(filename)[0]
1432     except TypeError:
1433         # No %s specified, use the filename as-is
1434         optfilename = options.options_file
1435         had_abspath = True
1436
1437     paths = ['.'] + options.options_path
1438     for p in paths:
1439         if os.path.isfile(os.path.join(p, optfilename)):
1440             optfilename = os.path.join(p, optfilename)
1441             if options.verbose:
1442                 sys.stderr.write('Reading options from ' + optfilename + '\n')
1443             Globals.separate_options = read_options_file(open(optfilename, "rU"))
1444             break
1445     else:
1446         # If we are given a full filename and it does not exist, give an error.
1447         # However, don't give error when we automatically look for .options file
1448         # with the same name as .proto.
1449         if options.verbose or had_abspath:
1450             sys.stderr.write('Options file not found: ' + optfilename + '\n')
1451         Globals.separate_options = []
1452
1453     Globals.matched_namemasks = set()
1454
1455     # Parse the file
1456     file_options = get_nanopb_suboptions(fdesc, toplevel_options, Names([filename]))
1457     f = ProtoFile(fdesc, file_options)
1458     f.optfilename = optfilename
1459
1460     return f
1461
1462 def process_file(filename, fdesc, options, other_files = {}):
1463     '''Process a single file.
1464     filename: The full path to the .proto or .pb source file, as string.
1465     fdesc: The loaded FileDescriptorSet, or None to read from the input file.
1466     options: Command line options as they come from OptionsParser.
1467
1468     Returns a dict:
1469         {'headername': Name of header file,
1470          'headerdata': Data for the .h header file,
1471          'sourcename': Name of the source code file,
1472          'sourcedata': Data for the .c source code file
1473         }
1474     '''
1475     f = parse_file(filename, fdesc, options)
1476
1477     # Provide dependencies if available
1478     for dep in f.fdesc.dependency:
1479         if dep in other_files:
1480             f.add_dependency(other_files[dep])
1481
1482     # Decide the file names
1483     noext = os.path.splitext(filename)[0]
1484     headername = noext + options.extension + '.h'
1485     sourcename = noext + options.extension + '.c'
1486     headerbasename = os.path.basename(headername)
1487
1488     # List of .proto files that should not be included in the C header file
1489     # even if they are mentioned in the source .proto.
1490     excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
1491     includes = [d for d in f.fdesc.dependency if d not in excludes]
1492
1493     headerdata = ''.join(f.generate_header(includes, headerbasename, options))
1494     sourcedata = ''.join(f.generate_source(headerbasename, options))
1495
1496     # Check if there were any lines in .options that did not match a member
1497     unmatched = [n for n,o in Globals.separate_options if n not in Globals.matched_namemasks]
1498     if unmatched and not options.quiet:
1499         sys.stderr.write("Following patterns in " + f.optfilename + " did not match any fields: "
1500                          + ', '.join(unmatched) + "\n")
1501         if not Globals.verbose_options:
1502             sys.stderr.write("Use  protoc --nanopb-out=-v:.   to see a list of the field names.\n")
1503
1504     return {'headername': headername, 'headerdata': headerdata,
1505             'sourcename': sourcename, 'sourcedata': sourcedata}
1506
1507 def main_cli():
1508     '''Main function when invoked directly from the command line.'''
1509
1510     options, filenames = optparser.parse_args()
1511
1512     if not filenames:
1513         optparser.print_help()
1514         sys.exit(1)
1515
1516     if options.quiet:
1517         options.verbose = False
1518
1519     if options.output_dir and not os.path.exists(options.output_dir):
1520         optparser.print_help()
1521         sys.stderr.write("\noutput_dir does not exist: %s\n" % options.output_dir)
1522         sys.exit(1)
1523
1524
1525     Globals.verbose_options = options.verbose
1526     for filename in filenames:
1527         results = process_file(filename, None, options)
1528
1529         base_dir = options.output_dir or ''
1530         to_write = [
1531             (os.path.join(base_dir, results['headername']), results['headerdata']),
1532             (os.path.join(base_dir, results['sourcename']), results['sourcedata']),
1533         ]
1534
1535         if not options.quiet:
1536             paths = " and ".join([x[0] for x in to_write])
1537             sys.stderr.write("Writing to %s\n" % paths)
1538
1539         for path, data in to_write:
1540             with open(path, 'w') as f:
1541                 f.write(data)
1542
1543 def main_plugin():
1544     '''Main function when invoked as a protoc plugin.'''
1545
1546     import io, sys
1547     if sys.platform == "win32":
1548         import os, msvcrt
1549         # Set stdin and stdout to binary mode
1550         msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
1551         msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
1552
1553     data = io.open(sys.stdin.fileno(), "rb").read()
1554
1555     request = plugin_pb2.CodeGeneratorRequest.FromString(data)
1556
1557     try:
1558         # Versions of Python prior to 2.7.3 do not support unicode
1559         # input to shlex.split(). Try to convert to str if possible.
1560         params = str(request.parameter)
1561     except UnicodeEncodeError:
1562         params = request.parameter
1563
1564     import shlex
1565     args = shlex.split(params)
1566     options, dummy = optparser.parse_args(args)
1567
1568     Globals.verbose_options = options.verbose
1569
1570     response = plugin_pb2.CodeGeneratorResponse()
1571
1572     # Google's protoc does not currently indicate the full path of proto files.
1573     # Instead always add the main file path to the search dirs, that works for
1574     # the common case.
1575     import os.path
1576     options.options_path.append(os.path.dirname(request.file_to_generate[0]))
1577
1578     # Process any include files first, in order to have them
1579     # available as dependencies
1580     other_files = {}
1581     for fdesc in request.proto_file:
1582         other_files[fdesc.name] = parse_file(fdesc.name, fdesc, options)
1583
1584     for filename in request.file_to_generate:
1585         for fdesc in request.proto_file:
1586             if fdesc.name == filename:
1587                 results = process_file(filename, fdesc, options, other_files)
1588
1589                 f = response.file.add()
1590                 f.name = results['headername']
1591                 f.content = results['headerdata']
1592
1593                 f = response.file.add()
1594                 f.name = results['sourcename']
1595                 f.content = results['sourcedata']
1596
1597     io.open(sys.stdout.fileno(), "wb").write(response.SerializeToString())
1598
1599 if __name__ == '__main__':
1600     # Check if we are running as a plugin under protoc
1601     if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv:
1602         main_plugin()
1603     else:
1604         main_cli()