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;
825 using _ThisCommonEnumerationFieldClass = CommonEnumerationFieldClass<LibObjT, MappingT>;
828 using Shared = SharedFieldClass<_ThisCommonEnumerationFieldClass, LibObjT>;
829 using Iterator = BorrowedObjectIterator<CommonEnumerationFieldClass>;
830 using Mapping = MappingT;
832 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
833 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
835 BT_ASSERT_DBG(this->isEnumeration());
838 template <typename OtherLibObjT>
839 CommonEnumerationFieldClass(
840 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
841 _ThisCommonEnumerationFieldClass {fc}
845 template <typename OtherLibObjT>
846 CommonEnumerationFieldClass&
847 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
849 _ThisCommonEnumerationFieldClass::operator=(fc);
853 Mapping operator[](const std::uint64_t index) const noexcept
855 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
856 this->libObjPtr(), index)};
859 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
861 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
862 this->libObjPtr(), label);
865 return Mapping {libObjPtr};
868 return nonstd::nullopt;
871 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
873 return (*this)[label.data()];
876 void addMapping(const char * const label, const typename Mapping::RangeSet ranges) const
878 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
879 this->libObjPtr(), label, ranges.libObjPtr());
881 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
882 throw MemoryError {};
886 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges) const
888 this->addMapping(label.data(), ranges);
891 Iterator begin() const noexcept
893 return Iterator {*this, 0};
896 Iterator end() const noexcept
898 return Iterator {*this, this->length()};
901 Shared shared() const noexcept
903 return Shared::createWithRef(*this);
907 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
908 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
910 using UnsignedEnumerationFieldClass =
911 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
913 using ConstUnsignedEnumerationFieldClass =
914 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
916 using SignedEnumerationFieldClass =
917 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
919 using ConstSignedEnumerationFieldClass =
920 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
924 struct UnsignedEnumerationFieldClassTypeDescr
926 using Const = ConstUnsignedEnumerationFieldClass;
927 using NonConst = UnsignedEnumerationFieldClass;
931 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
936 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
940 struct SignedEnumerationFieldClassTypeDescr
942 using Const = ConstSignedEnumerationFieldClass;
943 using NonConst = SignedEnumerationFieldClass;
947 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
952 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
956 template <typename LibObjT>
957 struct CommonStructureFieldClassMemberSpec;
959 /* Functions specific to mutable structure field class members */
961 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
963 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
965 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
968 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
970 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
974 /* Functions specific to constant structure field class members */
976 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
978 static const bt_field_class *
979 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
981 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
984 static const bt_value *
985 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
987 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
991 } /* namespace internal */
993 template <typename LibObjT>
994 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
997 using typename BorrowedObject<LibObjT>::_LibObjPtr;
998 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
999 using _FieldClass = internal::DepFc<LibObjT>;
1002 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1004 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
1005 _ThisBorrowedObject {libObjPtr}
1009 template <typename OtherLibObjT>
1010 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1012 _ThisBorrowedObject {fc}
1016 template <typename OtherLibObjT>
1017 CommonStructureFieldClassMember<LibObjT>&
1018 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1020 _ThisBorrowedObject::operator=(fc);
1024 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1026 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1029 bpstd::string_view name() const noexcept
1031 return bt_field_class_structure_member_get_name(this->libObjPtr());
1034 _FieldClass fieldClass() const noexcept
1036 return _FieldClass {
1037 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1040 template <typename LibValT>
1041 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1043 static_assert(!std::is_const<LibObjT>::value,
1044 "Not available with `bt2::ConstStructureFieldClassMember`.");
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>;
1129 using Iterator = BorrowedObjectIterator<CommonStructureFieldClass<LibObjT>>;
1132 internal::DepType<LibObjT, StructureFieldClassMember, ConstStructureFieldClassMember>;
1134 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1135 _ThisCommonFieldClass {libObjPtr}
1137 BT_ASSERT_DBG(this->isStructure());
1140 template <typename OtherLibObjT>
1141 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1142 _ThisCommonFieldClass {fc}
1146 template <typename OtherLibObjT>
1147 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1149 _ThisCommonFieldClass::operator=(fc);
1153 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1155 return CommonStructureFieldClass<const bt_field_class> {*this};
1158 void appendMember(const char * const name, const FieldClass fc) const
1160 static_assert(!std::is_const<LibObjT>::value,
1161 "Not available with `bt2::ConstStructureFieldClass`.");
1164 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1166 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1167 throw MemoryError {};
1171 void appendMember(const std::string& name, const FieldClass fc) const
1173 this->appendMember(name.data(), fc);
1176 std::uint64_t length() const noexcept
1178 return bt_field_class_structure_get_member_count(this->libObjPtr());
1181 Iterator begin() const noexcept
1183 return Iterator {*this, 0};
1186 Iterator end() const noexcept
1188 return Iterator {*this, this->length()};
1191 Member operator[](const std::uint64_t index) const noexcept
1193 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1194 this->libObjPtr(), index)};
1197 nonstd::optional<Member> operator[](const char * const name) const noexcept
1199 const auto libObjPtr =
1200 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1203 return Member {libObjPtr};
1206 return nonstd::nullopt;
1209 nonstd::optional<Member> operator[](const std::string& name) const noexcept
1211 return (*this)[name.data()];
1214 Shared shared() const noexcept
1216 return Shared::createWithRef(*this);
1220 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1221 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1223 namespace internal {
1225 struct StructureFieldClassTypeDescr
1227 using Const = ConstStructureFieldClass;
1228 using NonConst = StructureFieldClass;
1232 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1237 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1241 template <typename LibObjT>
1242 struct CommonArrayFieldClassSpec;
1244 /* Functions specific to mutable array field classes */
1246 struct CommonArrayFieldClassSpec<bt_field_class> final
1248 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1250 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1254 /* Functions specific to constant array field classes */
1256 struct CommonArrayFieldClassSpec<const bt_field_class> final
1258 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1260 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1264 } /* namespace internal */
1266 template <typename LibObjT>
1267 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1270 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1271 using _FieldClass = internal::DepFc<LibObjT>;
1274 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1275 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1278 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1280 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1281 _ThisCommonFieldClass {libObjPtr}
1283 BT_ASSERT_DBG(this->isArray());
1286 template <typename OtherLibObjT>
1287 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1288 _ThisCommonFieldClass {fc}
1292 template <typename OtherLibObjT>
1293 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1295 _ThisCommonFieldClass::operator=(fc);
1299 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1301 return CommonArrayFieldClass<const bt_field_class> {*this};
1304 _FieldClass elementFieldClass() const noexcept
1306 return _FieldClass {
1307 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1310 Shared shared() const noexcept
1312 return Shared::createWithRef(*this);
1316 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1317 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1319 namespace internal {
1321 struct ArrayFieldClassTypeDescr
1323 using Const = ConstArrayFieldClass;
1324 using NonConst = ArrayFieldClass;
1328 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1333 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1337 } /* namespace internal */
1339 template <typename LibObjT>
1340 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1343 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1344 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1347 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1349 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1350 _ThisCommonArrayFieldClass {libObjPtr}
1352 BT_ASSERT_DBG(this->isStaticArray());
1355 template <typename OtherLibObjT>
1356 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1357 _ThisCommonArrayFieldClass {fc}
1361 template <typename OtherLibObjT>
1362 CommonStaticArrayFieldClass&
1363 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1365 _ThisCommonArrayFieldClass::operator=(fc);
1369 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1371 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1374 std::uint64_t length() const noexcept
1376 return bt_field_class_array_static_get_length(this->libObjPtr());
1379 Shared shared() const noexcept
1381 return Shared::createWithRef(*this);
1385 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1386 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1388 namespace internal {
1390 struct StaticArrayFieldClassTypeDescr
1392 using Const = ConstStaticArrayFieldClass;
1393 using NonConst = StaticArrayFieldClass;
1397 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1402 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1406 } /* namespace internal */
1408 template <typename LibObjT>
1409 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1412 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1413 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1416 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1418 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1419 _ThisCommonArrayFieldClass {libObjPtr}
1421 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1424 template <typename OtherLibObjT>
1425 CommonDynamicArrayWithLengthFieldClass(
1426 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1427 _ThisCommonArrayFieldClass {fc}
1431 template <typename OtherLibObjT>
1432 CommonDynamicArrayWithLengthFieldClass&
1433 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1435 _ThisCommonArrayFieldClass::operator=(fc);
1439 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1441 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1444 ConstFieldPath lengthFieldPath() const noexcept
1446 return ConstFieldPath {
1447 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1448 this->libObjPtr())};
1451 Shared shared() const noexcept
1453 return Shared::createWithRef(*this);
1457 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1459 using ConstDynamicArrayWithLengthFieldClass =
1460 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1462 namespace internal {
1464 struct DynamicArrayWithLengthFieldClassTypeDescr
1466 using Const = ConstDynamicArrayWithLengthFieldClass;
1467 using NonConst = DynamicArrayWithLengthFieldClass;
1471 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1472 public DynamicArrayWithLengthFieldClassTypeDescr
1477 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1478 public DynamicArrayWithLengthFieldClassTypeDescr
1482 template <typename LibObjT>
1483 struct CommonOptionFieldClassSpec;
1485 /* Functions specific to mutable option field classes */
1487 struct CommonOptionFieldClassSpec<bt_field_class> final
1489 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1491 return bt_field_class_option_borrow_field_class(libObjPtr);
1495 /* Functions specific to constant option field classes */
1497 struct CommonOptionFieldClassSpec<const bt_field_class> final
1499 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1501 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1505 } /* namespace internal */
1507 template <typename LibObjT>
1508 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1511 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1512 using _FieldClass = internal::DepFc<LibObjT>;
1515 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1516 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1519 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1521 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1522 _ThisCommonFieldClass {libObjPtr}
1524 BT_ASSERT_DBG(this->isOption());
1527 template <typename OtherLibObjT>
1528 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1529 _ThisCommonFieldClass {fc}
1533 template <typename OtherLibObjT>
1534 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1536 _ThisCommonFieldClass::operator=(fc);
1540 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1542 return CommonOptionFieldClass<const bt_field_class> {*this};
1545 _FieldClass fieldClass() const noexcept
1547 return _FieldClass {
1548 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1551 Shared shared() const noexcept
1553 return Shared::createWithRef(*this);
1557 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1558 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1560 namespace internal {
1562 struct OptionFieldClassTypeDescr
1564 using Const = ConstOptionFieldClass;
1565 using NonConst = OptionFieldClass;
1569 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1574 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1578 } /* namespace internal */
1580 template <typename LibObjT>
1581 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1584 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1587 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1588 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1591 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1593 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1594 _ThisCommonOptionFieldClass {libObjPtr}
1596 BT_ASSERT_DBG(this->isOptionWithSelector());
1599 template <typename OtherLibObjT>
1600 CommonOptionWithSelectorFieldClass(
1601 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1602 _ThisCommonOptionFieldClass {fc}
1606 template <typename OtherLibObjT>
1607 CommonOptionWithSelectorFieldClass&
1608 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1610 _ThisCommonOptionFieldClass::operator=(fc);
1614 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1616 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1619 ConstFieldPath selectorFieldPath() const noexcept
1621 return ConstFieldPath {
1622 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1623 this->libObjPtr())};
1626 Shared shared() const noexcept
1628 return Shared::createWithRef(*this);
1632 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1633 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1635 namespace internal {
1637 struct OptionWithSelectorFieldClassTypeDescr
1639 using Const = ConstOptionWithSelectorFieldClass;
1640 using NonConst = OptionWithSelectorFieldClass;
1644 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1649 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1653 } /* namespace internal */
1655 template <typename LibObjT>
1656 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1659 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1661 using typename CommonOptionWithSelectorFieldClass<
1662 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1665 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1667 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1668 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1670 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1673 template <typename OtherLibObjT>
1674 CommonOptionWithBoolSelectorFieldClass(
1675 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1676 _ThisCommonOptionWithSelectorFieldClass {fc}
1680 template <typename OtherLibObjT>
1681 CommonOptionWithBoolSelectorFieldClass&
1682 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1684 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1688 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1690 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1693 bool selectorIsReversed() const noexcept
1695 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1699 Shared shared() const noexcept
1701 return Shared::createWithRef(*this);
1705 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1707 using ConstOptionWithBoolSelectorFieldClass =
1708 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1710 namespace internal {
1712 struct OptionWithBoolSelectorFieldClassTypeDescr
1714 using Const = ConstOptionWithBoolSelectorFieldClass;
1715 using NonConst = OptionWithBoolSelectorFieldClass;
1719 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1720 public OptionWithBoolSelectorFieldClassTypeDescr
1725 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1726 public OptionWithBoolSelectorFieldClassTypeDescr
1730 template <typename RangeSetT>
1731 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1733 /* Functions specific to option field classes with unsigned integer ranges */
1735 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1737 static const bt_integer_range_set_unsigned *
1738 ranges(const bt_field_class * const libObjPtr) noexcept
1740 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1745 /* Functions specific to option field classes with signed ranges */
1747 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1749 static const bt_integer_range_set_signed *
1750 ranges(const bt_field_class * const libObjPtr) noexcept
1752 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1757 } /* namespace internal */
1759 template <typename LibObjT, typename RangeSetT>
1760 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1763 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1765 using typename CommonOptionWithSelectorFieldClass<
1766 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1768 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1769 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1772 using Shared = SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1774 using RangeSet = RangeSetT;
1776 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1777 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1779 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1782 template <typename OtherLibObjT>
1783 CommonOptionWithIntegerSelectorFieldClass(
1784 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1785 _ThisCommonOptionWithSelectorFieldClass {fc}
1789 template <typename OtherLibObjT>
1790 CommonOptionWithIntegerSelectorFieldClass&
1791 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1793 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1797 RangeSet ranges() const noexcept
1799 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1800 this->libObjPtr())};
1803 Shared shared() const noexcept
1805 return Shared::createWithRef(*this);
1809 using OptionWithUnsignedIntegerSelectorFieldClass =
1810 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1812 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1813 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1815 using OptionWithSignedIntegerSelectorFieldClass =
1816 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1818 using ConstOptionWithSignedIntegerSelectorFieldClass =
1819 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1821 namespace internal {
1823 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1825 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1826 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1830 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1831 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1836 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1837 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1841 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1843 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1844 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1848 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1849 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1854 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1855 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1859 template <typename LibObjT>
1860 struct CommonVariantFieldClassOptionSpec;
1862 /* Functions specific to mutable variant field class options */
1864 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1866 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1868 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1871 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1873 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1877 /* Functions specific to constant variant field class options */
1879 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1881 static const bt_field_class *
1882 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1884 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1887 static const bt_value *
1888 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1890 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1894 } /* namespace internal */
1896 template <typename LibObjT>
1897 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1900 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1901 using typename BorrowedObject<LibObjT>::_LibObjPtr;
1902 using _FieldClass = internal::DepFc<LibObjT>;
1905 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1907 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1908 _ThisBorrowedObject {libObjPtr}
1912 template <typename OtherLibObjT>
1913 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1914 _ThisBorrowedObject {fc}
1918 template <typename OtherLibObjT>
1919 CommonVariantFieldClassOption&
1920 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1922 _ThisBorrowedObject::operator=(fc);
1926 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1928 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1931 nonstd::optional<bpstd::string_view> name() const noexcept
1933 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1939 return nonstd::nullopt;
1942 _FieldClass fieldClass() const noexcept
1944 return _FieldClass {
1945 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1948 template <typename LibValT>
1949 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1951 static_assert(!std::is_const<LibObjT>::value,
1952 "Not available with `bt2::ConstVariantFieldClassOption`.");
1954 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1957 UserAttributes userAttributes() const noexcept
1959 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1960 this->libObjPtr())};
1964 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1966 using ConstVariantFieldClassOption =
1967 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1969 namespace internal {
1971 struct VariantFieldClassOptionTypeDescr
1973 using Const = ConstVariantFieldClassOption;
1974 using NonConst = VariantFieldClassOption;
1978 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1983 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1987 template <typename LibObjT>
1988 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1990 /* Functions specific to variant field class options with unsigned integer selector */
1992 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1993 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1996 static const bt_integer_range_set_unsigned *
1997 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1998 * const libObjPtr) noexcept
2000 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
2004 static const bt_field_class_variant_option *
2005 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
2006 * const libObjPtr) noexcept
2008 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
2013 /* Functions specific to variant field class options with signed integer selector */
2015 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2016 const bt_field_class_variant_with_selector_field_integer_signed_option>
2019 static const bt_integer_range_set_signed *
2020 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
2021 * const libObjPtr) noexcept
2023 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
2027 static const bt_field_class_variant_option *
2028 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
2029 * const libObjPtr) noexcept
2031 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2036 } /* namespace internal */
2038 template <typename LibObjT>
2039 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2042 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2043 using typename BorrowedObject<LibObjT>::_LibObjPtr;
2044 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2047 using RangeSet = typename std::conditional<
2050 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2051 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2053 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2054 _ThisBorrowedObject {libObjPtr}
2058 template <typename OtherLibObjT>
2059 ConstVariantWithIntegerSelectorFieldClassOption(
2060 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2061 _ThisBorrowedObject {fc}
2065 template <typename OtherLibObjT>
2066 ConstVariantWithIntegerSelectorFieldClassOption&
2067 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2069 _ThisBorrowedObject::operator=(fc);
2073 ConstVariantFieldClassOption asBaseOption() const noexcept
2075 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2078 nonstd::optional<bpstd::string_view> name() const noexcept
2080 return this->asBaseOption().name();
2083 ConstFieldClass fieldClass() const noexcept
2085 return this->asBaseOption().fieldClass();
2088 RangeSet ranges() const noexcept
2090 return RangeSet {_Spec::ranges(this->libObjPtr())};
2094 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2095 ConstVariantWithIntegerSelectorFieldClassOption<
2096 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2098 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2099 ConstVariantWithIntegerSelectorFieldClassOption<
2100 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2102 namespace internal {
2104 template <typename LibObjT>
2105 struct CommonVariantFieldClassSpec;
2107 /* Functions specific to mutable variant field classes */
2109 struct CommonVariantFieldClassSpec<bt_field_class> final
2111 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2112 const std::uint64_t index) noexcept
2114 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2117 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2118 const char * const name) noexcept
2120 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2124 /* Functions specific to constant variant field classes */
2126 struct CommonVariantFieldClassSpec<const bt_field_class> final
2128 static const bt_field_class_variant_option *
2129 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2131 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2134 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2135 const char * const name) noexcept
2137 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2141 } /* namespace internal */
2143 template <typename LibObjT>
2144 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2147 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2150 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2151 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2154 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2155 using Iterator = BorrowedObjectIterator<CommonVariantFieldClass>;
2158 internal::DepType<LibObjT, VariantFieldClassOption, ConstVariantFieldClassOption>;
2160 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2161 _ThisCommonFieldClass {libObjPtr}
2163 BT_ASSERT_DBG(this->isVariant());
2166 template <typename OtherLibObjT>
2167 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2168 _ThisCommonFieldClass {fc}
2172 template <typename OtherLibObjT>
2173 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2175 _ThisCommonFieldClass::operator=(fc);
2179 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2181 return CommonVariantFieldClass<const bt_field_class> {*this};
2184 std::uint64_t length() const noexcept
2186 return bt_field_class_variant_get_option_count(this->libObjPtr());
2189 Iterator begin() const noexcept
2191 return Iterator {*this, 0};
2194 Iterator end() const noexcept
2196 return Iterator {*this, this->length()};
2199 Option operator[](const std::uint64_t index) const noexcept
2201 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2202 this->libObjPtr(), index)};
2205 nonstd::optional<Option> operator[](const char * const name) const noexcept
2207 const auto libObjPtr =
2208 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2211 return Option {libObjPtr};
2214 return nonstd::nullopt;
2217 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2219 return (*this)[name.data()];
2222 Shared shared() const noexcept
2224 return Shared::createWithRef(*this);
2228 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2229 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2231 namespace internal {
2233 struct VariantFieldClassTypeDescr
2235 using Const = ConstVariantFieldClass;
2236 using NonConst = VariantFieldClass;
2240 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2245 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2249 } /* namespace internal */
2251 template <typename LibObjT>
2252 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2255 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2256 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2259 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2261 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2262 _ThisCommonVariantFieldClass {libObjPtr}
2264 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2267 template <typename OtherLibObjT>
2268 CommonVariantWithoutSelectorFieldClass(
2269 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2270 _ThisCommonVariantFieldClass {fc}
2274 template <typename OtherLibObjT>
2275 CommonVariantWithoutSelectorFieldClass&
2276 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2278 _ThisCommonVariantFieldClass::operator=(fc);
2282 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2284 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2287 void appendOption(const char * const name, const FieldClass fc) const
2289 static_assert(!std::is_const<LibObjT>::value,
2290 "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");
2292 const auto status = bt_field_class_variant_without_selector_append_option(
2293 this->libObjPtr(), name, fc.libObjPtr());
2296 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2297 throw MemoryError {};
2301 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc) const
2303 this->appendOption(name ? name->data() : nullptr, fc);
2306 Shared shared() const noexcept
2308 return Shared::createWithRef(*this);
2312 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2313 using ConstVariantWithoutSelectorFieldClass =
2314 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2316 namespace internal {
2318 struct VariantWithoutSelectorFieldClassTypeDescr
2320 using Const = ConstVariantWithoutSelectorFieldClass;
2321 using NonConst = VariantWithoutSelectorFieldClass;
2325 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2326 public VariantWithoutSelectorFieldClassTypeDescr
2331 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2332 public VariantWithoutSelectorFieldClassTypeDescr
2336 template <typename OptionT>
2337 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2339 /* Functions specific to variant field classes with unsigned integer selector */
2341 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2342 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2345 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2346 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2348 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2352 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2353 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2355 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2359 static bt_field_class_variant_with_selector_field_integer_append_option_status
2360 appendOption(bt_field_class * const libObjPtr, const char * const name,
2361 bt_field_class * const libOptFcPtr,
2362 const bt_integer_range_set_unsigned * const libRangesPtr)
2364 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2365 libObjPtr, name, libOptFcPtr, libRangesPtr);
2369 /* Functions specific to variant field classes with signed integer selector */
2371 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2372 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2375 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2376 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2378 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2382 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2383 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2385 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2389 static bt_field_class_variant_with_selector_field_integer_append_option_status
2390 appendOption(bt_field_class * const libObjPtr, const char * const name,
2391 bt_field_class * const libOptFcPtr,
2392 const bt_integer_range_set_signed * const libRangesPtr)
2394 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2395 libObjPtr, name, libOptFcPtr, libRangesPtr);
2399 } /* namespace internal */
2401 template <typename LibObjT>
2402 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2405 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2408 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2409 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2412 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2414 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2415 _ThisCommonVariantFieldClass {libObjPtr}
2417 BT_ASSERT_DBG(this->isVariantWithSelector());
2420 template <typename OtherLibObjT>
2421 CommonVariantWithSelectorFieldClass(
2422 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2423 _ThisCommonVariantFieldClass {fc}
2427 template <typename OtherLibObjT>
2428 CommonVariantWithSelectorFieldClass&
2429 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2431 _ThisCommonVariantFieldClass::operator=(fc);
2435 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2437 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2440 ConstFieldPath selectorFieldPath() const noexcept
2442 return ConstFieldPath {
2443 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2444 this->libObjPtr())};
2447 Shared shared() const noexcept
2449 return Shared::createWithRef(*this);
2453 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2454 using ConstVariantWithSelectorFieldClass =
2455 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2457 template <typename LibObjT, typename OptionT>
2458 class CommonVariantWithIntegerSelectorFieldClass :
2459 public CommonVariantWithSelectorFieldClass<LibObjT>
2462 using typename CommonVariantWithSelectorFieldClass<
2463 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2464 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2465 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2466 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2468 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2471 using Shared = SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2473 using Option = OptionT;
2476 BorrowedObjectIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>>;
2478 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2479 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2481 BT_ASSERT_DBG(this->isVariant());
2484 template <typename OtherLibObjT>
2485 CommonVariantWithIntegerSelectorFieldClass(
2486 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2487 _ThisCommonVariantWithSelectorFieldClass {fc}
2491 template <typename OtherLibObjT>
2492 CommonVariantWithIntegerSelectorFieldClass&
2493 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2495 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2499 Option operator[](const std::uint64_t index) const noexcept
2501 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2504 nonstd::optional<Option> operator[](const char * const name) const noexcept
2506 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2509 return Option {libObjPtr};
2512 return nonstd::nullopt;
2515 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2517 return (*this)[name.data()];
2520 void appendOption(const char * const name, const FieldClass fc,
2521 const typename Option::RangeSet ranges) const
2524 !std::is_const<LibObjT>::value,
2525 "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");
2528 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2531 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2532 throw MemoryError {};
2536 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc,
2537 const typename Option::RangeSet ranges) const
2539 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2542 Iterator begin() const noexcept
2544 return Iterator {*this, 0};
2547 Iterator end() const noexcept
2549 return Iterator {*this, this->length()};
2552 Shared shared() const noexcept
2554 return Shared::createWithRef(*this);
2558 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2559 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2561 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2562 CommonVariantWithIntegerSelectorFieldClass<
2563 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2565 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2566 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2568 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2569 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2571 namespace internal {
2573 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2575 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2576 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2580 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2581 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2586 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2587 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2591 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2593 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2594 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2598 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2599 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2604 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2605 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2609 } /* namespace internal */
2611 template <typename LibObjT>
2612 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2614 BT_ASSERT_DBG(this->isBitArray());
2615 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2618 template <typename LibObjT>
2619 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2621 BT_ASSERT_DBG(this->isInteger());
2622 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2625 template <typename LibObjT>
2626 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2628 BT_ASSERT_DBG(this->isEnumeration());
2629 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2632 template <typename LibObjT>
2633 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2634 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2636 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2637 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2641 template <typename LibObjT>
2642 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2643 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2645 BT_ASSERT_DBG(this->isSignedEnumeration());
2646 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2650 template <typename LibObjT>
2651 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2653 BT_ASSERT_DBG(this->isStructure());
2654 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2657 template <typename LibObjT>
2658 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2660 BT_ASSERT_DBG(this->isArray());
2661 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2664 template <typename LibObjT>
2665 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2667 BT_ASSERT_DBG(this->isStaticArray());
2668 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2671 template <typename LibObjT>
2672 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2673 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2675 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2676 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2679 template <typename LibObjT>
2680 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2682 BT_ASSERT_DBG(this->isOption());
2683 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2686 template <typename LibObjT>
2687 CommonOptionWithSelectorFieldClass<LibObjT>
2688 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2690 BT_ASSERT_DBG(this->isOptionWithSelector());
2691 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2694 template <typename LibObjT>
2695 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2696 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2698 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2699 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2702 template <typename LibObjT>
2703 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2704 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2706 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2707 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2711 template <typename LibObjT>
2712 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2713 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2715 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2716 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2720 template <typename LibObjT>
2721 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2723 BT_ASSERT_DBG(this->isVariant());
2724 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2727 template <typename LibObjT>
2728 CommonVariantWithoutSelectorFieldClass<LibObjT>
2729 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2731 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2732 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2735 template <typename LibObjT>
2736 CommonVariantWithSelectorFieldClass<LibObjT>
2737 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2739 BT_ASSERT_DBG(this->isVariantWithSelector());
2740 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2743 template <typename LibObjT>
2744 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2745 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2746 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2748 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2749 return CommonVariantWithIntegerSelectorFieldClass<
2750 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2753 template <typename LibObjT>
2754 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2755 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2756 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2758 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2759 return CommonVariantWithIntegerSelectorFieldClass<
2760 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2763 } /* namespace bt2 */
2765 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */