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/bt2s/optional.hpp"
18 #include "borrowed-object-iterator.hpp"
19 #include "borrowed-object.hpp"
21 #include "field-path.hpp"
22 #include "integer-range-set.hpp"
23 #include "internal/utils.hpp"
24 #include "shared-object.hpp"
30 struct FieldClassRefFuncs final
32 static void get(const bt_field_class * const libObjPtr) noexcept
34 bt_field_class_get_ref(libObjPtr);
37 static void put(const bt_field_class * const libObjPtr) noexcept
39 bt_field_class_put_ref(libObjPtr);
43 template <typename LibObjT>
44 struct CommonFieldClassSpec;
46 /* Functions specific to mutable field classes */
48 struct CommonFieldClassSpec<bt_field_class> final
50 static bt_value *userAttributes(bt_field_class * const libObjPtr) noexcept
52 return bt_field_class_borrow_user_attributes(libObjPtr);
56 /* Functions specific to constant field classes */
58 struct CommonFieldClassSpec<const bt_field_class> final
60 static const bt_value *userAttributes(const bt_field_class * const libObjPtr) noexcept
62 return bt_field_class_borrow_user_attributes_const(libObjPtr);
66 } /* namespace internal */
68 template <typename ObjT, typename LibObjT>
69 using SharedFieldClass = SharedObject<ObjT, LibObjT, internal::FieldClassRefFuncs>;
71 template <typename LibObjT>
72 class CommonBitArrayFieldClass;
74 template <typename LibObjT>
75 class CommonIntegerFieldClass;
77 template <typename LibObjT>
78 class ConstEnumerationFieldClassMapping;
80 template <typename LibObjT>
81 class CommonBaseEnumerationFieldClass;
83 template <typename LibObjT, typename MappingT>
84 class CommonEnumerationFieldClass;
86 template <typename LibObjT>
87 class CommonStructureFieldClass;
89 template <typename LibObjT>
90 class CommonArrayFieldClass;
92 template <typename LibObjT>
93 class CommonStaticArrayFieldClass;
95 template <typename LibObjT>
96 class CommonDynamicArrayWithLengthFieldClass;
98 template <typename LibObjT>
99 class CommonOptionFieldClass;
101 template <typename LibObjT>
102 class CommonOptionWithSelectorFieldClass;
104 template <typename LibObjT>
105 class CommonOptionWithBoolSelectorFieldClass;
107 template <typename LibObjT>
108 class CommonVariantFieldClass;
110 template <typename LibObjT, typename RangeSetT>
111 class CommonOptionWithIntegerSelectorFieldClass;
113 template <typename LibObjT>
114 class CommonVariantWithoutSelectorFieldClass;
116 template <typename LibObjT>
117 class CommonVariantWithSelectorFieldClass;
119 template <typename LibObjT>
120 class ConstVariantWithIntegerSelectorFieldClassOption;
122 template <typename LibObjT, typename RangeSetT>
123 class CommonVariantWithIntegerSelectorFieldClass;
125 template <typename LibObjT>
126 class CommonEventClass;
128 template <typename LibObjT>
129 class CommonStreamClass;
131 template <typename LibObjT>
132 class CommonTraceClass;
134 enum class FieldClassType
136 BOOL = BT_FIELD_CLASS_TYPE_BOOL,
137 BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
138 UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
139 SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
140 UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
141 SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
142 SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
143 DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
144 STRING = BT_FIELD_CLASS_TYPE_STRING,
145 STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
146 STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
147 DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
148 DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
149 OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
150 OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
151 OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
152 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
153 OPTION_WITH_SIGNED_INTEGER_SELECTOR =
154 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
155 VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
156 VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
157 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
158 VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
159 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
162 template <typename LibObjT>
163 class CommonFieldClass : public BorrowedObject<LibObjT>
166 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
169 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
172 using typename BorrowedObject<LibObjT>::LibObjPtr;
173 using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
174 using UserAttributes = internal::DepUserAttrs<LibObjT>;
176 explicit CommonFieldClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
180 template <typename OtherLibObjT>
181 CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
185 template <typename OtherLibObjT>
186 CommonFieldClass operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
188 _ThisBorrowedObject::operator=(fc);
192 CommonFieldClass<const bt_field_class> asConst() const noexcept
194 return CommonFieldClass<const bt_field_class> {*this};
197 FieldClassType type() const noexcept
199 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
202 bool isBool() const noexcept
204 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
207 bool isBitArray() const noexcept
209 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
212 bool isInteger() const noexcept
214 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
217 bool isUnsignedInteger() const noexcept
219 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
222 bool isSignedInteger() const noexcept
224 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
227 bool isEnumeration() const noexcept
229 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
232 bool isUnsignedEnumeration() const noexcept
234 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
237 bool isSignedEnumeration() const noexcept
239 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
242 bool isReal() const noexcept
244 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
247 bool isSinglePrecisionReal() const noexcept
249 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
252 bool isDoublePrecisionReal() const noexcept
254 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
257 bool isString() const noexcept
259 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
262 bool isStructure() const noexcept
264 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
267 bool isArray() const noexcept
269 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
272 bool isStaticArray() const noexcept
274 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
277 bool isDynamicArray() const noexcept
279 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
282 bool isDynamicArrayWithoutLength() const noexcept
284 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
287 bool isDynamicArrayWithLength() const noexcept
289 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
292 bool isOption() const noexcept
294 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
297 bool isOptionWithoutSelector() const noexcept
299 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
302 bool isOptionWithSelector() const noexcept
304 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
307 bool isOptionWithBoolSelector() const noexcept
309 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
312 bool isOptionWithIntegerSelector() const noexcept
314 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
317 bool isOptionWithUnsignedIntegerSelector() const noexcept
319 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
322 bool isOptionWithSignedIntegerSelector() const noexcept
324 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
327 bool isVariant() const noexcept
329 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
332 bool isVariantWithoutSelector() const noexcept
334 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
337 bool isVariantWithSelector() const noexcept
339 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
342 bool isVariantWithIntegerSelector() const noexcept
344 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
347 bool isVariantWithUnsignedIntegerSelector() const noexcept
349 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
352 bool isVariantWithSignedIntegerSelector() const noexcept
354 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
357 template <typename FieldClassT>
358 FieldClassT as() const noexcept
360 return FieldClassT {this->libObjPtr()};
363 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
364 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
365 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
366 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
367 const bt_field_class_enumeration_unsigned_mapping>>
368 asUnsignedEnumeration() const noexcept;
370 CommonEnumerationFieldClass<
371 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
372 asSignedEnumeration() const noexcept;
374 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
375 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
376 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
377 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
378 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
379 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
380 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
382 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
383 asOptionWithUnsignedIntegerSelector() const noexcept;
385 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
386 asOptionWithSignedIntegerSelector() const noexcept;
388 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
389 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
390 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
392 CommonVariantWithIntegerSelectorFieldClass<
393 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
394 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
395 asVariantWithUnsignedIntegerSelector() const noexcept;
397 CommonVariantWithIntegerSelectorFieldClass<
398 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
399 const bt_field_class_variant_with_selector_field_integer_signed_option>>
400 asVariantWithSignedIntegerSelector() const noexcept;
402 template <typename LibValT>
403 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
405 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstFieldClass`.");
407 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
410 UserAttributes userAttributes() const noexcept
412 return UserAttributes {
413 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
416 Shared shared() const noexcept
418 return Shared::createWithRef(*this);
422 bool _libTypeIs(const bt_field_class_type type) const noexcept
424 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
428 using FieldClass = CommonFieldClass<bt_field_class>;
429 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
433 struct FieldClassTypeDescr
435 using Const = ConstFieldClass;
436 using NonConst = FieldClass;
440 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
445 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
449 } /* namespace internal */
451 template <typename LibObjT>
452 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
455 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
458 using typename CommonFieldClass<LibObjT>::LibObjPtr;
459 using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
461 explicit CommonBitArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
462 _ThisCommonFieldClass {libObjPtr}
464 BT_ASSERT_DBG(this->isBitArray());
467 template <typename OtherLibObjT>
468 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
469 _ThisCommonFieldClass {fc}
473 template <typename OtherLibObjT>
474 CommonBitArrayFieldClass<LibObjT>
475 operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
477 _ThisCommonFieldClass::operator=(fc);
481 CommonBitArrayFieldClass<const bt_field_class> asConst() const noexcept
483 return CommonBitArrayFieldClass<const bt_field_class> {*this};
486 std::uint64_t length() const noexcept
488 return bt_field_class_bit_array_get_length(this->libObjPtr());
491 Shared shared() const noexcept
493 return Shared::createWithRef(*this);
497 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
498 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
502 struct BitArrayFieldClassTypeDescr
504 using Const = ConstBitArrayFieldClass;
505 using NonConst = BitArrayFieldClass;
509 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
514 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
518 } /* namespace internal */
520 enum class DisplayBase
522 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
523 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
524 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
525 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
528 template <typename LibObjT>
529 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
532 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
535 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
538 using typename CommonFieldClass<LibObjT>::LibObjPtr;
539 using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
541 explicit CommonIntegerFieldClass(const LibObjPtr libObjPtr) noexcept :
542 _ThisCommonFieldClass {libObjPtr}
544 BT_ASSERT_DBG(this->isInteger());
547 template <typename OtherLibObjT>
548 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
549 _ThisCommonFieldClass {fc}
553 template <typename OtherLibObjT>
554 CommonIntegerFieldClass operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
556 _ThisCommonFieldClass::operator=(fc);
560 CommonIntegerFieldClass<const bt_field_class> asConst() const noexcept
562 return CommonIntegerFieldClass<const bt_field_class> {*this};
565 void fieldValueRange(const std::uint64_t n) const noexcept
567 static_assert(!std::is_const<LibObjT>::value,
568 "Not available with `bt2::ConstIntegerFieldClass`.");
570 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
573 std::uint64_t fieldValueRange() const noexcept
575 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
578 void preferredDisplayBase(const DisplayBase base) const noexcept
580 static_assert(!std::is_const<LibObjT>::value,
581 "Not available with `bt2::ConstIntegerFieldClass`.");
583 bt_field_class_integer_set_preferred_display_base(
584 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
587 DisplayBase preferredDisplayBase() const noexcept
589 return static_cast<DisplayBase>(
590 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
593 Shared shared() const noexcept
595 return Shared::createWithRef(*this);
599 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
600 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
604 struct IntegerFieldClassTypeDescr
606 using Const = ConstIntegerFieldClass;
607 using NonConst = IntegerFieldClass;
611 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
616 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
620 template <typename LibObjT>
621 struct ConstEnumerationFieldClassMappingSpec;
623 /* Functions specific to unsigned enumeration field class mappings */
625 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
628 static const bt_integer_range_set_unsigned *
629 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
631 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
635 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
637 return bt_field_class_enumeration_mapping_get_label(
638 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
642 /* Functions specific to signed enumeration field class mappings */
644 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
646 static const bt_integer_range_set_signed *
647 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
649 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
653 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
655 return bt_field_class_enumeration_mapping_get_label(
656 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
660 } /* namespace internal */
662 template <typename LibObjT>
663 class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
666 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
669 using typename BorrowedObject<LibObjT>::LibObjPtr;
671 using RangeSet = typename std::conditional<
672 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
673 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
675 explicit ConstEnumerationFieldClassMapping(const LibObjPtr libObjPtr) noexcept :
676 _ThisBorrowedObject {libObjPtr}
680 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
681 _ThisBorrowedObject {mapping}
685 ConstEnumerationFieldClassMapping
686 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
688 _ThisBorrowedObject::operator=(mapping);
692 RangeSet ranges() const noexcept
695 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
698 const char *label() const noexcept
700 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
704 using ConstUnsignedEnumerationFieldClassMapping =
705 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
707 using ConstSignedEnumerationFieldClassMapping =
708 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
712 template <typename MappingT>
713 struct CommonEnumerationFieldClassSpec;
715 /* Functions specific to unsigned enumeration field classes */
717 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
719 static const bt_field_class_enumeration_unsigned_mapping *
720 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
722 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
725 static const bt_field_class_enumeration_unsigned_mapping *
726 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
728 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
731 static bt_field_class_enumeration_add_mapping_status
732 addMapping(bt_field_class * const libObjPtr, const char * const label,
733 const bt_integer_range_set_unsigned * const libRanges) noexcept
735 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
739 /* Functions specific to signed enumeration field classes */
741 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
743 static const bt_field_class_enumeration_signed_mapping *
744 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
746 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
749 static const bt_field_class_enumeration_signed_mapping *
750 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
752 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
755 static bt_field_class_enumeration_add_mapping_status
756 addMapping(bt_field_class * const libObjPtr, const char * const label,
757 const bt_integer_range_set_signed * const libRanges) noexcept
759 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
763 } /* namespace internal */
765 template <typename LibObjT>
766 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
769 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
772 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
775 using typename CommonFieldClass<LibObjT>::LibObjPtr;
776 using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
778 explicit CommonBaseEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
779 _ThisCommonIntegerFieldClass {libObjPtr}
781 BT_ASSERT_DBG(this->isEnumeration());
784 template <typename OtherLibObjT>
785 CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
787 _ThisCommonIntegerFieldClass {fc}
791 template <typename OtherLibObjT>
792 CommonBaseEnumerationFieldClass
793 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
795 _ThisCommonIntegerFieldClass::operator=(fc);
799 CommonBaseEnumerationFieldClass<const bt_field_class> asConst() const noexcept
801 return CommonBaseEnumerationFieldClass<const bt_field_class> {*this};
804 std::uint64_t length() const noexcept
806 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
809 Shared shared() const noexcept
811 return Shared::createWithRef(*this);
815 template <typename LibObjT, typename MappingT>
816 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
819 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
822 using typename CommonFieldClass<LibObjT>::LibObjPtr;
823 using Shared = SharedFieldClass<CommonEnumerationFieldClass, LibObjT>;
824 using Iterator = BorrowedObjectIterator<CommonEnumerationFieldClass>;
825 using Mapping = MappingT;
827 explicit CommonEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
828 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
830 BT_ASSERT_DBG(this->isEnumeration());
833 template <typename OtherLibObjT>
834 CommonEnumerationFieldClass(
835 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
836 CommonEnumerationFieldClass {fc}
840 template <typename OtherLibObjT>
841 CommonEnumerationFieldClass
842 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
844 CommonEnumerationFieldClass::operator=(fc);
848 Mapping operator[](const std::uint64_t index) const noexcept
850 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
851 this->libObjPtr(), index)};
854 bt2s::optional<Mapping> operator[](const char * const label) const noexcept
856 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
857 this->libObjPtr(), label);
860 return Mapping {libObjPtr};
863 return bt2s::nullopt;
866 bt2s::optional<Mapping> operator[](const std::string& label) const noexcept
868 return (*this)[label.data()];
871 void addMapping(const char * const label, const typename Mapping::RangeSet ranges) const
873 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
874 this->libObjPtr(), label, ranges.libObjPtr());
876 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
877 throw MemoryError {};
881 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges) const
883 this->addMapping(label.data(), ranges);
886 Iterator begin() const noexcept
888 return Iterator {*this, 0};
891 Iterator end() const noexcept
893 return Iterator {*this, this->length()};
896 Shared shared() const noexcept
898 return Shared::createWithRef(*this);
902 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
903 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
905 using UnsignedEnumerationFieldClass =
906 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
908 using ConstUnsignedEnumerationFieldClass =
909 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
911 using SignedEnumerationFieldClass =
912 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
914 using ConstSignedEnumerationFieldClass =
915 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
919 struct UnsignedEnumerationFieldClassTypeDescr
921 using Const = ConstUnsignedEnumerationFieldClass;
922 using NonConst = UnsignedEnumerationFieldClass;
926 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
931 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
935 struct SignedEnumerationFieldClassTypeDescr
937 using Const = ConstSignedEnumerationFieldClass;
938 using NonConst = SignedEnumerationFieldClass;
942 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
947 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
951 template <typename LibObjT>
952 struct CommonStructureFieldClassMemberSpec;
954 /* Functions specific to mutable structure field class members */
956 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
958 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
960 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
963 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
965 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
969 /* Functions specific to constant structure field class members */
971 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
973 static const bt_field_class *
974 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
976 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
979 static const bt_value *
980 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
982 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
986 } /* namespace internal */
988 template <typename LibObjT>
989 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
992 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
993 using _FieldClass = internal::DepFc<LibObjT>;
996 using typename BorrowedObject<LibObjT>::LibObjPtr;
997 using UserAttributes = internal::DepUserAttrs<LibObjT>;
999 explicit CommonStructureFieldClassMember(const LibObjPtr libObjPtr) noexcept :
1000 _ThisBorrowedObject {libObjPtr}
1004 template <typename OtherLibObjT>
1005 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1007 _ThisBorrowedObject {fc}
1011 template <typename OtherLibObjT>
1012 CommonStructureFieldClassMember<LibObjT>
1013 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1015 _ThisBorrowedObject::operator=(fc);
1019 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1021 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1024 const char *name() const noexcept
1026 return bt_field_class_structure_member_get_name(this->libObjPtr());
1029 _FieldClass fieldClass() const noexcept
1031 return _FieldClass {
1032 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1035 template <typename LibValT>
1036 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1038 static_assert(!std::is_const<LibObjT>::value,
1039 "Not available with `bt2::ConstStructureFieldClassMember`.");
1041 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1042 userAttrs.libObjPtr());
1045 UserAttributes userAttributes() const noexcept
1047 return UserAttributes {
1048 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1049 this->libObjPtr())};
1053 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1055 using ConstStructureFieldClassMember =
1056 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1058 namespace internal {
1060 struct StructureFieldClassMemberTypeDescr
1062 using Const = ConstStructureFieldClassMember;
1063 using NonConst = StructureFieldClassMember;
1067 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1072 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1076 template <typename LibObjT>
1077 struct CommonStructureFieldClassSpec;
1079 /* Functions specific to mutable structure field classes */
1081 struct CommonStructureFieldClassSpec<bt_field_class> final
1083 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1084 const std::uint64_t index) noexcept
1086 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1089 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1090 const char * const name) noexcept
1092 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1096 /* Functions specific to constant structure field classes */
1098 struct CommonStructureFieldClassSpec<const bt_field_class> final
1100 static const bt_field_class_structure_member *
1101 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1103 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1106 static const bt_field_class_structure_member *
1107 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1109 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1113 } /* namespace internal */
1115 template <typename LibObjT>
1116 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1119 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1122 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1123 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1124 using Iterator = BorrowedObjectIterator<CommonStructureFieldClass<LibObjT>>;
1127 internal::DepType<LibObjT, StructureFieldClassMember, ConstStructureFieldClassMember>;
1129 explicit CommonStructureFieldClass(const LibObjPtr libObjPtr) noexcept :
1130 _ThisCommonFieldClass {libObjPtr}
1132 BT_ASSERT_DBG(this->isStructure());
1135 template <typename OtherLibObjT>
1136 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1137 _ThisCommonFieldClass {fc}
1141 template <typename OtherLibObjT>
1142 CommonStructureFieldClass operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1144 _ThisCommonFieldClass::operator=(fc);
1148 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1150 return CommonStructureFieldClass<const bt_field_class> {*this};
1153 void appendMember(const char * const name, const FieldClass fc) const
1155 static_assert(!std::is_const<LibObjT>::value,
1156 "Not available with `bt2::ConstStructureFieldClass`.");
1159 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1161 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1162 throw MemoryError {};
1166 void appendMember(const std::string& name, const FieldClass fc) const
1168 this->appendMember(name.data(), fc);
1171 std::uint64_t length() const noexcept
1173 return bt_field_class_structure_get_member_count(this->libObjPtr());
1176 Iterator begin() const noexcept
1178 return Iterator {*this, 0};
1181 Iterator end() const noexcept
1183 return Iterator {*this, this->length()};
1186 Member operator[](const std::uint64_t index) const noexcept
1188 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1189 this->libObjPtr(), index)};
1192 bt2s::optional<Member> operator[](const char * const name) const noexcept
1194 const auto libObjPtr =
1195 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1198 return Member {libObjPtr};
1201 return bt2s::nullopt;
1204 bt2s::optional<Member> operator[](const std::string& name) const noexcept
1206 return (*this)[name.data()];
1209 Shared shared() const noexcept
1211 return Shared::createWithRef(*this);
1215 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1216 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1218 namespace internal {
1220 struct StructureFieldClassTypeDescr
1222 using Const = ConstStructureFieldClass;
1223 using NonConst = StructureFieldClass;
1227 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1232 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1236 template <typename LibObjT>
1237 struct CommonArrayFieldClassSpec;
1239 /* Functions specific to mutable array field classes */
1241 struct CommonArrayFieldClassSpec<bt_field_class> final
1243 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1245 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1249 /* Functions specific to constant array field classes */
1251 struct CommonArrayFieldClassSpec<const bt_field_class> final
1253 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1255 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1259 } /* namespace internal */
1261 template <typename LibObjT>
1262 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1265 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1266 using _FieldClass = internal::DepFc<LibObjT>;
1269 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1272 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1273 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1275 explicit CommonArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1276 _ThisCommonFieldClass {libObjPtr}
1278 BT_ASSERT_DBG(this->isArray());
1281 template <typename OtherLibObjT>
1282 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1283 _ThisCommonFieldClass {fc}
1287 template <typename OtherLibObjT>
1288 CommonArrayFieldClass operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1290 _ThisCommonFieldClass::operator=(fc);
1294 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1296 return CommonArrayFieldClass<const bt_field_class> {*this};
1299 _FieldClass elementFieldClass() const noexcept
1301 return _FieldClass {
1302 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1305 Shared shared() const noexcept
1307 return Shared::createWithRef(*this);
1311 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1312 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1314 namespace internal {
1316 struct ArrayFieldClassTypeDescr
1318 using Const = ConstArrayFieldClass;
1319 using NonConst = ArrayFieldClass;
1323 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1328 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1332 } /* namespace internal */
1334 template <typename LibObjT>
1335 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1338 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1341 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1342 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1344 explicit CommonStaticArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1345 _ThisCommonArrayFieldClass {libObjPtr}
1347 BT_ASSERT_DBG(this->isStaticArray());
1350 template <typename OtherLibObjT>
1351 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1352 _ThisCommonArrayFieldClass {fc}
1356 template <typename OtherLibObjT>
1357 CommonStaticArrayFieldClass
1358 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1360 _ThisCommonArrayFieldClass::operator=(fc);
1364 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1366 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1369 std::uint64_t length() const noexcept
1371 return bt_field_class_array_static_get_length(this->libObjPtr());
1374 Shared shared() const noexcept
1376 return Shared::createWithRef(*this);
1380 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1381 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1383 namespace internal {
1385 struct StaticArrayFieldClassTypeDescr
1387 using Const = ConstStaticArrayFieldClass;
1388 using NonConst = StaticArrayFieldClass;
1392 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1397 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1401 } /* namespace internal */
1403 template <typename LibObjT>
1404 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1407 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1410 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1411 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1413 explicit CommonDynamicArrayWithLengthFieldClass(const LibObjPtr libObjPtr) noexcept :
1414 _ThisCommonArrayFieldClass {libObjPtr}
1416 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1419 template <typename OtherLibObjT>
1420 CommonDynamicArrayWithLengthFieldClass(
1421 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1422 _ThisCommonArrayFieldClass {fc}
1426 template <typename OtherLibObjT>
1427 CommonDynamicArrayWithLengthFieldClass
1428 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1430 _ThisCommonArrayFieldClass::operator=(fc);
1434 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1436 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1439 ConstFieldPath lengthFieldPath() const noexcept
1441 return ConstFieldPath {
1442 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1443 this->libObjPtr())};
1446 Shared shared() const noexcept
1448 return Shared::createWithRef(*this);
1452 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1454 using ConstDynamicArrayWithLengthFieldClass =
1455 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1457 namespace internal {
1459 struct DynamicArrayWithLengthFieldClassTypeDescr
1461 using Const = ConstDynamicArrayWithLengthFieldClass;
1462 using NonConst = DynamicArrayWithLengthFieldClass;
1466 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1467 public DynamicArrayWithLengthFieldClassTypeDescr
1472 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1473 public DynamicArrayWithLengthFieldClassTypeDescr
1477 template <typename LibObjT>
1478 struct CommonOptionFieldClassSpec;
1480 /* Functions specific to mutable option field classes */
1482 struct CommonOptionFieldClassSpec<bt_field_class> final
1484 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1486 return bt_field_class_option_borrow_field_class(libObjPtr);
1490 /* Functions specific to constant option field classes */
1492 struct CommonOptionFieldClassSpec<const bt_field_class> final
1494 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1496 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1500 } /* namespace internal */
1502 template <typename LibObjT>
1503 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1506 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1507 using _FieldClass = internal::DepFc<LibObjT>;
1510 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1513 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1514 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1516 explicit CommonOptionFieldClass(const LibObjPtr libObjPtr) noexcept :
1517 _ThisCommonFieldClass {libObjPtr}
1519 BT_ASSERT_DBG(this->isOption());
1522 template <typename OtherLibObjT>
1523 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1524 _ThisCommonFieldClass {fc}
1528 template <typename OtherLibObjT>
1529 CommonOptionFieldClass operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1531 _ThisCommonFieldClass::operator=(fc);
1535 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1537 return CommonOptionFieldClass<const bt_field_class> {*this};
1540 _FieldClass fieldClass() const noexcept
1542 return _FieldClass {
1543 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1546 Shared shared() const noexcept
1548 return Shared::createWithRef(*this);
1552 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1553 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1555 namespace internal {
1557 struct OptionFieldClassTypeDescr
1559 using Const = ConstOptionFieldClass;
1560 using NonConst = OptionFieldClass;
1564 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1569 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1573 } /* namespace internal */
1575 template <typename LibObjT>
1576 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1579 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1582 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1585 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1586 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1588 explicit CommonOptionWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1589 _ThisCommonOptionFieldClass {libObjPtr}
1591 BT_ASSERT_DBG(this->isOptionWithSelector());
1594 template <typename OtherLibObjT>
1595 CommonOptionWithSelectorFieldClass(
1596 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1597 _ThisCommonOptionFieldClass {fc}
1601 template <typename OtherLibObjT>
1602 CommonOptionWithSelectorFieldClass
1603 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1605 _ThisCommonOptionFieldClass::operator=(fc);
1609 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1611 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1614 ConstFieldPath selectorFieldPath() const noexcept
1616 return ConstFieldPath {
1617 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1618 this->libObjPtr())};
1621 Shared shared() const noexcept
1623 return Shared::createWithRef(*this);
1627 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1628 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1630 namespace internal {
1632 struct OptionWithSelectorFieldClassTypeDescr
1634 using Const = ConstOptionWithSelectorFieldClass;
1635 using NonConst = OptionWithSelectorFieldClass;
1639 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1644 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1648 } /* namespace internal */
1650 template <typename LibObjT>
1651 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1654 using typename CommonOptionWithSelectorFieldClass<
1655 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1658 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1659 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1661 explicit CommonOptionWithBoolSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1662 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1664 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1667 template <typename OtherLibObjT>
1668 CommonOptionWithBoolSelectorFieldClass(
1669 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1670 _ThisCommonOptionWithSelectorFieldClass {fc}
1674 template <typename OtherLibObjT>
1675 CommonOptionWithBoolSelectorFieldClass
1676 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1678 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1682 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1684 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1687 bool selectorIsReversed() const noexcept
1689 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1693 Shared shared() const noexcept
1695 return Shared::createWithRef(*this);
1699 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1701 using ConstOptionWithBoolSelectorFieldClass =
1702 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1704 namespace internal {
1706 struct OptionWithBoolSelectorFieldClassTypeDescr
1708 using Const = ConstOptionWithBoolSelectorFieldClass;
1709 using NonConst = OptionWithBoolSelectorFieldClass;
1713 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1714 public OptionWithBoolSelectorFieldClassTypeDescr
1719 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1720 public OptionWithBoolSelectorFieldClassTypeDescr
1724 template <typename RangeSetT>
1725 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1727 /* Functions specific to option field classes with unsigned integer ranges */
1729 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1731 static const bt_integer_range_set_unsigned *
1732 ranges(const bt_field_class * const libObjPtr) noexcept
1734 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1739 /* Functions specific to option field classes with signed ranges */
1741 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1743 static const bt_integer_range_set_signed *
1744 ranges(const bt_field_class * const libObjPtr) noexcept
1746 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1751 } /* namespace internal */
1753 template <typename LibObjT, typename RangeSetT>
1754 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1757 using typename CommonOptionWithSelectorFieldClass<
1758 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1761 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1762 using Shared = SharedFieldClass<CommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1763 using RangeSet = RangeSetT;
1765 explicit CommonOptionWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1766 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1768 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1771 template <typename OtherLibObjT>
1772 CommonOptionWithIntegerSelectorFieldClass(
1773 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1774 _ThisCommonOptionWithSelectorFieldClass {fc}
1778 template <typename OtherLibObjT>
1779 CommonOptionWithIntegerSelectorFieldClass
1780 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1782 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1786 RangeSet ranges() const noexcept
1788 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1789 this->libObjPtr())};
1792 Shared shared() const noexcept
1794 return Shared::createWithRef(*this);
1798 using OptionWithUnsignedIntegerSelectorFieldClass =
1799 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1801 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1802 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1804 using OptionWithSignedIntegerSelectorFieldClass =
1805 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1807 using ConstOptionWithSignedIntegerSelectorFieldClass =
1808 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1810 namespace internal {
1812 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1814 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1815 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1819 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1820 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1825 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1826 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1830 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1832 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1833 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1837 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1838 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1843 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1844 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1848 template <typename LibObjT>
1849 struct CommonVariantFieldClassOptionSpec;
1851 /* Functions specific to mutable variant field class options */
1853 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1855 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1857 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1860 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1862 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1866 /* Functions specific to constant variant field class options */
1868 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1870 static const bt_field_class *
1871 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1873 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1876 static const bt_value *
1877 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1879 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1883 } /* namespace internal */
1885 template <typename LibObjT>
1886 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1889 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1890 using _FieldClass = internal::DepFc<LibObjT>;
1893 using typename BorrowedObject<LibObjT>::LibObjPtr;
1894 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1896 explicit CommonVariantFieldClassOption(const LibObjPtr libObjPtr) noexcept :
1897 _ThisBorrowedObject {libObjPtr}
1901 template <typename OtherLibObjT>
1902 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1903 _ThisBorrowedObject {fc}
1907 template <typename OtherLibObjT>
1908 CommonVariantFieldClassOption
1909 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1911 _ThisBorrowedObject::operator=(fc);
1915 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1917 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1920 const char *name() const noexcept
1922 return bt_field_class_variant_option_get_name(this->libObjPtr());
1925 _FieldClass fieldClass() const noexcept
1927 return _FieldClass {
1928 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1931 template <typename LibValT>
1932 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1934 static_assert(!std::is_const<LibObjT>::value,
1935 "Not available with `bt2::ConstVariantFieldClassOption`.");
1937 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1940 UserAttributes userAttributes() const noexcept
1942 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1943 this->libObjPtr())};
1947 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1949 using ConstVariantFieldClassOption =
1950 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1952 namespace internal {
1954 struct VariantFieldClassOptionTypeDescr
1956 using Const = ConstVariantFieldClassOption;
1957 using NonConst = VariantFieldClassOption;
1961 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1966 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1970 template <typename LibObjT>
1971 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1973 /* Functions specific to variant field class options with unsigned integer selector */
1975 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1976 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1979 static const bt_integer_range_set_unsigned *
1980 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1981 * const libObjPtr) noexcept
1983 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1987 static const bt_field_class_variant_option *
1988 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1989 * const libObjPtr) noexcept
1991 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1996 /* Functions specific to variant field class options with signed integer selector */
1998 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1999 const bt_field_class_variant_with_selector_field_integer_signed_option>
2002 static const bt_integer_range_set_signed *
2003 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
2004 * const libObjPtr) noexcept
2006 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
2010 static const bt_field_class_variant_option *
2011 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
2012 * const libObjPtr) noexcept
2014 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2019 } /* namespace internal */
2021 template <typename LibObjT>
2022 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2025 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2026 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2029 using typename BorrowedObject<LibObjT>::LibObjPtr;
2031 using RangeSet = typename std::conditional<
2034 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2035 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2037 explicit ConstVariantWithIntegerSelectorFieldClassOption(const LibObjPtr libObjPtr) noexcept :
2038 _ThisBorrowedObject {libObjPtr}
2042 template <typename OtherLibObjT>
2043 ConstVariantWithIntegerSelectorFieldClassOption(
2044 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2045 _ThisBorrowedObject {fc}
2049 template <typename OtherLibObjT>
2050 ConstVariantWithIntegerSelectorFieldClassOption
2051 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2053 _ThisBorrowedObject::operator=(fc);
2057 ConstVariantFieldClassOption asBaseOption() const noexcept
2059 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2062 const char *name() const noexcept
2064 return this->asBaseOption().name();
2067 ConstFieldClass fieldClass() const noexcept
2069 return this->asBaseOption().fieldClass();
2072 RangeSet ranges() const noexcept
2074 return RangeSet {_Spec::ranges(this->libObjPtr())};
2078 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2079 ConstVariantWithIntegerSelectorFieldClassOption<
2080 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2082 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2083 ConstVariantWithIntegerSelectorFieldClassOption<
2084 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2086 namespace internal {
2088 template <typename LibObjT>
2089 struct CommonVariantFieldClassSpec;
2091 /* Functions specific to mutable variant field classes */
2093 struct CommonVariantFieldClassSpec<bt_field_class> final
2095 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2096 const std::uint64_t index) noexcept
2098 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2101 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2102 const char * const name) noexcept
2104 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2108 /* Functions specific to constant variant field classes */
2110 struct CommonVariantFieldClassSpec<const bt_field_class> final
2112 static const bt_field_class_variant_option *
2113 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2115 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2118 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2119 const char * const name) noexcept
2121 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2125 } /* namespace internal */
2127 template <typename LibObjT>
2128 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2131 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2134 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2137 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2138 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2139 using Iterator = BorrowedObjectIterator<CommonVariantFieldClass>;
2142 internal::DepType<LibObjT, VariantFieldClassOption, ConstVariantFieldClassOption>;
2144 explicit CommonVariantFieldClass(const LibObjPtr libObjPtr) noexcept :
2145 _ThisCommonFieldClass {libObjPtr}
2147 BT_ASSERT_DBG(this->isVariant());
2150 template <typename OtherLibObjT>
2151 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2152 _ThisCommonFieldClass {fc}
2156 template <typename OtherLibObjT>
2157 CommonVariantFieldClass operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2159 _ThisCommonFieldClass::operator=(fc);
2163 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2165 return CommonVariantFieldClass<const bt_field_class> {*this};
2168 std::uint64_t length() const noexcept
2170 return bt_field_class_variant_get_option_count(this->libObjPtr());
2173 Iterator begin() const noexcept
2175 return Iterator {*this, 0};
2178 Iterator end() const noexcept
2180 return Iterator {*this, this->length()};
2183 Option operator[](const std::uint64_t index) const noexcept
2185 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2186 this->libObjPtr(), index)};
2189 bt2s::optional<Option> operator[](const char * const name) const noexcept
2191 const auto libObjPtr =
2192 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
2195 return Option {libObjPtr};
2198 return bt2s::nullopt;
2201 bt2s::optional<Option> operator[](const std::string& name) const noexcept
2203 return (*this)[name.data()];
2206 Shared shared() const noexcept
2208 return Shared::createWithRef(*this);
2212 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2213 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2215 namespace internal {
2217 struct VariantFieldClassTypeDescr
2219 using Const = ConstVariantFieldClass;
2220 using NonConst = VariantFieldClass;
2224 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2229 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2233 } /* namespace internal */
2235 template <typename LibObjT>
2236 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2239 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2242 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2243 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2245 explicit CommonVariantWithoutSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2246 _ThisCommonVariantFieldClass {libObjPtr}
2248 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2251 template <typename OtherLibObjT>
2252 CommonVariantWithoutSelectorFieldClass(
2253 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2254 _ThisCommonVariantFieldClass {fc}
2258 template <typename OtherLibObjT>
2259 CommonVariantWithoutSelectorFieldClass
2260 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2262 _ThisCommonVariantFieldClass::operator=(fc);
2266 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2268 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2271 void appendOption(const char * const name, const FieldClass fc) const
2273 static_assert(!std::is_const<LibObjT>::value,
2274 "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");
2276 const auto status = bt_field_class_variant_without_selector_append_option(
2277 this->libObjPtr(), name, fc.libObjPtr());
2280 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2281 throw MemoryError {};
2285 void appendOption(const bt2s::optional<std::string>& name, const FieldClass fc) const
2287 this->appendOption(name ? name->data() : nullptr, fc);
2290 Shared shared() const noexcept
2292 return Shared::createWithRef(*this);
2296 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2297 using ConstVariantWithoutSelectorFieldClass =
2298 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2300 namespace internal {
2302 struct VariantWithoutSelectorFieldClassTypeDescr
2304 using Const = ConstVariantWithoutSelectorFieldClass;
2305 using NonConst = VariantWithoutSelectorFieldClass;
2309 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2310 public VariantWithoutSelectorFieldClassTypeDescr
2315 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2316 public VariantWithoutSelectorFieldClassTypeDescr
2320 template <typename OptionT>
2321 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2323 /* Functions specific to variant field classes with unsigned integer selector */
2325 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2326 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2329 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2330 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2332 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2336 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2337 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2339 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2343 static bt_field_class_variant_with_selector_field_integer_append_option_status
2344 appendOption(bt_field_class * const libObjPtr, const char * const name,
2345 bt_field_class * const libOptFcPtr,
2346 const bt_integer_range_set_unsigned * const libRangesPtr)
2348 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2349 libObjPtr, name, libOptFcPtr, libRangesPtr);
2353 /* Functions specific to variant field classes with signed integer selector */
2355 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2356 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2359 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2360 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2362 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2366 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2367 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2369 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2373 static bt_field_class_variant_with_selector_field_integer_append_option_status
2374 appendOption(bt_field_class * const libObjPtr, const char * const name,
2375 bt_field_class * const libOptFcPtr,
2376 const bt_integer_range_set_signed * const libRangesPtr)
2378 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2379 libObjPtr, name, libOptFcPtr, libRangesPtr);
2383 } /* namespace internal */
2385 template <typename LibObjT>
2386 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2389 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2392 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2395 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2396 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2398 explicit CommonVariantWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2399 _ThisCommonVariantFieldClass {libObjPtr}
2401 BT_ASSERT_DBG(this->isVariantWithSelector());
2404 template <typename OtherLibObjT>
2405 CommonVariantWithSelectorFieldClass(
2406 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2407 _ThisCommonVariantFieldClass {fc}
2411 template <typename OtherLibObjT>
2412 CommonVariantWithSelectorFieldClass
2413 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2415 _ThisCommonVariantFieldClass::operator=(fc);
2419 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2421 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2424 ConstFieldPath selectorFieldPath() const noexcept
2426 return ConstFieldPath {
2427 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2428 this->libObjPtr())};
2431 Shared shared() const noexcept
2433 return Shared::createWithRef(*this);
2437 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2438 using ConstVariantWithSelectorFieldClass =
2439 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2441 template <typename LibObjT, typename OptionT>
2442 class CommonVariantWithIntegerSelectorFieldClass :
2443 public CommonVariantWithSelectorFieldClass<LibObjT>
2446 using typename CommonVariantWithSelectorFieldClass<
2447 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2449 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2452 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2453 using Shared = SharedFieldClass<CommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2454 using Option = OptionT;
2457 BorrowedObjectIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>>;
2459 explicit CommonVariantWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2460 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2462 BT_ASSERT_DBG(this->isVariant());
2465 template <typename OtherLibObjT>
2466 CommonVariantWithIntegerSelectorFieldClass(
2467 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2468 _ThisCommonVariantWithSelectorFieldClass {fc}
2472 template <typename OtherLibObjT>
2473 CommonVariantWithIntegerSelectorFieldClass
2474 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2476 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2480 Option operator[](const std::uint64_t index) const noexcept
2482 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2485 bt2s::optional<Option> operator[](const char * const name) const noexcept
2487 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2490 return Option {libObjPtr};
2493 return bt2s::nullopt;
2496 bt2s::optional<Option> operator[](const std::string& name) const noexcept
2498 return (*this)[name.data()];
2501 void appendOption(const char * const name, const FieldClass fc,
2502 const typename Option::RangeSet ranges) const
2505 !std::is_const<LibObjT>::value,
2506 "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");
2509 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2512 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2513 throw MemoryError {};
2517 void appendOption(const bt2s::optional<std::string>& name, const FieldClass fc,
2518 const typename Option::RangeSet ranges) const
2520 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2523 Iterator begin() const noexcept
2525 return Iterator {*this, 0};
2528 Iterator end() const noexcept
2530 return Iterator {*this, this->length()};
2533 Shared shared() const noexcept
2535 return Shared::createWithRef(*this);
2539 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2540 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2542 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2543 CommonVariantWithIntegerSelectorFieldClass<
2544 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2546 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2547 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2549 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2550 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2552 namespace internal {
2554 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2556 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2557 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2561 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2562 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2567 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2568 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2572 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2574 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2575 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2579 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2580 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2585 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2586 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2590 } /* namespace internal */
2592 template <typename LibObjT>
2593 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2595 BT_ASSERT_DBG(this->isBitArray());
2596 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2599 template <typename LibObjT>
2600 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2602 BT_ASSERT_DBG(this->isInteger());
2603 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2606 template <typename LibObjT>
2607 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2609 BT_ASSERT_DBG(this->isEnumeration());
2610 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2613 template <typename LibObjT>
2614 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2615 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2617 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2618 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2622 template <typename LibObjT>
2623 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2624 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2626 BT_ASSERT_DBG(this->isSignedEnumeration());
2627 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2631 template <typename LibObjT>
2632 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2634 BT_ASSERT_DBG(this->isStructure());
2635 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2638 template <typename LibObjT>
2639 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2641 BT_ASSERT_DBG(this->isArray());
2642 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2645 template <typename LibObjT>
2646 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2648 BT_ASSERT_DBG(this->isStaticArray());
2649 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2652 template <typename LibObjT>
2653 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2654 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2656 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2657 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2660 template <typename LibObjT>
2661 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2663 BT_ASSERT_DBG(this->isOption());
2664 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2667 template <typename LibObjT>
2668 CommonOptionWithSelectorFieldClass<LibObjT>
2669 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2671 BT_ASSERT_DBG(this->isOptionWithSelector());
2672 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2675 template <typename LibObjT>
2676 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2677 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2679 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2680 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2683 template <typename LibObjT>
2684 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2685 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2687 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2688 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2692 template <typename LibObjT>
2693 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2694 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2696 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2697 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2701 template <typename LibObjT>
2702 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2704 BT_ASSERT_DBG(this->isVariant());
2705 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2708 template <typename LibObjT>
2709 CommonVariantWithoutSelectorFieldClass<LibObjT>
2710 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2712 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2713 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2716 template <typename LibObjT>
2717 CommonVariantWithSelectorFieldClass<LibObjT>
2718 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2720 BT_ASSERT_DBG(this->isVariantWithSelector());
2721 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2724 template <typename LibObjT>
2725 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2726 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2727 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2729 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2730 return CommonVariantWithIntegerSelectorFieldClass<
2731 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2734 template <typename LibObjT>
2735 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2736 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2737 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2739 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2740 return CommonVariantWithIntegerSelectorFieldClass<
2741 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2744 } /* namespace bt2 */
2746 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */