cpp-common/bt2c: add `bt2c::CStringView`

[babeltrace.git] / src / cpp-common / bt2 / field-class.hpp

/*
 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
 *
 * SPDX-License-Identifier: MIT
 */

#ifndef BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP
#define BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP

#include <cstdint>
#include <type_traits>

#include <babeltrace2/babeltrace.h>

#include "common/assert.h"
#include "cpp-common/bt2s/optional.hpp"

#include "borrowed-object-iterator.hpp"
#include "borrowed-object.hpp"
#include "exc.hpp"
#include "field-path.hpp"
#include "integer-range-set.hpp"
#include "internal/utils.hpp"
#include "optional-borrowed-object.hpp"
#include "shared-object.hpp"
#include "value.hpp"

namespace bt2 {
namespace internal {

struct FieldClassRefFuncs final
{
    static void get(const bt_field_class * const libObjPtr) noexcept
    {
        bt_field_class_get_ref(libObjPtr);
    }

    static void put(const bt_field_class * const libObjPtr) noexcept
    {
        bt_field_class_put_ref(libObjPtr);
    }
};

template <typename LibObjT>
struct CommonFieldClassSpec;

/* Functions specific to mutable field classes */
template <>
struct CommonFieldClassSpec<bt_field_class> final
{
    static bt_value *userAttributes(bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_borrow_user_attributes(libObjPtr);
    }
};

/* Functions specific to constant field classes */
template <>
struct CommonFieldClassSpec<const bt_field_class> final
{
    static const bt_value *userAttributes(const bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_borrow_user_attributes_const(libObjPtr);
    }
};

} /* namespace internal */

template <typename ObjT, typename LibObjT>
using SharedFieldClass = SharedObject<ObjT, LibObjT, internal::FieldClassRefFuncs>;

template <typename LibObjT>
class CommonBitArrayFieldClass;

template <typename LibObjT>
class CommonIntegerFieldClass;

template <typename LibObjT>
class ConstEnumerationFieldClassMapping;

template <typename LibObjT>
class CommonBaseEnumerationFieldClass;

template <typename LibObjT, typename MappingT>
class CommonEnumerationFieldClass;

template <typename LibObjT>
class CommonStructureFieldClass;

template <typename LibObjT>
class CommonArrayFieldClass;

template <typename LibObjT>
class CommonStaticArrayFieldClass;

template <typename LibObjT>
class CommonDynamicArrayWithLengthFieldClass;

template <typename LibObjT>
class CommonOptionFieldClass;

template <typename LibObjT>
class CommonOptionWithSelectorFieldClass;

template <typename LibObjT>
class CommonOptionWithBoolSelectorFieldClass;

template <typename LibObjT>
class CommonVariantFieldClass;

template <typename LibObjT, typename RangeSetT>
class CommonOptionWithIntegerSelectorFieldClass;

template <typename LibObjT>
class CommonVariantWithoutSelectorFieldClass;

template <typename LibObjT>
class CommonVariantWithSelectorFieldClass;

template <typename LibObjT>
class ConstVariantWithIntegerSelectorFieldClassOption;

template <typename LibObjT, typename RangeSetT>
class CommonVariantWithIntegerSelectorFieldClass;

template <typename LibObjT>
class CommonEventClass;

template <typename LibObjT>
class CommonStreamClass;

template <typename LibObjT>
class CommonTraceClass;

enum class FieldClassType
{
    BOOL = BT_FIELD_CLASS_TYPE_BOOL,
    BIT_ARRAY = BT_FIELD_CLASS_TYPE_BIT_ARRAY,
    UNSIGNED_INTEGER = BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
    SIGNED_INTEGER = BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
    UNSIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
    SIGNED_ENUMERATION = BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
    SINGLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL,
    DOUBLE_PRECISION_REAL = BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL,
    STRING = BT_FIELD_CLASS_TYPE_STRING,
    STRUCTURE = BT_FIELD_CLASS_TYPE_STRUCTURE,
    STATIC_ARRAY = BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
    DYNAMIC_ARRAY_WITHOUT_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD,
    DYNAMIC_ARRAY_WITH_LENGTH = BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
    OPTION_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
    OPTION_WITH_BOOL_SELECTOR = BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
    OPTION_WITH_UNSIGNED_INTEGER_SELECTOR =
        BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
    OPTION_WITH_SIGNED_INTEGER_SELECTOR =
        BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
    VARIANT_WITHOUT_SELECTOR = BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD,
    VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR =
        BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD,
    VARIANT_WITH_SIGNED_INTEGER_SELECTOR =
        BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD,
};

template <typename LibObjT>
class CommonFieldClass : public BorrowedObject<LibObjT>
{
private:
    using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;

protected:
    using _ThisCommonFieldClass = CommonFieldClass<LibObjT>;

public:
    using typename BorrowedObject<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonFieldClass<LibObjT>, LibObjT>;
    using UserAttributes = internal::DepUserAttrs<LibObjT>;

    explicit CommonFieldClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
    {
    }

    template <typename OtherLibObjT>
    CommonFieldClass(const CommonFieldClass<OtherLibObjT> fc) noexcept : _ThisBorrowedObject {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonFieldClass operator=(const CommonFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisBorrowedObject::operator=(fc);
        return *this;
    }

    CommonFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonFieldClass<const bt_field_class> {*this};
    }

    FieldClassType type() const noexcept
    {
        return static_cast<FieldClassType>(bt_field_class_get_type(this->libObjPtr()));
    }

    bool isBool() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BOOL);
    }

    bool isBitArray() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_BIT_ARRAY);
    }

    bool isInteger() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_INTEGER);
    }

    bool isUnsignedInteger() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
    }

    bool isSignedInteger() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
    }

    bool isEnumeration() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ENUMERATION);
    }

    bool isUnsignedEnumeration() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
    }

    bool isSignedEnumeration() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
    }

    bool isReal() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_REAL);
    }

    bool isSinglePrecisionReal() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
    }

    bool isDoublePrecisionReal() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
    }

    bool isString() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRING);
    }

    bool isStructure() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STRUCTURE);
    }

    bool isArray() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_ARRAY);
    }

    bool isStaticArray() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_STATIC_ARRAY);
    }

    bool isDynamicArray() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY);
    }

    bool isDynamicArrayWithoutLength() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD);
    }

    bool isDynamicArrayWithLength() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD);
    }

    bool isOption() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION);
    }

    bool isOptionWithoutSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD);
    }

    bool isOptionWithSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD);
    }

    bool isOptionWithBoolSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD);
    }

    bool isOptionWithIntegerSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD);
    }

    bool isOptionWithUnsignedIntegerSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
    }

    bool isOptionWithSignedIntegerSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
    }

    bool isVariant() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT);
    }

    bool isVariantWithoutSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD);
    }

    bool isVariantWithSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD);
    }

    bool isVariantWithIntegerSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD);
    }

    bool isVariantWithUnsignedIntegerSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
    }

    bool isVariantWithSignedIntegerSelector() const noexcept
    {
        return this->_libTypeIs(BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
    }

    template <typename FieldClassT>
    FieldClassT as() const noexcept
    {
        return FieldClassT {this->libObjPtr()};
    }

    CommonBitArrayFieldClass<LibObjT> asBitArray() const noexcept;
    CommonIntegerFieldClass<LibObjT> asInteger() const noexcept;
    CommonBaseEnumerationFieldClass<LibObjT> asEnumeration() const noexcept;
    CommonEnumerationFieldClass<LibObjT, ConstEnumerationFieldClassMapping<
                                             const bt_field_class_enumeration_unsigned_mapping>>
    asUnsignedEnumeration() const noexcept;

    CommonEnumerationFieldClass<
        LibObjT, ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>>
    asSignedEnumeration() const noexcept;

    CommonStructureFieldClass<LibObjT> asStructure() const noexcept;
    CommonArrayFieldClass<LibObjT> asArray() const noexcept;
    CommonStaticArrayFieldClass<LibObjT> asStaticArray() const noexcept;
    CommonDynamicArrayWithLengthFieldClass<LibObjT> asDynamicArrayWithLength() const noexcept;
    CommonOptionFieldClass<LibObjT> asOption() const noexcept;
    CommonOptionWithSelectorFieldClass<LibObjT> asOptionWithSelector() const noexcept;
    CommonOptionWithBoolSelectorFieldClass<LibObjT> asOptionWithBoolSelector() const noexcept;

    CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
    asOptionWithUnsignedIntegerSelector() const noexcept;

    CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
    asOptionWithSignedIntegerSelector() const noexcept;

    CommonVariantFieldClass<LibObjT> asVariant() const noexcept;
    CommonVariantWithoutSelectorFieldClass<LibObjT> asVariantWithoutSelector() const noexcept;
    CommonVariantWithSelectorFieldClass<LibObjT> asVariantWithSelector() const noexcept;

    CommonVariantWithIntegerSelectorFieldClass<
        LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
                     const bt_field_class_variant_with_selector_field_integer_unsigned_option>>
    asVariantWithUnsignedIntegerSelector() const noexcept;

    CommonVariantWithIntegerSelectorFieldClass<
        LibObjT, ConstVariantWithIntegerSelectorFieldClassOption<
                     const bt_field_class_variant_with_selector_field_integer_signed_option>>
    asVariantWithSignedIntegerSelector() const noexcept;

    template <typename LibValT>
    void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
    {
        static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstFieldClass`.");

        bt_field_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
    }

    UserAttributes userAttributes() const noexcept
    {
        return UserAttributes {
            internal::CommonFieldClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }

protected:
    bool _libTypeIs(const bt_field_class_type type) const noexcept
    {
        return bt_field_class_type_is(bt_field_class_get_type(this->libObjPtr()), type);
    }
};

using FieldClass = CommonFieldClass<bt_field_class>;
using ConstFieldClass = CommonFieldClass<const bt_field_class>;

namespace internal {

struct FieldClassTypeDescr
{
    using Const = ConstFieldClass;
    using NonConst = FieldClass;
};

template <>
struct TypeDescr<FieldClass> : public FieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstFieldClass> : public FieldClassTypeDescr
{
};

} /* namespace internal */

template <typename LibObjT>
class CommonBitArrayFieldClass final : public CommonFieldClass<LibObjT>
{
private:
    using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonBitArrayFieldClass<LibObjT>, LibObjT>;

    explicit CommonBitArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isBitArray());
    }

    template <typename OtherLibObjT>
    CommonBitArrayFieldClass(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonBitArrayFieldClass<LibObjT>
    operator=(const CommonBitArrayFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonFieldClass::operator=(fc);
        return *this;
    }

    CommonBitArrayFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonBitArrayFieldClass<const bt_field_class> {*this};
    }

    std::uint64_t length() const noexcept
    {
        return bt_field_class_bit_array_get_length(this->libObjPtr());
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using BitArrayFieldClass = CommonBitArrayFieldClass<bt_field_class>;
using ConstBitArrayFieldClass = CommonBitArrayFieldClass<const bt_field_class>;

namespace internal {

struct BitArrayFieldClassTypeDescr
{
    using Const = ConstBitArrayFieldClass;
    using NonConst = BitArrayFieldClass;
};

template <>
struct TypeDescr<BitArrayFieldClass> : public BitArrayFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstBitArrayFieldClass> : public BitArrayFieldClassTypeDescr
{
};

} /* namespace internal */

enum class DisplayBase
{
    BINARY = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
    OCTAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
    DECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
    HEXADECIMAL = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
};

template <typename LibObjT>
class CommonIntegerFieldClass : public CommonFieldClass<LibObjT>
{
private:
    using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;

protected:
    using _ThisCommonIntegerFieldClass = CommonIntegerFieldClass<LibObjT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonIntegerFieldClass<LibObjT>, LibObjT>;

    explicit CommonIntegerFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isInteger());
    }

    template <typename OtherLibObjT>
    CommonIntegerFieldClass(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonIntegerFieldClass operator=(const CommonIntegerFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonFieldClass::operator=(fc);
        return *this;
    }

    CommonIntegerFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonIntegerFieldClass<const bt_field_class> {*this};
    }

    void fieldValueRange(const std::uint64_t n) const noexcept
    {
        static_assert(!std::is_const<LibObjT>::value,
                      "Not available with `bt2::ConstIntegerFieldClass`.");

        bt_field_class_integer_set_field_value_range(this->libObjPtr(), n);
    }

    std::uint64_t fieldValueRange() const noexcept
    {
        return bt_field_class_integer_get_field_value_range(this->libObjPtr());
    }

    void preferredDisplayBase(const DisplayBase base) const noexcept
    {
        static_assert(!std::is_const<LibObjT>::value,
                      "Not available with `bt2::ConstIntegerFieldClass`.");

        bt_field_class_integer_set_preferred_display_base(
            this->libObjPtr(), static_cast<bt_field_class_integer_preferred_display_base>(base));
    }

    DisplayBase preferredDisplayBase() const noexcept
    {
        return static_cast<DisplayBase>(
            bt_field_class_integer_get_preferred_display_base(this->libObjPtr()));
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using IntegerFieldClass = CommonIntegerFieldClass<bt_field_class>;
using ConstIntegerFieldClass = CommonIntegerFieldClass<const bt_field_class>;

namespace internal {

struct IntegerFieldClassTypeDescr
{
    using Const = ConstIntegerFieldClass;
    using NonConst = IntegerFieldClass;
};

template <>
struct TypeDescr<IntegerFieldClass> : public IntegerFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstIntegerFieldClass> : public IntegerFieldClassTypeDescr
{
};

template <typename LibObjT>
struct ConstEnumerationFieldClassMappingSpec;

/* Functions specific to unsigned enumeration field class mappings */
template <>
struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_unsigned_mapping>
    final
{
    static const bt_integer_range_set_unsigned *
    ranges(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
    {
        return bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(libObjPtr);
    }

    static const char *
    label(const bt_field_class_enumeration_unsigned_mapping * const libObjPtr) noexcept
    {
        return bt_field_class_enumeration_mapping_get_label(
            bt_field_class_enumeration_unsigned_mapping_as_mapping_const(libObjPtr));
    }
};

/* Functions specific to signed enumeration field class mappings */
template <>
struct ConstEnumerationFieldClassMappingSpec<const bt_field_class_enumeration_signed_mapping> final
{
    static const bt_integer_range_set_signed *
    ranges(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
    {
        return bt_field_class_enumeration_signed_mapping_borrow_ranges_const(libObjPtr);
    }

    static const char *
    label(const bt_field_class_enumeration_signed_mapping * const libObjPtr) noexcept
    {
        return bt_field_class_enumeration_mapping_get_label(
            bt_field_class_enumeration_signed_mapping_as_mapping_const(libObjPtr));
    }
};

} /* namespace internal */

template <typename LibObjT>
class ConstEnumerationFieldClassMapping final : public BorrowedObject<LibObjT>
{
private:
    using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;

public:
    using typename BorrowedObject<LibObjT>::LibObjPtr;

    using RangeSet = typename std::conditional<
        std::is_same<LibObjT, const bt_field_class_enumeration_unsigned_mapping>::value,
        ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;

    explicit ConstEnumerationFieldClassMapping(const LibObjPtr libObjPtr) noexcept :
        _ThisBorrowedObject {libObjPtr}
    {
    }

    ConstEnumerationFieldClassMapping(const ConstEnumerationFieldClassMapping& mapping) noexcept :
        _ThisBorrowedObject {mapping}
    {
    }

    ConstEnumerationFieldClassMapping
    operator=(const ConstEnumerationFieldClassMapping& mapping) noexcept
    {
        _ThisBorrowedObject::operator=(mapping);
        return *this;
    }

    RangeSet ranges() const noexcept
    {
        return RangeSet {
            internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::ranges(this->libObjPtr())};
    }

    const char *label() const noexcept
    {
        return internal::ConstEnumerationFieldClassMappingSpec<LibObjT>::label(this->libObjPtr());
    }
};

using ConstUnsignedEnumerationFieldClassMapping =
    ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_unsigned_mapping>;

using ConstSignedEnumerationFieldClassMapping =
    ConstEnumerationFieldClassMapping<const bt_field_class_enumeration_signed_mapping>;

namespace internal {

template <typename MappingT>
struct CommonEnumerationFieldClassSpec;

/* Functions specific to unsigned enumeration field classes */
template <>
struct CommonEnumerationFieldClassSpec<ConstUnsignedEnumerationFieldClassMapping> final
{
    static const bt_field_class_enumeration_unsigned_mapping *
    mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
    {
        return bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(libObjPtr, index);
    }

    static const bt_field_class_enumeration_unsigned_mapping *
    mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
    {
        return bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(libObjPtr, label);
    }

    static bt_field_class_enumeration_add_mapping_status
    addMapping(bt_field_class * const libObjPtr, const char * const label,
               const bt_integer_range_set_unsigned * const libRanges) noexcept
    {
        return bt_field_class_enumeration_unsigned_add_mapping(libObjPtr, label, libRanges);
    }
};

/* Functions specific to signed enumeration field classes */
template <>
struct CommonEnumerationFieldClassSpec<ConstSignedEnumerationFieldClassMapping> final
{
    static const bt_field_class_enumeration_signed_mapping *
    mappingByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
    {
        return bt_field_class_enumeration_signed_borrow_mapping_by_index_const(libObjPtr, index);
    }

    static const bt_field_class_enumeration_signed_mapping *
    mappingByLabel(const bt_field_class * const libObjPtr, const char * const label) noexcept
    {
        return bt_field_class_enumeration_signed_borrow_mapping_by_label_const(libObjPtr, label);
    }

    static bt_field_class_enumeration_add_mapping_status
    addMapping(bt_field_class * const libObjPtr, const char * const label,
               const bt_integer_range_set_signed * const libRanges) noexcept
    {
        return bt_field_class_enumeration_signed_add_mapping(libObjPtr, label, libRanges);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonBaseEnumerationFieldClass : public CommonIntegerFieldClass<LibObjT>
{
private:
    using typename CommonIntegerFieldClass<LibObjT>::_ThisCommonIntegerFieldClass;

protected:
    using _ThisCommonBaseEnumerationFieldClass = CommonBaseEnumerationFieldClass<LibObjT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<_ThisCommonBaseEnumerationFieldClass, LibObjT>;

    explicit CommonBaseEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonIntegerFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isEnumeration());
    }

    template <typename OtherLibObjT>
    CommonBaseEnumerationFieldClass(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
        :
        _ThisCommonIntegerFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonBaseEnumerationFieldClass
    operator=(const CommonBaseEnumerationFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonIntegerFieldClass::operator=(fc);
        return *this;
    }

    CommonBaseEnumerationFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonBaseEnumerationFieldClass<const bt_field_class> {*this};
    }

    std::uint64_t length() const noexcept
    {
        return bt_field_class_enumeration_get_mapping_count(this->libObjPtr());
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

template <typename LibObjT, typename MappingT>
class CommonEnumerationFieldClass final : public CommonBaseEnumerationFieldClass<LibObjT>
{
private:
    using typename CommonBaseEnumerationFieldClass<LibObjT>::_ThisCommonBaseEnumerationFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonEnumerationFieldClass, LibObjT>;
    using Iterator = BorrowedObjectIterator<CommonEnumerationFieldClass>;
    using Mapping = MappingT;

    explicit CommonEnumerationFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonBaseEnumerationFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isEnumeration());
    }

    template <typename OtherLibObjT>
    CommonEnumerationFieldClass(
        const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept :
        CommonEnumerationFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonEnumerationFieldClass
    operator=(const CommonEnumerationFieldClass<OtherLibObjT, MappingT> fc) noexcept
    {
        CommonEnumerationFieldClass::operator=(fc);
        return *this;
    }

    Mapping operator[](const std::uint64_t index) const noexcept
    {
        return Mapping {internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByIndex(
            this->libObjPtr(), index)};
    }

    OptionalBorrowedObject<Mapping> operator[](const char * const label) const noexcept
    {
        return internal::CommonEnumerationFieldClassSpec<MappingT>::mappingByLabel(
            this->libObjPtr(), label);
    }

    OptionalBorrowedObject<Mapping> operator[](const std::string& label) const noexcept
    {
        return (*this)[label.data()];
    }

    void addMapping(const char * const label, const typename Mapping::RangeSet ranges) const
    {
        const auto status = internal::CommonEnumerationFieldClassSpec<MappingT>::addMapping(
            this->libObjPtr(), label, ranges.libObjPtr());

        if (status == BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR) {
            throw MemoryError {};
        }
    }

    void addMapping(const std::string& label, const typename Mapping::RangeSet ranges) const
    {
        this->addMapping(label.data(), ranges);
    }

    Iterator begin() const noexcept
    {
        return Iterator {*this, 0};
    }

    Iterator end() const noexcept
    {
        return Iterator {*this, this->length()};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using EnumerationFieldClass = CommonBaseEnumerationFieldClass<bt_field_class>;
using ConstEnumerationFieldClass = CommonBaseEnumerationFieldClass<const bt_field_class>;

using UnsignedEnumerationFieldClass =
    CommonEnumerationFieldClass<bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;

using ConstUnsignedEnumerationFieldClass =
    CommonEnumerationFieldClass<const bt_field_class, ConstUnsignedEnumerationFieldClassMapping>;

using SignedEnumerationFieldClass =
    CommonEnumerationFieldClass<bt_field_class, ConstSignedEnumerationFieldClassMapping>;

using ConstSignedEnumerationFieldClass =
    CommonEnumerationFieldClass<const bt_field_class, ConstSignedEnumerationFieldClassMapping>;

namespace internal {

struct UnsignedEnumerationFieldClassTypeDescr
{
    using Const = ConstUnsignedEnumerationFieldClass;
    using NonConst = UnsignedEnumerationFieldClass;
};

template <>
struct TypeDescr<UnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstUnsignedEnumerationFieldClass> : public UnsignedEnumerationFieldClassTypeDescr
{
};

struct SignedEnumerationFieldClassTypeDescr
{
    using Const = ConstSignedEnumerationFieldClass;
    using NonConst = SignedEnumerationFieldClass;
};

template <>
struct TypeDescr<SignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstSignedEnumerationFieldClass> : public SignedEnumerationFieldClassTypeDescr
{
};

template <typename LibObjT>
struct CommonStructureFieldClassMemberSpec;

/* Functions specific to mutable structure field class members */
template <>
struct CommonStructureFieldClassMemberSpec<bt_field_class_structure_member> final
{
    static bt_field_class *fieldClass(bt_field_class_structure_member * const libObjPtr) noexcept
    {
        return bt_field_class_structure_member_borrow_field_class(libObjPtr);
    }

    static bt_value *userAttributes(bt_field_class_structure_member * const libObjPtr) noexcept
    {
        return bt_field_class_structure_member_borrow_user_attributes(libObjPtr);
    }
};

/* Functions specific to constant structure field class members */
template <>
struct CommonStructureFieldClassMemberSpec<const bt_field_class_structure_member> final
{
    static const bt_field_class *
    fieldClass(const bt_field_class_structure_member * const libObjPtr) noexcept
    {
        return bt_field_class_structure_member_borrow_field_class_const(libObjPtr);
    }

    static const bt_value *
    userAttributes(const bt_field_class_structure_member * const libObjPtr) noexcept
    {
        return bt_field_class_structure_member_borrow_user_attributes_const(libObjPtr);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonStructureFieldClassMember final : public BorrowedObject<LibObjT>
{
private:
    using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
    using _FieldClass = internal::DepFc<LibObjT>;

public:
    using typename BorrowedObject<LibObjT>::LibObjPtr;
    using UserAttributes = internal::DepUserAttrs<LibObjT>;

    explicit CommonStructureFieldClassMember(const LibObjPtr libObjPtr) noexcept :
        _ThisBorrowedObject {libObjPtr}
    {
    }

    template <typename OtherLibObjT>
    CommonStructureFieldClassMember(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
        :
        _ThisBorrowedObject {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonStructureFieldClassMember<LibObjT>
    operator=(const CommonStructureFieldClassMember<OtherLibObjT> fc) noexcept
    {
        _ThisBorrowedObject::operator=(fc);
        return *this;
    }

    CommonStructureFieldClassMember<const bt_field_class_structure_member> asConst() const noexcept
    {
        return CommonStructureFieldClassMember<const bt_field_class_structure_member> {*this};
    }

    const char *name() const noexcept
    {
        return bt_field_class_structure_member_get_name(this->libObjPtr());
    }

    _FieldClass fieldClass() const noexcept
    {
        return _FieldClass {
            internal::CommonStructureFieldClassMemberSpec<LibObjT>::fieldClass(this->libObjPtr())};
    }

    template <typename LibValT>
    void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
    {
        static_assert(!std::is_const<LibObjT>::value,
                      "Not available with `bt2::ConstStructureFieldClassMember`.");

        bt_field_class_structure_member_set_user_attributes(this->libObjPtr(),
                                                            userAttrs.libObjPtr());
    }

    UserAttributes userAttributes() const noexcept
    {
        return UserAttributes {
            internal::CommonStructureFieldClassMemberSpec<LibObjT>::userAttributes(
                this->libObjPtr())};
    }
};

using StructureFieldClassMember = CommonStructureFieldClassMember<bt_field_class_structure_member>;

using ConstStructureFieldClassMember =
    CommonStructureFieldClassMember<const bt_field_class_structure_member>;

namespace internal {

struct StructureFieldClassMemberTypeDescr
{
    using Const = ConstStructureFieldClassMember;
    using NonConst = StructureFieldClassMember;
};

template <>
struct TypeDescr<StructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
{
};

template <>
struct TypeDescr<ConstStructureFieldClassMember> : public StructureFieldClassMemberTypeDescr
{
};

template <typename LibObjT>
struct CommonStructureFieldClassSpec;

/* Functions specific to mutable structure field classes */
template <>
struct CommonStructureFieldClassSpec<bt_field_class> final
{
    static bt_field_class_structure_member *memberByIndex(bt_field_class * const libObjPtr,
                                                          const std::uint64_t index) noexcept
    {
        return bt_field_class_structure_borrow_member_by_index(libObjPtr, index);
    }

    static bt_field_class_structure_member *memberByName(bt_field_class * const libObjPtr,
                                                         const char * const name) noexcept
    {
        return bt_field_class_structure_borrow_member_by_name(libObjPtr, name);
    }
};

/* Functions specific to constant structure field classes */
template <>
struct CommonStructureFieldClassSpec<const bt_field_class> final
{
    static const bt_field_class_structure_member *
    memberByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
    {
        return bt_field_class_structure_borrow_member_by_index_const(libObjPtr, index);
    }

    static const bt_field_class_structure_member *
    memberByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
    {
        return bt_field_class_structure_borrow_member_by_name_const(libObjPtr, name);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonStructureFieldClass final : public CommonFieldClass<LibObjT>
{
private:
    using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonStructureFieldClass<LibObjT>, LibObjT>;
    using Iterator = BorrowedObjectIterator<CommonStructureFieldClass<LibObjT>>;

    using Member =
        internal::DepType<LibObjT, StructureFieldClassMember, ConstStructureFieldClassMember>;

    explicit CommonStructureFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isStructure());
    }

    template <typename OtherLibObjT>
    CommonStructureFieldClass(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonStructureFieldClass operator=(const CommonStructureFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonFieldClass::operator=(fc);
        return *this;
    }

    CommonStructureFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonStructureFieldClass<const bt_field_class> {*this};
    }

    void appendMember(const char * const name, const FieldClass fc) const
    {
        static_assert(!std::is_const<LibObjT>::value,
                      "Not available with `bt2::ConstStructureFieldClass`.");

        const auto status =
            bt_field_class_structure_append_member(this->libObjPtr(), name, fc.libObjPtr());

        if (status == BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR) {
            throw MemoryError {};
        }
    }

    void appendMember(const std::string& name, const FieldClass fc) const
    {
        this->appendMember(name.data(), fc);
    }

    std::uint64_t length() const noexcept
    {
        return bt_field_class_structure_get_member_count(this->libObjPtr());
    }

    Iterator begin() const noexcept
    {
        return Iterator {*this, 0};
    }

    Iterator end() const noexcept
    {
        return Iterator {*this, this->length()};
    }

    Member operator[](const std::uint64_t index) const noexcept
    {
        return Member {internal::CommonStructureFieldClassSpec<LibObjT>::memberByIndex(
            this->libObjPtr(), index)};
    }

    OptionalBorrowedObject<Member> operator[](const char * const name) const noexcept
    {
        return internal::CommonStructureFieldClassSpec<LibObjT>::memberByName(this->libObjPtr(),
                                                                              name);
    }

    OptionalBorrowedObject<Member> operator[](const std::string& name) const noexcept
    {
        return (*this)[name.data()];
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using StructureFieldClass = CommonStructureFieldClass<bt_field_class>;
using ConstStructureFieldClass = CommonStructureFieldClass<const bt_field_class>;

namespace internal {

struct StructureFieldClassTypeDescr
{
    using Const = ConstStructureFieldClass;
    using NonConst = StructureFieldClass;
};

template <>
struct TypeDescr<StructureFieldClass> : public StructureFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstStructureFieldClass> : public StructureFieldClassTypeDescr
{
};

template <typename LibObjT>
struct CommonArrayFieldClassSpec;

/* Functions specific to mutable array field classes */
template <>
struct CommonArrayFieldClassSpec<bt_field_class> final
{
    static bt_field_class *elementFieldClass(bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_array_borrow_element_field_class(libObjPtr);
    }
};

/* Functions specific to constant array field classes */
template <>
struct CommonArrayFieldClassSpec<const bt_field_class> final
{
    static const bt_field_class *elementFieldClass(const bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_array_borrow_element_field_class_const(libObjPtr);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonArrayFieldClass : public CommonFieldClass<LibObjT>
{
private:
    using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
    using _FieldClass = internal::DepFc<LibObjT>;

protected:
    using _ThisCommonArrayFieldClass = CommonArrayFieldClass<LibObjT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonArrayFieldClass<LibObjT>, LibObjT>;

    explicit CommonArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isArray());
    }

    template <typename OtherLibObjT>
    CommonArrayFieldClass(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonArrayFieldClass operator=(const CommonArrayFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonFieldClass::operator=(fc);
        return *this;
    }

    CommonArrayFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonArrayFieldClass<const bt_field_class> {*this};
    }

    _FieldClass elementFieldClass() const noexcept
    {
        return _FieldClass {
            internal::CommonArrayFieldClassSpec<LibObjT>::elementFieldClass(this->libObjPtr())};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using ArrayFieldClass = CommonArrayFieldClass<bt_field_class>;
using ConstArrayFieldClass = CommonArrayFieldClass<const bt_field_class>;

namespace internal {

struct ArrayFieldClassTypeDescr
{
    using Const = ConstArrayFieldClass;
    using NonConst = ArrayFieldClass;
};

template <>
struct TypeDescr<ArrayFieldClass> : public ArrayFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstArrayFieldClass> : public ArrayFieldClassTypeDescr
{
};

} /* namespace internal */

template <typename LibObjT>
class CommonStaticArrayFieldClass final : public CommonArrayFieldClass<LibObjT>
{
private:
    using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonStaticArrayFieldClass<LibObjT>, LibObjT>;

    explicit CommonStaticArrayFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonArrayFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isStaticArray());
    }

    template <typename OtherLibObjT>
    CommonStaticArrayFieldClass(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonArrayFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonStaticArrayFieldClass
    operator=(const CommonStaticArrayFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonArrayFieldClass::operator=(fc);
        return *this;
    }

    CommonStaticArrayFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonStaticArrayFieldClass<const bt_field_class> {*this};
    }

    std::uint64_t length() const noexcept
    {
        return bt_field_class_array_static_get_length(this->libObjPtr());
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using StaticArrayFieldClass = CommonStaticArrayFieldClass<bt_field_class>;
using ConstStaticArrayFieldClass = CommonStaticArrayFieldClass<const bt_field_class>;

namespace internal {

struct StaticArrayFieldClassTypeDescr
{
    using Const = ConstStaticArrayFieldClass;
    using NonConst = StaticArrayFieldClass;
};

template <>
struct TypeDescr<StaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstStaticArrayFieldClass> : public StaticArrayFieldClassTypeDescr
{
};

} /* namespace internal */

template <typename LibObjT>
class CommonDynamicArrayWithLengthFieldClass final : public CommonArrayFieldClass<LibObjT>
{
private:
    using typename CommonArrayFieldClass<LibObjT>::_ThisCommonArrayFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonDynamicArrayWithLengthFieldClass<LibObjT>, LibObjT>;

    explicit CommonDynamicArrayWithLengthFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonArrayFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isDynamicArrayWithLength());
    }

    template <typename OtherLibObjT>
    CommonDynamicArrayWithLengthFieldClass(
        const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonArrayFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonDynamicArrayWithLengthFieldClass
    operator=(const CommonDynamicArrayWithLengthFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonArrayFieldClass::operator=(fc);
        return *this;
    }

    CommonDynamicArrayWithLengthFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonDynamicArrayWithLengthFieldClass<const bt_field_class> {*this};
    }

    ConstFieldPath lengthFieldPath() const noexcept
    {
        return ConstFieldPath {
            bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
                this->libObjPtr())};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using DynamicArrayWithLengthFieldClass = CommonDynamicArrayWithLengthFieldClass<bt_field_class>;

using ConstDynamicArrayWithLengthFieldClass =
    CommonDynamicArrayWithLengthFieldClass<const bt_field_class>;

namespace internal {

struct DynamicArrayWithLengthFieldClassTypeDescr
{
    using Const = ConstDynamicArrayWithLengthFieldClass;
    using NonConst = DynamicArrayWithLengthFieldClass;
};

template <>
struct TypeDescr<DynamicArrayWithLengthFieldClass> :
    public DynamicArrayWithLengthFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstDynamicArrayWithLengthFieldClass> :
    public DynamicArrayWithLengthFieldClassTypeDescr
{
};

template <typename LibObjT>
struct CommonOptionFieldClassSpec;

/* Functions specific to mutable option field classes */
template <>
struct CommonOptionFieldClassSpec<bt_field_class> final
{
    static bt_field_class *fieldClass(bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_option_borrow_field_class(libObjPtr);
    }
};

/* Functions specific to constant option field classes */
template <>
struct CommonOptionFieldClassSpec<const bt_field_class> final
{
    static const bt_field_class *fieldClass(const bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_option_borrow_field_class_const(libObjPtr);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonOptionFieldClass : public CommonFieldClass<LibObjT>
{
private:
    using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;
    using _FieldClass = internal::DepFc<LibObjT>;

protected:
    using _ThisCommonOptionFieldClass = CommonOptionFieldClass<LibObjT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonOptionFieldClass<LibObjT>, LibObjT>;

    explicit CommonOptionFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isOption());
    }

    template <typename OtherLibObjT>
    CommonOptionFieldClass(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonOptionFieldClass operator=(const CommonOptionFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonFieldClass::operator=(fc);
        return *this;
    }

    CommonOptionFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonOptionFieldClass<const bt_field_class> {*this};
    }

    _FieldClass fieldClass() const noexcept
    {
        return _FieldClass {
            internal::CommonOptionFieldClassSpec<LibObjT>::fieldClass(this->libObjPtr())};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using OptionFieldClass = CommonOptionFieldClass<bt_field_class>;
using ConstOptionFieldClass = CommonOptionFieldClass<const bt_field_class>;

namespace internal {

struct OptionFieldClassTypeDescr
{
    using Const = ConstOptionFieldClass;
    using NonConst = OptionFieldClass;
};

template <>
struct TypeDescr<OptionFieldClass> : public OptionFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstOptionFieldClass> : public OptionFieldClassTypeDescr
{
};

} /* namespace internal */

template <typename LibObjT>
class CommonOptionWithSelectorFieldClass : public CommonOptionFieldClass<LibObjT>
{
private:
    using typename CommonOptionFieldClass<LibObjT>::_ThisCommonOptionFieldClass;

protected:
    using _ThisCommonOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<LibObjT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonOptionWithSelectorFieldClass<LibObjT>, LibObjT>;

    explicit CommonOptionWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonOptionFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isOptionWithSelector());
    }

    template <typename OtherLibObjT>
    CommonOptionWithSelectorFieldClass(
        const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonOptionFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonOptionWithSelectorFieldClass
    operator=(const CommonOptionWithSelectorFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonOptionFieldClass::operator=(fc);
        return *this;
    }

    CommonOptionWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonOptionWithSelectorFieldClass<const bt_field_class> {*this};
    }

    ConstFieldPath selectorFieldPath() const noexcept
    {
        return ConstFieldPath {
            bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
                this->libObjPtr())};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using OptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<bt_field_class>;
using ConstOptionWithSelectorFieldClass = CommonOptionWithSelectorFieldClass<const bt_field_class>;

namespace internal {

struct OptionWithSelectorFieldClassTypeDescr
{
    using Const = ConstOptionWithSelectorFieldClass;
    using NonConst = OptionWithSelectorFieldClass;
};

template <>
struct TypeDescr<OptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstOptionWithSelectorFieldClass> : public OptionWithSelectorFieldClassTypeDescr
{
};

} /* namespace internal */

template <typename LibObjT>
class CommonOptionWithBoolSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
{
private:
    using typename CommonOptionWithSelectorFieldClass<
        LibObjT>::_ThisCommonOptionWithSelectorFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonOptionWithBoolSelectorFieldClass<LibObjT>, LibObjT>;

    explicit CommonOptionWithBoolSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isOptionWithBoolSelector());
    }

    template <typename OtherLibObjT>
    CommonOptionWithBoolSelectorFieldClass(
        const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonOptionWithSelectorFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonOptionWithBoolSelectorFieldClass
    operator=(const CommonOptionWithBoolSelectorFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
        return *this;
    }

    CommonOptionWithBoolSelectorFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonOptionWithBoolSelectorFieldClass<const bt_field_class> {*this};
    }

    bool selectorIsReversed() const noexcept
    {
        return bt_field_class_option_with_selector_field_bool_selector_is_reversed(
            this->libObjPtr());
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using OptionWithBoolSelectorFieldClass = CommonOptionWithBoolSelectorFieldClass<bt_field_class>;

using ConstOptionWithBoolSelectorFieldClass =
    CommonOptionWithBoolSelectorFieldClass<const bt_field_class>;

namespace internal {

struct OptionWithBoolSelectorFieldClassTypeDescr
{
    using Const = ConstOptionWithBoolSelectorFieldClass;
    using NonConst = OptionWithBoolSelectorFieldClass;
};

template <>
struct TypeDescr<OptionWithBoolSelectorFieldClass> :
    public OptionWithBoolSelectorFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstOptionWithBoolSelectorFieldClass> :
    public OptionWithBoolSelectorFieldClassTypeDescr
{
};

template <typename RangeSetT>
struct CommonOptionWithIntegerSelectorFieldClassSpec;

/* Functions specific to option field classes with unsigned integer ranges */
template <>
struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstUnsignedIntegerRangeSet> final
{
    static const bt_integer_range_set_unsigned *
    ranges(const bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
            libObjPtr);
    }
};

/* Functions specific to option field classes with signed ranges */
template <>
struct CommonOptionWithIntegerSelectorFieldClassSpec<ConstSignedIntegerRangeSet> final
{
    static const bt_integer_range_set_signed *
    ranges(const bt_field_class * const libObjPtr) noexcept
    {
        return bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
            libObjPtr);
    }
};

} /* namespace internal */

template <typename LibObjT, typename RangeSetT>
class CommonOptionWithIntegerSelectorFieldClass : public CommonOptionWithSelectorFieldClass<LibObjT>
{
private:
    using typename CommonOptionWithSelectorFieldClass<
        LibObjT>::_ThisCommonOptionWithSelectorFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonOptionWithIntegerSelectorFieldClass, LibObjT>;
    using RangeSet = RangeSetT;

    explicit CommonOptionWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonOptionWithSelectorFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isOptionWithIntegerSelector());
    }

    template <typename OtherLibObjT>
    CommonOptionWithIntegerSelectorFieldClass(
        const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept :
        _ThisCommonOptionWithSelectorFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonOptionWithIntegerSelectorFieldClass
    operator=(const CommonOptionWithIntegerSelectorFieldClass<OtherLibObjT, RangeSetT> fc) noexcept
    {
        _ThisCommonOptionWithSelectorFieldClass::operator=(fc);
        return *this;
    }

    RangeSet ranges() const noexcept
    {
        return RangeSet {internal::CommonOptionWithIntegerSelectorFieldClassSpec<RangeSetT>::ranges(
            this->libObjPtr())};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using OptionWithUnsignedIntegerSelectorFieldClass =
    CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstUnsignedIntegerRangeSet>;

using ConstOptionWithUnsignedIntegerSelectorFieldClass =
    CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstUnsignedIntegerRangeSet>;

using OptionWithSignedIntegerSelectorFieldClass =
    CommonOptionWithIntegerSelectorFieldClass<bt_field_class, ConstSignedIntegerRangeSet>;

using ConstOptionWithSignedIntegerSelectorFieldClass =
    CommonOptionWithIntegerSelectorFieldClass<const bt_field_class, ConstSignedIntegerRangeSet>;

namespace internal {

struct OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
{
    using Const = ConstOptionWithUnsignedIntegerSelectorFieldClass;
    using NonConst = OptionWithUnsignedIntegerSelectorFieldClass;
};

template <>
struct TypeDescr<OptionWithUnsignedIntegerSelectorFieldClass> :
    public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstOptionWithUnsignedIntegerSelectorFieldClass> :
    public OptionWithUnsignedIntegerSelectorFieldClassTypeDescr
{
};

struct OptionWithSignedIntegerSelectorFieldClassTypeDescr
{
    using Const = ConstOptionWithSignedIntegerSelectorFieldClass;
    using NonConst = OptionWithSignedIntegerSelectorFieldClass;
};

template <>
struct TypeDescr<OptionWithSignedIntegerSelectorFieldClass> :
    public OptionWithSignedIntegerSelectorFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstOptionWithSignedIntegerSelectorFieldClass> :
    public OptionWithSignedIntegerSelectorFieldClassTypeDescr
{
};

template <typename LibObjT>
struct CommonVariantFieldClassOptionSpec;

/* Functions specific to mutable variant field class options */
template <>
struct CommonVariantFieldClassOptionSpec<bt_field_class_variant_option> final
{
    static bt_field_class *fieldClass(bt_field_class_variant_option * const libObjPtr) noexcept
    {
        return bt_field_class_variant_option_borrow_field_class(libObjPtr);
    }

    static bt_value *userAttributes(bt_field_class_variant_option * const libObjPtr) noexcept
    {
        return bt_field_class_variant_option_borrow_user_attributes(libObjPtr);
    }
};

/* Functions specific to constant variant field class options */
template <>
struct CommonVariantFieldClassOptionSpec<const bt_field_class_variant_option> final
{
    static const bt_field_class *
    fieldClass(const bt_field_class_variant_option * const libObjPtr) noexcept
    {
        return bt_field_class_variant_option_borrow_field_class_const(libObjPtr);
    }

    static const bt_value *
    userAttributes(const bt_field_class_variant_option * const libObjPtr) noexcept
    {
        return bt_field_class_variant_option_borrow_user_attributes_const(libObjPtr);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonVariantFieldClassOption : public BorrowedObject<LibObjT>
{
private:
    using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
    using _FieldClass = internal::DepFc<LibObjT>;

public:
    using typename BorrowedObject<LibObjT>::LibObjPtr;
    using UserAttributes = internal::DepUserAttrs<LibObjT>;

    explicit CommonVariantFieldClassOption(const LibObjPtr libObjPtr) noexcept :
        _ThisBorrowedObject {libObjPtr}
    {
    }

    template <typename OtherLibObjT>
    CommonVariantFieldClassOption(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept :
        _ThisBorrowedObject {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonVariantFieldClassOption
    operator=(const CommonVariantFieldClassOption<OtherLibObjT> fc) noexcept
    {
        _ThisBorrowedObject::operator=(fc);
        return *this;
    }

    CommonVariantFieldClassOption<const bt_field_class_variant_option> asConst() const noexcept
    {
        return CommonVariantFieldClassOption<const bt_field_class_variant_option> {*this};
    }

    const char *name() const noexcept
    {
        return bt_field_class_variant_option_get_name(this->libObjPtr());
    }

    _FieldClass fieldClass() const noexcept
    {
        return _FieldClass {
            internal::CommonVariantFieldClassOptionSpec<LibObjT>::fieldClass(this->libObjPtr())};
    }

    template <typename LibValT>
    void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
    {
        static_assert(!std::is_const<LibObjT>::value,
                      "Not available with `bt2::ConstVariantFieldClassOption`.");

        bt_field_class_variant_option_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
    }

    UserAttributes userAttributes() const noexcept
    {
        return UserAttributes {internal::CommonVariantFieldClassOptionSpec<LibObjT>::userAttributes(
            this->libObjPtr())};
    }
};

using VariantFieldClassOption = CommonVariantFieldClassOption<bt_field_class_variant_option>;

using ConstVariantFieldClassOption =
    CommonVariantFieldClassOption<const bt_field_class_variant_option>;

namespace internal {

struct VariantFieldClassOptionTypeDescr
{
    using Const = ConstVariantFieldClassOption;
    using NonConst = VariantFieldClassOption;
};

template <>
struct TypeDescr<VariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
{
};

template <>
struct TypeDescr<ConstVariantFieldClassOption> : public VariantFieldClassOptionTypeDescr
{
};

template <typename LibObjT>
struct ConstVariantWithIntegerSelectorFieldClassOptionSpec;

/* Functions specific to variant field class options with unsigned integer selector */
template <>
struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
    const bt_field_class_variant_with_selector_field_integer_unsigned_option>
    final
{
    static const bt_integer_range_set_unsigned *
    ranges(const bt_field_class_variant_with_selector_field_integer_unsigned_option
               * const libObjPtr) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
            libObjPtr);
    }

    static const bt_field_class_variant_option *
    asBaseOption(const bt_field_class_variant_with_selector_field_integer_unsigned_option
                     * const libObjPtr) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
            libObjPtr);
    }
};

/* Functions specific to variant field class options with signed integer selector */
template <>
struct ConstVariantWithIntegerSelectorFieldClassOptionSpec<
    const bt_field_class_variant_with_selector_field_integer_signed_option>
    final
{
    static const bt_integer_range_set_signed *
    ranges(const bt_field_class_variant_with_selector_field_integer_signed_option
               * const libObjPtr) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
            libObjPtr);
    }

    static const bt_field_class_variant_option *
    asBaseOption(const bt_field_class_variant_with_selector_field_integer_signed_option
                     * const libObjPtr) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
            libObjPtr);
    }
};

} /* namespace internal */

template <typename LibObjT>
class ConstVariantWithIntegerSelectorFieldClassOption : public BorrowedObject<LibObjT>
{
private:
    using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
    using _Spec = internal::ConstVariantWithIntegerSelectorFieldClassOptionSpec<LibObjT>;

public:
    using typename BorrowedObject<LibObjT>::LibObjPtr;

    using RangeSet = typename std::conditional<
        std::is_same<
            LibObjT,
            const bt_field_class_variant_with_selector_field_integer_unsigned_option>::value,
        ConstUnsignedIntegerRangeSet, ConstSignedIntegerRangeSet>::type;

    explicit ConstVariantWithIntegerSelectorFieldClassOption(const LibObjPtr libObjPtr) noexcept :
        _ThisBorrowedObject {libObjPtr}
    {
    }

    template <typename OtherLibObjT>
    ConstVariantWithIntegerSelectorFieldClassOption(
        const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept :
        _ThisBorrowedObject {fc}
    {
    }

    template <typename OtherLibObjT>
    ConstVariantWithIntegerSelectorFieldClassOption
    operator=(const ConstVariantWithIntegerSelectorFieldClassOption<OtherLibObjT> fc) noexcept
    {
        _ThisBorrowedObject::operator=(fc);
        return *this;
    }

    ConstVariantFieldClassOption asBaseOption() const noexcept
    {
        return ConstVariantFieldClassOption {_Spec::asBaseOption(this->libObjPtr())};
    }

    const char *name() const noexcept
    {
        return this->asBaseOption().name();
    }

    ConstFieldClass fieldClass() const noexcept
    {
        return this->asBaseOption().fieldClass();
    }

    RangeSet ranges() const noexcept
    {
        return RangeSet {_Spec::ranges(this->libObjPtr())};
    }
};

using ConstVariantWithUnsignedIntegerSelectorFieldClassOption =
    ConstVariantWithIntegerSelectorFieldClassOption<
        const bt_field_class_variant_with_selector_field_integer_unsigned_option>;

using ConstVariantWithSignedIntegerSelectorFieldClassOption =
    ConstVariantWithIntegerSelectorFieldClassOption<
        const bt_field_class_variant_with_selector_field_integer_signed_option>;

namespace internal {

template <typename LibObjT>
struct CommonVariantFieldClassSpec;

/* Functions specific to mutable variant field classes */
template <>
struct CommonVariantFieldClassSpec<bt_field_class> final
{
    static bt_field_class_variant_option *optionByIndex(bt_field_class * const libObjPtr,
                                                        const std::uint64_t index) noexcept
    {
        return bt_field_class_variant_borrow_option_by_index(libObjPtr, index);
    }

    static bt_field_class_variant_option *optionByName(bt_field_class * const libObjPtr,
                                                       const char * const name) noexcept
    {
        return bt_field_class_variant_borrow_option_by_name(libObjPtr, name);
    }
};

/* Functions specific to constant variant field classes */
template <>
struct CommonVariantFieldClassSpec<const bt_field_class> final
{
    static const bt_field_class_variant_option *
    optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
    {
        return bt_field_class_variant_borrow_option_by_index_const(libObjPtr, index);
    }

    static const bt_field_class_variant_option *optionByName(const bt_field_class * const libObjPtr,
                                                             const char * const name) noexcept
    {
        return bt_field_class_variant_borrow_option_by_name_const(libObjPtr, name);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonVariantFieldClass : public CommonFieldClass<LibObjT>
{
private:
    using typename CommonFieldClass<LibObjT>::_ThisCommonFieldClass;

protected:
    using _ThisCommonVariantFieldClass = CommonVariantFieldClass<LibObjT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonVariantFieldClass<LibObjT>, LibObjT>;
    using Iterator = BorrowedObjectIterator<CommonVariantFieldClass>;

    using Option =
        internal::DepType<LibObjT, VariantFieldClassOption, ConstVariantFieldClassOption>;

    explicit CommonVariantFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isVariant());
    }

    template <typename OtherLibObjT>
    CommonVariantFieldClass(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonVariantFieldClass operator=(const CommonVariantFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonFieldClass::operator=(fc);
        return *this;
    }

    CommonVariantFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonVariantFieldClass<const bt_field_class> {*this};
    }

    std::uint64_t length() const noexcept
    {
        return bt_field_class_variant_get_option_count(this->libObjPtr());
    }

    Iterator begin() const noexcept
    {
        return Iterator {*this, 0};
    }

    Iterator end() const noexcept
    {
        return Iterator {*this, this->length()};
    }

    Option operator[](const std::uint64_t index) const noexcept
    {
        return Option {internal::CommonVariantFieldClassSpec<LibObjT>::optionByIndex(
            this->libObjPtr(), index)};
    }

    OptionalBorrowedObject<Option> operator[](const char * const name) const noexcept
    {
        return internal::CommonVariantFieldClassSpec<LibObjT>::optionByName(this->libObjPtr(),
                                                                            name);
    }

    OptionalBorrowedObject<Option> operator[](const std::string& name) const noexcept
    {
        return (*this)[name.data()];
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using VariantFieldClass = CommonVariantFieldClass<bt_field_class>;
using ConstVariantFieldClass = CommonVariantFieldClass<const bt_field_class>;

namespace internal {

struct VariantFieldClassTypeDescr
{
    using Const = ConstVariantFieldClass;
    using NonConst = VariantFieldClass;
};

template <>
struct TypeDescr<VariantFieldClass> : public VariantFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstVariantFieldClass> : public VariantFieldClassTypeDescr
{
};

} /* namespace internal */

template <typename LibObjT>
class CommonVariantWithoutSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
{
private:
    using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonVariantWithoutSelectorFieldClass<LibObjT>, LibObjT>;

    explicit CommonVariantWithoutSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonVariantFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isVariantWithoutSelector());
    }

    template <typename OtherLibObjT>
    CommonVariantWithoutSelectorFieldClass(
        const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonVariantFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonVariantWithoutSelectorFieldClass
    operator=(const CommonVariantWithoutSelectorFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonVariantFieldClass::operator=(fc);
        return *this;
    }

    CommonVariantWithoutSelectorFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonVariantWithoutSelectorFieldClass<const bt_field_class> {*this};
    }

    void appendOption(const char * const name, const FieldClass fc) const
    {
        static_assert(!std::is_const<LibObjT>::value,
                      "Not available with `bt2::ConstVariantWithoutSelectorFieldClass`.");

        const auto status = bt_field_class_variant_without_selector_append_option(
            this->libObjPtr(), name, fc.libObjPtr());

        if (status ==
            BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
            throw MemoryError {};
        }
    }

    void appendOption(const bt2s::optional<std::string>& name, const FieldClass fc) const
    {
        this->appendOption(name ? name->data() : nullptr, fc);
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using VariantWithoutSelectorFieldClass = CommonVariantWithoutSelectorFieldClass<bt_field_class>;
using ConstVariantWithoutSelectorFieldClass =
    CommonVariantWithoutSelectorFieldClass<const bt_field_class>;

namespace internal {

struct VariantWithoutSelectorFieldClassTypeDescr
{
    using Const = ConstVariantWithoutSelectorFieldClass;
    using NonConst = VariantWithoutSelectorFieldClass;
};

template <>
struct TypeDescr<VariantWithoutSelectorFieldClass> :
    public VariantWithoutSelectorFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstVariantWithoutSelectorFieldClass> :
    public VariantWithoutSelectorFieldClassTypeDescr
{
};

template <typename OptionT>
struct CommonVariantWithIntegerSelectorFieldClassSpec;

/* Functions specific to variant field classes with unsigned integer selector */
template <>
struct CommonVariantWithIntegerSelectorFieldClassSpec<
    ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
    final
{
    static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
    optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
            libObjPtr, index);
    }

    static const bt_field_class_variant_with_selector_field_integer_unsigned_option *
    optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
            libObjPtr, name);
    }

    static bt_field_class_variant_with_selector_field_integer_append_option_status
    appendOption(bt_field_class * const libObjPtr, const char * const name,
                 bt_field_class * const libOptFcPtr,
                 const bt_integer_range_set_unsigned * const libRangesPtr)
    {
        return bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
            libObjPtr, name, libOptFcPtr, libRangesPtr);
    }
};

/* Functions specific to variant field classes with signed integer selector */
template <>
struct CommonVariantWithIntegerSelectorFieldClassSpec<
    ConstVariantWithSignedIntegerSelectorFieldClassOption>
    final
{
    static const bt_field_class_variant_with_selector_field_integer_signed_option *
    optionByIndex(const bt_field_class * const libObjPtr, const std::uint64_t index) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
            libObjPtr, index);
    }

    static const bt_field_class_variant_with_selector_field_integer_signed_option *
    optionByName(const bt_field_class * const libObjPtr, const char * const name) noexcept
    {
        return bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
            libObjPtr, name);
    }

    static bt_field_class_variant_with_selector_field_integer_append_option_status
    appendOption(bt_field_class * const libObjPtr, const char * const name,
                 bt_field_class * const libOptFcPtr,
                 const bt_integer_range_set_signed * const libRangesPtr)
    {
        return bt_field_class_variant_with_selector_field_integer_signed_append_option(
            libObjPtr, name, libOptFcPtr, libRangesPtr);
    }
};

} /* namespace internal */

template <typename LibObjT>
class CommonVariantWithSelectorFieldClass : public CommonVariantFieldClass<LibObjT>
{
private:
    using typename CommonVariantFieldClass<LibObjT>::_ThisCommonVariantFieldClass;

protected:
    using _ThisCommonVariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<LibObjT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<_ThisCommonVariantWithSelectorFieldClass, LibObjT>;

    explicit CommonVariantWithSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonVariantFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isVariantWithSelector());
    }

    template <typename OtherLibObjT>
    CommonVariantWithSelectorFieldClass(
        const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept :
        _ThisCommonVariantFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonVariantWithSelectorFieldClass
    operator=(const CommonVariantWithSelectorFieldClass<OtherLibObjT> fc) noexcept
    {
        _ThisCommonVariantFieldClass::operator=(fc);
        return *this;
    }

    CommonVariantWithSelectorFieldClass<const bt_field_class> asConst() const noexcept
    {
        return CommonVariantWithSelectorFieldClass<const bt_field_class> {*this};
    }

    ConstFieldPath selectorFieldPath() const noexcept
    {
        return ConstFieldPath {
            bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
                this->libObjPtr())};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using VariantWithSelectorFieldClass = CommonVariantWithSelectorFieldClass<bt_field_class>;
using ConstVariantWithSelectorFieldClass =
    CommonVariantWithSelectorFieldClass<const bt_field_class>;

template <typename LibObjT, typename OptionT>
class CommonVariantWithIntegerSelectorFieldClass :
    public CommonVariantWithSelectorFieldClass<LibObjT>
{
private:
    using typename CommonVariantWithSelectorFieldClass<
        LibObjT>::_ThisCommonVariantWithSelectorFieldClass;

    using _Spec = internal::CommonVariantWithIntegerSelectorFieldClassSpec<OptionT>;

public:
    using typename CommonFieldClass<LibObjT>::LibObjPtr;
    using Shared = SharedFieldClass<CommonVariantWithIntegerSelectorFieldClass, LibObjT>;
    using Option = OptionT;

    using Iterator =
        BorrowedObjectIterator<CommonVariantWithIntegerSelectorFieldClass<LibObjT, Option>>;

    explicit CommonVariantWithIntegerSelectorFieldClass(const LibObjPtr libObjPtr) noexcept :
        _ThisCommonVariantWithSelectorFieldClass {libObjPtr}
    {
        BT_ASSERT_DBG(this->isVariant());
    }

    template <typename OtherLibObjT>
    CommonVariantWithIntegerSelectorFieldClass(
        const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept :
        _ThisCommonVariantWithSelectorFieldClass {fc}
    {
    }

    template <typename OtherLibObjT>
    CommonVariantWithIntegerSelectorFieldClass
    operator=(const CommonVariantWithIntegerSelectorFieldClass<OtherLibObjT, OptionT> fc) noexcept
    {
        _ThisCommonVariantWithSelectorFieldClass::operator=(fc);
        return *this;
    }

    Option operator[](const std::uint64_t index) const noexcept
    {
        return Option {_Spec::optionByIndex(this->libObjPtr(), index)};
    }

    OptionalBorrowedObject<Option> operator[](const char * const name) const noexcept
    {
        return _Spec::optionByName(this->libObjPtr(), name);
    }

    OptionalBorrowedObject<Option> operator[](const std::string& name) const noexcept
    {
        return (*this)[name.data()];
    }

    void appendOption(const char * const name, const FieldClass fc,
                      const typename Option::RangeSet ranges) const
    {
        static_assert(
            !std::is_const<LibObjT>::value,
            "Not available with `bt2::ConstVariantWithUnsignedIntegerSelectorFieldClass`.");

        const auto status =
            _Spec::appendOption(this->libObjPtr(), name, fc.libObjPtr(), ranges.libObjPtr());

        if (status ==
            BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR) {
            throw MemoryError {};
        }
    }

    void appendOption(const bt2s::optional<std::string>& name, const FieldClass fc,
                      const typename Option::RangeSet ranges) const
    {
        this->appendOption(name ? name->data() : nullptr, fc, ranges);
    }

    Iterator begin() const noexcept
    {
        return Iterator {*this, 0};
    }

    Iterator end() const noexcept
    {
        return Iterator {*this, this->length()};
    }

    Shared shared() const noexcept
    {
        return Shared::createWithRef(*this);
    }
};

using VariantWithUnsignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
    bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;

using ConstVariantWithUnsignedIntegerSelectorFieldClass =
    CommonVariantWithIntegerSelectorFieldClass<
        const bt_field_class, ConstVariantWithUnsignedIntegerSelectorFieldClassOption>;

using VariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
    bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;

using ConstVariantWithSignedIntegerSelectorFieldClass = CommonVariantWithIntegerSelectorFieldClass<
    const bt_field_class, ConstVariantWithSignedIntegerSelectorFieldClassOption>;

namespace internal {

struct VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
{
    using Const = ConstVariantWithUnsignedIntegerSelectorFieldClass;
    using NonConst = VariantWithUnsignedIntegerSelectorFieldClass;
};

template <>
struct TypeDescr<VariantWithUnsignedIntegerSelectorFieldClass> :
    public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstVariantWithUnsignedIntegerSelectorFieldClass> :
    public VariantWithUnsignedIntegerSelectorFieldClassTypeDescr
{
};

struct VariantWithSignedIntegerSelectorFieldClassTypeDescr
{
    using Const = ConstVariantWithSignedIntegerSelectorFieldClass;
    using NonConst = VariantWithSignedIntegerSelectorFieldClass;
};

template <>
struct TypeDescr<VariantWithSignedIntegerSelectorFieldClass> :
    public VariantWithSignedIntegerSelectorFieldClassTypeDescr
{
};

template <>
struct TypeDescr<ConstVariantWithSignedIntegerSelectorFieldClass> :
    public VariantWithSignedIntegerSelectorFieldClassTypeDescr
{
};

} /* namespace internal */

template <typename LibObjT>
CommonBitArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asBitArray() const noexcept
{
    BT_ASSERT_DBG(this->isBitArray());
    return CommonBitArrayFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonIntegerFieldClass<LibObjT> CommonFieldClass<LibObjT>::asInteger() const noexcept
{
    BT_ASSERT_DBG(this->isInteger());
    return CommonIntegerFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonBaseEnumerationFieldClass<LibObjT> CommonFieldClass<LibObjT>::asEnumeration() const noexcept
{
    BT_ASSERT_DBG(this->isEnumeration());
    return CommonBaseEnumerationFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping>
CommonFieldClass<LibObjT>::asUnsignedEnumeration() const noexcept
{
    BT_ASSERT_DBG(this->isUnsignedEnumeration());
    return CommonEnumerationFieldClass<LibObjT, ConstUnsignedEnumerationFieldClassMapping> {
        this->libObjPtr()};
}

template <typename LibObjT>
CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping>
CommonFieldClass<LibObjT>::asSignedEnumeration() const noexcept
{
    BT_ASSERT_DBG(this->isSignedEnumeration());
    return CommonEnumerationFieldClass<LibObjT, ConstSignedEnumerationFieldClassMapping> {
        this->libObjPtr()};
}

template <typename LibObjT>
CommonStructureFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStructure() const noexcept
{
    BT_ASSERT_DBG(this->isStructure());
    return CommonStructureFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asArray() const noexcept
{
    BT_ASSERT_DBG(this->isArray());
    return CommonArrayFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonStaticArrayFieldClass<LibObjT> CommonFieldClass<LibObjT>::asStaticArray() const noexcept
{
    BT_ASSERT_DBG(this->isStaticArray());
    return CommonStaticArrayFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonDynamicArrayWithLengthFieldClass<LibObjT>
CommonFieldClass<LibObjT>::asDynamicArrayWithLength() const noexcept
{
    BT_ASSERT_DBG(this->isDynamicArrayWithLength());
    return CommonDynamicArrayWithLengthFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonOptionFieldClass<LibObjT> CommonFieldClass<LibObjT>::asOption() const noexcept
{
    BT_ASSERT_DBG(this->isOption());
    return CommonOptionFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonOptionWithSelectorFieldClass<LibObjT>
CommonFieldClass<LibObjT>::asOptionWithSelector() const noexcept
{
    BT_ASSERT_DBG(this->isOptionWithSelector());
    return CommonOptionWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonOptionWithBoolSelectorFieldClass<LibObjT>
CommonFieldClass<LibObjT>::asOptionWithBoolSelector() const noexcept
{
    BT_ASSERT_DBG(this->isOptionWithBoolSelector());
    return CommonOptionWithBoolSelectorFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet>
CommonFieldClass<LibObjT>::asOptionWithUnsignedIntegerSelector() const noexcept
{
    BT_ASSERT_DBG(this->isOptionWithUnsignedIntegerSelector());
    return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstUnsignedIntegerRangeSet> {
        this->libObjPtr()};
}

template <typename LibObjT>
CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet>
CommonFieldClass<LibObjT>::asOptionWithSignedIntegerSelector() const noexcept
{
    BT_ASSERT_DBG(this->isOptionWithSignedIntegerSelector());
    return CommonOptionWithIntegerSelectorFieldClass<LibObjT, ConstSignedIntegerRangeSet> {
        this->libObjPtr()};
}

template <typename LibObjT>
CommonVariantFieldClass<LibObjT> CommonFieldClass<LibObjT>::asVariant() const noexcept
{
    BT_ASSERT_DBG(this->isVariant());
    return CommonVariantFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonVariantWithoutSelectorFieldClass<LibObjT>
CommonFieldClass<LibObjT>::asVariantWithoutSelector() const noexcept
{
    BT_ASSERT_DBG(this->isVariantWithoutSelector());
    return CommonVariantWithoutSelectorFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonVariantWithSelectorFieldClass<LibObjT>
CommonFieldClass<LibObjT>::asVariantWithSelector() const noexcept
{
    BT_ASSERT_DBG(this->isVariantWithSelector());
    return CommonVariantWithSelectorFieldClass<LibObjT> {this->libObjPtr()};
}

template <typename LibObjT>
CommonVariantWithIntegerSelectorFieldClass<LibObjT,
                                           ConstVariantWithUnsignedIntegerSelectorFieldClassOption>
CommonFieldClass<LibObjT>::asVariantWithUnsignedIntegerSelector() const noexcept
{
    BT_ASSERT_DBG(this->isVariantWithUnsignedIntegerSelector());
    return CommonVariantWithIntegerSelectorFieldClass<
        LibObjT, ConstVariantWithUnsignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
}

template <typename LibObjT>
CommonVariantWithIntegerSelectorFieldClass<LibObjT,
                                           ConstVariantWithSignedIntegerSelectorFieldClassOption>
CommonFieldClass<LibObjT>::asVariantWithSignedIntegerSelector() const noexcept
{
    BT_ASSERT_DBG(this->isVariantWithSignedIntegerSelector());
    return CommonVariantWithIntegerSelectorFieldClass<
        LibObjT, ConstVariantWithSignedIntegerSelectorFieldClassOption> {this->libObjPtr()};
}

} /* namespace bt2 */

#endif /* BABELTRACE_CPP_COMMON_BT2_FIELD_CLASS_HPP */