Update project plugins's properties
[babeltrace.git] / src / bindings / python / bt2 / bt2 / native_bt.i
1 /*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2016 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 #ifndef SWIGPYTHON
26 # error Unsupported output language
27 #endif
28
29 %module native_bt
30
31 %{
32 #define BT_LOG_TAG "BT2-PY"
33 #include "logging.h"
34
35 /*
36 * Include before `<babeltrace2/func-status.h>` because
37 * `<babeltrace2/babeltrace.h>` removes the `__BT_IN_BABELTRACE_H`
38 * definition.
39 */
40 #include <babeltrace2/babeltrace.h>
41
42 /*
43 * This is not part of the API, but because those bindings reside within
44 * the project, we take the liberty to use them.
45 */
46 #define __BT_IN_BABELTRACE_H
47 #include <babeltrace2/func-status.h>
48
49 #include "common/assert.h"
50 #include "py-common/py-common.h"
51
52 /* Used by some interface files */
53 #include "native_bt_bt2_objects.h"
54 #include "native_bt_log_and_append_error.h"
55 %}
56
57 typedef int bt_bool;
58 typedef uint64_t bt_listener_id;
59
60 /* For uint*_t/int*_t */
61 %include "stdint.i"
62
63 /*
64 * Remove `bt_` and `BT_` prefixes from function names, global variables and
65 * enumeration items
66 */
67 %rename("%(strip:[bt_])s", %$isfunction) "";
68 %rename("%(strip:[bt_])s", %$isvariable) "";
69 %rename("%(strip:[BT_])s", %$isenumitem) "";
70
71 /*
72 * Output argument typemap for string output (always appends)
73 *
74 * We initialize the output parameter `temp_value` to an invalid but non-zero
75 * pointer value. This is to make sure we don't rely on its initial value in
76 * the epilogue (where we call SWIG_Python_str_FromChar). When they fail,
77 * functions on which we apply this typemap don't guarantee that the value of
78 * `temp_value` will be unchanged or valid.
79 */
80 %typemap(in, numinputs=0) (const char **) (char *temp_value = (void *) 1) {
81 $1 = &temp_value;
82 }
83
84 %typemap(argout) (const char **) {
85 if (*$1) {
86 /* SWIG_Python_AppendOutput() steals the created object */
87 $result = SWIG_Python_AppendOutput($result, SWIG_Python_str_FromChar(*$1));
88 } else {
89 /* SWIG_Python_AppendOutput() steals Py_None */
90 Py_INCREF(Py_None);
91 $result = SWIG_Python_AppendOutput($result, Py_None);
92 }
93 }
94
95 /* Output argument typemap for value output (always appends) */
96 %typemap(in, numinputs=0) (bt_value **) (struct bt_value *temp_value = NULL) {
97 $1 = &temp_value;
98 }
99
100 %typemap(argout) (bt_value **) {
101 if (*$1) {
102 /* SWIG_Python_AppendOutput() steals the created object */
103 $result = SWIG_Python_AppendOutput($result,
104 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
105 SWIGTYPE_p_bt_value, 0));
106 } else {
107 /* SWIG_Python_AppendOutput() steals Py_None */
108 Py_INCREF(Py_None);
109 $result = SWIG_Python_AppendOutput($result, Py_None);
110 }
111 }
112
113 /* Output argument typemap for initialized uint64_t output parameter (always appends) */
114 %typemap(in, numinputs=0) (uint64_t *) (uint64_t temp) {
115 $1 = &temp;
116 }
117
118 %typemap(argout) uint64_t * {
119 $result = SWIG_Python_AppendOutput(resultobj,
120 SWIG_From_unsigned_SS_long_SS_long((*$1)));
121 }
122
123 /* Output argument typemap for initialized int64_t output parameter (always appends) */
124 %typemap(in, numinputs=0) (int64_t *) (int64_t temp) {
125 $1 = &temp;
126 }
127
128 %typemap(argout) (int64_t *) {
129 $result = SWIG_Python_AppendOutput(resultobj, SWIG_From_long_SS_long((*$1)));
130 }
131
132 /* Output argument typemap for initialized unsigned int output parameter (always appends) */
133 %typemap(in, numinputs=0) (unsigned int *) (unsigned int temp) {
134 $1 = &temp;
135 }
136
137 %typemap(argout) (unsigned int *) {
138 $result = SWIG_Python_AppendOutput(resultobj,
139 SWIG_From_unsigned_SS_long_SS_long((uint64_t) (*$1)));
140 }
141
142 /* Output argument typemap for initialized bt_boot output parameter (always appends) */
143 %typemap(in, numinputs=0) (bt_bool *) (bt_bool temp) {
144 $1 = &temp;
145 }
146
147 %typemap(argout) bt_bool * {
148 $result = SWIG_Python_AppendOutput(resultobj,
149 SWIG_From_bool(*$1));
150 }
151
152 /* Input argument typemap for UUID bytes */
153 %typemap(in) bt_uuid {
154 $1 = (unsigned char *) PyBytes_AsString($input);
155 }
156
157 /* Output argument typemap for UUID bytes */
158 %typemap(out) bt_uuid {
159 if (!$1) {
160 Py_INCREF(Py_None);
161 $result = Py_None;
162 } else {
163 $result = PyBytes_FromStringAndSize((const char *) $1, 16);
164 }
165 }
166
167 /* Input argument typemap for bt_bool */
168 %typemap(in) bt_bool {
169 $1 = PyObject_IsTrue($input);
170 }
171
172 /* Output argument typemap for bt_bool */
173 %typemap(out) bt_bool {
174 if ($1 > 0) {
175 $result = Py_True;
176 } else {
177 $result = Py_False;
178 }
179 Py_INCREF($result);
180 }
181
182 /*
183 * Input and output argument typemaps for raw Python objects (direct).
184 *
185 * Those typemaps honor the convention of Python C function calls with
186 * respect to reference counting: parameters are passed as borrowed
187 * references, and objects are returned as new references. The wrapped
188 * C function must ensure that the return value is always a new
189 * reference, and never steal parameter references.
190 */
191 %typemap(in) PyObject * {
192 $1 = $input;
193 }
194
195 %typemap(out) PyObject * {
196 $result = $1;
197 }
198
199 /* Native part initialization and finalization */
200 void bt_bt2_init_from_bt2(void);
201 void bt_bt2_exit_handler(void);
202
203 /*
204 * Define `__BT_IN_BABELTRACE_H` to allow specific headers to be
205 * included. This remains defined as long as we don't include the main
206 * header, `<babeltrace2/babeltrace.h>`.
207 */
208 #define __BT_IN_BABELTRACE_H
209
210 /* Property enumeration */
211 %include <babeltrace2/property.h>
212
213 /* Common function status codes */
214 %include <babeltrace2/func-status.h>
215
216 /* Per-module interface files */
217 %include "native_bt_autodisc.i"
218 %include "native_bt_clock_class.i"
219 %include "native_bt_clock_snapshot.i"
220 %include "native_bt_component.i"
221 %include "native_bt_component_class.i"
222 %include "native_bt_connection.i"
223 %include "native_bt_error.i"
224 %include "native_bt_event.i"
225 %include "native_bt_event_class.i"
226 %include "native_bt_field.i"
227 %include "native_bt_field_class.i"
228 %include "native_bt_field_path.i"
229 %include "native_bt_graph.i"
230 %include "native_bt_integer_range_set.i"
231 %include "native_bt_interrupter.i"
232 %include "native_bt_logging.i"
233 %include "native_bt_message.i"
234 %include "native_bt_message_iterator.i"
235 %include "native_bt_mip.i"
236 %include "native_bt_packet.i"
237 %include "native_bt_plugin.i"
238 %include "native_bt_port.i"
239 %include "native_bt_query_exec.i"
240 %include "native_bt_stream.i"
241 %include "native_bt_stream_class.i"
242 %include "native_bt_trace.i"
243 %include "native_bt_trace_class.i"
244 %include "native_bt_value.i"
245 %include "native_bt_version.i"
This page took 0.034907 seconds and 4 git commands to generate.