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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
#!/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
# Copyright (C) 2012-2017 Aleksander Morgado <aleksander@aleksander.es>
#
import string
from Message import Message
import utils
"""
The MessageList class handles the generation of all messages for a given
specific service
"""
class MessageList:
"""
Constructor
"""
def __init__(self, objects_dictionary, common_objects_dictionary):
self.list = []
self.message_id_enum_name = None
self.indication_id_enum_name = None
self.service = None
# Loop items in the list, creating Message objects for the messages
# and looking for the special 'Message-ID-Enum' type
for object_dictionary in objects_dictionary:
if object_dictionary['type'] == 'Message' or \
object_dictionary['type'] == 'Indication':
message = Message(object_dictionary, common_objects_dictionary)
self.list.append(message)
elif object_dictionary['type'] == 'Message-ID-Enum':
self.message_id_enum_name = object_dictionary['name']
elif object_dictionary['type'] == 'Indication-ID-Enum':
self.indication_id_enum_name = object_dictionary['name']
elif object_dictionary['type'] == 'Service':
self.service = object_dictionary['name']
# We NEED the Message-ID-Enum field
if self.message_id_enum_name is None:
raise ValueError('Missing Message-ID-Enum field')
# We NEED the Service field
if self.service is None:
raise ValueError('Missing Service field')
"""
Emit the enumeration of the messages found in the specific service
"""
def emit_message_ids_enum(self, f):
translations = { 'enum_type' : utils.build_camelcase_name (self.message_id_enum_name) }
template = (
'\n'
'typedef enum {\n')
for message in self.list:
if message.type == 'Message':
translations['enum_name'] = message.id_enum_name
translations['enum_value'] = message.id
if message.vendor is None:
enum_template = (
' ${enum_name} = ${enum_value},\n')
else:
translations['vendor'] = message.vendor
enum_template = (
' ${enum_name} = ${enum_value}, /* vendor ${vendor} */\n')
template += string.Template(enum_template).substitute(translations)
template += (
'} ${enum_type};\n'
'\n')
f.write(string.Template(template).substitute(translations))
"""
Emit the enumeration of the indications found in the specific service
"""
def emit_indication_ids_enum(self, f):
translations = { 'enum_type' : utils.build_camelcase_name (self.indication_id_enum_name) }
template = (
'\n'
'typedef enum {\n')
for message in self.list:
if message.type == 'Indication':
translations['enum_name'] = message.id_enum_name
translations['enum_value'] = message.id
enum_template = (
' ${enum_name} = ${enum_value},\n')
template += string.Template(enum_template).substitute(translations)
template += (
'} ${enum_type};\n'
'\n')
f.write(string.Template(template).substitute(translations))
"""
Emit the method responsible for getting a printable representation of all
messages of a given service.
"""
def __emit_get_printable(self, hfile, cfile):
translations = { 'service' : self.service.lower() }
template = (
'\n'
'#if defined (LIBQMI_GLIB_COMPILATION)\n'
'\n'
'G_GNUC_INTERNAL\n'
'gchar *__qmi_message_${service}_get_printable (\n'
' QmiMessage *self,\n'
' QmiMessageContext *context,\n'
' const gchar *line_prefix);\n'
'\n'
'#endif\n'
'\n')
hfile.write(string.Template(template).substitute(translations))
template = (
'\n'
'gchar *\n'
'__qmi_message_${service}_get_printable (\n'
' QmiMessage *self,\n'
' QmiMessageContext *context,\n'
' const gchar *line_prefix)\n'
'{\n'
' if (qmi_message_is_indication (self)) {\n'
' switch (qmi_message_get_message_id (self)) {\n')
for message in self.list:
if message.type == 'Indication':
translations['enum_name'] = message.id_enum_name
translations['message_underscore'] = utils.build_underscore_name (message.name)
inner_template = (
' case ${enum_name}:\n'
' return indication_${message_underscore}_get_printable (self, line_prefix);\n')
template += string.Template(inner_template).substitute(translations)
template += (
' default:\n'
' return NULL;\n'
' }\n'
' } else {\n'
' guint16 vendor_id;\n'
'\n'
' vendor_id = (context ? qmi_message_context_get_vendor_id (context) : QMI_MESSAGE_VENDOR_GENERIC);\n'
' if (vendor_id == QMI_MESSAGE_VENDOR_GENERIC) {\n'
' switch (qmi_message_get_message_id (self)) {\n')
for message in self.list:
if message.type == 'Message' and message.vendor is None:
translations['enum_name'] = message.id_enum_name
translations['message_underscore'] = utils.build_underscore_name (message.name)
inner_template = (
' case ${enum_name}:\n'
' return message_${message_underscore}_get_printable (self, line_prefix);\n')
template += string.Template(inner_template).substitute(translations)
template += (
' default:\n'
' return NULL;\n'
' }\n'
' } else {\n')
for message in self.list:
if message.type == 'Message' and message.vendor is not None:
translations['enum_name'] = message.id_enum_name
translations['message_underscore'] = utils.build_underscore_name (message.name)
translations['message_vendor'] = message.vendor
inner_template = (
' if (vendor_id == ${message_vendor} && (qmi_message_get_message_id (self) == ${enum_name}))\n'
' return message_${message_underscore}_get_printable (self, line_prefix);\n')
template += string.Template(inner_template).substitute(translations)
template += (
' return NULL;\n'
' }\n'
' }\n'
'}\n')
cfile.write(string.Template(template).substitute(translations))
"""
Emit the method responsible for getting in which version the messages were
introduced.
"""
def __emit_get_version_introduced(self, hfile, cfile):
translations = { 'service' : self.service.lower() }
template = (
'\n'
'#if defined (LIBQMI_GLIB_COMPILATION)\n'
'\n'
'G_GNUC_INTERNAL\n'
'gboolean __qmi_message_${service}_get_version_introduced (\n'
' QmiMessage *self,\n'
' QmiMessageContext *context,\n'
' guint *major,\n'
' guint *minor);\n'
'\n'
'#endif\n'
'\n')
hfile.write(string.Template(template).substitute(translations))
template = (
'\n'
'gboolean\n'
'__qmi_message_${service}_get_version_introduced (\n'
' QmiMessage *self,\n'
' QmiMessageContext *context,\n'
' guint *major,\n'
' guint *minor)\n'
'{\n'
' guint16 vendor_id;\n'
'\n'
' vendor_id = (context ? qmi_message_context_get_vendor_id (context) : QMI_MESSAGE_VENDOR_GENERIC);\n'
' if (vendor_id == QMI_MESSAGE_VENDOR_GENERIC) {\n'
' switch (qmi_message_get_message_id (self)) {\n')
for message in self.list:
if message.type == 'Message' and message.vendor is None:
# Only add if we know the version info
if message.version_info != []:
translations['enum_name'] = message.id_enum_name
translations['message_major'] = message.version_info[0]
translations['message_minor'] = message.version_info[1]
inner_template = (
' case ${enum_name}:\n'
' *major = ${message_major};\n'
' *minor = ${message_minor};\n'
' return TRUE;\n')
template += string.Template(inner_template).substitute(translations)
template += (
' default:\n'
' return FALSE;\n'
' }\n'
' } else {\n')
for message in self.list:
if message.type == 'Message' and message.vendor is not None:
# Only add if we know the version info
if message.version_info != []:
translations['enum_name'] = message.id_enum_name
translations['message_major'] = message.version_info[0]
translations['message_minor'] = message.version_info[1]
translations['message_vendor'] = message.vendor
inner_template = (
' if (vendor_id == ${message_vendor} && (qmi_message_get_message_id (self) == ${enum_name})) {\n'
' *major = ${message_major};\n'
' *minor = ${message_minor};\n'
' return TRUE;\n'
' }\n')
template += string.Template(inner_template).substitute(translations)
template += (
' return FALSE;\n'
' }\n'
'}\n')
cfile.write(string.Template(template).substitute(translations))
"""
Emit the message list handling implementation
"""
def emit(self, hfile, cfile):
# First, emit the message/indication IDs enum
self.emit_message_ids_enum(cfile)
if self.indication_id_enum_name is not None:
self.emit_indication_ids_enum(cfile)
# Then, emit all message handlers
for message in self.list:
message.emit(hfile, cfile)
# First, emit common class code
utils.add_separator(hfile, 'Service-specific printable', self.service);
utils.add_separator(cfile, 'Service-specific printable', self.service);
self.__emit_get_printable(hfile, cfile)
self.__emit_get_version_introduced(hfile, cfile)
"""
Emit the sections
"""
def emit_sections(self, sfile):
# Emit all message sections
for message in self.list:
message.emit_sections(sfile)
|
