Commit | Line | Data |
---|---|---|
81447b5b PP |
1 | # The MIT License (MIT) |
2 | # | |
f6a5e476 | 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 | |
c946c9de | 24 | from bt2 import field_class as bt2_field_class |
81447b5b PP |
25 | import collections.abc |
26 | import functools | |
27 | import numbers | |
28 | import math | |
81447b5b PP |
29 | |
30 | ||
9cbe0c59 FD |
31 | def _create_field_from_ptr_template( |
32 | object_map, ptr, owner_ptr, owner_get_ref, owner_put_ref | |
33 | ): | |
34 | ||
27d97a3f | 35 | field_class_ptr = native_bt.field_borrow_class_const(ptr) |
27d97a3f | 36 | typeid = native_bt.field_class_get_type(field_class_ptr) |
9cbe0c59 | 37 | field = object_map[typeid]._create_from_ptr_and_get_ref( |
61d96b89 FD |
38 | ptr, owner_ptr, owner_get_ref, owner_put_ref |
39 | ) | |
81447b5b PP |
40 | return field |
41 | ||
42 | ||
9cbe0c59 FD |
43 | def _create_field_from_ptr(ptr, owner_ptr, owner_get_ref, owner_put_ref): |
44 | return _create_field_from_ptr_template( | |
45 | _TYPE_ID_TO_OBJ, ptr, owner_ptr, owner_get_ref, owner_put_ref | |
46 | ) | |
47 | ||
48 | ||
49 | def _create_field_from_const_ptr(ptr, owner_ptr, owner_get_ref, owner_put_ref): | |
50 | return _create_field_from_ptr_template( | |
51 | _TYPE_ID_TO_CONST_OBJ, ptr, owner_ptr, owner_get_ref, owner_put_ref | |
52 | ) | |
53 | ||
54 | ||
84eba0d9 PP |
55 | # Get the "effective" field of `field`. If `field` is a variant, return |
56 | # the currently selected field. If `field` is an option, return the | |
57 | # content field. If `field` is of any other type, return `field` | |
4470d3a6 | 58 | # directly. |
81447b5b | 59 | |
61d96b89 | 60 | |
4470d3a6 | 61 | def _get_leaf_field(field): |
9cbe0c59 | 62 | if isinstance(field, _VariantFieldConst): |
84eba0d9 | 63 | return _get_leaf_field(field.selected_option) |
4470d3a6 | 64 | |
9cbe0c59 | 65 | if isinstance(field, _OptionFieldConst): |
84eba0d9 PP |
66 | return _get_leaf_field(field.field) |
67 | ||
68 | return field | |
81447b5b | 69 | |
80d037bc | 70 | |
9cbe0c59 FD |
71 | class _FieldConst(object._UniqueObject): |
72 | _create_field_from_ptr = staticmethod(_create_field_from_const_ptr) | |
73 | _create_field_class_from_ptr_and_get_ref = staticmethod( | |
74 | bt2_field_class._create_field_class_from_const_ptr_and_get_ref | |
75 | ) | |
76 | _borrow_class_ptr = staticmethod(native_bt.field_borrow_class_const) | |
77 | ||
4470d3a6 | 78 | def __eq__(self, other): |
80d037bc JG |
79 | other = _get_leaf_field(other) |
80 | return self._spec_eq(other) | |
81 | ||
81447b5b | 82 | @property |
ffe40722 | 83 | def cls(self): |
9cbe0c59 | 84 | field_class_ptr = self._borrow_class_ptr(self._ptr) |
e8d2391b | 85 | assert field_class_ptr is not None |
9cbe0c59 | 86 | return self._create_field_class_from_ptr_and_get_ref(field_class_ptr) |
81447b5b | 87 | |
dc78ca2f JG |
88 | def _repr(self): |
89 | raise NotImplementedError | |
90 | ||
91 | def __repr__(self): | |
4470d3a6 | 92 | return self._repr() |
dc78ca2f | 93 | |
81447b5b | 94 | |
9cbe0c59 FD |
95 | class _Field(_FieldConst): |
96 | _create_field_from_ptr = staticmethod(_create_field_from_ptr) | |
97 | _create_field_class_from_ptr_and_get_ref = staticmethod( | |
98 | bt2_field_class._create_field_class_from_ptr_and_get_ref | |
99 | ) | |
100 | _borrow_class_ptr = staticmethod(native_bt.field_borrow_class) | |
101 | ||
102 | ||
103 | class _BitArrayFieldConst(_FieldConst): | |
104 | _NAME = 'Const bit array' | |
6b29f2d4 PP |
105 | |
106 | @property | |
107 | def value_as_integer(self): | |
108 | return native_bt.field_bit_array_get_value_as_integer(self._ptr) | |
109 | ||
6b29f2d4 PP |
110 | def _spec_eq(self, other): |
111 | if type(other) is not type(self): | |
112 | return False | |
113 | ||
114 | return self.value_as_integer == other.value_as_integer | |
115 | ||
116 | def _repr(self): | |
117 | return repr(self.value_as_integer) | |
118 | ||
119 | def __str__(self): | |
120 | return str(self.value_as_integer) | |
121 | ||
122 | def __len__(self): | |
ffe40722 | 123 | return self.cls.length |
6b29f2d4 PP |
124 | |
125 | ||
9cbe0c59 FD |
126 | class _BitArrayField(_BitArrayFieldConst, _Field): |
127 | _NAME = 'Bit array' | |
128 | ||
129 | def _value_as_integer(self, value): | |
130 | utils._check_uint64(value) | |
131 | native_bt.field_bit_array_set_value_as_integer(self._ptr, value) | |
132 | ||
133 | value_as_integer = property( | |
134 | fget=_BitArrayFieldConst.value_as_integer.fget, fset=_value_as_integer | |
135 | ) | |
136 | ||
137 | ||
81447b5b | 138 | @functools.total_ordering |
9cbe0c59 | 139 | class _NumericFieldConst(_FieldConst): |
81447b5b PP |
140 | @staticmethod |
141 | def _extract_value(other): | |
9cbe0c59 | 142 | if isinstance(other, _BoolFieldConst) or isinstance(other, bool): |
a07f15cb | 143 | return bool(other) |
81447b5b PP |
144 | |
145 | if isinstance(other, numbers.Integral): | |
146 | return int(other) | |
147 | ||
148 | if isinstance(other, numbers.Real): | |
149 | return float(other) | |
150 | ||
151 | if isinstance(other, numbers.Complex): | |
152 | return complex(other) | |
153 | ||
61d96b89 FD |
154 | raise TypeError( |
155 | "'{}' object is not a number object".format(other.__class__.__name__) | |
156 | ) | |
81447b5b PP |
157 | |
158 | def __int__(self): | |
80d037bc | 159 | return int(self._value) |
81447b5b PP |
160 | |
161 | def __float__(self): | |
80d037bc | 162 | return float(self._value) |
81447b5b | 163 | |
dc78ca2f | 164 | def _repr(self): |
e100fef0 | 165 | return repr(self._value) |
81447b5b PP |
166 | |
167 | def __lt__(self, other): | |
168 | if not isinstance(other, numbers.Number): | |
61d96b89 FD |
169 | raise TypeError( |
170 | 'unorderable types: {}() < {}()'.format( | |
171 | self.__class__.__name__, other.__class__.__name__ | |
172 | ) | |
173 | ) | |
81447b5b | 174 | |
5f953519 | 175 | return self._value < self._extract_value(other) |
81447b5b | 176 | |
80d037bc | 177 | def _spec_eq(self, other): |
0bde7b52 PP |
178 | try: |
179 | return self._value == self._extract_value(other) | |
5760d571 | 180 | except Exception: |
0bde7b52 | 181 | return False |
81447b5b | 182 | |
04068900 FD |
183 | def __hash__(self): |
184 | return hash(self._value) | |
185 | ||
81447b5b | 186 | def __rmod__(self, other): |
80d037bc | 187 | return self._extract_value(other) % self._value |
81447b5b PP |
188 | |
189 | def __mod__(self, other): | |
80d037bc | 190 | return self._value % self._extract_value(other) |
81447b5b PP |
191 | |
192 | def __rfloordiv__(self, other): | |
80d037bc | 193 | return self._extract_value(other) // self._value |
81447b5b PP |
194 | |
195 | def __floordiv__(self, other): | |
80d037bc | 196 | return self._value // self._extract_value(other) |
81447b5b PP |
197 | |
198 | def __round__(self, ndigits=None): | |
199 | if ndigits is None: | |
80d037bc | 200 | return round(self._value) |
81447b5b | 201 | else: |
80d037bc | 202 | return round(self._value, ndigits) |
81447b5b PP |
203 | |
204 | def __ceil__(self): | |
80d037bc | 205 | return math.ceil(self._value) |
81447b5b PP |
206 | |
207 | def __floor__(self): | |
80d037bc | 208 | return math.floor(self._value) |
81447b5b PP |
209 | |
210 | def __trunc__(self): | |
80d037bc | 211 | return int(self._value) |
81447b5b PP |
212 | |
213 | def __abs__(self): | |
80d037bc | 214 | return abs(self._value) |
81447b5b PP |
215 | |
216 | def __add__(self, other): | |
80d037bc | 217 | return self._value + self._extract_value(other) |
81447b5b PP |
218 | |
219 | def __radd__(self, other): | |
220 | return self.__add__(other) | |
221 | ||
222 | def __neg__(self): | |
80d037bc | 223 | return -self._value |
81447b5b PP |
224 | |
225 | def __pos__(self): | |
80d037bc | 226 | return +self._value |
81447b5b PP |
227 | |
228 | def __mul__(self, other): | |
80d037bc | 229 | return self._value * self._extract_value(other) |
81447b5b PP |
230 | |
231 | def __rmul__(self, other): | |
232 | return self.__mul__(other) | |
233 | ||
234 | def __truediv__(self, other): | |
80d037bc | 235 | return self._value / self._extract_value(other) |
81447b5b PP |
236 | |
237 | def __rtruediv__(self, other): | |
80d037bc | 238 | return self._extract_value(other) / self._value |
81447b5b PP |
239 | |
240 | def __pow__(self, exponent): | |
80d037bc | 241 | return self._value ** self._extract_value(exponent) |
81447b5b PP |
242 | |
243 | def __rpow__(self, base): | |
80d037bc | 244 | return self._extract_value(base) ** self._value |
81447b5b | 245 | |
81447b5b | 246 | |
9cbe0c59 | 247 | class _NumericField(_NumericFieldConst, _Field): |
04068900 FD |
248 | def __hash__(self): |
249 | # Non const field are not hashable as their value may be modified | |
250 | # without changing the underlying Python object. | |
251 | raise TypeError('unhashable type: \'{}\''.format(self._NAME)) | |
9cbe0c59 FD |
252 | |
253 | ||
254 | class _IntegralFieldConst(_NumericFieldConst, numbers.Integral): | |
81447b5b | 255 | def __lshift__(self, other): |
80d037bc | 256 | return self._value << self._extract_value(other) |
81447b5b PP |
257 | |
258 | def __rlshift__(self, other): | |
80d037bc | 259 | return self._extract_value(other) << self._value |
81447b5b PP |
260 | |
261 | def __rshift__(self, other): | |
80d037bc | 262 | return self._value >> self._extract_value(other) |
81447b5b PP |
263 | |
264 | def __rrshift__(self, other): | |
80d037bc | 265 | return self._extract_value(other) >> self._value |
81447b5b PP |
266 | |
267 | def __and__(self, other): | |
80d037bc | 268 | return self._value & self._extract_value(other) |
81447b5b PP |
269 | |
270 | def __rand__(self, other): | |
80d037bc | 271 | return self._extract_value(other) & self._value |
81447b5b PP |
272 | |
273 | def __xor__(self, other): | |
80d037bc | 274 | return self._value ^ self._extract_value(other) |
81447b5b PP |
275 | |
276 | def __rxor__(self, other): | |
80d037bc | 277 | return self._extract_value(other) ^ self._value |
81447b5b PP |
278 | |
279 | def __or__(self, other): | |
80d037bc | 280 | return self._value | self._extract_value(other) |
81447b5b PP |
281 | |
282 | def __ror__(self, other): | |
80d037bc | 283 | return self._extract_value(other) | self._value |
81447b5b PP |
284 | |
285 | def __invert__(self): | |
80d037bc | 286 | return ~self._value |
81447b5b | 287 | |
81447b5b | 288 | |
9cbe0c59 FD |
289 | class _IntegralField(_IntegralFieldConst, _NumericField): |
290 | pass | |
291 | ||
292 | ||
293 | class _BoolFieldConst(_IntegralFieldConst, _FieldConst): | |
294 | _NAME = 'Const boolean' | |
a07f15cb PP |
295 | |
296 | def __bool__(self): | |
297 | return self._value | |
298 | ||
9cbe0c59 FD |
299 | @classmethod |
300 | def _value_to_bool(cls, value): | |
301 | if isinstance(value, _BoolFieldConst): | |
a07f15cb PP |
302 | value = value._value |
303 | ||
304 | if not isinstance(value, bool): | |
305 | raise TypeError( | |
9cbe0c59 | 306 | "'{}' object is not a 'bool', '_BoolFieldConst', or '_BoolField' object".format( |
a07f15cb PP |
307 | value.__class__ |
308 | ) | |
309 | ) | |
310 | ||
311 | return value | |
312 | ||
313 | @property | |
314 | def _value(self): | |
315 | return bool(native_bt.field_bool_get_value(self._ptr)) | |
316 | ||
9cbe0c59 FD |
317 | |
318 | class _BoolField(_BoolFieldConst, _IntegralField, _Field): | |
319 | _NAME = 'Boolean' | |
320 | ||
a07f15cb PP |
321 | def _set_value(self, value): |
322 | value = self._value_to_bool(value) | |
323 | native_bt.field_bool_set_value(self._ptr, value) | |
324 | ||
325 | value = property(fset=_set_value) | |
326 | ||
327 | ||
9cbe0c59 | 328 | class _IntegerFieldConst(_IntegralFieldConst, _FieldConst): |
81447b5b PP |
329 | pass |
330 | ||
331 | ||
9cbe0c59 | 332 | class _IntegerField(_IntegerFieldConst, _IntegralField, _Field): |
cc80c640 FD |
333 | def _check_range(self, value): |
334 | if not (value >= self._lower_bound and value <= self._upper_bound): | |
335 | raise ValueError( | |
336 | "Value {} is outside valid range [{}, {}]".format( | |
337 | value, self._lower_bound, self._upper_bound | |
338 | ) | |
339 | ) | |
9cbe0c59 FD |
340 | |
341 | ||
342 | class _UnsignedIntegerFieldConst(_IntegerFieldConst, _FieldConst): | |
343 | _NAME = 'Const unsigned integer' | |
4470d3a6 | 344 | |
9cbe0c59 FD |
345 | @classmethod |
346 | def _value_to_int(cls, value): | |
e2cf9726 PP |
347 | if not isinstance(value, numbers.Integral): |
348 | raise TypeError('expecting an integral number object') | |
81447b5b | 349 | |
cc80c640 | 350 | return int(value) |
81447b5b PP |
351 | |
352 | @property | |
80d037bc | 353 | def _value(self): |
60bbfc7c | 354 | return native_bt.field_integer_unsigned_get_value(self._ptr) |
81447b5b | 355 | |
9cbe0c59 FD |
356 | |
357 | class _UnsignedIntegerField(_UnsignedIntegerFieldConst, _IntegerField, _Field): | |
358 | _NAME = 'Unsigned integer' | |
359 | ||
27d97a3f SM |
360 | def _set_value(self, value): |
361 | value = self._value_to_int(value) | |
cc80c640 FD |
362 | |
363 | self._check_range(value) | |
364 | ||
60bbfc7c | 365 | native_bt.field_integer_unsigned_set_value(self._ptr, value) |
27d97a3f SM |
366 | |
367 | value = property(fset=_set_value) | |
368 | ||
cc80c640 FD |
369 | @property |
370 | def _lower_bound(self): | |
371 | return 0 | |
372 | ||
373 | @property | |
374 | def _upper_bound(self): | |
375 | return (2 ** self.cls.field_value_range) - 1 | |
376 | ||
27d97a3f | 377 | |
9cbe0c59 FD |
378 | class _SignedIntegerFieldConst(_IntegerFieldConst, _FieldConst): |
379 | _NAME = 'Const signed integer' | |
4470d3a6 | 380 | |
9cbe0c59 FD |
381 | @classmethod |
382 | def _value_to_int(cls, value): | |
e2cf9726 PP |
383 | if not isinstance(value, numbers.Integral): |
384 | raise TypeError('expecting an integral number object') | |
80d037bc | 385 | |
cc80c640 | 386 | return int(value) |
81447b5b | 387 | |
27d97a3f SM |
388 | @property |
389 | def _value(self): | |
60bbfc7c | 390 | return native_bt.field_integer_signed_get_value(self._ptr) |
27d97a3f | 391 | |
9cbe0c59 FD |
392 | |
393 | class _SignedIntegerField(_SignedIntegerFieldConst, _IntegerField, _Field): | |
394 | _NAME = 'Signed integer' | |
395 | ||
80d037bc | 396 | def _set_value(self, value): |
81447b5b | 397 | value = self._value_to_int(value) |
cc80c640 FD |
398 | |
399 | self._check_range(value) | |
400 | ||
60bbfc7c | 401 | native_bt.field_integer_signed_set_value(self._ptr, value) |
81447b5b | 402 | |
80d037bc | 403 | value = property(fset=_set_value) |
81447b5b | 404 | |
cc80c640 FD |
405 | @property |
406 | def _lower_bound(self): | |
407 | return -1 * (2 ** (self.cls.field_value_range - 1)) | |
408 | ||
409 | @property | |
410 | def _upper_bound(self): | |
411 | return (2 ** (self.cls.field_value_range - 1)) - 1 | |
412 | ||
5c8b3186 | 413 | |
9cbe0c59 FD |
414 | class _RealFieldConst(_NumericFieldConst, numbers.Real): |
415 | _NAME = 'Const real' | |
81447b5b | 416 | |
9cbe0c59 FD |
417 | @classmethod |
418 | def _value_to_float(cls, value): | |
81447b5b PP |
419 | if not isinstance(value, numbers.Real): |
420 | raise TypeError("expecting a real number object") | |
421 | ||
422 | return float(value) | |
423 | ||
424 | @property | |
80d037bc | 425 | def _value(self): |
27d97a3f | 426 | return native_bt.field_real_get_value(self._ptr) |
81447b5b | 427 | |
9cbe0c59 FD |
428 | |
429 | class _RealField(_RealFieldConst, _NumericField): | |
430 | _NAME = 'Real' | |
431 | ||
80d037bc | 432 | def _set_value(self, value): |
81447b5b | 433 | value = self._value_to_float(value) |
27d97a3f | 434 | native_bt.field_real_set_value(self._ptr, value) |
81447b5b | 435 | |
80d037bc | 436 | value = property(fset=_set_value) |
81447b5b | 437 | |
5c8b3186 | 438 | |
9cbe0c59 | 439 | class _EnumerationFieldConst(_IntegerFieldConst): |
4470d3a6 SM |
440 | def _repr(self): |
441 | return '{} ({})'.format(self._value, ', '.join(self.labels)) | |
81447b5b PP |
442 | |
443 | @property | |
4470d3a6 | 444 | def labels(self): |
fb25b9e3 | 445 | status, labels = self._get_mapping_labels(self._ptr) |
61d96b89 | 446 | utils._handle_func_status(status, "cannot get label for enumeration field") |
81447b5b | 447 | |
4470d3a6 SM |
448 | assert labels is not None |
449 | return labels | |
81447b5b | 450 | |
a310d6bd | 451 | |
9cbe0c59 FD |
452 | class _EnumerationField(_EnumerationFieldConst, _IntegerField): |
453 | pass | |
454 | ||
455 | ||
456 | class _UnsignedEnumerationFieldConst( | |
457 | _EnumerationFieldConst, _UnsignedIntegerFieldConst | |
458 | ): | |
459 | _NAME = 'Const unsigned Enumeration' | |
61d96b89 | 460 | _get_mapping_labels = staticmethod( |
60bbfc7c | 461 | native_bt.field_enumeration_unsigned_get_mapping_labels |
61d96b89 | 462 | ) |
80d037bc | 463 | |
80d037bc | 464 | |
9cbe0c59 FD |
465 | class _UnsignedEnumerationField( |
466 | _UnsignedEnumerationFieldConst, _EnumerationField, _UnsignedIntegerField | |
467 | ): | |
468 | _NAME = 'Unsigned enumeration' | |
469 | ||
470 | ||
471 | class _SignedEnumerationFieldConst(_EnumerationFieldConst, _SignedIntegerFieldConst): | |
472 | _NAME = 'Const signed Enumeration' | |
61d96b89 | 473 | _get_mapping_labels = staticmethod( |
60bbfc7c | 474 | native_bt.field_enumeration_signed_get_mapping_labels |
61d96b89 | 475 | ) |
81447b5b PP |
476 | |
477 | ||
9cbe0c59 FD |
478 | class _SignedEnumerationField( |
479 | _SignedEnumerationFieldConst, _EnumerationField, _SignedIntegerField | |
480 | ): | |
481 | _NAME = 'Signed enumeration' | |
482 | ||
483 | ||
81447b5b | 484 | @functools.total_ordering |
9cbe0c59 FD |
485 | class _StringFieldConst(_FieldConst): |
486 | _NAME = 'Const string' | |
81447b5b | 487 | |
9cbe0c59 FD |
488 | @classmethod |
489 | def _value_to_str(cls, value): | |
490 | if isinstance(value, _StringFieldConst): | |
80d037bc | 491 | value = value._value |
81447b5b PP |
492 | |
493 | if not isinstance(value, str): | |
494 | raise TypeError("expecting a 'str' object") | |
495 | ||
496 | return value | |
497 | ||
498 | @property | |
80d037bc | 499 | def _value(self): |
4470d3a6 | 500 | return native_bt.field_string_get_value(self._ptr) |
81447b5b | 501 | |
80d037bc | 502 | def _spec_eq(self, other): |
81447b5b | 503 | try: |
0bde7b52 | 504 | return self._value == self._value_to_str(other) |
5760d571 | 505 | except Exception: |
81447b5b PP |
506 | return False |
507 | ||
81447b5b | 508 | def __lt__(self, other): |
80d037bc | 509 | return self._value < self._value_to_str(other) |
81447b5b PP |
510 | |
511 | def __bool__(self): | |
80d037bc | 512 | return bool(self._value) |
81447b5b | 513 | |
04068900 FD |
514 | def __hash__(self): |
515 | return hash(self._value) | |
516 | ||
dc78ca2f | 517 | def _repr(self): |
89182b7e JG |
518 | return repr(self._value) |
519 | ||
81447b5b | 520 | def __str__(self): |
4470d3a6 | 521 | return str(self._value) |
81447b5b PP |
522 | |
523 | def __getitem__(self, index): | |
80d037bc | 524 | return self._value[index] |
81447b5b PP |
525 | |
526 | def __len__(self): | |
4470d3a6 | 527 | return native_bt.field_string_get_length(self._ptr) |
81447b5b | 528 | |
9cbe0c59 FD |
529 | |
530 | class _StringField(_StringFieldConst, _Field): | |
531 | _NAME = 'String' | |
532 | ||
533 | def _set_value(self, value): | |
534 | value = self._value_to_str(value) | |
535 | native_bt.field_string_set_value(self._ptr, value) | |
536 | ||
537 | value = property(fset=_set_value) | |
538 | ||
81447b5b PP |
539 | def __iadd__(self, value): |
540 | value = self._value_to_str(value) | |
fb25b9e3 | 541 | status = native_bt.field_string_append(self._ptr, value) |
61d96b89 FD |
542 | utils._handle_func_status( |
543 | status, "cannot append to string field object's value" | |
544 | ) | |
81447b5b PP |
545 | return self |
546 | ||
04068900 FD |
547 | def __hash__(self): |
548 | # Non const field are not hashable as their value may be modified | |
549 | # without changing the underlying Python object. | |
550 | raise TypeError('unhashable type: \'{}\''.format(self._NAME)) | |
551 | ||
81447b5b | 552 | |
9cbe0c59 | 553 | class _ContainerFieldConst(_FieldConst): |
81447b5b PP |
554 | def __bool__(self): |
555 | return len(self) != 0 | |
556 | ||
9cbe0c59 FD |
557 | def _count(self): |
558 | return len(self.cls) | |
559 | ||
81447b5b PP |
560 | def __len__(self): |
561 | count = self._count() | |
4470d3a6 | 562 | assert count >= 0 |
81447b5b PP |
563 | return count |
564 | ||
565 | def __delitem__(self, index): | |
566 | raise NotImplementedError | |
567 | ||
9cbe0c59 FD |
568 | def __setitem__(self, index, value): |
569 | raise TypeError( | |
570 | '\'{}\' object does not support item assignment'.format(self.__class__) | |
571 | ) | |
81447b5b | 572 | |
81447b5b | 573 | |
9cbe0c59 FD |
574 | class _ContainerField(_ContainerFieldConst, _Field): |
575 | pass | |
81447b5b | 576 | |
81447b5b | 577 | |
9cbe0c59 FD |
578 | class _StructureFieldConst(_ContainerFieldConst, collections.abc.Mapping): |
579 | _NAME = 'Const structure' | |
580 | _borrow_member_field_ptr_by_index = staticmethod( | |
581 | native_bt.field_structure_borrow_member_field_by_index_const | |
582 | ) | |
583 | _borrow_member_field_ptr_by_name = staticmethod( | |
584 | native_bt.field_structure_borrow_member_field_by_name_const | |
585 | ) | |
586 | ||
587 | def _count(self): | |
588 | return len(self.cls) | |
81447b5b | 589 | |
81447b5b PP |
590 | def __iter__(self): |
591 | # same name iterator | |
ffe40722 | 592 | return iter(self.cls) |
81447b5b | 593 | |
80d037bc | 594 | def _spec_eq(self, other): |
0bde7b52 PP |
595 | if not isinstance(other, collections.abc.Mapping): |
596 | return False | |
81447b5b | 597 | |
0bde7b52 PP |
598 | if len(self) != len(other): |
599 | # early mismatch | |
600 | return False | |
81447b5b | 601 | |
0bde7b52 PP |
602 | for self_key in self: |
603 | if self_key not in other: | |
604 | return False | |
81447b5b | 605 | |
0bde7b52 PP |
606 | if self[self_key] != other[self_key]: |
607 | return False | |
80d037bc | 608 | |
0bde7b52 | 609 | return True |
81447b5b | 610 | |
dc78ca2f | 611 | def _repr(self): |
797f4a78 JG |
612 | items = ['{}: {}'.format(repr(k), repr(v)) for k, v in self.items()] |
613 | return '{{{}}}'.format(', '.join(items)) | |
614 | ||
4470d3a6 SM |
615 | def __getitem__(self, key): |
616 | utils._check_str(key) | |
9cbe0c59 | 617 | field_ptr = self._borrow_member_field_ptr_by_name(self._ptr, key) |
5c8b3186 | 618 | |
4470d3a6 SM |
619 | if field_ptr is None: |
620 | raise KeyError(key) | |
81447b5b | 621 | |
9cbe0c59 | 622 | return self._create_field_from_ptr( |
61d96b89 FD |
623 | field_ptr, self._owner_ptr, self._owner_get_ref, self._owner_put_ref |
624 | ) | |
f6a5e476 | 625 | |
4470d3a6 SM |
626 | def member_at_index(self, index): |
627 | utils._check_uint64(index) | |
f6a5e476 | 628 | |
4470d3a6 SM |
629 | if index >= len(self): |
630 | raise IndexError | |
9cbe0c59 | 631 | field_ptr = self._borrow_member_field_ptr_by_index(self._ptr, index) |
4470d3a6 | 632 | assert field_ptr is not None |
9cbe0c59 | 633 | return self._create_field_from_ptr( |
61d96b89 FD |
634 | field_ptr, self._owner_ptr, self._owner_get_ref, self._owner_put_ref |
635 | ) | |
4470d3a6 SM |
636 | |
637 | ||
9cbe0c59 FD |
638 | class _StructureField( |
639 | _StructureFieldConst, _ContainerField, collections.abc.MutableMapping | |
640 | ): | |
641 | _NAME = 'Structure' | |
642 | _borrow_member_field_ptr_by_index = staticmethod( | |
643 | native_bt.field_structure_borrow_member_field_by_index | |
644 | ) | |
645 | _borrow_member_field_ptr_by_name = staticmethod( | |
646 | native_bt.field_structure_borrow_member_field_by_name | |
647 | ) | |
648 | ||
649 | def __setitem__(self, key, value): | |
650 | # raises if key is somehow invalid | |
651 | field = self[key] | |
652 | ||
653 | # the field's property does the appropriate conversion or raises | |
654 | # the appropriate exception | |
655 | field.value = value | |
656 | ||
657 | def _set_value(self, values): | |
658 | try: | |
659 | for key, value in values.items(): | |
660 | self[key].value = value | |
661 | except Exception: | |
662 | raise | |
663 | ||
664 | value = property(fset=_set_value) | |
665 | ||
666 | ||
667 | class _OptionFieldConst(_FieldConst): | |
668 | _NAME = 'Const option' | |
669 | _borrow_field_ptr = staticmethod(native_bt.field_option_borrow_field_const) | |
84eba0d9 PP |
670 | |
671 | @property | |
672 | def field(self): | |
9cbe0c59 | 673 | field_ptr = self._borrow_field_ptr(self._ptr) |
84eba0d9 PP |
674 | |
675 | if field_ptr is None: | |
676 | return | |
677 | ||
9cbe0c59 | 678 | return self._create_field_from_ptr( |
84eba0d9 PP |
679 | field_ptr, self._owner_ptr, self._owner_get_ref, self._owner_put_ref |
680 | ) | |
681 | ||
682 | @property | |
683 | def has_field(self): | |
684 | return self.field is not None | |
685 | ||
84eba0d9 PP |
686 | def _spec_eq(self, other): |
687 | return _get_leaf_field(self) == other | |
688 | ||
689 | def __bool__(self): | |
690 | return self.has_field | |
691 | ||
692 | def __str__(self): | |
693 | return str(self.field) | |
694 | ||
695 | def _repr(self): | |
696 | return repr(self.field) | |
697 | ||
9cbe0c59 FD |
698 | |
699 | class _OptionField(_OptionFieldConst, _Field): | |
700 | _NAME = 'Option' | |
701 | _borrow_field_ptr = staticmethod(native_bt.field_option_borrow_field) | |
702 | ||
703 | def _has_field(self, value): | |
704 | utils._check_bool(value) | |
705 | native_bt.field_option_set_has_field(self._ptr, value) | |
706 | ||
707 | has_field = property(fget=_OptionFieldConst.has_field.fget, fset=_has_field) | |
708 | ||
84eba0d9 PP |
709 | def _set_value(self, value): |
710 | self.has_field = True | |
711 | field = self.field | |
712 | assert field is not None | |
713 | field.value = value | |
714 | ||
715 | value = property(fset=_set_value) | |
716 | ||
717 | ||
9cbe0c59 FD |
718 | class _VariantFieldConst(_ContainerFieldConst, _FieldConst): |
719 | _NAME = 'Const variant' | |
720 | _borrow_selected_option_field_ptr = staticmethod( | |
721 | native_bt.field_variant_borrow_selected_option_field_const | |
722 | ) | |
81447b5b | 723 | |
7a4b69d3 FD |
724 | def _count(self): |
725 | return len(self.cls) | |
726 | ||
81447b5b | 727 | @property |
4470d3a6 SM |
728 | def selected_option_index(self): |
729 | return native_bt.field_variant_get_selected_option_field_index(self._ptr) | |
81447b5b | 730 | |
4470d3a6 SM |
731 | @property |
732 | def selected_option(self): | |
100b6d91 SM |
733 | # TODO: Is there a way to check if the variant field has a selected_option, |
734 | # so we can raise an exception instead of hitting a pre-condition check? | |
735 | # If there is something, that check should be added to selected_option_index too. | |
9cbe0c59 | 736 | field_ptr = self._borrow_selected_option_field_ptr(self._ptr) |
81447b5b | 737 | |
9cbe0c59 | 738 | return self._create_field_from_ptr( |
61d96b89 FD |
739 | field_ptr, self._owner_ptr, self._owner_get_ref, self._owner_put_ref |
740 | ) | |
81447b5b | 741 | |
80d037bc | 742 | def _spec_eq(self, other): |
0bde7b52 | 743 | return _get_leaf_field(self) == other |
f6a5e476 PP |
744 | |
745 | def __bool__(self): | |
4470d3a6 | 746 | raise NotImplementedError |
81447b5b | 747 | |
dc78ca2f | 748 | def __str__(self): |
4470d3a6 | 749 | return str(self.selected_option) |
dc78ca2f JG |
750 | |
751 | def _repr(self): | |
4470d3a6 | 752 | return repr(self.selected_option) |
80d037bc | 753 | |
9cbe0c59 FD |
754 | |
755 | class _VariantField(_VariantFieldConst, _ContainerField, _Field): | |
756 | _NAME = 'Variant' | |
757 | _borrow_selected_option_field_ptr = staticmethod( | |
758 | native_bt.field_variant_borrow_selected_option_field | |
759 | ) | |
760 | ||
761 | def _selected_option_index(self, index): | |
762 | if index < 0 or index >= len(self): | |
763 | raise IndexError('{} field object index is out of range'.format(self._NAME)) | |
764 | ||
765 | native_bt.field_variant_select_option_field_by_index(self._ptr, index) | |
766 | ||
767 | selected_option_index = property( | |
768 | fget=_VariantFieldConst.selected_option_index.fget, fset=_selected_option_index | |
769 | ) | |
770 | ||
80d037bc | 771 | def _set_value(self, value): |
4470d3a6 | 772 | self.selected_option.value = value |
80d037bc JG |
773 | |
774 | value = property(fset=_set_value) | |
81447b5b | 775 | |
5c8b3186 | 776 | |
9cbe0c59 FD |
777 | class _ArrayFieldConst(_ContainerFieldConst, _FieldConst, collections.abc.Sequence): |
778 | _borrow_element_field_ptr_by_index = staticmethod( | |
779 | native_bt.field_array_borrow_element_field_by_index_const | |
780 | ) | |
781 | ||
4470d3a6 SM |
782 | def _get_length(self): |
783 | return native_bt.field_array_get_length(self._ptr) | |
784 | ||
785 | length = property(fget=_get_length) | |
786 | ||
81447b5b PP |
787 | def __getitem__(self, index): |
788 | if not isinstance(index, numbers.Integral): | |
61d96b89 FD |
789 | raise TypeError( |
790 | "'{}' is not an integral number object: invalid index".format( | |
791 | index.__class__.__name__ | |
792 | ) | |
793 | ) | |
81447b5b PP |
794 | |
795 | index = int(index) | |
796 | ||
797 | if index < 0 or index >= len(self): | |
798 | raise IndexError('{} field object index is out of range'.format(self._NAME)) | |
799 | ||
9cbe0c59 | 800 | field_ptr = self._borrow_element_field_ptr_by_index(self._ptr, index) |
61d96b89 | 801 | assert field_ptr |
9cbe0c59 | 802 | return self._create_field_from_ptr( |
61d96b89 FD |
803 | field_ptr, self._owner_ptr, self._owner_get_ref, self._owner_put_ref |
804 | ) | |
81447b5b | 805 | |
81447b5b PP |
806 | def insert(self, index, value): |
807 | raise NotImplementedError | |
808 | ||
80d037bc | 809 | def _spec_eq(self, other): |
0bde7b52 PP |
810 | if not isinstance(other, collections.abc.Sequence): |
811 | return False | |
d5697082 | 812 | |
0bde7b52 PP |
813 | if len(self) != len(other): |
814 | # early mismatch | |
80d037bc | 815 | return False |
d5697082 | 816 | |
0bde7b52 PP |
817 | for self_elem, other_elem in zip(self, other): |
818 | if self_elem != other_elem: | |
819 | return False | |
820 | ||
821 | return True | |
822 | ||
dc78ca2f | 823 | def _repr(self): |
7e06e400 JG |
824 | return '[{}]'.format(', '.join([repr(v) for v in self])) |
825 | ||
81447b5b | 826 | |
9cbe0c59 FD |
827 | class _ArrayField( |
828 | _ArrayFieldConst, _ContainerField, _Field, collections.abc.MutableSequence | |
829 | ): | |
830 | _borrow_element_field_ptr_by_index = staticmethod( | |
831 | native_bt.field_array_borrow_element_field_by_index | |
832 | ) | |
833 | ||
834 | def __setitem__(self, index, value): | |
835 | # raises if index is somehow invalid | |
836 | field = self[index] | |
837 | ||
838 | if not isinstance(field, (_NumericField, _StringField)): | |
839 | raise TypeError('can only set the value of a number or string field') | |
840 | ||
841 | # the field's property does the appropriate conversion or raises | |
842 | # the appropriate exception | |
843 | field.value = value | |
844 | ||
845 | ||
846 | class _StaticArrayFieldConst(_ArrayFieldConst, _FieldConst): | |
847 | _NAME = 'Const static array' | |
81447b5b PP |
848 | |
849 | def _count(self): | |
4470d3a6 | 850 | return native_bt.field_array_get_length(self._ptr) |
81447b5b | 851 | |
9cbe0c59 FD |
852 | |
853 | class _StaticArrayField(_StaticArrayFieldConst, _ArrayField, _Field): | |
854 | _NAME = 'Static array' | |
855 | ||
80d037bc JG |
856 | def _set_value(self, values): |
857 | if len(self) != len(values): | |
e5e6a30a SM |
858 | raise ValueError( |
859 | 'expected length of value ({}) and array field ({}) to match'.format( | |
860 | len(values), len(self) | |
861 | ) | |
862 | ) | |
80d037bc | 863 | |
4470d3a6 SM |
864 | for index, value in enumerate(values): |
865 | if value is not None: | |
866 | self[index].value = value | |
80d037bc JG |
867 | |
868 | value = property(fset=_set_value) | |
869 | ||
81447b5b | 870 | |
9cbe0c59 FD |
871 | class _DynamicArrayFieldConst(_ArrayFieldConst, _FieldConst): |
872 | _NAME = 'Const dynamic array' | |
81447b5b PP |
873 | |
874 | def _count(self): | |
4470d3a6 | 875 | return self.length |
81447b5b | 876 | |
9cbe0c59 FD |
877 | |
878 | class _DynamicArrayField(_DynamicArrayFieldConst, _ArrayField, _Field): | |
879 | _NAME = 'Dynamic array' | |
880 | ||
4470d3a6 SM |
881 | def _set_length(self, length): |
882 | utils._check_uint64(length) | |
60bbfc7c | 883 | status = native_bt.field_array_dynamic_set_length(self._ptr, length) |
fb25b9e3 | 884 | utils._handle_func_status(status, "cannot set dynamic array length") |
81447b5b | 885 | |
4470d3a6 | 886 | length = property(fget=_ArrayField._get_length, fset=_set_length) |
81447b5b | 887 | |
80d037bc | 888 | def _set_value(self, values): |
4470d3a6 SM |
889 | if len(values) != self.length: |
890 | self.length = len(values) | |
80d037bc | 891 | |
4470d3a6 SM |
892 | for index, value in enumerate(values): |
893 | if value is not None: | |
894 | self[index].value = value | |
80d037bc JG |
895 | |
896 | value = property(fset=_set_value) | |
81447b5b | 897 | |
5c8b3186 | 898 | |
9cbe0c59 FD |
899 | _TYPE_ID_TO_CONST_OBJ = { |
900 | native_bt.FIELD_CLASS_TYPE_BOOL: _BoolFieldConst, | |
901 | native_bt.FIELD_CLASS_TYPE_BIT_ARRAY: _BitArrayFieldConst, | |
902 | native_bt.FIELD_CLASS_TYPE_UNSIGNED_INTEGER: _UnsignedIntegerFieldConst, | |
903 | native_bt.FIELD_CLASS_TYPE_SIGNED_INTEGER: _SignedIntegerFieldConst, | |
904 | native_bt.FIELD_CLASS_TYPE_REAL: _RealFieldConst, | |
905 | native_bt.FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION: _UnsignedEnumerationFieldConst, | |
906 | native_bt.FIELD_CLASS_TYPE_SIGNED_ENUMERATION: _SignedEnumerationFieldConst, | |
907 | native_bt.FIELD_CLASS_TYPE_STRING: _StringFieldConst, | |
908 | native_bt.FIELD_CLASS_TYPE_STRUCTURE: _StructureFieldConst, | |
909 | native_bt.FIELD_CLASS_TYPE_STATIC_ARRAY: _StaticArrayFieldConst, | |
910 | native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY: _DynamicArrayFieldConst, | |
911 | native_bt.FIELD_CLASS_TYPE_OPTION: _OptionFieldConst, | |
912 | native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR: _VariantFieldConst, | |
913 | native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR: _VariantFieldConst, | |
914 | native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR: _VariantFieldConst, | |
915 | } | |
916 | ||
81447b5b | 917 | _TYPE_ID_TO_OBJ = { |
a07f15cb | 918 | native_bt.FIELD_CLASS_TYPE_BOOL: _BoolField, |
6b29f2d4 | 919 | native_bt.FIELD_CLASS_TYPE_BIT_ARRAY: _BitArrayField, |
27d97a3f SM |
920 | native_bt.FIELD_CLASS_TYPE_UNSIGNED_INTEGER: _UnsignedIntegerField, |
921 | native_bt.FIELD_CLASS_TYPE_SIGNED_INTEGER: _SignedIntegerField, | |
922 | native_bt.FIELD_CLASS_TYPE_REAL: _RealField, | |
4470d3a6 SM |
923 | native_bt.FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION: _UnsignedEnumerationField, |
924 | native_bt.FIELD_CLASS_TYPE_SIGNED_ENUMERATION: _SignedEnumerationField, | |
27d97a3f SM |
925 | native_bt.FIELD_CLASS_TYPE_STRING: _StringField, |
926 | native_bt.FIELD_CLASS_TYPE_STRUCTURE: _StructureField, | |
4470d3a6 SM |
927 | native_bt.FIELD_CLASS_TYPE_STATIC_ARRAY: _StaticArrayField, |
928 | native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY: _DynamicArrayField, | |
84eba0d9 | 929 | native_bt.FIELD_CLASS_TYPE_OPTION: _OptionField, |
02b61fe0 PP |
930 | native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR: _VariantField, |
931 | native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR: _VariantField, | |
932 | native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR: _VariantField, | |
81447b5b | 933 | } |