feat: add basic hide function

Reviewed-on: #26

.gitea/workflows/ci.yaml

@@ -14,7 +14,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install tytanic
-        run: cargo binstall tytanic@0.2.2
+        run: cargo binstall tytanic@0.3.3
 
       - name: Run test suite
         run: tt run

README.md

@@ -15,7 +15,7 @@ This package lets you render sequence diagrams directly in Typst. The following
 <td>
 
 ```typst
-#import "@preview/chronos:0.2.2"
+#import "@preview/chronos:0.3.0"
 #chronos.diagram({
   import chronos: *
   _par("Alice")

gallery/example2.typ

@@ -4,7 +4,7 @@
 #chronos.diagram({
   import chronos: *
   _seq("User", "A", comment: "DoWork", enable-dst: true)
-  _seq("A", "B", comment: [#sym.quote.angle.l createRequest #sym.quote.angle.r], enable-dst: true)
+  _seq("A", "B", comment: [#sym.quote.chevron.l createRequest #sym.quote.chevron.r], enable-dst: true)
   _seq("B", "C", comment: "DoWork", enable-dst: true)
   _seq("C", "B", comment: "WorkDone", destroy-src: true, disable-src: true, dashed: true)
   _seq("B", "A", comment: "RequestCreated", disable-src: true, dashed: true)
@@ -15,7 +15,7 @@
   import chronos: *
   _seq("User", "A", comment: "DoWork", enable-dst: true, lifeline-style: (fill: rgb("#FFBBBB")))
   _seq("A", "A", comment: "Internal call", enable-dst: true, lifeline-style: (fill: rgb("#E9967A")))
-  _seq("A", "B", comment: [#sym.quote.angle.l createRequest #sym.quote.angle.r], enable-dst: true)
+  _seq("A", "B", comment: [#sym.quote.chevron.l createRequest #sym.quote.chevron.r], enable-dst: true)
   _seq("B", "A", comment: "RequestCreated", disable-src: true, disable-dst: true, dashed: true)
   _seq("A", "User", comment: "Done", disable-src: true)
 })

justfile

@@ -4,6 +4,13 @@
 gallery_dir := "./gallery"
 set shell := ["bash", "-uc"]
 
+@version:
+  echo $'\e[1mTypst:\e[0m'
+  typst --version
+  echo
+  echo $'\e[1mTytanic:\e[0m'
+  tt util about
+
 manual:
   typst c manual.typ manual.pdf
 

src/cetz.typ

@@ -1 +1 @@
-#import "@preview/cetz:0.4.0": *
+#import "@preview/cetz:0.4.2": *

src/core/draw/hide.typ

@@ -0,0 +1,15 @@
+#import "/src/core/utils.typ": get-ctx, set-ctx
+
+#let render(sync) = get-ctx(ctx => {
+  set-ctx(c => {
+    c.hidden = true
+    return c
+  })
+})
+
+#let render-end(sync) = get-ctx(ctx => {
+  set-ctx(c => {
+    c.hidden = false
+    return c
+  })
+})

src/core/draw/sync.typ

@@ -4,52 +4,62 @@
 #let render(sync) = get-ctx(ctx => {
   set-ctx(c => {
     c.sync = (
+      ctx: ctx,
       bottoms: (),
       starts: (),
-      y: ctx.y
+      start-y: ctx.y,
+      align-y: ctx.y
     )
+    c.in-sync = true
     return c
   })
+})
 
-  // Compute heights
-  for e in sync.elmts {
-    assert(is-elmt(e), message: "Sync element can only contain chronos elements, found " + repr(e))
-    assert(
-      e.type == "seq",
-      message: "Sync element can only contain sequences, found '" + e.type + "'"
-    )
-
+#let in-sync-render(elmt) = {
   set-ctx(c => {
-      c.y = ctx.y
+    c.y = c.sync.start-y
     return c
   })
   draw.hide({
-      (e.draw)(e)
+    (elmt.draw)(elmt)
   })
   set-ctx(c => {
     c.sync.starts.push(c.last-drawn.start-info.y)
     c.sync.bottoms.push(c.y)
     return c
   })
+}
+
+#let render-end(sync) = get-ctx(ctx => {
+  for e in sync.elmts {
+    assert(is-elmt(e), message: "Sync element can only contain chronos elements, found " + repr(e))
+    assert(
+      e.type == "seq",
+      message: "Sync element can only contain sequences, found '" + e.type + "'"
+    )
   }
 
   set-ctx(c => {
-    c.sync-y = calc.min(..c.sync.starts)
-    return c
+    let new-sync = c.sync
+    if new-sync.starts.len() != 0 {
+      new-sync.align-y = calc.min(..new-sync.starts)
+    }
+    new-sync.remove("ctx")
+    return c.sync.ctx + (sync: new-sync)
   })
 
-  // Draw aligned elements
   for (i, e) in sync.elmts.enumerate() {
     set-ctx(c => {
-      let dy = c.sync.starts.at(i) - ctx.y
-      c.y = c.sync-y - dy
+      let dy = c.sync.starts.at(i) - c.sync.start-y
+      c.y = c.sync.align-y - dy
       return c
     })
     (e.draw)(e)
   }
 
   set-ctx(c => {
-    c.y = calc.min(..c.sync.bottoms)
+    let heights = c.sync.starts.zip(c.sync.bottoms).map(((s, b)) => b - s)
+    c.y = c.sync.align-y + calc.min(..heights)
     c.remove("sync")
     return c
   })

src/core/renderer.typ

@@ -2,6 +2,7 @@
 
 #import "draw/note.typ": get-box as get-note-box, get-size as get-note-size
 #import "draw/participant.typ"
+#import "draw/sync.typ": in-sync-render
 #import "utils.typ": *
 #import "/src/consts.typ": *
 
@@ -15,22 +16,6 @@
   })
 }
 
-#let unwrap-syncs(elements) = {
-  let i = 0
-  while i < elements.len() {
-    let elmt = elements.at(i)
-    if elmt.type == "sync" {
-      elements = (
-        elements.slice(0, i + 1) +
-        elmt.elmts +
-        elements.slice(i + 1)
-      )
-    }
-    i += 1
-  }
-  return elements
-}
-
 #let seq-update-lifelines(participants, pars-i, seq) = {
   let participants = participants
   let com = if seq.comment == none {""} else {seq.comment}
@@ -308,7 +293,6 @@
 
 #let compute-columns-width(participants, elements, pars-i) = {
   elements = elements.filter(is-elmt)
-  elements = unwrap-syncs(elements)
 
   let cells
   (participants, elements, cells) = compute-max-lifeline-levels(participants, elements, pars-i)
@@ -334,7 +318,9 @@
     lifelines: participants.map(_ => (
       level: 0,
       lines: ()
-    ))
+    )),
+    in-sync: false,
+    hidden: false,
   )
   chronos-ctx.insert(
     "widths",
@@ -393,8 +379,18 @@
     if not is-elmt(elmt) {
       (elmt,)
     } else if "draw" in elmt and elmt.type != "par" {
+      get-ctx(ctx => {
+        let drawn = if ctx.in-sync and elmt.type != "sync-end" {
+          in-sync-render(elmt)
+        } else {
           (elmt.draw)(elmt)
         }
+        if ctx.hidden and elmt.type != "hide-end" {
+          drawn = draw.hide(drawn)
+        }
+        drawn
+      })
+    }
   }
 
   set-ctx(ctx => {

src/core/setup.typ

@@ -1,4 +1,6 @@
 #import "draw/group.typ": render-end as grp-render-end
+#import "draw/hide.typ": render-end as hide-render-end
+#import "draw/sync.typ": render-end as sync-render-end
 #import "utils.typ": get-group-span, is-elmt
 #import "/src/participant.typ": _exists as par-exists, _par
 #import "/src/sequence.typ": _seq
@@ -18,6 +20,39 @@
   )
 }
 
+#let flatten-sync(elmts, i) = {
+  let sync = elmts.at(i)
+  elmts.at(i) = sync
+  let start = sync
+  start.remove("elmts")
+  return (
+    elmts.slice(0, i) +
+    (start,) +
+    sync.elmts +
+    ((
+      type: "sync-end",
+      draw: sync-render-end,
+      elmts: sync.elmts
+    ),) +
+    elmts.slice(i + 1)
+  )
+}
+
+#let flatten-hide(elmts, i) = {
+  let hide = elmts.at(i)
+  elmts.at(i) = hide
+  return (
+    elmts.slice(0, i + 1) +
+    hide.elmts +
+    ((
+      type: "hide-end",
+      draw: hide-render-end,
+      start-i: i
+    ),) +
+    elmts.slice(i+1)
+  )
+}
+
 #let update-group-children(elmts, i) = {
   let elmts = elmts
   let group-end = elmts.at(i)
@@ -59,6 +94,12 @@
     if elmt.type == "grp" {
       elmts = flatten-group(elmts, i)
     
+    } else if elmt.type == "sync" {
+      elmts = flatten-sync(elmts, i)
+    
+    } else if elmt.type == "hide" {
+      elmts = flatten-hide(elmts, i)
+
     } else if elmt.type == "seq" {
       if elmt.enable-dst {
         activation-history.push(elmt)

src/core/utils.typ

@@ -42,7 +42,7 @@
       let (i0, i1) = get-group-span(participants, elmt)
       min-i = calc.min(min-i, i0)
       max-i = calc.max(max-i, i1)
-    } else if elmt.type == "sync" {
+    } else if elmt.type == "sync-end" {
       let (i0, i1) = get-group-span(participants, elmt)
       min-i = calc.min(min-i, i0)
       max-i = calc.max(max-i, i1)

src/lib.typ

@@ -1,8 +1,8 @@
-#let version = version(0, 2, 2)
+#let version = version(0, 3, 0)
 #import "diagram.typ": diagram, from-plantuml
 
 #import "sequence.typ": _seq, _ret
 #import "group.typ": _grp, _loop, _alt, _opt, _break
 #import "participant.typ": _par
-#import "misc.typ": _sep, _delay, _sync, _gap, _evt, _col
+#import "misc.typ": _sep, _delay, _sync, _gap, _evt, _col, _hide
 #import "note.typ": _note

src/misc.typ

@@ -1,5 +1,6 @@
 #import "core/draw/delay.typ"
 #import "core/draw/event.typ": render as evt-render
+#import "core/draw/hide.typ"
 #import "core/draw/separator.typ"
 #import "core/draw/sync.typ"
 #import "core/utils.typ": set-ctx
@@ -63,3 +64,11 @@
     max-width: max-width
   ),)
 }
+
+#let _hide(elmts) = {
+  return ((
+    type: "hide",
+    draw: hide.render,
+    elmts: elmts
+  ),)
+}

tests/sequence/sync/test.typ

@@ -35,3 +35,13 @@
     _seq("b", "b")
   })
 })
+
+#pagebreak()
+
+#diagram({
+  _sync({
+    _seq("a", "b", comment: [Abcdefgh])
+    _seq("b", "c", comment: [Foo\ bar], slant: 10)
+    _seq("c", "c", slant: 20)
+  })
+})

typst.toml

@@ -1,7 +1,7 @@
 [package]
 name = "chronos"
-version = "0.2.2"
-compiler = "0.13.1"
+version = "0.3.0"
+compiler = "0.14.2"
 repository = "https://git.kb28.ch/HEL/chronos"
 entrypoint = "src/lib.typ"
 authors = [