3 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
4 nanopb_version = "nanopb-0.3.0-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 += ' 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 += ' 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 struct {\n'
288 result += ' size_t size;\n'
289 result += ' uint8_t bytes[%d];\n' % self.max_size
290 result += '} %s;\n' % self.ctype
295 def get_initializer(self, null_init):
296 '''Return literal expression for this field's default value.'''
298 if self.pbtype == 'MESSAGE':
300 return '%s_init_zero' % self.ctype
302 return '%s_init_default' % self.ctype
304 if self.default is None or null_init:
305 if self.pbtype == 'STRING':
307 elif self.pbtype == 'BYTES':
309 elif self.pbtype == 'ENUM':
310 return '(%s)0' % self.ctype
314 default = str(self.default)
316 if self.pbtype == 'STRING':
317 default = default.encode('utf-8').encode('string_escape')
318 default = default.replace('"', '\\"')
319 default = '"' + default + '"'
320 elif self.pbtype == 'BYTES':
321 data = default.decode('string_escape')
322 data = ['0x%02x' % ord(c) for c in data]
326 default = '{%d, {%s}}' % (len(data), ','.join(data))
327 elif self.pbtype in ['FIXED32', 'UINT32']:
329 elif self.pbtype in ['FIXED64', 'UINT64']:
331 elif self.pbtype in ['SFIXED64', 'INT64']:
336 def default_decl(self, declaration_only = False):
337 '''Return definition for this field's default value.'''
338 if self.default is None:
342 default = self.get_initializer(False)
345 if self.pbtype == 'STRING':
346 if self.allocation != 'STATIC':
347 return None # Not implemented
348 array_decl = '[%d]' % self.max_size
349 elif self.pbtype == 'BYTES':
350 if self.allocation != 'STATIC':
351 return None # Not implemented
354 return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
356 return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
359 '''Return the #define for the tag number of this field.'''
360 identifier = '%s_%s_tag' % (self.struct_name, self.name)
361 return '#define %-40s %d\n' % (identifier, self.tag)
363 def pb_field_t(self, prev_field_name):
364 '''Return the pb_field_t initializer to use in the constant array.
365 prev_field_name is the name of the previous field or None.
367 result = ' PB_FIELD2(%3d, ' % self.tag
368 result += '%-8s, ' % self.pbtype
369 result += '%s, ' % self.rules
370 result += '%-8s, ' % self.allocation
371 result += '%s, ' % ("FIRST" if not prev_field_name else "OTHER")
372 result += '%s, ' % self.struct_name
373 result += '%s, ' % self.name
374 result += '%s, ' % (prev_field_name or self.name)
376 if self.pbtype == 'MESSAGE':
377 result += '&%s_fields)' % self.submsgname
378 elif self.default is None:
380 elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
381 result += '0)' # Arbitrary size default values not implemented
382 elif self.rules == 'OPTEXT':
383 result += '0)' # Default value for extensions is not implemented
385 result += '&%s_default)' % (self.struct_name + self.name)
389 def largest_field_value(self):
390 '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
391 Returns numeric value or a C-expression for assert.'''
392 if self.pbtype == 'MESSAGE':
393 if self.rules == 'REPEATED' and self.allocation == 'STATIC':
394 return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
396 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
398 return max(self.tag, self.max_size, self.max_count)
400 def encoded_size(self, allmsgs):
401 '''Return the maximum size that this field can take when encoded,
402 including the field tag. If the size cannot be determined, returns
405 if self.allocation != 'STATIC':
408 if self.pbtype == 'MESSAGE':
410 if msg.name == self.submsgname:
411 encsize = msg.encoded_size(allmsgs)
413 return None # Submessage size is indeterminate
415 # Include submessage length prefix
416 encsize += varint_max_size(encsize.upperlimit())
419 # Submessage cannot be found, this currently occurs when
420 # the submessage type is defined in a different file.
421 # Instead of direct numeric value, reference the size that
422 # has been #defined in the other file.
423 encsize = EncodedSize(self.submsgname + 'size')
425 # We will have to make a conservative assumption on the length
426 # prefix size, though.
429 elif self.enc_size is None:
430 raise RuntimeError("Could not determine encoded size for %s.%s"
431 % (self.struct_name, self.name))
433 encsize = EncodedSize(self.enc_size)
435 encsize += varint_max_size(self.tag << 3) # Tag + wire type
437 if self.rules == 'REPEATED':
438 # Decoders must be always able to handle unpacked arrays.
439 # Therefore we have to reserve space for it, even though
440 # we emit packed arrays ourselves.
441 encsize *= self.max_count
446 class ExtensionRange(Field):
447 def __init__(self, struct_name, range_start, field_options):
448 '''Implements a special pb_extension_t* field in an extensible message
449 structure. The range_start signifies the index at which the extensions
450 start. Not necessarily all tags above this are extensions, it is merely
451 a speed optimization.
453 self.tag = range_start
454 self.struct_name = struct_name
455 self.name = 'extensions'
456 self.pbtype = 'EXTENSION'
457 self.rules = 'OPTIONAL'
458 self.allocation = 'CALLBACK'
459 self.ctype = 'pb_extension_t'
466 return ' pb_extension_t *extensions;'
474 def encoded_size(self, allmsgs):
475 # We exclude extensions from the count, because they cannot be known
476 # until runtime. Other option would be to return None here, but this
477 # way the value remains useful if extensions are not used.
478 return EncodedSize(0)
480 class ExtensionField(Field):
481 def __init__(self, struct_name, desc, field_options):
482 self.fullname = struct_name + desc.name
483 self.extendee_name = names_from_type_name(desc.extendee)
484 Field.__init__(self, self.fullname + 'struct', desc, field_options)
486 if self.rules != 'OPTIONAL':
490 self.rules = 'OPTEXT'
493 '''Return the #define for the tag number of this field.'''
494 identifier = '%s_tag' % self.fullname
495 return '#define %-40s %d\n' % (identifier, self.tag)
497 def extension_decl(self):
498 '''Declaration of the extension type in the .pb.h file'''
500 msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname
501 msg +=' type of extension fields is currently supported. */\n'
504 return 'extern const pb_extension_type_t %s;\n' % self.fullname
506 def extension_def(self):
507 '''Definition of the extension type in the .pb.c file'''
512 result = 'typedef struct {\n'
514 result += '\n} %s;\n\n' % self.struct_name
515 result += ('static const pb_field_t %s_field = \n %s;\n\n' %
516 (self.fullname, self.pb_field_t(None)))
517 result += 'const pb_extension_type_t %s = {\n' % self.fullname
520 result += ' &%s_field\n' % self.fullname
525 # ---------------------------------------------------------------------------
526 # Generation of messages (structures)
527 # ---------------------------------------------------------------------------
531 def __init__(self, names, desc, message_options):
536 field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
537 if field_options.type != nanopb_pb2.FT_IGNORE:
538 self.fields.append(Field(self.name, f, field_options))
540 if len(desc.extension_range) > 0:
541 field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
542 range_start = min([r.start for r in desc.extension_range])
543 if field_options.type != nanopb_pb2.FT_IGNORE:
544 self.fields.append(ExtensionRange(self.name, range_start, field_options))
546 self.packed = message_options.packed_struct
547 self.ordered_fields = self.fields[:]
548 self.ordered_fields.sort()
550 def get_dependencies(self):
551 '''Get list of type names that this structure refers to.'''
552 return [str(field.ctype) for field in self.fields]
555 result = 'typedef struct _%s {\n' % self.name
557 if not self.ordered_fields:
558 # Empty structs are not allowed in C standard.
559 # Therefore add a dummy field if an empty message occurs.
560 result += ' uint8_t dummy_field;'
562 result += '\n'.join([str(f) for f in self.ordered_fields])
566 result += ' pb_packed'
568 result += ' %s;' % self.name
571 result = 'PB_PACKED_STRUCT_START\n' + result
572 result += '\nPB_PACKED_STRUCT_END'
578 for field in self.fields:
579 types = field.types()
580 if types is not None:
581 result += types + '\n'
584 def get_initializer(self, null_init):
585 if not self.ordered_fields:
589 for field in self.ordered_fields:
590 if field.allocation == 'STATIC':
591 if field.rules == 'REPEATED':
594 + ', '.join([field.get_initializer(null_init)] * field.max_count)
596 elif field.rules == 'OPTIONAL':
597 parts.append('false')
598 parts.append(field.get_initializer(null_init))
600 parts.append(field.get_initializer(null_init))
601 elif field.allocation == 'POINTER':
603 elif field.allocation == 'CALLBACK':
604 if field.pbtype == 'EXTENSION':
607 parts.append('{{NULL}, NULL}')
608 return '{' + ', '.join(parts) + '}'
610 def default_decl(self, declaration_only = False):
612 for field in self.fields:
613 default = field.default_decl(declaration_only)
614 if default is not None:
615 result += default + '\n'
618 def fields_declaration(self):
619 result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
622 def fields_definition(self):
623 result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
626 for field in self.ordered_fields:
627 result += field.pb_field_t(prev)
631 result += ' PB_LAST_FIELD\n};'
634 def encoded_size(self, allmsgs):
635 '''Return the maximum size that this message can take when encoded.
636 If the size cannot be determined, returns None.
638 size = EncodedSize(0)
639 for field in self.fields:
640 fsize = field.encoded_size(allmsgs)
648 # ---------------------------------------------------------------------------
649 # Processing of entire .proto files
650 # ---------------------------------------------------------------------------
653 def iterate_messages(desc, names = Names()):
654 '''Recursively find all messages. For each, yield name, DescriptorProto.'''
655 if hasattr(desc, 'message_type'):
656 submsgs = desc.message_type
658 submsgs = desc.nested_type
660 for submsg in submsgs:
661 sub_names = names + submsg.name
662 yield sub_names, submsg
664 for x in iterate_messages(submsg, sub_names):
667 def iterate_extensions(desc, names = Names()):
668 '''Recursively find all extensions.
669 For each, yield name, FieldDescriptorProto.
671 for extension in desc.extension:
672 yield names, extension
674 for subname, subdesc in iterate_messages(desc, names):
675 for extension in subdesc.extension:
676 yield subname, extension
678 def parse_file(fdesc, file_options):
679 '''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).'''
686 base_name = Names(fdesc.package.split('.'))
690 for enum in fdesc.enum_type:
691 enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name)
692 enums.append(Enum(base_name, enum, enum_options))
694 for names, message in iterate_messages(fdesc, base_name):
695 message_options = get_nanopb_suboptions(message, file_options, names)
697 if message_options.skip_message:
700 messages.append(Message(names, message, message_options))
701 for enum in message.enum_type:
702 enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
703 enums.append(Enum(names, enum, enum_options))
705 for names, extension in iterate_extensions(fdesc, base_name):
706 field_options = get_nanopb_suboptions(extension, file_options, names + extension.name)
707 if field_options.type != nanopb_pb2.FT_IGNORE:
708 extensions.append(ExtensionField(names, extension, field_options))
710 # Fix field default values where enum short names are used.
712 if not enum.options.long_names:
713 for message in messages:
714 for field in message.fields:
715 if field.default in enum.value_longnames:
716 idx = enum.value_longnames.index(field.default)
717 field.default = enum.values[idx][0]
719 return enums, messages, extensions
723 From http://code.activestate.com/recipes/577413-topological-sort/
724 This function is under the MIT license.
726 for k, v in data.items():
727 v.discard(k) # Ignore self dependencies
728 extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
729 data.update(dict([(item, set()) for item in extra_items_in_deps]))
731 ordered = set(item for item,dep in data.items() if not dep)
734 for item in sorted(ordered):
736 data = dict([(item, (dep - ordered)) for item,dep in data.items()
737 if item not in ordered])
738 assert not data, "A cyclic dependency exists amongst %r" % data
740 def sort_dependencies(messages):
741 '''Sort a list of Messages based on dependencies.'''
744 for message in messages:
745 dependencies[str(message.name)] = set(message.get_dependencies())
746 message_by_name[str(message.name)] = message
748 for msgname in toposort2(dependencies):
749 if msgname in message_by_name:
750 yield message_by_name[msgname]
752 def make_identifier(headername):
753 '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
755 for c in headername.upper():
762 def generate_header(dependencies, headername, enums, messages, extensions, options):
763 '''Generate content for a header file.
764 Generates strings, which should be concatenated and stored to file.
767 yield '/* Automatically generated nanopb header */\n'
768 if options.notimestamp:
769 yield '/* Generated by %s */\n\n' % (nanopb_version)
771 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
773 symbol = make_identifier(headername)
774 yield '#ifndef _PB_%s_\n' % symbol
775 yield '#define _PB_%s_\n' % symbol
777 yield options.libformat % ('pb.h')
779 # no %s specified - use whatever was passed in as options.libformat
780 yield options.libformat
783 for dependency in dependencies:
784 noext = os.path.splitext(dependency)[0]
785 yield options.genformat % (noext + options.extension + '.h')
788 yield '#ifdef __cplusplus\n'
789 yield 'extern "C" {\n'
792 yield '/* Enum definitions */\n'
794 yield str(enum) + '\n\n'
796 yield '/* Struct definitions */\n'
797 for msg in sort_dependencies(messages):
799 yield str(msg) + '\n\n'
802 yield '/* Extensions */\n'
803 for extension in extensions:
804 yield extension.extension_decl()
807 yield '/* Default values for struct fields */\n'
809 yield msg.default_decl(True)
812 yield '/* Initializer values for message structs */\n'
814 identifier = '%s_init_default' % msg.name
815 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(False))
817 identifier = '%s_init_zero' % msg.name
818 yield '#define %-40s %s\n' % (identifier, msg.get_initializer(True))
821 yield '/* Field tags (for use in manual encoding/decoding) */\n'
822 for msg in sort_dependencies(messages):
823 for field in msg.fields:
825 for extension in extensions:
826 yield extension.tags()
829 yield '/* Struct field encoding specification for nanopb */\n'
831 yield msg.fields_declaration() + '\n'
834 yield '/* Maximum encoded size of messages (where known) */\n'
836 msize = msg.encoded_size(messages)
837 if msize is not None:
838 identifier = '%s_size' % msg.name
839 yield '#define %-40s %s\n' % (identifier, msize)
842 yield '#ifdef __cplusplus\n'
843 yield '} /* extern "C" */\n'
849 def generate_source(headername, enums, messages, extensions, options):
850 '''Generate content for a source file.'''
852 yield '/* Automatically generated nanopb constant definitions */\n'
853 if options.notimestamp:
854 yield '/* Generated by %s */\n\n' % (nanopb_version)
856 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
857 yield options.genformat % (headername)
861 yield msg.default_decl(False)
866 yield msg.fields_definition() + '\n\n'
868 for ext in extensions:
869 yield ext.extension_def() + '\n'
871 # Add checks for numeric limits
873 count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
874 largest_msg = max(messages, key = count_required_fields)
875 largest_count = count_required_fields(largest_msg)
876 if largest_count > 64:
877 yield '\n/* Check that missing required fields will be properly detected */\n'
878 yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
879 yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
880 yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
888 checks_msgnames.append(msg.name)
889 for field in msg.fields:
890 status = field.largest_field_value()
891 if isinstance(status, (str, unicode)):
892 checks.append(status)
895 worst_field = str(field.struct_name) + '.' + str(field.name)
897 if worst > 255 or checks:
898 yield '\n/* Check that field information fits in pb_field_t */\n'
900 if worst > 65535 or checks:
901 yield '#if !defined(PB_FIELD_32BIT)\n'
903 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
905 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
906 msgs = '_'.join(str(n) for n in checks_msgnames)
907 yield '/* If you get an error here, it means that you need to define PB_FIELD_32BIT\n'
908 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
910 yield ' * The reason you need to do this is that some of your messages contain tag\n'
911 yield ' * numbers or field sizes that are larger than what can fit in 8 or 16 bit\n'
912 yield ' * field descriptors.\n'
914 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
918 yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
920 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
922 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
923 msgs = '_'.join(str(n) for n in checks_msgnames)
924 yield '/* If you get an error here, it means that you need to define PB_FIELD_16BIT\n'
925 yield ' * compile-time option. You can do that in pb.h or on compiler command line.\n'
927 yield ' * The reason you need to do this is that some of your messages contain tag\n'
928 yield ' * numbers or field sizes that are larger than what can fit in the default\n'
929 yield ' * 8 bit descriptors.\n'
931 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
934 # Add check for sizeof(double)
937 for field in msg.fields:
938 if field.ctype == 'double':
943 yield '/* On some platforms (such as AVR), double is really float.\n'
944 yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
945 yield ' * To get rid of this error, remove any double fields from your .proto.\n'
947 yield 'STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
951 # ---------------------------------------------------------------------------
952 # Options parsing for the .proto files
953 # ---------------------------------------------------------------------------
955 from fnmatch import fnmatch
957 def read_options_file(infile):
958 '''Parse a separate options file to list:
959 [(namemask, options), ...]
964 if not line or line.startswith('//') or line.startswith('#'):
967 parts = line.split(None, 1)
968 opts = nanopb_pb2.NanoPBOptions()
969 text_format.Merge(parts[1], opts)
970 results.append((parts[0], opts))
975 '''Ugly global variables, should find a good way to pass these.'''
976 verbose_options = False
977 separate_options = []
978 matched_namemasks = set()
980 def get_nanopb_suboptions(subdesc, options, name):
981 '''Get copy of options, and merge information from subdesc.'''
982 new_options = nanopb_pb2.NanoPBOptions()
983 new_options.CopyFrom(options)
985 # Handle options defined in a separate file
986 dotname = '.'.join(name.parts)
987 for namemask, options in Globals.separate_options:
988 if fnmatch(dotname, namemask):
989 Globals.matched_namemasks.add(namemask)
990 new_options.MergeFrom(options)
992 # Handle options defined in .proto
993 if isinstance(subdesc.options, descriptor.FieldOptions):
994 ext_type = nanopb_pb2.nanopb
995 elif isinstance(subdesc.options, descriptor.FileOptions):
996 ext_type = nanopb_pb2.nanopb_fileopt
997 elif isinstance(subdesc.options, descriptor.MessageOptions):
998 ext_type = nanopb_pb2.nanopb_msgopt
999 elif isinstance(subdesc.options, descriptor.EnumOptions):
1000 ext_type = nanopb_pb2.nanopb_enumopt
1002 raise Exception("Unknown options type")
1004 if subdesc.options.HasExtension(ext_type):
1005 ext = subdesc.options.Extensions[ext_type]
1006 new_options.MergeFrom(ext)
1008 if Globals.verbose_options:
1009 sys.stderr.write("Options for " + dotname + ": ")
1010 sys.stderr.write(text_format.MessageToString(new_options) + "\n")
1015 # ---------------------------------------------------------------------------
1016 # Command line interface
1017 # ---------------------------------------------------------------------------
1021 from optparse import OptionParser
1023 optparser = OptionParser(
1024 usage = "Usage: nanopb_generator.py [options] file.pb ...",
1025 epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
1026 "Output will be written to file.pb.h and file.pb.c.")
1027 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
1028 help="Exclude file from generated #include list.")
1029 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default=".pb",
1030 help="Set extension to use instead of '.pb' for generated files. [default: %default]")
1031 optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
1032 help="Set name of a separate generator options file.")
1033 optparser.add_option("-Q", "--generated-include-format", dest="genformat",
1034 metavar="FORMAT", default='#include "%s"\n',
1035 help="Set format string to use for including other .pb.h files. [default: %default]")
1036 optparser.add_option("-L", "--library-include-format", dest="libformat",
1037 metavar="FORMAT", default='#include <%s>\n',
1038 help="Set format string to use for including the nanopb pb.h header. [default: %default]")
1039 optparser.add_option("-T", "--no-timestamp", dest="notimestamp", action="store_true", default=False,
1040 help="Don't add timestamp to .pb.h and .pb.c preambles")
1041 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
1042 help="Don't print anything except errors.")
1043 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
1044 help="Print more information.")
1045 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
1046 help="Set generator option (max_size, max_count etc.).")
1048 def process_file(filename, fdesc, options):
1049 '''Process a single file.
1050 filename: The full path to the .proto or .pb source file, as string.
1051 fdesc: The loaded FileDescriptorSet, or None to read from the input file.
1052 options: Command line options as they come from OptionsParser.
1055 {'headername': Name of header file,
1056 'headerdata': Data for the .h header file,
1057 'sourcename': Name of the source code file,
1058 'sourcedata': Data for the .c source code file
1061 toplevel_options = nanopb_pb2.NanoPBOptions()
1062 for s in options.settings:
1063 text_format.Merge(s, toplevel_options)
1066 data = open(filename, 'rb').read()
1067 fdesc = descriptor.FileDescriptorSet.FromString(data).file[0]
1069 # Check if there is a separate .options file
1072 optfilename = options.options_file % os.path.splitext(filename)[0]
1074 # No %s specified, use the filename as-is
1075 optfilename = options.options_file
1078 if os.path.isfile(optfilename):
1080 sys.stderr.write('Reading options from ' + optfilename + '\n')
1082 Globals.separate_options = read_options_file(open(optfilename, "rU"))
1084 # If we are given a full filename and it does not exist, give an error.
1085 # However, don't give error when we automatically look for .options file
1086 # with the same name as .proto.
1087 if options.verbose or had_abspath:
1088 sys.stderr.write('Options file not found: ' + optfilename)
1090 Globals.separate_options = []
1092 Globals.matched_namemasks = set()
1095 file_options = get_nanopb_suboptions(fdesc, toplevel_options, Names([filename]))
1096 enums, messages, extensions = parse_file(fdesc, file_options)
1098 # Decide the file names
1099 noext = os.path.splitext(filename)[0]
1100 headername = noext + options.extension + '.h'
1101 sourcename = noext + options.extension + '.c'
1102 headerbasename = os.path.basename(headername)
1104 # List of .proto files that should not be included in the C header file
1105 # even if they are mentioned in the source .proto.
1106 excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
1107 dependencies = [d for d in fdesc.dependency if d not in excludes]
1109 headerdata = ''.join(generate_header(dependencies, headerbasename, enums,
1110 messages, extensions, options))
1112 sourcedata = ''.join(generate_source(headerbasename, enums,
1113 messages, extensions, options))
1115 # Check if there were any lines in .options that did not match a member
1116 unmatched = [n for n,o in Globals.separate_options if n not in Globals.matched_namemasks]
1117 if unmatched and not options.quiet:
1118 sys.stderr.write("Following patterns in " + optfilename + " did not match any fields: "
1119 + ', '.join(unmatched) + "\n")
1120 if not Globals.verbose_options:
1121 sys.stderr.write("Use protoc --nanopb-out=-v:. to see a list of the field names.\n")
1123 return {'headername': headername, 'headerdata': headerdata,
1124 'sourcename': sourcename, 'sourcedata': sourcedata}
1127 '''Main function when invoked directly from the command line.'''
1129 options, filenames = optparser.parse_args()
1132 optparser.print_help()
1136 options.verbose = False
1138 Globals.verbose_options = options.verbose
1140 for filename in filenames:
1141 results = process_file(filename, None, options)
1143 if not options.quiet:
1144 sys.stderr.write("Writing to " + results['headername'] + " and "
1145 + results['sourcename'] + "\n")
1147 open(results['headername'], 'w').write(results['headerdata'])
1148 open(results['sourcename'], 'w').write(results['sourcedata'])
1151 '''Main function when invoked as a protoc plugin.'''
1154 if sys.platform == "win32":
1156 # Set stdin and stdout to binary mode
1157 msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
1158 msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
1160 data = sys.stdin.read()
1161 request = plugin_pb2.CodeGeneratorRequest.FromString(data)
1164 args = shlex.split(request.parameter)
1165 options, dummy = optparser.parse_args(args)
1167 Globals.verbose_options = options.verbose
1169 response = plugin_pb2.CodeGeneratorResponse()
1171 for filename in request.file_to_generate:
1172 for fdesc in request.proto_file:
1173 if fdesc.name == filename:
1174 results = process_file(filename, fdesc, options)
1176 f = response.file.add()
1177 f.name = results['headername']
1178 f.content = results['headerdata']
1180 f = response.file.add()
1181 f.name = results['sourcename']
1182 f.content = results['sourcedata']
1184 sys.stdout.write(response.SerializeToString())
1186 if __name__ == '__main__':
1187 # Check if we are running as a plugin under protoc
1188 if 'protoc-gen-' in sys.argv[0] or '--protoc-plugin' in sys.argv: