1 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
2 nanopb_version = "nanopb-0.1.9"
5 import google.protobuf.descriptor_pb2 as descriptor
8 print "*************************************************************"
9 print "*** Could not import the Google protobuf Python libraries ***"
10 print "*** Try installing package 'python-protobuf' or similar. ***"
11 print "*************************************************************"
19 print "***************************************************************"
20 print "*** Could not import the precompiled nanopb_pb2.py. ***"
21 print "*** Run 'make' in the 'generator' folder to update the file.***"
22 print "***************************************************************"
31 # ---------------------------------------------------------------------------
32 # Generation of single fields
33 # ---------------------------------------------------------------------------
38 # Values are tuple (c type, pb ltype)
39 FieldD = descriptor.FieldDescriptorProto
41 FieldD.TYPE_BOOL: ('bool', 'PB_LTYPE_VARINT'),
42 FieldD.TYPE_DOUBLE: ('double', 'PB_LTYPE_FIXED64'),
43 FieldD.TYPE_FIXED32: ('uint32_t', 'PB_LTYPE_FIXED32'),
44 FieldD.TYPE_FIXED64: ('uint64_t', 'PB_LTYPE_FIXED64'),
45 FieldD.TYPE_FLOAT: ('float', 'PB_LTYPE_FIXED32'),
46 FieldD.TYPE_INT32: ('int32_t', 'PB_LTYPE_VARINT'),
47 FieldD.TYPE_INT64: ('int64_t', 'PB_LTYPE_VARINT'),
48 FieldD.TYPE_SFIXED32: ('int32_t', 'PB_LTYPE_FIXED32'),
49 FieldD.TYPE_SFIXED64: ('int64_t', 'PB_LTYPE_FIXED64'),
50 FieldD.TYPE_SINT32: ('int32_t', 'PB_LTYPE_SVARINT'),
51 FieldD.TYPE_SINT64: ('int64_t', 'PB_LTYPE_SVARINT'),
52 FieldD.TYPE_UINT32: ('uint32_t', 'PB_LTYPE_VARINT'),
53 FieldD.TYPE_UINT64: ('uint64_t', 'PB_LTYPE_VARINT')
57 '''Keeps a set of nested names and formats them to C identifier.
58 You can subclass this with your own implementation.
60 def __init__(self, parts = ()):
61 if isinstance(parts, Names):
63 self.parts = tuple(parts)
66 return '_'.join(self.parts)
68 def __add__(self, other):
69 if isinstance(other, (str, unicode)):
70 return Names(self.parts + (other,))
71 elif isinstance(other, tuple):
72 return Names(self.parts + other)
74 raise ValueError("Name parts should be of type str")
76 def __eq__(self, other):
77 return isinstance(other, Names) and self.parts == other.parts
79 def names_from_type_name(type_name):
80 '''Parse Names() from FieldDescriptorProto type_name'''
81 if type_name[0] != '.':
82 raise NotImplementedError("Lookup of non-absolute type names is not supported")
83 return Names(type_name[1:].split('.'))
86 def __init__(self, names, desc, enum_options):
87 '''desc is EnumDescriptorProto'''
89 self.options = enum_options
90 self.names = names + desc.name
92 if enum_options.long_names:
93 self.values = [(self.names + x.name, x.number) for x in desc.value]
95 self.values = [(names + x.name, x.number) for x in desc.value]
97 self.value_longnames = [self.names + x.name for x in desc.value]
100 result = 'typedef enum _%s {\n' % self.names
101 result += ',\n'.join([" %s = %d" % x for x in self.values])
102 result += '\n} %s;' % self.names
106 def __init__(self, struct_name, desc, field_options):
107 '''desc is FieldDescriptorProto'''
108 self.tag = desc.number
109 self.struct_name = struct_name
110 self.name = desc.name
113 self.max_count = None
116 # Parse field options
117 if field_options.HasField("max_size"):
118 self.max_size = field_options.max_size
120 if field_options.HasField("max_count"):
121 self.max_count = field_options.max_count
123 if desc.HasField('default_value'):
124 self.default = desc.default_value
127 # HTYPE is the high-order nibble of nanopb field description,
128 # defining whether value is required/optional/repeated.
130 if desc.label == FieldD.LABEL_REQUIRED:
131 self.htype = 'PB_HTYPE_REQUIRED'
132 elif desc.label == FieldD.LABEL_OPTIONAL:
133 self.htype = 'PB_HTYPE_OPTIONAL'
134 elif desc.label == FieldD.LABEL_REPEATED:
135 if self.max_count is None:
136 can_be_static = False
138 self.htype = 'PB_HTYPE_ARRAY'
139 self.array_decl = '[%d]' % self.max_count
141 raise NotImplementedError(desc.label)
143 # Decide LTYPE and CTYPE
144 # LTYPE is the low-order nibble of nanopb field description,
145 # defining how to decode an individual value.
146 # CTYPE is the name of the c type to use in the struct.
147 if datatypes.has_key(desc.type):
148 self.ctype, self.ltype = datatypes[desc.type]
149 elif desc.type == FieldD.TYPE_ENUM:
150 self.ltype = 'PB_LTYPE_VARINT'
151 self.ctype = names_from_type_name(desc.type_name)
152 if self.default is not None:
153 self.default = self.ctype + self.default
154 elif desc.type == FieldD.TYPE_STRING:
155 self.ltype = 'PB_LTYPE_STRING'
156 if self.max_size is None:
157 can_be_static = False
160 self.array_decl += '[%d]' % self.max_size
161 elif desc.type == FieldD.TYPE_BYTES:
162 self.ltype = 'PB_LTYPE_BYTES'
163 if self.max_size is None:
164 can_be_static = False
166 self.ctype = self.struct_name + self.name + 't'
167 elif desc.type == FieldD.TYPE_MESSAGE:
168 self.ltype = 'PB_LTYPE_SUBMESSAGE'
169 self.ctype = self.submsgname = names_from_type_name(desc.type_name)
171 raise NotImplementedError(desc.type)
173 if field_options.type == nanopb_pb2.FT_DEFAULT:
175 field_options.type = nanopb_pb2.FT_STATIC
177 field_options.type = nanopb_pb2.FT_CALLBACK
179 if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
180 raise Exception("Field %s is defined as static, but max_size or max_count is not given." % self.name)
182 if field_options.type == nanopb_pb2.FT_CALLBACK:
183 self.htype = 'PB_HTYPE_CALLBACK'
184 self.ctype = 'pb_callback_t'
187 def __cmp__(self, other):
188 return cmp(self.tag, other.tag)
191 if self.htype == 'PB_HTYPE_OPTIONAL':
192 result = ' bool has_' + self.name + ';\n'
193 elif self.htype == 'PB_HTYPE_ARRAY':
194 result = ' size_t ' + self.name + '_count;\n'
197 result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl)
201 '''Return definitions for any special types this field might need.'''
202 if self.ltype == 'PB_LTYPE_BYTES' and self.max_size is not None:
203 result = 'typedef struct {\n'
204 result += ' size_t size;\n'
205 result += ' uint8_t bytes[%d];\n' % self.max_size
206 result += '} %s;\n' % self.ctype
211 def default_decl(self, declaration_only = False):
212 '''Return definition for this field's default value.'''
213 if self.default is None:
216 if self.ltype == 'PB_LTYPE_STRING':
218 if self.max_size is None:
219 return None # Not implemented
221 array_decl = '[%d]' % (self.max_size + 1)
222 default = str(self.default).encode('string_escape')
223 default = default.replace('"', '\\"')
224 default = '"' + default + '"'
225 elif self.ltype == 'PB_LTYPE_BYTES':
226 data = self.default.decode('string_escape')
227 data = ['0x%02x' % ord(c) for c in data]
229 if self.max_size is None:
230 return None # Not implemented
234 default = '{%d, {%s}}' % (len(data), ','.join(data))
237 ctype, default = self.ctype, self.default
241 return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
243 return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
245 def pb_field_t(self, prev_field_name):
246 '''Return the pb_field_t initializer to use in the constant array.
247 prev_field_name is the name of the previous field or None.
249 result = ' {%d, ' % self.tag
250 result += '(pb_type_t) ((int) ' + self.htype
251 if self.ltype is not None:
252 result += ' | (int) ' + self.ltype
255 if prev_field_name is None:
256 result += ' offsetof(%s, %s),' % (self.struct_name, self.name)
258 result += ' pb_delta_end(%s, %s, %s),' % (self.struct_name, self.name, prev_field_name)
260 if self.htype == 'PB_HTYPE_OPTIONAL':
261 result += '\n pb_delta(%s, has_%s, %s),' % (self.struct_name, self.name, self.name)
262 elif self.htype == 'PB_HTYPE_ARRAY':
263 result += '\n pb_delta(%s, %s_count, %s),' % (self.struct_name, self.name, self.name)
268 if self.htype == 'PB_HTYPE_ARRAY':
269 result += '\n pb_membersize(%s, %s[0]),' % (self.struct_name, self.name)
270 result += ('\n pb_membersize(%s, %s) / pb_membersize(%s, %s[0]),'
271 % (self.struct_name, self.name, self.struct_name, self.name))
273 result += '\n pb_membersize(%s, %s),' % (self.struct_name, self.name)
276 if self.ltype == 'PB_LTYPE_SUBMESSAGE':
277 result += '\n &%s_fields}' % self.submsgname
278 elif self.default is None or self.htype == 'PB_HTYPE_CALLBACK':
281 result += '\n &%s_default}' % (self.struct_name + self.name)
285 def largest_field_value(self):
286 '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
287 Returns numeric value or a C-expression for assert.'''
288 if self.ltype == 'PB_LTYPE_SUBMESSAGE':
289 if self.htype == 'PB_HTYPE_ARRAY':
290 return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
292 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
294 return max(self.tag, self.max_size, self.max_count)
301 # ---------------------------------------------------------------------------
302 # Generation of messages (structures)
303 # ---------------------------------------------------------------------------
307 def __init__(self, names, desc, message_options):
312 field_options = get_nanopb_suboptions(f, message_options)
313 if field_options.type != nanopb_pb2.FT_IGNORE:
314 self.fields.append(Field(self.name, f, field_options))
316 self.packed = message_options.packed_struct
317 self.ordered_fields = self.fields[:]
318 self.ordered_fields.sort()
320 def get_dependencies(self):
321 '''Get list of type names that this structure refers to.'''
322 return [str(field.ctype) for field in self.fields]
325 result = 'typedef struct _%s {\n' % self.name
326 result += '\n'.join([str(f) for f in self.ordered_fields])
330 result += ' pb_packed'
332 result += ' %s;' % self.name
337 for field in self.fields:
338 types = field.types()
339 if types is not None:
340 result += types + '\n'
343 def default_decl(self, declaration_only = False):
345 for field in self.fields:
346 default = field.default_decl(declaration_only)
347 if default is not None:
348 result += default + '\n'
351 def fields_declaration(self):
352 result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
355 def fields_definition(self):
356 result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
359 for field in self.ordered_fields:
360 result += field.pb_field_t(prev)
364 result += ' PB_LAST_FIELD\n};'
372 # ---------------------------------------------------------------------------
373 # Processing of entire .proto files
374 # ---------------------------------------------------------------------------
377 def iterate_messages(desc, names = Names()):
378 '''Recursively find all messages. For each, yield name, DescriptorProto.'''
379 if hasattr(desc, 'message_type'):
380 submsgs = desc.message_type
382 submsgs = desc.nested_type
384 for submsg in submsgs:
385 sub_names = names + submsg.name
386 yield sub_names, submsg
388 for x in iterate_messages(submsg, sub_names):
391 def parse_file(fdesc, file_options):
392 '''Takes a FileDescriptorProto and returns tuple (enum, messages).'''
398 base_name = Names(fdesc.package.split('.'))
402 for enum in fdesc.enum_type:
403 enum_options = get_nanopb_suboptions(enum, file_options)
404 enums.append(Enum(base_name, enum, enum_options))
406 for names, message in iterate_messages(fdesc, base_name):
407 message_options = get_nanopb_suboptions(message, file_options)
408 messages.append(Message(names, message, message_options))
409 for enum in message.enum_type:
410 enum_options = get_nanopb_suboptions(enum, message_options)
411 enums.append(Enum(names, enum, enum_options))
413 # Fix field default values where enum short names are used.
415 if not enum.options.long_names:
416 for message in messages:
417 for field in message.fields:
418 if field.default in enum.value_longnames:
419 idx = enum.value_longnames.index(field.default)
420 field.default = enum.values[idx][0]
422 return enums, messages
426 From http://code.activestate.com/recipes/577413-topological-sort/
427 This function is under the MIT license.
429 for k, v in data.items():
430 v.discard(k) # Ignore self dependencies
431 extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
432 data.update(dict([(item, set()) for item in extra_items_in_deps]))
434 ordered = set(item for item,dep in data.items() if not dep)
437 for item in sorted(ordered):
439 data = dict([(item, (dep - ordered)) for item,dep in data.items()
440 if item not in ordered])
441 assert not data, "A cyclic dependency exists amongst %r" % data
443 def sort_dependencies(messages):
444 '''Sort a list of Messages based on dependencies.'''
447 for message in messages:
448 dependencies[str(message.name)] = set(message.get_dependencies())
449 message_by_name[str(message.name)] = message
451 for msgname in toposort2(dependencies):
452 if msgname in message_by_name:
453 yield message_by_name[msgname]
455 def make_identifier(headername):
456 '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
458 for c in headername.upper():
465 def generate_header(dependencies, headername, enums, messages):
466 '''Generate content for a header file.
467 Generates strings, which should be concatenated and stored to file.
470 yield '/* Automatically generated nanopb header */\n'
471 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
473 symbol = make_identifier(headername)
474 yield '#ifndef _PB_%s_\n' % symbol
475 yield '#define _PB_%s_\n' % symbol
476 yield '#include <pb.h>\n\n'
478 for dependency in dependencies:
479 noext = os.path.splitext(dependency)[0]
480 yield '#include "%s.pb.h"\n' % noext
482 yield '#ifdef __cplusplus\n'
483 yield 'extern "C" {\n'
486 yield '/* Enum definitions */\n'
488 yield str(enum) + '\n\n'
490 yield '/* Struct definitions */\n'
491 for msg in sort_dependencies(messages):
493 yield str(msg) + '\n\n'
495 yield '/* Default values for struct fields */\n'
497 yield msg.default_decl(True)
500 yield '/* Struct field encoding specification for nanopb */\n'
502 yield msg.fields_declaration() + '\n'
505 count_required_fields = lambda m: len([f for f in msg.fields if f.htype == 'PB_HTYPE_REQUIRED'])
506 largest_msg = max(messages, key = count_required_fields)
507 largest_count = count_required_fields(largest_msg)
508 if largest_count > 64:
509 yield '\n/* Check that missing required fields will be properly detected */\n'
510 yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
511 yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
512 yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
515 # Add checks for numeric limits
521 checks_msgnames.append(msg.name)
522 for field in msg.fields:
523 status = field.largest_field_value()
524 if isinstance(status, (str, unicode)):
525 checks.append(status)
528 worst_field = str(field.struct_name) + '.' + str(field.name)
530 if worst > 255 or checks:
531 yield '\n/* Check that field information fits in pb_field_t */\n'
534 yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
536 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
538 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
539 msgs = '_'.join(str(n) for n in checks_msgnames)
540 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
543 if worst > 65535 or checks:
544 yield '#if !defined(PB_FIELD_32BIT)\n'
546 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
548 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
549 msgs = '_'.join(str(n) for n in checks_msgnames)
550 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
553 # Add check for sizeof(double)
556 for field in msg.fields:
557 if field.ctype == 'double':
562 yield '/* On some platforms (such as AVR), double is really float.\n'
563 yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
565 yield 'STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
567 yield '\n#ifdef __cplusplus\n'
568 yield '} /* extern "C" */\n'
574 def generate_source(headername, enums, messages):
575 '''Generate content for a source file.'''
577 yield '/* Automatically generated nanopb constant definitions */\n'
578 yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
579 yield '#include "%s"\n\n' % headername
582 yield msg.default_decl(False)
587 yield msg.fields_definition() + '\n\n'
591 # ---------------------------------------------------------------------------
592 # Command line interface
593 # ---------------------------------------------------------------------------
597 from optparse import OptionParser
598 import google.protobuf.text_format as text_format
600 optparser = OptionParser(
601 usage = "Usage: nanopb_generator.py [options] file.pb ...",
602 epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
603 "Output will be written to file.pb.h and file.pb.c.")
604 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
605 help="Exclude file from generated #include list.")
606 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
607 help="Don't print anything except errors.")
608 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
609 help="Print more information.")
610 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
611 help="Set generator option (max_size, max_count etc.).")
613 def get_nanopb_suboptions(subdesc, options):
614 '''Get copy of options, and merge information from subdesc.'''
615 new_options = nanopb_pb2.NanoPBOptions()
616 new_options.CopyFrom(options)
618 if isinstance(subdesc.options, descriptor.FieldOptions):
619 ext_type = nanopb_pb2.nanopb
620 elif isinstance(subdesc.options, descriptor.FileOptions):
621 ext_type = nanopb_pb2.nanopb_fileopt
622 elif isinstance(subdesc.options, descriptor.MessageOptions):
623 ext_type = nanopb_pb2.nanopb_msgopt
624 elif isinstance(subdesc.options, descriptor.EnumOptions):
625 ext_type = nanopb_pb2.nanopb_enumopt
627 raise Exception("Unknown options type")
629 if subdesc.options.HasExtension(ext_type):
630 ext = subdesc.options.Extensions[ext_type]
631 new_options.MergeFrom(ext)
635 def process(filenames, options):
636 '''Process the files given on the command line.'''
639 optparser.print_help()
643 options.verbose = False
645 toplevel_options = nanopb_pb2.NanoPBOptions()
646 for s in options.settings:
647 text_format.Merge(s, toplevel_options)
649 for filename in filenames:
650 data = open(filename, 'rb').read()
651 fdesc = descriptor.FileDescriptorSet.FromString(data)
653 file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options)
656 print "Options for " + filename + ":"
657 print text_format.MessageToString(file_options)
659 enums, messages = parse_file(fdesc.file[0], file_options)
661 noext = os.path.splitext(filename)[0]
662 headername = noext + '.pb.h'
663 sourcename = noext + '.pb.c'
664 headerbasename = os.path.basename(headername)
666 if not options.quiet:
667 print "Writing to " + headername + " and " + sourcename
669 # List of .proto files that should not be included in the C header file
670 # even if they are mentioned in the source .proto.
671 excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
672 dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
674 header = open(headername, 'w')
675 for part in generate_header(dependencies, headerbasename, enums, messages):
678 source = open(sourcename, 'w')
679 for part in generate_source(headerbasename, enums, messages):
684 if __name__ == '__main__':
685 options, filenames = optparser.parse_args()
686 status = process(filenames, options)