Layout consist of multiple Views

Redraw all x,y coordinates on screen Instead of using ANSI codes,
to be avoid clearing the screen which introduces flickering in TMUX

src/musicplayer/musicplayer.gleam

@@ -52,7 +52,7 @@ pub fn new(
         handle_key(musicplayer, input_keys)
       })
 
-      process.spawn(fn() { update_playback_time_loop(mpv, ui, 1000) })
+      process.spawn(fn() { update_playback_time_loop(mpv, ui, 250) })
 
       Ok(pid)
     }
@@ -146,6 +146,7 @@ fn update_playback_time_loop(
   interval_ms: Int,
 ) {
   process.sleep(interval_ms)
+  // TODO only update if state is playing
   update_playback_time(mpv, ui)
 
   update_playback_time_loop(mpv, ui, interval_ms)

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/internal.gleam

@@ -3,13 +3,23 @@ import gleam/io
 
 // https://en.wikipedia.org/wiki/ANSI_escape_code#Control_Sequence_Introducer_commands
 
+pub const move_to_home = "\u{001B}[H"
+
+pub const disable_auto_wrap = "\u{001B}[?7l"
+
+pub const enable_auto_wrap = "\u{001B}[?7h"
+
+pub fn update(frame: String) -> Nil {
+  io.print(disable_auto_wrap <> move_to_home <> frame <> enable_auto_wrap)
+}
+
 pub fn clear_screen() -> Nil {
   io.print("\u{001B}[2J\u{001B}[H")
 }
 
-pub fn print_at(text: String, x: Int, y: Int) -> Nil {
+pub fn chars_at(chars: String, x: Int, y: Int) -> String {
   let seq = "\u{001B}[" <> int.to_string(y) <> ";" <> int.to_string(x) <> "H"
-  io.print(seq <> text)
+  seq <> chars
 }
 
 pub fn hide_cursor() -> Nil {

src/musicplayer/ui/layout.gleam

@@ -1,37 +1,97 @@
 import gleam/dict
+import gleam/int
+import gleam/list
+import gleam/pair
+import gleam/set
+import gleam/string
 
-pub type Layout {
+import musicplayer/logging/logging
-  Layout(width: Int, height: Int, nodes: dict.Dict(Section, Node))
+import musicplayer/ui/internal
-}
+import musicplayer/ui/plot.{type Buffer}
+
+pub const root_section = "reserved_root_section"
 
 pub type Section {
-  Root
+  Section(String)
+
   Header
   Search
   PlaybackTime
 }
 
-pub type Node {
+pub type Dimension {
-  Node(content: String, x: Int, y: Int, children: List(Section))
+  Percent(width: Int, height: Int)
+  // TODO add Flex that flows
 }
 
-pub fn new() -> Layout {
+pub type Style {
-  let nodes =
+  Style(dimensions: Dimension)
-    dict.from_list([
+}
-      #(
-        Root,
-        Node(content: "", x: 0, y: 0, children: [
-          Header,
-          Search,
-          PlaybackTime,
-        ]),
-      ),
-      #(Header, Node(content: "Music Player", x: 1, y: 1, children: [])),
-      #(Search, Node(content: "", x: 30, y: 1, children: [])),
-      #(PlaybackTime, Node(content: "00:00", x: 1, y: 2, children: [])),
-    ])
 
-  Layout(0, 0, nodes: nodes)
+pub type Node {
+  Row(content: String, style: Style, children: List(Section))
+  Cell(content: String, style: Style)
+}
+
+pub type ViewIdx =
+  Int
+
+pub type View =
+  dict.Dict(Section, Node)
+
+// Layout consists of a list Views, and only one View is rendered at a time
+pub type Layout {
+  Layout(
+    columns: Int,
+    rows: Int,
+    current_view: ViewIdx,
+    views: dict.Dict(ViewIdx, View),
+  )
+}
+
+pub fn new(
+  columns: Int,
+  rows: Int,
+  views: List(List(#(Section, Node))),
+) -> Layout {
+  let views =
+    list.index_map(views, fn(view_nodes, i) { #(i, view_nodes) })
+    |> list.fold(dict.new(), fn(view_acc, iv) {
+      let #(i, view_nodes) = iv
+
+      dict.insert(view_acc, i, view_loop(i, view_nodes))
+    })
+
+  Layout(columns:, rows:, current_view: 0, views:)
+}
+
+fn view_loop(i: ViewIdx, view_nodes: List(#(Section, Node))) -> View {
+  let children =
+    view_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 =
+    view_nodes
+    |> list.map(pair.first)
+    |> list.filter(fn(node) { !set.contains(children, node) })
+
+  dict.from_list(view_nodes)
+  |> dict.insert(
+    Section(string.append("view_", string.inspect(i))),
+    Row(
+      content: "",
+      style: Style(dimensions: Percent(width: 100, height: 100)),
+      children: orphans,
+    ),
+  )
 }
 
 pub fn update_section(
@@ -39,20 +99,148 @@ pub fn update_section(
   section: Section,
   content: String,
 ) -> Layout {
-  case dict.get(layout.nodes, section) {
+  case dict.get(layout.views, layout.current_view) {
     Error(_) -> layout
-    Ok(node) ->
+    Ok(view) ->
-      Layout(
+      case dict.get(view, section) {
-        ..layout,
+        Error(_) -> layout
-        nodes: dict.insert(
+        Ok(node) -> {
-          layout.nodes,
+          let updated_node = case node {
-          section,
+            Cell(..) -> Cell(..node, content: content)
-          Node(..node, content: content),
+            Row(..) -> Row(..node, content: content)
-        ),
+          }
-      )
+
+          let updated_view = dict.insert(view, section, updated_node)
+
+          Layout(
+            ..layout,
+            views: dict.insert(layout.views, layout.current_view, updated_view),
+          )
+        }
+      }
   }
 }
 
-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 {
+  [layout.columns, layout.rows]
+  |> list.map(int.to_string)
+  |> string.join(" ")
+  |> string.append("layout - render: ", _)
+  |> logging.log
+
+  let context =
+    RenderContext(
+      parent_width: layout.columns,
+      parent_height: layout.rows,
+      parent_top_left_x: 1,
+      parent_top_left_y: 1,
+      position_index: 0,
+    )
+
+  case dict.get(layout.views, layout.current_view) {
+    Error(_) -> Nil
+    Ok(view) -> {
+      let buffer: Buffer = dict.new()
+
+      render_loop(
+        view,
+        context,
+        Section(string.append("view_", string.inspect(layout.current_view))),
+        buffer,
+      )
+      |> plot.flush_buffer(layout.columns, layout.rows)
+      |> internal.update
+    }
+  }
+}
+
+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_loop(
+  view: View,
+  context: RenderContext,
+  from: Section,
+  buffer: Buffer,
+) -> Buffer {
+  case dict.get(view, from) {
+    Error(_) -> buffer
+    Ok(node) -> {
+      // Margin between container and the node being rendered
+      let margin = 2
+
+      let #(node_width, node_height) = case node.style.dimensions {
+        Percent(width:, height:) -> {
+          let width = { context.parent_width * width } / 100
+          let height = { context.parent_height * height } / 100
+
+          #(width, height)
+        }
+      }
+
+      // Check if this node should be placed to the left or below the parent
+      let #(node_top_left_x, node_top_left_y) = case node {
+        Row(..) -> #(
+          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 =
+        plot.box(
+          buffer,
+          node_top_left_x,
+          node_top_left_y,
+          node_width,
+          node_height,
+        )
+        |> plot.text(node.content, node_top_left_x, node_top_left_y)
+
+      case node {
+        Cell(..) -> parent
+        Row(children:, ..) -> {
+          list.index_map(children, fn(child, i) { #(i, child) })
+          |> list.fold(parent, fn(acc_buffer, ic) {
+            let #(i, child) = ic
+
+            let #(child_width, child_height) = case node.style.dimensions {
+              Percent(width:, height:) -> {
+                let width = { { context.parent_width * width } / 100 } - margin
+                let height =
+                  { { context.parent_height * height } / 100 } - margin
+
+                #(width, height)
+              }
+            }
+
+            let context =
+              RenderContext(
+                parent_width: child_width,
+                parent_height: child_height,
+                parent_top_left_x: context.parent_top_left_x + 1,
+                parent_top_left_y: context.parent_top_left_y + 1,
+                position_index: i,
+              )
+
+            render_loop(view, context, child, acc_buffer)
+          })
+        }
+      }
+    }
+  }
 }

src/musicplayer/ui/layout_examples/layout_examples.gleam

@@ -0,0 +1,58 @@
+import musicplayer/ui/internal
+import musicplayer/ui/layout.{Percent, Section, Style}
+import musicplayer/ui/layout_examples/wait_for_input.{wait_for_input}
+
+pub fn main() {
+  let assert Ok(columns) = internal.io_get_columns()
+  let assert Ok(rows) = internal.io_get_rows()
+
+  two_rows_with_cells(columns, rows)
+  |> layout.render
+
+  wait_for_input()
+}
+
+/// Two rows:
+/// First row has two cells
+/// Second row has no cells
+fn two_rows_with_cells(columns: Int, rows: Int) -> layout.Layout {
+  let views = [
+    [
+      #(
+        Section("Row1"),
+        layout.Row(
+          content: "row 1",
+          style: Style(dimensions: Percent(width: 100, height: 50)),
+          children: [
+            Section("A"),
+            Section("B"),
+          ],
+        ),
+      ),
+      #(
+        Section("A"),
+        layout.Cell(
+          content: "cell 1",
+          style: Style(dimensions: Percent(width: 50, height: 50)),
+        ),
+      ),
+      #(
+        Section("B"),
+        layout.Cell(
+          content: "cell 2",
+          style: Style(dimensions: Percent(width: 50, height: 50)),
+        ),
+      ),
+      #(
+        Section("Row2"),
+        layout.Row(
+          content: "row 2",
+          style: Style(dimensions: Percent(width: 50, height: 50)),
+          children: [],
+        ),
+      ),
+    ],
+  ]
+
+  layout.new(columns, rows, views)
+}

src/musicplayer/ui/layout_examples/wait_for_input.gleam

@@ -0,0 +1,15 @@
+import gleam/erlang/process.{type Name}
+
+import musicplayer/input/input
+import musicplayer/input/key.{type Key}
+
+pub fn wait_for_input() {
+  let input_keys_name: Name(Key) = process.new_name("input_keys")
+  let assert Ok(_) = process.register(process.self(), input_keys_name)
+
+  input.new(input_keys_name)
+
+  process.new_selector()
+  |> process.select(process.named_subject(input_keys_name))
+  |> process.selector_receive_forever
+}

src/musicplayer/ui/plot.gleam

@@ -0,0 +1,71 @@
+import gleam/dict.{type Dict}
+import gleam/list
+import gleam/string
+
+pub type Buffer =
+  Dict(#(Int, Int), String)
+
+pub fn flush_buffer(buffer: Buffer, columns: Int, rows: Int) -> String {
+  list.range(1, rows)
+  |> list.map(fn(y) {
+    list.range(1, columns)
+    |> list.map(fn(x) {
+      case dict.get(buffer, #(x, y)) {
+        Ok(char) -> char
+        Error(_) -> " "
+      }
+    })
+    |> string.join("")
+  })
+  |> string.join("\r\n")
+}
+
+pub fn text(buffer: Buffer, text: String, x: Int, y: Int) -> Buffer {
+  text
+  |> string.to_graphemes
+  |> list.index_fold(buffer, fn(acc, char, i) {
+    dict.insert(acc, #(x + i, y), char)
+  })
+}
+
+pub fn box(buffer: Buffer, x: Int, y: Int, width: Int, height: Int) -> Buffer {
+  let box_chars = #("┌", "┐", "└", "┘", "─", "│")
+  let #(tl, tr, bl, br, hor, ver) = box_chars
+
+  case width < 2 || height < 2 {
+    True -> buffer
+    False -> {
+      buffer
+      |> dict.insert(#(x, y), tl)
+      |> dict.insert(#(x + width - 1, y), tr)
+      |> dict.insert(#(x, y + height - 1), bl)
+      |> dict.insert(#(x + width - 1, y + height - 1), br)
+      |> horizontal_line(x + 1, y, width - 2, hor)
+      |> horizontal_line(x + 1, y + height - 1, width - 2, hor)
+      |> vertical_line(x, y + 1, height - 2, ver)
+      |> vertical_line(x + width - 1, y + 1, height - 2, ver)
+    }
+  }
+}
+
+fn horizontal_line(
+  buffer: Buffer,
+  x: Int,
+  y: Int,
+  len: Int,
+  char: String,
+) -> Buffer {
+  list.range(0, len - 1)
+  |> list.fold(buffer, fn(acc, i) { dict.insert(acc, #(x + i, y), char) })
+}
+
+fn vertical_line(
+  buffer: Buffer,
+  x: Int,
+  y: Int,
+  len: Int,
+  char: String,
+) -> Buffer {
+  list.range(0, len - 1)
+  |> list.fold(buffer, fn(acc, i) { dict.insert(acc, #(x, y + i), char) })
+}

src/musicplayer/ui/ui.gleam

@@ -1,4 +1,3 @@
-import gleam/dict
 import gleam/erlang/process.{type Subject}
 import gleam/int
 import gleam/list
@@ -7,8 +6,8 @@ import gleam/string
 
 import musicplayer/logging/logging
 import musicplayer/ui/control.{type Control}
-import musicplayer/ui/internal as ui_internal
+import musicplayer/ui/internal
-import musicplayer/ui/layout.{type Layout, type Section}
+import musicplayer/ui/layout.{type Layout}
 
 pub type State(redraw, content) {
   State(redraw: Subject(Layout), layout: Layout)
@@ -18,7 +17,45 @@ 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))
@@ -36,10 +73,10 @@ pub fn new() -> Result(Subject(Control), String) {
       process.spawn(fn() {
         let assert Ok(_) = process.register(process.self(), redraw_name)
 
-        ui_internal.clear_screen()
+        internal.clear_screen()
-        ui_internal.hide_cursor()
+        internal.hide_cursor()
 
-        redraw_on_update_loop(redraw)
+        redraw_loop(redraw)
       })
 
       Ok(ui)
@@ -52,54 +89,49 @@ 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
 
-          actor.continue(
+          let layout = layout.update_dimensions(state.layout, columns, rows)
-            State(
+
-              ..state,
+          process.send(state.redraw, layout)
-              layout: layout.update_dimensions(state.layout, width, height),
+          actor.continue(State(..state, layout:))
-            ),
-          )
         }
       }
     }
     control.UpdateState(section, content) -> {
       let layout = layout.update_section(state.layout, section, content)
-      let state = State(..state, layout:)
 
       actor.send(state.redraw, layout)
-      actor.continue(state)
+      actor.continue(State(..state, layout:))
     }
 
     control.Exit(reply_to) -> {
-      ui_internal.show_cursor()
+      internal.show_cursor()
       process.send(reply_to, Nil)
       actor.stop()
     }
   }
 }
 
-fn redraw_on_update_loop(redraw: Subject(Layout)) -> Nil {
+fn redraw_loop(redraw: Subject(Layout)) -> Nil {
-  let layout = process.receive_forever(redraw)
+  process.receive_forever(redraw)
+  |> layout.render
 
-  ui_internal.clear_screen()
+  redraw_loop(redraw)
-  render_layout(layout, layout.Root)
-
-  redraw_on_update_loop(redraw)
 }
 
 fn update_dimensions_on_interval(ui: Subject(Control), interval_ms: Int) {
-  case ui_internal.io_get_columns(), ui_internal.io_get_rows() {
+  case internal.io_get_columns(), internal.io_get_rows() {
     Ok(width), Ok(height) -> {
       process.send(ui, control.UpdateDimensions(width, height))
     }
@@ -109,13 +141,3 @@ fn update_dimensions_on_interval(ui: Subject(Control), interval_ms: Int) {
   process.sleep(interval_ms)
   update_dimensions_on_interval(ui, interval_ms)
 }
-
-fn render_layout(layout: Layout, from: Section) -> Nil {
-  case dict.get(layout.nodes, from) {
-    Error(_) -> Nil
-    Ok(node) -> {
-      list.each(node.children, fn(child) { render_layout(layout, child) })
-      ui_internal.print_at(node.content, node.x, node.y)
-    }
-  }
-}

test/musicplayer/mpv/mpv_test.gleam

@@ -1,6 +1,6 @@
 import gleeunit
 
-import musicplayer/mpv/internal as control_internal
+import musicplayer/mpv/internal
 
 pub fn main() -> Nil {
   gleeunit.main()
@@ -10,6 +10,6 @@ pub fn parse_playback_time_test() {
   let json_string =
     "{\"data\":\"123.456789\",\"request_id\":0,\"error\":\"success\"}\n"
 
-  let assert Ok(data) = control_internal.parse_playback_time(json_string)
+  let assert Ok(data) = internal.parse_playback_time(json_string)
   assert data == 123.456789
 }

test/musicplayer/ui/layout_test.gleam

@@ -0,0 +1,116 @@
+import gleam/dict
+import gleam/io
+import gleam/string
+import gleeunit
+import gleeunit/should
+
+import musicplayer/ui/layout.{Percent, RenderContext, Section, Style}
+import musicplayer/ui/plot
+
+pub fn main() -> Nil {
+  gleeunit.main()
+}
+
+pub fn percent_layout_test() {
+  let views = [
+    [
+      #(
+        Section("Row1"),
+        layout.Row(
+          content: "row 1",
+          style: Style(dimensions: Percent(width: 100, height: 50)),
+          children: [
+            Section("A"),
+            Section("B"),
+          ],
+        ),
+      ),
+      #(
+        Section("A"),
+        layout.Cell(
+          content: "cell 1",
+          style: Style(dimensions: Percent(width: 50, height: 100)),
+        ),
+      ),
+      #(
+        Section("B"),
+        layout.Cell(
+          content: "cell 2",
+          style: Style(dimensions: Percent(width: 50, height: 100)),
+        ),
+      ),
+      #(
+        Section("Row2"),
+        layout.Row(
+          content: "row 1",
+          style: Style(dimensions: Percent(width: 100, height: 50)),
+          children: [],
+        ),
+      ),
+    ],
+  ]
+
+  let columns = 80
+  let rows = 20
+  let layout = layout.new(columns, rows, views)
+
+  let expected =
+    "
+┌──────────────────────────────────────────────────────────────────────────────┐
+│row 1────────────────────────────────────────────────────────────────────────┐│
+││cell 1───────────────────────────────┐cell 2───────────────────────────────┐││
+│││                                    ││                                    │││
+│││                                    ││                                    │││
+│││                                    ││                                    │││
+│││                                    ││                                    │││
+│││                                    ││                                    │││
+││└────────────────────────────────────┘└────────────────────────────────────┘││
+│└────────────────────────────────────────────────────────────────────────────┘│
+│row 1────────────────────────────────────────────────────────────────────────┐│
+││                                                                            ││
+││                                                                            ││
+││                                                                            ││
+││                                                                            ││
+││                                                                            ││
+││                                                                            ││
+││                                                                            ││
+│└────────────────────────────────────────────────────────────────────────────┘│
+└──────────────────────────────────────────────────────────────────────────────┘
+"
+    |> string.replace(each: "\n", with: "\r\n")
+    |> string.trim
+
+  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 assert Ok(view) = dict.get(layout.views, layout.current_view)
+
+  let flushed =
+    layout.render_loop(
+      view,
+      context,
+      Section(string.append("view_", string.inspect(layout.current_view))),
+      dict.new(),
+    )
+    |> plot.flush_buffer(layout.columns, layout.rows)
+
+  case flushed == expected {
+    True -> Nil
+    False -> {
+      io.println("Test failed")
+      io.println("Expected:")
+      io.println(string.trim(expected))
+
+      io.println("Got:")
+      io.println(flushed)
+
+      should.equal(flushed, expected)
+    }
+  }
+}