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
|
#!/usr/bin/env python
# -*- Mode: python; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
#
# 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 ContainerOutput import ContainerOutput
from ContainerInput import ContainerInput
class Message:
def __init__(self, dictionary, common_objects_dictionary):
# The message prefix
self.prefix = 'Qmi Message'
# The message service, e.g. "Ctl"
self.service = dictionary['service']
# The name of the specific message, e.g. "Something"
self.name = dictionary['name']
# The specific message ID
self.id = dictionary['id']
# The type, which must always be 'Message'
self.type = dictionary['type']
# Create the composed full name (prefix + service + name),
# e.g. "Qmi Message Ctl Something Output Result"
self.fullname = self.prefix + ' ' + self.service + ' ' + self.name
# Create the ID enumeration name
self.id_enum_name = string.upper(utils.build_underscore_name(self.fullname))
# Build output container.
# Every defined message will have its own output container, which
# will generate a new Output type and public getters for each output
# field
self.output = ContainerOutput(self.fullname,
dictionary['output'],
common_objects_dictionary)
# Build input container.
# Every defined message will have its own input container, which
# will generate a new Input type and public getters for each input
# field
self.input = ContainerInput(self.fullname,
dictionary['input'] if 'input' in dictionary else None,
common_objects_dictionary)
def __emit_request_creator(self, hfile, cfile):
translations = { 'name' : self.name,
'service' : self.service,
'container' : utils.build_camelcase_name (self.input.fullname),
'underscore' : utils.build_underscore_name (self.fullname),
'message_id' : self.id_enum_name }
input_arg_template = 'gpointer unused' if self.input.fields is None else '${container} *input'
template = (
'\n'
'QmiMessage *${underscore}_request_create (\n'
' guint8 transaction_id,\n'
' guint8 cid,\n'
' %s,\n'
' GError **error);\n' % input_arg_template)
hfile.write(string.Template(template).substitute(translations))
# Emit message creator
template = (
'\n'
'/**\n'
' * ${underscore}_request_create:\n'
' */\n'
'QmiMessage *\n'
'${underscore}_request_create (\n'
' guint8 transaction_id,\n'
' guint8 cid,\n'
' %s,\n'
' GError **error)\n'
'{\n'
' QmiMessage *self;\n'
'\n'
' self = qmi_message_new (QMI_SERVICE_${service},\n'
' cid,\n'
' transaction_id,\n'
' ${message_id});\n' % input_arg_template)
cfile.write(string.Template(template).substitute(translations))
if self.input.fields is not None:
# Count how many mandatory fields we have
n_mandatory = 0
for field in self.input.fields:
if field.mandatory == 'yes':
n_mandatory += 1
if n_mandatory == 0:
# If we don't have mandatory fields, we do allow to have
# a NULL input
cfile.write(
'\n'
' /* All TLVs are optional, we allow NULL input */\n'
' if (!input)\n'
' return self;\n')
else:
# If we do have mandatory fields, issue error if no input
# given.
cfile.write(
'\n'
' /* There is at least one mandatory TLV, don\'t allow NULL input */\n'
' if (!input) {\n'
' g_set_error (error,\n'
' QMI_CORE_ERROR,\n'
' QMI_CORE_ERROR_INVALID_ARGS,\n'
' "Message \'${name}\' has mandatory TLVs");\n'
' qmi_message_unref (self);\n'
' return NULL;\n'
' }\n')
# Now iterate fields
for field in self.input.fields:
translations['tlv_name'] = field.name
translations['variable_name'] = field.variable_name
template = (
'\n'
' /* Try to add the \'${tlv_name}\' TLV */\n'
' if (input->${variable_name}_set) {\n')
cfile.write(string.Template(template).substitute(translations))
# Emit the TLV getter
field.emit_input_tlv_add(cfile, ' ')
if field.mandatory == 'yes':
template = (
' } else {\n'
' g_set_error (error,\n'
' QMI_CORE_ERROR,\n'
' QMI_CORE_ERROR_INVALID_ARGS,\n'
' "Missing mandatory TLV \'${tlv_name}\' in message \'${name}\'");\n'
' qmi_message_unref (self);\n'
' return NULL;\n')
cfile.write(string.Template(template).substitute(translations))
cfile.write(
' }\n')
cfile.write(
'\n'
' return self;\n'
'}\n')
def __emit_response_parser(self, hfile, cfile):
translations = { 'name' : self.name,
'container' : utils.build_camelcase_name (self.output.fullname),
'container_underscore' : utils.build_underscore_name (self.output.fullname),
'underscore' : utils.build_underscore_name (self.fullname),
'message_id' : self.id_enum_name }
template = (
'\n'
'${container} *${underscore}_response_parse (\n'
' QmiMessage *message,\n'
' GError **error);\n')
hfile.write(string.Template(template).substitute(translations))
template = (
'\n'
'/**\n'
' * ${underscore}_response_parse:\n'
' * @message: a #QmiMessage response.\n'
' * @error: a #GError.\n'
' *\n'
' * Parse the \'${name}\' response.\n'
' *\n'
' * Returns: a #${container} which should be disposed with ${container_underscore}_unref(), or #NULL if @error is set.\n'
' */\n'
'${container} *\n'
'${underscore}_response_parse (\n'
' QmiMessage *message,\n'
' GError **error)\n'
'{\n'
' ${container} *self;\n'
'\n'
' g_return_val_if_fail (qmi_message_get_message_id (message) == ${message_id}, NULL);\n'
'\n'
' self = g_slice_new0 (${container});\n'
' self->ref_count = 1;\n')
cfile.write(string.Template(template).substitute(translations))
for field in self.output.fields:
cfile.write(
'\n'
' do {\n')
field.emit_output_prerequisite_check(cfile, ' ')
cfile.write(
'\n'
' {\n')
field.emit_output_tlv_get(cfile, ' ')
cfile.write(
'\n'
' }\n')
cfile.write(
' } while (0);\n')
cfile.write(
'\n'
' return self;\n'
'}\n')
def emit(self, hfile, cfile):
utils.add_separator(hfile, 'REQUEST/RESPONSE', self.fullname);
utils.add_separator(cfile, 'REQUEST/RESPONSE', self.fullname);
hfile.write('\n/* --- Input -- */\n');
cfile.write('\n/* --- Input -- */\n');
self.input.emit(hfile, cfile)
self.__emit_request_creator (hfile, cfile)
hfile.write('\n/* --- Output -- */\n');
cfile.write('\n/* --- Output -- */\n');
self.output.emit(hfile, cfile)
self.__emit_response_parser (hfile, cfile)
|
