plugins/component-class.c

   1 /*
   2  * component-class.c
   3  *
   4  * Babeltrace Plugin Component Class
   5  *
   6  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/compiler.h>
  30 #include <babeltrace/plugin/component-class-internal.h>
  31 #include <babeltrace/ref.h>
  32 #include <glib.h>
  33
  34 static
  35 void bt_component_class_destroy(struct bt_object *obj)
  36 {
  37         struct bt_component_class *class;
  38
  39         assert(obj);
  40         class = container_of(obj, struct bt_component_class, base);
  41         if (class->name) {
  42                 g_string_free(class->name, TRUE);
  43         }
  44         if (class->description) {
  45                 g_string_free(class->description, TRUE);
  46         }
  47
  48         bt_put(class->plugin);
  49         g_free(class);
  50 }
  51
  52 BT_HIDDEN
  53 struct bt_component_class *bt_component_class_create(
  54                 enum bt_component_type type, const char *name,
  55                 const char *description, struct bt_plugin *plugin)
  56 {
  57         struct bt_component_class *class;
  58
  59         class = g_new0(struct bt_component_class, 1);
  60         if (!class) {
  61                 goto end;
  62         }
  63
  64         bt_object_init(class, bt_component_class_destroy);
  65         class->type = type;
  66         class->name = g_string_new(name);
  67         class->description = g_string_new(description);
  68         if (!class->name || !class->description) {
  69                 BT_PUT(class);
  70                 goto end;
  71         }
  72
  73         class->plugin = bt_get(plugin);
  74 end:
  75         return class;
  76 }
  77
  78 const char *bt_component_class_get_name(
  79                 struct bt_component_class *component_class)
  80 {
  81         return component_class ? component_class->name->str : NULL;
  82 }
  83
  84 enum bt_component_type bt_component_class_get_type(
  85                 struct bt_component_class *component_class)
  86 {
  87         return component_class ? component_class->type :
  88                         BT_COMPONENT_TYPE_UNKNOWN;
  89 }
  90
  91 struct bt_plugin *bt_component_class_get_plugin(
  92                 struct bt_component_class *component_class)
  93 {
  94         return component_class ? bt_get(component_class->plugin) :
  95                         NULL;
  96 }
  97
  98 const char *bt_component_class_get_description(
  99                 struct bt_component_class *component_class)
 100 {
 101         return component_class ? component_class->description->str : NULL;
 102 }
 103