Commit | Line | Data |
---|---|---|
633edee0 JG |
1 | #ifndef BABELTRACE_PLUGIN_COMPONENT_FACTORY_H |
2 | #define BABELTRACE_PLUGIN_COMPONENT_FACTORY_H | |
62ed7c30 JG |
3 | |
4 | /* | |
633edee0 | 5 | * Babeltrace - Component Factory Class Interface. |
62ed7c30 | 6 | * |
633edee0 | 7 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
62ed7c30 JG |
8 | * |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
633edee0 JG |
28 | #include <babeltrace/plugin/component.h> |
29 | #include <babeltrace/plugin/source.h> | |
30 | #include <babeltrace/plugin/sink.h> | |
31 | #include <babeltrace/plugin/filter.h> | |
0d884c50 | 32 | #include <babeltrace/plugin/plugin-system.h> |
2e339de1 | 33 | #include <babeltrace/values.h> |
62ed7c30 JG |
34 | |
35 | #ifdef __cplusplus | |
36 | extern "C" { | |
633edee0 JG |
37 | #endif |
38 | ||
f3e4505b JG |
39 | /** |
40 | * Status code. Errors are always negative. | |
41 | */ | |
42 | enum bt_component_factory_status { | |
43 | /** General error. */ | |
fb2dcc52 JG |
44 | BT_COMPONENT_FACTORY_STATUS_ERROR = -128, |
45 | ||
46 | /** Invalid plugin. */ | |
47 | BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN = -6, | |
f3e4505b JG |
48 | |
49 | /** Invalid arguments. */ | |
fb2dcc52 | 50 | BT_COMPONENT_FACTORY_STATUS_INVAL = -5, |
f3e4505b JG |
51 | |
52 | /** Memory allocation failure. */ | |
fb2dcc52 | 53 | BT_COMPONENT_FACTORY_STATUS_NOMEM = -4, |
f3e4505b JG |
54 | |
55 | /** I/O error. */ | |
fb2dcc52 | 56 | BT_COMPONENT_FACTORY_STATUS_IO = -3, |
f3e4505b JG |
57 | |
58 | /** No such file or directory. */ | |
fb2dcc52 | 59 | BT_COMPONENT_FACTORY_STATUS_NOENT = -2, |
f3e4505b JG |
60 | |
61 | /** Operation not permitted. */ | |
fb2dcc52 | 62 | BT_COMPONENT_FACTORY_STATUS_PERM = -1, |
f3e4505b JG |
63 | |
64 | /** No error, okay. */ | |
fb2dcc52 | 65 | BT_COMPONENT_FACTORY_STATUS_OK = 0, |
f3e4505b JG |
66 | }; |
67 | ||
633edee0 | 68 | struct bt_component_factory; |
62ed7c30 | 69 | |
f3e4505b JG |
70 | /** |
71 | * Create a component factory. | |
72 | * | |
73 | * @returns An instance of component factory | |
74 | */ | |
b8a06801 | 75 | extern struct bt_component_factory *bt_component_factory_create(void); |
f3e4505b | 76 | |
fb2dcc52 JG |
77 | /** |
78 | * Get the list of components registered to this factory. | |
fc11e32c JG |
79 | * |
80 | * @param factory Component factory | |
fb2dcc52 | 81 | */ |
2e339de1 | 82 | extern struct bt_value *bt_component_factory_get_components( |
fb2dcc52 JG |
83 | struct bt_component_factory *factory); |
84 | ||
fc11e32c JG |
85 | /** |
86 | * . | |
87 | */ | |
88 | extern struct bt_value *bt_component_factory_create_component( | |
89 | struct bt_component_factory *factory); | |
90 | ||
f3e4505b JG |
91 | /** |
92 | * Recursively load and register Babeltrace plugins under a given path. | |
93 | * | |
94 | * Path will be traversed recursively if it is a directory, otherwise only the | |
95 | * provided file will be loaded. | |
96 | * | |
97 | * @param factory A component factory instance | |
98 | * @param path A path to a file or directory | |
99 | * @returns One of #bt_component_factory_status values | |
100 | */ | |
b8a06801 | 101 | extern enum bt_component_factory_status bt_component_factory_load( |
f3e4505b | 102 | struct bt_component_factory *factory, const char *path); |
62ed7c30 | 103 | |
b8a06801 | 104 | extern enum bt_component_factory_status |
f3e4505b | 105 | bt_component_factory_register_source_component_class( |
fb2dcc52 JG |
106 | struct bt_component_factory *factory, const char *name, |
107 | bt_component_source_init_cb init); | |
62ed7c30 | 108 | |
b8a06801 JG |
109 | extern enum bt_component_factory_status |
110 | bt_component_factory_register_sink_component_class( | |
fb2dcc52 JG |
111 | struct bt_component_factory *factory, const char *name, |
112 | bt_component_sink_init_cb init); | |
62ed7c30 | 113 | |
633edee0 | 114 | #ifdef __cplusplus |
62ed7c30 JG |
115 | } |
116 | #endif | |
117 | ||
633edee0 | 118 | #endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */ |