lib/component/component-class.c

   1 /*
   2  * component-class.c
   3  *
   4  * Babeltrace Plugin Component Class
   5  *
   6  * Copyright 2016 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/component/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         int i;
  39
  40         assert(obj);
  41         class = container_of(obj, struct bt_component_class, base);
  42
  43         /* Call destroy listeners in reverse registration order */
  44         for (i = class->destroy_listeners->len - 1; i >= 0; i--) {
  45                 struct bt_component_class_destroyer_listener *listener =
  46                         &g_array_index(class->destroy_listeners,
  47                                 struct bt_component_class_destroyer_listener,
  48                                 i);
  49
  50                 listener->func(class, listener->data);
  51         }
  52
  53         if (class->name) {
  54                 g_string_free(class->name, TRUE);
  55         }
  56         if (class->description) {
  57                 g_string_free(class->description, TRUE);
  58         }
  59         if (class->destroy_listeners) {
  60                 g_array_free(class->destroy_listeners, TRUE);
  61         }
  62
  63         g_free(class);
  64 }
  65
  66 struct bt_component_class *bt_component_class_create(
  67                 enum bt_component_type type, const char *name,
  68                 const char *description, bt_component_init_cb init)
  69 {
  70         struct bt_component_class *class = NULL;
  71
  72         if (!name) {
  73                 goto end;
  74         }
  75
  76         class = g_new0(struct bt_component_class, 1);
  77         if (!class) {
  78                 goto end;
  79         }
  80
  81         bt_object_init(class, bt_component_class_destroy);
  82         class->type = type;
  83         class->init = init;
  84         class->name = g_string_new(name);
  85         if (!class->name) {
  86                 BT_PUT(class);
  87                 goto end;
  88         }
  89
  90         if (description) {
  91                 class->description = g_string_new(description);
  92                 if (!class->description) {
  93                         BT_PUT(class);
  94                         goto end;
  95                 }
  96         }
  97
  98         class->destroy_listeners = g_array_new(FALSE, TRUE,
  99                 sizeof(struct bt_component_class_destroyer_listener));
 100         if (!class->destroy_listeners) {
 101                 BT_PUT(class);
 102                 goto end;
 103         }
 104 end:
 105         return class;
 106 }
 107
 108 const char *bt_component_class_get_name(
 109                 struct bt_component_class *component_class)
 110 {
 111         return component_class ? component_class->name->str : NULL;
 112 }
 113
 114 enum bt_component_type bt_component_class_get_type(
 115                 struct bt_component_class *component_class)
 116 {
 117         return component_class ? component_class->type :
 118                         BT_COMPONENT_TYPE_UNKNOWN;
 119 }
 120
 121 const char *bt_component_class_get_description(
 122                 struct bt_component_class *component_class)
 123 {
 124         return component_class && component_class->description ?
 125                 component_class->description->str : NULL;
 126 }
 127
 128 BT_HIDDEN
 129 int bt_component_class_add_destroy_listener(struct bt_component_class *class,
 130                 bt_component_class_destroy_listener_func func, void *data)
 131 {
 132         int ret = 0;
 133         struct bt_component_class_destroyer_listener listener;
 134
 135         if (!class || !func) {
 136                 ret = -1;
 137                 goto end;
 138         }
 139
 140         listener.func = func;
 141         listener.data = data;
 142         g_array_append_val(class->destroy_listeners, listener);
 143
 144 end:
 145         return ret;
 146 }