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
10 #include <type_traits>
12 #include <babeltrace2/babeltrace.h>
14 #include "common/assert.h"
15 #include "internal/borrowed-obj.hpp"
16 #include "internal/shared-obj.hpp"
17 #include "internal/utils.hpp"
18 #include "cpp-common/optional.hpp"
19 #include "cpp-common/string_view.hpp"
20 #include "common-iter.hpp"
21 #include "lib-error.hpp"
22 #include "integer-range-set.hpp"
23 #include "field-path.hpp"
29 struct FieldClassRefFuncs final
31 static void get(const bt_field_class * const libObjPtr)
33 bt_field_class_get_ref(libObjPtr);
36 static void put(const bt_field_class * const libObjPtr)
38 bt_field_class_put_ref(libObjPtr);
42 template <typename ObjT, typename LibObjT>
43 using SharedFieldClass = internal::SharedObj<ObjT, LibObjT, internal::FieldClassRefFuncs>;
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 LibObjT>
71 class CommonBitArrayFieldClass;
73 template <typename LibObjT>
74 class CommonIntegerFieldClass;
76 template <typename LibObjT>
77 class ConstEnumerationFieldClassMapping;
79 template <typename LibObjT>
80 class CommonBaseEnumerationFieldClass;
82 template <typename LibObjT, typename MappingT>
83 class CommonEnumerationFieldClass;
85 template <typename LibObjT>
86 class CommonStructureFieldClass;
88 template <typename LibObjT>
89 class CommonArrayFieldClass;
91 template <typename LibObjT>
92 class CommonStaticArrayFieldClass;
94 template <typename LibObjT>
95 class CommonDynamicArrayWithLengthFieldClass;
97 template <typename LibObjT>
98 class CommonOptionFieldClass;
100 template <typename LibObjT>
101 class CommonOptionWithSelectorFieldClass;
103 template <typename LibObjT>
104 class CommonOptionWithBoolSelectorFieldClass;
106 template <typename LibObjT>
107 class CommonVariantFieldClass;
109 template <typename LibObjT, typename RangeSetT>
110 class CommonOptionWithIntegerSelectorFieldClass;
112 template <typename LibObjT>
113 class CommonVariantWithoutSelectorFieldClass;
115 template <typename LibObjT>
116 class CommonVariantWithSelectorFieldClass;
118 template <typename LibObjT>
119 class ConstVariantWithIntegerSelectorFieldClassOption;
121 template <typename LibObjT, typename RangeSetT>
122 class CommonVariantWithIntegerSelectorFieldClass;
124 template <typename LibObjT>
125 class CommonEventClass;
127 template <typename LibObjT>
128 class CommonStreamClass;
130 template <typename LibObjT>
131 class CommonTraceClass;
133 enum class FieldClassType
135 BOOL = BT_FIELD_CLASS_TYPE_BOOL,
136 BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
137 UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
138 SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
139 UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
140 SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
141 SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
142 DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
143 STRING = BT_FIELD_CLASS_TYPE_STRING,
144 STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
145 STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
146 DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
147 DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
148 OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
149 OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
150 OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
151 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
152 OPTION_WITH_SIGNED_INTEGER_SELECTOR =
153 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
154 VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
155 VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
156 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
157 VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
158 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
161 template <typename LibObjT>
162 class CommonFieldClass : public internal::BorrowedObj<LibObjT>
164 /* Allow appendMember() to call `fc.libObjPtr()` */
165 friend class CommonStructureFieldClass<bt_field_class>;
167 /* Allow appendOption() to call `fc.libObjPtr()` */
168 friend class CommonVariantWithoutSelectorFieldClass<bt_field_class>;
170 friend class CommonVariantWithIntegerSelectorFieldClass<
172 ConstVariantWithIntegerSelectorFieldClassOption<
173 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>;
175 friend class CommonVariantWithIntegerSelectorFieldClass<
177 ConstVariantWithIntegerSelectorFieldClassOption<
178 const bt_field_class_variant_with_selector_field_integer_signed_option>>;
180 /* Allow *FieldClass() to call `fc.libObjPtr()` */
181 friend class CommonEventClass<bt_event_class>;
182 friend class CommonStreamClass<bt_stream_class>;
184 /* Allow create*FieldClass() to call `fc.libObjPtr()` */
185 friend class CommonTraceClass<bt_trace_class>;
188 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
191 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
192 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
195 using Shared = internal::SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
197 using UserAttributes =
198 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
200 explicit CommonFieldClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObj {libObjPtr}
204 template <typename OtherLibObjT>
205 CommonFieldClass(const CommonFieldClass<OtherLibObjT>& fc) noexcept : _ThisBorrowedObj {fc}
209 template <typename OtherLibObjT>
210 CommonFieldClass& operator=(const CommonFieldClass<OtherLibObjT>& fc) noexcept
212 _ThisBorrowedObj::operator=(fc);
216 FieldClassType type() const noexcept
218 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
221 bool isBool() const noexcept
223 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
226 bool isBitArray() const noexcept
228 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
231 bool isInteger() const noexcept
233 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
236 bool isUnsignedInteger() const noexcept
238 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
241 bool isSignedInteger() const noexcept
243 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
246 bool isEnumeration() const noexcept
248 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
251 bool isUnsignedEnumeration() const noexcept
253 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
256 bool isSignedEnumeration() const noexcept
258 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
261 bool isReal() const noexcept
263 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
266 bool isSinglePrecisionReal() const noexcept
268 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
271 bool isDoublePrecisionReal() const noexcept
273 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
276 bool isString() const noexcept
278 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
281 bool isStructure() const noexcept
283 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
286 bool isArray() const noexcept
288 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
291 bool isStaticArray() const noexcept
293 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
296 bool isDynamicArray() const noexcept
298 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
301 bool isDynamicArrayWithoutLength() const noexcept
303 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
306 bool isDynamicArrayWithLength() const noexcept
308 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
311 bool isOption() const noexcept
313 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
316 bool isOptionWithoutSelector() const noexcept
318 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
321 bool isOptionWithSelector() const noexcept
323 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
326 bool isOptionWithBoolSelector() const noexcept
328 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
331 bool isOptionWithIntegerSelector() const noexcept
333 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
336 bool isOptionWithUnsignedIntegerSelector() const noexcept
338 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
341 bool isOptionWithSignedIntegerSelector() const noexcept
343 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
346 bool isVariant() const noexcept
348 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
351 bool isVariantWithoutSelector() const noexcept
353 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
356 bool isVariantWithSelector() const noexcept
358 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
361 bool isVariantWithIntegerSelector() const noexcept
363 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
366 bool isVariantWithUnsignedIntegerSelector() const noexcept
368 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
371 bool isVariantWithSignedIntegerSelector() const noexcept
373 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
376 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
377 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
378 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
379 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
380 const bt_field_class_enumeration_unsigned_mapping>>
381 asUnsignedEnumeration() const noexcept;
383 CommonEnumerationFieldClass<
384 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
385 asSignedEnumeration() const noexcept;
387 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
388 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
389 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
390 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
391 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
392 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
393 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
395 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
396 asOptionWithUnsignedIntegerSelector() const noexcept;
398 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
399 asOptionWithSignedIntegerSelector() const noexcept;
401 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
402 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
403 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
405 CommonVariantWithIntegerSelectorFieldClass<
406 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
407 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
408 asVariantWithUnsignedIntegerSelector() const noexcept;
410 CommonVariantWithIntegerSelectorFieldClass<
411 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
412 const bt_field_class_variant_with_selector_field_integer_signed_option>>
413 asVariantWithSignedIntegerSelector() const noexcept;
415 template <typename LibValT>
416 void userAttributes(const CommonMapValue<LibValT>& userAttrs)
418 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
420 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
423 ConstMapValue userAttributes() const noexcept
425 return ConstMapValue {internal::CommonFieldClassSpec<const bt_field_class>::userAttributes(
429 UserAttributes userAttributes() noexcept
431 return UserAttributes {
432 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
435 Shared shared() const noexcept
437 return Shared::createWithRef(*this);
441 bool _libTypeIs(const bt_field_class_type type) const noexcept
443 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
447 using FieldClass = CommonFieldClass<bt_field_class>;
448 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
452 struct FieldClassTypeDescr
454 using Const = ConstFieldClass;
455 using NonConst = FieldClass;
459 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
464 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
468 } /* namespace internal */
470 template <typename LibObjT>
471 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
474 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
475 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
478 using Shared = internal::SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
480 explicit CommonBitArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
481 _ThisCommonFieldClass {libObjPtr}
483 BT_ASSERT_DBG(this->isBitArray());
486 template <typename OtherLibObjT>
487 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept :
488 _ThisCommonFieldClass {fc}
492 template <typename OtherLibObjT>
493 CommonBitArrayFieldClass<LibObjT>&
494 operator=(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept
496 _ThisCommonFieldClass::operator=(fc);
500 std::uint64_t length() const noexcept
502 return bt_field_class_bit_array_get_length(this->libObjPtr());
505 Shared shared() const noexcept
507 return Shared::createWithRef(*this);
511 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
512 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
516 struct BitArrayFieldClassTypeDescr
518 using Const = ConstBitArrayFieldClass;
519 using NonConst = BitArrayFieldClass;
523 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
528 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
532 } /* namespace internal */
534 enum class DisplayBase
536 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
537 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
538 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
539 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
542 template <typename LibObjT>
543 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
546 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
549 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
550 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
553 using Shared = internal::SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
555 explicit CommonIntegerFieldClass(const _LibObjPtr libObjPtr) noexcept :
556 _ThisCommonFieldClass {libObjPtr}
558 BT_ASSERT_DBG(this->isInteger());
561 template <typename OtherLibObjT>
562 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept :
563 _ThisCommonFieldClass {fc}
567 template <typename OtherLibObjT>
568 CommonIntegerFieldClass& operator=(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept
570 _ThisCommonFieldClass::operator=(fc);
574 void fieldValueRange(const std::uint64_t n) noexcept
576 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
578 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
581 std::uint64_t fieldValueRange() const noexcept
583 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
586 void preferredDisplayBase(const DisplayBase base) noexcept
588 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
590 bt_field_class_integer_set_preferred_display_base(
591 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
594 DisplayBase preferredDisplayBase() const noexcept
596 return static_cast<DisplayBase>(
597 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
600 Shared shared() const noexcept
602 return Shared::createWithRef(*this);
606 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
607 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
611 struct IntegerFieldClassTypeDescr
613 using Const = ConstIntegerFieldClass;
614 using NonConst = IntegerFieldClass;
618 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
623 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
627 } /* namespace internal */
631 template <typename LibObjT>
632 struct ConstEnumerationFieldClassMappingSpec;
634 /* Functions specific to unsigned enumeration field class mappings */
636 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
639 static const bt_integer_range_set_unsigned *
640 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
642 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
646 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
648 return bt_field_class_enumeration_mapping_get_label(
649 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
653 /* Functions specific to signed enumeration field class mappings */
655 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
657 static const bt_integer_range_set_signed *
658 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
660 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
664 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
666 return bt_field_class_enumeration_mapping_get_label(
667 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
671 } /* namespace internal */
673 template <typename LibObjT>
674 class ConstEnumerationFieldClassMapping final : public internal::BorrowedObj<LibObjT>
677 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
678 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
681 using RangeSet = typename std::conditional<
682 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
683 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
685 explicit ConstEnumerationFieldClassMapping(const _LibObjPtr libObjPtr) noexcept :
686 _ThisBorrowedObj {libObjPtr}
690 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
691 _ThisBorrowedObj {mapping}
695 ConstEnumerationFieldClassMapping&
696 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
698 _ThisBorrowedObj::operator=(mapping);
702 RangeSet ranges() const noexcept
705 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
708 bpstd::string_view label() const noexcept
710 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
714 using ConstUnsignedEnumerationFieldClassMapping =
715 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
717 using ConstSignedEnumerationFieldClassMapping =
718 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
722 template <typename MappingT>
723 struct CommonEnumerationFieldClassSpec;
725 /* Functions specific to unsigned enumeration field classes */
727 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
729 static const bt_field_class_enumeration_unsigned_mapping *
730 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
732 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
735 static const bt_field_class_enumeration_unsigned_mapping *
736 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
738 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
741 static bt_field_class_enumeration_add_mapping_status
742 addMapping(bt_field_class * const libObjPtr, const char * const label,
743 const bt_integer_range_set_unsigned * const libRanges) noexcept
745 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
749 /* Functions specific to signed enumeration field classes */
751 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
753 static const bt_field_class_enumeration_signed_mapping *
754 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
756 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
759 static const bt_field_class_enumeration_signed_mapping *
760 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
762 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
765 static bt_field_class_enumeration_add_mapping_status
766 addMapping(bt_field_class * const libObjPtr, const char * const label,
767 const bt_integer_range_set_signed * const libRanges) noexcept
769 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
773 } /* namespace internal */
775 template <typename LibObjT>
776 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
779 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
782 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
783 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
786 using Shared = internal::SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
788 explicit CommonBaseEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
789 _ThisCommonIntegerFieldClass {libObjPtr}
791 BT_ASSERT_DBG(this->isEnumeration());
794 template <typename OtherLibObjT>
795 CommonBaseEnumerationFieldClass(
796 const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept :
797 _ThisCommonIntegerFieldClass {fc}
801 template <typename OtherLibObjT>
802 CommonBaseEnumerationFieldClass&
803 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept
805 _ThisCommonIntegerFieldClass::operator=(fc);
809 std::uint64_t size() 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 CommonFieldClass<LibObjT>::_LibObjPtr;
825 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
826 using _ThisCommonEnumerationFieldClass = CommonEnumerationFieldClass<LibObjT, MappingT>;
829 using Shared = internal::SharedFieldClass<_ThisCommonEnumerationFieldClass, LibObjT>;
830 using Iterator = CommonIterator<CommonEnumerationFieldClass, MappingT>;
831 using Mapping = MappingT;
833 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
834 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
836 BT_ASSERT_DBG(this->isEnumeration());
839 template <typename OtherLibObjT>
840 CommonEnumerationFieldClass(
841 const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept :
842 _ThisCommonEnumerationFieldClass {fc}
846 template <typename OtherLibObjT>
847 CommonEnumerationFieldClass&
848 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept
850 _ThisCommonEnumerationFieldClass::operator=(fc);
854 Mapping operator[](const std::uint64_t index) const noexcept
856 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
857 this->libObjPtr(), index)};
860 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
862 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
863 this->libObjPtr(), label);
866 return Mapping {libObjPtr};
869 return nonstd::nullopt;
872 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
874 return (*this)[label.data()];
877 void addMapping(const char * const label, const typename Mapping::RangeSet ranges)
879 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
880 this->libObjPtr(), label, ranges.libObjPtr());
882 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
883 throw LibMemoryError {};
887 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges)
889 this->addMapping(label.data(), ranges);
892 Iterator begin() const noexcept
894 return Iterator {*this, 0};
897 Iterator end() const noexcept
899 return Iterator {*this, this->size()};
902 Shared shared() const noexcept
904 return Shared::createWithRef(*this);
908 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
909 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
911 using UnsignedEnumerationFieldClass =
912 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
914 using ConstUnsignedEnumerationFieldClass =
915 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
917 using SignedEnumerationFieldClass =
918 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
920 using ConstSignedEnumerationFieldClass =
921 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
925 struct UnsignedEnumerationFieldClassTypeDescr
927 using Const = ConstUnsignedEnumerationFieldClass;
928 using NonConst = UnsignedEnumerationFieldClass;
932 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
937 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
941 struct SignedEnumerationFieldClassTypeDescr
943 using Const = ConstSignedEnumerationFieldClass;
944 using NonConst = SignedEnumerationFieldClass;
948 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
953 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
957 template <typename LibObjT>
958 struct CommonStructureFieldClassMemberSpec;
960 /* Functions specific to mutable structure field class members */
962 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
964 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
966 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
970 /* Functions specific to constant structure field class members */
972 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
974 static const bt_field_class *
975 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
977 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
981 } /* namespace internal */
983 template <typename LibObjT>
984 class CommonStructureFieldClassMember final : public internal::BorrowedObj<LibObjT>
987 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
988 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
991 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
994 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
995 _ThisBorrowedObj {libObjPtr}
999 template <typename OtherLibObjT>
1000 CommonStructureFieldClassMember(
1001 const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept :
1002 _ThisBorrowedObj {fc}
1006 template <typename OtherLibObjT>
1007 CommonStructureFieldClassMember<LibObjT>&
1008 operator=(const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept
1010 _ThisBorrowedObj::operator=(fc);
1014 bpstd::string_view name() const noexcept
1016 return bt_field_class_structure_member_get_name(this->libObjPtr());
1019 ConstFieldClass fieldClass() const noexcept
1021 return ConstFieldClass {internal::CommonStructureFieldClassMemberSpec<
1022 const bt_field_class_structure_member>::fieldClass(this->libObjPtr())};
1025 _FieldClass fieldClass() noexcept
1027 return _FieldClass {
1028 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1032 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1034 using ConstStructureFieldClassMember =
1035 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1037 namespace internal {
1039 struct StructureFieldClassMemberTypeDescr
1041 using Const = ConstStructureFieldClassMember;
1042 using NonConst = StructureFieldClassMember;
1046 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1051 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1055 template <typename LibObjT>
1056 struct CommonStructureFieldClassSpec;
1058 /* Functions specific to mutable structure field classes */
1060 struct CommonStructureFieldClassSpec<bt_field_class> final
1062 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1063 const std::uint64_t index) noexcept
1065 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1068 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1069 const char * const name) noexcept
1071 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1075 /* Functions specific to constant structure field classes */
1077 struct CommonStructureFieldClassSpec<const bt_field_class> final
1079 static const bt_field_class_structure_member *
1080 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1082 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1085 static const bt_field_class_structure_member *
1086 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1088 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1092 } /* namespace internal */
1094 template <typename LibObjT>
1095 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1098 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1099 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1102 using Shared = internal::SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1104 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1105 StructureFieldClassMember>::type;
1107 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1109 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1110 _ThisCommonFieldClass {libObjPtr}
1112 BT_ASSERT_DBG(this->isStructure());
1115 template <typename OtherLibObjT>
1116 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept :
1117 _ThisCommonFieldClass {fc}
1121 template <typename OtherLibObjT>
1122 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept
1124 _ThisCommonFieldClass::operator=(fc);
1128 void appendMember(const char * const name, const FieldClass& fc)
1130 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1133 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1135 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1136 throw LibMemoryError {};
1140 void appendMember(const std::string& name, const FieldClass& fc)
1142 this->appendMember(name.data(), fc);
1145 std::uint64_t size() const noexcept
1147 return bt_field_class_structure_get_member_count(this->libObjPtr());
1150 Iterator begin() const noexcept
1152 return Iterator {*this, 0};
1155 Iterator end() const noexcept
1157 return Iterator {*this, this->size()};
1160 ConstStructureFieldClassMember operator[](const std::uint64_t index) const noexcept
1162 return ConstStructureFieldClassMember {
1163 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByIndex(
1164 this->libObjPtr(), index)};
1167 Member operator[](const std::uint64_t index) noexcept
1169 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1170 this->libObjPtr(), index)};
1173 nonstd::optional<ConstStructureFieldClassMember>
1174 operator[](const char * const name) const noexcept
1176 const auto libObjPtr =
1177 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByName(
1178 this->libObjPtr(), name);
1181 return ConstStructureFieldClassMember {libObjPtr};
1184 return nonstd::nullopt;
1187 nonstd::optional<ConstStructureFieldClassMember>
1188 operator[](const std::string& name) const noexcept
1190 return (*this)[name.data()];
1193 nonstd::optional<Member> operator[](const char * const name) noexcept
1195 const auto libObjPtr =
1196 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1199 return Member {libObjPtr};
1202 return nonstd::nullopt;
1205 nonstd::optional<Member> operator[](const std::string& name) noexcept
1207 return (*this)[name.data()];
1210 Shared shared() const noexcept
1212 return Shared::createWithRef(*this);
1216 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1217 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1219 namespace internal {
1221 struct StructureFieldClassTypeDescr
1223 using Const = ConstStructureFieldClass;
1224 using NonConst = StructureFieldClass;
1228 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1233 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1237 template <typename LibObjT>
1238 struct CommonArrayFieldClassSpec;
1240 /* Functions specific to mutable array field classes */
1242 struct CommonArrayFieldClassSpec<bt_field_class> final
1244 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1246 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1250 /* Functions specific to constant array field classes */
1252 struct CommonArrayFieldClassSpec<const bt_field_class> final
1254 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1256 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1260 } /* namespace internal */
1262 template <typename LibObjT>
1263 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1266 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1269 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1272 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1273 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1276 using Shared = internal::SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1278 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1279 _ThisCommonFieldClass {libObjPtr}
1281 BT_ASSERT_DBG(this->isArray());
1284 template <typename OtherLibObjT>
1285 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept :
1286 _ThisCommonFieldClass {fc}
1290 template <typename OtherLibObjT>
1291 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept
1293 _ThisCommonFieldClass::operator=(fc);
1297 ConstFieldClass elementFieldClass() const noexcept
1299 return ConstFieldClass {
1300 internal::CommonArrayFieldClassSpec<const bt_field_class>::elementFieldClass(
1301 this->libObjPtr())};
1304 _FieldClass elementFieldClass() noexcept
1306 return _FieldClass {
1307 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1310 Shared shared() const noexcept
1312 return Shared::createWithRef(*this);
1316 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1317 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1319 namespace internal {
1321 struct ArrayFieldClassTypeDescr
1323 using Const = ConstArrayFieldClass;
1324 using NonConst = ArrayFieldClass;
1328 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1333 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1337 } /* namespace internal */
1339 template <typename LibObjT>
1340 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1343 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1344 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1347 using Shared = internal::SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1349 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1350 _ThisCommonArrayFieldClass {libObjPtr}
1352 BT_ASSERT_DBG(this->isStaticArray());
1355 template <typename OtherLibObjT>
1356 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept :
1357 _ThisCommonArrayFieldClass {fc}
1361 template <typename OtherLibObjT>
1362 CommonStaticArrayFieldClass&
1363 operator=(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept
1365 _ThisCommonArrayFieldClass::operator=(fc);
1369 std::uint64_t length() const noexcept
1371 return bt_field_class_array_static_get_length(this->libObjPtr());
1374 Shared shared() const noexcept
1376 return Shared::createWithRef(*this);
1380 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1381 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1383 namespace internal {
1385 struct StaticArrayFieldClassTypeDescr
1387 using Const = ConstStaticArrayFieldClass;
1388 using NonConst = StaticArrayFieldClass;
1392 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1397 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1401 } /* namespace internal */
1403 template <typename LibObjT>
1404 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1407 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1408 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1412 internal::SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1414 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1415 _ThisCommonArrayFieldClass {libObjPtr}
1417 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1420 template <typename OtherLibObjT>
1421 CommonDynamicArrayWithLengthFieldClass(
1422 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept :
1423 _ThisCommonArrayFieldClass {fc}
1427 template <typename OtherLibObjT>
1428 CommonDynamicArrayWithLengthFieldClass&
1429 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept
1431 _ThisCommonArrayFieldClass::operator=(fc);
1435 ConstFieldPath lengthFieldPath() const noexcept
1437 return ConstFieldPath {
1438 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1439 this->libObjPtr())};
1442 Shared shared() const noexcept
1444 return Shared::createWithRef(*this);
1448 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1450 using ConstDynamicArrayWithLengthFieldClass =
1451 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1453 namespace internal {
1455 struct DynamicArrayWithLengthFieldClassTypeDescr
1457 using Const = ConstDynamicArrayWithLengthFieldClass;
1458 using NonConst = DynamicArrayWithLengthFieldClass;
1462 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1463 public DynamicArrayWithLengthFieldClassTypeDescr
1468 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1469 public DynamicArrayWithLengthFieldClassTypeDescr
1473 template <typename LibObjT>
1474 struct CommonOptionFieldClassSpec;
1476 /* Functions specific to mutable option field classes */
1478 struct CommonOptionFieldClassSpec<bt_field_class> final
1480 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1482 return bt_field_class_option_borrow_field_class(libObjPtr);
1486 /* Functions specific to constant option field classes */
1488 struct CommonOptionFieldClassSpec<const bt_field_class> final
1490 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1492 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1496 } /* namespace internal */
1498 template <typename LibObjT>
1499 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1502 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1505 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1508 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1509 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1512 using Shared = internal::SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1514 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1515 _ThisCommonFieldClass {libObjPtr}
1517 BT_ASSERT_DBG(this->isOption());
1520 template <typename OtherLibObjT>
1521 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept :
1522 _ThisCommonFieldClass {fc}
1526 template <typename OtherLibObjT>
1527 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept
1529 _ThisCommonFieldClass::operator=(fc);
1533 ConstFieldClass fieldClass() const noexcept
1535 return ConstFieldClass {
1536 internal::CommonOptionFieldClassSpec<const bt_field_class>::fieldClass(
1537 this->libObjPtr())};
1540 _FieldClass fieldClass() noexcept
1542 return _FieldClass {
1543 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1546 Shared shared() const noexcept
1548 return Shared::createWithRef(*this);
1552 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1553 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1555 namespace internal {
1557 struct OptionFieldClassTypeDescr
1559 using Const = ConstOptionFieldClass;
1560 using NonConst = OptionFieldClass;
1564 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1569 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1573 } /* namespace internal */
1575 template <typename LibObjT>
1576 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1579 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1582 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1583 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1586 using Shared = internal::SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1588 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1589 _ThisCommonOptionFieldClass {libObjPtr}
1591 BT_ASSERT_DBG(this->isOptionWithSelector());
1594 template <typename OtherLibObjT>
1595 CommonOptionWithSelectorFieldClass(
1596 const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1597 _ThisCommonOptionFieldClass {fc}
1601 template <typename OtherLibObjT>
1602 CommonOptionWithSelectorFieldClass&
1603 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
1605 _ThisCommonOptionFieldClass::operator=(fc);
1609 ConstFieldPath selectorFieldPath() const noexcept
1611 return ConstFieldPath {
1612 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1613 this->libObjPtr())};
1616 Shared shared() const noexcept
1618 return Shared::createWithRef(*this);
1622 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1623 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1625 namespace internal {
1627 struct OptionWithSelectorFieldClassTypeDescr
1629 using Const = ConstOptionWithSelectorFieldClass;
1630 using NonConst = OptionWithSelectorFieldClass;
1634 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1639 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1643 } /* namespace internal */
1645 template <typename LibObjT>
1646 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1649 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1651 using typename CommonOptionWithSelectorFieldClass<
1652 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1656 internal::SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1658 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1659 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1661 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1664 template <typename OtherLibObjT>
1665 CommonOptionWithBoolSelectorFieldClass(
1666 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1667 _ThisCommonOptionWithSelectorFieldClass {fc}
1671 template <typename OtherLibObjT>
1672 CommonOptionWithBoolSelectorFieldClass&
1673 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept
1675 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1679 bool selectorIsReversed() const noexcept
1681 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1685 Shared shared() const noexcept
1687 return Shared::createWithRef(*this);
1691 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1693 using ConstOptionWithBoolSelectorFieldClass =
1694 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1696 namespace internal {
1698 struct OptionWithBoolSelectorFieldClassTypeDescr
1700 using Const = ConstOptionWithBoolSelectorFieldClass;
1701 using NonConst = OptionWithBoolSelectorFieldClass;
1705 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1706 public OptionWithBoolSelectorFieldClassTypeDescr
1711 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1712 public OptionWithBoolSelectorFieldClassTypeDescr
1716 template <typename RangeSetT>
1717 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1719 /* Functions specific to option field classes with unsigned integer ranges */
1721 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1723 static const bt_integer_range_set_unsigned *
1724 ranges(const bt_field_class * const libObjPtr) noexcept
1726 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1731 /* Functions specific to option field classes with signed ranges */
1733 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1735 static const bt_integer_range_set_signed *
1736 ranges(const bt_field_class * const libObjPtr) noexcept
1738 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1743 } /* namespace internal */
1745 template <typename LibObjT, typename RangeSetT>
1746 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1749 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1751 using typename CommonOptionWithSelectorFieldClass<
1752 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1754 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1755 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1759 internal::SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1761 using RangeSet = RangeSetT;
1763 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1764 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1766 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1769 template <typename OtherLibObjT>
1770 CommonOptionWithIntegerSelectorFieldClass(
1771 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept :
1772 _ThisCommonOptionWithSelectorFieldClass {fc}
1776 template <typename OtherLibObjT>
1777 CommonOptionWithIntegerSelectorFieldClass&
1778 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept
1780 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1784 RangeSet ranges() const noexcept
1786 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1787 this->libObjPtr())};
1790 Shared shared() const noexcept
1792 return Shared::createWithRef(*this);
1796 using OptionWithUnsignedIntegerSelectorFieldClass =
1797 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1799 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1800 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1802 using OptionWithSignedIntegerSelectorFieldClass =
1803 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1805 using ConstOptionWithSignedIntegerSelectorFieldClass =
1806 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1808 namespace internal {
1810 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1812 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1813 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1817 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1818 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1823 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1824 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1828 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1830 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1831 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1835 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1836 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1841 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1842 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1846 template <typename LibObjT>
1847 struct CommonVariantFieldClassOptionSpec;
1849 /* Functions specific to mutable variant field class options */
1851 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1853 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1855 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1859 /* Functions specific to constant variant field class options */
1861 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1863 static const bt_field_class *
1864 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1866 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1870 } /* namespace internal */
1872 template <typename LibObjT>
1873 class CommonVariantFieldClassOption : public internal::BorrowedObj<LibObjT>
1876 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1877 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1880 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1883 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1884 _ThisBorrowedObj {libObjPtr}
1888 template <typename OtherLibObjT>
1889 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept :
1890 _ThisBorrowedObj {fc}
1894 template <typename OtherLibObjT>
1895 CommonVariantFieldClassOption&
1896 operator=(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept
1898 _ThisBorrowedObj::operator=(fc);
1902 bpstd::string_view name() const noexcept
1904 return bt_field_class_variant_option_get_name(this->libObjPtr());
1907 ConstFieldClass fieldClass() const noexcept
1909 return ConstFieldClass {internal::CommonVariantFieldClassOptionSpec<
1910 const bt_field_class_variant_option>::fieldClass(this->libObjPtr())};
1913 _FieldClass fieldClass() noexcept
1915 return _FieldClass {
1916 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1920 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1922 using ConstVariantFieldClassOption =
1923 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1925 namespace internal {
1927 struct VariantFieldClassOptionTypeDescr
1929 using Const = ConstVariantFieldClassOption;
1930 using NonConst = VariantFieldClassOption;
1934 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1939 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1943 template <typename LibObjT>
1944 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1946 /* Functions specific to variant field class options with unsigned integer selector */
1948 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1949 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1952 static const bt_integer_range_set_unsigned *
1953 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1954 * const libObjPtr) noexcept
1956 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1960 static const bt_field_class_variant_option *
1961 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1962 * const libObjPtr) noexcept
1964 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1969 /* Functions specific to variant field class options with signed integer selector */
1971 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1972 const bt_field_class_variant_with_selector_field_integer_signed_option>
1975 static const bt_integer_range_set_signed *
1976 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1977 * const libObjPtr) noexcept
1979 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1983 static const bt_field_class_variant_option *
1984 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1985 * const libObjPtr) noexcept
1987 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
1992 } /* namespace internal */
1994 template <typename LibObjT>
1995 class ConstVariantWithIntegerSelectorFieldClassOption : public internal::BorrowedObj<LibObjT>
1998 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1999 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
2000 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2003 using RangeSet = typename std::conditional<
2006 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2007 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2009 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2010 _ThisBorrowedObj {libObjPtr}
2014 template <typename OtherLibObjT>
2015 ConstVariantWithIntegerSelectorFieldClassOption(
2016 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept :
2017 _ThisBorrowedObj {fc}
2021 template <typename OtherLibObjT>
2022 ConstVariantWithIntegerSelectorFieldClassOption&
2023 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept
2025 _ThisBorrowedObj::operator=(fc);
2029 ConstVariantFieldClassOption asBaseOption() const noexcept
2031 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2034 bpstd::string_view name() const noexcept
2036 return this->asBaseOption().name();
2039 ConstFieldClass fieldClass() const noexcept
2041 return this->asBaseOption().fieldClass();
2044 RangeSet ranges() const noexcept
2046 return RangeSet {_Spec::ranges(this->libObjPtr())};
2050 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2051 ConstVariantWithIntegerSelectorFieldClassOption<
2052 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2054 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2055 ConstVariantWithIntegerSelectorFieldClassOption<
2056 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2058 namespace internal {
2060 template <typename LibObjT>
2061 struct CommonVariantFieldClassSpec;
2063 /* Functions specific to mutable variant field classes */
2065 struct CommonVariantFieldClassSpec<bt_field_class> final
2067 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2068 const std::uint64_t index) noexcept
2070 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2073 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2074 const char * const name) noexcept
2076 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2080 /* Functions specific to constant variant field classes */
2082 struct CommonVariantFieldClassSpec<const bt_field_class> final
2084 static const bt_field_class_variant_option *
2085 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2087 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2090 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2091 const char * const name) noexcept
2093 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2097 } /* namespace internal */
2099 template <typename LibObjT>
2100 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2103 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2106 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2107 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2110 using Shared = internal::SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2113 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2114 VariantFieldClassOption>::type;
2116 using Iterator = CommonIterator<CommonVariantFieldClass, Option>;
2118 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2119 _ThisCommonFieldClass {libObjPtr}
2121 BT_ASSERT_DBG(this->isVariant());
2124 template <typename OtherLibObjT>
2125 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept :
2126 _ThisCommonFieldClass {fc}
2130 template <typename OtherLibObjT>
2131 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept
2133 _ThisCommonFieldClass::operator=(fc);
2137 std::uint64_t size() const noexcept
2139 return bt_field_class_variant_get_option_count(this->libObjPtr());
2142 Iterator begin() const noexcept
2144 return Iterator {*this, 0};
2147 Iterator end() const noexcept
2149 return Iterator {*this, this->size()};
2152 ConstVariantFieldClassOption operator[](const std::uint64_t index) const noexcept
2154 return ConstVariantFieldClassOption {
2155 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByIndex(
2156 this->libObjPtr(), index)};
2159 Option operator[](const std::uint64_t index) noexcept
2161 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2162 this->libObjPtr(), index)};
2165 nonstd::optional<ConstVariantFieldClassOption>
2166 operator[](const char * const name) const noexcept
2168 const auto libObjPtr =
2169 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByName(
2170 this->libObjPtr(), name);
2173 return ConstVariantFieldClassOption {libObjPtr};
2176 return nonstd::nullopt;
2179 nonstd::optional<ConstVariantFieldClassOption>
2180 operator[](const std::string& name) const noexcept
2182 return (*this)[name.data()];
2185 nonstd::optional<Option> operator[](const char * const name) noexcept
2187 const auto libObjPtr =
2188 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2191 return Option {libObjPtr};
2194 return nonstd::nullopt;
2197 nonstd::optional<Option> operator[](const std::string& name) noexcept
2199 return (*this)[name.data()];
2202 Shared shared() const noexcept
2204 return Shared::createWithRef(*this);
2208 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2209 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2211 namespace internal {
2213 struct VariantFieldClassTypeDescr
2215 using Const = ConstVariantFieldClass;
2216 using NonConst = VariantFieldClass;
2220 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2225 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2229 } /* namespace internal */
2231 template <typename LibObjT>
2232 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2235 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2236 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2240 internal::SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2242 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2243 _ThisCommonVariantFieldClass {libObjPtr}
2245 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2248 template <typename OtherLibObjT>
2249 CommonVariantWithoutSelectorFieldClass(
2250 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2251 _ThisCommonVariantFieldClass {fc}
2255 template <typename OtherLibObjT>
2256 CommonVariantWithoutSelectorFieldClass&
2257 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept
2259 _ThisCommonVariantFieldClass::operator=(fc);
2263 void appendOption(const char * const name, const FieldClass& fc)
2265 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2267 const auto status = bt_field_class_variant_without_selector_append_option(
2268 this->libObjPtr(), name, fc.libObjPtr());
2271 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2272 throw LibMemoryError {};
2276 void appendOption(const std::string& name, const FieldClass& fc)
2278 this->appendOption(name.data(), fc);
2281 Shared shared() const noexcept
2283 return Shared::createWithRef(*this);
2287 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2288 using ConstVariantWithoutSelectorFieldClass =
2289 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2291 namespace internal {
2293 struct VariantWithoutSelectorFieldClassTypeDescr
2295 using Const = ConstVariantWithoutSelectorFieldClass;
2296 using NonConst = VariantWithoutSelectorFieldClass;
2300 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2301 public VariantWithoutSelectorFieldClassTypeDescr
2306 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2307 public VariantWithoutSelectorFieldClassTypeDescr
2311 template <typename OptionT>
2312 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2314 /* Functions specific to variant field classes with unsigned integer selector */
2316 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2317 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2320 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2321 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2323 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2327 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2328 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2330 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2334 static bt_field_class_variant_with_selector_field_integer_append_option_status
2335 appendOption(bt_field_class * const libObjPtr, const char * const name,
2336 bt_field_class * const libOptFcPtr,
2337 const bt_integer_range_set_unsigned * const libRangesPtr)
2339 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2340 libObjPtr, name, libOptFcPtr, libRangesPtr);
2344 /* Functions specific to variant field classes with signed integer selector */
2346 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2347 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2350 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2351 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2353 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2357 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2358 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2360 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2364 static bt_field_class_variant_with_selector_field_integer_append_option_status
2365 appendOption(bt_field_class * const libObjPtr, const char * const name,
2366 bt_field_class * const libOptFcPtr,
2367 const bt_integer_range_set_signed * const libRangesPtr)
2369 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2370 libObjPtr, name, libOptFcPtr, libRangesPtr);
2374 } /* namespace internal */
2376 template <typename LibObjT>
2377 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2380 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2383 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2384 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2387 using Shared = internal::SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2389 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2390 _ThisCommonVariantFieldClass {libObjPtr}
2392 BT_ASSERT_DBG(this->isVariantWithSelector());
2395 template <typename OtherLibObjT>
2396 CommonVariantWithSelectorFieldClass(
2397 const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2398 _ThisCommonVariantFieldClass {fc}
2402 template <typename OtherLibObjT>
2403 CommonVariantWithSelectorFieldClass&
2404 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
2406 _ThisCommonVariantFieldClass::operator=(fc);
2410 ConstFieldPath selectorFieldPath() const noexcept
2412 return ConstFieldPath {
2413 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2414 this->libObjPtr())};
2417 Shared shared() const noexcept
2419 return Shared::createWithRef(*this);
2423 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2424 using ConstVariantWithSelectorFieldClass =
2425 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2427 template <typename LibObjT, typename OptionT>
2428 class CommonVariantWithIntegerSelectorFieldClass :
2429 public CommonVariantWithSelectorFieldClass<LibObjT>
2432 using typename CommonVariantWithSelectorFieldClass<
2433 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2434 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2435 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2436 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2438 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2442 internal::SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2444 using Option = OptionT;
2446 CommonIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>, Option>;
2448 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2449 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2451 BT_ASSERT_DBG(this->isVariant());
2454 template <typename OtherLibObjT>
2455 CommonVariantWithIntegerSelectorFieldClass(
2456 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept :
2457 _ThisCommonVariantWithSelectorFieldClass {fc}
2461 template <typename OtherLibObjT>
2462 CommonVariantWithIntegerSelectorFieldClass&
2463 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept
2465 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2469 Option operator[](const std::uint64_t index) const noexcept
2471 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2474 nonstd::optional<Option> operator[](const char * const name) const noexcept
2476 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2479 return Option {libObjPtr};
2482 return nonstd::nullopt;
2485 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2487 return (*this)[name.data()];
2490 void appendOption(const char * const name, const FieldClass& fc,
2491 const typename Option::RangeSet& ranges)
2493 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2496 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2499 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2500 throw LibMemoryError {};
2504 void appendOption(const std::string& name, const FieldClass& fc)
2506 this->appendOption(name.data(), fc);
2509 Iterator begin() const noexcept
2511 return Iterator {*this, 0};
2514 Iterator end() const noexcept
2516 return Iterator {*this, this->size()};
2519 Shared shared() const noexcept
2521 return Shared::createWithRef(*this);
2525 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2526 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2528 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2529 CommonVariantWithIntegerSelectorFieldClass<
2530 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2532 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2533 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2535 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2536 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2538 namespace internal {
2540 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2542 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2543 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2547 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2548 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2553 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2554 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2558 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2560 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2561 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2565 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2566 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2571 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2572 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2576 } /* namespace internal */
2578 template <typename LibObjT>
2579 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2581 BT_ASSERT_DBG(this->isBitArray());
2582 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2585 template <typename LibObjT>
2586 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2588 BT_ASSERT_DBG(this->isInteger());
2589 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2592 template <typename LibObjT>
2593 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2595 BT_ASSERT_DBG(this->isEnumeration());
2596 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2599 template <typename LibObjT>
2600 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2601 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2603 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2604 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2608 template <typename LibObjT>
2609 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2610 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2612 BT_ASSERT_DBG(this->isSignedEnumeration());
2613 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2617 template <typename LibObjT>
2618 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2620 BT_ASSERT_DBG(this->isStructure());
2621 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2624 template <typename LibObjT>
2625 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2627 BT_ASSERT_DBG(this->isArray());
2628 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2631 template <typename LibObjT>
2632 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2634 BT_ASSERT_DBG(this->isStaticArray());
2635 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2638 template <typename LibObjT>
2639 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2640 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2642 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2643 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2646 template <typename LibObjT>
2647 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2649 BT_ASSERT_DBG(this->isOption());
2650 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2653 template <typename LibObjT>
2654 CommonOptionWithSelectorFieldClass<LibObjT>
2655 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2657 BT_ASSERT_DBG(this->isOptionWithSelector());
2658 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2661 template <typename LibObjT>
2662 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2663 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2665 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2666 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2669 template <typename LibObjT>
2670 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2671 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2673 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2674 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2678 template <typename LibObjT>
2679 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2680 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2682 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2683 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2687 template <typename LibObjT>
2688 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2690 BT_ASSERT_DBG(this->isVariant());
2691 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2694 template <typename LibObjT>
2695 CommonVariantWithoutSelectorFieldClass<LibObjT>
2696 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2698 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2699 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2702 template <typename LibObjT>
2703 CommonVariantWithSelectorFieldClass<LibObjT>
2704 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2706 BT_ASSERT_DBG(this->isVariantWithSelector());
2707 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2710 template <typename LibObjT>
2711 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2712 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2713 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2715 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2716 return CommonVariantWithIntegerSelectorFieldClass<
2717 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2720 template <typename LibObjT>
2721 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2722 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2723 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2725 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2726 return CommonVariantWithIntegerSelectorFieldClass<
2727 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2730 } /* namespace bt2 */
2732 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */