Rework Layout

To be a based on a dictionary, where each node child is just a key in
the dictionary and the value is the node itself

src/musicplayer/ui/control.gleam

@@ -3,7 +3,7 @@ import gleam/erlang/process.{type Subject}
 import musicplayer/ui/layout.{type Section}
 
 pub type Control {
-  UpdateDimensions(width: Int, height: Int)
+  UpdateDimensions(columns: Int, rows: Int)
   UpdateState(section: Section, content: String)
 
   Exit(reply_to: Subject(Nil))

src/musicplayer/ui/layout.gleam

@@ -1,7 +1,8 @@
 import gleam/dict
-import gleam/float
 import gleam/int
 import gleam/list
+import gleam/pair
+import gleam/set
 import gleam/string
 import gleam/string_tree
 
@@ -9,81 +10,64 @@ import musicplayer/logging/logging
 import musicplayer/ui/ansi
 import musicplayer/ui/internal
 
+pub const root_section = "reserved_root_section"
+
 pub type Section {
   Section(String)
 
-  Root
   Header
   Search
   PlaybackTime
 }
 
-pub type NodeType {
+pub type Dimension {
-  Container
+  Percent(width: Int, height: Int)
-  Row
+  // TODO add Flex that flows
-  Cell
+}
+
+pub type Style {
+  Style(dimensions: Dimension)
 }
 
-/// A Nodes width and height is in percentage (of the available width/height of its parent Node)
 pub type Node {
-  Node(
+  Row(content: String, style: Style, children: List(Section))
-    t: NodeType,
+  Cell(content: String, style: Style)
-    content: String,
-    width_percent: Int,
-    height_percent: Int,
-    children: List(Section),
-  )
 }
 
 pub type Layout {
-  Layout(width: Int, height: Int, nodes: dict.Dict(Section, Node))
+  Layout(columns: Int, rows: Int, nodes: dict.Dict(Section, Node))
 }
 
-pub fn new() -> Layout {
+pub fn new(columns: Int, rows: Int, nodes: List(#(Section, Node))) -> Layout {
+  let children =
+    nodes
+    |> list.flat_map(fn(node) {
+      case pair.second(node) {
+        Row(children: c, ..) -> c
+        Cell(..) -> []
+      }
+    })
+    |> set.from_list
+
+  // All sections that are not children of other nodes will be added as
+  // children to the root
+  let orphans =
+    nodes
+    |> list.map(pair.first)
+    |> list.filter(fn(node) { !set.contains(children, node) })
+
   let nodes =
-    dict.from_list([
+    dict.from_list(nodes)
-      #(
+    |> dict.insert(
-        Root,
+      Section(root_section),
-        Node(
+      Row(
-          t: Container,
-          content: "Music Player",
-          width_percent: 100,
-          height_percent: 100,
-          children: [Header, Search, PlaybackTime],
-        ),
-      ),
-      #(
-        Header,
-        Node(
-          t: Row,
-          content: "Foo (1) | Bar (2) | Baz (3)",
-          width_percent: 100,
-          height_percent: 33,
-          children: [],
-        ),
-      ),
-      #(
-        Search,
-        Node(
-          t: Row,
         content: "",
-          width_percent: 100,
+        style: Style(dimensions: Percent(width: 100, height: 100)),
-          height_percent: 33,
+        children: orphans,
-          children: [],
       ),
-      ),
+    )
-      #(
+
-        PlaybackTime,
+  Layout(columns:, rows:, nodes:)
-        Node(
-          t: Row,
-          content: "00:00",
-          width_percent: 100,
-          height_percent: 33,
-          children: [],
-        ),
-      ),
-    ])
-  Layout(width: 0, height: 0, nodes: nodes)
 }
 
 pub fn update_section(
@@ -93,77 +77,77 @@ pub fn update_section(
 ) -> Layout {
   case dict.get(layout.nodes, section) {
     Error(_) -> layout
-    Ok(node) ->
+    Ok(node) -> {
-      Layout(
+      let updated = case node {
-        ..layout,
+        Cell(..) -> Cell(..node, content: content)
-        nodes: dict.insert(
+        Row(..) -> Row(..node, content: content)
-          layout.nodes,
+      }
-          section,
+
-          Node(..node, content: content),
+      Layout(..layout, nodes: dict.insert(layout.nodes, section, updated))
-        ),
+    }
-      )
   }
 }
 
-pub fn update_dimensions(layout: Layout, width: Int, height: Int) -> Layout {
+pub fn update_dimensions(layout: Layout, columns: Int, rows: Int) -> Layout {
-  Layout(..layout, width:, height:)
+  Layout(..layout, columns:, rows:)
 }
 
 pub fn render(layout: Layout) -> Nil {
   internal.clear_screen()
-  [layout.width, layout.height]
+
+  [layout.columns, layout.rows]
   |> list.map(int.to_string)
   |> string.join(" ")
   |> string.append("layout - render: ", _)
   |> logging.log
 
-  let container_width = int.to_float(layout.width)
+  let context =
-  let container_height = int.to_float(layout.height)
+    RenderContext(
-  let container_top_left_x = 1
+      parent_width: layout.columns,
-  let container_top_left_y = 1
+      parent_height: layout.rows,
+      parent_top_left_x: 1,
+      parent_top_left_y: 1,
+      position_index: 0,
+    )
 
   let ansi_renders =
     Renders(
-      box: fn(tree, x, y, w, h) {
-        string_tree.append(tree, ansi.box(x, y, w, h))
-      },
       text: fn(tree, chars, x, y) {
         string_tree.append(tree, ansi.text(chars, x, y))
       },
+      box: fn(tree, x, y, w, h) {
+        string_tree.append(tree, ansi.box(x, y, w, h))
+      },
     )
 
   string_tree.new()
-  |> render_generic(
+  |> render_generic(layout, context, Section(root_section), _, ansi_renders)
-    layout,
-    container_width,
-    container_height,
-    container_top_left_x,
-    container_top_left_y,
-    0,
-    Root,
-    _,
-    ansi_renders,
-  )
   |> string_tree.to_string
   |> internal.print
 }
 
 pub type Renders(into) {
   Renders(
+    // into, chars, x, y
     text: fn(into, String, Int, Int) -> into,
+    // into, x, y, width, height
     box: fn(into, Int, Int, Int, Int) -> into,
   )
 }
 
+pub type RenderContext {
+  RenderContext(
+    parent_width: Int,
+    parent_height: Int,
+    parent_top_left_x: Int,
+    parent_top_left_y: Int,
+    position_index: Int,
+  )
+}
+
 pub fn render_generic(
   layout: Layout,
-  // Dimensions
+  context: RenderContext,
-  container_width: Float,
-  container_height: Float,
-  container_tl_x: Int,
-  container_tl_y: Int,
-  // State
-  index: Int,
   from: Section,
   render_into: into,
   renders: Renders(into),
@@ -171,61 +155,70 @@ pub fn render_generic(
   case dict.get(layout.nodes, from) {
     Error(_) -> render_into
     Ok(node) -> {
-      let margin = 2.0
+      // Margin between container and the node being rendere
+      let margin = 2
 
-      let width =
+      let #(node_width, node_height) = case node.style.dimensions {
-        container_width *. { int.to_float(node.width_percent) /. 100.0 }
+        Percent(width:, height:) -> {
-        |> float.floor
+          let width = { context.parent_width * width } / 100
-        |> float.truncate
+          let height = { context.parent_height * height } / 100
 
-      let height =
+          #(width, height)
-        container_height *. { int.to_float(node.height_percent) /. 100.0 }
+        }
-        |> float.floor
+      }
-        |> float.truncate
 
-      let #(cx, cy) = case node.t {
+      // Check if this node should be placed to the left or below the parent
-        Container -> #(container_tl_x, container_tl_y)
+      let #(node_top_left_x, node_top_left_y) = case node {
-        Row -> #(container_tl_x, container_tl_y + { index * height })
+        Row(..) -> #(
-        Cell -> #(container_tl_x + { index * width }, container_tl_y)
+          context.parent_top_left_x,
+          context.parent_top_left_y + { context.position_index * node_height },
+        )
+        Cell(..) -> #(
+          context.parent_top_left_x + { context.position_index * node_width },
+          context.parent_top_left_y,
+        )
       }
 
       let parent =
         render_into
-        |> renders.box(cx, cy, width, height)
+        |> renders.box(
-        // + 2 for header margin
+          node_top_left_x,
-        |> renders.text(node.content, cx + 2, cy)
+          node_top_left_y,
+          node_width,
+          node_height,
+        )
+        |> renders.text(node.content, node_top_left_x, node_top_left_y)
 
-      list.index_map(node.children, fn(child, i) { #(i, child) })
+      case node {
+        Cell(..) -> parent
+        Row(children:, ..) -> {
+          list.index_map(children, fn(child, i) { #(i, child) })
           |> list.fold(parent, fn(acc_into, ic) {
             let #(i, child) = ic
 
-        let cw =
+            let #(child_width, child_height) = case node.style.dimensions {
-          container_width
+              Percent(width:, height:) -> {
-          *. { int.to_float(node.width_percent) /. 100.0 }
+                let width = { { context.parent_width * width } / 100 } - margin
-          -. margin
+                let height =
-          |> float.floor
+                  { { context.parent_height * height } / 100 } - margin
 
-        let ch =
+                #(width, height)
-          container_height
+              }
-          *. { int.to_float(node.height_percent) /. 100.0 }
+            }
-          -. margin
-          |> float.floor
 
-        let child_origin_x = container_tl_x + 1
+            let context =
-        let child_origin_y = container_tl_y + 1
+              RenderContext(
-
+                parent_width: child_width,
-        render_generic(
+                parent_height: child_height,
-          layout,
+                parent_top_left_x: context.parent_top_left_x + 1,
-          cw,
+                parent_top_left_y: context.parent_top_left_y + 1,
-          ch,
+                position_index: i,
-          child_origin_x,
-          child_origin_y,
-          i,
-          child,
-          acc_into,
-          renders,
               )
+
+            render_generic(layout, context, child, acc_into, renders)
           })
         }
       }
+    }
+  }
 }

src/musicplayer/ui/layout_examples/layout_examples.gleam

@@ -1,14 +1,12 @@
-import gleam/dict
-
 import musicplayer/ui/internal
-import musicplayer/ui/layout.{Container, Layout, Node, Section}
+import musicplayer/ui/layout.{Percent, Section, Style}
 import musicplayer/ui/layout_examples/wait_for_input.{wait_for_input}
 
 pub fn main() {
-  let assert Ok(width) = internal.io_get_columns()
+  let assert Ok(columns) = internal.io_get_columns()
-  let assert Ok(height) = internal.io_get_rows()
+  let assert Ok(rows) = internal.io_get_rows()
 
-  two_rows_with_cells(width, height)
+  two_rows_with_cells(columns, rows)
   |> layout.render
 
   wait_for_input()
@@ -17,66 +15,42 @@ pub fn main() {
 /// Two rows:
 /// First row has two cells
 /// Second row has no cells
-fn two_rows_with_cells(width: Int, height: Int) -> layout.Layout {
+fn two_rows_with_cells(columns: Int, rows: Int) -> layout.Layout {
-  let nodes =
+  let nodes = [
-    dict.from_list([
-      #(
-        Section("Root"),
-        Node(
-          t: Container,
-          content: "container",
-          width_percent: 100,
-          height_percent: 100,
-          children: [
-            Section("Row1"),
-            Section("Row2"),
-          ],
-        ),
-      ),
     #(
       Section("Row1"),
-        Node(
+      layout.Row(
-          t: layout.Row,
         content: "row 1",
-          width_percent: 100,
+        style: Style(dimensions: Percent(width: 100, height: 50)),
-          height_percent: 50,
         children: [
           Section("A"),
-            Section("A"),
+          Section("B"),
         ],
       ),
     ),
     #(
       Section("A"),
-        Node(
+      layout.Cell(
-          t: layout.Cell,
         content: "cell 1",
-          width_percent: 50,
+        style: Style(dimensions: Percent(width: 50, height: 50)),
-          height_percent: 100,
-          children: [],
       ),
     ),
     #(
       Section("B"),
-        Node(
+      layout.Cell(
-          t: layout.Cell,
         content: "cell 2",
-          width_percent: 50,
+        style: Style(dimensions: Percent(width: 50, height: 50)),
-          height_percent: 100,
-          children: [],
       ),
     ),
     #(
       Section("Row2"),
-        Node(
+      layout.Row(
-          t: layout.Row,
         content: "row 2",
-          width_percent: 100,
+        style: Style(dimensions: Percent(width: 50, height: 50)),
-          height_percent: 50,
         children: [],
       ),
     ),
-    ])
+  ]
 
-  Layout(width:, height:, nodes: nodes)
+  layout.new(columns, rows, nodes)
 }

src/musicplayer/ui/ui.gleam

@@ -17,7 +17,34 @@ pub fn new() -> Result(Subject(Control), String) {
   let redraw_name = process.new_name("redraw")
   let redraw: Subject(Layout) = process.named_subject(redraw_name)
 
-  let layout = layout.new()
+  let layout =
+    [
+      #(
+        layout.Header,
+        layout.Row(
+          content: "Foo (1) | Bar (2) | Baz (3)",
+          style: layout.Style(dimensions: layout.Percent(width: 100, height: 33)),
+          children: [],
+        ),
+      ),
+      #(
+        layout.Search,
+        layout.Row(
+          content: "",
+          style: layout.Style(dimensions: layout.Percent(width: 100, height: 33)),
+          children: [],
+        ),
+      ),
+      #(
+        layout.PlaybackTime,
+        layout.Row(
+          content: "00:00",
+          style: layout.Style(dimensions: layout.Percent(width: 100, height: 33)),
+          children: [],
+        ),
+      ),
+    ]
+    |> layout.new(0, 0, _)
 
   case
     actor.new(State(redraw, layout))
@@ -51,19 +78,19 @@ fn handle_message(
   control: Control,
 ) -> actor.Next(State(redraw, layout), Control) {
   case control {
-    control.UpdateDimensions(width, height) -> {
+    control.UpdateDimensions(columns, rows) -> {
-      let current_dimensions = #(state.layout.width, state.layout.height)
+      let current_dimensions = #(state.layout.columns, state.layout.rows)
 
-      case #(width, height) == current_dimensions {
+      case #(columns, rows) == current_dimensions {
         True -> actor.continue(state)
         False -> {
-          [width, height]
+          [columns, rows]
           |> list.map(int.to_string)
           |> string.join(" ")
           |> string.append("ui - updating dimensions: ", _)
           |> logging.log
 
-          let layout = layout.update_dimensions(state.layout, width, height)
+          let layout = layout.update_dimensions(state.layout, columns, rows)
 
           process.send(state.redraw, layout)
           actor.continue(State(..state, layout:))

test/musicplayer/ui/layout_test.gleam

@@ -1,42 +1,22 @@
-import gleam/dict
 import gleam/io
 import gleam/string
 import gleeunit
 import gleeunit/should
 import musicplayer/ui/virtual_ansi
 
-import musicplayer/ui/layout.{Layout, Node, Section}
+import musicplayer/ui/layout.{Percent, Section, Style}
 
 pub fn main() -> Nil {
   gleeunit.main()
 }
 
-pub fn foo_test() {
+pub fn percent_layout_test() {
-  let layout =
+  let nodes = [
-    Layout(
-      width: 80,
-      height: 20,
-      nodes: dict.from_list([
-        #(
-          Section("Root"),
-          Node(
-            t: layout.Container,
-            content: "container",
-            width_percent: 100,
-            height_percent: 100,
-            children: [
-              Section("Row1"),
-              Section("Row2"),
-            ],
-          ),
-        ),
     #(
       Section("Row1"),
-          Node(
+      layout.Row(
-            t: layout.Row,
         content: "row 1",
-            width_percent: 100,
+        style: Style(dimensions: Percent(width: 100, height: 50)),
-            height_percent: 50,
         children: [
           Section("A"),
           Section("B"),
@@ -45,40 +25,35 @@ pub fn foo_test() {
     ),
     #(
       Section("A"),
-          Node(
+      layout.Cell(
-            t: layout.Cell,
         content: "cell 1",
-            width_percent: 50,
+        style: Style(dimensions: Percent(width: 50, height: 100)),
-            height_percent: 100,
-            children: [],
       ),
     ),
     #(
       Section("B"),
-          Node(
+      layout.Cell(
-            t: layout.Cell,
         content: "cell 2",
-            width_percent: 50,
+        style: Style(dimensions: Percent(width: 50, height: 100)),
-            height_percent: 100,
-            children: [],
       ),
     ),
     #(
       Section("Row2"),
-          Node(
+      layout.Row(
-            t: layout.Row,
         content: "row 1",
-            width_percent: 100,
+        style: Style(dimensions: Percent(width: 100, height: 50)),
-            height_percent: 50,
         children: [],
       ),
     ),
-      ]),
+  ]
-    )
+
+  let columns = 80
+  let rows = 20
+  let layout = layout.new(columns, rows, nodes)
 
   let expected =
     "
-container──────────────────────────────────────────────────────────────────────┐
+┌──────────────────────────────────────────────────────────────────────────────┐
 │row 1────────────────────────────────────────────────────────────────────────┐│
 ││cell 1───────────────────────────────┐cell 2───────────────────────────────┐││
 │││                                    ││                                    │││
@@ -100,8 +75,7 @@ container───────────────────────
 └──────────────────────────────────────────────────────────────────────────────┘
 "
 
-  let visual =
+  let visual = virtual_ansi.render(layout)
-    virtual_ansi.render(layout, Section("Root"), layout.width, layout.height)
   case visual == string.trim(expected) {
     True -> Nil
     False -> {

test/musicplayer/ui/virtual_ansi.gleam

@@ -3,27 +3,32 @@ import gleam/int
 import gleam/list
 import gleam/string
 
-import musicplayer/ui/layout.{type Layout, type Section, Renders}
+import musicplayer/ui/layout.{type Layout, RenderContext, Renders}
 
 pub type Screen =
   dict.Dict(#(Int, Int), String)
 
-pub fn render(layout: Layout, root: Section, width: Int, height: Int) -> String {
+pub fn render(layout: Layout) -> String {
   let test_renders =
     Renders(
-      box: fn(screen, x, y, w, h) { box(screen, x, y, w, h) },
       text: fn(screen, chars, x, y) { text(screen, chars, x, y) },
+      box: fn(screen, x, y, w, h) { box(screen, x, y, w, h) },
+    )
+
+  let context =
+    RenderContext(
+      parent_width: layout.columns,
+      parent_height: layout.rows,
+      parent_top_left_x: 1,
+      parent_top_left_y: 1,
+      position_index: 0,
     )
 
   let screen =
     layout.render_generic(
       layout,
-      int.to_float(width),
+      context,
-      int.to_float(height),
+      layout.Section(layout.root_section),
-      1,
-      1,
-      0,
-      root,
       dict.new(),
       test_renders,
     )