lib: Add functions to borrow specialized component classes from specialized components
[babeltrace.git] / include / babeltrace / plugin / plugin-const.h
1 #ifndef BABELTRACE_PLUGIN_PLUGIN_CONST_H
2 #define BABELTRACE_PLUGIN_PLUGIN_CONST_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
29 #include <stdint.h>
30 #include <stddef.h>
31
32 /*
33 * For bt_bool, bt_plugin, bt_plugin_set, bt_component_class,
34 * bt_component_class_source, bt_component_class_filter,
35 * bt_component_class_sink
36 */
37 #include <babeltrace/types.h>
38
39 /* For bt_property_availability */
40 #include <babeltrace/property.h>
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 extern const bt_plugin *bt_plugin_find(const char *plugin_name);
47
48 extern const bt_plugin_set *bt_plugin_find_all_from_file(
49 const char *path);
50
51 extern const bt_plugin_set *bt_plugin_find_all_from_dir(
52 const char *path, bt_bool recurse);
53
54 extern const bt_plugin_set *bt_plugin_find_all_from_static(void);
55
56 extern const char *bt_plugin_get_name(const bt_plugin *plugin);
57
58 extern const char *bt_plugin_get_author(const bt_plugin *plugin);
59
60 extern const char *bt_plugin_get_license(const bt_plugin *plugin);
61
62 extern const char *bt_plugin_get_description(const bt_plugin *plugin);
63
64 extern const char *bt_plugin_get_path(const bt_plugin *plugin);
65
66 extern bt_property_availability bt_plugin_get_version(
67 const bt_plugin *plugin, unsigned int *major,
68 unsigned int *minor, unsigned int *patch, const char **extra);
69
70 extern uint64_t bt_plugin_get_source_component_class_count(
71 const bt_plugin *plugin);
72
73 extern uint64_t bt_plugin_get_filter_component_class_count(
74 const bt_plugin *plugin);
75
76 extern uint64_t bt_plugin_get_sink_component_class_count(
77 const bt_plugin *plugin);
78
79 extern const bt_component_class_source *
80 bt_plugin_borrow_source_component_class_by_index_const(
81 const bt_plugin *plugin, uint64_t index);
82
83 extern const bt_component_class_filter *
84 bt_plugin_borrow_filter_component_class_by_index_const(
85 const bt_plugin *plugin, uint64_t index);
86
87 extern const bt_component_class_sink *
88 bt_plugin_borrow_sink_component_class_by_index_const(
89 const bt_plugin *plugin, uint64_t index);
90
91 extern const bt_component_class_source *
92 bt_plugin_borrow_source_component_class_by_name_const(
93 const bt_plugin *plugin, const char *name);
94
95 extern const bt_component_class_filter *
96 bt_plugin_borrow_filter_component_class_by_name_const(
97 const bt_plugin *plugin, const char *name);
98
99 extern const bt_component_class_sink *
100 bt_plugin_borrow_sink_component_class_by_name_const(
101 const bt_plugin *plugin, const char *name);
102
103 extern void bt_plugin_get_ref(const bt_plugin *plugin);
104
105 extern void bt_plugin_put_ref(const bt_plugin *plugin);
106
107 #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \
108 do { \
109 bt_plugin_put_ref(_var); \
110 (_var) = NULL; \
111 } while (0)
112
113 #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \
114 do { \
115 bt_plugin_put_ref(_var_dst); \
116 (_var_dst) = (_var_src); \
117 (_var_src) = NULL; \
118 } while (0)
119
120 #ifdef __cplusplus
121 }
122 #endif
123
124 #endif /* BABELTRACE_PLUGIN_PLUGIN_CONST_H */
This page took 0.031224 seconds and 4 git commands to generate.