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/bt2c/c-string-view.hpp"
17 #include "cpp-common/bt2s/optional.hpp"
19 #include "borrowed-object-iterator.hpp"
20 #include "borrowed-object.hpp"
22 #include "field-path.hpp"
23 #include "integer-range-set.hpp"
24 #include "internal/utils.hpp"
25 #include "optional-borrowed-object.hpp"
26 #include "shared-object.hpp"
32 struct FieldClassRefFuncs final
34 static void get(const bt_field_class * const libObjPtr) noexcept
36 bt_field_class_get_ref(libObjPtr);
39 static void put(const bt_field_class * const libObjPtr) noexcept
41 bt_field_class_put_ref(libObjPtr);
45 template <typename LibObjT>
46 struct CommonFieldClassSpec;
48 /* Functions specific to mutable field classes */
50 struct CommonFieldClassSpec<bt_field_class> final
52 static bt_value *userAttributes(bt_field_class * const libObjPtr) noexcept
54 return bt_field_class_borrow_user_attributes(libObjPtr);
58 /* Functions specific to constant field classes */
60 struct CommonFieldClassSpec<const bt_field_class> final
62 static const bt_value *userAttributes(const bt_field_class * const libObjPtr) noexcept
64 return bt_field_class_borrow_user_attributes_const(libObjPtr);
68 } /* namespace internal */
70 template <typename ObjT, typename LibObjT>
71 using SharedFieldClass = SharedObject<ObjT, LibObjT, internal::FieldClassRefFuncs>;
73 template <typename LibObjT>
74 class CommonBitArrayFieldClass;
76 template <typename LibObjT>
77 class CommonIntegerFieldClass;
79 template <typename LibObjT>
80 class ConstEnumerationFieldClassMapping;
82 template <typename LibObjT>
83 class CommonBaseEnumerationFieldClass;
85 template <typename LibObjT, typename MappingT>
86 class CommonEnumerationFieldClass;
88 template <typename LibObjT>
89 class CommonStructureFieldClass;
91 template <typename LibObjT>
92 class CommonArrayFieldClass;
94 template <typename LibObjT>
95 class CommonStaticArrayFieldClass;
97 template <typename LibObjT>
98 class CommonDynamicArrayWithLengthFieldClass;
100 template <typename LibObjT>
101 class CommonOptionFieldClass;
103 template <typename LibObjT>
104 class CommonOptionWithSelectorFieldClass;
106 template <typename LibObjT>
107 class CommonOptionWithBoolSelectorFieldClass;
109 template <typename LibObjT>
110 class CommonVariantFieldClass;
112 template <typename LibObjT, typename RangeSetT>
113 class CommonOptionWithIntegerSelectorFieldClass;
115 template <typename LibObjT>
116 class CommonVariantWithoutSelectorFieldClass;
118 template <typename LibObjT>
119 class CommonVariantWithSelectorFieldClass;
121 template <typename LibObjT>
122 class ConstVariantWithIntegerSelectorFieldClassOption;
124 template <typename LibObjT, typename RangeSetT>
125 class CommonVariantWithIntegerSelectorFieldClass;
127 template <typename LibObjT>
128 class CommonEventClass;
130 template <typename LibObjT>
131 class CommonStreamClass;
133 template <typename LibObjT>
134 class CommonTraceClass;
136 enum class FieldClassType
138 BOOL = BT_FIELD_CLASS_TYPE_BOOL,
139 BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
140 UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
141 SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
142 UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
143 SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
144 SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
145 DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
146 STRING = BT_FIELD_CLASS_TYPE_STRING,
147 STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
148 STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
149 DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
150 DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
151 OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
152 OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
153 OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
154 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
155 OPTION_WITH_SIGNED_INTEGER_SELECTOR =
156 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
157 VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
158 VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
159 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
160 VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
161 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
164 template <typename LibObjT>
165 class CommonFieldClass : public BorrowedObject<LibObjT>
168 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
171 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
174 using typename BorrowedObject<LibObjT>::LibObjPtr;
175 using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
176 using UserAttributes = internal::DepUserAttrs<LibObjT>;
178 explicit CommonFieldClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
182 template <typename OtherLibObjT>
183 CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
187 template <typename OtherLibObjT>
188 CommonFieldClass operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
190 _ThisBorrowedObject::operator=(fc);
194 CommonFieldClass<const bt_field_class> asConst() const noexcept
196 return CommonFieldClass<const bt_field_class> {*this};
199 FieldClassType type() const noexcept
201 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
204 bool isBool() const noexcept
206 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
209 bool isBitArray() const noexcept
211 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
214 bool isInteger() const noexcept
216 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
219 bool isUnsignedInteger() const noexcept
221 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
224 bool isSignedInteger() const noexcept
226 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
229 bool isEnumeration() const noexcept
231 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
234 bool isUnsignedEnumeration() const noexcept
236 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
239 bool isSignedEnumeration() const noexcept
241 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
244 bool isReal() const noexcept
246 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
249 bool isSinglePrecisionReal() const noexcept
251 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
254 bool isDoublePrecisionReal() const noexcept
256 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
259 bool isString() const noexcept
261 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
264 bool isStructure() const noexcept
266 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
269 bool isArray() const noexcept
271 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
274 bool isStaticArray() const noexcept
276 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
279 bool isDynamicArray() const noexcept
281 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
284 bool isDynamicArrayWithoutLength() const noexcept
286 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
289 bool isDynamicArrayWithLength() const noexcept
291 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
294 bool isOption() const noexcept
296 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
299 bool isOptionWithoutSelector() const noexcept
301 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
304 bool isOptionWithSelector() const noexcept
306 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
309 bool isOptionWithBoolSelector() const noexcept
311 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
314 bool isOptionWithIntegerSelector() const noexcept
316 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
319 bool isOptionWithUnsignedIntegerSelector() const noexcept
321 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
324 bool isOptionWithSignedIntegerSelector() const noexcept
326 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
329 bool isVariant() const noexcept
331 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
334 bool isVariantWithoutSelector() const noexcept
336 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
339 bool isVariantWithSelector() const noexcept
341 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
344 bool isVariantWithIntegerSelector() const noexcept
346 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
349 bool isVariantWithUnsignedIntegerSelector() const noexcept
351 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
354 bool isVariantWithSignedIntegerSelector() const noexcept
356 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
359 template <typename FieldClassT>
360 FieldClassT as() const noexcept
362 return FieldClassT {this->libObjPtr()};
365 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
366 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
367 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
368 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
369 const bt_field_class_enumeration_unsigned_mapping>>
370 asUnsignedEnumeration() const noexcept;
372 CommonEnumerationFieldClass<
373 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
374 asSignedEnumeration() const noexcept;
376 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
377 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
378 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
379 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
380 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
381 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
382 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
384 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
385 asOptionWithUnsignedIntegerSelector() const noexcept;
387 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
388 asOptionWithSignedIntegerSelector() const noexcept;
390 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
391 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
392 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
394 CommonVariantWithIntegerSelectorFieldClass<
395 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
396 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
397 asVariantWithUnsignedIntegerSelector() const noexcept;
399 CommonVariantWithIntegerSelectorFieldClass<
400 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
401 const bt_field_class_variant_with_selector_field_integer_signed_option>>
402 asVariantWithSignedIntegerSelector() const noexcept;
404 template <typename LibValT>
405 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
407 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstFieldClass`.");
409 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
412 UserAttributes userAttributes() const noexcept
414 return UserAttributes {
415 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
418 Shared shared() const noexcept
420 return Shared::createWithRef(*this);
424 bool _libTypeIs(const bt_field_class_type type) const noexcept
426 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
430 using FieldClass = CommonFieldClass<bt_field_class>;
431 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
435 struct FieldClassTypeDescr
437 using Const = ConstFieldClass;
438 using NonConst = FieldClass;
442 struct TypeDescr<FieldClass> : public FieldClassTypeDescr
447 struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
451 } /* namespace internal */
453 template <typename LibObjT>
454 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
457 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
460 using typename CommonFieldClass<LibObjT>::LibObjPtr;
461 using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
463 explicit CommonBitArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
464 _ThisCommonFieldClass {libObjPtr}
466 BT_ASSERT_DBG(this->isBitArray());
469 template <typename OtherLibObjT>
470 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
471 _ThisCommonFieldClass {fc}
475 template <typename OtherLibObjT>
476 CommonBitArrayFieldClass<LibObjT>
477 operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
479 _ThisCommonFieldClass::operator=(fc);
483 CommonBitArrayFieldClass<const bt_field_class> asConst() const noexcept
485 return CommonBitArrayFieldClass<const bt_field_class> {*this};
488 std::uint64_t length() const noexcept
490 return bt_field_class_bit_array_get_length(this->libObjPtr());
493 Shared shared() const noexcept
495 return Shared::createWithRef(*this);
499 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
500 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
504 struct BitArrayFieldClassTypeDescr
506 using Const = ConstBitArrayFieldClass;
507 using NonConst = BitArrayFieldClass;
511 struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
516 struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
520 } /* namespace internal */
522 enum class DisplayBase
524 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
525 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
526 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
527 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
530 template <typename LibObjT>
531 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
534 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
537 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
540 using typename CommonFieldClass<LibObjT>::LibObjPtr;
541 using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
543 explicit CommonIntegerFieldClass(const LibObjPtr libObjPtr) noexcept :
544 _ThisCommonFieldClass {libObjPtr}
546 BT_ASSERT_DBG(this->isInteger());
549 template <typename OtherLibObjT>
550 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
551 _ThisCommonFieldClass {fc}
555 template <typename OtherLibObjT>
556 CommonIntegerFieldClass operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
558 _ThisCommonFieldClass::operator=(fc);
562 CommonIntegerFieldClass<const bt_field_class> asConst() const noexcept
564 return CommonIntegerFieldClass<const bt_field_class> {*this};
567 void fieldValueRange(const std::uint64_t n) const noexcept
569 static_assert(!std::is_const<LibObjT>::value,
570 "Not available with `bt2::ConstIntegerFieldClass`.");
572 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
575 std::uint64_t fieldValueRange() const noexcept
577 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
580 void preferredDisplayBase(const DisplayBase base) const noexcept
582 static_assert(!std::is_const<LibObjT>::value,
583 "Not available with `bt2::ConstIntegerFieldClass`.");
585 bt_field_class_integer_set_preferred_display_base(
586 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
589 DisplayBase preferredDisplayBase() const noexcept
591 return static_cast<DisplayBase>(
592 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
595 Shared shared() const noexcept
597 return Shared::createWithRef(*this);
601 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
602 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
606 struct IntegerFieldClassTypeDescr
608 using Const = ConstIntegerFieldClass;
609 using NonConst = IntegerFieldClass;
613 struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
618 struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
622 template <typename LibObjT>
623 struct ConstEnumerationFieldClassMappingSpec;
625 /* Functions specific to unsigned enumeration field class mappings */
627 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
630 static const bt_integer_range_set_unsigned *
631 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
633 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
637 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
639 return bt_field_class_enumeration_mapping_get_label(
640 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
644 /* Functions specific to signed enumeration field class mappings */
646 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
648 static const bt_integer_range_set_signed *
649 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
651 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
655 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
657 return bt_field_class_enumeration_mapping_get_label(
658 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
662 } /* namespace internal */
664 template <typename LibObjT>
665 class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
668 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
671 using typename BorrowedObject<LibObjT>::LibObjPtr;
673 using RangeSet = typename std::conditional<
674 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
675 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
677 explicit ConstEnumerationFieldClassMapping(const LibObjPtr libObjPtr) noexcept :
678 _ThisBorrowedObject {libObjPtr}
682 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
683 _ThisBorrowedObject {mapping}
687 ConstEnumerationFieldClassMapping
688 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
690 _ThisBorrowedObject::operator=(mapping);
694 RangeSet ranges() const noexcept
697 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
700 bt2c::CStringView label() const noexcept
702 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
706 using ConstUnsignedEnumerationFieldClassMapping =
707 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
709 using ConstSignedEnumerationFieldClassMapping =
710 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
714 template <typename MappingT>
715 struct CommonEnumerationFieldClassSpec;
717 /* Functions specific to unsigned enumeration field classes */
719 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
721 static const bt_field_class_enumeration_unsigned_mapping *
722 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
724 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
727 static const bt_field_class_enumeration_unsigned_mapping *
728 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
730 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
733 static bt_field_class_enumeration_add_mapping_status
734 addMapping(bt_field_class * const libObjPtr, const char * const label,
735 const bt_integer_range_set_unsigned * const libRanges) noexcept
737 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
741 /* Functions specific to signed enumeration field classes */
743 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
745 static const bt_field_class_enumeration_signed_mapping *
746 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
748 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
751 static const bt_field_class_enumeration_signed_mapping *
752 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
754 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
757 static bt_field_class_enumeration_add_mapping_status
758 addMapping(bt_field_class * const libObjPtr, const char * const label,
759 const bt_integer_range_set_signed * const libRanges) noexcept
761 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
765 } /* namespace internal */
767 template <typename LibObjT>
768 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
771 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
774 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
777 using typename CommonFieldClass<LibObjT>::LibObjPtr;
778 using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
780 explicit CommonBaseEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
781 _ThisCommonIntegerFieldClass {libObjPtr}
783 BT_ASSERT_DBG(this->isEnumeration());
786 template <typename OtherLibObjT>
787 CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
789 _ThisCommonIntegerFieldClass {fc}
793 template <typename OtherLibObjT>
794 CommonBaseEnumerationFieldClass
795 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
797 _ThisCommonIntegerFieldClass::operator=(fc);
801 CommonBaseEnumerationFieldClass<const bt_field_class> asConst() const noexcept
803 return CommonBaseEnumerationFieldClass<const bt_field_class> {*this};
806 std::uint64_t length() const noexcept
808 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
811 Shared shared() const noexcept
813 return Shared::createWithRef(*this);
817 template <typename LibObjT, typename MappingT>
818 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
821 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
824 using typename CommonFieldClass<LibObjT>::LibObjPtr;
825 using Shared = SharedFieldClass<CommonEnumerationFieldClass, LibObjT>;
826 using Iterator = BorrowedObjectIterator<CommonEnumerationFieldClass>;
827 using Mapping = MappingT;
829 explicit CommonEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
830 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
832 BT_ASSERT_DBG(this->isEnumeration());
835 template <typename OtherLibObjT>
836 CommonEnumerationFieldClass(
837 const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
838 CommonEnumerationFieldClass {fc}
842 template <typename OtherLibObjT>
843 CommonEnumerationFieldClass
844 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
846 CommonEnumerationFieldClass::operator=(fc);
850 Mapping operator[](const std::uint64_t index) const noexcept
852 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
853 this->libObjPtr(), index)};
856 OptionalBorrowedObject<Mapping> operator[](const char * const label) const noexcept
858 return internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
859 this->libObjPtr(), label);
862 OptionalBorrowedObject<Mapping> operator[](const std::string& label) const noexcept
864 return (*this)[label.data()];
867 void addMapping(const char * const label, const typename Mapping::RangeSet ranges) const
869 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
870 this->libObjPtr(), label, ranges.libObjPtr());
872 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
873 throw MemoryError {};
877 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges) const
879 this->addMapping(label.data(), ranges);
882 Iterator begin() const noexcept
884 return Iterator {*this, 0};
887 Iterator end() const noexcept
889 return Iterator {*this, this->length()};
892 Shared shared() const noexcept
894 return Shared::createWithRef(*this);
898 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
899 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
901 using UnsignedEnumerationFieldClass =
902 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
904 using ConstUnsignedEnumerationFieldClass =
905 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
907 using SignedEnumerationFieldClass =
908 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
910 using ConstSignedEnumerationFieldClass =
911 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
915 struct UnsignedEnumerationFieldClassTypeDescr
917 using Const = ConstUnsignedEnumerationFieldClass;
918 using NonConst = UnsignedEnumerationFieldClass;
922 struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
927 struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
931 struct SignedEnumerationFieldClassTypeDescr
933 using Const = ConstSignedEnumerationFieldClass;
934 using NonConst = SignedEnumerationFieldClass;
938 struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
943 struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
947 template <typename LibObjT>
948 struct CommonStructureFieldClassMemberSpec;
950 /* Functions specific to mutable structure field class members */
952 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
954 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
956 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
959 static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
961 return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
965 /* Functions specific to constant structure field class members */
967 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
969 static const bt_field_class *
970 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
972 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
975 static const bt_value *
976 userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
978 return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
982 } /* namespace internal */
984 template <typename LibObjT>
985 class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
988 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
989 using _FieldClass = internal::DepFc<LibObjT>;
992 using typename BorrowedObject<LibObjT>::LibObjPtr;
993 using UserAttributes = internal::DepUserAttrs<LibObjT>;
995 explicit CommonStructureFieldClassMember(const LibObjPtr libObjPtr) noexcept :
996 _ThisBorrowedObject {libObjPtr}
1000 template <typename OtherLibObjT>
1001 CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1003 _ThisBorrowedObject {fc}
1007 template <typename OtherLibObjT>
1008 CommonStructureFieldClassMember<LibObjT>
1009 operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
1011 _ThisBorrowedObject::operator=(fc);
1015 CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
1017 return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
1020 bt2c::CStringView name() const noexcept
1022 return bt_field_class_structure_member_get_name(this->libObjPtr());
1025 _FieldClass fieldClass() const noexcept
1027 return _FieldClass {
1028 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
1031 template <typename LibValT>
1032 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1034 static_assert(!std::is_const<LibObjT>::value,
1035 "Not available with `bt2::ConstStructureFieldClassMember`.");
1037 bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
1038 userAttrs.libObjPtr());
1041 UserAttributes userAttributes() const noexcept
1043 return UserAttributes {
1044 internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
1045 this->libObjPtr())};
1049 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1051 using ConstStructureFieldClassMember =
1052 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1054 namespace internal {
1056 struct StructureFieldClassMemberTypeDescr
1058 using Const = ConstStructureFieldClassMember;
1059 using NonConst = StructureFieldClassMember;
1063 struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1068 struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1072 template <typename LibObjT>
1073 struct CommonStructureFieldClassSpec;
1075 /* Functions specific to mutable structure field classes */
1077 struct CommonStructureFieldClassSpec<bt_field_class> final
1079 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1080 const std::uint64_t index) noexcept
1082 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1085 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1086 const char * const name) noexcept
1088 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1092 /* Functions specific to constant structure field classes */
1094 struct CommonStructureFieldClassSpec<const bt_field_class> final
1096 static const bt_field_class_structure_member *
1097 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1099 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1102 static const bt_field_class_structure_member *
1103 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1105 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1109 } /* namespace internal */
1111 template <typename LibObjT>
1112 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1115 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1118 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1119 using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
1120 using Iterator = BorrowedObjectIterator<CommonStructureFieldClass<LibObjT>>;
1123 internal::DepType<LibObjT, StructureFieldClassMember, ConstStructureFieldClassMember>;
1125 explicit CommonStructureFieldClass(const LibObjPtr libObjPtr) noexcept :
1126 _ThisCommonFieldClass {libObjPtr}
1128 BT_ASSERT_DBG(this->isStructure());
1131 template <typename OtherLibObjT>
1132 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
1133 _ThisCommonFieldClass {fc}
1137 template <typename OtherLibObjT>
1138 CommonStructureFieldClass operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
1140 _ThisCommonFieldClass::operator=(fc);
1144 CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
1146 return CommonStructureFieldClass<const bt_field_class> {*this};
1149 void appendMember(const char * const name, const FieldClass fc) const
1151 static_assert(!std::is_const<LibObjT>::value,
1152 "Not available with `bt2::ConstStructureFieldClass`.");
1155 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
1157 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1158 throw MemoryError {};
1162 void appendMember(const std::string& name, const FieldClass fc) const
1164 this->appendMember(name.data(), fc);
1167 std::uint64_t length() const noexcept
1169 return bt_field_class_structure_get_member_count(this->libObjPtr());
1172 Iterator begin() const noexcept
1174 return Iterator {*this, 0};
1177 Iterator end() const noexcept
1179 return Iterator {*this, this->length()};
1182 Member operator[](const std::uint64_t index) const noexcept
1184 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1185 this->libObjPtr(), index)};
1188 OptionalBorrowedObject<Member> operator[](const char * const name) const noexcept
1190 return internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(),
1194 OptionalBorrowedObject<Member> operator[](const std::string& name) const noexcept
1196 return (*this)[name.data()];
1199 Shared shared() const noexcept
1201 return Shared::createWithRef(*this);
1205 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1206 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1208 namespace internal {
1210 struct StructureFieldClassTypeDescr
1212 using Const = ConstStructureFieldClass;
1213 using NonConst = StructureFieldClass;
1217 struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1222 struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1226 template <typename LibObjT>
1227 struct CommonArrayFieldClassSpec;
1229 /* Functions specific to mutable array field classes */
1231 struct CommonArrayFieldClassSpec<bt_field_class> final
1233 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1235 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1239 /* Functions specific to constant array field classes */
1241 struct CommonArrayFieldClassSpec<const bt_field_class> final
1243 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1245 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1249 } /* namespace internal */
1251 template <typename LibObjT>
1252 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1255 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1256 using _FieldClass = internal::DepFc<LibObjT>;
1259 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1262 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1263 using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1265 explicit CommonArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1266 _ThisCommonFieldClass {libObjPtr}
1268 BT_ASSERT_DBG(this->isArray());
1271 template <typename OtherLibObjT>
1272 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
1273 _ThisCommonFieldClass {fc}
1277 template <typename OtherLibObjT>
1278 CommonArrayFieldClass operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
1280 _ThisCommonFieldClass::operator=(fc);
1284 CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
1286 return CommonArrayFieldClass<const bt_field_class> {*this};
1289 _FieldClass elementFieldClass() const noexcept
1291 return _FieldClass {
1292 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1295 Shared shared() const noexcept
1297 return Shared::createWithRef(*this);
1301 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1302 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1304 namespace internal {
1306 struct ArrayFieldClassTypeDescr
1308 using Const = ConstArrayFieldClass;
1309 using NonConst = ArrayFieldClass;
1313 struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1318 struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1322 } /* namespace internal */
1324 template <typename LibObjT>
1325 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1328 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1331 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1332 using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1334 explicit CommonStaticArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
1335 _ThisCommonArrayFieldClass {libObjPtr}
1337 BT_ASSERT_DBG(this->isStaticArray());
1340 template <typename OtherLibObjT>
1341 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
1342 _ThisCommonArrayFieldClass {fc}
1346 template <typename OtherLibObjT>
1347 CommonStaticArrayFieldClass
1348 operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
1350 _ThisCommonArrayFieldClass::operator=(fc);
1354 CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
1356 return CommonStaticArrayFieldClass<const bt_field_class> {*this};
1359 std::uint64_t length() const noexcept
1361 return bt_field_class_array_static_get_length(this->libObjPtr());
1364 Shared shared() const noexcept
1366 return Shared::createWithRef(*this);
1370 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1371 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1373 namespace internal {
1375 struct StaticArrayFieldClassTypeDescr
1377 using Const = ConstStaticArrayFieldClass;
1378 using NonConst = StaticArrayFieldClass;
1382 struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1387 struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1391 } /* namespace internal */
1393 template <typename LibObjT>
1394 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1397 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1400 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1401 using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1403 explicit CommonDynamicArrayWithLengthFieldClass(const LibObjPtr libObjPtr) noexcept :
1404 _ThisCommonArrayFieldClass {libObjPtr}
1406 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1409 template <typename OtherLibObjT>
1410 CommonDynamicArrayWithLengthFieldClass(
1411 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
1412 _ThisCommonArrayFieldClass {fc}
1416 template <typename OtherLibObjT>
1417 CommonDynamicArrayWithLengthFieldClass
1418 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
1420 _ThisCommonArrayFieldClass::operator=(fc);
1424 CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
1426 return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
1429 ConstFieldPath lengthFieldPath() const noexcept
1431 return ConstFieldPath {
1432 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1433 this->libObjPtr())};
1436 Shared shared() const noexcept
1438 return Shared::createWithRef(*this);
1442 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1444 using ConstDynamicArrayWithLengthFieldClass =
1445 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1447 namespace internal {
1449 struct DynamicArrayWithLengthFieldClassTypeDescr
1451 using Const = ConstDynamicArrayWithLengthFieldClass;
1452 using NonConst = DynamicArrayWithLengthFieldClass;
1456 struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1457 public DynamicArrayWithLengthFieldClassTypeDescr
1462 struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1463 public DynamicArrayWithLengthFieldClassTypeDescr
1467 template <typename LibObjT>
1468 struct CommonOptionFieldClassSpec;
1470 /* Functions specific to mutable option field classes */
1472 struct CommonOptionFieldClassSpec<bt_field_class> final
1474 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1476 return bt_field_class_option_borrow_field_class(libObjPtr);
1480 /* Functions specific to constant option field classes */
1482 struct CommonOptionFieldClassSpec<const bt_field_class> final
1484 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1486 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1490 } /* namespace internal */
1492 template <typename LibObjT>
1493 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1496 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1497 using _FieldClass = internal::DepFc<LibObjT>;
1500 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1503 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1504 using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1506 explicit CommonOptionFieldClass(const LibObjPtr libObjPtr) noexcept :
1507 _ThisCommonFieldClass {libObjPtr}
1509 BT_ASSERT_DBG(this->isOption());
1512 template <typename OtherLibObjT>
1513 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
1514 _ThisCommonFieldClass {fc}
1518 template <typename OtherLibObjT>
1519 CommonOptionFieldClass operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
1521 _ThisCommonFieldClass::operator=(fc);
1525 CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
1527 return CommonOptionFieldClass<const bt_field_class> {*this};
1530 _FieldClass fieldClass() const noexcept
1532 return _FieldClass {
1533 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1536 Shared shared() const noexcept
1538 return Shared::createWithRef(*this);
1542 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1543 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1545 namespace internal {
1547 struct OptionFieldClassTypeDescr
1549 using Const = ConstOptionFieldClass;
1550 using NonConst = OptionFieldClass;
1554 struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1559 struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1563 } /* namespace internal */
1565 template <typename LibObjT>
1566 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1569 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1572 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1575 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1576 using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1578 explicit CommonOptionWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1579 _ThisCommonOptionFieldClass {libObjPtr}
1581 BT_ASSERT_DBG(this->isOptionWithSelector());
1584 template <typename OtherLibObjT>
1585 CommonOptionWithSelectorFieldClass(
1586 const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
1587 _ThisCommonOptionFieldClass {fc}
1591 template <typename OtherLibObjT>
1592 CommonOptionWithSelectorFieldClass
1593 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
1595 _ThisCommonOptionFieldClass::operator=(fc);
1599 CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
1601 return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
1604 ConstFieldPath selectorFieldPath() const noexcept
1606 return ConstFieldPath {
1607 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1608 this->libObjPtr())};
1611 Shared shared() const noexcept
1613 return Shared::createWithRef(*this);
1617 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1618 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1620 namespace internal {
1622 struct OptionWithSelectorFieldClassTypeDescr
1624 using Const = ConstOptionWithSelectorFieldClass;
1625 using NonConst = OptionWithSelectorFieldClass;
1629 struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1634 struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1638 } /* namespace internal */
1640 template <typename LibObjT>
1641 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1644 using typename CommonOptionWithSelectorFieldClass<
1645 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1648 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1649 using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1651 explicit CommonOptionWithBoolSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1652 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1654 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1657 template <typename OtherLibObjT>
1658 CommonOptionWithBoolSelectorFieldClass(
1659 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
1660 _ThisCommonOptionWithSelectorFieldClass {fc}
1664 template <typename OtherLibObjT>
1665 CommonOptionWithBoolSelectorFieldClass
1666 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
1668 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1672 CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
1674 return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
1677 bool selectorIsReversed() const noexcept
1679 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1683 Shared shared() const noexcept
1685 return Shared::createWithRef(*this);
1689 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1691 using ConstOptionWithBoolSelectorFieldClass =
1692 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1694 namespace internal {
1696 struct OptionWithBoolSelectorFieldClassTypeDescr
1698 using Const = ConstOptionWithBoolSelectorFieldClass;
1699 using NonConst = OptionWithBoolSelectorFieldClass;
1703 struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1704 public OptionWithBoolSelectorFieldClassTypeDescr
1709 struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1710 public OptionWithBoolSelectorFieldClassTypeDescr
1714 template <typename RangeSetT>
1715 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1717 /* Functions specific to option field classes with unsigned integer ranges */
1719 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1721 static const bt_integer_range_set_unsigned *
1722 ranges(const bt_field_class * const libObjPtr) noexcept
1724 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1729 /* Functions specific to option field classes with signed ranges */
1731 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1733 static const bt_integer_range_set_signed *
1734 ranges(const bt_field_class * const libObjPtr) noexcept
1736 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1741 } /* namespace internal */
1743 template <typename LibObjT, typename RangeSetT>
1744 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1747 using typename CommonOptionWithSelectorFieldClass<
1748 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1751 using typename CommonFieldClass<LibObjT>::LibObjPtr;
1752 using Shared = SharedFieldClass<CommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1753 using RangeSet = RangeSetT;
1755 explicit CommonOptionWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
1756 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1758 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1761 template <typename OtherLibObjT>
1762 CommonOptionWithIntegerSelectorFieldClass(
1763 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
1764 _ThisCommonOptionWithSelectorFieldClass {fc}
1768 template <typename OtherLibObjT>
1769 CommonOptionWithIntegerSelectorFieldClass
1770 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
1772 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1776 RangeSet ranges() const noexcept
1778 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1779 this->libObjPtr())};
1782 Shared shared() const noexcept
1784 return Shared::createWithRef(*this);
1788 using OptionWithUnsignedIntegerSelectorFieldClass =
1789 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1791 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1792 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1794 using OptionWithSignedIntegerSelectorFieldClass =
1795 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1797 using ConstOptionWithSignedIntegerSelectorFieldClass =
1798 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1800 namespace internal {
1802 struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1804 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1805 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1809 struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1810 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1815 struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1816 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1820 struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1822 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1823 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1827 struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1828 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1833 struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1834 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1838 template <typename LibObjT>
1839 struct CommonVariantFieldClassOptionSpec;
1841 /* Functions specific to mutable variant field class options */
1843 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1845 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1847 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1850 static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
1852 return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
1856 /* Functions specific to constant variant field class options */
1858 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1860 static const bt_field_class *
1861 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1863 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1866 static const bt_value *
1867 userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
1869 return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
1873 } /* namespace internal */
1875 template <typename LibObjT>
1876 class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
1879 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
1880 using _FieldClass = internal::DepFc<LibObjT>;
1883 using typename BorrowedObject<LibObjT>::LibObjPtr;
1884 using UserAttributes = internal::DepUserAttrs<LibObjT>;
1886 explicit CommonVariantFieldClassOption(const LibObjPtr libObjPtr) noexcept :
1887 _ThisBorrowedObject {libObjPtr}
1891 template <typename OtherLibObjT>
1892 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
1893 _ThisBorrowedObject {fc}
1897 template <typename OtherLibObjT>
1898 CommonVariantFieldClassOption
1899 operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
1901 _ThisBorrowedObject::operator=(fc);
1905 CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
1907 return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
1910 bt2c::CStringView name() const noexcept
1912 return bt_field_class_variant_option_get_name(this->libObjPtr());
1915 _FieldClass fieldClass() const noexcept
1917 return _FieldClass {
1918 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1921 template <typename LibValT>
1922 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
1924 static_assert(!std::is_const<LibObjT>::value,
1925 "Not available with `bt2::ConstVariantFieldClassOption`.");
1927 bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
1930 UserAttributes userAttributes() const noexcept
1932 return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
1933 this->libObjPtr())};
1937 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1939 using ConstVariantFieldClassOption =
1940 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1942 namespace internal {
1944 struct VariantFieldClassOptionTypeDescr
1946 using Const = ConstVariantFieldClassOption;
1947 using NonConst = VariantFieldClassOption;
1951 struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1956 struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1960 template <typename LibObjT>
1961 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1963 /* Functions specific to variant field class options with unsigned integer selector */
1965 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1966 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1969 static const bt_integer_range_set_unsigned *
1970 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1971 * const libObjPtr) noexcept
1973 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1977 static const bt_field_class_variant_option *
1978 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1979 * const libObjPtr) noexcept
1981 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1986 /* Functions specific to variant field class options with signed integer selector */
1988 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1989 const bt_field_class_variant_with_selector_field_integer_signed_option>
1992 static const bt_integer_range_set_signed *
1993 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1994 * const libObjPtr) noexcept
1996 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
2000 static const bt_field_class_variant_option *
2001 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
2002 * const libObjPtr) noexcept
2004 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
2009 } /* namespace internal */
2011 template <typename LibObjT>
2012 class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
2015 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
2016 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2019 using typename BorrowedObject<LibObjT>::LibObjPtr;
2021 using RangeSet = typename std::conditional<
2024 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2025 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2027 explicit ConstVariantWithIntegerSelectorFieldClassOption(const LibObjPtr libObjPtr) noexcept :
2028 _ThisBorrowedObject {libObjPtr}
2032 template <typename OtherLibObjT>
2033 ConstVariantWithIntegerSelectorFieldClassOption(
2034 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
2035 _ThisBorrowedObject {fc}
2039 template <typename OtherLibObjT>
2040 ConstVariantWithIntegerSelectorFieldClassOption
2041 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
2043 _ThisBorrowedObject::operator=(fc);
2047 ConstVariantFieldClassOption asBaseOption() const noexcept
2049 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
2052 bt2c::CStringView name() const noexcept
2054 return this->asBaseOption().name();
2057 ConstFieldClass fieldClass() const noexcept
2059 return this->asBaseOption().fieldClass();
2062 RangeSet ranges() const noexcept
2064 return RangeSet {_Spec::ranges(this->libObjPtr())};
2068 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2069 ConstVariantWithIntegerSelectorFieldClassOption<
2070 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2072 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2073 ConstVariantWithIntegerSelectorFieldClassOption<
2074 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2076 namespace internal {
2078 template <typename LibObjT>
2079 struct CommonVariantFieldClassSpec;
2081 /* Functions specific to mutable variant field classes */
2083 struct CommonVariantFieldClassSpec<bt_field_class> final
2085 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2086 const std::uint64_t index) noexcept
2088 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2091 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2092 const char * const name) noexcept
2094 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2098 /* Functions specific to constant variant field classes */
2100 struct CommonVariantFieldClassSpec<const bt_field_class> final
2102 static const bt_field_class_variant_option *
2103 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2105 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2108 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2109 const char * const name) noexcept
2111 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2115 } /* namespace internal */
2117 template <typename LibObjT>
2118 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2121 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2124 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2127 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2128 using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2129 using Iterator = BorrowedObjectIterator<CommonVariantFieldClass>;
2132 internal::DepType<LibObjT, VariantFieldClassOption, ConstVariantFieldClassOption>;
2134 explicit CommonVariantFieldClass(const LibObjPtr libObjPtr) noexcept :
2135 _ThisCommonFieldClass {libObjPtr}
2137 BT_ASSERT_DBG(this->isVariant());
2140 template <typename OtherLibObjT>
2141 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
2142 _ThisCommonFieldClass {fc}
2146 template <typename OtherLibObjT>
2147 CommonVariantFieldClass operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
2149 _ThisCommonFieldClass::operator=(fc);
2153 CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
2155 return CommonVariantFieldClass<const bt_field_class> {*this};
2158 std::uint64_t length() const noexcept
2160 return bt_field_class_variant_get_option_count(this->libObjPtr());
2163 Iterator begin() const noexcept
2165 return Iterator {*this, 0};
2168 Iterator end() const noexcept
2170 return Iterator {*this, this->length()};
2173 Option operator[](const std::uint64_t index) const noexcept
2175 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
2176 this->libObjPtr(), index)};
2179 OptionalBorrowedObject<Option> operator[](const char * const name) const noexcept
2181 return internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(),
2185 OptionalBorrowedObject<Option> operator[](const std::string& name) const noexcept
2187 return (*this)[name.data()];
2190 Shared shared() const noexcept
2192 return Shared::createWithRef(*this);
2196 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2197 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2199 namespace internal {
2201 struct VariantFieldClassTypeDescr
2203 using Const = ConstVariantFieldClass;
2204 using NonConst = VariantFieldClass;
2208 struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2213 struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2217 } /* namespace internal */
2219 template <typename LibObjT>
2220 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2223 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2226 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2227 using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2229 explicit CommonVariantWithoutSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2230 _ThisCommonVariantFieldClass {libObjPtr}
2232 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2235 template <typename OtherLibObjT>
2236 CommonVariantWithoutSelectorFieldClass(
2237 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
2238 _ThisCommonVariantFieldClass {fc}
2242 template <typename OtherLibObjT>
2243 CommonVariantWithoutSelectorFieldClass
2244 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
2246 _ThisCommonVariantFieldClass::operator=(fc);
2250 CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
2252 return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
2255 void appendOption(const char * const name, const FieldClass fc) const
2257 static_assert(!std::is_const<LibObjT>::value,
2258 "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");
2260 const auto status = bt_field_class_variant_without_selector_append_option(
2261 this->libObjPtr(), name, fc.libObjPtr());
2264 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2265 throw MemoryError {};
2269 void appendOption(const bt2s::optional<std::string>& name, const FieldClass fc) const
2271 this->appendOption(name ? name->data() : nullptr, fc);
2274 Shared shared() const noexcept
2276 return Shared::createWithRef(*this);
2280 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2281 using ConstVariantWithoutSelectorFieldClass =
2282 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2284 namespace internal {
2286 struct VariantWithoutSelectorFieldClassTypeDescr
2288 using Const = ConstVariantWithoutSelectorFieldClass;
2289 using NonConst = VariantWithoutSelectorFieldClass;
2293 struct TypeDescr<VariantWithoutSelectorFieldClass> :
2294 public VariantWithoutSelectorFieldClassTypeDescr
2299 struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2300 public VariantWithoutSelectorFieldClassTypeDescr
2304 template <typename OptionT>
2305 struct CommonVariantWithIntegerSelectorFieldClassSpec;
2307 /* Functions specific to variant field classes with unsigned integer selector */
2309 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2310 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2313 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2314 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2316 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2320 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2321 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2323 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2327 static bt_field_class_variant_with_selector_field_integer_append_option_status
2328 appendOption(bt_field_class * const libObjPtr, const char * const name,
2329 bt_field_class * const libOptFcPtr,
2330 const bt_integer_range_set_unsigned * const libRangesPtr)
2332 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2333 libObjPtr, name, libOptFcPtr, libRangesPtr);
2337 /* Functions specific to variant field classes with signed integer selector */
2339 struct CommonVariantWithIntegerSelectorFieldClassSpec<
2340 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2343 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2344 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2346 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2350 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2351 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2353 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2357 static bt_field_class_variant_with_selector_field_integer_append_option_status
2358 appendOption(bt_field_class * const libObjPtr, const char * const name,
2359 bt_field_class * const libOptFcPtr,
2360 const bt_integer_range_set_signed * const libRangesPtr)
2362 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2363 libObjPtr, name, libOptFcPtr, libRangesPtr);
2367 } /* namespace internal */
2369 template <typename LibObjT>
2370 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2373 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2376 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2379 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2380 using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2382 explicit CommonVariantWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2383 _ThisCommonVariantFieldClass {libObjPtr}
2385 BT_ASSERT_DBG(this->isVariantWithSelector());
2388 template <typename OtherLibObjT>
2389 CommonVariantWithSelectorFieldClass(
2390 const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
2391 _ThisCommonVariantFieldClass {fc}
2395 template <typename OtherLibObjT>
2396 CommonVariantWithSelectorFieldClass
2397 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
2399 _ThisCommonVariantFieldClass::operator=(fc);
2403 CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
2405 return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
2408 ConstFieldPath selectorFieldPath() const noexcept
2410 return ConstFieldPath {
2411 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2412 this->libObjPtr())};
2415 Shared shared() const noexcept
2417 return Shared::createWithRef(*this);
2421 using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2422 using ConstVariantWithSelectorFieldClass =
2423 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2425 template <typename LibObjT, typename OptionT>
2426 class CommonVariantWithIntegerSelectorFieldClass :
2427 public CommonVariantWithSelectorFieldClass<LibObjT>
2430 using typename CommonVariantWithSelectorFieldClass<
2431 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2433 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2436 using typename CommonFieldClass<LibObjT>::LibObjPtr;
2437 using Shared = SharedFieldClass<CommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2438 using Option = OptionT;
2441 BorrowedObjectIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>>;
2443 explicit CommonVariantWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
2444 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2446 BT_ASSERT_DBG(this->isVariant());
2449 template <typename OtherLibObjT>
2450 CommonVariantWithIntegerSelectorFieldClass(
2451 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
2452 _ThisCommonVariantWithSelectorFieldClass {fc}
2456 template <typename OtherLibObjT>
2457 CommonVariantWithIntegerSelectorFieldClass
2458 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
2460 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2464 Option operator[](const std::uint64_t index) const noexcept
2466 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2469 OptionalBorrowedObject<Option> operator[](const char * const name) const noexcept
2471 return _Spec::optionByName(this->libObjPtr(), name);
2474 OptionalBorrowedObject<Option> operator[](const std::string& name) const noexcept
2476 return (*this)[name.data()];
2479 void appendOption(const char * const name, const FieldClass fc,
2480 const typename Option::RangeSet ranges) const
2483 !std::is_const<LibObjT>::value,
2484 "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");
2487 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2490 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2491 throw MemoryError {};
2495 void appendOption(const bt2s::optional<std::string>& name, const FieldClass fc,
2496 const typename Option::RangeSet ranges) const
2498 this->appendOption(name ? name->data() : nullptr, fc, ranges);
2501 Iterator begin() const noexcept
2503 return Iterator {*this, 0};
2506 Iterator end() const noexcept
2508 return Iterator {*this, this->length()};
2511 Shared shared() const noexcept
2513 return Shared::createWithRef(*this);
2517 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2518 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2520 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2521 CommonVariantWithIntegerSelectorFieldClass<
2522 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2524 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2525 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2527 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2528 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2530 namespace internal {
2532 struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2534 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2535 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2539 struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2540 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2545 struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2546 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2550 struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2552 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2553 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2557 struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2558 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2563 struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2564 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2568 } /* namespace internal */
2570 template <typename LibObjT>
2571 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2573 BT_ASSERT_DBG(this->isBitArray());
2574 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2577 template <typename LibObjT>
2578 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2580 BT_ASSERT_DBG(this->isInteger());
2581 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2584 template <typename LibObjT>
2585 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2587 BT_ASSERT_DBG(this->isEnumeration());
2588 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2591 template <typename LibObjT>
2592 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2593 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2595 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2596 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2600 template <typename LibObjT>
2601 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2602 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2604 BT_ASSERT_DBG(this->isSignedEnumeration());
2605 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2609 template <typename LibObjT>
2610 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2612 BT_ASSERT_DBG(this->isStructure());
2613 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2616 template <typename LibObjT>
2617 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2619 BT_ASSERT_DBG(this->isArray());
2620 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2623 template <typename LibObjT>
2624 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2626 BT_ASSERT_DBG(this->isStaticArray());
2627 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2630 template <typename LibObjT>
2631 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2632 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2634 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2635 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2638 template <typename LibObjT>
2639 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2641 BT_ASSERT_DBG(this->isOption());
2642 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2645 template <typename LibObjT>
2646 CommonOptionWithSelectorFieldClass<LibObjT>
2647 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2649 BT_ASSERT_DBG(this->isOptionWithSelector());
2650 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2653 template <typename LibObjT>
2654 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2655 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2657 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2658 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2661 template <typename LibObjT>
2662 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2663 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2665 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2666 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2670 template <typename LibObjT>
2671 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2672 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2674 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2675 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2679 template <typename LibObjT>
2680 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2682 BT_ASSERT_DBG(this->isVariant());
2683 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2686 template <typename LibObjT>
2687 CommonVariantWithoutSelectorFieldClass<LibObjT>
2688 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2690 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2691 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2694 template <typename LibObjT>
2695 CommonVariantWithSelectorFieldClass<LibObjT>
2696 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2698 BT_ASSERT_DBG(this->isVariantWithSelector());
2699 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2702 template <typename LibObjT>
2703 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2704 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2705 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2707 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2708 return CommonVariantWithIntegerSelectorFieldClass<
2709 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2712 template <typename LibObjT>
2713 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2714 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2715 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2717 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2718 return CommonVariantWithIntegerSelectorFieldClass<
2719 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2722 } /* namespace bt2 */
2724 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */