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