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-iterator.hpp"
20 #include "borrowed-object.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>
167 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
170 using typename BorrowedObject<LibObjT>::_LibObjPtr;
171 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
174 using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
175 using UserAttributes = internal::DepUserAttrs<LibObjT>;
177 explicit CommonFieldClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
181 template <typename OtherLibObjT>
182 CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
186 template <typename OtherLibObjT>
187 CommonFieldClass& operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
189 _ThisBorrowedObject::operator=(fc);
193 CommonFieldClass<const bt_field_class> asConst() const noexcept
195 return CommonFieldClass<const bt_field_class> {*this};
198 FieldClassType type() const noexcept
200 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
203 bool isBool() const noexcept
205 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
208 bool isBitArray() const noexcept
210 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
213 bool isInteger() const noexcept
215 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
218 bool isUnsignedInteger() const noexcept
220 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
223 bool isSignedInteger() const noexcept
225 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
228 bool isEnumeration() const noexcept
230 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
233 bool isUnsignedEnumeration() const noexcept
235 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
238 bool isSignedEnumeration() const noexcept
240 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
243 bool isReal() const noexcept
245 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
248 bool isSinglePrecisionReal() const noexcept
250 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
253 bool isDoublePrecisionReal() const noexcept
255 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
258 bool isString() const noexcept
260 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
263 bool isStructure() const noexcept
265 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
268 bool isArray() const noexcept
270 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
273 bool isStaticArray() const noexcept
275 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
278 bool isDynamicArray() const noexcept
280 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
283 bool isDynamicArrayWithoutLength() const noexcept
285 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
288 bool isDynamicArrayWithLength() const noexcept
290 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
293 bool isOption() const noexcept
295 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
298 bool isOptionWithoutSelector() const noexcept
300 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
303 bool isOptionWithSelector() const noexcept
305 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
308 bool isOptionWithBoolSelector() const noexcept
310 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
313 bool isOptionWithIntegerSelector() const noexcept
315 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
318 bool isOptionWithUnsignedIntegerSelector() const noexcept
320 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
323 bool isOptionWithSignedIntegerSelector() const noexcept
325 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
328 bool isVariant() const noexcept
330 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
333 bool isVariantWithoutSelector() const noexcept
335 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
338 bool isVariantWithSelector() const noexcept
340 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
343 bool isVariantWithIntegerSelector() const noexcept
345 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
348 bool isVariantWithUnsignedIntegerSelector() const noexcept
350 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
353 bool isVariantWithSignedIntegerSelector() const noexcept
355 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
358 template <typename FieldClassT>
359 FieldClassT as() const noexcept
361 return FieldClassT {this->libObjPtr()};
364 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
365 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
366 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
367 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
368 const bt_field_class_enumeration_unsigned_mapping>>
369 asUnsignedEnumeration() const noexcept;
371 CommonEnumerationFieldClass<
372 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
373 asSignedEnumeration() const noexcept;
375 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
376 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
377 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
378 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
379 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
380 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
381 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
383 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
384 asOptionWithUnsignedIntegerSelector() const noexcept;
386 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
387 asOptionWithSignedIntegerSelector() const noexcept;
389 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
390 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
391 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
393 CommonVariantWithIntegerSelectorFieldClass<
394 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
395 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
396 asVariantWithUnsignedIntegerSelector() const noexcept;
398 CommonVariantWithIntegerSelectorFieldClass<
399 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
400 const bt_field_class_variant_with_selector_field_integer_signed_option>>
401 asVariantWithSignedIntegerSelector() const noexcept;
403 template <typename LibValT>
404 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
406 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstFieldClass`.");
408 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
411 UserAttributes userAttributes() const noexcept
413 return UserAttributes {
414 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
417 Shared shared() const noexcept
419 return Shared::createWithRef(*this);
423 bool _libTypeIs(const bt_field_class_type type) const noexcept
425 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
429 using FieldClass = CommonFieldClass<bt_field_class>;
430 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
434 struct FieldClassTypeDescr
436 using Const = ConstFieldClass;
437 using NonConst = FieldClass;
441 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
446 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
450 } /* namespace internal */
452 template <typename LibObjT>
453 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
456 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
457 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
460 using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
462 explicit CommonBitArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
463 _ThisCommonFieldClass {libObjPtr}
465 BT_ASSERT_DBG(this->isBitArray());
468 template <typename OtherLibObjT>
469 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
470 _ThisCommonFieldClass {fc}
474 template <typename OtherLibObjT>
475 CommonBitArrayFieldClass<LibObjT>&
476 operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
478 _ThisCommonFieldClass::operator=(fc);
482 CommonBitArrayFieldClass<const bt_field_class> asConst() const noexcept
484 return CommonBitArrayFieldClass<const bt_field_class> {*this};
487 std::uint64_t length() const noexcept
489 return bt_field_class_bit_array_get_length(this->libObjPtr());
492 Shared shared() const noexcept
494 return Shared::createWithRef(*this);
498 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
499 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
503 struct BitArrayFieldClassTypeDescr
505 using Const = ConstBitArrayFieldClass;
506 using NonConst = BitArrayFieldClass;
510 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
515 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
519 } /* namespace internal */
521 enum class DisplayBase
523 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
524 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
525 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
526 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
529 template <typename LibObjT>
530 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
533 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
536 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
537 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
540 using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
542 explicit CommonIntegerFieldClass(const _LibObjPtr libObjPtr) noexcept :
543 _ThisCommonFieldClass {libObjPtr}
545 BT_ASSERT_DBG(this->isInteger());
548 template <typename OtherLibObjT>
549 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
550 _ThisCommonFieldClass {fc}
554 template <typename OtherLibObjT>
555 CommonIntegerFieldClass& operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
557 _ThisCommonFieldClass::operator=(fc);
561 CommonIntegerFieldClass<const bt_field_class> asConst() const noexcept
563 return CommonIntegerFieldClass<const bt_field_class> {*this};
566 void fieldValueRange(const std::uint64_t n) const noexcept
568 static_assert(!std::is_const<LibObjT>::value,
569 "Not available with `bt2::ConstIntegerFieldClass`.");
571 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
574 std::uint64_t fieldValueRange() const noexcept
576 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
579 void preferredDisplayBase(const DisplayBase base) const noexcept
581 static_assert(!std::is_const<LibObjT>::value,
582 "Not available with `bt2::ConstIntegerFieldClass`.");
584 bt_field_class_integer_set_preferred_display_base(
585 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
588 DisplayBase preferredDisplayBase() const noexcept
590 return static_cast<DisplayBase>(
591 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
594 Shared shared() const noexcept
596 return Shared::createWithRef(*this);
600 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
601 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
605 struct IntegerFieldClassTypeDescr
607 using Const = ConstIntegerFieldClass;
608 using NonConst = IntegerFieldClass;
612 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
617 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
621 } /* namespace internal */
625 template <typename LibObjT>
626 struct ConstEnumerationFieldClassMappingSpec;
628 /* Functions specific to unsigned enumeration field class mappings */
630 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
633 static const bt_integer_range_set_unsigned *
634 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
636 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
640 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
642 return bt_field_class_enumeration_mapping_get_label(
643 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
647 /* Functions specific to signed enumeration field class mappings */
649 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
651 static const bt_integer_range_set_signed *
652 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
654 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
658 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
660 return bt_field_class_enumeration_mapping_get_label(
661 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
665 } /* namespace internal */
667 template <typename LibObjT>
668 class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
671 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
672 using typename BorrowedObject<LibObjT>::_LibObjPtr;
675 using RangeSet = typename std::conditional<
676 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
677 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
679 explicit ConstEnumerationFieldClassMapping(const _LibObjPtr libObjPtr) noexcept :
680 _ThisBorrowedObject {libObjPtr}
684 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
685 _ThisBorrowedObject {mapping}
689 ConstEnumerationFieldClassMapping&
690 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
692 _ThisBorrowedObject::operator=(mapping);
696 RangeSet ranges() const noexcept
699 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
702 bpstd::string_view label() const noexcept
704 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
708 using ConstUnsignedEnumerationFieldClassMapping =
709 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
711 using ConstSignedEnumerationFieldClassMapping =
712 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
716 template <typename MappingT>
717 struct CommonEnumerationFieldClassSpec;
719 /* Functions specific to unsigned enumeration field classes */
721 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
723 static const bt_field_class_enumeration_unsigned_mapping *
724 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
726 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
729 static const bt_field_class_enumeration_unsigned_mapping *
730 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
732 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
735 static bt_field_class_enumeration_add_mapping_status
736 addMapping(bt_field_class * const libObjPtr, const char * const label,
737 const bt_integer_range_set_unsigned * const libRanges) noexcept
739 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
743 /* Functions specific to signed enumeration field classes */
745 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
747 static const bt_field_class_enumeration_signed_mapping *
748 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
750 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
753 static const bt_field_class_enumeration_signed_mapping *
754 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
756 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
759 static bt_field_class_enumeration_add_mapping_status
760 addMapping(bt_field_class * const libObjPtr, const char * const label,
761 const bt_integer_range_set_signed * const libRanges) noexcept
763 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
767 } /* namespace internal */
769 template <typename LibObjT>
770 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
773 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
776 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
777 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
780 using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
782 explicit CommonBaseEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
783 _ThisCommonIntegerFieldClass {libObjPtr}
785 BT_ASSERT_DBG(this->isEnumeration());
788 template <typename OtherLibObjT>
789 CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
791 _ThisCommonIntegerFieldClass {fc}
795 template <typename OtherLibObjT>
796 CommonBaseEnumerationFieldClass&
797 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
799 _ThisCommonIntegerFieldClass::operator=(fc);
803 CommonBaseEnumerationFieldClass<const bt_field_class> asConst() const noexcept
805 return CommonBaseEnumerationFieldClass<const bt_field_class> {*this};
808 std::uint64_t length() const noexcept
810 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
813 Shared shared() const noexcept
815 return Shared::createWithRef(*this);
819 template <typename LibObjT, typename MappingT>
820 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
823 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
824 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
827 using Shared = SharedFieldClass<CommonEnumerationFieldClass, LibObjT>;
828 using Iterator = BorrowedObjectIterator<CommonEnumerationFieldClass>;
829 using Mapping = MappingT;
831 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
832 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
834 BT_ASSERT_DBG(this->isEnumeration());
837 template <typename OtherLibObjT>
838 CommonEnumerationFieldClass(
839 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
840 CommonEnumerationFieldClass {fc}
844 template <typename OtherLibObjT>
845 CommonEnumerationFieldClass&
846 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
848 CommonEnumerationFieldClass::operator=(fc);
852 Mapping operator[](const std::uint64_t index) const noexcept
854 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
855 this->libObjPtr(), index)};
858 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
860 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
861 this->libObjPtr(), label);
864 return Mapping {libObjPtr};
867 return nonstd::nullopt;
870 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
872 return (*this)[label.data()];
875 void addMapping(const char * const label, const typename Mapping::RangeSet ranges) const
877 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
878 this->libObjPtr(), label, ranges.libObjPtr());
880 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
881 throw MemoryError {};
885 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges) const
887 this->addMapping(label.data(), ranges);
890 Iterator begin() const noexcept
892 return Iterator {*this, 0};
895 Iterator end() const noexcept
897 return Iterator {*this, this->length()};
900 Shared shared() const noexcept
902 return Shared::createWithRef(*this);
906 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
907 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
909 using UnsignedEnumerationFieldClass =
910 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
912 using ConstUnsignedEnumerationFieldClass =
913 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
915 using SignedEnumerationFieldClass =
916 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
918 using ConstSignedEnumerationFieldClass =
919 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
923 struct UnsignedEnumerationFieldClassTypeDescr
925 using Const = ConstUnsignedEnumerationFieldClass;
926 using NonConst = UnsignedEnumerationFieldClass;
930 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
935 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
939 struct SignedEnumerationFieldClassTypeDescr
941 using Const = ConstSignedEnumerationFieldClass;
942 using NonConst = SignedEnumerationFieldClass;
946 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
951 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
955 template <typename LibObjT>
956 struct CommonStructureFieldClassMemberSpec;
958 /* Functions specific to mutable structure field class members */
960 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
962 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
964 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
967 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
969 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
973 /* Functions specific to constant structure field class members */
975 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
977 static const bt_field_class *
978 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
980 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
983 static const bt_value *
984 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
986 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
990 } /* namespace internal */
992 template <typename LibObjT>
993 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
996 using typename BorrowedObject<LibObjT>::_LibObjPtr;
997 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
998 using _FieldClass = internal::DepFc<LibObjT>;
1001 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1003 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
1004 _ThisBorrowedObject {libObjPtr}
1008 template <typename OtherLibObjT>
1009 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1011 _ThisBorrowedObject {fc}
1015 template <typename OtherLibObjT>
1016 CommonStructureFieldClassMember<LibObjT>&
1017 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1019 _ThisBorrowedObject::operator=(fc);
1023 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1025 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1028 bpstd::string_view name() const noexcept
1030 return bt_field_class_structure_member_get_name(this->libObjPtr());
1033 _FieldClass fieldClass() const noexcept
1035 return _FieldClass {
1036 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1039 template <typename LibValT>
1040 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1042 static_assert(!std::is_const<LibObjT>::value,
1043 "Not available with `bt2::ConstStructureFieldClassMember`.");
1045 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1046 userAttrs.libObjPtr());
1049 UserAttributes userAttributes() const noexcept
1051 return UserAttributes {
1052 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1053 this->libObjPtr())};
1057 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1059 using ConstStructureFieldClassMember =
1060 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1062 namespace internal {
1064 struct StructureFieldClassMemberTypeDescr
1066 using Const = ConstStructureFieldClassMember;
1067 using NonConst = StructureFieldClassMember;
1071 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1076 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1080 template <typename LibObjT>
1081 struct CommonStructureFieldClassSpec;
1083 /* Functions specific to mutable structure field classes */
1085 struct CommonStructureFieldClassSpec<bt_field_class> final
1087 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1088 const std::uint64_t index) noexcept
1090 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1093 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1094 const char * const name) noexcept
1096 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1100 /* Functions specific to constant structure field classes */
1102 struct CommonStructureFieldClassSpec<const bt_field_class> final
1104 static const bt_field_class_structure_member *
1105 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1107 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1110 static const bt_field_class_structure_member *
1111 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1113 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1117 } /* namespace internal */
1119 template <typename LibObjT>
1120 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1123 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1124 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1127 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1128 using Iterator = BorrowedObjectIterator<CommonStructureFieldClass<LibObjT>>;
1131 internal::DepType<LibObjT, StructureFieldClassMember, ConstStructureFieldClassMember>;
1133 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1134 _ThisCommonFieldClass {libObjPtr}
1136 BT_ASSERT_DBG(this->isStructure());
1139 template <typename OtherLibObjT>
1140 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1141 _ThisCommonFieldClass {fc}
1145 template <typename OtherLibObjT>
1146 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1148 _ThisCommonFieldClass::operator=(fc);
1152 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1154 return CommonStructureFieldClass<const bt_field_class> {*this};
1157 void appendMember(const char * const name, const FieldClass fc) const
1159 static_assert(!std::is_const<LibObjT>::value,
1160 "Not available with `bt2::ConstStructureFieldClass`.");
1163 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1165 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1166 throw MemoryError {};
1170 void appendMember(const std::string& name, const FieldClass fc) const
1172 this->appendMember(name.data(), fc);
1175 std::uint64_t length() const noexcept
1177 return bt_field_class_structure_get_member_count(this->libObjPtr());
1180 Iterator begin() const noexcept
1182 return Iterator {*this, 0};
1185 Iterator end() const noexcept
1187 return Iterator {*this, this->length()};
1190 Member operator[](const std::uint64_t index) const noexcept
1192 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1193 this->libObjPtr(), index)};
1196 nonstd::optional<Member> operator[](const char * const name) const noexcept
1198 const auto libObjPtr =
1199 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1202 return Member {libObjPtr};
1205 return nonstd::nullopt;
1208 nonstd::optional<Member> operator[](const std::string& name) const noexcept
1210 return (*this)[name.data()];
1213 Shared shared() const noexcept
1215 return Shared::createWithRef(*this);
1219 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1220 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1222 namespace internal {
1224 struct StructureFieldClassTypeDescr
1226 using Const = ConstStructureFieldClass;
1227 using NonConst = StructureFieldClass;
1231 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1236 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1240 template <typename LibObjT>
1241 struct CommonArrayFieldClassSpec;
1243 /* Functions specific to mutable array field classes */
1245 struct CommonArrayFieldClassSpec<bt_field_class> final
1247 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1249 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1253 /* Functions specific to constant array field classes */
1255 struct CommonArrayFieldClassSpec<const bt_field_class> final
1257 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1259 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1263 } /* namespace internal */
1265 template <typename LibObjT>
1266 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1269 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1270 using _FieldClass = internal::DepFc<LibObjT>;
1273 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1274 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1277 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1279 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1280 _ThisCommonFieldClass {libObjPtr}
1282 BT_ASSERT_DBG(this->isArray());
1285 template <typename OtherLibObjT>
1286 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1287 _ThisCommonFieldClass {fc}
1291 template <typename OtherLibObjT>
1292 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1294 _ThisCommonFieldClass::operator=(fc);
1298 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1300 return CommonArrayFieldClass<const bt_field_class> {*this};
1303 _FieldClass elementFieldClass() const noexcept
1305 return _FieldClass {
1306 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1309 Shared shared() const noexcept
1311 return Shared::createWithRef(*this);
1315 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1316 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1318 namespace internal {
1320 struct ArrayFieldClassTypeDescr
1322 using Const = ConstArrayFieldClass;
1323 using NonConst = ArrayFieldClass;
1327 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1332 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1336 } /* namespace internal */
1338 template <typename LibObjT>
1339 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1342 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1343 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1346 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1348 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1349 _ThisCommonArrayFieldClass {libObjPtr}
1351 BT_ASSERT_DBG(this->isStaticArray());
1354 template <typename OtherLibObjT>
1355 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1356 _ThisCommonArrayFieldClass {fc}
1360 template <typename OtherLibObjT>
1361 CommonStaticArrayFieldClass&
1362 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1364 _ThisCommonArrayFieldClass::operator=(fc);
1368 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1370 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1373 std::uint64_t length() const noexcept
1375 return bt_field_class_array_static_get_length(this->libObjPtr());
1378 Shared shared() const noexcept
1380 return Shared::createWithRef(*this);
1384 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1385 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1387 namespace internal {
1389 struct StaticArrayFieldClassTypeDescr
1391 using Const = ConstStaticArrayFieldClass;
1392 using NonConst = StaticArrayFieldClass;
1396 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1401 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1405 } /* namespace internal */
1407 template <typename LibObjT>
1408 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1411 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1412 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1415 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1417 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1418 _ThisCommonArrayFieldClass {libObjPtr}
1420 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1423 template <typename OtherLibObjT>
1424 CommonDynamicArrayWithLengthFieldClass(
1425 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1426 _ThisCommonArrayFieldClass {fc}
1430 template <typename OtherLibObjT>
1431 CommonDynamicArrayWithLengthFieldClass&
1432 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1434 _ThisCommonArrayFieldClass::operator=(fc);
1438 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1440 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1443 ConstFieldPath lengthFieldPath() const noexcept
1445 return ConstFieldPath {
1446 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1447 this->libObjPtr())};
1450 Shared shared() const noexcept
1452 return Shared::createWithRef(*this);
1456 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1458 using ConstDynamicArrayWithLengthFieldClass =
1459 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1461 namespace internal {
1463 struct DynamicArrayWithLengthFieldClassTypeDescr
1465 using Const = ConstDynamicArrayWithLengthFieldClass;
1466 using NonConst = DynamicArrayWithLengthFieldClass;
1470 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1471 public DynamicArrayWithLengthFieldClassTypeDescr
1476 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1477 public DynamicArrayWithLengthFieldClassTypeDescr
1481 template <typename LibObjT>
1482 struct CommonOptionFieldClassSpec;
1484 /* Functions specific to mutable option field classes */
1486 struct CommonOptionFieldClassSpec<bt_field_class> final
1488 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1490 return bt_field_class_option_borrow_field_class(libObjPtr);
1494 /* Functions specific to constant option field classes */
1496 struct CommonOptionFieldClassSpec<const bt_field_class> final
1498 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1500 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1504 } /* namespace internal */
1506 template <typename LibObjT>
1507 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1510 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1511 using _FieldClass = internal::DepFc<LibObjT>;
1514 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1515 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1518 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1520 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1521 _ThisCommonFieldClass {libObjPtr}
1523 BT_ASSERT_DBG(this->isOption());
1526 template <typename OtherLibObjT>
1527 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1528 _ThisCommonFieldClass {fc}
1532 template <typename OtherLibObjT>
1533 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1535 _ThisCommonFieldClass::operator=(fc);
1539 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1541 return CommonOptionFieldClass<const bt_field_class> {*this};
1544 _FieldClass fieldClass() const noexcept
1546 return _FieldClass {
1547 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1550 Shared shared() const noexcept
1552 return Shared::createWithRef(*this);
1556 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1557 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1559 namespace internal {
1561 struct OptionFieldClassTypeDescr
1563 using Const = ConstOptionFieldClass;
1564 using NonConst = OptionFieldClass;
1568 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1573 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1577 } /* namespace internal */
1579 template <typename LibObjT>
1580 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1583 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1586 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1587 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1590 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1592 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1593 _ThisCommonOptionFieldClass {libObjPtr}
1595 BT_ASSERT_DBG(this->isOptionWithSelector());
1598 template <typename OtherLibObjT>
1599 CommonOptionWithSelectorFieldClass(
1600 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1601 _ThisCommonOptionFieldClass {fc}
1605 template <typename OtherLibObjT>
1606 CommonOptionWithSelectorFieldClass&
1607 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1609 _ThisCommonOptionFieldClass::operator=(fc);
1613 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1615 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1618 ConstFieldPath selectorFieldPath() const noexcept
1620 return ConstFieldPath {
1621 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1622 this->libObjPtr())};
1625 Shared shared() const noexcept
1627 return Shared::createWithRef(*this);
1631 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1632 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1634 namespace internal {
1636 struct OptionWithSelectorFieldClassTypeDescr
1638 using Const = ConstOptionWithSelectorFieldClass;
1639 using NonConst = OptionWithSelectorFieldClass;
1643 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1648 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1652 } /* namespace internal */
1654 template <typename LibObjT>
1655 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1658 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1660 using typename CommonOptionWithSelectorFieldClass<
1661 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1664 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1666 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1667 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1669 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1672 template <typename OtherLibObjT>
1673 CommonOptionWithBoolSelectorFieldClass(
1674 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1675 _ThisCommonOptionWithSelectorFieldClass {fc}
1679 template <typename OtherLibObjT>
1680 CommonOptionWithBoolSelectorFieldClass&
1681 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1683 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1687 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1689 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1692 bool selectorIsReversed() const noexcept
1694 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1698 Shared shared() const noexcept
1700 return Shared::createWithRef(*this);
1704 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1706 using ConstOptionWithBoolSelectorFieldClass =
1707 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1709 namespace internal {
1711 struct OptionWithBoolSelectorFieldClassTypeDescr
1713 using Const = ConstOptionWithBoolSelectorFieldClass;
1714 using NonConst = OptionWithBoolSelectorFieldClass;
1718 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1719 public OptionWithBoolSelectorFieldClassTypeDescr
1724 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1725 public OptionWithBoolSelectorFieldClassTypeDescr
1729 template <typename RangeSetT>
1730 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1732 /* Functions specific to option field classes with unsigned integer ranges */
1734 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1736 static const bt_integer_range_set_unsigned *
1737 ranges(const bt_field_class * const libObjPtr) noexcept
1739 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1744 /* Functions specific to option field classes with signed ranges */
1746 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1748 static const bt_integer_range_set_signed *
1749 ranges(const bt_field_class * const libObjPtr) noexcept
1751 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1756 } /* namespace internal */
1758 template <typename LibObjT, typename RangeSetT>
1759 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1762 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1764 using typename CommonOptionWithSelectorFieldClass<
1765 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1768 using Shared = SharedFieldClass<CommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1769 using RangeSet = RangeSetT;
1771 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1772 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1774 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1777 template <typename OtherLibObjT>
1778 CommonOptionWithIntegerSelectorFieldClass(
1779 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1780 _ThisCommonOptionWithSelectorFieldClass {fc}
1784 template <typename OtherLibObjT>
1785 CommonOptionWithIntegerSelectorFieldClass&
1786 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1788 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1792 RangeSet ranges() const noexcept
1794 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1795 this->libObjPtr())};
1798 Shared shared() const noexcept
1800 return Shared::createWithRef(*this);
1804 using OptionWithUnsignedIntegerSelectorFieldClass =
1805 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1807 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1808 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1810 using OptionWithSignedIntegerSelectorFieldClass =
1811 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1813 using ConstOptionWithSignedIntegerSelectorFieldClass =
1814 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1816 namespace internal {
1818 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1820 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1821 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1825 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1826 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1831 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1832 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1836 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1838 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1839 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1843 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1844 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1849 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1850 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1854 template <typename LibObjT>
1855 struct CommonVariantFieldClassOptionSpec;
1857 /* Functions specific to mutable variant field class options */
1859 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1861 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1863 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1866 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1868 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1872 /* Functions specific to constant variant field class options */
1874 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1876 static const bt_field_class *
1877 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1879 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1882 static const bt_value *
1883 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1885 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1889 } /* namespace internal */
1891 template <typename LibObjT>
1892 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1895 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1896 using typename BorrowedObject<LibObjT>::_LibObjPtr;
1897 using _FieldClass = internal::DepFc<LibObjT>;
1900 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1902 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1903 _ThisBorrowedObject {libObjPtr}
1907 template <typename OtherLibObjT>
1908 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1909 _ThisBorrowedObject {fc}
1913 template <typename OtherLibObjT>
1914 CommonVariantFieldClassOption&
1915 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1917 _ThisBorrowedObject::operator=(fc);
1921 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1923 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1926 nonstd::optional<bpstd::string_view> name() const noexcept
1928 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1934 return nonstd::nullopt;
1937 _FieldClass fieldClass() const noexcept
1939 return _FieldClass {
1940 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1943 template <typename LibValT>
1944 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1946 static_assert(!std::is_const<LibObjT>::value,
1947 "Not available with `bt2::ConstVariantFieldClassOption`.");
1949 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1952 UserAttributes userAttributes() const noexcept
1954 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1955 this->libObjPtr())};
1959 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1961 using ConstVariantFieldClassOption =
1962 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1964 namespace internal {
1966 struct VariantFieldClassOptionTypeDescr
1968 using Const = ConstVariantFieldClassOption;
1969 using NonConst = VariantFieldClassOption;
1973 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1978 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1982 template <typename LibObjT>
1983 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1985 /* Functions specific to variant field class options with unsigned integer selector */
1987 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1988 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1991 static const bt_integer_range_set_unsigned *
1992 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1993 * const libObjPtr) noexcept
1995 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1999 static const bt_field_class_variant_option *
2000 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
2001 * const libObjPtr) noexcept
2003 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
2008 /* Functions specific to variant field class options with signed integer selector */
2010 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2011 const bt_field_class_variant_with_selector_field_integer_signed_option>
2014 static const bt_integer_range_set_signed *
2015 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
2016 * const libObjPtr) noexcept
2018 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
2022 static const bt_field_class_variant_option *
2023 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
2024 * const libObjPtr) noexcept
2026 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2031 } /* namespace internal */
2033 template <typename LibObjT>
2034 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2037 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2038 using typename BorrowedObject<LibObjT>::_LibObjPtr;
2039 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2042 using RangeSet = typename std::conditional<
2045 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2046 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2048 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2049 _ThisBorrowedObject {libObjPtr}
2053 template <typename OtherLibObjT>
2054 ConstVariantWithIntegerSelectorFieldClassOption(
2055 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2056 _ThisBorrowedObject {fc}
2060 template <typename OtherLibObjT>
2061 ConstVariantWithIntegerSelectorFieldClassOption&
2062 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2064 _ThisBorrowedObject::operator=(fc);
2068 ConstVariantFieldClassOption asBaseOption() const noexcept
2070 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2073 nonstd::optional<bpstd::string_view> name() const noexcept
2075 return this->asBaseOption().name();
2078 ConstFieldClass fieldClass() const noexcept
2080 return this->asBaseOption().fieldClass();
2083 RangeSet ranges() const noexcept
2085 return RangeSet {_Spec::ranges(this->libObjPtr())};
2089 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2090 ConstVariantWithIntegerSelectorFieldClassOption<
2091 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2093 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2094 ConstVariantWithIntegerSelectorFieldClassOption<
2095 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2097 namespace internal {
2099 template <typename LibObjT>
2100 struct CommonVariantFieldClassSpec;
2102 /* Functions specific to mutable variant field classes */
2104 struct CommonVariantFieldClassSpec<bt_field_class> final
2106 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2107 const std::uint64_t index) noexcept
2109 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2112 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2113 const char * const name) noexcept
2115 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2119 /* Functions specific to constant variant field classes */
2121 struct CommonVariantFieldClassSpec<const bt_field_class> final
2123 static const bt_field_class_variant_option *
2124 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2126 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2129 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2130 const char * const name) noexcept
2132 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2136 } /* namespace internal */
2138 template <typename LibObjT>
2139 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2142 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2145 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2146 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2149 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2150 using Iterator = BorrowedObjectIterator<CommonVariantFieldClass>;
2153 internal::DepType<LibObjT, VariantFieldClassOption, ConstVariantFieldClassOption>;
2155 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2156 _ThisCommonFieldClass {libObjPtr}
2158 BT_ASSERT_DBG(this->isVariant());
2161 template <typename OtherLibObjT>
2162 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2163 _ThisCommonFieldClass {fc}
2167 template <typename OtherLibObjT>
2168 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2170 _ThisCommonFieldClass::operator=(fc);
2174 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2176 return CommonVariantFieldClass<const bt_field_class> {*this};
2179 std::uint64_t length() const noexcept
2181 return bt_field_class_variant_get_option_count(this->libObjPtr());
2184 Iterator begin() const noexcept
2186 return Iterator {*this, 0};
2189 Iterator end() const noexcept
2191 return Iterator {*this, this->length()};
2194 Option operator[](const std::uint64_t index) const noexcept
2196 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2197 this->libObjPtr(), index)};
2200 nonstd::optional<Option> operator[](const char * const name) const noexcept
2202 const auto libObjPtr =
2203 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2206 return Option {libObjPtr};
2209 return nonstd::nullopt;
2212 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2214 return (*this)[name.data()];
2217 Shared shared() const noexcept
2219 return Shared::createWithRef(*this);
2223 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2224 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2226 namespace internal {
2228 struct VariantFieldClassTypeDescr
2230 using Const = ConstVariantFieldClass;
2231 using NonConst = VariantFieldClass;
2235 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2240 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2244 } /* namespace internal */
2246 template <typename LibObjT>
2247 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2250 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2251 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2254 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2256 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2257 _ThisCommonVariantFieldClass {libObjPtr}
2259 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2262 template <typename OtherLibObjT>
2263 CommonVariantWithoutSelectorFieldClass(
2264 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2265 _ThisCommonVariantFieldClass {fc}
2269 template <typename OtherLibObjT>
2270 CommonVariantWithoutSelectorFieldClass&
2271 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2273 _ThisCommonVariantFieldClass::operator=(fc);
2277 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2279 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2282 void appendOption(const char * const name, const FieldClass fc) const
2284 static_assert(!std::is_const<LibObjT>::value,
2285 "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");
2287 const auto status = bt_field_class_variant_without_selector_append_option(
2288 this->libObjPtr(), name, fc.libObjPtr());
2291 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2292 throw MemoryError {};
2296 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc) const
2298 this->appendOption(name ? name->data() : nullptr, fc);
2301 Shared shared() const noexcept
2303 return Shared::createWithRef(*this);
2307 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2308 using ConstVariantWithoutSelectorFieldClass =
2309 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2311 namespace internal {
2313 struct VariantWithoutSelectorFieldClassTypeDescr
2315 using Const = ConstVariantWithoutSelectorFieldClass;
2316 using NonConst = VariantWithoutSelectorFieldClass;
2320 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2321 public VariantWithoutSelectorFieldClassTypeDescr
2326 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2327 public VariantWithoutSelectorFieldClassTypeDescr
2331 template <typename OptionT>
2332 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2334 /* Functions specific to variant field classes with unsigned integer selector */
2336 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2337 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2340 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2341 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2343 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2347 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2348 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2350 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2354 static bt_field_class_variant_with_selector_field_integer_append_option_status
2355 appendOption(bt_field_class * const libObjPtr, const char * const name,
2356 bt_field_class * const libOptFcPtr,
2357 const bt_integer_range_set_unsigned * const libRangesPtr)
2359 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2360 libObjPtr, name, libOptFcPtr, libRangesPtr);
2364 /* Functions specific to variant field classes with signed integer selector */
2366 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2367 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2370 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2371 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2373 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2377 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2378 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2380 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2384 static bt_field_class_variant_with_selector_field_integer_append_option_status
2385 appendOption(bt_field_class * const libObjPtr, const char * const name,
2386 bt_field_class * const libOptFcPtr,
2387 const bt_integer_range_set_signed * const libRangesPtr)
2389 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2390 libObjPtr, name, libOptFcPtr, libRangesPtr);
2394 } /* namespace internal */
2396 template <typename LibObjT>
2397 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2400 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2403 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2404 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2407 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2409 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2410 _ThisCommonVariantFieldClass {libObjPtr}
2412 BT_ASSERT_DBG(this->isVariantWithSelector());
2415 template <typename OtherLibObjT>
2416 CommonVariantWithSelectorFieldClass(
2417 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2418 _ThisCommonVariantFieldClass {fc}
2422 template <typename OtherLibObjT>
2423 CommonVariantWithSelectorFieldClass&
2424 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2426 _ThisCommonVariantFieldClass::operator=(fc);
2430 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2432 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2435 ConstFieldPath selectorFieldPath() const noexcept
2437 return ConstFieldPath {
2438 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2439 this->libObjPtr())};
2442 Shared shared() const noexcept
2444 return Shared::createWithRef(*this);
2448 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2449 using ConstVariantWithSelectorFieldClass =
2450 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2452 template <typename LibObjT, typename OptionT>
2453 class CommonVariantWithIntegerSelectorFieldClass :
2454 public CommonVariantWithSelectorFieldClass<LibObjT>
2457 using typename CommonVariantWithSelectorFieldClass<
2458 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2459 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2461 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2464 using Shared = SharedFieldClass<CommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2465 using Option = OptionT;
2468 BorrowedObjectIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>>;
2470 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2471 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2473 BT_ASSERT_DBG(this->isVariant());
2476 template <typename OtherLibObjT>
2477 CommonVariantWithIntegerSelectorFieldClass(
2478 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2479 _ThisCommonVariantWithSelectorFieldClass {fc}
2483 template <typename OtherLibObjT>
2484 CommonVariantWithIntegerSelectorFieldClass&
2485 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2487 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2491 Option operator[](const std::uint64_t index) const noexcept
2493 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2496 nonstd::optional<Option> operator[](const char * const name) const noexcept
2498 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2501 return Option {libObjPtr};
2504 return nonstd::nullopt;
2507 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2509 return (*this)[name.data()];
2512 void appendOption(const char * const name, const FieldClass fc,
2513 const typename Option::RangeSet ranges) const
2516 !std::is_const<LibObjT>::value,
2517 "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");
2520 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2523 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2524 throw MemoryError {};
2528 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc,
2529 const typename Option::RangeSet ranges) const
2531 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2534 Iterator begin() const noexcept
2536 return Iterator {*this, 0};
2539 Iterator end() const noexcept
2541 return Iterator {*this, this->length()};
2544 Shared shared() const noexcept
2546 return Shared::createWithRef(*this);
2550 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2551 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2553 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2554 CommonVariantWithIntegerSelectorFieldClass<
2555 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2557 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2558 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2560 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2561 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2563 namespace internal {
2565 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2567 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2568 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2572 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2573 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2578 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2579 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2583 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2585 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2586 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2590 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2591 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2596 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2597 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2601 } /* namespace internal */
2603 template <typename LibObjT>
2604 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2606 BT_ASSERT_DBG(this->isBitArray());
2607 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2610 template <typename LibObjT>
2611 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2613 BT_ASSERT_DBG(this->isInteger());
2614 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2617 template <typename LibObjT>
2618 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2620 BT_ASSERT_DBG(this->isEnumeration());
2621 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2624 template <typename LibObjT>
2625 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2626 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2628 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2629 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2633 template <typename LibObjT>
2634 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2635 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2637 BT_ASSERT_DBG(this->isSignedEnumeration());
2638 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2642 template <typename LibObjT>
2643 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2645 BT_ASSERT_DBG(this->isStructure());
2646 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2649 template <typename LibObjT>
2650 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2652 BT_ASSERT_DBG(this->isArray());
2653 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2656 template <typename LibObjT>
2657 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2659 BT_ASSERT_DBG(this->isStaticArray());
2660 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2663 template <typename LibObjT>
2664 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2665 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2667 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2668 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2671 template <typename LibObjT>
2672 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2674 BT_ASSERT_DBG(this->isOption());
2675 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2678 template <typename LibObjT>
2679 CommonOptionWithSelectorFieldClass<LibObjT>
2680 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2682 BT_ASSERT_DBG(this->isOptionWithSelector());
2683 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2686 template <typename LibObjT>
2687 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2688 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2690 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2691 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2694 template <typename LibObjT>
2695 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2696 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2698 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2699 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2703 template <typename LibObjT>
2704 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2705 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2707 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2708 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2712 template <typename LibObjT>
2713 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2715 BT_ASSERT_DBG(this->isVariant());
2716 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2719 template <typename LibObjT>
2720 CommonVariantWithoutSelectorFieldClass<LibObjT>
2721 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2723 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2724 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2727 template <typename LibObjT>
2728 CommonVariantWithSelectorFieldClass<LibObjT>
2729 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2731 BT_ASSERT_DBG(this->isVariantWithSelector());
2732 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2735 template <typename LibObjT>
2736 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2737 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2738 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2740 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2741 return CommonVariantWithIntegerSelectorFieldClass<
2742 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2745 template <typename LibObjT>
2746 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2747 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2748 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2750 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2751 return CommonVariantWithIntegerSelectorFieldClass<
2752 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2755 } /* namespace bt2 */
2757 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */