field-class.hpp: support optional variant FC option name
[babeltrace.git] / src / cpp-common / bt2 / field-class.hpp
CommitLineData
12435a68
PP
1/*
2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
3 *
4 * SPDX-License-Identifier: MIT
5 */
6
7#ifndef BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
8#define BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
9
10#include <type_traits>
11#include <cstdint>
12#include <babeltrace2/babeltrace.h>
13
14#include "common/assert.h"
15#include "internal/borrowed-obj.hpp"
16#include "internal/shared-obj.hpp"
4927bae7 17#include "internal/utils.hpp"
12435a68
PP
18#include "cpp-common/optional.hpp"
19#include "cpp-common/string_view.hpp"
5046c776 20#include "common-iter.hpp"
12435a68
PP
21#include "lib-error.hpp"
22#include "integer-range-set.hpp"
23#include "field-path.hpp"
096c6be7 24#include "value.hpp"
12435a68
PP
25
26namespace bt2 {
12435a68
PP
27namespace internal {
28
29struct FieldClassRefFuncs final
30{
31 static void get(const bt_field_class * const libObjPtr)
32 {
33 bt_field_class_get_ref(libObjPtr);
34 }
35
36 static void put(const bt_field_class * const libObjPtr)
37 {
38 bt_field_class_put_ref(libObjPtr);
39 }
40};
41
42template <typename ObjT, typename LibObjT>
43using SharedFieldClass = internal::SharedObj<ObjT, LibObjT, internal::FieldClassRefFuncs>;
44
45template <typename LibObjT>
46struct CommonFieldClassSpec;
47
b5f55e9f 48/* Functions specific to mutable field classes */
12435a68
PP
49template <>
50struct CommonFieldClassSpec<bt_field_class> final
51{
52 static bt_value *userAttributes(bt_field_class * const libObjPtr) noexcept
53 {
54 return bt_field_class_borrow_user_attributes(libObjPtr);
55 }
56};
57
b5f55e9f 58/* Functions specific to constant field classes */
12435a68
PP
59template <>
60struct CommonFieldClassSpec<const bt_field_class> final
61{
62 static const bt_value *userAttributes(const bt_field_class * const libObjPtr) noexcept
63 {
64 return bt_field_class_borrow_user_attributes_const(libObjPtr);
65 }
66};
67
b5f55e9f 68} /* namespace internal */
12435a68
PP
69
70template <typename LibObjT>
71class CommonBitArrayFieldClass;
72
73template <typename LibObjT>
74class CommonIntegerFieldClass;
75
76template <typename LibObjT>
77class ConstEnumerationFieldClassMapping;
78
be6aa636
FD
79template <typename LibObjT>
80class CommonBaseEnumerationFieldClass;
81
12435a68
PP
82template <typename LibObjT, typename MappingT>
83class CommonEnumerationFieldClass;
84
85template <typename LibObjT>
86class CommonStructureFieldClass;
87
88template <typename LibObjT>
89class CommonArrayFieldClass;
90
91template <typename LibObjT>
92class CommonStaticArrayFieldClass;
93
94template <typename LibObjT>
95class CommonDynamicArrayWithLengthFieldClass;
96
97template <typename LibObjT>
98class CommonOptionFieldClass;
99
100template <typename LibObjT>
101class CommonOptionWithSelectorFieldClass;
102
103template <typename LibObjT>
104class CommonOptionWithBoolSelectorFieldClass;
105
106template <typename LibObjT>
107class CommonVariantFieldClass;
108
109template <typename LibObjT, typename RangeSetT>
110class CommonOptionWithIntegerSelectorFieldClass;
111
112template <typename LibObjT>
113class CommonVariantWithoutSelectorFieldClass;
114
cefe03a2
FD
115template <typename LibObjT>
116class CommonVariantWithSelectorFieldClass;
117
12435a68
PP
118template <typename LibObjT>
119class ConstVariantWithIntegerSelectorFieldClassOption;
120
121template <typename LibObjT, typename RangeSetT>
122class CommonVariantWithIntegerSelectorFieldClass;
123
74fc764d
PP
124template <typename LibObjT>
125class CommonEventClass;
126
127template <typename LibObjT>
128class CommonStreamClass;
129
130template <typename LibObjT>
131class CommonTraceClass;
132
12435a68
PP
133enum class FieldClassType
134{
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,
159};
160
161template <typename LibObjT>
162class CommonFieldClass : public internal::BorrowedObj<LibObjT>
163{
341a67c4 164 /* Allow appendMember() to call `fc.libObjPtr()` */
12435a68
PP
165 friend class CommonStructureFieldClass<bt_field_class>;
166
341a67c4 167 /* Allow appendOption() to call `fc.libObjPtr()` */
12435a68
PP
168 friend class CommonVariantWithoutSelectorFieldClass<bt_field_class>;
169
170 friend class CommonVariantWithIntegerSelectorFieldClass<
171 bt_field_class,
172 ConstVariantWithIntegerSelectorFieldClassOption<
173 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>;
174
175 friend class CommonVariantWithIntegerSelectorFieldClass<
176 bt_field_class,
177 ConstVariantWithIntegerSelectorFieldClassOption<
178 const bt_field_class_variant_with_selector_field_integer_signed_option>>;
179
341a67c4 180 /* Allow *FieldClass() to call `fc.libObjPtr()` */
74fc764d
PP
181 friend class CommonEventClass<bt_event_class>;
182 friend class CommonStreamClass<bt_stream_class>;
183
341a67c4 184 /* Allow create*FieldClass() to call `fc.libObjPtr()` */
74fc764d
PP
185 friend class CommonTraceClass<bt_trace_class>;
186
12435a68
PP
187private:
188 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
189
190protected:
191 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
192 using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;
193
194public:
195 using Shared = internal::SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
196
197 using UserAttributes =
198 typename std::conditional<std::is_const<LibObjT>::value, ConstMapValue, MapValue>::type;
199
200 explicit CommonFieldClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObj {libObjPtr}
201 {
202 }
203
204 template <typename OtherLibObjT>
205 CommonFieldClass(const CommonFieldClass<OtherLibObjT>& fc) noexcept : _ThisBorrowedObj {fc}
206 {
207 }
208
209 template <typename OtherLibObjT>
0d6ad4d8 210 CommonFieldClass& operator=(const CommonFieldClass<OtherLibObjT>& fc) noexcept
12435a68
PP
211 {
212 _ThisBorrowedObj::operator=(fc);
213 return *this;
214 }
215
216 FieldClassType type() const noexcept
217 {
341a67c4 218 return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
12435a68
PP
219 }
220
221 bool isBool() const noexcept
222 {
223 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
224 }
225
226 bool isBitArray() const noexcept
227 {
228 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
229 }
230
231 bool isInteger() const noexcept
232 {
233 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
234 }
235
236 bool isUnsignedInteger() const noexcept
237 {
238 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
239 }
240
241 bool isSignedInteger() const noexcept
242 {
243 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
244 }
245
246 bool isEnumeration() const noexcept
247 {
248 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
249 }
250
251 bool isUnsignedEnumeration() const noexcept
252 {
253 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
254 }
255
256 bool isSignedEnumeration() const noexcept
257 {
258 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
259 }
260
ff620936
FD
261 bool isReal() const noexcept
262 {
263 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
264 }
265
12435a68
PP
266 bool isSinglePrecisionReal() const noexcept
267 {
268 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
269 }
270
271 bool isDoublePrecisionReal() const noexcept
272 {
273 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
274 }
275
276 bool isString() const noexcept
277 {
278 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
279 }
280
281 bool isStructure() const noexcept
282 {
283 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
284 }
285
286 bool isArray() const noexcept
287 {
288 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
289 }
290
291 bool isStaticArray() const noexcept
292 {
293 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
294 }
295
296 bool isDynamicArray() const noexcept
297 {
298 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
299 }
300
301 bool isDynamicArrayWithoutLength() const noexcept
302 {
303 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
304 }
305
306 bool isDynamicArrayWithLength() const noexcept
307 {
308 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
309 }
310
311 bool isOption() const noexcept
312 {
313 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
314 }
315
316 bool isOptionWithoutSelector() const noexcept
317 {
318 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
319 }
320
321 bool isOptionWithSelector() const noexcept
322 {
323 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
324 }
325
326 bool isOptionWithBoolSelector() const noexcept
327 {
328 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
329 }
330
331 bool isOptionWithIntegerSelector() const noexcept
332 {
333 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
334 }
335
336 bool isOptionWithUnsignedIntegerSelector() const noexcept
337 {
338 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
339 }
340
341 bool isOptionWithSignedIntegerSelector() const noexcept
342 {
343 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
344 }
345
346 bool isVariant() const noexcept
347 {
348 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
349 }
350
351 bool isVariantWithoutSelector() const noexcept
352 {
353 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
354 }
355
356 bool isVariantWithSelector() const noexcept
357 {
358 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
359 }
360
361 bool isVariantWithIntegerSelector() const noexcept
362 {
363 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
364 }
365
366 bool isVariantWithUnsignedIntegerSelector() const noexcept
367 {
368 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
369 }
370
371 bool isVariantWithSignedIntegerSelector() const noexcept
372 {
373 return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
374 }
375
376 CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
377 CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
be6aa636 378 CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
12435a68
PP
379 CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
380 const bt_field_class_enumeration_unsigned_mapping>>
381 asUnsignedEnumeration() const noexcept;
382
383 CommonEnumerationFieldClass<
384 LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
385 asSignedEnumeration() const noexcept;
386
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;
394
395 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
396 asOptionWithUnsignedIntegerSelector() const noexcept;
397
398 CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
399 asOptionWithSignedIntegerSelector() const noexcept;
400
401 CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
402 CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
cefe03a2 403 CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;
12435a68
PP
404
405 CommonVariantWithIntegerSelectorFieldClass<
406 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
407 const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
408 asVariantWithUnsignedIntegerSelector() const noexcept;
409
410 CommonVariantWithIntegerSelectorFieldClass<
411 LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
412 const bt_field_class_variant_with_selector_field_integer_signed_option>>
413 asVariantWithSignedIntegerSelector() const noexcept;
414
415 template <typename LibValT>
416 void userAttributes(const CommonMapValue<LibValT>& userAttrs)
417 {
418 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
419
341a67c4 420 bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
12435a68
PP
421 }
422
423 ConstMapValue userAttributes() const noexcept
424 {
425 return ConstMapValue {internal::CommonFieldClassSpec<const bt_field_class>::userAttributes(
341a67c4 426 this->libObjPtr())};
12435a68
PP
427 }
428
429 UserAttributes userAttributes() noexcept
430 {
431 return UserAttributes {
341a67c4 432 internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
12435a68
PP
433 }
434
435 Shared shared() const noexcept
436 {
c9c0b6e2 437 return Shared::createWithRef(*this);
12435a68
PP
438 }
439
440protected:
441 bool _libTypeIs(const bt_field_class_type type) const noexcept
442 {
341a67c4 443 return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
12435a68
PP
444 }
445};
446
447using FieldClass = CommonFieldClass<bt_field_class>;
448using ConstFieldClass = CommonFieldClass<const bt_field_class>;
449
4927bae7
PP
450namespace internal {
451
452struct FieldClassTypeDescr
453{
454 using Const = ConstFieldClass;
455 using NonConst = FieldClass;
456};
457
458template <>
459struct TypeDescr<FieldClass> : public FieldClassTypeDescr
460{
461};
462
463template <>
464struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
465{
466};
467
468} /* namespace internal */
469
12435a68
PP
470template <typename LibObjT>
471class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
472{
473private:
474 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
475 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
476
477public:
478 using Shared = internal::SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;
479
480 explicit CommonBitArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
481 _ThisCommonFieldClass {libObjPtr}
482 {
483 BT_ASSERT_DBG(this->isBitArray());
484 }
485
486 template <typename OtherLibObjT>
487 CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept :
488 _ThisCommonFieldClass {fc}
489 {
490 }
491
492 template <typename OtherLibObjT>
493 CommonBitArrayFieldClass<LibObjT>&
494 operator=(const CommonBitArrayFieldClass<OtherLibObjT>& fc) noexcept
495 {
496 _ThisCommonFieldClass::operator=(fc);
497 return *this;
498 }
499
500 std::uint64_t length() const noexcept
501 {
341a67c4 502 return bt_field_class_bit_array_get_length(this->libObjPtr());
12435a68
PP
503 }
504
505 Shared shared() const noexcept
506 {
c9c0b6e2 507 return Shared::createWithRef(*this);
12435a68
PP
508 }
509};
510
511using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
512using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;
513
4927bae7
PP
514namespace internal {
515
516struct BitArrayFieldClassTypeDescr
517{
518 using Const = ConstBitArrayFieldClass;
519 using NonConst = BitArrayFieldClass;
520};
521
522template <>
523struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
524{
525};
526
527template <>
528struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
529{
530};
531
532} /* namespace internal */
533
12435a68
PP
534enum class DisplayBase
535{
536 BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
537 OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
538 DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
539 HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
540};
541
542template <typename LibObjT>
543class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
544{
545private:
546 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
547
548protected:
549 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
550 using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;
551
552public:
553 using Shared = internal::SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;
554
555 explicit CommonIntegerFieldClass(const _LibObjPtr libObjPtr) noexcept :
556 _ThisCommonFieldClass {libObjPtr}
557 {
558 BT_ASSERT_DBG(this->isInteger());
559 }
560
561 template <typename OtherLibObjT>
562 CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept :
563 _ThisCommonFieldClass {fc}
564 {
565 }
566
567 template <typename OtherLibObjT>
0d6ad4d8 568 CommonIntegerFieldClass& operator=(const CommonIntegerFieldClass<OtherLibObjT>& fc) noexcept
12435a68
PP
569 {
570 _ThisCommonFieldClass::operator=(fc);
571 return *this;
572 }
573
574 void fieldValueRange(const std::uint64_t n) noexcept
575 {
576 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
577
78017fef 578 bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
12435a68
PP
579 }
580
581 std::uint64_t fieldValueRange() const noexcept
582 {
341a67c4 583 return bt_field_class_integer_get_field_value_range(this->libObjPtr());
12435a68
PP
584 }
585
586 void preferredDisplayBase(const DisplayBase base) noexcept
587 {
588 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
589
590 bt_field_class_integer_set_preferred_display_base(
341a67c4 591 this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
12435a68
PP
592 }
593
594 DisplayBase preferredDisplayBase() const noexcept
595 {
596 return static_cast<DisplayBase>(
341a67c4 597 bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
12435a68
PP
598 }
599
600 Shared shared() const noexcept
601 {
c9c0b6e2 602 return Shared::createWithRef(*this);
12435a68
PP
603 }
604};
605
606using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
607using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;
608
609namespace internal {
610
4927bae7
PP
611struct IntegerFieldClassTypeDescr
612{
613 using Const = ConstIntegerFieldClass;
614 using NonConst = IntegerFieldClass;
615};
616
617template <>
618struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
619{
620};
621
622template <>
623struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
624{
625};
626
627} /* namespace internal */
628
629namespace internal {
630
12435a68
PP
631template <typename LibObjT>
632struct ConstEnumerationFieldClassMappingSpec;
633
b5f55e9f 634/* Functions specific to unsigned enumeration field class mappings */
12435a68
PP
635template <>
636struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
637 final
638{
639 static const bt_integer_range_set_unsigned *
640 ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
641 {
642 return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
643 }
644
645 static const char *
646 label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
647 {
648 return bt_field_class_enumeration_mapping_get_label(
649 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
650 }
651};
652
b5f55e9f 653/* Functions specific to signed enumeration field class mappings */
12435a68
PP
654template <>
655struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
656{
657 static const bt_integer_range_set_signed *
658 ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
659 {
660 return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
661 }
662
663 static const char *
664 label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
665 {
666 return bt_field_class_enumeration_mapping_get_label(
667 bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
668 }
669};
670
b5f55e9f 671} /* namespace internal */
12435a68
PP
672
673template <typename LibObjT>
674class ConstEnumerationFieldClassMapping final : public internal::BorrowedObj<LibObjT>
675{
676private:
677 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
678 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
12435a68
PP
679
680public:
681 using RangeSet = typename std::conditional<
682 std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
683 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
684
685 explicit ConstEnumerationFieldClassMapping(const _LibObjPtr libObjPtr) noexcept :
686 _ThisBorrowedObj {libObjPtr}
687 {
688 }
689
0d6ad4d8 690 ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
12435a68
PP
691 _ThisBorrowedObj {mapping}
692 {
693 }
694
0d6ad4d8
FD
695 ConstEnumerationFieldClassMapping&
696 operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
12435a68
PP
697 {
698 _ThisBorrowedObj::operator=(mapping);
699 return *this;
700 }
701
702 RangeSet ranges() const noexcept
703 {
704 return RangeSet {
341a67c4 705 internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
12435a68
PP
706 }
707
708 bpstd::string_view label() const noexcept
709 {
341a67c4 710 return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
12435a68
PP
711 }
712};
713
714using ConstUnsignedEnumerationFieldClassMapping =
715 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;
716
717using ConstSignedEnumerationFieldClassMapping =
718 ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;
719
720namespace internal {
721
722template <typename MappingT>
723struct CommonEnumerationFieldClassSpec;
724
b5f55e9f 725/* Functions specific to unsigned enumeration field classes */
12435a68
PP
726template <>
727struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
728{
729 static const bt_field_class_enumeration_unsigned_mapping *
730 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
731 {
732 return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
733 }
734
735 static const bt_field_class_enumeration_unsigned_mapping *
736 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
737 {
738 return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
739 }
5d6ccdae
PP
740
741 static bt_field_class_enumeration_add_mapping_status
742 addMapping(bt_field_class * const libObjPtr, const char * const label,
743 const bt_integer_range_set_unsigned * const libRanges) noexcept
744 {
745 return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
746 }
12435a68
PP
747};
748
b5f55e9f 749/* Functions specific to signed enumeration field classes */
12435a68
PP
750template <>
751struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
752{
753 static const bt_field_class_enumeration_signed_mapping *
754 mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
755 {
756 return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
757 }
758
759 static const bt_field_class_enumeration_signed_mapping *
760 mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
761 {
762 return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
763 }
5d6ccdae
PP
764
765 static bt_field_class_enumeration_add_mapping_status
766 addMapping(bt_field_class * const libObjPtr, const char * const label,
767 const bt_integer_range_set_signed * const libRanges) noexcept
768 {
769 return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
770 }
12435a68
PP
771};
772
b5f55e9f 773} /* namespace internal */
12435a68 774
be6aa636
FD
775template <typename LibObjT>
776class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
777{
778private:
779 using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;
780
781protected:
782 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
783 using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;
784
785public:
786 using Shared = internal::SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;
787
788 explicit CommonBaseEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
789 _ThisCommonIntegerFieldClass {libObjPtr}
790 {
791 BT_ASSERT_DBG(this->isEnumeration());
792 }
793
794 template <typename OtherLibObjT>
795 CommonBaseEnumerationFieldClass(
796 const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept :
797 _ThisCommonIntegerFieldClass {fc}
798 {
799 }
800
801 template <typename OtherLibObjT>
0d6ad4d8 802 CommonBaseEnumerationFieldClass&
be6aa636
FD
803 operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT>& fc) noexcept
804 {
805 _ThisCommonIntegerFieldClass::operator=(fc);
806 return *this;
807 }
808
809 std::uint64_t size() const noexcept
810 {
341a67c4 811 return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
be6aa636
FD
812 }
813
814 Shared shared() const noexcept
815 {
c9c0b6e2 816 return Shared::createWithRef(*this);
be6aa636
FD
817 }
818};
819
12435a68 820template <typename LibObjT, typename MappingT>
be6aa636 821class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
12435a68
PP
822{
823private:
824 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
be6aa636 825 using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;
12435a68
PP
826 using _ThisCommonEnumerationFieldClass = CommonEnumerationFieldClass<LibObjT, MappingT>;
827
828public:
829 using Shared = internal::SharedFieldClass<_ThisCommonEnumerationFieldClass, LibObjT>;
e5a8a7c4 830 using Iterator = CommonIterator<CommonEnumerationFieldClass, MappingT>;
12435a68
PP
831 using Mapping = MappingT;
832
833 explicit CommonEnumerationFieldClass(const _LibObjPtr libObjPtr) noexcept :
be6aa636 834 _ThisCommonBaseEnumerationFieldClass {libObjPtr}
12435a68
PP
835 {
836 BT_ASSERT_DBG(this->isEnumeration());
837 }
838
839 template <typename OtherLibObjT>
840 CommonEnumerationFieldClass(
841 const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept :
be6aa636 842 _ThisCommonEnumerationFieldClass {fc}
12435a68
PP
843 {
844 }
845
846 template <typename OtherLibObjT>
0d6ad4d8 847 CommonEnumerationFieldClass&
12435a68
PP
848 operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT>& fc) noexcept
849 {
be6aa636 850 _ThisCommonEnumerationFieldClass::operator=(fc);
12435a68
PP
851 return *this;
852 }
853
12435a68
PP
854 Mapping operator[](const std::uint64_t index) const noexcept
855 {
856 return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
341a67c4 857 this->libObjPtr(), index)};
12435a68
PP
858 }
859
860 nonstd::optional<Mapping> operator[](const char * const label) const noexcept
861 {
862 const auto libObjPtr = internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
341a67c4 863 this->libObjPtr(), label);
12435a68
PP
864
865 if (libObjPtr) {
866 return Mapping {libObjPtr};
867 }
868
869 return nonstd::nullopt;
870 }
871
872 nonstd::optional<Mapping> operator[](const std::string& label) const noexcept
873 {
874 return (*this)[label.data()];
875 }
876
5d6ccdae
PP
877 void addMapping(const char * const label, const typename Mapping::RangeSet ranges)
878 {
879 const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
880 this->libObjPtr(), label, ranges.libObjPtr());
881
882 if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
883 throw LibMemoryError {};
884 }
885 }
886
887 void addMapping(const std::string& label, const typename Mapping::RangeSet ranges)
888 {
889 this->addMapping(label.data(), ranges);
890 }
891
e5a8a7c4
FD
892 Iterator begin() const noexcept
893 {
894 return Iterator {*this, 0};
895 }
896
897 Iterator end() const noexcept
898 {
899 return Iterator {*this, this->size()};
900 }
901
12435a68
PP
902 Shared shared() const noexcept
903 {
c9c0b6e2 904 return Shared::createWithRef(*this);
12435a68
PP
905 }
906};
907
be6aa636
FD
908using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
909using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;
910
12435a68
PP
911using UnsignedEnumerationFieldClass =
912 CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
913
914using ConstUnsignedEnumerationFieldClass =
915 CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;
916
917using SignedEnumerationFieldClass =
918 CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;
919
920using ConstSignedEnumerationFieldClass =
921 CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;
922
923namespace internal {
924
4927bae7
PP
925struct UnsignedEnumerationFieldClassTypeDescr
926{
927 using Const = ConstUnsignedEnumerationFieldClass;
928 using NonConst = UnsignedEnumerationFieldClass;
929};
930
931template <>
932struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
933{
934};
935
936template <>
937struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
938{
939};
940
941struct SignedEnumerationFieldClassTypeDescr
942{
943 using Const = ConstSignedEnumerationFieldClass;
944 using NonConst = SignedEnumerationFieldClass;
945};
946
947template <>
948struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
949{
950};
951
952template <>
953struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
954{
955};
956
12435a68
PP
957template <typename LibObjT>
958struct CommonStructureFieldClassMemberSpec;
959
b5f55e9f 960/* Functions specific to mutable structure field class members */
12435a68
PP
961template <>
962struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
963{
964 static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
965 {
966 return bt_field_class_structure_member_borrow_field_class(libObjPtr);
967 }
968};
969
b5f55e9f 970/* Functions specific to constant structure field class members */
12435a68
PP
971template <>
972struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
973{
974 static const bt_field_class *
975 fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
976 {
977 return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
978 }
979};
980
b5f55e9f 981} /* namespace internal */
12435a68
PP
982
983template <typename LibObjT>
984class CommonStructureFieldClassMember final : public internal::BorrowedObj<LibObjT>
985{
986private:
987 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
988 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
989
990 using _FieldClass =
991 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
992
993public:
994 explicit CommonStructureFieldClassMember(const _LibObjPtr libObjPtr) noexcept :
995 _ThisBorrowedObj {libObjPtr}
996 {
997 }
998
999 template <typename OtherLibObjT>
1000 CommonStructureFieldClassMember(
1001 const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept :
1002 _ThisBorrowedObj {fc}
1003 {
1004 }
1005
1006 template <typename OtherLibObjT>
1007 CommonStructureFieldClassMember<LibObjT>&
1008 operator=(const CommonStructureFieldClassMember<OtherLibObjT>& fc) noexcept
1009 {
1010 _ThisBorrowedObj::operator=(fc);
1011 return *this;
1012 }
1013
1014 bpstd::string_view name() const noexcept
1015 {
341a67c4 1016 return bt_field_class_structure_member_get_name(this->libObjPtr());
12435a68
PP
1017 }
1018
1019 ConstFieldClass fieldClass() const noexcept
1020 {
1021 return ConstFieldClass {internal::CommonStructureFieldClassMemberSpec<
341a67c4 1022 const bt_field_class_structure_member>::fieldClass(this->libObjPtr())};
12435a68
PP
1023 }
1024
1025 _FieldClass fieldClass() noexcept
1026 {
1027 return _FieldClass {
341a67c4 1028 internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
12435a68
PP
1029 }
1030};
1031
1032using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;
1033
1034using ConstStructureFieldClassMember =
1035 CommonStructureFieldClassMember<const bt_field_class_structure_member>;
1036
1037namespace internal {
1038
4927bae7
PP
1039struct StructureFieldClassMemberTypeDescr
1040{
1041 using Const = ConstStructureFieldClassMember;
1042 using NonConst = StructureFieldClassMember;
1043};
1044
1045template <>
1046struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1047{
1048};
1049
1050template <>
1051struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
1052{
1053};
1054
12435a68
PP
1055template <typename LibObjT>
1056struct CommonStructureFieldClassSpec;
1057
b5f55e9f 1058/* Functions specific to mutable structure field classes */
12435a68
PP
1059template <>
1060struct CommonStructureFieldClassSpec<bt_field_class> final
1061{
1062 static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
1063 const std::uint64_t index) noexcept
1064 {
1065 return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
1066 }
1067
1068 static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
1069 const char * const name) noexcept
1070 {
1071 return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
1072 }
1073};
1074
b5f55e9f 1075/* Functions specific to constant structure field classes */
12435a68
PP
1076template <>
1077struct CommonStructureFieldClassSpec<const bt_field_class> final
1078{
1079 static const bt_field_class_structure_member *
1080 memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
1081 {
1082 return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
1083 }
1084
1085 static const bt_field_class_structure_member *
1086 memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
1087 {
1088 return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
1089 }
1090};
1091
b5f55e9f 1092} /* namespace internal */
12435a68
PP
1093
1094template <typename LibObjT>
1095class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
1096{
1097private:
1098 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1099 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1100
1101public:
1102 using Shared = internal::SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
12435a68
PP
1103 using Member =
1104 typename std::conditional<std::is_const<LibObjT>::value, ConstStructureFieldClassMember,
1105 StructureFieldClassMember>::type;
1106
5046c776
FD
1107 using Iterator = CommonIterator<CommonStructureFieldClass<LibObjT>, Member>;
1108
12435a68
PP
1109 explicit CommonStructureFieldClass(const _LibObjPtr libObjPtr) noexcept :
1110 _ThisCommonFieldClass {libObjPtr}
1111 {
1112 BT_ASSERT_DBG(this->isStructure());
1113 }
1114
1115 template <typename OtherLibObjT>
1116 CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept :
1117 _ThisCommonFieldClass {fc}
1118 {
1119 }
1120
1121 template <typename OtherLibObjT>
0d6ad4d8 1122 CommonStructureFieldClass& operator=(const CommonStructureFieldClass<OtherLibObjT>& fc) noexcept
12435a68
PP
1123 {
1124 _ThisCommonFieldClass::operator=(fc);
1125 return *this;
1126 }
1127
1128 void appendMember(const char * const name, const FieldClass& fc)
1129 {
1130 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
1131
1132 const auto status =
341a67c4 1133 bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());
12435a68
PP
1134
1135 if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
1136 throw LibMemoryError {};
1137 }
1138 }
1139
1140 void appendMember(const std::string& name, const FieldClass& fc)
1141 {
1142 this->appendMember(name.data(), fc);
1143 }
1144
1145 std::uint64_t size() const noexcept
1146 {
341a67c4 1147 return bt_field_class_structure_get_member_count(this->libObjPtr());
12435a68
PP
1148 }
1149
5046c776
FD
1150 Iterator begin() const noexcept
1151 {
1152 return Iterator {*this, 0};
1153 }
1154
1155 Iterator end() const noexcept
1156 {
1157 return Iterator {*this, this->size()};
1158 }
1159
12435a68
PP
1160 ConstStructureFieldClassMember operator[](const std::uint64_t index) const noexcept
1161 {
1162 return ConstStructureFieldClassMember {
1163 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByIndex(
341a67c4 1164 this->libObjPtr(), index)};
12435a68
PP
1165 }
1166
1167 Member operator[](const std::uint64_t index) noexcept
1168 {
1169 return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
341a67c4 1170 this->libObjPtr(), index)};
12435a68
PP
1171 }
1172
1173 nonstd::optional<ConstStructureFieldClassMember>
1174 operator[](const char * const name) const noexcept
1175 {
1176 const auto libObjPtr =
1177 internal::CommonStructureFieldClassSpec<const bt_field_class>::memberByName(
341a67c4 1178 this->libObjPtr(), name);
12435a68
PP
1179
1180 if (libObjPtr) {
1181 return ConstStructureFieldClassMember {libObjPtr};
1182 }
1183
1184 return nonstd::nullopt;
1185 }
1186
1187 nonstd::optional<ConstStructureFieldClassMember>
1188 operator[](const std::string& name) const noexcept
1189 {
1190 return (*this)[name.data()];
1191 }
1192
1193 nonstd::optional<Member> operator[](const char * const name) noexcept
1194 {
341a67c4
FD
1195 const auto libObjPtr =
1196 internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(), name);
12435a68
PP
1197
1198 if (libObjPtr) {
1199 return Member {libObjPtr};
1200 }
1201
1202 return nonstd::nullopt;
1203 }
1204
1205 nonstd::optional<Member> operator[](const std::string& name) noexcept
1206 {
1207 return (*this)[name.data()];
1208 }
1209
1210 Shared shared() const noexcept
1211 {
c9c0b6e2 1212 return Shared::createWithRef(*this);
12435a68
PP
1213 }
1214};
1215
1216using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
1217using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;
1218
1219namespace internal {
1220
4927bae7
PP
1221struct StructureFieldClassTypeDescr
1222{
1223 using Const = ConstStructureFieldClass;
1224 using NonConst = StructureFieldClass;
1225};
1226
1227template <>
1228struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
1229{
1230};
1231
1232template <>
1233struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
1234{
1235};
1236
12435a68
PP
1237template <typename LibObjT>
1238struct CommonArrayFieldClassSpec;
1239
b5f55e9f 1240/* Functions specific to mutable array field classes */
12435a68
PP
1241template <>
1242struct CommonArrayFieldClassSpec<bt_field_class> final
1243{
1244 static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
1245 {
1246 return bt_field_class_array_borrow_element_field_class(libObjPtr);
1247 }
1248};
1249
b5f55e9f 1250/* Functions specific to constant array field classes */
12435a68
PP
1251template <>
1252struct CommonArrayFieldClassSpec<const bt_field_class> final
1253{
1254 static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
1255 {
1256 return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
1257 }
1258};
1259
b5f55e9f 1260} /* namespace internal */
12435a68
PP
1261
1262template <typename LibObjT>
1263class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
1264{
1265private:
1266 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1267
1268 using _FieldClass =
1269 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1270
1271protected:
1272 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1273 using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;
1274
1275public:
1276 using Shared = internal::SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;
1277
1278 explicit CommonArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1279 _ThisCommonFieldClass {libObjPtr}
1280 {
1281 BT_ASSERT_DBG(this->isArray());
1282 }
1283
1284 template <typename OtherLibObjT>
1285 CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept :
1286 _ThisCommonFieldClass {fc}
1287 {
1288 }
1289
1290 template <typename OtherLibObjT>
0d6ad4d8 1291 CommonArrayFieldClass& operator=(const CommonArrayFieldClass<OtherLibObjT>& fc) noexcept
12435a68
PP
1292 {
1293 _ThisCommonFieldClass::operator=(fc);
1294 return *this;
1295 }
1296
1297 ConstFieldClass elementFieldClass() const noexcept
1298 {
1299 return ConstFieldClass {
1300 internal::CommonArrayFieldClassSpec<const bt_field_class>::elementFieldClass(
341a67c4 1301 this->libObjPtr())};
12435a68
PP
1302 }
1303
1304 _FieldClass elementFieldClass() noexcept
1305 {
1306 return _FieldClass {
341a67c4 1307 internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
12435a68
PP
1308 }
1309
1310 Shared shared() const noexcept
1311 {
c9c0b6e2 1312 return Shared::createWithRef(*this);
12435a68
PP
1313 }
1314};
1315
1316using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
1317using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;
1318
4927bae7
PP
1319namespace internal {
1320
1321struct ArrayFieldClassTypeDescr
1322{
1323 using Const = ConstArrayFieldClass;
1324 using NonConst = ArrayFieldClass;
1325};
1326
1327template <>
1328struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
1329{
1330};
1331
1332template <>
1333struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
1334{
1335};
1336
1337} /* namespace internal */
1338
12435a68
PP
1339template <typename LibObjT>
1340class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
1341{
1342private:
1343 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1344 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1345
1346public:
1347 using Shared = internal::SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;
1348
1349 explicit CommonStaticArrayFieldClass(const _LibObjPtr libObjPtr) noexcept :
1350 _ThisCommonArrayFieldClass {libObjPtr}
1351 {
1352 BT_ASSERT_DBG(this->isStaticArray());
1353 }
1354
1355 template <typename OtherLibObjT>
1356 CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept :
1357 _ThisCommonArrayFieldClass {fc}
1358 {
1359 }
1360
1361 template <typename OtherLibObjT>
0d6ad4d8 1362 CommonStaticArrayFieldClass&
12435a68
PP
1363 operator=(const CommonStaticArrayFieldClass<OtherLibObjT>& fc) noexcept
1364 {
1365 _ThisCommonArrayFieldClass::operator=(fc);
1366 return *this;
1367 }
1368
1369 std::uint64_t length() const noexcept
1370 {
341a67c4 1371 return bt_field_class_array_static_get_length(this->libObjPtr());
12435a68
PP
1372 }
1373
1374 Shared shared() const noexcept
1375 {
c9c0b6e2 1376 return Shared::createWithRef(*this);
12435a68
PP
1377 }
1378};
1379
1380using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
1381using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;
1382
4927bae7
PP
1383namespace internal {
1384
1385struct StaticArrayFieldClassTypeDescr
1386{
1387 using Const = ConstStaticArrayFieldClass;
1388 using NonConst = StaticArrayFieldClass;
1389};
1390
1391template <>
1392struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1393{
1394};
1395
1396template <>
1397struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
1398{
1399};
1400
1401} /* namespace internal */
1402
12435a68
PP
1403template <typename LibObjT>
1404class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
1405{
1406private:
1407 using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;
1408 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1409
1410public:
1411 using Shared =
1412 internal::SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;
1413
1414 explicit CommonDynamicArrayWithLengthFieldClass(const _LibObjPtr libObjPtr) noexcept :
1415 _ThisCommonArrayFieldClass {libObjPtr}
1416 {
1417 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
1418 }
1419
1420 template <typename OtherLibObjT>
1421 CommonDynamicArrayWithLengthFieldClass(
1422 const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept :
1423 _ThisCommonArrayFieldClass {fc}
1424 {
1425 }
1426
1427 template <typename OtherLibObjT>
0d6ad4d8 1428 CommonDynamicArrayWithLengthFieldClass&
12435a68
PP
1429 operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT>& fc) noexcept
1430 {
1431 _ThisCommonArrayFieldClass::operator=(fc);
1432 return *this;
1433 }
1434
1435 ConstFieldPath lengthFieldPath() const noexcept
1436 {
1437 return ConstFieldPath {
1438 bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
341a67c4 1439 this->libObjPtr())};
12435a68
PP
1440 }
1441
1442 Shared shared() const noexcept
1443 {
c9c0b6e2 1444 return Shared::createWithRef(*this);
12435a68
PP
1445 }
1446};
1447
1448using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;
1449
1450using ConstDynamicArrayWithLengthFieldClass =
1451 CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;
1452
1453namespace internal {
1454
4927bae7
PP
1455struct DynamicArrayWithLengthFieldClassTypeDescr
1456{
1457 using Const = ConstDynamicArrayWithLengthFieldClass;
1458 using NonConst = DynamicArrayWithLengthFieldClass;
1459};
1460
1461template <>
1462struct TypeDescr<DynamicArrayWithLengthFieldClass> :
1463 public DynamicArrayWithLengthFieldClassTypeDescr
1464{
1465};
1466
1467template <>
1468struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
1469 public DynamicArrayWithLengthFieldClassTypeDescr
1470{
1471};
1472
12435a68
PP
1473template <typename LibObjT>
1474struct CommonOptionFieldClassSpec;
1475
b5f55e9f 1476/* Functions specific to mutable option field classes */
12435a68
PP
1477template <>
1478struct CommonOptionFieldClassSpec<bt_field_class> final
1479{
1480 static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
1481 {
1482 return bt_field_class_option_borrow_field_class(libObjPtr);
1483 }
1484};
1485
b5f55e9f 1486/* Functions specific to constant option field classes */
12435a68
PP
1487template <>
1488struct CommonOptionFieldClassSpec<const bt_field_class> final
1489{
1490 static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
1491 {
1492 return bt_field_class_option_borrow_field_class_const(libObjPtr);
1493 }
1494};
1495
b5f55e9f 1496} /* namespace internal */
12435a68
PP
1497
1498template <typename LibObjT>
1499class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
1500{
1501private:
1502 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
1503
1504 using _FieldClass =
1505 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1506
1507protected:
1508 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1509 using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;
1510
1511public:
1512 using Shared = internal::SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;
1513
1514 explicit CommonOptionFieldClass(const _LibObjPtr libObjPtr) noexcept :
1515 _ThisCommonFieldClass {libObjPtr}
1516 {
1517 BT_ASSERT_DBG(this->isOption());
1518 }
1519
1520 template <typename OtherLibObjT>
1521 CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept :
1522 _ThisCommonFieldClass {fc}
1523 {
1524 }
1525
1526 template <typename OtherLibObjT>
0d6ad4d8 1527 CommonOptionFieldClass& operator=(const CommonOptionFieldClass<OtherLibObjT>& fc) noexcept
12435a68
PP
1528 {
1529 _ThisCommonFieldClass::operator=(fc);
1530 return *this;
1531 }
1532
1533 ConstFieldClass fieldClass() const noexcept
1534 {
1535 return ConstFieldClass {
1536 internal::CommonOptionFieldClassSpec<const bt_field_class>::fieldClass(
341a67c4 1537 this->libObjPtr())};
12435a68
PP
1538 }
1539
1540 _FieldClass fieldClass() noexcept
1541 {
1542 return _FieldClass {
341a67c4 1543 internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
12435a68
PP
1544 }
1545
1546 Shared shared() const noexcept
1547 {
c9c0b6e2 1548 return Shared::createWithRef(*this);
12435a68
PP
1549 }
1550};
1551
1552using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
1553using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;
1554
4927bae7
PP
1555namespace internal {
1556
1557struct OptionFieldClassTypeDescr
1558{
1559 using Const = ConstOptionFieldClass;
1560 using NonConst = OptionFieldClass;
1561};
1562
1563template <>
1564struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
1565{
1566};
1567
1568template <>
1569struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
1570{
1571};
1572
1573} /* namespace internal */
1574
12435a68
PP
1575template <typename LibObjT>
1576class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
1577{
1578private:
1579 using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;
1580
1581protected:
1582 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1583 using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;
1584
1585public:
1586 using Shared = internal::SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;
1587
1588 explicit CommonOptionWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1589 _ThisCommonOptionFieldClass {libObjPtr}
1590 {
1591 BT_ASSERT_DBG(this->isOptionWithSelector());
1592 }
1593
1594 template <typename OtherLibObjT>
1595 CommonOptionWithSelectorFieldClass(
1596 const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1597 _ThisCommonOptionFieldClass {fc}
1598 {
1599 }
1600
1601 template <typename OtherLibObjT>
0d6ad4d8 1602 CommonOptionWithSelectorFieldClass&
12435a68
PP
1603 operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
1604 {
1605 _ThisCommonOptionFieldClass::operator=(fc);
1606 return *this;
1607 }
1608
1609 ConstFieldPath selectorFieldPath() const noexcept
1610 {
1611 return ConstFieldPath {
1612 bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
341a67c4 1613 this->libObjPtr())};
12435a68
PP
1614 }
1615
1616 Shared shared() const noexcept
1617 {
c9c0b6e2 1618 return Shared::createWithRef(*this);
12435a68
PP
1619 }
1620};
1621
1622using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
1623using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;
1624
4927bae7
PP
1625namespace internal {
1626
1627struct OptionWithSelectorFieldClassTypeDescr
1628{
1629 using Const = ConstOptionWithSelectorFieldClass;
1630 using NonConst = OptionWithSelectorFieldClass;
1631};
1632
1633template <>
1634struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1635{
1636};
1637
1638template <>
1639struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
1640{
1641};
1642
1643} /* namespace internal */
1644
12435a68
PP
1645template <typename LibObjT>
1646class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1647{
1648private:
1649 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1650
1651 using typename CommonOptionWithSelectorFieldClass<
1652 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1653
1654public:
1655 using Shared =
1656 internal::SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;
1657
1658 explicit CommonOptionWithBoolSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1659 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1660 {
1661 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
1662 }
1663
1664 template <typename OtherLibObjT>
1665 CommonOptionWithBoolSelectorFieldClass(
1666 const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept :
1667 _ThisCommonOptionWithSelectorFieldClass {fc}
1668 {
1669 }
1670
1671 template <typename OtherLibObjT>
0d6ad4d8 1672 CommonOptionWithBoolSelectorFieldClass&
12435a68
PP
1673 operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT>& fc) noexcept
1674 {
1675 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1676 return *this;
1677 }
1678
1679 bool selectorIsReversed() const noexcept
1680 {
1681 return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
341a67c4 1682 this->libObjPtr());
12435a68
PP
1683 }
1684
1685 Shared shared() const noexcept
1686 {
c9c0b6e2 1687 return Shared::createWithRef(*this);
12435a68
PP
1688 }
1689};
1690
1691using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;
1692
1693using ConstOptionWithBoolSelectorFieldClass =
1694 CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;
1695
1696namespace internal {
1697
4927bae7
PP
1698struct OptionWithBoolSelectorFieldClassTypeDescr
1699{
1700 using Const = ConstOptionWithBoolSelectorFieldClass;
1701 using NonConst = OptionWithBoolSelectorFieldClass;
1702};
1703
1704template <>
1705struct TypeDescr<OptionWithBoolSelectorFieldClass> :
1706 public OptionWithBoolSelectorFieldClassTypeDescr
1707{
1708};
1709
1710template <>
1711struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
1712 public OptionWithBoolSelectorFieldClassTypeDescr
1713{
1714};
1715
12435a68
PP
1716template <typename RangeSetT>
1717struct CommonOptionWithIntegerSelectorFieldClassSpec;
1718
b5f55e9f 1719/* Functions specific to option field classes with unsigned integer ranges */
12435a68
PP
1720template <>
1721struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
1722{
1723 static const bt_integer_range_set_unsigned *
1724 ranges(const bt_field_class * const libObjPtr) noexcept
1725 {
1726 return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
1727 libObjPtr);
1728 }
1729};
1730
b5f55e9f 1731/* Functions specific to option field classes with signed ranges */
12435a68
PP
1732template <>
1733struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
1734{
1735 static const bt_integer_range_set_signed *
1736 ranges(const bt_field_class * const libObjPtr) noexcept
1737 {
1738 return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
1739 libObjPtr);
1740 }
1741};
1742
b5f55e9f 1743} /* namespace internal */
12435a68
PP
1744
1745template <typename LibObjT, typename RangeSetT>
1746class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
1747{
1748private:
1749 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
1750
1751 using typename CommonOptionWithSelectorFieldClass<
1752 LibObjT>::_ThisCommonOptionWithSelectorFieldClass;
1753
1754 using _ThisCommonOptionWithIntegerSelectorFieldClass =
1755 CommonOptionWithIntegerSelectorFieldClass<LibObjT, RangeSetT>;
1756
1757public:
1758 using Shared =
1759 internal::SharedFieldClass<_ThisCommonOptionWithIntegerSelectorFieldClass, LibObjT>;
1760
1761 using RangeSet = RangeSetT;
1762
1763 explicit CommonOptionWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
1764 _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
1765 {
1766 BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
1767 }
1768
1769 template <typename OtherLibObjT>
1770 CommonOptionWithIntegerSelectorFieldClass(
1771 const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept :
1772 _ThisCommonOptionWithSelectorFieldClass {fc}
1773 {
1774 }
1775
1776 template <typename OtherLibObjT>
0d6ad4d8 1777 CommonOptionWithIntegerSelectorFieldClass&
12435a68
PP
1778 operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT>& fc) noexcept
1779 {
1780 _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
1781 return *this;
1782 }
1783
1784 RangeSet ranges() const noexcept
1785 {
1786 return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
341a67c4 1787 this->libObjPtr())};
12435a68
PP
1788 }
1789
1790 Shared shared() const noexcept
1791 {
c9c0b6e2 1792 return Shared::createWithRef(*this);
12435a68
PP
1793 }
1794};
1795
1796using OptionWithUnsignedIntegerSelectorFieldClass =
1797 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;
1798
1799using ConstOptionWithUnsignedIntegerSelectorFieldClass =
1800 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;
1801
1802using OptionWithSignedIntegerSelectorFieldClass =
1803 CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;
1804
1805using ConstOptionWithSignedIntegerSelectorFieldClass =
1806 CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;
1807
1808namespace internal {
1809
4927bae7
PP
1810struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1811{
1812 using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
1813 using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
1814};
1815
1816template <>
1817struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
1818 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1819{
1820};
1821
1822template <>
1823struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
1824 public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
1825{
1826};
1827
1828struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
1829{
1830 using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
1831 using NonConst = OptionWithSignedIntegerSelectorFieldClass;
1832};
1833
1834template <>
1835struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
1836 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1837{
1838};
1839
1840template <>
1841struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
1842 public OptionWithSignedIntegerSelectorFieldClassTypeDescr
1843{
1844};
1845
12435a68
PP
1846template <typename LibObjT>
1847struct CommonVariantFieldClassOptionSpec;
1848
b5f55e9f 1849/* Functions specific to mutable variant field class options */
12435a68
PP
1850template <>
1851struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
1852{
1853 static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
1854 {
1855 return bt_field_class_variant_option_borrow_field_class(libObjPtr);
1856 }
1857};
1858
b5f55e9f 1859/* Functions specific to constant variant field class options */
12435a68
PP
1860template <>
1861struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
1862{
1863 static const bt_field_class *
1864 fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
1865 {
1866 return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
1867 }
1868};
1869
b5f55e9f 1870} /* namespace internal */
12435a68
PP
1871
1872template <typename LibObjT>
1873class CommonVariantFieldClassOption : public internal::BorrowedObj<LibObjT>
1874{
1875private:
1876 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
1877 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
1878
1879 using _FieldClass =
1880 typename std::conditional<std::is_const<LibObjT>::value, ConstFieldClass, FieldClass>::type;
1881
1882public:
1883 explicit CommonVariantFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
1884 _ThisBorrowedObj {libObjPtr}
1885 {
1886 }
1887
1888 template <typename OtherLibObjT>
1889 CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept :
1890 _ThisBorrowedObj {fc}
1891 {
1892 }
1893
1894 template <typename OtherLibObjT>
0d6ad4d8 1895 CommonVariantFieldClassOption&
12435a68
PP
1896 operator=(const CommonVariantFieldClassOption<OtherLibObjT>& fc) noexcept
1897 {
1898 _ThisBorrowedObj::operator=(fc);
1899 return *this;
1900 }
1901
41c4bedf 1902 nonstd::optional<bpstd::string_view> name() const noexcept
12435a68 1903 {
41c4bedf
PP
1904 const auto name = bt_field_class_variant_option_get_name(this->libObjPtr());
1905
1906 if (name) {
1907 return name;
1908 }
1909
1910 return nonstd::nullopt;
12435a68
PP
1911 }
1912
1913 ConstFieldClass fieldClass() const noexcept
1914 {
1915 return ConstFieldClass {internal::CommonVariantFieldClassOptionSpec<
341a67c4 1916 const bt_field_class_variant_option>::fieldClass(this->libObjPtr())};
12435a68
PP
1917 }
1918
1919 _FieldClass fieldClass() noexcept
1920 {
1921 return _FieldClass {
341a67c4 1922 internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
12435a68
PP
1923 }
1924};
1925
1926using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;
1927
1928using ConstVariantFieldClassOption =
1929 CommonVariantFieldClassOption<const bt_field_class_variant_option>;
1930
1931namespace internal {
1932
4927bae7
PP
1933struct VariantFieldClassOptionTypeDescr
1934{
1935 using Const = ConstVariantFieldClassOption;
1936 using NonConst = VariantFieldClassOption;
1937};
1938
1939template <>
1940struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1941{
1942};
1943
1944template <>
1945struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
1946{
1947};
1948
12435a68
PP
1949template <typename LibObjT>
1950struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;
1951
b5f55e9f 1952/* Functions specific to variant field class options with unsigned integer selector */
12435a68
PP
1953template <>
1954struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1955 const bt_field_class_variant_with_selector_field_integer_unsigned_option>
1956 final
1957{
1958 static const bt_integer_range_set_unsigned *
1959 ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1960 * const libObjPtr) noexcept
1961 {
1962 return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
1963 libObjPtr);
1964 }
1965
1966 static const bt_field_class_variant_option *
1967 asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
1968 * const libObjPtr) noexcept
1969 {
1970 return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
1971 libObjPtr);
1972 }
1973};
1974
b5f55e9f 1975/* Functions specific to variant field class options with signed integer selector */
12435a68
PP
1976template <>
1977struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
1978 const bt_field_class_variant_with_selector_field_integer_signed_option>
1979 final
1980{
1981 static const bt_integer_range_set_signed *
1982 ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
1983 * const libObjPtr) noexcept
1984 {
1985 return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
1986 libObjPtr);
1987 }
1988
1989 static const bt_field_class_variant_option *
1990 asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
1991 * const libObjPtr) noexcept
1992 {
1993 return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
1994 libObjPtr);
1995 }
1996};
1997
b5f55e9f 1998} /* namespace internal */
12435a68
PP
1999
2000template <typename LibObjT>
2001class ConstVariantWithIntegerSelectorFieldClassOption : public internal::BorrowedObj<LibObjT>
2002{
2003private:
2004 using typename internal::BorrowedObj<LibObjT>::_ThisBorrowedObj;
2005 using typename internal::BorrowedObj<LibObjT>::_LibObjPtr;
2006 using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;
2007
2008public:
2009 using RangeSet = typename std::conditional<
2010 std::is_same<
2011 LibObjT,
2012 const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
2013 ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;
2014
2015 explicit ConstVariantWithIntegerSelectorFieldClassOption(const _LibObjPtr libObjPtr) noexcept :
2016 _ThisBorrowedObj {libObjPtr}
2017 {
2018 }
2019
2020 template <typename OtherLibObjT>
2021 ConstVariantWithIntegerSelectorFieldClassOption(
2022 const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept :
2023 _ThisBorrowedObj {fc}
2024 {
2025 }
2026
2027 template <typename OtherLibObjT>
0d6ad4d8 2028 ConstVariantWithIntegerSelectorFieldClassOption&
12435a68
PP
2029 operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT>& fc) noexcept
2030 {
2031 _ThisBorrowedObj::operator=(fc);
2032 return *this;
2033 }
2034
2035 ConstVariantFieldClassOption asBaseOption() const noexcept
2036 {
341a67c4 2037 return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
12435a68
PP
2038 }
2039
41c4bedf 2040 nonstd::optional<bpstd::string_view> name() const noexcept
12435a68
PP
2041 {
2042 return this->asBaseOption().name();
2043 }
2044
2045 ConstFieldClass fieldClass() const noexcept
2046 {
2047 return this->asBaseOption().fieldClass();
2048 }
2049
2050 RangeSet ranges() const noexcept
2051 {
341a67c4 2052 return RangeSet {_Spec::ranges(this->libObjPtr())};
12435a68
PP
2053 }
2054};
2055
2056using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
2057 ConstVariantWithIntegerSelectorFieldClassOption<
2058 const bt_field_class_variant_with_selector_field_integer_unsigned_option>;
2059
2060using ConstVariantWithSignedIntegerSelectorFieldClassOption =
2061 ConstVariantWithIntegerSelectorFieldClassOption<
2062 const bt_field_class_variant_with_selector_field_integer_signed_option>;
2063
2064namespace internal {
2065
2066template <typename LibObjT>
2067struct CommonVariantFieldClassSpec;
2068
b5f55e9f 2069/* Functions specific to mutable variant field classes */
12435a68
PP
2070template <>
2071struct CommonVariantFieldClassSpec<bt_field_class> final
2072{
2073 static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
2074 const std::uint64_t index) noexcept
2075 {
2076 return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
2077 }
2078
2079 static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
2080 const char * const name) noexcept
2081 {
2082 return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
2083 }
2084};
2085
b5f55e9f 2086/* Functions specific to constant variant field classes */
12435a68
PP
2087template <>
2088struct CommonVariantFieldClassSpec<const bt_field_class> final
2089{
2090 static const bt_field_class_variant_option *
2091 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2092 {
2093 return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
2094 }
2095
2096 static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
2097 const char * const name) noexcept
2098 {
2099 return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
2100 }
2101};
2102
b5f55e9f 2103} /* namespace internal */
12435a68
PP
2104
2105template <typename LibObjT>
2106class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
2107{
2108private:
2109 using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
2110
2111protected:
2112 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2113 using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;
2114
2115public:
2116 using Shared = internal::SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
2117
2118 using Option =
2119 typename std::conditional<std::is_const<LibObjT>::value, ConstVariantFieldClassOption,
2120 VariantFieldClassOption>::type;
2121
3c02a7cb 2122 using Iterator = CommonIterator<CommonVariantFieldClass, Option>;
5046c776 2123
12435a68
PP
2124 explicit CommonVariantFieldClass(const _LibObjPtr libObjPtr) noexcept :
2125 _ThisCommonFieldClass {libObjPtr}
2126 {
2127 BT_ASSERT_DBG(this->isVariant());
2128 }
2129
2130 template <typename OtherLibObjT>
2131 CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept :
2132 _ThisCommonFieldClass {fc}
2133 {
2134 }
2135
2136 template <typename OtherLibObjT>
0d6ad4d8 2137 CommonVariantFieldClass& operator=(const CommonVariantFieldClass<OtherLibObjT>& fc) noexcept
12435a68
PP
2138 {
2139 _ThisCommonFieldClass::operator=(fc);
2140 return *this;
2141 }
2142
2143 std::uint64_t size() const noexcept
2144 {
341a67c4 2145 return bt_field_class_variant_get_option_count(this->libObjPtr());
12435a68
PP
2146 }
2147
5046c776
FD
2148 Iterator begin() const noexcept
2149 {
2150 return Iterator {*this, 0};
2151 }
2152
2153 Iterator end() const noexcept
2154 {
2155 return Iterator {*this, this->size()};
2156 }
2157
12435a68
PP
2158 ConstVariantFieldClassOption operator[](const std::uint64_t index) const noexcept
2159 {
2160 return ConstVariantFieldClassOption {
2161 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByIndex(
341a67c4 2162 this->libObjPtr(), index)};
12435a68
PP
2163 }
2164
2165 Option operator[](const std::uint64_t index) noexcept
2166 {
2167 return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
341a67c4 2168 this->libObjPtr(), index)};
12435a68
PP
2169 }
2170
2171 nonstd::optional<ConstVariantFieldClassOption>
2172 operator[](const char * const name) const noexcept
2173 {
2174 const auto libObjPtr =
2175 internal::CommonVariantFieldClassSpec<const bt_field_class>::optionByName(
341a67c4 2176 this->libObjPtr(), name);
12435a68
PP
2177
2178 if (libObjPtr) {
2179 return ConstVariantFieldClassOption {libObjPtr};
2180 }
2181
2182 return nonstd::nullopt;
2183 }
2184
2185 nonstd::optional<ConstVariantFieldClassOption>
2186 operator[](const std::string& name) const noexcept
2187 {
2188 return (*this)[name.data()];
2189 }
2190
2191 nonstd::optional<Option> operator[](const char * const name) noexcept
2192 {
2193 const auto libObjPtr =
341a67c4 2194 internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(), name);
12435a68
PP
2195
2196 if (libObjPtr) {
2197 return Option {libObjPtr};
2198 }
2199
2200 return nonstd::nullopt;
2201 }
2202
2203 nonstd::optional<Option> operator[](const std::string& name) noexcept
2204 {
2205 return (*this)[name.data()];
2206 }
2207
2208 Shared shared() const noexcept
2209 {
c9c0b6e2 2210 return Shared::createWithRef(*this);
12435a68
PP
2211 }
2212};
2213
2214using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
2215using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;
2216
4927bae7
PP
2217namespace internal {
2218
2219struct VariantFieldClassTypeDescr
2220{
2221 using Const = ConstVariantFieldClass;
2222 using NonConst = VariantFieldClass;
2223};
2224
2225template <>
2226struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
2227{
2228};
2229
2230template <>
2231struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
2232{
2233};
2234
2235} /* namespace internal */
2236
12435a68
PP
2237template <typename LibObjT>
2238class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
2239{
2240private:
2241 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
2242 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
2243
2244public:
2245 using Shared =
2246 internal::SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;
2247
2248 explicit CommonVariantWithoutSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2249 _ThisCommonVariantFieldClass {libObjPtr}
2250 {
2251 BT_ASSERT_DBG(this->isVariantWithoutSelector());
2252 }
2253
2254 template <typename OtherLibObjT>
2255 CommonVariantWithoutSelectorFieldClass(
2256 const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2257 _ThisCommonVariantFieldClass {fc}
2258 {
2259 }
2260
2261 template <typename OtherLibObjT>
0d6ad4d8 2262 CommonVariantWithoutSelectorFieldClass&
12435a68
PP
2263 operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT>& fc) noexcept
2264 {
2265 _ThisCommonVariantFieldClass::operator=(fc);
2266 return *this;
2267 }
2268
2269 void appendOption(const char * const name, const FieldClass& fc)
2270 {
2271 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2272
2273 const auto status = bt_field_class_variant_without_selector_append_option(
341a67c4 2274 this->libObjPtr(), name, fc.libObjPtr());
12435a68
PP
2275
2276 if (status ==
2277 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2278 throw LibMemoryError {};
2279 }
2280 }
2281
41c4bedf 2282 void appendOption(const nonstd::optional<std::string>& name, const FieldClass& fc)
12435a68 2283 {
41c4bedf 2284 this->appendOption(name ? name->data() : nullptr, fc);
12435a68
PP
2285 }
2286
2287 Shared shared() const noexcept
2288 {
c9c0b6e2 2289 return Shared::createWithRef(*this);
12435a68
PP
2290 }
2291};
2292
2293using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
2294using ConstVariantWithoutSelectorFieldClass =
2295 CommonVariantWithoutSelectorFieldClass<const bt_field_class>;
2296
2297namespace internal {
2298
4927bae7
PP
2299struct VariantWithoutSelectorFieldClassTypeDescr
2300{
2301 using Const = ConstVariantWithoutSelectorFieldClass;
2302 using NonConst = VariantWithoutSelectorFieldClass;
2303};
2304
2305template <>
2306struct TypeDescr<VariantWithoutSelectorFieldClass> :
2307 public VariantWithoutSelectorFieldClassTypeDescr
2308{
2309};
2310
2311template <>
2312struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
2313 public VariantWithoutSelectorFieldClassTypeDescr
2314{
2315};
2316
12435a68
PP
2317template <typename OptionT>
2318struct CommonVariantWithIntegerSelectorFieldClassSpec;
2319
b5f55e9f 2320/* Functions specific to variant field classes with unsigned integer selector */
12435a68
PP
2321template <>
2322struct CommonVariantWithIntegerSelectorFieldClassSpec<
2323 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2324 final
2325{
2326 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2327 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2328 {
2329 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
2330 libObjPtr, index);
2331 }
2332
2333 static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
2334 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2335 {
2336 return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
2337 libObjPtr, name);
2338 }
2339
2340 static bt_field_class_variant_with_selector_field_integer_append_option_status
2341 appendOption(bt_field_class * const libObjPtr, const char * const name,
2342 bt_field_class * const libOptFcPtr,
2343 const bt_integer_range_set_unsigned * const libRangesPtr)
2344 {
2345 return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
2346 libObjPtr, name, libOptFcPtr, libRangesPtr);
2347 }
2348};
2349
b5f55e9f 2350/* Functions specific to variant field classes with signed integer selector */
12435a68
PP
2351template <>
2352struct CommonVariantWithIntegerSelectorFieldClassSpec<
2353 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2354 final
2355{
2356 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2357 optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
2358 {
2359 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
2360 libObjPtr, index);
2361 }
2362
2363 static const bt_field_class_variant_with_selector_field_integer_signed_option *
2364 optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
2365 {
2366 return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
2367 libObjPtr, name);
2368 }
2369
2370 static bt_field_class_variant_with_selector_field_integer_append_option_status
2371 appendOption(bt_field_class * const libObjPtr, const char * const name,
2372 bt_field_class * const libOptFcPtr,
2373 const bt_integer_range_set_signed * const libRangesPtr)
2374 {
2375 return bt_field_class_variant_with_selector_field_integer_signed_append_option(
2376 libObjPtr, name, libOptFcPtr, libRangesPtr);
2377 }
2378};
2379
b5f55e9f 2380} /* namespace internal */
12435a68 2381
cefe03a2
FD
2382template <typename LibObjT>
2383class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
12435a68
PP
2384{
2385private:
2386 using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;
cefe03a2
FD
2387
2388protected:
12435a68 2389 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
cefe03a2
FD
2390 using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;
2391
2392public:
2393 using Shared = internal::SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;
2394
2395 explicit CommonVariantWithSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
2396 _ThisCommonVariantFieldClass {libObjPtr}
2397 {
2398 BT_ASSERT_DBG(this->isVariantWithSelector());
2399 }
2400
2401 template <typename OtherLibObjT>
2402 CommonVariantWithSelectorFieldClass(
2403 const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept :
2404 _ThisCommonVariantFieldClass {fc}
2405 {
2406 }
2407
2408 template <typename OtherLibObjT>
0d6ad4d8 2409 CommonVariantWithSelectorFieldClass&
cefe03a2
FD
2410 operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT>& fc) noexcept
2411 {
2412 _ThisCommonVariantFieldClass::operator=(fc);
2413 return *this;
2414 }
2415
2416 ConstFieldPath selectorFieldPath() const noexcept
2417 {
2418 return ConstFieldPath {
2419 bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
341a67c4 2420 this->libObjPtr())};
cefe03a2
FD
2421 }
2422
2423 Shared shared() const noexcept
2424 {
c9c0b6e2 2425 return Shared::createWithRef(*this);
cefe03a2
FD
2426 }
2427};
12435a68 2428
3c02a7cb
FD
2429using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
2430using ConstVariantWithSelectorFieldClass =
2431 CommonVariantWithSelectorFieldClass<const bt_field_class>;
2432
cefe03a2
FD
2433template <typename LibObjT, typename OptionT>
2434class CommonVariantWithIntegerSelectorFieldClass :
2435 public CommonVariantWithSelectorFieldClass<LibObjT>
2436{
2437private:
2438 using typename CommonVariantWithSelectorFieldClass<
2439 LibObjT>::_ThisCommonVariantWithSelectorFieldClass;
2440 using typename CommonFieldClass<LibObjT>::_LibObjPtr;
12435a68
PP
2441 using _ThisCommonVariantWithIntegerSelectorFieldClass =
2442 CommonVariantWithIntegerSelectorFieldClass<LibObjT, OptionT>;
2443
2444 using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;
2445
2446public:
2447 using Shared =
2448 internal::SharedFieldClass<_ThisCommonVariantWithIntegerSelectorFieldClass, LibObjT>;
2449
2450 using Option = OptionT;
3c02a7cb
FD
2451 using Iterator =
2452 CommonIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>, Option>;
12435a68
PP
2453
2454 explicit CommonVariantWithIntegerSelectorFieldClass(const _LibObjPtr libObjPtr) noexcept :
cefe03a2 2455 _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
12435a68
PP
2456 {
2457 BT_ASSERT_DBG(this->isVariant());
2458 }
2459
2460 template <typename OtherLibObjT>
2461 CommonVariantWithIntegerSelectorFieldClass(
2462 const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept :
cefe03a2 2463 _ThisCommonVariantWithSelectorFieldClass {fc}
12435a68
PP
2464 {
2465 }
2466
2467 template <typename OtherLibObjT>
0d6ad4d8 2468 CommonVariantWithIntegerSelectorFieldClass&
12435a68
PP
2469 operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT>& fc) noexcept
2470 {
cefe03a2 2471 _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
12435a68
PP
2472 return *this;
2473 }
2474
12435a68
PP
2475 Option operator[](const std::uint64_t index) const noexcept
2476 {
341a67c4 2477 return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
12435a68
PP
2478 }
2479
2480 nonstd::optional<Option> operator[](const char * const name) const noexcept
2481 {
341a67c4 2482 const auto libObjPtr = _Spec::optionByName(this->libObjPtr(), name);
12435a68
PP
2483
2484 if (libObjPtr) {
2485 return Option {libObjPtr};
2486 }
2487
2488 return nonstd::nullopt;
2489 }
2490
2491 nonstd::optional<Option> operator[](const std::string& name) const noexcept
2492 {
2493 return (*this)[name.data()];
2494 }
2495
2496 void appendOption(const char * const name, const FieldClass& fc,
2497 const typename Option::RangeSet& ranges)
2498 {
2499 static_assert(!std::is_const<LibObjT>::value, "`LibObjT` must NOT be `const`.");
2500
2501 const auto status =
341a67c4 2502 _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());
12435a68
PP
2503
2504 if (status ==
2505 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
2506 throw LibMemoryError {};
2507 }
2508 }
2509
41c4bedf
PP
2510 void appendOption(const nonstd::optional<std::string>& name, const FieldClass& fc,
2511 const typename Option::RangeSet& ranges)
12435a68 2512 {
41c4bedf 2513 this->appendOption(name ? name->data() : nullptr, fc, ranges);
12435a68
PP
2514 }
2515
3c02a7cb
FD
2516 Iterator begin() const noexcept
2517 {
2518 return Iterator {*this, 0};
2519 }
2520
2521 Iterator end() const noexcept
2522 {
2523 return Iterator {*this, this->size()};
2524 }
2525
12435a68
PP
2526 Shared shared() const noexcept
2527 {
c9c0b6e2 2528 return Shared::createWithRef(*this);
12435a68
PP
2529 }
2530};
2531
2532using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2533 bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2534
2535using ConstVariantWithUnsignedIntegerSelectorFieldClass =
2536 CommonVariantWithIntegerSelectorFieldClass<
2537 const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;
2538
2539using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2540 bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2541
2542using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
2543 const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;
2544
4927bae7
PP
2545namespace internal {
2546
2547struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2548{
2549 using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
2550 using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
2551};
2552
2553template <>
2554struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
2555 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2556{
2557};
2558
2559template <>
2560struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
2561 public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
2562{
2563};
2564
2565struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
2566{
2567 using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
2568 using NonConst = VariantWithSignedIntegerSelectorFieldClass;
2569};
2570
2571template <>
2572struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
2573 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2574{
2575};
2576
2577template <>
2578struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
2579 public VariantWithSignedIntegerSelectorFieldClassTypeDescr
2580{
2581};
2582
2583} /* namespace internal */
2584
12435a68
PP
2585template <typename LibObjT>
2586CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
2587{
2588 BT_ASSERT_DBG(this->isBitArray());
341a67c4 2589 return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2590}
2591
2592template <typename LibObjT>
2593CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
2594{
2595 BT_ASSERT_DBG(this->isInteger());
341a67c4 2596 return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2597}
2598
be6aa636
FD
2599template <typename LibObjT>
2600CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
2601{
2602 BT_ASSERT_DBG(this->isEnumeration());
341a67c4 2603 return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
be6aa636
FD
2604}
2605
12435a68
PP
2606template <typename LibObjT>
2607CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
2608CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
2609{
2610 BT_ASSERT_DBG(this->isUnsignedEnumeration());
2611 return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
341a67c4 2612 this->libObjPtr()};
12435a68
PP
2613}
2614
2615template <typename LibObjT>
2616CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
2617CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
2618{
2619 BT_ASSERT_DBG(this->isSignedEnumeration());
2620 return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
341a67c4 2621 this->libObjPtr()};
12435a68
PP
2622}
2623
2624template <typename LibObjT>
2625CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
2626{
2627 BT_ASSERT_DBG(this->isStructure());
341a67c4 2628 return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2629}
2630
2631template <typename LibObjT>
2632CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
2633{
2634 BT_ASSERT_DBG(this->isArray());
341a67c4 2635 return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2636}
2637
2638template <typename LibObjT>
2639CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
2640{
2641 BT_ASSERT_DBG(this->isStaticArray());
341a67c4 2642 return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2643}
2644
2645template <typename LibObjT>
2646CommonDynamicArrayWithLengthFieldClass<LibObjT>
2647CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
2648{
2649 BT_ASSERT_DBG(this->isDynamicArrayWithLength());
341a67c4 2650 return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2651}
2652
2653template <typename LibObjT>
2654CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
2655{
2656 BT_ASSERT_DBG(this->isOption());
341a67c4 2657 return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2658}
2659
2660template <typename LibObjT>
2661CommonOptionWithSelectorFieldClass<LibObjT>
2662CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
2663{
2664 BT_ASSERT_DBG(this->isOptionWithSelector());
341a67c4 2665 return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2666}
2667
2668template <typename LibObjT>
2669CommonOptionWithBoolSelectorFieldClass<LibObjT>
2670CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
2671{
2672 BT_ASSERT_DBG(this->isOptionWithBoolSelector());
341a67c4 2673 return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2674}
2675
2676template <typename LibObjT>
2677CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
2678CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
2679{
2680 BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
2681 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
341a67c4 2682 this->libObjPtr()};
12435a68
PP
2683}
2684
2685template <typename LibObjT>
2686CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
2687CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
2688{
2689 BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
2690 return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
341a67c4 2691 this->libObjPtr()};
12435a68
PP
2692}
2693
2694template <typename LibObjT>
2695CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
2696{
2697 BT_ASSERT_DBG(this->isVariant());
341a67c4 2698 return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2699}
2700
2701template <typename LibObjT>
2702CommonVariantWithoutSelectorFieldClass<LibObjT>
2703CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
2704{
2705 BT_ASSERT_DBG(this->isVariantWithoutSelector());
341a67c4 2706 return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
12435a68
PP
2707}
2708
2709template <typename LibObjT>
cefe03a2
FD
2710CommonVariantWithSelectorFieldClass<LibObjT>
2711CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
2712{
2713 BT_ASSERT_DBG(this->isVariantWithSelector());
341a67c4 2714 return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
cefe03a2
FD
2715}
2716
2717template <typename LibObjT>
12435a68
PP
2718CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2719 ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
2720CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
2721{
2722 BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
2723 return CommonVariantWithIntegerSelectorFieldClass<
341a67c4 2724 LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
12435a68
PP
2725}
2726
2727template <typename LibObjT>
2728CommonVariantWithIntegerSelectorFieldClass<LibObjT,
2729 ConstVariantWithSignedIntegerSelectorFieldClassOption>
2730CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
2731{
2732 BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
2733 return CommonVariantWithIntegerSelectorFieldClass<
341a67c4 2734 LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
12435a68
PP
2735}
2736
b5f55e9f 2737} /* namespace bt2 */
12435a68 2738
b5f55e9f 2739#endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */
This page took 0.141224 seconds and 4 git commands to generate.