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