3 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
4 nanopb_version = "nanopb-0.3.1-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)
48 FieldD = descriptor.FieldDescriptorProto
50 FieldD.TYPE_BOOL: ('bool', 'BOOL', 1),
51 FieldD.TYPE_DOUBLE: ('double', 'DOUBLE', 8),
52 FieldD.TYPE_FIXED32: ('uint32_t', 'FIXED32', 4),
53 FieldD.TYPE_FIXED64: ('uint64_t', 'FIXED64', 8),
54 FieldD.TYPE_FLOAT: ('float', 'FLOAT', 4),
55 FieldD.TYPE_INT32: ('int32_t', 'INT32', 10),
56 FieldD.TYPE_INT64: ('int64_t', 'INT64', 10),
57 FieldD.TYPE_SFIXED32: ('int32_t', 'SFIXED32', 4),
58 FieldD.TYPE_SFIXED64: ('int64_t', 'SFIXED64', 8),
59 FieldD.TYPE_SINT32: ('int32_t', 'SINT32', 5),
60 FieldD.TYPE_SINT64: ('int64_t', 'SINT64', 10),
61 FieldD.TYPE_UINT32: ('uint32_t', 'UINT32', 5),
62 FieldD.TYPE_UINT64: ('uint64_t', 'UINT64', 10)
66 '''Keeps a set of nested names and formats them to C identifier.'''
67 def __init__(self, parts = ()):
68 if isinstance(parts, Names):
70 self.parts = tuple(parts)
73 return '_'.join(self.parts)
75 def __add__(self, other):
76 if isinstance(other, (str, unicode)):
77 return Names(self.parts + (other,))
78 elif isinstance(other, tuple):
79 return Names(self.parts + other)
81 raise ValueError("Name parts should be of type str")
83 def __eq__(self, other):
84 return isinstance(other, Names) and self.parts == other.parts
86 def names_from_type_name(type_name):
87 '''Parse Names() from FieldDescriptorProto type_name'''
88 if type_name[0] != '.':
89 raise NotImplementedError("Lookup of non-absolute type names is not supported")
90 return Names(type_name[1:].split('.'))
92 def varint_max_size(max_value):
93 '''Returns the maximum number of bytes a varint can take when encoded.'''
94 for i in range(1, 11):
95 if (max_value >> (i * 7)) == 0:
97 raise ValueError("Value too large for varint: " + str(max_value))
99 assert varint_max_size(0) == 1
100 assert varint_max_size(127) == 1
101 assert varint_max_size(128) == 2
104 '''Class used to represent the encoded size of a field or a message.
105 Consists of a combination of symbolic sizes and integer sizes.'''
106 def __init__(self, value = 0, symbols = []):
107 if isinstance(value, (str, Names)):
108 symbols = [str(value)]
111 self.symbols = symbols
113 def __add__(self, other):
114 if isinstance(other, (int, long)):
115 return EncodedSize(self.value + other, self.symbols)
116 elif isinstance(other, (str, Names)):
117 return EncodedSize(self.value, self.symbols + [str(other)])
118 elif isinstance(other, EncodedSize):
119 return EncodedSize(self.value + other.value, self.symbols + other.symbols)
121 raise ValueError("Cannot add size: " + repr(other))
123 def __mul__(self, other):
124 if isinstance(other, (int, long)):
125 return EncodedSize(self.value * other, [str(other) + '*' + s for s in self.symbols])
127 raise ValueError("Cannot multiply size: " + repr(other))
131 return str(self.value)
133 return '(' + str(self.value) + ' + ' + ' + '.join(self.symbols) + ')'
135 def upperlimit(self):
142 def __init__(self, names, desc, enum_options):
143 '''desc is EnumDescriptorProto'''
145 self.options = enum_options
146 self.names = names + desc.name
148 if enum_options.long_names:
149 self.values = [(self.names + x.name, x.number) for x in desc.value]
151 self.values = [(names + x.name, x.number) for x in desc.value]
153 self.value_longnames = [self.names + x.name for x in desc.value]
156 result = 'typedef enum _%s {\n' % self.names
157 result += ',\n'.join([" %s = %d" % x for x in self.values])
158 result += '\n} %s;' % self.names
162 def __init__(self, struct_name, desc, field_options):
163 '''desc is FieldDescriptorProto'''
164 self.tag = desc.number
165 self.struct_name = struct_name
166 self.name = desc.name
169 self.max_count = None
174 # Parse field options
175 if field_options.HasField("max_size"):
176 self.max_size = field_options.max_size
178 if field_options.HasField("max_count"):
179 self.max_count = field_options.max_count
181 if desc.HasField('default_value'):
182 self.default = desc.default_value
184 # Check field rules, i.e. required/optional/repeated.
186 if desc.label == FieldD.LABEL_REQUIRED:
187 self.rules = 'REQUIRED'
188 elif desc.label == FieldD.LABEL_OPTIONAL:
189 self.rules = 'OPTIONAL'
190 elif desc.label == FieldD.LABEL_REPEATED:
191 self.rules = 'REPEATED'
192 if self.max_count is None:
193 can_be_static = False
195 self.array_decl = '[%d]' % self.max_count
197 raise NotImplementedError(desc.label)
199 # Check if the field can be implemented with static allocation
200 # i.e. whether the data size is known.
201 if desc.type == FieldD.TYPE_STRING and self.max_size is None:
202 can_be_static = False
204 if desc.type == FieldD.TYPE_BYTES and self.max_size is None:
205 can_be_static = False
207 # Decide how the field data will be allocated
208 if field_options.type == nanopb_pb2.FT_DEFAULT:
210 field_options.type = nanopb_pb2.FT_STATIC
212 field_options.type = nanopb_pb2.FT_CALLBACK
214 if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
215 raise Exception("Field %s is defined as static, but max_size or "
216 "max_count is not given." % self.name)
218 if field_options.type == nanopb_pb2.FT_STATIC:
219 self.allocation = 'STATIC'
220 elif field_options.type == nanopb_pb2.FT_POINTER:
221 self.allocation = 'POINTER'
222 elif field_options.type == nanopb_pb2.FT_CALLBACK:
223 self.allocation = 'CALLBACK'
225 raise NotImplementedError(field_options.type)
227 # Decide the C data type to use in the struct.
228 if datatypes.has_key(desc.type):
229 self.ctype, self.pbtype, self.enc_size = datatypes[desc.type]
230 elif desc.type == FieldD.TYPE_ENUM:
232 self.ctype = names_from_type_name(desc.type_name)
233 if self.default is not None:
234 self.default = self.ctype + self.default
235 self.enc_size = 5 # protoc rejects enum values > 32 bits
236 elif desc.type == FieldD.TYPE_STRING:
237 self.pbtype = 'STRING'
239 if self.allocation == 'STATIC':
241 self.array_decl += '[%d]' % self.max_size
242 self.enc_size = varint_max_size(self.max_size) + self.max_size
243 elif desc.type == FieldD.TYPE_BYTES:
244 self.pbtype = 'BYTES'
245 if self.allocation == 'STATIC':
246 self.ctype = self.struct_name + self.name + 't'
247 self.enc_size = varint_max_size(self.max_size) + self.max_size
248 elif self.allocation == 'POINTER':
249 self.ctype = 'pb_bytes_array_t'
250 elif desc.type == FieldD.TYPE_MESSAGE:
251 self.pbtype = 'MESSAGE'
252 self.ctype = self.submsgname = names_from_type_name(desc.type_name)
253 self.enc_size = None # Needs to be filled in after the message type is available
255 raise NotImplementedError(desc.type)
257 def __cmp__(self, other):
258 return cmp(self.tag, other.tag)
262 if self.allocation == 'POINTER':
263 if self.rules == 'REPEATED':
264 result += ' pb_size_t ' + self.name + '_count;\n'
266 if self.pbtype == 'MESSAGE':
267 # Use struct definition, so recursive submessages are possible
268 result += ' struct _%s *%s;' % (self.ctype, self.name)
269 elif self.rules == 'REPEATED' and self.pbtype in ['STRING', 'BYTES']:
270 # String/bytes arrays need to be defined as pointers to pointers
271 result += ' %s **%s;' % (self.ctype, self.name)
273 result += ' %s *%s;' % (self.ctype, self.name)
274 elif self.allocation == 'CALLBACK':
275 result += ' pb_callback_t %s;' % self.name
277 if self.rules == 'OPTIONAL' and self.allocation == 'STATIC':
278 result += ' bool has_' + self.name + ';\n'
279 elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
280 result += ' pb_size_t ' + self.name + '_count;\n'
281 result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
285 '''Return definitions for any special types this field might need.'''
286 if self.pbtype == 'BYTES' and self.allocation == 'STATIC':
287 result = 'typedef PB_BYTES_ARRAY_T(%d) %s;\n' % (self.max_size, self.ctype)
292 def get_initializer(self, null_init):
293 '''Return literal expression for this field's default value.'''
295 if self.pbtype == 'MESSAGE':
297 return '%s_init_zero' % self.ctype
299 return '%s_init_default' % self.ctype
301 if self.default is None or null_init:
302 if self.pbtype == 'STRING':
304 elif self.pbtype == 'BYTES':
306 elif self.pbtype == 'ENUM':
307 return '(%s)0' % self.ctype
311 default = str(self.default)
313 if self.pbtype == 'STRING':
314 default = default.encode('utf-8').encode('string_escape')
315 default = default.replace('"', '\\"')
316 default = '"' + default + '"'
317 elif self.pbtype == 'BYTES':
318 data = default.decode('string_escape')
319 data = ['0x%02x' % ord(c) for c in data]
323 default = '{%d, {%s}}' % (len(data), ','.join(data))
324 elif self.pbtype in ['FIXED32', 'UINT32']:
326 elif self.pbtype in ['FIXED64', 'UINT64']:
328 elif self.pbtype in ['SFIXED64', 'INT64']:
333 def default_decl(self, declaration_only = False):
334 '''Return definition for this field's default value.'''
335 if self.default is None:
339 default = self.get_initializer(False)
342 if self.pbtype == 'STRING':
343 if self.allocation != 'STATIC':
344 return None # Not implemented
345 array_decl = '[%d]' % self.max_size
346 elif self.pbtype == 'BYTES':
347 if self.allocation != 'STATIC':
348 return None # Not implemented
351 return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
353 return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
356 '''Return the #define for the tag number of this field.'''
357 identifier = '%s_%s_tag' % (self.struct_name, self.name)
358 return '#define %-40s %d\n' % (identifier, self.tag)
360 def pb_field_t(self, prev_field_name):
361 '''Return the pb_field_t initializer to use in the constant array.
362 prev_field_name is the name of the previous field or None.
364 result = ' PB_FIELD(%3d, ' % self.tag
365 result += '%-8s, ' % self.pbtype
366 result += '%s, ' % self.rules
367 result += '%-8s, ' % self.allocation
368 result += '%s, ' % ("FIRST" if not prev_field_name else "OTHER")
369 result += '%s, ' % self.struct_name
370 result += '%s, ' % self.name
371 result += '%s, ' % (prev_field_name or self.name)
373 if self.pbtype == 'MESSAGE':
374 result += '&%s_fields)' % self.submsgname
375 elif self.default is None:
377 elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
378 result += '0)' # Arbitrary size default values not implemented
379 elif self.rules == 'OPTEXT':
380 result += '0)' # Default value for extensions is not implemented
382 result += '&%s_default)' % (self.struct_name + self.name)
386 def largest_field_value(self):
387 '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
388 Returns numeric value or a C-expression for assert.'''
389 if self.pbtype == 'MESSAGE':
390 if self.rules == 'REPEATED' and self.allocation == 'STATIC':
391 return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
393 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
395 return max(self.tag, self.max_size, self.max_count)
397 def encoded_size(self, allmsgs):
398 '''Return the maximum size that this field can take when encoded,
399 including the field tag. If the size cannot be determined, returns
402 if self.allocation != 'STATIC':
405 if self.pbtype == 'MESSAGE':
407 if msg.name == self.submsgname:
408 encsize = msg.encoded_size(allmsgs)
410 return None # Submessage size is indeterminate
412 # Include submessage length prefix
413 encsize += varint_max_size(encsize.upperlimit())
416 # Submessage cannot be found, this currently occurs when
417 # the submessage type is defined in a different file.
418 # Instead of direct numeric value, reference the size that
419 # has been #defined in the other file.
420 encsize = EncodedSize(self.submsgname + 'size')
422 # We will have to make a conservative assumption on the length
423 # prefix size, though.
426 elif self.enc_size is None:
427 raise RuntimeError("Could not determine encoded size for %s.%s"
428 % (self.struct_name, self.name))
430 encsize = EncodedSize(self.enc_size)
432 encsize += varint_max_size(self.tag << 3) # Tag + wire type
434 if self.rules == 'REPEATED':
435 # Decoders must be always able to handle unpacked arrays.
436 # Therefore we have to reserve space for it, even though
437 # we emit packed arrays ourselves.
438 encsize *= self.max_count
443 class ExtensionRange(Field):
444 def __init__(self, struct_name, range_start, field_options):
445 '''Implements a special pb_extension_t* field in an extensible message
446 structure. The range_start signifies the index at which the extensions
447 start. Not necessarily all tags above this are extensions, it is merely
448 a speed optimization.
450 self.tag = range_start
451 self.struct_name = struct_name
452 self.name = 'extensions'
453 self.pbtype = 'EXTENSION'
454 self.rules = 'OPTIONAL'
455 self.allocation = 'CALLBACK'
456 self.ctype = 'pb_extension_t'
463 return ' pb_extension_t *extensions;'
471 def encoded_size(self, allmsgs):
472 # We exclude extensions from the count, because they cannot be known
473 # until runtime. Other option would be to return None here, but this
474 # way the value remains useful if extensions are not used.
475 return EncodedSize(0)
477 class ExtensionField(Field):
478 def __init__(self, struct_name, desc, field_options):
479 self.fullname = struct_name + desc.name
480 self.extendee_name = names_from_type_name(desc.extendee)
481 Field.__init__(self, self.fullname + 'struct', desc, field_options)
483 if self.rules != 'OPTIONAL':
487 self.rules = 'OPTEXT'
490 '''Return the #define for the tag number of this field.'''
491 identifier = '%s_tag' % self.fullname
492 return '#define %-40s %d\n' % (identifier, self.tag)
494 def extension_decl(self):
495 '''Declaration of the extension type in the .pb.h file'''
497 msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname
498 msg +=' type of extension fields is currently supported. */\n'
501 return 'extern const pb_extension_type_t %s;\n' % self.fullname
503 def extension_def(self):
504 '''Definition of the extension type in the .pb.c file'''
509 result = 'typedef struct {\n'
511 result += '\n} %s;\n\n' % self.struct_name
512 result += ('static const pb_field_t %s_field = \n %s;\n\n' %
513 (self.fullname, self.pb_field_t(None)))
514 result += 'const pb_extension_type_t %s = {\n' % self.fullname
517 result += ' &%s_field\n' % self.fullname
522 # ---------------------------------------------------------------------------
523 # Generation of messages (structures)
524 # ---------------------------------------------------------------------------
528 def __init__(self, names, desc, message_options):
533 field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
534 if field_options.type != nanopb_pb2.FT_IGNORE:
535 self.fields.append(Field(self.name, f, field_options))
537 if len(desc.extension_range) > 0:
538 field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
539 range_start = min([r.start for r in desc.extension_range])
540 if field_options.type != nanopb_pb2.FT_IGNORE:
541 self.fields.append(ExtensionRange(self.name, range_start, field_options))
543 self.packed = message_options.packed_struct
544 self.ordered_fields = self.fields[:]
545 self.ordered_fields.sort()
547 def get_dependencies(self):
548 '''Get list of type names that this structure refers to.'''
549 return [str(field.ctype) for field in self.fields if field.allocation == 'STATIC']
552 result = 'typedef struct _%s {\n' % self.name
554 if not self.ordered_fields:
555 # Empty structs are not allowed in C standard.
556 # Therefore add a dummy field if an empty message occurs.
557 result += ' uint8_t dummy_field;'
559 result += '\n'.join([str(f) for f in self.ordered_fields])
563 result += ' pb_packed'
565 result += ' %s;' % self.name
568 result = 'PB_PACKED_STRUCT_START\n' + result
569 result += '\nPB_PACKED_STRUCT_END'
575 for field in self.fields:
576 types = field.types()
577 if types is not None:
578 result += types + '\n'
581 def get_initializer(self, null_init):
582 if not self.ordered_fields:
586 for field in self.ordered_fields:
587 if field.allocation == 'STATIC':
588 if field.rules == 'REPEATED':
591 + ', '.join([field.get_initializer(null_init)] * field.max_count)
593 elif field.rules == 'OPTIONAL':
594 parts.append('false')
595 parts.append(field.get_initializer(null_init))
597 parts.append(field.get_initializer(null_init))
598 elif field.allocation == 'POINTER':
600 elif field.allocation == 'CALLBACK':
601 if field.pbtype == 'EXTENSION':
604 parts.append('{{NULL}, NULL}')
605 return '{' + ', '.join(parts) + '}'
607 def default_decl(self, declaration_only = False):
609 for field in self.fields:
610 default = field.default_decl(declaration_only)
611 if default is not None:
612 result += default + '\n'
615 def fields_declaration(self):
616 result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
619 def fields_definition(self):
620 result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
623 for field in self.ordered_fields:
624 result += field.pb_field_t(prev)
628 result += ' PB_LAST_FIELD\n};'
631 def encoded_size(self, allmsgs):
632 '''Return the maximum size that this message can take when encoded.
633 If the size cannot be determined, returns None.
635 size = EncodedSize(0)
636 for field in self.fields:
637 fsize = field.encoded_size(allmsgs)
645 # ---------------------------------------------------------------------------
646 # Processing of entire .proto files
647 # ---------------------------------------------------------------------------
650 def iterate_messages(desc, names = Names()):
651 '''Recursively find all messages. For each, yield name, DescriptorProto.'''
652 if hasattr(desc, 'message_type'):
653 submsgs = desc.message_type
655 submsgs = desc.nested_type
657 for submsg in submsgs:
658 sub_names = names + submsg.name
659 yield sub_names, submsg
661 for x in iterate_messages(submsg, sub_names):
664 def iterate_extensions(desc, names = Names()):
665 '''Recursively find all extensions.
666 For each, yield name, FieldDescriptorProto.
668 for extension in desc.extension:
669 yield names, extension
671 for subname, subdesc in iterate_messages(desc, names):
672 for extension in subdesc.extension:
673 yield subname, extension
675 def parse_file(fdesc, file_options):
676 '''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).'''
683 base_name = Names(fdesc.package.split('.'))
687 for enum in fdesc.enum_type:
688 enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
689 enums.append(Enum(base_name, enum, enum_options))
691 for names, message in iterate_messages(fdesc, base_name):
692 message_options = get_nanopb_suboptions(message, file_options, names)
694 if message_options.skip_message:
697 messages.append(Message(names, message, message_options))
698 for enum in message.enum_type:
699 enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
700 enums.append(Enum(names, enum, enum_options))
702 for names, extension in iterate_extensions(fdesc, base_name):
703 field_options = get_nanopb_suboptions(extension, file_options, names + extension.name)
704 if field_options.type != nanopb_pb2.FT_IGNORE:
705 extensions.append(ExtensionField(names, extension, field_options))
707 # Fix field default values where enum short names are used.
709 if not enum.options.long_names:
710 for message in messages:
711 for field in message.fields:
712 if field.default in enum.value_longnames:
713 idx = enum.value_longnames.index(field.default)
714 field.default = enum.values[idx][0]
716 return enums, messages, extensions
720 From http://code.activestate.com/recipes/577413-topological-sort/
721 This function is under the MIT license.
723 for k, v in data.items():
724 v.discard(k) # Ignore self dependencies
725 extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
726 data.update(dict([(item, set()) for item in extra_items_in_deps]))
728 ordered = set(item for item,dep in data.items() if not dep)
731 for item in sorted(ordered):
733 data = dict([(item, (dep - ordered)) for item,dep in data.items()
734 if item not in ordered])
735 assert not data, "A cyclic dependency exists amongst %r" % data
737 def sort_dependencies(messages):
738 '''Sort a list of Messages based on dependencies.'''
741 for message in messages:
742 dependencies[str(message.name)] = set(message.get_dependencies())
743 message_by_name[str(message.name)] = message
745 for msgname in toposort2(dependencies):
746 if msgname in message_by_name:
747 yield message_by_name[msgname]
749 def make_identifier(headername):
750 '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
752 for c in headername.upper():
759 def generate_header(dependencies, headername, enums, messages, extensions, options):
760 '''Generate content for a header file.
761 Generates strings, which should be concatenated and stored to file.
764 yield '/* Automatically generated nanopb header */\n'
765 if options.notimestamp:
766 yield '/* Generated by %s */\n\n' % (nanopb_version)
768 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
770 symbol = make_identifier(headername)
771 yield '#ifndef PB_%s_INCLUDED\n' % symbol
772 yield '#define PB_%s_INCLUDED\n' % symbol
774 yield options.libformat % ('pb.h')
776 # no %s specified - use whatever was passed in as options.libformat
777 yield options.libformat
780 for dependency in dependencies:
781 noext = os.path.splitext(dependency)[0]
782 yield options.genformat % (noext + options.extension + '.h')
785 yield '#if PB_PROTO_HEADER_VERSION != 30\n'
786 yield '#error Regenerate this file with the current version of nanopb generator.\n'
790 yield '#ifdef __cplusplus\n'
791 yield 'extern "C" {\n'
794 yield '/* Enum definitions */\n'
796 yield str(enum) + '\n\n'
798 yield '/* Struct definitions */\n'
799 for msg in sort_dependencies(messages):
801 yield str(msg) + '\n\n'
804 yield '/* Extensions */\n'
805 for extension in extensions:
806 yield extension.extension_decl()
809 yield '/* Default values for struct fields */\n'
811 yield msg.default_decl(True)
814 yield '/* Initializer values for message structs */\n'
816 identifier = '%s_init_default' % msg.name
817 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(False))
819 identifier = '%s_init_zero' % msg.name
820 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(True))
823 yield '/* Field tags (for use in manual encoding/decoding) */\n'
824 for msg in sort_dependencies(messages):
825 for field in msg.fields:
827 for extension in extensions:
828 yield extension.tags()
831 yield '/* Struct field encoding specification for nanopb */\n'
833 yield msg.fields_declaration() + '\n'
836 yield '/* Maximum encoded size of messages (where known) */\n'
838 msize = msg.encoded_size(messages)
839 if msize is not None:
840 identifier = '%s_size' % msg.name
841 yield '#define %-40s %s\n' % (identifier, msize)
844 yield '#ifdef __cplusplus\n'
845 yield '} /* extern "C" */\n'
851 def generate_source(headername, enums, messages, extensions, options):
852 '''Generate content for a source file.'''
854 yield '/* Automatically generated nanopb constant definitions */\n'
855 if options.notimestamp:
856 yield '/* Generated by %s */\n\n' % (nanopb_version)
858 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
859 yield options.genformat % (headername)
862 yield '#if PB_PROTO_HEADER_VERSION != 30\n'
863 yield '#error Regenerate this file with the current version of nanopb generator.\n'
868 yield msg.default_decl(False)
873 yield msg.fields_definition() + '\n\n'
875 for ext in extensions:
876 yield ext.extension_def() + '\n'
878 # Add checks for numeric limits
880 count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
881 largest_msg = max(messages, key = count_required_fields)
882 largest_count = count_required_fields(largest_msg)
883 if largest_count > 64:
884 yield '\n/* Check that missing required fields will be properly detected */\n'
885 yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
886 yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
887 yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
895 checks_msgnames.append(msg.name)
896 for field in msg.fields:
897 status = field.largest_field_value()
898 if isinstance(status, (str, unicode)):
899 checks.append(status)
902 worst_field = str(field.struct_name) + '.' + str(field.name)
904 if worst > 255 or checks:
905 yield '\n/* Check that field information fits in pb_field_t */\n'
907 if worst > 65535 or checks:
908 yield '#if !defined(PB_FIELD_32BIT)\n'
910 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
912 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
913 msgs = '_'.join(str(n) for n in checks_msgnames)
914 yield '/* If you get an error here, it means that you need to define PB_FIELD_32BIT\n'
915 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
917 yield ' * The reason you need to do this is that some of your messages contain tag\n'
918 yield ' * numbers or field sizes that are larger than what can fit in 8 or 16 bit\n'
919 yield ' * field descriptors.\n'
921 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
925 yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
927 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
929 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
930 msgs = '_'.join(str(n) for n in checks_msgnames)
931 yield '/* If you get an error here, it means that you need to define PB_FIELD_16BIT\n'
932 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
934 yield ' * The reason you need to do this is that some of your messages contain tag\n'
935 yield ' * numbers or field sizes that are larger than what can fit in the default\n'
936 yield ' * 8 bit descriptors.\n'
938 yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
941 # Add check for sizeof(double)
944 for field in msg.fields:
945 if field.ctype == 'double':
950 yield '/* On some platforms (such as AVR), double is really float.\n'
951 yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
952 yield ' * To get rid of this error, remove any double fields from your .proto.\n'
954 yield 'PB_STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
958 # ---------------------------------------------------------------------------
959 # Options parsing for the .proto files
960 # ---------------------------------------------------------------------------
962 from fnmatch import fnmatch
964 def read_options_file(infile):
965 '''Parse a separate options file to list:
966 [(namemask, options), ...]
971 if not line or line.startswith('//') or line.startswith('#'):
974 parts = line.split(None, 1)
975 opts = nanopb_pb2.NanoPBOptions()
976 text_format.Merge(parts[1], opts)
977 results.append((parts[0], opts))
982 '''Ugly global variables, should find a good way to pass these.'''
983 verbose_options = False
984 separate_options = []
985 matched_namemasks = set()
987 def get_nanopb_suboptions(subdesc, options, name):
988 '''Get copy of options, and merge information from subdesc.'''
989 new_options = nanopb_pb2.NanoPBOptions()
990 new_options.CopyFrom(options)
992 # Handle options defined in a separate file
993 dotname = '.'.join(name.parts)
994 for namemask, options in Globals.separate_options:
995 if fnmatch(dotname, namemask):
996 Globals.matched_namemasks.add(namemask)
997 new_options.MergeFrom(options)
999 # Handle options defined in .proto
1000 if isinstance(subdesc.options, descriptor.FieldOptions):
1001 ext_type = nanopb_pb2.nanopb
1002 elif isinstance(subdesc.options, descriptor.FileOptions):
1003 ext_type = nanopb_pb2.nanopb_fileopt
1004 elif isinstance(subdesc.options, descriptor.MessageOptions):
1005 ext_type = nanopb_pb2.nanopb_msgopt
1006 elif isinstance(subdesc.options, descriptor.EnumOptions):
1007 ext_type = nanopb_pb2.nanopb_enumopt
1009 raise Exception("Unknown options type")
1011 if subdesc.options.HasExtension(ext_type):
1012 ext = subdesc.options.Extensions[ext_type]
1013 new_options.MergeFrom(ext)
1015 if Globals.verbose_options:
1016 sys.stderr.write("Options for " + dotname + ": ")
1017 sys.stderr.write(text_format.MessageToString(new_options) + "\n")
1022 # ---------------------------------------------------------------------------
1023 # Command line interface
1024 # ---------------------------------------------------------------------------
1028 from optparse import OptionParser
1030 optparser = OptionParser(
1031 usage = "Usage: nanopb_generator.py [options] file.pb ...",
1032 epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
1033 "Output will be written to file.pb.h and file.pb.c.")
1034 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
1035 help="Exclude file from generated #include list.")
1036 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default=".pb",
1037 help="Set extension to use instead of '.pb' for generated files. [default: %default]")
1038 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
1039 help="Set name of a separate generator options file.")
1040 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
1041 metavar="FORMAT", default='#include "%s"\n',
1042 help="Set format string to use for including other .pb.h files. [default: %default]")
1043 optparser.add_option("-L", "--library-include-format", dest="libformat",
1044 metavar="FORMAT", default='#include <%s>\n',
1045 help="Set format string to use for including the nanopb pb.h header. [default: %default]")
1046 optparser.add_option("-T", "--no-timestamp", dest="notimestamp", action="store_true", default=False,
1047 help="Don't add timestamp to .pb.h and .pb.c preambles")
1048 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
1049 help="Don't print anything except errors.")
1050 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
1051 help="Print more information.")
1052 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
1053 help="Set generator option (max_size, max_count etc.).")
1055 def process_file(filename, fdesc, options):
1056 '''Process a single file.
1057 filename: The full path to the .proto or .pb source file, as string.
1058 fdesc: The loaded FileDescriptorSet, or None to read from the input file.
1059 options: Command line options as they come from OptionsParser.
1062 {'headername': Name of header file,
1063 'headerdata': Data for the .h header file,
1064 'sourcename': Name of the source code file,
1065 'sourcedata': Data for the .c source code file
1068 toplevel_options = nanopb_pb2.NanoPBOptions()
1069 for s in options.settings:
1070 text_format.Merge(s, toplevel_options)
1073 data = open(filename, 'rb').read()
1074 fdesc = descriptor.FileDescriptorSet.FromString(data).file[0]
1076 # Check if there is a separate .options file
1079 optfilename = options.options_file % os.path.splitext(filename)[0]
1081 # No %s specified, use the filename as-is
1082 optfilename = options.options_file
1085 if os.path.isfile(optfilename):
1087 sys.stderr.write('Reading options from ' + optfilename + '\n')
1089 Globals.separate_options = read_options_file(open(optfilename, "rU"))
1091 # If we are given a full filename and it does not exist, give an error.
1092 # However, don't give error when we automatically look for .options file
1093 # with the same name as .proto.
1094 if options.verbose or had_abspath:
1095 sys.stderr.write('Options file not found: ' + optfilename)
1097 Globals.separate_options = []
1099 Globals.matched_namemasks = set()
1102 file_options = get_nanopb_suboptions(fdesc, toplevel_options, Names([filename]))
1103 enums, messages, extensions = parse_file(fdesc, file_options)
1105 # Decide the file names
1106 noext = os.path.splitext(filename)[0]
1107 headername = noext + options.extension + '.h'
1108 sourcename = noext + options.extension + '.c'
1109 headerbasename = os.path.basename(headername)
1111 # List of .proto files that should not be included in the C header file
1112 # even if they are mentioned in the source .proto.
1113 excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
1114 dependencies = [d for d in fdesc.dependency if d not in excludes]
1116 headerdata = ''.join(generate_header(dependencies, headerbasename, enums,
1117 messages, extensions, options))
1119 sourcedata = ''.join(generate_source(headerbasename, enums,
1120 messages, extensions, options))
1122 # Check if there were any lines in .options that did not match a member
1123 unmatched = [n for n,o in Globals.separate_options if n not in Globals.matched_namemasks]
1124 if unmatched and not options.quiet:
1125 sys.stderr.write("Following patterns in " + optfilename + " did not match any fields: "
1126 + ', '.join(unmatched) + "\n")
1127 if not Globals.verbose_options:
1128 sys.stderr.write("Use protoc --nanopb-out=-v:. to see a list of the field names.\n")
1130 return {'headername': headername, 'headerdata': headerdata,
1131 'sourcename': sourcename, 'sourcedata': sourcedata}
1134 '''Main function when invoked directly from the command line.'''
1136 options, filenames = optparser.parse_args()
1139 optparser.print_help()
1143 options.verbose = False
1145 Globals.verbose_options = options.verbose
1147 for filename in filenames:
1148 results = process_file(filename, None, options)
1150 if not options.quiet:
1151 sys.stderr.write("Writing to " + results['headername'] + " and "
1152 + results['sourcename'] + "\n")
1154 open(results['headername'], 'w').write(results['headerdata'])
1155 open(results['sourcename'], 'w').write(results['sourcedata'])
1158 '''Main function when invoked as a protoc plugin.'''
1161 if sys.platform == "win32":
1163 # Set stdin and stdout to binary mode
1164 msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
1165 msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
1167 data = sys.stdin.read()
1168 request = plugin_pb2.CodeGeneratorRequest.FromString(data)
1171 args = shlex.split(request.parameter)
1172 options, dummy = optparser.parse_args(args)
1174 Globals.verbose_options = options.verbose
1176 response = plugin_pb2.CodeGeneratorResponse()
1178 for filename in request.file_to_generate:
1179 for fdesc in request.proto_file:
1180 if fdesc.name == filename:
1181 results = process_file(filename, fdesc, options)
1183 f = response.file.add()
1184 f.name = results['headername']
1185 f.content = results['headerdata']
1187 f = response.file.add()
1188 f.name = results['sourcename']
1189 f.content = results['sourcedata']
1191 sys.stdout.write(response.SerializeToString())
1193 if __name__ == '__main__':
1194 # Check if we are running as a plugin under protoc
1195 if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv: