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
33 def _get_leaf_field(obj
):
34 if type(obj
) is not _VariantField
:
37 return _get_leaf_field(obj
.selected_field
)
40 def _create_field_from_ptr(ptr
, owner_ptr
, owner_get_ref
, owner_put_ref
):
41 field_class_ptr
= native_bt
.field_borrow_class_const(ptr
)
42 utils
._handle
_ptr
(field_class_ptr
, "cannot get field object's class")
43 typeid
= native_bt
.field_class_get_type(field_class_ptr
)
44 field
= _TYPE_ID_TO_OBJ
[typeid
]._create
_from
_ptr
_and
_get
_ref
(
45 ptr
, owner_ptr
, owner_get_ref
, owner_put_ref
)
49 class _Field(object._UniqueObject
, metaclass
=abc
.ABCMeta
):
51 ptr
= native_bt
.field_copy(self
._ptr
)
52 utils
._handle
_ptr
(ptr
, 'cannot copy {} field object'.format(self
._NAME
.lower()))
53 return _create_from_ptr(ptr
)
55 def __deepcopy__(self
, memo
):
60 def __eq__(self
, other
):
61 # special case: two unset fields with the same field class are equal
62 if isinstance(other
, _Field
):
63 if not self
.is_set
or not other
.is_set
:
64 if not self
.is_set
and not other
.is_set
and self
.field_class
== other
.field_class
:
68 other
= _get_leaf_field(other
)
69 return self
._spec
_eq
(other
)
72 def field_class(self
):
73 field_class_ptr
= native_bt
.field_borrow_class_const(self
._ptr
)
74 assert field_class_ptr
is not None
75 return bt2
.field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(field_class_ptr
)
79 is_set
= native_bt
.field_is_set(self
._ptr
)
83 ret
= native_bt
.field_reset(self
._ptr
)
84 utils
._handle
_ret
(ret
, "cannot reset field object's value")
87 raise NotImplementedError
90 return self
._repr
() if self
.is_set
else 'Unset'
93 @functools.total_ordering
94 class _NumericField(_Field
):
96 def _extract_value(other
):
97 if other
is True or other
is False:
100 if isinstance(other
, numbers
.Integral
):
103 if isinstance(other
, numbers
.Real
):
106 if isinstance(other
, numbers
.Complex
):
107 return complex(other
)
109 raise TypeError("'{}' object is not a number object".format(other
.__class
__.__name
__))
112 return int(self
._value
)
115 return float(self
._value
)
118 return repr(self
._value
)
120 def __lt__(self
, other
):
121 if not isinstance(other
, numbers
.Number
):
122 raise TypeError('unorderable types: {}() < {}()'.format(self
.__class
__.__name
__,
123 other
.__class
__.__name
__))
125 return self
._value
< float(other
)
127 def __le__(self
, other
):
128 if not isinstance(other
, numbers
.Number
):
129 raise TypeError('unorderable types: {}() <= {}()'.format(self
.__class
__.__name
__,
130 other
.__class
__.__name
__))
132 return self
._value
<= float(other
)
134 def _spec_eq(self
, other
):
135 if not isinstance(other
, numbers
.Number
):
138 return self
._value
== complex(other
)
140 def __rmod__(self
, other
):
141 return self
._extract
_value
(other
) % self
._value
143 def __mod__(self
, other
):
144 return self
._value
% self
._extract
_value
(other
)
146 def __rfloordiv__(self
, other
):
147 return self
._extract
_value
(other
) // self
._value
149 def __floordiv__(self
, other
):
150 return self
._value
// self
._extract
_value
(other
)
152 def __round__(self
, ndigits
=None):
154 return round(self
._value
)
156 return round(self
._value
, ndigits
)
159 return math
.ceil(self
._value
)
162 return math
.floor(self
._value
)
165 return int(self
._value
)
168 return abs(self
._value
)
170 def __add__(self
, other
):
171 return self
._value
+ self
._extract
_value
(other
)
173 def __radd__(self
, other
):
174 return self
.__add
__(other
)
182 def __mul__(self
, other
):
183 return self
._value
* self
._extract
_value
(other
)
185 def __rmul__(self
, other
):
186 return self
.__mul
__(other
)
188 def __truediv__(self
, other
):
189 return self
._value
/ self
._extract
_value
(other
)
191 def __rtruediv__(self
, other
):
192 return self
._extract
_value
(other
) / self
._value
194 def __pow__(self
, exponent
):
195 return self
._value
** self
._extract
_value
(exponent
)
197 def __rpow__(self
, base
):
198 return self
._extract
_value
(base
) ** self
._value
200 def __iadd__(self
, other
):
201 self
.value
= self
+ other
204 def __isub__(self
, other
):
205 self
.value
= self
- other
208 def __imul__(self
, other
):
209 self
.value
= self
* other
212 def __itruediv__(self
, other
):
213 self
.value
= self
/ other
216 def __ifloordiv__(self
, other
):
217 self
.value
= self
// other
220 def __imod__(self
, other
):
221 self
.value
= self
% other
224 def __ipow__(self
, other
):
225 self
.value
= self
** other
229 class _IntegralField(_NumericField
, numbers
.Integral
):
230 def __lshift__(self
, other
):
231 return self
._value
<< self
._extract
_value
(other
)
233 def __rlshift__(self
, other
):
234 return self
._extract
_value
(other
) << self
._value
236 def __rshift__(self
, other
):
237 return self
._value
>> self
._extract
_value
(other
)
239 def __rrshift__(self
, other
):
240 return self
._extract
_value
(other
) >> self
._value
242 def __and__(self
, other
):
243 return self
._value
& self
._extract
_value
(other
)
245 def __rand__(self
, other
):
246 return self
._extract
_value
(other
) & self
._value
248 def __xor__(self
, other
):
249 return self
._value ^ self
._extract
_value
(other
)
251 def __rxor__(self
, other
):
252 return self
._extract
_value
(other
) ^ self
._value
254 def __or__(self
, other
):
255 return self
._value | self
._extract
_value
(other
)
257 def __ror__(self
, other
):
258 return self
._extract
_value
(other
) | self
._value
260 def __invert__(self
):
263 def __ilshift__(self
, other
):
264 self
.value
= self
<< other
267 def __irshift__(self
, other
):
268 self
.value
= self
>> other
271 def __iand__(self
, other
):
272 self
.value
= self
& other
275 def __ixor__(self
, other
):
276 self
.value
= self ^ other
279 def __ior__(self
, other
):
280 self
.value
= self | other
284 class _IntegerField(_IntegralField
, _Field
):
288 class _UnsignedIntegerField(_IntegerField
, _Field
):
289 _NAME
= 'Unsigned integer'
290 def _value_to_int(self
, value
):
291 if not isinstance(value
, numbers
.Real
):
292 raise TypeError('expecting a real number object')
295 utils
._check
_uint
64(value
)
301 return native_bt
.field_unsigned_integer_get_value(self
._ptr
)
303 def _set_value(self
, value
):
304 value
= self
._value
_to
_int
(value
)
305 native_bt
.field_unsigned_integer_set_value(self
._ptr
, value
)
307 value
= property(fset
=_set_value
)
310 class _SignedIntegerField(_IntegerField
, _Field
):
311 _NAME
= 'Signed integer'
312 def _value_to_int(self
, value
):
313 if not isinstance(value
, numbers
.Real
):
314 raise TypeError('expecting a real number object')
317 utils
._check
_int
64(value
)
323 return native_bt
.field_signed_integer_get_value(self
._ptr
)
325 def _set_value(self
, value
):
326 value
= self
._value
_to
_int
(value
)
327 native_bt
.field_signed_integer_set_value(self
._ptr
, value
)
329 value
= property(fset
=_set_value
)
332 class _RealField(_NumericField
, numbers
.Real
):
335 def _value_to_float(self
, value
):
336 if not isinstance(value
, numbers
.Real
):
337 raise TypeError("expecting a real number object")
343 return native_bt
.field_real_get_value(self
._ptr
)
345 def _set_value(self
, value
):
346 value
= self
._value
_to
_float
(value
)
347 native_bt
.field_real_set_value(self
._ptr
, value
)
349 value
= property(fset
=_set_value
)
352 class _EnumerationField(_IntegerField
):
353 _NAME
= 'Enumeration'
356 def integer_field(self
):
357 int_field_ptr
= native_bt
.field_enumeration_get_container(self
._ptr
)
358 assert(int_field_ptr
)
359 return _create_from_ptr(int_field_ptr
)
361 def _set_value(self
, value
):
362 self
.integer_field
.value
= value
365 labels
= [repr(v
.name
) for v
in self
.mappings
]
366 return '{} ({})'.format(self
._value
, ', '.join(labels
))
368 value
= property(fset
=_set_value
)
372 return self
.integer_field
._value
376 iter_ptr
= native_bt
.field_enumeration_get_mappings(self
._ptr
)
378 return bt2
.field_class
._EnumerationFieldClassMappingIterator
(iter_ptr
,
379 self
.field_class
.is_signed
)
382 @functools.total_ordering
383 class _StringField(_Field
, collections
.abc
.Sequence
):
386 def _value_to_str(self
, value
):
387 if isinstance(value
, self
.__class
__):
390 if not isinstance(value
, str):
391 raise TypeError("expecting a 'str' object")
397 value
= native_bt
.field_string_get_value(self
._ptr
)
400 def _set_value(self
, value
):
401 value
= self
._value
_to
_str
(value
)
402 ret
= native_bt
.field_string_set_value(self
._ptr
, value
)
403 utils
._handle
_ret
(ret
, "cannot set string field object's value")
405 value
= property(fset
=_set_value
)
407 def _spec_eq(self
, other
):
409 other
= self
._value
_to
_str
(other
)
413 return self
._value
== other
415 def __le__(self
, other
):
416 return self
._value
<= self
._value
_to
_str
(other
)
418 def __lt__(self
, other
):
419 return self
._value
< self
._value
_to
_str
(other
)
422 return bool(self
._value
)
425 return repr(self
._value
)
428 return self
._value
if self
.is_set
else repr(self
)
430 def __getitem__(self
, index
):
431 return self
._value
[index
]
434 return len(self
._value
)
436 def __iadd__(self
, value
):
437 value
= self
._value
_to
_str
(value
)
438 ret
= native_bt
.field_string_append(self
._ptr
, value
)
439 utils
._handle
_ret
(ret
, "cannot append to string field object's value")
443 class _ContainerField(_Field
):
445 return len(self
) != 0
448 count
= self
._count
()
452 def __delitem__(self
, index
):
453 raise NotImplementedError
456 class _StructureField(_ContainerField
, collections
.abc
.MutableMapping
):
460 return len(self
.field_class
)
462 def __getitem__(self
, key
):
463 utils
._check
_str
(key
)
464 field_ptr
= native_bt
.field_structure_borrow_member_field_by_name(self
._ptr
, key
)
466 if field_ptr
is None:
469 return _create_field_from_ptr(field_ptr
, self
._owner
_ptr
,
473 def __setitem__(self
, key
, value
):
474 # raises if key is somehow invalid
477 # the field's property does the appropriate conversion or raises
478 # the appropriate exception
481 def at_index(self
, index
):
482 utils
._check
_uint
64(index
)
484 if index
>= len(self
):
487 field_ptr
= native_bt
.field_structure_get_field_by_index(self
._ptr
, index
)
489 return _create_from_ptr(field_ptr
)
493 return iter(self
.field_class
)
495 def _spec_eq(self
, other
):
497 if len(self
) != len(other
):
500 for self_key
, self_value
in self
.items():
501 if self_key
not in other
:
504 other_value
= other
[self_key
]
506 if self_value
!= other_value
:
515 return {key
: value
._value
for key
, value
in self
.items()}
517 def _set_value(self
, values
):
518 original_values
= self
._value
521 for key
, value
in values
.items():
522 self
[key
].value
= value
524 self
.value
= original_values
527 value
= property(fset
=_set_value
)
530 items
= ['{}: {}'.format(repr(k
), repr(v
)) for k
, v
in self
.items()]
531 return '{{{}}}'.format(', '.join(items
))
534 class _VariantField(_Field
):
539 field_ptr
= native_bt
.field_variant_get_tag(self
._ptr
)
541 if field_ptr
is None:
544 return _create_from_ptr(field_ptr
)
547 def selected_field(self
):
550 def field(self
, tag_field
=None):
551 if tag_field
is None:
552 field_ptr
= native_bt
.field_variant_get_current_field(self
._ptr
)
554 if field_ptr
is None:
557 utils
._check
_type
(tag_field
, _EnumerationField
)
558 field_ptr
= native_bt
.field_variant_get_field(self
._ptr
, tag_field
._ptr
)
559 utils
._handle
_ptr
(field_ptr
, "cannot select variant field object's field")
561 return _create_from_ptr(field_ptr
)
563 def _spec_eq(self
, other
):
564 return _get_leaf_field(self
) == other
567 return bool(self
.selected_field
)
570 return str(self
.selected_field
) if self
.is_set
else repr(self
)
573 return repr(self
.selected_field
)
577 if self
.selected_field
is not None:
578 return self
.selected_field
._value
580 def _set_value(self
, value
):
581 self
.selected_field
.value
= value
583 value
= property(fset
=_set_value
)
586 class _ArraySequenceField(_ContainerField
, collections
.abc
.MutableSequence
):
587 def __getitem__(self
, index
):
588 if not isinstance(index
, numbers
.Integral
):
589 raise TypeError("'{}' is not an integral number object: invalid index".format(index
.__class
__.__name
__))
593 if index
< 0 or index
>= len(self
):
594 raise IndexError('{} field object index is out of range'.format(self
._NAME
))
596 field_ptr
= self
._get
_field
_ptr
_at
_index
(index
)
598 return _create_from_ptr(field_ptr
)
600 def __setitem__(self
, index
, value
):
601 # we can only set numbers and strings
602 if not isinstance(value
, (numbers
.Number
, _StringField
, str)):
603 raise TypeError('expecting number or string object')
605 # raises if index is somehow invalid
608 if not isinstance(field
, (_NumericField
, _StringField
)):
609 raise TypeError('can only set the value of a number or string field')
611 # the field's property does the appropriate conversion or raises
612 # the appropriate exception
615 def insert(self
, index
, value
):
616 raise NotImplementedError
618 def _spec_eq(self
, other
):
620 if len(self
) != len(other
):
623 for self_field
, other_field
in zip(self
, other
):
624 if self_field
!= other_field
:
633 return [field
._value
for field
in self
]
636 return '[{}]'.format(', '.join([repr(v
) for v
in self
]))
639 class _ArrayField(_ArraySequenceField
):
643 return self
.field_class
.length
645 def _get_field_ptr_at_index(self
, index
):
646 return native_bt
.field_array_get_field(self
._ptr
, index
)
648 def _set_value(self
, values
):
649 if len(self
) != len(values
):
651 'expected length of value and array field to match')
653 original_values
= self
._value
655 for index
, value
in enumerate(values
):
656 if value
is not None:
657 self
[index
].value
= value
661 self
.value
= original_values
664 value
= property(fset
=_set_value
)
667 class _SequenceField(_ArraySequenceField
):
671 return int(self
.length_field
)
674 def length_field(self
):
675 field_ptr
= native_bt
.field_sequence_get_length(self
._ptr
)
676 if field_ptr
is None:
678 return _create_from_ptr(field_ptr
)
681 def length_field(self
, length_field
):
682 utils
._check
_type
(length_field
, _IntegerField
)
683 ret
= native_bt
.field_sequence_set_length(self
._ptr
, length_field
._ptr
)
684 utils
._handle
_ret
(ret
, "cannot set sequence field object's length field")
686 def _get_field_ptr_at_index(self
, index
):
687 return native_bt
.field_sequence_get_field(self
._ptr
, index
)
689 def _set_value(self
, values
):
690 original_length_field
= self
.length_field
691 if original_length_field
is not None:
692 original_values
= self
._value
694 if len(values
) != self
.length_field
:
695 if self
.length_field
is not None:
696 length_fc
= self
.length_field
.field_class
698 length_fc
= bt2
.IntegerFieldClass(size
=64, is_signed
=False)
699 self
.length_field
= length_fc(len(values
))
702 for index
, value
in enumerate(values
):
703 if value
is not None:
704 self
[index
].value
= value
708 if original_length_field
is not None:
709 self
.length_field
= original_length_field
710 self
.value
= original_values
715 value
= property(fset
=_set_value
)
719 native_bt
.FIELD_CLASS_TYPE_UNSIGNED_INTEGER
: _UnsignedIntegerField
,
720 native_bt
.FIELD_CLASS_TYPE_SIGNED_INTEGER
: _SignedIntegerField
,
721 native_bt
.FIELD_CLASS_TYPE_REAL
: _RealField
,
722 native_bt
.FIELD_CLASS_TYPE_STRING
: _StringField
,
723 native_bt
.FIELD_CLASS_TYPE_STRUCTURE
: _StructureField
,