diff options
| author | Aleksander Morgado <aleksander@lanedo.com> | 2013-05-21 15:14:59 +0200 |
|---|---|---|
| committer | Aleksander Morgado <aleksander@lanedo.com> | 2013-05-21 17:34:06 +0200 |
| commit | d5af6a58ad8f6c2aca9865300536f4f6d43724a8 (patch) | |
| tree | 0f123a46d91878a5defae8d511592f13d0e0ab27 /build-aux | |
| parent | dee368d110aa1c65cb4481da1d5c0e42d31381a2 (diff) | |
| download | libmbim-d5af6a58ad8f6c2aca9865300536f4f6d43724a8.tar.gz | |
mbim-codegen: document generated structs
Diffstat (limited to 'build-aux')
| -rw-r--r-- | build-aux/mbim-codegen/Struct.py | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/build-aux/mbim-codegen/Struct.py b/build-aux/mbim-codegen/Struct.py index 30a3a90..1321fd9 100644 --- a/build-aux/mbim-codegen/Struct.py +++ b/build-aux/mbim-codegen/Struct.py @@ -59,6 +59,52 @@ class Struct: translations = { 'name' : self.name } template = ( '\n' + '/**\n' + ' * ${name}:\n') + for field in self.contents: + translations['field_name_underscore'] = utils.build_underscore_name_from_camelcase(field['name']) + if field['format'] == 'uuid': + inner_template = ( + ' * @${field_name_underscore}: a #MbimUuid.\n') + elif field['format'] == 'guint32': + inner_template = ( + ' * @${field_name_underscore}: a #guint32.\n') + elif field['format'] == 'guint32-array': + inner_template = ( + ' * @${field_name_underscore}: an array of #guint32 values.\n') + elif field['format'] == 'guint64': + inner_template = ( + ' * @${field_name_underscore}: a #guint64.\n') + elif field['format'] == 'string': + inner_template = ( + ' * @${field_name_underscore}: a string.\n') + elif field['format'] == 'string-array': + inner_template = ( + ' * @${field_name_underscore}: an array of strings.\n') + elif field['format'] == 'ipv4': + inner_template = ( + ' * @${field_name_underscore}: a #MbimIPv4.\n') + elif field['format'] == 'ref-ipv4': + inner_template = ( + ' * @${field_name_underscore}: a #MbimIPv4.\n') + elif field['format'] == 'ipv4-array': + inner_template = ( + ' * @${field_name_underscore}: an array of #MbimIPv4 values.\n') + elif field['format'] == 'ipv6': + inner_template = ( + ' * @${field_name_underscore}: a #MbimIPv6\n') + elif field['format'] == 'ref-ipv6': + inner_template = ( + ' * @${field_name_underscore}: a #MbimIPv6\n') + elif field['format'] == 'ipv6-array': + inner_template = ( + ' * @${field_name_underscore}: an array of #MbimIPv6 values.\n') + else: + raise ValueError('Cannot handle format \'%s\' in struct' % field['format']) + template += string.Template(inner_template).substitute(translations) + + template += ( + ' */\n' 'typedef struct {\n') for field in self.contents: translations['field_name_underscore'] = utils.build_underscore_name_from_camelcase(field['name']) |