#!/usr/bin/python
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
-nanopb_version = "nanopb-0.3.1-dev"
+nanopb_version = "nanopb-0.3.4-dev"
import sys
+import re
try:
# Add some dummy imports to keep packaging tools happy.
import time
import os.path
-# Values are tuple (c type, pb type, encoded size)
+# Values are tuple (c type, pb type, encoded size, int_size_allowed)
FieldD = descriptor.FieldDescriptorProto
datatypes = {
- FieldD.TYPE_BOOL: ('bool', 'BOOL', 1),
- FieldD.TYPE_DOUBLE: ('double', 'DOUBLE', 8),
- FieldD.TYPE_FIXED32: ('uint32_t', 'FIXED32', 4),
- FieldD.TYPE_FIXED64: ('uint64_t', 'FIXED64', 8),
- FieldD.TYPE_FLOAT: ('float', 'FLOAT', 4),
- FieldD.TYPE_INT32: ('int32_t', 'INT32', 10),
- FieldD.TYPE_INT64: ('int64_t', 'INT64', 10),
- FieldD.TYPE_SFIXED32: ('int32_t', 'SFIXED32', 4),
- FieldD.TYPE_SFIXED64: ('int64_t', 'SFIXED64', 8),
- FieldD.TYPE_SINT32: ('int32_t', 'SINT32', 5),
- FieldD.TYPE_SINT64: ('int64_t', 'SINT64', 10),
- FieldD.TYPE_UINT32: ('uint32_t', 'UINT32', 5),
- FieldD.TYPE_UINT64: ('uint64_t', 'UINT64', 10)
+ FieldD.TYPE_BOOL: ('bool', 'BOOL', 1, False),
+ FieldD.TYPE_DOUBLE: ('double', 'DOUBLE', 8, False),
+ FieldD.TYPE_FIXED32: ('uint32_t', 'FIXED32', 4, False),
+ FieldD.TYPE_FIXED64: ('uint64_t', 'FIXED64', 8, False),
+ FieldD.TYPE_FLOAT: ('float', 'FLOAT', 4, False),
+ FieldD.TYPE_INT32: ('int32_t', 'INT32', 10, True),
+ FieldD.TYPE_INT64: ('int64_t', 'INT64', 10, True),
+ FieldD.TYPE_SFIXED32: ('int32_t', 'SFIXED32', 4, False),
+ FieldD.TYPE_SFIXED64: ('int64_t', 'SFIXED64', 8, False),
+ FieldD.TYPE_SINT32: ('int32_t', 'SINT32', 5, True),
+ FieldD.TYPE_SINT64: ('int64_t', 'SINT64', 10, True),
+ FieldD.TYPE_UINT32: ('uint32_t', 'UINT32', 5, True),
+ FieldD.TYPE_UINT64: ('uint64_t', 'UINT64', 10, True)
+}
+
+# Integer size overrides (from .proto settings)
+intsizes = {
+ nanopb_pb2.IS_8: 'int8_t',
+ nanopb_pb2.IS_16: 'int16_t',
+ nanopb_pb2.IS_32: 'int32_t',
+ nanopb_pb2.IS_64: 'int64_t',
}
class Names:
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 __str__(self):
result = 'typedef enum _%s {\n' % self.names
result += ',\n'.join([" %s = %d" % x for x in self.values])
- result += '\n} %s;' % self.names
+ result += '\n}'
+
+ if self.packed:
+ result += ' pb_packed'
+
+ result += ' %s;' % self.names
+
+ 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 Field:
'''desc is FieldDescriptorProto'''
self.tag = desc.number
self.struct_name = struct_name
+ self.union_name = None
self.name = desc.name
self.default = None
self.max_size = None
# Decide the C data type to use in the struct.
if datatypes.has_key(desc.type):
- self.ctype, self.pbtype, self.enc_size = datatypes[desc.type]
+ self.ctype, self.pbtype, self.enc_size, isa = datatypes[desc.type]
+
+ # Override the field size if user wants to use smaller integers
+ if isa and field_options.int_size != nanopb_pb2.IS_DEFAULT:
+ self.ctype = intsizes[field_options.int_size]
+ if desc.type == FieldD.TYPE_UINT32 or desc.type == FieldD.TYPE_UINT64:
+ self.ctype = 'u' + self.ctype;
elif desc.type == FieldD.TYPE_ENUM:
self.pbtype = 'ENUM'
self.ctype = names_from_type_name(desc.type_name)
if self.pbtype == 'BYTES' and self.allocation == 'STATIC':
result = 'typedef PB_BYTES_ARRAY_T(%d) %s;\n' % (self.max_size, self.ctype)
else:
- result = None
+ result = ''
return result
- def get_initializer(self, null_init):
- '''Return literal expression for this field's default value.'''
-
+ def get_dependencies(self):
+ '''Get list of type names used by this field.'''
+ if self.allocation == 'STATIC':
+ return [str(self.ctype)]
+ else:
+ return []
+
+ def get_initializer(self, null_init, inner_init_only = False):
+ '''Return literal expression for this field's default value.
+ null_init: If True, initialize to a 0 value instead of default from .proto
+ inner_init_only: If True, exclude initialization for any count/has fields
+ '''
+
+ inner_init = None
if self.pbtype == 'MESSAGE':
if null_init:
- return '%s_init_zero' % self.ctype
+ inner_init = '%s_init_zero' % self.ctype
else:
- return '%s_init_default' % self.ctype
-
- if self.default is None or null_init:
+ inner_init = '%s_init_default' % self.ctype
+ elif self.default is None or null_init:
if self.pbtype == 'STRING':
- return '""'
+ inner_init = '""'
elif self.pbtype == 'BYTES':
- return '{0, {0}}'
+ inner_init = '{0, {0}}'
elif self.pbtype == 'ENUM':
- return '(%s)0' % self.ctype
+ inner_init = '(%s)0' % self.ctype
else:
- return '0'
-
- default = str(self.default)
-
- if self.pbtype == 'STRING':
- default = default.encode('utf-8').encode('string_escape')
- default = default.replace('"', '\\"')
- default = '"' + default + '"'
- elif self.pbtype == 'BYTES':
- data = default.decode('string_escape')
- data = ['0x%02x' % ord(c) for c in data]
- if len(data) == 0:
- default = '{0, {0}}'
+ 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 = '"' + inner_init + '"'
+ elif self.pbtype == 'BYTES':
+ data = str(self.default).decode('string_escape')
+ data = ['0x%02x' % ord(c) for c in data]
+ if len(data) == 0:
+ inner_init = '{0, {0}}'
+ 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']:
+ inner_init = str(self.default) + 'ull'
+ elif self.pbtype in ['SFIXED64', 'INT64']:
+ inner_init = str(self.default) + 'll'
else:
- default = '{%d, {%s}}' % (len(data), ','.join(data))
- elif self.pbtype in ['FIXED32', 'UINT32']:
- default += 'u'
- elif self.pbtype in ['FIXED64', 'UINT64']:
- default += 'ull'
- elif self.pbtype in ['SFIXED64', 'INT64']:
- default += 'll'
+ inner_init = str(self.default)
- return default
-
+ if inner_init_only:
+ return inner_init
+
+ outer_init = None
+ if self.allocation == 'STATIC':
+ if self.rules == 'REPEATED':
+ outer_init = '0, {'
+ outer_init += ', '.join([inner_init] * self.max_count)
+ outer_init += '}'
+ elif self.rules == 'OPTIONAL':
+ outer_init = 'false, ' + inner_init
+ else:
+ outer_init = inner_init
+ elif self.allocation == 'POINTER':
+ if self.rules == 'REPEATED':
+ outer_init = '0, NULL'
+ else:
+ outer_init = 'NULL'
+ elif self.allocation == 'CALLBACK':
+ if self.pbtype == 'EXTENSION':
+ outer_init = 'NULL'
+ else:
+ outer_init = '{{NULL}, NULL}'
+
+ return outer_init
+
def default_decl(self, declaration_only = False):
'''Return definition for this field's default value.'''
if self.default is None:
return None
ctype = self.ctype
- default = self.get_initializer(False)
+ default = self.get_initializer(False, True)
array_decl = ''
if self.pbtype == 'STRING':
'''Return the pb_field_t initializer to use in the constant array.
prev_field_name is the name of the previous field or None.
'''
- result = ' PB_FIELD(%3d, ' % self.tag
+
+ if self.rules == 'ONEOF':
+ 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
if self.pbtype == 'MESSAGE':
if self.rules == 'REPEATED' and self.allocation == 'STATIC':
return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
+ elif self.rules == 'ONEOF':
+ return 'pb_membersize(%s, %s.%s)' % (self.struct_name, self.union_name, self.name)
else:
return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
return ' pb_extension_t *extensions;'
def types(self):
- return None
+ return ''
def tags(self):
return ''
msg +=' type of extension fields is currently supported. */\n'
return msg
- return 'extern const pb_extension_type_t %s;\n' % self.fullname
+ return ('extern const pb_extension_type_t %s; /* field type: %s */\n' %
+ (self.fullname, str(self).strip()))
def extension_def(self):
'''Definition of the extension type in the .pb.c file'''
return result
+# ---------------------------------------------------------------------------
+# Generation of oneofs (unions)
+# ---------------------------------------------------------------------------
+
+class OneOf(Field):
+ def __init__(self, struct_name, oneof_desc):
+ self.struct_name = struct_name
+ self.name = oneof_desc.name
+ self.ctype = 'union'
+ self.fields = []
+ self.allocation = 'ONEOF'
+ self.default = None
+ self.rules = 'ONEOF'
+
+ def add_field(self, field):
+ if field.allocation == 'CALLBACK':
+ raise Exception("Callback fields inside of oneof are not supported"
+ + " (field %s)" % field.name)
+
+ field.union_name = self.name
+ field.rules = 'ONEOF'
+ self.fields.append(field)
+ self.fields.sort(key = lambda f: f.tag)
+
+ # Sort by the lowest tag number inside union
+ self.tag = min([f.tag for f in self.fields])
+
+ def __cmp__(self, other):
+ return cmp(self.tag, other.tag)
+
+ def __str__(self):
+ result = ''
+ if self.fields:
+ result += ' pb_size_t which_' + self.name + ";\n"
+ result += ' union {\n'
+ for f in self.fields:
+ result += ' ' + str(f).replace('\n', '\n ') + '\n'
+ result += ' } ' + self.name + ';'
+ return result
+
+ def types(self):
+ return ''.join([f.types() for f in self.fields])
+
+ def get_dependencies(self):
+ deps = []
+ for f in self.fields:
+ deps += f.get_dependencies()
+ return deps
+
+ def get_initializer(self, null_init):
+ return '0, {' + self.fields[0].get_initializer(null_init) + '}'
+
+ def default_decl(self, declaration_only = False):
+ return None
+
+ def tags(self):
+ return '\n'.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 largest_field_value(self):
+ return max([f.largest_field_value() for f in self.fields])
+
+ def encoded_size(self, allmsgs):
+ largest = EncodedSize(0)
+ for f in self.fields:
+ size = f.encoded_size(allmsgs)
+ if size is None:
+ return None
+ elif size.symbols:
+ return None # Cannot resolve maximum of symbols
+ elif size.value > largest.value:
+ largest = size
+
+ return largest
+
# ---------------------------------------------------------------------------
# Generation of messages (structures)
# ---------------------------------------------------------------------------
def __init__(self, names, desc, message_options):
self.name = names
self.fields = []
-
+ self.oneofs = {}
+ no_unions = []
+
+ if message_options.msgid:
+ self.msgid = message_options.msgid
+
+ if hasattr(desc, 'oneof_decl'):
+ for i, f in enumerate(desc.oneof_decl):
+ oneof_options = get_nanopb_suboptions(desc, message_options, self.name + f.name)
+ if oneof_options.no_unions:
+ no_unions.append(i) # No union, but add fields normally
+ elif oneof_options.type == nanopb_pb2.FT_IGNORE:
+ pass # No union and skip fields also
+ else:
+ oneof = OneOf(self.name, f)
+ self.oneofs[i] = oneof
+ self.fields.append(oneof)
+
for f in desc.field:
field_options = get_nanopb_suboptions(f, message_options, self.name + f.name)
- if field_options.type != nanopb_pb2.FT_IGNORE:
- self.fields.append(Field(self.name, f, field_options))
+ if field_options.type == nanopb_pb2.FT_IGNORE:
+ continue
+
+ field = Field(self.name, f, field_options)
+ if (hasattr(f, 'oneof_index') and
+ f.HasField('oneof_index') and
+ f.oneof_index not in no_unions):
+ if f.oneof_index in self.oneofs:
+ 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')
def get_dependencies(self):
'''Get list of type names that this structure refers to.'''
- return [str(field.ctype) for field in self.fields if field.allocation == 'STATIC']
+ deps = []
+ for f in self.fields:
+ deps += f.get_dependencies()
+ return deps
def __str__(self):
result = 'typedef struct _%s {\n' % self.name
return result
def types(self):
- result = ""
- for field in self.fields:
- types = field.types()
- if types is not None:
- result += types + '\n'
- return result
-
+ 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:
- if field.allocation == 'STATIC':
- if field.rules == 'REPEATED':
- parts.append('0')
- parts.append('{'
- + ', '.join([field.get_initializer(null_init)] * field.max_count)
- + '}')
- elif field.rules == 'OPTIONAL':
- parts.append('false')
- parts.append(field.get_initializer(null_init))
- else:
- parts.append(field.get_initializer(null_init))
- elif field.allocation == 'POINTER':
- if field.rules == 'REPEATED':
- parts.append('0')
- parts.append('NULL')
- elif field.allocation == 'CALLBACK':
- if field.pbtype == 'EXTENSION':
- parts.append('NULL')
- else:
- parts.append('{{NULL}, NULL}')
+ parts.append(field.get_initializer(null_init))
return '{' + ', '.join(parts) + '}'
def default_decl(self, declaration_only = False):
result += default + '\n'
return result
+ def count_required_fields(self):
+ '''Returns number of required fields inside this message'''
+ count = 0
+ for f in self.fields:
+ if not isinstance(f, OneOf):
+ if f.rules == 'REQUIRED':
+ count += 1
+ return count
+
+ def count_all_fields(self):
+ count = 0
+ for f in self.fields:
+ if isinstance(f, OneOf):
+ count += len(f.fields)
+ else:
+ count += 1
+ return count
+
def fields_declaration(self):
- result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields) + 1)
+ result = 'extern const pb_field_t %s_fields[%d];' % (self.name, self.count_all_fields() + 1)
return result
def fields_definition(self):
- result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields) + 1)
+ 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'
- prev = field.name
+ if isinstance(field, OneOf):
+ prev = field.name + '.' + field.fields[-1].name
+ else:
+ prev = field.name
result += ' PB_LAST_FIELD\n};'
return result
if message_options.skip_message:
continue
-
+
messages.append(Message(names, message, message_options))
for enum in message.enum_type:
enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name)
identifier = '%s_size' % msg.name
yield '#define %-40s %s\n' % (identifier, msize)
yield '\n'
+
+ yield '/* Message IDs (where set with "msgid" option) */\n'
+ yield '#ifdef PB_MSGID\n'
+ for msg in messages:
+ if hasattr(msg,'msgid'):
+ yield '#define PB_MSG_%d %s\n' % (msg.msgid, msg.name)
+ yield '\n'
+
+ symbol = make_identifier(headername.split('.')[0])
+ yield '#define %s_MESSAGES \\\n' % symbol
+
+ for msg in messages:
+ m = "-1"
+ msize = msg.encoded_size(messages)
+ if msize is not None:
+ m = msize
+ if hasattr(msg,'msgid'):
+ yield '\tPB_MSG(%d,%s,%s) \\\n' % (msg.msgid, m, msg.name)
+ yield '\n'
+
+ for msg in messages:
+ if hasattr(msg,'msgid'):
+ yield '#define %s_msgid %d\n' % (msg.name, msg.msgid)
+ yield '\n'
+
+ yield '#endif\n\n'
+
+
yield '#ifdef __cplusplus\n'
yield '} /* extern "C" */\n'
yield '#endif\n'
# Add checks for numeric limits
if messages:
- count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED'])
- largest_msg = max(messages, key = count_required_fields)
- largest_count = count_required_fields(largest_msg)
+ largest_msg = max(messages, key = lambda m: m.count_required_fields())
+ largest_count = largest_msg.count_required_fields()
if largest_count > 64:
yield '\n/* Check that missing required fields will be properly detected */\n'
yield '#if PB_MAX_REQUIRED_FIELDS < %d\n' % largest_count
[(namemask, options), ...]
'''
results = []
- for line in infile:
+ data = infile.read()
+ data = re.sub('/\*.*?\*/', '', data, flags = re.MULTILINE)
+ data = re.sub('//.*?$', '', data, flags = re.MULTILINE)
+ data = re.sub('#.*?$', '', data, flags = re.MULTILINE)
+ for i, line in enumerate(data.split('\n')):
line = line.strip()
- if not line or line.startswith('//') or line.startswith('#'):
+ 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()
- text_format.Merge(parts[1], opts)
+
+ try:
+ text_format.Merge(parts[1], opts)
+ except Exception, e:
+ sys.stderr.write("%s:%d: " % (infile.name, i + 1) +
+ "Unparseable option line: '%s'. " % line +
+ "Error: %s\n" % str(e))
+ continue
results.append((parts[0], opts))
return results
data = sys.stdin.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(request.parameter)
+ args = shlex.split(params)
options, dummy = optparser.parse_args(args)
Globals.verbose_options = options.verbose