lib: graph: add "self" and some "private" APIs

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

diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h
index ae6dae865a0591aa1ecf0153f71e22aecea44ad7..667486ea01fc51230a108776d64c2b74a7390713 100644 (file)
--- a/include/babeltrace/plugin/plugin.h
+++ b/include/babeltrace/plugin/plugin.h
@@ -1,11 +1,9 @@
-#ifndef BABELTRACE_PLUGIN_H
-#define BABELTRACE_PLUGIN_H
+#ifndef BABELTRACE_PLUGIN_PLUGIN_H
+#define BABELTRACE_PLUGIN_PLUGIN_H
 
 /*
- * BabelTrace - Babeltrace Plug-in Interface
- *
- * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- * Copyright 2015 Philippe Proulx <pproulx@efficios.com>
+ * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -28,33 +26,108 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/plugin/component-factory.h>
+#include <stdint.h>
+#include <stddef.h>
+
+/* For bt_bool */
+#include <babeltrace/types.h>
+
+/* For enum bt_component_class_type */
+#include <babeltrace/graph/component-class.h>
+
+/* For enum bt_component_class_source */
+#include <babeltrace/graph/component-class-source.h>
+
+/* For enum bt_component_class_filter */
+#include <babeltrace/graph/component-class-filter.h>
+
+/* For enum bt_component_class_sink */
+#include <babeltrace/graph/component-class-sink.h>
+
+/* For enum bt_property_availability */
+#include <babeltrace/property.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct bt_plugin;
+struct bt_plugin_set;
+struct bt_component_class;
+struct bt_component_class_source;
+struct bt_component_class_filter;
+struct bt_component_class_sink;
+
+enum bt_plugin_status {
+       BT_PLUGIN_STATUS_OK =           0,
+       BT_PLUGIN_STATUS_ERROR =        -1,
+       BT_PLUGIN_STATUS_NOMEM =        -12,
+};
+
+extern struct bt_plugin *bt_plugin_find(const char *plugin_name);
+
+extern struct bt_plugin_set *bt_plugin_create_all_from_file(const char *path);
+
+extern struct bt_plugin_set *bt_plugin_create_all_from_dir(const char *path,
+               bt_bool recurse);
+
+extern struct bt_plugin_set *bt_plugin_create_all_from_static(void);
+
+extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
+
+extern const char *bt_plugin_get_author(struct bt_plugin *plugin);
+
+extern const char *bt_plugin_get_license(struct bt_plugin *plugin);
+
+extern const char *bt_plugin_get_description(struct bt_plugin *plugin);
+
+extern const char *bt_plugin_get_path(struct bt_plugin *plugin);
+
+extern enum bt_property_availability bt_plugin_get_version(
+               struct bt_plugin *plugin, unsigned int *major,
+               unsigned int *minor, unsigned int *patch, const char **extra);
+
+extern uint64_t bt_plugin_get_source_component_class_count(
+               struct bt_plugin *plugin);
+
+extern uint64_t bt_plugin_get_filter_component_class_count(
+               struct bt_plugin *plugin);
+
+extern uint64_t bt_plugin_get_sink_component_class_count(
+               struct bt_plugin *plugin);
+
+extern struct bt_component_class_source *
+bt_plugin_borrow_source_component_class_by_index(
+               struct bt_plugin *plugin, uint64_t index);
+
+extern struct bt_component_class_filter *
+bt_plugin_borrow_filter_component_class_by_index(
+               struct bt_plugin *plugin, uint64_t index);
+
+extern struct bt_component_class_sink *
+bt_plugin_borrow_sink_component_class_by_index(
+               struct bt_plugin *plugin, uint64_t index);
+
+extern struct bt_component_class_source *
+bt_plugin_borrow_source_component_class_by_name(struct bt_plugin *plugin,
+               const char *name);
 
-#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)     void *__bt_plugin_init = (_x)
-#define BT_PLUGIN_EXIT(_x)     void *__bt_plugin_exit = (_x)
+extern struct bt_component_class_filter *
+bt_plugin_borrow_filter_component_class_by_name(struct bt_plugin *plugin,
+               const char *name);
 
-#define BT_PLUGIN_COMPONENT_CLASSES_BEGIN                      \
-       enum bt_status __bt_plugin_register_component_classes(\
-               struct bt_component_factory *factory)\
-       {
+extern struct bt_component_class_sink *
+bt_plugin_borrow_sink_component_class_by_name(struct bt_plugin *plugin,
+               const char *name);
 
-#define BT_PLUGIN_SOURCE_COMPONENT_CLASS_ENTRY(_name, _init, _fini, _it_cr) \
-       bt_component_factory_register_source_component_class(factory, \
-               _name, _init, _fini, _it_cr);
+extern uint64_t bt_plugin_set_get_plugin_count(
+               struct bt_plugin_set *plugin_set);
 
-#define BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY(_name, _init, _fini, _hd_notif) \
-       bt_component_factory_register_sink_component_class(factory, \
-               _name, _init, _fini, _hd_notif);
+extern struct bt_plugin *bt_plugin_set_borrow_plugin_by_index(
+               struct bt_plugin_set *plugin_set, uint64_t index);
 
-#define BT_PLUGIN_COMPONENT_CLASSES_END\
-       \
-       return BT_STATUS_OK;\
-}\
-       \
-       BT_PLUGIN_INIT(__bt_plugin_register_component_classes);\
-       BT_PLUGIN_EXIT(NULL);
+#ifdef __cplusplus
+}
+#endif
 
-#endif /* BABELTRACE_PLUGIN_H */
+#endif /* BABELTRACE_PLUGIN_PLUGIN_H */