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
  53 typedef int bt_bool;
  54 typedef uint64_t bt_listener_id;
  55
  56 /* For uint*_t/int*_t */
  57 %include "stdint.i"
  58
  59 /*
  60  * Remove `bt_` and `BT_` prefixes from function names, global variables and
  61  * enumeration items
  62  */
  63 %rename("%(strip:[bt_])s", %$isfunction) "";
  64 %rename("%(strip:[bt_])s", %$isvariable) "";
  65 %rename("%(strip:[BT_])s", %$isenumitem) "";
  66
  67 /*
  68  * Output argument typemap for string output (always appends)
  69  *
  70  * We initialize the output parameter `temp_value` to an invalid but non-zero
  71  * pointer value.  This is to make sure we don't rely on its initial value in
  72  * the epilogue (where we call SWIG_Python_str_FromChar).  When they fail,
  73  * functions on which we apply this typemap don't guarantee that the value of
  74  * `temp_value` will be unchanged or valid.
  75  */
  76 %typemap(in, numinputs=0) (const char **) (char *temp_value = (void *) 1) {
  77         $1 = &temp_value;
  78 }
  79
  80 %typemap(argout) (const char **) {
  81         if (*$1) {
  82                 /* SWIG_Python_AppendOutput() steals the created object */
  83                 $result = SWIG_Python_AppendOutput($result, SWIG_Python_str_FromChar(*$1));
  84         } else {
  85                 /* SWIG_Python_AppendOutput() steals Py_None */
  86                 Py_INCREF(Py_None);
  87                 $result = SWIG_Python_AppendOutput($result, Py_None);
  88         }
  89 }
  90
  91 /* Output argument typemap for value output (always appends) */
  92 %typemap(in, numinputs=0) (bt_value **) (struct bt_value *temp_value = NULL) {
  93         $1 = &temp_value;
  94 }
  95
  96 %typemap(argout) (bt_value **) {
  97         if (*$1) {
  98                 /* SWIG_Python_AppendOutput() steals the created object */
  99                 $result = SWIG_Python_AppendOutput($result,
 100                                 SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
 101                                         SWIGTYPE_p_bt_value, 0));
 102         } else {
 103                 /* SWIG_Python_AppendOutput() steals Py_None */
 104                 Py_INCREF(Py_None);
 105                 $result = SWIG_Python_AppendOutput($result, Py_None);
 106         }
 107 }
 108
 109 /* Output argument typemap for initialized uint64_t output parameter (always appends) */
 110 %typemap(in, numinputs=0) (uint64_t *) (uint64_t temp) {
 111         $1 = &temp;
 112 }
 113
 114 %typemap(argout) uint64_t * {
 115         $result = SWIG_Python_AppendOutput(resultobj,
 116                         SWIG_From_unsigned_SS_long_SS_long((*$1)));
 117 }
 118
 119 /* Output argument typemap for initialized int64_t output parameter (always appends) */
 120 %typemap(in, numinputs=0) (int64_t *) (int64_t temp) {
 121         $1 = &temp;
 122 }
 123
 124 %typemap(argout) (int64_t *) {
 125         $result = SWIG_Python_AppendOutput(resultobj, SWIG_From_long_SS_long((*$1)));
 126 }
 127
 128 /* Output argument typemap for initialized unsigned int output parameter (always appends) */
 129 %typemap(in, numinputs=0) (unsigned int *) (unsigned int temp) {
 130         $1 = &temp;
 131 }
 132
 133 %typemap(argout) (unsigned int *) {
 134         $result = SWIG_Python_AppendOutput(resultobj,
 135                         SWIG_From_unsigned_SS_long_SS_long((uint64_t) (*$1)));
 136 }
 137
 138 /* Input argument typemap for UUID bytes */
 139 %typemap(in) bt_uuid {
 140         $1 = (unsigned char *) PyBytes_AsString($input);
 141 }
 142
 143 /* Output argument typemap for UUID bytes */
 144 %typemap(out) bt_uuid {
 145         if (!$1) {
 146                 Py_INCREF(Py_None);
 147                 $result = Py_None;
 148         } else {
 149                 $result = PyBytes_FromStringAndSize((const char *) $1, 16);
 150         }
 151 }
 152
 153 /* Input argument typemap for bt_bool */
 154 %typemap(in) bt_bool {
 155         $1 = PyObject_IsTrue($input);
 156 }
 157
 158 /* Output argument typemap for bt_bool */
 159 %typemap(out) bt_bool {
 160         if ($1 > 0) {
 161                 $result = Py_True;
 162         } else {
 163                 $result = Py_False;
 164         }
 165         Py_INCREF($result);
 166 }
 167
 168 /*
 169  * Input and output argument typemaps for raw Python objects (direct).
 170  *
 171  * Those typemaps honor the convention of Python C function calls with
 172  * respect to reference counting: parameters are passed as borrowed
 173  * references, and objects are returned as new references. The wrapped
 174  * C function must ensure that the return value is always a new
 175  * reference, and never steal parameter references.
 176  */
 177 %typemap(in) PyObject * {
 178         $1 = $input;
 179 }
 180
 181 %typemap(out) PyObject * {
 182         $result = $1;
 183 }
 184
 185 /*
 186  * Define `__BT_IN_BABELTRACE_H` to allow specific headers to be
 187  * included. This remains defined as long as we don't include the main
 188  * header, `<babeltrace2/babeltrace.h>`.
 189  */
 190 #define __BT_IN_BABELTRACE_H
 191
 192 /* Property enumeration */
 193 %include <babeltrace2/property.h>
 194
 195 /* Common function status codes */
 196 %include <babeltrace2/func-status.h>
 197
 198 /* Per-module interface files */
 199 %include "native_bt_clock_class.i"
 200 %include "native_bt_clock_snapshot.i"
 201 %include "native_bt_component.i"
 202 %include "native_bt_component_class.i"
 203 %include "native_bt_connection.i"
 204 %include "native_bt_error.i"
 205 %include "native_bt_event.i"
 206 %include "native_bt_event_class.i"
 207 %include "native_bt_field.i"
 208 %include "native_bt_field_class.i"
 209 %include "native_bt_field_path.i"
 210 %include "native_bt_graph.i"
 211 %include "native_bt_integer_range_set.i"
 212 %include "native_bt_interrupter.i"
 213 %include "native_bt_logging.i"
 214 %include "native_bt_message.i"
 215 %include "native_bt_message_iterator.i"
 216 %include "native_bt_packet.i"
 217 %include "native_bt_plugin.i"
 218 %include "native_bt_port.i"
 219 %include "native_bt_query_exec.i"
 220 %include "native_bt_stream.i"
 221 %include "native_bt_stream_class.i"
 222 %include "native_bt_trace.i"
 223 %include "native_bt_trace_class.i"
 224 %include "native_bt_value.i"
 225 %include "native_bt_version.i"