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
10 #include <type_traits>
12 #include <babeltrace2/babeltrace.h>
14 #include "common/assert.h"
15 #include "internal/borrowed-obj.hpp"
16 #include "internal/shared-obj.hpp"
17 #include "cpp-common/optional.hpp"
18 #include "cpp-common/string_view.hpp"
19 #include "common-iter.hpp"
20 #include "lib-error.hpp"
21 #include "integer-range-set.hpp"
22 #include "field-path.hpp"
29 struct FieldClassRefFuncs final
31 static void get(const bt_field_class * const libObjPtr)
33 bt_field_class_get_ref(libObjPtr);
36 static void put(const bt_field_class * const libObjPtr)
38 bt_field_class_put_ref(libObjPtr);
42 template <typename ObjT, typename LibObjT>
43 using SharedFieldClass = internal::SharedObj<ObjT, LibObjT, internal::FieldClassRefFuncs>;
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 LibObjT>
71 class CommonBitArrayFieldClass;
73 template <typename LibObjT>
74 class CommonIntegerFieldClass;
76 template <typename LibObjT>
77 class ConstEnumerationFieldClassMapping;
79 template <typename LibObjT>
80 class CommonBaseEnumerationFieldClass;
82 template <typename LibObjT, typename MappingT>
83 class CommonEnumerationFieldClass;
85 template <typename LibObjT>
86 class CommonStructureFieldClass;
88 template <typename LibObjT>
89 class CommonArrayFieldClass;
91 template <typename LibObjT>
92 class CommonStaticArrayFieldClass;
94 template <typename LibObjT>
95 class CommonDynamicArrayWithLengthFieldClass;
97 template <typename LibObjT>
98 class CommonOptionFieldClass;
100 template <typename LibObjT>
101 class CommonOptionWithSelectorFieldClass;
103 template <typename LibObjT>
104 class CommonOptionWithBoolSelectorFieldClass;
106 template <typename LibObjT>
107 class CommonVariantFieldClass;
109 template <typename LibObjT, typename RangeSetT>
110 class CommonOptionWithIntegerSelectorFieldClass;
112 template <typename LibObjT>
113 class CommonVariantWithoutSelectorFieldClass;
115 template <typename LibObjT>
116 class CommonVariantWithSelectorFieldClass;
118 template <typename LibObjT>
119 class ConstVariantWithIntegerSelectorFieldClassOption;
121 template <typename LibObjT, typename RangeSetT>
122 class CommonVariantWithIntegerSelectorFieldClass;
124 template <typename LibObjT>
125 class CommonEventClass;
127 template <typename LibObjT>
128 class CommonStreamClass;
130 template <typename LibObjT>
131 class CommonTraceClass;
133 enum class FieldClassType
135 BOOL = BT_FIELD_CLASS_TYPE_BOOL,
136 BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
137 UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
138 SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
139 UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
140 SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
141 SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
142 DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
143 STRING = BT_FIELD_CLASS_TYPE_STRING,
144 STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
145 STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
146 DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
147 DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
148 OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
149 OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
150 OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
151 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
152 OPTION_WITH_SIGNED_INTEGER_SELECTOR =
153 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
154 VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
155 VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
156 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
157 VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
158 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
161 template <typename LibObjT>
162 class CommonFieldClass : public internal::BorrowedObj<LibObjT>
164 /* Allow appendMember() to call `fc.libObjPtr()` */
165 friend class CommonStructureFieldClass<bt_field_class>;
167 /* Allow appendOption() to call `fc.libObjPtr()` */
168 friend class CommonVariantWithoutSelectorFieldClass<bt_field_class>;
170 friend class CommonVariantWithIntegerSelectorFieldClass<
172 ConstVariantWithIntegerSelectorFieldClassOption<
173 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>;
175 friend class CommonVariantWithIntegerSelectorFieldClass<
177 ConstVariantWithIntegerSelectorFieldClassOption<
178 const bt_field_class_variant_with_selector_field_integer_signed_option>>;
180 /* Allow *FieldClass() to call `fc.libObjPtr()` */
181 friend class CommonEventClass<bt_event_class>;
182 friend class CommonStreamClass<bt_stream_class>;
184 /* Allow create*FieldClass() to call `fc.libObjPtr()` */
185 friend class CommonTraceClass<bt_trace_class>;
188 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
191 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
192 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
195 using Shared = internal::SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
197 using UserAttributes =
198 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
200 explicit CommonFieldClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObj {libObjPtr}
204 template <typename OtherLibObjT>
205 CommonFieldClass(const CommonFieldClass<OtherLibObjT>& fc) noexcept : _ThisBorrowedObj {fc}
209 template <typename OtherLibObjT>
210 CommonFieldClass& operator=(const CommonFieldClass<OtherLibObjT>& fc) noexcept
212 _ThisBorrowedObj::operator=(fc);
216 FieldClassType type() const noexcept
218 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
221 bool isBool() const noexcept
223 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
226 bool isBitArray() const noexcept
228 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
231 bool isInteger() const noexcept
233 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
236 bool isUnsignedInteger() const noexcept
238 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
241 bool isSignedInteger() const noexcept
243 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
246 bool isEnumeration() const noexcept
248 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
251 bool isUnsignedEnumeration() const noexcept
253 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
256 bool isSignedEnumeration() const noexcept
258 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
261 bool isReal() const noexcept
263 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
266 bool isSinglePrecisionReal() const noexcept
268 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
271 bool isDoublePrecisionReal() const noexcept
273 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
276 bool isString() const noexcept
278 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
281 bool isStructure() const noexcept
283 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
286 bool isArray() const noexcept
288 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
291 bool isStaticArray() const noexcept
293 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
296 bool isDynamicArray() const noexcept
298 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
301 bool isDynamicArrayWithoutLength() const noexcept
303 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
306 bool isDynamicArrayWithLength() const noexcept
308 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
311 bool isOption() const noexcept
313 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
316 bool isOptionWithoutSelector() const noexcept
318 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
321 bool isOptionWithSelector() const noexcept
323 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
326 bool isOptionWithBoolSelector() const noexcept
328 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
331 bool isOptionWithIntegerSelector() const noexcept
333 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
336 bool isOptionWithUnsignedIntegerSelector() const noexcept
338 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
341 bool isOptionWithSignedIntegerSelector() const noexcept
343 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
346 bool isVariant() const noexcept
348 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
351 bool isVariantWithoutSelector() const noexcept
353 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
356 bool isVariantWithSelector() const noexcept
358 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
361 bool isVariantWithIntegerSelector() const noexcept
363 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
366 bool isVariantWithUnsignedIntegerSelector() const noexcept
368 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
371 bool isVariantWithSignedIntegerSelector() const noexcept
373 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
376 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
377 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
378 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
379 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
380 const bt_field_class_enumeration_unsigned_mapping>>
381 asUnsignedEnumeration() const noexcept;
383 CommonEnumerationFieldClass<
384 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
385 asSignedEnumeration() const noexcept;
387 CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
388 CommonArrayFieldClass<LibObjT> asArray() const noexcept;
389 CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
390 CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
391 CommonOptionFieldClass<LibObjT> asOption() const noexcept;
392 CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
393 CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;
395 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
396 asOptionWithUnsignedIntegerSelector() const noexcept;
398 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
399 asOptionWithSignedIntegerSelector() const noexcept;
401 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
402 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
403 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
405 CommonVariantWithIntegerSelectorFieldClass<
406 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
407 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
408 asVariantWithUnsignedIntegerSelector() const noexcept;
410 CommonVariantWithIntegerSelectorFieldClass<
411 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
412 const bt_field_class_variant_with_selector_field_integer_signed_option>>
413 asVariantWithSignedIntegerSelector() const noexcept;
415 template <typename LibValT>
416 void userAttributes(const CommonMapValue<LibValT>& userAttrs)
418 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
420 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
423 ConstMapValue userAttributes() const noexcept
425 return ConstMapValue {internal::CommonFieldClassSpec<const bt_field_class>::userAttributes(
429 UserAttributes userAttributes() noexcept
431 return UserAttributes {
432 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
435 Shared shared() const noexcept
437 return Shared {*this};
441 bool _libTypeIs(const bt_field_class_type type) const noexcept
443 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
447 using FieldClass = CommonFieldClass<bt_field_class>;
448 using ConstFieldClass = CommonFieldClass<const bt_field_class>;
450 template <typename LibObjT>
451 class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
454 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
455 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
458 using Shared = internal::SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
460 explicit CommonBitArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
461 _ThisCommonFieldClass {libObjPtr}
463 BT_ASSERT_DBG(this->isBitArray());
466 template <typename OtherLibObjT>
467 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept :
468 _ThisCommonFieldClass {fc}
472 template <typename OtherLibObjT>
473 CommonBitArrayFieldClass<LibObjT>&
474 operator=(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept
476 _ThisCommonFieldClass::operator=(fc);
480 std::uint64_t length() const noexcept
482 return bt_field_class_bit_array_get_length(this->libObjPtr());
485 Shared shared() const noexcept
487 return Shared {*this};
491 using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
492 using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
494 enum class DisplayBase
496 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
497 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
498 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
499 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
502 template <typename LibObjT>
503 class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
506 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
509 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
510 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
513 using Shared = internal::SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
515 explicit CommonIntegerFieldClass(const _LibObjPtr libObjPtr) noexcept :
516 _ThisCommonFieldClass {libObjPtr}
518 BT_ASSERT_DBG(this->isInteger());
521 template <typename OtherLibObjT>
522 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept :
523 _ThisCommonFieldClass {fc}
527 template <typename OtherLibObjT>
528 CommonIntegerFieldClass& operator=(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept
530 _ThisCommonFieldClass::operator=(fc);
534 void fieldValueRange(const std::uint64_t n) noexcept
536 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
538 bt_field_class_integer_get_field_value_range(this->libObjPtr(), n);
541 std::uint64_t fieldValueRange() const noexcept
543 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
546 void preferredDisplayBase(const DisplayBase base) noexcept
548 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
550 bt_field_class_integer_set_preferred_display_base(
551 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
554 DisplayBase preferredDisplayBase() const noexcept
556 return static_cast<DisplayBase>(
557 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
560 Shared shared() const noexcept
562 return Shared {*this};
566 using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
567 using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
571 template <typename LibObjT>
572 struct ConstEnumerationFieldClassMappingSpec;
574 /* Functions specific to unsigned enumeration field class mappings */
576 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
579 static const bt_integer_range_set_unsigned *
580 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
582 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
586 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
588 return bt_field_class_enumeration_mapping_get_label(
589 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
593 /* Functions specific to signed enumeration field class mappings */
595 struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
597 static const bt_integer_range_set_signed *
598 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
600 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
604 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
606 return bt_field_class_enumeration_mapping_get_label(
607 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
611 } /* namespace internal */
613 template <typename LibObjT>
614 class ConstEnumerationFieldClassMapping final : public internal::BorrowedObj<LibObjT>
617 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
618 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
621 using RangeSet = typename std::conditional<
622 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
623 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
625 explicit ConstEnumerationFieldClassMapping(const _LibObjPtr libObjPtr) noexcept :
626 _ThisBorrowedObj {libObjPtr}
630 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
631 _ThisBorrowedObj {mapping}
635 ConstEnumerationFieldClassMapping&
636 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
638 _ThisBorrowedObj::operator=(mapping);
642 RangeSet ranges() const noexcept
645 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
648 bpstd::string_view label() const noexcept
650 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
654 using ConstUnsignedEnumerationFieldClassMapping =
655 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
657 using ConstSignedEnumerationFieldClassMapping =
658 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
662 template <typename MappingT>
663 struct CommonEnumerationFieldClassSpec;
665 /* Functions specific to unsigned enumeration field classes */
667 struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
669 static const bt_field_class_enumeration_unsigned_mapping *
670 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
672 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
675 static const bt_field_class_enumeration_unsigned_mapping *
676 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
678 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
682 /* Functions specific to signed enumeration field classes */
684 struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
686 static const bt_field_class_enumeration_signed_mapping *
687 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
689 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
692 static const bt_field_class_enumeration_signed_mapping *
693 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
695 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
699 } /* namespace internal */
701 template <typename LibObjT>
702 class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
705 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
708 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
709 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
712 using Shared = internal::SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
714 explicit CommonBaseEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
715 _ThisCommonIntegerFieldClass {libObjPtr}
717 BT_ASSERT_DBG(this->isEnumeration());
720 template <typename OtherLibObjT>
721 CommonBaseEnumerationFieldClass(
722 const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept :
723 _ThisCommonIntegerFieldClass {fc}
727 template <typename OtherLibObjT>
728 CommonBaseEnumerationFieldClass&
729 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept
731 _ThisCommonIntegerFieldClass::operator=(fc);
735 std::uint64_t size() const noexcept
737 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
740 Shared shared() const noexcept
742 return Shared {*this};
746 template <typename LibObjT, typename MappingT>
747 class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
750 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
751 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
752 using _ThisCommonEnumerationFieldClass = CommonEnumerationFieldClass<LibObjT, MappingT>;
755 using Shared = internal::SharedFieldClass<_ThisCommonEnumerationFieldClass, LibObjT>;
756 using Mapping = MappingT;
758 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
759 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
761 BT_ASSERT_DBG(this->isEnumeration());
764 template <typename OtherLibObjT>
765 CommonEnumerationFieldClass(
766 const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept :
767 _ThisCommonEnumerationFieldClass {fc}
771 template <typename OtherLibObjT>
772 CommonEnumerationFieldClass&
773 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept
775 _ThisCommonEnumerationFieldClass::operator=(fc);
779 Mapping operator[](const std::uint64_t index) const noexcept
781 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
782 this->libObjPtr(), index)};
785 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
787 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
788 this->libObjPtr(), label);
791 return Mapping {libObjPtr};
794 return nonstd::nullopt;
797 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
799 return (*this)[label.data()];
802 Shared shared() const noexcept
804 return Shared {*this};
808 using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
809 using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
811 using UnsignedEnumerationFieldClass =
812 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
814 using ConstUnsignedEnumerationFieldClass =
815 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
817 using SignedEnumerationFieldClass =
818 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
820 using ConstSignedEnumerationFieldClass =
821 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
825 template <typename LibObjT>
826 struct CommonStructureFieldClassMemberSpec;
828 /* Functions specific to mutable structure field class members */
830 struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
832 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
834 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
838 /* Functions specific to constant structure field class members */
840 struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
842 static const bt_field_class *
843 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
845 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
849 } /* namespace internal */
851 template <typename LibObjT>
852 class CommonStructureFieldClassMember final : public internal::BorrowedObj<LibObjT>
855 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
856 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
859 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
862 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
863 _ThisBorrowedObj {libObjPtr}
867 template <typename OtherLibObjT>
868 CommonStructureFieldClassMember(
869 const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept :
870 _ThisBorrowedObj {fc}
874 template <typename OtherLibObjT>
875 CommonStructureFieldClassMember<LibObjT>&
876 operator=(const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept
878 _ThisBorrowedObj::operator=(fc);
882 bpstd::string_view name() const noexcept
884 return bt_field_class_structure_member_get_name(this->libObjPtr());
887 ConstFieldClass fieldClass() const noexcept
889 return ConstFieldClass {internal::CommonStructureFieldClassMemberSpec<
890 const bt_field_class_structure_member>::fieldClass(this->libObjPtr())};
893 _FieldClass fieldClass() noexcept
896 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
900 using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
902 using ConstStructureFieldClassMember =
903 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
907 template <typename LibObjT>
908 struct CommonStructureFieldClassSpec;
910 /* Functions specific to mutable structure field classes */
912 struct CommonStructureFieldClassSpec<bt_field_class> final
914 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
915 const std::uint64_t index) noexcept
917 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
920 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
921 const char * const name) noexcept
923 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
927 /* Functions specific to constant structure field classes */
929 struct CommonStructureFieldClassSpec<const bt_field_class> final
931 static const bt_field_class_structure_member *
932 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
934 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
937 static const bt_field_class_structure_member *
938 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
940 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
944 } /* namespace internal */
946 template <typename LibObjT>
947 class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
950 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
951 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
954 using Shared = internal::SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
956 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
957 StructureFieldClassMember>::type;
959 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
961 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
962 _ThisCommonFieldClass {libObjPtr}
964 BT_ASSERT_DBG(this->isStructure());
967 template <typename OtherLibObjT>
968 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept :
969 _ThisCommonFieldClass {fc}
973 template <typename OtherLibObjT>
974 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept
976 _ThisCommonFieldClass::operator=(fc);
980 void appendMember(const char * const name, const FieldClass& fc)
982 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
985 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
987 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
988 throw LibMemoryError {};
992 void appendMember(const std::string& name, const FieldClass& fc)
994 this->appendMember(name.data(), fc);
997 std::uint64_t size() const noexcept
999 return bt_field_class_structure_get_member_count(this->libObjPtr());
1002 Iterator begin() const noexcept
1004 return Iterator {*this, 0};
1007 Iterator end() const noexcept
1009 return Iterator {*this, this->size()};
1012 ConstStructureFieldClassMember operator[](const std::uint64_t index) const noexcept
1014 return ConstStructureFieldClassMember {
1015 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByIndex(
1016 this->libObjPtr(), index)};
1019 Member operator[](const std::uint64_t index) noexcept
1021 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
1022 this->libObjPtr(), index)};
1025 nonstd::optional<ConstStructureFieldClassMember>
1026 operator[](const char * const name) const noexcept
1028 const auto libObjPtr =
1029 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByName(
1030 this->libObjPtr(), name);
1033 return ConstStructureFieldClassMember {libObjPtr};
1036 return nonstd::nullopt;
1039 nonstd::optional<ConstStructureFieldClassMember>
1040 operator[](const std::string& name) const noexcept
1042 return (*this)[name.data()];
1045 nonstd::optional<Member> operator[](const char * const name) noexcept
1047 const auto libObjPtr =
1048 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
1051 return Member {libObjPtr};
1054 return nonstd::nullopt;
1057 nonstd::optional<Member> operator[](const std::string& name) noexcept
1059 return (*this)[name.data()];
1062 Shared shared() const noexcept
1064 return Shared {*this};
1068 using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1069 using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1071 namespace internal {
1073 template <typename LibObjT>
1074 struct CommonArrayFieldClassSpec;
1076 /* Functions specific to mutable array field classes */
1078 struct CommonArrayFieldClassSpec<bt_field_class> final
1080 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1082 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1086 /* Functions specific to constant array field classes */
1088 struct CommonArrayFieldClassSpec<const bt_field_class> final
1090 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1092 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1096 } /* namespace internal */
1098 template <typename LibObjT>
1099 class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1102 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1105 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1108 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1109 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1112 using Shared = internal::SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1114 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1115 _ThisCommonFieldClass {libObjPtr}
1117 BT_ASSERT_DBG(this->isArray());
1120 template <typename OtherLibObjT>
1121 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept :
1122 _ThisCommonFieldClass {fc}
1126 template <typename OtherLibObjT>
1127 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept
1129 _ThisCommonFieldClass::operator=(fc);
1133 ConstFieldClass elementFieldClass() const noexcept
1135 return ConstFieldClass {
1136 internal::CommonArrayFieldClassSpec<const bt_field_class>::elementFieldClass(
1137 this->libObjPtr())};
1140 _FieldClass elementFieldClass() noexcept
1142 return _FieldClass {
1143 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
1146 Shared shared() const noexcept
1148 return Shared {*this};
1152 using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1153 using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1155 template <typename LibObjT>
1156 class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1159 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1160 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1163 using Shared = internal::SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1165 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1166 _ThisCommonArrayFieldClass {libObjPtr}
1168 BT_ASSERT_DBG(this->isStaticArray());
1171 template <typename OtherLibObjT>
1172 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept :
1173 _ThisCommonArrayFieldClass {fc}
1177 template <typename OtherLibObjT>
1178 CommonStaticArrayFieldClass&
1179 operator=(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept
1181 _ThisCommonArrayFieldClass::operator=(fc);
1185 std::uint64_t length() const noexcept
1187 return bt_field_class_array_static_get_length(this->libObjPtr());
1190 Shared shared() const noexcept
1192 return Shared {*this};
1196 using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1197 using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1199 template <typename LibObjT>
1200 class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1203 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1204 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1208 internal::SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1210 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1211 _ThisCommonArrayFieldClass {libObjPtr}
1213 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1216 template <typename OtherLibObjT>
1217 CommonDynamicArrayWithLengthFieldClass(
1218 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept :
1219 _ThisCommonArrayFieldClass {fc}
1223 template <typename OtherLibObjT>
1224 CommonDynamicArrayWithLengthFieldClass&
1225 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept
1227 _ThisCommonArrayFieldClass::operator=(fc);
1231 ConstFieldPath lengthFieldPath() const noexcept
1233 return ConstFieldPath {
1234 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
1235 this->libObjPtr())};
1238 Shared shared() const noexcept
1240 return Shared {*this};
1244 using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1246 using ConstDynamicArrayWithLengthFieldClass =
1247 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1249 namespace internal {
1251 template <typename LibObjT>
1252 struct CommonOptionFieldClassSpec;
1254 /* Functions specific to mutable option field classes */
1256 struct CommonOptionFieldClassSpec<bt_field_class> final
1258 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1260 return bt_field_class_option_borrow_field_class(libObjPtr);
1264 /* Functions specific to constant option field classes */
1266 struct CommonOptionFieldClassSpec<const bt_field_class> final
1268 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1270 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1274 } /* namespace internal */
1276 template <typename LibObjT>
1277 class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1280 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1283 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1286 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1287 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1290 using Shared = internal::SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1292 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1293 _ThisCommonFieldClass {libObjPtr}
1295 BT_ASSERT_DBG(this->isOption());
1298 template <typename OtherLibObjT>
1299 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept :
1300 _ThisCommonFieldClass {fc}
1304 template <typename OtherLibObjT>
1305 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept
1307 _ThisCommonFieldClass::operator=(fc);
1311 ConstFieldClass fieldClass() const noexcept
1313 return ConstFieldClass {
1314 internal::CommonOptionFieldClassSpec<const bt_field_class>::fieldClass(
1315 this->libObjPtr())};
1318 _FieldClass fieldClass() noexcept
1320 return _FieldClass {
1321 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
1324 Shared shared() const noexcept
1326 return Shared {*this};
1330 using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1331 using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1333 template <typename LibObjT>
1334 class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1337 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1340 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1341 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1344 using Shared = internal::SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1346 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1347 _ThisCommonOptionFieldClass {libObjPtr}
1349 BT_ASSERT_DBG(this->isOptionWithSelector());
1352 template <typename OtherLibObjT>
1353 CommonOptionWithSelectorFieldClass(
1354 const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1355 _ThisCommonOptionFieldClass {fc}
1359 template <typename OtherLibObjT>
1360 CommonOptionWithSelectorFieldClass&
1361 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
1363 _ThisCommonOptionFieldClass::operator=(fc);
1367 ConstFieldPath selectorFieldPath() const noexcept
1369 return ConstFieldPath {
1370 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
1371 this->libObjPtr())};
1374 Shared shared() const noexcept
1376 return Shared {*this};
1380 using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1381 using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1383 template <typename LibObjT>
1384 class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1387 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1389 using typename CommonOptionWithSelectorFieldClass<
1390 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1394 internal::SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1396 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1397 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1399 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1402 template <typename OtherLibObjT>
1403 CommonOptionWithBoolSelectorFieldClass(
1404 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1405 _ThisCommonOptionWithSelectorFieldClass {fc}
1409 template <typename OtherLibObjT>
1410 CommonOptionWithBoolSelectorFieldClass&
1411 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept
1413 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1417 bool selectorIsReversed() const noexcept
1419 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
1423 Shared shared() const noexcept
1425 return Shared {*this};
1429 using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1431 using ConstOptionWithBoolSelectorFieldClass =
1432 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1434 namespace internal {
1436 template <typename RangeSetT>
1437 struct CommonOptionWithIntegerSelectorFieldClassSpec;
1439 /* Functions specific to option field classes with unsigned integer ranges */
1441 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1443 static const bt_integer_range_set_unsigned *
1444 ranges(const bt_field_class * const libObjPtr) noexcept
1446 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1451 /* Functions specific to option field classes with signed ranges */
1453 struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1455 static const bt_integer_range_set_signed *
1456 ranges(const bt_field_class * const libObjPtr) noexcept
1458 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1463 } /* namespace internal */
1465 template <typename LibObjT, typename RangeSetT>
1466 class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1469 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1471 using typename CommonOptionWithSelectorFieldClass<
1472 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1474 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1475 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1479 internal::SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1481 using RangeSet = RangeSetT;
1483 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1484 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1486 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1489 template <typename OtherLibObjT>
1490 CommonOptionWithIntegerSelectorFieldClass(
1491 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept :
1492 _ThisCommonOptionWithSelectorFieldClass {fc}
1496 template <typename OtherLibObjT>
1497 CommonOptionWithIntegerSelectorFieldClass&
1498 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept
1500 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1504 RangeSet ranges() const noexcept
1506 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
1507 this->libObjPtr())};
1510 Shared shared() const noexcept
1512 return Shared {*this};
1516 using OptionWithUnsignedIntegerSelectorFieldClass =
1517 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1519 using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1520 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1522 using OptionWithSignedIntegerSelectorFieldClass =
1523 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1525 using ConstOptionWithSignedIntegerSelectorFieldClass =
1526 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1528 namespace internal {
1530 template <typename LibObjT>
1531 struct CommonVariantFieldClassOptionSpec;
1533 /* Functions specific to mutable variant field class options */
1535 struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1537 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1539 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1543 /* Functions specific to constant variant field class options */
1545 struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1547 static const bt_field_class *
1548 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1550 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1554 } /* namespace internal */
1556 template <typename LibObjT>
1557 class CommonVariantFieldClassOption : public internal::BorrowedObj<LibObjT>
1560 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1561 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1564 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1567 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1568 _ThisBorrowedObj {libObjPtr}
1572 template <typename OtherLibObjT>
1573 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept :
1574 _ThisBorrowedObj {fc}
1578 template <typename OtherLibObjT>
1579 CommonVariantFieldClassOption&
1580 operator=(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept
1582 _ThisBorrowedObj::operator=(fc);
1586 bpstd::string_view name() const noexcept
1588 return bt_field_class_variant_option_get_name(this->libObjPtr());
1591 ConstFieldClass fieldClass() const noexcept
1593 return ConstFieldClass {internal::CommonVariantFieldClassOptionSpec<
1594 const bt_field_class_variant_option>::fieldClass(this->libObjPtr())};
1597 _FieldClass fieldClass() noexcept
1599 return _FieldClass {
1600 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
1604 using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1606 using ConstVariantFieldClassOption =
1607 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1609 namespace internal {
1611 template <typename LibObjT>
1612 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1614 /* Functions specific to variant field class options with unsigned integer selector */
1616 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1617 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1620 static const bt_integer_range_set_unsigned *
1621 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1622 * const libObjPtr) noexcept
1624 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1628 static const bt_field_class_variant_option *
1629 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1630 * const libObjPtr) noexcept
1632 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1637 /* Functions specific to variant field class options with signed integer selector */
1639 struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1640 const bt_field_class_variant_with_selector_field_integer_signed_option>
1643 static const bt_integer_range_set_signed *
1644 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1645 * const libObjPtr) noexcept
1647 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1651 static const bt_field_class_variant_option *
1652 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1653 * const libObjPtr) noexcept
1655 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
1660 } /* namespace internal */
1662 template <typename LibObjT>
1663 class ConstVariantWithIntegerSelectorFieldClassOption : public internal::BorrowedObj<LibObjT>
1666 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1667 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1668 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
1671 using RangeSet = typename std::conditional<
1674 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
1675 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
1677 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1678 _ThisBorrowedObj {libObjPtr}
1682 template <typename OtherLibObjT>
1683 ConstVariantWithIntegerSelectorFieldClassOption(
1684 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept :
1685 _ThisBorrowedObj {fc}
1689 template <typename OtherLibObjT>
1690 ConstVariantWithIntegerSelectorFieldClassOption&
1691 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept
1693 _ThisBorrowedObj::operator=(fc);
1697 ConstVariantFieldClassOption asBaseOption() const noexcept
1699 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
1702 bpstd::string_view name() const noexcept
1704 return this->asBaseOption().name();
1707 ConstFieldClass fieldClass() const noexcept
1709 return this->asBaseOption().fieldClass();
1712 RangeSet ranges() const noexcept
1714 return RangeSet {_Spec::ranges(this->libObjPtr())};
1718 using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
1719 ConstVariantWithIntegerSelectorFieldClassOption<
1720 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
1722 using ConstVariantWithSignedIntegerSelectorFieldClassOption =
1723 ConstVariantWithIntegerSelectorFieldClassOption<
1724 const bt_field_class_variant_with_selector_field_integer_signed_option>;
1726 namespace internal {
1728 template <typename LibObjT>
1729 struct CommonVariantFieldClassSpec;
1731 /* Functions specific to mutable variant field classes */
1733 struct CommonVariantFieldClassSpec<bt_field_class> final
1735 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
1736 const std::uint64_t index) noexcept
1738 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
1741 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
1742 const char * const name) noexcept
1744 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
1748 /* Functions specific to constant variant field classes */
1750 struct CommonVariantFieldClassSpec<const bt_field_class> final
1752 static const bt_field_class_variant_option *
1753 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1755 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
1758 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
1759 const char * const name) noexcept
1761 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
1765 } /* namespace internal */
1767 template <typename LibObjT>
1768 class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
1771 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1774 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1775 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
1778 using Shared = internal::SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
1781 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
1782 VariantFieldClassOption>::type;
1784 using Iterator = CommonIterator<CommonVariantFieldClass<LibObjT>, Option>;
1786 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
1787 _ThisCommonFieldClass {libObjPtr}
1789 BT_ASSERT_DBG(this->isVariant());
1792 template <typename OtherLibObjT>
1793 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept :
1794 _ThisCommonFieldClass {fc}
1798 template <typename OtherLibObjT>
1799 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept
1801 _ThisCommonFieldClass::operator=(fc);
1805 std::uint64_t size() const noexcept
1807 return bt_field_class_variant_get_option_count(this->libObjPtr());
1810 Iterator begin() const noexcept
1812 return Iterator {*this, 0};
1815 Iterator end() const noexcept
1817 return Iterator {*this, this->size()};
1820 ConstVariantFieldClassOption operator[](const std::uint64_t index) const noexcept
1822 return ConstVariantFieldClassOption {
1823 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByIndex(
1824 this->libObjPtr(), index)};
1827 Option operator[](const std::uint64_t index) noexcept
1829 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
1830 this->libObjPtr(), index)};
1833 nonstd::optional<ConstVariantFieldClassOption>
1834 operator[](const char * const name) const noexcept
1836 const auto libObjPtr =
1837 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByName(
1838 this->libObjPtr(), name);
1841 return ConstVariantFieldClassOption {libObjPtr};
1844 return nonstd::nullopt;
1847 nonstd::optional<ConstVariantFieldClassOption>
1848 operator[](const std::string& name) const noexcept
1850 return (*this)[name.data()];
1853 nonstd::optional<Option> operator[](const char * const name) noexcept
1855 const auto libObjPtr =
1856 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
1859 return Option {libObjPtr};
1862 return nonstd::nullopt;
1865 nonstd::optional<Option> operator[](const std::string& name) noexcept
1867 return (*this)[name.data()];
1870 Shared shared() const noexcept
1872 return Shared {*this};
1876 using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
1877 using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
1879 template <typename LibObjT>
1880 class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
1883 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
1884 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1888 internal::SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
1890 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1891 _ThisCommonVariantFieldClass {libObjPtr}
1893 BT_ASSERT_DBG(this->isVariantWithoutSelector());
1896 template <typename OtherLibObjT>
1897 CommonVariantWithoutSelectorFieldClass(
1898 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1899 _ThisCommonVariantFieldClass {fc}
1903 template <typename OtherLibObjT>
1904 CommonVariantWithoutSelectorFieldClass&
1905 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept
1907 _ThisCommonVariantFieldClass::operator=(fc);
1911 void appendOption(const char * const name, const FieldClass& fc)
1913 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1915 const auto status = bt_field_class_variant_without_selector_append_option(
1916 this->libObjPtr(), name, fc.libObjPtr());
1919 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
1920 throw LibMemoryError {};
1924 void appendOption(const std::string& name, const FieldClass& fc)
1926 this->appendOption(name.data(), fc);
1929 Shared shared() const noexcept
1931 return Shared {*this};
1935 using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
1936 using ConstVariantWithoutSelectorFieldClass =
1937 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
1939 namespace internal {
1941 template <typename OptionT>
1942 struct CommonVariantWithIntegerSelectorFieldClassSpec;
1944 /* Functions specific to variant field classes with unsigned integer selector */
1946 struct CommonVariantWithIntegerSelectorFieldClassSpec<
1947 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
1950 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
1951 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1953 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
1957 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
1958 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1960 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
1964 static bt_field_class_variant_with_selector_field_integer_append_option_status
1965 appendOption(bt_field_class * const libObjPtr, const char * const name,
1966 bt_field_class * const libOptFcPtr,
1967 const bt_integer_range_set_unsigned * const libRangesPtr)
1969 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
1970 libObjPtr, name, libOptFcPtr, libRangesPtr);
1974 /* Functions specific to variant field classes with signed integer selector */
1976 struct CommonVariantWithIntegerSelectorFieldClassSpec<
1977 ConstVariantWithSignedIntegerSelectorFieldClassOption>
1980 static const bt_field_class_variant_with_selector_field_integer_signed_option *
1981 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1983 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
1987 static const bt_field_class_variant_with_selector_field_integer_signed_option *
1988 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1990 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
1994 static bt_field_class_variant_with_selector_field_integer_append_option_status
1995 appendOption(bt_field_class * const libObjPtr, const char * const name,
1996 bt_field_class * const libOptFcPtr,
1997 const bt_integer_range_set_signed * const libRangesPtr)
1999 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2000 libObjPtr, name, libOptFcPtr, libRangesPtr);
2004 } /* namespace internal */
2006 template <typename LibObjT>
2007 class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2010 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2013 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2014 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2017 using Shared = internal::SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2019 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2020 _ThisCommonVariantFieldClass {libObjPtr}
2022 BT_ASSERT_DBG(this->isVariantWithSelector());
2025 template <typename OtherLibObjT>
2026 CommonVariantWithSelectorFieldClass(
2027 const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2028 _ThisCommonVariantFieldClass {fc}
2032 template <typename OtherLibObjT>
2033 CommonVariantWithSelectorFieldClass&
2034 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
2036 _ThisCommonVariantFieldClass::operator=(fc);
2040 ConstFieldPath selectorFieldPath() const noexcept
2042 return ConstFieldPath {
2043 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
2044 this->libObjPtr())};
2047 Shared shared() const noexcept
2049 return Shared {*this};
2053 template <typename LibObjT, typename OptionT>
2054 class CommonVariantWithIntegerSelectorFieldClass :
2055 public CommonVariantWithSelectorFieldClass<LibObjT>
2058 using typename CommonVariantWithSelectorFieldClass<
2059 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2060 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2061 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2062 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2064 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2068 internal::SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2070 using Option = OptionT;
2072 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2073 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
2075 BT_ASSERT_DBG(this->isVariant());
2078 template <typename OtherLibObjT>
2079 CommonVariantWithIntegerSelectorFieldClass(
2080 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept :
2081 _ThisCommonVariantWithSelectorFieldClass {fc}
2085 template <typename OtherLibObjT>
2086 CommonVariantWithIntegerSelectorFieldClass&
2087 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept
2089 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
2093 Option operator[](const std::uint64_t index) const noexcept
2095 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
2098 nonstd::optional<Option> operator[](const char * const name) const noexcept
2100 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
2103 return Option {libObjPtr};
2106 return nonstd::nullopt;
2109 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2111 return (*this)[name.data()];
2114 void appendOption(const char * const name, const FieldClass& fc,
2115 const typename Option::RangeSet& ranges)
2117 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2120 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
2123 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2124 throw LibMemoryError {};
2128 void appendOption(const std::string& name, const FieldClass& fc)
2130 this->appendOption(name.data(), fc);
2133 Shared shared() const noexcept
2135 return Shared {*this};
2139 using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2140 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2142 using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2143 CommonVariantWithIntegerSelectorFieldClass<
2144 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2146 using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2147 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2149 using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2150 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2152 template <typename LibObjT>
2153 CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2155 BT_ASSERT_DBG(this->isBitArray());
2156 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
2159 template <typename LibObjT>
2160 CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2162 BT_ASSERT_DBG(this->isInteger());
2163 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
2166 template <typename LibObjT>
2167 CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2169 BT_ASSERT_DBG(this->isEnumeration());
2170 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
2173 template <typename LibObjT>
2174 CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2175 CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2177 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2178 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
2182 template <typename LibObjT>
2183 CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2184 CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2186 BT_ASSERT_DBG(this->isSignedEnumeration());
2187 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
2191 template <typename LibObjT>
2192 CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2194 BT_ASSERT_DBG(this->isStructure());
2195 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
2198 template <typename LibObjT>
2199 CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2201 BT_ASSERT_DBG(this->isArray());
2202 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
2205 template <typename LibObjT>
2206 CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2208 BT_ASSERT_DBG(this->isStaticArray());
2209 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
2212 template <typename LibObjT>
2213 CommonDynamicArrayWithLengthFieldClass<LibObjT>
2214 CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2216 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
2217 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
2220 template <typename LibObjT>
2221 CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2223 BT_ASSERT_DBG(this->isOption());
2224 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
2227 template <typename LibObjT>
2228 CommonOptionWithSelectorFieldClass<LibObjT>
2229 CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2231 BT_ASSERT_DBG(this->isOptionWithSelector());
2232 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2235 template <typename LibObjT>
2236 CommonOptionWithBoolSelectorFieldClass<LibObjT>
2237 CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2239 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
2240 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
2243 template <typename LibObjT>
2244 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2245 CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2247 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2248 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
2252 template <typename LibObjT>
2253 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2254 CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2256 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2257 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
2261 template <typename LibObjT>
2262 CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2264 BT_ASSERT_DBG(this->isVariant());
2265 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
2268 template <typename LibObjT>
2269 CommonVariantWithoutSelectorFieldClass<LibObjT>
2270 CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2272 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2273 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
2276 template <typename LibObjT>
2277 CommonVariantWithSelectorFieldClass<LibObjT>
2278 CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2280 BT_ASSERT_DBG(this->isVariantWithSelector());
2281 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
2284 template <typename LibObjT>
2285 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2286 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2287 CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2289 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2290 return CommonVariantWithIntegerSelectorFieldClass<
2291 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2294 template <typename LibObjT>
2295 CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2296 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2297 CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2299 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2300 return CommonVariantWithIntegerSelectorFieldClass<
2301 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
2304 } /* namespace bt2 */
2306 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */