Load plugins and components

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

diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h
index d0816261e90ebcdf93f4ac4abca279ab36a8c90a..945deb940a956fe580e66336b4658e506a0796e7 100644 (file)
--- a/include/babeltrace/plugin/plugin.h
+++ b/include/babeltrace/plugin/plugin.h
@@ -5,6 +5,7 @@
  * BabelTrace - Babeltrace Plug-in Interface
  *
  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright 2015 Philippe Proulx <pproulx@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -27,109 +28,39 @@
  * SOFTWARE.
  */
 
-#include <stdio.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * Plug-in type.
- */
-enum bt_plugin_type {
-       BT_PLUGIN_TYPE_UNKNOWN =        -1,
-
-       /** A source plug-in is a notification generator. */
-       BT_PLUGIN_TYPE_SOURCE =         0,
-
-       /** A sink plug-in handles incoming notifications. */
-       BT_PLUGIN_TYPE_SINK =           1,
-
-       /** A filter plug-in implements both Source and Sink interfaces. */
-       BT_PLUGIN_TYPE_FILTER =         2,
-};
-
-/**
- * Status code. Errors are always negative.
- */
-enum bt_plugin_status {
-       /** Memory allocation failure. */
-       /* -12 for compatibility with -ENOMEM */
-       BT_PLUGIN_STATUS_NOMEM =        -12,
-
-       /** Invalid arguments. */
-       /* -22 for compatibility with -EINVAL */
-       BT_PLUGIN_STATUS_INVAL =        -22,
-
-       /** Unsupported plug-in feature. */
-       BT_PLUGIN_STATUS_UNSUPPORTED =  -2,
-
-       /** General error. */
-       BT_PLUGIN_STATUS_ERROR =        -1,
-
-       /** No error, okay. */
-       BT_PLUGIN_STATUS_OK =           0,
-};
-
-struct bt_plugin;
-
-/**
- * Get plug-in instance name.
- *
- * @param plugin       Plug-in instance of which to get the name
- * @returns            Returns a pointer to the plug-in's name
- */
-extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
-
-/**
- * Set plug-in instance name.
- *
- * @param plugin       Plug-in instance of which to set the name
- * @param name         New plug-in name (will be copied)
- * @returns            One of #bt_plugin_status values
- */
-extern enum bt_plugin_status bt_plugin_set_name(
-               struct bt_plugin *plugin, const char *name);
-
-/**
- * Get plug-in instance type.
- *
- * @param plugin       Plug-in instance of which to get the type
- * @returns            One of #bt_plugin_type values
- */
-extern enum bt_plugin_type bt_plugin_get_type(struct bt_plugin *plugin);
-
-/**
- * Set a plug-in instance's error stream.
- *
- * @param plugin       Plug-in instance
- * @param error_stream Error stream
- * @returns            One of #bt_plugin_status values
- */
-extern enum bt_plugin_status bt_plugin_set_error_stream(
-               struct bt_plugin *plugin, FILE *error_stream);
-
-/**
- * Increments the reference count of \p plugin.
- *
- * @param plugin       Plug-in of which to increment the reference count
- *
- * @see bt_plugin_put()
- */
-extern void bt_plugin_get(struct bt_plugin *plugin);
-
-/**
- * Decrements the reference count of \p plugin, destroying it when this
- * count reaches 0.
- *
- * @param plugin       Plug-in of which to decrement the reference count
- *
- * @see bt_plugin_get()
- */
-extern void bt_plugin_put(struct bt_plugin *plugin);
-
-#ifdef __cplusplus
-}
-#endif
+#include <babeltrace/plugin/component-factory.h>
+#include <babeltrace/plugin/component.h>
+
+typedef enum bt_component_status (*bt_plugin_init_func)(
+               struct bt_component_factory *factory);
+typedef void (*bt_plugin_exit_func)(void);
+
+/* 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 __bt_plugin_init = (_x)
+#define BT_PLUGIN_EXIT(_x)      bt_plugin_exit __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_SOURCE_COMPONENT_CLASS_ENTRY(_name, _init) \
+       bt_component_factory_register_source_component_class(factory, \
+               _name, _init);
+
+#define BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY(_name, _init) \
+       bt_component_factory_register_sink_component_class(factory, \
+               _name, _init);
+
+#define BT_PLUGIN_COMPONENT_CLASSES_END\
+       \
+       return BT_COMPONENT_STATUS_OK;\
+}\
+       \
+       BT_PLUGIN_INIT(__bt_plugin_register_component_classes);\
+       BT_PLUGIN_EXIT(NULL);
 
 #endif /* BABELTRACE_PLUGIN_H */