Add --extension option to generator.
[apps/agl-service-can-low-level.git] / generator / nanopb_generator.py
1 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
2 nanopb_version = "0.2.0-dev"
3
4 try:
5     import google.protobuf.descriptor_pb2 as descriptor
6 except:
7     print
8     print "*************************************************************"
9     print "*** Could not import the Google protobuf Python libraries ***"
10     print "*** Try installing package 'python-protobuf' or similar.  ***"
11     print "*************************************************************"
12     print
13     raise
14
15 try:
16     import nanopb_pb2
17 except:
18     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 "***************************************************************"
23     print
24     raise
25
26
27
28
29
30
31 # ---------------------------------------------------------------------------
32 #                     Generation of single fields
33 # ---------------------------------------------------------------------------
34
35 import time
36 import os.path
37
38 # Values are tuple (c type, pb type)
39 FieldD = descriptor.FieldDescriptorProto
40 datatypes = {
41     FieldD.TYPE_BOOL:       ('bool',     'BOOL'),
42     FieldD.TYPE_DOUBLE:     ('double',   'DOUBLE'),
43     FieldD.TYPE_FIXED32:    ('uint32_t', 'FIXED32'),
44     FieldD.TYPE_FIXED64:    ('uint64_t', 'FIXED64'),
45     FieldD.TYPE_FLOAT:      ('float',    'FLOAT'),
46     FieldD.TYPE_INT32:      ('int32_t',  'INT32'),
47     FieldD.TYPE_INT64:      ('int64_t',  'INT64'),
48     FieldD.TYPE_SFIXED32:   ('int32_t',  'SFIXED32'),
49     FieldD.TYPE_SFIXED64:   ('int64_t',  'SFIXED64'),
50     FieldD.TYPE_SINT32:     ('int32_t',  'SINT32'),
51     FieldD.TYPE_SINT64:     ('int64_t',  'SINT64'),
52     FieldD.TYPE_UINT32:     ('uint32_t', 'UINT32'),
53     FieldD.TYPE_UINT64:     ('uint64_t', 'UINT64')
54 }
55
56 class Names:
57     '''Keeps a set of nested names and formats them to C identifier.
58     You can subclass this with your own implementation.
59     '''
60     def __init__(self, parts = ()):
61         if isinstance(parts, Names):
62             parts = parts.parts
63         self.parts = tuple(parts)
64     
65     def __str__(self):
66         return '_'.join(self.parts)
67
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)
73         else:
74             raise ValueError("Name parts should be of type str")
75     
76     def __eq__(self, other):
77         return isinstance(other, Names) and self.parts == other.parts
78     
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('.'))
84
85 class Enum:
86     def __init__(self, names, desc, enum_options):
87         '''desc is EnumDescriptorProto'''
88         
89         self.options = enum_options
90         self.names = names + desc.name
91         
92         if enum_options.long_names:
93             self.values = [(self.names + x.name, x.number) for x in desc.value]            
94         else:
95             self.values = [(names + x.name, x.number) for x in desc.value] 
96         
97         self.value_longnames = [self.names + x.name for x in desc.value]
98     
99     def __str__(self):
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
103         return result
104
105 class Field:
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
111         self.default = None
112         self.max_size = None
113         self.max_count = None
114         self.array_decl = ""
115         
116         # Parse field options
117         if field_options.HasField("max_size"):
118             self.max_size = field_options.max_size
119         
120         if field_options.HasField("max_count"):
121             self.max_count = field_options.max_count
122         
123         if desc.HasField('default_value'):
124             self.default = desc.default_value
125            
126         # Check field rules, i.e. required/optional/repeated.
127         can_be_static = True
128         if desc.label == FieldD.LABEL_REQUIRED:
129             self.rules = 'REQUIRED'
130         elif desc.label == FieldD.LABEL_OPTIONAL:
131             self.rules = 'OPTIONAL'
132         elif desc.label == FieldD.LABEL_REPEATED:
133             self.rules = 'REPEATED'
134             if self.max_count is None:
135                 can_be_static = False
136             else:
137                 self.array_decl = '[%d]' % self.max_count
138         else:
139             raise NotImplementedError(desc.label)
140         
141         # Decide the C data type to use in the struct.
142         if datatypes.has_key(desc.type):
143             self.ctype, self.pbtype = datatypes[desc.type]
144         elif desc.type == FieldD.TYPE_ENUM:
145             self.pbtype = 'ENUM'
146             self.ctype = names_from_type_name(desc.type_name)
147             if self.default is not None:
148                 self.default = self.ctype + self.default
149         elif desc.type == FieldD.TYPE_STRING:
150             self.pbtype = 'STRING'
151             if self.max_size is None:
152                 can_be_static = False
153             else:
154                 self.ctype = 'char'
155                 self.array_decl += '[%d]' % self.max_size
156         elif desc.type == FieldD.TYPE_BYTES:
157             self.pbtype = 'BYTES'
158             if self.max_size is None:
159                 can_be_static = False
160             else:
161                 self.ctype = self.struct_name + self.name + 't'
162         elif desc.type == FieldD.TYPE_MESSAGE:
163             self.pbtype = 'MESSAGE'
164             self.ctype = self.submsgname = names_from_type_name(desc.type_name)
165         else:
166             raise NotImplementedError(desc.type)
167         
168         if field_options.type == nanopb_pb2.FT_DEFAULT:
169             if can_be_static:
170                 field_options.type = nanopb_pb2.FT_STATIC
171             else:
172                 field_options.type = nanopb_pb2.FT_CALLBACK
173         
174         if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
175             raise Exception("Field %s is defined as static, but max_size or max_count is not given." % self.name)
176         
177         if field_options.type == nanopb_pb2.FT_STATIC:
178             self.allocation = 'STATIC'
179         elif field_options.type == nanopb_pb2.FT_CALLBACK:
180             self.allocation = 'CALLBACK'
181             self.ctype = 'pb_callback_t'
182             self.array_decl = ''
183         else:
184             raise NotImplementedError(field_options.type)
185     
186     def __cmp__(self, other):
187         return cmp(self.tag, other.tag)
188     
189     def __str__(self):
190         if self.rules == 'OPTIONAL':
191             result = '    bool has_' + self.name + ';\n'
192         elif self.rules == 'REPEATED' and self.allocation == 'STATIC':
193             result = '    size_t ' + self.name + '_count;\n'
194         else:
195             result = ''
196         result += '    %s %s%s;' % (self.ctype, self.name, self.array_decl)
197         return result
198     
199     def types(self):
200         '''Return definitions for any special types this field might need.'''
201         if self.pbtype == 'BYTES' and self.allocation == 'STATIC':
202             result = 'typedef struct {\n'
203             result += '    size_t size;\n'
204             result += '    uint8_t bytes[%d];\n' % self.max_size
205             result += '} %s;\n' % self.ctype
206         else:
207             result = None
208         return result
209     
210     def default_decl(self, declaration_only = False):
211         '''Return definition for this field's default value.'''
212         if self.default is None:
213             return None
214
215         ctype, default = self.ctype, self.default
216         array_decl = ''
217         
218         if self.pbtype == 'STRING':
219             if self.allocation != 'STATIC':
220                 return None # Not implemented
221         
222             array_decl = '[%d]' % self.max_size
223             default = str(self.default).encode('string_escape')
224             default = default.replace('"', '\\"')
225             default = '"' + default + '"'
226         elif self.pbtype == 'BYTES':
227             if self.allocation != 'STATIC':
228                 return None # Not implemented
229
230             data = self.default.decode('string_escape')
231             data = ['0x%02x' % ord(c) for c in data]
232             default = '{%d, {%s}}' % (len(data), ','.join(data))
233         
234         if declaration_only:
235             return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
236         else:
237             return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
238     
239     def pb_field_t(self, prev_field_name):
240         '''Return the pb_field_t initializer to use in the constant array.
241         prev_field_name is the name of the previous field or None.
242         '''
243         result  = '    PB_FIELD(%3d, ' % self.tag
244         result += '%-8s, ' % self.pbtype
245         result += '%s, ' % self.rules
246         result += '%s, ' % self.allocation
247         result += '%s, ' % self.struct_name
248         result += '%s, ' % self.name
249         result += '%s, ' % (prev_field_name or self.name)
250         
251         if self.pbtype == 'MESSAGE':
252             result += '&%s_fields)' % self.submsgname
253         elif self.default is None:
254             result += '0)'
255         elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
256             result += '0)' # Arbitrary size default values not implemented
257         else:
258             result += '&%s_default)' % (self.struct_name + self.name)
259         
260         return result
261     
262     def largest_field_value(self):
263         '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
264         Returns numeric value or a C-expression for assert.'''
265         if self.pbtype == 'MESSAGE':
266             if self.rules == 'REPEATED' and self.allocation == 'STATIC':
267                 return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
268             else:
269                 return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
270
271         return max(self.tag, self.max_size, self.max_count)        
272
273
274
275
276
277
278 # ---------------------------------------------------------------------------
279 #                   Generation of messages (structures)
280 # ---------------------------------------------------------------------------
281
282
283 class Message:
284     def __init__(self, names, desc, message_options):
285         self.name = names
286         self.fields = []
287         
288         for f in desc.field:
289             field_options = get_nanopb_suboptions(f, message_options)
290             if field_options.type != nanopb_pb2.FT_IGNORE:
291                 self.fields.append(Field(self.name, f, field_options))
292         
293         self.packed = message_options.packed_struct
294         self.ordered_fields = self.fields[:]
295         self.ordered_fields.sort()
296
297     def get_dependencies(self):
298         '''Get list of type names that this structure refers to.'''
299         return [str(field.ctype) for field in self.fields]
300     
301     def __str__(self):
302         result = 'typedef struct _%s {\n' % self.name
303         result += '\n'.join([str(f) for f in self.ordered_fields])
304         result += '\n}'
305         
306         if self.packed:
307             result += ' pb_packed'
308         
309         result += ' %s;' % self.name
310         return result
311     
312     def types(self):
313         result = ""
314         for field in self.fields:
315             types = field.types()
316             if types is not None:
317                 result += types + '\n'
318         return result
319     
320     def default_decl(self, declaration_only = False):
321         result = ""
322         for field in self.fields:
323             default = field.default_decl(declaration_only)
324             if default is not None:
325                 result += default + '\n'
326         return result
327
328     def fields_declaration(self):
329         result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
330         return result
331
332     def fields_definition(self):
333         result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
334         
335         prev = None
336         for field in self.ordered_fields:
337             result += field.pb_field_t(prev)
338             result += ',\n'
339             prev = field.name
340         
341         result += '    PB_LAST_FIELD\n};'
342         return result
343
344
345
346
347
348
349 # ---------------------------------------------------------------------------
350 #                    Processing of entire .proto files
351 # ---------------------------------------------------------------------------
352
353
354 def iterate_messages(desc, names = Names()):
355     '''Recursively find all messages. For each, yield name, DescriptorProto.'''
356     if hasattr(desc, 'message_type'):
357         submsgs = desc.message_type
358     else:
359         submsgs = desc.nested_type
360     
361     for submsg in submsgs:
362         sub_names = names + submsg.name
363         yield sub_names, submsg
364         
365         for x in iterate_messages(submsg, sub_names):
366             yield x
367
368 def parse_file(fdesc, file_options):
369     '''Takes a FileDescriptorProto and returns tuple (enum, messages).'''
370     
371     enums = []
372     messages = []
373     
374     if fdesc.package:
375         base_name = Names(fdesc.package.split('.'))
376     else:
377         base_name = Names()
378     
379     for enum in fdesc.enum_type:
380         enum_options = get_nanopb_suboptions(enum, file_options)
381         enums.append(Enum(base_name, enum, enum_options))
382     
383     for names, message in iterate_messages(fdesc, base_name):
384         message_options = get_nanopb_suboptions(message, file_options)
385         messages.append(Message(names, message, message_options))
386         for enum in message.enum_type:
387             enum_options = get_nanopb_suboptions(enum, message_options)
388             enums.append(Enum(names, enum, enum_options))
389     
390     # Fix field default values where enum short names are used.
391     for enum in enums:
392         if not enum.options.long_names:
393             for message in messages:
394                 for field in message.fields:
395                     if field.default in enum.value_longnames:
396                         idx = enum.value_longnames.index(field.default)
397                         field.default = enum.values[idx][0]
398     
399     return enums, messages
400
401 def toposort2(data):
402     '''Topological sort.
403     From http://code.activestate.com/recipes/577413-topological-sort/
404     This function is under the MIT license.
405     '''
406     for k, v in data.items():
407         v.discard(k) # Ignore self dependencies
408     extra_items_in_deps = reduce(set.union, data.values(), set()) - set(data.keys())
409     data.update(dict([(item, set()) for item in extra_items_in_deps]))
410     while True:
411         ordered = set(item for item,dep in data.items() if not dep)
412         if not ordered:
413             break
414         for item in sorted(ordered):
415             yield item
416         data = dict([(item, (dep - ordered)) for item,dep in data.items()
417                 if item not in ordered])
418     assert not data, "A cyclic dependency exists amongst %r" % data
419
420 def sort_dependencies(messages):
421     '''Sort a list of Messages based on dependencies.'''
422     dependencies = {}
423     message_by_name = {}
424     for message in messages:
425         dependencies[str(message.name)] = set(message.get_dependencies())
426         message_by_name[str(message.name)] = message
427     
428     for msgname in toposort2(dependencies):
429         if msgname in message_by_name:
430             yield message_by_name[msgname]
431
432 def make_identifier(headername):
433     '''Make #ifndef identifier that contains uppercase A-Z and digits 0-9'''
434     result = ""
435     for c in headername.upper():
436         if c.isalnum():
437             result += c
438         else:
439             result += '_'
440     return result
441
442 def generate_header(dependencies, headername, enums, messages, options):
443     '''Generate content for a header file.
444     Generates strings, which should be concatenated and stored to file.
445     '''
446     
447     yield '/* Automatically generated nanopb header */\n'
448     yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
449     
450     symbol = make_identifier(headername)
451     yield '#ifndef _PB_%s_\n' % symbol
452     yield '#define _PB_%s_\n' % symbol
453     yield '#include <pb.h>\n\n'
454     
455     for dependency in dependencies:
456         noext = os.path.splitext(dependency)[0]
457         yield '#include "%s.%s.h"\n' % (noext,options.extension)
458     
459     yield '#ifdef __cplusplus\n'
460     yield 'extern "C" {\n'
461     yield '#endif\n\n'
462     
463     yield '/* Enum definitions */\n'
464     for enum in enums:
465         yield str(enum) + '\n\n'
466     
467     yield '/* Struct definitions */\n'
468     for msg in sort_dependencies(messages):
469         yield msg.types()
470         yield str(msg) + '\n\n'
471         
472     yield '/* Default values for struct fields */\n'
473     for msg in messages:
474         yield msg.default_decl(True)
475     yield '\n'
476     
477     yield '/* Struct field encoding specification for nanopb */\n'
478     for msg in messages:
479         yield msg.fields_declaration() + '\n'
480     
481     yield '\n#ifdef __cplusplus\n'
482     yield '} /* extern "C" */\n'
483     yield '#endif\n'
484     
485     # End of header
486     yield '\n#endif\n'
487
488 def generate_source(headername, enums, messages):
489     '''Generate content for a source file.'''
490     
491     yield '/* Automatically generated nanopb constant definitions */\n'
492     yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
493     yield '#include "%s"\n\n' % headername
494     
495     for msg in messages:
496         yield msg.default_decl(False)
497     
498     yield '\n\n'
499     
500     for msg in messages:
501         yield msg.fields_definition() + '\n\n'
502         
503     if messages:
504         count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
505         largest_msg = max(messages, key = count_required_fields)
506         largest_count = count_required_fields(largest_msg)
507         if largest_count > 64:
508             yield '\n/* Check that missing required fields will be properly detected */\n'
509             yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
510             yield '#error Properly detecting missing required fields in %s requires \\\n' % largest_msg.name
511             yield '       setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
512             yield '#endif\n'
513     
514     # Add checks for numeric limits
515     worst = 0
516     worst_field = ''
517     checks = []
518     checks_msgnames = []
519     for msg in messages:
520         checks_msgnames.append(msg.name)
521         for field in msg.fields:
522             status = field.largest_field_value()
523             if isinstance(status, (str, unicode)):
524                 checks.append(status)
525             elif status > worst:
526                 worst = status
527                 worst_field = str(field.struct_name) + '.' + str(field.name)
528
529     if worst > 255 or checks:
530         yield '\n/* Check that field information fits in pb_field_t */\n'
531         
532         if worst < 65536:
533             yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n'
534             if worst > 255:
535                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_16BIT to fix this.\n' % worst_field
536             else:
537                 assertion = ' && '.join(str(c) + ' < 256' for c in checks)
538                 msgs = '_'.join(str(n) for n in checks_msgnames)
539                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
540             yield '#endif\n\n'
541         
542         if worst > 65535 or checks:
543             yield '#if !defined(PB_FIELD_32BIT)\n'
544             if worst > 65535:
545                 yield '#error Field descriptor for %s is too large. Define PB_FIELD_32BIT to fix this.\n' % worst_field
546             else:
547                 assertion = ' && '.join(str(c) + ' < 65536' for c in checks)
548                 msgs = '_'.join(str(n) for n in checks_msgnames)
549                 yield 'STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs)
550             yield '#endif\n'
551     
552     # Add check for sizeof(double)
553     has_double = False
554     for msg in messages:
555         for field in msg.fields:
556             if field.ctype == 'double':
557                 has_double = True
558     
559     if has_double:
560         yield '\n'
561         yield '/* On some platforms (such as AVR), double is really float.\n'
562         yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
563         yield ' * To get rid of this error, remove any double fields from your .proto.\n'
564         yield ' */\n'
565         yield 'STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
566     
567     yield '\n'
568
569
570 # ---------------------------------------------------------------------------
571 #                         Command line interface
572 # ---------------------------------------------------------------------------
573
574 import sys
575 import os.path    
576 from optparse import OptionParser
577 import google.protobuf.text_format as text_format
578
579 optparser = OptionParser(
580     usage = "Usage: nanopb_generator.py [options] file.pb ...",
581     epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
582              "Output will be written to file.pb.h and file.pb.c.")
583 optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
584     help="Exclude file from generated #include list.")
585 optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
586     help="use extension instead of 'pb' for generated files.")
587 optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
588     help="Don't print anything except errors.")
589 optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
590     help="Print more information.")
591 optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
592     help="Set generator option (max_size, max_count etc.).")
593
594 def get_nanopb_suboptions(subdesc, options):
595     '''Get copy of options, and merge information from subdesc.'''
596     new_options = nanopb_pb2.NanoPBOptions()
597     new_options.CopyFrom(options)
598     
599     if isinstance(subdesc.options, descriptor.FieldOptions):
600         ext_type = nanopb_pb2.nanopb
601     elif isinstance(subdesc.options, descriptor.FileOptions):
602         ext_type = nanopb_pb2.nanopb_fileopt
603     elif isinstance(subdesc.options, descriptor.MessageOptions):
604         ext_type = nanopb_pb2.nanopb_msgopt
605     elif isinstance(subdesc.options, descriptor.EnumOptions):
606         ext_type = nanopb_pb2.nanopb_enumopt
607     else:
608         raise Exception("Unknown options type")
609     
610     if subdesc.options.HasExtension(ext_type):
611         ext = subdesc.options.Extensions[ext_type]
612         new_options.MergeFrom(ext)
613     
614     return new_options
615
616 def process(filenames, options):
617     '''Process the files given on the command line.'''
618     
619     if not filenames:
620         optparser.print_help()
621         return False
622     
623     if options.quiet:
624         options.verbose = False
625     
626     toplevel_options = nanopb_pb2.NanoPBOptions()
627     for s in options.settings:
628         text_format.Merge(s, toplevel_options)
629     
630     for filename in filenames:
631         data = open(filename, 'rb').read()
632         fdesc = descriptor.FileDescriptorSet.FromString(data)
633         
634         file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options)
635         
636         if options.verbose:
637             print "Options for " + filename + ":"
638             print text_format.MessageToString(file_options)
639         
640         enums, messages = parse_file(fdesc.file[0], file_options)
641         
642         noext = os.path.splitext(filename)[0]
643         headername = noext + '.' + options.extension + '.h'
644         sourcename = noext + '.' + options.extension + '.c'
645         headerbasename = os.path.basename(headername)
646         
647         if not options.quiet:
648             print "Writing to " + headername + " and " + sourcename
649         
650         # List of .proto files that should not be included in the C header file
651         # even if they are mentioned in the source .proto.
652         excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude
653         dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
654         
655         header = open(headername, 'w')
656         for part in generate_header(dependencies, headerbasename, enums, messages, options):
657             header.write(part)
658
659         source = open(sourcename, 'w')
660         for part in generate_source(headerbasename, enums, messages):
661             source.write(part)
662
663     return True
664
665 if __name__ == '__main__':
666     options, filenames = optparser.parse_args()
667     status = process(filenames, options)
668     
669     if not status:
670         sys.exit(1)
671