bindings/python/bt2/bt2/native_btplugin.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 /* Types */
  26 struct bt_plugin;
  27 struct bt_plugin_set;
  28
  29 /* Status */
  30 enum bt_plugin_status {
  31         BT_PLUGIN_STATUS_OK = 0,
  32         BT_PLUGIN_STATUS_ERROR = -1,
  33         BT_PLUGIN_STATUS_NOMEM = -4,
  34 };
  35
  36 /* Plugin functions */
  37 struct bt_plugin *bt_plugin_find(const char *plugin_name);
  38 struct bt_component_class *bt_plugin_find_component_class(
  39                 const char *plugin_name, const char *component_class_name,
  40                 enum bt_component_class_type component_class_type);
  41 struct bt_plugin_set *bt_plugin_create_all_from_file(const char *path);
  42 struct bt_plugin_set *bt_plugin_create_all_from_dir(const char *path,
  43                 int recurse);
  44 struct bt_plugin_set *bt_plugin_create_all_from_static(void);
  45 const char *bt_plugin_get_name(struct bt_plugin *plugin);
  46 const char *bt_plugin_get_author(struct bt_plugin *plugin);
  47 const char *bt_plugin_get_license(struct bt_plugin *plugin);
  48 const char *bt_plugin_get_description(struct bt_plugin *plugin);
  49 const char *bt_plugin_get_path(struct bt_plugin *plugin);
  50 enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin,
  51                 unsigned int *OUTPUTINIT, unsigned int *OUTPUTINIT,
  52                 unsigned int *OUTPUTINIT, const char **BTOUTSTR);
  53 int64_t bt_plugin_get_component_class_count(struct bt_plugin *plugin);
  54 struct bt_component_class *bt_plugin_get_component_class_by_index(
  55                 struct bt_plugin *plugin, uint64_t index);
  56 struct bt_component_class *bt_plugin_get_component_class_by_name_and_type(
  57                 struct bt_plugin *plugin, const char *name,
  58                 enum bt_component_class_type type);
  59
  60 /* Plugin set functions */
  61 int64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set *plugin_set);
  62 struct bt_plugin *bt_plugin_set_get_plugin(struct bt_plugin_set *plugin_set,
  63                 uint64_t index);