X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fplugin%2Fplugin.h;h=66436dfb47dbd44eab11d92ad5f1bbab6cc0bfda;hb=6ba0b073d3cc5040234aad3ab820b7ca4022e3e9;hp=60a1a21a7b48ade9fdb9aedcf1fe1db36a8a36e5;hpb=62ed7c304672e2b6fd88b6d59fa3c9a7ad993a2d;p=babeltrace.git diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h index 60a1a21a..66436dfb 100644 --- a/include/babeltrace/plugin/plugin.h +++ b/include/babeltrace/plugin/plugin.h @@ -1,10 +1,11 @@ -#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 + * Copyright 2016 Jérémie Galarneau + * Copyright 2017 Philippe Proulx * * Author: Jérémie Galarneau * @@ -27,10 +28,88 @@ * SOFTWARE. */ -#include -#include -#include -#include -#include +#include +#include +#include -#endif /* BABELTRACE_PLUGIN_H */ +#ifdef __cplusplus +extern "C" { +#endif + +struct bt_plugin; +struct bt_component_class; + +/** + * 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, +}; + +extern struct bt_plugin **bt_plugin_create_all_from_file(const char *path); + +extern struct bt_plugin **bt_plugin_create_all_from_dir(const char *path, + bool recurse); + +extern struct bt_plugin **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 int bt_plugin_get_component_class_count(struct bt_plugin *plugin); + +extern struct bt_component_class *bt_plugin_get_component_class( + struct bt_plugin *plugin, size_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_type type); + +#ifdef __cplusplus +} +#endif + +#endif /* BABELTRACE_PLUGIN_PLUGIN_H */