Move to kernel style SPDX license identifiers
[babeltrace.git] / src / bindings / python / bt2 / bt2 / field_class.py
index 12ecced041b85f99eb0f6ff2e3f2f1bb62096537..13c5e46213a26cd4d9f6ec011a173e95ceaf6ebc 100644 (file)
@@ -1,24 +1,6 @@
-# The MIT License (MIT)
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
 
 from bt2 import native_bt, object, utils
 import collections.abc
@@ -92,7 +74,7 @@ class _FieldClass(_FieldClassConst):
 
 
 class _BoolFieldClassConst(_FieldClassConst):
-    _NAME = 'Const Boolean'
+    _NAME = 'Const boolean'
 
 
 class _BoolFieldClass(_BoolFieldClassConst, _FieldClass):
@@ -100,7 +82,7 @@ class _BoolFieldClass(_BoolFieldClassConst, _FieldClass):
 
 
 class _BitArrayFieldClassConst(_FieldClassConst):
-    _NAME = 'Const Bit array'
+    _NAME = 'Const bit array'
 
     @property
     def length(self):
@@ -498,31 +480,76 @@ class _StructureFieldClass(_StructureFieldClassConst, _FieldClass):
 
 
 class _OptionFieldClassConst(_FieldClassConst):
-    _NAME = 'Const Option'
+    _NAME = 'Const option'
     _create_field_class_from_ptr_and_get_ref = staticmethod(
         _create_field_class_from_const_ptr_and_get_ref
     )
     _borrow_field_class_ptr = staticmethod(
         native_bt.field_class_option_borrow_field_class_const
     )
-    _borrow_selector_field_path = staticmethod(
-        native_bt.field_class_option_borrow_selector_field_path_const
-    )
 
     @property
     def field_class(self):
         elem_fc_ptr = self._borrow_field_class_ptr(self._ptr)
         return self._create_field_class_from_ptr_and_get_ref(elem_fc_ptr)
 
+
+class _OptionWithSelectorFieldClassConst(_OptionFieldClassConst):
+    _NAME = 'Const option (with selector)'
+
     @property
     def selector_field_path(self):
-        ptr = self._borrow_selector_field_path(self._ptr)
+        ptr = native_bt.field_class_option_with_selector_field_borrow_selector_field_path_const(
+            self._ptr
+        )
         if ptr is None:
             return
 
         return bt2_field_path._FieldPathConst._create_from_ptr_and_get_ref(ptr)
 
 
+class _OptionWithBoolSelectorFieldClassConst(_OptionWithSelectorFieldClassConst):
+    _NAME = 'Const option (with boolean selector)'
+
+    @property
+    def selector_is_reversed(self):
+        return bool(
+            native_bt.field_class_option_with_selector_field_bool_selector_is_reversed(
+                self._ptr
+            )
+        )
+
+
+class _OptionWithIntegerSelectorFieldClassConst(_OptionWithSelectorFieldClassConst):
+    _NAME = 'Const option (with integer selector)'
+
+    @property
+    def ranges(self):
+        range_set_ptr = self._borrow_selector_ranges_ptr(self._ptr)
+        assert range_set_ptr is not None
+        return self._range_set_pycls._create_from_ptr_and_get_ref(range_set_ptr)
+
+
+class _OptionWithUnsignedIntegerSelectorFieldClassConst(
+    _OptionWithIntegerSelectorFieldClassConst
+):
+    _NAME = 'Const option (with unsigned integer selector)'
+    _range_set_pycls = bt2_integer_range_set._UnsignedIntegerRangeSetConst
+    _borrow_selector_ranges_ptr = staticmethod(
+        native_bt.field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const
+    )
+
+
+class _OptionWithSignedIntegerSelectorFieldClassConst(
+    _OptionWithIntegerSelectorFieldClassConst
+):
+    _NAME = 'Const option (with signed integer selector)'
+    _range_set_pycls = bt2_integer_range_set._SignedIntegerRangeSetConst
+    _borrow_selector_ranges_ptr = staticmethod(
+        native_bt.field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const
+    )
+
+
 class _OptionFieldClass(_OptionFieldClassConst, _FieldClass):
     _NAME = 'Option'
     _borrow_field_class_ptr = staticmethod(
@@ -533,6 +560,46 @@ class _OptionFieldClass(_OptionFieldClassConst, _FieldClass):
     )
 
 
+class _OptionWithSelectorFieldClass(
+    _OptionWithSelectorFieldClassConst, _OptionFieldClass
+):
+    _NAME = 'Option (with selector)'
+
+
+class _OptionWithBoolSelectorFieldClass(
+    _OptionWithBoolSelectorFieldClassConst, _OptionWithSelectorFieldClass
+):
+    _NAME = 'Option (with boolean selector)'
+
+    def _selector_is_reversed(self, selector_is_reversed):
+        utils._check_bool(selector_is_reversed)
+        native_bt.field_class_option_with_selector_field_bool_set_selector_is_reversed(
+            self._ptr, selector_is_reversed
+        )
+
+    _selector_is_reversed = property(fset=_selector_is_reversed)
+
+
+class _OptionWithIntegerSelectorFieldClass(
+    _OptionWithIntegerSelectorFieldClassConst, _OptionWithSelectorFieldClass
+):
+    _NAME = 'Option (with integer selector)'
+
+
+class _OptionWithUnsignedIntegerSelectorFieldClass(
+    _OptionWithUnsignedIntegerSelectorFieldClassConst,
+    _OptionWithIntegerSelectorFieldClass,
+):
+    _NAME = 'Option (with unsigned integer selector)'
+
+
+class _OptionWithSignedIntegerSelectorFieldClass(
+    _OptionWithSignedIntegerSelectorFieldClassConst,
+    _OptionWithIntegerSelectorFieldClass,
+):
+    _NAME = 'Option (with signed integer selector)'
+
+
 class _VariantFieldClassOptionConst:
     _create_field_class_from_ptr_and_get_ref = staticmethod(
         _create_field_class_from_const_ptr_and_get_ref
@@ -594,7 +661,7 @@ class _VariantFieldClassOption(_VariantFieldClassOptionConst):
     _user_attributes = property(fset=_user_attributes)
 
 
-class _VariantFieldClassWithSelectorOptionConst(_VariantFieldClassOptionConst):
+class _VariantFieldClassWithIntegerSelectorOptionConst(_VariantFieldClassOptionConst):
     def __init__(self, owning_var_fc, spec_opt_ptr):
         self._spec_ptr = spec_opt_ptr
         super().__init__(owning_var_fc, self._as_option_ptr(spec_opt_ptr))
@@ -606,52 +673,52 @@ class _VariantFieldClassWithSelectorOptionConst(_VariantFieldClassOptionConst):
         return self._range_set_pycls._create_from_ptr_and_get_ref(range_set_ptr)
 
 
-class _VariantFieldClassWithSelectorOption(
-    _VariantFieldClassWithSelectorOptionConst, _VariantFieldClassOption
+class _VariantFieldClassWithIntegerSelectorOption(
+    _VariantFieldClassWithIntegerSelectorOptionConst, _VariantFieldClassOption
 ):
     pass
 
 
-class _VariantFieldClassWithSignedSelectorOptionConst(
-    _VariantFieldClassWithSelectorOptionConst
+class _VariantFieldClassWithSignedIntegerSelectorOptionConst(
+    _VariantFieldClassWithIntegerSelectorOptionConst
 ):
     _as_option_ptr = staticmethod(
-        native_bt.field_class_variant_with_selector_signed_option_as_option_const
+        native_bt.field_class_variant_with_selector_field_integer_signed_option_as_option_const
     )
     _borrow_ranges_ptr = staticmethod(
-        native_bt.field_class_variant_with_selector_signed_option_borrow_ranges_const
+        native_bt.field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const
     )
     _range_set_pycls = bt2_integer_range_set._SignedIntegerRangeSetConst
 
 
-class _VariantFieldClassWithSignedSelectorOption(
-    _VariantFieldClassWithSignedSelectorOptionConst,
-    _VariantFieldClassWithSelectorOption,
+class _VariantFieldClassWithSignedIntegerSelectorOption(
+    _VariantFieldClassWithSignedIntegerSelectorOptionConst,
+    _VariantFieldClassWithIntegerSelectorOption,
 ):
     pass
 
 
-class _VariantFieldClassWithUnsignedSelectorOptionConst(
-    _VariantFieldClassWithSelectorOptionConst
+class _VariantFieldClassWithUnsignedIntegerSelectorOptionConst(
+    _VariantFieldClassWithIntegerSelectorOptionConst
 ):
     _as_option_ptr = staticmethod(
-        native_bt.field_class_variant_with_selector_unsigned_option_as_option_const
+        native_bt.field_class_variant_with_selector_field_integer_unsigned_option_as_option_const
     )
     _borrow_ranges_ptr = staticmethod(
-        native_bt.field_class_variant_with_selector_unsigned_option_borrow_ranges_const
+        native_bt.field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const
     )
     _range_set_pycls = bt2_integer_range_set._UnsignedIntegerRangeSetConst
 
 
-class _VariantFieldClassWithUnsignedSelectorOption(
-    _VariantFieldClassWithUnsignedSelectorOptionConst,
-    _VariantFieldClassWithSelectorOption,
+class _VariantFieldClassWithUnsignedIntegerSelectorOption(
+    _VariantFieldClassWithUnsignedIntegerSelectorOptionConst,
+    _VariantFieldClassWithIntegerSelectorOption,
 ):
     pass
 
 
 class _VariantFieldClassConst(_FieldClassConst, collections.abc.Mapping):
-    _NAME = 'Const Variant'
+    _NAME = 'Const variant'
     _borrow_option_ptr_by_name = staticmethod(
         native_bt.field_class_variant_borrow_option_by_name_const
     )
@@ -715,7 +782,7 @@ class _VariantFieldClass(_VariantFieldClassConst, _FieldClass, collections.abc.M
 
 
 class _VariantFieldClassWithoutSelectorConst(_VariantFieldClassConst):
-    _NAME = 'Const Variant (without selector)'
+    _NAME = 'Const variant (without selector)'
 
 
 class _VariantFieldClassWithoutSelector(
@@ -753,12 +820,12 @@ class _VariantFieldClassWithoutSelector(
         return self
 
 
-class _VariantFieldClassWithSelectorConst(_VariantFieldClassConst):
-    _NAME = 'Const Variant (with selector)'
+class _VariantFieldClassWithIntegerSelectorConst(_VariantFieldClassConst):
+    _NAME = 'Const variant (with selector)'
 
     @property
     def selector_field_path(self):
-        ptr = native_bt.field_class_variant_with_selector_borrow_selector_field_path_const(
+        ptr = native_bt.field_class_variant_with_selector_field_borrow_selector_field_path_const(
             self._ptr
         )
 
@@ -768,8 +835,8 @@ class _VariantFieldClassWithSelectorConst(_VariantFieldClassConst):
         return bt2_field_path._FieldPathConst._create_from_ptr_and_get_ref(ptr)
 
 
-class _VariantFieldClassWithSelector(
-    _VariantFieldClassWithSelectorConst, _VariantFieldClass
+class _VariantFieldClassWithIntegerSelector(
+    _VariantFieldClassWithIntegerSelectorConst, _VariantFieldClass
 ):
     _NAME = 'Variant (with selector)'
 
@@ -807,49 +874,55 @@ class _VariantFieldClassWithSelector(
         return self
 
 
-class _VariantFieldClassWithUnsignedSelectorConst(_VariantFieldClassWithSelectorConst):
-    _NAME = 'Const Variant (with unsigned selector)'
+class _VariantFieldClassWithUnsignedIntegerSelectorConst(
+    _VariantFieldClassWithIntegerSelectorConst
+):
+    _NAME = 'Const variant (with unsigned integer selector)'
     _borrow_option_ptr_by_name = staticmethod(
-        native_bt.field_class_variant_with_selector_unsigned_borrow_option_by_name_const
+        native_bt.field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const
     )
     _borrow_option_ptr_by_index = staticmethod(
-        native_bt.field_class_variant_with_selector_unsigned_borrow_option_by_index_const
+        native_bt.field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const
     )
-    _variant_option_pycls = _VariantFieldClassWithUnsignedSelectorOptionConst
+    _variant_option_pycls = _VariantFieldClassWithUnsignedIntegerSelectorOptionConst
     _as_option_ptr = staticmethod(_variant_option_pycls._as_option_ptr)
 
 
-class _VariantFieldClassWithUnsignedSelector(
-    _VariantFieldClassWithUnsignedSelectorConst, _VariantFieldClassWithSelector
+class _VariantFieldClassWithUnsignedIntegerSelector(
+    _VariantFieldClassWithUnsignedIntegerSelectorConst,
+    _VariantFieldClassWithIntegerSelector,
 ):
-    _NAME = 'Variant (with unsigned selector)'
-    _variant_option_pycls = _VariantFieldClassWithUnsignedSelectorOption
+    _NAME = 'Variant (with unsigned integer selector)'
+    _variant_option_pycls = _VariantFieldClassWithUnsignedIntegerSelectorOption
     _as_option_ptr = staticmethod(_variant_option_pycls._as_option_ptr)
     _append_option = staticmethod(
-        native_bt.field_class_variant_with_selector_unsigned_append_option
+        native_bt.field_class_variant_with_selector_field_integer_unsigned_append_option
     )
 
 
-class _VariantFieldClassWithSignedSelectorConst(_VariantFieldClassWithSelectorConst):
-    _NAME = 'Const Variant (with signed selector)'
+class _VariantFieldClassWithSignedIntegerSelectorConst(
+    _VariantFieldClassWithIntegerSelectorConst
+):
+    _NAME = 'Const variant (with signed integer selector)'
     _borrow_option_ptr_by_name = staticmethod(
-        native_bt.field_class_variant_with_selector_signed_borrow_option_by_name_const
+        native_bt.field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const
     )
     _borrow_option_ptr_by_index = staticmethod(
-        native_bt.field_class_variant_with_selector_signed_borrow_option_by_index_const
+        native_bt.field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const
     )
-    _variant_option_pycls = _VariantFieldClassWithSignedSelectorOptionConst
+    _variant_option_pycls = _VariantFieldClassWithSignedIntegerSelectorOptionConst
     _as_option_ptr = staticmethod(_variant_option_pycls._as_option_ptr)
 
 
-class _VariantFieldClassWithSignedSelector(
-    _VariantFieldClassWithSignedSelectorConst, _VariantFieldClassWithSelector
+class _VariantFieldClassWithSignedIntegerSelector(
+    _VariantFieldClassWithSignedIntegerSelectorConst,
+    _VariantFieldClassWithIntegerSelector,
 ):
-    _NAME = 'Variant (with signed selector)'
-    _variant_option_pycls = _VariantFieldClassWithSignedSelectorOption
+    _NAME = 'Variant (with signed integer selector)'
+    _variant_option_pycls = _VariantFieldClassWithSignedIntegerSelectorOption
     _as_option_ptr = staticmethod(_variant_option_pycls._as_option_ptr)
     _append_option = staticmethod(
-        native_bt.field_class_variant_with_selector_signed_append_option
+        native_bt.field_class_variant_with_selector_field_integer_signed_append_option
     )
 
 
@@ -891,9 +964,13 @@ class _StaticArrayFieldClass(_StaticArrayFieldClassConst, _ArrayFieldClass):
 class _DynamicArrayFieldClassConst(_ArrayFieldClassConst):
     _NAME = 'Const dynamic array'
 
+
+class _DynamicArrayWithLengthFieldFieldClassConst(_DynamicArrayFieldClassConst):
+    _NAME = 'Const dynamic array (with length field)'
+
     @property
     def length_field_path(self):
-        ptr = native_bt.field_class_array_dynamic_borrow_length_field_path_const(
+        ptr = native_bt.field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
             self._ptr
         )
         if ptr is None:
@@ -903,7 +980,13 @@ class _DynamicArrayFieldClassConst(_ArrayFieldClassConst):
 
 
 class _DynamicArrayFieldClass(_DynamicArrayFieldClassConst, _ArrayFieldClass):
-    _NAME = 'Dynamic Array'
+    _NAME = 'Dynamic array'
+
+
+class _DynamicArrayWithLengthFieldFieldClass(
+    _DynamicArrayWithLengthFieldFieldClassConst, _DynamicArrayFieldClass
+):
+    _NAME = 'Dynamic array (with length field)'
 
 
 _FIELD_CLASS_TYPE_TO_CONST_OBJ = {
@@ -918,11 +1001,15 @@ _FIELD_CLASS_TYPE_TO_CONST_OBJ = {
     native_bt.FIELD_CLASS_TYPE_STRING: _StringFieldClassConst,
     native_bt.FIELD_CLASS_TYPE_STRUCTURE: _StructureFieldClassConst,
     native_bt.FIELD_CLASS_TYPE_STATIC_ARRAY: _StaticArrayFieldClassConst,
-    native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY: _DynamicArrayFieldClassConst,
-    native_bt.FIELD_CLASS_TYPE_OPTION: _OptionFieldClassConst,
-    native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR: _VariantFieldClassWithoutSelectorConst,
-    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR: _VariantFieldClassWithUnsignedSelectorConst,
-    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR: _VariantFieldClassWithSignedSelectorConst,
+    native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD: _DynamicArrayFieldClassConst,
+    native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD: _DynamicArrayWithLengthFieldFieldClassConst,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD: _OptionFieldClassConst,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD: _OptionWithBoolSelectorFieldClassConst,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _OptionWithUnsignedIntegerSelectorFieldClassConst,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _OptionWithSignedIntegerSelectorFieldClassConst,
+    native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD: _VariantFieldClassWithoutSelectorConst,
+    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _VariantFieldClassWithUnsignedIntegerSelectorConst,
+    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _VariantFieldClassWithSignedIntegerSelectorConst,
 }
 
 _FIELD_CLASS_TYPE_TO_OBJ = {
@@ -937,9 +1024,13 @@ _FIELD_CLASS_TYPE_TO_OBJ = {
     native_bt.FIELD_CLASS_TYPE_STRING: _StringFieldClass,
     native_bt.FIELD_CLASS_TYPE_STRUCTURE: _StructureFieldClass,
     native_bt.FIELD_CLASS_TYPE_STATIC_ARRAY: _StaticArrayFieldClass,
-    native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY: _DynamicArrayFieldClass,
-    native_bt.FIELD_CLASS_TYPE_OPTION: _OptionFieldClass,
-    native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR: _VariantFieldClassWithoutSelector,
-    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR: _VariantFieldClassWithUnsignedSelector,
-    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR: _VariantFieldClassWithSignedSelector,
+    native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD: _DynamicArrayFieldClass,
+    native_bt.FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD: _DynamicArrayWithLengthFieldFieldClass,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD: _OptionFieldClass,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD: _OptionWithBoolSelectorFieldClass,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _OptionWithUnsignedIntegerSelectorFieldClass,
+    native_bt.FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _OptionWithSignedIntegerSelectorFieldClass,
+    native_bt.FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD: _VariantFieldClassWithoutSelector,
+    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD: _VariantFieldClassWithUnsignedIntegerSelector,
+    native_bt.FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD: _VariantFieldClassWithSignedIntegerSelector,
 }
This page took 0.029146 seconds and 4 git commands to generate.