2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_FIELD_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_FIELD_HPP
11 #include <type_traits>
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "cpp-common/optional.hpp"
17 #include "cpp-common/string_view.hpp"
19 #include "borrowed-object.hpp"
20 #include "field-class.hpp"
21 #include "internal/utils.hpp"
22 #include "raw-value-proxy.hpp"
26 template <typename LibObjT>
27 class CommonBoolField;
29 template <typename LibObjT>
30 class CommonBitArrayField;
32 template <typename LibObjT>
33 class CommonUnsignedIntegerField;
35 template <typename LibObjT>
36 class CommonSignedIntegerField;
38 template <typename LibObjT>
39 class CommonUnsignedEnumerationField;
41 template <typename LibObjT>
42 class CommonSignedEnumerationField;
44 template <typename LibObjT>
45 class CommonSinglePrecisionRealField;
47 template <typename LibObjT>
48 class CommonDoublePrecisionRealField;
50 template <typename LibObjT>
51 class CommonStringField;
53 template <typename LibObjT>
54 class CommonStructureField;
56 template <typename LibObjT>
57 class CommonArrayField;
59 template <typename LibObjT>
60 class CommonDynamicArrayField;
62 template <typename LibObjT>
63 class CommonOptionField;
65 template <typename LibObjT>
66 class CommonVariantField;
70 template <typename LibObjT>
71 struct CommonFieldSpec;
73 /* Functions specific to mutable fields */
75 struct CommonFieldSpec<bt_field> final
77 static bt_field_class *cls(bt_field * const libObjPtr) noexcept
79 return bt_field_borrow_class(libObjPtr);
83 /* Functions specific to constant fields */
85 struct CommonFieldSpec<const bt_field> final
87 static const bt_field_class *cls(const bt_field * const libObjPtr) noexcept
89 return bt_field_borrow_class_const(libObjPtr);
93 } /* namespace internal */
95 template <typename LibObjT>
96 class CommonField : public BorrowedObject<LibObjT>
99 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
102 using typename BorrowedObject<LibObjT>::_LibObjPtr;
103 using _ThisCommonField = CommonField<LibObjT>;
106 using Class = internal::DepFc<LibObjT>;
108 explicit CommonField(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
112 template <typename OtherLibObjT>
113 CommonField(const CommonField<OtherLibObjT> val) noexcept : _ThisBorrowedObject {val}
117 template <typename OtherLibObjT>
118 _ThisCommonField operator=(const CommonField<OtherLibObjT> val) noexcept
120 _ThisBorrowedObject::operator=(val);
124 CommonField<const bt_field> asConst() const noexcept
126 return CommonField<const bt_field> {*this};
129 FieldClassType classType() const noexcept
131 return static_cast<FieldClassType>(bt_field_get_class_type(this->libObjPtr()));
134 Class cls() const noexcept
136 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
139 bool isBool() const noexcept
141 return this->cls().isBool();
144 bool isBitArray() const noexcept
146 return this->cls().isBitArray();
149 bool isUnsignedInteger() const noexcept
151 return this->cls().isUnsignedInteger();
154 bool isSignedInteger() const noexcept
156 return this->cls().isSignedInteger();
159 bool isUnsignedEnumeration() const noexcept
161 return this->cls().isUnsignedEnumeration();
164 bool isSignedEnumeration() const noexcept
166 return this->cls().isSignedEnumeration();
169 bool isSinglePrecisionReal() const noexcept
171 return this->cls().isSinglePrecisionReal();
174 bool isDoublePrecisionReal() const noexcept
176 return this->cls().isDoublePrecisionReal();
179 bool isString() const noexcept
181 return this->cls().isString();
184 bool isStructure() const noexcept
186 return this->cls().isStructure();
189 bool isArray() const noexcept
191 return this->cls().isArray();
194 bool isDynamicArray() const noexcept
196 return this->cls().isDynamicArray();
199 bool isOption() const noexcept
201 return this->cls().isOption();
204 bool isVariant() const noexcept
206 return this->cls().isVariant();
209 template <typename FieldT>
210 FieldT as() const noexcept
212 return FieldT {this->libObjPtr()};
215 CommonBoolField<LibObjT> asBool() const noexcept;
216 CommonBitArrayField<LibObjT> asBitArray() const noexcept;
217 CommonUnsignedIntegerField<LibObjT> asUnsignedInteger() const noexcept;
218 CommonSignedIntegerField<LibObjT> asSignedInteger() const noexcept;
219 CommonUnsignedEnumerationField<LibObjT> asUnsignedEnumeration() const noexcept;
220 CommonSignedEnumerationField<LibObjT> asSignedEnumeration() const noexcept;
221 CommonSinglePrecisionRealField<LibObjT> asSinglePrecisionReal() const noexcept;
222 CommonDoublePrecisionRealField<LibObjT> asDoublePrecisionReal() const noexcept;
223 CommonStringField<LibObjT> asString() const noexcept;
224 CommonStructureField<LibObjT> asStructure() const noexcept;
225 CommonArrayField<LibObjT> asArray() const noexcept;
226 CommonDynamicArrayField<LibObjT> asDynamicArray() const noexcept;
227 CommonOptionField<LibObjT> asOption() const noexcept;
228 CommonVariantField<LibObjT> asVariant() const noexcept;
231 using Field = CommonField<bt_field>;
232 using ConstField = CommonField<const bt_field>;
236 struct FieldTypeDescr
238 using Const = ConstField;
239 using NonConst = Field;
243 struct TypeDescr<Field> : public FieldTypeDescr
248 struct TypeDescr<ConstField> : public FieldTypeDescr
252 } /* namespace internal */
254 template <typename LibObjT>
255 class CommonBoolField final : public CommonField<LibObjT>
258 using typename CommonField<LibObjT>::_LibObjPtr;
259 using typename CommonField<LibObjT>::_ThisCommonField;
264 explicit CommonBoolField(const _LibObjPtr libObjPtr) noexcept : _ThisCommonField {libObjPtr}
266 BT_ASSERT_DBG(this->isBool());
269 template <typename OtherLibObjT>
270 CommonBoolField(const CommonBoolField<OtherLibObjT> val) noexcept : _ThisCommonField {val}
274 template <typename OtherLibObjT>
275 CommonBoolField<LibObjT> operator=(const CommonBoolField<OtherLibObjT> val) noexcept
277 _ThisCommonField::operator=(val);
281 CommonBoolField<const bt_field> asConst() const noexcept
283 return CommonBoolField<const bt_field> {*this};
286 RawValueProxy<CommonBoolField> operator*() const noexcept
288 return RawValueProxy<CommonBoolField> {*this};
291 void value(const Value val) const noexcept
293 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstBoolField`.");
295 bt_field_bool_set_value(this->libObjPtr(), static_cast<bt_bool>(val));
298 Value value() const noexcept
300 return static_cast<Value>(bt_field_bool_get_value(this->libObjPtr()));
304 using BoolField = CommonBoolField<bt_field>;
305 using ConstBoolField = CommonBoolField<const bt_field>;
309 struct BoolFieldTypeDescr
311 using Const = ConstBoolField;
312 using NonConst = BoolField;
316 struct TypeDescr<BoolField> : public BoolFieldTypeDescr
321 struct TypeDescr<ConstBoolField> : public BoolFieldTypeDescr
325 } /* namespace internal */
327 template <typename LibObjT>
328 class CommonBitArrayField final : public CommonField<LibObjT>
331 using typename CommonField<LibObjT>::_LibObjPtr;
332 using typename CommonField<LibObjT>::_ThisCommonField;
335 using Class = internal::DepType<LibObjT, BitArrayFieldClass, ConstBitArrayFieldClass>;
337 explicit CommonBitArrayField(const _LibObjPtr libObjPtr) noexcept : _ThisCommonField {libObjPtr}
339 BT_ASSERT_DBG(this->isBitArray());
342 template <typename OtherLibObjT>
343 CommonBitArrayField(const CommonBitArrayField<OtherLibObjT> val) noexcept :
344 _ThisCommonField {val}
348 template <typename OtherLibObjT>
349 CommonBitArrayField<LibObjT> operator=(const CommonBitArrayField<OtherLibObjT> val) noexcept
351 _ThisCommonField::operator=(val);
355 CommonBitArrayField<const bt_field> asConst() const noexcept
357 return CommonBitArrayField<const bt_field> {*this};
360 ConstBitArrayFieldClass cls() const noexcept
362 return ConstBitArrayFieldClass {
363 internal::CommonFieldSpec<const bt_field>::cls(this->libObjPtr())};
368 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
371 void valueAsInteger(const std::uint64_t bits) const noexcept
373 static_assert(!std::is_const<LibObjT>::value,
374 "Not available with `bt2::ConstBitArrayField`.");
376 bt_field_bit_array_set_value_as_integer(this->libObjPtr(), bits);
379 std::uint64_t valueAsInteger() const noexcept
381 return bt_field_bit_array_get_value_as_integer(this->libObjPtr());
384 bool bitValue(const std::uint64_t index) const noexcept
386 BT_ASSERT_DBG(index < this->cls().length());
387 return static_cast<bool>(this->valueAsInteger() & (1ULL << index));
391 using BitArrayField = CommonBitArrayField<bt_field>;
392 using ConstBitArrayField = CommonBitArrayField<const bt_field>;
396 struct BitArrayFieldTypeDescr
398 using Const = ConstBitArrayField;
399 using NonConst = BitArrayField;
403 struct TypeDescr<BitArrayField> : public BitArrayFieldTypeDescr
408 struct TypeDescr<ConstBitArrayField> : public BitArrayFieldTypeDescr
412 } /* namespace internal */
414 template <typename LibObjT>
415 class CommonUnsignedIntegerField : public CommonField<LibObjT>
418 using typename CommonField<LibObjT>::_ThisCommonField;
421 using typename CommonField<LibObjT>::_LibObjPtr;
422 using _ThisCommonUnsignedIntegerField = CommonUnsignedIntegerField<LibObjT>;
425 using Value = std::uint64_t;
426 using Class = internal::DepType<LibObjT, IntegerFieldClass, ConstIntegerFieldClass>;
428 explicit CommonUnsignedIntegerField(const _LibObjPtr libObjPtr) noexcept :
429 _ThisCommonField {libObjPtr}
431 BT_ASSERT_DBG(this->isUnsignedInteger());
434 template <typename OtherLibObjT>
435 CommonUnsignedIntegerField(const CommonUnsignedIntegerField<OtherLibObjT> val) noexcept :
436 _ThisCommonField {val}
440 template <typename OtherLibObjT>
441 _ThisCommonUnsignedIntegerField
442 operator=(const CommonUnsignedIntegerField<OtherLibObjT> val) noexcept
444 _ThisCommonField::operator=(val);
448 CommonUnsignedIntegerField<const bt_field> asConst() const noexcept
450 return CommonUnsignedIntegerField<const bt_field> {*this};
453 Class cls() const noexcept
455 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
458 RawValueProxy<CommonUnsignedIntegerField> operator*() const noexcept
460 return RawValueProxy<CommonUnsignedIntegerField> {*this};
463 void value(const Value val) const noexcept
465 static_assert(!std::is_const<LibObjT>::value,
466 "Not available with `bt2::ConstUnsignedIntegerField`.");
468 bt_field_integer_unsigned_set_value(this->libObjPtr(), val);
471 Value value() const noexcept
473 return bt_field_integer_unsigned_get_value(this->libObjPtr());
477 using UnsignedIntegerField = CommonUnsignedIntegerField<bt_field>;
478 using ConstUnsignedIntegerField = CommonUnsignedIntegerField<const bt_field>;
482 struct UnsignedIntegerFieldTypeDescr
484 using Const = ConstUnsignedIntegerField;
485 using NonConst = UnsignedIntegerField;
489 struct TypeDescr<UnsignedIntegerField> : public UnsignedIntegerFieldTypeDescr
494 struct TypeDescr<ConstUnsignedIntegerField> : public UnsignedIntegerFieldTypeDescr
498 } /* namespace internal */
500 template <typename LibObjT>
501 class CommonSignedIntegerField : public CommonField<LibObjT>
504 using typename CommonField<LibObjT>::_ThisCommonField;
507 using typename CommonField<LibObjT>::_LibObjPtr;
508 using _ThisCommonSignedIntegerField = CommonSignedIntegerField<LibObjT>;
511 using Value = std::int64_t;
512 using Class = internal::DepType<LibObjT, IntegerFieldClass, ConstIntegerFieldClass>;
514 explicit CommonSignedIntegerField(const _LibObjPtr libObjPtr) noexcept :
515 _ThisCommonField {libObjPtr}
517 BT_ASSERT_DBG(this->isSignedInteger());
520 template <typename OtherLibObjT>
521 CommonSignedIntegerField(const CommonSignedIntegerField<OtherLibObjT> val) noexcept :
522 _ThisCommonField {val}
526 template <typename OtherLibObjT>
527 _ThisCommonSignedIntegerField
528 operator=(const CommonSignedIntegerField<OtherLibObjT> val) noexcept
530 _ThisCommonField::operator=(val);
534 CommonSignedIntegerField<const bt_field> asConst() const noexcept
536 return CommonSignedIntegerField<const bt_field> {*this};
539 Class cls() const noexcept
541 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
544 RawValueProxy<CommonSignedIntegerField> operator*() const noexcept
546 return RawValueProxy<CommonSignedIntegerField> {*this};
549 void value(const Value val) const noexcept
551 static_assert(!std::is_const<LibObjT>::value,
552 "Not available with `bt2::ConstSignedIntegerField`.");
554 bt_field_integer_signed_set_value(this->libObjPtr(), val);
557 Value value() const noexcept
559 return bt_field_integer_signed_get_value(this->libObjPtr());
563 using SignedIntegerField = CommonSignedIntegerField<bt_field>;
564 using ConstSignedIntegerField = CommonSignedIntegerField<const bt_field>;
568 struct SignedIntegerFieldTypeDescr
570 using Const = ConstSignedIntegerField;
571 using NonConst = SignedIntegerField;
575 struct TypeDescr<SignedIntegerField> : public SignedIntegerFieldTypeDescr
580 struct TypeDescr<ConstSignedIntegerField> : public SignedIntegerFieldTypeDescr
584 } /* namespace internal */
586 class EnumerationFieldClassMappingLabels
589 explicit EnumerationFieldClassMappingLabels(
590 const bt_field_class_enumeration_mapping_label_array labels, const std::uint64_t size) :
596 std::uint64_t length() const noexcept
601 bpstd::string_view operator[](const std::uint64_t index) const noexcept
603 return _mLabels[index];
607 bt_field_class_enumeration_mapping_label_array _mLabels;
611 template <typename LibObjT>
612 class CommonUnsignedEnumerationField final : public CommonUnsignedIntegerField<LibObjT>
615 using typename CommonUnsignedIntegerField<LibObjT>::_ThisCommonUnsignedIntegerField;
616 using typename CommonField<LibObjT>::_LibObjPtr;
619 using Class = internal::DepType<LibObjT, UnsignedEnumerationFieldClass,
620 ConstUnsignedEnumerationFieldClass>;
622 explicit CommonUnsignedEnumerationField(const _LibObjPtr libObjPtr) noexcept :
623 _ThisCommonUnsignedIntegerField {libObjPtr}
625 BT_ASSERT_DBG(this->isUnsignedEnumeration());
628 template <typename OtherLibObjT>
629 CommonUnsignedEnumerationField(const CommonUnsignedEnumerationField<OtherLibObjT> val) noexcept
631 _ThisCommonUnsignedIntegerField {val}
635 template <typename OtherLibObjT>
636 CommonUnsignedEnumerationField<LibObjT>
637 operator=(const CommonUnsignedEnumerationField<OtherLibObjT> val) noexcept
639 _ThisCommonUnsignedIntegerField::operator=(val);
643 CommonUnsignedEnumerationField<const bt_field> asConst() const noexcept
645 return CommonUnsignedEnumerationField<const bt_field> {*this};
648 Class cls() const noexcept
650 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
653 EnumerationFieldClassMappingLabels labels() const
655 bt_field_class_enumeration_mapping_label_array labelArray;
657 const auto status = bt_field_enumeration_unsigned_get_mapping_labels(this->libObjPtr(),
658 &labelArray, &count);
660 if (status == BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_MEMORY_ERROR) {
661 throw MemoryError {};
664 return EnumerationFieldClassMappingLabels {labelArray, count};
668 using UnsignedEnumerationField = CommonUnsignedEnumerationField<bt_field>;
669 using ConstUnsignedEnumerationField = CommonUnsignedEnumerationField<const bt_field>;
673 struct UnsignedEnumerationFieldTypeDescr
675 using Const = ConstUnsignedEnumerationField;
676 using NonConst = UnsignedEnumerationField;
680 struct TypeDescr<UnsignedEnumerationField> : public UnsignedEnumerationFieldTypeDescr
685 struct TypeDescr<ConstUnsignedEnumerationField> : public UnsignedEnumerationFieldTypeDescr
689 } /* namespace internal */
691 template <typename LibObjT>
692 class CommonSignedEnumerationField final : public CommonSignedIntegerField<LibObjT>
695 using typename CommonSignedIntegerField<LibObjT>::_ThisCommonSignedIntegerField;
696 using typename CommonField<LibObjT>::_LibObjPtr;
700 internal::DepType<LibObjT, SignedEnumerationFieldClass, ConstSignedEnumerationFieldClass>;
702 explicit CommonSignedEnumerationField(const _LibObjPtr libObjPtr) noexcept :
703 _ThisCommonSignedIntegerField {libObjPtr}
705 BT_ASSERT_DBG(this->isSignedEnumeration());
708 template <typename OtherLibObjT>
709 CommonSignedEnumerationField(const CommonSignedEnumerationField<OtherLibObjT> val) noexcept :
710 _ThisCommonSignedIntegerField {val}
714 template <typename OtherLibObjT>
715 CommonSignedEnumerationField<LibObjT>
716 operator=(const CommonSignedEnumerationField<OtherLibObjT> val) noexcept
718 _ThisCommonSignedIntegerField::operator=(val);
722 CommonSignedEnumerationField<const bt_field> asConst() const noexcept
724 return CommonSignedEnumerationField<const bt_field> {*this};
727 Class cls() const noexcept
729 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
732 EnumerationFieldClassMappingLabels labels() const
734 bt_field_class_enumeration_mapping_label_array labelArray;
737 bt_field_enumeration_signed_get_mapping_labels(this->libObjPtr(), &labelArray, &count);
739 if (status == BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_MEMORY_ERROR) {
740 throw MemoryError {};
743 return EnumerationFieldClassMappingLabels {labelArray, count};
747 using SignedEnumerationField = CommonSignedEnumerationField<bt_field>;
748 using ConstSignedEnumerationField = CommonSignedEnumerationField<const bt_field>;
752 struct SignedEnumerationFieldTypeDescr
754 using Const = ConstSignedEnumerationField;
755 using NonConst = SignedEnumerationField;
759 struct TypeDescr<SignedEnumerationField> : public SignedEnumerationFieldTypeDescr
764 struct TypeDescr<ConstSignedEnumerationField> : public SignedEnumerationFieldTypeDescr
768 } /* namespace internal */
770 template <typename LibObjT>
771 class CommonSinglePrecisionRealField final : public CommonField<LibObjT>
774 using typename CommonField<LibObjT>::_LibObjPtr;
775 using typename CommonField<LibObjT>::_ThisCommonField;
780 explicit CommonSinglePrecisionRealField(const _LibObjPtr libObjPtr) noexcept :
781 _ThisCommonField {libObjPtr}
783 BT_ASSERT_DBG(this->isSinglePrecisionReal());
786 template <typename OtherLibObjT>
787 CommonSinglePrecisionRealField(const CommonSinglePrecisionRealField<OtherLibObjT> val) noexcept
789 _ThisCommonField {val}
793 template <typename OtherLibObjT>
794 CommonSinglePrecisionRealField<LibObjT>
795 operator=(const CommonSinglePrecisionRealField<OtherLibObjT> val) noexcept
797 _ThisCommonField::operator=(val);
801 CommonSinglePrecisionRealField<const bt_field> asConst() const noexcept
803 return CommonSinglePrecisionRealField<const bt_field> {*this};
806 RawValueProxy<CommonSinglePrecisionRealField> operator*() const noexcept
808 return RawValueProxy<CommonSinglePrecisionRealField> {*this};
811 void value(const Value val) const noexcept
813 static_assert(!std::is_const<LibObjT>::value,
814 "Not available with `bt2::ConstSinglePrecisionRealField`.");
816 bt_field_real_single_precision_set_value(this->libObjPtr(), val);
819 Value value() const noexcept
821 return bt_field_real_single_precision_get_value(this->libObjPtr());
825 using SinglePrecisionRealField = CommonSinglePrecisionRealField<bt_field>;
826 using ConstSinglePrecisionRealField = CommonSinglePrecisionRealField<const bt_field>;
830 struct SinglePrecisionRealFieldTypeDescr
832 using Const = ConstSinglePrecisionRealField;
833 using NonConst = SinglePrecisionRealField;
837 struct TypeDescr<SinglePrecisionRealField> : public SinglePrecisionRealFieldTypeDescr
842 struct TypeDescr<ConstSinglePrecisionRealField> : public SinglePrecisionRealFieldTypeDescr
846 } /* namespace internal */
848 template <typename LibObjT>
849 class CommonDoublePrecisionRealField final : public CommonField<LibObjT>
852 using typename CommonField<LibObjT>::_LibObjPtr;
853 using typename CommonField<LibObjT>::_ThisCommonField;
856 using Value = double;
858 explicit CommonDoublePrecisionRealField(const _LibObjPtr libObjPtr) noexcept :
859 _ThisCommonField {libObjPtr}
861 BT_ASSERT_DBG(this->isDoublePrecisionReal());
864 template <typename OtherLibObjT>
865 CommonDoublePrecisionRealField(const CommonDoublePrecisionRealField<OtherLibObjT> val) noexcept
867 _ThisCommonField {val}
871 template <typename OtherLibObjT>
872 CommonDoublePrecisionRealField<LibObjT>
873 operator=(const CommonDoublePrecisionRealField<OtherLibObjT> val) noexcept
875 _ThisCommonField::operator=(val);
879 CommonDoublePrecisionRealField<const bt_field> asConst() const noexcept
881 return CommonDoublePrecisionRealField<const bt_field> {*this};
884 RawValueProxy<CommonDoublePrecisionRealField> operator*() const noexcept
886 return RawValueProxy<CommonDoublePrecisionRealField> {*this};
889 void value(const Value val) const noexcept
891 static_assert(!std::is_const<LibObjT>::value,
892 "Not available with `bt2::ConstDoublePrecisionRealField`.");
894 bt_field_real_double_precision_set_value(this->libObjPtr(), val);
897 Value value() const noexcept
899 return bt_field_real_double_precision_get_value(this->libObjPtr());
903 using DoublePrecisionRealField = CommonDoublePrecisionRealField<bt_field>;
904 using ConstDoublePrecisionRealField = CommonDoublePrecisionRealField<const bt_field>;
908 struct DoublePrecisionRealFieldTypeDescr
910 using Const = ConstDoublePrecisionRealField;
911 using NonConst = DoublePrecisionRealField;
915 struct TypeDescr<DoublePrecisionRealField> : public DoublePrecisionRealFieldTypeDescr
920 struct TypeDescr<ConstDoublePrecisionRealField> : public DoublePrecisionRealFieldTypeDescr
924 } /* namespace internal */
926 template <typename LibObjT>
927 class CommonStringField final : public CommonField<LibObjT>
930 using typename CommonField<LibObjT>::_LibObjPtr;
931 using typename CommonField<LibObjT>::_ThisCommonField;
934 using Value = const char *;
936 explicit CommonStringField(const _LibObjPtr libObjPtr) noexcept : _ThisCommonField {libObjPtr}
938 BT_ASSERT_DBG(this->isString());
941 template <typename OtherLibObjT>
942 CommonStringField(const CommonStringField<OtherLibObjT> val) noexcept : _ThisCommonField {val}
946 template <typename OtherLibObjT>
947 CommonStringField<LibObjT> operator=(const CommonStringField<OtherLibObjT> val) noexcept
949 _ThisCommonField::operator=(val);
953 CommonStringField<const bt_field> asConst() const noexcept
955 return CommonStringField<const bt_field> {*this};
958 RawStringValueProxy<CommonStringField> operator*() const noexcept
960 return RawStringValueProxy<CommonStringField> {*this};
963 void value(const char * const val) const
965 static_assert(!std::is_const<LibObjT>::value,
966 "Not available with `bt2::ConstStringField`.");
968 const auto status = bt_field_string_set_value(this->libObjPtr(), val);
970 if (status == BT_FIELD_STRING_SET_VALUE_STATUS_MEMORY_ERROR) {
971 throw MemoryError {};
975 void value(const std::string& val) const
977 this->value(val.data());
980 void append(const char * const begin, const std::uint64_t len) const
982 static_assert(!std::is_const<LibObjT>::value,
983 "Not available with `bt2::ConstStringField`.");
985 const auto status = bt_field_string_append_with_length(this->libObjPtr(), begin, len);
987 if (status == BT_FIELD_STRING_APPEND_STATUS_MEMORY_ERROR) {
988 throw MemoryError {};
992 void append(const std::string& val) const
994 this->append(val.data(), val.size());
997 void clear() const noexcept
999 static_assert(!std::is_const<LibObjT>::value,
1000 "Not available with `bt2::ConstStringField`.");
1002 bt_field_string_clear(this->libObjPtr());
1005 const char *value() const noexcept
1007 return bt_field_string_get_value(this->libObjPtr());
1011 using StringField = CommonStringField<bt_field>;
1012 using ConstStringField = CommonStringField<const bt_field>;
1014 namespace internal {
1016 struct StringFieldTypeDescr
1018 using Const = ConstStringField;
1019 using NonConst = StringField;
1023 struct TypeDescr<StringField> : public StringFieldTypeDescr
1028 struct TypeDescr<ConstStringField> : public StringFieldTypeDescr
1032 template <typename LibObjT>
1033 struct CommonStructureFieldSpec;
1035 /* Functions specific to mutable structure fields */
1037 struct CommonStructureFieldSpec<bt_field> final
1039 static bt_field *memberFieldByIndex(bt_field * const libObjPtr,
1040 const std::uint64_t index) noexcept
1042 return bt_field_structure_borrow_member_field_by_index(libObjPtr, index);
1045 static bt_field *memberFieldByName(bt_field * const libObjPtr, const char * const name) noexcept
1047 return bt_field_structure_borrow_member_field_by_name(libObjPtr, name);
1051 /* Functions specific to constant structure fields */
1053 struct CommonStructureFieldSpec<const bt_field> final
1055 static const bt_field *memberFieldByIndex(const bt_field * const libObjPtr,
1056 const std::uint64_t index) noexcept
1058 return bt_field_structure_borrow_member_field_by_index_const(libObjPtr, index);
1061 static const bt_field *memberFieldByName(const bt_field * const libObjPtr,
1062 const char * const name) noexcept
1064 return bt_field_structure_borrow_member_field_by_name_const(libObjPtr, name);
1068 } /* namespace internal */
1070 template <typename LibObjT>
1071 class CommonStructureField final : public CommonField<LibObjT>
1074 using typename CommonField<LibObjT>::_LibObjPtr;
1075 using typename CommonField<LibObjT>::_ThisCommonField;
1076 using _Spec = internal::CommonStructureFieldSpec<LibObjT>;
1079 using Class = internal::DepType<LibObjT, StructureFieldClass, ConstStructureFieldClass>;
1081 explicit CommonStructureField(const _LibObjPtr libObjPtr) noexcept :
1082 _ThisCommonField {libObjPtr}
1084 BT_ASSERT_DBG(this->isStructure());
1087 template <typename OtherLibObjT>
1088 CommonStructureField(const CommonStructureField<OtherLibObjT> val) noexcept :
1089 _ThisCommonField {val}
1093 template <typename OtherLibObjT>
1094 CommonStructureField<LibObjT> operator=(const CommonStructureField<OtherLibObjT> val) noexcept
1096 _ThisCommonField::operator=(val);
1100 CommonStructureField<const bt_field> asConst() const noexcept
1102 return CommonStructureField<const bt_field> {*this};
1105 Class cls() const noexcept
1107 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
1110 std::uint64_t length() const noexcept
1112 return this->cls().length();
1115 CommonField<LibObjT> operator[](const std::uint64_t index) const noexcept
1117 return CommonField<LibObjT> {_Spec::memberFieldByIndex(this->libObjPtr(), index)};
1120 nonstd::optional<CommonField<LibObjT>> operator[](const char * const name) const noexcept
1122 const auto libObjPtr = _Spec::memberFieldByName(this->libObjPtr(), name);
1125 return CommonField<LibObjT> {libObjPtr};
1128 return nonstd::nullopt;
1131 nonstd::optional<CommonField<LibObjT>> operator[](const std::string& name) const noexcept
1133 return (*this)[name.data()];
1137 using StructureField = CommonStructureField<bt_field>;
1138 using ConstStructureField = CommonStructureField<const bt_field>;
1140 namespace internal {
1142 struct StructureFieldTypeDescr
1144 using Const = ConstStructureField;
1145 using NonConst = StructureField;
1149 struct TypeDescr<StructureField> : public StructureFieldTypeDescr
1154 struct TypeDescr<ConstStructureField> : public StructureFieldTypeDescr
1158 template <typename LibObjT>
1159 struct CommonArrayFieldSpec;
1161 /* Functions specific to mutable array fields */
1163 struct CommonArrayFieldSpec<bt_field> final
1165 static bt_field *elementFieldByIndex(bt_field * const libObjPtr,
1166 const std::uint64_t index) noexcept
1168 return bt_field_array_borrow_element_field_by_index(libObjPtr, index);
1172 /* Functions specific to constant array fields */
1174 struct CommonArrayFieldSpec<const bt_field> final
1176 static const bt_field *elementFieldByIndex(const bt_field * const libObjPtr,
1177 const std::uint64_t index) noexcept
1179 return bt_field_array_borrow_element_field_by_index_const(libObjPtr, index);
1183 } /* namespace internal */
1185 template <typename LibObjT>
1186 class CommonArrayField : public CommonField<LibObjT>
1189 using typename CommonField<LibObjT>::_ThisCommonField;
1190 using _Spec = internal::CommonArrayFieldSpec<LibObjT>;
1193 using typename CommonField<LibObjT>::_LibObjPtr;
1194 using _ThisCommonArrayField = CommonArrayField<LibObjT>;
1197 using Class = internal::DepType<LibObjT, ArrayFieldClass, ConstArrayFieldClass>;
1199 explicit CommonArrayField(const _LibObjPtr libObjPtr) noexcept : _ThisCommonField {libObjPtr}
1201 BT_ASSERT_DBG(this->isArray());
1204 template <typename OtherLibObjT>
1205 CommonArrayField(const CommonArrayField<OtherLibObjT> val) noexcept : _ThisCommonField {val}
1209 template <typename OtherLibObjT>
1210 _ThisCommonArrayField operator=(const CommonArrayField<OtherLibObjT> val) noexcept
1212 _ThisCommonField::operator=(val);
1216 CommonArrayField<const bt_field> asConst() const noexcept
1218 return CommonArrayField<const bt_field> {*this};
1221 Class cls() const noexcept
1223 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
1226 std::uint64_t length() const noexcept
1228 return bt_field_array_get_length(this->libObjPtr());
1231 CommonField<LibObjT> operator[](const std::uint64_t index) const noexcept
1233 return CommonField<LibObjT> {_Spec::elementFieldByIndex(this->libObjPtr(), index)};
1237 using ArrayField = CommonArrayField<bt_field>;
1238 using ConstArrayField = CommonArrayField<const bt_field>;
1240 namespace internal {
1242 struct ArrayFieldTypeDescr
1244 using Const = ConstArrayField;
1245 using NonConst = ArrayField;
1249 struct TypeDescr<ArrayField> : public ArrayFieldTypeDescr
1254 struct TypeDescr<ConstArrayField> : public ArrayFieldTypeDescr
1258 } /* namespace internal */
1260 template <typename LibObjT>
1261 class CommonDynamicArrayField : public CommonArrayField<LibObjT>
1264 using typename CommonField<LibObjT>::_LibObjPtr;
1265 using typename CommonArrayField<LibObjT>::_ThisCommonArrayField;
1268 explicit CommonDynamicArrayField(const _LibObjPtr libObjPtr) noexcept :
1269 _ThisCommonArrayField {libObjPtr}
1271 BT_ASSERT_DBG(this->isDynamicArray());
1274 template <typename OtherLibObjT>
1275 CommonDynamicArrayField(const CommonDynamicArrayField<OtherLibObjT> val) noexcept :
1276 _ThisCommonArrayField {val}
1280 template <typename OtherLibObjT>
1281 CommonDynamicArrayField<LibObjT>
1282 operator=(const CommonDynamicArrayField<OtherLibObjT> val) noexcept
1284 _ThisCommonArrayField::operator=(val);
1288 CommonDynamicArrayField<const bt_field> asConst() const noexcept
1290 return CommonDynamicArrayField<const bt_field> {*this};
1293 std::uint64_t length() const noexcept
1295 return _ThisCommonArrayField::length();
1298 void length(const std::uint64_t length) const
1300 static_assert(!std::is_const<LibObjT>::value,
1301 "Not available with `bt2::ConstDynamicArrayField`.");
1303 const auto status = bt_field_array_dynamic_set_length(this->libObjPtr(), length);
1305 if (status == BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_MEMORY_ERROR) {
1306 throw MemoryError {};
1311 using DynamicArrayField = CommonDynamicArrayField<bt_field>;
1312 using ConstDynamicArrayField = CommonDynamicArrayField<const bt_field>;
1314 namespace internal {
1316 struct DynamicArrayFieldTypeDescr
1318 using Const = ConstDynamicArrayField;
1319 using NonConst = DynamicArrayField;
1323 struct TypeDescr<DynamicArrayField> : public DynamicArrayFieldTypeDescr
1328 struct TypeDescr<ConstDynamicArrayField> : public DynamicArrayFieldTypeDescr
1332 template <typename LibObjT>
1333 struct CommonOptionFieldSpec;
1335 /* Functions specific to mutable option fields */
1337 struct CommonOptionFieldSpec<bt_field> final
1339 static bt_field *field(bt_field * const libObjPtr) noexcept
1341 return bt_field_option_borrow_field(libObjPtr);
1345 /* Functions specific to constant option fields */
1347 struct CommonOptionFieldSpec<const bt_field> final
1349 static const bt_field *field(const bt_field * const libObjPtr) noexcept
1351 return bt_field_option_borrow_field_const(libObjPtr);
1355 } /* namespace internal */
1357 template <typename LibObjT>
1358 class CommonOptionField : public CommonField<LibObjT>
1361 using typename CommonField<LibObjT>::_LibObjPtr;
1362 using typename CommonField<LibObjT>::_ThisCommonField;
1363 using _Spec = internal::CommonOptionFieldSpec<LibObjT>;
1366 using Class = internal::DepType<LibObjT, OptionFieldClass, ConstOptionFieldClass>;
1368 explicit CommonOptionField(const _LibObjPtr libObjPtr) noexcept : _ThisCommonField {libObjPtr}
1370 BT_ASSERT_DBG(this->isOption());
1373 template <typename OtherLibObjT>
1374 CommonOptionField(const CommonOptionField<OtherLibObjT> val) noexcept : _ThisCommonField {val}
1378 template <typename OtherLibObjT>
1379 CommonOptionField<LibObjT> operator=(const CommonOptionField<OtherLibObjT> val) noexcept
1381 _ThisCommonField::operator=(val);
1385 CommonOptionField<const bt_field> asConst() const noexcept
1387 return CommonOptionField<const bt_field> {*this};
1390 Class cls() const noexcept
1392 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
1395 void hasField(const bool hasField) const noexcept
1397 static_assert(!std::is_const<LibObjT>::value,
1398 "Not available with `bt2::ConstOptionField`.");
1400 bt_field_option_set_has_field(this->libObjPtr(), static_cast<bt_bool>(hasField));
1403 bool hasField() const noexcept
1405 return this->field().has_value();
1408 nonstd::optional<CommonField<LibObjT>> field() const noexcept
1410 const auto libObjPtr = _Spec::field(this->libObjPtr());
1413 return CommonField<LibObjT> {libObjPtr};
1416 return nonstd::nullopt;
1420 using OptionField = CommonOptionField<bt_field>;
1421 using ConstOptionField = CommonOptionField<const bt_field>;
1423 namespace internal {
1425 struct OptionFieldTypeDescr
1427 using Const = ConstOptionField;
1428 using NonConst = OptionField;
1432 struct TypeDescr<OptionField> : public OptionFieldTypeDescr
1437 struct TypeDescr<ConstOptionField> : public OptionFieldTypeDescr
1441 template <typename LibObjT>
1442 struct CommonVariantFieldSpec;
1444 /* Functions specific to mutable variant fields */
1446 struct CommonVariantFieldSpec<bt_field> final
1448 static bt_field *selectedOptionField(bt_field * const libObjPtr) noexcept
1450 return bt_field_variant_borrow_selected_option_field(libObjPtr);
1454 /* Functions specific to constant variant fields */
1456 struct CommonVariantFieldSpec<const bt_field> final
1458 static const bt_field *selectedOptionField(const bt_field * const libObjPtr) noexcept
1460 return bt_field_variant_borrow_selected_option_field_const(libObjPtr);
1464 } /* namespace internal */
1466 template <typename LibObjT>
1467 class CommonVariantField : public CommonField<LibObjT>
1470 using typename CommonField<LibObjT>::_LibObjPtr;
1471 using typename CommonField<LibObjT>::_ThisCommonField;
1472 using _Spec = internal::CommonVariantFieldSpec<LibObjT>;
1475 using Class = internal::DepType<LibObjT, VariantFieldClass, ConstVariantFieldClass>;
1477 explicit CommonVariantField(const _LibObjPtr libObjPtr) noexcept : _ThisCommonField {libObjPtr}
1479 BT_ASSERT_DBG(this->isVariant());
1482 template <typename OtherLibObjT>
1483 CommonVariantField(const CommonVariantField<OtherLibObjT> val) noexcept : _ThisCommonField {val}
1487 template <typename OtherLibObjT>
1488 CommonVariantField<LibObjT> operator=(const CommonVariantField<OtherLibObjT> val) noexcept
1490 _ThisCommonField::operator=(val);
1494 CommonVariantField<const bt_field> asConst() const noexcept
1496 return CommonVariantField<const bt_field> {*this};
1499 Class cls() const noexcept
1501 return Class {internal::CommonFieldSpec<LibObjT>::cls(this->libObjPtr())};
1504 void selectOption(const std::uint64_t index) const noexcept
1506 static_assert(!std::is_const<LibObjT>::value,
1507 "Not available with `bt2::ConstVariantField`.");
1509 static_cast<void>(bt_field_variant_select_option_by_index(this->libObjPtr(), index));
1512 CommonField<LibObjT> selectedOptionField() const noexcept
1514 return CommonField<LibObjT> {_Spec::selectedOptionField(this->libObjPtr())};
1517 std::uint64_t selectedOptionIndex() const noexcept
1519 return bt_field_variant_get_selected_option_index(this->libObjPtr());
1523 using VariantField = CommonVariantField<bt_field>;
1524 using ConstVariantField = CommonVariantField<const bt_field>;
1526 namespace internal {
1528 struct VariantFieldTypeDescr
1530 using Const = ConstVariantField;
1531 using NonConst = VariantField;
1535 struct TypeDescr<VariantField> : public VariantFieldTypeDescr
1540 struct TypeDescr<ConstVariantField> : public VariantFieldTypeDescr
1544 } /* namespace internal */
1546 template <typename LibObjT>
1547 CommonBoolField<LibObjT> CommonField<LibObjT>::asBool() const noexcept
1549 BT_ASSERT_DBG(this->isBool());
1550 return CommonBoolField<LibObjT> {this->libObjPtr()};
1553 template <typename LibObjT>
1554 CommonBitArrayField<LibObjT> CommonField<LibObjT>::asBitArray() const noexcept
1556 BT_ASSERT_DBG(this->isBitArray());
1557 return CommonBitArrayField<LibObjT> {this->libObjPtr()};
1560 template <typename LibObjT>
1561 CommonUnsignedIntegerField<LibObjT> CommonField<LibObjT>::asUnsignedInteger() const noexcept
1563 BT_ASSERT_DBG(this->isUnsignedInteger());
1564 return CommonUnsignedIntegerField<LibObjT> {this->libObjPtr()};
1567 template <typename LibObjT>
1568 CommonSignedIntegerField<LibObjT> CommonField<LibObjT>::asSignedInteger() const noexcept
1570 BT_ASSERT_DBG(this->isSignedInteger());
1571 return CommonSignedIntegerField<LibObjT> {this->libObjPtr()};
1574 template <typename LibObjT>
1575 CommonUnsignedEnumerationField<LibObjT> CommonField<LibObjT>::asUnsignedEnumeration() const noexcept
1577 BT_ASSERT_DBG(this->isUnsignedEnumeration());
1578 return CommonUnsignedEnumerationField<LibObjT> {this->libObjPtr()};
1581 template <typename LibObjT>
1582 CommonSignedEnumerationField<LibObjT> CommonField<LibObjT>::asSignedEnumeration() const noexcept
1584 BT_ASSERT_DBG(this->isSignedEnumeration());
1585 return CommonSignedEnumerationField<LibObjT> {this->libObjPtr()};
1588 template <typename LibObjT>
1589 CommonSinglePrecisionRealField<LibObjT> CommonField<LibObjT>::asSinglePrecisionReal() const noexcept
1591 BT_ASSERT_DBG(this->isSinglePrecisionReal());
1592 return CommonSinglePrecisionRealField<LibObjT> {this->libObjPtr()};
1595 template <typename LibObjT>
1596 CommonDoublePrecisionRealField<LibObjT> CommonField<LibObjT>::asDoublePrecisionReal() const noexcept
1598 BT_ASSERT_DBG(this->isDoublePrecisionReal());
1599 return CommonDoublePrecisionRealField<LibObjT> {this->libObjPtr()};
1602 template <typename LibObjT>
1603 CommonStringField<LibObjT> CommonField<LibObjT>::asString() const noexcept
1605 BT_ASSERT_DBG(this->isString());
1606 return CommonStringField<LibObjT> {this->libObjPtr()};
1609 template <typename LibObjT>
1610 CommonStructureField<LibObjT> CommonField<LibObjT>::asStructure() const noexcept
1612 BT_ASSERT_DBG(this->isStructure());
1613 return CommonStructureField<LibObjT> {this->libObjPtr()};
1616 template <typename LibObjT>
1617 CommonArrayField<LibObjT> CommonField<LibObjT>::asArray() const noexcept
1619 BT_ASSERT_DBG(this->isArray());
1620 return CommonArrayField<LibObjT> {this->libObjPtr()};
1623 template <typename LibObjT>
1624 CommonDynamicArrayField<LibObjT> CommonField<LibObjT>::asDynamicArray() const noexcept
1626 BT_ASSERT_DBG(this->isDynamicArray());
1627 return CommonDynamicArrayField<LibObjT> {this->libObjPtr()};
1630 template <typename LibObjT>
1631 CommonOptionField<LibObjT> CommonField<LibObjT>::asOption() const noexcept
1633 BT_ASSERT_DBG(this->isOption());
1634 return CommonOptionField<LibObjT> {this->libObjPtr()};
1637 template <typename LibObjT>
1638 CommonVariantField<LibObjT> CommonField<LibObjT>::asVariant() const noexcept
1640 BT_ASSERT_DBG(this->isVariant());
1641 return CommonVariantField<LibObjT> {this->libObjPtr()};
1644 } /* namespace bt2 */
1646 #endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_HPP */