Debian Codegraph @

build-aux/qmi-codegen/VariableSequence.py

raw
1 # -*- Mode: python; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 #
3 # This program is free software; you can redistribute it and/or modify it under
4 # the terms of the GNU Lesser General Public License as published by the Free
5 # Software Foundation; either version 2 of the License, or (at your option) any
6 # later version.
7 #
8 # This program is distributed in the hope that it will be useful, but WITHOUT
9 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10 # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
11 # details.
12 #
13 # You should have received a copy of the GNU Lesser General Public License along
14 # with this program; if not, write to the Free Software Foundation, Inc., 51
15 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 #
17 # Copyright (C) 2012 Lanedo GmbH
18 # Copyright (C) 2012-2022 Aleksander Morgado <[email protected]>
19 # Copyright (c) 2022 Qualcomm Innovation Center, Inc.
20 #
21
22 import string
23 import utils
24 from Variable import Variable
25 import VariableFactory
26
27 """
28 Variable type for Sequences ('sequence' format)
29 """
30 class VariableSequence(Variable):
31
32 def __init__(self, service, dictionary, sequence_type_name, container_type):
33
34 # Call the parent constructor
35 Variable.__init__(self, service, dictionary)
36
37 self.container_type = container_type
38
39 # Load members of this sequence
40 self.members = []
41 for member_dictionary in dictionary['contents']:
42 member = {}
43 member['name'] = utils.build_underscore_name(member_dictionary['name'])
44 member['object'] = VariableFactory.create_variable(self.service, member_dictionary, sequence_type_name + ' ' + member_dictionary['name'], self.container_type)
45 self.members.append(member)
46
47 # We'll need to dispose if at least one of the members needs it
48 for member in self.members:
49 if member['object'].needs_dispose:
50 self.needs_dispose = True
51 break
52
53 # We'll flag the variable as needing compat GIR methods if we find any
54 # sequence member needing it
55 for member in self.members:
56 if member['object'].needs_compat_gir:
57 self.needs_compat_gir = True
58 break
59
60 # We'll contain personal info if at least one of the members contains personal info or we ourselves are personal info
61 if not self.contains_personal_info:
62 for member in self.members:
63 if member['object'].contains_personal_info:
64 self.contains_personal_info = True
65 break
66
67
68 def emit_types(self, hfile, cfile, since, static):
69 for member in self.members:
70 member['object'].emit_types(hfile, cfile, since, static)
71
72
73 def emit_types_gir(self, hfile, cfile, since):
74 for member in self.members:
75 member['object'].emit_types_gir(hfile, cfile, since)
76
77
78 def emit_buffer_read(self, f, line_prefix, tlv_out, error, variable_name):
79 for member in self.members:
80 member['object'].emit_buffer_read(f, line_prefix, tlv_out, error, variable_name + '_' + member['name'])
81
82
83 def emit_buffer_write(self, f, line_prefix, tlv_name, variable_name):
84 for member in self.members:
85 member['object'].emit_buffer_write(f, line_prefix, tlv_name, variable_name + '_' + member['name'])
86
87
88 def emit_get_printable(self, f, line_prefix, is_personal):
89 translations = { 'lp' : line_prefix }
90
91 template = (
92 '${lp}g_string_append (printable, "[");\n')
93 f.write(string.Template(template).substitute(translations))
94
95 for member in self.members:
96 translations['variable_name'] = member['name']
97 template = (
98 '${lp}g_string_append (printable, " ${variable_name} = \'");\n')
99 f.write(string.Template(template).substitute(translations))
100
101 member['object'].emit_get_printable(f, line_prefix, self.personal_info or is_personal)
102
103 template = (
104 '${lp}g_string_append (printable, "\'");\n')
105 f.write(string.Template(template).substitute(translations))
106
107 template = (
108 '${lp}g_string_append (printable, " ]");\n')
109 f.write(string.Template(template).substitute(translations))
110
111
112 def build_variable_declaration(self, line_prefix, variable_name):
113 built = ''
114 for member in self.members:
115 built += member['object'].build_variable_declaration(line_prefix, variable_name + '_' + member['name'])
116 return built
117
118
119 def build_variable_declaration_gir(self, line_prefix, variable_name):
120 built = ''
121 for member in self.members:
122 built += member['object'].build_variable_declaration_gir(line_prefix, variable_name + '_' + member['name'])
123 return built
124
125
126 def build_struct_field_declaration(self, line_prefix, variable_name):
127 raise RuntimeError('Variable of type "sequence" is never expected as a struct field')
128
129
130 def build_getter_declaration(self, line_prefix, variable_name):
131 if not self.visible:
132 return ""
133
134 built = ''
135 for member in self.members:
136 built += member['object'].build_getter_declaration(line_prefix, variable_name + '_' + member['name'])
137 return built
138
139
140 def build_getter_declaration_gir(self, line_prefix, variable_name):
141 if not self.visible:
142 return ""
143
144 built = ''
145 for member in self.members:
146 built += member['object'].build_getter_declaration_gir(line_prefix, variable_name + '_' + member['name'])
147 return built
148
149
150 def build_getter_documentation(self, line_prefix, variable_name):
151 if not self.visible:
152 return ""
153
154 built = ''
155 for member in self.members:
156 built += member['object'].build_getter_documentation(line_prefix, variable_name + '_' + member['name'])
157 return built
158
159
160 def build_getter_documentation_gir(self, line_prefix, variable_name):
161 if not self.visible:
162 return ""
163
164 built = ''
165 for member in self.members:
166 built += member['object'].build_getter_documentation_gir(line_prefix, variable_name + '_' + member['name'])
167 return built
168
169
170 def build_getter_implementation(self, line_prefix, variable_name_from, variable_name_to):
171 if not self.visible:
172 return ""
173
174 built = ''
175 for member in self.members:
176 built += member['object'].build_getter_implementation(line_prefix,
177 variable_name_from + '_' + member['name'],
178 variable_name_to + '_' + member['name'])
179 return built
180
181
182 def build_getter_implementation_gir(self, line_prefix, variable_name_from, variable_name_to):
183 if not self.visible:
184 return ""
185
186 built = ''
187 for member in self.members:
188 built += member['object'].build_getter_implementation_gir(line_prefix,
189 variable_name_from + '_' + member['name'],
190 variable_name_to + '_' + member['name'])
191 return built
192
193
194 def build_setter_declaration(self, line_prefix, variable_name):
195 if not self.visible:
196 return ""
197
198 built = ''
199 for member in self.members:
200 built += member['object'].build_setter_declaration(line_prefix, variable_name + '_' + member['name'])
201 return built
202
203
204 def build_setter_declaration_gir(self, line_prefix, variable_name):
205 if not self.visible:
206 return ""
207
208 built = ''
209 for member in self.members:
210 built += member['object'].build_setter_declaration_gir(line_prefix, variable_name + '_' + member['name'])
211 return built
212
213
214 def build_setter_documentation(self, line_prefix, variable_name):
215 if not self.visible:
216 return ""
217
218 built = ''
219 for member in self.members:
220 built += member['object'].build_setter_documentation(line_prefix, variable_name + '_' + member['name'])
221 return built
222
223
224 def build_setter_documentation_gir(self, line_prefix, variable_name):
225 if not self.visible:
226 return ""
227
228 built = ''
229 for member in self.members:
230 built += member['object'].build_setter_documentation_gir(line_prefix, variable_name + '_' + member['name'])
231 return built
232
233
234 def build_setter_implementation(self, line_prefix, variable_name_from, variable_name_to):
235 if not self.visible:
236 return ""
237
238 built = ''
239 for member in self.members:
240 built += member['object'].build_setter_implementation(line_prefix,
241 variable_name_from + '_' + member['name'],
242 variable_name_to + '_' + member['name'])
243 return built
244
245
246 def build_setter_implementation_gir(self, line_prefix, variable_name_from, variable_name_to):
247 if not self.visible:
248 return ""
249
250 built = ''
251 for member in self.members:
252 built += member['object'].build_setter_implementation_gir(line_prefix,
253 variable_name_from + '_' + member['name'],
254 variable_name_to + '_' + member['name'])
255 return built
256
257
258 def build_dispose(self, line_prefix, variable_name):
259 built = ''
260 for member in self.members:
261 built += member['object'].build_dispose(line_prefix, variable_name + '_' + member['name'])
262 return built
263
264
265 def build_dispose_gir(self, line_prefix, variable_name):
266 built = ''
267 for member in self.members:
268 built += member['object'].build_dispose_gir(line_prefix, variable_name + '_' + member['name'])
269 return built
270
271
272 def build_copy_to_gir(self, line_prefix, variable_name_from, variable_name_to):
273 built = ''
274 for member in self.members:
275 built += member['object'].build_copy_to_gir(line_prefix, variable_name_from, variable_name_to)
276 return built
277
278
279 def build_copy_from_gir(self, line_prefix, variable_name_from, variable_name_to):
280 built = ''
281 for member in self.members:
282 built += member['object'].build_copy_from_gir(line_prefix, variable_name_from, variable_name_to)
283 return built
284
285
286 def build_copy_gir(self, line_prefix, variable_name_from, variable_name_to):
287 built = ''
288 for member in self.members:
289 built += member['object'].build_copy_gir(line_prefix, variable_name_from, variable_name_to)
290 return built
291
292
293 def add_sections(self, sections):
294 # Add sections for each member
295 for member in self.members:
296 member['object'].add_sections(sections)