nmcli: add support for printing color strings

clients/cli/nmcli.h

@@ -68,6 +68,18 @@ typedef enum {
 	NMC_RESULT_ERROR_NOT_FOUND = 10
 } NMCResultCode;
 
+typedef enum {
+	NMC_TERM_COLOR_NORMAL  = 0,
+	NMC_TERM_COLOR_BLACK   = 1,
+	NMC_TERM_COLOR_RED     = 2,
+	NMC_TERM_COLOR_GREEN   = 3,
+	NMC_TERM_COLOR_YELLOW  = 4,
+	NMC_TERM_COLOR_BLUE    = 5,
+	NMC_TERM_COLOR_MAGENTA = 6,
+	NMC_TERM_COLOR_CYAN    = 7,
+	NMC_TERM_COLOR_WHITE   = 8
+} NmcTermColor;
+
 typedef enum {
 	NMC_PRINT_TERSE = 0,
 	NMC_PRINT_NORMAL = 1,
@@ -90,6 +102,7 @@ typedef struct _NmcOutputField {
 	gboolean value_is_array;        /* Whether value is char** instead of char* */
 	gboolean free_value;            /* Whether to free the value */
 	guint32 flags;                  /* Flags - whether and how to print values/field names/headers */
+	NmcTermColor color;             /* Use this color to print value */
 } NmcOutputField;
 
 typedef struct {
@@ -98,18 +111,6 @@ typedef struct {
 	int indent;           /* Indent by this number of spaces */
 } NmcPrintFields;
 
-typedef enum {
-	NMC_TERM_COLOR_NORMAL  = 0,
-	NMC_TERM_COLOR_BLACK   = 1,
-	NMC_TERM_COLOR_RED     = 2,
-	NMC_TERM_COLOR_GREEN   = 3,
-	NMC_TERM_COLOR_YELLOW  = 4,
-	NMC_TERM_COLOR_BLUE    = 5,
-	NMC_TERM_COLOR_MAGENTA = 6,
-	NMC_TERM_COLOR_CYAN    = 7,
-	NMC_TERM_COLOR_WHITE   = 8
-} NmcTermColor;
-
 /* NmCli - main structure */
 typedef struct _NmCli {
 	NMClient *client;                                 /* Pointer to NMClient of libnm */

clients/cli/utils.c

@@ -705,6 +705,16 @@ set_val_arrc (NmcOutputField fields_array[], guint32 idx, const char **value)
 	fields_array[idx].free_value = FALSE;
 }
 
+void
+set_val_color_all (NmcOutputField fields_array[], NmcTermColor color)
+{
+	int i;
+
+	for (i = 0; fields_array[i].name; i++) {
+		fields_array[i].color = color;
+	}
+}
+
 /*
  * Free 'value' members in array of NmcOutputField
  */
@@ -923,23 +933,54 @@ nmc_empty_output_fields (NmCli *nmc)
 }
 
 static char *
-get_value_to_print (NmcOutputField *fields,
+colorize_string (gboolean colorize,
+                 NmcTermColor color,
+                 const char *str,
+                 gboolean *dealloc)
+{
+	char *out;
+
+	if (   colorize
+	    && (color != NMC_TERM_COLOR_NORMAL)) {
+		out = nmc_colorize (color, str);
+		*dealloc = TRUE;
+	} else {
+		out = (char *) str;
+		*dealloc = FALSE;
+	}
+	return out;
+}
+
+static char *
+get_value_to_print (NmcOutputField *field,
                     gboolean field_name,
                     const char *not_set_str,
-                    gboolean *dealloc)
+                    gboolean *dealloc,
+                    gboolean colorize)
 {
-	gboolean is_array = fields->value_is_array;
+	gboolean is_array = field->value_is_array;
-	char *value;
+	char *value, *out;
+	gboolean free_value, free_out;
 
 	if (field_name)
-		value = _(fields->name_l10n);
+		value = _(field->name_l10n);
 	else
-		value = fields->value ?
+		value = field->value ?
-		          (is_array ? g_strjoinv (" | ", (char **) fields->value) :
+		          (is_array ? g_strjoinv (" | ", (char **) field->value) :
-		                      (char *) fields->value) :
+		                      (char *) field->value) :
 		          (char *) not_set_str;
-	*dealloc = fields->value && is_array && !field_name;
+	free_value = field->value && is_array && !field_name;
-	return value;
+
+	/* colorize the value */
+	out = colorize_string (colorize, field->color, value, &free_out);
+	if (free_out) {
+		if (free_value)
+			g_free (value);
+		 *dealloc = TRUE;
+	} else
+		 *dealloc = free_value;
+
+	return out;
 }
 
 /*
@@ -969,6 +1010,7 @@ print_required_fields (NmCli *nmc, const NmcOutputField field_values[])
 	gboolean field_names = field_values[0].flags & NMC_OF_FLAG_FIELD_NAMES;
 	gboolean section_prefix = field_values[0].flags & NMC_OF_FLAG_SECTION_PREFIX;
 	gboolean main_header = main_header_add || main_header_only;
+	gboolean colorize;
 
 	/* No headers are printed in terse mode:
 	 * - neither main header nor field (column) names
@@ -976,6 +1018,9 @@ print_required_fields (NmCli *nmc, const NmcOutputField field_values[])
 	if ((main_header_only || field_names) && terse)
 		return;
 
+	/* Only show colors if the output is a terminal */
+	colorize = isatty (fileno (stdout));
+
 	if (multiline) {
 	/* --- Multiline mode --- */
 		enum { ML_HEADER_WIDTH = 79 };
@@ -998,6 +1043,7 @@ print_required_fields (NmCli *nmc, const NmcOutputField field_values[])
 		if (!main_header_only && !field_names) {
 			for (i = 0; i < fields.indices->len; i++) {
 				char *tmp;
+				gboolean free_print_val;
 				int idx = g_array_index (fields.indices, int, i);
 				gboolean is_array = field_values[idx].value_is_array;
 
@@ -1009,10 +1055,14 @@ print_required_fields (NmCli *nmc, const NmcOutputField field_values[])
 
 				if (is_array) {
 					/* value is a null-terminated string array */
-					const char **p;
+					const char **p, *val;
+					char *print_val;
 					int j;
 
 					for (p = (const char **) field_values[idx].value, j = 1; p && *p; p++, j++) {
+						val = *p ? *p : not_set_str;
+						print_val = colorize_string (colorize, field_values[idx].color,
+						                             val, &free_print_val);
 						tmp = g_strdup_printf ("%s%s%s[%d]:",
 						                       section_prefix ? (const char*) field_values[0].value : "",
 						                       section_prefix ? "." : "",
@@ -1020,24 +1070,30 @@ print_required_fields (NmCli *nmc, const NmcOutputField field_values[])
 						                       j);
 						width1 = strlen (tmp);
 						width2 = nmc_string_screen_width (tmp, NULL);
-						g_print ("%-*s%s\n", terse ? 0 : ML_VALUE_INDENT+width1-width2, tmp,
+						g_print ("%-*s%s\n", terse ? 0 : ML_VALUE_INDENT+width1-width2, tmp, print_val);
-						         *p ? *p : not_set_str);
 						g_free (tmp);
+						if (free_print_val)
+							g_free (print_val);
 					}
 				} else {
 					/* value is a string */
 					const char *hdr_name = (const char*) field_values[0].value;
 					const char *val = (const char*) field_values[idx].value;
+					char *print_val;
 
+					val = val ? val : not_set_str;
+					print_val = colorize_string (colorize, field_values[idx].color,
+					                             val, &free_print_val);
 					tmp = g_strdup_printf ("%s%s%s:",
 					                       section_prefix ? hdr_name : "",
 					                       section_prefix ? "." : "",
 					                       _(field_values[idx].name_l10n));
 					width1 = strlen (tmp);
 					width2 = nmc_string_screen_width (tmp, NULL);
-					g_print ("%-*s%s\n", terse ? 0 : ML_VALUE_INDENT+width1-width2, tmp,
+					g_print ("%-*s%s\n", terse ? 0 : ML_VALUE_INDENT+width1-width2, tmp, print_val);
-					         val ? val : not_set_str);
 					g_free (tmp);
+					if (free_print_val)
+						g_free (print_val);
 				}
 			}
 			if (pretty) {
@@ -1055,7 +1111,8 @@ print_required_fields (NmCli *nmc, const NmcOutputField field_values[])
 	for (i = 0; i < fields.indices->len; i++) {
 		int idx = g_array_index (fields.indices, int, i);
 		gboolean dealloc;
-		char *value = get_value_to_print ((NmcOutputField *) field_values+idx, field_names, not_set_str, &dealloc);
+		char *value = get_value_to_print ((NmcOutputField *) field_values+idx, field_names,
+		                                   not_set_str, &dealloc, colorize);
 
 		if (terse) {
 			if (escape) {
@@ -1153,7 +1210,7 @@ print_data (NmCli *nmc)
 			char *value;
 			row = g_ptr_array_index (nmc->output_data, j);
 			field_names = row[0].flags & NMC_OF_FLAG_FIELD_NAMES;
-			value = get_value_to_print (row+i, field_names, "--", &dealloc);
+			value = get_value_to_print (row+i, field_names, "--", &dealloc, FALSE);
 			len = nmc_string_screen_width (value, NULL);
 			max_width = len > max_width ? len : max_width;
 			if (dealloc)

clients/cli/utils.h

@@ -81,6 +81,7 @@ void set_val_str  (NmcOutputField fields_array[], guint32 index, char *value);
 void set_val_strc (NmcOutputField fields_array[], guint32 index, const char *value);
 void set_val_arr  (NmcOutputField fields_array[], guint32 index, char **value);
 void set_val_arrc (NmcOutputField fields_array[], guint32 index, const char **value);
+void set_val_color_all (NmcOutputField fields_array[], NmcTermColor color);
 void nmc_free_output_field_values (NmcOutputField fields_array[]);
 GArray *parse_output_fields (const char *fields_str,
                              const NmcOutputField fields_array[],