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 collections
.abc
30 def _create_field_class_from_ptr_and_get_ref(ptr
):
31 typeid
= native_bt
.field_class_get_type(ptr
)
32 return _FIELD_CLASS_TYPE_TO_OBJ
[typeid
]._create
_from
_ptr
_and
_get
_ref
(ptr
)
35 class _FieldClass(object._SharedObject
, metaclass
=abc
.ABCMeta
):
36 _get_ref
= staticmethod(native_bt
.field_class_get_ref
)
37 _put_ref
= staticmethod(native_bt
.field_class_put_ref
)
39 def __init__(self
, ptr
):
42 def __eq__(self
, other
):
43 if not isinstance(other
, self
.__class
__):
44 # not comparing apples to apples
47 if self
.addr
== other
.addr
:
50 ret
= native_bt
.field_class_compare(self
._ptr
, other
._ptr
)
51 utils
._handle
_ret
(ret
, "cannot compare field classes")
54 def _check_create_status(self
, ptr
):
56 raise bt2
.CreationError('cannot create {} field class object'.format(self
._NAME
.lower()))
59 ptr
= native_bt
.field_class_copy(self
._ptr
)
60 utils
._handle
_ptr
(ptr
, 'cannot copy {} field class object'.format(self
._NAME
.lower()))
61 return _create_from_ptr(ptr
)
63 def __deepcopy__(self
, memo
):
68 def __call__(self
, value
=None):
69 field_ptr
= native_bt
.field_create(self
._ptr
)
72 raise bt2
.CreationError('cannot create {} field object'.format(self
._NAME
.lower()))
74 field
= bt2
.field
._create
_from
_ptr
(field_ptr
)
77 if not isinstance(field
, (bt2
.field
._IntegerField
, bt2
.field
._FloatingPointNumberField
, bt2
.field
._StringField
)):
78 raise bt2
.Error('cannot assign an initial value to a {} field object'.format(field
._NAME
))
88 alignment
= native_bt
.field_class_get_alignment(self
._ptr
)
89 assert(alignment
>= 0)
93 def alignment(self
, alignment
):
94 utils
._check
_alignment
(alignment
)
95 ret
= native_bt
.field_class_set_alignment(self
._ptr
, alignment
)
96 utils
._handle
_ret
(ret
, "cannot set field class object's alignment")
101 def byte_order(self
):
102 bo
= native_bt
.field_class_get_byte_order(self
._ptr
)
107 def byte_order(self
, byte_order
):
108 utils
._check
_int
(byte_order
)
109 ret
= native_bt
.field_class_set_byte_order(self
._ptr
, byte_order
)
110 utils
._handle
_ret
(ret
, "cannot set field class object's byte order")
113 class _IntegerFieldClass(_FieldClass
):
115 def __init__(self
, size
, alignment
=None, byte_order
=None, is_signed
=None,
116 base
=None, encoding
=None, mapped_clock_class
=None):
117 utils
._check
_uint
64(size
)
120 raise ValueError('size is 0 bits')
122 ptr
= native_bt
.field_class_integer_create(size
)
123 self
._check
_create
_status
(ptr
)
124 super().__init
__(ptr
)
126 if alignment
is not None:
127 self
.alignment
= alignment
129 if byte_order
is not None:
130 self
.byte_order
= byte_order
132 if is_signed
is not None:
133 self
.is_signed
= is_signed
138 if encoding
is not None:
139 self
.encoding
= encoding
141 if mapped_clock_class
is not None:
142 self
.mapped_clock_class
= mapped_clock_class
146 size
= native_bt
.field_class_integer_get_size(self
._ptr
)
152 is_signed
= native_bt
.field_class_integer_is_signed(self
._ptr
)
153 assert(is_signed
>= 0)
157 def is_signed(self
, is_signed
):
158 utils
._check
_bool
(is_signed
)
159 ret
= native_bt
.field_class_integer_set_is_signed(self
._ptr
, int(is_signed
))
160 utils
._handle
_ret
(ret
, "cannot set integer field class object's signedness")
164 base
= native_bt
.field_class_integer_get_base(self
._ptr
)
169 def base(self
, base
):
170 utils
._check
_int
(base
)
171 ret
= native_bt
.field_class_integer_set_base(self
._ptr
, base
)
172 utils
._handle
_ret
(ret
, "cannot set integer field class object's base")
176 encoding
= native_bt
.field_class_integer_get_encoding(self
._ptr
)
177 assert(encoding
>= 0)
181 def encoding(self
, encoding
):
182 utils
._check
_int
(encoding
)
183 ret
= native_bt
.field_class_integer_set_encoding(self
._ptr
, encoding
)
184 utils
._handle
_ret
(ret
, "cannot set integer field class object's encoding")
187 def mapped_clock_class(self
):
188 ptr
= native_bt
.field_class_integer_get_mapped_clock_class(self
._ptr
)
193 return bt2
.ClockClass
._create
_from
_ptr
(ptr
)
195 @mapped_clock_class.setter
196 def mapped_clock_class(self
, clock_class
):
197 utils
._check
_type
(clock_class
, bt2
.ClockClass
)
198 ret
= native_bt
.field_class_integer_set_mapped_clock_class(self
._ptr
, clock_class
._ptr
)
199 utils
._handle
_ret
(ret
, "cannot set integer field class object's mapped clock class")
202 class _SignedIntegerFieldClass(_IntegerFieldClass
):
205 class SignedIntegerFieldClass(_SignedIntegerFieldClass
):
206 _NAME
= 'SignedInteger'
208 class FloatingPointNumberFieldClass(_FieldClass
, _AlignmentProp
, _ByteOrderProp
):
209 _NAME
= 'Floating point number'
211 def __init__(self
, alignment
=None, byte_order
=None, exponent_size
=None,
213 ptr
= native_bt
.field_class_floating_point_create()
214 self
._check
_create
_status
(ptr
)
215 super().__init
__(ptr
)
217 if alignment
is not None:
218 self
.alignment
= alignment
220 if byte_order
is not None:
221 self
.byte_order
= byte_order
223 if exponent_size
is not None:
224 self
.exponent_size
= exponent_size
226 if mantissa_size
is not None:
227 self
.mantissa_size
= mantissa_size
230 def exponent_size(self
):
231 exp_size
= native_bt
.field_class_floating_point_get_exponent_digits(self
._ptr
)
232 assert(exp_size
>= 0)
235 @exponent_size.setter
236 def exponent_size(self
, exponent_size
):
237 utils
._check
_uint
64(exponent_size
)
238 ret
= native_bt
.field_class_floating_point_set_exponent_digits(self
._ptr
, exponent_size
)
239 utils
._handle
_ret
(ret
, "cannot set floating point number field class object's exponent size")
242 def mantissa_size(self
):
243 mant_size
= native_bt
.field_class_floating_point_get_mantissa_digits(self
._ptr
)
244 assert(mant_size
>= 0)
247 @mantissa_size.setter
248 def mantissa_size(self
, mantissa_size
):
249 utils
._check
_uint
64(mantissa_size
)
250 ret
= native_bt
.field_class_floating_point_set_mantissa_digits(self
._ptr
, mantissa_size
)
251 utils
._handle
_ret
(ret
, "cannot set floating point number field class object's mantissa size")
254 class _EnumerationFieldClassMapping
:
255 def __init__(self
, name
, lower
, upper
):
272 def __eq__(self
, other
):
273 if type(other
) is not self
.__class
__:
276 return (self
.name
, self
.lower
, self
.upper
) == (other
.name
, other
.lower
, other
.upper
)
279 class _EnumerationFieldClassMappingIterator(object._SharedObject
,
280 collections
.abc
.Iterator
):
281 def __init__(self
, iter_ptr
, is_signed
):
282 super().__init
__(iter_ptr
)
283 self
._is
_signed
= is_signed
284 self
._done
= (iter_ptr
is None)
290 ret
= native_bt
.field_class_enumeration_mapping_iterator_next(self
._ptr
)
296 ret
, name
, lower
, upper
= native_bt
.field_class_enumeration_mapping_iterator_get_signed(self
._ptr
)
298 ret
, name
, lower
, upper
= native_bt
.field_class_enumeration_mapping_iterator_get_unsigned(self
._ptr
)
301 mapping
= _EnumerationFieldClassMapping(name
, lower
, upper
)
306 class EnumerationFieldClass(_IntegerFieldClass
, collections
.abc
.Sequence
):
307 _NAME
= 'Enumeration'
309 def __init__(self
, int_field_class
=None, size
=None, alignment
=None,
310 byte_order
=None, is_signed
=None, base
=None, encoding
=None,
311 mapped_clock_class
=None):
312 if int_field_class
is None:
313 int_field_class
= IntegerFieldClass(size
=size
, alignment
=alignment
,
314 byte_order
=byte_order
,
315 is_signed
=is_signed
, base
=base
,
317 mapped_clock_class
=mapped_clock_class
)
319 utils
._check
_type
(int_field_class
, IntegerFieldClass
)
320 ptr
= native_bt
.field_class_enumeration_create(int_field_class
._ptr
)
321 self
._check
_create
_status
(ptr
)
322 _FieldClass
.__init
__(self
, ptr
)
325 def integer_field_class(self
):
326 ptr
= native_bt
.field_class_enumeration_get_container_type(self
._ptr
)
328 return _create_from_ptr(ptr
)
332 return self
.integer_field_class
.size
336 return self
.integer_field_class
.alignment
339 def alignment(self
, alignment
):
340 self
.integer_field_class
.alignment
= alignment
343 def byte_order(self
):
344 return self
.integer_field_class
.byte_order
347 def byte_order(self
, byte_order
):
348 self
.integer_field_class
.byte_order
= byte_order
352 return self
.integer_field_class
.is_signed
355 def is_signed(self
, is_signed
):
356 self
.integer_field_class
.is_signed
= is_signed
360 return self
.integer_field_class
.base
363 def base(self
, base
):
364 self
.integer_field_class
.base
= base
368 return self
.integer_field_class
.encoding
371 def encoding(self
, encoding
):
372 self
.integer_field_class
.encoding
= encoding
375 def mapped_clock_class(self
):
376 return self
.integer_field_class
.mapped_clock_class
378 @mapped_clock_class.setter
379 def mapped_clock_class(self
, mapped_clock_class
):
380 self
.integer_field_class
.mapped_clock_class
= mapped_clock_class
383 count
= native_bt
.field_class_enumeration_get_mapping_count(self
._ptr
)
387 def __getitem__(self
, index
):
388 utils
._check
_uint
64(index
)
390 if index
>= len(self
):
394 get_fn
= native_bt
.field_class_enumeration_get_mapping_signed
396 get_fn
= native_bt
.field_class_enumeration_get_mapping_unsigned
398 ret
, name
, lower
, upper
= get_fn(self
._ptr
, index
)
400 return _EnumerationFieldClassMapping(name
, lower
, upper
)
402 def _get_mapping_iter(self
, iter_ptr
):
403 return _EnumerationFieldClassMappingIterator(iter_ptr
, self
.is_signed
)
405 def mappings_by_name(self
, name
):
406 utils
._check
_str
(name
)
407 iter_ptr
= native_bt
.field_class_enumeration_find_mappings_by_name(self
._ptr
, name
)
408 print('iter_ptr', iter_ptr
)
409 return self
._get
_mapping
_iter
(iter_ptr
)
411 def mappings_by_value(self
, value
):
413 utils
._check
_int
64(value
)
414 iter_ptr
= native_bt
.field_class_enumeration_find_mappings_by_signed_value(self
._ptr
, value
)
416 utils
._check
_uint
64(value
)
417 iter_ptr
= native_bt
.field_class_enumeration_find_mappings_by_unsigned_value(self
._ptr
, value
)
419 return self
._get
_mapping
_iter
(iter_ptr
)
421 def add_mapping(self
, name
, lower
, upper
=None):
422 utils
._check
_str
(name
)
428 add_fn
= native_bt
.field_class_enumeration_add_mapping_signed
429 utils
._check
_int
64(lower
)
430 utils
._check
_int
64(upper
)
432 add_fn
= native_bt
.field_class_enumeration_add_mapping_unsigned
433 utils
._check
_uint
64(lower
)
434 utils
._check
_uint
64(upper
)
436 ret
= add_fn(self
._ptr
, name
, lower
, upper
)
437 utils
._handle
_ret
(ret
, "cannot add mapping to enumeration field class object")
439 def __iadd__(self
, mappings
):
440 for mapping
in mappings
:
441 self
.add_mapping(mapping
.name
, mapping
.lower
, mapping
.upper
)
446 class StringFieldClass(_FieldClass
):
449 def __init__(self
, encoding
=None):
450 ptr
= native_bt
.field_class_string_create()
451 self
._check
_create
_status
(ptr
)
452 super().__init
__(ptr
)
454 if encoding
is not None:
455 self
.encoding
= encoding
459 encoding
= native_bt
.field_class_string_get_encoding(self
._ptr
)
460 assert(encoding
>= 0)
464 def encoding(self
, encoding
):
465 utils
._check
_int
(encoding
)
466 ret
= native_bt
.field_class_string_set_encoding(self
._ptr
, encoding
)
467 utils
._handle
_ret
(ret
, "cannot set string field class object's encoding")
470 class _FieldContainer(collections
.abc
.Mapping
):
472 count
= self
._count
()
476 def __getitem__(self
, key
):
477 if not isinstance(key
, str):
478 raise TypeError("'{}' is not a 'str' object".format(key
.__class
__.__name
__))
480 ptr
= self
._get
_field
_by
_name
(key
)
485 return _create_from_ptr(ptr
)
488 return self
._ITER
_CLS
(self
)
490 def append_field(self
, name
, field_class
):
491 utils
._check
_str
(name
)
492 utils
._check
_type
(field_class
, _FieldClass
)
493 ret
= self
._add
_field
(name
, field_class
._ptr
)
494 utils
._handle
_ret
(ret
, "cannot add field to {} field class object".format(self
._NAME
.lower()))
496 def __iadd__(self
, fields
):
497 for name
, field_class
in fields
.items():
498 self
.append_field(name
, field_class
)
502 def at_index(self
, index
):
503 utils
._check
_uint
64(index
)
504 return self
._at
(index
)
507 class _StructureFieldClassFieldIterator(collections
.abc
.Iterator
):
508 def __init__(self
, struct_field_class
):
509 self
._struct
_field
_class
= struct_field_class
513 if self
._at
== len(self
._struct
_field
_class
):
516 get_fc_by_index
= native_bt
.field_class_structure_get_field_by_index
517 ret
, name
, field_class_ptr
= get_fc_by_index(self
._struct
_field
_class
._ptr
,
520 native_bt
.put(field_class_ptr
)
525 class _StructureFieldClass(_FieldClass
, _FieldContainer
, _AlignmentProp
):
527 _ITER_CLS
= _StructureFieldClassFieldIterator
529 def __init__(self
, min_alignment
=None):
530 ptr
= native_bt
.field_class_structure_create()
531 self
._check
_create
_status
(ptr
)
532 super().__init
__(ptr
)
534 if min_alignment
is not None:
535 self
.min_alignment
= min_alignment
538 return native_bt
.field_class_structure_get_field_count(self
._ptr
)
540 def _get_field_by_name(self
, key
):
541 return native_bt
.field_class_structure_get_field_class_by_name(self
._ptr
, key
)
543 def _add_field(self
, name
, ptr
):
544 return native_bt
.field_class_structure_append_member(self
._ptr
, name
, ptr
)
546 def _at(self
, index
):
547 if index
< 0 or index
>= len(self
):
550 ret
, name
, field_class_ptr
= native_bt
.field_class_structure_get_field_by_index(self
._ptr
, index
)
552 return _create_from_ptr(field_class_ptr
)
555 _StructureFieldClass
.min_alignment
= property(fset
=_StructureFieldClass
.alignment
.fset
)
556 _StructureFieldClass
.alignment
= property(fget
=_StructureFieldClass
.alignment
.fget
)
559 class _VariantFieldClassFieldIterator(collections
.abc
.Iterator
):
560 def __init__(self
, variant_field_class
):
561 self
._variant
_field
_class
= variant_field_class
565 if self
._at
== len(self
._variant
_field
_class
):
568 ret
, name
, field_class_ptr
= native_bt
.field_class_variant_get_field_by_index(self
._variant
_field
_class
._ptr
,
571 native_bt
.put(field_class_ptr
)
576 class VariantFieldClass(_FieldClass
, _FieldContainer
, _AlignmentProp
):
578 _ITER_CLS
= _VariantFieldClassFieldIterator
580 def __init__(self
, tag_name
, tag_field_class
=None):
581 utils
._check
_str
(tag_name
)
583 if tag_field_class
is None:
586 utils
._check
_type
(tag_field_class
, EnumerationFieldClass
)
587 tag_fc_ptr
= tag_field_class
._ptr
589 ptr
= native_bt
.field_class_variant_create(tag_fc_ptr
,
591 self
._check
_create
_status
(ptr
)
592 super().__init
__(ptr
)
596 tag_name
= native_bt
.field_class_variant_get_tag_name(self
._ptr
)
597 assert(tag_name
is not None)
601 def tag_name(self
, tag_name
):
602 utils
._check
_str
(tag_name
)
603 ret
= native_bt
.field_class_variant_set_tag_name(self
._ptr
, tag_name
)
604 utils
._handle
_ret
(ret
, "cannot set variant field class object's tag name")
607 def tag_field_class(self
):
608 fc_ptr
= native_bt
.field_class_variant_get_tag_type(self
._ptr
)
613 return _create_from_ptr(fc_ptr
)
616 return native_bt
.field_class_variant_get_field_count(self
._ptr
)
618 def _get_field_by_name(self
, key
):
619 return native_bt
.field_class_variant_get_field_class_by_name(self
._ptr
, key
)
621 def _add_field(self
, ptr
, name
):
622 return native_bt
.field_class_variant_add_field(self
._ptr
, ptr
, name
)
624 def _at(self
, index
):
625 if index
< 0 or index
>= len(self
):
628 ret
, name
, field_class_ptr
= native_bt
.field_class_variant_get_field_by_index(self
._ptr
, index
)
630 return _create_from_ptr(field_class_ptr
)
633 class ArrayFieldClass(_FieldClass
):
636 def __init__(self
, element_field_class
, length
):
637 utils
._check
_type
(element_field_class
, _FieldClass
)
638 utils
._check
_uint
64(length
)
639 ptr
= native_bt
.field_class_array_create(element_field_class
._ptr
, length
)
640 self
._check
_create
_status
(ptr
)
641 super().__init
__(ptr
)
645 length
= native_bt
.field_class_array_get_length(self
._ptr
)
650 def element_field_class(self
):
651 ptr
= native_bt
.field_class_array_get_element_type(self
._ptr
)
653 return _create_from_ptr(ptr
)
656 class SequenceFieldClass(_FieldClass
):
659 def __init__(self
, element_field_class
, length_name
):
660 utils
._check
_type
(element_field_class
, _FieldClass
)
661 utils
._check
_str
(length_name
)
662 ptr
= native_bt
.field_class_sequence_create(element_field_class
._ptr
,
664 self
._check
_create
_status
(ptr
)
665 super().__init
__(ptr
)
668 def length_name(self
):
669 length_name
= native_bt
.field_class_sequence_get_length_field_name(self
._ptr
)
670 assert(length_name
is not None)
674 def element_field_class(self
):
675 ptr
= native_bt
.field_class_sequence_get_element_type(self
._ptr
)
677 return _create_from_ptr(ptr
)
680 _FIELD_CLASS_TYPE_TO_OBJ
= {
681 native_bt
.FIELD_CLASS_TYPE_STRUCTURE
: _StructureFieldClass
,