Add the verbose parameter to the legacy text options

[babeltrace.git] / plugins / text / text.c

diff --git a/plugins/text/text.c b/plugins/text/text.c
index 2712dd684db95d8de215cf24dc94a356e3faf71e..44887b6fe11498470cac076f4d4deb9661a70318 100644 (file)
--- a/plugins/text/text.c
+++ b/plugins/text/text.c
@@ -27,23 +27,24 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/plugin/plugin-macros.h>
-#include <babeltrace/plugin/component.h>
-#include <babeltrace/plugin/sink.h>
-#include <babeltrace/plugin/notification/notification.h>
-#include <babeltrace/plugin/notification/iterator.h>
-#include <babeltrace/plugin/notification/event.h>
+#include <babeltrace/plugin/plugin-dev.h>
+#include <babeltrace/component/component.h>
+#include <babeltrace/component/component-sink.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"
 
-#define PLUGIN_NAME    "text"
-
 static
 const char *plugin_options[] = {
+       "color",
        "output-path",
        "debug-info-dir",
        "debug-info-target-prefix",
@@ -53,6 +54,7 @@ const char *plugin_options[] = {
        "clock-seconds",
        "clock-date",
        "clock-gmt",
+       "verbose",
        "name-default",         /* show/hide */
        "name-payload",
        "name-context",
@@ -224,8 +226,7 @@ bool check_param_exists(const char *key, struct bt_value *object, void *data)
 
        if (!bt_value_map_get(plugin_opt_map, key)) {
                fprintf(text->err,
-                       "[warning] Parameter \"%s\" unknown to \"%s\" plugin\n",
-                       key, PLUGIN_NAME);
+                       "[warning] Parameter \"%s\" unknown to \"text\" plugin\n", key);
        }
        return true;
 }
@@ -291,6 +292,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)
@@ -319,6 +327,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;
+               }
+
+               ret = bt_value_string_get(color_value, &color);
+               if (ret) {
+                       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);
@@ -382,6 +418,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) {
@@ -605,9 +648,27 @@ 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
 enum bt_component_status text_component_init(
-               struct bt_component *component, struct bt_value *params)
+               struct bt_component *component, struct bt_value *params,
+               UNUSED_VAR void *init_method_data)
 {
        enum bt_component_status ret;
        struct text_component *text = create_text();
@@ -631,22 +692,12 @@ enum bt_component_status text_component_init(
                goto error;
        }
 
-       ret = bt_component_set_destroy_cb(component,
-                       destroy_text);
-       if (ret != BT_COMPONENT_STATUS_OK) {
-               goto error;
-       }
+       set_use_colors(text);
 
        ret = bt_component_set_private_data(component, text);
        if (ret != BT_COMPONENT_STATUS_OK) {
                goto error;
        }
-
-       ret = bt_component_sink_set_consume_cb(component,
-                       run);
-       if (ret != BT_COMPONENT_STATUS_OK) {
-               goto error;
-       }
 end:
        return ret;
 error:
@@ -655,13 +706,13 @@ error:
 }
 
 /* Initialize plug-in entry points. */
-BT_PLUGIN_NAME("text");
+BT_PLUGIN(text);
 BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
 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_DESCRIPTION(text,
+       "Formats CTF-IR to text. Formerly known as ctf-text.");
 
-BT_PLUGIN_COMPONENT_CLASSES_BEGIN
-BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY(PLUGIN_NAME,
-               "Formats CTF-IR to text. Formerly known as ctf-text.",
-               text_component_init)
-BT_PLUGIN_COMPONENT_CLASSES_END