src/bindings/python/bt2/bt2/native_bt_plugin.i.h

   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 /*
  26  * Those  bt_bt2_*() functions below ensure that when the API function
  27  * fails, the output parameter is set to `NULL`.  This is necessary
  28  * because the epilogue of the `something **OUT` typemap will use that
  29  * value to make a Python object.  We can't rely on the initial value of
  30  * `*OUT`; it could point to unreadable memory.
  31  */
  32
  33 static
  34 bt_property_availability bt_bt2_plugin_get_version(
  35                 const bt_plugin *plugin, unsigned int *major,
  36                 unsigned int *minor, unsigned int *patch, const char **extra)
  37 {
  38         bt_property_availability ret;
  39
  40         ret = bt_plugin_get_version(plugin, major, minor, patch, extra);
  41
  42         if (ret == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
  43                 *extra = NULL;
  44         }
  45
  46         return ret;
  47 }
  48
  49 static
  50 bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
  51                 bt_bool find_in_std_env_var, bt_bool find_in_user_dir,
  52                 bt_bool find_in_sys_dir, bt_bool find_in_static,
  53                 bt_bool fail_on_load_error, const bt_plugin **plugin)
  54 {
  55         bt_plugin_find_status status;
  56
  57         status = bt_plugin_find(plugin_name, find_in_std_env_var,
  58                 find_in_user_dir, find_in_sys_dir, find_in_static,
  59                 fail_on_load_error, plugin);
  60         if (status != __BT_FUNC_STATUS_OK) {
  61                 *plugin = NULL;
  62         }
  63
  64         return status;
  65 }
  66
  67 static
  68 bt_plugin_find_all_status bt_bt2_plugin_find_all(bt_bool find_in_std_env_var,
  69                 bt_bool find_in_user_dir, bt_bool find_in_sys_dir,
  70                 bt_bool find_in_static, bt_bool fail_on_load_error,
  71                 const bt_plugin_set **plugin_set)
  72 {
  73         bt_plugin_find_all_status status;
  74
  75         status = bt_plugin_find_all(find_in_std_env_var,
  76                 find_in_user_dir, find_in_sys_dir, find_in_static,
  77                 fail_on_load_error, plugin_set);
  78         if (status != __BT_FUNC_STATUS_OK) {
  79                 *plugin_set = NULL;
  80         }
  81
  82         return status;
  83 }
  84
  85 static
  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_file_status status;
  91
  92         status = bt_plugin_find_all_from_file(path, fail_on_load_error,
  93                 plugin_set);
  94         if (status != __BT_FUNC_STATUS_OK) {
  95                 *plugin_set = NULL;
  96         }
  97
  98         return status;
  99 }
 100
 101 static
 102 bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
 103                 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
 104                 const bt_plugin_set **plugin_set)
 105 {
 106         bt_plugin_find_all_from_dir_status status;
 107
 108         status = bt_plugin_find_all_from_dir(path, recurse, fail_on_load_error,
 109                 plugin_set);
 110         if (status != __BT_FUNC_STATUS_OK) {
 111                 *plugin_set = NULL;
 112         }
 113
 114         return status;
 115 }