2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
11 #include <type_traits>
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "cpp-common/bt2c/c-string-view.hpp"
17 #include "cpp-common/bt2s/optional.hpp"
19 #include "borrowed-object-iterator.hpp"
20 #include "borrowed-object.hpp"
22 #include "field-path.hpp"
23 #include "integer-range-set.hpp"
24 #include "internal/utils.hpp"
25 #include "optional-borrowed-object.hpp"
26 #include "shared-object.hpp"
32 struct FieldClassRefFuncs final
34 static void get(const bt_field_class * const libObjPtr) noexcept
36 bt_field_class_get_ref(libObjPtr);
39 static void put(const bt_field_class * const libObjPtr) noexcept
41 bt_field_class_put_ref(libObjPtr);
45 template <typename LibObjT>
46 struct CommonFieldClassSpec;
48 /* Functions specific to mutable field classes */
50 struct CommonFieldClassSpec<bt_field_class> final
52 static bt_value *userAttributes(bt_field_class * const libObjPtr) noexcept
54 return bt_field_class_borrow_user_attributes(libObjPtr);
58 /* Functions specific to constant field classes */
60 struct CommonFieldClassSpec<const bt_field_class> final
62 static const bt_value *userAttributes(const bt_field_class * const libObjPtr) noexcept
64 return bt_field_class_borrow_user_attributes_const(libObjPtr);
68 } /* namespace internal */
70 template <typename ObjT, typename LibObjT>
71 using SharedFieldClass = SharedObject<ObjT, LibObjT, internal::FieldClassRefFuncs>;
73 template <typename LibObjT>
74 class CommonBitArrayFieldClass;
76 template <typename LibObjT>
77 class CommonIntegerFieldClass;
79 template <typename LibObjT>
80 class ConstEnumerationFieldClassMapping;
82 template <typename LibObjT>
83 class CommonBaseEnumerationFieldClass;
85 template <typename LibObjT, typename MappingT>
86 class CommonEnumerationFieldClass;
88 template <typename LibObjT>
89 class CommonStructureFieldClass;
91 template <typename LibObjT>
92 class CommonArrayFieldClass;
94 template <typename LibObjT>
95 class CommonStaticArrayFieldClass;
97 template <typename LibObjT>
98 class CommonDynamicArrayWithLengthFieldClass;
100 template <typename LibObjT>
101 class CommonOptionFieldClass;
103 template <typename LibObjT>
104 class CommonOptionWithSelectorFieldClass;
106 template <typename LibObjT>
107 class CommonOptionWithBoolSelectorFieldClass;
109 template <typename LibObjT>
110 class CommonVariantFieldClass;
112 template <typename LibObjT, typename RangeSetT>
113 class CommonOptionWithIntegerSelectorFieldClass;
115 template <typename LibObjT>
116 class CommonVariantWithoutSelectorFieldClass;
118 template <typename LibObjT>
119 class CommonVariantWithSelectorFieldClass;
121 template <typename LibObjT>
122 class ConstVariantWithIntegerSelectorFieldClassOption;
124 template <typename LibObjT, typename RangeSetT>
125 class CommonVariantWithIntegerSelectorFieldClass;
127 template <typename LibObjT>
128 class CommonEventClass;
130 template <typename LibObjT>
131 class CommonStreamClass;
133 template <typename LibObjT>
134 class CommonTraceClass;
136 enum class FieldClassType
138 Bool = BT_FIELD_CLASS_TYPE_BOOL,
139 BitArray = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
140 UnsignedInteger = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
141 SignedInteger = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
142 UnsignedEnumeration = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
143 SignedEnumeration = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
144 SinglePrecisionReal = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
145 DoublePrecisionReal = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
146 String = BT_FIELD_CLASS_TYPE_STRING,
147 Structure = BT_FIELD_CLASS_TYPE_STRUCTURE,
148 StaticArray = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
149 DynamicArrayWithoutLength = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
150 DynamicArrayWithLength = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
151 OptionWithoutSelector = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
152 OptionWithBoolSelector = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
153 OptionWithUnsignedIntegerSelector =
154 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
155 OptionWithSignedIntegerSelector = BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
156 VariantWithoutSelector = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
157 VariantWithUnsignedIntegerSelector =
158 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
159 VariantWithSignedIntegerSelector =
160 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
163 template <typename LibObjT>
164 class CommonFieldClass : public BorrowedObject<LibObjT>
167 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
170 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
173 using typename BorrowedObject<LibObjT>::LibObjPtr;
174 using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
175 using UserAttributes = internal::DepUserAttrs<LibObjT>;
177 explicit CommonFieldClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
181 template <typename OtherLibObjT>
182 CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
186 template <typename OtherLibObjT>
187 CommonFieldClass operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
189 _ThisBorrowedObject::operator=(fc);
193 CommonFieldClass<const bt_field_class> asConst() const noexcept
195 return CommonFieldClass<const bt_field_class> {*this};
198 FieldClassType type() const noexcept
200 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
203 bool isBool() const noexcept
205 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
208 bool isBitArray() const noexcept
210 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
213 bool isInteger() const noexcept
215 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
218 bool isUnsignedInteger() const noexcept
220 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
223 bool isSignedInteger() const noexcept
225 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
228 bool isEnumeration() const noexcept
230 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
233 bool isUnsignedEnumeration() const noexcept
235 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
238 bool isSignedEnumeration() const noexcept
240 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
243 bool isReal() const noexcept
245 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
248 bool isSinglePrecisionReal() const noexcept
250 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
253 bool isDoublePrecisionReal() const noexcept
255 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
258 bool isString() const noexcept
260 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
263 bool isStructure() const noexcept
265 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
268 bool isArray() const noexcept
270 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
273 bool isStaticArray() const noexcept
275 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
278 bool isDynamicArray() const noexcept
280 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
283 bool isDynamicArrayWithoutLength() const noexcept
285 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
288 bool isDynamicArrayWithLength() const noexcept
290 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
293 bool isOption() const noexcept
295 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
298 bool isOptionWithoutSelector() const noexcept
300 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
303 bool isOptionWithSelector() const noexcept
305 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
308 bool isOptionWithBoolSelector() const noexcept
310 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
313 bool isOptionWithIntegerSelector() const noexcept
315 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
318 bool isOptionWithUnsignedIntegerSelector() const noexcept
320 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
323 bool isOptionWithSignedIntegerSelector() const noexcept
325 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
328 bool isVariant() const noexcept
330 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
333 bool isVariantWithoutSelector() const noexcept
335 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
338 bool isVariantWithSelector() const noexcept
340 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
343 bool isVariantWithIntegerSelector() const noexcept
345 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
348 bool isVariantWithUnsignedIntegerSelector() const noexcept
350 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
353 bool isVariantWithSignedIntegerSelector() const noexcept
355 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
358 template <typename FieldClassT>
359 FieldClassT as() const noexcept
361 return FieldClassT {this->libObjPtr()};
364 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
365 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
366 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
367 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
368 const bt_field_class_enumeration_unsigned_mapping>>
369 asUnsignedEnumeration() const noexcept;
371 CommonEnumerationFieldClass<
372 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
373 asSignedEnumeration() const noexcept;
375 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
376 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
377 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
378 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
379 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
380 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
381 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
383 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
384 asOptionWithUnsignedIntegerSelector() const noexcept;
386 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
387 asOptionWithSignedIntegerSelector() const noexcept;
389 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
390 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
391 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
393 CommonVariantWithIntegerSelectorFieldClass<
394 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
395 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
396 asVariantWithUnsignedIntegerSelector() const noexcept;
398 CommonVariantWithIntegerSelectorFieldClass<
399 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
400 const bt_field_class_variant_with_selector_field_integer_signed_option>>
401 asVariantWithSignedIntegerSelector() const noexcept;
403 template <typename LibValT>
404 CommonFieldClass userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
406 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstFieldClass`.");
408 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
412 UserAttributes userAttributes() const noexcept
414 return UserAttributes {
415 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
418 Shared shared() const noexcept
420 return Shared::createWithRef(*this);
424 bool _libTypeIs(const bt_field_class_type type) const noexcept
426 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
430 using FieldClass = CommonFieldClass<bt_field_class>;
431 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
435 struct FieldClassTypeDescr
437 using Const = ConstFieldClass;
438 using NonConst = FieldClass;
442 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
447 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
451 } /* namespace internal */
453 template <typename LibObjT>
454 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
457 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
460 using typename CommonFieldClass<LibObjT>::LibObjPtr;
461 using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
463 explicit CommonBitArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
464 _ThisCommonFieldClass {libObjPtr}
466 BT_ASSERT_DBG(this->isBitArray());
469 template <typename OtherLibObjT>
470 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
471 _ThisCommonFieldClass {fc}
475 template <typename OtherLibObjT>
476 CommonBitArrayFieldClass<LibObjT>
477 operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
479 _ThisCommonFieldClass::operator=(fc);
483 CommonBitArrayFieldClass<const bt_field_class> asConst() const noexcept
485 return CommonBitArrayFieldClass<const bt_field_class> {*this};
488 std::uint64_t length() const noexcept
490 return bt_field_class_bit_array_get_length(this->libObjPtr());
493 Shared shared() const noexcept
495 return Shared::createWithRef(*this);
499 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
500 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
504 struct BitArrayFieldClassTypeDescr
506 using Const = ConstBitArrayFieldClass;
507 using NonConst = BitArrayFieldClass;
511 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
516 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
520 } /* namespace internal */
522 enum class DisplayBase
524 Binary = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
525 Octal = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
526 Decimal = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
527 Hexadecimal = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
530 template <typename LibObjT>
531 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
534 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
537 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
540 using typename CommonFieldClass<LibObjT>::LibObjPtr;
541 using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
543 explicit CommonIntegerFieldClass(const LibObjPtr libObjPtr) noexcept :
544 _ThisCommonFieldClass {libObjPtr}
546 BT_ASSERT_DBG(this->isInteger());
549 template <typename OtherLibObjT>
550 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
551 _ThisCommonFieldClass {fc}
555 template <typename OtherLibObjT>
556 CommonIntegerFieldClass operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
558 _ThisCommonFieldClass::operator=(fc);
562 CommonIntegerFieldClass<const bt_field_class> asConst() const noexcept
564 return CommonIntegerFieldClass<const bt_field_class> {*this};
567 CommonIntegerFieldClass fieldValueRange(const std::uint64_t n) const noexcept
569 static_assert(!std::is_const<LibObjT>::value,
570 "Not available with `bt2::ConstIntegerFieldClass`.");
572 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
576 std::uint64_t fieldValueRange() const noexcept
578 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
581 CommonIntegerFieldClass preferredDisplayBase(const DisplayBase base) const noexcept
583 static_assert(!std::is_const<LibObjT>::value,
584 "Not available with `bt2::ConstIntegerFieldClass`.");
586 bt_field_class_integer_set_preferred_display_base(
587 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
591 DisplayBase preferredDisplayBase() const noexcept
593 return static_cast<DisplayBase>(
594 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
597 Shared shared() const noexcept
599 return Shared::createWithRef(*this);
603 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
604 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
608 struct IntegerFieldClassTypeDescr
610 using Const = ConstIntegerFieldClass;
611 using NonConst = IntegerFieldClass;
615 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
620 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
624 template <typename LibObjT>
625 struct ConstEnumerationFieldClassMappingSpec;
627 /* Functions specific to unsigned enumeration field class mappings */
629 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
632 static const bt_integer_range_set_unsigned *
633 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
635 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
639 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
641 return bt_field_class_enumeration_mapping_get_label(
642 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
646 /* Functions specific to signed enumeration field class mappings */
648 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
650 static const bt_integer_range_set_signed *
651 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
653 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
657 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
659 return bt_field_class_enumeration_mapping_get_label(
660 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
664 } /* namespace internal */
666 template <typename LibObjT>
667 class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
670 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
673 using typename BorrowedObject<LibObjT>::LibObjPtr;
675 using RangeSet = typename std::conditional<
676 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
677 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
679 explicit ConstEnumerationFieldClassMapping(const LibObjPtr libObjPtr) noexcept :
680 _ThisBorrowedObject {libObjPtr}
684 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
685 _ThisBorrowedObject {mapping}
689 ConstEnumerationFieldClassMapping
690 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
692 _ThisBorrowedObject::operator=(mapping);
696 RangeSet ranges() const noexcept
699 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
702 bt2c::CStringView label() const noexcept
704 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
708 using ConstUnsignedEnumerationFieldClassMapping =
709 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
711 using ConstSignedEnumerationFieldClassMapping =
712 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
716 template <typename MappingT>
717 struct CommonEnumerationFieldClassSpec;
719 /* Functions specific to unsigned enumeration field classes */
721 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
723 static const bt_field_class_enumeration_unsigned_mapping *
724 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
726 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
729 static const bt_field_class_enumeration_unsigned_mapping *
730 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
732 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
735 static bt_field_class_enumeration_add_mapping_status
736 addMapping(bt_field_class * const libObjPtr, const char * const label,
737 const bt_integer_range_set_unsigned * const libRanges) noexcept
739 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
743 /* Functions specific to signed enumeration field classes */
745 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
747 static const bt_field_class_enumeration_signed_mapping *
748 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
750 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
753 static const bt_field_class_enumeration_signed_mapping *
754 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
756 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
759 static bt_field_class_enumeration_add_mapping_status
760 addMapping(bt_field_class * const libObjPtr, const char * const label,
761 const bt_integer_range_set_signed * const libRanges) noexcept
763 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
767 } /* namespace internal */
769 template <typename LibObjT>
770 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
773 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
776 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
779 using typename CommonFieldClass<LibObjT>::LibObjPtr;
780 using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
782 explicit CommonBaseEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
783 _ThisCommonIntegerFieldClass {libObjPtr}
785 BT_ASSERT_DBG(this->isEnumeration());
788 template <typename OtherLibObjT>
789 CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
791 _ThisCommonIntegerFieldClass {fc}
795 template <typename OtherLibObjT>
796 CommonBaseEnumerationFieldClass
797 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
799 _ThisCommonIntegerFieldClass::operator=(fc);
803 CommonBaseEnumerationFieldClass<const bt_field_class> asConst() const noexcept
805 return CommonBaseEnumerationFieldClass<const bt_field_class> {*this};
808 std::uint64_t length() const noexcept
810 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
813 Shared shared() const noexcept
815 return Shared::createWithRef(*this);
819 template <typename LibObjT, typename MappingT>
820 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
823 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
826 using typename CommonFieldClass<LibObjT>::LibObjPtr;
827 using Shared = SharedFieldClass<CommonEnumerationFieldClass, LibObjT>;
828 using Iterator = BorrowedObjectIterator<CommonEnumerationFieldClass>;
829 using Mapping = MappingT;
831 explicit CommonEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
832 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
834 BT_ASSERT_DBG(this->isEnumeration());
837 template <typename OtherLibObjT>
838 CommonEnumerationFieldClass(
839 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
840 CommonEnumerationFieldClass {fc}
844 template <typename OtherLibObjT>
845 CommonEnumerationFieldClass
846 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
848 CommonEnumerationFieldClass::operator=(fc);
852 Mapping operator[](const std::uint64_t index) const noexcept
854 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
855 this->libObjPtr(), index)};
858 OptionalBorrowedObject<Mapping> operator[](const bt2c::CStringView label) const noexcept
860 return internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
861 this->libObjPtr(), label);
864 CommonEnumerationFieldClass addMapping(const bt2c::CStringView label,
865 const typename Mapping::RangeSet ranges) const
867 static_assert(!std::is_const<LibObjT>::value,
868 "Not available with `bt2::Const*EnumerationFieldClass`.");
870 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
871 this->libObjPtr(), label, ranges.libObjPtr());
873 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
874 throw MemoryError {};
880 Iterator begin() const noexcept
882 return Iterator {*this, 0};
885 Iterator end() const noexcept
887 return Iterator {*this, this->length()};
890 Shared shared() const noexcept
892 return Shared::createWithRef(*this);
896 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
897 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
899 using UnsignedEnumerationFieldClass =
900 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
902 using ConstUnsignedEnumerationFieldClass =
903 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
905 using SignedEnumerationFieldClass =
906 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
908 using ConstSignedEnumerationFieldClass =
909 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
913 struct UnsignedEnumerationFieldClassTypeDescr
915 using Const = ConstUnsignedEnumerationFieldClass;
916 using NonConst = UnsignedEnumerationFieldClass;
920 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
925 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
929 struct SignedEnumerationFieldClassTypeDescr
931 using Const = ConstSignedEnumerationFieldClass;
932 using NonConst = SignedEnumerationFieldClass;
936 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
941 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
945 template <typename LibObjT>
946 struct CommonStructureFieldClassMemberSpec;
948 /* Functions specific to mutable structure field class members */
950 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
952 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
954 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
957 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
959 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
963 /* Functions specific to constant structure field class members */
965 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
967 static const bt_field_class *
968 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
970 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
973 static const bt_value *
974 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
976 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
980 } /* namespace internal */
982 template <typename LibObjT>
983 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
986 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
987 using _FieldClass = internal::DepFc<LibObjT>;
990 using typename BorrowedObject<LibObjT>::LibObjPtr;
991 using UserAttributes = internal::DepUserAttrs<LibObjT>;
993 explicit CommonStructureFieldClassMember(const LibObjPtr libObjPtr) noexcept :
994 _ThisBorrowedObject {libObjPtr}
998 template <typename OtherLibObjT>
999 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1001 _ThisBorrowedObject {fc}
1005 template <typename OtherLibObjT>
1006 CommonStructureFieldClassMember<LibObjT>
1007 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1009 _ThisBorrowedObject::operator=(fc);
1013 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1015 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1018 bt2c::CStringView name() const noexcept
1020 return bt_field_class_structure_member_get_name(this->libObjPtr());
1023 _FieldClass fieldClass() const noexcept
1025 return _FieldClass {
1026 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1029 template <typename LibValT>
1030 CommonStructureFieldClassMember
1031 userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1033 static_assert(!std::is_const<LibObjT>::value,
1034 "Not available with `bt2::ConstStructureFieldClassMember`.");
1036 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1037 userAttrs.libObjPtr());
1041 UserAttributes userAttributes() const noexcept
1043 return UserAttributes {
1044 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1045 this->libObjPtr())};
1049 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1051 using ConstStructureFieldClassMember =
1052 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1054 namespace internal {
1056 struct StructureFieldClassMemberTypeDescr
1058 using Const = ConstStructureFieldClassMember;
1059 using NonConst = StructureFieldClassMember;
1063 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1068 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1072 template <typename LibObjT>
1073 struct CommonStructureFieldClassSpec;
1075 /* Functions specific to mutable structure field classes */
1077 struct CommonStructureFieldClassSpec<bt_field_class> final
1079 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1080 const std::uint64_t index) noexcept
1082 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1085 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1086 const char * const name) noexcept
1088 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1092 /* Functions specific to constant structure field classes */
1094 struct CommonStructureFieldClassSpec<const bt_field_class> final
1096 static const bt_field_class_structure_member *
1097 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1099 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1102 static const bt_field_class_structure_member *
1103 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1105 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1109 } /* namespace internal */
1111 template <typename LibObjT>
1112 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1115 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1118 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1119 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1120 using Iterator = BorrowedObjectIterator<CommonStructureFieldClass<LibObjT>>;
1123 internal::DepType<LibObjT, StructureFieldClassMember, ConstStructureFieldClassMember>;
1125 explicit CommonStructureFieldClass(const LibObjPtr libObjPtr) noexcept :
1126 _ThisCommonFieldClass {libObjPtr}
1128 BT_ASSERT_DBG(this->isStructure());
1131 template <typename OtherLibObjT>
1132 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1133 _ThisCommonFieldClass {fc}
1137 template <typename OtherLibObjT>
1138 CommonStructureFieldClass operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1140 _ThisCommonFieldClass::operator=(fc);
1144 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1146 return CommonStructureFieldClass<const bt_field_class> {*this};
1149 CommonStructureFieldClass appendMember(const bt2c::CStringView name, const FieldClass fc) const
1151 static_assert(!std::is_const<LibObjT>::value,
1152 "Not available with `bt2::ConstStructureFieldClass`.");
1155 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1157 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1158 throw MemoryError {};
1164 std::uint64_t length() const noexcept
1166 return bt_field_class_structure_get_member_count(this->libObjPtr());
1169 Iterator begin() const noexcept
1171 return Iterator {*this, 0};
1174 Iterator end() const noexcept
1176 return Iterator {*this, this->length()};
1179 Member operator[](const std::uint64_t index) const noexcept
1181 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1182 this->libObjPtr(), index)};
1185 OptionalBorrowedObject<Member> operator[](const bt2c::CStringView name) const noexcept
1187 return internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(),
1191 Shared shared() const noexcept
1193 return Shared::createWithRef(*this);
1197 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1198 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1200 namespace internal {
1202 struct StructureFieldClassTypeDescr
1204 using Const = ConstStructureFieldClass;
1205 using NonConst = StructureFieldClass;
1209 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1214 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1218 template <typename LibObjT>
1219 struct CommonArrayFieldClassSpec;
1221 /* Functions specific to mutable array field classes */
1223 struct CommonArrayFieldClassSpec<bt_field_class> final
1225 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1227 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1231 /* Functions specific to constant array field classes */
1233 struct CommonArrayFieldClassSpec<const bt_field_class> final
1235 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1237 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1241 } /* namespace internal */
1243 template <typename LibObjT>
1244 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1247 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1248 using _FieldClass = internal::DepFc<LibObjT>;
1251 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1254 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1255 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1257 explicit CommonArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1258 _ThisCommonFieldClass {libObjPtr}
1260 BT_ASSERT_DBG(this->isArray());
1263 template <typename OtherLibObjT>
1264 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1265 _ThisCommonFieldClass {fc}
1269 template <typename OtherLibObjT>
1270 CommonArrayFieldClass operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1272 _ThisCommonFieldClass::operator=(fc);
1276 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1278 return CommonArrayFieldClass<const bt_field_class> {*this};
1281 _FieldClass elementFieldClass() const noexcept
1283 return _FieldClass {
1284 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1287 Shared shared() const noexcept
1289 return Shared::createWithRef(*this);
1293 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1294 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1296 namespace internal {
1298 struct ArrayFieldClassTypeDescr
1300 using Const = ConstArrayFieldClass;
1301 using NonConst = ArrayFieldClass;
1305 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1310 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1314 } /* namespace internal */
1316 template <typename LibObjT>
1317 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1320 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1323 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1324 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1326 explicit CommonStaticArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1327 _ThisCommonArrayFieldClass {libObjPtr}
1329 BT_ASSERT_DBG(this->isStaticArray());
1332 template <typename OtherLibObjT>
1333 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1334 _ThisCommonArrayFieldClass {fc}
1338 template <typename OtherLibObjT>
1339 CommonStaticArrayFieldClass
1340 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1342 _ThisCommonArrayFieldClass::operator=(fc);
1346 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1348 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1351 std::uint64_t length() const noexcept
1353 return bt_field_class_array_static_get_length(this->libObjPtr());
1356 Shared shared() const noexcept
1358 return Shared::createWithRef(*this);
1362 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1363 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1365 namespace internal {
1367 struct StaticArrayFieldClassTypeDescr
1369 using Const = ConstStaticArrayFieldClass;
1370 using NonConst = StaticArrayFieldClass;
1374 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1379 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1383 } /* namespace internal */
1385 template <typename LibObjT>
1386 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1389 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1392 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1393 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1395 explicit CommonDynamicArrayWithLengthFieldClass(const LibObjPtr libObjPtr) noexcept :
1396 _ThisCommonArrayFieldClass {libObjPtr}
1398 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1401 template <typename OtherLibObjT>
1402 CommonDynamicArrayWithLengthFieldClass(
1403 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1404 _ThisCommonArrayFieldClass {fc}
1408 template <typename OtherLibObjT>
1409 CommonDynamicArrayWithLengthFieldClass
1410 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1412 _ThisCommonArrayFieldClass::operator=(fc);
1416 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1418 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1421 ConstFieldPath lengthFieldPath() const noexcept
1423 return ConstFieldPath {
1424 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1425 this->libObjPtr())};
1428 Shared shared() const noexcept
1430 return Shared::createWithRef(*this);
1434 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1436 using ConstDynamicArrayWithLengthFieldClass =
1437 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1439 namespace internal {
1441 struct DynamicArrayWithLengthFieldClassTypeDescr
1443 using Const = ConstDynamicArrayWithLengthFieldClass;
1444 using NonConst = DynamicArrayWithLengthFieldClass;
1448 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1449 public DynamicArrayWithLengthFieldClassTypeDescr
1454 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1455 public DynamicArrayWithLengthFieldClassTypeDescr
1459 template <typename LibObjT>
1460 struct CommonOptionFieldClassSpec;
1462 /* Functions specific to mutable option field classes */
1464 struct CommonOptionFieldClassSpec<bt_field_class> final
1466 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1468 return bt_field_class_option_borrow_field_class(libObjPtr);
1472 /* Functions specific to constant option field classes */
1474 struct CommonOptionFieldClassSpec<const bt_field_class> final
1476 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1478 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1482 } /* namespace internal */
1484 template <typename LibObjT>
1485 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1488 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1489 using _FieldClass = internal::DepFc<LibObjT>;
1492 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1495 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1496 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1498 explicit CommonOptionFieldClass(const LibObjPtr libObjPtr) noexcept :
1499 _ThisCommonFieldClass {libObjPtr}
1501 BT_ASSERT_DBG(this->isOption());
1504 template <typename OtherLibObjT>
1505 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1506 _ThisCommonFieldClass {fc}
1510 template <typename OtherLibObjT>
1511 CommonOptionFieldClass operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1513 _ThisCommonFieldClass::operator=(fc);
1517 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1519 return CommonOptionFieldClass<const bt_field_class> {*this};
1522 _FieldClass fieldClass() const noexcept
1524 return _FieldClass {
1525 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1528 Shared shared() const noexcept
1530 return Shared::createWithRef(*this);
1534 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1535 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1537 namespace internal {
1539 struct OptionFieldClassTypeDescr
1541 using Const = ConstOptionFieldClass;
1542 using NonConst = OptionFieldClass;
1546 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1551 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1555 } /* namespace internal */
1557 template <typename LibObjT>
1558 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1561 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1564 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1567 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1568 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1570 explicit CommonOptionWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1571 _ThisCommonOptionFieldClass {libObjPtr}
1573 BT_ASSERT_DBG(this->isOptionWithSelector());
1576 template <typename OtherLibObjT>
1577 CommonOptionWithSelectorFieldClass(
1578 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1579 _ThisCommonOptionFieldClass {fc}
1583 template <typename OtherLibObjT>
1584 CommonOptionWithSelectorFieldClass
1585 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1587 _ThisCommonOptionFieldClass::operator=(fc);
1591 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1593 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1596 ConstFieldPath selectorFieldPath() const noexcept
1598 return ConstFieldPath {
1599 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1600 this->libObjPtr())};
1603 Shared shared() const noexcept
1605 return Shared::createWithRef(*this);
1609 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1610 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1612 namespace internal {
1614 struct OptionWithSelectorFieldClassTypeDescr
1616 using Const = ConstOptionWithSelectorFieldClass;
1617 using NonConst = OptionWithSelectorFieldClass;
1621 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1626 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1630 } /* namespace internal */
1632 template <typename LibObjT>
1633 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1636 using typename CommonOptionWithSelectorFieldClass<
1637 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1640 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1641 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1643 explicit CommonOptionWithBoolSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1644 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1646 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1649 template <typename OtherLibObjT>
1650 CommonOptionWithBoolSelectorFieldClass(
1651 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1652 _ThisCommonOptionWithSelectorFieldClass {fc}
1656 template <typename OtherLibObjT>
1657 CommonOptionWithBoolSelectorFieldClass
1658 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1660 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1664 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1666 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1669 bool selectorIsReversed() const noexcept
1671 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1675 Shared shared() const noexcept
1677 return Shared::createWithRef(*this);
1681 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1683 using ConstOptionWithBoolSelectorFieldClass =
1684 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1686 namespace internal {
1688 struct OptionWithBoolSelectorFieldClassTypeDescr
1690 using Const = ConstOptionWithBoolSelectorFieldClass;
1691 using NonConst = OptionWithBoolSelectorFieldClass;
1695 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1696 public OptionWithBoolSelectorFieldClassTypeDescr
1701 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1702 public OptionWithBoolSelectorFieldClassTypeDescr
1706 template <typename RangeSetT>
1707 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1709 /* Functions specific to option field classes with unsigned integer ranges */
1711 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1713 static const bt_integer_range_set_unsigned *
1714 ranges(const bt_field_class * const libObjPtr) noexcept
1716 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1721 /* Functions specific to option field classes with signed ranges */
1723 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1725 static const bt_integer_range_set_signed *
1726 ranges(const bt_field_class * const libObjPtr) noexcept
1728 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1733 } /* namespace internal */
1735 template <typename LibObjT, typename RangeSetT>
1736 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1739 using typename CommonOptionWithSelectorFieldClass<
1740 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1743 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1744 using Shared = SharedFieldClass<CommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1745 using RangeSet = RangeSetT;
1747 explicit CommonOptionWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1748 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1750 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1753 template <typename OtherLibObjT>
1754 CommonOptionWithIntegerSelectorFieldClass(
1755 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1756 _ThisCommonOptionWithSelectorFieldClass {fc}
1760 template <typename OtherLibObjT>
1761 CommonOptionWithIntegerSelectorFieldClass
1762 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1764 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1768 RangeSet ranges() const noexcept
1770 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1771 this->libObjPtr())};
1774 Shared shared() const noexcept
1776 return Shared::createWithRef(*this);
1780 using OptionWithUnsignedIntegerSelectorFieldClass =
1781 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1783 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1784 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1786 using OptionWithSignedIntegerSelectorFieldClass =
1787 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1789 using ConstOptionWithSignedIntegerSelectorFieldClass =
1790 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1792 namespace internal {
1794 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1796 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1797 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1801 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1802 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1807 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1808 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1812 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1814 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1815 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1819 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1820 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1825 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1826 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1830 template <typename LibObjT>
1831 struct CommonVariantFieldClassOptionSpec;
1833 /* Functions specific to mutable variant field class options */
1835 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1837 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1839 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1842 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1844 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1848 /* Functions specific to constant variant field class options */
1850 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1852 static const bt_field_class *
1853 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1855 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1858 static const bt_value *
1859 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1861 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1865 } /* namespace internal */
1867 template <typename LibObjT>
1868 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1871 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1872 using _FieldClass = internal::DepFc<LibObjT>;
1875 using typename BorrowedObject<LibObjT>::LibObjPtr;
1876 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1878 explicit CommonVariantFieldClassOption(const LibObjPtr libObjPtr) noexcept :
1879 _ThisBorrowedObject {libObjPtr}
1883 template <typename OtherLibObjT>
1884 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1885 _ThisBorrowedObject {fc}
1889 template <typename OtherLibObjT>
1890 CommonVariantFieldClassOption
1891 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1893 _ThisBorrowedObject::operator=(fc);
1897 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1899 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1902 bt2c::CStringView name() const noexcept
1904 return bt_field_class_variant_option_get_name(this->libObjPtr());
1907 _FieldClass fieldClass() const noexcept
1909 return _FieldClass {
1910 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1913 template <typename LibValT>
1914 CommonVariantFieldClassOption
1915 userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1917 static_assert(!std::is_const<LibObjT>::value,
1918 "Not available with `bt2::ConstVariantFieldClassOption`.");
1920 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1924 UserAttributes userAttributes() const noexcept
1926 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1927 this->libObjPtr())};
1931 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1933 using ConstVariantFieldClassOption =
1934 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1936 namespace internal {
1938 struct VariantFieldClassOptionTypeDescr
1940 using Const = ConstVariantFieldClassOption;
1941 using NonConst = VariantFieldClassOption;
1945 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1950 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1954 template <typename LibObjT>
1955 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1957 /* Functions specific to variant field class options with unsigned integer selector */
1959 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1960 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1963 static const bt_integer_range_set_unsigned *
1964 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1965 * const libObjPtr) noexcept
1967 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1971 static const bt_field_class_variant_option *
1972 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1973 * const libObjPtr) noexcept
1975 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1980 /* Functions specific to variant field class options with signed integer selector */
1982 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1983 const bt_field_class_variant_with_selector_field_integer_signed_option>
1986 static const bt_integer_range_set_signed *
1987 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1988 * const libObjPtr) noexcept
1990 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1994 static const bt_field_class_variant_option *
1995 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1996 * const libObjPtr) noexcept
1998 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2003 } /* namespace internal */
2005 template <typename LibObjT>
2006 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2009 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2010 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2013 using typename BorrowedObject<LibObjT>::LibObjPtr;
2015 using RangeSet = typename std::conditional<
2018 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2019 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2021 explicit ConstVariantWithIntegerSelectorFieldClassOption(const LibObjPtr libObjPtr) noexcept :
2022 _ThisBorrowedObject {libObjPtr}
2026 template <typename OtherLibObjT>
2027 ConstVariantWithIntegerSelectorFieldClassOption(
2028 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2029 _ThisBorrowedObject {fc}
2033 template <typename OtherLibObjT>
2034 ConstVariantWithIntegerSelectorFieldClassOption
2035 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2037 _ThisBorrowedObject::operator=(fc);
2041 ConstVariantFieldClassOption asBaseOption() const noexcept
2043 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2046 bt2c::CStringView name() const noexcept
2048 return this->asBaseOption().name();
2051 ConstFieldClass fieldClass() const noexcept
2053 return this->asBaseOption().fieldClass();
2056 RangeSet ranges() const noexcept
2058 return RangeSet {_Spec::ranges(this->libObjPtr())};
2062 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2063 ConstVariantWithIntegerSelectorFieldClassOption<
2064 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2066 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2067 ConstVariantWithIntegerSelectorFieldClassOption<
2068 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2070 namespace internal {
2072 template <typename LibObjT>
2073 struct CommonVariantFieldClassSpec;
2075 /* Functions specific to mutable variant field classes */
2077 struct CommonVariantFieldClassSpec<bt_field_class> final
2079 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2080 const std::uint64_t index) noexcept
2082 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2085 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2086 const char * const name) noexcept
2088 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2092 /* Functions specific to constant variant field classes */
2094 struct CommonVariantFieldClassSpec<const bt_field_class> final
2096 static const bt_field_class_variant_option *
2097 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2099 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2102 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2103 const char * const name) noexcept
2105 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2109 } /* namespace internal */
2111 template <typename LibObjT>
2112 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2115 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2118 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2121 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2122 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2123 using Iterator = BorrowedObjectIterator<CommonVariantFieldClass>;
2126 internal::DepType<LibObjT, VariantFieldClassOption, ConstVariantFieldClassOption>;
2128 explicit CommonVariantFieldClass(const LibObjPtr libObjPtr) noexcept :
2129 _ThisCommonFieldClass {libObjPtr}
2131 BT_ASSERT_DBG(this->isVariant());
2134 template <typename OtherLibObjT>
2135 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2136 _ThisCommonFieldClass {fc}
2140 template <typename OtherLibObjT>
2141 CommonVariantFieldClass operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2143 _ThisCommonFieldClass::operator=(fc);
2147 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2149 return CommonVariantFieldClass<const bt_field_class> {*this};
2152 std::uint64_t length() const noexcept
2154 return bt_field_class_variant_get_option_count(this->libObjPtr());
2157 Iterator begin() const noexcept
2159 return Iterator {*this, 0};
2162 Iterator end() const noexcept
2164 return Iterator {*this, this->length()};
2167 Option operator[](const std::uint64_t index) const noexcept
2169 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2170 this->libObjPtr(), index)};
2173 OptionalBorrowedObject<Option> operator[](const bt2c::CStringView name) const noexcept
2175 return internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(),
2179 Shared shared() const noexcept
2181 return Shared::createWithRef(*this);
2185 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2186 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2188 namespace internal {
2190 struct VariantFieldClassTypeDescr
2192 using Const = ConstVariantFieldClass;
2193 using NonConst = VariantFieldClass;
2197 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2202 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2206 } /* namespace internal */
2208 template <typename LibObjT>
2209 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2212 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2215 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2216 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2218 explicit CommonVariantWithoutSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2219 _ThisCommonVariantFieldClass {libObjPtr}
2221 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2224 template <typename OtherLibObjT>
2225 CommonVariantWithoutSelectorFieldClass(
2226 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2227 _ThisCommonVariantFieldClass {fc}
2231 template <typename OtherLibObjT>
2232 CommonVariantWithoutSelectorFieldClass
2233 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2235 _ThisCommonVariantFieldClass::operator=(fc);
2239 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2241 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2244 CommonVariantWithoutSelectorFieldClass appendOption(const char * const name,
2245 const FieldClass fc) const
2247 static_assert(!std::is_const<LibObjT>::value,
2248 "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");
2250 const auto status = bt_field_class_variant_without_selector_append_option(
2251 this->libObjPtr(), name, fc.libObjPtr());
2254 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2255 throw MemoryError {};
2261 CommonVariantWithoutSelectorFieldClass appendOption(const bt2c::CStringView name,
2262 const FieldClass fc) const
2264 return this->appendOption(name.data(), fc);
2267 CommonVariantWithoutSelectorFieldClass appendOption(const bt2s::optional<std::string>& name,
2268 const FieldClass fc) const
2270 return this->appendOption(name ? name->data() : nullptr, fc);
2273 Shared shared() const noexcept
2275 return Shared::createWithRef(*this);
2279 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2280 using ConstVariantWithoutSelectorFieldClass =
2281 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2283 namespace internal {
2285 struct VariantWithoutSelectorFieldClassTypeDescr
2287 using Const = ConstVariantWithoutSelectorFieldClass;
2288 using NonConst = VariantWithoutSelectorFieldClass;
2292 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2293 public VariantWithoutSelectorFieldClassTypeDescr
2298 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2299 public VariantWithoutSelectorFieldClassTypeDescr
2303 template <typename OptionT>
2304 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2306 /* Functions specific to variant field classes with unsigned integer selector */
2308 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2309 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2312 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2313 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2315 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2319 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2320 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2322 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2326 static bt_field_class_variant_with_selector_field_integer_append_option_status
2327 appendOption(bt_field_class * const libObjPtr, const char * const name,
2328 bt_field_class * const libOptFcPtr,
2329 const bt_integer_range_set_unsigned * const libRangesPtr)
2331 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2332 libObjPtr, name, libOptFcPtr, libRangesPtr);
2336 /* Functions specific to variant field classes with signed integer selector */
2338 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2339 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2342 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2343 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2345 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2349 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2350 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2352 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2356 static bt_field_class_variant_with_selector_field_integer_append_option_status
2357 appendOption(bt_field_class * const libObjPtr, const char * const name,
2358 bt_field_class * const libOptFcPtr,
2359 const bt_integer_range_set_signed * const libRangesPtr)
2361 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2362 libObjPtr, name, libOptFcPtr, libRangesPtr);
2366 } /* namespace internal */
2368 template <typename LibObjT>
2369 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2372 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2375 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2378 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2379 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2381 explicit CommonVariantWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2382 _ThisCommonVariantFieldClass {libObjPtr}
2384 BT_ASSERT_DBG(this->isVariantWithSelector());
2387 template <typename OtherLibObjT>
2388 CommonVariantWithSelectorFieldClass(
2389 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2390 _ThisCommonVariantFieldClass {fc}
2394 template <typename OtherLibObjT>
2395 CommonVariantWithSelectorFieldClass
2396 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2398 _ThisCommonVariantFieldClass::operator=(fc);
2402 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2404 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2407 ConstFieldPath selectorFieldPath() const noexcept
2409 return ConstFieldPath {
2410 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2411 this->libObjPtr())};
2414 Shared shared() const noexcept
2416 return Shared::createWithRef(*this);
2420 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2421 using ConstVariantWithSelectorFieldClass =
2422 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2424 template <typename LibObjT, typename OptionT>
2425 class CommonVariantWithIntegerSelectorFieldClass :
2426 public CommonVariantWithSelectorFieldClass<LibObjT>
2429 using typename CommonVariantWithSelectorFieldClass<
2430 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2432 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2435 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2436 using Shared = SharedFieldClass<CommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2437 using Option = OptionT;
2440 BorrowedObjectIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>>;
2442 explicit CommonVariantWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2443 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2445 BT_ASSERT_DBG(this->isVariantWithIntegerSelector());
2448 template <typename OtherLibObjT>
2449 CommonVariantWithIntegerSelectorFieldClass(
2450 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2451 _ThisCommonVariantWithSelectorFieldClass {fc}
2455 template <typename OtherLibObjT>
2456 CommonVariantWithIntegerSelectorFieldClass
2457 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2459 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2463 Option operator[](const std::uint64_t index) const noexcept
2465 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2468 OptionalBorrowedObject<Option> operator[](const bt2c::CStringView name) const noexcept
2470 return _Spec::optionByName(this->libObjPtr(), name);
2473 CommonVariantWithIntegerSelectorFieldClass
2474 appendOption(const char * const name, const FieldClass fc,
2475 const typename Option::RangeSet ranges) const
2478 !std::is_const<LibObjT>::value,
2479 "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");
2482 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2485 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2486 throw MemoryError {};
2492 CommonVariantWithIntegerSelectorFieldClass
2493 appendOption(const bt2c::CStringView name, const FieldClass fc,
2494 const typename Option::RangeSet ranges) const
2496 return this->appendOption(name.data(), fc, ranges);
2499 CommonVariantWithIntegerSelectorFieldClass
2500 appendOption(const bt2s::optional<std::string>& name, const FieldClass fc,
2501 const typename Option::RangeSet ranges) const
2503 return this->appendOption(name ? name->data() : nullptr, fc, ranges);
2506 Iterator begin() const noexcept
2508 return Iterator {*this, 0};
2511 Iterator end() const noexcept
2513 return Iterator {*this, this->length()};
2516 Shared shared() const noexcept
2518 return Shared::createWithRef(*this);
2522 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2523 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2525 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2526 CommonVariantWithIntegerSelectorFieldClass<
2527 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2529 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2530 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2532 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2533 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2535 namespace internal {
2537 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2539 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2540 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2544 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2545 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2550 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2551 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2555 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2557 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2558 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2562 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2563 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2568 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2569 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2573 } /* namespace internal */
2575 template <typename LibObjT>
2576 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2578 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2581 template <typename LibObjT>
2582 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2584 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2587 template <typename LibObjT>
2588 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2590 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2593 template <typename LibObjT>
2594 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2595 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2597 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2598 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2602 template <typename LibObjT>
2603 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2604 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2606 BT_ASSERT_DBG(this->isSignedEnumeration());
2607 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2611 template <typename LibObjT>
2612 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2614 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2617 template <typename LibObjT>
2618 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2620 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2623 template <typename LibObjT>
2624 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2626 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2629 template <typename LibObjT>
2630 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2631 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2633 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2636 template <typename LibObjT>
2637 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2639 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2642 template <typename LibObjT>
2643 CommonOptionWithSelectorFieldClass<LibObjT>
2644 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2646 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2649 template <typename LibObjT>
2650 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2651 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2653 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2656 template <typename LibObjT>
2657 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2658 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2660 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2661 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2665 template <typename LibObjT>
2666 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2667 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2669 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2670 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2674 template <typename LibObjT>
2675 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2677 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2680 template <typename LibObjT>
2681 CommonVariantWithoutSelectorFieldClass<LibObjT>
2682 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2684 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2687 template <typename LibObjT>
2688 CommonVariantWithSelectorFieldClass<LibObjT>
2689 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2691 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2694 template <typename LibObjT>
2695 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2696 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2697 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2699 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2700 return CommonVariantWithIntegerSelectorFieldClass<
2701 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2704 template <typename LibObjT>
2705 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2706 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2707 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2709 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2710 return CommonVariantWithIntegerSelectorFieldClass<
2711 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2714 } /* namespace bt2 */
2716 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */