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 ae7b7c7ad3d94a71c62680eb938ed43e3be3d769..667486ea01fc51230a108776d64c2b74a7390713 100644 (file)
--- a/include/babeltrace/plugin/plugin.h
+++ b/include/babeltrace/plugin/plugin.h
@@ -2,8 +2,6 @@
 #define BABELTRACE_PLUGIN_PLUGIN_H
 
 /*
- * BabelTrace - Babeltrace Plug-in Interface
- *
  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
  *
@@ -37,6 +35,18 @@
 /* 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
@@ -44,25 +54,18 @@ extern "C" {
 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;
 
-/**
- * Status code. Errors are always negative.
- */
 enum bt_plugin_status {
-       /** No error, okay. */
        BT_PLUGIN_STATUS_OK =           0,
-       /** General error. */
        BT_PLUGIN_STATUS_ERROR =        -1,
-       /** Memory allocation failure. */
-       BT_PLUGIN_STATUS_NOMEM =        -4,
+       BT_PLUGIN_STATUS_NOMEM =        -12,
 };
 
 extern struct bt_plugin *bt_plugin_find(const char *plugin_name);
 
-extern struct bt_component_class *bt_plugin_find_component_class(
-               const char *plugin_name, const char *component_class_name,
-               enum bt_component_class_type component_class_type);
-
 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,
@@ -70,66 +73,58 @@ extern struct bt_plugin_set *bt_plugin_create_all_from_dir(const char *path,
 
 extern struct bt_plugin_set *bt_plugin_create_all_from_static(void);
 
-/**
- * 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);
 
-extern enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin,
-               unsigned int *major, unsigned int *minor, unsigned int *patch,
-               const char **extra);
+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 int64_t bt_plugin_get_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 *bt_plugin_get_component_class_by_index(
+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 *bt_plugin_get_component_class_by_name_and_type(
-               struct bt_plugin *plugin, const char *name,
-               enum bt_component_class_type type);
+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);
+
+extern struct bt_component_class_filter *
+bt_plugin_borrow_filter_component_class_by_name(struct bt_plugin *plugin,
+               const char *name);
+
+extern struct bt_component_class_sink *
+bt_plugin_borrow_sink_component_class_by_name(struct bt_plugin *plugin,
+               const char *name);
 
-extern
-int64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set *plugin_set);
+extern uint64_t bt_plugin_set_get_plugin_count(
+               struct bt_plugin_set *plugin_set);
 
-extern
-struct bt_plugin *bt_plugin_set_get_plugin(struct bt_plugin_set *plugin_set,
-               uint64_t index);
+extern struct bt_plugin *bt_plugin_set_borrow_plugin_by_index(
+               struct bt_plugin_set *plugin_set, uint64_t index);
 
 #ifdef __cplusplus
 }