doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab

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

diff --git a/src/lib/graph/component-class.c b/src/lib/graph/component-class.c
index 7f31aa3022850ebef7e2aba6ba9a344003c4d6e5..4c37e617a1ac6242cd9365578a55319d0b019731 100644 (file)
--- a/src/lib/graph/component-class.c
+++ b/src/lib/graph/component-class.c
@@ -9,6 +9,7 @@
 #include "lib/logging.h"
 
 #include "common/assert.h"
+#include "common/common.h"
 #include "lib/assert-cond.h"
 #include "compat/compiler.h"
 #include <babeltrace2/graph/component-class.h>
@@ -20,7 +21,8 @@
 #include "lib/graph/message-iterator-class.h"
 
 #define BT_ASSERT_PRE_DEV_COMP_CLS_HOT(_cc)                            \
-       BT_ASSERT_PRE_DEV_HOT(((const struct bt_component_class *) (_cc)), \
+       BT_ASSERT_PRE_DEV_HOT("component-class",                        \
+               ((const struct bt_component_class *) (_cc)), \
                "Component class", ": %!+C", (_cc))
 
 static
@@ -35,15 +37,17 @@ void destroy_component_class(struct bt_object *obj)
        BT_LIB_LOGI("Destroying component class: %!+C", class);
 
        /* Call destroy listeners in reverse registration order */
-       for (i = class->destroy_listeners->len - 1; i >= 0; i--) {
-               struct bt_component_class_destroy_listener *listener =
-                       &g_array_index(class->destroy_listeners,
-                               struct bt_component_class_destroy_listener,
-                               i);
-
-               BT_LOGD("Calling destroy listener: func-addr=%p, data-addr=%p",
-                       listener->func, listener->data);
-               listener->func(class, listener->data);
+       if (class->destroy_listeners) {
+               for (i = class->destroy_listeners->len - 1; i >= 0; i--) {
+                       struct bt_component_class_destroy_listener *listener =
+                               &bt_g_array_index(class->destroy_listeners,
+                                       struct bt_component_class_destroy_listener,
+                                       i);
+
+                       BT_LOGD("Calling destroy listener: func-addr=%p, data-addr=%p",
+                               listener->func, listener->data);
+                       listener->func(class, listener->data);
+               }
        }
 
        if (class->name) {
@@ -153,6 +157,7 @@ end:
        return ret;
 }
 
+BT_EXPORT
 struct bt_component_class_source *bt_component_class_source_create(
                const char *name,
                struct bt_message_iterator_class *message_iterator_class)
@@ -192,6 +197,7 @@ end:
        return (void *) source_class;
 }
 
+BT_EXPORT
 struct bt_component_class_filter *bt_component_class_filter_create(
                const char *name,
                struct bt_message_iterator_class *message_iterator_class)
@@ -231,6 +237,7 @@ end:
        return (void *) filter_class;
 }
 
+BT_EXPORT
 struct bt_component_class_sink *bt_component_class_sink_create(
                const char *name, bt_component_class_sink_consume_method method)
 {
@@ -239,7 +246,7 @@ struct bt_component_class_sink *bt_component_class_sink_create(
 
        BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NAME_NON_NULL(name);
-       BT_ASSERT_PRE_NON_NULL(method, "Consume next method");
+       BT_ASSERT_PRE_NON_NULL("consume-method", method, "Consume next method");
        BT_LOGI("Creating sink component class: "
                "name=\"%s\", consume-method-addr=%p",
                name, method);
@@ -270,6 +277,7 @@ end:
        return (void *) sink_class;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_source_set_get_supported_mip_versions_method(
                struct bt_component_class_source *comp_cls,
@@ -285,6 +293,7 @@ bt_component_class_source_set_get_supported_mip_versions_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_filter_set_get_supported_mip_versions_method(
                struct bt_component_class_filter *comp_cls,
@@ -300,6 +309,7 @@ bt_component_class_filter_set_get_supported_mip_versions_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_sink_set_get_supported_mip_versions_method(
                struct bt_component_class_sink *comp_cls,
@@ -315,6 +325,7 @@ bt_component_class_sink_set_get_supported_mip_versions_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_source_set_initialize_method(
                struct bt_component_class_source *comp_cls,
@@ -330,6 +341,7 @@ bt_component_class_source_set_initialize_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_filter_set_initialize_method(
                struct bt_component_class_filter *comp_cls,
@@ -345,6 +357,7 @@ bt_component_class_filter_set_initialize_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_sink_set_initialize_method(
                struct bt_component_class_sink *comp_cls,
@@ -360,6 +373,7 @@ bt_component_class_sink_set_initialize_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_source_set_finalize_method(
                struct bt_component_class_source *comp_cls,
@@ -375,6 +389,7 @@ bt_component_class_source_set_finalize_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_filter_set_finalize_method(
                struct bt_component_class_filter *comp_cls,
@@ -390,6 +405,7 @@ bt_component_class_filter_set_finalize_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_sink_set_finalize_method(
                struct bt_component_class_sink *comp_cls,
@@ -405,6 +421,7 @@ bt_component_class_sink_set_finalize_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_source_set_query_method(
                struct bt_component_class_source *comp_cls,
@@ -420,6 +437,7 @@ bt_component_class_source_set_query_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_filter_set_query_method(
                struct bt_component_class_filter *comp_cls,
@@ -435,6 +453,7 @@ bt_component_class_filter_set_query_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_sink_set_query_method(
                struct bt_component_class_sink *comp_cls,
@@ -450,6 +469,7 @@ bt_component_class_sink_set_query_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_filter_set_input_port_connected_method(
                struct bt_component_class_filter *comp_cls,
@@ -465,6 +485,7 @@ bt_component_class_filter_set_input_port_connected_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_sink_set_input_port_connected_method(
                struct bt_component_class_sink *comp_cls,
@@ -480,6 +501,7 @@ bt_component_class_sink_set_input_port_connected_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_source_set_output_port_connected_method(
                struct bt_component_class_source *comp_cls,
@@ -495,6 +517,7 @@ bt_component_class_source_set_output_port_connected_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_filter_set_output_port_connected_method(
                struct bt_component_class_filter *comp_cls,
@@ -510,6 +533,7 @@ bt_component_class_filter_set_output_port_connected_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_method_status
 bt_component_class_sink_set_graph_is_configured_method(
                struct bt_component_class_sink *comp_cls,
@@ -525,6 +549,7 @@ bt_component_class_sink_set_graph_is_configured_method(
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_description_status
 bt_component_class_set_description(
                struct bt_component_class *comp_cls,
@@ -539,29 +564,32 @@ bt_component_class_set_description(
                "addr=%p, name=\"%s\", type=%s",
                comp_cls,
                bt_component_class_get_name(comp_cls),
-               bt_component_class_type_string(comp_cls->type));
+               bt_common_component_class_type_string(comp_cls->type));
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 enum bt_component_class_set_help_status bt_component_class_set_help(
                struct bt_component_class *comp_cls,
                const char *help)
 {
        BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls);
-       BT_ASSERT_PRE_NON_NULL(help, "Help");
+       BT_ASSERT_PRE_NON_NULL("help-text", help, "Help text");
        BT_ASSERT_PRE_DEV_COMP_CLS_HOT(comp_cls);
        g_string_assign(comp_cls->help, help);
        BT_LIB_LOGD("Set component class's help text: %!+C", comp_cls);
        return BT_FUNC_STATUS_OK;
 }
 
+BT_EXPORT
 const char *bt_component_class_get_name(const struct bt_component_class *comp_cls)
 {
        BT_ASSERT_PRE_DEV_COMP_CLS_NON_NULL(comp_cls);
        return comp_cls->name->str;
 }
 
+BT_EXPORT
 enum bt_component_class_type bt_component_class_get_type(
                const struct bt_component_class *comp_cls)
 {
@@ -569,6 +597,7 @@ enum bt_component_class_type bt_component_class_get_type(
        return comp_cls->type;
 }
 
+BT_EXPORT
 const char *bt_component_class_get_description(
                const struct bt_component_class *comp_cls)
 {
@@ -578,6 +607,7 @@ const char *bt_component_class_get_description(
                comp_cls->description->str : NULL;
 }
 
+BT_EXPORT
 const char *bt_component_class_get_help(
                const struct bt_component_class *comp_cls)
 {
@@ -586,7 +616,6 @@ const char *bt_component_class_get_help(
                comp_cls->help->str[0] != '\0' ? comp_cls->help->str : NULL;
 }
 
-BT_HIDDEN
 void bt_component_class_add_destroy_listener(
                struct bt_component_class *comp_cls,
                bt_component_class_destroy_listener_func func, void *data)
@@ -602,7 +631,6 @@ void bt_component_class_add_destroy_listener(
                "%![cc-]+C, listener-func-addr=%p", comp_cls, func);
 }
 
-BT_HIDDEN
 void _bt_component_class_freeze(const struct bt_component_class *comp_cls)
 {
        BT_ASSERT(comp_cls);
@@ -610,48 +638,56 @@ void _bt_component_class_freeze(const struct bt_component_class *comp_cls)
        ((struct bt_component_class *) comp_cls)->frozen = true;
 }
 
+BT_EXPORT
 void bt_component_class_get_ref(
                const struct bt_component_class *component_class)
 {
        bt_object_get_ref(component_class);
 }
 
+BT_EXPORT
 void bt_component_class_put_ref(
                const struct bt_component_class *component_class)
 {
        bt_object_put_ref(component_class);
 }
 
+BT_EXPORT
 void bt_component_class_source_get_ref(
                const struct bt_component_class_source *component_class_source)
 {
        bt_object_get_ref(component_class_source);
 }
 
+BT_EXPORT
 void bt_component_class_source_put_ref(
                const struct bt_component_class_source *component_class_source)
 {
        bt_object_put_ref(component_class_source);
 }
 
+BT_EXPORT
 void bt_component_class_filter_get_ref(
                const struct bt_component_class_filter *component_class_filter)
 {
        bt_object_get_ref(component_class_filter);
 }
 
+BT_EXPORT
 void bt_component_class_filter_put_ref(
                const struct bt_component_class_filter *component_class_filter)
 {
        bt_object_put_ref(component_class_filter);
 }
 
+BT_EXPORT
 void bt_component_class_sink_get_ref(
                const struct bt_component_class_sink *component_class_sink)
 {
        bt_object_get_ref(component_class_sink);
 }
 
+BT_EXPORT
 void bt_component_class_sink_put_ref(
                const struct bt_component_class_sink *component_class_sink)
 {