Document libbabeltrace2's C API
[babeltrace.git] / src / bindings / python / bt2 / bt2 / native_bt_plugin.i
1 /*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25 /* Output argument typemap for plugin output (always appends) */
26 %typemap(in, numinputs=0)
27 (const bt_plugin **)
28 (bt_plugin *temp_plugin = NULL) {
29 $1 = &temp_plugin;
30 }
31
32 %typemap(argout)
33 (const bt_plugin **) {
34 if (*$1) {
35 /* SWIG_Python_AppendOutput() steals the created object */
36 $result = SWIG_Python_AppendOutput($result,
37 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
38 SWIGTYPE_p_bt_plugin, 0));
39 } else {
40 /* SWIG_Python_AppendOutput() steals Py_None */
41 Py_INCREF(Py_None);
42 $result = SWIG_Python_AppendOutput($result, Py_None);
43 }
44 }
45
46 /* Output argument typemap for plugin set output (always appends) */
47 %typemap(in, numinputs=0)
48 (const bt_plugin_set **)
49 (bt_plugin_set *temp_plugin_set = NULL) {
50 $1 = &temp_plugin_set;
51 }
52
53 %typemap(argout)
54 (const bt_plugin_set **) {
55 if (*$1) {
56 /* SWIG_Python_AppendOutput() steals the created object */
57 $result = SWIG_Python_AppendOutput($result,
58 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
59 SWIGTYPE_p_bt_plugin_set, 0));
60 } else {
61 /* SWIG_Python_AppendOutput() steals Py_None */
62 Py_INCREF(Py_None);
63 $result = SWIG_Python_AppendOutput($result, Py_None);
64 }
65 }
66
67 %include <babeltrace2/plugin/plugin-loading.h>
68
69 /* Helpers */
70
71 %{
72 #include "native_bt_plugin.i.h"
73 %}
74
75 bt_property_availability bt_bt2_plugin_get_version(
76 const bt_plugin *plugin, unsigned int *major,
77 unsigned int *minor, unsigned int *patch, const char **extra);
78
79 bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
80 bt_bool find_in_std_env_var, bt_bool find_in_user_dir,
81 bt_bool find_in_sys_dir, bt_bool find_in_static,
82 bt_bool fail_on_load_error, const bt_plugin **plugin);
83
84 bt_plugin_find_all_status bt_bt2_plugin_find_all(bt_bool find_in_std_env_var,
85 bt_bool find_in_user_dir, bt_bool find_in_sys_dir,
86 bt_bool find_in_static, bt_bool fail_on_load_error,
87 const bt_plugin_set **plugin_set);
88
89 bt_plugin_find_all_from_file_status bt_bt2_plugin_find_all_from_file(
90 const char *path, bt_bool fail_on_load_error,
91 const bt_plugin_set **plugin_set);
92
93 bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
94 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
95 const bt_plugin_set **plugin_set);
This page took 0.03088 seconds and 4 git commands to generate.