3 from __future__ import unicode_literals
5 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
6 nanopb_version = "nanopb-0.3.5-dev"
10 from functools import reduce
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
17 # Don't care, we will error out later if it is actually important.
21 import google.protobuf.text_format as text_format
22 import google.protobuf.descriptor_pb2 as descriptor
25 *************************************************************
26 *** Could not import the Google protobuf Python libraries ***
27 *** Try installing package 'python-protobuf' or similar. ***
28 *************************************************************
33 import proto.nanopb_pb2 as nanopb_pb2
34 import proto.plugin_pb2 as plugin_pb2
37 ********************************************************************
38 *** Failed to import the protocol definitions for generator. ***
39 *** You have to run 'make' in the nanopb/generator/proto folder. ***
40 ********************************************************************
44 # ---------------------------------------------------------------------------
45 # Generation of single fields
46 # ---------------------------------------------------------------------------
51 # Values are tuple (c type, pb type, encoded size, int_size_allowed)
52 FieldD = descriptor.FieldDescriptorProto
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)
69 # Integer size overrides (from .proto settings)
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',
77 # String types (for python 2 / python 3 compatibility)
79 strtypes = (unicode, str)
84 '''Keeps a set of nested names and formats them to C identifier.'''
85 def __init__(self, parts = ()):
86 if isinstance(parts, Names):
88 self.parts = tuple(parts)
91 return '_'.join(self.parts)
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)
99 raise ValueError("Name parts should be of type str")
101 def __eq__(self, other):
102 return isinstance(other, Names) and self.parts == other.parts
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('.'))
110 def varint_max_size(max_value):
111 '''Returns the maximum number of bytes a varint can take when encoded.'''
113 max_value = 2**64 - max_value
114 for i in range(1, 11):
115 if (max_value >> (i * 7)) == 0:
117 raise ValueError("Value too large for varint: " + str(max_value))
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
125 '''Class used to represent the encoded size of a field or a message.
126 Consists of a combination of symbolic sizes and integer sizes.'''
127 def __init__(self, value = 0, symbols = []):
128 if isinstance(value, EncodedSize):
129 self.value = value.value
130 self.symbols = value.symbols
131 elif isinstance(value, strtypes + (Names,)):
132 self.symbols = [str(value)]
136 self.symbols = symbols
138 def __add__(self, other):
139 if isinstance(other, int):
140 return EncodedSize(self.value + other, self.symbols)
141 elif isinstance(other, strtypes + (Names,)):
142 return EncodedSize(self.value, self.symbols + [str(other)])
143 elif isinstance(other, EncodedSize):
144 return EncodedSize(self.value + other.value, self.symbols + other.symbols)
146 raise ValueError("Cannot add size: " + repr(other))
148 def __mul__(self, other):
149 if isinstance(other, int):
150 return EncodedSize(self.value * other, [str(other) + '*' + s for s in self.symbols])
152 raise ValueError("Cannot multiply size: " + repr(other))
156 return str(self.value)
158 return '(' + str(self.value) + ' + ' + ' + '.join(self.symbols) + ')'
160 def upperlimit(self):
167 def __init__(self, names, desc, enum_options):
168 '''desc is EnumDescriptorProto'''
170 self.options = enum_options
171 self.names = names + desc.name
173 if enum_options.long_names:
174 self.values = [(self.names + x.name, x.number) for x in desc.value]
176 self.values = [(names + x.name, x.number) for x in desc.value]
178 self.value_longnames = [self.names + x.name for x in desc.value]
179 self.packed = enum_options.packed_enum
181 def has_negative(self):
182 for n, v in self.values:
187 def encoded_size(self):
188 return max([varint_max_size(v) for n,v in self.values])
191 result = 'typedef enum _%s {\n' % self.names
192 result += ',\n'.join([" %s = %d" % x for x in self.values])
196 result += ' pb_packed'
198 result += ' %s;' % self.names
200 if not self.options.long_names:
201 # Define the long names always so that enum value references
202 # from other files work properly.
203 for i, x in enumerate(self.values):
204 result += '\n#define %s %s' % (self.value_longnames[i], x[0])
209 def __init__(self, worst = 0, checks = [], field_name = 'undefined'):
210 if isinstance(worst, list):
211 self.worst = max(i for i in worst if i is not None)
215 self.worst_field = field_name
218 def extend(self, extend, field_name = None):
219 self.worst = max(self.worst, extend.worst)
221 if self.worst == extend.worst:
222 self.worst_field = extend.worst_field
224 self.checks.extend(extend.checks)
227 def __init__(self, struct_name, desc, field_options):
228 '''desc is FieldDescriptorProto'''
229 self.tag = desc.number
230 self.struct_name = struct_name
231 self.union_name = None
232 self.name = desc.name
235 self.max_count = None
240 # Parse field options
241 if field_options.HasField("max_size"):
242 self.max_size = field_options.max_size
244 if field_options.HasField("max_count"):
245 self.max_count = field_options.max_count
247 if desc.HasField('default_value'):
248 self.default = desc.default_value
250 # Check field rules, i.e. required/optional/repeated.
252 if desc.label == FieldD.LABEL_REQUIRED:
253 self.rules = 'REQUIRED'
254 elif desc.label == FieldD.LABEL_OPTIONAL:
255 self.rules = 'OPTIONAL'
256 elif desc.label == FieldD.LABEL_REPEATED:
257 self.rules = 'REPEATED'
258 if self.max_count is None:
259 can_be_static = False
261 self.array_decl = '[%d]' % self.max_count
263 raise NotImplementedError(desc.label)
265 # Check if the field can be implemented with static allocation
266 # i.e. whether the data size is known.
267 if desc.type == FieldD.TYPE_STRING and self.max_size is None:
268 can_be_static = False
270 if desc.type == FieldD.TYPE_BYTES and self.max_size is None:
271 can_be_static = False
273 # Decide how the field data will be allocated
274 if field_options.type == nanopb_pb2.FT_DEFAULT:
276 field_options.type = nanopb_pb2.FT_STATIC
278 field_options.type = nanopb_pb2.FT_CALLBACK
280 if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
281 raise Exception("Field %s is defined as static, but max_size or "
282 "max_count is not given." % self.name)
284 if field_options.type == nanopb_pb2.FT_STATIC:
285 self.allocation = 'STATIC'
286 elif field_options.type == nanopb_pb2.FT_POINTER:
287 self.allocation = 'POINTER'
288 elif field_options.type == nanopb_pb2.FT_CALLBACK:
289 self.allocation = 'CALLBACK'
291 raise NotImplementedError(field_options.type)
293 # Decide the C data type to use in the struct.
294 if desc.type in datatypes:
295 self.ctype, self.pbtype, self.enc_size, isa = datatypes[desc.type]
297 # Override the field size if user wants to use smaller integers
298 if isa and field_options.int_size != nanopb_pb2.IS_DEFAULT:
299 self.ctype = intsizes[field_options.int_size]
300 if desc.type == FieldD.TYPE_UINT32 or desc.type == FieldD.TYPE_UINT64:
301 self.ctype = 'u' + self.ctype;
302 elif desc.type == FieldD.TYPE_ENUM:
304 self.ctype = names_from_type_name(desc.type_name)
305 if self.default is not None:
306 self.default = self.ctype + self.default
307 self.enc_size = None # Needs to be filled in when enum values are known
308 elif desc.type == FieldD.TYPE_STRING:
309 self.pbtype = 'STRING'
311 if self.allocation == 'STATIC':
313 self.array_decl += '[%d]' % self.max_size
314 self.enc_size = varint_max_size(self.max_size) + self.max_size
315 elif desc.type == FieldD.TYPE_BYTES:
316 self.pbtype = 'BYTES'
317 if self.allocation == 'STATIC':
318 self.ctype = self.struct_name + self.name + 't'
319 self.enc_size = varint_max_size(self.max_size) + self.max_size
320 elif self.allocation == 'POINTER':
321 self.ctype = 'pb_bytes_array_t'
322 elif desc.type == FieldD.TYPE_MESSAGE:
323 self.pbtype = 'MESSAGE'
324 self.ctype = self.submsgname = names_from_type_name(desc.type_name)
325 self.enc_size = None # Needs to be filled in after the message type is available
327 raise NotImplementedError(desc.type)
329 def __lt__(self, other):
330 return self.tag < other.tag
334 if self.allocation == 'POINTER':
335 if self.rules == 'REPEATED':
336 result += ' pb_size_t ' + self.name + '_count;\n'
338 if self.pbtype == 'MESSAGE':
339 # Use struct definition, so recursive submessages are possible
340 result += ' struct _%s *%s;' % (self.ctype, self.name)
341 elif self.rules == 'REPEATED' and self.pbtype in ['STRING', 'BYTES']:
342 # String/bytes arrays need to be defined as pointers to pointers
343 result += ' %s **%s;' % (self.ctype, self.name)
345 result += ' %s *%s;' % (self.ctype, self.name)
346 elif self.allocation == 'CALLBACK':
347 result += ' pb_callback_t %s;' % self.name
349 if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
350 result += ' bool has_' + self.name + ';\n'
351 elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
352 result += ' pb_size_t ' + self.name + '_count;\n'
353 result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
357 '''Return definitions for any special types this field might need.'''
358 if self.pbtype == 'BYTES' and self.allocation == 'STATIC':
359 result = 'typedef PB_BYTES_ARRAY_T(%d) %s;\n' % (self.max_size, self.ctype)
364 def get_dependencies(self):
365 '''Get list of type names used by this field.'''
366 if self.allocation == 'STATIC':
367 return [str(self.ctype)]
371 def get_initializer(self, null_init, inner_init_only = False):
372 '''Return literal expression for this field's default value.
373 null_init: If True, initialize to a 0 value instead of default from .proto
374 inner_init_only: If True, exclude initialization for any count/has fields
378 if self.pbtype == 'MESSAGE':
380 inner_init = '%s_init_zero' % self.ctype
382 inner_init = '%s_init_default' % self.ctype
383 elif self.default is None or null_init:
384 if self.pbtype == 'STRING':
386 elif self.pbtype == 'BYTES':
387 inner_init = '{0, {0}}'
388 elif self.pbtype in ('ENUM', 'UENUM'):
389 inner_init = '(%s)0' % self.ctype
393 if self.pbtype == 'STRING':
394 inner_init = self.default.replace('"', '\\"')
395 inner_init = '"' + inner_init + '"'
396 elif self.pbtype == 'BYTES':
397 data = ['0x%02x' % ord(c) for c in self.default]
399 inner_init = '{0, {0}}'
401 inner_init = '{%d, {%s}}' % (len(data), ','.join(data))
402 elif self.pbtype in ['FIXED32', 'UINT32']:
403 inner_init = str(self.default) + 'u'
404 elif self.pbtype in ['FIXED64', 'UINT64']:
405 inner_init = str(self.default) + 'ull'
406 elif self.pbtype in ['SFIXED64', 'INT64']:
407 inner_init = str(self.default) + 'll'
409 inner_init = str(self.default)
415 if self.allocation == 'STATIC':
416 if self.rules == 'REPEATED':
418 outer_init += ', '.join([inner_init] * self.max_count)
420 elif self.rules == 'OPTIONAL':
421 outer_init = 'false, ' + inner_init
423 outer_init = inner_init
424 elif self.allocation == 'POINTER':
425 if self.rules == 'REPEATED':
426 outer_init = '0, NULL'
429 elif self.allocation == 'CALLBACK':
430 if self.pbtype == 'EXTENSION':
433 outer_init = '{{NULL}, NULL}'
437 def default_decl(self, declaration_only = False):
438 '''Return definition for this field's default value.'''
439 if self.default is None:
443 default = self.get_initializer(False, True)
446 if self.pbtype == 'STRING':
447 if self.allocation != 'STATIC':
448 return None # Not implemented
449 array_decl = '[%d]' % self.max_size
450 elif self.pbtype == 'BYTES':
451 if self.allocation != 'STATIC':
452 return None # Not implemented
455 return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
457 return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
460 '''Return the #define for the tag number of this field.'''
461 identifier = '%s_%s_tag' % (self.struct_name, self.name)
462 return '#define %-40s %d\n' % (identifier, self.tag)
464 def pb_field_t(self, prev_field_name):
465 '''Return the pb_field_t initializer to use in the constant array.
466 prev_field_name is the name of the previous field or None.
469 if self.rules == 'ONEOF':
471 result = ' PB_ANONYMOUS_ONEOF_FIELD(%s, ' % self.union_name
473 result = ' PB_ONEOF_FIELD(%s, ' % self.union_name
475 result = ' PB_FIELD('
477 result += '%3d, ' % self.tag
478 result += '%-8s, ' % self.pbtype
479 result += '%s, ' % self.rules
480 result += '%-8s, ' % self.allocation
481 result += '%s, ' % ("FIRST" if not prev_field_name else "OTHER")
482 result += '%s, ' % self.struct_name
483 result += '%s, ' % self.name
484 result += '%s, ' % (prev_field_name or self.name)
486 if self.pbtype == 'MESSAGE':
487 result += '&%s_fields)' % self.submsgname
488 elif self.default is None:
490 elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
491 result += '0)' # Arbitrary size default values not implemented
492 elif self.rules == 'OPTEXT':
493 result += '0)' # Default value for extensions is not implemented
495 result += '&%s_default)' % (self.struct_name + self.name)
499 def get_last_field_name(self):
502 def largest_field_value(self):
503 '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
504 Returns numeric value or a C-expression for assert.'''
506 if self.pbtype == 'MESSAGE':
507 if self.rules == 'REPEATED' and self.allocation == 'STATIC':
508 check.append('pb_membersize(%s, %s[0])' % (self.struct_name, self.name))
509 elif self.rules == 'ONEOF':
511 check.append('pb_membersize(%s, %s)' % (self.struct_name, self.name))
513 check.append('pb_membersize(%s, %s.%s)' % (self.struct_name, self.union_name, self.name))
515 check.append('pb_membersize(%s, %s)' % (self.struct_name, self.name))
517 return FieldMaxSize([self.tag, self.max_size, self.max_count],
519 ('%s.%s' % (self.struct_name, self.name)))
521 def encoded_size(self, dependencies):
522 '''Return the maximum size that this field can take when encoded,
523 including the field tag. If the size cannot be determined, returns
526 if self.allocation != 'STATIC':
529 if self.pbtype == 'MESSAGE':
531 if str(self.submsgname) in dependencies:
532 submsg = dependencies[str(self.submsgname)]
533 encsize = submsg.encoded_size(dependencies)
534 if encsize is not None:
535 # Include submessage length prefix
536 encsize += varint_max_size(encsize.upperlimit())
539 # Submessage or its size cannot be found.
540 # This can occur if submessage is defined in different
541 # file, and it or its .options could not be found.
542 # Instead of direct numeric value, reference the size that
543 # has been #defined in the other file.
544 encsize = EncodedSize(self.submsgname + 'size')
546 # We will have to make a conservative assumption on the length
547 # prefix size, though.
550 elif self.pbtype in ['ENUM', 'UENUM']:
551 if str(self.ctype) in dependencies:
552 enumtype = dependencies[str(self.ctype)]
553 encsize = enumtype.encoded_size()
555 # Conservative assumption
558 elif self.enc_size is None:
559 raise RuntimeError("Could not determine encoded size for %s.%s"
560 % (self.struct_name, self.name))
562 encsize = EncodedSize(self.enc_size)
564 encsize += varint_max_size(self.tag << 3) # Tag + wire type
566 if self.rules == 'REPEATED':
567 # Decoders must be always able to handle unpacked arrays.
568 # Therefore we have to reserve space for it, even though
569 # we emit packed arrays ourselves.
570 encsize *= self.max_count
575 class ExtensionRange(Field):
576 def __init__(self, struct_name, range_start, field_options):
577 '''Implements a special pb_extension_t* field in an extensible message
578 structure. The range_start signifies the index at which the extensions
579 start. Not necessarily all tags above this are extensions, it is merely
580 a speed optimization.
582 self.tag = range_start
583 self.struct_name = struct_name
584 self.name = 'extensions'
585 self.pbtype = 'EXTENSION'
586 self.rules = 'OPTIONAL'
587 self.allocation = 'CALLBACK'
588 self.ctype = 'pb_extension_t'
595 return ' pb_extension_t *extensions;'
603 def encoded_size(self, dependencies):
604 # We exclude extensions from the count, because they cannot be known
605 # until runtime. Other option would be to return None here, but this
606 # way the value remains useful if extensions are not used.
607 return EncodedSize(0)
609 class ExtensionField(Field):
610 def __init__(self, struct_name, desc, field_options):
611 self.fullname = struct_name + desc.name
612 self.extendee_name = names_from_type_name(desc.extendee)
613 Field.__init__(self, self.fullname + 'struct', desc, field_options)
615 if self.rules != 'OPTIONAL':
619 self.rules = 'OPTEXT'
622 '''Return the #define for the tag number of this field.'''
623 identifier = '%s_tag' % self.fullname
624 return '#define %-40s %d\n' % (identifier, self.tag)
626 def extension_decl(self):
627 '''Declaration of the extension type in the .pb.h file'''
629 msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname
630 msg +=' type of extension fields is currently supported. */\n'
633 return ('extern const pb_extension_type_t %s; /* field type: %s */\n' %
634 (self.fullname, str(self).strip()))
636 def extension_def(self):
637 '''Definition of the extension type in the .pb.c file'''
642 result = 'typedef struct {\n'
644 result += '\n} %s;\n\n' % self.struct_name
645 result += ('static const pb_field_t %s_field = \n %s;\n\n' %
646 (self.fullname, self.pb_field_t(None)))
647 result += 'const pb_extension_type_t %s = {\n' % self.fullname
650 result += ' &%s_field\n' % self.fullname
655 # ---------------------------------------------------------------------------
656 # Generation of oneofs (unions)
657 # ---------------------------------------------------------------------------
660 def __init__(self, struct_name, oneof_desc):
661 self.struct_name = struct_name
662 self.name = oneof_desc.name
664 self.pbtype = 'oneof'
666 self.allocation = 'ONEOF'
669 self.anonymous = False
671 def add_field(self, field):
672 if field.allocation == 'CALLBACK':
673 raise Exception("Callback fields inside of oneof are not supported"
674 + " (field %s)" % field.name)
676 field.union_name = self.name
677 field.rules = 'ONEOF'
678 field.anonymous = self.anonymous
679 self.fields.append(field)
680 self.fields.sort(key = lambda f: f.tag)
682 # Sort by the lowest tag number inside union
683 self.tag = min([f.tag for f in self.fields])
688 result += ' pb_size_t which_' + self.name + ";\n"
689 result += ' union {\n'
690 for f in self.fields:
691 result += ' ' + str(f).replace('\n', '\n ') + '\n'
695 result += ' } ' + self.name + ';'
699 return ''.join([f.types() for f in self.fields])
701 def get_dependencies(self):
703 for f in self.fields:
704 deps += f.get_dependencies()
707 def get_initializer(self, null_init):
708 return '0, {' + self.fields[0].get_initializer(null_init) + '}'
710 def default_decl(self, declaration_only = False):
714 return ''.join([f.tags() for f in self.fields])
716 def pb_field_t(self, prev_field_name):
717 result = ',\n'.join([f.pb_field_t(prev_field_name) for f in self.fields])
720 def get_last_field_name(self):
722 return self.fields[-1].name
724 return self.name + '.' + self.fields[-1].name
726 def largest_field_value(self):
727 largest = FieldMaxSize()
728 for f in self.fields:
729 largest.extend(f.largest_field_value())
732 def encoded_size(self, dependencies):
733 largest = EncodedSize(0)
734 for f in self.fields:
735 size = EncodedSize(f.encoded_size(dependencies))
739 return None # Cannot resolve maximum of symbols
740 elif size.value > largest.value:
745 # ---------------------------------------------------------------------------
746 # Generation of messages (structures)
747 # ---------------------------------------------------------------------------
751 def __init__(self, names, desc, message_options):
757 if message_options.msgid:
758 self.msgid = message_options.msgid
760 if hasattr(desc, 'oneof_decl'):
761 for i, f in enumerate(desc.oneof_decl):
762 oneof_options = get_nanopb_suboptions(desc, message_options, self.name + f.name)
763 if oneof_options.no_unions:
764 no_unions.append(i) # No union, but add fields normally
765 elif oneof_options.type == nanopb_pb2.FT_IGNORE:
766 pass # No union and skip fields also
768 oneof = OneOf(self.name, f)
769 if oneof_options.anonymous_oneof:
770 oneof.anonymous = True
771 self.oneofs[i] = oneof
772 self.fields.append(oneof)
775 field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
776 if field_options.type == nanopb_pb2.FT_IGNORE:
779 field = Field(self.name, f, field_options)
780 if (hasattr(f, 'oneof_index') and
781 f.HasField('oneof_index') and
782 f.oneof_index not in no_unions):
783 if f.oneof_index in self.oneofs:
784 self.oneofs[f.oneof_index].add_field(field)
786 self.fields.append(field)
788 if len(desc.extension_range) > 0:
789 field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
790 range_start = min([r.start for r in desc.extension_range])
791 if field_options.type != nanopb_pb2.FT_IGNORE:
792 self.fields.append(ExtensionRange(self.name, range_start, field_options))
794 self.packed = message_options.packed_struct
795 self.ordered_fields = self.fields[:]
796 self.ordered_fields.sort()
798 def get_dependencies(self):
799 '''Get list of type names that this structure refers to.'''
801 for f in self.fields:
802 deps += f.get_dependencies()
806 result = 'typedef struct _%s {\n' % self.name
808 if not self.ordered_fields:
809 # Empty structs are not allowed in C standard.
810 # Therefore add a dummy field if an empty message occurs.
811 result += ' uint8_t dummy_field;'
813 result += '\n'.join([str(f) for f in self.ordered_fields])
817 result += ' pb_packed'
819 result += ' %s;' % self.name
822 result = 'PB_PACKED_STRUCT_START\n' + result
823 result += '\nPB_PACKED_STRUCT_END'
828 return ''.join([f.types() for f in self.fields])
830 def get_initializer(self, null_init):
831 if not self.ordered_fields:
835 for field in self.ordered_fields:
836 parts.append(field.get_initializer(null_init))
837 return '{' + ', '.join(parts) + '}'
839 def default_decl(self, declaration_only = False):
841 for field in self.fields:
842 default = field.default_decl(declaration_only)
843 if default is not None:
844 result += default + '\n'
847 def count_required_fields(self):
848 '''Returns number of required fields inside this message'''
850 for f in self.fields:
851 if not isinstance(f, OneOf):
852 if f.rules == 'REQUIRED':
856 def count_all_fields(self):
858 for f in self.fields:
859 if isinstance(f, OneOf):
860 count += len(f.fields)
865 def fields_declaration(self):
866 result = 'extern const pb_field_t %s_fields[%d];' % (self.name, self.count_all_fields() + 1)
869 def fields_definition(self):
870 result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, self.count_all_fields() + 1)
873 for field in self.ordered_fields:
874 result += field.pb_field_t(prev)
876 prev = field.get_last_field_name()
878 result += ' PB_LAST_FIELD\n};'
881 def encoded_size(self, dependencies):
882 '''Return the maximum size that this message can take when encoded.
883 If the size cannot be determined, returns None.
885 size = EncodedSize(0)
886 for field in self.fields:
887 fsize = field.encoded_size(dependencies)
895 # ---------------------------------------------------------------------------
896 # Processing of entire .proto files
897 # ---------------------------------------------------------------------------
899 def iterate_messages(desc, names = Names()):
900 '''Recursively find all messages. For each, yield name, DescriptorProto.'''
901 if hasattr(desc, 'message_type'):
902 submsgs = desc.message_type
904 submsgs = desc.nested_type
906 for submsg in submsgs:
907 sub_names = names + submsg.name
908 yield sub_names, submsg
910 for x in iterate_messages(submsg, sub_names):
913 def iterate_extensions(desc, names = Names()):
914 '''Recursively find all extensions.
915 For each, yield name, FieldDescriptorProto.
917 for extension in desc.extension:
918 yield names, extension
920 for subname, subdesc in iterate_messages(desc, names):
921 for extension in subdesc.extension:
922 yield subname, extension
926 From http://code.activestate.com/recipes/577413-topological-sort/
927 This function is under the MIT license.
929 for k, v in list(data.items()):
930 v.discard(k) # Ignore self dependencies
931 extra_items_in_deps = reduce(set.union, list(data.values()), set()) - set(data.keys())
932 data.update(dict([(item, set()) for item in extra_items_in_deps]))
934 ordered = set(item for item,dep in list(data.items()) if not dep)
937 for item in sorted(ordered):
939 data = dict([(item, (dep - ordered)) for item,dep in list(data.items())
940 if item not in ordered])
941 assert not data, "A cyclic dependency exists amongst %r" % data
943 def sort_dependencies(messages):
944 '''Sort a list of Messages based on dependencies.'''
947 for message in messages:
948 dependencies[str(message.name)] = set(message.get_dependencies())
949 message_by_name[str(message.name)] = message
951 for msgname in toposort2(dependencies):
952 if msgname in message_by_name:
953 yield message_by_name[msgname]
955 def make_identifier(headername):
956 '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
958 for c in headername.upper():
966 def __init__(self, fdesc, file_options):
967 '''Takes a FileDescriptorProto and parses it.'''
969 self.file_options = file_options
970 self.dependencies = {}
973 # Some of types used in this file probably come from the file itself.
974 # Thus it has implicit dependency on itself.
975 self.add_dependency(self)
982 if self.fdesc.package:
983 base_name = Names(self.fdesc.package.split('.'))
987 for enum in self.fdesc.enum_type:
988 enum_options = get_nanopb_suboptions(enum, self.file_options, base_name + enum.name)
989 self.enums.append(Enum(base_name, enum, enum_options))
991 for names, message in iterate_messages(self.fdesc, base_name):
992 message_options = get_nanopb_suboptions(message, self.file_options, names)
994 if message_options.skip_message:
997 self.messages.append(Message(names, message, message_options))
998 for enum in message.enum_type:
999 enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
1000 self.enums.append(Enum(names, enum, enum_options))
1002 for names, extension in iterate_extensions(self.fdesc, base_name):
1003 field_options = get_nanopb_suboptions(extension, self.file_options, names + extension.name)
1004 if field_options.type != nanopb_pb2.FT_IGNORE:
1005 self.extensions.append(ExtensionField(names, extension, field_options))
1007 def add_dependency(self, other):
1008 for enum in other.enums:
1009 self.dependencies[str(enum.names)] = enum
1011 for msg in other.messages:
1012 self.dependencies[str(msg.name)] = msg
1014 # Fix field default values where enum short names are used.
1015 for enum in other.enums:
1016 if not enum.options.long_names:
1017 for message in self.messages:
1018 for field in message.fields:
1019 if field.default in enum.value_longnames:
1020 idx = enum.value_longnames.index(field.default)
1021 field.default = enum.values[idx][0]
1023 # Fix field data types where enums have negative values.
1024 for enum in other.enums:
1025 if not enum.has_negative():
1026 for message in self.messages:
1027 for field in message.fields:
1028 if field.pbtype == 'ENUM' and field.ctype == enum.names:
1029 field.pbtype = 'UENUM'
1031 def generate_header(self, includes, headername, options):
1032 '''Generate content for a header file.
1033 Generates strings, which should be concatenated and stored to file.
1036 yield '/* Automatically generated nanopb header */\n'
1037 if options.notimestamp:
1038 yield '/* Generated by %s */\n\n' % (nanopb_version)
1040 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
1042 symbol = make_identifier(headername)
1043 yield '#ifndef PB_%s_INCLUDED\n' % symbol
1044 yield '#define PB_%s_INCLUDED\n' % symbol
1046 yield options.libformat % ('pb.h')
1048 # no %s specified - use whatever was passed in as options.libformat
1049 yield options.libformat
1052 for incfile in includes:
1053 noext = os.path.splitext(incfile)[0]
1054 yield options.genformat % (noext + options.extension + '.h')
1057 yield '#if PB_PROTO_HEADER_VERSION != 30\n'
1058 yield '#error Regenerate this file with the current version of nanopb generator.\n'
1062 yield '#ifdef __cplusplus\n'
1063 yield 'extern "C" {\n'
1067 yield '/* Enum definitions */\n'
1068 for enum in self.enums:
1069 yield str(enum) + '\n\n'
1072 yield '/* Struct definitions */\n'
1073 for msg in sort_dependencies(self.messages):
1075 yield str(msg) + '\n\n'
1078 yield '/* Extensions */\n'
1079 for extension in self.extensions:
1080 yield extension.extension_decl()
1084 yield '/* Default values for struct fields */\n'
1085 for msg in self.messages:
1086 yield msg.default_decl(True)
1089 yield '/* Initializer values for message structs */\n'
1090 for msg in self.messages:
1091 identifier = '%s_init_default' % msg.name
1092 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(False))
1093 for msg in self.messages:
1094 identifier = '%s_init_zero' % msg.name
1095 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(True))
1098 yield '/* Field tags (for use in manual encoding/decoding) */\n'
1099 for msg in sort_dependencies(self.messages):
1100 for field in msg.fields:
1102 for extension in self.extensions:
1103 yield extension.tags()
1106 yield '/* Struct field encoding specification for nanopb */\n'
1107 for msg in self.messages:
1108 yield msg.fields_declaration() + '\n'
1111 yield '/* Maximum encoded size of messages (where known) */\n'
1112 for msg in self.messages:
1113 msize = msg.encoded_size(self.dependencies)
1114 if msize is not None:
1115 identifier = '%s_size' % msg.name
1116 yield '#define %-40s %s\n' % (identifier, msize)
1119 yield '/* Message IDs (where set with "msgid" option) */\n'
1121 yield '#ifdef PB_MSGID\n'
1122 for msg in self.messages:
1123 if hasattr(msg,'msgid'):
1124 yield '#define PB_MSG_%d %s\n' % (msg.msgid, msg.name)
1127 symbol = make_identifier(headername.split('.')[0])
1128 yield '#define %s_MESSAGES \\\n' % symbol
1130 for msg in self.messages:
1132 msize = msg.encoded_size(self.dependencies)
1133 if msize is not None:
1135 if hasattr(msg,'msgid'):
1136 yield '\tPB_MSG(%d,%s,%s) \\\n' % (msg.msgid, m, msg.name)
1139 for msg in self.messages:
1140 if hasattr(msg,'msgid'):
1141 yield '#define %s_msgid %d\n' % (msg.name, msg.msgid)
1146 yield '#ifdef __cplusplus\n'
1147 yield '} /* extern "C" */\n'
1153 def generate_source(self, headername, options):
1154 '''Generate content for a source file.'''
1156 yield '/* Automatically generated nanopb constant definitions */\n'
1157 if options.notimestamp:
1158 yield '/* Generated by %s */\n\n' % (nanopb_version)
1160 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
1161 yield options.genformat % (headername)
1164 yield '#if PB_PROTO_HEADER_VERSION != 30\n'
1165 yield '#error Regenerate this file with the current version of nanopb generator.\n'
1169 for msg in self.messages:
1170 yield msg.default_decl(False)
1174 for msg in self.messages:
1175 yield msg.fields_definition() + '\n\n'
1177 for ext in self.extensions:
1178 yield ext.extension_def() + '\n'
1180 # Add checks for numeric limits
1182 largest_msg = max(self.messages, key = lambda m: m.count_required_fields())
1183 largest_count = largest_msg.count_required_fields()
1184 if largest_count > 64:
1185 yield '\n/* Check that missing required fields will be properly detected */\n'
1186 yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
1187 yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
1188 yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
1191 max_field = FieldMaxSize()
1192 checks_msgnames = []
1193 for msg in self.messages:
1194 checks_msgnames.append(msg.name)
1195 for field in msg.fields:
1196 max_field.extend(field.largest_field_value())
1198 worst = max_field.worst
1199 worst_field = max_field.worst_field
1200 checks = max_field.checks
1202 if worst > 255 or checks:
1203 yield '\n/* Check that field information fits in pb_field_t */\n'
1205 if worst > 65535 or checks:
1206 yield '#if !defined(PB_FIELD_32BIT)\n'
1208 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
1210 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
1211 msgs = '_'.join(str(n) for n in checks_msgnames)
1212 yield '/* If you get an error here, it means that you need to define PB_FIELD_32BIT\n'
1213 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
1215 yield ' * The reason you need to do this is that some of your messages contain tag\n'
1216 yield ' * numbers or field sizes that are larger than what can fit in 8 or 16 bit\n'
1217 yield ' * field descriptors.\n'
1219 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
1223 yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
1225 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
1227 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
1228 msgs = '_'.join(str(n) for n in checks_msgnames)
1229 yield '/* If you get an error here, it means that you need to define PB_FIELD_16BIT\n'
1230 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
1232 yield ' * The reason you need to do this is that some of your messages contain tag\n'
1233 yield ' * numbers or field sizes that are larger than what can fit in the default\n'
1234 yield ' * 8 bit descriptors.\n'
1236 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
1239 # Add check for sizeof(double)
1241 for msg in self.messages:
1242 for field in msg.fields:
1243 if field.ctype == 'double':
1248 yield '/* On some platforms (such as AVR), double is really float.\n'
1249 yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
1250 yield ' * To get rid of this error, remove any double fields from your .proto.\n'
1252 yield 'PB_STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
1256 # ---------------------------------------------------------------------------
1257 # Options parsing for the .proto files
1258 # ---------------------------------------------------------------------------
1260 from fnmatch import fnmatch
1262 def read_options_file(infile):
1263 '''Parse a separate options file to list:
1264 [(namemask, options), ...]
1267 data = infile.read()
1268 data = re.sub('/\*.*?\*/', '', data, flags = re.MULTILINE)
1269 data = re.sub('//.*?$', '', data, flags = re.MULTILINE)
1270 data = re.sub('#.*?$', '', data, flags = re.MULTILINE)
1271 for i, line in enumerate(data.split('\n')):
1276 parts = line.split(None, 1)
1279 sys.stderr.write("%s:%d: " % (infile.name, i + 1) +
1280 "Option lines should have space between field name and options. " +
1281 "Skipping line: '%s'\n" % line)
1284 opts = nanopb_pb2.NanoPBOptions()
1287 text_format.Merge(parts[1], opts)
1288 except Exception as e:
1289 sys.stderr.write("%s:%d: " % (infile.name, i + 1) +
1290 "Unparseable option line: '%s'. " % line +
1291 "Error: %s\n" % str(e))
1293 results.append((parts[0], opts))
1298 '''Ugly global variables, should find a good way to pass these.'''
1299 verbose_options = False
1300 separate_options = []
1301 matched_namemasks = set()
1303 def get_nanopb_suboptions(subdesc, options, name):
1304 '''Get copy of options, and merge information from subdesc.'''
1305 new_options = nanopb_pb2.NanoPBOptions()
1306 new_options.CopyFrom(options)
1308 # Handle options defined in a separate file
1309 dotname = '.'.join(name.parts)
1310 for namemask, options in Globals.separate_options:
1311 if fnmatch(dotname, namemask):
1312 Globals.matched_namemasks.add(namemask)
1313 new_options.MergeFrom(options)
1315 # Handle options defined in .proto
1316 if isinstance(subdesc.options, descriptor.FieldOptions):
1317 ext_type = nanopb_pb2.nanopb
1318 elif isinstance(subdesc.options, descriptor.FileOptions):
1319 ext_type = nanopb_pb2.nanopb_fileopt
1320 elif isinstance(subdesc.options, descriptor.MessageOptions):
1321 ext_type = nanopb_pb2.nanopb_msgopt
1322 elif isinstance(subdesc.options, descriptor.EnumOptions):
1323 ext_type = nanopb_pb2.nanopb_enumopt
1325 raise Exception("Unknown options type")
1327 if subdesc.options.HasExtension(ext_type):
1328 ext = subdesc.options.Extensions[ext_type]
1329 new_options.MergeFrom(ext)
1331 if Globals.verbose_options:
1332 sys.stderr.write("Options for " + dotname + ": ")
1333 sys.stderr.write(text_format.MessageToString(new_options) + "\n")
1338 # ---------------------------------------------------------------------------
1339 # Command line interface
1340 # ---------------------------------------------------------------------------
1344 from optparse import OptionParser
1346 optparser = OptionParser(
1347 usage = "Usage: nanopb_generator.py [options] file.pb ...",
1348 epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
1349 "Output will be written to file.pb.h and file.pb.c.")
1350 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
1351 help="Exclude file from generated #include list.")
1352 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default=".pb",
1353 help="Set extension to use instead of '.pb' for generated files. [default: %default]")
1354 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
1355 help="Set name of a separate generator options file.")
1356 optparser.add_option("-I", "--options-path", dest="options_path", metavar="DIR",
1357 action="append", default = [],
1358 help="Search for .options files additionally in this path")
1359 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
1360 metavar="FORMAT", default='#include "%s"\n',
1361 help="Set format string to use for including other .pb.h files. [default: %default]")
1362 optparser.add_option("-L", "--library-include-format", dest="libformat",
1363 metavar="FORMAT", default='#include <%s>\n',
1364 help="Set format string to use for including the nanopb pb.h header. [default: %default]")
1365 optparser.add_option("-T", "--no-timestamp", dest="notimestamp", action="store_true", default=False,
1366 help="Don't add timestamp to .pb.h and .pb.c preambles")
1367 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
1368 help="Don't print anything except errors.")
1369 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
1370 help="Print more information.")
1371 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
1372 help="Set generator option (max_size, max_count etc.).")
1374 def parse_file(filename, fdesc, options):
1375 '''Parse a single file. Returns a ProtoFile instance.'''
1376 toplevel_options = nanopb_pb2.NanoPBOptions()
1377 for s in options.settings:
1378 text_format.Merge(s, toplevel_options)
1381 data = open(filename, 'rb').read()
1382 fdesc = descriptor.FileDescriptorSet.FromString(data).file[0]
1384 # Check if there is a separate .options file
1387 optfilename = options.options_file % os.path.splitext(filename)[0]
1389 # No %s specified, use the filename as-is
1390 optfilename = options.options_file
1393 paths = ['.'] + options.options_path
1395 if os.path.isfile(os.path.join(p, optfilename)):
1396 optfilename = os.path.join(p, optfilename)
1398 sys.stderr.write('Reading options from ' + optfilename + '\n')
1399 Globals.separate_options = read_options_file(open(optfilename, "rU"))
1402 # If we are given a full filename and it does not exist, give an error.
1403 # However, don't give error when we automatically look for .options file
1404 # with the same name as .proto.
1405 if options.verbose or had_abspath:
1406 sys.stderr.write('Options file not found: ' + optfilename + '\n')
1407 Globals.separate_options = []
1409 Globals.matched_namemasks = set()
1412 file_options = get_nanopb_suboptions(fdesc, toplevel_options, Names([filename]))
1413 f = ProtoFile(fdesc, file_options)
1414 f.optfilename = optfilename
1418 def process_file(filename, fdesc, options, other_files = {}):
1419 '''Process a single file.
1420 filename: The full path to the .proto or .pb source file, as string.
1421 fdesc: The loaded FileDescriptorSet, or None to read from the input file.
1422 options: Command line options as they come from OptionsParser.
1425 {'headername': Name of header file,
1426 'headerdata': Data for the .h header file,
1427 'sourcename': Name of the source code file,
1428 'sourcedata': Data for the .c source code file
1431 f = parse_file(filename, fdesc, options)
1433 # Provide dependencies if available
1434 for dep in f.fdesc.dependency:
1435 if dep in other_files:
1436 f.add_dependency(other_files[dep])
1438 # Decide the file names
1439 noext = os.path.splitext(filename)[0]
1440 headername = noext + options.extension + '.h'
1441 sourcename = noext + options.extension + '.c'
1442 headerbasename = os.path.basename(headername)
1444 # List of .proto files that should not be included in the C header file
1445 # even if they are mentioned in the source .proto.
1446 excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
1447 includes = [d for d in f.fdesc.dependency if d not in excludes]
1449 headerdata = ''.join(f.generate_header(includes, headerbasename, options))
1450 sourcedata = ''.join(f.generate_source(headerbasename, options))
1452 # Check if there were any lines in .options that did not match a member
1453 unmatched = [n for n,o in Globals.separate_options if n not in Globals.matched_namemasks]
1454 if unmatched and not options.quiet:
1455 sys.stderr.write("Following patterns in " + f.optfilename + " did not match any fields: "
1456 + ', '.join(unmatched) + "\n")
1457 if not Globals.verbose_options:
1458 sys.stderr.write("Use protoc --nanopb-out=-v:. to see a list of the field names.\n")
1460 return {'headername': headername, 'headerdata': headerdata,
1461 'sourcename': sourcename, 'sourcedata': sourcedata}
1464 '''Main function when invoked directly from the command line.'''
1466 options, filenames = optparser.parse_args()
1469 optparser.print_help()
1473 options.verbose = False
1475 Globals.verbose_options = options.verbose
1477 for filename in filenames:
1478 results = process_file(filename, None, options)
1480 if not options.quiet:
1481 sys.stderr.write("Writing to " + results['headername'] + " and "
1482 + results['sourcename'] + "\n")
1484 open(results['headername'], 'w').write(results['headerdata'])
1485 open(results['sourcename'], 'w').write(results['sourcedata'])
1488 '''Main function when invoked as a protoc plugin.'''
1491 if sys.platform == "win32":
1493 # Set stdin and stdout to binary mode
1494 msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
1495 msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
1497 data = io.open(sys.stdin.fileno(), "rb").read()
1499 request = plugin_pb2.CodeGeneratorRequest.FromString(data)
1502 # Versions of Python prior to 2.7.3 do not support unicode
1503 # input to shlex.split(). Try to convert to str if possible.
1504 params = str(request.parameter)
1505 except UnicodeEncodeError:
1506 params = request.parameter
1509 args = shlex.split(params)
1510 options, dummy = optparser.parse_args(args)
1512 Globals.verbose_options = options.verbose
1514 response = plugin_pb2.CodeGeneratorResponse()
1516 # Google's protoc does not currently indicate the full path of proto files.
1517 # Instead always add the main file path to the search dirs, that works for
1520 options.options_path.append(os.path.dirname(request.file_to_generate[0]))
1522 # Process any include files first, in order to have them
1523 # available as dependencies
1525 for fdesc in request.proto_file:
1526 other_files[fdesc.name] = parse_file(fdesc.name, fdesc, options)
1528 for filename in request.file_to_generate:
1529 for fdesc in request.proto_file:
1530 if fdesc.name == filename:
1531 results = process_file(filename, fdesc, options, other_files)
1533 f = response.file.add()
1534 f.name = results['headername']
1535 f.content = results['headerdata']
1537 f = response.file.add()
1538 f.name = results['sourcename']
1539 f.content = results['sourcedata']
1541 io.open(sys.stdout.fileno(), "wb").write(response.SerializeToString())
1543 if __name__ == '__main__':
1544 # Check if we are running as a plugin under protoc
1545 if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv: