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 BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
140 UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
141 SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
142 UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
143 SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
144 SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
145 DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
146 STRING = BT_FIELD_CLASS_TYPE_STRING,
147 STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
148 STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
149 DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
150 DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
151 OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
152 OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
153 OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
154 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
155 OPTION_WITH_SIGNED_INTEGER_SELECTOR =
156 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
157 VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
158 VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
159 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
160 VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
161 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
164 template <typename LibObjT>
165 class CommonFieldClass : public BorrowedObject<LibObjT>
168 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
171 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
174 using typename BorrowedObject<LibObjT>::LibObjPtr;
175 using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
176 using UserAttributes = internal::DepUserAttrs<LibObjT>;
178 explicit CommonFieldClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
182 template <typename OtherLibObjT>
183 CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
187 template <typename OtherLibObjT>
188 CommonFieldClass operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
190 _ThisBorrowedObject::operator=(fc);
194 CommonFieldClass<const bt_field_class> asConst() const noexcept
196 return CommonFieldClass<const bt_field_class> {*this};
199 FieldClassType type() const noexcept
201 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
204 bool isBool() const noexcept
206 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
209 bool isBitArray() const noexcept
211 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
214 bool isInteger() const noexcept
216 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
219 bool isUnsignedInteger() const noexcept
221 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
224 bool isSignedInteger() const noexcept
226 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
229 bool isEnumeration() const noexcept
231 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
234 bool isUnsignedEnumeration() const noexcept
236 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
239 bool isSignedEnumeration() const noexcept
241 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
244 bool isReal() const noexcept
246 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
249 bool isSinglePrecisionReal() const noexcept
251 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
254 bool isDoublePrecisionReal() const noexcept
256 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
259 bool isString() const noexcept
261 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
264 bool isStructure() const noexcept
266 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
269 bool isArray() const noexcept
271 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
274 bool isStaticArray() const noexcept
276 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
279 bool isDynamicArray() const noexcept
281 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
284 bool isDynamicArrayWithoutLength() const noexcept
286 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
289 bool isDynamicArrayWithLength() const noexcept
291 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
294 bool isOption() const noexcept
296 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
299 bool isOptionWithoutSelector() const noexcept
301 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
304 bool isOptionWithSelector() const noexcept
306 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
309 bool isOptionWithBoolSelector() const noexcept
311 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
314 bool isOptionWithIntegerSelector() const noexcept
316 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
319 bool isOptionWithUnsignedIntegerSelector() const noexcept
321 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
324 bool isOptionWithSignedIntegerSelector() const noexcept
326 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
329 bool isVariant() const noexcept
331 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
334 bool isVariantWithoutSelector() const noexcept
336 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
339 bool isVariantWithSelector() const noexcept
341 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
344 bool isVariantWithIntegerSelector() const noexcept
346 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
349 bool isVariantWithUnsignedIntegerSelector() const noexcept
351 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
354 bool isVariantWithSignedIntegerSelector() const noexcept
356 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
359 template <typename FieldClassT>
360 FieldClassT as() const noexcept
362 return FieldClassT {this->libObjPtr()};
365 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
366 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
367 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
368 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
369 const bt_field_class_enumeration_unsigned_mapping>>
370 asUnsignedEnumeration() const noexcept;
372 CommonEnumerationFieldClass<
373 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
374 asSignedEnumeration() const noexcept;
376 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
377 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
378 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
379 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
380 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
381 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
382 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
384 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
385 asOptionWithUnsignedIntegerSelector() const noexcept;
387 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
388 asOptionWithSignedIntegerSelector() const noexcept;
390 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
391 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
392 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
394 CommonVariantWithIntegerSelectorFieldClass<
395 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
396 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
397 asVariantWithUnsignedIntegerSelector() const noexcept;
399 CommonVariantWithIntegerSelectorFieldClass<
400 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
401 const bt_field_class_variant_with_selector_field_integer_signed_option>>
402 asVariantWithSignedIntegerSelector() const noexcept;
404 template <typename LibValT>
405 CommonFieldClass userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
407 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstFieldClass`.");
409 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
413 UserAttributes userAttributes() const noexcept
415 return UserAttributes {
416 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
419 Shared shared() const noexcept
421 return Shared::createWithRef(*this);
425 bool _libTypeIs(const bt_field_class_type type) const noexcept
427 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
431 using FieldClass = CommonFieldClass<bt_field_class>;
432 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
436 struct FieldClassTypeDescr
438 using Const = ConstFieldClass;
439 using NonConst = FieldClass;
443 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
448 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
452 } /* namespace internal */
454 template <typename LibObjT>
455 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
458 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
461 using typename CommonFieldClass<LibObjT>::LibObjPtr;
462 using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
464 explicit CommonBitArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
465 _ThisCommonFieldClass {libObjPtr}
467 BT_ASSERT_DBG(this->isBitArray());
470 template <typename OtherLibObjT>
471 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
472 _ThisCommonFieldClass {fc}
476 template <typename OtherLibObjT>
477 CommonBitArrayFieldClass<LibObjT>
478 operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
480 _ThisCommonFieldClass::operator=(fc);
484 CommonBitArrayFieldClass<const bt_field_class> asConst() const noexcept
486 return CommonBitArrayFieldClass<const bt_field_class> {*this};
489 std::uint64_t length() const noexcept
491 return bt_field_class_bit_array_get_length(this->libObjPtr());
494 Shared shared() const noexcept
496 return Shared::createWithRef(*this);
500 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
501 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
505 struct BitArrayFieldClassTypeDescr
507 using Const = ConstBitArrayFieldClass;
508 using NonConst = BitArrayFieldClass;
512 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
517 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
521 } /* namespace internal */
523 enum class DisplayBase
525 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
526 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
527 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
528 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
531 template <typename LibObjT>
532 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
535 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
538 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
541 using typename CommonFieldClass<LibObjT>::LibObjPtr;
542 using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
544 explicit CommonIntegerFieldClass(const LibObjPtr libObjPtr) noexcept :
545 _ThisCommonFieldClass {libObjPtr}
547 BT_ASSERT_DBG(this->isInteger());
550 template <typename OtherLibObjT>
551 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
552 _ThisCommonFieldClass {fc}
556 template <typename OtherLibObjT>
557 CommonIntegerFieldClass operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
559 _ThisCommonFieldClass::operator=(fc);
563 CommonIntegerFieldClass<const bt_field_class> asConst() const noexcept
565 return CommonIntegerFieldClass<const bt_field_class> {*this};
568 CommonIntegerFieldClass fieldValueRange(const std::uint64_t n) const noexcept
570 static_assert(!std::is_const<LibObjT>::value,
571 "Not available with `bt2::ConstIntegerFieldClass`.");
573 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
577 std::uint64_t fieldValueRange() const noexcept
579 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
582 CommonIntegerFieldClass preferredDisplayBase(const DisplayBase base) const noexcept
584 static_assert(!std::is_const<LibObjT>::value,
585 "Not available with `bt2::ConstIntegerFieldClass`.");
587 bt_field_class_integer_set_preferred_display_base(
588 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
592 DisplayBase preferredDisplayBase() const noexcept
594 return static_cast<DisplayBase>(
595 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
598 Shared shared() const noexcept
600 return Shared::createWithRef(*this);
604 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
605 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
609 struct IntegerFieldClassTypeDescr
611 using Const = ConstIntegerFieldClass;
612 using NonConst = IntegerFieldClass;
616 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
621 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
625 template <typename LibObjT>
626 struct ConstEnumerationFieldClassMappingSpec;
628 /* Functions specific to unsigned enumeration field class mappings */
630 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
633 static const bt_integer_range_set_unsigned *
634 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
636 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
640 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
642 return bt_field_class_enumeration_mapping_get_label(
643 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
647 /* Functions specific to signed enumeration field class mappings */
649 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
651 static const bt_integer_range_set_signed *
652 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
654 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
658 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
660 return bt_field_class_enumeration_mapping_get_label(
661 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
665 } /* namespace internal */
667 template <typename LibObjT>
668 class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
671 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
674 using typename BorrowedObject<LibObjT>::LibObjPtr;
676 using RangeSet = typename std::conditional<
677 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
678 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
680 explicit ConstEnumerationFieldClassMapping(const LibObjPtr libObjPtr) noexcept :
681 _ThisBorrowedObject {libObjPtr}
685 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
686 _ThisBorrowedObject {mapping}
690 ConstEnumerationFieldClassMapping
691 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
693 _ThisBorrowedObject::operator=(mapping);
697 RangeSet ranges() const noexcept
700 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
703 bt2c::CStringView label() const noexcept
705 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
709 using ConstUnsignedEnumerationFieldClassMapping =
710 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
712 using ConstSignedEnumerationFieldClassMapping =
713 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
717 template <typename MappingT>
718 struct CommonEnumerationFieldClassSpec;
720 /* Functions specific to unsigned enumeration field classes */
722 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
724 static const bt_field_class_enumeration_unsigned_mapping *
725 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
727 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
730 static const bt_field_class_enumeration_unsigned_mapping *
731 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
733 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
736 static bt_field_class_enumeration_add_mapping_status
737 addMapping(bt_field_class * const libObjPtr, const char * const label,
738 const bt_integer_range_set_unsigned * const libRanges) noexcept
740 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
744 /* Functions specific to signed enumeration field classes */
746 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
748 static const bt_field_class_enumeration_signed_mapping *
749 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
751 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
754 static const bt_field_class_enumeration_signed_mapping *
755 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
757 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
760 static bt_field_class_enumeration_add_mapping_status
761 addMapping(bt_field_class * const libObjPtr, const char * const label,
762 const bt_integer_range_set_signed * const libRanges) noexcept
764 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
768 } /* namespace internal */
770 template <typename LibObjT>
771 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
774 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
777 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
780 using typename CommonFieldClass<LibObjT>::LibObjPtr;
781 using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
783 explicit CommonBaseEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
784 _ThisCommonIntegerFieldClass {libObjPtr}
786 BT_ASSERT_DBG(this->isEnumeration());
789 template <typename OtherLibObjT>
790 CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
792 _ThisCommonIntegerFieldClass {fc}
796 template <typename OtherLibObjT>
797 CommonBaseEnumerationFieldClass
798 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
800 _ThisCommonIntegerFieldClass::operator=(fc);
804 CommonBaseEnumerationFieldClass<const bt_field_class> asConst() const noexcept
806 return CommonBaseEnumerationFieldClass<const bt_field_class> {*this};
809 std::uint64_t length() const noexcept
811 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
814 Shared shared() const noexcept
816 return Shared::createWithRef(*this);
820 template <typename LibObjT, typename MappingT>
821 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
824 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
827 using typename CommonFieldClass<LibObjT>::LibObjPtr;
828 using Shared = SharedFieldClass<CommonEnumerationFieldClass, LibObjT>;
829 using Iterator = BorrowedObjectIterator<CommonEnumerationFieldClass>;
830 using Mapping = MappingT;
832 explicit CommonEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
833 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
835 BT_ASSERT_DBG(this->isEnumeration());
838 template <typename OtherLibObjT>
839 CommonEnumerationFieldClass(
840 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
841 CommonEnumerationFieldClass {fc}
845 template <typename OtherLibObjT>
846 CommonEnumerationFieldClass
847 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
849 CommonEnumerationFieldClass::operator=(fc);
853 Mapping operator[](const std::uint64_t index) const noexcept
855 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
856 this->libObjPtr(), index)};
859 OptionalBorrowedObject<Mapping> operator[](const bt2c::CStringView label) const noexcept
861 return internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
862 this->libObjPtr(), label);
865 CommonEnumerationFieldClass addMapping(const bt2c::CStringView label,
866 const typename Mapping::RangeSet ranges) const
868 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
869 this->libObjPtr(), label, ranges.libObjPtr());
871 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
872 throw MemoryError {};
878 Iterator begin() const noexcept
880 return Iterator {*this, 0};
883 Iterator end() const noexcept
885 return Iterator {*this, this->length()};
888 Shared shared() const noexcept
890 return Shared::createWithRef(*this);
894 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
895 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
897 using UnsignedEnumerationFieldClass =
898 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
900 using ConstUnsignedEnumerationFieldClass =
901 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
903 using SignedEnumerationFieldClass =
904 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
906 using ConstSignedEnumerationFieldClass =
907 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
911 struct UnsignedEnumerationFieldClassTypeDescr
913 using Const = ConstUnsignedEnumerationFieldClass;
914 using NonConst = UnsignedEnumerationFieldClass;
918 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
923 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
927 struct SignedEnumerationFieldClassTypeDescr
929 using Const = ConstSignedEnumerationFieldClass;
930 using NonConst = SignedEnumerationFieldClass;
934 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
939 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
943 template <typename LibObjT>
944 struct CommonStructureFieldClassMemberSpec;
946 /* Functions specific to mutable structure field class members */
948 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
950 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
952 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
955 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
957 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
961 /* Functions specific to constant structure field class members */
963 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
965 static const bt_field_class *
966 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
968 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
971 static const bt_value *
972 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
974 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
978 } /* namespace internal */
980 template <typename LibObjT>
981 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
984 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
985 using _FieldClass = internal::DepFc<LibObjT>;
988 using typename BorrowedObject<LibObjT>::LibObjPtr;
989 using UserAttributes = internal::DepUserAttrs<LibObjT>;
991 explicit CommonStructureFieldClassMember(const LibObjPtr libObjPtr) noexcept :
992 _ThisBorrowedObject {libObjPtr}
996 template <typename OtherLibObjT>
997 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
999 _ThisBorrowedObject {fc}
1003 template <typename OtherLibObjT>
1004 CommonStructureFieldClassMember<LibObjT>
1005 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1007 _ThisBorrowedObject::operator=(fc);
1011 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1013 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1016 bt2c::CStringView name() const noexcept
1018 return bt_field_class_structure_member_get_name(this->libObjPtr());
1021 _FieldClass fieldClass() const noexcept
1023 return _FieldClass {
1024 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1027 template <typename LibValT>
1028 CommonStructureFieldClassMember
1029 userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1031 static_assert(!std::is_const<LibObjT>::value,
1032 "Not available with `bt2::ConstStructureFieldClassMember`.");
1034 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1035 userAttrs.libObjPtr());
1039 UserAttributes userAttributes() const noexcept
1041 return UserAttributes {
1042 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1043 this->libObjPtr())};
1047 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1049 using ConstStructureFieldClassMember =
1050 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1052 namespace internal {
1054 struct StructureFieldClassMemberTypeDescr
1056 using Const = ConstStructureFieldClassMember;
1057 using NonConst = StructureFieldClassMember;
1061 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1066 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1070 template <typename LibObjT>
1071 struct CommonStructureFieldClassSpec;
1073 /* Functions specific to mutable structure field classes */
1075 struct CommonStructureFieldClassSpec<bt_field_class> final
1077 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1078 const std::uint64_t index) noexcept
1080 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1083 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1084 const char * const name) noexcept
1086 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1090 /* Functions specific to constant structure field classes */
1092 struct CommonStructureFieldClassSpec<const bt_field_class> final
1094 static const bt_field_class_structure_member *
1095 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1097 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1100 static const bt_field_class_structure_member *
1101 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1103 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1107 } /* namespace internal */
1109 template <typename LibObjT>
1110 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1113 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1116 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1117 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1118 using Iterator = BorrowedObjectIterator<CommonStructureFieldClass<LibObjT>>;
1121 internal::DepType<LibObjT, StructureFieldClassMember, ConstStructureFieldClassMember>;
1123 explicit CommonStructureFieldClass(const LibObjPtr libObjPtr) noexcept :
1124 _ThisCommonFieldClass {libObjPtr}
1126 BT_ASSERT_DBG(this->isStructure());
1129 template <typename OtherLibObjT>
1130 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1131 _ThisCommonFieldClass {fc}
1135 template <typename OtherLibObjT>
1136 CommonStructureFieldClass operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1138 _ThisCommonFieldClass::operator=(fc);
1142 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1144 return CommonStructureFieldClass<const bt_field_class> {*this};
1147 CommonStructureFieldClass appendMember(const bt2c::CStringView name, const FieldClass fc) const
1149 static_assert(!std::is_const<LibObjT>::value,
1150 "Not available with `bt2::ConstStructureFieldClass`.");
1153 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1155 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1156 throw MemoryError {};
1162 std::uint64_t length() const noexcept
1164 return bt_field_class_structure_get_member_count(this->libObjPtr());
1167 Iterator begin() const noexcept
1169 return Iterator {*this, 0};
1172 Iterator end() const noexcept
1174 return Iterator {*this, this->length()};
1177 Member operator[](const std::uint64_t index) const noexcept
1179 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1180 this->libObjPtr(), index)};
1183 OptionalBorrowedObject<Member> operator[](const bt2c::CStringView name) const noexcept
1185 return internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(),
1189 Shared shared() const noexcept
1191 return Shared::createWithRef(*this);
1195 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1196 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1198 namespace internal {
1200 struct StructureFieldClassTypeDescr
1202 using Const = ConstStructureFieldClass;
1203 using NonConst = StructureFieldClass;
1207 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1212 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1216 template <typename LibObjT>
1217 struct CommonArrayFieldClassSpec;
1219 /* Functions specific to mutable array field classes */
1221 struct CommonArrayFieldClassSpec<bt_field_class> final
1223 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1225 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1229 /* Functions specific to constant array field classes */
1231 struct CommonArrayFieldClassSpec<const bt_field_class> final
1233 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1235 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1239 } /* namespace internal */
1241 template <typename LibObjT>
1242 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1245 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1246 using _FieldClass = internal::DepFc<LibObjT>;
1249 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1252 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1253 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1255 explicit CommonArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1256 _ThisCommonFieldClass {libObjPtr}
1258 BT_ASSERT_DBG(this->isArray());
1261 template <typename OtherLibObjT>
1262 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1263 _ThisCommonFieldClass {fc}
1267 template <typename OtherLibObjT>
1268 CommonArrayFieldClass operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1270 _ThisCommonFieldClass::operator=(fc);
1274 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1276 return CommonArrayFieldClass<const bt_field_class> {*this};
1279 _FieldClass elementFieldClass() const noexcept
1281 return _FieldClass {
1282 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1285 Shared shared() const noexcept
1287 return Shared::createWithRef(*this);
1291 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1292 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1294 namespace internal {
1296 struct ArrayFieldClassTypeDescr
1298 using Const = ConstArrayFieldClass;
1299 using NonConst = ArrayFieldClass;
1303 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1308 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1312 } /* namespace internal */
1314 template <typename LibObjT>
1315 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1318 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1321 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1322 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1324 explicit CommonStaticArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1325 _ThisCommonArrayFieldClass {libObjPtr}
1327 BT_ASSERT_DBG(this->isStaticArray());
1330 template <typename OtherLibObjT>
1331 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1332 _ThisCommonArrayFieldClass {fc}
1336 template <typename OtherLibObjT>
1337 CommonStaticArrayFieldClass
1338 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1340 _ThisCommonArrayFieldClass::operator=(fc);
1344 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1346 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1349 std::uint64_t length() const noexcept
1351 return bt_field_class_array_static_get_length(this->libObjPtr());
1354 Shared shared() const noexcept
1356 return Shared::createWithRef(*this);
1360 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1361 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1363 namespace internal {
1365 struct StaticArrayFieldClassTypeDescr
1367 using Const = ConstStaticArrayFieldClass;
1368 using NonConst = StaticArrayFieldClass;
1372 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1377 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1381 } /* namespace internal */
1383 template <typename LibObjT>
1384 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1387 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1390 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1391 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1393 explicit CommonDynamicArrayWithLengthFieldClass(const LibObjPtr libObjPtr) noexcept :
1394 _ThisCommonArrayFieldClass {libObjPtr}
1396 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1399 template <typename OtherLibObjT>
1400 CommonDynamicArrayWithLengthFieldClass(
1401 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1402 _ThisCommonArrayFieldClass {fc}
1406 template <typename OtherLibObjT>
1407 CommonDynamicArrayWithLengthFieldClass
1408 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1410 _ThisCommonArrayFieldClass::operator=(fc);
1414 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1416 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1419 ConstFieldPath lengthFieldPath() const noexcept
1421 return ConstFieldPath {
1422 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1423 this->libObjPtr())};
1426 Shared shared() const noexcept
1428 return Shared::createWithRef(*this);
1432 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1434 using ConstDynamicArrayWithLengthFieldClass =
1435 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1437 namespace internal {
1439 struct DynamicArrayWithLengthFieldClassTypeDescr
1441 using Const = ConstDynamicArrayWithLengthFieldClass;
1442 using NonConst = DynamicArrayWithLengthFieldClass;
1446 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1447 public DynamicArrayWithLengthFieldClassTypeDescr
1452 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1453 public DynamicArrayWithLengthFieldClassTypeDescr
1457 template <typename LibObjT>
1458 struct CommonOptionFieldClassSpec;
1460 /* Functions specific to mutable option field classes */
1462 struct CommonOptionFieldClassSpec<bt_field_class> final
1464 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1466 return bt_field_class_option_borrow_field_class(libObjPtr);
1470 /* Functions specific to constant option field classes */
1472 struct CommonOptionFieldClassSpec<const bt_field_class> final
1474 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1476 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1480 } /* namespace internal */
1482 template <typename LibObjT>
1483 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1486 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1487 using _FieldClass = internal::DepFc<LibObjT>;
1490 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1493 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1494 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1496 explicit CommonOptionFieldClass(const LibObjPtr libObjPtr) noexcept :
1497 _ThisCommonFieldClass {libObjPtr}
1499 BT_ASSERT_DBG(this->isOption());
1502 template <typename OtherLibObjT>
1503 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1504 _ThisCommonFieldClass {fc}
1508 template <typename OtherLibObjT>
1509 CommonOptionFieldClass operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1511 _ThisCommonFieldClass::operator=(fc);
1515 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1517 return CommonOptionFieldClass<const bt_field_class> {*this};
1520 _FieldClass fieldClass() const noexcept
1522 return _FieldClass {
1523 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1526 Shared shared() const noexcept
1528 return Shared::createWithRef(*this);
1532 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1533 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1535 namespace internal {
1537 struct OptionFieldClassTypeDescr
1539 using Const = ConstOptionFieldClass;
1540 using NonConst = OptionFieldClass;
1544 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1549 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1553 } /* namespace internal */
1555 template <typename LibObjT>
1556 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1559 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1562 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1565 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1566 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1568 explicit CommonOptionWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1569 _ThisCommonOptionFieldClass {libObjPtr}
1571 BT_ASSERT_DBG(this->isOptionWithSelector());
1574 template <typename OtherLibObjT>
1575 CommonOptionWithSelectorFieldClass(
1576 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1577 _ThisCommonOptionFieldClass {fc}
1581 template <typename OtherLibObjT>
1582 CommonOptionWithSelectorFieldClass
1583 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1585 _ThisCommonOptionFieldClass::operator=(fc);
1589 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1591 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1594 ConstFieldPath selectorFieldPath() const noexcept
1596 return ConstFieldPath {
1597 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1598 this->libObjPtr())};
1601 Shared shared() const noexcept
1603 return Shared::createWithRef(*this);
1607 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1608 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1610 namespace internal {
1612 struct OptionWithSelectorFieldClassTypeDescr
1614 using Const = ConstOptionWithSelectorFieldClass;
1615 using NonConst = OptionWithSelectorFieldClass;
1619 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1624 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1628 } /* namespace internal */
1630 template <typename LibObjT>
1631 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1634 using typename CommonOptionWithSelectorFieldClass<
1635 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1638 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1639 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1641 explicit CommonOptionWithBoolSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1642 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1644 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1647 template <typename OtherLibObjT>
1648 CommonOptionWithBoolSelectorFieldClass(
1649 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1650 _ThisCommonOptionWithSelectorFieldClass {fc}
1654 template <typename OtherLibObjT>
1655 CommonOptionWithBoolSelectorFieldClass
1656 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1658 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1662 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1664 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1667 bool selectorIsReversed() const noexcept
1669 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1673 Shared shared() const noexcept
1675 return Shared::createWithRef(*this);
1679 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1681 using ConstOptionWithBoolSelectorFieldClass =
1682 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1684 namespace internal {
1686 struct OptionWithBoolSelectorFieldClassTypeDescr
1688 using Const = ConstOptionWithBoolSelectorFieldClass;
1689 using NonConst = OptionWithBoolSelectorFieldClass;
1693 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1694 public OptionWithBoolSelectorFieldClassTypeDescr
1699 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1700 public OptionWithBoolSelectorFieldClassTypeDescr
1704 template <typename RangeSetT>
1705 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1707 /* Functions specific to option field classes with unsigned integer ranges */
1709 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1711 static const bt_integer_range_set_unsigned *
1712 ranges(const bt_field_class * const libObjPtr) noexcept
1714 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1719 /* Functions specific to option field classes with signed ranges */
1721 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1723 static const bt_integer_range_set_signed *
1724 ranges(const bt_field_class * const libObjPtr) noexcept
1726 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1731 } /* namespace internal */
1733 template <typename LibObjT, typename RangeSetT>
1734 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1737 using typename CommonOptionWithSelectorFieldClass<
1738 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1741 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1742 using Shared = SharedFieldClass<CommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1743 using RangeSet = RangeSetT;
1745 explicit CommonOptionWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1746 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1748 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1751 template <typename OtherLibObjT>
1752 CommonOptionWithIntegerSelectorFieldClass(
1753 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1754 _ThisCommonOptionWithSelectorFieldClass {fc}
1758 template <typename OtherLibObjT>
1759 CommonOptionWithIntegerSelectorFieldClass
1760 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1762 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1766 RangeSet ranges() const noexcept
1768 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1769 this->libObjPtr())};
1772 Shared shared() const noexcept
1774 return Shared::createWithRef(*this);
1778 using OptionWithUnsignedIntegerSelectorFieldClass =
1779 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1781 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1782 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1784 using OptionWithSignedIntegerSelectorFieldClass =
1785 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1787 using ConstOptionWithSignedIntegerSelectorFieldClass =
1788 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1790 namespace internal {
1792 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1794 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1795 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1799 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1800 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1805 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1806 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1810 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1812 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1813 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1817 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1818 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1823 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1824 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1828 template <typename LibObjT>
1829 struct CommonVariantFieldClassOptionSpec;
1831 /* Functions specific to mutable variant field class options */
1833 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1835 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1837 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1840 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1842 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1846 /* Functions specific to constant variant field class options */
1848 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1850 static const bt_field_class *
1851 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1853 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1856 static const bt_value *
1857 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1859 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1863 } /* namespace internal */
1865 template <typename LibObjT>
1866 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1869 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1870 using _FieldClass = internal::DepFc<LibObjT>;
1873 using typename BorrowedObject<LibObjT>::LibObjPtr;
1874 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1876 explicit CommonVariantFieldClassOption(const LibObjPtr libObjPtr) noexcept :
1877 _ThisBorrowedObject {libObjPtr}
1881 template <typename OtherLibObjT>
1882 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1883 _ThisBorrowedObject {fc}
1887 template <typename OtherLibObjT>
1888 CommonVariantFieldClassOption
1889 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1891 _ThisBorrowedObject::operator=(fc);
1895 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1897 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1900 bt2c::CStringView name() const noexcept
1902 return bt_field_class_variant_option_get_name(this->libObjPtr());
1905 _FieldClass fieldClass() const noexcept
1907 return _FieldClass {
1908 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1911 template <typename LibValT>
1912 CommonVariantFieldClassOption
1913 userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1915 static_assert(!std::is_const<LibObjT>::value,
1916 "Not available with `bt2::ConstVariantFieldClassOption`.");
1918 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1922 UserAttributes userAttributes() const noexcept
1924 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1925 this->libObjPtr())};
1929 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1931 using ConstVariantFieldClassOption =
1932 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1934 namespace internal {
1936 struct VariantFieldClassOptionTypeDescr
1938 using Const = ConstVariantFieldClassOption;
1939 using NonConst = VariantFieldClassOption;
1943 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1948 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1952 template <typename LibObjT>
1953 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1955 /* Functions specific to variant field class options with unsigned integer selector */
1957 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1958 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1961 static const bt_integer_range_set_unsigned *
1962 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1963 * const libObjPtr) noexcept
1965 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1969 static const bt_field_class_variant_option *
1970 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1971 * const libObjPtr) noexcept
1973 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1978 /* Functions specific to variant field class options with signed integer selector */
1980 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1981 const bt_field_class_variant_with_selector_field_integer_signed_option>
1984 static const bt_integer_range_set_signed *
1985 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1986 * const libObjPtr) noexcept
1988 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1992 static const bt_field_class_variant_option *
1993 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1994 * const libObjPtr) noexcept
1996 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2001 } /* namespace internal */
2003 template <typename LibObjT>
2004 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2007 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2008 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2011 using typename BorrowedObject<LibObjT>::LibObjPtr;
2013 using RangeSet = typename std::conditional<
2016 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2017 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2019 explicit ConstVariantWithIntegerSelectorFieldClassOption(const LibObjPtr libObjPtr) noexcept :
2020 _ThisBorrowedObject {libObjPtr}
2024 template <typename OtherLibObjT>
2025 ConstVariantWithIntegerSelectorFieldClassOption(
2026 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2027 _ThisBorrowedObject {fc}
2031 template <typename OtherLibObjT>
2032 ConstVariantWithIntegerSelectorFieldClassOption
2033 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2035 _ThisBorrowedObject::operator=(fc);
2039 ConstVariantFieldClassOption asBaseOption() const noexcept
2041 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2044 bt2c::CStringView name() const noexcept
2046 return this->asBaseOption().name();
2049 ConstFieldClass fieldClass() const noexcept
2051 return this->asBaseOption().fieldClass();
2054 RangeSet ranges() const noexcept
2056 return RangeSet {_Spec::ranges(this->libObjPtr())};
2060 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2061 ConstVariantWithIntegerSelectorFieldClassOption<
2062 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2064 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2065 ConstVariantWithIntegerSelectorFieldClassOption<
2066 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2068 namespace internal {
2070 template <typename LibObjT>
2071 struct CommonVariantFieldClassSpec;
2073 /* Functions specific to mutable variant field classes */
2075 struct CommonVariantFieldClassSpec<bt_field_class> final
2077 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2078 const std::uint64_t index) noexcept
2080 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2083 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2084 const char * const name) noexcept
2086 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2090 /* Functions specific to constant variant field classes */
2092 struct CommonVariantFieldClassSpec<const bt_field_class> final
2094 static const bt_field_class_variant_option *
2095 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2097 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2100 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2101 const char * const name) noexcept
2103 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2107 } /* namespace internal */
2109 template <typename LibObjT>
2110 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2113 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2116 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2119 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2120 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2121 using Iterator = BorrowedObjectIterator<CommonVariantFieldClass>;
2124 internal::DepType<LibObjT, VariantFieldClassOption, ConstVariantFieldClassOption>;
2126 explicit CommonVariantFieldClass(const LibObjPtr libObjPtr) noexcept :
2127 _ThisCommonFieldClass {libObjPtr}
2129 BT_ASSERT_DBG(this->isVariant());
2132 template <typename OtherLibObjT>
2133 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2134 _ThisCommonFieldClass {fc}
2138 template <typename OtherLibObjT>
2139 CommonVariantFieldClass operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2141 _ThisCommonFieldClass::operator=(fc);
2145 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2147 return CommonVariantFieldClass<const bt_field_class> {*this};
2150 std::uint64_t length() const noexcept
2152 return bt_field_class_variant_get_option_count(this->libObjPtr());
2155 Iterator begin() const noexcept
2157 return Iterator {*this, 0};
2160 Iterator end() const noexcept
2162 return Iterator {*this, this->length()};
2165 Option operator[](const std::uint64_t index) const noexcept
2167 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2168 this->libObjPtr(), index)};
2171 OptionalBorrowedObject<Option> operator[](const bt2c::CStringView name) const noexcept
2173 return internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(),
2177 Shared shared() const noexcept
2179 return Shared::createWithRef(*this);
2183 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2184 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2186 namespace internal {
2188 struct VariantFieldClassTypeDescr
2190 using Const = ConstVariantFieldClass;
2191 using NonConst = VariantFieldClass;
2195 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2200 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2204 } /* namespace internal */
2206 template <typename LibObjT>
2207 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2210 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2213 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2214 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2216 explicit CommonVariantWithoutSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2217 _ThisCommonVariantFieldClass {libObjPtr}
2219 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2222 template <typename OtherLibObjT>
2223 CommonVariantWithoutSelectorFieldClass(
2224 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2225 _ThisCommonVariantFieldClass {fc}
2229 template <typename OtherLibObjT>
2230 CommonVariantWithoutSelectorFieldClass
2231 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2233 _ThisCommonVariantFieldClass::operator=(fc);
2237 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2239 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2242 CommonVariantWithoutSelectorFieldClass appendOption(const char * const name,
2243 const FieldClass fc) const
2245 static_assert(!std::is_const<LibObjT>::value,
2246 "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");
2248 const auto status = bt_field_class_variant_without_selector_append_option(
2249 this->libObjPtr(), name, fc.libObjPtr());
2252 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2253 throw MemoryError {};
2259 CommonVariantWithoutSelectorFieldClass appendOption(const bt2c::CStringView name,
2260 const FieldClass fc) const
2262 return this->appendOption(name.data(), fc);
2265 CommonVariantWithoutSelectorFieldClass appendOption(const bt2s::optional<std::string>& name,
2266 const FieldClass fc) const
2268 return this->appendOption(name ? name->data() : nullptr, fc);
2271 Shared shared() const noexcept
2273 return Shared::createWithRef(*this);
2277 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2278 using ConstVariantWithoutSelectorFieldClass =
2279 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2281 namespace internal {
2283 struct VariantWithoutSelectorFieldClassTypeDescr
2285 using Const = ConstVariantWithoutSelectorFieldClass;
2286 using NonConst = VariantWithoutSelectorFieldClass;
2290 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2291 public VariantWithoutSelectorFieldClassTypeDescr
2296 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2297 public VariantWithoutSelectorFieldClassTypeDescr
2301 template <typename OptionT>
2302 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2304 /* Functions specific to variant field classes with unsigned integer selector */
2306 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2307 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2310 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2311 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2313 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2317 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2318 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2320 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2324 static bt_field_class_variant_with_selector_field_integer_append_option_status
2325 appendOption(bt_field_class * const libObjPtr, const char * const name,
2326 bt_field_class * const libOptFcPtr,
2327 const bt_integer_range_set_unsigned * const libRangesPtr)
2329 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2330 libObjPtr, name, libOptFcPtr, libRangesPtr);
2334 /* Functions specific to variant field classes with signed integer selector */
2336 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2337 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2340 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2341 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2343 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2347 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2348 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2350 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2354 static bt_field_class_variant_with_selector_field_integer_append_option_status
2355 appendOption(bt_field_class * const libObjPtr, const char * const name,
2356 bt_field_class * const libOptFcPtr,
2357 const bt_integer_range_set_signed * const libRangesPtr)
2359 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2360 libObjPtr, name, libOptFcPtr, libRangesPtr);
2364 } /* namespace internal */
2366 template <typename LibObjT>
2367 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2370 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2373 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2376 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2377 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2379 explicit CommonVariantWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2380 _ThisCommonVariantFieldClass {libObjPtr}
2382 BT_ASSERT_DBG(this->isVariantWithSelector());
2385 template <typename OtherLibObjT>
2386 CommonVariantWithSelectorFieldClass(
2387 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2388 _ThisCommonVariantFieldClass {fc}
2392 template <typename OtherLibObjT>
2393 CommonVariantWithSelectorFieldClass
2394 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2396 _ThisCommonVariantFieldClass::operator=(fc);
2400 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2402 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2405 ConstFieldPath selectorFieldPath() const noexcept
2407 return ConstFieldPath {
2408 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2409 this->libObjPtr())};
2412 Shared shared() const noexcept
2414 return Shared::createWithRef(*this);
2418 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2419 using ConstVariantWithSelectorFieldClass =
2420 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2422 template <typename LibObjT, typename OptionT>
2423 class CommonVariantWithIntegerSelectorFieldClass :
2424 public CommonVariantWithSelectorFieldClass<LibObjT>
2427 using typename CommonVariantWithSelectorFieldClass<
2428 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2430 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2433 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2434 using Shared = SharedFieldClass<CommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2435 using Option = OptionT;
2438 BorrowedObjectIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>>;
2440 explicit CommonVariantWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2441 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2443 BT_ASSERT_DBG(this->isVariantWithIntegerSelector());
2446 template <typename OtherLibObjT>
2447 CommonVariantWithIntegerSelectorFieldClass(
2448 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2449 _ThisCommonVariantWithSelectorFieldClass {fc}
2453 template <typename OtherLibObjT>
2454 CommonVariantWithIntegerSelectorFieldClass
2455 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2457 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2461 Option operator[](const std::uint64_t index) const noexcept
2463 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2466 OptionalBorrowedObject<Option> operator[](const bt2c::CStringView name) const noexcept
2468 return _Spec::optionByName(this->libObjPtr(), name);
2471 CommonVariantWithIntegerSelectorFieldClass
2472 appendOption(const char * const name, const FieldClass fc,
2473 const typename Option::RangeSet ranges) const
2476 !std::is_const<LibObjT>::value,
2477 "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");
2480 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2483 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2484 throw MemoryError {};
2490 CommonVariantWithIntegerSelectorFieldClass
2491 appendOption(const bt2c::CStringView name, const FieldClass fc,
2492 const typename Option::RangeSet ranges) const
2494 return this->appendOption(name.data(), fc, ranges);
2497 CommonVariantWithIntegerSelectorFieldClass
2498 appendOption(const bt2s::optional<std::string>& name, const FieldClass fc,
2499 const typename Option::RangeSet ranges) const
2501 return this->appendOption(name ? name->data() : nullptr, fc, ranges);
2504 Iterator begin() const noexcept
2506 return Iterator {*this, 0};
2509 Iterator end() const noexcept
2511 return Iterator {*this, this->length()};
2514 Shared shared() const noexcept
2516 return Shared::createWithRef(*this);
2520 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2521 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2523 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2524 CommonVariantWithIntegerSelectorFieldClass<
2525 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2527 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2528 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2530 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2531 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2533 namespace internal {
2535 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2537 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2538 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2542 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2543 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2548 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2549 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2553 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2555 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2556 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2560 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2561 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2566 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2567 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2571 } /* namespace internal */
2573 template <typename LibObjT>
2574 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2576 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2579 template <typename LibObjT>
2580 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2582 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2585 template <typename LibObjT>
2586 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2588 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2591 template <typename LibObjT>
2592 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2593 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2595 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2596 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2600 template <typename LibObjT>
2601 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2602 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2604 BT_ASSERT_DBG(this->isSignedEnumeration());
2605 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2609 template <typename LibObjT>
2610 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2612 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2615 template <typename LibObjT>
2616 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2618 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2621 template <typename LibObjT>
2622 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2624 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2627 template <typename LibObjT>
2628 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2629 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2631 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2634 template <typename LibObjT>
2635 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2637 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2640 template <typename LibObjT>
2641 CommonOptionWithSelectorFieldClass<LibObjT>
2642 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2644 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2647 template <typename LibObjT>
2648 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2649 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2651 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2654 template <typename LibObjT>
2655 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2656 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2658 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2659 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2663 template <typename LibObjT>
2664 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2665 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2667 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2668 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2672 template <typename LibObjT>
2673 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2675 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2678 template <typename LibObjT>
2679 CommonVariantWithoutSelectorFieldClass<LibObjT>
2680 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2682 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2685 template <typename LibObjT>
2686 CommonVariantWithSelectorFieldClass<LibObjT>
2687 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2689 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2692 template <typename LibObjT>
2693 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2694 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2695 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2697 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2698 return CommonVariantWithIntegerSelectorFieldClass<
2699 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2702 template <typename LibObjT>
2703 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2704 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2705 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2707 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2708 return CommonVariantWithIntegerSelectorFieldClass<
2709 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2712 } /* namespace bt2 */
2714 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */