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
|
#!/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 Variable import Variable
import VariableFactory
"""
Variable type for Sequences ('sequence' format)
"""
class VariableSequence(Variable):
"""
Constructor
"""
def __init__(self, dictionary, sequence_type_name, container_type):
# Call the parent constructor
Variable.__init__(self, dictionary)
self.container_type = container_type
# Load members of this sequence
self.members = []
for member_dictionary in dictionary['contents']:
member = {}
member['name'] = utils.build_underscore_name(member_dictionary['name'])
member['object'] = VariableFactory.create_variable(member_dictionary, sequence_type_name + ' ' + member_dictionary['name'], self.container_type)
self.members.append(member)
# TODO: do we need this?
# We'll need to dispose if at least one of the members needs it
for member in self.members:
if member['object'].needs_dispose == True:
self.needs_dispose = True
"""
Emit all types for the members of the sequence
"""
def emit_types(self, f):
# Emit types for each member
for member in self.members:
member['object'].emit_types(f)
"""
Emit helper methods for all types in the struct
"""
def emit_helper_methods(self, hfile, cfile):
# Emit for each member
for member in self.members:
member['object'].emit_helper_methods(hfile, cfile)
"""
Reading the contents of a sequence is just about reading each of the sequence
fields one by one.
"""
def emit_buffer_read(self, f, line_prefix, variable_name, buffer_name, buffer_len):
for member in self.members:
member['object'].emit_buffer_read(f, line_prefix, variable_name + '_' + member['name'], buffer_name, buffer_len)
"""
Emits the code involved in computing the size of the variable.
"""
def emit_size_read(self, f, line_prefix, variable_name, buffer_name, buffer_len):
for member in self.members:
member['object'].emit_size_read(f, line_prefix, variable_name, buffer_name, buffer_len)
"""
Writing the contents of a sequence is just about writing each of the sequence
fields one by one.
"""
def emit_buffer_write(self, f, line_prefix, tlv_name, variable_name):
for member in self.members:
member['object'].emit_buffer_write(f, line_prefix, tlv_name, variable_name + '_' + member['name'])
"""
The sequence will be printed as a list of fields enclosed between square
brackets
"""
def emit_get_printable(self, f, line_prefix, printable, buffer_name, buffer_len):
translations = { 'lp' : line_prefix,
'printable' : printable }
template = (
'${lp}g_string_append (${printable}, "[");\n')
f.write(string.Template(template).substitute(translations))
for member in self.members:
translations['variable_name'] = member['name']
template = (
'${lp}g_string_append (${printable}, " ${variable_name} = \'");\n')
f.write(string.Template(template).substitute(translations))
member['object'].emit_get_printable(f, line_prefix, printable, buffer_name, buffer_len)
template = (
'${lp}g_string_append (${printable}, "\'");\n')
f.write(string.Template(template).substitute(translations))
template = (
'${lp}g_string_append (${printable}, " ]");\n')
f.write(string.Template(template).substitute(translations))
"""
Variable declaration
"""
def build_variable_declaration(self, line_prefix, variable_name):
built = ''
for member in self.members:
built += member['object'].build_variable_declaration(line_prefix, variable_name + '_' + member['name'])
return built
"""
The getter for a sequence variable will include independent getters for each
of the variables in the sequence.
"""
def build_getter_declaration(self, line_prefix, variable_name):
built = ''
for member in self.members:
built += member['object'].build_getter_declaration(line_prefix, variable_name + '_' + member['name'])
return built
"""
Documentation for the getter
"""
def build_getter_documentation(self, line_prefix, variable_name):
built = ''
for member in self.members:
built += member['object'].build_getter_documentation(line_prefix, variable_name + '_' + member['name'])
return built
"""
Builds the Struct getter implementation
"""
def build_getter_implementation(self, line_prefix, variable_name_from, variable_name_to, to_is_reference):
built = ''
for member in self.members:
built += member['object'].build_getter_implementation(line_prefix,
variable_name_from + '_' + member['name'],
variable_name_to + '_' + member['name'],
to_is_reference)
return built
"""
The setter for a sequence variable will include independent setters for each
of the variables in the sequence.
"""
def build_setter_declaration(self, line_prefix, variable_name):
built = ''
for member in self.members:
built += member['object'].build_setter_declaration(line_prefix, variable_name + '_' + member['name'])
return built
"""
Documentation for the setter
"""
def build_setter_documentation(self, line_prefix, variable_name):
built = ''
for member in self.members:
built += member['object'].build_setter_documentation(line_prefix, variable_name + '_' + member['name'])
return built
"""
Builds the Sequence setter implementation
"""
def build_setter_implementation(self, line_prefix, variable_name_from, variable_name_to):
built = ''
for member in self.members:
built += member['object'].build_setter_implementation(line_prefix,
variable_name_from + '_' + member['name'],
variable_name_to + '_' + member['name'])
return built
"""
Disposing a sequence is just about disposing each of the sequence fields one by
one.
"""
def build_dispose(self, line_prefix, variable_name):
built = ''
for member in self.members:
built += member['object'].build_dispose(line_prefix, variable_name + '_' + member['name'])
return built
"""
Add sections
"""
def add_sections(self, sections):
# Add sections for each member
for member in self.members:
member['object'].add_sections(sections)
|
