lib: remove "For *" comments in public headers
[babeltrace.git] / include / babeltrace2 / graph / graph-const.h
CommitLineData
924dc299
PP
1#ifndef BABELTRACE2_GRAPH_GRAPH_CONST_H
2#define BABELTRACE2_GRAPH_GRAPH_CONST_H
784cdc68
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
784cdc68
JG
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
784cdc68
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
4fa90f32
PP
27#ifndef __BT_IN_BABELTRACE_H
28# error "Please include <babeltrace2/babeltrace.h> instead."
29#endif
30
3fadfbc0 31#include <babeltrace2/types.h>
73d5c1ad 32
784cdc68
JG
33#ifdef __cplusplus
34extern "C" {
35#endif
36
b19ff26f 37extern bt_bool bt_graph_is_canceled(const bt_graph *graph);
090a4c0a 38
b19ff26f 39extern void bt_graph_get_ref(const bt_graph *graph);
c5b9b441 40
b19ff26f 41extern void bt_graph_put_ref(const bt_graph *graph);
c5b9b441
PP
42
43#define BT_GRAPH_PUT_REF_AND_RESET(_var) \
44 do { \
45 bt_graph_put_ref(_var); \
46 (_var) = NULL; \
47 } while (0)
48
49#define BT_GRAPH_MOVE_REF(_var_dst, _var_src) \
50 do { \
51 bt_graph_put_ref(_var_dst); \
52 (_var_dst) = (_var_src); \
53 (_var_src) = NULL; \
54 } while (0)
55
784cdc68
JG
56#ifdef __cplusplus
57}
58#endif
59
924dc299 60#endif /* BABELTRACE2_GRAPH_GRAPH_CONST_H */
This page took 0.046046 seconds and 4 git commands to generate.