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