Rename <babeltrace/component/...> -> <babeltrace/graph/...>

[babeltrace.git] / lib / component / component-class.c

diff --git a/lib/component/component-class.c b/lib/component/component-class.c
index 1f6e680aa7efb01d2115764f6c8befffa52e3320..bdaa2d37d3435f53081d8371593fbff83ce96d08 100644 (file)
--- a/lib/component/component-class.c
+++ b/lib/component/component-class.c
@@ -27,7 +27,7 @@
  */
 
 #include <babeltrace/compiler.h>
-#include <babeltrace/component/component-class-internal.h>
+#include <babeltrace/graph/component-class-internal.h>
 #include <babeltrace/ref.h>
 #include <stdbool.h>
 #include <glib.h>
@@ -57,6 +57,9 @@ void bt_component_class_destroy(struct bt_object *obj)
        if (class->description) {
                g_string_free(class->description, TRUE);
        }
+       if (class->help) {
+               g_string_free(class->help, TRUE);
+       }
        if (class->destroy_listeners) {
                g_array_free(class->destroy_listeners, TRUE);
        }
@@ -82,6 +85,11 @@ int bt_component_class_init(struct bt_component_class *class,
                goto error;
        }
 
+       class->help = g_string_new(NULL);
+       if (!class->help) {
+               goto error;
+       }
+
        class->destroy_listeners = g_array_new(FALSE, TRUE,
                sizeof(struct bt_component_class_destroy_listener));
        if (!class->destroy_listeners) {
@@ -99,14 +107,12 @@ end:
 }
 
 struct bt_component_class *bt_component_class_source_create(const char *name,
-               bt_component_class_notification_iterator_get_method notification_iterator_get_method,
                bt_component_class_notification_iterator_next_method notification_iterator_next_method)
 {
        struct bt_component_class_source *source_class = NULL;
        int ret;
 
-       if (!name || !notification_iterator_get_method ||
-                       !notification_iterator_next_method) {
+       if (!name || !notification_iterator_next_method) {
                goto end;
        }
 
@@ -127,7 +133,6 @@ struct bt_component_class *bt_component_class_source_create(const char *name,
                goto end;
        }
 
-       source_class->methods.iterator.get = notification_iterator_get_method;
        source_class->methods.iterator.next = notification_iterator_next_method;
 
 end:
@@ -135,14 +140,12 @@ end:
 }
 
 struct bt_component_class *bt_component_class_filter_create(const char *name,
-               bt_component_class_notification_iterator_get_method notification_iterator_get_method,
                bt_component_class_notification_iterator_next_method notification_iterator_next_method)
 {
        struct bt_component_class_filter *filter_class = NULL;
        int ret;
 
-       if (!name || !notification_iterator_get_method ||
-                       !notification_iterator_next_method) {
+       if (!name || !notification_iterator_next_method) {
                goto end;
        }
 
@@ -163,7 +166,6 @@ struct bt_component_class *bt_component_class_filter_create(const char *name,
                goto end;
        }
 
-       filter_class->methods.iterator.get = notification_iterator_get_method;
        filter_class->methods.iterator.next = notification_iterator_next_method;
 
 end:
@@ -220,18 +222,69 @@ end:
        return ret;
 }
 
-int bt_component_class_set_destroy_method(
+int bt_component_class_set_query_method(
                struct bt_component_class *component_class,
-               bt_component_class_destroy_method destroy_method)
+               bt_component_class_query_method query_method)
 {
        int ret = 0;
 
-       if (!component_class || component_class->frozen || !destroy_method) {
+       if (!component_class || component_class->frozen || !query_method) {
                ret = -1;
                goto end;
        }
 
-       component_class->methods.destroy = destroy_method;
+       component_class->methods.query = query_method;
+
+end:
+       return ret;
+}
+
+int bt_component_class_set_accept_port_connection_method(
+               struct bt_component_class *component_class,
+               bt_component_class_accept_port_connection_method method)
+{
+       int ret = 0;
+
+       if (!component_class || component_class->frozen || !method) {
+               ret = -1;
+               goto end;
+       }
+
+       component_class->methods.accept_port_connection = method;
+
+end:
+       return ret;
+}
+
+int bt_component_class_set_port_disconnected_method(
+               struct bt_component_class *component_class,
+               bt_component_class_port_disconnected_method method)
+{
+       int ret = 0;
+
+       if (!component_class || component_class->frozen || !method) {
+               ret = -1;
+               goto end;
+       }
+
+       component_class->methods.port_disconnected = method;
+
+end:
+       return ret;
+}
+
+int bt_component_class_set_finalize_method(
+               struct bt_component_class *component_class,
+               bt_component_class_finalize_method finalize_method)
+{
+       int ret = 0;
+
+       if (!component_class || component_class->frozen || !finalize_method) {
+               ret = -1;
+               goto end;
+       }
+
+       component_class->methods.finalize = finalize_method;
 
 end:
        return ret;
@@ -259,15 +312,15 @@ end:
        return ret;
 }
 
-int bt_component_class_source_set_notification_iterator_destroy_method(
+int bt_component_class_source_set_notification_iterator_finalize_method(
                struct bt_component_class *component_class,
-               bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
+               bt_component_class_notification_iterator_finalize_method notification_iterator_finalize_method)
 {
        struct bt_component_class_source *source_class;
        int ret = 0;
 
        if (!component_class || component_class->frozen ||
-                       !notification_iterator_destroy_method ||
+                       !notification_iterator_finalize_method ||
                        component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
                ret = -1;
                goto end;
@@ -275,8 +328,8 @@ int bt_component_class_source_set_notification_iterator_destroy_method(
 
        source_class = container_of(component_class,
                struct bt_component_class_source, parent);
-       source_class->methods.iterator.destroy =
-               notification_iterator_destroy_method;
+       source_class->methods.iterator.finalize =
+               notification_iterator_finalize_method;
 
 end:
        return ret;
@@ -327,15 +380,15 @@ end:
        return ret;
 }
 
-int bt_component_class_filter_set_notification_iterator_destroy_method(
+int bt_component_class_filter_set_notification_iterator_finalize_method(
                struct bt_component_class *component_class,
-               bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
+               bt_component_class_notification_iterator_finalize_method notification_iterator_finalize_method)
 {
        struct bt_component_class_filter *filter_class;
        int ret = 0;
 
        if (!component_class || component_class->frozen ||
-                       !notification_iterator_destroy_method ||
+                       !notification_iterator_finalize_method ||
                        component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
                ret = -1;
                goto end;
@@ -343,8 +396,8 @@ int bt_component_class_filter_set_notification_iterator_destroy_method(
 
        filter_class = container_of(component_class,
                struct bt_component_class_filter, parent);
-       filter_class->methods.iterator.destroy =
-               notification_iterator_destroy_method;
+       filter_class->methods.iterator.finalize =
+               notification_iterator_finalize_method;
 
 end:
        return ret;
@@ -390,6 +443,23 @@ end:
        return ret;
 }
 
+int bt_component_class_set_help(
+               struct bt_component_class *component_class,
+               const char *help)
+{
+       int ret = 0;
+
+       if (!component_class || component_class->frozen || !help) {
+               ret = -1;
+               goto end;
+       }
+
+       g_string_assign(component_class->help, help);
+
+end:
+       return ret;
+}
+
 const char *bt_component_class_get_name(
                struct bt_component_class *component_class)
 {
@@ -406,10 +476,19 @@ enum bt_component_class_type bt_component_class_get_type(
 const char *bt_component_class_get_description(
                struct bt_component_class *component_class)
 {
-       return component_class && component_class->description ?
+       return component_class && component_class->description &&
+               component_class->description->str[0] != '\0' ?
                component_class->description->str : NULL;
 }
 
+const char *bt_component_class_get_help(
+               struct bt_component_class *component_class)
+{
+       return component_class && component_class->help &&
+               component_class->help->str[0] != '\0' ?
+               component_class->help->str : NULL;
+}
+
 BT_HIDDEN
 int bt_component_class_add_destroy_listener(struct bt_component_class *class,
                bt_component_class_destroy_listener_func func, void *data)
@@ -430,63 +509,36 @@ end:
        return ret;
 }
 
-extern int bt_component_class_sink_set_add_iterator_method(
-               struct bt_component_class *component_class,
-               bt_component_class_sink_add_iterator_method add_iterator_method)
+int bt_component_class_freeze(
+               struct bt_component_class *component_class)
 {
-       struct bt_component_class_sink *sink_class;
        int ret = 0;
 
-       if (!component_class || component_class->frozen ||
-                       !add_iterator_method ||
-                       component_class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
+       if (!component_class) {
                ret = -1;
                goto end;
        }
 
-       sink_class = container_of(component_class,
-               struct bt_component_class_sink, parent);
-       sink_class->methods.add_iterator = add_iterator_method;
+       component_class->frozen = true;
 
 end:
        return ret;
 }
 
-extern int bt_component_class_filter_set_add_iterator_method(
+struct bt_value *bt_component_class_query(
                struct bt_component_class *component_class,
-               bt_component_class_filter_add_iterator_method add_iterator_method)
-{
-       struct bt_component_class_filter *filter_class;
-       int ret = 0;
-
-       if (!component_class || component_class->frozen ||
-                       !add_iterator_method ||
-                       component_class->type !=
-                       BT_COMPONENT_CLASS_TYPE_FILTER) {
-               ret = -1;
-               goto end;
-       }
-
-       filter_class = container_of(component_class,
-               struct bt_component_class_filter, parent);
-       filter_class->methods.add_iterator = add_iterator_method;
-
-end:
-       return ret;
-}
-
-int bt_component_class_freeze(
-               struct bt_component_class *component_class)
+               const char *object, struct bt_value *params)
 {
-       int ret = 0;
+       struct bt_value *results = NULL;
 
-       if (!component_class) {
-               ret = -1;
+       if (!component_class || !object || !params ||
+                       !component_class->methods.query) {
                goto end;
        }
 
-       component_class->frozen = true;
+       results = component_class->methods.query(component_class,
+               object, params);
 
 end:
-       return ret;
+       return results;
 }