0
|
1 |
#
|
|
2 |
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
# All rights reserved.
|
|
4 |
# This component and the accompanying materials are made available
|
|
5 |
# under the terms of "Eclipse Public License v1.0"
|
|
6 |
# which accompanies this distribution, and is available
|
|
7 |
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
#
|
|
9 |
# Initial Contributors:
|
|
10 |
# Nokia Corporation - initial contribution.
|
|
11 |
#
|
|
12 |
# Contributors:
|
|
13 |
#
|
|
14 |
# Description:
|
|
15 |
#
|
|
16 |
|
|
17 |
class _CrmlObjectBase(object):
|
|
18 |
"""
|
|
19 |
Common utility base class for all CRML objects for implementing
|
|
20 |
operations like repr(), copy() etc.
|
|
21 |
"""
|
|
22 |
|
|
23 |
# Variable names used in simple object equality comparison
|
|
24 |
SIMPLE_EQ_VARNAMES = []
|
|
25 |
|
|
26 |
def __repr__(self):
|
|
27 |
return "%s(**%r)" % (self.__class__.__name__, vars(self))
|
|
28 |
|
|
29 |
def __get_filtered_dict(self, source_dict, allowed_keys):
|
|
30 |
result = {}
|
|
31 |
for key in allowed_keys:
|
|
32 |
if key in source_dict:
|
|
33 |
result[key] = source_dict[key]
|
|
34 |
return result
|
|
35 |
|
|
36 |
def __eq__(self, other):
|
|
37 |
# 1. Compare type
|
|
38 |
if type(self) is not type(other):
|
|
39 |
return False
|
|
40 |
|
|
41 |
# 2. Compare all members that can be simply compared using ==
|
|
42 |
varnames = self.__class__.SIMPLE_EQ_VARNAMES
|
|
43 |
dict_self = self.__get_filtered_dict(vars(self), varnames)
|
|
44 |
dict_other = self.__get_filtered_dict(vars(other), varnames)
|
|
45 |
if dict_self != dict_other:
|
|
46 |
return False
|
|
47 |
|
|
48 |
# 3. Do any extra comparing
|
|
49 |
if not self._do_extra_eq_handling(other):
|
|
50 |
return False
|
|
51 |
|
|
52 |
return True
|
|
53 |
|
|
54 |
def __ne__(self, other):
|
|
55 |
return not (self == other)
|
|
56 |
|
|
57 |
def _do_extra_eq_handling(self, other):
|
|
58 |
"""
|
|
59 |
If sub-classes need to do any extra handling in __eq__(), they
|
|
60 |
should implement this method and do it here.
|
|
61 |
@return: True if self is equal to other, False if not.
|
|
62 |
"""
|
|
63 |
return True
|
|
64 |
|
|
65 |
def copy(self):
|
|
66 |
"""
|
|
67 |
Return a deep copy of this object.
|
|
68 |
"""
|
|
69 |
new_obj = self.__class__(**vars(self))
|
|
70 |
self._do_extra_copy_handling(new_obj)
|
|
71 |
return new_obj
|
|
72 |
|
|
73 |
def _do_extra_copy_handling(self, new_object):
|
|
74 |
"""
|
|
75 |
If sub-classes need to do any extra handling in copy(), they
|
|
76 |
should implement this method and do it here.
|
|
77 |
@param new_object: The new copied object, a shallow copy at this point.
|
|
78 |
"""
|
|
79 |
return
|
|
80 |
|
|
81 |
class CrmlAccess(_CrmlObjectBase):
|
|
82 |
SIMPLE_EQ_VARNAMES = ['cap_rd', 'cap_wr', 'sid_rd', 'sid_wr']
|
|
83 |
|
|
84 |
def __init__(self, **kwargs):
|
|
85 |
self.cap_rd = kwargs.get('cap_rd')
|
|
86 |
self.cap_wr = kwargs.get('cap_wr')
|
|
87 |
self.sid_rd = kwargs.get('sid_rd')
|
|
88 |
self.sid_wr = kwargs.get('sid_wr')
|
3
|
89 |
self.line_rd = kwargs.get('line_rd')
|
|
90 |
self.line_wr = kwargs.get('line_wr')
|
0
|
91 |
|
|
92 |
|
|
93 |
class CrmlRepository(_CrmlObjectBase):
|
|
94 |
SIMPLE_EQ_VARNAMES = ['uid_value', 'uid_name', 'owner', 'backup', 'rfs', 'access', 'keys', 'version']
|
|
95 |
|
|
96 |
def __init__(self, **kwargs):
|
|
97 |
self.uid_value = kwargs.get('uid_value')
|
|
98 |
self.uid_name = kwargs.get('uid_name')
|
|
99 |
self.owner = kwargs.get('owner')
|
|
100 |
self.backup = kwargs.get('backup', False)
|
|
101 |
self.rfs = kwargs.get('rfs', False)
|
|
102 |
self.access = kwargs.get('access', CrmlAccess())
|
|
103 |
self.keys = kwargs.get('keys', [])
|
|
104 |
self.version = kwargs.get('version', '1')
|
|
105 |
|
|
106 |
def _do_extra_copy_handling(self, new_object):
|
|
107 |
new_keys = []
|
|
108 |
for key in new_object.keys:
|
|
109 |
new_keys.append(key.copy())
|
|
110 |
new_object.keys = new_keys
|
|
111 |
|
|
112 |
self.access = new_object.access.copy()
|
|
113 |
|
|
114 |
def get_refs(self):
|
|
115 |
result = []
|
|
116 |
for key in self.keys:
|
|
117 |
result.extend(key.get_refs())
|
|
118 |
return result
|
|
119 |
|
|
120 |
class CrmlKeyBase(object):
|
|
121 |
def __init__(self, **kwargs):
|
|
122 |
self.ref = kwargs.get('ref')
|
|
123 |
self.name = kwargs.get('name')
|
|
124 |
self.backup = kwargs.get('backup', False)
|
|
125 |
self.read_only = kwargs.get('read_only', False)
|
|
126 |
self.access = kwargs.get('access', CrmlAccess())
|
3
|
127 |
self.line = kwargs.get('line', None)
|
0
|
128 |
|
|
129 |
class CrmlSimpleKey(CrmlKeyBase, _CrmlObjectBase):
|
|
130 |
SIMPLE_EQ_VARNAMES = ['ref', 'name', 'int', 'type', 'backup', 'read_only', 'access']
|
|
131 |
|
|
132 |
def __init__(self, **kwargs):
|
|
133 |
CrmlKeyBase.__init__(self, **kwargs)
|
|
134 |
try:
|
|
135 |
self.ref = kwargs['ref']
|
|
136 |
self.int = kwargs['int']
|
|
137 |
self.type = kwargs.get('type', 'int')
|
|
138 |
except KeyError, e:
|
|
139 |
raise ValueError("Mandatory argument '%s' not given!" % e.message)
|
|
140 |
|
|
141 |
def _do_extra_copy_handling(self, new_object):
|
|
142 |
self.access = new_object.access.copy()
|
|
143 |
|
|
144 |
def get_refs(self):
|
|
145 |
return [self.ref]
|
|
146 |
|
|
147 |
class CrmlBitmaskKey(CrmlKeyBase, _CrmlObjectBase):
|
|
148 |
SIMPLE_EQ_VARNAMES = ['int', 'type', 'backup', 'read_only', 'access', 'name', 'bits']
|
|
149 |
|
|
150 |
def __init__(self, **kwargs):
|
|
151 |
CrmlKeyBase.__init__(self, **kwargs)
|
|
152 |
try:
|
|
153 |
self.int = kwargs['int']
|
|
154 |
self.type = kwargs.get('type', 'int')
|
|
155 |
self.bits = kwargs.get('bits', [])
|
|
156 |
except KeyError, e:
|
|
157 |
raise ValueError("Mandatory argument '%s' not given!" % e.message)
|
|
158 |
|
|
159 |
def _do_extra_copy_handling(self, new_object):
|
|
160 |
new_bits = []
|
|
161 |
for bit in new_object.bits:
|
|
162 |
new_bits.append(bit.copy())
|
|
163 |
new_object.bits = new_bits
|
|
164 |
|
|
165 |
self.access = new_object.access.copy()
|
|
166 |
|
|
167 |
def get_refs(self):
|
|
168 |
return [bit.ref for bit in self.bits]
|
|
169 |
|
|
170 |
class CrmlBit(_CrmlObjectBase):
|
|
171 |
SIMPLE_EQ_VARNAMES = ['ref', 'index', 'invert']
|
|
172 |
|
|
173 |
def __init__(self, **kwargs):
|
|
174 |
try:
|
|
175 |
self.ref = kwargs['ref']
|
|
176 |
self.index = kwargs['index']
|
|
177 |
self.invert = kwargs.get('invert', False)
|
|
178 |
except KeyError, e:
|
|
179 |
raise ValueError("Mandatory argument '%s' not given!" % e.message)
|
3
|
180 |
self.line = kwargs.get('line')
|
0
|
181 |
|
|
182 |
class CrmlKeyRange(CrmlKeyBase, _CrmlObjectBase):
|
|
183 |
SIMPLE_EQ_VARNAMES = ['ref', 'name', 'first_int', 'last_int', 'first_index', 'index_bits', 'count_int', 'backup', 'read_only', 'access', 'subkeys']
|
|
184 |
|
|
185 |
def __init__(self, **kwargs):
|
|
186 |
CrmlKeyBase.__init__(self, **kwargs)
|
|
187 |
try:
|
|
188 |
self.first_int = kwargs['first_int']
|
|
189 |
self.last_int = kwargs['last_int']
|
|
190 |
self.first_index = kwargs.get('first_index', 0)
|
|
191 |
self.index_bits = kwargs.get('index_bits')
|
|
192 |
self.count_int = kwargs.get('count_int')
|
|
193 |
self.subkeys = kwargs.get('subkeys', [])
|
|
194 |
except KeyError, e:
|
|
195 |
raise ValueError("Mandatory argument '%s' not given!" % e.message)
|
|
196 |
|
|
197 |
def _do_extra_copy_handling(self, new_object):
|
|
198 |
new_subkeys = []
|
|
199 |
for subkey in new_object.subkeys:
|
|
200 |
new_subkeys.append(subkey.copy())
|
|
201 |
new_object.subkeys = new_subkeys
|
|
202 |
|
|
203 |
self.access = new_object.access.copy()
|
|
204 |
|
|
205 |
def get_refs(self):
|
|
206 |
if self.ref is not None:
|
|
207 |
refs = [self.ref]
|
|
208 |
for sk in self.subkeys:
|
|
209 |
refs.append(self.ref + '.' + sk.ref)
|
|
210 |
return refs
|
|
211 |
else:
|
|
212 |
return []
|
|
213 |
|
|
214 |
|
|
215 |
class CrmlKeyRangeSubKey(_CrmlObjectBase):
|
|
216 |
SIMPLE_EQ_VARNAMES = ['ref', 'name', 'type', 'int']
|
|
217 |
|
|
218 |
def __init__(self, **kwargs):
|
|
219 |
try:
|
|
220 |
self.ref = kwargs['ref']
|
|
221 |
self.type = kwargs['type']
|
|
222 |
self.int = kwargs['int']
|
|
223 |
self.name = kwargs.get('name')
|
|
224 |
except KeyError, e:
|
|
225 |
raise ValueError("Mandatory argument '%s' not given!" % e.message)
|
3
|
226 |
self.line = kwargs.get('line')
|
0
|
227 |
|