src/cpp-common/bt2/field-class.hpp

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