Add base plug-in skeletons

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

diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h
index 60a1a21a7b48ade9fdb9aedcf1fe1db36a8a36e5..8eec84e552e4fb92e456cd6befa33b8865efb6f7 100644 (file)
--- a/include/babeltrace/plugin/plugin.h
+++ b/include/babeltrace/plugin/plugin.h
@@ -4,7 +4,7 @@
 /*
  * BabelTrace - Babeltrace Plug-in Interface
  *
- * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -27,10 +27,54 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/plugin/component.h>
-#include <babeltrace/plugin/component-class.h>
-#include <babeltrace/plugin/source.h>
-#include <babeltrace/plugin/sink.h>
-#include <babeltrace/plugin/filter.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct bt_plugin;
+
+/**
+ * Get the name of a plug-in.
+ *
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in name or NULL on error
+ */
+extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
+
+/**
+ * Get the name of a plug-in's author.
+ *
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in author or NULL on error
+ */
+extern const char *bt_plugin_get_author(struct bt_plugin *plugin);
+
+/**
+ * Get the license of a plug-in.
+ *
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in license or NULL on error
+ */
+extern const char *bt_plugin_get_license(struct bt_plugin *plugin);
+
+/**
+ * Get the decription of a plug-in.
+ *
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in description or NULL if none is available
+ */
+extern const char *bt_plugin_get_description(struct bt_plugin *plugin);
+
+/**
+ * Get the path of a plug-in.
+ *
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in path or NULL on error
+ */
+extern const char *bt_plugin_get_path(struct bt_plugin *plugin);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* BABELTRACE_PLUGIN_H */