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_bt2_plugin_get_version(
  73                 const bt_plugin *plugin, unsigned int *major,
  74                 unsigned int *minor, unsigned int *patch, const char **extra);
  75
  76 bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
  77                 bt_bool find_in_std_env_var, bt_bool find_in_user_dir,
  78                 bt_bool find_in_sys_dir, bt_bool find_in_static,
  79                 bt_bool fail_on_load_error, const bt_plugin **plugin);
  80
  81 bt_plugin_find_all_status bt_bt2_plugin_find_all(bt_bool find_in_std_env_var,
  82                 bt_bool find_in_user_dir, bt_bool find_in_sys_dir,
  83                 bt_bool find_in_static, bt_bool fail_on_load_error,
  84                 const bt_plugin_set **plugin_set);
  85
  86 bt_plugin_find_all_from_file_status bt_bt2_plugin_find_all_from_file(
  87                 const char *path, bt_bool fail_on_load_error,
  88                 const bt_plugin_set **plugin_set);
  89
  90 bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
  91                 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
  92                 const bt_plugin_set **plugin_set);
  93
  94 %{
  95 /*
  96  * Those  bt_bt2_*() functions below ensure that when the API function
  97  * fails, the output parameter is set to `NULL`.  This is necessary
  98  * because the epilogue of the `something **OUT` typemap will use that
  99  * value to make a Python object.  We can't rely on the initial value of
 100  * `*OUT`; it could point to unreadable memory.
 101  */
 102
 103 bt_property_availability bt_bt2_plugin_get_version(
 104                 const bt_plugin *plugin, unsigned int *major,
 105                 unsigned int *minor, unsigned int *patch, const char **extra)
 106 {
 107         bt_property_availability ret;
 108
 109         ret = bt_plugin_get_version(plugin, major, minor, patch, extra);
 110
 111         if (ret == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
 112                 *extra = NULL;
 113         }
 114
 115         return ret;
 116 }
 117
 118 bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
 119                 bt_bool find_in_std_env_var, bt_bool find_in_user_dir,
 120                 bt_bool find_in_sys_dir, bt_bool find_in_static,
 121                 bt_bool fail_on_load_error, const bt_plugin **plugin)
 122 {
 123         bt_plugin_find_status status;
 124
 125         status = bt_plugin_find(plugin_name, find_in_std_env_var,
 126                 find_in_user_dir, find_in_sys_dir, find_in_static,
 127                 fail_on_load_error, plugin);
 128         if (status != __BT_FUNC_STATUS_OK) {
 129                 *plugin = NULL;
 130         }
 131
 132         return status;
 133 }
 134
 135 bt_plugin_find_all_status bt_bt2_plugin_find_all(bt_bool find_in_std_env_var,
 136                 bt_bool find_in_user_dir, bt_bool find_in_sys_dir,
 137                 bt_bool find_in_static, bt_bool fail_on_load_error,
 138                 const bt_plugin_set **plugin_set)
 139 {
 140         bt_plugin_find_all_status status;
 141
 142         status = bt_plugin_find_all(find_in_std_env_var,
 143                 find_in_user_dir, find_in_sys_dir, find_in_static,
 144                 fail_on_load_error, plugin_set);
 145         if (status != __BT_FUNC_STATUS_OK) {
 146                 *plugin_set = NULL;
 147         }
 148
 149         return status;
 150 }
 151
 152 bt_plugin_find_all_from_file_status bt_bt2_plugin_find_all_from_file(
 153                 const char *path, bt_bool fail_on_load_error,
 154                 const bt_plugin_set **plugin_set)
 155 {
 156         bt_plugin_find_all_from_file_status status;
 157
 158         status = bt_plugin_find_all_from_file(path, fail_on_load_error,
 159                 plugin_set);
 160         if (status != __BT_FUNC_STATUS_OK) {
 161                 *plugin_set = NULL;
 162         }
 163
 164         return status;
 165 }
 166
 167 bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
 168                 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
 169                 const bt_plugin_set **plugin_set)
 170 {
 171         bt_plugin_find_all_from_dir_status status;
 172
 173         status = bt_plugin_find_all_from_dir(path, recurse, fail_on_load_error,
 174                 plugin_set);
 175         if (status != __BT_FUNC_STATUS_OK) {
 176                 *plugin_set = NULL;
 177         }
 178
 179         return status;
 180 }
 181 %}