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"
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(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 MemoryError {};
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);
975 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
977 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
981 /* Functions specific to constant structure field class members */
983 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
985 static const bt_field_class *
986 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
988 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
991 static const bt_value *
992 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
994 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
998 } /* namespace internal */
1000 template <typename LibObjT>
1001 class CommonStructureFieldClassMember final : public internal::BorrowedObj<LibObjT>
1004 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1005 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1008 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1011 using UserAttributes =
1012 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1014 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
1015 _ThisBorrowedObj {libObjPtr}
1019 template <typename OtherLibObjT>
1020 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1022 _ThisBorrowedObj {fc}
1026 template <typename OtherLibObjT>
1027 CommonStructureFieldClassMember<LibObjT>&
1028 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1030 _ThisBorrowedObj::operator=(fc);
1034 bpstd::string_view name() const noexcept
1036 return bt_field_class_structure_member_get_name(this->libObjPtr());
1039 ConstFieldClass fieldClass() const noexcept
1041 return ConstFieldClass {internal::CommonStructureFieldClassMemberSpec<
1042 const bt_field_class_structure_member>::fieldClass(this->libObjPtr())};
1045 _FieldClass fieldClass() noexcept
1047 return _FieldClass {
1048 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1051 template <typename LibValT>
1052 void userAttributes(const CommonMapValue<LibValT> userAttrs)
1054 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1056 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1057 userAttrs.libObjPtr());
1060 ConstMapValue userAttributes() const noexcept
1062 return ConstMapValue {internal::CommonStructureFieldClassMemberSpec<
1063 const bt_field_class_structure_member>::userAttributes(this->libObjPtr())};
1066 UserAttributes userAttributes() noexcept
1068 return UserAttributes {
1069 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1070 this->libObjPtr())};
1074 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1076 using ConstStructureFieldClassMember =
1077 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1079 namespace internal {
1081 struct StructureFieldClassMemberTypeDescr
1083 using Const = ConstStructureFieldClassMember;
1084 using NonConst = StructureFieldClassMember;
1088 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1093 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1097 template <typename LibObjT>
1098 struct CommonStructureFieldClassSpec;
1100 /* Functions specific to mutable structure field classes */
1102 struct CommonStructureFieldClassSpec<bt_field_class> final
1104 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1105 const std::uint64_t index) noexcept
1107 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1110 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1111 const char * const name) noexcept
1113 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1117 /* Functions specific to constant structure field classes */
1119 struct CommonStructureFieldClassSpec<const bt_field_class> final
1121 static const bt_field_class_structure_member *
1122 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1124 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1127 static const bt_field_class_structure_member *
1128 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1130 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1134 } /* namespace internal */
1136 template <typename LibObjT>
1137 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1140 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1141 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1144 using Shared = internal::SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1146 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1147 StructureFieldClassMember>::type;
1149 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1151 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1152 _ThisCommonFieldClass {libObjPtr}
1154 BT_ASSERT_DBG(this->isStructure());
1157 template <typename OtherLibObjT>
1158 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1159 _ThisCommonFieldClass {fc}
1163 template <typename OtherLibObjT>
1164 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1166 _ThisCommonFieldClass::operator=(fc);
1170 void appendMember(const char * const name, const FieldClass fc)
1172 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1175 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1177 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1178 throw MemoryError {};
1182 void appendMember(const std::string& name, const FieldClass fc)
1184 this->appendMember(name.data(), fc);
1187 std::uint64_t size() const noexcept
1189 return bt_field_class_structure_get_member_count(this->libObjPtr());
1192 Iterator begin() const noexcept
1194 return Iterator {*this, 0};
1197 Iterator end() const noexcept
1199 return Iterator {*this, this->size()};
1202 ConstStructureFieldClassMember operator[](const std::uint64_t index) const noexcept
1204 return ConstStructureFieldClassMember {
1205 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByIndex(
1206 this->libObjPtr(), index)};
1209 Member operator[](const std::uint64_t index) noexcept
1211 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1212 this->libObjPtr(), index)};
1215 nonstd::optional<ConstStructureFieldClassMember>
1216 operator[](const char * const name) const noexcept
1218 const auto libObjPtr =
1219 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByName(
1220 this->libObjPtr(), name);
1223 return ConstStructureFieldClassMember {libObjPtr};
1226 return nonstd::nullopt;
1229 nonstd::optional<ConstStructureFieldClassMember>
1230 operator[](const std::string& name) const noexcept
1232 return (*this)[name.data()];
1235 nonstd::optional<Member> operator[](const char * const name) noexcept
1237 const auto libObjPtr =
1238 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1241 return Member {libObjPtr};
1244 return nonstd::nullopt;
1247 nonstd::optional<Member> operator[](const std::string& name) noexcept
1249 return (*this)[name.data()];
1252 Shared shared() const noexcept
1254 return Shared::createWithRef(*this);
1258 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1259 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1261 namespace internal {
1263 struct StructureFieldClassTypeDescr
1265 using Const = ConstStructureFieldClass;
1266 using NonConst = StructureFieldClass;
1270 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1275 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1279 template <typename LibObjT>
1280 struct CommonArrayFieldClassSpec;
1282 /* Functions specific to mutable array field classes */
1284 struct CommonArrayFieldClassSpec<bt_field_class> final
1286 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1288 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1292 /* Functions specific to constant array field classes */
1294 struct CommonArrayFieldClassSpec<const bt_field_class> final
1296 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1298 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1302 } /* namespace internal */
1304 template <typename LibObjT>
1305 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1308 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1311 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1314 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1315 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1318 using Shared = internal::SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1320 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1321 _ThisCommonFieldClass {libObjPtr}
1323 BT_ASSERT_DBG(this->isArray());
1326 template <typename OtherLibObjT>
1327 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1328 _ThisCommonFieldClass {fc}
1332 template <typename OtherLibObjT>
1333 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1335 _ThisCommonFieldClass::operator=(fc);
1339 ConstFieldClass elementFieldClass() const noexcept
1341 return ConstFieldClass {
1342 internal::CommonArrayFieldClassSpec<const bt_field_class>::elementFieldClass(
1343 this->libObjPtr())};
1346 _FieldClass elementFieldClass() noexcept
1348 return _FieldClass {
1349 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1352 Shared shared() const noexcept
1354 return Shared::createWithRef(*this);
1358 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1359 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1361 namespace internal {
1363 struct ArrayFieldClassTypeDescr
1365 using Const = ConstArrayFieldClass;
1366 using NonConst = ArrayFieldClass;
1370 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1375 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1379 } /* namespace internal */
1381 template <typename LibObjT>
1382 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1385 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1386 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1389 using Shared = internal::SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1391 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1392 _ThisCommonArrayFieldClass {libObjPtr}
1394 BT_ASSERT_DBG(this->isStaticArray());
1397 template <typename OtherLibObjT>
1398 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1399 _ThisCommonArrayFieldClass {fc}
1403 template <typename OtherLibObjT>
1404 CommonStaticArrayFieldClass&
1405 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1407 _ThisCommonArrayFieldClass::operator=(fc);
1411 std::uint64_t length() const noexcept
1413 return bt_field_class_array_static_get_length(this->libObjPtr());
1416 Shared shared() const noexcept
1418 return Shared::createWithRef(*this);
1422 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1423 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1425 namespace internal {
1427 struct StaticArrayFieldClassTypeDescr
1429 using Const = ConstStaticArrayFieldClass;
1430 using NonConst = StaticArrayFieldClass;
1434 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1439 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1443 } /* namespace internal */
1445 template <typename LibObjT>
1446 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1449 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1450 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1454 internal::SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1456 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1457 _ThisCommonArrayFieldClass {libObjPtr}
1459 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1462 template <typename OtherLibObjT>
1463 CommonDynamicArrayWithLengthFieldClass(
1464 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1465 _ThisCommonArrayFieldClass {fc}
1469 template <typename OtherLibObjT>
1470 CommonDynamicArrayWithLengthFieldClass&
1471 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1473 _ThisCommonArrayFieldClass::operator=(fc);
1477 ConstFieldPath lengthFieldPath() const noexcept
1479 return ConstFieldPath {
1480 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1481 this->libObjPtr())};
1484 Shared shared() const noexcept
1486 return Shared::createWithRef(*this);
1490 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1492 using ConstDynamicArrayWithLengthFieldClass =
1493 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1495 namespace internal {
1497 struct DynamicArrayWithLengthFieldClassTypeDescr
1499 using Const = ConstDynamicArrayWithLengthFieldClass;
1500 using NonConst = DynamicArrayWithLengthFieldClass;
1504 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1505 public DynamicArrayWithLengthFieldClassTypeDescr
1510 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1511 public DynamicArrayWithLengthFieldClassTypeDescr
1515 template <typename LibObjT>
1516 struct CommonOptionFieldClassSpec;
1518 /* Functions specific to mutable option field classes */
1520 struct CommonOptionFieldClassSpec<bt_field_class> final
1522 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1524 return bt_field_class_option_borrow_field_class(libObjPtr);
1528 /* Functions specific to constant option field classes */
1530 struct CommonOptionFieldClassSpec<const bt_field_class> final
1532 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1534 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1538 } /* namespace internal */
1540 template <typename LibObjT>
1541 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1544 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1547 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1550 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1551 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1554 using Shared = internal::SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1556 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1557 _ThisCommonFieldClass {libObjPtr}
1559 BT_ASSERT_DBG(this->isOption());
1562 template <typename OtherLibObjT>
1563 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1564 _ThisCommonFieldClass {fc}
1568 template <typename OtherLibObjT>
1569 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1571 _ThisCommonFieldClass::operator=(fc);
1575 ConstFieldClass fieldClass() const noexcept
1577 return ConstFieldClass {
1578 internal::CommonOptionFieldClassSpec<const bt_field_class>::fieldClass(
1579 this->libObjPtr())};
1582 _FieldClass fieldClass() noexcept
1584 return _FieldClass {
1585 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1588 Shared shared() const noexcept
1590 return Shared::createWithRef(*this);
1594 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1595 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1597 namespace internal {
1599 struct OptionFieldClassTypeDescr
1601 using Const = ConstOptionFieldClass;
1602 using NonConst = OptionFieldClass;
1606 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1611 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1615 } /* namespace internal */
1617 template <typename LibObjT>
1618 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1621 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1624 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1625 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1628 using Shared = internal::SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1630 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1631 _ThisCommonOptionFieldClass {libObjPtr}
1633 BT_ASSERT_DBG(this->isOptionWithSelector());
1636 template <typename OtherLibObjT>
1637 CommonOptionWithSelectorFieldClass(
1638 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1639 _ThisCommonOptionFieldClass {fc}
1643 template <typename OtherLibObjT>
1644 CommonOptionWithSelectorFieldClass&
1645 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1647 _ThisCommonOptionFieldClass::operator=(fc);
1651 ConstFieldPath selectorFieldPath() const noexcept
1653 return ConstFieldPath {
1654 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1655 this->libObjPtr())};
1658 Shared shared() const noexcept
1660 return Shared::createWithRef(*this);
1664 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1665 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1667 namespace internal {
1669 struct OptionWithSelectorFieldClassTypeDescr
1671 using Const = ConstOptionWithSelectorFieldClass;
1672 using NonConst = OptionWithSelectorFieldClass;
1676 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1681 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1685 } /* namespace internal */
1687 template <typename LibObjT>
1688 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1691 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1693 using typename CommonOptionWithSelectorFieldClass<
1694 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1698 internal::SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1700 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1701 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1703 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1706 template <typename OtherLibObjT>
1707 CommonOptionWithBoolSelectorFieldClass(
1708 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1709 _ThisCommonOptionWithSelectorFieldClass {fc}
1713 template <typename OtherLibObjT>
1714 CommonOptionWithBoolSelectorFieldClass&
1715 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1717 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1721 bool selectorIsReversed() const noexcept
1723 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1727 Shared shared() const noexcept
1729 return Shared::createWithRef(*this);
1733 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1735 using ConstOptionWithBoolSelectorFieldClass =
1736 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1738 namespace internal {
1740 struct OptionWithBoolSelectorFieldClassTypeDescr
1742 using Const = ConstOptionWithBoolSelectorFieldClass;
1743 using NonConst = OptionWithBoolSelectorFieldClass;
1747 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1748 public OptionWithBoolSelectorFieldClassTypeDescr
1753 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1754 public OptionWithBoolSelectorFieldClassTypeDescr
1758 template <typename RangeSetT>
1759 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1761 /* Functions specific to option field classes with unsigned integer ranges */
1763 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1765 static const bt_integer_range_set_unsigned *
1766 ranges(const bt_field_class * const libObjPtr) noexcept
1768 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1773 /* Functions specific to option field classes with signed ranges */
1775 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1777 static const bt_integer_range_set_signed *
1778 ranges(const bt_field_class * const libObjPtr) noexcept
1780 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1785 } /* namespace internal */
1787 template <typename LibObjT, typename RangeSetT>
1788 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1791 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1793 using typename CommonOptionWithSelectorFieldClass<
1794 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1796 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1797 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1801 internal::SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1803 using RangeSet = RangeSetT;
1805 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1806 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1808 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1811 template <typename OtherLibObjT>
1812 CommonOptionWithIntegerSelectorFieldClass(
1813 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1814 _ThisCommonOptionWithSelectorFieldClass {fc}
1818 template <typename OtherLibObjT>
1819 CommonOptionWithIntegerSelectorFieldClass&
1820 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1822 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1826 RangeSet ranges() const noexcept
1828 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1829 this->libObjPtr())};
1832 Shared shared() const noexcept
1834 return Shared::createWithRef(*this);
1838 using OptionWithUnsignedIntegerSelectorFieldClass =
1839 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1841 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1842 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1844 using OptionWithSignedIntegerSelectorFieldClass =
1845 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1847 using ConstOptionWithSignedIntegerSelectorFieldClass =
1848 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1850 namespace internal {
1852 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1854 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1855 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1859 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1860 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1865 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1866 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1870 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1872 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1873 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1877 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1878 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1883 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1884 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1888 template <typename LibObjT>
1889 struct CommonVariantFieldClassOptionSpec;
1891 /* Functions specific to mutable variant field class options */
1893 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1895 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1897 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1900 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1902 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1906 /* Functions specific to constant variant field class options */
1908 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1910 static const bt_field_class *
1911 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1913 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1916 static const bt_value *
1917 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1919 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1923 } /* namespace internal */
1925 template <typename LibObjT>
1926 class CommonVariantFieldClassOption : public internal::BorrowedObj<LibObjT>
1929 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1930 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1933 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1936 using UserAttributes =
1937 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1939 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1940 _ThisBorrowedObj {libObjPtr}
1944 template <typename OtherLibObjT>
1945 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1946 _ThisBorrowedObj {fc}
1950 template <typename OtherLibObjT>
1951 CommonVariantFieldClassOption&
1952 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1954 _ThisBorrowedObj::operator=(fc);
1958 nonstd::optional<bpstd::string_view> name() const noexcept
1960 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1966 return nonstd::nullopt;
1969 ConstFieldClass fieldClass() const noexcept
1971 return ConstFieldClass {internal::CommonVariantFieldClassOptionSpec<
1972 const bt_field_class_variant_option>::fieldClass(this->libObjPtr())};
1975 _FieldClass fieldClass() noexcept
1977 return _FieldClass {
1978 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1981 template <typename LibValT>
1982 void userAttributes(const CommonMapValue<LibValT> userAttrs)
1984 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1986 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1989 ConstMapValue userAttributes() const noexcept
1991 return ConstMapValue {internal::CommonVariantFieldClassOptionSpec<
1992 const bt_field_class_variant_option>::userAttributes(this->libObjPtr())};
1995 UserAttributes userAttributes() noexcept
1997 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1998 this->libObjPtr())};
2002 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
2004 using ConstVariantFieldClassOption =
2005 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
2007 namespace internal {
2009 struct VariantFieldClassOptionTypeDescr
2011 using Const = ConstVariantFieldClassOption;
2012 using NonConst = VariantFieldClassOption;
2016 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
2021 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
2025 template <typename LibObjT>
2026 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
2028 /* Functions specific to variant field class options with unsigned integer selector */
2030 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2031 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
2034 static const bt_integer_range_set_unsigned *
2035 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
2036 * const libObjPtr) noexcept
2038 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
2042 static const bt_field_class_variant_option *
2043 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
2044 * const libObjPtr) noexcept
2046 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
2051 /* Functions specific to variant field class options with signed integer selector */
2053 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2054 const bt_field_class_variant_with_selector_field_integer_signed_option>
2057 static const bt_integer_range_set_signed *
2058 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
2059 * const libObjPtr) noexcept
2061 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
2065 static const bt_field_class_variant_option *
2066 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
2067 * const libObjPtr) noexcept
2069 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2074 } /* namespace internal */
2076 template <typename LibObjT>
2077 class ConstVariantWithIntegerSelectorFieldClassOption : public internal::BorrowedObj<LibObjT>
2080 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
2081 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
2082 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2085 using RangeSet = typename std::conditional<
2088 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2089 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2091 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2092 _ThisBorrowedObj {libObjPtr}
2096 template <typename OtherLibObjT>
2097 ConstVariantWithIntegerSelectorFieldClassOption(
2098 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2099 _ThisBorrowedObj {fc}
2103 template <typename OtherLibObjT>
2104 ConstVariantWithIntegerSelectorFieldClassOption&
2105 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2107 _ThisBorrowedObj::operator=(fc);
2111 ConstVariantFieldClassOption asBaseOption() const noexcept
2113 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2116 nonstd::optional<bpstd::string_view> name() const noexcept
2118 return this->asBaseOption().name();
2121 ConstFieldClass fieldClass() const noexcept
2123 return this->asBaseOption().fieldClass();
2126 RangeSet ranges() const noexcept
2128 return RangeSet {_Spec::ranges(this->libObjPtr())};
2132 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2133 ConstVariantWithIntegerSelectorFieldClassOption<
2134 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2136 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2137 ConstVariantWithIntegerSelectorFieldClassOption<
2138 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2140 namespace internal {
2142 template <typename LibObjT>
2143 struct CommonVariantFieldClassSpec;
2145 /* Functions specific to mutable variant field classes */
2147 struct CommonVariantFieldClassSpec<bt_field_class> final
2149 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2150 const std::uint64_t index) noexcept
2152 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2155 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2156 const char * const name) noexcept
2158 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2162 /* Functions specific to constant variant field classes */
2164 struct CommonVariantFieldClassSpec<const bt_field_class> final
2166 static const bt_field_class_variant_option *
2167 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2169 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2172 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2173 const char * const name) noexcept
2175 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2179 } /* namespace internal */
2181 template <typename LibObjT>
2182 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2185 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2188 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2189 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2192 using Shared = internal::SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2195 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2196 VariantFieldClassOption>::type;
2198 using Iterator = CommonIterator<CommonVariantFieldClass, Option>;
2200 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2201 _ThisCommonFieldClass {libObjPtr}
2203 BT_ASSERT_DBG(this->isVariant());
2206 template <typename OtherLibObjT>
2207 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2208 _ThisCommonFieldClass {fc}
2212 template <typename OtherLibObjT>
2213 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2215 _ThisCommonFieldClass::operator=(fc);
2219 std::uint64_t size() const noexcept
2221 return bt_field_class_variant_get_option_count(this->libObjPtr());
2224 Iterator begin() const noexcept
2226 return Iterator {*this, 0};
2229 Iterator end() const noexcept
2231 return Iterator {*this, this->size()};
2234 ConstVariantFieldClassOption operator[](const std::uint64_t index) const noexcept
2236 return ConstVariantFieldClassOption {
2237 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByIndex(
2238 this->libObjPtr(), index)};
2241 Option operator[](const std::uint64_t index) noexcept
2243 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2244 this->libObjPtr(), index)};
2247 nonstd::optional<ConstVariantFieldClassOption>
2248 operator[](const char * const name) const noexcept
2250 const auto libObjPtr =
2251 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByName(
2252 this->libObjPtr(), name);
2255 return ConstVariantFieldClassOption {libObjPtr};
2258 return nonstd::nullopt;
2261 nonstd::optional<ConstVariantFieldClassOption>
2262 operator[](const std::string& name) const noexcept
2264 return (*this)[name.data()];
2267 nonstd::optional<Option> operator[](const char * const name) noexcept
2269 const auto libObjPtr =
2270 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2273 return Option {libObjPtr};
2276 return nonstd::nullopt;
2279 nonstd::optional<Option> operator[](const std::string& name) noexcept
2281 return (*this)[name.data()];
2284 Shared shared() const noexcept
2286 return Shared::createWithRef(*this);
2290 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2291 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2293 namespace internal {
2295 struct VariantFieldClassTypeDescr
2297 using Const = ConstVariantFieldClass;
2298 using NonConst = VariantFieldClass;
2302 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2307 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2311 } /* namespace internal */
2313 template <typename LibObjT>
2314 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2317 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2318 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2322 internal::SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2324 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2325 _ThisCommonVariantFieldClass {libObjPtr}
2327 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2330 template <typename OtherLibObjT>
2331 CommonVariantWithoutSelectorFieldClass(
2332 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2333 _ThisCommonVariantFieldClass {fc}
2337 template <typename OtherLibObjT>
2338 CommonVariantWithoutSelectorFieldClass&
2339 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2341 _ThisCommonVariantFieldClass::operator=(fc);
2345 void appendOption(const char * const name, const FieldClass fc)
2347 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2349 const auto status = bt_field_class_variant_without_selector_append_option(
2350 this->libObjPtr(), name, fc.libObjPtr());
2353 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2354 throw MemoryError {};
2358 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc)
2360 this->appendOption(name ? name->data() : nullptr, fc);
2363 Shared shared() const noexcept
2365 return Shared::createWithRef(*this);
2369 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2370 using ConstVariantWithoutSelectorFieldClass =
2371 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2373 namespace internal {
2375 struct VariantWithoutSelectorFieldClassTypeDescr
2377 using Const = ConstVariantWithoutSelectorFieldClass;
2378 using NonConst = VariantWithoutSelectorFieldClass;
2382 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2383 public VariantWithoutSelectorFieldClassTypeDescr
2388 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2389 public VariantWithoutSelectorFieldClassTypeDescr
2393 template <typename OptionT>
2394 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2396 /* Functions specific to variant field classes with unsigned integer selector */
2398 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2399 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2402 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2403 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2405 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2409 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2410 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2412 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2416 static bt_field_class_variant_with_selector_field_integer_append_option_status
2417 appendOption(bt_field_class * const libObjPtr, const char * const name,
2418 bt_field_class * const libOptFcPtr,
2419 const bt_integer_range_set_unsigned * const libRangesPtr)
2421 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2422 libObjPtr, name, libOptFcPtr, libRangesPtr);
2426 /* Functions specific to variant field classes with signed integer selector */
2428 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2429 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2432 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2433 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2435 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2439 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2440 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2442 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2446 static bt_field_class_variant_with_selector_field_integer_append_option_status
2447 appendOption(bt_field_class * const libObjPtr, const char * const name,
2448 bt_field_class * const libOptFcPtr,
2449 const bt_integer_range_set_signed * const libRangesPtr)
2451 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2452 libObjPtr, name, libOptFcPtr, libRangesPtr);
2456 } /* namespace internal */
2458 template <typename LibObjT>
2459 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2462 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2465 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2466 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2469 using Shared = internal::SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2471 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2472 _ThisCommonVariantFieldClass {libObjPtr}
2474 BT_ASSERT_DBG(this->isVariantWithSelector());
2477 template <typename OtherLibObjT>
2478 CommonVariantWithSelectorFieldClass(
2479 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2480 _ThisCommonVariantFieldClass {fc}
2484 template <typename OtherLibObjT>
2485 CommonVariantWithSelectorFieldClass&
2486 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2488 _ThisCommonVariantFieldClass::operator=(fc);
2492 ConstFieldPath selectorFieldPath() const noexcept
2494 return ConstFieldPath {
2495 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2496 this->libObjPtr())};
2499 Shared shared() const noexcept
2501 return Shared::createWithRef(*this);
2505 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2506 using ConstVariantWithSelectorFieldClass =
2507 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2509 template <typename LibObjT, typename OptionT>
2510 class CommonVariantWithIntegerSelectorFieldClass :
2511 public CommonVariantWithSelectorFieldClass<LibObjT>
2514 using typename CommonVariantWithSelectorFieldClass<
2515 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2516 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2517 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2518 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2520 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2524 internal::SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2526 using Option = OptionT;
2528 CommonIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>, Option>;
2530 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2531 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2533 BT_ASSERT_DBG(this->isVariant());
2536 template <typename OtherLibObjT>
2537 CommonVariantWithIntegerSelectorFieldClass(
2538 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2539 _ThisCommonVariantWithSelectorFieldClass {fc}
2543 template <typename OtherLibObjT>
2544 CommonVariantWithIntegerSelectorFieldClass&
2545 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2547 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2551 Option operator[](const std::uint64_t index) const noexcept
2553 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2556 nonstd::optional<Option> operator[](const char * const name) const noexcept
2558 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2561 return Option {libObjPtr};
2564 return nonstd::nullopt;
2567 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2569 return (*this)[name.data()];
2572 void appendOption(const char * const name, const FieldClass fc,
2573 const typename Option::RangeSet ranges)
2575 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2578 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2581 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2582 throw MemoryError {};
2586 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc,
2587 const typename Option::RangeSet ranges)
2589 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2592 Iterator begin() const noexcept
2594 return Iterator {*this, 0};
2597 Iterator end() const noexcept
2599 return Iterator {*this, this->size()};
2602 Shared shared() const noexcept
2604 return Shared::createWithRef(*this);
2608 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2609 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2611 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2612 CommonVariantWithIntegerSelectorFieldClass<
2613 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2615 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2616 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2618 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2619 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2621 namespace internal {
2623 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2625 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2626 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2630 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2631 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2636 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2637 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2641 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2643 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2644 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2648 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2649 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2654 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2655 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2659 } /* namespace internal */
2661 template <typename LibObjT>
2662 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2664 BT_ASSERT_DBG(this->isBitArray());
2665 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2668 template <typename LibObjT>
2669 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2671 BT_ASSERT_DBG(this->isInteger());
2672 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2675 template <typename LibObjT>
2676 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2678 BT_ASSERT_DBG(this->isEnumeration());
2679 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2682 template <typename LibObjT>
2683 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2684 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2686 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2687 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2691 template <typename LibObjT>
2692 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2693 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2695 BT_ASSERT_DBG(this->isSignedEnumeration());
2696 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2700 template <typename LibObjT>
2701 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2703 BT_ASSERT_DBG(this->isStructure());
2704 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2707 template <typename LibObjT>
2708 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2710 BT_ASSERT_DBG(this->isArray());
2711 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2714 template <typename LibObjT>
2715 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2717 BT_ASSERT_DBG(this->isStaticArray());
2718 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2721 template <typename LibObjT>
2722 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2723 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2725 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2726 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2729 template <typename LibObjT>
2730 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2732 BT_ASSERT_DBG(this->isOption());
2733 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2736 template <typename LibObjT>
2737 CommonOptionWithSelectorFieldClass<LibObjT>
2738 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2740 BT_ASSERT_DBG(this->isOptionWithSelector());
2741 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2744 template <typename LibObjT>
2745 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2746 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2748 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2749 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2752 template <typename LibObjT>
2753 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2754 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2756 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2757 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2761 template <typename LibObjT>
2762 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2763 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2765 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2766 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2770 template <typename LibObjT>
2771 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2773 BT_ASSERT_DBG(this->isVariant());
2774 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2777 template <typename LibObjT>
2778 CommonVariantWithoutSelectorFieldClass<LibObjT>
2779 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2781 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2782 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2785 template <typename LibObjT>
2786 CommonVariantWithSelectorFieldClass<LibObjT>
2787 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2789 BT_ASSERT_DBG(this->isVariantWithSelector());
2790 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2793 template <typename LibObjT>
2794 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2795 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2796 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2798 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2799 return CommonVariantWithIntegerSelectorFieldClass<
2800 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2803 template <typename LibObjT>
2804 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2805 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2806 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2808 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2809 return CommonVariantWithIntegerSelectorFieldClass<
2810 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2813 } /* namespace bt2 */
2815 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */