2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
11 #include <type_traits>
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "cpp-common/optional.hpp"
17 #include "cpp-common/string_view.hpp"
19 #include "borrowed-object.hpp"
20 #include "common-iterator.hpp"
22 #include "field-path.hpp"
23 #include "integer-range-set.hpp"
24 #include "internal/utils.hpp"
25 #include "shared-object.hpp"
31 struct FieldClassRefFuncs final
33 static void get(const bt_field_class * const libObjPtr) noexcept
35 bt_field_class_get_ref(libObjPtr);
38 static void put(const bt_field_class * const libObjPtr) noexcept
40 bt_field_class_put_ref(libObjPtr);
44 template <typename LibObjT>
45 struct CommonFieldClassSpec;
47 /* Functions specific to mutable field classes */
49 struct CommonFieldClassSpec<bt_field_class> final
51 static bt_value *userAttributes(bt_field_class * const libObjPtr) noexcept
53 return bt_field_class_borrow_user_attributes(libObjPtr);
57 /* Functions specific to constant field classes */
59 struct CommonFieldClassSpec<const bt_field_class> final
61 static const bt_value *userAttributes(const bt_field_class * const libObjPtr) noexcept
63 return bt_field_class_borrow_user_attributes_const(libObjPtr);
67 } /* namespace internal */
69 template <typename ObjT, typename LibObjT>
70 using SharedFieldClass = SharedObject<ObjT, LibObjT, internal::FieldClassRefFuncs>;
72 template <typename LibObjT>
73 class CommonBitArrayFieldClass;
75 template <typename LibObjT>
76 class CommonIntegerFieldClass;
78 template <typename LibObjT>
79 class ConstEnumerationFieldClassMapping;
81 template <typename LibObjT>
82 class CommonBaseEnumerationFieldClass;
84 template <typename LibObjT, typename MappingT>
85 class CommonEnumerationFieldClass;
87 template <typename LibObjT>
88 class CommonStructureFieldClass;
90 template <typename LibObjT>
91 class CommonArrayFieldClass;
93 template <typename LibObjT>
94 class CommonStaticArrayFieldClass;
96 template <typename LibObjT>
97 class CommonDynamicArrayWithLengthFieldClass;
99 template <typename LibObjT>
100 class CommonOptionFieldClass;
102 template <typename LibObjT>
103 class CommonOptionWithSelectorFieldClass;
105 template <typename LibObjT>
106 class CommonOptionWithBoolSelectorFieldClass;
108 template <typename LibObjT>
109 class CommonVariantFieldClass;
111 template <typename LibObjT, typename RangeSetT>
112 class CommonOptionWithIntegerSelectorFieldClass;
114 template <typename LibObjT>
115 class CommonVariantWithoutSelectorFieldClass;
117 template <typename LibObjT>
118 class CommonVariantWithSelectorFieldClass;
120 template <typename LibObjT>
121 class ConstVariantWithIntegerSelectorFieldClassOption;
123 template <typename LibObjT, typename RangeSetT>
124 class CommonVariantWithIntegerSelectorFieldClass;
126 template <typename LibObjT>
127 class CommonEventClass;
129 template <typename LibObjT>
130 class CommonStreamClass;
132 template <typename LibObjT>
133 class CommonTraceClass;
135 enum class FieldClassType
137 BOOL = BT_FIELD_CLASS_TYPE_BOOL,
138 BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
139 UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
140 SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
141 UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
142 SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
143 SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
144 DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
145 STRING = BT_FIELD_CLASS_TYPE_STRING,
146 STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
147 STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
148 DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
149 DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
150 OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
151 OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
152 OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
153 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
154 OPTION_WITH_SIGNED_INTEGER_SELECTOR =
155 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
156 VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
157 VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
158 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
159 VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
160 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
163 template <typename LibObjT>
164 class CommonFieldClass : public BorrowedObject<LibObjT>
166 /* Allow appendMember() to call `fc.libObjPtr()` */
167 friend class CommonStructureFieldClass<bt_field_class>;
169 /* Allow appendOption() to call `fc.libObjPtr()` */
170 friend class CommonVariantWithoutSelectorFieldClass<bt_field_class>;
172 friend class CommonVariantWithIntegerSelectorFieldClass<
174 ConstVariantWithIntegerSelectorFieldClassOption<
175 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>;
177 friend class CommonVariantWithIntegerSelectorFieldClass<
179 ConstVariantWithIntegerSelectorFieldClassOption<
180 const bt_field_class_variant_with_selector_field_integer_signed_option>>;
182 /* Allow *FieldClass() to call `fc.libObjPtr()` */
183 friend class CommonEventClass<bt_event_class>;
184 friend class CommonStreamClass<bt_stream_class>;
186 /* Allow create*FieldClass() to call `fc.libObjPtr()` */
187 friend class CommonTraceClass<bt_trace_class>;
190 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
193 using typename BorrowedObject<LibObjT>::_LibObjPtr;
194 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
197 using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
199 using UserAttributes =
200 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
202 explicit CommonFieldClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
206 template <typename OtherLibObjT>
207 CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
211 template <typename OtherLibObjT>
212 CommonFieldClass& operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
214 _ThisBorrowedObject::operator=(fc);
218 FieldClassType type() const noexcept
220 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
223 bool isBool() const noexcept
225 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
228 bool isBitArray() const noexcept
230 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
233 bool isInteger() const noexcept
235 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
238 bool isUnsignedInteger() const noexcept
240 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
243 bool isSignedInteger() const noexcept
245 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
248 bool isEnumeration() const noexcept
250 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
253 bool isUnsignedEnumeration() const noexcept
255 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
258 bool isSignedEnumeration() const noexcept
260 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
263 bool isReal() const noexcept
265 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
268 bool isSinglePrecisionReal() const noexcept
270 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
273 bool isDoublePrecisionReal() const noexcept
275 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
278 bool isString() const noexcept
280 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
283 bool isStructure() const noexcept
285 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
288 bool isArray() const noexcept
290 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
293 bool isStaticArray() const noexcept
295 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
298 bool isDynamicArray() const noexcept
300 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
303 bool isDynamicArrayWithoutLength() const noexcept
305 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
308 bool isDynamicArrayWithLength() const noexcept
310 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
313 bool isOption() const noexcept
315 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
318 bool isOptionWithoutSelector() const noexcept
320 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
323 bool isOptionWithSelector() const noexcept
325 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
328 bool isOptionWithBoolSelector() const noexcept
330 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
333 bool isOptionWithIntegerSelector() const noexcept
335 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
338 bool isOptionWithUnsignedIntegerSelector() const noexcept
340 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
343 bool isOptionWithSignedIntegerSelector() const noexcept
345 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
348 bool isVariant() const noexcept
350 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
353 bool isVariantWithoutSelector() const noexcept
355 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
358 bool isVariantWithSelector() const noexcept
360 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
363 bool isVariantWithIntegerSelector() const noexcept
365 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
368 bool isVariantWithUnsignedIntegerSelector() const noexcept
370 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
373 bool isVariantWithSignedIntegerSelector() const noexcept
375 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
378 template <typename FieldClassT>
379 FieldClassT as() const noexcept
381 return FieldClassT {this->libObjPtr()};
384 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
385 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
386 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
387 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
388 const bt_field_class_enumeration_unsigned_mapping>>
389 asUnsignedEnumeration() const noexcept;
391 CommonEnumerationFieldClass<
392 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
393 asSignedEnumeration() const noexcept;
395 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
396 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
397 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
398 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
399 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
400 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
401 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
403 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
404 asOptionWithUnsignedIntegerSelector() const noexcept;
406 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
407 asOptionWithSignedIntegerSelector() const noexcept;
409 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
410 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
411 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
413 CommonVariantWithIntegerSelectorFieldClass<
414 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
415 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
416 asVariantWithUnsignedIntegerSelector() const noexcept;
418 CommonVariantWithIntegerSelectorFieldClass<
419 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
420 const bt_field_class_variant_with_selector_field_integer_signed_option>>
421 asVariantWithSignedIntegerSelector() const noexcept;
423 template <typename LibValT>
424 void userAttributes(const CommonMapValue<LibValT> userAttrs) const
426 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
428 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
431 UserAttributes userAttributes() const noexcept
433 return UserAttributes {
434 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
437 Shared shared() const noexcept
439 return Shared::createWithRef(*this);
443 bool _libTypeIs(const bt_field_class_type type) const noexcept
445 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
449 using FieldClass = CommonFieldClass<bt_field_class>;
450 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
454 struct FieldClassTypeDescr
456 using Const = ConstFieldClass;
457 using NonConst = FieldClass;
461 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
466 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
470 } /* namespace internal */
472 template <typename LibObjT>
473 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
476 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
477 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
480 using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
482 explicit CommonBitArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
483 _ThisCommonFieldClass {libObjPtr}
485 BT_ASSERT_DBG(this->isBitArray());
488 template <typename OtherLibObjT>
489 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
490 _ThisCommonFieldClass {fc}
494 template <typename OtherLibObjT>
495 CommonBitArrayFieldClass<LibObjT>&
496 operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
498 _ThisCommonFieldClass::operator=(fc);
502 std::uint64_t length() const noexcept
504 return bt_field_class_bit_array_get_length(this->libObjPtr());
507 Shared shared() const noexcept
509 return Shared::createWithRef(*this);
513 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
514 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
518 struct BitArrayFieldClassTypeDescr
520 using Const = ConstBitArrayFieldClass;
521 using NonConst = BitArrayFieldClass;
525 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
530 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
534 } /* namespace internal */
536 enum class DisplayBase
538 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
539 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
540 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
541 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
544 template <typename LibObjT>
545 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
548 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
551 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
552 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
555 using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
557 explicit CommonIntegerFieldClass(const _LibObjPtr libObjPtr) noexcept :
558 _ThisCommonFieldClass {libObjPtr}
560 BT_ASSERT_DBG(this->isInteger());
563 template <typename OtherLibObjT>
564 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
565 _ThisCommonFieldClass {fc}
569 template <typename OtherLibObjT>
570 CommonIntegerFieldClass& operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
572 _ThisCommonFieldClass::operator=(fc);
576 void fieldValueRange(const std::uint64_t n) const noexcept
578 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
580 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
583 std::uint64_t fieldValueRange() const noexcept
585 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
588 void preferredDisplayBase(const DisplayBase base) const noexcept
590 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
592 bt_field_class_integer_set_preferred_display_base(
593 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
596 DisplayBase preferredDisplayBase() const noexcept
598 return static_cast<DisplayBase>(
599 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
602 Shared shared() const noexcept
604 return Shared::createWithRef(*this);
608 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
609 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
613 struct IntegerFieldClassTypeDescr
615 using Const = ConstIntegerFieldClass;
616 using NonConst = IntegerFieldClass;
620 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
625 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
629 } /* namespace internal */
633 template <typename LibObjT>
634 struct ConstEnumerationFieldClassMappingSpec;
636 /* Functions specific to unsigned enumeration field class mappings */
638 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
641 static const bt_integer_range_set_unsigned *
642 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
644 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
648 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
650 return bt_field_class_enumeration_mapping_get_label(
651 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
655 /* Functions specific to signed enumeration field class mappings */
657 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
659 static const bt_integer_range_set_signed *
660 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
662 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
666 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
668 return bt_field_class_enumeration_mapping_get_label(
669 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
673 } /* namespace internal */
675 template <typename LibObjT>
676 class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
679 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
680 using typename BorrowedObject<LibObjT>::_LibObjPtr;
683 using RangeSet = typename std::conditional<
684 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
685 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
687 explicit ConstEnumerationFieldClassMapping(const _LibObjPtr libObjPtr) noexcept :
688 _ThisBorrowedObject {libObjPtr}
692 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
693 _ThisBorrowedObject {mapping}
697 ConstEnumerationFieldClassMapping&
698 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
700 _ThisBorrowedObject::operator=(mapping);
704 RangeSet ranges() const noexcept
707 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
710 bpstd::string_view label() const noexcept
712 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
716 using ConstUnsignedEnumerationFieldClassMapping =
717 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
719 using ConstSignedEnumerationFieldClassMapping =
720 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
724 template <typename MappingT>
725 struct CommonEnumerationFieldClassSpec;
727 /* Functions specific to unsigned enumeration field classes */
729 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
731 static const bt_field_class_enumeration_unsigned_mapping *
732 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
734 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
737 static const bt_field_class_enumeration_unsigned_mapping *
738 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
740 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
743 static bt_field_class_enumeration_add_mapping_status
744 addMapping(bt_field_class * const libObjPtr, const char * const label,
745 const bt_integer_range_set_unsigned * const libRanges) noexcept
747 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
751 /* Functions specific to signed enumeration field classes */
753 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
755 static const bt_field_class_enumeration_signed_mapping *
756 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
758 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
761 static const bt_field_class_enumeration_signed_mapping *
762 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
764 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
767 static bt_field_class_enumeration_add_mapping_status
768 addMapping(bt_field_class * const libObjPtr, const char * const label,
769 const bt_integer_range_set_signed * const libRanges) noexcept
771 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
775 } /* namespace internal */
777 template <typename LibObjT>
778 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
781 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
784 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
785 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
788 using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
790 explicit CommonBaseEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
791 _ThisCommonIntegerFieldClass {libObjPtr}
793 BT_ASSERT_DBG(this->isEnumeration());
796 template <typename OtherLibObjT>
797 CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
799 _ThisCommonIntegerFieldClass {fc}
803 template <typename OtherLibObjT>
804 CommonBaseEnumerationFieldClass&
805 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
807 _ThisCommonIntegerFieldClass::operator=(fc);
811 std::uint64_t size() const noexcept
813 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
816 Shared shared() const noexcept
818 return Shared::createWithRef(*this);
822 template <typename LibObjT, typename MappingT>
823 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
826 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
827 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
828 using _ThisCommonEnumerationFieldClass = CommonEnumerationFieldClass<LibObjT, MappingT>;
831 using Shared = SharedFieldClass<_ThisCommonEnumerationFieldClass, LibObjT>;
832 using Iterator = CommonIterator<CommonEnumerationFieldClass, MappingT>;
833 using Mapping = MappingT;
835 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
836 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
838 BT_ASSERT_DBG(this->isEnumeration());
841 template <typename OtherLibObjT>
842 CommonEnumerationFieldClass(
843 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
844 _ThisCommonEnumerationFieldClass {fc}
848 template <typename OtherLibObjT>
849 CommonEnumerationFieldClass&
850 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
852 _ThisCommonEnumerationFieldClass::operator=(fc);
856 Mapping operator[](const std::uint64_t index) const noexcept
858 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
859 this->libObjPtr(), index)};
862 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
864 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
865 this->libObjPtr(), label);
868 return Mapping {libObjPtr};
871 return nonstd::nullopt;
874 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
876 return (*this)[label.data()];
879 void addMapping(const char * const label, const typename Mapping::RangeSet ranges) const
881 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
882 this->libObjPtr(), label, ranges.libObjPtr());
884 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
885 throw MemoryError {};
889 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges) const
891 this->addMapping(label.data(), ranges);
894 Iterator begin() const noexcept
896 return Iterator {*this, 0};
899 Iterator end() const noexcept
901 return Iterator {*this, this->size()};
904 Shared shared() const noexcept
906 return Shared::createWithRef(*this);
910 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
911 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
913 using UnsignedEnumerationFieldClass =
914 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
916 using ConstUnsignedEnumerationFieldClass =
917 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
919 using SignedEnumerationFieldClass =
920 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
922 using ConstSignedEnumerationFieldClass =
923 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
927 struct UnsignedEnumerationFieldClassTypeDescr
929 using Const = ConstUnsignedEnumerationFieldClass;
930 using NonConst = UnsignedEnumerationFieldClass;
934 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
939 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
943 struct SignedEnumerationFieldClassTypeDescr
945 using Const = ConstSignedEnumerationFieldClass;
946 using NonConst = SignedEnumerationFieldClass;
950 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
955 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
959 template <typename LibObjT>
960 struct CommonStructureFieldClassMemberSpec;
962 /* Functions specific to mutable structure field class members */
964 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
966 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
968 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
971 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
973 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
977 /* Functions specific to constant structure field class members */
979 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
981 static const bt_field_class *
982 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
984 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
987 static const bt_value *
988 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
990 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
994 } /* namespace internal */
996 template <typename LibObjT>
997 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
1000 using typename BorrowedObject<LibObjT>::_LibObjPtr;
1001 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1004 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1007 using UserAttributes =
1008 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1010 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
1011 _ThisBorrowedObject {libObjPtr}
1015 template <typename OtherLibObjT>
1016 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1018 _ThisBorrowedObject {fc}
1022 template <typename OtherLibObjT>
1023 CommonStructureFieldClassMember<LibObjT>&
1024 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1026 _ThisBorrowedObject::operator=(fc);
1030 bpstd::string_view name() const noexcept
1032 return bt_field_class_structure_member_get_name(this->libObjPtr());
1035 _FieldClass fieldClass() const noexcept
1037 return _FieldClass {
1038 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1041 template <typename LibValT>
1042 void userAttributes(const CommonMapValue<LibValT> userAttrs) const
1044 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1046 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1047 userAttrs.libObjPtr());
1050 UserAttributes userAttributes() const noexcept
1052 return UserAttributes {
1053 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1054 this->libObjPtr())};
1058 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1060 using ConstStructureFieldClassMember =
1061 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1063 namespace internal {
1065 struct StructureFieldClassMemberTypeDescr
1067 using Const = ConstStructureFieldClassMember;
1068 using NonConst = StructureFieldClassMember;
1072 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1077 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1081 template <typename LibObjT>
1082 struct CommonStructureFieldClassSpec;
1084 /* Functions specific to mutable structure field classes */
1086 struct CommonStructureFieldClassSpec<bt_field_class> final
1088 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1089 const std::uint64_t index) noexcept
1091 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1094 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1095 const char * const name) noexcept
1097 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1101 /* Functions specific to constant structure field classes */
1103 struct CommonStructureFieldClassSpec<const bt_field_class> final
1105 static const bt_field_class_structure_member *
1106 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1108 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1111 static const bt_field_class_structure_member *
1112 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1114 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1118 } /* namespace internal */
1120 template <typename LibObjT>
1121 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1124 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1125 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1128 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1130 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1131 StructureFieldClassMember>::type;
1133 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1135 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1136 _ThisCommonFieldClass {libObjPtr}
1138 BT_ASSERT_DBG(this->isStructure());
1141 template <typename OtherLibObjT>
1142 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1143 _ThisCommonFieldClass {fc}
1147 template <typename OtherLibObjT>
1148 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1150 _ThisCommonFieldClass::operator=(fc);
1154 void appendMember(const char * const name, const FieldClass fc) const
1156 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1159 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1161 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1162 throw MemoryError {};
1166 void appendMember(const std::string& name, const FieldClass fc) const
1168 this->appendMember(name.data(), fc);
1171 std::uint64_t size() const noexcept
1173 return bt_field_class_structure_get_member_count(this->libObjPtr());
1176 Iterator begin() const noexcept
1178 return Iterator {*this, 0};
1181 Iterator end() const noexcept
1183 return Iterator {*this, this->size()};
1186 Member operator[](const std::uint64_t index) const noexcept
1188 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1189 this->libObjPtr(), index)};
1192 nonstd::optional<Member> operator[](const char * const name) const noexcept
1194 const auto libObjPtr =
1195 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1198 return Member {libObjPtr};
1201 return nonstd::nullopt;
1204 nonstd::optional<Member> operator[](const std::string& name) const noexcept
1206 return (*this)[name.data()];
1209 Shared shared() const noexcept
1211 return Shared::createWithRef(*this);
1215 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1216 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1218 namespace internal {
1220 struct StructureFieldClassTypeDescr
1222 using Const = ConstStructureFieldClass;
1223 using NonConst = StructureFieldClass;
1227 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1232 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1236 template <typename LibObjT>
1237 struct CommonArrayFieldClassSpec;
1239 /* Functions specific to mutable array field classes */
1241 struct CommonArrayFieldClassSpec<bt_field_class> final
1243 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1245 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1249 /* Functions specific to constant array field classes */
1251 struct CommonArrayFieldClassSpec<const bt_field_class> final
1253 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1255 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1259 } /* namespace internal */
1261 template <typename LibObjT>
1262 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1265 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1268 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1271 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1272 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1275 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1277 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1278 _ThisCommonFieldClass {libObjPtr}
1280 BT_ASSERT_DBG(this->isArray());
1283 template <typename OtherLibObjT>
1284 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1285 _ThisCommonFieldClass {fc}
1289 template <typename OtherLibObjT>
1290 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1292 _ThisCommonFieldClass::operator=(fc);
1296 _FieldClass elementFieldClass() const noexcept
1298 return _FieldClass {
1299 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1302 Shared shared() const noexcept
1304 return Shared::createWithRef(*this);
1308 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1309 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1311 namespace internal {
1313 struct ArrayFieldClassTypeDescr
1315 using Const = ConstArrayFieldClass;
1316 using NonConst = ArrayFieldClass;
1320 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1325 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1329 } /* namespace internal */
1331 template <typename LibObjT>
1332 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1335 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1336 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1339 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1341 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1342 _ThisCommonArrayFieldClass {libObjPtr}
1344 BT_ASSERT_DBG(this->isStaticArray());
1347 template <typename OtherLibObjT>
1348 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1349 _ThisCommonArrayFieldClass {fc}
1353 template <typename OtherLibObjT>
1354 CommonStaticArrayFieldClass&
1355 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1357 _ThisCommonArrayFieldClass::operator=(fc);
1361 std::uint64_t length() const noexcept
1363 return bt_field_class_array_static_get_length(this->libObjPtr());
1366 Shared shared() const noexcept
1368 return Shared::createWithRef(*this);
1372 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1373 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1375 namespace internal {
1377 struct StaticArrayFieldClassTypeDescr
1379 using Const = ConstStaticArrayFieldClass;
1380 using NonConst = StaticArrayFieldClass;
1384 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1389 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1393 } /* namespace internal */
1395 template <typename LibObjT>
1396 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1399 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1400 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1403 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1405 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1406 _ThisCommonArrayFieldClass {libObjPtr}
1408 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1411 template <typename OtherLibObjT>
1412 CommonDynamicArrayWithLengthFieldClass(
1413 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1414 _ThisCommonArrayFieldClass {fc}
1418 template <typename OtherLibObjT>
1419 CommonDynamicArrayWithLengthFieldClass&
1420 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1422 _ThisCommonArrayFieldClass::operator=(fc);
1426 ConstFieldPath lengthFieldPath() const noexcept
1428 return ConstFieldPath {
1429 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1430 this->libObjPtr())};
1433 Shared shared() const noexcept
1435 return Shared::createWithRef(*this);
1439 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1441 using ConstDynamicArrayWithLengthFieldClass =
1442 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1444 namespace internal {
1446 struct DynamicArrayWithLengthFieldClassTypeDescr
1448 using Const = ConstDynamicArrayWithLengthFieldClass;
1449 using NonConst = DynamicArrayWithLengthFieldClass;
1453 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1454 public DynamicArrayWithLengthFieldClassTypeDescr
1459 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1460 public DynamicArrayWithLengthFieldClassTypeDescr
1464 template <typename LibObjT>
1465 struct CommonOptionFieldClassSpec;
1467 /* Functions specific to mutable option field classes */
1469 struct CommonOptionFieldClassSpec<bt_field_class> final
1471 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1473 return bt_field_class_option_borrow_field_class(libObjPtr);
1477 /* Functions specific to constant option field classes */
1479 struct CommonOptionFieldClassSpec<const bt_field_class> final
1481 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1483 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1487 } /* namespace internal */
1489 template <typename LibObjT>
1490 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1493 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1496 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1499 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1500 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1503 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1505 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1506 _ThisCommonFieldClass {libObjPtr}
1508 BT_ASSERT_DBG(this->isOption());
1511 template <typename OtherLibObjT>
1512 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1513 _ThisCommonFieldClass {fc}
1517 template <typename OtherLibObjT>
1518 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1520 _ThisCommonFieldClass::operator=(fc);
1524 _FieldClass fieldClass() const noexcept
1526 return _FieldClass {
1527 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1530 Shared shared() const noexcept
1532 return Shared::createWithRef(*this);
1536 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1537 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1539 namespace internal {
1541 struct OptionFieldClassTypeDescr
1543 using Const = ConstOptionFieldClass;
1544 using NonConst = OptionFieldClass;
1548 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1553 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1557 } /* namespace internal */
1559 template <typename LibObjT>
1560 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1563 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1566 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1567 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1570 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1572 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1573 _ThisCommonOptionFieldClass {libObjPtr}
1575 BT_ASSERT_DBG(this->isOptionWithSelector());
1578 template <typename OtherLibObjT>
1579 CommonOptionWithSelectorFieldClass(
1580 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1581 _ThisCommonOptionFieldClass {fc}
1585 template <typename OtherLibObjT>
1586 CommonOptionWithSelectorFieldClass&
1587 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1589 _ThisCommonOptionFieldClass::operator=(fc);
1593 ConstFieldPath selectorFieldPath() const noexcept
1595 return ConstFieldPath {
1596 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1597 this->libObjPtr())};
1600 Shared shared() const noexcept
1602 return Shared::createWithRef(*this);
1606 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1607 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1609 namespace internal {
1611 struct OptionWithSelectorFieldClassTypeDescr
1613 using Const = ConstOptionWithSelectorFieldClass;
1614 using NonConst = OptionWithSelectorFieldClass;
1618 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1623 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1627 } /* namespace internal */
1629 template <typename LibObjT>
1630 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1633 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1635 using typename CommonOptionWithSelectorFieldClass<
1636 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1639 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1641 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1642 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1644 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1647 template <typename OtherLibObjT>
1648 CommonOptionWithBoolSelectorFieldClass(
1649 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1650 _ThisCommonOptionWithSelectorFieldClass {fc}
1654 template <typename OtherLibObjT>
1655 CommonOptionWithBoolSelectorFieldClass&
1656 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1658 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1662 bool selectorIsReversed() const noexcept
1664 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1668 Shared shared() const noexcept
1670 return Shared::createWithRef(*this);
1674 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1676 using ConstOptionWithBoolSelectorFieldClass =
1677 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1679 namespace internal {
1681 struct OptionWithBoolSelectorFieldClassTypeDescr
1683 using Const = ConstOptionWithBoolSelectorFieldClass;
1684 using NonConst = OptionWithBoolSelectorFieldClass;
1688 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1689 public OptionWithBoolSelectorFieldClassTypeDescr
1694 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1695 public OptionWithBoolSelectorFieldClassTypeDescr
1699 template <typename RangeSetT>
1700 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1702 /* Functions specific to option field classes with unsigned integer ranges */
1704 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1706 static const bt_integer_range_set_unsigned *
1707 ranges(const bt_field_class * const libObjPtr) noexcept
1709 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1714 /* Functions specific to option field classes with signed ranges */
1716 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1718 static const bt_integer_range_set_signed *
1719 ranges(const bt_field_class * const libObjPtr) noexcept
1721 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1726 } /* namespace internal */
1728 template <typename LibObjT, typename RangeSetT>
1729 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1732 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1734 using typename CommonOptionWithSelectorFieldClass<
1735 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1737 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1738 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1741 using Shared = SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1743 using RangeSet = RangeSetT;
1745 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1746 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1748 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1751 template <typename OtherLibObjT>
1752 CommonOptionWithIntegerSelectorFieldClass(
1753 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1754 _ThisCommonOptionWithSelectorFieldClass {fc}
1758 template <typename OtherLibObjT>
1759 CommonOptionWithIntegerSelectorFieldClass&
1760 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1762 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1766 RangeSet ranges() const noexcept
1768 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1769 this->libObjPtr())};
1772 Shared shared() const noexcept
1774 return Shared::createWithRef(*this);
1778 using OptionWithUnsignedIntegerSelectorFieldClass =
1779 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1781 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1782 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1784 using OptionWithSignedIntegerSelectorFieldClass =
1785 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1787 using ConstOptionWithSignedIntegerSelectorFieldClass =
1788 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1790 namespace internal {
1792 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1794 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1795 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1799 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1800 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1805 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1806 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1810 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1812 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1813 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1817 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1818 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1823 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1824 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1828 template <typename LibObjT>
1829 struct CommonVariantFieldClassOptionSpec;
1831 /* Functions specific to mutable variant field class options */
1833 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1835 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1837 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1840 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1842 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1846 /* Functions specific to constant variant field class options */
1848 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1850 static const bt_field_class *
1851 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1853 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1856 static const bt_value *
1857 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1859 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1863 } /* namespace internal */
1865 template <typename LibObjT>
1866 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1869 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1870 using typename BorrowedObject<LibObjT>::_LibObjPtr;
1873 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1876 using UserAttributes =
1877 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1879 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1880 _ThisBorrowedObject {libObjPtr}
1884 template <typename OtherLibObjT>
1885 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1886 _ThisBorrowedObject {fc}
1890 template <typename OtherLibObjT>
1891 CommonVariantFieldClassOption&
1892 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1894 _ThisBorrowedObject::operator=(fc);
1898 nonstd::optional<bpstd::string_view> name() const noexcept
1900 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1906 return nonstd::nullopt;
1909 _FieldClass fieldClass() const noexcept
1911 return _FieldClass {
1912 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1915 template <typename LibValT>
1916 void userAttributes(const CommonMapValue<LibValT> userAttrs) const
1918 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1920 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1923 UserAttributes userAttributes() const noexcept
1925 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1926 this->libObjPtr())};
1930 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1932 using ConstVariantFieldClassOption =
1933 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1935 namespace internal {
1937 struct VariantFieldClassOptionTypeDescr
1939 using Const = ConstVariantFieldClassOption;
1940 using NonConst = VariantFieldClassOption;
1944 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1949 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1953 template <typename LibObjT>
1954 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1956 /* Functions specific to variant field class options with unsigned integer selector */
1958 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1959 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1962 static const bt_integer_range_set_unsigned *
1963 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1964 * const libObjPtr) noexcept
1966 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1970 static const bt_field_class_variant_option *
1971 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1972 * const libObjPtr) noexcept
1974 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1979 /* Functions specific to variant field class options with signed integer selector */
1981 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1982 const bt_field_class_variant_with_selector_field_integer_signed_option>
1985 static const bt_integer_range_set_signed *
1986 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1987 * const libObjPtr) noexcept
1989 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1993 static const bt_field_class_variant_option *
1994 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1995 * const libObjPtr) noexcept
1997 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2002 } /* namespace internal */
2004 template <typename LibObjT>
2005 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2008 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2009 using typename BorrowedObject<LibObjT>::_LibObjPtr;
2010 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2013 using RangeSet = typename std::conditional<
2016 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2017 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2019 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2020 _ThisBorrowedObject {libObjPtr}
2024 template <typename OtherLibObjT>
2025 ConstVariantWithIntegerSelectorFieldClassOption(
2026 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2027 _ThisBorrowedObject {fc}
2031 template <typename OtherLibObjT>
2032 ConstVariantWithIntegerSelectorFieldClassOption&
2033 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2035 _ThisBorrowedObject::operator=(fc);
2039 ConstVariantFieldClassOption asBaseOption() const noexcept
2041 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2044 nonstd::optional<bpstd::string_view> name() const noexcept
2046 return this->asBaseOption().name();
2049 ConstFieldClass fieldClass() const noexcept
2051 return this->asBaseOption().fieldClass();
2054 RangeSet ranges() const noexcept
2056 return RangeSet {_Spec::ranges(this->libObjPtr())};
2060 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2061 ConstVariantWithIntegerSelectorFieldClassOption<
2062 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2064 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2065 ConstVariantWithIntegerSelectorFieldClassOption<
2066 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2068 namespace internal {
2070 template <typename LibObjT>
2071 struct CommonVariantFieldClassSpec;
2073 /* Functions specific to mutable variant field classes */
2075 struct CommonVariantFieldClassSpec<bt_field_class> final
2077 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2078 const std::uint64_t index) noexcept
2080 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2083 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2084 const char * const name) noexcept
2086 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2090 /* Functions specific to constant variant field classes */
2092 struct CommonVariantFieldClassSpec<const bt_field_class> final
2094 static const bt_field_class_variant_option *
2095 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2097 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2100 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2101 const char * const name) noexcept
2103 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2107 } /* namespace internal */
2109 template <typename LibObjT>
2110 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2113 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2116 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2117 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2120 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2123 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2124 VariantFieldClassOption>::type;
2126 using Iterator = CommonIterator<CommonVariantFieldClass, Option>;
2128 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2129 _ThisCommonFieldClass {libObjPtr}
2131 BT_ASSERT_DBG(this->isVariant());
2134 template <typename OtherLibObjT>
2135 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2136 _ThisCommonFieldClass {fc}
2140 template <typename OtherLibObjT>
2141 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2143 _ThisCommonFieldClass::operator=(fc);
2147 std::uint64_t size() const noexcept
2149 return bt_field_class_variant_get_option_count(this->libObjPtr());
2152 Iterator begin() const noexcept
2154 return Iterator {*this, 0};
2157 Iterator end() const noexcept
2159 return Iterator {*this, this->size()};
2162 Option operator[](const std::uint64_t index) const noexcept
2164 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2165 this->libObjPtr(), index)};
2168 nonstd::optional<Option> operator[](const char * const name) const noexcept
2170 const auto libObjPtr =
2171 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2174 return Option {libObjPtr};
2177 return nonstd::nullopt;
2180 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2182 return (*this)[name.data()];
2185 Shared shared() const noexcept
2187 return Shared::createWithRef(*this);
2191 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2192 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2194 namespace internal {
2196 struct VariantFieldClassTypeDescr
2198 using Const = ConstVariantFieldClass;
2199 using NonConst = VariantFieldClass;
2203 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2208 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2212 } /* namespace internal */
2214 template <typename LibObjT>
2215 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2218 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2219 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2222 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2224 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2225 _ThisCommonVariantFieldClass {libObjPtr}
2227 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2230 template <typename OtherLibObjT>
2231 CommonVariantWithoutSelectorFieldClass(
2232 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2233 _ThisCommonVariantFieldClass {fc}
2237 template <typename OtherLibObjT>
2238 CommonVariantWithoutSelectorFieldClass&
2239 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2241 _ThisCommonVariantFieldClass::operator=(fc);
2245 void appendOption(const char * const name, const FieldClass fc) const
2247 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2249 const auto status = bt_field_class_variant_without_selector_append_option(
2250 this->libObjPtr(), name, fc.libObjPtr());
2253 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2254 throw MemoryError {};
2258 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc) const
2260 this->appendOption(name ? name->data() : nullptr, fc);
2263 Shared shared() const noexcept
2265 return Shared::createWithRef(*this);
2269 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2270 using ConstVariantWithoutSelectorFieldClass =
2271 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2273 namespace internal {
2275 struct VariantWithoutSelectorFieldClassTypeDescr
2277 using Const = ConstVariantWithoutSelectorFieldClass;
2278 using NonConst = VariantWithoutSelectorFieldClass;
2282 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2283 public VariantWithoutSelectorFieldClassTypeDescr
2288 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2289 public VariantWithoutSelectorFieldClassTypeDescr
2293 template <typename OptionT>
2294 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2296 /* Functions specific to variant field classes with unsigned integer selector */
2298 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2299 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2302 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2303 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2305 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2309 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2310 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2312 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2316 static bt_field_class_variant_with_selector_field_integer_append_option_status
2317 appendOption(bt_field_class * const libObjPtr, const char * const name,
2318 bt_field_class * const libOptFcPtr,
2319 const bt_integer_range_set_unsigned * const libRangesPtr)
2321 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2322 libObjPtr, name, libOptFcPtr, libRangesPtr);
2326 /* Functions specific to variant field classes with signed integer selector */
2328 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2329 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2332 static const bt_field_class_variant_with_selector_field_integer_signed_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_signed_borrow_option_by_index_const(
2339 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2340 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2342 return bt_field_class_variant_with_selector_field_integer_signed_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_signed * const libRangesPtr)
2351 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2352 libObjPtr, name, libOptFcPtr, libRangesPtr);
2356 } /* namespace internal */
2358 template <typename LibObjT>
2359 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2362 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2365 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2366 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2369 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2371 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2372 _ThisCommonVariantFieldClass {libObjPtr}
2374 BT_ASSERT_DBG(this->isVariantWithSelector());
2377 template <typename OtherLibObjT>
2378 CommonVariantWithSelectorFieldClass(
2379 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2380 _ThisCommonVariantFieldClass {fc}
2384 template <typename OtherLibObjT>
2385 CommonVariantWithSelectorFieldClass&
2386 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2388 _ThisCommonVariantFieldClass::operator=(fc);
2392 ConstFieldPath selectorFieldPath() const noexcept
2394 return ConstFieldPath {
2395 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2396 this->libObjPtr())};
2399 Shared shared() const noexcept
2401 return Shared::createWithRef(*this);
2405 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2406 using ConstVariantWithSelectorFieldClass =
2407 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2409 template <typename LibObjT, typename OptionT>
2410 class CommonVariantWithIntegerSelectorFieldClass :
2411 public CommonVariantWithSelectorFieldClass<LibObjT>
2414 using typename CommonVariantWithSelectorFieldClass<
2415 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2416 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2417 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2418 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2420 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2423 using Shared = SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2425 using Option = OptionT;
2427 CommonIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>, Option>;
2429 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2430 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2432 BT_ASSERT_DBG(this->isVariant());
2435 template <typename OtherLibObjT>
2436 CommonVariantWithIntegerSelectorFieldClass(
2437 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2438 _ThisCommonVariantWithSelectorFieldClass {fc}
2442 template <typename OtherLibObjT>
2443 CommonVariantWithIntegerSelectorFieldClass&
2444 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2446 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2450 Option operator[](const std::uint64_t index) const noexcept
2452 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2455 nonstd::optional<Option> operator[](const char * const name) const noexcept
2457 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2460 return Option {libObjPtr};
2463 return nonstd::nullopt;
2466 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2468 return (*this)[name.data()];
2471 void appendOption(const char * const name, const FieldClass fc,
2472 const typename Option::RangeSet ranges) const
2474 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2477 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2480 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2481 throw MemoryError {};
2485 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc,
2486 const typename Option::RangeSet ranges) const
2488 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2491 Iterator begin() const noexcept
2493 return Iterator {*this, 0};
2496 Iterator end() const noexcept
2498 return Iterator {*this, this->size()};
2501 Shared shared() const noexcept
2503 return Shared::createWithRef(*this);
2507 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2508 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2510 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2511 CommonVariantWithIntegerSelectorFieldClass<
2512 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2514 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2515 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2517 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2518 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2520 namespace internal {
2522 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2524 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2525 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2529 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2530 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2535 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2536 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2540 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2542 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2543 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2547 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2548 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2553 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2554 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2558 } /* namespace internal */
2560 template <typename LibObjT>
2561 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2563 BT_ASSERT_DBG(this->isBitArray());
2564 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2567 template <typename LibObjT>
2568 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2570 BT_ASSERT_DBG(this->isInteger());
2571 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2574 template <typename LibObjT>
2575 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2577 BT_ASSERT_DBG(this->isEnumeration());
2578 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2581 template <typename LibObjT>
2582 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2583 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2585 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2586 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2590 template <typename LibObjT>
2591 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2592 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2594 BT_ASSERT_DBG(this->isSignedEnumeration());
2595 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2599 template <typename LibObjT>
2600 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2602 BT_ASSERT_DBG(this->isStructure());
2603 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2606 template <typename LibObjT>
2607 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2609 BT_ASSERT_DBG(this->isArray());
2610 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2613 template <typename LibObjT>
2614 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2616 BT_ASSERT_DBG(this->isStaticArray());
2617 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2620 template <typename LibObjT>
2621 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2622 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2624 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2625 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2628 template <typename LibObjT>
2629 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2631 BT_ASSERT_DBG(this->isOption());
2632 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2635 template <typename LibObjT>
2636 CommonOptionWithSelectorFieldClass<LibObjT>
2637 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2639 BT_ASSERT_DBG(this->isOptionWithSelector());
2640 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2643 template <typename LibObjT>
2644 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2645 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2647 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2648 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2651 template <typename LibObjT>
2652 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2653 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2655 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2656 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2660 template <typename LibObjT>
2661 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2662 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2664 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2665 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2669 template <typename LibObjT>
2670 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2672 BT_ASSERT_DBG(this->isVariant());
2673 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2676 template <typename LibObjT>
2677 CommonVariantWithoutSelectorFieldClass<LibObjT>
2678 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2680 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2681 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2684 template <typename LibObjT>
2685 CommonVariantWithSelectorFieldClass<LibObjT>
2686 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2688 BT_ASSERT_DBG(this->isVariantWithSelector());
2689 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2692 template <typename LibObjT>
2693 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2694 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2695 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2697 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2698 return CommonVariantWithIntegerSelectorFieldClass<
2699 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2702 template <typename LibObjT>
2703 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2704 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2705 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2707 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2708 return CommonVariantWithIntegerSelectorFieldClass<
2709 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2712 } /* namespace bt2 */
2714 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */