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 template <typename FieldClassT>
377 FieldClassT as() const noexcept
379 return FieldClassT {this->libObjPtr()};
382 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
383 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
384 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
385 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
386 const bt_field_class_enumeration_unsigned_mapping>>
387 asUnsignedEnumeration() const noexcept;
389 CommonEnumerationFieldClass<
390 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
391 asSignedEnumeration() const noexcept;
393 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
394 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
395 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
396 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
397 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
398 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
399 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
401 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
402 asOptionWithUnsignedIntegerSelector() const noexcept;
404 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
405 asOptionWithSignedIntegerSelector() const noexcept;
407 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
408 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
409 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
411 CommonVariantWithIntegerSelectorFieldClass<
412 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
413 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
414 asVariantWithUnsignedIntegerSelector() const noexcept;
416 CommonVariantWithIntegerSelectorFieldClass<
417 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
418 const bt_field_class_variant_with_selector_field_integer_signed_option>>
419 asVariantWithSignedIntegerSelector() const noexcept;
421 template <typename LibValT>
422 void userAttributes(const CommonMapValue<LibValT>& userAttrs)
424 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
426 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
429 ConstMapValue userAttributes() const noexcept
431 return ConstMapValue {internal::CommonFieldClassSpec<const bt_field_class>::userAttributes(
435 UserAttributes userAttributes() noexcept
437 return UserAttributes {
438 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
441 Shared shared() const noexcept
443 return Shared::createWithRef(*this);
447 bool _libTypeIs(const bt_field_class_type type) const noexcept
449 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
453 using FieldClass = CommonFieldClass<bt_field_class>;
454 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
458 struct FieldClassTypeDescr
460 using Const = ConstFieldClass;
461 using NonConst = FieldClass;
465 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
470 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
474 } /* namespace internal */
476 template <typename LibObjT>
477 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
480 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
481 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
484 using Shared = internal::SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
486 explicit CommonBitArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
487 _ThisCommonFieldClass {libObjPtr}
489 BT_ASSERT_DBG(this->isBitArray());
492 template <typename OtherLibObjT>
493 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept :
494 _ThisCommonFieldClass {fc}
498 template <typename OtherLibObjT>
499 CommonBitArrayFieldClass<LibObjT>&
500 operator=(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept
502 _ThisCommonFieldClass::operator=(fc);
506 std::uint64_t length() const noexcept
508 return bt_field_class_bit_array_get_length(this->libObjPtr());
511 Shared shared() const noexcept
513 return Shared::createWithRef(*this);
517 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
518 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
522 struct BitArrayFieldClassTypeDescr
524 using Const = ConstBitArrayFieldClass;
525 using NonConst = BitArrayFieldClass;
529 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
534 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
538 } /* namespace internal */
540 enum class DisplayBase
542 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
543 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
544 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
545 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
548 template <typename LibObjT>
549 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
552 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
555 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
556 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
559 using Shared = internal::SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
561 explicit CommonIntegerFieldClass(const _LibObjPtr libObjPtr) noexcept :
562 _ThisCommonFieldClass {libObjPtr}
564 BT_ASSERT_DBG(this->isInteger());
567 template <typename OtherLibObjT>
568 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept :
569 _ThisCommonFieldClass {fc}
573 template <typename OtherLibObjT>
574 CommonIntegerFieldClass& operator=(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept
576 _ThisCommonFieldClass::operator=(fc);
580 void fieldValueRange(const std::uint64_t n) noexcept
582 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
584 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
587 std::uint64_t fieldValueRange() const noexcept
589 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
592 void preferredDisplayBase(const DisplayBase base) noexcept
594 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
596 bt_field_class_integer_set_preferred_display_base(
597 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
600 DisplayBase preferredDisplayBase() const noexcept
602 return static_cast<DisplayBase>(
603 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
606 Shared shared() const noexcept
608 return Shared::createWithRef(*this);
612 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
613 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
617 struct IntegerFieldClassTypeDescr
619 using Const = ConstIntegerFieldClass;
620 using NonConst = IntegerFieldClass;
624 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
629 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
633 } /* namespace internal */
637 template <typename LibObjT>
638 struct ConstEnumerationFieldClassMappingSpec;
640 /* Functions specific to unsigned enumeration field class mappings */
642 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
645 static const bt_integer_range_set_unsigned *
646 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
648 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
652 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
654 return bt_field_class_enumeration_mapping_get_label(
655 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
659 /* Functions specific to signed enumeration field class mappings */
661 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
663 static const bt_integer_range_set_signed *
664 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
666 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
670 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
672 return bt_field_class_enumeration_mapping_get_label(
673 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
677 } /* namespace internal */
679 template <typename LibObjT>
680 class ConstEnumerationFieldClassMapping final : public internal::BorrowedObj<LibObjT>
683 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
684 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
687 using RangeSet = typename std::conditional<
688 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
689 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
691 explicit ConstEnumerationFieldClassMapping(const _LibObjPtr libObjPtr) noexcept :
692 _ThisBorrowedObj {libObjPtr}
696 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
697 _ThisBorrowedObj {mapping}
701 ConstEnumerationFieldClassMapping&
702 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
704 _ThisBorrowedObj::operator=(mapping);
708 RangeSet ranges() const noexcept
711 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
714 bpstd::string_view label() const noexcept
716 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
720 using ConstUnsignedEnumerationFieldClassMapping =
721 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
723 using ConstSignedEnumerationFieldClassMapping =
724 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
728 template <typename MappingT>
729 struct CommonEnumerationFieldClassSpec;
731 /* Functions specific to unsigned enumeration field classes */
733 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
735 static const bt_field_class_enumeration_unsigned_mapping *
736 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
738 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
741 static const bt_field_class_enumeration_unsigned_mapping *
742 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
744 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
747 static bt_field_class_enumeration_add_mapping_status
748 addMapping(bt_field_class * const libObjPtr, const char * const label,
749 const bt_integer_range_set_unsigned * const libRanges) noexcept
751 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
755 /* Functions specific to signed enumeration field classes */
757 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
759 static const bt_field_class_enumeration_signed_mapping *
760 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
762 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
765 static const bt_field_class_enumeration_signed_mapping *
766 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
768 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
771 static bt_field_class_enumeration_add_mapping_status
772 addMapping(bt_field_class * const libObjPtr, const char * const label,
773 const bt_integer_range_set_signed * const libRanges) noexcept
775 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
779 } /* namespace internal */
781 template <typename LibObjT>
782 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
785 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
788 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
789 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
792 using Shared = internal::SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
794 explicit CommonBaseEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
795 _ThisCommonIntegerFieldClass {libObjPtr}
797 BT_ASSERT_DBG(this->isEnumeration());
800 template <typename OtherLibObjT>
801 CommonBaseEnumerationFieldClass(
802 const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept :
803 _ThisCommonIntegerFieldClass {fc}
807 template <typename OtherLibObjT>
808 CommonBaseEnumerationFieldClass&
809 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept
811 _ThisCommonIntegerFieldClass::operator=(fc);
815 std::uint64_t size() const noexcept
817 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
820 Shared shared() const noexcept
822 return Shared::createWithRef(*this);
826 template <typename LibObjT, typename MappingT>
827 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
830 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
831 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
832 using _ThisCommonEnumerationFieldClass = CommonEnumerationFieldClass<LibObjT, MappingT>;
835 using Shared = internal::SharedFieldClass<_ThisCommonEnumerationFieldClass, LibObjT>;
836 using Iterator = CommonIterator<CommonEnumerationFieldClass, MappingT>;
837 using Mapping = MappingT;
839 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
840 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
842 BT_ASSERT_DBG(this->isEnumeration());
845 template <typename OtherLibObjT>
846 CommonEnumerationFieldClass(
847 const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept :
848 _ThisCommonEnumerationFieldClass {fc}
852 template <typename OtherLibObjT>
853 CommonEnumerationFieldClass&
854 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept
856 _ThisCommonEnumerationFieldClass::operator=(fc);
860 Mapping operator[](const std::uint64_t index) const noexcept
862 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
863 this->libObjPtr(), index)};
866 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
868 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
869 this->libObjPtr(), label);
872 return Mapping {libObjPtr};
875 return nonstd::nullopt;
878 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
880 return (*this)[label.data()];
883 void addMapping(const char * const label, const typename Mapping::RangeSet ranges)
885 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
886 this->libObjPtr(), label, ranges.libObjPtr());
888 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
889 throw LibMemoryError {};
893 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges)
895 this->addMapping(label.data(), ranges);
898 Iterator begin() const noexcept
900 return Iterator {*this, 0};
903 Iterator end() const noexcept
905 return Iterator {*this, this->size()};
908 Shared shared() const noexcept
910 return Shared::createWithRef(*this);
914 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
915 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
917 using UnsignedEnumerationFieldClass =
918 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
920 using ConstUnsignedEnumerationFieldClass =
921 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
923 using SignedEnumerationFieldClass =
924 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
926 using ConstSignedEnumerationFieldClass =
927 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
931 struct UnsignedEnumerationFieldClassTypeDescr
933 using Const = ConstUnsignedEnumerationFieldClass;
934 using NonConst = UnsignedEnumerationFieldClass;
938 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
943 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
947 struct SignedEnumerationFieldClassTypeDescr
949 using Const = ConstSignedEnumerationFieldClass;
950 using NonConst = SignedEnumerationFieldClass;
954 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
959 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
963 template <typename LibObjT>
964 struct CommonStructureFieldClassMemberSpec;
966 /* Functions specific to mutable structure field class members */
968 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
970 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
972 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
976 /* Functions specific to constant structure field class members */
978 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
980 static const bt_field_class *
981 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
983 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
987 } /* namespace internal */
989 template <typename LibObjT>
990 class CommonStructureFieldClassMember final : public internal::BorrowedObj<LibObjT>
993 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
994 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
997 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1000 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
1001 _ThisBorrowedObj {libObjPtr}
1005 template <typename OtherLibObjT>
1006 CommonStructureFieldClassMember(
1007 const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept :
1008 _ThisBorrowedObj {fc}
1012 template <typename OtherLibObjT>
1013 CommonStructureFieldClassMember<LibObjT>&
1014 operator=(const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept
1016 _ThisBorrowedObj::operator=(fc);
1020 bpstd::string_view name() const noexcept
1022 return bt_field_class_structure_member_get_name(this->libObjPtr());
1025 ConstFieldClass fieldClass() const noexcept
1027 return ConstFieldClass {internal::CommonStructureFieldClassMemberSpec<
1028 const bt_field_class_structure_member>::fieldClass(this->libObjPtr())};
1031 _FieldClass fieldClass() noexcept
1033 return _FieldClass {
1034 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1038 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1040 using ConstStructureFieldClassMember =
1041 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1043 namespace internal {
1045 struct StructureFieldClassMemberTypeDescr
1047 using Const = ConstStructureFieldClassMember;
1048 using NonConst = StructureFieldClassMember;
1052 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1057 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1061 template <typename LibObjT>
1062 struct CommonStructureFieldClassSpec;
1064 /* Functions specific to mutable structure field classes */
1066 struct CommonStructureFieldClassSpec<bt_field_class> final
1068 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1069 const std::uint64_t index) noexcept
1071 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1074 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1075 const char * const name) noexcept
1077 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1081 /* Functions specific to constant structure field classes */
1083 struct CommonStructureFieldClassSpec<const bt_field_class> final
1085 static const bt_field_class_structure_member *
1086 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1088 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1091 static const bt_field_class_structure_member *
1092 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1094 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1098 } /* namespace internal */
1100 template <typename LibObjT>
1101 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1104 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1105 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1108 using Shared = internal::SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1110 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1111 StructureFieldClassMember>::type;
1113 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1115 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1116 _ThisCommonFieldClass {libObjPtr}
1118 BT_ASSERT_DBG(this->isStructure());
1121 template <typename OtherLibObjT>
1122 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept :
1123 _ThisCommonFieldClass {fc}
1127 template <typename OtherLibObjT>
1128 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept
1130 _ThisCommonFieldClass::operator=(fc);
1134 void appendMember(const char * const name, const FieldClass& fc)
1136 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1139 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1141 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1142 throw LibMemoryError {};
1146 void appendMember(const std::string& name, const FieldClass& fc)
1148 this->appendMember(name.data(), fc);
1151 std::uint64_t size() const noexcept
1153 return bt_field_class_structure_get_member_count(this->libObjPtr());
1156 Iterator begin() const noexcept
1158 return Iterator {*this, 0};
1161 Iterator end() const noexcept
1163 return Iterator {*this, this->size()};
1166 ConstStructureFieldClassMember operator[](const std::uint64_t index) const noexcept
1168 return ConstStructureFieldClassMember {
1169 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByIndex(
1170 this->libObjPtr(), index)};
1173 Member operator[](const std::uint64_t index) noexcept
1175 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1176 this->libObjPtr(), index)};
1179 nonstd::optional<ConstStructureFieldClassMember>
1180 operator[](const char * const name) const noexcept
1182 const auto libObjPtr =
1183 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByName(
1184 this->libObjPtr(), name);
1187 return ConstStructureFieldClassMember {libObjPtr};
1190 return nonstd::nullopt;
1193 nonstd::optional<ConstStructureFieldClassMember>
1194 operator[](const std::string& name) const noexcept
1196 return (*this)[name.data()];
1199 nonstd::optional<Member> operator[](const char * const name) noexcept
1201 const auto libObjPtr =
1202 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1205 return Member {libObjPtr};
1208 return nonstd::nullopt;
1211 nonstd::optional<Member> operator[](const std::string& name) noexcept
1213 return (*this)[name.data()];
1216 Shared shared() const noexcept
1218 return Shared::createWithRef(*this);
1222 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1223 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1225 namespace internal {
1227 struct StructureFieldClassTypeDescr
1229 using Const = ConstStructureFieldClass;
1230 using NonConst = StructureFieldClass;
1234 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1239 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1243 template <typename LibObjT>
1244 struct CommonArrayFieldClassSpec;
1246 /* Functions specific to mutable array field classes */
1248 struct CommonArrayFieldClassSpec<bt_field_class> final
1250 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1252 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1256 /* Functions specific to constant array field classes */
1258 struct CommonArrayFieldClassSpec<const bt_field_class> final
1260 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1262 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1266 } /* namespace internal */
1268 template <typename LibObjT>
1269 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1272 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1275 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1278 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1279 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1282 using Shared = internal::SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1284 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1285 _ThisCommonFieldClass {libObjPtr}
1287 BT_ASSERT_DBG(this->isArray());
1290 template <typename OtherLibObjT>
1291 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept :
1292 _ThisCommonFieldClass {fc}
1296 template <typename OtherLibObjT>
1297 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept
1299 _ThisCommonFieldClass::operator=(fc);
1303 ConstFieldClass elementFieldClass() const noexcept
1305 return ConstFieldClass {
1306 internal::CommonArrayFieldClassSpec<const bt_field_class>::elementFieldClass(
1307 this->libObjPtr())};
1310 _FieldClass elementFieldClass() noexcept
1312 return _FieldClass {
1313 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1316 Shared shared() const noexcept
1318 return Shared::createWithRef(*this);
1322 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1323 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1325 namespace internal {
1327 struct ArrayFieldClassTypeDescr
1329 using Const = ConstArrayFieldClass;
1330 using NonConst = ArrayFieldClass;
1334 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1339 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1343 } /* namespace internal */
1345 template <typename LibObjT>
1346 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1349 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1350 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1353 using Shared = internal::SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1355 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1356 _ThisCommonArrayFieldClass {libObjPtr}
1358 BT_ASSERT_DBG(this->isStaticArray());
1361 template <typename OtherLibObjT>
1362 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept :
1363 _ThisCommonArrayFieldClass {fc}
1367 template <typename OtherLibObjT>
1368 CommonStaticArrayFieldClass&
1369 operator=(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept
1371 _ThisCommonArrayFieldClass::operator=(fc);
1375 std::uint64_t length() const noexcept
1377 return bt_field_class_array_static_get_length(this->libObjPtr());
1380 Shared shared() const noexcept
1382 return Shared::createWithRef(*this);
1386 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1387 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1389 namespace internal {
1391 struct StaticArrayFieldClassTypeDescr
1393 using Const = ConstStaticArrayFieldClass;
1394 using NonConst = StaticArrayFieldClass;
1398 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1403 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1407 } /* namespace internal */
1409 template <typename LibObjT>
1410 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1413 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1414 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1418 internal::SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1420 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1421 _ThisCommonArrayFieldClass {libObjPtr}
1423 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1426 template <typename OtherLibObjT>
1427 CommonDynamicArrayWithLengthFieldClass(
1428 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept :
1429 _ThisCommonArrayFieldClass {fc}
1433 template <typename OtherLibObjT>
1434 CommonDynamicArrayWithLengthFieldClass&
1435 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept
1437 _ThisCommonArrayFieldClass::operator=(fc);
1441 ConstFieldPath lengthFieldPath() const noexcept
1443 return ConstFieldPath {
1444 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1445 this->libObjPtr())};
1448 Shared shared() const noexcept
1450 return Shared::createWithRef(*this);
1454 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1456 using ConstDynamicArrayWithLengthFieldClass =
1457 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1459 namespace internal {
1461 struct DynamicArrayWithLengthFieldClassTypeDescr
1463 using Const = ConstDynamicArrayWithLengthFieldClass;
1464 using NonConst = DynamicArrayWithLengthFieldClass;
1468 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1469 public DynamicArrayWithLengthFieldClassTypeDescr
1474 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1475 public DynamicArrayWithLengthFieldClassTypeDescr
1479 template <typename LibObjT>
1480 struct CommonOptionFieldClassSpec;
1482 /* Functions specific to mutable option field classes */
1484 struct CommonOptionFieldClassSpec<bt_field_class> final
1486 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1488 return bt_field_class_option_borrow_field_class(libObjPtr);
1492 /* Functions specific to constant option field classes */
1494 struct CommonOptionFieldClassSpec<const bt_field_class> final
1496 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1498 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1502 } /* namespace internal */
1504 template <typename LibObjT>
1505 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1508 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1511 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1514 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1515 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1518 using Shared = internal::SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1520 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1521 _ThisCommonFieldClass {libObjPtr}
1523 BT_ASSERT_DBG(this->isOption());
1526 template <typename OtherLibObjT>
1527 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept :
1528 _ThisCommonFieldClass {fc}
1532 template <typename OtherLibObjT>
1533 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept
1535 _ThisCommonFieldClass::operator=(fc);
1539 ConstFieldClass fieldClass() const noexcept
1541 return ConstFieldClass {
1542 internal::CommonOptionFieldClassSpec<const bt_field_class>::fieldClass(
1543 this->libObjPtr())};
1546 _FieldClass fieldClass() noexcept
1548 return _FieldClass {
1549 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1552 Shared shared() const noexcept
1554 return Shared::createWithRef(*this);
1558 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1559 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1561 namespace internal {
1563 struct OptionFieldClassTypeDescr
1565 using Const = ConstOptionFieldClass;
1566 using NonConst = OptionFieldClass;
1570 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1575 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1579 } /* namespace internal */
1581 template <typename LibObjT>
1582 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1585 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1588 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1589 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1592 using Shared = internal::SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1594 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1595 _ThisCommonOptionFieldClass {libObjPtr}
1597 BT_ASSERT_DBG(this->isOptionWithSelector());
1600 template <typename OtherLibObjT>
1601 CommonOptionWithSelectorFieldClass(
1602 const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1603 _ThisCommonOptionFieldClass {fc}
1607 template <typename OtherLibObjT>
1608 CommonOptionWithSelectorFieldClass&
1609 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
1611 _ThisCommonOptionFieldClass::operator=(fc);
1615 ConstFieldPath selectorFieldPath() const noexcept
1617 return ConstFieldPath {
1618 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1619 this->libObjPtr())};
1622 Shared shared() const noexcept
1624 return Shared::createWithRef(*this);
1628 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1629 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1631 namespace internal {
1633 struct OptionWithSelectorFieldClassTypeDescr
1635 using Const = ConstOptionWithSelectorFieldClass;
1636 using NonConst = OptionWithSelectorFieldClass;
1640 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1645 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1649 } /* namespace internal */
1651 template <typename LibObjT>
1652 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1655 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1657 using typename CommonOptionWithSelectorFieldClass<
1658 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1662 internal::SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1664 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1665 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1667 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1670 template <typename OtherLibObjT>
1671 CommonOptionWithBoolSelectorFieldClass(
1672 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1673 _ThisCommonOptionWithSelectorFieldClass {fc}
1677 template <typename OtherLibObjT>
1678 CommonOptionWithBoolSelectorFieldClass&
1679 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept
1681 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1685 bool selectorIsReversed() const noexcept
1687 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1691 Shared shared() const noexcept
1693 return Shared::createWithRef(*this);
1697 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1699 using ConstOptionWithBoolSelectorFieldClass =
1700 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1702 namespace internal {
1704 struct OptionWithBoolSelectorFieldClassTypeDescr
1706 using Const = ConstOptionWithBoolSelectorFieldClass;
1707 using NonConst = OptionWithBoolSelectorFieldClass;
1711 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1712 public OptionWithBoolSelectorFieldClassTypeDescr
1717 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1718 public OptionWithBoolSelectorFieldClassTypeDescr
1722 template <typename RangeSetT>
1723 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1725 /* Functions specific to option field classes with unsigned integer ranges */
1727 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1729 static const bt_integer_range_set_unsigned *
1730 ranges(const bt_field_class * const libObjPtr) noexcept
1732 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1737 /* Functions specific to option field classes with signed ranges */
1739 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1741 static const bt_integer_range_set_signed *
1742 ranges(const bt_field_class * const libObjPtr) noexcept
1744 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1749 } /* namespace internal */
1751 template <typename LibObjT, typename RangeSetT>
1752 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1755 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1757 using typename CommonOptionWithSelectorFieldClass<
1758 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1760 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1761 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1765 internal::SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1767 using RangeSet = RangeSetT;
1769 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1770 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1772 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1775 template <typename OtherLibObjT>
1776 CommonOptionWithIntegerSelectorFieldClass(
1777 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept :
1778 _ThisCommonOptionWithSelectorFieldClass {fc}
1782 template <typename OtherLibObjT>
1783 CommonOptionWithIntegerSelectorFieldClass&
1784 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept
1786 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1790 RangeSet ranges() const noexcept
1792 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1793 this->libObjPtr())};
1796 Shared shared() const noexcept
1798 return Shared::createWithRef(*this);
1802 using OptionWithUnsignedIntegerSelectorFieldClass =
1803 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1805 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1806 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1808 using OptionWithSignedIntegerSelectorFieldClass =
1809 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1811 using ConstOptionWithSignedIntegerSelectorFieldClass =
1812 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1814 namespace internal {
1816 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1818 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1819 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1823 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1824 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1829 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1830 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1834 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1836 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1837 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1841 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1842 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1847 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1848 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1852 template <typename LibObjT>
1853 struct CommonVariantFieldClassOptionSpec;
1855 /* Functions specific to mutable variant field class options */
1857 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1859 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1861 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1865 /* Functions specific to constant variant field class options */
1867 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1869 static const bt_field_class *
1870 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1872 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1876 } /* namespace internal */
1878 template <typename LibObjT>
1879 class CommonVariantFieldClassOption : public internal::BorrowedObj<LibObjT>
1882 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1883 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1886 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1889 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1890 _ThisBorrowedObj {libObjPtr}
1894 template <typename OtherLibObjT>
1895 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept :
1896 _ThisBorrowedObj {fc}
1900 template <typename OtherLibObjT>
1901 CommonVariantFieldClassOption&
1902 operator=(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept
1904 _ThisBorrowedObj::operator=(fc);
1908 nonstd::optional<bpstd::string_view> name() const noexcept
1910 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1916 return nonstd::nullopt;
1919 ConstFieldClass fieldClass() const noexcept
1921 return ConstFieldClass {internal::CommonVariantFieldClassOptionSpec<
1922 const bt_field_class_variant_option>::fieldClass(this->libObjPtr())};
1925 _FieldClass fieldClass() noexcept
1927 return _FieldClass {
1928 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1932 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1934 using ConstVariantFieldClassOption =
1935 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1937 namespace internal {
1939 struct VariantFieldClassOptionTypeDescr
1941 using Const = ConstVariantFieldClassOption;
1942 using NonConst = VariantFieldClassOption;
1946 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1951 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1955 template <typename LibObjT>
1956 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1958 /* Functions specific to variant field class options with unsigned integer selector */
1960 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1961 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1964 static const bt_integer_range_set_unsigned *
1965 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1966 * const libObjPtr) noexcept
1968 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1972 static const bt_field_class_variant_option *
1973 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1974 * const libObjPtr) noexcept
1976 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1981 /* Functions specific to variant field class options with signed integer selector */
1983 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1984 const bt_field_class_variant_with_selector_field_integer_signed_option>
1987 static const bt_integer_range_set_signed *
1988 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1989 * const libObjPtr) noexcept
1991 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1995 static const bt_field_class_variant_option *
1996 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1997 * const libObjPtr) noexcept
1999 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2004 } /* namespace internal */
2006 template <typename LibObjT>
2007 class ConstVariantWithIntegerSelectorFieldClassOption : public internal::BorrowedObj<LibObjT>
2010 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
2011 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
2012 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2015 using RangeSet = typename std::conditional<
2018 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2019 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2021 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2022 _ThisBorrowedObj {libObjPtr}
2026 template <typename OtherLibObjT>
2027 ConstVariantWithIntegerSelectorFieldClassOption(
2028 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept :
2029 _ThisBorrowedObj {fc}
2033 template <typename OtherLibObjT>
2034 ConstVariantWithIntegerSelectorFieldClassOption&
2035 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept
2037 _ThisBorrowedObj::operator=(fc);
2041 ConstVariantFieldClassOption asBaseOption() const noexcept
2043 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2046 nonstd::optional<bpstd::string_view> name() const noexcept
2048 return this->asBaseOption().name();
2051 ConstFieldClass fieldClass() const noexcept
2053 return this->asBaseOption().fieldClass();
2056 RangeSet ranges() const noexcept
2058 return RangeSet {_Spec::ranges(this->libObjPtr())};
2062 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2063 ConstVariantWithIntegerSelectorFieldClassOption<
2064 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2066 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2067 ConstVariantWithIntegerSelectorFieldClassOption<
2068 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2070 namespace internal {
2072 template <typename LibObjT>
2073 struct CommonVariantFieldClassSpec;
2075 /* Functions specific to mutable variant field classes */
2077 struct CommonVariantFieldClassSpec<bt_field_class> final
2079 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2080 const std::uint64_t index) noexcept
2082 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2085 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2086 const char * const name) noexcept
2088 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2092 /* Functions specific to constant variant field classes */
2094 struct CommonVariantFieldClassSpec<const bt_field_class> final
2096 static const bt_field_class_variant_option *
2097 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2099 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2102 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2103 const char * const name) noexcept
2105 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2109 } /* namespace internal */
2111 template <typename LibObjT>
2112 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2115 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2118 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2119 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2122 using Shared = internal::SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2125 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2126 VariantFieldClassOption>::type;
2128 using Iterator = CommonIterator<CommonVariantFieldClass, Option>;
2130 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2131 _ThisCommonFieldClass {libObjPtr}
2133 BT_ASSERT_DBG(this->isVariant());
2136 template <typename OtherLibObjT>
2137 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept :
2138 _ThisCommonFieldClass {fc}
2142 template <typename OtherLibObjT>
2143 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept
2145 _ThisCommonFieldClass::operator=(fc);
2149 std::uint64_t size() const noexcept
2151 return bt_field_class_variant_get_option_count(this->libObjPtr());
2154 Iterator begin() const noexcept
2156 return Iterator {*this, 0};
2159 Iterator end() const noexcept
2161 return Iterator {*this, this->size()};
2164 ConstVariantFieldClassOption operator[](const std::uint64_t index) const noexcept
2166 return ConstVariantFieldClassOption {
2167 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByIndex(
2168 this->libObjPtr(), index)};
2171 Option operator[](const std::uint64_t index) noexcept
2173 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2174 this->libObjPtr(), index)};
2177 nonstd::optional<ConstVariantFieldClassOption>
2178 operator[](const char * const name) const noexcept
2180 const auto libObjPtr =
2181 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByName(
2182 this->libObjPtr(), name);
2185 return ConstVariantFieldClassOption {libObjPtr};
2188 return nonstd::nullopt;
2191 nonstd::optional<ConstVariantFieldClassOption>
2192 operator[](const std::string& name) const noexcept
2194 return (*this)[name.data()];
2197 nonstd::optional<Option> operator[](const char * const name) noexcept
2199 const auto libObjPtr =
2200 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2203 return Option {libObjPtr};
2206 return nonstd::nullopt;
2209 nonstd::optional<Option> operator[](const std::string& name) noexcept
2211 return (*this)[name.data()];
2214 Shared shared() const noexcept
2216 return Shared::createWithRef(*this);
2220 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2221 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2223 namespace internal {
2225 struct VariantFieldClassTypeDescr
2227 using Const = ConstVariantFieldClass;
2228 using NonConst = VariantFieldClass;
2232 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2237 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2241 } /* namespace internal */
2243 template <typename LibObjT>
2244 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2247 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2248 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2252 internal::SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2254 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2255 _ThisCommonVariantFieldClass {libObjPtr}
2257 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2260 template <typename OtherLibObjT>
2261 CommonVariantWithoutSelectorFieldClass(
2262 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2263 _ThisCommonVariantFieldClass {fc}
2267 template <typename OtherLibObjT>
2268 CommonVariantWithoutSelectorFieldClass&
2269 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept
2271 _ThisCommonVariantFieldClass::operator=(fc);
2275 void appendOption(const char * const name, const FieldClass& fc)
2277 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2279 const auto status = bt_field_class_variant_without_selector_append_option(
2280 this->libObjPtr(), name, fc.libObjPtr());
2283 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2284 throw LibMemoryError {};
2288 void appendOption(const nonstd::optional<std::string>& name, const FieldClass& fc)
2290 this->appendOption(name ? name->data() : nullptr, fc);
2293 Shared shared() const noexcept
2295 return Shared::createWithRef(*this);
2299 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2300 using ConstVariantWithoutSelectorFieldClass =
2301 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2303 namespace internal {
2305 struct VariantWithoutSelectorFieldClassTypeDescr
2307 using Const = ConstVariantWithoutSelectorFieldClass;
2308 using NonConst = VariantWithoutSelectorFieldClass;
2312 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2313 public VariantWithoutSelectorFieldClassTypeDescr
2318 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2319 public VariantWithoutSelectorFieldClassTypeDescr
2323 template <typename OptionT>
2324 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2326 /* Functions specific to variant field classes with unsigned integer selector */
2328 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2329 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2332 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2333 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2335 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2339 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2340 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2342 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2346 static bt_field_class_variant_with_selector_field_integer_append_option_status
2347 appendOption(bt_field_class * const libObjPtr, const char * const name,
2348 bt_field_class * const libOptFcPtr,
2349 const bt_integer_range_set_unsigned * const libRangesPtr)
2351 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2352 libObjPtr, name, libOptFcPtr, libRangesPtr);
2356 /* Functions specific to variant field classes with signed integer selector */
2358 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2359 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2362 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2363 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2365 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2369 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2370 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2372 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2376 static bt_field_class_variant_with_selector_field_integer_append_option_status
2377 appendOption(bt_field_class * const libObjPtr, const char * const name,
2378 bt_field_class * const libOptFcPtr,
2379 const bt_integer_range_set_signed * const libRangesPtr)
2381 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2382 libObjPtr, name, libOptFcPtr, libRangesPtr);
2386 } /* namespace internal */
2388 template <typename LibObjT>
2389 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2392 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2395 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2396 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2399 using Shared = internal::SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2401 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2402 _ThisCommonVariantFieldClass {libObjPtr}
2404 BT_ASSERT_DBG(this->isVariantWithSelector());
2407 template <typename OtherLibObjT>
2408 CommonVariantWithSelectorFieldClass(
2409 const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2410 _ThisCommonVariantFieldClass {fc}
2414 template <typename OtherLibObjT>
2415 CommonVariantWithSelectorFieldClass&
2416 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
2418 _ThisCommonVariantFieldClass::operator=(fc);
2422 ConstFieldPath selectorFieldPath() const noexcept
2424 return ConstFieldPath {
2425 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2426 this->libObjPtr())};
2429 Shared shared() const noexcept
2431 return Shared::createWithRef(*this);
2435 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2436 using ConstVariantWithSelectorFieldClass =
2437 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2439 template <typename LibObjT, typename OptionT>
2440 class CommonVariantWithIntegerSelectorFieldClass :
2441 public CommonVariantWithSelectorFieldClass<LibObjT>
2444 using typename CommonVariantWithSelectorFieldClass<
2445 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2446 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2447 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2448 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2450 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2454 internal::SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2456 using Option = OptionT;
2458 CommonIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>, Option>;
2460 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2461 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2463 BT_ASSERT_DBG(this->isVariant());
2466 template <typename OtherLibObjT>
2467 CommonVariantWithIntegerSelectorFieldClass(
2468 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept :
2469 _ThisCommonVariantWithSelectorFieldClass {fc}
2473 template <typename OtherLibObjT>
2474 CommonVariantWithIntegerSelectorFieldClass&
2475 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept
2477 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2481 Option operator[](const std::uint64_t index) const noexcept
2483 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2486 nonstd::optional<Option> operator[](const char * const name) const noexcept
2488 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2491 return Option {libObjPtr};
2494 return nonstd::nullopt;
2497 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2499 return (*this)[name.data()];
2502 void appendOption(const char * const name, const FieldClass& fc,
2503 const typename Option::RangeSet& ranges)
2505 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2508 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2511 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2512 throw LibMemoryError {};
2516 void appendOption(const nonstd::optional<std::string>& name, const FieldClass& fc,
2517 const typename Option::RangeSet& ranges)
2519 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2522 Iterator begin() const noexcept
2524 return Iterator {*this, 0};
2527 Iterator end() const noexcept
2529 return Iterator {*this, this->size()};
2532 Shared shared() const noexcept
2534 return Shared::createWithRef(*this);
2538 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2539 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2541 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2542 CommonVariantWithIntegerSelectorFieldClass<
2543 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2545 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2546 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2548 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2549 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2551 namespace internal {
2553 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2555 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2556 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2560 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2561 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2566 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2567 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2571 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2573 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2574 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2578 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2579 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2584 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2585 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2589 } /* namespace internal */
2591 template <typename LibObjT>
2592 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2594 BT_ASSERT_DBG(this->isBitArray());
2595 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2598 template <typename LibObjT>
2599 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2601 BT_ASSERT_DBG(this->isInteger());
2602 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2605 template <typename LibObjT>
2606 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2608 BT_ASSERT_DBG(this->isEnumeration());
2609 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2612 template <typename LibObjT>
2613 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2614 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2616 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2617 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2621 template <typename LibObjT>
2622 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2623 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2625 BT_ASSERT_DBG(this->isSignedEnumeration());
2626 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2630 template <typename LibObjT>
2631 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2633 BT_ASSERT_DBG(this->isStructure());
2634 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2637 template <typename LibObjT>
2638 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2640 BT_ASSERT_DBG(this->isArray());
2641 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2644 template <typename LibObjT>
2645 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2647 BT_ASSERT_DBG(this->isStaticArray());
2648 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2651 template <typename LibObjT>
2652 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2653 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2655 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2656 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2659 template <typename LibObjT>
2660 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2662 BT_ASSERT_DBG(this->isOption());
2663 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2666 template <typename LibObjT>
2667 CommonOptionWithSelectorFieldClass<LibObjT>
2668 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2670 BT_ASSERT_DBG(this->isOptionWithSelector());
2671 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2674 template <typename LibObjT>
2675 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2676 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2678 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2679 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2682 template <typename LibObjT>
2683 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2684 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2686 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2687 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2691 template <typename LibObjT>
2692 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2693 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2695 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2696 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2700 template <typename LibObjT>
2701 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2703 BT_ASSERT_DBG(this->isVariant());
2704 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2707 template <typename LibObjT>
2708 CommonVariantWithoutSelectorFieldClass<LibObjT>
2709 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2711 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2712 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2715 template <typename LibObjT>
2716 CommonVariantWithSelectorFieldClass<LibObjT>
2717 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2719 BT_ASSERT_DBG(this->isVariantWithSelector());
2720 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2723 template <typename LibObjT>
2724 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2725 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2726 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2728 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2729 return CommonVariantWithIntegerSelectorFieldClass<
2730 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2733 template <typename LibObjT>
2734 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2735 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2736 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2738 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2739 return CommonVariantWithIntegerSelectorFieldClass<
2740 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2743 } /* namespace bt2 */
2745 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */