generator/nanopb_generator.py

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