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 bt_property_availability bt_bt2_plugin_get_version(
  34                 const bt_plugin *plugin, unsigned int *major,
  35                 unsigned int *minor, unsigned int *patch, const char **extra)
  36 {
  37         bt_property_availability ret;
  38
  39         ret = bt_plugin_get_version(plugin, major, minor, patch, extra);
  40
  41         if (ret == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
  42                 *extra = NULL;
  43         }
  44
  45         return ret;
  46 }
  47
  48 bt_plugin_find_status bt_bt2_plugin_find(const char *plugin_name,
  49                 bt_bool find_in_std_env_var, bt_bool find_in_user_dir,
  50                 bt_bool find_in_sys_dir, bt_bool find_in_static,
  51                 bt_bool fail_on_load_error, const bt_plugin **plugin)
  52 {
  53         bt_plugin_find_status status;
  54
  55         status = bt_plugin_find(plugin_name, find_in_std_env_var,
  56                 find_in_user_dir, find_in_sys_dir, find_in_static,
  57                 fail_on_load_error, plugin);
  58         if (status != __BT_FUNC_STATUS_OK) {
  59                 *plugin = NULL;
  60         }
  61
  62         return status;
  63 }
  64
  65 bt_plugin_find_all_status bt_bt2_plugin_find_all(bt_bool find_in_std_env_var,
  66                 bt_bool find_in_user_dir, bt_bool find_in_sys_dir,
  67                 bt_bool find_in_static, bt_bool fail_on_load_error,
  68                 const bt_plugin_set **plugin_set)
  69 {
  70         bt_plugin_find_all_status status;
  71
  72         status = bt_plugin_find_all(find_in_std_env_var,
  73                 find_in_user_dir, find_in_sys_dir, find_in_static,
  74                 fail_on_load_error, plugin_set);
  75         if (status != __BT_FUNC_STATUS_OK) {
  76                 *plugin_set = NULL;
  77         }
  78
  79         return status;
  80 }
  81
  82 bt_plugin_find_all_from_file_status bt_bt2_plugin_find_all_from_file(
  83                 const char *path, bt_bool fail_on_load_error,
  84                 const bt_plugin_set **plugin_set)
  85 {
  86         bt_plugin_find_all_from_file_status status;
  87
  88         status = bt_plugin_find_all_from_file(path, fail_on_load_error,
  89                 plugin_set);
  90         if (status != __BT_FUNC_STATUS_OK) {
  91                 *plugin_set = NULL;
  92         }
  93
  94         return status;
  95 }
  96
  97 bt_plugin_find_all_from_dir_status bt_bt2_plugin_find_all_from_dir(
  98                 const char *path, bt_bool recurse, bt_bool fail_on_load_error,
  99                 const bt_plugin_set **plugin_set)
 100 {
 101         bt_plugin_find_all_from_dir_status status;
 102
 103         status = bt_plugin_find_all_from_dir(path, recurse, fail_on_load_error,
 104                 plugin_set);
 105         if (status != __BT_FUNC_STATUS_OK) {
 106                 *plugin_set = NULL;
 107         }
 108
 109         return status;
 110 }