3 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
4 nanopb_version = "nanopb-0.3.2-dev"
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
13 # Don't care, we will error out later if it is actually important.
17 import google.protobuf.text_format as text_format
18 import google.protobuf.descriptor_pb2 as descriptor
21 *************************************************************
22 *** Could not import the Google protobuf Python libraries ***
23 *** Try installing package 'python-protobuf' or similar. ***
24 *************************************************************
29 import proto.nanopb_pb2 as nanopb_pb2
30 import proto.plugin_pb2 as plugin_pb2
33 ********************************************************************
34 *** Failed to import the protocol definitions for generator. ***
35 *** You have to run 'make' in the nanopb/generator/proto folder. ***
36 ********************************************************************
40 # ---------------------------------------------------------------------------
41 # Generation of single fields
42 # ---------------------------------------------------------------------------
47 # Values are tuple (c type, pb type, encoded size, int_size_allowed)
48 FieldD = descriptor.FieldDescriptorProto
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)
65 # Integer size overrides (from .proto settings)
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',
74 '''Keeps a set of nested names and formats them to C identifier.'''
75 def __init__(self, parts = ()):
76 if isinstance(parts, Names):
78 self.parts = tuple(parts)
81 return '_'.join(self.parts)
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)
89 raise ValueError("Name parts should be of type str")
91 def __eq__(self, other):
92 return isinstance(other, Names) and self.parts == other.parts
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('.'))
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:
105 raise ValueError("Value too large for varint: " + str(max_value))
107 assert varint_max_size(0) == 1
108 assert varint_max_size(127) == 1
109 assert varint_max_size(128) == 2
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)]
119 self.symbols = symbols
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)
129 raise ValueError("Cannot add size: " + repr(other))
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])
135 raise ValueError("Cannot multiply size: " + repr(other))
139 return str(self.value)
141 return '(' + str(self.value) + ' + ' + ' + '.join(self.symbols) + ')'
143 def upperlimit(self):
150 def __init__(self, names, desc, enum_options):
151 '''desc is EnumDescriptorProto'''
153 self.options = enum_options
154 self.names = names + desc.name
156 if enum_options.long_names:
157 self.values = [(self.names + x.name, x.number) for x in desc.value]
159 self.values = [(names + x.name, x.number) for x in desc.value]
161 self.value_longnames = [self.names + x.name for x in desc.value]
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
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
178 self.max_count = None
183 # Parse field options
184 if field_options.HasField("max_size"):
185 self.max_size = field_options.max_size
187 if field_options.HasField("max_count"):
188 self.max_count = field_options.max_count
190 if desc.HasField('default_value'):
191 self.default = desc.default_value
193 # Check field rules, i.e. required/optional/repeated.
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
204 self.array_decl = '[%d]' % self.max_count
206 raise NotImplementedError(desc.label)
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
213 if desc.type == FieldD.TYPE_BYTES and self.max_size is None:
214 can_be_static = False
216 # Decide how the field data will be allocated
217 if field_options.type == nanopb_pb2.FT_DEFAULT:
219 field_options.type = nanopb_pb2.FT_STATIC
221 field_options.type = nanopb_pb2.FT_CALLBACK
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)
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'
234 raise NotImplementedError(field_options.type)
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]
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:
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'
254 if self.allocation == 'STATIC':
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
270 raise NotImplementedError(desc.type)
272 def __cmp__(self, other):
273 return cmp(self.tag, other.tag)
277 if self.allocation == 'POINTER':
278 if self.rules == 'REPEATED':
279 result += ' pb_size_t ' + self.name + '_count;\n'
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)
288 result += ' %s *%s;' % (self.ctype, self.name)
289 elif self.allocation == 'CALLBACK':
290 result += ' pb_callback_t %s;' % self.name
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)
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)
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)]
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
321 if self.pbtype == 'MESSAGE':
323 inner_init = '%s_init_zero' % self.ctype
325 inner_init = '%s_init_default' % self.ctype
326 elif self.default is None or null_init:
327 if self.pbtype == 'STRING':
329 elif self.pbtype == 'BYTES':
330 inner_init = '{0, {0}}'
331 elif self.pbtype == 'ENUM':
332 inner_init = '(%s)0' % self.ctype
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]
344 inner_init = '{0, {0}}'
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'
354 inner_init = str(self.default)
360 if self.allocation == 'STATIC':
361 if self.rules == 'REPEATED':
363 outer_init += ', '.join([inner_init] * self.max_count)
365 elif self.rules == 'OPTIONAL':
366 outer_init = 'false, ' + inner_init
368 outer_init = inner_init
369 elif self.allocation == 'POINTER':
370 if self.rules == 'REPEATED':
371 outer_init = '0, NULL'
374 elif self.allocation == 'CALLBACK':
375 if self.pbtype == 'EXTENSION':
378 outer_init = '{{NULL}, NULL}'
382 def default_decl(self, declaration_only = False):
383 '''Return definition for this field's default value.'''
384 if self.default is None:
388 default = self.get_initializer(False, True)
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
400 return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
402 return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
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)
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.
414 if self.rules == 'ONEOF':
415 result = ' PB_ONEOF_FIELD(%s, ' % self.union_name
417 result = ' PB_FIELD('
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)
428 if self.pbtype == 'MESSAGE':
429 result += '&%s_fields)' % self.submsgname
430 elif self.default is None:
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
437 result += '&%s_default)' % (self.struct_name + self.name)
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)
450 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
452 return max(self.tag, self.max_size, self.max_count)
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
459 if self.allocation != 'STATIC':
462 if self.pbtype == 'MESSAGE':
464 if msg.name == self.submsgname:
465 encsize = msg.encoded_size(allmsgs)
467 return None # Submessage size is indeterminate
469 # Include submessage length prefix
470 encsize += varint_max_size(encsize.upperlimit())
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')
479 # We will have to make a conservative assumption on the length
480 # prefix size, though.
483 elif self.enc_size is None:
484 raise RuntimeError("Could not determine encoded size for %s.%s"
485 % (self.struct_name, self.name))
487 encsize = EncodedSize(self.enc_size)
489 encsize += varint_max_size(self.tag << 3) # Tag + wire type
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
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.
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'
520 return ' pb_extension_t *extensions;'
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)
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)
540 if self.rules != 'OPTIONAL':
544 self.rules = 'OPTEXT'
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)
551 def extension_decl(self):
552 '''Declaration of the extension type in the .pb.h file'''
554 msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname
555 msg +=' type of extension fields is currently supported. */\n'
558 return ('extern const pb_extension_type_t %s; /* field type: %s */\n' %
559 (self.fullname, str(self).strip()))
561 def extension_def(self):
562 '''Definition of the extension type in the .pb.c file'''
567 result = 'typedef struct {\n'
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
575 result += ' &%s_field\n' % self.fullname
580 # ---------------------------------------------------------------------------
581 # Generation of oneofs (unions)
582 # ---------------------------------------------------------------------------
585 def __init__(self, struct_name, oneof_desc):
586 self.struct_name = struct_name
587 self.name = oneof_desc.name
591 def add_field(self, field):
592 if field.allocation == 'CALLBACK':
593 raise Exception("Callback fields inside of oneof are not supported"
594 + " (field %s)" % field.name)
596 field.union_name = self.name
597 field.rules = 'ONEOF'
598 self.fields.append(field)
599 self.fields.sort(key = lambda f: f.tag)
601 # Sort by the lowest tag number inside union
602 self.tag = min([f.tag for f in self.fields])
604 def __cmp__(self, other):
605 return cmp(self.tag, other.tag)
610 result += ' pb_size_t which_' + self.name + ";\n"
611 result += ' union {\n'
612 for f in self.fields:
613 result += ' ' + str(f).replace('\n', '\n ') + '\n'
614 result += ' } ' + self.name + ';'
618 return ''.join([f.types() for f in self.fields])
620 def get_dependencies(self):
622 for f in self.fields:
623 deps += f.get_dependencies()
626 def get_initializer(self, null_init):
627 return '0, {' + self.fields[0].get_initializer(null_init) + '}'
629 def default_decl(self, declaration_only = False):
633 return '\n'.join([f.tags() for f in self.fields])
635 def pb_field_t(self, prev_field_name):
636 prev_field_name = prev_field_name or self.name
637 result = ',\n'.join([f.pb_field_t(prev_field_name) for f in self.fields])
640 def largest_field_value(self):
641 return max([f.largest_field_value() for f in self.fields])
643 def encoded_size(self, allmsgs):
644 largest = EncodedSize(0)
645 for f in self.fields:
646 size = f.encoded_size(allmsgs)
650 return None # Cannot resolve maximum of symbols
651 elif size.value > largest.value:
656 # ---------------------------------------------------------------------------
657 # Generation of messages (structures)
658 # ---------------------------------------------------------------------------
662 def __init__(self, names, desc, message_options):
668 if hasattr(desc, 'oneof_decl'):
669 for i, f in enumerate(desc.oneof_decl):
670 oneof_options = get_nanopb_suboptions(desc, message_options, self.name + f.name)
671 if oneof_options.no_unions:
672 no_unions.append(i) # No union, but add fields normally
673 elif oneof_options.type == nanopb_pb2.FT_IGNORE:
674 pass # No union and skip fields also
676 oneof = OneOf(self.name, f)
677 self.oneofs[i] = oneof
678 self.fields.append(oneof)
681 field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
682 if field_options.type == nanopb_pb2.FT_IGNORE:
685 field = Field(self.name, f, field_options)
686 if (hasattr(f, 'oneof_index') and
687 f.HasField('oneof_index') and
688 f.oneof_index not in no_unions):
689 if f.oneof_index in self.oneofs:
690 self.oneofs[f.oneof_index].add_field(field)
692 self.fields.append(field)
694 if len(desc.extension_range) > 0:
695 field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
696 range_start = min([r.start for r in desc.extension_range])
697 if field_options.type != nanopb_pb2.FT_IGNORE:
698 self.fields.append(ExtensionRange(self.name, range_start, field_options))
700 self.packed = message_options.packed_struct
701 self.ordered_fields = self.fields[:]
702 self.ordered_fields.sort()
704 def get_dependencies(self):
705 '''Get list of type names that this structure refers to.'''
707 for f in self.fields:
708 deps += f.get_dependencies()
712 result = 'typedef struct _%s {\n' % self.name
714 if not self.ordered_fields:
715 # Empty structs are not allowed in C standard.
716 # Therefore add a dummy field if an empty message occurs.
717 result += ' uint8_t dummy_field;'
719 result += '\n'.join([str(f) for f in self.ordered_fields])
723 result += ' pb_packed'
725 result += ' %s;' % self.name
728 result = 'PB_PACKED_STRUCT_START\n' + result
729 result += '\nPB_PACKED_STRUCT_END'
734 return ''.join([f.types() for f in self.fields])
736 def get_initializer(self, null_init):
737 if not self.ordered_fields:
741 for field in self.ordered_fields:
742 parts.append(field.get_initializer(null_init))
743 return '{' + ', '.join(parts) + '}'
745 def default_decl(self, declaration_only = False):
747 for field in self.fields:
748 default = field.default_decl(declaration_only)
749 if default is not None:
750 result += default + '\n'
753 def count_required_fields(self):
754 '''Returns number of required fields inside this message'''
756 for f in self.fields:
757 if not isinstance(f, OneOf):
758 if f.rules == 'REQUIRED':
762 def count_all_fields(self):
764 for f in self.fields:
765 if isinstance(f, OneOf):
766 count += len(f.fields)
771 def fields_declaration(self):
772 result = 'extern const pb_field_t %s_fields[%d];' % (self.name, self.count_all_fields() + 1)
775 def fields_definition(self):
776 result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, self.count_all_fields() + 1)
779 for field in self.ordered_fields:
780 result += field.pb_field_t(prev)
782 if isinstance(field, OneOf):
783 prev = field.name + '.' + field.fields[-1].name
787 result += ' PB_LAST_FIELD\n};'
790 def encoded_size(self, allmsgs):
791 '''Return the maximum size that this message can take when encoded.
792 If the size cannot be determined, returns None.
794 size = EncodedSize(0)
795 for field in self.fields:
796 fsize = field.encoded_size(allmsgs)
804 # ---------------------------------------------------------------------------
805 # Processing of entire .proto files
806 # ---------------------------------------------------------------------------
809 def iterate_messages(desc, names = Names()):
810 '''Recursively find all messages. For each, yield name, DescriptorProto.'''
811 if hasattr(desc, 'message_type'):
812 submsgs = desc.message_type
814 submsgs = desc.nested_type
816 for submsg in submsgs:
817 sub_names = names + submsg.name
818 yield sub_names, submsg
820 for x in iterate_messages(submsg, sub_names):
823 def iterate_extensions(desc, names = Names()):
824 '''Recursively find all extensions.
825 For each, yield name, FieldDescriptorProto.
827 for extension in desc.extension:
828 yield names, extension
830 for subname, subdesc in iterate_messages(desc, names):
831 for extension in subdesc.extension:
832 yield subname, extension
834 def parse_file(fdesc, file_options):
835 '''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).'''
842 base_name = Names(fdesc.package.split('.'))
846 for enum in fdesc.enum_type:
847 enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
848 enums.append(Enum(base_name, enum, enum_options))
850 for names, message in iterate_messages(fdesc, base_name):
851 message_options = get_nanopb_suboptions(message, file_options, names)
853 if message_options.skip_message:
856 messages.append(Message(names, message, message_options))
857 for enum in message.enum_type:
858 enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
859 enums.append(Enum(names, enum, enum_options))
861 for names, extension in iterate_extensions(fdesc, base_name):
862 field_options = get_nanopb_suboptions(extension, file_options, names + extension.name)
863 if field_options.type != nanopb_pb2.FT_IGNORE:
864 extensions.append(ExtensionField(names, extension, field_options))
866 # Fix field default values where enum short names are used.
868 if not enum.options.long_names:
869 for message in messages:
870 for field in message.fields:
871 if field.default in enum.value_longnames:
872 idx = enum.value_longnames.index(field.default)
873 field.default = enum.values[idx][0]
875 return enums, messages, extensions
879 From http://code.activestate.com/recipes/577413-topological-sort/
880 This function is under the MIT license.
882 for k, v in data.items():
883 v.discard(k) # Ignore self dependencies
884 extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
885 data.update(dict([(item, set()) for item in extra_items_in_deps]))
887 ordered = set(item for item,dep in data.items() if not dep)
890 for item in sorted(ordered):
892 data = dict([(item, (dep - ordered)) for item,dep in data.items()
893 if item not in ordered])
894 assert not data, "A cyclic dependency exists amongst %r" % data
896 def sort_dependencies(messages):
897 '''Sort a list of Messages based on dependencies.'''
900 for message in messages:
901 dependencies[str(message.name)] = set(message.get_dependencies())
902 message_by_name[str(message.name)] = message
904 for msgname in toposort2(dependencies):
905 if msgname in message_by_name:
906 yield message_by_name[msgname]
908 def make_identifier(headername):
909 '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
911 for c in headername.upper():
918 def generate_header(dependencies, headername, enums, messages, extensions, options):
919 '''Generate content for a header file.
920 Generates strings, which should be concatenated and stored to file.
923 yield '/* Automatically generated nanopb header */\n'
924 if options.notimestamp:
925 yield '/* Generated by %s */\n\n' % (nanopb_version)
927 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
929 symbol = make_identifier(headername)
930 yield '#ifndef PB_%s_INCLUDED\n' % symbol
931 yield '#define PB_%s_INCLUDED\n' % symbol
933 yield options.libformat % ('pb.h')
935 # no %s specified - use whatever was passed in as options.libformat
936 yield options.libformat
939 for dependency in dependencies:
940 noext = os.path.splitext(dependency)[0]
941 yield options.genformat % (noext + options.extension + '.h')
944 yield '#if PB_PROTO_HEADER_VERSION != 30\n'
945 yield '#error Regenerate this file with the current version of nanopb generator.\n'
949 yield '#ifdef __cplusplus\n'
950 yield 'extern "C" {\n'
953 yield '/* Enum definitions */\n'
955 yield str(enum) + '\n\n'
957 yield '/* Struct definitions */\n'
958 for msg in sort_dependencies(messages):
960 yield str(msg) + '\n\n'
963 yield '/* Extensions */\n'
964 for extension in extensions:
965 yield extension.extension_decl()
968 yield '/* Default values for struct fields */\n'
970 yield msg.default_decl(True)
973 yield '/* Initializer values for message structs */\n'
975 identifier = '%s_init_default' % msg.name
976 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(False))
978 identifier = '%s_init_zero' % msg.name
979 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(True))
982 yield '/* Field tags (for use in manual encoding/decoding) */\n'
983 for msg in sort_dependencies(messages):
984 for field in msg.fields:
986 for extension in extensions:
987 yield extension.tags()
990 yield '/* Struct field encoding specification for nanopb */\n'
992 yield msg.fields_declaration() + '\n'
995 yield '/* Maximum encoded size of messages (where known) */\n'
997 msize = msg.encoded_size(messages)
998 if msize is not None:
999 identifier = '%s_size' % msg.name
1000 yield '#define %-40s %s\n' % (identifier, msize)
1003 yield '#ifdef __cplusplus\n'
1004 yield '} /* extern "C" */\n'
1010 def generate_source(headername, enums, messages, extensions, options):
1011 '''Generate content for a source file.'''
1013 yield '/* Automatically generated nanopb constant definitions */\n'
1014 if options.notimestamp:
1015 yield '/* Generated by %s */\n\n' % (nanopb_version)
1017 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
1018 yield options.genformat % (headername)
1021 yield '#if PB_PROTO_HEADER_VERSION != 30\n'
1022 yield '#error Regenerate this file with the current version of nanopb generator.\n'
1026 for msg in messages:
1027 yield msg.default_decl(False)
1031 for msg in messages:
1032 yield msg.fields_definition() + '\n\n'
1034 for ext in extensions:
1035 yield ext.extension_def() + '\n'
1037 # Add checks for numeric limits
1039 largest_msg = max(messages, key = lambda m: m.count_required_fields())
1040 largest_count = largest_msg.count_required_fields()
1041 if largest_count > 64:
1042 yield '\n/* Check that missing required fields will be properly detected */\n'
1043 yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
1044 yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
1045 yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
1051 checks_msgnames = []
1052 for msg in messages:
1053 checks_msgnames.append(msg.name)
1054 for field in msg.fields:
1055 status = field.largest_field_value()
1056 if isinstance(status, (str, unicode)):
1057 checks.append(status)
1058 elif status > worst:
1060 worst_field = str(field.struct_name) + '.' + str(field.name)
1062 if worst > 255 or checks:
1063 yield '\n/* Check that field information fits in pb_field_t */\n'
1065 if worst > 65535 or checks:
1066 yield '#if !defined(PB_FIELD_32BIT)\n'
1068 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
1070 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
1071 msgs = '_'.join(str(n) for n in checks_msgnames)
1072 yield '/* If you get an error here, it means that you need to define PB_FIELD_32BIT\n'
1073 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
1075 yield ' * The reason you need to do this is that some of your messages contain tag\n'
1076 yield ' * numbers or field sizes that are larger than what can fit in 8 or 16 bit\n'
1077 yield ' * field descriptors.\n'
1079 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
1083 yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
1085 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
1087 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
1088 msgs = '_'.join(str(n) for n in checks_msgnames)
1089 yield '/* If you get an error here, it means that you need to define PB_FIELD_16BIT\n'
1090 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
1092 yield ' * The reason you need to do this is that some of your messages contain tag\n'
1093 yield ' * numbers or field sizes that are larger than what can fit in the default\n'
1094 yield ' * 8 bit descriptors.\n'
1096 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
1099 # Add check for sizeof(double)
1101 for msg in messages:
1102 for field in msg.fields:
1103 if field.ctype == 'double':
1108 yield '/* On some platforms (such as AVR), double is really float.\n'
1109 yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
1110 yield ' * To get rid of this error, remove any double fields from your .proto.\n'
1112 yield 'PB_STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
1116 # ---------------------------------------------------------------------------
1117 # Options parsing for the .proto files
1118 # ---------------------------------------------------------------------------
1120 from fnmatch import fnmatch
1122 def read_options_file(infile):
1123 '''Parse a separate options file to list:
1124 [(namemask, options), ...]
1129 if not line or line.startswith('//') or line.startswith('#'):
1132 parts = line.split(None, 1)
1133 opts = nanopb_pb2.NanoPBOptions()
1134 text_format.Merge(parts[1], opts)
1135 results.append((parts[0], opts))
1140 '''Ugly global variables, should find a good way to pass these.'''
1141 verbose_options = False
1142 separate_options = []
1143 matched_namemasks = set()
1145 def get_nanopb_suboptions(subdesc, options, name):
1146 '''Get copy of options, and merge information from subdesc.'''
1147 new_options = nanopb_pb2.NanoPBOptions()
1148 new_options.CopyFrom(options)
1150 # Handle options defined in a separate file
1151 dotname = '.'.join(name.parts)
1152 for namemask, options in Globals.separate_options:
1153 if fnmatch(dotname, namemask):
1154 Globals.matched_namemasks.add(namemask)
1155 new_options.MergeFrom(options)
1157 # Handle options defined in .proto
1158 if isinstance(subdesc.options, descriptor.FieldOptions):
1159 ext_type = nanopb_pb2.nanopb
1160 elif isinstance(subdesc.options, descriptor.FileOptions):
1161 ext_type = nanopb_pb2.nanopb_fileopt
1162 elif isinstance(subdesc.options, descriptor.MessageOptions):
1163 ext_type = nanopb_pb2.nanopb_msgopt
1164 elif isinstance(subdesc.options, descriptor.EnumOptions):
1165 ext_type = nanopb_pb2.nanopb_enumopt
1167 raise Exception("Unknown options type")
1169 if subdesc.options.HasExtension(ext_type):
1170 ext = subdesc.options.Extensions[ext_type]
1171 new_options.MergeFrom(ext)
1173 if Globals.verbose_options:
1174 sys.stderr.write("Options for " + dotname + ": ")
1175 sys.stderr.write(text_format.MessageToString(new_options) + "\n")
1180 # ---------------------------------------------------------------------------
1181 # Command line interface
1182 # ---------------------------------------------------------------------------
1186 from optparse import OptionParser
1188 optparser = OptionParser(
1189 usage = "Usage: nanopb_generator.py [options] file.pb ...",
1190 epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
1191 "Output will be written to file.pb.h and file.pb.c.")
1192 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
1193 help="Exclude file from generated #include list.")
1194 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default=".pb",
1195 help="Set extension to use instead of '.pb' for generated files. [default: %default]")
1196 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
1197 help="Set name of a separate generator options file.")
1198 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
1199 metavar="FORMAT", default='#include "%s"\n',
1200 help="Set format string to use for including other .pb.h files. [default: %default]")
1201 optparser.add_option("-L", "--library-include-format", dest="libformat",
1202 metavar="FORMAT", default='#include <%s>\n',
1203 help="Set format string to use for including the nanopb pb.h header. [default: %default]")
1204 optparser.add_option("-T", "--no-timestamp", dest="notimestamp", action="store_true", default=False,
1205 help="Don't add timestamp to .pb.h and .pb.c preambles")
1206 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
1207 help="Don't print anything except errors.")
1208 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
1209 help="Print more information.")
1210 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
1211 help="Set generator option (max_size, max_count etc.).")
1213 def process_file(filename, fdesc, options):
1214 '''Process a single file.
1215 filename: The full path to the .proto or .pb source file, as string.
1216 fdesc: The loaded FileDescriptorSet, or None to read from the input file.
1217 options: Command line options as they come from OptionsParser.
1220 {'headername': Name of header file,
1221 'headerdata': Data for the .h header file,
1222 'sourcename': Name of the source code file,
1223 'sourcedata': Data for the .c source code file
1226 toplevel_options = nanopb_pb2.NanoPBOptions()
1227 for s in options.settings:
1228 text_format.Merge(s, toplevel_options)
1231 data = open(filename, 'rb').read()
1232 fdesc = descriptor.FileDescriptorSet.FromString(data).file[0]
1234 # Check if there is a separate .options file
1237 optfilename = options.options_file % os.path.splitext(filename)[0]
1239 # No %s specified, use the filename as-is
1240 optfilename = options.options_file
1243 if os.path.isfile(optfilename):
1245 sys.stderr.write('Reading options from ' + optfilename + '\n')
1247 Globals.separate_options = read_options_file(open(optfilename, "rU"))
1249 # If we are given a full filename and it does not exist, give an error.
1250 # However, don't give error when we automatically look for .options file
1251 # with the same name as .proto.
1252 if options.verbose or had_abspath:
1253 sys.stderr.write('Options file not found: ' + optfilename)
1255 Globals.separate_options = []
1257 Globals.matched_namemasks = set()
1260 file_options = get_nanopb_suboptions(fdesc, toplevel_options, Names([filename]))
1261 enums, messages, extensions = parse_file(fdesc, file_options)
1263 # Decide the file names
1264 noext = os.path.splitext(filename)[0]
1265 headername = noext + options.extension + '.h'
1266 sourcename = noext + options.extension + '.c'
1267 headerbasename = os.path.basename(headername)
1269 # List of .proto files that should not be included in the C header file
1270 # even if they are mentioned in the source .proto.
1271 excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
1272 dependencies = [d for d in fdesc.dependency if d not in excludes]
1274 headerdata = ''.join(generate_header(dependencies, headerbasename, enums,
1275 messages, extensions, options))
1277 sourcedata = ''.join(generate_source(headerbasename, enums,
1278 messages, extensions, options))
1280 # Check if there were any lines in .options that did not match a member
1281 unmatched = [n for n,o in Globals.separate_options if n not in Globals.matched_namemasks]
1282 if unmatched and not options.quiet:
1283 sys.stderr.write("Following patterns in " + optfilename + " did not match any fields: "
1284 + ', '.join(unmatched) + "\n")
1285 if not Globals.verbose_options:
1286 sys.stderr.write("Use protoc --nanopb-out=-v:. to see a list of the field names.\n")
1288 return {'headername': headername, 'headerdata': headerdata,
1289 'sourcename': sourcename, 'sourcedata': sourcedata}
1292 '''Main function when invoked directly from the command line.'''
1294 options, filenames = optparser.parse_args()
1297 optparser.print_help()
1301 options.verbose = False
1303 Globals.verbose_options = options.verbose
1305 for filename in filenames:
1306 results = process_file(filename, None, options)
1308 if not options.quiet:
1309 sys.stderr.write("Writing to " + results['headername'] + " and "
1310 + results['sourcename'] + "\n")
1312 open(results['headername'], 'w').write(results['headerdata'])
1313 open(results['sourcename'], 'w').write(results['sourcedata'])
1316 '''Main function when invoked as a protoc plugin.'''
1319 if sys.platform == "win32":
1321 # Set stdin and stdout to binary mode
1322 msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
1323 msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
1325 data = sys.stdin.read()
1326 request = plugin_pb2.CodeGeneratorRequest.FromString(data)
1329 args = shlex.split(request.parameter)
1330 options, dummy = optparser.parse_args(args)
1332 Globals.verbose_options = options.verbose
1334 response = plugin_pb2.CodeGeneratorResponse()
1336 for filename in request.file_to_generate:
1337 for fdesc in request.proto_file:
1338 if fdesc.name == filename:
1339 results = process_file(filename, fdesc, options)
1341 f = response.file.add()
1342 f.name = results['headername']
1343 f.content = results['headerdata']
1345 f = response.file.add()
1346 f.name = results['sourcename']
1347 f.content = results['sourcedata']
1349 sys.stdout.write(response.SerializeToString())
1351 if __name__ == '__main__':
1352 # Check if we are running as a plugin under protoc
1353 if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv: