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 other
is True or other
is False:
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
):
105 if not isinstance(other
, numbers
.Number
):
106 return NotImplemented
108 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
170 def __iadd__(self
, other
):
171 self
.value
= self
+ other
174 def __isub__(self
, other
):
175 self
.value
= self
- other
178 def __imul__(self
, other
):
179 self
.value
= self
* other
182 def __itruediv__(self
, other
):
183 self
.value
= self
/ other
186 def __ifloordiv__(self
, other
):
187 self
.value
= self
// other
190 def __imod__(self
, other
):
191 self
.value
= self
% other
194 def __ipow__(self
, other
):
195 self
.value
= self
** other
199 class _IntegralField(_NumericField
, numbers
.Integral
):
200 def __lshift__(self
, other
):
201 return self
._value
<< self
._extract
_value
(other
)
203 def __rlshift__(self
, other
):
204 return self
._extract
_value
(other
) << self
._value
206 def __rshift__(self
, other
):
207 return self
._value
>> self
._extract
_value
(other
)
209 def __rrshift__(self
, other
):
210 return self
._extract
_value
(other
) >> self
._value
212 def __and__(self
, other
):
213 return self
._value
& self
._extract
_value
(other
)
215 def __rand__(self
, other
):
216 return self
._extract
_value
(other
) & self
._value
218 def __xor__(self
, other
):
219 return self
._value ^ self
._extract
_value
(other
)
221 def __rxor__(self
, other
):
222 return self
._extract
_value
(other
) ^ self
._value
224 def __or__(self
, other
):
225 return self
._value | self
._extract
_value
(other
)
227 def __ror__(self
, other
):
228 return self
._extract
_value
(other
) | self
._value
230 def __invert__(self
):
233 def __ilshift__(self
, other
):
234 self
.value
= self
<< other
237 def __irshift__(self
, other
):
238 self
.value
= self
>> other
241 def __iand__(self
, other
):
242 self
.value
= self
& other
245 def __ixor__(self
, other
):
246 self
.value
= self ^ other
249 def __ior__(self
, other
):
250 self
.value
= self | other
254 class _IntegerField(_IntegralField
, _Field
):
258 class _UnsignedIntegerField(_IntegerField
, _Field
):
259 _NAME
= 'Unsigned integer'
261 def _value_to_int(self
, value
):
262 if not isinstance(value
, numbers
.Real
):
263 raise TypeError('expecting a real number object')
266 utils
._check
_uint
64(value
)
272 return native_bt
.field_unsigned_integer_get_value(self
._ptr
)
274 def _set_value(self
, value
):
275 value
= self
._value
_to
_int
(value
)
276 native_bt
.field_unsigned_integer_set_value(self
._ptr
, value
)
278 value
= property(fset
=_set_value
)
281 class _SignedIntegerField(_IntegerField
, _Field
):
282 _NAME
= 'Signed integer'
284 def _value_to_int(self
, value
):
285 if not isinstance(value
, numbers
.Real
):
286 raise TypeError('expecting a real number object')
289 utils
._check
_int
64(value
)
295 return native_bt
.field_signed_integer_get_value(self
._ptr
)
297 def _set_value(self
, value
):
298 value
= self
._value
_to
_int
(value
)
299 native_bt
.field_signed_integer_set_value(self
._ptr
, value
)
301 value
= property(fset
=_set_value
)
304 class _RealField(_NumericField
, numbers
.Real
):
307 def _value_to_float(self
, value
):
308 if not isinstance(value
, numbers
.Real
):
309 raise TypeError("expecting a real number object")
315 return native_bt
.field_real_get_value(self
._ptr
)
317 def _set_value(self
, value
):
318 value
= self
._value
_to
_float
(value
)
319 native_bt
.field_real_set_value(self
._ptr
, value
)
321 value
= property(fset
=_set_value
)
324 class _EnumerationField(_IntegerField
):
326 return '{} ({})'.format(self
._value
, ', '.join(self
.labels
))
330 ret
, labels
= self
._get
_mapping
_labels
(self
._ptr
)
331 utils
._handle
_ret
(ret
, "cannot get label for enumeration field")
333 assert labels
is not None
337 class _UnsignedEnumerationField(_EnumerationField
, _UnsignedIntegerField
):
338 _NAME
= 'Unsigned Enumeration'
339 _get_mapping_labels
= staticmethod(native_bt
.field_unsigned_enumeration_get_mapping_labels
)
342 class _SignedEnumerationField(_EnumerationField
, _SignedIntegerField
):
343 _NAME
= 'Signed Enumeration'
344 _get_mapping_labels
= staticmethod(native_bt
.field_signed_enumeration_get_mapping_labels
)
347 @functools.total_ordering
348 class _StringField(_Field
):
351 def _value_to_str(self
, value
):
352 if isinstance(value
, self
.__class
__):
355 if not isinstance(value
, str):
356 raise TypeError("expecting a 'str' object")
362 return native_bt
.field_string_get_value(self
._ptr
)
364 def _set_value(self
, value
):
365 value
= self
._value
_to
_str
(value
)
366 native_bt
.field_string_set_value(self
._ptr
, value
)
368 value
= property(fset
=_set_value
)
370 def _spec_eq(self
, other
):
372 other
= self
._value
_to
_str
(other
)
376 return self
._value
== other
378 def __lt__(self
, other
):
379 return self
._value
< self
._value
_to
_str
(other
)
382 return bool(self
._value
)
385 return repr(self
._value
)
388 return str(self
._value
)
390 def __getitem__(self
, index
):
391 return self
._value
[index
]
394 return native_bt
.field_string_get_length(self
._ptr
)
396 def __iadd__(self
, value
):
397 value
= self
._value
_to
_str
(value
)
398 ret
= native_bt
.field_string_append(self
._ptr
, value
)
399 utils
._handle
_ret
(ret
, "cannot append to string field object's value")
403 class _ContainerField(_Field
):
405 return len(self
) != 0
408 count
= self
._count
()
412 def __delitem__(self
, index
):
413 raise NotImplementedError
416 class _StructureField(_ContainerField
, collections
.abc
.MutableMapping
):
420 return len(self
.field_class
)
422 def __setitem__(self
, key
, value
):
423 # raises if key is somehow invalid
426 # the field's property does the appropriate conversion or raises
427 # the appropriate exception
432 return iter(self
.field_class
)
434 def _spec_eq(self
, other
):
436 if len(self
) != len(other
):
439 for self_key
, self_value
in self
.items():
440 if self_key
not in other
:
443 other_value
= other
[self_key
]
445 if self_value
!= other_value
:
452 def _set_value(self
, values
):
454 for key
, value
in values
.items():
455 self
[key
].value
= value
459 value
= property(fset
=_set_value
)
462 items
= ['{}: {}'.format(repr(k
), repr(v
)) for k
, v
in self
.items()]
463 return '{{{}}}'.format(', '.join(items
))
465 def __getitem__(self
, key
):
466 utils
._check
_str
(key
)
467 field_ptr
= native_bt
.field_structure_borrow_member_field_by_name(self
._ptr
, key
)
469 if field_ptr
is None:
472 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
476 def member_at_index(self
, index
):
477 utils
._check
_uint
64(index
)
479 if index
>= len(self
):
482 field_ptr
= native_bt
.field_structure_borrow_member_field_by_index(self
._ptr
, index
)
483 assert field_ptr
is not None
484 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
489 class _VariantField(_ContainerField
, _Field
):
493 def selected_option_index(self
):
494 return native_bt
.field_variant_get_selected_option_field_index(self
._ptr
)
496 @selected_option_index.setter
497 def selected_option_index(self
, index
):
498 native_bt
.field_variant_select_option_field(self
._ptr
, index
)
501 def selected_option(self
):
502 field_ptr
= native_bt
.field_variant_borrow_selected_option_field(self
._ptr
)
503 utils
._handle
_ptr
(field_ptr
, "cannot get variant field's selected option")
505 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
509 def _spec_eq(self
, other
):
510 new_self
= _get_leaf_field(self
)
511 return new_self
== other
514 raise NotImplementedError
517 return str(self
.selected_option
)
520 return repr(self
.selected_option
)
522 def _set_value(self
, value
):
523 self
.selected_option
.value
= value
525 value
= property(fset
=_set_value
)
528 class _ArrayField(_ContainerField
, _Field
, collections
.abc
.MutableSequence
):
529 def _get_length(self
):
530 return native_bt
.field_array_get_length(self
._ptr
)
532 length
= property(fget
=_get_length
)
534 def __getitem__(self
, index
):
535 if not isinstance(index
, numbers
.Integral
):
536 raise TypeError("'{}' is not an integral number object: invalid index".format(index
.__class
__.__name
__))
540 if index
< 0 or index
>= len(self
):
541 raise IndexError('{} field object index is out of range'.format(self
._NAME
))
543 field_ptr
= native_bt
.field_array_borrow_element_field_by_index(self
._ptr
, index
)
545 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
549 def __setitem__(self
, index
, value
):
550 # we can only set numbers and strings
551 if not isinstance(value
, (numbers
.Number
, _StringField
, str)):
552 raise TypeError('expecting number or string object')
554 # raises if index is somehow invalid
557 if not isinstance(field
, (_NumericField
, _StringField
)):
558 raise TypeError('can only set the value of a number or string field')
560 # the field's property does the appropriate conversion or raises
561 # the appropriate exception
564 def insert(self
, index
, value
):
565 raise NotImplementedError
567 def _spec_eq(self
, other
):
569 if len(self
) != len(other
):
572 for self_field
, other_field
in zip(self
, other
):
573 if self_field
!= other_field
:
581 return '[{}]'.format(', '.join([repr(v
) for v
in self
]))
584 class _StaticArrayField(_ArrayField
, _Field
):
585 _NAME
= 'Static array'
588 return native_bt
.field_array_get_length(self
._ptr
)
590 def _set_value(self
, values
):
591 if len(self
) != len(values
):
593 'expected length of value and array field to match')
595 for index
, value
in enumerate(values
):
596 if value
is not None:
597 self
[index
].value
= value
599 value
= property(fset
=_set_value
)
602 class _DynamicArrayField(_ArrayField
, _Field
):
603 _NAME
= 'Dynamic array'
608 def _set_length(self
, length
):
609 utils
._check
_uint
64(length
)
610 ret
= native_bt
.field_dynamic_array_set_length(self
._ptr
, length
)
611 utils
._handle
_ret
(ret
, "cannot set dynamic array length")
613 length
= property(fget
=_ArrayField
._get
_length
, fset
=_set_length
)
615 def _set_value(self
, values
):
616 if len(values
) != self
.length
:
617 self
.length
= len(values
)
619 for index
, value
in enumerate(values
):
620 if value
is not None:
621 self
[index
].value
= value
623 value
= property(fset
=_set_value
)
627 native_bt
.FIELD_CLASS_TYPE_UNSIGNED_INTEGER
: _UnsignedIntegerField
,
628 native_bt
.FIELD_CLASS_TYPE_SIGNED_INTEGER
: _SignedIntegerField
,
629 native_bt
.FIELD_CLASS_TYPE_REAL
: _RealField
,
630 native_bt
.FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
: _UnsignedEnumerationField
,
631 native_bt
.FIELD_CLASS_TYPE_SIGNED_ENUMERATION
: _SignedEnumerationField
,
632 native_bt
.FIELD_CLASS_TYPE_STRING
: _StringField
,
633 native_bt
.FIELD_CLASS_TYPE_STRUCTURE
: _StructureField
,
634 native_bt
.FIELD_CLASS_TYPE_STATIC_ARRAY
: _StaticArrayField
,
635 native_bt
.FIELD_CLASS_TYPE_DYNAMIC_ARRAY
: _DynamicArrayField
,
636 native_bt
.FIELD_CLASS_TYPE_VARIANT
: _VariantField
,