lib: strictly type function return status enumerations
[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-const.h>
68 %include <babeltrace2/plugin/plugin-set-const.h>
69
70 /* Helpers */
71
72 bt_property_availability bt_bt2_plugin_get_version(
73 const bt_plugin *plugin, unsigned int *major,
74 unsigned int *minor, unsigned int *patch, const char **extra);
75
76 bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
77 bt_bool fail_on_load_error, const bt_plugin **plugin);
78
79 bt_plugin_find_all_from_file_status bt_bt2_plugin_find_all_from_file(
80 const char *path, bt_bool fail_on_load_error,
81 const bt_plugin_set **plugin_set);
82
83 bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
84 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
85 const bt_plugin_set **plugin_set);
86
87 %{
88 /*
89 * Those bt_bt2_*() functions below ensure that when the API function
90 * fails, the output parameter is set to `NULL`. This is necessary
91 * because the epilogue of the `something **OUT` typemap will use that
92 * value to make a Python object. We can't rely on the initial value of
93 * `*OUT`; it could point to unreadable memory.
94 */
95
96 bt_property_availability bt_bt2_plugin_get_version(
97 const bt_plugin *plugin, unsigned int *major,
98 unsigned int *minor, unsigned int *patch, const char **extra)
99 {
100 bt_property_availability ret;
101
102 ret = bt_plugin_get_version(plugin, major, minor, patch, extra);
103
104 if (ret == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
105 *extra = NULL;
106 }
107
108 return ret;
109 }
110
111 bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
112 bt_bool fail_on_load_error, const bt_plugin **plugin)
113 {
114 bt_plugin_find_status status;
115
116 status = bt_plugin_find(plugin_name, fail_on_load_error,
117 plugin);
118 if (status != __BT_FUNC_STATUS_OK) {
119 *plugin = NULL;
120 }
121
122 return status;
123 }
124
125 bt_plugin_find_all_from_file_status bt_bt2_plugin_find_all_from_file(
126 const char *path, bt_bool fail_on_load_error,
127 const bt_plugin_set **plugin_set)
128 {
129 bt_plugin_find_all_from_file_status status;
130
131 status = bt_plugin_find_all_from_file(path, fail_on_load_error,
132 plugin_set);
133 if (status != __BT_FUNC_STATUS_OK) {
134 *plugin_set = NULL;
135 }
136
137 return status;
138 }
139
140 bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
141 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
142 const bt_plugin_set **plugin_set)
143 {
144 bt_plugin_find_all_from_dir_status status;
145
146 status = bt_plugin_find_all_from_dir(path, recurse, fail_on_load_error,
147 plugin_set);
148 if (status != __BT_FUNC_STATUS_OK) {
149 *plugin_set = NULL;
150 }
151
152 return status;
153 }
154 %}
This page took 0.03279 seconds and 4 git commands to generate.