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 {*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 {*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 {*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 {*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 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 _ThisCommonEnumerationFieldClass {fc}
845 template <typename OtherLibObjT>
846 CommonEnumerationFieldClass&
847 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept
849 _ThisCommonEnumerationFieldClass::operator=(fc);
853 Mapping operator[](const std::uint64_t index) const noexcept
855 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
856 this->libObjPtr(), index)};
859 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
861 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
862 this->libObjPtr(), label);
865 return Mapping {libObjPtr};
868 return nonstd::nullopt;
871 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
873 return (*this)[label.data()];
876 void addMapping(const char * const label, const typename Mapping::RangeSet ranges)
878 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
879 this->libObjPtr(), label, ranges.libObjPtr());
881 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
882 throw LibMemoryError {};
886 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges)
888 this->addMapping(label.data(), ranges);
891 Shared shared() const noexcept
893 return Shared {*this};
897 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
898 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
900 using UnsignedEnumerationFieldClass =
901 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
903 using ConstUnsignedEnumerationFieldClass =
904 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
906 using SignedEnumerationFieldClass =
907 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
909 using ConstSignedEnumerationFieldClass =
910 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
914 struct UnsignedEnumerationFieldClassTypeDescr
916 using Const = ConstUnsignedEnumerationFieldClass;
917 using NonConst = UnsignedEnumerationFieldClass;
921 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
926 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
930 struct SignedEnumerationFieldClassTypeDescr
932 using Const = ConstSignedEnumerationFieldClass;
933 using NonConst = SignedEnumerationFieldClass;
937 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
942 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
946 template <typename LibObjT>
947 struct CommonStructureFieldClassMemberSpec;
949 /* Functions specific to mutable structure field class members */
951 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
953 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
955 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
959 /* Functions specific to constant structure field class members */
961 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
963 static const bt_field_class *
964 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
966 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
970 } /* namespace internal */
972 template <typename LibObjT>
973 class CommonStructureFieldClassMember final : public internal::BorrowedObj<LibObjT>
976 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
977 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
980 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
983 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
984 _ThisBorrowedObj {libObjPtr}
988 template <typename OtherLibObjT>
989 CommonStructureFieldClassMember(
990 const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept :
991 _ThisBorrowedObj {fc}
995 template <typename OtherLibObjT>
996 CommonStructureFieldClassMember<LibObjT>&
997 operator=(const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept
999 _ThisBorrowedObj::operator=(fc);
1003 bpstd::string_view name() const noexcept
1005 return bt_field_class_structure_member_get_name(this->libObjPtr());
1008 ConstFieldClass fieldClass() const noexcept
1010 return ConstFieldClass {internal::CommonStructureFieldClassMemberSpec<
1011 const bt_field_class_structure_member>::fieldClass(this->libObjPtr())};
1014 _FieldClass fieldClass() noexcept
1016 return _FieldClass {
1017 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1021 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1023 using ConstStructureFieldClassMember =
1024 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1026 namespace internal {
1028 struct StructureFieldClassMemberTypeDescr
1030 using Const = ConstStructureFieldClassMember;
1031 using NonConst = StructureFieldClassMember;
1035 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1040 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1044 template <typename LibObjT>
1045 struct CommonStructureFieldClassSpec;
1047 /* Functions specific to mutable structure field classes */
1049 struct CommonStructureFieldClassSpec<bt_field_class> final
1051 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1052 const std::uint64_t index) noexcept
1054 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1057 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1058 const char * const name) noexcept
1060 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1064 /* Functions specific to constant structure field classes */
1066 struct CommonStructureFieldClassSpec<const bt_field_class> final
1068 static const bt_field_class_structure_member *
1069 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1071 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1074 static const bt_field_class_structure_member *
1075 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1077 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1081 } /* namespace internal */
1083 template <typename LibObjT>
1084 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1087 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1088 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1091 using Shared = internal::SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1093 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1094 StructureFieldClassMember>::type;
1096 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1098 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1099 _ThisCommonFieldClass {libObjPtr}
1101 BT_ASSERT_DBG(this->isStructure());
1104 template <typename OtherLibObjT>
1105 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept :
1106 _ThisCommonFieldClass {fc}
1110 template <typename OtherLibObjT>
1111 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept
1113 _ThisCommonFieldClass::operator=(fc);
1117 void appendMember(const char * const name, const FieldClass& fc)
1119 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1122 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1124 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1125 throw LibMemoryError {};
1129 void appendMember(const std::string& name, const FieldClass& fc)
1131 this->appendMember(name.data(), fc);
1134 std::uint64_t size() const noexcept
1136 return bt_field_class_structure_get_member_count(this->libObjPtr());
1139 Iterator begin() const noexcept
1141 return Iterator {*this, 0};
1144 Iterator end() const noexcept
1146 return Iterator {*this, this->size()};
1149 ConstStructureFieldClassMember operator[](const std::uint64_t index) const noexcept
1151 return ConstStructureFieldClassMember {
1152 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByIndex(
1153 this->libObjPtr(), index)};
1156 Member operator[](const std::uint64_t index) noexcept
1158 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1159 this->libObjPtr(), index)};
1162 nonstd::optional<ConstStructureFieldClassMember>
1163 operator[](const char * const name) const noexcept
1165 const auto libObjPtr =
1166 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByName(
1167 this->libObjPtr(), name);
1170 return ConstStructureFieldClassMember {libObjPtr};
1173 return nonstd::nullopt;
1176 nonstd::optional<ConstStructureFieldClassMember>
1177 operator[](const std::string& name) const noexcept
1179 return (*this)[name.data()];
1182 nonstd::optional<Member> operator[](const char * const name) noexcept
1184 const auto libObjPtr =
1185 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1188 return Member {libObjPtr};
1191 return nonstd::nullopt;
1194 nonstd::optional<Member> operator[](const std::string& name) noexcept
1196 return (*this)[name.data()];
1199 Shared shared() const noexcept
1201 return Shared {*this};
1205 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1206 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1208 namespace internal {
1210 struct StructureFieldClassTypeDescr
1212 using Const = ConstStructureFieldClass;
1213 using NonConst = StructureFieldClass;
1217 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1222 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1226 template <typename LibObjT>
1227 struct CommonArrayFieldClassSpec;
1229 /* Functions specific to mutable array field classes */
1231 struct CommonArrayFieldClassSpec<bt_field_class> final
1233 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1235 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1239 /* Functions specific to constant array field classes */
1241 struct CommonArrayFieldClassSpec<const bt_field_class> final
1243 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1245 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1249 } /* namespace internal */
1251 template <typename LibObjT>
1252 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1255 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1258 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1261 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1262 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1265 using Shared = internal::SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1267 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1268 _ThisCommonFieldClass {libObjPtr}
1270 BT_ASSERT_DBG(this->isArray());
1273 template <typename OtherLibObjT>
1274 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept :
1275 _ThisCommonFieldClass {fc}
1279 template <typename OtherLibObjT>
1280 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept
1282 _ThisCommonFieldClass::operator=(fc);
1286 ConstFieldClass elementFieldClass() const noexcept
1288 return ConstFieldClass {
1289 internal::CommonArrayFieldClassSpec<const bt_field_class>::elementFieldClass(
1290 this->libObjPtr())};
1293 _FieldClass elementFieldClass() noexcept
1295 return _FieldClass {
1296 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1299 Shared shared() const noexcept
1301 return Shared {*this};
1305 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1306 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1308 namespace internal {
1310 struct ArrayFieldClassTypeDescr
1312 using Const = ConstArrayFieldClass;
1313 using NonConst = ArrayFieldClass;
1317 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1322 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1326 } /* namespace internal */
1328 template <typename LibObjT>
1329 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1332 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1333 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1336 using Shared = internal::SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1338 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1339 _ThisCommonArrayFieldClass {libObjPtr}
1341 BT_ASSERT_DBG(this->isStaticArray());
1344 template <typename OtherLibObjT>
1345 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept :
1346 _ThisCommonArrayFieldClass {fc}
1350 template <typename OtherLibObjT>
1351 CommonStaticArrayFieldClass&
1352 operator=(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept
1354 _ThisCommonArrayFieldClass::operator=(fc);
1358 std::uint64_t length() const noexcept
1360 return bt_field_class_array_static_get_length(this->libObjPtr());
1363 Shared shared() const noexcept
1365 return Shared {*this};
1369 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1370 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1372 namespace internal {
1374 struct StaticArrayFieldClassTypeDescr
1376 using Const = ConstStaticArrayFieldClass;
1377 using NonConst = StaticArrayFieldClass;
1381 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1386 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1390 } /* namespace internal */
1392 template <typename LibObjT>
1393 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1396 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1397 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1401 internal::SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1403 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1404 _ThisCommonArrayFieldClass {libObjPtr}
1406 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1409 template <typename OtherLibObjT>
1410 CommonDynamicArrayWithLengthFieldClass(
1411 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept :
1412 _ThisCommonArrayFieldClass {fc}
1416 template <typename OtherLibObjT>
1417 CommonDynamicArrayWithLengthFieldClass&
1418 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept
1420 _ThisCommonArrayFieldClass::operator=(fc);
1424 ConstFieldPath lengthFieldPath() const noexcept
1426 return ConstFieldPath {
1427 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1428 this->libObjPtr())};
1431 Shared shared() const noexcept
1433 return Shared {*this};
1437 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1439 using ConstDynamicArrayWithLengthFieldClass =
1440 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1442 namespace internal {
1444 struct DynamicArrayWithLengthFieldClassTypeDescr
1446 using Const = ConstDynamicArrayWithLengthFieldClass;
1447 using NonConst = DynamicArrayWithLengthFieldClass;
1451 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1452 public DynamicArrayWithLengthFieldClassTypeDescr
1457 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1458 public DynamicArrayWithLengthFieldClassTypeDescr
1462 template <typename LibObjT>
1463 struct CommonOptionFieldClassSpec;
1465 /* Functions specific to mutable option field classes */
1467 struct CommonOptionFieldClassSpec<bt_field_class> final
1469 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1471 return bt_field_class_option_borrow_field_class(libObjPtr);
1475 /* Functions specific to constant option field classes */
1477 struct CommonOptionFieldClassSpec<const bt_field_class> final
1479 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1481 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1485 } /* namespace internal */
1487 template <typename LibObjT>
1488 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1491 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1494 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1497 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1498 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1501 using Shared = internal::SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1503 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1504 _ThisCommonFieldClass {libObjPtr}
1506 BT_ASSERT_DBG(this->isOption());
1509 template <typename OtherLibObjT>
1510 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept :
1511 _ThisCommonFieldClass {fc}
1515 template <typename OtherLibObjT>
1516 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept
1518 _ThisCommonFieldClass::operator=(fc);
1522 ConstFieldClass fieldClass() const noexcept
1524 return ConstFieldClass {
1525 internal::CommonOptionFieldClassSpec<const bt_field_class>::fieldClass(
1526 this->libObjPtr())};
1529 _FieldClass fieldClass() noexcept
1531 return _FieldClass {
1532 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1535 Shared shared() const noexcept
1537 return Shared {*this};
1541 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1542 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1544 namespace internal {
1546 struct OptionFieldClassTypeDescr
1548 using Const = ConstOptionFieldClass;
1549 using NonConst = OptionFieldClass;
1553 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1558 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1562 } /* namespace internal */
1564 template <typename LibObjT>
1565 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1568 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1571 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1572 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1575 using Shared = internal::SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1577 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1578 _ThisCommonOptionFieldClass {libObjPtr}
1580 BT_ASSERT_DBG(this->isOptionWithSelector());
1583 template <typename OtherLibObjT>
1584 CommonOptionWithSelectorFieldClass(
1585 const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1586 _ThisCommonOptionFieldClass {fc}
1590 template <typename OtherLibObjT>
1591 CommonOptionWithSelectorFieldClass&
1592 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
1594 _ThisCommonOptionFieldClass::operator=(fc);
1598 ConstFieldPath selectorFieldPath() const noexcept
1600 return ConstFieldPath {
1601 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1602 this->libObjPtr())};
1605 Shared shared() const noexcept
1607 return Shared {*this};
1611 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1612 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1614 namespace internal {
1616 struct OptionWithSelectorFieldClassTypeDescr
1618 using Const = ConstOptionWithSelectorFieldClass;
1619 using NonConst = OptionWithSelectorFieldClass;
1623 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1628 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1632 } /* namespace internal */
1634 template <typename LibObjT>
1635 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1638 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1640 using typename CommonOptionWithSelectorFieldClass<
1641 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1645 internal::SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1647 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1648 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1650 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1653 template <typename OtherLibObjT>
1654 CommonOptionWithBoolSelectorFieldClass(
1655 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1656 _ThisCommonOptionWithSelectorFieldClass {fc}
1660 template <typename OtherLibObjT>
1661 CommonOptionWithBoolSelectorFieldClass&
1662 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept
1664 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1668 bool selectorIsReversed() const noexcept
1670 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1674 Shared shared() const noexcept
1676 return Shared {*this};
1680 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1682 using ConstOptionWithBoolSelectorFieldClass =
1683 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1685 namespace internal {
1687 struct OptionWithBoolSelectorFieldClassTypeDescr
1689 using Const = ConstOptionWithBoolSelectorFieldClass;
1690 using NonConst = OptionWithBoolSelectorFieldClass;
1694 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1695 public OptionWithBoolSelectorFieldClassTypeDescr
1700 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1701 public OptionWithBoolSelectorFieldClassTypeDescr
1705 template <typename RangeSetT>
1706 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1708 /* Functions specific to option field classes with unsigned integer ranges */
1710 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1712 static const bt_integer_range_set_unsigned *
1713 ranges(const bt_field_class * const libObjPtr) noexcept
1715 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1720 /* Functions specific to option field classes with signed ranges */
1722 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1724 static const bt_integer_range_set_signed *
1725 ranges(const bt_field_class * const libObjPtr) noexcept
1727 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1732 } /* namespace internal */
1734 template <typename LibObjT, typename RangeSetT>
1735 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1738 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1740 using typename CommonOptionWithSelectorFieldClass<
1741 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1743 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1744 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1748 internal::SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1750 using RangeSet = RangeSetT;
1752 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1753 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1755 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1758 template <typename OtherLibObjT>
1759 CommonOptionWithIntegerSelectorFieldClass(
1760 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept :
1761 _ThisCommonOptionWithSelectorFieldClass {fc}
1765 template <typename OtherLibObjT>
1766 CommonOptionWithIntegerSelectorFieldClass&
1767 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept
1769 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1773 RangeSet ranges() const noexcept
1775 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1776 this->libObjPtr())};
1779 Shared shared() const noexcept
1781 return Shared {*this};
1785 using OptionWithUnsignedIntegerSelectorFieldClass =
1786 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1788 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1789 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1791 using OptionWithSignedIntegerSelectorFieldClass =
1792 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1794 using ConstOptionWithSignedIntegerSelectorFieldClass =
1795 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1797 namespace internal {
1799 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1801 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1802 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1806 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1807 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1812 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1813 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1817 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1819 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1820 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1824 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1825 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1830 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1831 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1835 template <typename LibObjT>
1836 struct CommonVariantFieldClassOptionSpec;
1838 /* Functions specific to mutable variant field class options */
1840 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1842 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1844 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1848 /* Functions specific to constant variant field class options */
1850 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1852 static const bt_field_class *
1853 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1855 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1859 } /* namespace internal */
1861 template <typename LibObjT>
1862 class CommonVariantFieldClassOption : public internal::BorrowedObj<LibObjT>
1865 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1866 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1869 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1872 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1873 _ThisBorrowedObj {libObjPtr}
1877 template <typename OtherLibObjT>
1878 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept :
1879 _ThisBorrowedObj {fc}
1883 template <typename OtherLibObjT>
1884 CommonVariantFieldClassOption&
1885 operator=(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept
1887 _ThisBorrowedObj::operator=(fc);
1891 bpstd::string_view name() const noexcept
1893 return bt_field_class_variant_option_get_name(this->libObjPtr());
1896 ConstFieldClass fieldClass() const noexcept
1898 return ConstFieldClass {internal::CommonVariantFieldClassOptionSpec<
1899 const bt_field_class_variant_option>::fieldClass(this->libObjPtr())};
1902 _FieldClass fieldClass() noexcept
1904 return _FieldClass {
1905 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1909 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1911 using ConstVariantFieldClassOption =
1912 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1914 namespace internal {
1916 struct VariantFieldClassOptionTypeDescr
1918 using Const = ConstVariantFieldClassOption;
1919 using NonConst = VariantFieldClassOption;
1923 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1928 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1932 template <typename LibObjT>
1933 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1935 /* Functions specific to variant field class options with unsigned integer selector */
1937 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1938 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1941 static const bt_integer_range_set_unsigned *
1942 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1943 * const libObjPtr) noexcept
1945 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1949 static const bt_field_class_variant_option *
1950 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1951 * const libObjPtr) noexcept
1953 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1958 /* Functions specific to variant field class options with signed integer selector */
1960 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1961 const bt_field_class_variant_with_selector_field_integer_signed_option>
1964 static const bt_integer_range_set_signed *
1965 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1966 * const libObjPtr) noexcept
1968 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1972 static const bt_field_class_variant_option *
1973 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1974 * const libObjPtr) noexcept
1976 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
1981 } /* namespace internal */
1983 template <typename LibObjT>
1984 class ConstVariantWithIntegerSelectorFieldClassOption : public internal::BorrowedObj<LibObjT>
1987 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1988 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1989 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
1992 using RangeSet = typename std::conditional<
1995 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
1996 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
1998 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1999 _ThisBorrowedObj {libObjPtr}
2003 template <typename OtherLibObjT>
2004 ConstVariantWithIntegerSelectorFieldClassOption(
2005 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept :
2006 _ThisBorrowedObj {fc}
2010 template <typename OtherLibObjT>
2011 ConstVariantWithIntegerSelectorFieldClassOption&
2012 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept
2014 _ThisBorrowedObj::operator=(fc);
2018 ConstVariantFieldClassOption asBaseOption() const noexcept
2020 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2023 bpstd::string_view name() const noexcept
2025 return this->asBaseOption().name();
2028 ConstFieldClass fieldClass() const noexcept
2030 return this->asBaseOption().fieldClass();
2033 RangeSet ranges() const noexcept
2035 return RangeSet {_Spec::ranges(this->libObjPtr())};
2039 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2040 ConstVariantWithIntegerSelectorFieldClassOption<
2041 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2043 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2044 ConstVariantWithIntegerSelectorFieldClassOption<
2045 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2047 namespace internal {
2049 template <typename LibObjT>
2050 struct CommonVariantFieldClassSpec;
2052 /* Functions specific to mutable variant field classes */
2054 struct CommonVariantFieldClassSpec<bt_field_class> final
2056 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2057 const std::uint64_t index) noexcept
2059 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2062 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2063 const char * const name) noexcept
2065 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2069 /* Functions specific to constant variant field classes */
2071 struct CommonVariantFieldClassSpec<const bt_field_class> final
2073 static const bt_field_class_variant_option *
2074 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2076 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2079 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2080 const char * const name) noexcept
2082 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2086 } /* namespace internal */
2088 template <typename LibObjT>
2089 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2092 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2095 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2096 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2099 using Shared = internal::SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2102 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2103 VariantFieldClassOption>::type;
2105 using Iterator = CommonIterator<CommonVariantFieldClass<LibObjT>, Option>;
2107 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2108 _ThisCommonFieldClass {libObjPtr}
2110 BT_ASSERT_DBG(this->isVariant());
2113 template <typename OtherLibObjT>
2114 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept :
2115 _ThisCommonFieldClass {fc}
2119 template <typename OtherLibObjT>
2120 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept
2122 _ThisCommonFieldClass::operator=(fc);
2126 std::uint64_t size() const noexcept
2128 return bt_field_class_variant_get_option_count(this->libObjPtr());
2131 Iterator begin() const noexcept
2133 return Iterator {*this, 0};
2136 Iterator end() const noexcept
2138 return Iterator {*this, this->size()};
2141 ConstVariantFieldClassOption operator[](const std::uint64_t index) const noexcept
2143 return ConstVariantFieldClassOption {
2144 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByIndex(
2145 this->libObjPtr(), index)};
2148 Option operator[](const std::uint64_t index) noexcept
2150 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2151 this->libObjPtr(), index)};
2154 nonstd::optional<ConstVariantFieldClassOption>
2155 operator[](const char * const name) const noexcept
2157 const auto libObjPtr =
2158 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByName(
2159 this->libObjPtr(), name);
2162 return ConstVariantFieldClassOption {libObjPtr};
2165 return nonstd::nullopt;
2168 nonstd::optional<ConstVariantFieldClassOption>
2169 operator[](const std::string& name) const noexcept
2171 return (*this)[name.data()];
2174 nonstd::optional<Option> operator[](const char * const name) noexcept
2176 const auto libObjPtr =
2177 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2180 return Option {libObjPtr};
2183 return nonstd::nullopt;
2186 nonstd::optional<Option> operator[](const std::string& name) noexcept
2188 return (*this)[name.data()];
2191 Shared shared() const noexcept
2193 return Shared {*this};
2197 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2198 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2200 namespace internal {
2202 struct VariantFieldClassTypeDescr
2204 using Const = ConstVariantFieldClass;
2205 using NonConst = VariantFieldClass;
2209 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2214 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2218 } /* namespace internal */
2220 template <typename LibObjT>
2221 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2224 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2225 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2229 internal::SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2231 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2232 _ThisCommonVariantFieldClass {libObjPtr}
2234 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2237 template <typename OtherLibObjT>
2238 CommonVariantWithoutSelectorFieldClass(
2239 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2240 _ThisCommonVariantFieldClass {fc}
2244 template <typename OtherLibObjT>
2245 CommonVariantWithoutSelectorFieldClass&
2246 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept
2248 _ThisCommonVariantFieldClass::operator=(fc);
2252 void appendOption(const char * const name, const FieldClass& fc)
2254 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2256 const auto status = bt_field_class_variant_without_selector_append_option(
2257 this->libObjPtr(), name, fc.libObjPtr());
2260 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2261 throw LibMemoryError {};
2265 void appendOption(const std::string& name, const FieldClass& fc)
2267 this->appendOption(name.data(), fc);
2270 Shared shared() const noexcept
2272 return Shared {*this};
2276 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2277 using ConstVariantWithoutSelectorFieldClass =
2278 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2280 namespace internal {
2282 struct VariantWithoutSelectorFieldClassTypeDescr
2284 using Const = ConstVariantWithoutSelectorFieldClass;
2285 using NonConst = VariantWithoutSelectorFieldClass;
2289 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2290 public VariantWithoutSelectorFieldClassTypeDescr
2295 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2296 public VariantWithoutSelectorFieldClassTypeDescr
2300 template <typename OptionT>
2301 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2303 /* Functions specific to variant field classes with unsigned integer selector */
2305 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2306 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2309 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2310 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2312 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2316 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2317 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2319 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2323 static bt_field_class_variant_with_selector_field_integer_append_option_status
2324 appendOption(bt_field_class * const libObjPtr, const char * const name,
2325 bt_field_class * const libOptFcPtr,
2326 const bt_integer_range_set_unsigned * const libRangesPtr)
2328 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2329 libObjPtr, name, libOptFcPtr, libRangesPtr);
2333 /* Functions specific to variant field classes with signed integer selector */
2335 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2336 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2339 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2340 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2342 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2346 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2347 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2349 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2353 static bt_field_class_variant_with_selector_field_integer_append_option_status
2354 appendOption(bt_field_class * const libObjPtr, const char * const name,
2355 bt_field_class * const libOptFcPtr,
2356 const bt_integer_range_set_signed * const libRangesPtr)
2358 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2359 libObjPtr, name, libOptFcPtr, libRangesPtr);
2363 } /* namespace internal */
2365 template <typename LibObjT>
2366 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2369 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2372 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2373 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2376 using Shared = internal::SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2378 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2379 _ThisCommonVariantFieldClass {libObjPtr}
2381 BT_ASSERT_DBG(this->isVariantWithSelector());
2384 template <typename OtherLibObjT>
2385 CommonVariantWithSelectorFieldClass(
2386 const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2387 _ThisCommonVariantFieldClass {fc}
2391 template <typename OtherLibObjT>
2392 CommonVariantWithSelectorFieldClass&
2393 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
2395 _ThisCommonVariantFieldClass::operator=(fc);
2399 ConstFieldPath selectorFieldPath() const noexcept
2401 return ConstFieldPath {
2402 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2403 this->libObjPtr())};
2406 Shared shared() const noexcept
2408 return Shared {*this};
2412 template <typename LibObjT, typename OptionT>
2413 class CommonVariantWithIntegerSelectorFieldClass :
2414 public CommonVariantWithSelectorFieldClass<LibObjT>
2417 using typename CommonVariantWithSelectorFieldClass<
2418 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2419 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2420 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2421 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2423 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2427 internal::SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2429 using Option = OptionT;
2431 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2432 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2434 BT_ASSERT_DBG(this->isVariant());
2437 template <typename OtherLibObjT>
2438 CommonVariantWithIntegerSelectorFieldClass(
2439 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept :
2440 _ThisCommonVariantWithSelectorFieldClass {fc}
2444 template <typename OtherLibObjT>
2445 CommonVariantWithIntegerSelectorFieldClass&
2446 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept
2448 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2452 Option operator[](const std::uint64_t index) const noexcept
2454 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2457 nonstd::optional<Option> operator[](const char * const name) const noexcept
2459 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2462 return Option {libObjPtr};
2465 return nonstd::nullopt;
2468 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2470 return (*this)[name.data()];
2473 void appendOption(const char * const name, const FieldClass& fc,
2474 const typename Option::RangeSet& ranges)
2476 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2479 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2482 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2483 throw LibMemoryError {};
2487 void appendOption(const std::string& name, const FieldClass& fc)
2489 this->appendOption(name.data(), fc);
2492 Shared shared() const noexcept
2494 return Shared {*this};
2498 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2499 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2501 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2502 CommonVariantWithIntegerSelectorFieldClass<
2503 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2505 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2506 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2508 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2509 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2511 namespace internal {
2513 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2515 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2516 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2520 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2521 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2526 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2527 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2531 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2533 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2534 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2538 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2539 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2544 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2545 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2549 } /* namespace internal */
2551 template <typename LibObjT>
2552 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2554 BT_ASSERT_DBG(this->isBitArray());
2555 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2558 template <typename LibObjT>
2559 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2561 BT_ASSERT_DBG(this->isInteger());
2562 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2565 template <typename LibObjT>
2566 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2568 BT_ASSERT_DBG(this->isEnumeration());
2569 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2572 template <typename LibObjT>
2573 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2574 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2576 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2577 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2581 template <typename LibObjT>
2582 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2583 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2585 BT_ASSERT_DBG(this->isSignedEnumeration());
2586 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2590 template <typename LibObjT>
2591 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2593 BT_ASSERT_DBG(this->isStructure());
2594 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2597 template <typename LibObjT>
2598 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2600 BT_ASSERT_DBG(this->isArray());
2601 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2604 template <typename LibObjT>
2605 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2607 BT_ASSERT_DBG(this->isStaticArray());
2608 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2611 template <typename LibObjT>
2612 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2613 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2615 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2616 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2619 template <typename LibObjT>
2620 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2622 BT_ASSERT_DBG(this->isOption());
2623 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2626 template <typename LibObjT>
2627 CommonOptionWithSelectorFieldClass<LibObjT>
2628 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2630 BT_ASSERT_DBG(this->isOptionWithSelector());
2631 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2634 template <typename LibObjT>
2635 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2636 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2638 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2639 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2642 template <typename LibObjT>
2643 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2644 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2646 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2647 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2651 template <typename LibObjT>
2652 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2653 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2655 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2656 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2660 template <typename LibObjT>
2661 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2663 BT_ASSERT_DBG(this->isVariant());
2664 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2667 template <typename LibObjT>
2668 CommonVariantWithoutSelectorFieldClass<LibObjT>
2669 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2671 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2672 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2675 template <typename LibObjT>
2676 CommonVariantWithSelectorFieldClass<LibObjT>
2677 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2679 BT_ASSERT_DBG(this->isVariantWithSelector());
2680 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2683 template <typename LibObjT>
2684 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2685 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2686 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2688 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2689 return CommonVariantWithIntegerSelectorFieldClass<
2690 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2693 template <typename LibObjT>
2694 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2695 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2696 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2698 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2699 return CommonVariantWithIntegerSelectorFieldClass<
2700 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2703 } /* namespace bt2 */
2705 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */