Add base plug-in skeletons

[babeltrace.git] / include / babeltrace / plugin / plugin-macros.h

diff --git a/include/babeltrace/plugin/plugin-macros.h b/include/babeltrace/plugin/plugin-macros.h
index 5011e3a68b31e322a5f027ca3d2ae8dcad96ff10..26c3ebc35e8e91341fe14ee3b65881c5a37c533b 100644 (file)
--- a/include/babeltrace/plugin/plugin-macros.h
+++ b/include/babeltrace/plugin/plugin-macros.h
@@ -32,30 +32,30 @@
 #include <babeltrace/plugin/component.h>
 
 /* A plugin must define the __bt_plugin_init symbol */
-#define BT_PLUGIN_NAME(_x)     const char __bt_plugin_name[] = (_x)
-#define BT_PLUGIN_AUTHOR(_x)   const char __bt_plugin_author[] = (_x)
-#define BT_PLUGIN_LICENSE(_x)  const char __bt_plugin_license[] = (_x)
-#define BT_PLUGIN_INIT(_x)     bt_plugin_init_func __bt_plugin_init = (_x)
-#define BT_PLUGIN_EXIT(_x)     bt_plugin_exit_func __bt_plugin_exit = (_x)
-
-#define BT_PLUGIN_COMPONENT_CLASSES_BEGIN                      \
-       enum bt_component_status __bt_plugin_register_component_classes(\
-               struct bt_component_factory *factory)\
+#define BT_PLUGIN_NAME(_x)             const char __bt_plugin_name[] = (_x)
+#define BT_PLUGIN_AUTHOR(_x)           const char __bt_plugin_author[] = (_x)
+#define BT_PLUGIN_LICENSE(_x)          const char __bt_plugin_license[] = (_x)
+#define BT_PLUGIN_DESCRIPTION(_x)      const char __bt_plugin_description[] = (_x)
+#define BT_PLUGIN_INIT(_x)             bt_plugin_init_func __bt_plugin_init = (_x)
+#define BT_PLUGIN_EXIT(_x)             bt_plugin_exit_func __bt_plugin_exit = (_x)
+
+#define BT_PLUGIN_COMPONENT_CLASSES_BEGIN                                      \
+       static enum bt_component_status __bt_plugin_register_component_classes( \
+               struct bt_component_factory *factory)                           \
        {
 
-#define BT_PLUGIN_SOURCE_COMPONENT_CLASS_ENTRY(_name, _init) \
-       bt_component_factory_register_source_component_class(factory, \
-               _name, _init);
+#define BT_PLUGIN_SOURCE_COMPONENT_CLASS_ENTRY(_name, description, _init)      \
+       bt_component_factory_register_source_component_class(factory,           \
+                       _name, description, _init);
 
-#define BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY(_name, _init) \
-       bt_component_factory_register_sink_component_class(factory, \
-               _name, _init);
+#define BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY(_name, _description, _init)       \
+       bt_component_factory_register_sink_component_class(factory,             \
+                       _name, _description, _init);
 
-#define BT_PLUGIN_COMPONENT_CLASSES_END\
-       \
-       return BT_COMPONENT_STATUS_OK;\
-}\
-       \
-       BT_PLUGIN_INIT(__bt_plugin_register_component_classes);\
+#define BT_PLUGIN_COMPONENT_CLASSES_END                                                \
+       return BT_COMPONENT_STATUS_OK;                                          \
+}                                                                              \
+                                                                               \
+       BT_PLUGIN_INIT(__bt_plugin_register_component_classes);                 \
 
 #endif /* BABELTRACE_PLUGIN_MACROS_H */