Load plugins and components
[babeltrace.git] / include / babeltrace / plugin / plugin.h
CommitLineData
90354d3a
JG
1#ifndef BABELTRACE_PLUGIN_H
2#define BABELTRACE_PLUGIN_H
3
4/*
584e4e78 5 * BabelTrace - Babeltrace Plug-in Interface
90354d3a
JG
6 *
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
633edee0 8 * Copyright 2015 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
633edee0 31#include <babeltrace/plugin/component-factory.h>
73299554 32#include <babeltrace/plugin/component.h>
633edee0 33
73299554
JG
34typedef enum bt_component_status (*bt_plugin_init_func)(
35 struct bt_component_factory *factory);
36typedef void (*bt_plugin_exit_func)(void);
37
38/* A plugin must define the __bt_plugin_init symbol */
633edee0
JG
39#define BT_PLUGIN_NAME(_x) const char *__bt_plugin_name = (_x)
40#define BT_PLUGIN_AUTHOR(_x) const char *__bt_plugin_author = (_x)
41#define BT_PLUGIN_LICENSE(_x) const char *__bt_plugin_license = (_x)
73299554
JG
42#define BT_PLUGIN_INIT(_x) bt_plugin_init __bt_plugin_init = (_x)
43#define BT_PLUGIN_EXIT(_x) bt_plugin_exit __bt_plugin_exit = (_x)
633edee0
JG
44
45#define BT_PLUGIN_COMPONENT_CLASSES_BEGIN \
73299554 46 enum bt_component_status __bt_plugin_register_component_classes(\
633edee0
JG
47 struct bt_component_factory *factory)\
48 {
49
8738a040 50#define BT_PLUGIN_SOURCE_COMPONENT_CLASS_ENTRY(_name, _init) \
633edee0 51 bt_component_factory_register_source_component_class(factory, \
8738a040 52 _name, _init);
633edee0 53
8738a040 54#define BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY(_name, _init) \
633edee0 55 bt_component_factory_register_sink_component_class(factory, \
8738a040 56 _name, _init);
633edee0
JG
57
58#define BT_PLUGIN_COMPONENT_CLASSES_END\
59 \
73299554 60 return BT_COMPONENT_STATUS_OK;\
633edee0
JG
61}\
62 \
63 BT_PLUGIN_INIT(__bt_plugin_register_component_classes);\
64 BT_PLUGIN_EXIT(NULL);
90354d3a 65
0db5ca2c 66#endif /* BABELTRACE_PLUGIN_H */
This page took 0.026686 seconds and 4 git commands to generate.