Document libbabeltrace2's C API

[babeltrace.git] / src / bindings / python / bt2 / bt2 / native_bt_plugin.i

diff --git a/src/bindings/python/bt2/bt2/native_bt_plugin.i b/src/bindings/python/bt2/bt2/native_bt_plugin.i
index 9d2677c74e852e7c9807d0c667d4d25c5ac7744f..edd91e797689bfb1900d5a9fe223c65d4ac71ecf 100644 (file)
--- a/src/bindings/python/bt2/bt2/native_bt_plugin.i
+++ b/src/bindings/python/bt2/bt2/native_bt_plugin.i
@@ -64,93 +64,32 @@
        }
 }
 
-%include <babeltrace2/plugin/plugin-const.h>
-%include <babeltrace2/plugin/plugin-set-const.h>
+%include <babeltrace2/plugin/plugin-loading.h>
 
 /* Helpers */
 
-bt_property_availability bt_plugin_get_version_wrapper(
+%{
+#include "native_bt_plugin.i.h"
+%}
+
+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_plugin_status bt_plugin_find_wrapper(const char *plugin_name,
+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);
 
-bt_plugin_status bt_plugin_find_all_from_file_wrapper(
-               const char *path, bt_bool fail_on_load_error,
+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);
 
-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 **plugin_set);
-
-%{
-
-/*
- * 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(
-               const bt_plugin *plugin, unsigned int *major,
-               unsigned int *minor, unsigned int *patch, const char **extra)
-{
-       bt_property_availability ret;
-
-       ret = bt_plugin_get_version(plugin, major, minor, patch, extra);
-
-       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;
-       }
-
-       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);