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