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