generator/nanopb_generator.py

   1 '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
   2
   3 import google.protobuf.descriptor_pb2 as descriptor
   4 import nanopb_pb2
   5 import os.path
   6
   7 # Values are tuple (c type, pb ltype)
   8 FieldD = descriptor.FieldDescriptorProto
   9 datatypes = {
  10     FieldD.TYPE_BOOL: ('bool', 'PB_LTYPE_VARINT'),
  11     FieldD.TYPE_DOUBLE: ('double', 'PB_LTYPE_FIXED'),
  12     FieldD.TYPE_FIXED32: ('uint32_t', 'PB_LTYPE_FIXED'),
  13     FieldD.TYPE_FIXED64: ('uint64_t', 'PB_LTYPE_FIXED'),
  14     FieldD.TYPE_FLOAT: ('float', 'PB_LTYPE_FIXED'),
  15     FieldD.TYPE_INT32: ('int32_t', 'PB_LTYPE_VARINT'),
  16     FieldD.TYPE_INT64: ('int64_t', 'PB_LTYPE_VARINT'),
  17     FieldD.TYPE_SFIXED32: ('int32_t', 'PB_LTYPE_FIXED'),
  18     FieldD.TYPE_SFIXED64: ('int64_t', 'PB_LTYPE_FIXED'),
  19     FieldD.TYPE_SINT32: ('int32_t', 'PB_LTYPE_SVARINT'),
  20     FieldD.TYPE_SINT64: ('int64_t', 'PB_LTYPE_SVARINT'),
  21     FieldD.TYPE_UINT32: ('uint32_t', 'PB_LTYPE_VARINT'),
  22     FieldD.TYPE_UINT64: ('uint64_t', 'PB_LTYPE_VARINT')
  23 }
  24
  25 class Names:
  26     '''Keeps a set of nested names and formats them to C identifier.
  27     You can subclass this with your own implementation.
  28     '''
  29     def __init__(self, parts = ()):
  30         if isinstance(parts, Names):
  31             parts = parts.parts
  32         self.parts = tuple(parts)
  33
  34     def __str__(self):
  35         return '_'.join(self.parts)
  36
  37     def __add__(self, other):
  38         if isinstance(other, (str, unicode)):
  39             return Names(self.parts + (other,))
  40         elif isinstance(other, tuple):
  41             return Names(self.parts + other)
  42         else:
  43             raise ValueError("Name parts should be of type str")
  44
  45 def names_from_type_name(type_name):
  46     '''Parse Names() from FieldDescriptorProto type_name'''
  47     if type_name[0] != '.':
  48         raise NotImplementedError("Lookup of non-absolute type names is not supported")
  49     return Names(type_name[1:].split('.'))
  50
  51 class Enum:
  52     def __init__(self, names, desc):
  53         '''desc is EnumDescriptorProto'''
  54         self.names = names + desc.name
  55         self.values = [(self.names + x.name, x.number) for x in desc.value]
  56
  57     def __str__(self):
  58         result = 'typedef enum {\n'
  59         result += ',\n'.join(["    %s = %d" % x for x in self.values])
  60         result += '\n} %s;' % self.names
  61         return result
  62
  63 class Field:
  64     def __init__(self, struct_name, desc):
  65         '''desc is FieldDescriptorProto'''
  66         self.tag = desc.number
  67         self.struct_name = struct_name
  68         self.name = desc.name
  69         self.default = None
  70         self.max_size = None
  71         self.max_count = None
  72         self.array_decl = ""
  73
  74         # Parse nanopb-specific field options
  75         if desc.options.HasExtension(nanopb_pb2.nanopb):
  76             ext = desc.options.Extensions[nanopb_pb2.nanopb]
  77             if ext.HasField("max_size"):
  78                 self.max_size = ext.max_size
  79             if ext.HasField("max_count"):
  80                 self.max_count = ext.max_count
  81
  82         if desc.HasField('default_value'):
  83             self.default = desc.default_value
  84
  85         # Decide HTYPE
  86         # HTYPE is the high-order nibble of nanopb field description,
  87         # defining whether value is required/optional/repeated.
  88         is_callback = False
  89         if desc.label == FieldD.LABEL_REQUIRED:
  90             self.htype = 'PB_HTYPE_REQUIRED'
  91         elif desc.label == FieldD.LABEL_OPTIONAL:
  92             self.htype = 'PB_HTYPE_OPTIONAL'
  93         elif desc.label == FieldD.LABEL_REPEATED:
  94             if self.max_count is None:
  95                 is_callback = True
  96             else:
  97                 self.htype = 'PB_HTYPE_ARRAY'
  98                 self.array_decl = '[%d]' % self.max_count
  99         else:
 100             raise NotImplementedError(desc.label)
 101
 102         # Decide LTYPE and CTYPE
 103         # LTYPE is the low-order nibble of nanopb field description,
 104         # defining how to decode an individual value.
 105         # CTYPE is the name of the c type to use in the struct.
 106         if datatypes.has_key(desc.type):
 107             self.ctype, self.ltype = datatypes[desc.type]
 108         elif desc.type == FieldD.TYPE_ENUM:
 109             self.ltype = 'PB_LTYPE_VARINT'
 110             self.ctype = names_from_type_name(desc.type_name)
 111             self.default = Names(self.ctype) + self.default
 112         elif desc.type == FieldD.TYPE_STRING:
 113             self.ltype = 'PB_LTYPE_STRING'
 114             if self.max_size is None:
 115                 is_callback = True
 116             else:
 117                 self.ctype = 'char'
 118                 self.array_decl += '[%d]' % self.max_size
 119         elif desc.type == FieldD.TYPE_BYTES:
 120             self.ltype = 'PB_LTYPE_BYTES'
 121             if self.max_size is None:
 122                 is_callback = True
 123             else:
 124                 self.ctype = self.struct_name + self.name + 't'
 125         elif desc.type == FieldD.TYPE_MESSAGE:
 126             self.ltype = 'PB_LTYPE_SUBMESSAGE'
 127             self.ctype = names_from_type_name(desc.type_name)
 128         else:
 129             raise NotImplementedError(desc.type)
 130
 131         if is_callback:
 132             self.htype = 'PB_HTYPE_CALLBACK'
 133             self.ctype = 'pb_callback_t'
 134             self.array_decl = ''
 135
 136     def __cmp__(self, other):
 137         return cmp(self.tag, other.tag)
 138
 139     def __str__(self):
 140         if self.htype == 'PB_HTYPE_OPTIONAL':
 141             result = '    bool has_' + self.name + ';\n'
 142         elif self.htype == 'PB_HTYPE_ARRAY':
 143             result = '    size_t ' + self.name + '_count;\n'
 144         else:
 145             result = ''
 146         result += '    %s %s%s;' % (self.ctype, self.name, self.array_decl)
 147         return result
 148
 149     def types(self):
 150         '''Return definitions for any special types this field might need.'''
 151         if self.ltype == 'PB_LTYPE_BYTES' and self.max_size is not None:
 152             result = 'typedef struct {\n'
 153             result += '    size_t size;\n'
 154             result += '    uint8_t bytes[%d];\n' % self.max_size
 155             result += '} %s;\n' % self.ctype
 156         else:
 157             result = None
 158         return result
 159
 160     def default_decl(self, declaration_only = False):
 161         '''Return definition for this field's default value.'''
 162         if self.default is None:
 163             return None
 164
 165         if self.ltype == 'PB_LTYPE_STRING':
 166             ctype = 'char'
 167             if self.max_size is None:
 168                 return None # Not implemented
 169             else:
 170                 array_decl = '[%d]' % self.max_size
 171             default = self.default.encode('string_escape')
 172             default = default.replace('"', '\\"')
 173             default = '"' + default + '"'
 174         elif self.ltype == 'PB_LTYPE_BYTES':
 175             data = self.default.decode('string_escape')
 176             data = ['0x%02x' % ord(c) for c in data]
 177
 178             if self.max_size is None:
 179                 return None # Not implemented
 180             else:
 181                 ctype = self.ctype
 182
 183             default = '{%d, {%s}}' % (len(data), ','.join(data))
 184             array_decl = ''
 185         else:
 186             ctype, default = self.ctype, self.default
 187             array_decl = ''
 188
 189         if declaration_only:
 190             return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
 191         else:
 192             return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
 193
 194     def pb_field_t(self, prev_field_name):
 195         '''Return the pb_field_t initializer to use in the constant array.
 196         prev_field_name is the name of the previous field or None.
 197         '''
 198         result = '    {%d, ' % self.tag
 199         result += self.htype
 200         if self.ltype is not None:
 201             result += ' | ' + self.ltype
 202         result += ',\n'
 203
 204         if prev_field_name is None:
 205             result += '    offsetof(%s, %s),' % (self.struct_name, self.name)
 206         else:
 207             result += '    pb_delta(%s, %s, %s),' % (self.struct_name, self.name, prev_field_name)
 208
 209         if self.htype == 'PB_HTYPE_OPTIONAL':
 210             result += '\n    pb_delta(%s, has_%s, %s),' % (self.struct_name, self.name, self.name)
 211         elif self.htype == 'PB_HTYPE_ARRAY':
 212             result += '\n    pb_delta(%s, %s_count, %s),' % (self.struct_name, self.name, self.name)
 213         else:
 214             result += ' 0,'
 215
 216
 217         if self.htype == 'PB_HTYPE_ARRAY':
 218             result += '\n    pb_membersize(%s, %s[0]),' % (self.struct_name, self.name)
 219             result += ('\n    pb_membersize(%s, %s) / pb_membersize(%s, %s[0]),'
 220                        % (self.struct_name, self.name, self.struct_name, self.name))
 221         else:
 222             result += '\n    pb_membersize(%s, %s),' % (self.struct_name, self.name)
 223             result += ' 0,'
 224
 225         if self.ltype == 'PB_LTYPE_SUBMESSAGE':
 226             result += '\n    &%s_fields}' % self.ctype
 227         elif self.default is None or self.htype == 'PB_HTYPE_CALLBACK':
 228             result += ' 0}'
 229         else:
 230             result += '\n    &%s_default}' % (self.struct_name + self.name)
 231
 232         return result
 233
 234 class Message:
 235     def __init__(self, names, desc):
 236         self.name = names
 237         self.fields = [Field(self.name, f) for f in desc.field]
 238         self.ordered_fields = self.fields[:]
 239         self.ordered_fields.sort()
 240
 241     def __cmp__(self, other):
 242         '''Sort messages so that submessages are declared before the message
 243         that uses them.
 244         '''
 245         if self.refers_to(other.name):
 246             return 1
 247         elif other.refers_to(self.name):
 248             return -1
 249         else:
 250             return 0
 251
 252     def refers_to(self, name):
 253         '''Returns True if this message uses the specified type as field type.'''
 254         for field in self.fields:
 255             if str(field.ctype) == str(name):
 256                 return True
 257         return False
 258
 259     def __str__(self):
 260         result = 'typedef struct {\n'
 261         result += '\n'.join([str(f) for f in self.ordered_fields])
 262         result += '\n} %s;' % self.name
 263         return result
 264
 265     def types(self):
 266         result = ""
 267         for field in self.fields:
 268             types = field.types()
 269             if types is not None:
 270                 result += types + '\n'
 271         return result
 272
 273     def default_decl(self, declaration_only = False):
 274         result = ""
 275         for field in self.fields:
 276             default = field.default_decl(declaration_only)
 277             if default is not None:
 278                 result += default + '\n'
 279         return result
 280
 281     def fields_declaration(self):
 282         result = 'extern const pb_field_t %s_fields[%d];' % (self.name, len(self.fields))
 283         return result
 284
 285     def fields_definition(self):
 286         result = 'const pb_field_t %s_fields[%d] = {\n' % (self.name, len(self.fields))
 287
 288         prev = None
 289         for field in self.ordered_fields:
 290             result += field.pb_field_t(prev)
 291             result += ',\n\n'
 292             prev = field.name
 293
 294         result = result[:-3] + '\n};'
 295         return result
 296
 297 def iterate_messages(desc, names = Names()):
 298     '''Recursively find all messages. For each, yield name, DescriptorProto.'''
 299     if hasattr(desc, 'message_type'):
 300         submsgs = desc.message_type
 301     else:
 302         submsgs = desc.nested_type
 303
 304     for submsg in submsgs:
 305         sub_names = names + submsg.name
 306         yield sub_names, submsg
 307
 308         for x in iterate_messages(submsg, sub_names):
 309             yield x
 310
 311 def parse_file(fdesc):
 312     '''Takes a FileDescriptorProto and returns tuple (enum, messages).'''
 313
 314     enums = []
 315     messages = []
 316
 317     for enum in fdesc.enum_type:
 318         enums.append(Enum(Names(), enum))
 319
 320     for names, message in iterate_messages(fdesc):
 321         messages.append(Message(names, message))
 322         for enum in message.enum_type:
 323             enums.append(Enum(names, enum))
 324
 325     return enums, messages
 326
 327 def generate_header(headername, enums, messages):
 328     '''Generate content for a header file.
 329     Generates strings, which should be concatenated and stored to file.
 330     '''
 331
 332     yield '/* Automatically generated nanopb header */\n'
 333
 334     symbol = headername.replace('.', '_').upper()
 335     yield '#ifndef _PB_%s_\n' % symbol
 336     yield '#define _PB_%s_\n' % symbol
 337     yield '#include <pb.h>\n\n'
 338
 339     yield '/* Enum definitions */\n'
 340     for enum in enums:
 341         yield str(enum) + '\n\n'
 342
 343     yield '/* Struct definitions */\n'
 344     messages.sort()
 345     for msg in messages:
 346         yield msg.types()
 347         yield str(msg) + '\n\n'
 348
 349     yield '/* Default values for struct fields */\n'
 350     for msg in messages:
 351         yield msg.default_decl(True)
 352     yield '\n'
 353
 354     yield '/* Struct field encoding specification for nanopb */\n'
 355     for msg in messages:
 356         yield msg.fields_declaration() + '\n'
 357
 358     yield '\n#endif\n'
 359
 360 def generate_source(headername, enums, messages):
 361     '''Generate content for a source file.'''
 362
 363     yield '/* Automatically generated nanopb constant definitions */\n'
 364     yield '#include "%s"\n\n' % headername
 365
 366     for msg in messages:
 367         yield msg.default_decl(False)
 368
 369     yield '\n\n'
 370
 371     for msg in messages:
 372         yield msg.fields_definition() + '\n\n'
 373
 374 if __name__ == '__main__':
 375     import sys
 376     import os.path
 377
 378     if len(sys.argv) != 2:
 379         print "Usage: " + sys.argv[0] + " file.pb"
 380         print "where file.pb has been compiled from .proto by:"
 381         print "protoc -ofile.pb file.proto"
 382         print "Output fill be written to file.h and file.c"
 383         sys.exit(1)
 384
 385     data = open(sys.argv[1]).read()
 386     fdesc = descriptor.FileDescriptorSet.FromString(data)
 387     enums, messages = parse_file(fdesc.file[0])
 388
 389     noext = os.path.splitext(sys.argv[1])[0]
 390     headername = noext + '.h'
 391     sourcename = noext + '.c'
 392     headerbasename = os.path.basename(headername)
 393
 394     print "Writing to " + headername + " and " + sourcename
 395
 396     header = open(headername, 'w')
 397     for part in generate_header(headerbasename, enums, messages):
 398         header.write(part)
 399
 400     source = open(sourcename, 'w')
 401     for part in generate_source(headerbasename, enums, messages):
 402         source.write(part)
 403
 404