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, "Not available with `bt2::ConstFieldClass`.");
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,
571 "Not available with `bt2::ConstIntegerFieldClass`.");
573 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
576 std::uint64_t fieldValueRange() const noexcept
578 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
581 void preferredDisplayBase(const DisplayBase base) const noexcept
583 static_assert(!std::is_const<LibObjT>::value,
584 "Not available with `bt2::ConstIntegerFieldClass`.");
586 bt_field_class_integer_set_preferred_display_base(
587 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
590 DisplayBase preferredDisplayBase() const noexcept
592 return static_cast<DisplayBase>(
593 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
596 Shared shared() const noexcept
598 return Shared::createWithRef(*this);
602 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
603 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
607 struct IntegerFieldClassTypeDescr
609 using Const = ConstIntegerFieldClass;
610 using NonConst = IntegerFieldClass;
614 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
619 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
623 } /* namespace internal */
627 template <typename LibObjT>
628 struct ConstEnumerationFieldClassMappingSpec;
630 /* Functions specific to unsigned enumeration field class mappings */
632 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
635 static const bt_integer_range_set_unsigned *
636 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
638 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
642 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
644 return bt_field_class_enumeration_mapping_get_label(
645 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
649 /* Functions specific to signed enumeration field class mappings */
651 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
653 static const bt_integer_range_set_signed *
654 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
656 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
660 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
662 return bt_field_class_enumeration_mapping_get_label(
663 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
667 } /* namespace internal */
669 template <typename LibObjT>
670 class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
673 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
674 using typename BorrowedObject<LibObjT>::_LibObjPtr;
677 using RangeSet = typename std::conditional<
678 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
679 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
681 explicit ConstEnumerationFieldClassMapping(const _LibObjPtr libObjPtr) noexcept :
682 _ThisBorrowedObject {libObjPtr}
686 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
687 _ThisBorrowedObject {mapping}
691 ConstEnumerationFieldClassMapping&
692 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
694 _ThisBorrowedObject::operator=(mapping);
698 RangeSet ranges() const noexcept
701 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
704 bpstd::string_view label() const noexcept
706 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
710 using ConstUnsignedEnumerationFieldClassMapping =
711 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
713 using ConstSignedEnumerationFieldClassMapping =
714 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
718 template <typename MappingT>
719 struct CommonEnumerationFieldClassSpec;
721 /* Functions specific to unsigned enumeration field classes */
723 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
725 static const bt_field_class_enumeration_unsigned_mapping *
726 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
728 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
731 static const bt_field_class_enumeration_unsigned_mapping *
732 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
734 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
737 static bt_field_class_enumeration_add_mapping_status
738 addMapping(bt_field_class * const libObjPtr, const char * const label,
739 const bt_integer_range_set_unsigned * const libRanges) noexcept
741 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
745 /* Functions specific to signed enumeration field classes */
747 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
749 static const bt_field_class_enumeration_signed_mapping *
750 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
752 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
755 static const bt_field_class_enumeration_signed_mapping *
756 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
758 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
761 static bt_field_class_enumeration_add_mapping_status
762 addMapping(bt_field_class * const libObjPtr, const char * const label,
763 const bt_integer_range_set_signed * const libRanges) noexcept
765 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
769 } /* namespace internal */
771 template <typename LibObjT>
772 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
775 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
778 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
779 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
782 using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
784 explicit CommonBaseEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
785 _ThisCommonIntegerFieldClass {libObjPtr}
787 BT_ASSERT_DBG(this->isEnumeration());
790 template <typename OtherLibObjT>
791 CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
793 _ThisCommonIntegerFieldClass {fc}
797 template <typename OtherLibObjT>
798 CommonBaseEnumerationFieldClass&
799 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
801 _ThisCommonIntegerFieldClass::operator=(fc);
805 CommonBaseEnumerationFieldClass<const bt_field_class> asConst() const noexcept
807 return CommonBaseEnumerationFieldClass<const bt_field_class> {*this};
810 std::uint64_t length() const noexcept
812 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
815 Shared shared() const noexcept
817 return Shared::createWithRef(*this);
821 template <typename LibObjT, typename MappingT>
822 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
825 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
826 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
827 using _ThisCommonEnumerationFieldClass = CommonEnumerationFieldClass<LibObjT, MappingT>;
830 using Shared = SharedFieldClass<_ThisCommonEnumerationFieldClass, LibObjT>;
831 using Iterator = CommonIterator<CommonEnumerationFieldClass, MappingT>;
832 using Mapping = MappingT;
834 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
835 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
837 BT_ASSERT_DBG(this->isEnumeration());
840 template <typename OtherLibObjT>
841 CommonEnumerationFieldClass(
842 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
843 _ThisCommonEnumerationFieldClass {fc}
847 template <typename OtherLibObjT>
848 CommonEnumerationFieldClass&
849 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
851 _ThisCommonEnumerationFieldClass::operator=(fc);
855 Mapping operator[](const std::uint64_t index) const noexcept
857 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
858 this->libObjPtr(), index)};
861 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
863 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
864 this->libObjPtr(), label);
867 return Mapping {libObjPtr};
870 return nonstd::nullopt;
873 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
875 return (*this)[label.data()];
878 void addMapping(const char * const label, const typename Mapping::RangeSet ranges) const
880 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
881 this->libObjPtr(), label, ranges.libObjPtr());
883 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
884 throw MemoryError {};
888 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges) const
890 this->addMapping(label.data(), ranges);
893 Iterator begin() const noexcept
895 return Iterator {*this, 0};
898 Iterator end() const noexcept
900 return Iterator {*this, this->length()};
903 Shared shared() const noexcept
905 return Shared::createWithRef(*this);
909 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
910 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
912 using UnsignedEnumerationFieldClass =
913 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
915 using ConstUnsignedEnumerationFieldClass =
916 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
918 using SignedEnumerationFieldClass =
919 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
921 using ConstSignedEnumerationFieldClass =
922 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
926 struct UnsignedEnumerationFieldClassTypeDescr
928 using Const = ConstUnsignedEnumerationFieldClass;
929 using NonConst = UnsignedEnumerationFieldClass;
933 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
938 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
942 struct SignedEnumerationFieldClassTypeDescr
944 using Const = ConstSignedEnumerationFieldClass;
945 using NonConst = SignedEnumerationFieldClass;
949 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
954 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
958 template <typename LibObjT>
959 struct CommonStructureFieldClassMemberSpec;
961 /* Functions specific to mutable structure field class members */
963 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
965 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
967 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
970 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
972 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
976 /* Functions specific to constant structure field class members */
978 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
980 static const bt_field_class *
981 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
983 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
986 static const bt_value *
987 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
989 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
993 } /* namespace internal */
995 template <typename LibObjT>
996 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
999 using typename BorrowedObject<LibObjT>::_LibObjPtr;
1000 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1003 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1006 using UserAttributes =
1007 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1009 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
1010 _ThisBorrowedObject {libObjPtr}
1014 template <typename OtherLibObjT>
1015 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1017 _ThisBorrowedObject {fc}
1021 template <typename OtherLibObjT>
1022 CommonStructureFieldClassMember<LibObjT>&
1023 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1025 _ThisBorrowedObject::operator=(fc);
1029 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1031 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1034 bpstd::string_view name() const noexcept
1036 return bt_field_class_structure_member_get_name(this->libObjPtr());
1039 _FieldClass fieldClass() const noexcept
1041 return _FieldClass {
1042 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1045 template <typename LibValT>
1046 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1048 static_assert(!std::is_const<LibObjT>::value,
1049 "Not available with `bt2::ConstStructureFieldClassMember`.");
1051 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1052 userAttrs.libObjPtr());
1055 UserAttributes userAttributes() const noexcept
1057 return UserAttributes {
1058 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1059 this->libObjPtr())};
1063 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1065 using ConstStructureFieldClassMember =
1066 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1068 namespace internal {
1070 struct StructureFieldClassMemberTypeDescr
1072 using Const = ConstStructureFieldClassMember;
1073 using NonConst = StructureFieldClassMember;
1077 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1082 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1086 template <typename LibObjT>
1087 struct CommonStructureFieldClassSpec;
1089 /* Functions specific to mutable structure field classes */
1091 struct CommonStructureFieldClassSpec<bt_field_class> final
1093 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1094 const std::uint64_t index) noexcept
1096 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1099 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1100 const char * const name) noexcept
1102 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1106 /* Functions specific to constant structure field classes */
1108 struct CommonStructureFieldClassSpec<const bt_field_class> final
1110 static const bt_field_class_structure_member *
1111 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1113 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1116 static const bt_field_class_structure_member *
1117 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1119 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1123 } /* namespace internal */
1125 template <typename LibObjT>
1126 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1129 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1130 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1133 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1135 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1136 StructureFieldClassMember>::type;
1138 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1140 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1141 _ThisCommonFieldClass {libObjPtr}
1143 BT_ASSERT_DBG(this->isStructure());
1146 template <typename OtherLibObjT>
1147 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1148 _ThisCommonFieldClass {fc}
1152 template <typename OtherLibObjT>
1153 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1155 _ThisCommonFieldClass::operator=(fc);
1159 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1161 return CommonStructureFieldClass<const bt_field_class> {*this};
1164 void appendMember(const char * const name, const FieldClass fc) const
1166 static_assert(!std::is_const<LibObjT>::value,
1167 "Not available with `bt2::ConstStructureFieldClass`.");
1170 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1172 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1173 throw MemoryError {};
1177 void appendMember(const std::string& name, const FieldClass fc) const
1179 this->appendMember(name.data(), fc);
1182 std::uint64_t length() const noexcept
1184 return bt_field_class_structure_get_member_count(this->libObjPtr());
1187 Iterator begin() const noexcept
1189 return Iterator {*this, 0};
1192 Iterator end() const noexcept
1194 return Iterator {*this, this->length()};
1197 Member operator[](const std::uint64_t index) const noexcept
1199 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1200 this->libObjPtr(), index)};
1203 nonstd::optional<Member> operator[](const char * const name) const noexcept
1205 const auto libObjPtr =
1206 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1209 return Member {libObjPtr};
1212 return nonstd::nullopt;
1215 nonstd::optional<Member> operator[](const std::string& name) const noexcept
1217 return (*this)[name.data()];
1220 Shared shared() const noexcept
1222 return Shared::createWithRef(*this);
1226 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1227 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1229 namespace internal {
1231 struct StructureFieldClassTypeDescr
1233 using Const = ConstStructureFieldClass;
1234 using NonConst = StructureFieldClass;
1238 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1243 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1247 template <typename LibObjT>
1248 struct CommonArrayFieldClassSpec;
1250 /* Functions specific to mutable array field classes */
1252 struct CommonArrayFieldClassSpec<bt_field_class> final
1254 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1256 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1260 /* Functions specific to constant array field classes */
1262 struct CommonArrayFieldClassSpec<const bt_field_class> final
1264 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1266 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1270 } /* namespace internal */
1272 template <typename LibObjT>
1273 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1276 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1279 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1282 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1283 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1286 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1288 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1289 _ThisCommonFieldClass {libObjPtr}
1291 BT_ASSERT_DBG(this->isArray());
1294 template <typename OtherLibObjT>
1295 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1296 _ThisCommonFieldClass {fc}
1300 template <typename OtherLibObjT>
1301 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1303 _ThisCommonFieldClass::operator=(fc);
1307 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1309 return CommonArrayFieldClass<const bt_field_class> {*this};
1312 _FieldClass elementFieldClass() const noexcept
1314 return _FieldClass {
1315 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1318 Shared shared() const noexcept
1320 return Shared::createWithRef(*this);
1324 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1325 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1327 namespace internal {
1329 struct ArrayFieldClassTypeDescr
1331 using Const = ConstArrayFieldClass;
1332 using NonConst = ArrayFieldClass;
1336 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1341 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1345 } /* namespace internal */
1347 template <typename LibObjT>
1348 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1351 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1352 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1355 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1357 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1358 _ThisCommonArrayFieldClass {libObjPtr}
1360 BT_ASSERT_DBG(this->isStaticArray());
1363 template <typename OtherLibObjT>
1364 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1365 _ThisCommonArrayFieldClass {fc}
1369 template <typename OtherLibObjT>
1370 CommonStaticArrayFieldClass&
1371 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1373 _ThisCommonArrayFieldClass::operator=(fc);
1377 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1379 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1382 std::uint64_t length() const noexcept
1384 return bt_field_class_array_static_get_length(this->libObjPtr());
1387 Shared shared() const noexcept
1389 return Shared::createWithRef(*this);
1393 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1394 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1396 namespace internal {
1398 struct StaticArrayFieldClassTypeDescr
1400 using Const = ConstStaticArrayFieldClass;
1401 using NonConst = StaticArrayFieldClass;
1405 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1410 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1414 } /* namespace internal */
1416 template <typename LibObjT>
1417 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1420 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1421 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1424 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1426 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1427 _ThisCommonArrayFieldClass {libObjPtr}
1429 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1432 template <typename OtherLibObjT>
1433 CommonDynamicArrayWithLengthFieldClass(
1434 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1435 _ThisCommonArrayFieldClass {fc}
1439 template <typename OtherLibObjT>
1440 CommonDynamicArrayWithLengthFieldClass&
1441 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1443 _ThisCommonArrayFieldClass::operator=(fc);
1447 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1449 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1452 ConstFieldPath lengthFieldPath() const noexcept
1454 return ConstFieldPath {
1455 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1456 this->libObjPtr())};
1459 Shared shared() const noexcept
1461 return Shared::createWithRef(*this);
1465 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1467 using ConstDynamicArrayWithLengthFieldClass =
1468 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1470 namespace internal {
1472 struct DynamicArrayWithLengthFieldClassTypeDescr
1474 using Const = ConstDynamicArrayWithLengthFieldClass;
1475 using NonConst = DynamicArrayWithLengthFieldClass;
1479 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1480 public DynamicArrayWithLengthFieldClassTypeDescr
1485 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1486 public DynamicArrayWithLengthFieldClassTypeDescr
1490 template <typename LibObjT>
1491 struct CommonOptionFieldClassSpec;
1493 /* Functions specific to mutable option field classes */
1495 struct CommonOptionFieldClassSpec<bt_field_class> final
1497 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1499 return bt_field_class_option_borrow_field_class(libObjPtr);
1503 /* Functions specific to constant option field classes */
1505 struct CommonOptionFieldClassSpec<const bt_field_class> final
1507 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1509 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1513 } /* namespace internal */
1515 template <typename LibObjT>
1516 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1519 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1522 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1525 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1526 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1529 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1531 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1532 _ThisCommonFieldClass {libObjPtr}
1534 BT_ASSERT_DBG(this->isOption());
1537 template <typename OtherLibObjT>
1538 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1539 _ThisCommonFieldClass {fc}
1543 template <typename OtherLibObjT>
1544 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1546 _ThisCommonFieldClass::operator=(fc);
1550 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1552 return CommonOptionFieldClass<const bt_field_class> {*this};
1555 _FieldClass fieldClass() const noexcept
1557 return _FieldClass {
1558 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1561 Shared shared() const noexcept
1563 return Shared::createWithRef(*this);
1567 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1568 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1570 namespace internal {
1572 struct OptionFieldClassTypeDescr
1574 using Const = ConstOptionFieldClass;
1575 using NonConst = OptionFieldClass;
1579 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1584 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1588 } /* namespace internal */
1590 template <typename LibObjT>
1591 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1594 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1597 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1598 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1601 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1603 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1604 _ThisCommonOptionFieldClass {libObjPtr}
1606 BT_ASSERT_DBG(this->isOptionWithSelector());
1609 template <typename OtherLibObjT>
1610 CommonOptionWithSelectorFieldClass(
1611 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1612 _ThisCommonOptionFieldClass {fc}
1616 template <typename OtherLibObjT>
1617 CommonOptionWithSelectorFieldClass&
1618 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1620 _ThisCommonOptionFieldClass::operator=(fc);
1624 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1626 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1629 ConstFieldPath selectorFieldPath() const noexcept
1631 return ConstFieldPath {
1632 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1633 this->libObjPtr())};
1636 Shared shared() const noexcept
1638 return Shared::createWithRef(*this);
1642 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1643 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1645 namespace internal {
1647 struct OptionWithSelectorFieldClassTypeDescr
1649 using Const = ConstOptionWithSelectorFieldClass;
1650 using NonConst = OptionWithSelectorFieldClass;
1654 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1659 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1663 } /* namespace internal */
1665 template <typename LibObjT>
1666 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1669 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1671 using typename CommonOptionWithSelectorFieldClass<
1672 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1675 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1677 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1678 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1680 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1683 template <typename OtherLibObjT>
1684 CommonOptionWithBoolSelectorFieldClass(
1685 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1686 _ThisCommonOptionWithSelectorFieldClass {fc}
1690 template <typename OtherLibObjT>
1691 CommonOptionWithBoolSelectorFieldClass&
1692 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1694 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1698 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1700 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1703 bool selectorIsReversed() const noexcept
1705 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1709 Shared shared() const noexcept
1711 return Shared::createWithRef(*this);
1715 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1717 using ConstOptionWithBoolSelectorFieldClass =
1718 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1720 namespace internal {
1722 struct OptionWithBoolSelectorFieldClassTypeDescr
1724 using Const = ConstOptionWithBoolSelectorFieldClass;
1725 using NonConst = OptionWithBoolSelectorFieldClass;
1729 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1730 public OptionWithBoolSelectorFieldClassTypeDescr
1735 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1736 public OptionWithBoolSelectorFieldClassTypeDescr
1740 template <typename RangeSetT>
1741 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1743 /* Functions specific to option field classes with unsigned integer ranges */
1745 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1747 static const bt_integer_range_set_unsigned *
1748 ranges(const bt_field_class * const libObjPtr) noexcept
1750 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1755 /* Functions specific to option field classes with signed ranges */
1757 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1759 static const bt_integer_range_set_signed *
1760 ranges(const bt_field_class * const libObjPtr) noexcept
1762 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1767 } /* namespace internal */
1769 template <typename LibObjT, typename RangeSetT>
1770 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1773 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1775 using typename CommonOptionWithSelectorFieldClass<
1776 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1778 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1779 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1782 using Shared = SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1784 using RangeSet = RangeSetT;
1786 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1787 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1789 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1792 template <typename OtherLibObjT>
1793 CommonOptionWithIntegerSelectorFieldClass(
1794 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1795 _ThisCommonOptionWithSelectorFieldClass {fc}
1799 template <typename OtherLibObjT>
1800 CommonOptionWithIntegerSelectorFieldClass&
1801 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1803 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1807 RangeSet ranges() const noexcept
1809 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1810 this->libObjPtr())};
1813 Shared shared() const noexcept
1815 return Shared::createWithRef(*this);
1819 using OptionWithUnsignedIntegerSelectorFieldClass =
1820 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1822 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1823 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1825 using OptionWithSignedIntegerSelectorFieldClass =
1826 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1828 using ConstOptionWithSignedIntegerSelectorFieldClass =
1829 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1831 namespace internal {
1833 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1835 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1836 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1840 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1841 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1846 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1847 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1851 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1853 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1854 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1858 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1859 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1864 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1865 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1869 template <typename LibObjT>
1870 struct CommonVariantFieldClassOptionSpec;
1872 /* Functions specific to mutable variant field class options */
1874 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1876 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1878 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1881 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1883 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1887 /* Functions specific to constant variant field class options */
1889 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1891 static const bt_field_class *
1892 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1894 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1897 static const bt_value *
1898 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1900 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1904 } /* namespace internal */
1906 template <typename LibObjT>
1907 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1910 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1911 using typename BorrowedObject<LibObjT>::_LibObjPtr;
1914 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1917 using UserAttributes =
1918 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
1920 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1921 _ThisBorrowedObject {libObjPtr}
1925 template <typename OtherLibObjT>
1926 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1927 _ThisBorrowedObject {fc}
1931 template <typename OtherLibObjT>
1932 CommonVariantFieldClassOption&
1933 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1935 _ThisBorrowedObject::operator=(fc);
1939 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1941 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1944 nonstd::optional<bpstd::string_view> name() const noexcept
1946 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1952 return nonstd::nullopt;
1955 _FieldClass fieldClass() const noexcept
1957 return _FieldClass {
1958 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1961 template <typename LibValT>
1962 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1964 static_assert(!std::is_const<LibObjT>::value,
1965 "Not available with `bt2::ConstVariantFieldClassOption`.");
1967 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1970 UserAttributes userAttributes() const noexcept
1972 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1973 this->libObjPtr())};
1977 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1979 using ConstVariantFieldClassOption =
1980 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1982 namespace internal {
1984 struct VariantFieldClassOptionTypeDescr
1986 using Const = ConstVariantFieldClassOption;
1987 using NonConst = VariantFieldClassOption;
1991 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1996 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
2000 template <typename LibObjT>
2001 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
2003 /* Functions specific to variant field class options with unsigned integer selector */
2005 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2006 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
2009 static const bt_integer_range_set_unsigned *
2010 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
2011 * const libObjPtr) noexcept
2013 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
2017 static const bt_field_class_variant_option *
2018 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
2019 * const libObjPtr) noexcept
2021 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
2026 /* Functions specific to variant field class options with signed integer selector */
2028 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
2029 const bt_field_class_variant_with_selector_field_integer_signed_option>
2032 static const bt_integer_range_set_signed *
2033 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
2034 * const libObjPtr) noexcept
2036 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
2040 static const bt_field_class_variant_option *
2041 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
2042 * const libObjPtr) noexcept
2044 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2049 } /* namespace internal */
2051 template <typename LibObjT>
2052 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2055 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2056 using typename BorrowedObject<LibObjT>::_LibObjPtr;
2057 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2060 using RangeSet = typename std::conditional<
2063 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2064 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2066 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2067 _ThisBorrowedObject {libObjPtr}
2071 template <typename OtherLibObjT>
2072 ConstVariantWithIntegerSelectorFieldClassOption(
2073 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2074 _ThisBorrowedObject {fc}
2078 template <typename OtherLibObjT>
2079 ConstVariantWithIntegerSelectorFieldClassOption&
2080 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2082 _ThisBorrowedObject::operator=(fc);
2086 ConstVariantFieldClassOption asBaseOption() const noexcept
2088 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2091 nonstd::optional<bpstd::string_view> name() const noexcept
2093 return this->asBaseOption().name();
2096 ConstFieldClass fieldClass() const noexcept
2098 return this->asBaseOption().fieldClass();
2101 RangeSet ranges() const noexcept
2103 return RangeSet {_Spec::ranges(this->libObjPtr())};
2107 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2108 ConstVariantWithIntegerSelectorFieldClassOption<
2109 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2111 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2112 ConstVariantWithIntegerSelectorFieldClassOption<
2113 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2115 namespace internal {
2117 template <typename LibObjT>
2118 struct CommonVariantFieldClassSpec;
2120 /* Functions specific to mutable variant field classes */
2122 struct CommonVariantFieldClassSpec<bt_field_class> final
2124 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2125 const std::uint64_t index) noexcept
2127 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2130 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2131 const char * const name) noexcept
2133 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2137 /* Functions specific to constant variant field classes */
2139 struct CommonVariantFieldClassSpec<const bt_field_class> final
2141 static const bt_field_class_variant_option *
2142 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2144 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2147 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2148 const char * const name) noexcept
2150 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2154 } /* namespace internal */
2156 template <typename LibObjT>
2157 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2160 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2163 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2164 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2167 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2170 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2171 VariantFieldClassOption>::type;
2173 using Iterator = CommonIterator<CommonVariantFieldClass, Option>;
2175 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2176 _ThisCommonFieldClass {libObjPtr}
2178 BT_ASSERT_DBG(this->isVariant());
2181 template <typename OtherLibObjT>
2182 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2183 _ThisCommonFieldClass {fc}
2187 template <typename OtherLibObjT>
2188 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2190 _ThisCommonFieldClass::operator=(fc);
2194 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2196 return CommonVariantFieldClass<const bt_field_class> {*this};
2199 std::uint64_t length() const noexcept
2201 return bt_field_class_variant_get_option_count(this->libObjPtr());
2204 Iterator begin() const noexcept
2206 return Iterator {*this, 0};
2209 Iterator end() const noexcept
2211 return Iterator {*this, this->length()};
2214 Option operator[](const std::uint64_t index) const noexcept
2216 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2217 this->libObjPtr(), index)};
2220 nonstd::optional<Option> operator[](const char * const name) const noexcept
2222 const auto libObjPtr =
2223 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2226 return Option {libObjPtr};
2229 return nonstd::nullopt;
2232 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2234 return (*this)[name.data()];
2237 Shared shared() const noexcept
2239 return Shared::createWithRef(*this);
2243 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2244 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2246 namespace internal {
2248 struct VariantFieldClassTypeDescr
2250 using Const = ConstVariantFieldClass;
2251 using NonConst = VariantFieldClass;
2255 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2260 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2264 } /* namespace internal */
2266 template <typename LibObjT>
2267 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2270 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2271 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2274 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2276 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2277 _ThisCommonVariantFieldClass {libObjPtr}
2279 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2282 template <typename OtherLibObjT>
2283 CommonVariantWithoutSelectorFieldClass(
2284 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2285 _ThisCommonVariantFieldClass {fc}
2289 template <typename OtherLibObjT>
2290 CommonVariantWithoutSelectorFieldClass&
2291 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2293 _ThisCommonVariantFieldClass::operator=(fc);
2297 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2299 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2302 void appendOption(const char * const name, const FieldClass fc) const
2304 static_assert(!std::is_const<LibObjT>::value,
2305 "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");
2307 const auto status = bt_field_class_variant_without_selector_append_option(
2308 this->libObjPtr(), name, fc.libObjPtr());
2311 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2312 throw MemoryError {};
2316 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc) const
2318 this->appendOption(name ? name->data() : nullptr, fc);
2321 Shared shared() const noexcept
2323 return Shared::createWithRef(*this);
2327 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2328 using ConstVariantWithoutSelectorFieldClass =
2329 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2331 namespace internal {
2333 struct VariantWithoutSelectorFieldClassTypeDescr
2335 using Const = ConstVariantWithoutSelectorFieldClass;
2336 using NonConst = VariantWithoutSelectorFieldClass;
2340 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2341 public VariantWithoutSelectorFieldClassTypeDescr
2346 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2347 public VariantWithoutSelectorFieldClassTypeDescr
2351 template <typename OptionT>
2352 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2354 /* Functions specific to variant field classes with unsigned integer selector */
2356 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2357 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2360 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2361 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2363 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2367 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2368 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2370 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2374 static bt_field_class_variant_with_selector_field_integer_append_option_status
2375 appendOption(bt_field_class * const libObjPtr, const char * const name,
2376 bt_field_class * const libOptFcPtr,
2377 const bt_integer_range_set_unsigned * const libRangesPtr)
2379 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2380 libObjPtr, name, libOptFcPtr, libRangesPtr);
2384 /* Functions specific to variant field classes with signed integer selector */
2386 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2387 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2390 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2391 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2393 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2397 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2398 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2400 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2404 static bt_field_class_variant_with_selector_field_integer_append_option_status
2405 appendOption(bt_field_class * const libObjPtr, const char * const name,
2406 bt_field_class * const libOptFcPtr,
2407 const bt_integer_range_set_signed * const libRangesPtr)
2409 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2410 libObjPtr, name, libOptFcPtr, libRangesPtr);
2414 } /* namespace internal */
2416 template <typename LibObjT>
2417 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2420 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2423 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2424 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2427 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2429 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2430 _ThisCommonVariantFieldClass {libObjPtr}
2432 BT_ASSERT_DBG(this->isVariantWithSelector());
2435 template <typename OtherLibObjT>
2436 CommonVariantWithSelectorFieldClass(
2437 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2438 _ThisCommonVariantFieldClass {fc}
2442 template <typename OtherLibObjT>
2443 CommonVariantWithSelectorFieldClass&
2444 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2446 _ThisCommonVariantFieldClass::operator=(fc);
2450 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2452 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2455 ConstFieldPath selectorFieldPath() const noexcept
2457 return ConstFieldPath {
2458 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2459 this->libObjPtr())};
2462 Shared shared() const noexcept
2464 return Shared::createWithRef(*this);
2468 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2469 using ConstVariantWithSelectorFieldClass =
2470 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2472 template <typename LibObjT, typename OptionT>
2473 class CommonVariantWithIntegerSelectorFieldClass :
2474 public CommonVariantWithSelectorFieldClass<LibObjT>
2477 using typename CommonVariantWithSelectorFieldClass<
2478 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2479 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2480 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2481 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2483 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2486 using Shared = SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2488 using Option = OptionT;
2490 CommonIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>, Option>;
2492 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2493 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2495 BT_ASSERT_DBG(this->isVariant());
2498 template <typename OtherLibObjT>
2499 CommonVariantWithIntegerSelectorFieldClass(
2500 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2501 _ThisCommonVariantWithSelectorFieldClass {fc}
2505 template <typename OtherLibObjT>
2506 CommonVariantWithIntegerSelectorFieldClass&
2507 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2509 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2513 Option operator[](const std::uint64_t index) const noexcept
2515 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2518 nonstd::optional<Option> operator[](const char * const name) const noexcept
2520 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2523 return Option {libObjPtr};
2526 return nonstd::nullopt;
2529 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2531 return (*this)[name.data()];
2534 void appendOption(const char * const name, const FieldClass fc,
2535 const typename Option::RangeSet ranges) const
2538 !std::is_const<LibObjT>::value,
2539 "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");
2542 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2545 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2546 throw MemoryError {};
2550 void appendOption(const nonstd::optional<std::string>& name, const FieldClass fc,
2551 const typename Option::RangeSet ranges) const
2553 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2556 Iterator begin() const noexcept
2558 return Iterator {*this, 0};
2561 Iterator end() const noexcept
2563 return Iterator {*this, this->length()};
2566 Shared shared() const noexcept
2568 return Shared::createWithRef(*this);
2572 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2573 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2575 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2576 CommonVariantWithIntegerSelectorFieldClass<
2577 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2579 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2580 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2582 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2583 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2585 namespace internal {
2587 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2589 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2590 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2594 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2595 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2600 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2601 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2605 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2607 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2608 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2612 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2613 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2618 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2619 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2623 } /* namespace internal */
2625 template <typename LibObjT>
2626 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2628 BT_ASSERT_DBG(this->isBitArray());
2629 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2632 template <typename LibObjT>
2633 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2635 BT_ASSERT_DBG(this->isInteger());
2636 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2639 template <typename LibObjT>
2640 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2642 BT_ASSERT_DBG(this->isEnumeration());
2643 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2646 template <typename LibObjT>
2647 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2648 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2650 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2651 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2655 template <typename LibObjT>
2656 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2657 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2659 BT_ASSERT_DBG(this->isSignedEnumeration());
2660 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2664 template <typename LibObjT>
2665 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2667 BT_ASSERT_DBG(this->isStructure());
2668 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2671 template <typename LibObjT>
2672 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2674 BT_ASSERT_DBG(this->isArray());
2675 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2678 template <typename LibObjT>
2679 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2681 BT_ASSERT_DBG(this->isStaticArray());
2682 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2685 template <typename LibObjT>
2686 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2687 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2689 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2690 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2693 template <typename LibObjT>
2694 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2696 BT_ASSERT_DBG(this->isOption());
2697 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2700 template <typename LibObjT>
2701 CommonOptionWithSelectorFieldClass<LibObjT>
2702 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2704 BT_ASSERT_DBG(this->isOptionWithSelector());
2705 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2708 template <typename LibObjT>
2709 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2710 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2712 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2713 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2716 template <typename LibObjT>
2717 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2718 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2720 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2721 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2725 template <typename LibObjT>
2726 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2727 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2729 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2730 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2734 template <typename LibObjT>
2735 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2737 BT_ASSERT_DBG(this->isVariant());
2738 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2741 template <typename LibObjT>
2742 CommonVariantWithoutSelectorFieldClass<LibObjT>
2743 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2745 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2746 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2749 template <typename LibObjT>
2750 CommonVariantWithSelectorFieldClass<LibObjT>
2751 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2753 BT_ASSERT_DBG(this->isVariantWithSelector());
2754 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2757 template <typename LibObjT>
2758 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2759 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2760 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2762 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2763 return CommonVariantWithIntegerSelectorFieldClass<
2764 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2767 template <typename LibObjT>
2768 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2769 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2770 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2772 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2773 return CommonVariantWithIntegerSelectorFieldClass<
2774 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2777 } /* namespace bt2 */
2779 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */