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_plugin_get_version_wrapper(
  73                 const bt_plugin *plugin, unsigned int *major,
  74                 unsigned int *minor, unsigned int *patch, const char **extra);
  75
  76 bt_plugin_status bt_plugin_find_wrapper(const char *plugin_name,
  77                 bt_bool fail_on_load_error, const bt_plugin **plugin);
  78
  79 bt_plugin_status bt_plugin_find_all_from_file_wrapper(
  80                 const char *path, bt_bool fail_on_load_error,
  81                 const bt_plugin_set **plugin_set);
  82
  83 bt_plugin_status bt_plugin_find_all_from_dir_wrapper(
  84                 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
  85                 const bt_plugin_set **plugin_set);
  86
  87 %{
  88
  89 /*
  90  * This *_wrapper() functions below ensure that when the API function
  91  * fails, the output parameter is set to `NULL`.  This is necessary
  92  * because the epilogue of the `something **OUT` typemap will use that
  93  * value to make a Python object.  We can't rely on the initial value of
  94  * `*OUT`; it could point to unreadable memory.
  95  */
  96
  97 bt_property_availability bt_plugin_get_version_wrapper(
  98                 const bt_plugin *plugin, unsigned int *major,
  99                 unsigned int *minor, unsigned int *patch, const char **extra)
 100 {
 101         bt_property_availability ret;
 102
 103         ret = bt_plugin_get_version(plugin, major, minor, patch, extra);
 104
 105         if (ret == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
 106                 *extra = NULL;
 107         }
 108
 109         return ret;
 110 }
 111
 112 bt_plugin_status bt_plugin_find_wrapper(const char *plugin_name,
 113                 bt_bool fail_on_load_error, const bt_plugin **plugin)
 114 {
 115         bt_plugin_status status;
 116
 117         status = bt_plugin_find(plugin_name, fail_on_load_error,
 118                 plugin);
 119         if (status != BT_PLUGIN_STATUS_OK) {
 120                 *plugin = NULL;
 121         }
 122
 123         return status;
 124 }
 125
 126 bt_plugin_status bt_plugin_find_all_from_file_wrapper(
 127                 const char *path, bt_bool fail_on_load_error,
 128                 const bt_plugin_set **plugin_set)
 129 {
 130         bt_plugin_status status;
 131
 132         status = bt_plugin_find_all_from_file(path, fail_on_load_error,
 133                 plugin_set);
 134         if (status != BT_PLUGIN_STATUS_OK) {
 135                 *plugin_set = NULL;
 136         }
 137
 138         return status;
 139 }
 140
 141 bt_plugin_status bt_plugin_find_all_from_dir_wrapper(
 142                 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
 143                 const bt_plugin_set **plugin_set)
 144 {
 145         bt_plugin_status status;
 146
 147         status = bt_plugin_find_all_from_dir(path, recurse, fail_on_load_error,
 148                 plugin_set);
 149         if (status != BT_PLUGIN_STATUS_OK) {
 150                 *plugin_set = NULL;
 151         }
 152
 153         return status;
 154 }
 155
 156 %}