From 165f1eec896e1612a47e14fa0200cdcac9d2b415 Mon Sep 17 00:00:00 2001
From: stellarpower <stellarpower@googlemail.com>
Date: Sun, 2 Jun 2024 16:20:52 +0100
Subject: [PATCH] Basic implementation of pretty-printing a tree. Generated by
 copilot and could do with some expansion and customisation options
 (indentation, display characters like unix tree; display payload or not), but
 is a starting point.

---
 src/radix/tree.cr | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/src/radix/tree.cr b/src/radix/tree.cr
index 9cd5194..5de53fe 100644
--- a/src/radix/tree.cr
+++ b/src/radix/tree.cr
@@ -474,5 +474,36 @@ module Radix
       (!different) &&
         (!key_reader.has_next? || _check_markers(key_reader.current_char))
     end
+
+
+    # Prints out each node, with branches similar to `tree` in the shell.
+    def pretty_print(pp : PrettyPrint)
+      pretty_print pp, @root
+    end
+  
+    # Recurses through children; prefix is spaces and branches like the `tree` command
+    # Node will be the current node and if it has children, we will recurse down this function to get the whole lot.
+    # TODO: custom indentation level, change the appearance of bars,
+    # Also specify if we want to print the value, seeing as some of these may not render nicely.
+    def pretty_print(pp : PrettyPrint, node, prefix : String = "")
+      node.children.each_with_index { |child, index|
+      
+        # Print the bars nicely for the last element.
+        is_last = index == node.children.size - 1
+        line   = is_last ? "└── " : "├── "
+        indent = is_last ? "    " : "|   "
+        
+        
+        # TODO - pretty-print here? Or just use to_s?
+        # Ouptuts the node's key as well as the payload.
+        pp.text "#{ prefix }#{ line }#{ child.key }: #{ child.payload? && child.payload }"
+        pp.breakable
+
+        # Now recurse, with the leading characters and indentatioin
+        pretty_print(pp, child, prefix: prefix + indent)
+      }
+    end
+
   end
+
 end