1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
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:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
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
23 from bt2
import native_bt
, object, utils
24 import bt2
.field_class
25 import collections
.abc
32 def _create_field_from_ptr(ptr
, owner_ptr
, owner_get_ref
, owner_put_ref
):
33 field_class_ptr
= native_bt
.field_borrow_class_const(ptr
)
34 utils
._handle
_ptr
(field_class_ptr
, "cannot get field object's class")
35 typeid
= native_bt
.field_class_get_type(field_class_ptr
)
36 field
= _TYPE_ID_TO_OBJ
[typeid
]._create
_from
_ptr
_and
_get
_ref
(
37 ptr
, owner_ptr
, owner_get_ref
, owner_put_ref
)
41 # Get the "effective" field of `field`. If `field` is a variant, return the
42 # currently selected field. If `field` is of any other type, return `field`
45 def _get_leaf_field(field
):
46 if not isinstance(field
, _VariantField
):
49 return _get_leaf_field(field
.selected_option
)
52 class _Field(object._UniqueObject
):
53 def __eq__(self
, other
):
54 other
= _get_leaf_field(other
)
55 return self
._spec
_eq
(other
)
58 def field_class(self
):
59 field_class_ptr
= native_bt
.field_borrow_class_const(self
._ptr
)
60 assert field_class_ptr
is not None
61 return bt2
.field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(field_class_ptr
)
64 raise NotImplementedError
70 @functools.total_ordering
71 class _NumericField(_Field
):
73 def _extract_value(other
):
74 if isinstance(other
, bool):
77 if isinstance(other
, numbers
.Integral
):
80 if isinstance(other
, numbers
.Real
):
83 if isinstance(other
, numbers
.Complex
):
86 raise TypeError("'{}' object is not a number object".format(other
.__class
__.__name
__))
89 return int(self
._value
)
92 return float(self
._value
)
95 return repr(self
._value
)
97 def __lt__(self
, other
):
98 if not isinstance(other
, numbers
.Number
):
99 raise TypeError('unorderable types: {}() < {}()'.format(self
.__class
__.__name
__,
100 other
.__class
__.__name
__))
102 return self
._value
< self
._extract
_value
(other
)
104 def _spec_eq(self
, other
):
106 return self
._value
== self
._extract
_value
(other
)
110 def __rmod__(self
, other
):
111 return self
._extract
_value
(other
) % self
._value
113 def __mod__(self
, other
):
114 return self
._value
% self
._extract
_value
(other
)
116 def __rfloordiv__(self
, other
):
117 return self
._extract
_value
(other
) // self
._value
119 def __floordiv__(self
, other
):
120 return self
._value
// self
._extract
_value
(other
)
122 def __round__(self
, ndigits
=None):
124 return round(self
._value
)
126 return round(self
._value
, ndigits
)
129 return math
.ceil(self
._value
)
132 return math
.floor(self
._value
)
135 return int(self
._value
)
138 return abs(self
._value
)
140 def __add__(self
, other
):
141 return self
._value
+ self
._extract
_value
(other
)
143 def __radd__(self
, other
):
144 return self
.__add
__(other
)
152 def __mul__(self
, other
):
153 return self
._value
* self
._extract
_value
(other
)
155 def __rmul__(self
, other
):
156 return self
.__mul
__(other
)
158 def __truediv__(self
, other
):
159 return self
._value
/ self
._extract
_value
(other
)
161 def __rtruediv__(self
, other
):
162 return self
._extract
_value
(other
) / self
._value
164 def __pow__(self
, exponent
):
165 return self
._value
** self
._extract
_value
(exponent
)
167 def __rpow__(self
, base
):
168 return self
._extract
_value
(base
) ** self
._value
171 class _IntegralField(_NumericField
, numbers
.Integral
):
172 def __lshift__(self
, other
):
173 return self
._value
<< self
._extract
_value
(other
)
175 def __rlshift__(self
, other
):
176 return self
._extract
_value
(other
) << self
._value
178 def __rshift__(self
, other
):
179 return self
._value
>> self
._extract
_value
(other
)
181 def __rrshift__(self
, other
):
182 return self
._extract
_value
(other
) >> self
._value
184 def __and__(self
, other
):
185 return self
._value
& self
._extract
_value
(other
)
187 def __rand__(self
, other
):
188 return self
._extract
_value
(other
) & self
._value
190 def __xor__(self
, other
):
191 return self
._value ^ self
._extract
_value
(other
)
193 def __rxor__(self
, other
):
194 return self
._extract
_value
(other
) ^ self
._value
196 def __or__(self
, other
):
197 return self
._value | self
._extract
_value
(other
)
199 def __ror__(self
, other
):
200 return self
._extract
_value
(other
) | self
._value
202 def __invert__(self
):
206 class _IntegerField(_IntegralField
, _Field
):
210 class _UnsignedIntegerField(_IntegerField
, _Field
):
211 _NAME
= 'Unsigned integer'
213 def _value_to_int(self
, value
):
214 if not isinstance(value
, numbers
.Integral
):
215 raise TypeError('expecting an integral number object')
218 utils
._check
_uint
64(value
)
224 return native_bt
.field_unsigned_integer_get_value(self
._ptr
)
226 def _set_value(self
, value
):
227 value
= self
._value
_to
_int
(value
)
228 native_bt
.field_unsigned_integer_set_value(self
._ptr
, value
)
230 value
= property(fset
=_set_value
)
233 class _SignedIntegerField(_IntegerField
, _Field
):
234 _NAME
= 'Signed integer'
236 def _value_to_int(self
, value
):
237 if not isinstance(value
, numbers
.Integral
):
238 raise TypeError('expecting an integral number object')
241 utils
._check
_int
64(value
)
247 return native_bt
.field_signed_integer_get_value(self
._ptr
)
249 def _set_value(self
, value
):
250 value
= self
._value
_to
_int
(value
)
251 native_bt
.field_signed_integer_set_value(self
._ptr
, value
)
253 value
= property(fset
=_set_value
)
256 class _RealField(_NumericField
, numbers
.Real
):
259 def _value_to_float(self
, value
):
260 if not isinstance(value
, numbers
.Real
):
261 raise TypeError("expecting a real number object")
267 return native_bt
.field_real_get_value(self
._ptr
)
269 def _set_value(self
, value
):
270 value
= self
._value
_to
_float
(value
)
271 native_bt
.field_real_set_value(self
._ptr
, value
)
273 value
= property(fset
=_set_value
)
276 class _EnumerationField(_IntegerField
):
278 return '{} ({})'.format(self
._value
, ', '.join(self
.labels
))
282 status
, labels
= self
._get
_mapping
_labels
(self
._ptr
)
283 utils
._handle
_func
_status
(status
,
284 "cannot get label for enumeration field")
286 assert labels
is not None
290 class _UnsignedEnumerationField(_EnumerationField
, _UnsignedIntegerField
):
291 _NAME
= 'Unsigned Enumeration'
292 _get_mapping_labels
= staticmethod(native_bt
.field_unsigned_enumeration_get_mapping_labels
)
295 class _SignedEnumerationField(_EnumerationField
, _SignedIntegerField
):
296 _NAME
= 'Signed Enumeration'
297 _get_mapping_labels
= staticmethod(native_bt
.field_signed_enumeration_get_mapping_labels
)
300 @functools.total_ordering
301 class _StringField(_Field
):
304 def _value_to_str(self
, value
):
305 if isinstance(value
, self
.__class
__):
308 if not isinstance(value
, str):
309 raise TypeError("expecting a 'str' object")
315 return native_bt
.field_string_get_value(self
._ptr
)
317 def _set_value(self
, value
):
318 value
= self
._value
_to
_str
(value
)
319 native_bt
.field_string_set_value(self
._ptr
, value
)
321 value
= property(fset
=_set_value
)
323 def _spec_eq(self
, other
):
325 return self
._value
== self
._value
_to
_str
(other
)
329 def __lt__(self
, other
):
330 return self
._value
< self
._value
_to
_str
(other
)
333 return bool(self
._value
)
336 return repr(self
._value
)
339 return str(self
._value
)
341 def __getitem__(self
, index
):
342 return self
._value
[index
]
345 return native_bt
.field_string_get_length(self
._ptr
)
347 def __iadd__(self
, value
):
348 value
= self
._value
_to
_str
(value
)
349 status
= native_bt
.field_string_append(self
._ptr
, value
)
350 utils
._handle
_func
_status
(status
,
351 "cannot append to string field object's value")
355 class _ContainerField(_Field
):
357 return len(self
) != 0
360 count
= self
._count
()
364 def __delitem__(self
, index
):
365 raise NotImplementedError
368 class _StructureField(_ContainerField
, collections
.abc
.MutableMapping
):
372 return len(self
.field_class
)
374 def __setitem__(self
, key
, value
):
375 # raises if key is somehow invalid
378 # the field's property does the appropriate conversion or raises
379 # the appropriate exception
384 return iter(self
.field_class
)
386 def _spec_eq(self
, other
):
387 if not isinstance(other
, collections
.abc
.Mapping
):
390 if len(self
) != len(other
):
394 for self_key
in self
:
395 if self_key
not in other
:
398 if self
[self_key
] != other
[self_key
]:
403 def _set_value(self
, values
):
405 for key
, value
in values
.items():
406 self
[key
].value
= value
410 value
= property(fset
=_set_value
)
413 items
= ['{}: {}'.format(repr(k
), repr(v
)) for k
, v
in self
.items()]
414 return '{{{}}}'.format(', '.join(items
))
416 def __getitem__(self
, key
):
417 utils
._check
_str
(key
)
418 field_ptr
= native_bt
.field_structure_borrow_member_field_by_name(self
._ptr
, key
)
420 if field_ptr
is None:
423 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
427 def member_at_index(self
, index
):
428 utils
._check
_uint
64(index
)
430 if index
>= len(self
):
433 field_ptr
= native_bt
.field_structure_borrow_member_field_by_index(self
._ptr
, index
)
434 assert field_ptr
is not None
435 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
440 class _VariantField(_ContainerField
, _Field
):
444 def selected_option_index(self
):
445 return native_bt
.field_variant_get_selected_option_field_index(self
._ptr
)
447 @selected_option_index.setter
448 def selected_option_index(self
, index
):
449 native_bt
.field_variant_select_option_field(self
._ptr
, index
)
452 def selected_option(self
):
453 field_ptr
= native_bt
.field_variant_borrow_selected_option_field(self
._ptr
)
454 utils
._handle
_ptr
(field_ptr
, "cannot get variant field's selected option")
456 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
460 def _spec_eq(self
, other
):
461 return _get_leaf_field(self
) == other
464 raise NotImplementedError
467 return str(self
.selected_option
)
470 return repr(self
.selected_option
)
472 def _set_value(self
, value
):
473 self
.selected_option
.value
= value
475 value
= property(fset
=_set_value
)
478 class _ArrayField(_ContainerField
, _Field
, collections
.abc
.MutableSequence
):
479 def _get_length(self
):
480 return native_bt
.field_array_get_length(self
._ptr
)
482 length
= property(fget
=_get_length
)
484 def __getitem__(self
, index
):
485 if not isinstance(index
, numbers
.Integral
):
486 raise TypeError("'{}' is not an integral number object: invalid index".format(index
.__class
__.__name
__))
490 if index
< 0 or index
>= len(self
):
491 raise IndexError('{} field object index is out of range'.format(self
._NAME
))
493 field_ptr
= native_bt
.field_array_borrow_element_field_by_index(self
._ptr
, index
)
495 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
499 def __setitem__(self
, index
, value
):
500 # raises if index is somehow invalid
503 if not isinstance(field
, (_NumericField
, _StringField
)):
504 raise TypeError('can only set the value of a number or string field')
506 # the field's property does the appropriate conversion or raises
507 # the appropriate exception
510 def insert(self
, index
, value
):
511 raise NotImplementedError
513 def _spec_eq(self
, other
):
514 if not isinstance(other
, collections
.abc
.Sequence
):
517 if len(self
) != len(other
):
521 for self_elem
, other_elem
in zip(self
, other
):
522 if self_elem
!= other_elem
:
528 return '[{}]'.format(', '.join([repr(v
) for v
in self
]))
531 class _StaticArrayField(_ArrayField
, _Field
):
532 _NAME
= 'Static array'
535 return native_bt
.field_array_get_length(self
._ptr
)
537 def _set_value(self
, values
):
538 if len(self
) != len(values
):
540 'expected length of value and array field to match')
542 for index
, value
in enumerate(values
):
543 if value
is not None:
544 self
[index
].value
= value
546 value
= property(fset
=_set_value
)
549 class _DynamicArrayField(_ArrayField
, _Field
):
550 _NAME
= 'Dynamic array'
555 def _set_length(self
, length
):
556 utils
._check
_uint
64(length
)
557 status
= native_bt
.field_dynamic_array_set_length(self
._ptr
, length
)
558 utils
._handle
_func
_status
(status
, "cannot set dynamic array length")
560 length
= property(fget
=_ArrayField
._get
_length
, fset
=_set_length
)
562 def _set_value(self
, values
):
563 if len(values
) != self
.length
:
564 self
.length
= len(values
)
566 for index
, value
in enumerate(values
):
567 if value
is not None:
568 self
[index
].value
= value
570 value
= property(fset
=_set_value
)
574 native_bt
.FIELD_CLASS_TYPE_UNSIGNED_INTEGER
: _UnsignedIntegerField
,
575 native_bt
.FIELD_CLASS_TYPE_SIGNED_INTEGER
: _SignedIntegerField
,
576 native_bt
.FIELD_CLASS_TYPE_REAL
: _RealField
,
577 native_bt
.FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
: _UnsignedEnumerationField
,
578 native_bt
.FIELD_CLASS_TYPE_SIGNED_ENUMERATION
: _SignedEnumerationField
,
579 native_bt
.FIELD_CLASS_TYPE_STRING
: _StringField
,
580 native_bt
.FIELD_CLASS_TYPE_STRUCTURE
: _StructureField
,
581 native_bt
.FIELD_CLASS_TYPE_STATIC_ARRAY
: _StaticArrayField
,
582 native_bt
.FIELD_CLASS_TYPE_DYNAMIC_ARRAY
: _DynamicArrayField
,
583 native_bt
.FIELD_CLASS_TYPE_VARIANT
: _VariantField
,