2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
11 #include <type_traits>
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "cpp-common/optional.hpp"
17 #include "cpp-common/string_view.hpp"
19 #include "borrowed-object.hpp"
20 #include "common-iterator.hpp"
22 #include "field-path.hpp"
23 #include "integer-range-set.hpp"
24 #include "internal/utils.hpp"
25 #include "shared-object.hpp"
31 struct FieldClassRefFuncs final
33 static void get(const bt_field_class * const libObjPtr) noexcept
35 bt_field_class_get_ref(libObjPtr);
38 static void put(const bt_field_class * const libObjPtr) noexcept
40 bt_field_class_put_ref(libObjPtr);
44 template <typename LibObjT>
45 struct CommonFieldClassSpec;
47 /* Functions specific to mutable field classes */
49 struct CommonFieldClassSpec<bt_field_class> final
51 static bt_value *userAttributes(bt_field_class * const libObjPtr) noexcept
53 return bt_field_class_borrow_user_attributes(libObjPtr);
57 /* Functions specific to constant field classes */
59 struct CommonFieldClassSpec<const bt_field_class> final
61 static const bt_value *userAttributes(const bt_field_class * const libObjPtr) noexcept
63 return bt_field_class_borrow_user_attributes_const(libObjPtr);
67 } /* namespace internal */
69 template <typename ObjT, typename LibObjT>
70 using SharedFieldClass = SharedObject<ObjT, LibObjT, internal::FieldClassRefFuncs>;
72 template <typename LibObjT>
73 class CommonBitArrayFieldClass;
75 template <typename LibObjT>
76 class CommonIntegerFieldClass;
78 template <typename LibObjT>
79 class ConstEnumerationFieldClassMapping;
81 template <typename LibObjT>
82 class CommonBaseEnumerationFieldClass;
84 template <typename LibObjT, typename MappingT>
85 class CommonEnumerationFieldClass;
87 template <typename LibObjT>
88 class CommonStructureFieldClass;
90 template <typename LibObjT>
91 class CommonArrayFieldClass;
93 template <typename LibObjT>
94 class CommonStaticArrayFieldClass;
96 template <typename LibObjT>
97 class CommonDynamicArrayWithLengthFieldClass;
99 template <typename LibObjT>
100 class CommonOptionFieldClass;
102 template <typename LibObjT>
103 class CommonOptionWithSelectorFieldClass;
105 template <typename LibObjT>
106 class CommonOptionWithBoolSelectorFieldClass;
108 template <typename LibObjT>
109 class CommonVariantFieldClass;
111 template <typename LibObjT, typename RangeSetT>
112 class CommonOptionWithIntegerSelectorFieldClass;
114 template <typename LibObjT>
115 class CommonVariantWithoutSelectorFieldClass;
117 template <typename LibObjT>
118 class CommonVariantWithSelectorFieldClass;
120 template <typename LibObjT>
121 class ConstVariantWithIntegerSelectorFieldClassOption;
123 template <typename LibObjT, typename RangeSetT>
124 class CommonVariantWithIntegerSelectorFieldClass;
126 template <typename LibObjT>
127 class CommonEventClass;
129 template <typename LibObjT>
130 class CommonStreamClass;
132 template <typename LibObjT>
133 class CommonTraceClass;
135 enum class FieldClassType
137 BOOL = BT_FIELD_CLASS_TYPE_BOOL,
138 BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
139 UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
140 SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
141 UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
142 SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
143 SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
144 DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
145 STRING = BT_FIELD_CLASS_TYPE_STRING,
146 STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
147 STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
148 DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
149 DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
150 OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
151 OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
152 OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
153 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
154 OPTION_WITH_SIGNED_INTEGER_SELECTOR =
155 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
156 VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
157 VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
158 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
159 VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
160 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
163 template <typename LibObjT>
164 class CommonFieldClass : public BorrowedObject<LibObjT>
167 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
170 using typename BorrowedObject<LibObjT>::_LibObjPtr;
171 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
174 using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
176 using UserAttributes =
177 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
179 explicit CommonFieldClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
183 template <typename OtherLibObjT>
184 CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
188 template <typename OtherLibObjT>
189 CommonFieldClass& operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
191 _ThisBorrowedObject::operator=(fc);
195 CommonFieldClass<const bt_field_class> asConst() const noexcept
197 return CommonFieldClass<const bt_field_class> {*this};
200 FieldClassType type() const noexcept
202 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
205 bool isBool() const noexcept
207 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
210 bool isBitArray() const noexcept
212 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
215 bool isInteger() const noexcept
217 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
220 bool isUnsignedInteger() const noexcept
222 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
225 bool isSignedInteger() const noexcept
227 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
230 bool isEnumeration() const noexcept
232 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
235 bool isUnsignedEnumeration() const noexcept
237 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
240 bool isSignedEnumeration() const noexcept
242 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
245 bool isReal() const noexcept
247 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
250 bool isSinglePrecisionReal() const noexcept
252 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
255 bool isDoublePrecisionReal() const noexcept
257 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
260 bool isString() const noexcept
262 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
265 bool isStructure() const noexcept
267 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
270 bool isArray() const noexcept
272 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
275 bool isStaticArray() const noexcept
277 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
280 bool isDynamicArray() const noexcept
282 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
285 bool isDynamicArrayWithoutLength() const noexcept
287 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
290 bool isDynamicArrayWithLength() const noexcept
292 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
295 bool isOption() const noexcept
297 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
300 bool isOptionWithoutSelector() const noexcept
302 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
305 bool isOptionWithSelector() const noexcept
307 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
310 bool isOptionWithBoolSelector() const noexcept
312 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
315 bool isOptionWithIntegerSelector() const noexcept
317 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
320 bool isOptionWithUnsignedIntegerSelector() const noexcept
322 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
325 bool isOptionWithSignedIntegerSelector() const noexcept
327 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
330 bool isVariant() const noexcept
332 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
335 bool isVariantWithoutSelector() const noexcept
337 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
340 bool isVariantWithSelector() const noexcept
342 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
345 bool isVariantWithIntegerSelector() const noexcept
347 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
350 bool isVariantWithUnsignedIntegerSelector() const noexcept
352 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
355 bool isVariantWithSignedIntegerSelector() const noexcept
357 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
360 template <typename FieldClassT>
361 FieldClassT as() const noexcept
363 return FieldClassT {this->libObjPtr()};
366 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
367 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
368 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
369 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
370 const bt_field_class_enumeration_unsigned_mapping>>
371 asUnsignedEnumeration() const noexcept;
373 CommonEnumerationFieldClass<
374 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
375 asSignedEnumeration() const noexcept;
377 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
378 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
379 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
380 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
381 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
382 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
383 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
385 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
386 asOptionWithUnsignedIntegerSelector() const noexcept;
388 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
389 asOptionWithSignedIntegerSelector() const noexcept;
391 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
392 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
393 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
395 CommonVariantWithIntegerSelectorFieldClass<
396 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
397 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
398 asVariantWithUnsignedIntegerSelector() const noexcept;
400 CommonVariantWithIntegerSelectorFieldClass<
401 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
402 const bt_field_class_variant_with_selector_field_integer_signed_option>>
403 asVariantWithSignedIntegerSelector() const noexcept;
405 template <typename LibValT>
406 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
408 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
410 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
413 UserAttributes userAttributes() const noexcept
415 return UserAttributes {
416 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
419 Shared shared() const noexcept
421 return Shared::createWithRef(*this);
425 bool _libTypeIs(const bt_field_class_type type) const noexcept
427 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
431 using FieldClass = CommonFieldClass<bt_field_class>;
432 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
436 struct FieldClassTypeDescr
438 using Const = ConstFieldClass;
439 using NonConst = FieldClass;
443 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
448 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
452 } /* namespace internal */
454 template <typename LibObjT>
455 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
458 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
459 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
462 using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
464 explicit CommonBitArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
465 _ThisCommonFieldClass {libObjPtr}
467 BT_ASSERT_DBG(this->isBitArray());
470 template <typename OtherLibObjT>
471 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
472 _ThisCommonFieldClass {fc}
476 template <typename OtherLibObjT>
477 CommonBitArrayFieldClass<LibObjT>&
478 operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
480 _ThisCommonFieldClass::operator=(fc);
484 CommonBitArrayFieldClass<const bt_field_class> asConst() const noexcept
486 return CommonBitArrayFieldClass<const bt_field_class> {*this};
489 std::uint64_t length() const noexcept
491 return bt_field_class_bit_array_get_length(this->libObjPtr());
494 Shared shared() const noexcept
496 return Shared::createWithRef(*this);
500 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
501 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
505 struct BitArrayFieldClassTypeDescr
507 using Const = ConstBitArrayFieldClass;
508 using NonConst = BitArrayFieldClass;
512 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
517 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
521 } /* namespace internal */
523 enum class DisplayBase
525 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
526 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
527 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
528 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
531 template <typename LibObjT>
532 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
535 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
538 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
539 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
542 using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
544 explicit CommonIntegerFieldClass(const _LibObjPtr libObjPtr) noexcept :
545 _ThisCommonFieldClass {libObjPtr}
547 BT_ASSERT_DBG(this->isInteger());
550 template <typename OtherLibObjT>
551 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
552 _ThisCommonFieldClass {fc}
556 template <typename OtherLibObjT>
557 CommonIntegerFieldClass& operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
559 _ThisCommonFieldClass::operator=(fc);
563 CommonIntegerFieldClass<const bt_field_class> asConst() const noexcept
565 return CommonIntegerFieldClass<const bt_field_class> {*this};
568 void fieldValueRange(const std::uint64_t n) const noexcept
570 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
572 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
575 std::uint64_t fieldValueRange() const noexcept
577 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
580 void preferredDisplayBase(const DisplayBase base) const noexcept
582 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
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 = CommonIterator<CommonEnumerationFieldClass, MappingT>;
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;
1001 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1004 using UserAttributes =
1005 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1007 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
1008 _ThisBorrowedObject {libObjPtr}
1012 template <typename OtherLibObjT>
1013 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1015 _ThisBorrowedObject {fc}
1019 template <typename OtherLibObjT>
1020 CommonStructureFieldClassMember<LibObjT>&
1021 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1023 _ThisBorrowedObject::operator=(fc);
1027 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1029 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1032 bpstd::string_view name() const noexcept
1034 return bt_field_class_structure_member_get_name(this->libObjPtr());
1037 _FieldClass fieldClass() const noexcept
1039 return _FieldClass {
1040 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1043 template <typename LibValT>
1044 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1046 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1048 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1049 userAttrs.libObjPtr());
1052 UserAttributes userAttributes() const noexcept
1054 return UserAttributes {
1055 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1056 this->libObjPtr())};
1060 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1062 using ConstStructureFieldClassMember =
1063 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1065 namespace internal {
1067 struct StructureFieldClassMemberTypeDescr
1069 using Const = ConstStructureFieldClassMember;
1070 using NonConst = StructureFieldClassMember;
1074 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1079 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1083 template <typename LibObjT>
1084 struct CommonStructureFieldClassSpec;
1086 /* Functions specific to mutable structure field classes */
1088 struct CommonStructureFieldClassSpec<bt_field_class> final
1090 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1091 const std::uint64_t index) noexcept
1093 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1096 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1097 const char * const name) noexcept
1099 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1103 /* Functions specific to constant structure field classes */
1105 struct CommonStructureFieldClassSpec<const bt_field_class> final
1107 static const bt_field_class_structure_member *
1108 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1110 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1113 static const bt_field_class_structure_member *
1114 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1116 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1120 } /* namespace internal */
1122 template <typename LibObjT>
1123 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1126 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1127 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1130 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1132 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1133 StructureFieldClassMember>::type;
1135 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1137 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1138 _ThisCommonFieldClass {libObjPtr}
1140 BT_ASSERT_DBG(this->isStructure());
1143 template <typename OtherLibObjT>
1144 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1145 _ThisCommonFieldClass {fc}
1149 template <typename OtherLibObjT>
1150 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1152 _ThisCommonFieldClass::operator=(fc);
1156 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1158 return CommonStructureFieldClass<const bt_field_class> {*this};
1161 void appendMember(const char * const name, const FieldClass fc) const
1163 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1166 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1168 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1169 throw MemoryError {};
1173 void appendMember(const std::string& name, const FieldClass fc) const
1175 this->appendMember(name.data(), fc);
1178 std::uint64_t length() const noexcept
1180 return bt_field_class_structure_get_member_count(this->libObjPtr());
1183 Iterator begin() const noexcept
1185 return Iterator {*this, 0};
1188 Iterator end() const noexcept
1190 return Iterator {*this, this->length()};
1193 Member operator[](const std::uint64_t index) const noexcept
1195 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1196 this->libObjPtr(), index)};
1199 nonstd::optional<Member> operator[](const char * const name) const noexcept
1201 const auto libObjPtr =
1202 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1205 return Member {libObjPtr};
1208 return nonstd::nullopt;
1211 nonstd::optional<Member> operator[](const std::string& name) const noexcept
1213 return (*this)[name.data()];
1216 Shared shared() const noexcept
1218 return Shared::createWithRef(*this);
1222 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1223 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1225 namespace internal {
1227 struct StructureFieldClassTypeDescr
1229 using Const = ConstStructureFieldClass;
1230 using NonConst = StructureFieldClass;
1234 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1239 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1243 template <typename LibObjT>
1244 struct CommonArrayFieldClassSpec;
1246 /* Functions specific to mutable array field classes */
1248 struct CommonArrayFieldClassSpec<bt_field_class> final
1250 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1252 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1256 /* Functions specific to constant array field classes */
1258 struct CommonArrayFieldClassSpec<const bt_field_class> final
1260 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1262 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1266 } /* namespace internal */
1268 template <typename LibObjT>
1269 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1272 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1275 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1278 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1279 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1282 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1284 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1285 _ThisCommonFieldClass {libObjPtr}
1287 BT_ASSERT_DBG(this->isArray());
1290 template <typename OtherLibObjT>
1291 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1292 _ThisCommonFieldClass {fc}
1296 template <typename OtherLibObjT>
1297 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1299 _ThisCommonFieldClass::operator=(fc);
1303 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1305 return CommonArrayFieldClass<const bt_field_class> {*this};
1308 _FieldClass elementFieldClass() const noexcept
1310 return _FieldClass {
1311 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1314 Shared shared() const noexcept
1316 return Shared::createWithRef(*this);
1320 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1321 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1323 namespace internal {
1325 struct ArrayFieldClassTypeDescr
1327 using Const = ConstArrayFieldClass;
1328 using NonConst = ArrayFieldClass;
1332 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1337 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1341 } /* namespace internal */
1343 template <typename LibObjT>
1344 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1347 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1348 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1351 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1353 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1354 _ThisCommonArrayFieldClass {libObjPtr}
1356 BT_ASSERT_DBG(this->isStaticArray());
1359 template <typename OtherLibObjT>
1360 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1361 _ThisCommonArrayFieldClass {fc}
1365 template <typename OtherLibObjT>
1366 CommonStaticArrayFieldClass&
1367 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1369 _ThisCommonArrayFieldClass::operator=(fc);
1373 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1375 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1378 std::uint64_t length() const noexcept
1380 return bt_field_class_array_static_get_length(this->libObjPtr());
1383 Shared shared() const noexcept
1385 return Shared::createWithRef(*this);
1389 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1390 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1392 namespace internal {
1394 struct StaticArrayFieldClassTypeDescr
1396 using Const = ConstStaticArrayFieldClass;
1397 using NonConst = StaticArrayFieldClass;
1401 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1406 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1410 } /* namespace internal */
1412 template <typename LibObjT>
1413 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1416 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1417 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1420 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1422 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1423 _ThisCommonArrayFieldClass {libObjPtr}
1425 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1428 template <typename OtherLibObjT>
1429 CommonDynamicArrayWithLengthFieldClass(
1430 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1431 _ThisCommonArrayFieldClass {fc}
1435 template <typename OtherLibObjT>
1436 CommonDynamicArrayWithLengthFieldClass&
1437 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1439 _ThisCommonArrayFieldClass::operator=(fc);
1443 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1445 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1448 ConstFieldPath lengthFieldPath() const noexcept
1450 return ConstFieldPath {
1451 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1452 this->libObjPtr())};
1455 Shared shared() const noexcept
1457 return Shared::createWithRef(*this);
1461 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1463 using ConstDynamicArrayWithLengthFieldClass =
1464 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1466 namespace internal {
1468 struct DynamicArrayWithLengthFieldClassTypeDescr
1470 using Const = ConstDynamicArrayWithLengthFieldClass;
1471 using NonConst = DynamicArrayWithLengthFieldClass;
1475 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1476 public DynamicArrayWithLengthFieldClassTypeDescr
1481 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1482 public DynamicArrayWithLengthFieldClassTypeDescr
1486 template <typename LibObjT>
1487 struct CommonOptionFieldClassSpec;
1489 /* Functions specific to mutable option field classes */
1491 struct CommonOptionFieldClassSpec<bt_field_class> final
1493 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1495 return bt_field_class_option_borrow_field_class(libObjPtr);
1499 /* Functions specific to constant option field classes */
1501 struct CommonOptionFieldClassSpec<const bt_field_class> final
1503 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1505 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1509 } /* namespace internal */
1511 template <typename LibObjT>
1512 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1515 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1518 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1521 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1522 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1525 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1527 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1528 _ThisCommonFieldClass {libObjPtr}
1530 BT_ASSERT_DBG(this->isOption());
1533 template <typename OtherLibObjT>
1534 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1535 _ThisCommonFieldClass {fc}
1539 template <typename OtherLibObjT>
1540 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1542 _ThisCommonFieldClass::operator=(fc);
1546 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1548 return CommonOptionFieldClass<const bt_field_class> {*this};
1551 _FieldClass fieldClass() const noexcept
1553 return _FieldClass {
1554 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1557 Shared shared() const noexcept
1559 return Shared::createWithRef(*this);
1563 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1564 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1566 namespace internal {
1568 struct OptionFieldClassTypeDescr
1570 using Const = ConstOptionFieldClass;
1571 using NonConst = OptionFieldClass;
1575 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1580 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1584 } /* namespace internal */
1586 template <typename LibObjT>
1587 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1590 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1593 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1594 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1597 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1599 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1600 _ThisCommonOptionFieldClass {libObjPtr}
1602 BT_ASSERT_DBG(this->isOptionWithSelector());
1605 template <typename OtherLibObjT>
1606 CommonOptionWithSelectorFieldClass(
1607 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1608 _ThisCommonOptionFieldClass {fc}
1612 template <typename OtherLibObjT>
1613 CommonOptionWithSelectorFieldClass&
1614 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1616 _ThisCommonOptionFieldClass::operator=(fc);
1620 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1622 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1625 ConstFieldPath selectorFieldPath() const noexcept
1627 return ConstFieldPath {
1628 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1629 this->libObjPtr())};
1632 Shared shared() const noexcept
1634 return Shared::createWithRef(*this);
1638 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1639 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1641 namespace internal {
1643 struct OptionWithSelectorFieldClassTypeDescr
1645 using Const = ConstOptionWithSelectorFieldClass;
1646 using NonConst = OptionWithSelectorFieldClass;
1650 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1655 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1659 } /* namespace internal */
1661 template <typename LibObjT>
1662 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1665 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1667 using typename CommonOptionWithSelectorFieldClass<
1668 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1671 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1673 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1674 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1676 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1679 template <typename OtherLibObjT>
1680 CommonOptionWithBoolSelectorFieldClass(
1681 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1682 _ThisCommonOptionWithSelectorFieldClass {fc}
1686 template <typename OtherLibObjT>
1687 CommonOptionWithBoolSelectorFieldClass&
1688 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1690 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1694 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1696 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1699 bool selectorIsReversed() const noexcept
1701 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1705 Shared shared() const noexcept
1707 return Shared::createWithRef(*this);
1711 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1713 using ConstOptionWithBoolSelectorFieldClass =
1714 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1716 namespace internal {
1718 struct OptionWithBoolSelectorFieldClassTypeDescr
1720 using Const = ConstOptionWithBoolSelectorFieldClass;
1721 using NonConst = OptionWithBoolSelectorFieldClass;
1725 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1726 public OptionWithBoolSelectorFieldClassTypeDescr
1731 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1732 public OptionWithBoolSelectorFieldClassTypeDescr
1736 template <typename RangeSetT>
1737 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1739 /* Functions specific to option field classes with unsigned integer ranges */
1741 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1743 static const bt_integer_range_set_unsigned *
1744 ranges(const bt_field_class * const libObjPtr) noexcept
1746 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1751 /* Functions specific to option field classes with signed ranges */
1753 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1755 static const bt_integer_range_set_signed *
1756 ranges(const bt_field_class * const libObjPtr) noexcept
1758 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1763 } /* namespace internal */
1765 template <typename LibObjT, typename RangeSetT>
1766 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1769 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1771 using typename CommonOptionWithSelectorFieldClass<
1772 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1774 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1775 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1778 using Shared = SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1780 using RangeSet = RangeSetT;
1782 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1783 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1785 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1788 template <typename OtherLibObjT>
1789 CommonOptionWithIntegerSelectorFieldClass(
1790 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1791 _ThisCommonOptionWithSelectorFieldClass {fc}
1795 template <typename OtherLibObjT>
1796 CommonOptionWithIntegerSelectorFieldClass&
1797 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1799 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1803 RangeSet ranges() const noexcept
1805 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1806 this->libObjPtr())};
1809 Shared shared() const noexcept
1811 return Shared::createWithRef(*this);
1815 using OptionWithUnsignedIntegerSelectorFieldClass =
1816 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1818 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1819 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1821 using OptionWithSignedIntegerSelectorFieldClass =
1822 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1824 using ConstOptionWithSignedIntegerSelectorFieldClass =
1825 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1827 namespace internal {
1829 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1831 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1832 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1836 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1837 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1842 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1843 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1847 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1849 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1850 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1854 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1855 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1860 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1861 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1865 template <typename LibObjT>
1866 struct CommonVariantFieldClassOptionSpec;
1868 /* Functions specific to mutable variant field class options */
1870 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1872 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1874 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1877 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1879 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1883 /* Functions specific to constant variant field class options */
1885 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1887 static const bt_field_class *
1888 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1890 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1893 static const bt_value *
1894 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1896 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1900 } /* namespace internal */
1902 template <typename LibObjT>
1903 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1906 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1907 using typename BorrowedObject<LibObjT>::_LibObjPtr;
1910 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1913 using UserAttributes =
1914 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1916 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1917 _ThisBorrowedObject {libObjPtr}
1921 template <typename OtherLibObjT>
1922 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1923 _ThisBorrowedObject {fc}
1927 template <typename OtherLibObjT>
1928 CommonVariantFieldClassOption&
1929 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1931 _ThisBorrowedObject::operator=(fc);
1935 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1937 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1940 nonstd::optional<bpstd::string_view> name() const noexcept
1942 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1948 return nonstd::nullopt;
1951 _FieldClass fieldClass() const noexcept
1953 return _FieldClass {
1954 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1957 template <typename LibValT>
1958 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1960 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1962 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1965 UserAttributes userAttributes() const noexcept
1967 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1968 this->libObjPtr())};
1972 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1974 using ConstVariantFieldClassOption =
1975 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1977 namespace internal {
1979 struct VariantFieldClassOptionTypeDescr
1981 using Const = ConstVariantFieldClassOption;
1982 using NonConst = VariantFieldClassOption;
1986 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1991 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1995 template <typename LibObjT>
1996 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1998 /* Functions specific to variant field class options with unsigned integer selector */
2000 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2001 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
2004 static const bt_integer_range_set_unsigned *
2005 ranges(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_borrow_ranges_const(
2012 static const bt_field_class_variant_option *
2013 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
2014 * const libObjPtr) noexcept
2016 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
2021 /* Functions specific to variant field class options with signed integer selector */
2023 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2024 const bt_field_class_variant_with_selector_field_integer_signed_option>
2027 static const bt_integer_range_set_signed *
2028 ranges(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_borrow_ranges_const(
2035 static const bt_field_class_variant_option *
2036 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
2037 * const libObjPtr) noexcept
2039 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2044 } /* namespace internal */
2046 template <typename LibObjT>
2047 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2050 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2051 using typename BorrowedObject<LibObjT>::_LibObjPtr;
2052 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2055 using RangeSet = typename std::conditional<
2058 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2059 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2061 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2062 _ThisBorrowedObject {libObjPtr}
2066 template <typename OtherLibObjT>
2067 ConstVariantWithIntegerSelectorFieldClassOption(
2068 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2069 _ThisBorrowedObject {fc}
2073 template <typename OtherLibObjT>
2074 ConstVariantWithIntegerSelectorFieldClassOption&
2075 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2077 _ThisBorrowedObject::operator=(fc);
2081 ConstVariantFieldClassOption asBaseOption() const noexcept
2083 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2086 nonstd::optional<bpstd::string_view> name() const noexcept
2088 return this->asBaseOption().name();
2091 ConstFieldClass fieldClass() const noexcept
2093 return this->asBaseOption().fieldClass();
2096 RangeSet ranges() const noexcept
2098 return RangeSet {_Spec::ranges(this->libObjPtr())};
2102 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2103 ConstVariantWithIntegerSelectorFieldClassOption<
2104 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2106 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2107 ConstVariantWithIntegerSelectorFieldClassOption<
2108 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2110 namespace internal {
2112 template <typename LibObjT>
2113 struct CommonVariantFieldClassSpec;
2115 /* Functions specific to mutable variant field classes */
2117 struct CommonVariantFieldClassSpec<bt_field_class> final
2119 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2120 const std::uint64_t index) noexcept
2122 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2125 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2126 const char * const name) noexcept
2128 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2132 /* Functions specific to constant variant field classes */
2134 struct CommonVariantFieldClassSpec<const bt_field_class> final
2136 static const bt_field_class_variant_option *
2137 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2139 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2142 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2143 const char * const name) noexcept
2145 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2149 } /* namespace internal */
2151 template <typename LibObjT>
2152 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2155 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2158 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2159 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2162 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2165 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2166 VariantFieldClassOption>::type;
2168 using Iterator = CommonIterator<CommonVariantFieldClass, Option>;
2170 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2171 _ThisCommonFieldClass {libObjPtr}
2173 BT_ASSERT_DBG(this->isVariant());
2176 template <typename OtherLibObjT>
2177 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2178 _ThisCommonFieldClass {fc}
2182 template <typename OtherLibObjT>
2183 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2185 _ThisCommonFieldClass::operator=(fc);
2189 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2191 return CommonVariantFieldClass<const bt_field_class> {*this};
2194 std::uint64_t length() const noexcept
2196 return bt_field_class_variant_get_option_count(this->libObjPtr());
2199 Iterator begin() const noexcept
2201 return Iterator {*this, 0};
2204 Iterator end() const noexcept
2206 return Iterator {*this, this->length()};
2209 Option operator[](const std::uint64_t index) const noexcept
2211 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2212 this->libObjPtr(), index)};
2215 nonstd::optional<Option> operator[](const char * const name) const noexcept
2217 const auto libObjPtr =
2218 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2221 return Option {libObjPtr};
2224 return nonstd::nullopt;
2227 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2229 return (*this)[name.data()];
2232 Shared shared() const noexcept
2234 return Shared::createWithRef(*this);
2238 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2239 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2241 namespace internal {
2243 struct VariantFieldClassTypeDescr
2245 using Const = ConstVariantFieldClass;
2246 using NonConst = VariantFieldClass;
2250 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2255 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2259 } /* namespace internal */
2261 template <typename LibObjT>
2262 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2265 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2266 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2269 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2271 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2272 _ThisCommonVariantFieldClass {libObjPtr}
2274 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2277 template <typename OtherLibObjT>
2278 CommonVariantWithoutSelectorFieldClass(
2279 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2280 _ThisCommonVariantFieldClass {fc}
2284 template <typename OtherLibObjT>
2285 CommonVariantWithoutSelectorFieldClass&
2286 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2288 _ThisCommonVariantFieldClass::operator=(fc);
2292 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2294 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2297 void appendOption(const char * const name, const FieldClass fc) const
2299 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2301 const auto status = bt_field_class_variant_without_selector_append_option(
2302 this->libObjPtr(), name, fc.libObjPtr());
2305 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2306 throw MemoryError {};
2310 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc) const
2312 this->appendOption(name ? name->data() : nullptr, fc);
2315 Shared shared() const noexcept
2317 return Shared::createWithRef(*this);
2321 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2322 using ConstVariantWithoutSelectorFieldClass =
2323 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2325 namespace internal {
2327 struct VariantWithoutSelectorFieldClassTypeDescr
2329 using Const = ConstVariantWithoutSelectorFieldClass;
2330 using NonConst = VariantWithoutSelectorFieldClass;
2334 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2335 public VariantWithoutSelectorFieldClassTypeDescr
2340 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2341 public VariantWithoutSelectorFieldClassTypeDescr
2345 template <typename OptionT>
2346 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2348 /* Functions specific to variant field classes with unsigned integer selector */
2350 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2351 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2354 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2355 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2357 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2361 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2362 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2364 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2368 static bt_field_class_variant_with_selector_field_integer_append_option_status
2369 appendOption(bt_field_class * const libObjPtr, const char * const name,
2370 bt_field_class * const libOptFcPtr,
2371 const bt_integer_range_set_unsigned * const libRangesPtr)
2373 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2374 libObjPtr, name, libOptFcPtr, libRangesPtr);
2378 /* Functions specific to variant field classes with signed integer selector */
2380 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2381 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2384 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2385 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2387 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2391 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2392 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2394 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2398 static bt_field_class_variant_with_selector_field_integer_append_option_status
2399 appendOption(bt_field_class * const libObjPtr, const char * const name,
2400 bt_field_class * const libOptFcPtr,
2401 const bt_integer_range_set_signed * const libRangesPtr)
2403 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2404 libObjPtr, name, libOptFcPtr, libRangesPtr);
2408 } /* namespace internal */
2410 template <typename LibObjT>
2411 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2414 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2417 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2418 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2421 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2423 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2424 _ThisCommonVariantFieldClass {libObjPtr}
2426 BT_ASSERT_DBG(this->isVariantWithSelector());
2429 template <typename OtherLibObjT>
2430 CommonVariantWithSelectorFieldClass(
2431 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2432 _ThisCommonVariantFieldClass {fc}
2436 template <typename OtherLibObjT>
2437 CommonVariantWithSelectorFieldClass&
2438 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2440 _ThisCommonVariantFieldClass::operator=(fc);
2444 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2446 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2449 ConstFieldPath selectorFieldPath() const noexcept
2451 return ConstFieldPath {
2452 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2453 this->libObjPtr())};
2456 Shared shared() const noexcept
2458 return Shared::createWithRef(*this);
2462 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2463 using ConstVariantWithSelectorFieldClass =
2464 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2466 template <typename LibObjT, typename OptionT>
2467 class CommonVariantWithIntegerSelectorFieldClass :
2468 public CommonVariantWithSelectorFieldClass<LibObjT>
2471 using typename CommonVariantWithSelectorFieldClass<
2472 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2473 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2474 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2475 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2477 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2480 using Shared = SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2482 using Option = OptionT;
2484 CommonIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>, Option>;
2486 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2487 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2489 BT_ASSERT_DBG(this->isVariant());
2492 template <typename OtherLibObjT>
2493 CommonVariantWithIntegerSelectorFieldClass(
2494 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2495 _ThisCommonVariantWithSelectorFieldClass {fc}
2499 template <typename OtherLibObjT>
2500 CommonVariantWithIntegerSelectorFieldClass&
2501 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2503 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2507 Option operator[](const std::uint64_t index) const noexcept
2509 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2512 nonstd::optional<Option> operator[](const char * const name) const noexcept
2514 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2517 return Option {libObjPtr};
2520 return nonstd::nullopt;
2523 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2525 return (*this)[name.data()];
2528 void appendOption(const char * const name, const FieldClass fc,
2529 const typename Option::RangeSet ranges) const
2531 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2534 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2537 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2538 throw MemoryError {};
2542 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc,
2543 const typename Option::RangeSet ranges) const
2545 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2548 Iterator begin() const noexcept
2550 return Iterator {*this, 0};
2553 Iterator end() const noexcept
2555 return Iterator {*this, this->length()};
2558 Shared shared() const noexcept
2560 return Shared::createWithRef(*this);
2564 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2565 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2567 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2568 CommonVariantWithIntegerSelectorFieldClass<
2569 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2571 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2572 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2574 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2575 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2577 namespace internal {
2579 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2581 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2582 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2586 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2587 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2592 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2593 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2597 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2599 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2600 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2604 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2605 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2610 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2611 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2615 } /* namespace internal */
2617 template <typename LibObjT>
2618 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2620 BT_ASSERT_DBG(this->isBitArray());
2621 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2624 template <typename LibObjT>
2625 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2627 BT_ASSERT_DBG(this->isInteger());
2628 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2631 template <typename LibObjT>
2632 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2634 BT_ASSERT_DBG(this->isEnumeration());
2635 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2638 template <typename LibObjT>
2639 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2640 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2642 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2643 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2647 template <typename LibObjT>
2648 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2649 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2651 BT_ASSERT_DBG(this->isSignedEnumeration());
2652 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2656 template <typename LibObjT>
2657 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2659 BT_ASSERT_DBG(this->isStructure());
2660 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2663 template <typename LibObjT>
2664 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2666 BT_ASSERT_DBG(this->isArray());
2667 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2670 template <typename LibObjT>
2671 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2673 BT_ASSERT_DBG(this->isStaticArray());
2674 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2677 template <typename LibObjT>
2678 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2679 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2681 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2682 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2685 template <typename LibObjT>
2686 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2688 BT_ASSERT_DBG(this->isOption());
2689 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2692 template <typename LibObjT>
2693 CommonOptionWithSelectorFieldClass<LibObjT>
2694 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2696 BT_ASSERT_DBG(this->isOptionWithSelector());
2697 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2700 template <typename LibObjT>
2701 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2702 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2704 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2705 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2708 template <typename LibObjT>
2709 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2710 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2712 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2713 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2717 template <typename LibObjT>
2718 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2719 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2721 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2722 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2726 template <typename LibObjT>
2727 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2729 BT_ASSERT_DBG(this->isVariant());
2730 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2733 template <typename LibObjT>
2734 CommonVariantWithoutSelectorFieldClass<LibObjT>
2735 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2737 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2738 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2741 template <typename LibObjT>
2742 CommonVariantWithSelectorFieldClass<LibObjT>
2743 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2745 BT_ASSERT_DBG(this->isVariantWithSelector());
2746 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2749 template <typename LibObjT>
2750 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2751 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2752 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2754 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2755 return CommonVariantWithIntegerSelectorFieldClass<
2756 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2759 template <typename LibObjT>
2760 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2761 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2762 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2764 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2765 return CommonVariantWithIntegerSelectorFieldClass<
2766 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2769 } /* namespace bt2 */
2771 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */