Commit | Line | Data |
---|---|---|
81447b5b PP |
1 | # The MIT License (MIT) |
2 | # | |
811644b8 | 3 | # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> |
81447b5b PP |
4 | # |
5 | # Permission is hereby granted, free of charge, to any person obtaining a copy | |
6 | # of this software and associated documentation files (the "Software"), to deal | |
7 | # in the Software without restriction, including without limitation the rights | |
8 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | # copies of the Software, and to permit persons to whom the Software is | |
10 | # furnished to do so, subject to the following conditions: | |
11 | # | |
12 | # The above copyright notice and this permission notice shall be included in | |
13 | # all copies or substantial portions of the Software. | |
14 | # | |
15 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
21 | # THE SOFTWARE. | |
22 | ||
23 | from bt2 import native_bt, object, utils | |
b4f45851 | 24 | import bt2.field_class |
81447b5b PP |
25 | import collections.abc |
26 | import functools | |
27 | import numbers | |
28 | import math | |
29 | import abc | |
30 | import bt2 | |
31 | ||
32 | ||
e1c6bebd JG |
33 | def _get_leaf_field(obj): |
34 | if type(obj) is not _VariantField: | |
35 | return obj | |
36 | ||
37 | return _get_leaf_field(obj.selected_field) | |
38 | ||
39 | ||
2ae9f48c SM |
40 | def _create_field_from_ptr(ptr, owner_ptr, owner_get_ref, owner_put_ref): |
41 | field_class_ptr = native_bt.field_borrow_class_const(ptr) | |
42 | utils._handle_ptr(field_class_ptr, "cannot get field object's class") | |
43 | typeid = native_bt.field_class_get_type(field_class_ptr) | |
44 | field = _TYPE_ID_TO_OBJ[typeid]._create_from_ptr_and_get_ref( | |
45 | ptr, owner_ptr, owner_get_ref, owner_put_ref) | |
81447b5b PP |
46 | return field |
47 | ||
48 | ||
78288f58 | 49 | class _Field(object._UniqueObject, metaclass=abc.ABCMeta): |
81447b5b | 50 | def __copy__(self): |
50842bdc | 51 | ptr = native_bt.field_copy(self._ptr) |
81447b5b PP |
52 | utils._handle_ptr(ptr, 'cannot copy {} field object'.format(self._NAME.lower())) |
53 | return _create_from_ptr(ptr) | |
54 | ||
55 | def __deepcopy__(self, memo): | |
56 | cpy = self.__copy__() | |
57 | memo[id(self)] = cpy | |
58 | return cpy | |
59 | ||
e1c6bebd | 60 | def __eq__(self, other): |
b4f45851 | 61 | # special case: two unset fields with the same field class are equal |
e1c6bebd JG |
62 | if isinstance(other, _Field): |
63 | if not self.is_set or not other.is_set: | |
b4f45851 | 64 | if not self.is_set and not other.is_set and self.field_class == other.field_class: |
e1c6bebd JG |
65 | return True |
66 | return False | |
67 | ||
68 | other = _get_leaf_field(other) | |
69 | return self._spec_eq(other) | |
70 | ||
81447b5b | 71 | @property |
b4f45851 | 72 | def field_class(self): |
838a5a52 SM |
73 | field_class_ptr = native_bt.field_borrow_class_const(self._ptr) |
74 | assert field_class_ptr is not None | |
75 | return bt2.field_class._create_field_class_from_ptr_and_get_ref(field_class_ptr) | |
81447b5b | 76 | |
742e4747 JG |
77 | @property |
78 | def is_set(self): | |
50842bdc | 79 | is_set = native_bt.field_is_set(self._ptr) |
742e4747 JG |
80 | return is_set > 0 |
81 | ||
82 | def reset(self): | |
50842bdc | 83 | ret = native_bt.field_reset(self._ptr) |
742e4747 JG |
84 | utils._handle_ret(ret, "cannot reset field object's value") |
85 | ||
12bf0d88 JG |
86 | def _repr(self): |
87 | raise NotImplementedError | |
88 | ||
89 | def __repr__(self): | |
90 | return self._repr() if self.is_set else 'Unset' | |
91 | ||
81447b5b PP |
92 | |
93 | @functools.total_ordering | |
94 | class _NumericField(_Field): | |
95 | @staticmethod | |
96 | def _extract_value(other): | |
97 | if other is True or other is False: | |
98 | return other | |
99 | ||
100 | if isinstance(other, numbers.Integral): | |
101 | return int(other) | |
102 | ||
103 | if isinstance(other, numbers.Real): | |
104 | return float(other) | |
105 | ||
106 | if isinstance(other, numbers.Complex): | |
107 | return complex(other) | |
108 | ||
109 | raise TypeError("'{}' object is not a number object".format(other.__class__.__name__)) | |
110 | ||
111 | def __int__(self): | |
e1c6bebd | 112 | return int(self._value) |
81447b5b PP |
113 | |
114 | def __float__(self): | |
e1c6bebd | 115 | return float(self._value) |
81447b5b | 116 | |
12bf0d88 | 117 | def _repr(self): |
5abb9e33 | 118 | return repr(self._value) |
81447b5b PP |
119 | |
120 | def __lt__(self, other): | |
121 | if not isinstance(other, numbers.Number): | |
122 | raise TypeError('unorderable types: {}() < {}()'.format(self.__class__.__name__, | |
123 | other.__class__.__name__)) | |
124 | ||
e1c6bebd | 125 | return self._value < float(other) |
81447b5b PP |
126 | |
127 | def __le__(self, other): | |
128 | if not isinstance(other, numbers.Number): | |
129 | raise TypeError('unorderable types: {}() <= {}()'.format(self.__class__.__name__, | |
130 | other.__class__.__name__)) | |
131 | ||
e1c6bebd | 132 | return self._value <= float(other) |
81447b5b | 133 | |
e1c6bebd | 134 | def _spec_eq(self, other): |
81447b5b PP |
135 | if not isinstance(other, numbers.Number): |
136 | return False | |
137 | ||
e1c6bebd | 138 | return self._value == complex(other) |
81447b5b PP |
139 | |
140 | def __rmod__(self, other): | |
e1c6bebd | 141 | return self._extract_value(other) % self._value |
81447b5b PP |
142 | |
143 | def __mod__(self, other): | |
e1c6bebd | 144 | return self._value % self._extract_value(other) |
81447b5b PP |
145 | |
146 | def __rfloordiv__(self, other): | |
e1c6bebd | 147 | return self._extract_value(other) // self._value |
81447b5b PP |
148 | |
149 | def __floordiv__(self, other): | |
e1c6bebd | 150 | return self._value // self._extract_value(other) |
81447b5b PP |
151 | |
152 | def __round__(self, ndigits=None): | |
153 | if ndigits is None: | |
e1c6bebd | 154 | return round(self._value) |
81447b5b | 155 | else: |
e1c6bebd | 156 | return round(self._value, ndigits) |
81447b5b PP |
157 | |
158 | def __ceil__(self): | |
e1c6bebd | 159 | return math.ceil(self._value) |
81447b5b PP |
160 | |
161 | def __floor__(self): | |
e1c6bebd | 162 | return math.floor(self._value) |
81447b5b PP |
163 | |
164 | def __trunc__(self): | |
e1c6bebd | 165 | return int(self._value) |
81447b5b PP |
166 | |
167 | def __abs__(self): | |
e1c6bebd | 168 | return abs(self._value) |
81447b5b PP |
169 | |
170 | def __add__(self, other): | |
e1c6bebd | 171 | return self._value + self._extract_value(other) |
81447b5b PP |
172 | |
173 | def __radd__(self, other): | |
174 | return self.__add__(other) | |
175 | ||
176 | def __neg__(self): | |
e1c6bebd | 177 | return -self._value |
81447b5b PP |
178 | |
179 | def __pos__(self): | |
e1c6bebd | 180 | return +self._value |
81447b5b PP |
181 | |
182 | def __mul__(self, other): | |
e1c6bebd | 183 | return self._value * self._extract_value(other) |
81447b5b PP |
184 | |
185 | def __rmul__(self, other): | |
186 | return self.__mul__(other) | |
187 | ||
188 | def __truediv__(self, other): | |
e1c6bebd | 189 | return self._value / self._extract_value(other) |
81447b5b PP |
190 | |
191 | def __rtruediv__(self, other): | |
e1c6bebd | 192 | return self._extract_value(other) / self._value |
81447b5b PP |
193 | |
194 | def __pow__(self, exponent): | |
e1c6bebd | 195 | return self._value ** self._extract_value(exponent) |
81447b5b PP |
196 | |
197 | def __rpow__(self, base): | |
e1c6bebd | 198 | return self._extract_value(base) ** self._value |
81447b5b PP |
199 | |
200 | def __iadd__(self, other): | |
201 | self.value = self + other | |
202 | return self | |
203 | ||
204 | def __isub__(self, other): | |
205 | self.value = self - other | |
206 | return self | |
207 | ||
208 | def __imul__(self, other): | |
209 | self.value = self * other | |
210 | return self | |
211 | ||
212 | def __itruediv__(self, other): | |
213 | self.value = self / other | |
214 | return self | |
215 | ||
216 | def __ifloordiv__(self, other): | |
217 | self.value = self // other | |
218 | return self | |
219 | ||
220 | def __imod__(self, other): | |
221 | self.value = self % other | |
222 | return self | |
223 | ||
224 | def __ipow__(self, other): | |
225 | self.value = self ** other | |
226 | return self | |
227 | ||
228 | ||
229 | class _IntegralField(_NumericField, numbers.Integral): | |
230 | def __lshift__(self, other): | |
e1c6bebd | 231 | return self._value << self._extract_value(other) |
81447b5b PP |
232 | |
233 | def __rlshift__(self, other): | |
e1c6bebd | 234 | return self._extract_value(other) << self._value |
81447b5b PP |
235 | |
236 | def __rshift__(self, other): | |
e1c6bebd | 237 | return self._value >> self._extract_value(other) |
81447b5b PP |
238 | |
239 | def __rrshift__(self, other): | |
e1c6bebd | 240 | return self._extract_value(other) >> self._value |
81447b5b PP |
241 | |
242 | def __and__(self, other): | |
e1c6bebd | 243 | return self._value & self._extract_value(other) |
81447b5b PP |
244 | |
245 | def __rand__(self, other): | |
e1c6bebd | 246 | return self._extract_value(other) & self._value |
81447b5b PP |
247 | |
248 | def __xor__(self, other): | |
e1c6bebd | 249 | return self._value ^ self._extract_value(other) |
81447b5b PP |
250 | |
251 | def __rxor__(self, other): | |
e1c6bebd | 252 | return self._extract_value(other) ^ self._value |
81447b5b PP |
253 | |
254 | def __or__(self, other): | |
e1c6bebd | 255 | return self._value | self._extract_value(other) |
81447b5b PP |
256 | |
257 | def __ror__(self, other): | |
e1c6bebd | 258 | return self._extract_value(other) | self._value |
81447b5b PP |
259 | |
260 | def __invert__(self): | |
e1c6bebd | 261 | return ~self._value |
81447b5b PP |
262 | |
263 | def __ilshift__(self, other): | |
264 | self.value = self << other | |
265 | return self | |
266 | ||
267 | def __irshift__(self, other): | |
268 | self.value = self >> other | |
269 | return self | |
270 | ||
271 | def __iand__(self, other): | |
272 | self.value = self & other | |
273 | return self | |
274 | ||
275 | def __ixor__(self, other): | |
276 | self.value = self ^ other | |
277 | return self | |
278 | ||
279 | def __ior__(self, other): | |
280 | self.value = self | other | |
281 | return self | |
282 | ||
283 | ||
2ae9f48c | 284 | class _IntegerField(_IntegralField, _Field): |
81447b5b PP |
285 | pass |
286 | ||
287 | ||
2ae9f48c SM |
288 | class _UnsignedIntegerField(_IntegerField, _Field): |
289 | _NAME = 'Unsigned integer' | |
81447b5b PP |
290 | def _value_to_int(self, value): |
291 | if not isinstance(value, numbers.Real): | |
292 | raise TypeError('expecting a real number object') | |
293 | ||
294 | value = int(value) | |
2ae9f48c | 295 | utils._check_uint64(value) |
81447b5b PP |
296 | |
297 | return value | |
298 | ||
299 | @property | |
e1c6bebd | 300 | def _value(self): |
2ae9f48c | 301 | return native_bt.field_unsigned_integer_get_value(self._ptr) |
81447b5b | 302 | |
2ae9f48c SM |
303 | def _set_value(self, value): |
304 | value = self._value_to_int(value) | |
305 | native_bt.field_unsigned_integer_set_value(self._ptr, value) | |
306 | ||
307 | value = property(fset=_set_value) | |
308 | ||
309 | ||
310 | class _SignedIntegerField(_IntegerField, _Field): | |
311 | _NAME = 'Signed integer' | |
312 | def _value_to_int(self, value): | |
313 | if not isinstance(value, numbers.Real): | |
314 | raise TypeError('expecting a real number object') | |
e1c6bebd | 315 | |
2ae9f48c SM |
316 | value = int(value) |
317 | utils._check_int64(value) | |
811644b8 | 318 | |
81447b5b PP |
319 | return value |
320 | ||
2ae9f48c SM |
321 | @property |
322 | def _value(self): | |
323 | return native_bt.field_signed_integer_get_value(self._ptr) | |
324 | ||
e1c6bebd | 325 | def _set_value(self, value): |
81447b5b | 326 | value = self._value_to_int(value) |
2ae9f48c | 327 | native_bt.field_signed_integer_set_value(self._ptr, value) |
81447b5b | 328 | |
e1c6bebd | 329 | value = property(fset=_set_value) |
81447b5b | 330 | |
0b03f63e | 331 | |
2ae9f48c SM |
332 | class _RealField(_NumericField, numbers.Real): |
333 | _NAME = 'Real' | |
81447b5b PP |
334 | |
335 | def _value_to_float(self, value): | |
336 | if not isinstance(value, numbers.Real): | |
337 | raise TypeError("expecting a real number object") | |
338 | ||
339 | return float(value) | |
340 | ||
341 | @property | |
e1c6bebd | 342 | def _value(self): |
2ae9f48c | 343 | return native_bt.field_real_get_value(self._ptr) |
81447b5b | 344 | |
e1c6bebd | 345 | def _set_value(self, value): |
81447b5b | 346 | value = self._value_to_float(value) |
2ae9f48c | 347 | native_bt.field_real_set_value(self._ptr, value) |
81447b5b | 348 | |
e1c6bebd | 349 | value = property(fset=_set_value) |
81447b5b | 350 | |
0b03f63e | 351 | |
81447b5b PP |
352 | class _EnumerationField(_IntegerField): |
353 | _NAME = 'Enumeration' | |
354 | ||
355 | @property | |
356 | def integer_field(self): | |
50842bdc | 357 | int_field_ptr = native_bt.field_enumeration_get_container(self._ptr) |
811644b8 | 358 | assert(int_field_ptr) |
81447b5b PP |
359 | return _create_from_ptr(int_field_ptr) |
360 | ||
e1c6bebd | 361 | def _set_value(self, value): |
81447b5b PP |
362 | self.integer_field.value = value |
363 | ||
12bf0d88 | 364 | def _repr(self): |
4addd228 JG |
365 | labels = [repr(v.name) for v in self.mappings] |
366 | return '{} ({})'.format(self._value, ', '.join(labels)) | |
367 | ||
e1c6bebd JG |
368 | value = property(fset=_set_value) |
369 | ||
370 | @property | |
371 | def _value(self): | |
372 | return self.integer_field._value | |
373 | ||
81447b5b PP |
374 | @property |
375 | def mappings(self): | |
50842bdc | 376 | iter_ptr = native_bt.field_enumeration_get_mappings(self._ptr) |
811644b8 | 377 | assert(iter_ptr) |
b4f45851 SM |
378 | return bt2.field_class._EnumerationFieldClassMappingIterator(iter_ptr, |
379 | self.field_class.is_signed) | |
81447b5b PP |
380 | |
381 | ||
382 | @functools.total_ordering | |
383 | class _StringField(_Field, collections.abc.Sequence): | |
384 | _NAME = 'String' | |
385 | ||
386 | def _value_to_str(self, value): | |
387 | if isinstance(value, self.__class__): | |
e1c6bebd | 388 | value = value._value |
81447b5b PP |
389 | |
390 | if not isinstance(value, str): | |
391 | raise TypeError("expecting a 'str' object") | |
392 | ||
393 | return value | |
394 | ||
395 | @property | |
e1c6bebd | 396 | def _value(self): |
50842bdc | 397 | value = native_bt.field_string_get_value(self._ptr) |
81447b5b PP |
398 | return value |
399 | ||
e1c6bebd | 400 | def _set_value(self, value): |
81447b5b | 401 | value = self._value_to_str(value) |
50842bdc | 402 | ret = native_bt.field_string_set_value(self._ptr, value) |
81447b5b PP |
403 | utils._handle_ret(ret, "cannot set string field object's value") |
404 | ||
e1c6bebd JG |
405 | value = property(fset=_set_value) |
406 | ||
407 | def _spec_eq(self, other): | |
81447b5b PP |
408 | try: |
409 | other = self._value_to_str(other) | |
410 | except: | |
411 | return False | |
412 | ||
e1c6bebd | 413 | return self._value == other |
81447b5b PP |
414 | |
415 | def __le__(self, other): | |
e1c6bebd | 416 | return self._value <= self._value_to_str(other) |
81447b5b PP |
417 | |
418 | def __lt__(self, other): | |
e1c6bebd | 419 | return self._value < self._value_to_str(other) |
81447b5b PP |
420 | |
421 | def __bool__(self): | |
e1c6bebd | 422 | return bool(self._value) |
81447b5b | 423 | |
12bf0d88 | 424 | def _repr(self): |
d623d2e9 JG |
425 | return repr(self._value) |
426 | ||
81447b5b | 427 | def __str__(self): |
12bf0d88 | 428 | return self._value if self.is_set else repr(self) |
81447b5b PP |
429 | |
430 | def __getitem__(self, index): | |
e1c6bebd | 431 | return self._value[index] |
81447b5b PP |
432 | |
433 | def __len__(self): | |
e1c6bebd | 434 | return len(self._value) |
81447b5b PP |
435 | |
436 | def __iadd__(self, value): | |
437 | value = self._value_to_str(value) | |
50842bdc | 438 | ret = native_bt.field_string_append(self._ptr, value) |
81447b5b PP |
439 | utils._handle_ret(ret, "cannot append to string field object's value") |
440 | return self | |
441 | ||
442 | ||
443 | class _ContainerField(_Field): | |
444 | def __bool__(self): | |
445 | return len(self) != 0 | |
446 | ||
447 | def __len__(self): | |
448 | count = self._count() | |
811644b8 | 449 | assert(count >= 0) |
81447b5b PP |
450 | return count |
451 | ||
452 | def __delitem__(self, index): | |
453 | raise NotImplementedError | |
454 | ||
455 | ||
456 | class _StructureField(_ContainerField, collections.abc.MutableMapping): | |
457 | _NAME = 'Structure' | |
458 | ||
459 | def _count(self): | |
b4f45851 | 460 | return len(self.field_class) |
81447b5b PP |
461 | |
462 | def __getitem__(self, key): | |
463 | utils._check_str(key) | |
2ae9f48c | 464 | field_ptr = native_bt.field_structure_borrow_member_field_by_name(self._ptr, key) |
81447b5b | 465 | |
2ae9f48c | 466 | if field_ptr is None: |
81447b5b PP |
467 | raise KeyError(key) |
468 | ||
2ae9f48c SM |
469 | return _create_field_from_ptr(field_ptr, self._owner_ptr, |
470 | self._owner_get_ref, | |
471 | self._owner_put_ref) | |
81447b5b PP |
472 | |
473 | def __setitem__(self, key, value): | |
236355c2 | 474 | # raises if key is somehow invalid |
81447b5b PP |
475 | field = self[key] |
476 | ||
81447b5b PP |
477 | # the field's property does the appropriate conversion or raises |
478 | # the appropriate exception | |
479 | field.value = value | |
480 | ||
481 | def at_index(self, index): | |
482 | utils._check_uint64(index) | |
811644b8 PP |
483 | |
484 | if index >= len(self): | |
485 | raise IndexError | |
486 | ||
50842bdc | 487 | field_ptr = native_bt.field_structure_get_field_by_index(self._ptr, index) |
811644b8 | 488 | assert(field_ptr) |
81447b5b PP |
489 | return _create_from_ptr(field_ptr) |
490 | ||
491 | def __iter__(self): | |
492 | # same name iterator | |
b4f45851 | 493 | return iter(self.field_class) |
81447b5b | 494 | |
e1c6bebd JG |
495 | def _spec_eq(self, other): |
496 | try: | |
497 | if len(self) != len(other): | |
81447b5b PP |
498 | return False |
499 | ||
e1c6bebd JG |
500 | for self_key, self_value in self.items(): |
501 | if self_key not in other: | |
502 | return False | |
81447b5b | 503 | |
e1c6bebd | 504 | other_value = other[self_key] |
81447b5b | 505 | |
e1c6bebd JG |
506 | if self_value != other_value: |
507 | return False | |
508 | ||
509 | return True | |
510 | except: | |
511 | return False | |
81447b5b | 512 | |
7c54e2e7 | 513 | @property |
e1c6bebd JG |
514 | def _value(self): |
515 | return {key: value._value for key, value in self.items()} | |
7c54e2e7 | 516 | |
e1c6bebd JG |
517 | def _set_value(self, values): |
518 | original_values = self._value | |
7c54e2e7 | 519 | |
e1c6bebd JG |
520 | try: |
521 | for key, value in values.items(): | |
522 | self[key].value = value | |
523 | except: | |
524 | self.value = original_values | |
525 | raise | |
7c54e2e7 | 526 | |
e1c6bebd | 527 | value = property(fset=_set_value) |
81447b5b | 528 | |
12bf0d88 | 529 | def _repr(self): |
ac7e2dc6 JG |
530 | items = ['{}: {}'.format(repr(k), repr(v)) for k, v in self.items()] |
531 | return '{{{}}}'.format(', '.join(items)) | |
532 | ||
0b03f63e | 533 | |
81447b5b PP |
534 | class _VariantField(_Field): |
535 | _NAME = 'Variant' | |
536 | ||
537 | @property | |
538 | def tag_field(self): | |
50842bdc | 539 | field_ptr = native_bt.field_variant_get_tag(self._ptr) |
811644b8 PP |
540 | |
541 | if field_ptr is None: | |
542 | return | |
543 | ||
81447b5b PP |
544 | return _create_from_ptr(field_ptr) |
545 | ||
546 | @property | |
547 | def selected_field(self): | |
548 | return self.field() | |
549 | ||
550 | def field(self, tag_field=None): | |
551 | if tag_field is None: | |
50842bdc | 552 | field_ptr = native_bt.field_variant_get_current_field(self._ptr) |
811644b8 PP |
553 | |
554 | if field_ptr is None: | |
555 | return | |
81447b5b PP |
556 | else: |
557 | utils._check_type(tag_field, _EnumerationField) | |
50842bdc | 558 | field_ptr = native_bt.field_variant_get_field(self._ptr, tag_field._ptr) |
81447b5b PP |
559 | utils._handle_ptr(field_ptr, "cannot select variant field object's field") |
560 | ||
561 | return _create_from_ptr(field_ptr) | |
562 | ||
e1c6bebd JG |
563 | def _spec_eq(self, other): |
564 | return _get_leaf_field(self) == other | |
811644b8 PP |
565 | |
566 | def __bool__(self): | |
567 | return bool(self.selected_field) | |
81447b5b | 568 | |
12bf0d88 JG |
569 | def __str__(self): |
570 | return str(self.selected_field) if self.is_set else repr(self) | |
571 | ||
572 | def _repr(self): | |
573 | return repr(self.selected_field) | |
872eeccb | 574 | |
e1c6bebd JG |
575 | @property |
576 | def _value(self): | |
577 | if self.selected_field is not None: | |
578 | return self.selected_field._value | |
579 | ||
580 | def _set_value(self, value): | |
581 | self.selected_field.value = value | |
582 | ||
583 | value = property(fset=_set_value) | |
81447b5b | 584 | |
0b03f63e | 585 | |
81447b5b PP |
586 | class _ArraySequenceField(_ContainerField, collections.abc.MutableSequence): |
587 | def __getitem__(self, index): | |
588 | if not isinstance(index, numbers.Integral): | |
589 | raise TypeError("'{}' is not an integral number object: invalid index".format(index.__class__.__name__)) | |
590 | ||
591 | index = int(index) | |
592 | ||
593 | if index < 0 or index >= len(self): | |
594 | raise IndexError('{} field object index is out of range'.format(self._NAME)) | |
595 | ||
596 | field_ptr = self._get_field_ptr_at_index(index) | |
811644b8 | 597 | assert(field_ptr) |
81447b5b PP |
598 | return _create_from_ptr(field_ptr) |
599 | ||
600 | def __setitem__(self, index, value): | |
601 | # we can only set numbers and strings | |
602 | if not isinstance(value, (numbers.Number, _StringField, str)): | |
603 | raise TypeError('expecting number or string object') | |
604 | ||
605 | # raises if index is somehow invalid | |
606 | field = self[index] | |
607 | ||
608 | if not isinstance(field, (_NumericField, _StringField)): | |
609 | raise TypeError('can only set the value of a number or string field') | |
610 | ||
611 | # the field's property does the appropriate conversion or raises | |
612 | # the appropriate exception | |
613 | field.value = value | |
614 | ||
615 | def insert(self, index, value): | |
616 | raise NotImplementedError | |
617 | ||
e1c6bebd JG |
618 | def _spec_eq(self, other): |
619 | try: | |
620 | if len(self) != len(other): | |
81447b5b PP |
621 | return False |
622 | ||
e1c6bebd JG |
623 | for self_field, other_field in zip(self, other): |
624 | if self_field != other_field: | |
625 | return False | |
7c54e2e7 | 626 | |
e1c6bebd JG |
627 | return True |
628 | except: | |
629 | return False | |
7c54e2e7 | 630 | |
e1c6bebd JG |
631 | @property |
632 | def _value(self): | |
633 | return [field._value for field in self] | |
7c54e2e7 | 634 | |
12bf0d88 | 635 | def _repr(self): |
2bc21382 JG |
636 | return '[{}]'.format(', '.join([repr(v) for v in self])) |
637 | ||
81447b5b PP |
638 | |
639 | class _ArrayField(_ArraySequenceField): | |
640 | _NAME = 'Array' | |
641 | ||
642 | def _count(self): | |
b4f45851 | 643 | return self.field_class.length |
81447b5b PP |
644 | |
645 | def _get_field_ptr_at_index(self, index): | |
50842bdc | 646 | return native_bt.field_array_get_field(self._ptr, index) |
81447b5b | 647 | |
e1c6bebd JG |
648 | def _set_value(self, values): |
649 | if len(self) != len(values): | |
650 | raise ValueError( | |
651 | 'expected length of value and array field to match') | |
652 | ||
653 | original_values = self._value | |
654 | try: | |
655 | for index, value in enumerate(values): | |
656 | if value is not None: | |
657 | self[index].value = value | |
658 | else: | |
659 | self[index].reset() | |
660 | except: | |
661 | self.value = original_values | |
662 | raise | |
663 | ||
664 | value = property(fset=_set_value) | |
665 | ||
81447b5b PP |
666 | |
667 | class _SequenceField(_ArraySequenceField): | |
668 | _NAME = 'Sequence' | |
669 | ||
670 | def _count(self): | |
a29094be | 671 | return int(self.length_field) |
81447b5b PP |
672 | |
673 | @property | |
674 | def length_field(self): | |
50842bdc | 675 | field_ptr = native_bt.field_sequence_get_length(self._ptr) |
a29094be JG |
676 | if field_ptr is None: |
677 | return | |
81447b5b PP |
678 | return _create_from_ptr(field_ptr) |
679 | ||
680 | @length_field.setter | |
681 | def length_field(self, length_field): | |
682 | utils._check_type(length_field, _IntegerField) | |
50842bdc | 683 | ret = native_bt.field_sequence_set_length(self._ptr, length_field._ptr) |
81447b5b PP |
684 | utils._handle_ret(ret, "cannot set sequence field object's length field") |
685 | ||
686 | def _get_field_ptr_at_index(self, index): | |
50842bdc | 687 | return native_bt.field_sequence_get_field(self._ptr, index) |
81447b5b | 688 | |
e1c6bebd JG |
689 | def _set_value(self, values): |
690 | original_length_field = self.length_field | |
691 | if original_length_field is not None: | |
692 | original_values = self._value | |
693 | ||
694 | if len(values) != self.length_field: | |
695 | if self.length_field is not None: | |
b4f45851 | 696 | length_fc = self.length_field.field_class |
e1c6bebd | 697 | else: |
b4f45851 SM |
698 | length_fc = bt2.IntegerFieldClass(size=64, is_signed=False) |
699 | self.length_field = length_fc(len(values)) | |
e1c6bebd JG |
700 | |
701 | try: | |
702 | for index, value in enumerate(values): | |
703 | if value is not None: | |
704 | self[index].value = value | |
705 | else: | |
706 | self[index].reset() | |
707 | except: | |
708 | if original_length_field is not None: | |
709 | self.length_field = original_length_field | |
710 | self.value = original_values | |
711 | else: | |
712 | self.reset() | |
713 | raise | |
714 | ||
715 | value = property(fset=_set_value) | |
81447b5b | 716 | |
0b03f63e | 717 | |
81447b5b | 718 | _TYPE_ID_TO_OBJ = { |
2ae9f48c SM |
719 | native_bt.FIELD_CLASS_TYPE_UNSIGNED_INTEGER: _UnsignedIntegerField, |
720 | native_bt.FIELD_CLASS_TYPE_SIGNED_INTEGER: _SignedIntegerField, | |
721 | native_bt.FIELD_CLASS_TYPE_REAL: _RealField, | |
722 | native_bt.FIELD_CLASS_TYPE_STRING: _StringField, | |
723 | native_bt.FIELD_CLASS_TYPE_STRUCTURE: _StructureField, | |
81447b5b | 724 | } |