1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
#!/usr/bin/env python
# -*- Mode: python; tab-width: 4; indent-tabs-mode: nil -*-
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation; either version 2 of the License, or (at your option) any
# later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright (C) 2012 Lanedo GmbH
#
import string
import utils
from FieldResult import FieldResult
from Field import Field
"""
The Container class takes care of handling collections of Input or
Output fields
"""
class Container:
"""
Constructor
"""
def __init__(self, prefix, container_type, dictionary, common_objects_dictionary):
# The field container prefix usually contains the name of the Message,
# e.g. "Qmi Message Ctl Something"
self.prefix = prefix
# We may have 'Input' or 'Output' containers
if container_type == 'Input':
self.readonly = False
elif container_type == 'Output':
self.readonly = True
else:
raise ValueError('Cannot handle container type \'%s\'' % container_type)
self.name = container_type
# Create the composed full name (prefix + name),
# e.g. "Qmi Message Ctl Something Output"
self.fullname = self.prefix + ' ' + self.name
self.fields = None
if dictionary is not None:
self.fields = []
# First, look for references to common types
for field_dictionary in dictionary:
if 'common-ref' in field_dictionary:
for common in common_objects_dictionary:
if common['type'] == 'TLV' and \
common['common-ref'] == field_dictionary['common-ref']:
# Replace the reference with a copy of the common dictionary
# If the source reference has prerequisites, add them to the copy
copy = dict(common)
if 'prerequisites' in field_dictionary:
copy['prerequisites'] = field_dictionary['prerequisites']
dictionary.remove(field_dictionary)
dictionary.append(copy)
break
else:
raise RuntimeError('Common type \'%s\' not found' % field_dictionary['name'])
# We need to sort the fields, so that the ones with prerequisites are
# include after the prerequisites themselves. Note: we don't currently
# support complex setups yet.
sorted_dictionary = []
for field_dictionary in dictionary:
if 'prerequisites' in field_dictionary:
sorted_dictionary.append(field_dictionary)
else:
sorted_dictionary.insert(0, field_dictionary)
# Then, really parse each field
for field_dictionary in sorted_dictionary:
if field_dictionary['type'] == 'TLV':
if field_dictionary['format'] == 'struct' and \
field_dictionary['name'] == 'Result':
self.fields.append(FieldResult(self.fullname, field_dictionary, common_objects_dictionary))
else:
self.fields.append(Field(self.fullname, field_dictionary, common_objects_dictionary))
"""
Emit enumeration of TLVs in the container
"""
def __emit_tlv_ids_enum(self, f):
if self.fields is None:
return
translations = { 'enum_type' : utils.build_camelcase_name (self.fullname + ' TLV') }
template = (
'\n'
'/**\n'
' * ${enum_type}:\n')
f.write(string.Template(template).substitute(translations))
for tlv in self.fields:
translations['enum_name'] = tlv.id_enum_name
translations['enum_value'] = tlv.id
template = (
' * @${enum_name}: TODO,\n')
f.write(string.Template(template).substitute(translations))
template = (
' * TODO: comment enum\n'
' */\n'
'typedef enum {\n')
f.write(string.Template(template).substitute(translations))
for tlv in self.fields:
translations['enum_name'] = tlv.id_enum_name
translations['enum_value'] = tlv.id
template = (
' ${enum_name} = ${enum_value},\n')
f.write(string.Template(template).substitute(translations))
template = (
'} ${enum_type};\n')
f.write(string.Template(template).substitute(translations))
"""
Emit new container types
"""
def __emit_types(self, hfile, cfile, translations):
# Emit types header
template = (
'\n'
'typedef struct _${camelcase} ${camelcase};\n')
hfile.write(string.Template(template).substitute(translations))
# Emit types source
template = (
'\n'
'struct _${camelcase} {\n'
' volatile gint ref_count;\n')
cfile.write(string.Template(template).substitute(translations))
if self.fields is not None:
for field in self.fields:
if field.variable is not None:
variable_declaration = field.variable.build_variable_declaration(' ', field.variable_name)
translations['field_variable_name'] = field.variable_name
translations['field_name'] = field.name
template = (
'\n'
' /* ${field_name} */\n'
' gboolean ${field_variable_name}_set;\n')
cfile.write(string.Template(template).substitute(translations))
cfile.write(variable_declaration)
cfile.write(
'};\n')
"""
Emit container handling core implementation
"""
def __emit_core(self, hfile, cfile, translations):
# Emit container core header
template = (
'\n'
'${camelcase} *${underscore}_ref (${camelcase} *self);\n'
'void ${underscore}_unref (${camelcase} *self);\n')
if self.readonly == False:
template += (
'${camelcase} *${underscore}_new (void);\n')
hfile.write(string.Template(template).substitute(translations))
# Emit container core source
template = (
'\n'
'/**\n'
' * ${underscore}_ref:\n'
' * @self: a #${camelcase}.\n'
' *\n'
' * Atomically increments the reference count of @self by one.\n'
' *\n'
' * Returns: the new reference to @self.\n'
' */\n'
'${camelcase} *\n'
'${underscore}_ref (${camelcase} *self)\n'
'{\n'
' g_return_val_if_fail (self != NULL, NULL);\n'
'\n'
' g_atomic_int_inc (&self->ref_count);\n'
' return self;\n'
'}\n'
'\n'
'/**\n'
' * ${underscore}_unref:\n'
' * @self: a #${camelcase}.\n'
' *\n'
' * Atomically decrements the reference count of @self by one.\n'
' * If the reference count drops to 0, @self is completely disposed.\n'
' */\n'
'void\n'
'${underscore}_unref (${camelcase} *self)\n'
'{\n'
' g_return_if_fail (self != NULL);\n'
'\n'
' if (g_atomic_int_dec_and_test (&self->ref_count)) {\n')
cfile.write(string.Template(template).substitute(translations))
if self.fields is not None:
for field in self.fields:
if field.variable is not None and field.variable.needs_dispose is True:
template += field.variable.build_dispose(' ', 'self->' + field.variable_name)
template = (
' g_slice_free (${camelcase}, self);\n'
' }\n'
'}\n')
cfile.write(string.Template(template).substitute(translations))
# _new() is only generated if the container is not readonly
if self.readonly == True:
return
template = (
'\n'
'/**\n'
' * ${underscore}_new:\n'
' *\n'
' * Allocates a new ${camelcase}.\n'
' *\n'
' * Returns: the newly created ${camelcase}.\n'
' */\n'
'${camelcase} *\n'
'${underscore}_new (void)\n'
'{\n'
' ${camelcase} *self;\n'
'\n'
' self = g_slice_new0 (${camelcase});\n'
' self->ref_count = 1;\n'
' return self;\n'
'}\n')
cfile.write(string.Template(template).substitute(translations))
"""
Emit container implementation
"""
def emit(self, hfile, cfile):
translations = { 'name' : self.name,
'camelcase' : utils.build_camelcase_name (self.fullname),
'underscore' : utils.build_underscore_name (self.fullname) }
if self.fields is None:
template = ('\n'
'/* Note: no fields in the ${name} container */\n')
hfile.write(string.Template(template).substitute(translations))
cfile.write(string.Template(template).substitute(translations))
return
# Emit the container and field types
# Emit field getter/setter
if self.fields is not None:
for field in self.fields:
field.emit_types(hfile, cfile)
self.__emit_types(hfile, cfile, translations)
# Emit TLV enums
self.__emit_tlv_ids_enum(cfile)
# Emit fields
if self.fields is not None:
for field in self.fields:
field.emit_getter(hfile, cfile)
if self.readonly == False:
field.emit_setter(hfile, cfile)
# Emit the container core
self.__emit_core(hfile, cfile, translations)
|
