component-class.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_H
#define BABELTRACE2_GRAPH_COMPONENT_CLASS_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <babeltrace2/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum bt_component_class_type {
    BT_COMPONENT_CLASS_TYPE_SOURCE  = 1 << 0,
 
    BT_COMPONENT_CLASS_TYPE_FILTER  = 1 << 1,
 
    BT_COMPONENT_CLASS_TYPE_SINK    = 1 << 2,
} bt_component_class_type;
 
extern bt_component_class_type bt_component_class_get_type(
        const bt_component_class *component_class) __BT_NOEXCEPT;
 
static inline
bt_bool bt_component_class_is_source(
        const bt_component_class *component_class) __BT_NOEXCEPT
{
    return bt_component_class_get_type(component_class) ==
        BT_COMPONENT_CLASS_TYPE_SOURCE;
}
 
static inline
bt_bool bt_component_class_is_filter(
        const bt_component_class *component_class) __BT_NOEXCEPT
{
    return bt_component_class_get_type(component_class) ==
        BT_COMPONENT_CLASS_TYPE_FILTER;
}
 
static inline
bt_bool bt_component_class_is_sink(
        const bt_component_class *component_class) __BT_NOEXCEPT
{
    return bt_component_class_get_type(component_class) ==
        BT_COMPONENT_CLASS_TYPE_SINK;
}
 
extern const char *bt_component_class_get_name(
        const bt_component_class *component_class) __BT_NOEXCEPT;
 
extern const char *bt_component_class_get_description(
        const bt_component_class *component_class) __BT_NOEXCEPT;
 
extern const char *bt_component_class_get_help(
        const bt_component_class *component_class) __BT_NOEXCEPT;
 
extern void bt_component_class_get_ref(
        const bt_component_class *component_class) __BT_NOEXCEPT;
 
extern void bt_component_class_put_ref(
        const bt_component_class *component_class) __BT_NOEXCEPT;
 
#define BT_COMPONENT_CLASS_PUT_REF_AND_RESET(_component_class)  \
    do {                            \
        bt_component_class_put_ref(_component_class);   \
        (_component_class) = NULL;          \
    } while (0)
 
#define BT_COMPONENT_CLASS_MOVE_REF(_dst, _src)     \
    do {                        \
        bt_component_class_put_ref(_dst);   \
        (_dst) = (_src);            \
        (_src) = NULL;              \
    } while (0)
 
static inline
const bt_component_class *
bt_component_class_source_as_component_class_const(
        const bt_component_class_source *component_class) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_component_class, component_class);
}
 
extern void bt_component_class_source_get_ref(
        const bt_component_class_source *component_class) __BT_NOEXCEPT;
 
extern void bt_component_class_source_put_ref(
        const bt_component_class_source *component_class) __BT_NOEXCEPT;
 
#define BT_COMPONENT_CLASS_SOURCE_PUT_REF_AND_RESET(_component_class)   \
    do {                                \
        bt_component_class_source_put_ref(_component_class);    \
        (_component_class) = NULL;              \
    } while (0)
 
#define BT_COMPONENT_CLASS_SOURCE_MOVE_REF(_dst, _src)      \
    do {                            \
        bt_component_class_source_put_ref(_dst);    \
        (_dst) = (_src);                \
        (_src) = NULL;                  \
    } while (0)
 
static inline
const bt_component_class *
bt_component_class_filter_as_component_class_const(
        const bt_component_class_filter *component_class) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_component_class, component_class);
}
 
extern void bt_component_class_filter_get_ref(
        const bt_component_class_filter *component_class) __BT_NOEXCEPT;
 
extern void bt_component_class_filter_put_ref(
        const bt_component_class_filter *component_class) __BT_NOEXCEPT;
 
#define BT_COMPONENT_CLASS_FILTER_PUT_REF_AND_RESET(_component_class)   \
    do {                                \
        bt_component_class_filter_put_ref(_component_class);    \
        (_component_class) = NULL;              \
    } while (0)
 
#define BT_COMPONENT_CLASS_FILTER_MOVE_REF(_dst, _src)      \
    do {                            \
        bt_component_class_filter_put_ref(_dst);    \
        (_dst) = (_src);                \
        (_src) = NULL;                  \
    } while (0)
 
static inline
const bt_component_class *
bt_component_class_sink_as_component_class_const(
        const bt_component_class_sink *component_class) __BT_NOEXCEPT
{
    return __BT_UPCAST_CONST(bt_component_class, component_class);
}
 
extern void bt_component_class_sink_get_ref(
        const bt_component_class_sink *component_class) __BT_NOEXCEPT;
 
extern void bt_component_class_sink_put_ref(
        const bt_component_class_sink *component_class) __BT_NOEXCEPT;
 
#define BT_COMPONENT_CLASS_SINK_PUT_REF_AND_RESET(_component_class) \
    do {                                \
        bt_component_class_sink_put_ref(_component_class);  \
        (_component_class) = NULL;              \
    } while (0)
 
#define BT_COMPONENT_CLASS_SINK_MOVE_REF(_dst, _src)        \
    do {                            \
        bt_component_class_sink_put_ref(_dst);      \
        (_dst) = (_src);                \
        (_src) = NULL;                  \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_H */