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
|
#!/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
import TypeFactory
from Field import Field
"""
The FieldResult class takes care of handling the common 'Result' TLV
"""
class FieldResult(Field):
"""
Emit the types required to the source file (they will not be exposed in the
interface)
"""
def emit_types(self, hfile, cfile):
if TypeFactory.is_type_emitted(self.fullname) is False:
TypeFactory.set_type_emitted(self.fullname)
self.variable.emit_types(cfile, self.since)
"""
Emit the method responsible for getting the Result TLV contents. This
special TLV will have its own getter implementation, as we want to have
proper GErrors built from the QMI result status/code.
"""
def emit_getter(self, hfile, cfile):
translations = { 'variable_name' : self.variable_name,
'prefix_camelcase' : utils.build_camelcase_name(self.prefix),
'prefix_underscore' : utils.build_underscore_name(self.prefix),
'since' : self.since }
# Emit the getter header
template = (
'\n'
'/**\n'
' * ${prefix_underscore}_get_result:\n'
' * @self: a ${prefix_camelcase}.\n'
' * @error: Return location for error or %NULL.\n'
' *\n'
' * Get the result of the QMI operation.\n'
' *\n'
' * Returns: %TRUE if the QMI operation succeeded, %FALSE if @error is set.\n'
' *\n'
' * Since: ${since}\n'
' */\n'
'gboolean ${prefix_underscore}_get_result (\n'
' ${prefix_camelcase} *self,\n'
' GError **error);\n')
hfile.write(string.Template(template).substitute(translations))
# Emit the getter source
template = (
'\n'
'gboolean\n'
'${prefix_underscore}_get_result (\n'
' ${prefix_camelcase} *self,\n'
' GError **error)\n'
'{\n'
' g_return_val_if_fail (self != NULL, FALSE);\n'
'\n'
' /* We should always have a result set in the response message */\n'
' if (!self->${variable_name}_set) {\n'
' g_set_error (error,\n'
' QMI_CORE_ERROR,\n'
' QMI_CORE_ERROR_INVALID_MESSAGE,\n'
' "No \'Result\' field given in the message");\n'
' return FALSE;\n'
' }\n'
'\n'
' if (self->${variable_name}.error_status == QMI_STATUS_SUCCESS) {\n'
' /* Operation succeeded */\n'
' return TRUE;\n'
' }\n'
'\n'
' /* Report a QMI protocol error */\n'
' g_set_error (error,\n'
' QMI_PROTOCOL_ERROR,\n'
' (QmiProtocolError) self->${variable_name}.error_code,\n'
' "QMI protocol error (%u): \'%s\'",\n'
' self->${variable_name}.error_code,\n'
' qmi_protocol_error_get_string ((QmiProtocolError) self->${variable_name}.error_code));\n'
' return FALSE;\n'
'}\n')
cfile.write(string.Template(template).substitute(translations))
"""
Emit the method responsible for getting a printable representation of this
TLV field.
"""
def emit_tlv_helpers(self, f):
if TypeFactory.helpers_emitted(self.fullname):
return
TypeFactory.set_helpers_emitted(self.fullname)
translations = { 'name' : self.name,
'tlv_id' : self.id_enum_name,
'underscore' : utils.build_underscore_name (self.fullname) }
template = (
'\n'
'static gboolean\n'
'${underscore}_validate (\n'
' const guint8 *buffer,\n'
' guint16 buffer_len)\n'
'{\n'
' static const guint expected_len = 4;\n'
'\n'
' if (buffer_len < expected_len) {\n'
' g_warning ("Cannot read the \'${name}\' TLV: expected \'%u\' bytes, but only got \'%u\' bytes",\n'
' expected_len, buffer_len);\n'
' return FALSE;\n'
' }\n'
'\n'
' return TRUE;\n'
'}\n')
f.write(string.Template(template).substitute(translations))
template = (
'\n'
'static gchar *\n'
'${underscore}_get_printable (\n'
' QmiMessage *self,\n'
' const gchar *line_prefix)\n'
'{\n'
' const guint8 *buffer;\n'
' guint16 buffer_len;\n'
'\n'
' buffer = qmi_message_get_raw_tlv (self,\n'
' ${tlv_id},\n'
' &buffer_len);\n'
' if (buffer) {\n'
' GString *printable;\n'
' guint16 error_status;\n'
' guint16 error_code;\n'
'\n'
' printable = g_string_new ("");\n'
' qmi_utils_read_guint16_from_buffer (\n'
' &buffer,\n'
' &buffer_len,\n'
' QMI_ENDIAN_LITTLE,\n'
' &error_status);\n'
' qmi_utils_read_guint16_from_buffer (\n'
' &buffer,\n'
' &buffer_len,\n'
' QMI_ENDIAN_LITTLE,\n'
' &error_code);\n'
'\n'
' g_warn_if_fail (buffer_len == 0);\n'
'\n'
' if (error_status == QMI_STATUS_SUCCESS)\n'
' g_string_append (printable, "SUCCESS");\n'
' else\n'
' g_string_append_printf (printable,\n'
' "FAILURE: %s",\n'
' qmi_protocol_error_get_string ((QmiProtocolError) error_code));\n'
'\n'
' return g_string_free (printable, FALSE);\n'
' }\n'
'\n'
' return NULL;\n'
'}\n')
f.write(string.Template(template).substitute(translations))
"""
Add sections
"""
def add_sections(self, sections):
translations = { 'underscore' : utils.build_underscore_name(self.name),
'prefix_camelcase' : utils.build_camelcase_name(self.prefix),
'prefix_underscore' : utils.build_underscore_name(self.prefix) }
# Public methods
template = (
'${prefix_underscore}_get_${underscore}\n')
if self.container_type == 'Input':
template += (
'${prefix_underscore}_set_${underscore}\n')
sections['public-methods'] += string.Template(template).substitute(translations)
|
