Document libbabeltrace2's C API
[babeltrace.git] / src / bindings / python / bt2 / bt2 / native_bt_plugin.i
index 44633f2c4a0311e97ffa74a6a52a2a4340558a87..edd91e797689bfb1900d5a9fe223c65d4ac71ecf 100644 (file)
 
 /* Output argument typemap for plugin output (always appends) */
 %typemap(in, numinputs=0)
-       (const bt_plugin **OUT)
+       (const bt_plugin **)
        (bt_plugin *temp_plugin = NULL) {
        $1 = &temp_plugin;
 }
 
 %typemap(argout)
-       (const bt_plugin **OUT) {
+       (const bt_plugin **) {
        if (*$1) {
                /* SWIG_Python_AppendOutput() steals the created object */
                $result = SWIG_Python_AppendOutput($result,
 
 /* Output argument typemap for plugin set output (always appends) */
 %typemap(in, numinputs=0)
-       (const bt_plugin_set **OUT)
+       (const bt_plugin_set **)
        (bt_plugin_set *temp_plugin_set = NULL) {
        $1 = &temp_plugin_set;
 }
 
 %typemap(argout)
-       (const bt_plugin_set **OUT) {
+       (const bt_plugin_set **) {
        if (*$1) {
                /* SWIG_Python_AppendOutput() steals the created object */
                $result = SWIG_Python_AppendOutput($result,
        }
 }
 
-/* From plugin-const.h */
-
-typedef enum bt_plugin_status {
-       BT_PLUGIN_STATUS_OK = 0,
-       BT_PLUGIN_STATUS_NOT_FOUND = 2,
-       BT_PLUGIN_STATUS_ERROR = -1,
-       BT_PLUGIN_STATUS_LOADING_ERROR = -2,
-       BT_PLUGIN_STATUS_NOMEM = -12,
-} bt_plugin_status;
-
-extern const char *bt_plugin_get_name(const bt_plugin *plugin);
-
-extern const char *bt_plugin_get_author(const bt_plugin *plugin);
-
-extern const char *bt_plugin_get_license(const bt_plugin *plugin);
-
-extern const char *bt_plugin_get_description(const bt_plugin *plugin);
-
-extern const char *bt_plugin_get_path(const bt_plugin *plugin);
-
-extern uint64_t bt_plugin_get_source_component_class_count(
-               const bt_plugin *plugin);
-
-extern uint64_t bt_plugin_get_filter_component_class_count(
-               const bt_plugin *plugin);
-
-extern uint64_t bt_plugin_get_sink_component_class_count(
-               const bt_plugin *plugin);
-
-extern const bt_component_class_source *
-bt_plugin_borrow_source_component_class_by_index_const(
-               const bt_plugin *plugin, uint64_t index);
-
-extern const bt_component_class_filter *
-bt_plugin_borrow_filter_component_class_by_index_const(
-               const bt_plugin *plugin, uint64_t index);
-
-extern const bt_component_class_sink *
-bt_plugin_borrow_sink_component_class_by_index_const(
-               const bt_plugin *plugin, uint64_t index);
-
-extern const bt_component_class_source *
-bt_plugin_borrow_source_component_class_by_name_const(
-               const bt_plugin *plugin, const char *name);
-
-extern const bt_component_class_filter *
-bt_plugin_borrow_filter_component_class_by_name_const(
-               const bt_plugin *plugin, const char *name);
-
-extern const bt_component_class_sink *
-bt_plugin_borrow_sink_component_class_by_name_const(
-               const bt_plugin *plugin, const char *name);
-
-extern void bt_plugin_get_ref(const bt_plugin *plugin);
-
-extern void bt_plugin_put_ref(const bt_plugin *plugin);
-
-/* From plugin-set-const.h */
-
-extern uint64_t bt_plugin_set_get_plugin_count(
-               const bt_plugin_set *plugin_set);
-
-extern const bt_plugin *bt_plugin_set_borrow_plugin_by_index_const(
-               const bt_plugin_set *plugin_set, uint64_t index);
-
-extern void bt_plugin_set_get_ref(const bt_plugin_set *plugin_set);
-
-extern void bt_plugin_set_put_ref(const bt_plugin_set *plugin_set);
+%include <babeltrace2/plugin/plugin-loading.h>
 
 /* Helpers */
 
-bt_property_availability bt_plugin_get_version_wrapper(
-               const bt_plugin *plugin, unsigned int *OUT,
-               unsigned int *OUT, unsigned int *OUT, const char **OUT);
-
-bt_plugin_status bt_plugin_find_wrapper(const char *plugin_name,
-               bt_bool fail_on_load_error, const bt_plugin **OUT);
-
-bt_plugin_status bt_plugin_find_all_from_file_wrapper(
-               const char *path, bt_bool fail_on_load_error,
-               const bt_plugin_set **OUT);
-
-bt_plugin_status bt_plugin_find_all_from_dir_wrapper(
-               const char *path, bt_bool recurse, bt_bool fail_on_load_error,
-               const bt_plugin_set **OUT);
-
 %{
+#include "native_bt_plugin.i.h"
+%}
 
-/*
- * This *_wrapper() functions below ensure that when the API function
- * fails, the output parameter is set to `NULL`.  This is necessary
- * because the epilogue of the `something **OUT` typemap will use that
- * value to make a Python object.  We can't rely on the initial value of
- * `*OUT`; it could point to unreadable memory.
- */
-
-bt_property_availability bt_plugin_get_version_wrapper(
+bt_property_availability bt_bt2_plugin_get_version(
                const bt_plugin *plugin, unsigned int *major,
-               unsigned int *minor, unsigned int *patch, const char **extra)
-{
-       bt_property_availability ret;
+               unsigned int *minor, unsigned int *patch, const char **extra);
 
-       ret = bt_plugin_get_version(plugin, major, minor, patch, extra);
+bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
+               bt_bool find_in_std_env_var, bt_bool find_in_user_dir,
+               bt_bool find_in_sys_dir, bt_bool find_in_static,
+               bt_bool fail_on_load_error, const bt_plugin **plugin);
 
-       if (ret == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
-               *extra = NULL;
-       }
-
-       return ret;
-}
-
-bt_plugin_status bt_plugin_find_wrapper(const char *plugin_name,
-               bt_bool fail_on_load_error, const bt_plugin **plugin)
-{
-       bt_plugin_status status;
-
-       status = bt_plugin_find(plugin_name, fail_on_load_error,
-               plugin);
-       if (status != BT_PLUGIN_STATUS_OK) {
-               *plugin = NULL;
-       }
+bt_plugin_find_all_status bt_bt2_plugin_find_all(bt_bool find_in_std_env_var,
+               bt_bool find_in_user_dir, bt_bool find_in_sys_dir,
+               bt_bool find_in_static, bt_bool fail_on_load_error,
+               const bt_plugin_set **plugin_set);
 
-       return status;
-}
-
-bt_plugin_status bt_plugin_find_all_from_file_wrapper(
+bt_plugin_find_all_from_file_status bt_bt2_plugin_find_all_from_file(
                const char *path, bt_bool fail_on_load_error,
-               const bt_plugin_set **plugin_set)
-{
-       bt_plugin_status status;
-
-       status = bt_plugin_find_all_from_file(path, fail_on_load_error,
-               plugin_set);
-       if (status != BT_PLUGIN_STATUS_OK) {
-               *plugin_set = NULL;
-       }
-
-       return status;
-}
+               const bt_plugin_set **plugin_set);
 
-bt_plugin_status bt_plugin_find_all_from_dir_wrapper(
+bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
                const char *path, bt_bool recurse, bt_bool fail_on_load_error,
-               const bt_plugin_set **plugin_set)
-{
-       bt_plugin_status status;
-
-       status = bt_plugin_find_all_from_dir(path, recurse, fail_on_load_error,
-               plugin_set);
-       if (status != BT_PLUGIN_STATUS_OK) {
-               *plugin_set = NULL;
-       }
-
-       return status;
-}
-
-%}
+               const bt_plugin_set **plugin_set);
This page took 0.041724 seconds and 4 git commands to generate.