"destroy" method -> "finalize" method
[babeltrace.git] / plugins / text / text.c
index 4ddca35cfa1310f828e5dd4c9887475a351554f3..a270fd4820ad046c62e2529a8a452ca457a7b3bf 100644 (file)
 
 #include <babeltrace/plugin/plugin-dev.h>
 #include <babeltrace/component/component.h>
-#include <babeltrace/component/sink.h>
+#include <babeltrace/component/private-component.h>
+#include <babeltrace/component/component-sink.h>
+#include <babeltrace/component/port.h>
+#include <babeltrace/component/private-port.h>
+#include <babeltrace/component/connection.h>
+#include <babeltrace/component/private-connection.h>
 #include <babeltrace/component/notification/notification.h>
 #include <babeltrace/component/notification/iterator.h>
 #include <babeltrace/component/notification/event.h>
 #include <babeltrace/values.h>
 #include <babeltrace/compiler.h>
+#include <babeltrace/common-internal.h>
+#include <plugins-common.h>
 #include <stdio.h>
 #include <stdbool.h>
 #include <glib.h>
 #include "text.h"
+#include <assert.h>
 
 static
 const char *plugin_options[] = {
+       "color",
        "output-path",
        "debug-info-dir",
        "debug-info-target-prefix",
@@ -51,6 +60,7 @@ const char *plugin_options[] = {
        "clock-seconds",
        "clock-date",
        "clock-gmt",
+       "verbose",
        "name-default",         /* show/hide */
        "name-payload",
        "name-context",
@@ -69,6 +79,7 @@ const char *plugin_options[] = {
 static
 void destroy_text_data(struct text_component *text)
 {
+       bt_put(text->input_iterator);
        (void) g_string_free(text->string, TRUE);
        g_free(text->options.output_path);
        g_free(text->options.debug_info_dir);
@@ -98,9 +109,9 @@ error:
 }
 
 static
-void destroy_text(struct bt_component *component)
+void finalize_text(struct bt_private_component *component)
 {
-       void *data = bt_component_get_private_data(component);
+       void *data = bt_private_component_get_user_data(component);
 
        destroy_text_data(data);
 }
@@ -150,17 +161,41 @@ end:
 }
 
 static
-enum bt_component_status run(struct bt_component *component)
+enum bt_component_status text_accept_port_connection(
+               struct bt_private_component *component,
+               struct bt_private_port *self_port,
+               struct bt_port *other_port)
+{
+       enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
+       struct bt_private_connection *connection;
+       struct text_component *text;
+
+       text = bt_private_component_get_user_data(component);
+       assert(text);
+       assert(!text->input_iterator);
+       connection = bt_private_port_get_private_connection(self_port);
+       assert(connection);
+       text->input_iterator =
+               bt_private_connection_create_notification_iterator(connection);
+
+       if (!text->input_iterator) {
+               ret = BT_COMPONENT_STATUS_ERROR;
+       }
+
+       bt_put(connection);
+       return ret;
+}
+
+static
+enum bt_component_status run(struct bt_private_component *component)
 {
        enum bt_component_status ret;
        struct bt_notification *notification = NULL;
        struct bt_notification_iterator *it;
-       struct text_component *text = bt_component_get_private_data(component);
+       struct text_component *text =
+               bt_private_component_get_user_data(component);
 
-       ret = bt_component_sink_get_input_iterator(component, 0, &it);
-       if (ret != BT_COMPONENT_STATUS_OK) {
-               goto end;
-       }
+       it = text->input_iterator;
 
        if (likely(text->processed_first_event)) {
                enum bt_notification_iterator_status it_ret;
@@ -172,6 +207,7 @@ enum bt_component_status run(struct bt_component *component)
                        goto end;
                case BT_NOTIFICATION_ITERATOR_STATUS_END:
                        ret = BT_COMPONENT_STATUS_END;
+                       BT_PUT(text->input_iterator);
                        goto end;
                default:
                        break;
@@ -186,7 +222,6 @@ enum bt_component_status run(struct bt_component *component)
        ret = handle_notification(text, notification);
        text->processed_first_event = true;
 end:
-       bt_put(it);
        bt_put(notification);
        return ret;
 }
@@ -288,6 +323,13 @@ end:
        return ret;
 }
 
+static
+void warn_wrong_color_param(struct text_component *text)
+{
+       fprintf(text->err,
+               "[warning] Accepted values for the \"color\" parameter are:\n    \"always\", \"auto\", \"never\"\n");
+}
+
 static
 enum bt_component_status apply_params(struct text_component *text,
                struct bt_value *params)
@@ -316,6 +358,34 @@ enum bt_component_status apply_params(struct text_component *text,
                goto end;
        }
        /* Known parameters. */
+       text->options.color = TEXT_COLOR_OPT_AUTO;
+       if (bt_value_map_has_key(params, "color")) {
+               struct bt_value *color_value;
+               const char *color;
+
+               color_value = bt_value_map_get(params, "color");
+               if (!color_value) {
+                       goto end;
+               }
+
+               status = bt_value_string_get(color_value, &color);
+               if (status) {
+                       warn_wrong_color_param(text);
+               } else {
+                       if (strcmp(color, "never") == 0) {
+                               text->options.color = TEXT_COLOR_OPT_NEVER;
+                       } else if (strcmp(color, "auto") == 0) {
+                               text->options.color = TEXT_COLOR_OPT_AUTO;
+                       } else if (strcmp(color, "always") == 0) {
+                               text->options.color = TEXT_COLOR_OPT_ALWAYS;
+                       } else {
+                               warn_wrong_color_param(text);
+                       }
+               }
+
+               bt_put(color_value);
+       }
+
        ret = apply_one_string("output-path",
                        params,
                        &text->options.output_path);
@@ -379,6 +449,13 @@ enum bt_component_status apply_params(struct text_component *text,
        }
        text->options.clock_gmt = value;
 
+       value = false;          /* Default. */
+       ret = apply_one_bool("verbose", params, &value, NULL);
+       if (ret != BT_COMPONENT_STATUS_OK) {
+               goto end;
+       }
+       text->options.verbose = value;
+
        /* Names. */
        ret = apply_one_string("name-default", params, &str);
        if (ret != BT_COMPONENT_STATUS_OK) {
@@ -602,9 +679,47 @@ end:
        return ret;
 }
 
+static
+void set_use_colors(struct text_component *text)
+{
+       switch (text->options.color) {
+       case TEXT_COLOR_OPT_ALWAYS:
+               text->use_colors = true;
+               break;
+       case TEXT_COLOR_OPT_AUTO:
+               text->use_colors = text->out == stdout &&
+                       bt_common_colors_supported();
+               break;
+       case TEXT_COLOR_OPT_NEVER:
+               text->use_colors = false;
+               break;
+       }
+}
+
+static
+void init_stream_packet_context_quarks(void)
+{
+       stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] =
+               g_quark_from_string("timestamp_begin");
+       stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] =
+               g_quark_from_string("timestamp_begin");
+       stream_packet_context_quarks[Q_TIMESTAMP_END] =
+               g_quark_from_string("timestamp_end");
+       stream_packet_context_quarks[Q_EVENTS_DISCARDED] =
+               g_quark_from_string("events_discarded");
+       stream_packet_context_quarks[Q_CONTENT_SIZE] =
+               g_quark_from_string("content_size");
+       stream_packet_context_quarks[Q_PACKET_SIZE] =
+               g_quark_from_string("packet_size");
+       stream_packet_context_quarks[Q_PACKET_SEQ_NUM] =
+               g_quark_from_string("packet_seq_num");
+}
+
 static
 enum bt_component_status text_component_init(
-               struct bt_component *component, struct bt_value *params)
+               struct bt_private_component *component,
+               struct bt_value *params,
+               UNUSED_VAR void *init_method_data)
 {
        enum bt_component_status ret;
        struct text_component *text = create_text();
@@ -628,10 +743,15 @@ enum bt_component_status text_component_init(
                goto error;
        }
 
-       ret = bt_component_set_private_data(component, text);
+       set_use_colors(text);
+
+       ret = bt_private_component_set_user_data(component, text);
        if (ret != BT_COMPONENT_STATUS_OK) {
                goto error;
        }
+
+       init_stream_packet_context_quarks();
+
 end:
        return ret;
 error:
@@ -646,7 +766,7 @@ BT_PLUGIN_AUTHOR("Jérémie Galarneau");
 BT_PLUGIN_LICENSE("MIT");
 BT_PLUGIN_SINK_COMPONENT_CLASS(text, run);
 BT_PLUGIN_SINK_COMPONENT_CLASS_INIT_METHOD(text, text_component_init);
-BT_PLUGIN_SINK_COMPONENT_CLASS_DESTROY_METHOD(text, destroy_text);
+BT_PLUGIN_SINK_COMPONENT_CLASS_ACCEPT_PORT_CONNECTION_METHOD(text, text_accept_port_connection);
+BT_PLUGIN_SINK_COMPONENT_CLASS_FINALIZE_METHOD(text, finalize_text);
 BT_PLUGIN_SINK_COMPONENT_CLASS_DESCRIPTION(text,
        "Formats CTF-IR to text. Formerly known as ctf-text.");
-
This page took 0.030016 seconds and 4 git commands to generate.