lib: Add functions to borrow specialized component classes from specialized components
[babeltrace.git] / include / babeltrace / graph / component-source-const.h
CommitLineData
7b53201c
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_SOURCE_CONST_H
2#define BABELTRACE_GRAPH_COMPONENT_SOURCE_CONST_H
90354d3a
JG
3
4/*
f2b0325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
34ac9eaf 6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
90354d3a 7 *
90354d3a
JG
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27#include <stdint.h>
28
8470daa9
PP
29/*
30 * For bt_component, bt_component_filter, bt_port_output,
61fd44ac 31 * __BT_UPCAST_CONST, bt_component_class_source
8470daa9 32 */
8eee8ea2
PP
33#include <babeltrace/types.h>
34
90354d3a
JG
35#ifdef __cplusplus
36extern "C" {
37#endif
38
834e9996 39static inline
8eee8ea2
PP
40const bt_component *bt_component_source_as_component_const(
41 const bt_component_source *component)
834e9996 42{
8470daa9 43 return __BT_UPCAST_CONST(bt_component, component);
834e9996
PP
44}
45
61fd44ac
SM
46extern const bt_component_class_source *
47bt_component_source_borrow_class_const(
48 const bt_component_source *component);
49
834e9996 50extern uint64_t bt_component_source_get_output_port_count(
8eee8ea2 51 const bt_component_source *component);
834e9996 52
8eee8ea2 53extern const bt_port_output *
7b53201c 54bt_component_source_borrow_output_port_by_name_const(
8eee8ea2 55 const bt_component_source *component, const char *name);
0c881a11 56
8eee8ea2 57extern const bt_port_output *
7b53201c 58bt_component_source_borrow_output_port_by_index_const(
8eee8ea2 59 const bt_component_source *component, uint64_t index);
90354d3a 60
8c6884d9 61extern void bt_component_source_get_ref(
8eee8ea2 62 const bt_component_source *component_source);
8c6884d9
PP
63
64extern void bt_component_source_put_ref(
8eee8ea2 65 const bt_component_source *component_source);
8c6884d9
PP
66
67#define BT_COMPONENT_SOURCE_PUT_REF_AND_RESET(_var) \
68 do { \
69 bt_component_source_put_ref(_var); \
70 (_var) = NULL; \
71 } while (0)
72
73#define BT_COMPONENT_SOURCE_MOVE_REF(_var_dst, _var_src) \
74 do { \
75 bt_component_source_put_ref(_var_dst); \
76 (_var_dst) = (_var_src); \
77 (_var_src) = NULL; \
78 } while (0)
79
90354d3a
JG
80#ifdef __cplusplus
81}
82#endif
83
7b53201c 84#endif /* BABELTRACE_GRAPH_COMPONENT_SOURCE_CONST_H */
This page took 0.04561 seconds and 4 git commands to generate.