field-class.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
#define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <stdint.h>
#include <stddef.h>
 
#include <babeltrace2/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum bt_field_class_type {
    BT_FIELD_CLASS_TYPE_BOOL                        = 1ULL << 0,
 
    BT_FIELD_CLASS_TYPE_BIT_ARRAY                       = 1ULL << 1,
 
    BT_FIELD_CLASS_TYPE_INTEGER                     = 1ULL << 2,
 
    BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER                    = (1ULL << 3) | BT_FIELD_CLASS_TYPE_INTEGER,
 
    BT_FIELD_CLASS_TYPE_SIGNED_INTEGER                  = (1ULL << 4) | BT_FIELD_CLASS_TYPE_INTEGER,
 
    BT_FIELD_CLASS_TYPE_ENUMERATION                     = 1ULL << 5,
 
    BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION                = BT_FIELD_CLASS_TYPE_ENUMERATION | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
 
    BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION                  = BT_FIELD_CLASS_TYPE_ENUMERATION | BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
 
    BT_FIELD_CLASS_TYPE_REAL                        = 1ULL << 6,
 
    BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL               = (1ULL << 7) | BT_FIELD_CLASS_TYPE_REAL,
 
    BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL               = (1ULL << 8) | BT_FIELD_CLASS_TYPE_REAL,
 
    BT_FIELD_CLASS_TYPE_STRING                      = 1ULL << 9,
 
    BT_FIELD_CLASS_TYPE_BLOB                        = (1ULL << 29),
 
    BT_FIELD_CLASS_TYPE_STATIC_BLOB                     = (1ULL << 30) | BT_FIELD_CLASS_TYPE_BLOB,
 
    BT_FIELD_CLASS_TYPE_DYNAMIC_BLOB                    = (1ULL << 31) | BT_FIELD_CLASS_TYPE_BLOB,
 
    BT_FIELD_CLASS_TYPE_DYNAMIC_BLOB_WITHOUT_LENGTH_FIELD           = (1ULL << 32) | BT_FIELD_CLASS_TYPE_DYNAMIC_BLOB,
 
    BT_FIELD_CLASS_TYPE_DYNAMIC_BLOB_WITH_LENGTH_FIELD          = (1ULL << 33) | BT_FIELD_CLASS_TYPE_DYNAMIC_BLOB,
 
    BT_FIELD_CLASS_TYPE_STRUCTURE                       = 1ULL << 10,
 
    BT_FIELD_CLASS_TYPE_ARRAY                       = 1ULL << 11,
 
    BT_FIELD_CLASS_TYPE_STATIC_ARRAY                    = (1ULL << 12) | BT_FIELD_CLASS_TYPE_ARRAY,
 
    BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY                   = (1ULL << 13) | BT_FIELD_CLASS_TYPE_ARRAY,
 
    BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD          = (1ULL << 14) | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
 
    BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD         = (1ULL << 15) | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
 
    BT_FIELD_CLASS_TYPE_OPTION                      = 1ULL << 16,
 
    BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD           = (1ULL << 17) | BT_FIELD_CLASS_TYPE_OPTION,
 
    BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD              = (1ULL << 18) | BT_FIELD_CLASS_TYPE_OPTION,
 
    BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD         = (1ULL << 19) | BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD,
 
    BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD          = (1ULL << 20) | BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD,
 
    BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD     = (1ULL << 21) | BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD,
 
    BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD       = (1ULL << 22) | BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD,
 
    BT_FIELD_CLASS_TYPE_VARIANT                     = 1ULL << 23,
 
    BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD          = (1ULL << 24) | BT_FIELD_CLASS_TYPE_VARIANT,
 
    BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD             = (1ULL << 25) | BT_FIELD_CLASS_TYPE_VARIANT,
 
    BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD         = (1ULL << 26) | BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD,
 
    BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD    = (1ULL << 27) | BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD,
 
    BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD      = (1ULL << 28) | BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD,
 
    /*
     * Make sure the enumeration type is a 64-bit integer in case
     * the project needs field class types in the future.
     *
     * This isn't part of the API.
     */
    __BT_FIELD_CLASS_TYPE_BIG_VALUE                     = 1ULL << 62,
} bt_field_class_type;
 
extern bt_field_class_type bt_field_class_get_type(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
static inline
bt_bool bt_field_class_type_is(const bt_field_class_type type,
        const bt_field_class_type other_type) __BT_NOEXCEPT
{
    return (type & other_type) == other_type;
}
 
extern void bt_field_class_set_user_attributes(
        bt_field_class *field_class,
        const bt_value *user_attributes) __BT_NOEXCEPT;
 
extern bt_value *bt_field_class_borrow_user_attributes(
        bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_value *bt_field_class_borrow_user_attributes_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_get_graph_mip_version(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_bool_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_bit_array_create(
        bt_trace_class *trace_class, uint64_t length) __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_bit_array_get_length(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
typedef enum bt_field_class_bit_array_add_flag_status {
    BT_FIELD_CLASS_BIT_ARRAY_ADD_FLAG_STATUS_OK     = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_BIT_ARRAY_ADD_FLAG_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
 
} bt_field_class_bit_array_add_flag_status;
 
extern bt_field_class_bit_array_add_flag_status
bt_field_class_bit_array_add_flag(
    bt_field_class *field_class, const char *label,
    const bt_integer_range_set_unsigned *index_ranges) __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_bit_array_get_flag_count(
    const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_field_class_bit_array_flag *
bt_field_class_bit_array_borrow_flag_by_index_const(
    const bt_field_class *field_class, uint64_t index) __BT_NOEXCEPT;
 
extern const bt_field_class_bit_array_flag *
bt_field_class_bit_array_borrow_flag_by_label_const(
    const bt_field_class *field_class, const char *label) __BT_NOEXCEPT;
 
typedef char const * const *bt_field_class_bit_array_flag_label_array;
 
typedef enum bt_field_class_bit_array_get_active_flag_labels_for_value_as_integer_status {
    BT_FIELD_CLASS_BIT_ARRAY_GET_ACTIVE_FLAG_LABELS_FOR_VALUE_AS_INTEGER_STATUS_OK          = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_BIT_ARRAY_GET_ACTIVE_FLAG_LABELS_FOR_VALUE_AS_INTEGER_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_field_class_bit_array_get_active_flag_labels_for_value_as_integer_status;
 
extern bt_field_class_bit_array_get_active_flag_labels_for_value_as_integer_status
bt_field_class_bit_array_get_active_flag_labels_for_value_as_integer(
    const bt_field_class *field_class, uint64_t value_as_integer,
    bt_field_class_bit_array_flag_label_array *labels,
    uint64_t *count) __BT_NOEXCEPT;
 
extern const char *bt_field_class_bit_array_flag_get_label(
    const bt_field_class_bit_array_flag *flag) __BT_NOEXCEPT;
 
extern const bt_integer_range_set_unsigned *
bt_field_class_bit_array_flag_borrow_index_ranges_const(
    const bt_field_class_bit_array_flag *flag) __BT_NOEXCEPT;
 
extern void bt_field_class_integer_set_field_value_range(
        bt_field_class *field_class, uint64_t n) __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_integer_get_field_value_range(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
typedef enum bt_field_class_integer_field_value_hint {
    BT_FIELD_CLASS_INTEGER_FIELD_VALUE_HINT_SMALL = 1ULL << 0,
} bt_field_class_integer_field_value_hint;
 
void bt_field_class_integer_set_field_value_hints(bt_field_class *field_class,
        uint64_t hints) __BT_NOEXCEPT;
 
uint64_t bt_field_class_integer_get_field_value_hints(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
static inline
bt_bool bt_field_class_integer_has_field_value_hint(
        const bt_field_class * const field_class,
        const bt_field_class_integer_field_value_hint hint)
        __BT_NOEXCEPT
{
    return (bt_field_class_integer_get_field_value_hints(field_class) & (uint64_t) hint) ?
        BT_TRUE : BT_FALSE;
}
 
typedef enum bt_field_class_integer_preferred_display_base {
    BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY        = 2,
 
    BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL     = 8,
 
    BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL       = 10,
 
    BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL   = 16,
} bt_field_class_integer_preferred_display_base;
 
extern void bt_field_class_integer_set_preferred_display_base(
        bt_field_class *field_class,
        bt_field_class_integer_preferred_display_base preferred_display_base)
        __BT_NOEXCEPT;
 
extern bt_field_class_integer_preferred_display_base
bt_field_class_integer_get_preferred_display_base(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_integer_unsigned_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_integer_signed_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_real_single_precision_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_real_double_precision_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
typedef char const * const *bt_field_class_enumeration_mapping_label_array;
 
typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
    BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_field_class_enumeration_get_mapping_labels_for_value_status;
 
typedef enum bt_field_class_enumeration_add_mapping_status {
    BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_field_class_enumeration_add_mapping_status;
 
extern uint64_t bt_field_class_enumeration_get_mapping_count(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const char *bt_field_class_enumeration_mapping_get_label(
        const bt_field_class_enumeration_mapping *mapping)
        __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_enumeration_unsigned_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class_enumeration_add_mapping_status
bt_field_class_enumeration_unsigned_add_mapping(
        bt_field_class *field_class, const char *label,
        const bt_integer_range_set_unsigned *ranges) __BT_NOEXCEPT;
 
extern const bt_field_class_enumeration_unsigned_mapping *
bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
        const bt_field_class *field_class, uint64_t index)
        __BT_NOEXCEPT;
 
extern const bt_field_class_enumeration_unsigned_mapping *
bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(
        const bt_field_class *field_class, const char *label)
        __BT_NOEXCEPT;
 
extern bt_field_class_enumeration_get_mapping_labels_for_value_status
bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
        const bt_field_class *field_class, uint64_t value,
        bt_field_class_enumeration_mapping_label_array *labels,
        uint64_t *count) __BT_NOEXCEPT;
 
extern const bt_integer_range_set_unsigned *
bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
        const bt_field_class_enumeration_unsigned_mapping *mapping)
        __BT_NOEXCEPT;
 
static inline
const bt_field_class_enumeration_mapping *
bt_field_class_enumeration_unsigned_mapping_as_mapping_const(
        const bt_field_class_enumeration_unsigned_mapping *mapping)
        __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
}
 
extern bt_field_class *bt_field_class_enumeration_signed_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class_enumeration_add_mapping_status
bt_field_class_enumeration_signed_add_mapping(
        bt_field_class *field_class, const char *label,
        const bt_integer_range_set_signed *ranges) __BT_NOEXCEPT;
 
extern const bt_field_class_enumeration_signed_mapping *
bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
        const bt_field_class *field_class, uint64_t index)
        __BT_NOEXCEPT;
 
extern const bt_field_class_enumeration_signed_mapping *
bt_field_class_enumeration_signed_borrow_mapping_by_label_const(
        const bt_field_class *field_class, const char *label)
        __BT_NOEXCEPT;
 
extern bt_field_class_enumeration_get_mapping_labels_for_value_status
bt_field_class_enumeration_signed_get_mapping_labels_for_value(
        const bt_field_class *field_class, int64_t value,
        bt_field_class_enumeration_mapping_label_array *labels,
        uint64_t *count) __BT_NOEXCEPT;
 
extern const bt_integer_range_set_signed *
bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
        const bt_field_class_enumeration_signed_mapping *mapping)
        __BT_NOEXCEPT;
 
static inline
const bt_field_class_enumeration_mapping *
bt_field_class_enumeration_signed_mapping_as_mapping_const(
        const bt_field_class_enumeration_signed_mapping *mapping)
        __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
}
 
extern bt_field_class *bt_field_class_string_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_blob_static_create(
        bt_trace_class *trace_class, uint64_t length) __BT_NOEXCEPT;
 
extern bt_field_class *
bt_field_class_blob_dynamic_without_length_field_location_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_field_class *
bt_field_class_blob_dynamic_with_length_field_location_create(
        bt_trace_class *trace_class,
        const bt_field_location *length_field_location) __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_blob_static_get_length(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_field_location *
bt_field_class_blob_dynamic_with_length_field_borrow_length_field_location_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
typedef enum bt_field_class_blob_set_media_type_status {
    BT_FIELD_CLASS_BLOB_SET_MEDIA_TYPE_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_BLOB_SET_MEDIA_TYPE_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_field_class_blob_set_media_type_status;
 
extern bt_field_class_blob_set_media_type_status
bt_field_class_blob_set_media_type(bt_field_class *field_class,
        const char *media_type) __BT_NOEXCEPT;
 
extern const char *bt_field_class_blob_get_media_type(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_array_borrow_element_field_class(
        bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_field_class *
bt_field_class_array_borrow_element_field_class_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_array_static_create(
        bt_trace_class *trace_class,
        bt_field_class *element_field_class, uint64_t length)
        __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_array_static_get_length(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_array_dynamic_create(
        bt_trace_class *trace_class,
        bt_field_class *element_field_class,
        bt_field_class *length_field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_array_dynamic_without_length_field_location_create(
        bt_trace_class *trace_class,
        bt_field_class *element_field_class);
 
extern bt_field_class *bt_field_class_array_dynamic_with_length_field_location_create(
        bt_trace_class *trace_class,
        bt_field_class *element_field_class,
        const bt_field_location *length_field_location);
 
extern const bt_field_path *
bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_field_location *
bt_field_class_array_dynamic_with_length_field_borrow_length_field_location_const(
        const bt_field_class *field_class);
 
extern bt_field_class *bt_field_class_structure_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
typedef enum bt_field_class_structure_append_member_status {
    BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK    = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_field_class_structure_append_member_status;
 
extern bt_field_class_structure_append_member_status
bt_field_class_structure_append_member(
        bt_field_class *field_class,
        const char *name, bt_field_class *member_field_class)
        __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_structure_get_member_count(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class_structure_member *
bt_field_class_structure_borrow_member_by_index(
        bt_field_class *field_class, uint64_t index) __BT_NOEXCEPT;
 
extern const bt_field_class_structure_member *
bt_field_class_structure_borrow_member_by_index_const(
        const bt_field_class *field_class, uint64_t index)
        __BT_NOEXCEPT;
 
extern bt_field_class_structure_member *
bt_field_class_structure_borrow_member_by_name(
        bt_field_class *field_class, const char *name) __BT_NOEXCEPT;
 
extern const bt_field_class_structure_member *
bt_field_class_structure_borrow_member_by_name_const(
        const bt_field_class *field_class, const char *name)
        __BT_NOEXCEPT;
 
extern const char *bt_field_class_structure_member_get_name(
        const bt_field_class_structure_member *member) __BT_NOEXCEPT;
 
extern bt_field_class *
bt_field_class_structure_member_borrow_field_class(
        bt_field_class_structure_member *member) __BT_NOEXCEPT;
 
extern const bt_field_class *
bt_field_class_structure_member_borrow_field_class_const(
        const bt_field_class_structure_member *member) __BT_NOEXCEPT;
 
extern void bt_field_class_structure_member_set_user_attributes(
        bt_field_class_structure_member *member,
        const bt_value *user_attributes) __BT_NOEXCEPT;
 
extern bt_value *
bt_field_class_structure_member_borrow_user_attributes(
        bt_field_class_structure_member *member) __BT_NOEXCEPT;
 
extern const bt_value *
bt_field_class_structure_member_borrow_user_attributes_const(
        const bt_field_class_structure_member *member) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_option_borrow_field_class(
        bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_field_class *
bt_field_class_option_borrow_field_class_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_option_without_selector_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_option_without_selector_field_location_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class) __BT_NOEXCEPT;
 
extern const bt_field_path *
bt_field_class_option_with_selector_field_borrow_selector_field_path_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_field_location *
bt_field_class_option_with_selector_field_borrow_selector_field_location_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_option_with_selector_field_bool_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class,
        bt_field_class *selector_field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_option_with_selector_field_location_bool_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class,
        const bt_field_location *selector_field_location) __BT_NOEXCEPT;
 
extern void
bt_field_class_option_with_selector_field_bool_set_selector_is_reversed(
        bt_field_class *field_class, bt_bool selector_is_reversed)
        __BT_NOEXCEPT;
 
extern bt_bool
bt_field_class_option_with_selector_field_bool_selector_is_reversed(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *
bt_field_class_option_with_selector_field_integer_unsigned_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class,
        bt_field_class *selector_field_class,
        const bt_integer_range_set_unsigned *ranges)
        __BT_NOEXCEPT;
 
extern bt_field_class *
bt_field_class_option_with_selector_field_location_integer_unsigned_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class,
        const bt_field_location *selector_field_location,
        const bt_integer_range_set_unsigned *ranges) __BT_NOEXCEPT;
 
extern const bt_integer_range_set_unsigned *
bt_field_class_option_with_selector_field_integer_unsigned_borrow_selector_ranges_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *
bt_field_class_option_with_selector_field_integer_signed_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class,
        bt_field_class *selector_field_class,
        const bt_integer_range_set_signed *ranges) __BT_NOEXCEPT;
 
extern bt_field_class *
bt_field_class_option_with_selector_field_location_integer_signed_create(
        bt_trace_class *trace_class,
        bt_field_class *optional_field_class,
        const bt_field_location *selector_field_location,
        const bt_integer_range_set_signed *ranges) __BT_NOEXCEPT;
 
extern const bt_integer_range_set_signed *
bt_field_class_option_with_selector_field_integer_signed_borrow_selector_ranges_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_variant_create(
        bt_trace_class *trace_class,
        bt_field_class *selector_field_class) __BT_NOEXCEPT;
 
extern uint64_t bt_field_class_variant_get_option_count(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern bt_field_class_variant_option *
bt_field_class_variant_borrow_option_by_index(
        bt_field_class *field_class, uint64_t index) __BT_NOEXCEPT;
 
extern const bt_field_class_variant_option *
bt_field_class_variant_borrow_option_by_index_const(
        const bt_field_class *field_class, uint64_t index)
        __BT_NOEXCEPT;
 
extern bt_field_class_variant_option *
bt_field_class_variant_borrow_option_by_name(
        bt_field_class *field_class, const char *name) __BT_NOEXCEPT;
 
extern const bt_field_class_variant_option *
bt_field_class_variant_borrow_option_by_name_const(
        const bt_field_class *field_class, const char *name)
        __BT_NOEXCEPT;
 
extern const char *bt_field_class_variant_option_get_name(
        const bt_field_class_variant_option *option) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_variant_option_borrow_field_class(
        bt_field_class_variant_option *option) __BT_NOEXCEPT;
 
extern const bt_field_class *
bt_field_class_variant_option_borrow_field_class_const(
        const bt_field_class_variant_option *option) __BT_NOEXCEPT;
 
extern void bt_field_class_variant_option_set_user_attributes(
        bt_field_class_variant_option *option,
        const bt_value *user_attributes) __BT_NOEXCEPT;
 
extern bt_value *bt_field_class_variant_option_borrow_user_attributes(
        bt_field_class_variant_option *option) __BT_NOEXCEPT;
 
extern const bt_value *bt_field_class_variant_option_borrow_user_attributes_const(
        const bt_field_class_variant_option *option) __BT_NOEXCEPT;
 
extern bt_field_class *bt_field_class_variant_without_selector_field_location_create(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
typedef enum bt_field_class_variant_without_selector_append_option_status {
    BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_OK           = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_field_class_variant_without_selector_append_option_status;
 
extern bt_field_class_variant_without_selector_append_option_status
bt_field_class_variant_without_selector_append_option(
        bt_field_class *field_class, const char *name,
        bt_field_class *option_field_class) __BT_NOEXCEPT;
 
typedef enum bt_field_class_variant_with_selector_field_integer_append_option_status {
    BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_OK      = __BT_FUNC_STATUS_OK,
 
    BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_field_class_variant_with_selector_field_integer_append_option_status;
 
extern const bt_field_path *
bt_field_class_variant_with_selector_field_borrow_selector_field_path_const(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern const bt_field_location *
bt_field_class_variant_with_selector_field_borrow_selector_field_location_const(
        const bt_field_class *field_class);
 
extern bt_field_class *bt_field_class_variant_with_selector_field_location_integer_unsigned_create(
        bt_trace_class *trace_class,
        const bt_field_location *selector_field_location) __BT_NOEXCEPT;
 
extern bt_field_class_variant_with_selector_field_integer_append_option_status
bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
        bt_field_class *field_class, const char *name,
        bt_field_class *option_field_class,
        const bt_integer_range_set_unsigned *ranges) __BT_NOEXCEPT;
 
extern const bt_field_class_variant_with_selector_field_integer_unsigned_option *
bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_index_const(
        const bt_field_class *field_class, uint64_t index)
        __BT_NOEXCEPT;
 
extern const bt_field_class_variant_with_selector_field_integer_unsigned_option *
bt_field_class_variant_with_selector_field_integer_unsigned_borrow_option_by_name_const(
        const bt_field_class *field_class, const char *name)
        __BT_NOEXCEPT;
 
extern const bt_integer_range_set_unsigned *
bt_field_class_variant_with_selector_field_integer_unsigned_option_borrow_ranges_const(
        const bt_field_class_variant_with_selector_field_integer_unsigned_option *option)
        __BT_NOEXCEPT;
 
static inline
const bt_field_class_variant_option *
bt_field_class_variant_with_selector_field_integer_unsigned_option_as_option_const(
        const bt_field_class_variant_with_selector_field_integer_unsigned_option *option)
        __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
}
 
extern bt_field_class *bt_field_class_variant_with_selector_field_location_integer_signed_create(
        bt_trace_class *trace_class,
        const bt_field_location *selector_field_location) __BT_NOEXCEPT;
 
extern bt_field_class_variant_with_selector_field_integer_append_option_status
bt_field_class_variant_with_selector_field_integer_signed_append_option(
        bt_field_class *field_class, const char *name,
        bt_field_class *option_field_class,
        const bt_integer_range_set_signed *ranges)
        __BT_NOEXCEPT;
 
extern const bt_field_class_variant_with_selector_field_integer_signed_option *
bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_index_const(
        const bt_field_class *field_class, uint64_t index)
        __BT_NOEXCEPT;
 
extern const bt_field_class_variant_with_selector_field_integer_signed_option *
bt_field_class_variant_with_selector_field_integer_signed_borrow_option_by_name_const(
        const bt_field_class *field_class, const char *name)
        __BT_NOEXCEPT;
 
extern const bt_integer_range_set_signed *
bt_field_class_variant_with_selector_field_integer_signed_option_borrow_ranges_const(
        const bt_field_class_variant_with_selector_field_integer_signed_option *option)
        __BT_NOEXCEPT;
 
static inline
const bt_field_class_variant_option *
bt_field_class_variant_with_selector_field_integer_signed_option_as_option_const(
        const bt_field_class_variant_with_selector_field_integer_signed_option *option)
        __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
}
 
extern void bt_field_class_get_ref(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
extern void bt_field_class_put_ref(
        const bt_field_class *field_class) __BT_NOEXCEPT;
 
#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_field_class)  \
    do {                        \
        bt_field_class_put_ref(_field_class);   \
        (_field_class) = NULL;          \
    } while (0)
 
#define BT_FIELD_CLASS_MOVE_REF(_dst, _src) \
    do {                    \
        bt_field_class_put_ref(_dst);   \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */