Stream class API: use status

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/include/babeltrace/trace-ir/stream-class-const.h b/include/babeltrace/trace-ir/stream-class-const.h
index 476a40eb0e3c49829af361eddee0c337a08c484f..dee6fbde478319c502b49e846cf98f95843dea1a 100644 (file)
--- a/include/babeltrace/trace-ir/stream-class-const.h
+++ b/include/babeltrace/trace-ir/stream-class-const.h
@@ -39,6 +39,11 @@
 extern "C" {
 #endif
 
+enum bt_stream_class_status {
+       BT_STREAM_CLASS_STATUS_OK = 0,
+       BT_STREAM_CLASS_STATUS_NOMEM = -12,
+};
+
 extern const bt_trace_class *bt_stream_class_borrow_trace_class_const(
                const bt_stream_class *stream_class);
 

diff --git a/include/babeltrace/trace-ir/stream-class.h b/include/babeltrace/trace-ir/stream-class.h
index 074d4584e5d9f7fe9d0e480f2495afcd637a147d..c8a8c98bfba15a829db765dbf94c9ca64253cc95 100644 (file)
--- a/include/babeltrace/trace-ir/stream-class.h
+++ b/include/babeltrace/trace-ir/stream-class.h
@@ -35,6 +35,9 @@
  */
 #include <babeltrace/types.h>
 
+/* For enum bt_stream_class_status */
+#include <babeltrace/trace-ir/stream-class-const.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -48,8 +51,8 @@ extern bt_stream_class *bt_stream_class_create_with_id(
 extern bt_trace_class *bt_stream_class_borrow_trace_class(
                bt_stream_class *stream_class);
 
-extern int bt_stream_class_set_name(bt_stream_class *stream_class,
-               const char *name);
+extern enum bt_stream_class_status bt_stream_class_set_name(
+               bt_stream_class *stream_class, const char *name);
 
 extern void bt_stream_class_set_assigns_automatic_event_class_id(
                bt_stream_class *stream_class, bt_bool value);
@@ -57,15 +60,17 @@ extern void bt_stream_class_set_assigns_automatic_event_class_id(
 extern void bt_stream_class_set_assigns_automatic_stream_id(
                bt_stream_class *stream_class, bt_bool value);
 
-extern int bt_stream_class_set_packet_context_field_class(
+extern enum bt_stream_class_status
+bt_stream_class_set_packet_context_field_class(
                bt_stream_class *stream_class,
                bt_field_class *field_class);
 
-extern int bt_stream_class_set_event_header_field_class(
+extern enum bt_stream_class_status
+bt_stream_class_set_event_header_field_class(
                bt_stream_class *stream_class,
                bt_field_class *field_class);
 
-extern int
+extern enum bt_stream_class_status
 bt_stream_class_set_event_common_context_field_class(
                bt_stream_class *stream_class,
                bt_field_class *field_class);
@@ -81,7 +86,7 @@ bt_stream_class_borrow_event_class_by_id(
 extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
                bt_stream_class *stream_class);
 
-extern int bt_stream_class_set_default_clock_class(
+extern enum bt_stream_class_status bt_stream_class_set_default_clock_class(
                bt_stream_class *stream_class,
                bt_clock_class *clock_class);
 

diff --git a/lib/trace-ir/stream-class.c b/lib/trace-ir/stream-class.c
index f8dd5999ee9a059c8659fd151eaeab2dfcc1f10a..5fe060c278b80554297a3a97098be47236f46d20 100644 (file)
--- a/lib/trace-ir/stream-class.c
+++ b/lib/trace-ir/stream-class.c
@@ -217,7 +217,7 @@ const char *bt_stream_class_get_name(const struct bt_stream_class *stream_class)
        return stream_class->name.value;
 }
 
-int bt_stream_class_set_name(
+enum bt_stream_class_status bt_stream_class_set_name(
                struct bt_stream_class *stream_class,
                const char *name)
 {
@@ -227,7 +227,7 @@ int bt_stream_class_set_name(
        g_string_assign(stream_class->name.str, name);
        stream_class->name.value = stream_class->name.str->str;
        BT_LIB_LOGV("Set stream class's name: %!+S", stream_class);
-       return 0;
+       return BT_STREAM_CLASS_STATUS_OK;
 }
 
 uint64_t bt_stream_class_get_id(const struct bt_stream_class *stream_class)
@@ -297,7 +297,7 @@ bt_stream_class_borrow_packet_context_field_class_const(
        return stream_class->packet_context_fc;
 }
 
-int bt_stream_class_set_packet_context_field_class(
+enum bt_stream_class_status bt_stream_class_set_packet_context_field_class(
                struct bt_stream_class *stream_class,
                struct bt_field_class *field_class)
 {
@@ -322,6 +322,12 @@ int bt_stream_class_set_packet_context_field_class(
                bt_stream_class_borrow_trace_class_inline(stream_class)->packet_header_fc;
        ret = bt_resolve_field_paths(field_class, &resolve_ctx);
        if (ret) {
+               /*
+                * This is the only reason for which
+                * bt_resolve_field_paths() can fail: anything else
+                * would be because a precondition is not satisfied.
+                */
+               ret = BT_STREAM_CLASS_STATUS_NOMEM;
                goto end;
        }
 
@@ -344,7 +350,7 @@ const struct bt_field_class *bt_stream_class_borrow_event_header_field_class_con
        return stream_class->event_header_fc;
 }
 
-int bt_stream_class_set_event_header_field_class(
+enum bt_stream_class_status bt_stream_class_set_event_header_field_class(
                struct bt_stream_class *stream_class,
                struct bt_field_class *field_class)
 {
@@ -370,6 +376,12 @@ int bt_stream_class_set_event_header_field_class(
        resolve_ctx.packet_context = stream_class->packet_context_fc;
        ret = bt_resolve_field_paths(field_class, &resolve_ctx);
        if (ret) {
+               /*
+                * This is the only reason for which
+                * bt_resolve_field_paths() can fail: anything else
+                * would be because a precondition is not satisfied.
+                */
+               ret = BT_STREAM_CLASS_STATUS_NOMEM;
                goto end;
        }
 
@@ -393,7 +405,8 @@ bt_stream_class_borrow_event_common_context_field_class_const(
        return stream_class->event_common_context_fc;
 }
 
-int bt_stream_class_set_event_common_context_field_class(
+enum bt_stream_class_status
+bt_stream_class_set_event_common_context_field_class(
                struct bt_stream_class *stream_class,
                struct bt_field_class *field_class)
 {
@@ -420,6 +433,12 @@ int bt_stream_class_set_event_common_context_field_class(
        resolve_ctx.event_header = stream_class->event_header_fc;
        ret = bt_resolve_field_paths(field_class, &resolve_ctx);
        if (ret) {
+               /*
+                * This is the only reason for which
+                * bt_resolve_field_paths() can fail: anything else
+                * would be because a precondition is not satisfied.
+                */
+               ret = BT_STREAM_CLASS_STATUS_NOMEM;
                goto end;
        }
 
@@ -444,7 +463,7 @@ void _bt_stream_class_freeze(const struct bt_stream_class *stream_class)
        ((struct bt_stream_class *) stream_class)->frozen = true;
 }
 
-int bt_stream_class_set_default_clock_class(
+enum bt_stream_class_status bt_stream_class_set_default_clock_class(
                struct bt_stream_class *stream_class,
                struct bt_clock_class *clock_class)
 {
@@ -457,7 +476,7 @@ int bt_stream_class_set_default_clock_class(
        bt_clock_class_freeze(clock_class);
        BT_LIB_LOGV("Set stream class's default clock class: %!+S",
                stream_class);
-       return 0;
+       return BT_STREAM_CLASS_STATUS_OK;
 }
 
 struct bt_clock_class *bt_stream_class_borrow_default_clock_class(