Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_PLUGIN_PLUGIN_H |
2 | #define BABELTRACE_PLUGIN_PLUGIN_H | |
90354d3a JG |
3 | |
4 | /* | |
584e4e78 | 5 | * BabelTrace - Babeltrace Plug-in Interface |
90354d3a | 6 | * |
38b48196 | 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
33b34c43 | 8 | * Copyright 2017 Philippe Proulx <pproulx@efficios.com> |
90354d3a JG |
9 | * |
10 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
11 | * | |
12 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
13 | * of this software and associated documentation files (the "Software"), to deal | |
14 | * in the Software without restriction, including without limitation the rights | |
15 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
16 | * copies of the Software, and to permit persons to whom the Software is | |
17 | * furnished to do so, subject to the following conditions: | |
18 | * | |
19 | * The above copyright notice and this permission notice shall be included in | |
20 | * all copies or substantial portions of the Software. | |
21 | * | |
22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
25 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
26 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
27 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
28 | * SOFTWARE. | |
29 | */ | |
30 | ||
33b34c43 PP |
31 | #include <stddef.h> |
32 | #include <stdbool.h> | |
33 | #include <babeltrace/component/component-class.h> | |
34 | ||
38b48196 JG |
35 | #ifdef __cplusplus |
36 | extern "C" { | |
37 | #endif | |
633edee0 | 38 | |
38b48196 | 39 | struct bt_plugin; |
33b34c43 PP |
40 | struct bt_component_class; |
41 | ||
42 | /** | |
43 | * Status code. Errors are always negative. | |
44 | */ | |
45 | enum bt_plugin_status { | |
46 | /** No error, okay. */ | |
47 | BT_PLUGIN_STATUS_OK = 0, | |
48 | /** General error. */ | |
49 | BT_PLUGIN_STATUS_ERROR = -1, | |
50 | /** Memory allocation failure. */ | |
51 | BT_PLUGIN_STATUS_NOMEM = -4, | |
52 | }; | |
53 | ||
6ba0b073 | 54 | extern struct bt_plugin **bt_plugin_create_all_from_file(const char *path); |
33b34c43 PP |
55 | |
56 | extern struct bt_plugin **bt_plugin_create_all_from_dir(const char *path, | |
57 | bool recurse); | |
58 | ||
59 | extern struct bt_plugin **bt_plugin_create_all_from_static(void); | |
73299554 | 60 | |
38b48196 JG |
61 | /** |
62 | * Get the name of a plug-in. | |
63 | * | |
64 | * @param plugin An instance of a plug-in | |
65 | * @returns Plug-in name or NULL on error | |
66 | */ | |
67 | extern const char *bt_plugin_get_name(struct bt_plugin *plugin); | |
633edee0 | 68 | |
38b48196 JG |
69 | /** |
70 | * Get the name of a plug-in's author. | |
71 | * | |
72 | * @param plugin An instance of a plug-in | |
73 | * @returns Plug-in author or NULL on error | |
74 | */ | |
75 | extern const char *bt_plugin_get_author(struct bt_plugin *plugin); | |
633edee0 | 76 | |
38b48196 JG |
77 | /** |
78 | * Get the license of a plug-in. | |
79 | * | |
80 | * @param plugin An instance of a plug-in | |
81 | * @returns Plug-in license or NULL on error | |
82 | */ | |
83 | extern const char *bt_plugin_get_license(struct bt_plugin *plugin); | |
633edee0 | 84 | |
f3bc2010 JG |
85 | /** |
86 | * Get the decription of a plug-in. | |
87 | * | |
88 | * @param plugin An instance of a plug-in | |
89 | * @returns Plug-in description or NULL if none is available | |
90 | */ | |
91 | extern const char *bt_plugin_get_description(struct bt_plugin *plugin); | |
92 | ||
7c7c0433 JG |
93 | /** |
94 | * Get the path of a plug-in. | |
95 | * | |
96 | * @param plugin An instance of a plug-in | |
97 | * @returns Plug-in path or NULL on error | |
98 | */ | |
99 | extern const char *bt_plugin_get_path(struct bt_plugin *plugin); | |
100 | ||
33b34c43 PP |
101 | extern int bt_plugin_get_component_class_count(struct bt_plugin *plugin); |
102 | ||
103 | extern struct bt_component_class *bt_plugin_get_component_class( | |
104 | struct bt_plugin *plugin, size_t index); | |
105 | ||
106 | extern | |
107 | struct bt_component_class *bt_plugin_get_component_class_by_name_and_type( | |
108 | struct bt_plugin *plugin, const char *name, | |
d3e4dcd8 | 109 | enum bt_component_class_type type); |
33b34c43 | 110 | |
38b48196 JG |
111 | #ifdef __cplusplus |
112 | } | |
113 | #endif | |
90354d3a | 114 | |
33b34c43 | 115 | #endif /* BABELTRACE_PLUGIN_PLUGIN_H */ |