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