From 06ee1bd6fe3b42c9ff5077e86c6d40f45a0781e1 Mon Sep 17 00:00:00 2001
From: David Dworken <david@daviddworken.com>
Date: Sun, 24 Sep 2023 18:06:32 -0700
Subject: [PATCH] Add comments/clean up TUI highlighting code

---
 client/tui/tui.go | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/client/tui/tui.go b/client/tui/tui.go
index daf284b..49db438 100644
--- a/client/tui/tui.go
+++ b/client/tui/tui.go
@@ -589,6 +589,7 @@ func makeTable(ctx context.Context, rows []table.Row) (table.Model, error) {
 			var re *regexp.Regexp
 			CURRENT_QUERY_FOR_HIGHLIGHTING = strings.TrimSpace(CURRENT_QUERY_FOR_HIGHLIGHTING)
 			if CURRENT_QUERY_FOR_HIGHLIGHTING == "" {
+				// If there is no search query, then there is nothing to highlight
 				re = MATCH_NOTHING_REGEXP
 			} else {
 				queryRegex := lib.MakeRegexFromQuery(CURRENT_QUERY_FOR_HIGHLIGHTING)
@@ -602,28 +603,34 @@ func makeTable(ctx context.Context, rows []table.Row) (table.Model, error) {
 				}
 			}
 
+			// func to render a given chunk of `value`. `isMatching` is whether `v` matches the search query (and
+			// thus needs to be highlighted). `isLeftMost` and `isRightMost` determines whether additional
+			// padding is added (to reproduce the padding that `s.Cell` normally adds).
 			renderChunk := func(v string, isMatching, isLeftMost, isRightMost bool) string {
-				baseStyle := lipgloss.NewStyle()
+				chunkStyle := lipgloss.NewStyle()
 				if position.IsRowSelected {
-					baseStyle = s.Selected.Copy()
+					// Apply the selected style as the base style if this is the highlighted row of the table
+					chunkStyle = s.Selected.Copy()
 				}
 				if isLeftMost {
-					baseStyle = baseStyle.PaddingLeft(1)
+					chunkStyle = chunkStyle.PaddingLeft(1)
 				}
 				if isRightMost {
-					baseStyle = baseStyle.PaddingRight(1)
+					chunkStyle = chunkStyle.PaddingRight(1)
 				}
 				if isMatching {
-					baseStyle = baseStyle.Bold(true)
+					chunkStyle = chunkStyle.Bold(true)
 				}
-				return baseStyle.Render(v)
+				return chunkStyle.Render(v)
 			}
 
 			matches := re.FindAllStringIndex(value, -1)
 			if len(matches) == 0 {
-				return renderChunk(value, false, true, true)
+				// No matches, so render the entire value
+				return renderChunk(value /*isMatching = */, false /*isLeftMost = */, true /*isRightMost = */, true)
 			}
 
+			// Iterate through the chunks of the value and highlight the relevant pieces
 			ret := ""
 			lastIncludedIdx := 0
 			for _, match := range re.FindAllStringIndex(value, -1) {