lib: strictly type function return status enumerations

[babeltrace.git] / src / lib / graph / graph.h

diff --git a/src/lib/graph/graph.h b/src/lib/graph/graph.h
index 71328fae1d42405749ffb8b6a5f9bffe4ccf8ca5..30d59fb9d7e40eac63634884d7f8a7df8f21b956 100644 (file)
--- a/src/lib/graph/graph.h
+++ b/src/lib/graph/graph.h
@@ -30,12 +30,29 @@
 #include "lib/object.h"
 #include "lib/object-pool.h"
 #include "common/assert.h"
+#include "common/common.h"
 #include <stdlib.h>
 #include <glib.h>
 
 #include "component.h"
 #include "component-sink.h"
 #include "connection.h"
+#include "lib/func-status.h"
+
+/* Protection: this file uses BT_LIB_LOG*() macros directly */
+#ifndef BT_LIB_LOG_SUPPORTED
+# error Please include "lib/logging.h" before including this file.
+#endif
+
+/* Protection: this file uses BT_ASSERT_PRE*() macros directly */
+#ifndef BT_ASSERT_PRE_SUPPORTED
+# error Please include "lib/assert-pre.h" before including this file.
+#endif
+
+/* Protection: this file uses BT_ASSERT_POST*() macros directly */
+#ifndef BT_ASSERT_POST_SUPPORTED
+# error Please include "lib/assert-post.h" before including this file.
+#endif
 
 struct bt_component;
 struct bt_port;
@@ -74,7 +91,7 @@ struct bt_graph {
        /*
         * If this is false, then the public API's consuming
         * functions (bt_graph_consume() and bt_graph_run()) return
-        * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check"
+        * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
         * functions always work.
         *
         * In bt_port_output_message_iterator_create(), on success,
@@ -136,15 +153,15 @@ void _bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
 #endif
 
 BT_HIDDEN
-enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph,
+int bt_graph_consume_sink_no_check(struct bt_graph *graph,
                struct bt_component_sink *sink);
 
 BT_HIDDEN
-enum bt_graph_listener_status bt_graph_notify_port_added(struct bt_graph *graph,
+enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph,
                struct bt_port *port);
 
 BT_HIDDEN
-enum bt_graph_listener_status bt_graph_notify_ports_connected(
+enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
                struct bt_graph *graph, struct bt_port *upstream_port,
                struct bt_port *downstream_port);
 
@@ -168,29 +185,6 @@ BT_HIDDEN
 void bt_graph_add_message(struct bt_graph *graph,
                struct bt_message *msg);
 
-static inline
-const char *bt_graph_status_string(enum bt_graph_status status)
-{
-       switch (status) {
-       case BT_GRAPH_STATUS_CANCELED:
-               return "BT_GRAPH_STATUS_CANCELED";
-       case BT_GRAPH_STATUS_AGAIN:
-               return "BT_GRAPH_STATUS_AGAIN";
-       case BT_GRAPH_STATUS_END:
-               return "BT_GRAPH_STATUS_END";
-       case BT_GRAPH_STATUS_OK:
-               return "BT_GRAPH_STATUS_OK";
-       case BT_GRAPH_STATUS_ERROR:
-               return "BT_GRAPH_STATUS_ERROR";
-       case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
-               return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
-       case BT_GRAPH_STATUS_NOMEM:
-               return "BT_GRAPH_STATUS_NOMEM";
-       default:
-               return "(unknown)";
-       }
-}
-
 static inline
 const char *bt_graph_configuration_state_string(
                enum bt_graph_configuration_state state)
@@ -208,9 +202,9 @@ const char *bt_graph_configuration_state_string(
 }
 
 static inline
-enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
+int bt_graph_configure(struct bt_graph *graph)
 {
-       enum bt_graph_status status = BT_GRAPH_STATUS_OK;
+       int status = BT_FUNC_STATUS_OK;
        uint64_t i;
 
        BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
@@ -220,10 +214,7 @@ enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
                goto end;
        }
 
-#ifdef BT_ASSERT_PRE
        BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
-#endif
-
        graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
 
        for (i = 0; i < graph->components->len; i++) {
@@ -241,40 +232,27 @@ enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
                }
 
                if (comp_cls_sink->methods.graph_is_configured) {
-                       enum bt_self_component_status comp_status;
+                       enum bt_component_class_sink_graph_is_configured_method_status comp_status;
 
-#ifdef BT_LIB_LOGD
                        BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
                                "%![graph-]+g, %![comp-]+c",
                                graph, comp);
-#endif
-
                        comp_status = comp_cls_sink->methods.graph_is_configured(
                                (void *) comp_sink);
-
-#ifdef BT_LIB_LOGD
                        BT_LIB_LOGD("User method returned: status=%s",
-                               bt_self_component_status_string(comp_status));
-#endif
-
-#ifdef BT_ASSERT_PRE
-                       BT_ASSERT_PRE(comp_status == BT_SELF_COMPONENT_STATUS_OK ||
-                               comp_status == BT_SELF_COMPONENT_STATUS_ERROR ||
-                               comp_status == BT_SELF_COMPONENT_STATUS_NOMEM,
+                               bt_common_func_status_string(comp_status));
+                       BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK ||
+                               comp_status == BT_FUNC_STATUS_ERROR ||
+                               comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
                                "Unexpected returned status: status=%s",
-                               bt_self_component_status_string(comp_status));
-#endif
+                               bt_common_func_status_string(comp_status));
 
-                       if (comp_status != BT_SELF_COMPONENT_STATUS_OK) {
-                               status = BT_GRAPH_STATUS_ERROR;
-#ifdef BT_LIB_LOGW
+                       if (comp_status != BT_FUNC_STATUS_OK) {
+                               status = BT_FUNC_STATUS_ERROR;
                                BT_LIB_LOGW("User's \"graph is configured\" method failed: "
                                        "%![comp-]+c, status=%s",
-                                       comp,
-                                       bt_self_component_status_string(
+                                       comp, bt_common_func_status_string(
                                                comp_status));
-#endif
-
                                goto end;
                        }
                }
@@ -292,9 +270,7 @@ static inline
 void bt_graph_make_faulty(struct bt_graph *graph)
 {
        graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
-#ifdef BT_LIB_LOGD
-       BT_LIB_LOGD("Set graph's state to faulty: %![graph-]+g", graph);
-#endif
+       BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
 }
 
 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */