From f13d30ad2306caafaa667e6ba9f430d64c482812 Mon Sep 17 00:00:00 2001
From: Feoramund <161657516+Feoramund@users.noreply.github.com>
Date: Wed, 26 Jun 2024 12:50:43 -0400
Subject: [PATCH] Add `write_decorated_table` API

---
 core/text/table/table.odin | 79 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)

diff --git a/core/text/table/table.odin b/core/text/table/table.odin
index 7b4942478..27c99b1f1 100644
--- a/core/text/table/table.odin
+++ b/core/text/table/table.odin
@@ -51,6 +51,19 @@ Table :: struct {
 	tblw: int,          // Width of entire table (including padding, excluding borders)
 }
 
+Decorations :: struct {
+	// These are strings, because of multi-codepoint Unicode graphemes.
+
+	// Connecting decorations:
+	nw, n, ne,
+	 w, x,  e,
+	sw, s, se: string,
+
+	// Straight lines:
+	vert: string,
+	horz: string,
+}
+
 ascii_width_proc :: proc(str: string) -> int {
 	return len(str)
 }
@@ -397,6 +410,72 @@ write_plain_table :: proc(w: io.Writer, tbl: ^Table, width_proc: Width_Proc = un
 	write_table_separator(w, tbl)
 }
 
+write_decorated_table :: proc(w: io.Writer, tbl: ^Table, decorations: Decorations, width_proc: Width_Proc = unicode_width_proc) {
+	draw_dividing_row :: proc(w: io.Writer, tbl: ^Table, left, horz, divider, right: string) {
+		io.write_string(w, left)
+		for col in 0..<tbl.nr_cols {
+			for _ in 0..<tbl.colw[col] + tbl.lpad + tbl.rpad {
+				io.write_string(w, horz)
+			}
+			if col < tbl.nr_cols-1 {
+				io.write_string(w, divider)
+			}
+		}
+		io.write_string(w, right)
+		io.write_byte(w, '\n')
+	}
+
+	build(tbl, width_proc)
+
+	// This determines whether or not to divide the top border.
+	top_divider := decorations.n if len(tbl.caption) == 0 else decorations.horz
+
+	// Draw the north border.
+	draw_dividing_row(w, tbl, decorations.nw, decorations.horz, top_divider, decorations.ne)
+
+	if len(tbl.caption) != 0 {
+		// Draw the caption.
+		io.write_string(w, decorations.vert)
+		write_text_align(w, tbl.caption, .Center,
+			tbl.lpad, tbl.rpad, tbl.tblw + tbl.nr_cols - 1 - width_proc(tbl.caption) - tbl.lpad - tbl.rpad)
+		io.write_string(w, decorations.vert)
+		io.write_byte(w, '\n')
+
+		// Draw the divider between the caption and the table rows.
+		draw_dividing_row(w, tbl, decorations.w, decorations.horz, decorations.n, decorations.e)
+	}
+
+	// Draw the header.
+	start := 0
+	if tbl.has_header_row {
+		io.write_string(w, decorations.vert)
+		row := header_row(tbl)
+		for col in 0..<tbl.nr_cols {
+			write_table_cell(w, tbl, row, col)
+			io.write_string(w, decorations.vert)
+		}
+		io.write_byte(w, '\n')
+		start += row + 1
+
+		draw_dividing_row(w, tbl, decorations.w, decorations.horz, decorations.x, decorations.e)
+	}
+
+	// Draw the cells.
+	for row in start..<tbl.nr_rows {
+		for col in 0..<tbl.nr_cols {
+			if col == 0 {
+				io.write_string(w, decorations.vert)
+			}
+			write_table_cell(w, tbl, row, col)
+			io.write_string(w, decorations.vert)
+		}
+		io.write_byte(w, '\n')
+	}
+
+	// Draw the south border.
+	draw_dividing_row(w, tbl, decorations.sw, decorations.horz, decorations.s, decorations.se)
+}
+
 // Renders table according to GitHub Flavored Markdown (GFM) specification
 write_markdown_table :: proc(w: io.Writer, tbl: ^Table, width_proc: Width_Proc = unicode_width_proc) {
 	// NOTE(oskar): Captions or colspans are not supported by GFM as far as I can tell.