lib: add aliases for Babeltrace enumeration types
[babeltrace.git] / include / babeltrace / graph / port-const.h
CommitLineData
7b53201c
PP
1#ifndef BABELTRACE_GRAPH_PORT_CONST_H
2#define BABELTRACE_GRAPH_PORT_CONST_H
8b285017
JG
3
4/*
f2b0325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
8b285017
JG
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8b285017
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>
e0831b38 28
8eee8ea2 29/* For bt_bool, bt_port, bt_connection, bt_component */
c55a9f58 30#include <babeltrace/types.h>
8b285017
JG
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
ee78f405 36typedef enum bt_port_type {
8b285017
JG
37 BT_PORT_TYPE_INPUT = 0,
38 BT_PORT_TYPE_OUTPUT = 1,
ee78f405 39} bt_port_type;
8b285017 40
8eee8ea2 41extern const char *bt_port_get_name(const bt_port *port);
834e9996 42
ee78f405 43extern bt_port_type bt_port_get_type(const bt_port *port);
834e9996 44
8eee8ea2
PP
45extern const bt_connection *bt_port_borrow_connection_const(
46 const bt_port *port);
834e9996 47
8eee8ea2
PP
48extern const bt_component *bt_port_borrow_component_const(
49 const bt_port *port);
834e9996 50
8eee8ea2 51extern bt_bool bt_port_is_connected(const bt_port *port);
8b285017 52
e3655084 53static inline
8eee8ea2 54bt_bool bt_port_is_input(const bt_port *port)
e3655084
PP
55{
56 return bt_port_get_type(port) == BT_PORT_TYPE_INPUT;
57}
58
59static inline
8eee8ea2 60bt_bool bt_port_is_output(const bt_port *port)
e3655084
PP
61{
62 return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT;
63}
64
8eee8ea2 65extern void bt_port_get_ref(const bt_port *port);
8c6884d9 66
8eee8ea2 67extern void bt_port_put_ref(const bt_port *port);
8c6884d9
PP
68
69#define BT_PORT_PUT_REF_AND_RESET(_var) \
70 do { \
71 bt_port_put_ref(_var); \
72 (_var) = NULL; \
73 } while (0)
74
75#define BT_PORT_MOVE_REF(_var_dst, _var_src) \
76 do { \
77 bt_port_put_ref(_var_dst); \
78 (_var_dst) = (_var_src); \
79 (_var_src) = NULL; \
80 } while (0)
81
8b285017
JG
82#ifdef __cplusplus
83}
84#endif
85
7b53201c 86#endif /* BABELTRACE_GRAPH_PORT_CONST_H */
This page took 0.038342 seconds and 4 git commands to generate.