include/babeltrace/plugin/plugin-internal.h

   1 #ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
   2 #define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Plug-in Internal
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/babeltrace-internal.h>
  31 #include <babeltrace/plugin/plugin-dev.h>
  32 #include <babeltrace/object-internal.h>
  33 #include <stdbool.h>
  34 #include <glib.h>
  35
  36 enum bt_plugin_type {
  37         BT_PLUGIN_TYPE_SO = 0,
  38         BT_PLUGIN_TYPE_PYTHON = 1,
  39 };
  40
  41 struct bt_plugin {
  42         struct bt_object base;
  43         enum bt_plugin_type type;
  44         bool frozen;
  45
  46         /* Array of pointers to bt_component_class (owned by this) */
  47         GPtrArray *comp_classes;
  48
  49         /* Info (owned by this) */
  50         struct {
  51                 GString *path;
  52                 GString *name;
  53                 GString *author;
  54                 GString *license;
  55                 GString *description;
  56                 struct {
  57                         unsigned int major;
  58                         unsigned int minor;
  59                         unsigned int patch;
  60                         GString *extra;
  61                 } version;
  62                 bool path_set;
  63                 bool name_set;
  64                 bool author_set;
  65                 bool license_set;
  66                 bool description_set;
  67                 bool version_set;
  68         } info;
  69
  70         /* Value depends on the specific plugin type */
  71         void *spec_data;
  72 };
  73
  74 BT_HIDDEN
  75 struct bt_plugin *bt_plugin_create_empty(enum bt_plugin_type type);
  76
  77 static inline
  78 void bt_plugin_set_path(struct bt_plugin *plugin, const char *path)
  79 {
  80         assert(plugin);
  81         assert(path);
  82         g_string_assign(plugin->info.path, path);
  83         plugin->info.path_set = true;
  84 }
  85
  86 static inline
  87 void bt_plugin_set_name(struct bt_plugin *plugin, const char *name)
  88 {
  89         assert(plugin);
  90         assert(name);
  91         g_string_assign(plugin->info.name, name);
  92         plugin->info.name_set = true;
  93 }
  94
  95 static inline
  96 void bt_plugin_set_description(struct bt_plugin *plugin,
  97                 const char *description)
  98 {
  99         assert(plugin);
 100         assert(description);
 101         g_string_assign(plugin->info.description, description);
 102         plugin->info.description_set = true;
 103 }
 104
 105 static inline
 106 void bt_plugin_set_author(struct bt_plugin *plugin, const char *author)
 107 {
 108         assert(plugin);
 109         assert(author);
 110         g_string_assign(plugin->info.author, author);
 111         plugin->info.author_set = true;
 112 }
 113
 114 static inline
 115 void bt_plugin_set_license(struct bt_plugin *plugin, const char *license)
 116 {
 117         assert(plugin);
 118         assert(license);
 119         g_string_assign(plugin->info.license, license);
 120         plugin->info.license_set = true;
 121 }
 122
 123 static inline
 124 void bt_plugin_set_version(struct bt_plugin *plugin, unsigned int major,
 125                 unsigned int minor, unsigned int patch, const char *extra)
 126 {
 127         assert(plugin);
 128         plugin->info.version.major = major;
 129         plugin->info.version.minor = minor;
 130         plugin->info.version.patch = patch;
 131
 132         if (extra) {
 133                 g_string_assign(plugin->info.version.extra, extra);
 134         }
 135
 136         plugin->info.version_set = true;
 137 }
 138
 139 static inline
 140 void bt_plugin_freeze(struct bt_plugin *plugin)
 141 {
 142         assert(plugin);
 143         plugin->frozen = true;
 144 }
 145
 146 #endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */