lib: strictly type function return status enumerations
[babeltrace.git] / src / bindings / python / bt2 / bt2 / native_bt_plugin.i
index 435d40f2ed7de5b86243d5e26d18bf6710d72baa..4cdf9a41308f939b65dd80710f08333ef93ae62d 100644 (file)
  * THE SOFTWARE.
  */
 
-/* From plugin-const.h */
-
-extern const bt_plugin *bt_plugin_find(const char *plugin_name);
-
-extern const bt_plugin_set *bt_plugin_find_all_from_file(
-               const char *path);
-
-extern const bt_plugin_set *bt_plugin_find_all_from_dir(
-               const char *path, bt_bool recurse);
-
-extern const bt_plugin_set *bt_plugin_find_all_from_static(void);
-
-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 bt_property_availability bt_plugin_get_version(
-               const bt_plugin *plugin, unsigned int *OUT,
-               unsigned int *OUT, unsigned int *OUT, const char **OUT);
-
-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);
+/* Output argument typemap for plugin output (always appends) */
+%typemap(in, numinputs=0)
+       (const bt_plugin **)
+       (bt_plugin *temp_plugin = NULL) {
+       $1 = &temp_plugin;
+}
 
-extern void bt_plugin_get_ref(const bt_plugin *plugin);
+%typemap(argout)
+       (const bt_plugin **) {
+       if (*$1) {
+               /* SWIG_Python_AppendOutput() steals the created object */
+               $result = SWIG_Python_AppendOutput($result,
+                               SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
+                                       SWIGTYPE_p_bt_plugin, 0));
+       } else {
+               /* SWIG_Python_AppendOutput() steals Py_None */
+               Py_INCREF(Py_None);
+               $result = SWIG_Python_AppendOutput($result, Py_None);
+       }
+}
 
-extern void bt_plugin_put_ref(const bt_plugin *plugin);
+/* Output argument typemap for plugin set output (always appends) */
+%typemap(in, numinputs=0)
+       (const bt_plugin_set **)
+       (bt_plugin_set *temp_plugin_set = NULL) {
+       $1 = &temp_plugin_set;
+}
 
-/* From plugin-set-const.h */
+%typemap(argout)
+       (const bt_plugin_set **) {
+       if (*$1) {
+               /* SWIG_Python_AppendOutput() steals the created object */
+               $result = SWIG_Python_AppendOutput($result,
+                               SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
+                                       SWIGTYPE_p_bt_plugin_set, 0));
+       } else {
+               /* SWIG_Python_AppendOutput() steals Py_None */
+               Py_INCREF(Py_None);
+               $result = SWIG_Python_AppendOutput($result, Py_None);
+       }
+}
 
-extern uint64_t bt_plugin_set_get_plugin_count(
-               const bt_plugin_set *plugin_set);
+%include <babeltrace2/plugin/plugin-const.h>
+%include <babeltrace2/plugin/plugin-set-const.h>
 
-extern const bt_plugin *bt_plugin_set_borrow_plugin_by_index_const(
-               const bt_plugin_set *plugin_set, uint64_t index);
+/* Helpers */
 
-extern void bt_plugin_set_get_ref(const bt_plugin_set *plugin_set);
+bt_property_availability bt_bt2_plugin_get_version(
+               const bt_plugin *plugin, unsigned int *major,
+               unsigned int *minor, unsigned int *patch, const char **extra);
 
-extern void bt_plugin_set_put_ref(const bt_plugin_set *plugin_set);
+bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
+               bt_bool fail_on_load_error, const bt_plugin **plugin);
 
-/* Helpers */
+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_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_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);
 
 %{
-
 /*
- * This wrapper ensures that when the API function fails, the `*extra` output
- * parameter is set to NULL.  This is necessary because the epilogue of the
- * "char **OUT" typemap will use that value to make a Python str object.  We
- * can't rely on the initial value of `*extra`, it could point to unreadable
- * memory.
+ * Those  bt_bt2_*() 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)
 {
@@ -128,4 +108,47 @@ bt_property_availability bt_plugin_get_version_wrapper(
        return ret;
 }
 
+bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
+               bt_bool fail_on_load_error, const bt_plugin **plugin)
+{
+       bt_plugin_find_status status;
+
+       status = bt_plugin_find(plugin_name, fail_on_load_error,
+               plugin);
+       if (status != __BT_FUNC_STATUS_OK) {
+               *plugin = NULL;
+       }
+
+       return status;
+}
+
+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_find_all_from_file_status status;
+
+       status = bt_plugin_find_all_from_file(path, fail_on_load_error,
+               plugin_set);
+       if (status != __BT_FUNC_STATUS_OK) {
+               *plugin_set = NULL;
+       }
+
+       return status;
+}
+
+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_find_all_from_dir_status status;
+
+       status = bt_plugin_find_all_from_dir(path, recurse, fail_on_load_error,
+               plugin_set);
+       if (status != __BT_FUNC_STATUS_OK) {
+               *plugin_set = NULL;
+       }
+
+       return status;
+}
 %}
This page took 0.025762 seconds and 4 git commands to generate.