From 073fec520c75d2468bd0eff0933feaab3283449c Mon Sep 17 00:00:00 2001
From: Philippe Guibert <philippe.guibert@6wind.com>
Date: Tue, 18 Jun 2024 12:11:44 +0200
Subject: [PATCH] lib: add json API to dump and override row naming convention

The following table is not compliant with caml format when displayed in
json:

>                 ttable_add_row(
>                         tt,
>                         "Vertex|Type|Metric|Next-Hop|Interface|Parent");
>
>                 ttable_json(tt, "ssdsss");

output observed:

> [..]
>        {
>          "Vertex":"r1",
>          "Type":"",
>          "Metric":0,
>          "Next-Hop":"",
>          "Interface":"",
>          "Parent":""
>        }

output expected:

> [..]
>        {
>          "vertex":"r1",
>          "type":"",
>          "metric":0,
>          "nextHop":"",
>          "interface":"",
>          "parent":""
>        }

Override the ttable_json() function with a new function which has an
extra paramter: this parameter will redefine the initial row value for
json:

> ttable_json_with_json_text(tt,
> "vertex|type|metric|nextHop|interface|parent");

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
---
 lib/termtable.c | 52 +++++++++++++++++++++++++++++++++++++++++++++++--
 lib/termtable.h | 15 ++++++++++++++
 2 files changed, 65 insertions(+), 2 deletions(-)

diff --git a/lib/termtable.c b/lib/termtable.c
index 9b36d5ebfa..88cc25bf68 100644
--- a/lib/termtable.c
+++ b/lib/termtable.c
@@ -496,7 +496,9 @@ char *ttable_dump(struct ttable *tt, const char *newline)
  *   l	int64
  *   s	string (default)
  */
-json_object *ttable_json(struct ttable *tt, const char *const formats)
+static json_object *ttable_json_internal(struct ttable *tt,
+					 const char *const formats,
+					 const char *row_text[])
 {
 	struct ttable_cell *row; /* iteration pointers */
 	json_object *json = NULL;
@@ -522,9 +524,55 @@ json_object *ttable_json(struct ttable *tt, const char *const formats)
 			default:
 				val = json_object_new_string(row[j].text);
 			}
-			json_object_object_add(jobj, tt->table[0][j].text, val);
+			if (row_text)
+				json_object_object_add(jobj, row_text[j], val);
+			else
+				json_object_object_add(jobj,
+						       tt->table[0][j].text,
+						       val);
 		}
 	}
 
 	return json;
 }
+
+json_object *ttable_json(struct ttable *tt, const char *const formats)
+{
+	return ttable_json_internal(tt, formats, NULL);
+}
+
+json_object *ttable_json_with_json_text(struct ttable *tt,
+					const char *const formats,
+					const char *json_override_text)
+{
+	char **row_name; /* iteration pointers */
+	char *res, *section, *orig;
+	int col = 0;
+	int ncols = 0, j;
+	json_object *json = NULL;
+
+	if (json_override_text) {
+		/* count how many columns we have */
+		for (j = 0; json_override_text[j]; j++)
+			ncols += !!(json_override_text[j] == '|');
+		ncols++;
+	}
+	if (json_override_text == NULL || ncols != tt->ncols)
+		return ttable_json_internal(tt, formats, NULL);
+
+	/* CALLOC a block of cells */
+	row_name = XCALLOC(MTYPE_TTABLE, ncols * sizeof(char *));
+	orig = XSTRDUP(MTYPE_TTABLE, json_override_text);
+	res = orig;
+	while (res && col < ncols) {
+		section = strsep(&res, "|");
+		row_name[col] = XSTRDUP(MTYPE_TTABLE, section);
+		col++;
+	}
+	json = ttable_json_internal(tt, formats, (const char **)row_name);
+	for (j = 0; j < col; j++)
+		XFREE(MTYPE_TTABLE, row_name[j]);
+	XFREE(MTYPE_TTABLE, row_name);
+	XFREE(MTYPE_TTABLE, orig);
+	return json;
+}
diff --git a/lib/termtable.h b/lib/termtable.h
index 7258682bd8..0782c82abd 100644
--- a/lib/termtable.h
+++ b/lib/termtable.h
@@ -289,6 +289,21 @@ char *ttable_dump(struct ttable *tt, const char *newline);
  */
 json_object *ttable_json(struct ttable *tt, const char *const formats);
 
+/**
+ * Convert a table to a JSON array of objects.
+ *
+ * Caller must free the returned json_object structure.
+ *
+ * @param tt the table to convert
+ * @param formats an array of characters indicating what JSON type should be
+ * used.
+ * @param formats an optinal string of row headers that overrids the first row of the table.
+ * This is useful to get naming convention that align with caml Format.
+ */
+json_object *ttable_json_with_json_text(struct ttable *tt,
+					const char *const formats,
+					const char *json_override_text);
+
 #ifdef __cplusplus
 }
 #endif
-- 
2.39.5