X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=generator%2Fnanopb_generator.py;h=351c37e32019656f4a2215115dc070c2fbde1b91;hb=60d8ba229b58f07fdefc31e2756402cc74cede5f;hp=f7d432218fd12ca1b11c7e5e2c1bc735f11d95f1;hpb=0d7ef5f936afc32bfe0aaec8b92667d4c3a026a0;p=apps%2Fagl-service-can-low-level.git diff --git a/generator/nanopb_generator.py b/generator/nanopb_generator.py index f7d43221..351c37e3 100755 --- a/generator/nanopb_generator.py +++ b/generator/nanopb_generator.py @@ -1,7 +1,9 @@ -#!/usr/bin/python +#!/usr/bin/env python + +from __future__ import unicode_literals '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.''' -nanopb_version = "nanopb-0.3.4-dev" +nanopb_version = "nanopb-0.3.7" import sys import re @@ -72,27 +74,33 @@ intsizes = { nanopb_pb2.IS_64: 'int64_t', } +# String types (for python 2 / python 3 compatibility) +try: + strtypes = (unicode, str) +except NameError: + strtypes = (str, ) + class Names: '''Keeps a set of nested names and formats them to C identifier.''' def __init__(self, parts = ()): if isinstance(parts, Names): parts = parts.parts self.parts = tuple(parts) - + def __str__(self): return '_'.join(self.parts) def __add__(self, other): - if isinstance(other, str): + if isinstance(other, strtypes): return Names(self.parts + (other,)) elif isinstance(other, tuple): return Names(self.parts + other) else: raise ValueError("Name parts should be of type str") - + def __eq__(self, other): return isinstance(other, Names) and self.parts == other.parts - + def names_from_type_name(type_name): '''Parse Names() from FieldDescriptorProto type_name''' if type_name[0] != '.': @@ -117,16 +125,20 @@ class EncodedSize: '''Class used to represent the encoded size of a field or a message. Consists of a combination of symbolic sizes and integer sizes.''' def __init__(self, value = 0, symbols = []): - if isinstance(value, (str, Names)): - symbols = [str(value)] - value = 0 - self.value = value - self.symbols = symbols - + if isinstance(value, EncodedSize): + self.value = value.value + self.symbols = value.symbols + elif isinstance(value, strtypes + (Names,)): + self.symbols = [str(value)] + self.value = 0 + else: + self.value = value + self.symbols = symbols + def __add__(self, other): if isinstance(other, int): return EncodedSize(self.value + other, self.symbols) - elif isinstance(other, (str, Names)): + elif isinstance(other, strtypes + (Names,)): return EncodedSize(self.value, self.symbols + [str(other)]) elif isinstance(other, EncodedSize): return EncodedSize(self.value + other.value, self.symbols + other.symbols) @@ -154,43 +166,47 @@ class EncodedSize: class Enum: def __init__(self, names, desc, enum_options): '''desc is EnumDescriptorProto''' - + self.options = enum_options self.names = names + desc.name - + if enum_options.long_names: - self.values = [(self.names + x.name, x.number) for x in desc.value] + self.values = [(self.names + x.name, x.number) for x in desc.value] else: - self.values = [(names + x.name, x.number) for x in desc.value] - + self.values = [(names + x.name, x.number) for x in desc.value] + self.value_longnames = [self.names + x.name for x in desc.value] self.packed = enum_options.packed_enum - + def has_negative(self): for n, v in self.values: if v < 0: return True return False - + def encoded_size(self): return max([varint_max_size(v) for n,v in self.values]) - + def __str__(self): result = 'typedef enum _%s {\n' % self.names result += ',\n'.join([" %s = %d" % x for x in self.values]) result += '\n}' - + if self.packed: result += ' pb_packed' - + result += ' %s;' % self.names - + + result += '\n#define _%s_MIN %s' % (self.names, self.values[0][0]) + result += '\n#define _%s_MAX %s' % (self.names, self.values[-1][0]) + result += '\n#define _%s_ARRAYSIZE ((%s)(%s+1))' % (self.names, self.names, self.values[-1][0]) + if not self.options.long_names: # Define the long names always so that enum value references # from other files work properly. for i, x in enumerate(self.values): result += '\n#define %s %s' % (self.value_longnames[i], x[0]) - + return result class FieldMaxSize: @@ -201,7 +217,7 @@ class FieldMaxSize: self.worst = worst self.worst_field = field_name - self.checks = checks + self.checks = list(checks) def extend(self, extend, field_name = None): self.worst = max(self.worst, extend.worst) @@ -224,51 +240,58 @@ class Field: self.array_decl = "" self.enc_size = None self.ctype = None - + + self.inline = None + if field_options.type == nanopb_pb2.FT_INLINE: + field_options.type = nanopb_pb2.FT_STATIC + self.inline = nanopb_pb2.FT_INLINE + # Parse field options if field_options.HasField("max_size"): self.max_size = field_options.max_size - + if field_options.HasField("max_count"): self.max_count = field_options.max_count - + if desc.HasField('default_value'): self.default = desc.default_value - + # Check field rules, i.e. required/optional/repeated. can_be_static = True - if desc.label == FieldD.LABEL_REQUIRED: - self.rules = 'REQUIRED' - elif desc.label == FieldD.LABEL_OPTIONAL: - self.rules = 'OPTIONAL' - elif desc.label == FieldD.LABEL_REPEATED: + if desc.label == FieldD.LABEL_REPEATED: self.rules = 'REPEATED' if self.max_count is None: can_be_static = False else: self.array_decl = '[%d]' % self.max_count + elif field_options.HasField("proto3"): + self.rules = 'SINGULAR' + elif desc.label == FieldD.LABEL_REQUIRED: + self.rules = 'REQUIRED' + elif desc.label == FieldD.LABEL_OPTIONAL: + self.rules = 'OPTIONAL' else: raise NotImplementedError(desc.label) - + # Check if the field can be implemented with static allocation # i.e. whether the data size is known. if desc.type == FieldD.TYPE_STRING and self.max_size is None: can_be_static = False - + if desc.type == FieldD.TYPE_BYTES and self.max_size is None: can_be_static = False - + # Decide how the field data will be allocated if field_options.type == nanopb_pb2.FT_DEFAULT: if can_be_static: field_options.type = nanopb_pb2.FT_STATIC else: field_options.type = nanopb_pb2.FT_CALLBACK - + if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static: raise Exception("Field %s is defined as static, but max_size or " "max_count is not given." % self.name) - + if field_options.type == nanopb_pb2.FT_STATIC: self.allocation = 'STATIC' elif field_options.type == nanopb_pb2.FT_POINTER: @@ -277,7 +300,7 @@ class Field: self.allocation = 'CALLBACK' else: raise NotImplementedError(field_options.type) - + # Decide the C data type to use in the struct. if desc.type in datatypes: self.ctype, self.pbtype, self.enc_size, isa = datatypes[desc.type] @@ -303,7 +326,12 @@ class Field: elif desc.type == FieldD.TYPE_BYTES: self.pbtype = 'BYTES' if self.allocation == 'STATIC': - self.ctype = self.struct_name + self.name + 't' + # Inline STATIC for BYTES is like STATIC for STRING. + if self.inline: + self.ctype = 'pb_byte_t' + self.array_decl += '[%d]' % self.max_size + else: + self.ctype = self.struct_name + self.name + 't' self.enc_size = varint_max_size(self.max_size) + self.max_size elif self.allocation == 'POINTER': self.ctype = 'pb_bytes_array_t' @@ -313,16 +341,16 @@ class Field: self.enc_size = None # Needs to be filled in after the message type is available else: raise NotImplementedError(desc.type) - + def __lt__(self, other): return self.tag < other.tag - + def __str__(self): result = '' if self.allocation == 'POINTER': if self.rules == 'REPEATED': result += ' pb_size_t ' + self.name + '_count;\n' - + if self.pbtype == 'MESSAGE': # Use struct definition, so recursive submessages are possible result += ' struct _%s *%s;' % (self.ctype, self.name) @@ -340,15 +368,15 @@ class Field: result += ' pb_size_t ' + self.name + '_count;\n' result += ' %s %s%s;' % (self.ctype, self.name, self.array_decl) return result - + def types(self): '''Return definitions for any special types this field might need.''' - if self.pbtype == 'BYTES' and self.allocation == 'STATIC': + if self.pbtype == 'BYTES' and self.allocation == 'STATIC' and not self.inline: result = 'typedef PB_BYTES_ARRAY_T(%d) %s;\n' % (self.max_size, self.ctype) else: result = '' return result - + def get_dependencies(self): '''Get list of type names used by this field.''' if self.allocation == 'STATIC': @@ -372,23 +400,30 @@ class Field: if self.pbtype == 'STRING': inner_init = '""' elif self.pbtype == 'BYTES': - inner_init = '{0, {0}}' + if self.inline: + inner_init = '{0}' + else: + inner_init = '{0, {0}}' elif self.pbtype in ('ENUM', 'UENUM'): inner_init = '(%s)0' % self.ctype else: inner_init = '0' else: if self.pbtype == 'STRING': - inner_init = self.default.encode('utf-8').encode('string_escape') - inner_init = inner_init.replace('"', '\\"') + inner_init = self.default.replace('"', '\\"') inner_init = '"' + inner_init + '"' elif self.pbtype == 'BYTES': - data = str(self.default).decode('string_escape') - data = ['0x%02x' % ord(c) for c in data] + data = ['0x%02x' % ord(c) for c in self.default] if len(data) == 0: - inner_init = '{0, {0}}' + if self.inline: + inner_init = '{0}' + else: + inner_init = '{0, {0}}' else: - inner_init = '{%d, {%s}}' % (len(data), ','.join(data)) + if self.inline: + inner_init = '{%s}' % ','.join(data) + else: + inner_init = '{%d, {%s}}' % (len(data), ','.join(data)) elif self.pbtype in ['FIXED32', 'UINT32']: inner_init = str(self.default) + 'u' elif self.pbtype in ['FIXED64', 'UINT64']: @@ -397,7 +432,7 @@ class Field: inner_init = str(self.default) + 'll' else: inner_init = str(self.default) - + if inner_init_only: return inner_init @@ -432,7 +467,7 @@ class Field: ctype = self.ctype default = self.get_initializer(False, True) array_decl = '' - + if self.pbtype == 'STRING': if self.allocation != 'STATIC': return None # Not implemented @@ -440,36 +475,41 @@ class Field: elif self.pbtype == 'BYTES': if self.allocation != 'STATIC': return None # Not implemented - + if self.inline: + array_decl = '[%d]' % self.max_size + if declaration_only: return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl) else: return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default) - + def tags(self): '''Return the #define for the tag number of this field.''' identifier = '%s_%s_tag' % (self.struct_name, self.name) return '#define %-40s %d\n' % (identifier, self.tag) - + def pb_field_t(self, prev_field_name): '''Return the pb_field_t initializer to use in the constant array. prev_field_name is the name of the previous field or None. ''' if self.rules == 'ONEOF': - result = ' PB_ONEOF_FIELD(%s, ' % self.union_name + if self.anonymous: + result = ' PB_ANONYMOUS_ONEOF_FIELD(%s, ' % self.union_name + else: + result = ' PB_ONEOF_FIELD(%s, ' % self.union_name else: result = ' PB_FIELD(' result += '%3d, ' % self.tag result += '%-8s, ' % self.pbtype result += '%s, ' % self.rules - result += '%-8s, ' % self.allocation + result += '%-8s, ' % (self.allocation if not self.inline else "INLINE") result += '%s, ' % ("FIRST" if not prev_field_name else "OTHER") result += '%s, ' % self.struct_name result += '%s, ' % self.name result += '%s, ' % (prev_field_name or self.name) - + if self.pbtype == 'MESSAGE': result += '&%s_fields)' % self.submsgname elif self.default is None: @@ -480,20 +520,29 @@ class Field: result += '0)' # Default value for extensions is not implemented else: result += '&%s_default)' % (self.struct_name + self.name) - + return result - + + def get_last_field_name(self): + return self.name + def largest_field_value(self): '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly. Returns numeric value or a C-expression for assert.''' check = [] - if self.pbtype == 'MESSAGE': - if self.rules == 'REPEATED' and self.allocation == 'STATIC': + if self.pbtype == 'MESSAGE' and self.allocation == 'STATIC': + if self.rules == 'REPEATED': check.append('pb_membersize(%s, %s[0])' % (self.struct_name, self.name)) elif self.rules == 'ONEOF': - check.append('pb_membersize(%s, %s.%s)' % (self.struct_name, self.union_name, self.name)) + if self.anonymous: + check.append('pb_membersize(%s, %s)' % (self.struct_name, self.name)) + else: + check.append('pb_membersize(%s, %s.%s)' % (self.struct_name, self.union_name, self.name)) else: check.append('pb_membersize(%s, %s)' % (self.struct_name, self.name)) + elif self.pbtype == 'BYTES' and self.allocation == 'STATIC': + if self.max_size > 251: + check.append('pb_membersize(%s, %s)' % (self.struct_name, self.name)) return FieldMaxSize([self.tag, self.max_size, self.max_count], check, @@ -503,23 +552,23 @@ class Field: '''Return the maximum size that this field can take when encoded, including the field tag. If the size cannot be determined, returns None.''' - + if self.allocation != 'STATIC': return None - + if self.pbtype == 'MESSAGE': + encsize = None if str(self.submsgname) in dependencies: submsg = dependencies[str(self.submsgname)] encsize = submsg.encoded_size(dependencies) - if encsize is None: - return None # Submessage size is indeterminate - - # Include submessage length prefix - encsize += varint_max_size(encsize.upperlimit()) - else: - # Submessage cannot be found, this currently occurs when - # the submessage type is defined in a different file and - # not using the protoc plugin. + if encsize is not None: + # Include submessage length prefix + encsize += varint_max_size(encsize.upperlimit()) + + if encsize is None: + # Submessage or its size cannot be found. + # This can occur if submessage is defined in different + # file, and it or its .options could not be found. # Instead of direct numeric value, reference the size that # has been #defined in the other file. encsize = EncodedSize(self.submsgname + 'size') @@ -541,7 +590,7 @@ class Field: % (self.struct_name, self.name)) else: encsize = EncodedSize(self.enc_size) - + encsize += varint_max_size(self.tag << 3) # Tag + wire type if self.rules == 'REPEATED': @@ -549,7 +598,7 @@ class Field: # Therefore we have to reserve space for it, even though # we emit packed arrays ourselves. encsize *= self.max_count - + return encsize @@ -571,16 +620,17 @@ class ExtensionRange(Field): self.default = None self.max_size = 0 self.max_count = 0 - + self.inline = None + def __str__(self): return ' pb_extension_t *extensions;' - + def types(self): return '' - + def tags(self): return '' - + def encoded_size(self, dependencies): # We exclude extensions from the count, because they cannot be known # until runtime. Other option would be to return None here, but this @@ -592,7 +642,7 @@ class ExtensionField(Field): self.fullname = struct_name + desc.name self.extendee_name = names_from_type_name(desc.extendee) Field.__init__(self, self.fullname + 'struct', desc, field_options) - + if self.rules != 'OPTIONAL': self.skip = True else: @@ -610,7 +660,7 @@ class ExtensionField(Field): msg = '/* Extension field %s was skipped because only "optional"\n' % self.fullname msg +=' type of extension fields is currently supported. */\n' return msg - + return ('extern const pb_extension_type_t %s; /* field type: %s */\n' % (self.fullname, str(self).strip())) @@ -647,6 +697,8 @@ class OneOf(Field): self.allocation = 'ONEOF' self.default = None self.rules = 'ONEOF' + self.anonymous = False + self.inline = None def add_field(self, field): if field.allocation == 'CALLBACK': @@ -655,6 +707,7 @@ class OneOf(Field): field.union_name = self.name field.rules = 'ONEOF' + field.anonymous = self.anonymous self.fields.append(field) self.fields.sort(key = lambda f: f.tag) @@ -668,7 +721,10 @@ class OneOf(Field): result += ' union {\n' for f in self.fields: result += ' ' + str(f).replace('\n', '\n ') + '\n' - result += ' } ' + self.name + ';' + if self.anonymous: + result += ' };' + else: + result += ' } ' + self.name + ';' return result def types(self): @@ -687,12 +743,18 @@ class OneOf(Field): return None def tags(self): - return '\n'.join([f.tags() for f in self.fields]) + return ''.join([f.tags() for f in self.fields]) def pb_field_t(self, prev_field_name): result = ',\n'.join([f.pb_field_t(prev_field_name) for f in self.fields]) return result + def get_last_field_name(self): + if self.anonymous: + return self.fields[-1].name + else: + return self.name + '.' + self.fields[-1].name + def largest_field_value(self): largest = FieldMaxSize() for f in self.fields: @@ -700,10 +762,11 @@ class OneOf(Field): return largest def encoded_size(self, dependencies): + '''Returns the size of the largest oneof field.''' largest = EncodedSize(0) for f in self.fields: - size = f.encoded_size(dependencies) - if size is None: + size = EncodedSize(f.encoded_size(dependencies)) + if size.value is None: return None elif size.symbols: return None # Cannot resolve maximum of symbols @@ -736,6 +799,8 @@ class Message: pass # No union and skip fields also else: oneof = OneOf(self.name, f) + if oneof_options.anonymous_oneof: + oneof.anonymous = True self.oneofs[i] = oneof self.fields.append(oneof) @@ -752,13 +817,13 @@ class Message: self.oneofs[f.oneof_index].add_field(field) else: self.fields.append(field) - + if len(desc.extension_range) > 0: field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions') range_start = min([r.start for r in desc.extension_range]) if field_options.type != nanopb_pb2.FT_IGNORE: self.fields.append(ExtensionRange(self.name, range_start, field_options)) - + self.packed = message_options.packed_struct self.ordered_fields = self.fields[:] self.ordered_fields.sort() @@ -769,41 +834,42 @@ class Message: for f in self.fields: deps += f.get_dependencies() return deps - + def __str__(self): result = 'typedef struct _%s {\n' % self.name if not self.ordered_fields: # Empty structs are not allowed in C standard. # Therefore add a dummy field if an empty message occurs. - result += ' uint8_t dummy_field;' + result += ' char dummy_field;' result += '\n'.join([str(f) for f in self.ordered_fields]) + result += '\n/* @@protoc_insertion_point(struct:%s) */' % self.name result += '\n}' - + if self.packed: result += ' pb_packed' - + result += ' %s;' % self.name - + if self.packed: result = 'PB_PACKED_STRUCT_START\n' + result result += '\nPB_PACKED_STRUCT_END' - + return result - + def types(self): return ''.join([f.types() for f in self.fields]) def get_initializer(self, null_init): if not self.ordered_fields: return '{0}' - + parts = [] for field in self.ordered_fields: parts.append(field.get_initializer(null_init)) return '{' + ', '.join(parts) + '}' - + def default_decl(self, declaration_only = False): result = "" for field in self.fields: @@ -836,16 +902,13 @@ class Message: def fields_definition(self): result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, self.count_all_fields() + 1) - + prev = None for field in self.ordered_fields: result += field.pb_field_t(prev) result += ',\n' - if isinstance(field, OneOf): - prev = field.name + '.' + field.fields[-1].name - else: - prev = field.name - + prev = field.get_last_field_name() + result += ' PB_LAST_FIELD\n};' return result @@ -859,7 +922,7 @@ class Message: if fsize is None: return None size += fsize - + return size @@ -873,11 +936,11 @@ def iterate_messages(desc, names = Names()): submsgs = desc.message_type else: submsgs = desc.nested_type - + for submsg in submsgs: sub_names = names + submsg.name yield sub_names, submsg - + for x in iterate_messages(submsg, sub_names): yield x @@ -918,7 +981,7 @@ def sort_dependencies(messages): for message in messages: dependencies[str(message.name)] = set(message.get_dependencies()) message_by_name[str(message.name)] = message - + for msgname in toposort2(dependencies): if msgname in message_by_name: yield message_by_name[msgname] @@ -940,7 +1003,7 @@ class ProtoFile: self.file_options = file_options self.dependencies = {} self.parse() - + # Some of types used in this file probably come from the file itself. # Thus it has implicit dependency on itself. self.add_dependency(self) @@ -949,39 +1012,39 @@ class ProtoFile: self.enums = [] self.messages = [] self.extensions = [] - + if self.fdesc.package: base_name = Names(self.fdesc.package.split('.')) else: base_name = Names() - + for enum in self.fdesc.enum_type: enum_options = get_nanopb_suboptions(enum, self.file_options, base_name + enum.name) self.enums.append(Enum(base_name, enum, enum_options)) - + for names, message in iterate_messages(self.fdesc, base_name): message_options = get_nanopb_suboptions(message, self.file_options, names) - + if message_options.skip_message: continue - + self.messages.append(Message(names, message, message_options)) for enum in message.enum_type: enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name) self.enums.append(Enum(names, enum, enum_options)) - + for names, extension in iterate_extensions(self.fdesc, base_name): field_options = get_nanopb_suboptions(extension, self.file_options, names + extension.name) if field_options.type != nanopb_pb2.FT_IGNORE: self.extensions.append(ExtensionField(names, extension, field_options)) - + def add_dependency(self, other): for enum in other.enums: self.dependencies[str(enum.names)] = enum - + for msg in other.messages: self.dependencies[str(msg.name)] = msg - + # Fix field default values where enum short names are used. for enum in other.enums: if not enum.options.long_names: @@ -990,7 +1053,7 @@ class ProtoFile: if field.default in enum.value_longnames: idx = enum.value_longnames.index(field.default) field.default = enum.values[idx][0] - + # Fix field data types where enums have negative values. for enum in other.enums: if not enum.has_negative(): @@ -1003,14 +1066,17 @@ class ProtoFile: '''Generate content for a header file. Generates strings, which should be concatenated and stored to file. ''' - + yield '/* Automatically generated nanopb header */\n' if options.notimestamp: yield '/* Generated by %s */\n\n' % (nanopb_version) else: yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime()) - - symbol = make_identifier(headername) + + if self.fdesc.package: + symbol = make_identifier(self.fdesc.package + '_' + headername) + else: + symbol = make_identifier(headername) yield '#ifndef PB_%s_INCLUDED\n' % symbol yield '#define PB_%s_INCLUDED\n' % symbol try: @@ -1019,12 +1085,14 @@ class ProtoFile: # no %s specified - use whatever was passed in as options.libformat yield options.libformat yield '\n' - + for incfile in includes: noext = os.path.splitext(incfile)[0] yield options.genformat % (noext + options.extension + '.h') yield '\n' + yield '/* @@protoc_insertion_point(includes) */\n' + yield '#if PB_PROTO_HEADER_VERSION != 30\n' yield '#error Regenerate this file with the current version of nanopb generator.\n' yield '#endif\n' @@ -1033,30 +1101,30 @@ class ProtoFile: yield '#ifdef __cplusplus\n' yield 'extern "C" {\n' yield '#endif\n\n' - + if self.enums: yield '/* Enum definitions */\n' for enum in self.enums: yield str(enum) + '\n\n' - + if self.messages: yield '/* Struct definitions */\n' for msg in sort_dependencies(self.messages): yield msg.types() yield str(msg) + '\n\n' - + if self.extensions: yield '/* Extensions */\n' for extension in self.extensions: yield extension.extension_decl() yield '\n' - + if self.messages: yield '/* Default values for struct fields */\n' for msg in self.messages: yield msg.default_decl(True) yield '\n' - + yield '/* Initializer values for message structs */\n' for msg in self.messages: identifier = '%s_init_default' % msg.name @@ -1065,7 +1133,7 @@ class ProtoFile: identifier = '%s_init_zero' % msg.name yield '#define %-40s %s\n' % (identifier, msg.get_initializer(True)) yield '\n' - + yield '/* Field tags (for use in manual encoding/decoding) */\n' for msg in sort_dependencies(self.messages): for field in msg.fields: @@ -1073,22 +1141,24 @@ class ProtoFile: for extension in self.extensions: yield extension.tags() yield '\n' - + yield '/* Struct field encoding specification for nanopb */\n' for msg in self.messages: yield msg.fields_declaration() + '\n' yield '\n' - + yield '/* Maximum encoded size of messages (where known) */\n' for msg in self.messages: msize = msg.encoded_size(self.dependencies) + identifier = '%s_size' % msg.name if msize is not None: - identifier = '%s_size' % msg.name yield '#define %-40s %s\n' % (identifier, msize) + else: + yield '/* %s depends on runtime parameters */\n' % identifier yield '\n' yield '/* Message IDs (where set with "msgid" option) */\n' - + yield '#ifdef PB_MSGID\n' for msg in self.messages: if hasattr(msg,'msgid'): @@ -1117,13 +1187,14 @@ class ProtoFile: yield '#ifdef __cplusplus\n' yield '} /* extern "C" */\n' yield '#endif\n' - + # End of header + yield '/* @@protoc_insertion_point(eof) */\n' yield '\n#endif\n' def generate_source(self, headername, options): '''Generate content for a source file.''' - + yield '/* Automatically generated nanopb constant definitions */\n' if options.notimestamp: yield '/* Generated by %s */\n\n' % (nanopb_version) @@ -1131,23 +1202,24 @@ class ProtoFile: yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime()) yield options.genformat % (headername) yield '\n' - + yield '/* @@protoc_insertion_point(includes) */\n' + yield '#if PB_PROTO_HEADER_VERSION != 30\n' yield '#error Regenerate this file with the current version of nanopb generator.\n' yield '#endif\n' yield '\n' - + for msg in self.messages: yield msg.default_decl(False) - + yield '\n\n' - + for msg in self.messages: yield msg.fields_definition() + '\n\n' - + for ext in self.extensions: yield ext.extension_def() + '\n' - + # Add checks for numeric limits if self.messages: largest_msg = max(self.messages, key = lambda m: m.count_required_fields()) @@ -1172,7 +1244,7 @@ class ProtoFile: if worst > 255 or checks: yield '\n/* Check that field information fits in pb_field_t */\n' - + if worst > 65535 or checks: yield '#if !defined(PB_FIELD_32BIT)\n' if worst > 65535: @@ -1189,7 +1261,7 @@ class ProtoFile: yield ' */\n' yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs) yield '#endif\n\n' - + if worst < 65536: yield '#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)\n' if worst > 255: @@ -1206,14 +1278,14 @@ class ProtoFile: yield ' */\n' yield 'PB_STATIC_ASSERT((%s), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_%s)\n'%(assertion,msgs) yield '#endif\n\n' - + # Add check for sizeof(double) has_double = False for msg in self.messages: for field in msg.fields: if field.ctype == 'double': has_double = True - + if has_double: yield '\n' yield '/* On some platforms (such as AVR), double is really float.\n' @@ -1221,8 +1293,9 @@ class ProtoFile: yield ' * To get rid of this error, remove any double fields from your .proto.\n' yield ' */\n' yield 'PB_STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n' - + yield '\n' + yield '/* @@protoc_insertion_point(eof) */\n' # --------------------------------------------------------------------------- # Options parsing for the .proto files @@ -1243,17 +1316,17 @@ def read_options_file(infile): line = line.strip() if not line: continue - + parts = line.split(None, 1) - + if len(parts) < 2: sys.stderr.write("%s:%d: " % (infile.name, i + 1) + "Option lines should have space between field name and options. " + "Skipping line: '%s'\n" % line) continue - + opts = nanopb_pb2.NanoPBOptions() - + try: text_format.Merge(parts[1], opts) except Exception as e: @@ -1275,14 +1348,17 @@ def get_nanopb_suboptions(subdesc, options, name): '''Get copy of options, and merge information from subdesc.''' new_options = nanopb_pb2.NanoPBOptions() new_options.CopyFrom(options) - + # Handle options defined in a separate file dotname = '.'.join(name.parts) for namemask, options in Globals.separate_options: if fnmatch(dotname, namemask): Globals.matched_namemasks.add(namemask) new_options.MergeFrom(options) - + + if hasattr(subdesc, 'syntax') and subdesc.syntax == "proto3": + new_options.proto3 = True + # Handle options defined in .proto if isinstance(subdesc.options, descriptor.FieldOptions): ext_type = nanopb_pb2.nanopb @@ -1294,15 +1370,15 @@ def get_nanopb_suboptions(subdesc, options, name): ext_type = nanopb_pb2.nanopb_enumopt else: raise Exception("Unknown options type") - + if subdesc.options.HasExtension(ext_type): ext = subdesc.options.Extensions[ext_type] new_options.MergeFrom(ext) - + if Globals.verbose_options: sys.stderr.write("Options for " + dotname + ": ") sys.stderr.write(text_format.MessageToString(new_options) + "\n") - + return new_options @@ -1311,7 +1387,7 @@ def get_nanopb_suboptions(subdesc, options, name): # --------------------------------------------------------------------------- import sys -import os.path +import os.path from optparse import OptionParser optparser = OptionParser( @@ -1327,6 +1403,9 @@ optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE" optparser.add_option("-I", "--options-path", dest="options_path", metavar="DIR", action="append", default = [], help="Search for .options files additionally in this path") +optparser.add_option("-D", "--output-dir", dest="output_dir", + metavar="OUTPUTDIR", default=None, + help="Output directory of .pb.h and .pb.c files") optparser.add_option("-Q", "--generated-include-format", dest="genformat", metavar="FORMAT", default='#include "%s"\n', help="Set format string to use for including other .pb.h files. [default: %default]") @@ -1347,11 +1426,11 @@ def parse_file(filename, fdesc, options): toplevel_options = nanopb_pb2.NanoPBOptions() for s in options.settings: text_format.Merge(s, toplevel_options) - + if not fdesc: data = open(filename, 'rb').read() fdesc = descriptor.FileDescriptorSet.FromString(data).file[0] - + # Check if there is a separate .options file had_abspath = False try: @@ -1378,12 +1457,12 @@ def parse_file(filename, fdesc, options): Globals.separate_options = [] Globals.matched_namemasks = set() - + # Parse the file file_options = get_nanopb_suboptions(fdesc, toplevel_options, Names([filename])) f = ProtoFile(fdesc, file_options) f.optfilename = optfilename - + return f def process_file(filename, fdesc, options, other_files = {}): @@ -1391,7 +1470,7 @@ def process_file(filename, fdesc, options, other_files = {}): filename: The full path to the .proto or .pb source file, as string. fdesc: The loaded FileDescriptorSet, or None to read from the input file. options: Command line options as they come from OptionsParser. - + Returns a dict: {'headername': Name of header file, 'headerdata': Data for the .h header file, @@ -1411,12 +1490,12 @@ def process_file(filename, fdesc, options, other_files = {}): headername = noext + options.extension + '.h' sourcename = noext + options.extension + '.c' headerbasename = os.path.basename(headername) - + # List of .proto files that should not be included in the C header file # even if they are mentioned in the source .proto. excludes = ['nanopb.proto', 'google/protobuf/descriptor.proto'] + options.exclude includes = [d for d in f.fdesc.dependency if d not in excludes] - + headerdata = ''.join(f.generate_header(includes, headerbasename, options)) sourcedata = ''.join(f.generate_source(headerbasename, options)) @@ -1430,30 +1509,42 @@ def process_file(filename, fdesc, options, other_files = {}): return {'headername': headername, 'headerdata': headerdata, 'sourcename': sourcename, 'sourcedata': sourcedata} - + def main_cli(): '''Main function when invoked directly from the command line.''' - + options, filenames = optparser.parse_args() - + if not filenames: optparser.print_help() sys.exit(1) - + if options.quiet: options.verbose = False + if options.output_dir and not os.path.exists(options.output_dir): + optparser.print_help() + sys.stderr.write("\noutput_dir does not exist: %s\n" % options.output_dir) + sys.exit(1) + + Globals.verbose_options = options.verbose - for filename in filenames: results = process_file(filename, None, options) - + + base_dir = options.output_dir or '' + to_write = [ + (os.path.join(base_dir, results['headername']), results['headerdata']), + (os.path.join(base_dir, results['sourcename']), results['sourcedata']), + ] + if not options.quiet: - sys.stderr.write("Writing to " + results['headername'] + " and " - + results['sourcename'] + "\n") - - open(results['headername'], 'w').write(results['headerdata']) - open(results['sourcename'], 'w').write(results['sourcedata']) + paths = " and ".join([x[0] for x in to_write]) + sys.stderr.write("Writing to %s\n" % paths) + + for path, data in to_write: + with open(path, 'w') as f: + f.write(data) def main_plugin(): '''Main function when invoked as a protoc plugin.''' @@ -1464,51 +1555,51 @@ def main_plugin(): # Set stdin and stdout to binary mode msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY) msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY) - + data = io.open(sys.stdin.fileno(), "rb").read() request = plugin_pb2.CodeGeneratorRequest.FromString(data) - + try: # Versions of Python prior to 2.7.3 do not support unicode # input to shlex.split(). Try to convert to str if possible. params = str(request.parameter) except UnicodeEncodeError: params = request.parameter - + import shlex args = shlex.split(params) options, dummy = optparser.parse_args(args) - + Globals.verbose_options = options.verbose - + response = plugin_pb2.CodeGeneratorResponse() - + # Google's protoc does not currently indicate the full path of proto files. # Instead always add the main file path to the search dirs, that works for # the common case. import os.path options.options_path.append(os.path.dirname(request.file_to_generate[0])) - + # Process any include files first, in order to have them # available as dependencies other_files = {} for fdesc in request.proto_file: other_files[fdesc.name] = parse_file(fdesc.name, fdesc, options) - + for filename in request.file_to_generate: for fdesc in request.proto_file: if fdesc.name == filename: results = process_file(filename, fdesc, options, other_files) - + f = response.file.add() f.name = results['headername'] f.content = results['headerdata'] f = response.file.add() f.name = results['sourcename'] - f.content = results['sourcedata'] - + f.content = results['sourcedata'] + io.open(sys.stdout.fileno(), "wb").write(response.SerializeToString()) if __name__ == '__main__': @@ -1517,4 +1608,3 @@ if __name__ == '__main__': main_plugin() else: main_cli() -