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
|
# -*- Mode: python; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
#
# SPDX-License-Identifier: LGPL-2.1-or-later
#
# Copyright (C) 2013 - 2018 Aleksander Morgado <aleksander@aleksander.es>
#
import string
from Message import Message
from Struct import Struct
import utils
"""
Check field to see if it holds a struct
"""
def set_struct_usage(struct, fields):
for field in fields:
if field['format'] == 'struct' and field['struct-type'] == struct.name:
struct.single_member = True
break
if field['format'] == 'ref-struct-array' and field['struct-type'] == struct.name:
struct.array_member = True
break
if field['format'] == 'struct-array' and field['struct-type'] == struct.name:
struct.array_member = True
break
"""
The ObjectList class handles the generation of all commands and types for a given
specific service
"""
class ObjectList:
"""
Constructor
"""
def __init__(self, objects_dictionary):
self.command_list = []
self.struct_list = []
self.service = ''
self.mbimex_service = ''
self.mbimex_version = ''
# Loop items in the list, creating Message objects for the messages
for object_dictionary in objects_dictionary:
if object_dictionary['type'] == 'Command':
if self.service == '':
raise ValueError('Service name not specified before the first command')
self.command_list.append(Message(self.service, self.mbimex_service, self.mbimex_version, object_dictionary))
elif object_dictionary['type'] == 'Struct':
self.struct_list.append(Struct(object_dictionary))
elif object_dictionary['type'] == 'Service':
self.service = object_dictionary['name']
if 'mbimex-service' in object_dictionary:
self.mbimex_service = object_dictionary['mbimex-service']
self.mbimex_version = object_dictionary['mbimex-version']
else:
raise ValueError('Cannot handle object type \'%s\'' % object_dictionary['type'])
if self.service == '':
raise ValueError('Service name not specified')
# Populate struct usages
for struct in self.struct_list:
for command in self.command_list:
set_struct_usage(struct, command.query)
set_struct_usage(struct, command.set)
set_struct_usage(struct, command.response)
set_struct_usage(struct, command.notification)
"""
Emit the structs and commands handling implementation
"""
def emit(self, hfile, cfile):
# Emit all structs
for item in self.struct_list:
item.emit(hfile, cfile)
# Emit all commands
for item in self.command_list:
item.emit(hfile, cfile)
"""
Emit support for printing messages in this service
"""
def emit_printable(self, hfile, cfile):
translations = { 'service_underscore' : utils.build_underscore_name(self.service),
'service' : self.service }
template = (
'\n'
'/*****************************************************************************/\n'
'/* Service helper for printable fields */\n'
'\n'
'#if defined (LIBMBIM_GLIB_COMPILATION)\n'
'\n'
'G_GNUC_INTERNAL\n'
'gchar *\n'
'__mbim_message_${service_underscore}_get_printable_fields (\n'
' const MbimMessage *message,\n'
' const gchar *line_prefix,\n'
' GError **error);\n'
'\n'
'#endif\n')
hfile.write(string.Template(template).substitute(translations))
template = (
'\n'
'typedef struct {\n'
' gchar * (* query_cb) (const MbimMessage *message, const gchar *line_prefix, GError **error);\n'
' gchar * (* set_cb) (const MbimMessage *message, const gchar *line_prefix, GError **error);\n'
' gchar * (* response_cb) (const MbimMessage *message, const gchar *line_prefix, GError **error);\n'
' gchar * (* notification_cb) (const MbimMessage *message, const gchar *line_prefix, GError **error);\n'
'} GetPrintableCallbacks;\n'
'\n'
'static const GetPrintableCallbacks get_printable_callbacks[] = {\n')
for item in self.command_list:
translations['message'] = utils.build_underscore_name (item.fullname)
translations['cid'] = item.cid_enum_name
inner_template = (
' [${cid}] = {\n')
if item.has_query:
inner_template += (
' .query_cb = ${message}_query_get_printable,\n')
if item.has_set:
inner_template += (
' .set_cb = ${message}_set_get_printable,\n')
if item.has_response:
inner_template += (
' .response_cb = ${message}_response_get_printable,\n')
if item.has_notification:
inner_template += (
' .notification_cb = ${message}_notification_get_printable,\n')
inner_template += (
' },\n')
template += (string.Template(inner_template).substitute(translations))
template += (
'};\n'
'\n'
'gchar *\n'
'__mbim_message_${service_underscore}_get_printable_fields (\n'
' const MbimMessage *message,\n'
' const gchar *line_prefix,\n'
' GError **error)\n'
'{\n'
' guint32 cid;\n'
'\n'
' switch (mbim_message_get_message_type (message)) {\n'
' case MBIM_MESSAGE_TYPE_COMMAND: {\n'
' cid = mbim_message_command_get_cid (message);\n'
' if (cid < G_N_ELEMENTS (get_printable_callbacks)) {\n'
' switch (mbim_message_command_get_command_type (message)) {\n'
' case MBIM_MESSAGE_COMMAND_TYPE_QUERY:\n'
' if (get_printable_callbacks[cid].query_cb)\n'
' return get_printable_callbacks[cid].query_cb (message, line_prefix, error);\n'
' break;\n'
' case MBIM_MESSAGE_COMMAND_TYPE_SET:\n'
' if (get_printable_callbacks[cid].set_cb)\n'
' return get_printable_callbacks[cid].set_cb (message, line_prefix, error);\n'
' break;\n'
' case MBIM_MESSAGE_COMMAND_TYPE_UNKNOWN:\n'
' default:\n'
' g_set_error (error,\n'
' MBIM_CORE_ERROR,\n'
' MBIM_CORE_ERROR_INVALID_MESSAGE,\n'
' \"Invalid command type\");\n'
' return NULL;\n'
' }\n'
' }\n'
' break;\n'
' }\n'
'\n'
' case MBIM_MESSAGE_TYPE_COMMAND_DONE:\n'
' cid = mbim_message_command_done_get_cid (message);\n'
' if (cid < G_N_ELEMENTS (get_printable_callbacks)) {\n'
' if (get_printable_callbacks[cid].response_cb)\n'
' return get_printable_callbacks[cid].response_cb (message, line_prefix, error);\n'
' }\n'
' break;\n'
'\n'
' case MBIM_MESSAGE_TYPE_INDICATE_STATUS:\n'
' cid = mbim_message_indicate_status_get_cid (message);\n'
' if (cid < G_N_ELEMENTS (get_printable_callbacks)) {\n'
' if (get_printable_callbacks[cid].notification_cb)\n'
' return get_printable_callbacks[cid].notification_cb (message, line_prefix, error);\n'
' }\n'
' break;\n'
'\n'
' case MBIM_MESSAGE_TYPE_OPEN: \n'
' case MBIM_MESSAGE_TYPE_CLOSE: \n'
' case MBIM_MESSAGE_TYPE_INVALID: \n'
' case MBIM_MESSAGE_TYPE_HOST_ERROR: \n'
' case MBIM_MESSAGE_TYPE_OPEN_DONE: \n'
' case MBIM_MESSAGE_TYPE_CLOSE_DONE: \n'
' case MBIM_MESSAGE_TYPE_FUNCTION_ERROR: \n'
' default:\n'
' g_set_error (error,\n'
' MBIM_CORE_ERROR,\n'
' MBIM_CORE_ERROR_INVALID_MESSAGE,\n'
' \"No contents expected in this message type\");\n'
' return NULL;\n'
' }\n'
'\n'
' g_set_error (error,\n'
' MBIM_CORE_ERROR,\n'
' MBIM_CORE_ERROR_INVALID_MESSAGE,\n'
' \"Unknown contents\");\n'
' return NULL;\n'
'}\n')
cfile.write(string.Template(template).substitute(translations))
"""
Emit the sections
"""
def emit_sections(self, sfile):
translations = { 'service_dashed' : utils.build_dashed_name(self.service),
'service' : self.service }
# Emit section header
template = (
'\n'
'<SECTION>\n'
'<FILE>mbim-${service_dashed}</FILE>\n'
'<TITLE>${service}</TITLE>\n')
sfile.write(string.Template(template).substitute(translations))
# Emit subsection per type
for struct in self.struct_list:
struct.emit_section_content(sfile)
# Emit subsection per command
for command in self.command_list:
command.emit_section_content(sfile)
sfile.write(
'</SECTION>\n')
|
