Merge pull request 'v0.2.0: Updates' (#5) from dev into main

Reviewed-on: HEL/circuiteria#5

README.md

@@ -56,7 +56,7 @@ For more information, see the [manual](manual.pdf)
 
 To use this package, simply import [circuiteria](https://typst.app/universe/package/circuiteria) and call the `circuit` function:
 ```typ
-#import "@preview/circuiteria:0.1.0"
+#import "@preview/circuiteria:0.2.0"
 #circuiteria.circuit({
   import circuiteria: *
   ...

doc/example.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "../src/circuit.typ": circuit
 #import "../src/util.typ"
 

gallery.bash

@@ -1,40 +0,0 @@
-#!/bin/bash
-
-PDFS=false
-
-while getopts "p" flag
-do
-    case "${flag}" in
-        p) PDFS=true;;
-    esac
-done
-
-echo "Generating gallery images"
-
-set -- ./gallery/*.typ
-cnt="$#"
-i=1
-for f
-do
-    f2="${f/typ/png}"
-    echo "($i/$cnt) $f -> $f2"
-    typst c --root ./ "$f" "$f2"
-    i=$((i+1))
-done
-
-if [ "$PDFS" = true ]
-then
-    echo
-    echo "Generating gallery PDFs"
-
-    set -- ./gallery/*.typ
-    cnt="$#"
-    i=1
-    for f
-    do
-        f2="${f/typ/pdf}"
-        echo "($i/$cnt) $f -> $f2"
-        typst c --root ./ "$f" "$f2"
-        i=$((i+1))
-    done
-fi

gallery/test3.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "../src/lib.typ": circuit, element, util, wire
 
 #set page(width: auto, height: auto, margin: .5cm)

gallery/test4.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "../src/lib.typ": *
 
 #set page(width: auto, height: auto, margin: .5cm)

gallery/test5.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "../src/lib.typ": *
 
 #set page(width: auto, height: auto, margin: .5cm)

gallery/test6.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw, vector
+#import "@preview/cetz:0.3.2": draw, vector
 #import "../src/lib.typ": *
 
 #set page(width: auto, height: auto, margin: .5cm)

justfile

@@ -0,0 +1,11 @@
+# Local Variables:
+# mode: makefile
+# End:
+gallery_dir := "./gallery"
+set shell := ["bash", "-uc"]
+
+manual:
+  typst c manual.typ manual.pdf
+
+gallery:
+  for f in "{{gallery_dir}}"/*.typ; do typst c --root . "$f" "${f%typ}png"; done

manual.typ

@@ -1,5 +1,5 @@
-#import "@preview/tidy:0.3.0"
-#import "@preview/cetz:0.2.2": draw, canvas
+#import "@preview/tidy:0.4.1"
+#import "@preview/cetz:0.3.2": draw, canvas
 #import "src/lib.typ"
 #import "doc/examples.typ"
 #import "src/circuit.typ": circuit
@@ -12,7 +12,7 @@
   numbering("1.1", ..num)
 })
 #{
-  outline(indent: true, depth: 3)
+  outline(indent: auto, depth: 3)
 }
 
 #show link: set text(blue)
@@ -47,7 +47,7 @@
 
 #set page(numbering: "1/1", header: align(right)[circuiteria #sym.dash.em v#lib.version])
 #set page(
-  header: locate(loc => {
+  header: context {
     let txt = [circuiteria #sym.dash.em v#lib.version]
     let cnt = counter(heading)
     let cnt-val = cnt.get()
@@ -65,8 +65,8 @@
         #rect(width: 100%, height: .5em, radius: .25em, stroke: none, fill: util.colors.values().at(i))
       ]
     )
-  }),
-  footer: locate(loc => {
+  },
+  footer: context {
     let cnt = counter(heading)
     let cnt-val = cnt.get()
     if cnt-val.len() < 2 { return }
@@ -80,12 +80,12 @@
       ],
       counter(page).display("1/1", both: true)
     )
-  })
+  }
 )
 
 #let doc-ref(target, full: false, var: false) = {
   let (module, func) = target.split(".")
-  let label-name = module + func
+  let label-name = module + "-" + func
   let display-name = func
   if full {
     display-name = target
@@ -94,7 +94,7 @@
     label-name += "()"
     display-name += "()"
   }
-  link(label(label-name))[#display-name]
+  link(label(label-name), raw(display-name))
 }
 
 = Introduction
@@ -103,11 +103,21 @@ This package provides a way to make beautiful block circuit diagrams using the C
 
 = Usage
 
-Simply import #link("src/lib.typ") and call the `circuit` function:
+Simply import Circuiteria and call the `circuit` function:
 #pad(left: 1em)[```typ
-#import "src/lib.typ"
-#lib.circuit({
-  import lib: *
+#import "@preview/circuiteria:0.2.0"
+#circuiteria.circuit({
+  import circuiteria: *
+  ...
+})
+```]
+
+== Project installation
+If you have installed Circuiteria directly in your project, import #link("src/lib.typ") and call the `circuit` function:
+#pad(left: 1em)[```typ
+#import "src/lib.typ" as circuiteria
+#circuiteria.circuit({
+  import circuiteria: *
   ...
 })
 ```]
@@ -117,6 +127,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
 #let circuit-docs = tidy.parse-module(
   read("src/circuit.typ"),
   name: "circuit",
+  old-syntax: true,
   require-all-parameters: true
 )
 #tidy.show-module(circuit-docs)
@@ -126,6 +137,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
 #let util-docs = tidy.parse-module(
   read("src/util.typ"),
   name: "util",
+  old-syntax: true,
   require-all-parameters: true,
   scope: (
     util: util,
@@ -140,6 +152,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
 #let wire-docs = tidy.parse-module(
   read("src/wire.typ"),
   name: "wire",
+  old-syntax: true,
   require-all-parameters: true,
   scope: (
     wire: wire,
@@ -161,6 +174,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
   read("src/elements/multiplexer.typ") + "\n" +
   read("src/elements/group.typ"),
   name: "element",
+  old-syntax: true,
   scope: (
     element: element,
     circuit: circuit,
@@ -183,6 +197,7 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
   read("src/elements/logic/or.typ") + "\n" +
   read("src/elements/logic/xor.typ"),
   name: "gates",
+  old-syntax: true,
   scope: (
     element: element,
     circuit: circuit,

src/circuit.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": canvas
+#import "@preview/cetz:0.3.2": canvas
 #import "@preview/tidy:0.3.0"
 
 /// Draws a block circuit diagram
@@ -9,6 +9,6 @@
 /// - length (length, ratio): Optional base unit
 /// -> none
 #let circuit(body, length: 2em) = {
-  // set text(font: "Source Sans 3")
+  set text(font: "Source Sans 3")
   canvas(length: length, body)
 }

src/elements/alu.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "element.typ"
 #import "ports.typ": add-port
 

src/elements/block.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "element.typ"
 
 #let draw-shape(id, tl, tr, br, bl, fill, stroke) = {

src/elements/element.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw, coordinate
+#import "@preview/cetz:0.3.2": draw, coordinate
 #import "ports.typ": add-ports, add-port
 #import "../util.typ"
 
@@ -88,15 +88,26 @@
     if to-side in ports-margins {
       margins = ports-margins.at(to-side)
     }
-    let used-pct = 100% - margins.at(0) - margins.at(1)
-    let used-height = height * used-pct / 100%
-    let top-margin = height * margins.at(0) / 100%
-    
-    let dy = used-height * (i + 1) / (ports.at(to-side).len() + 1)
 
-    if not auto-ports {
+    let dy
+    let top-margin
+    if to-side in ("east", "west") {
+      let used-pct = 100% - margins.at(0) - margins.at(1)
+      let used-height = height * used-pct / 100%
+      top-margin = height * margins.at(0) / 100%
+      
+      dy = used-height * (i + 1) / (ports.at(to-side).len() + 1)
+
+      if not auto-ports {
+        top-margin = 0
+        dy = ports-y.at(to)(height)
+      }
+    } else if to-side == "north" {
+      dy = 0
+      top-margin = 0
+    } else if to-side == "south" {
+      dy = height
       top-margin = 0
-      dy = ports-y.at(to)(height)
     }
     
     let (ctx, from-pos) = coordinate.resolve(ctx, from)

src/elements/extender.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "element.typ"
 #import "ports.typ": add-port
 

src/elements/group.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw, coordinate
+#import "@preview/cetz:0.3.2": draw, coordinate
 #import "../util.typ"
 
 /// Draws a group of elements

src/elements/logic/and.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "gate.typ"
 
 #let draw-shape(id, tl, tr, br, bl, fill, stroke) = {

src/elements/logic/buf.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "gate.typ"
 
 #let draw-shape(id, tl, tr, br, bl, fill, stroke) = {

src/elements/logic/gate.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw, coordinate
+#import "@preview/cetz:0.3.2": draw, coordinate
 #import "../ports.typ": add-ports, add-port
 #import "../element.typ"
 
@@ -54,24 +54,20 @@
     let (ctx, to-pos) = coordinate.resolve(ctx, (rel: (offset, 0), to: to))
     x = to-pos.at(0)
   }
-
+  
   if (type(y) == dictionary) {
-    let offset = y.rel
+    let from = y.from
     let to = y.to
-    let (ctx, to-pos) = coordinate.resolve(ctx, (rel: (0, offset), to: to))
-    y = to-pos.at(1)
-    // let from = y.from
-    // let to = y.to
-
-    // let dy
-    // if to == "out" {
-    //   dy = height / 2
-    // } else {
-    //   dy = height * (i + 0.5) / inputs
-    // }
-
-    // let (ctx, from-pos) = coordinate.resolve(ctx, from)
-    // y = from-pos.at(1) + dy - height
+    
+    let dy
+    if to == "out" {
+      dy = height / 2
+    } else {
+      dy = height * (i + 0.5) / inputs
+    }
+    
+    let (ctx, from-pos) = coordinate.resolve(ctx, from)
+    y = from-pos.at(1) + dy - height
   }
 
   let tl = (x, y + height)

src/elements/logic/or.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "gate.typ"
 
 #let draw-shape(id, tl, tr, br, bl, fill, stroke) = {

src/elements/logic/xor.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "gate.typ"
 
 #let space = 10%

src/elements/multiplexer.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "../util.typ"
 #import "element.typ"
 #import "ports.typ": add-port

src/elements/ports.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw
+#import "@preview/cetz:0.3.2": draw
 #import "../util.typ": rotate-anchor
 
 #let add-port(

src/lib.typ

@@ -1,4 +1,4 @@
-#let version = version(0, 1, 0)
+#let version = version(0, 2, 0)
 
 #import "circuit.typ": circuit
 #import "element.typ"

src/wire.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.2.2": draw, coordinate
+#import "@preview/cetz:0.3.2": draw, coordinate
 #import "util.typ": opposite-anchor
 
 /// List of valid wire styles
@@ -19,7 +19,7 @@
 #let get-direct-wire(pts) = {
   let anchors = (
     "start": pts.first(),
-    "end": pts.last(),
+    "end": pts.last()
   )
   return (pts, anchors)
 }
@@ -38,21 +38,21 @@
       start,
       (horizontal: mid, vertical: ()),
       (horizontal: (), vertical: end),
-      end,
+      end
     )
   } else {
     (
       start,
       (horizontal: (), vertical: mid),
       (horizontal: end, vertical: ()),
-      end,
+      end
     )
   }
   let anchors = (
     "start": start,
     "zig": points.at(1),
     "zag": points.at(2),
-    "end": end,
+    "end": end
   )
   return (points, anchors)
 }
@@ -65,7 +65,7 @@
 
   let p1 = (start, margin-start, end)
   let p2 = (end, margin-end, start)
-
+  
   let (ctx, p0) = coordinate.resolve(ctx, start)
   let (ctx, p3) = coordinate.resolve(ctx, end)
   p0 = (x: p0.first(), y: p0.last())
@@ -73,7 +73,7 @@
 
   let dx1 = margin-start
   let dx2 = margin-end
-
+  
   if type(margin-start) == ratio {
     dx1 = calc.abs(p3.x - p0.x) * margin-start / 100%
   }
@@ -95,7 +95,7 @@
     (horizontal: (), vertical: (0, dodge-y)),
     (horizontal: p2, vertical: ()),
     (horizontal: (), vertical: end),
-    end,
+    end
   )
   let anchors = (
     "start": start,
@@ -103,7 +103,7 @@
     "dodge-start": points.at(2),
     "dodge-end": points.at(3),
     "end2": points.at(4),
-    "end": end,
+    "end": end
   )
 
   return (points, anchors)
@@ -128,8 +128,7 @@
 /// - dodge-sides (array): The start and end sides (going out of the connected element) of the wire (only with style "dodge")
 /// - dodge-margins (array): The start and end margins (i.e. space before dodging) of the wire (only with style "dodge")
 #let wire(
-  id,
-  pts,
+  id, pts,
   bus: false,
   name: none,
   name-pos: "middle",
@@ -144,7 +143,7 @@
   zigzag-dir: "vertical",
   dodge-y: 0,
   dodge-sides: ("east", "west"),
-  dodge-margins: (5%, 5%),
+  dodge-margins: (5%, 5%)
 ) = draw.get-ctx(ctx => {
   if not style in wire-styles {
     panic("Invalid wire style '" + style + "'")
@@ -153,14 +152,10 @@
   if pts.len() != 2 {
     panic("Wrong number of points (got " + str(pts.len()) + " instead of 2)")
   }
-
+  
   let stroke = (
     paint: color,
-    thickness: if bus {
-      bus-width
-    } else {
-      signal-width
-    },
+    thickness: if bus {bus-width} else {signal-width}
   )
   if dashed {
     stroke.insert("dash", "dashed")
@@ -171,17 +166,17 @@
 
   if style == "direct" {
     (points, anchors) = get-direct-wire(pts)
-
+    
   } else if style == "zigzag" {
     (points, anchors) = get-zigzag-wire(pts, zigzag-ratio, zigzag-dir)
-
+    
   } else if style == "dodge" {
     (points, anchors) = get-dodge-wire(
       pts,
       dodge-y,
       dodge-margins,
       dodge-sides,
-      ctx,
+      ctx
     )
   }
 
@@ -189,15 +184,12 @@
   if directed {
     mark = (end: ">", fill: color)
   }
-  draw.group(
-    name: id,
-    {
-      draw.line(..points, stroke: stroke, mark: mark)
-      for (anchor-name, anchor-pos) in anchors {
-        draw.anchor(anchor-name, anchor-pos)
-      }
-    },
-  )
+  draw.group(name: id, {
+    draw.line(..points, stroke: stroke, mark: mark)
+    for (anchor-name, anchor-pos) in anchors {
+      draw.anchor(anchor-name, anchor-pos)
+    }
+  })
 
   let first-pt = id + ".start"
   let last-pt = id + ".end"
@@ -206,12 +198,12 @@
   if reverse {
     (first-pt, last-pt) = (last-pt, first-pt)
   }
-
+  
   let angle = 0deg
   if rotate-name {
     (ctx, first-pos) = coordinate.resolve(ctx, first-pos)
     (ctx, second-pos) = coordinate.resolve(ctx, second-pos)
-
+    
     if reverse {
       (first-pos, second-pos) = (second-pos, first-pos)
     }
@@ -219,24 +211,24 @@
     let (x2, y2, ..) = second-pos
     angle = calc.atan2(x2 - x1, y2 - y1)
   }
-
+  
   if name != none {
     let names = ()
-
-    if type(name) == str or type(name) == content {
+    
+    if type(name) == str {
       names = ((name, name-pos),)
-
+      
     } else if type(name) == array {
       names = (
         (name.at(0), "start"),
-        (name.at(1), "end"),
+        (name.at(1), "end")
       )
     }
 
     for (name, pos) in names {
       let point
       let anchor
-
+      
       if pos == "middle" {
         point = (first-pt, 50%, last-pt)
         anchor = "south"
@@ -256,12 +248,12 @@
 
   if slice != none {
     let slice-txt = "[" + slice.map(b => str(b)).join(":") + "]"
-
+    
     draw.content(
       first-pt,
       anchor: "south-west",
       padding: 3pt,
-      text(slice-txt, size: 0.75em),
+      text(slice-txt, size: 0.75em)
     )
   }
 })
@@ -275,38 +267,24 @@
 /// - vertical (bool): Whether the name should be displayed vertically
 /// - length (number): The length of the stub
 /// - name-offset (number): The name offset, perpendicular to the stub
-#let stub(
-  port-id,
-  side,
-  name: none,
-  vertical: false,
-  length: 1em,
-  name-offset: 0,
-  color: black,
-  directed: none,
-) = {
+#let stub(port-id, side, name: none, vertical: false, length: 1em, name-offset: 0) = {
   let end-offset = (
     north: (0, length),
     east: (length, 0),
     south: (0, -length),
-    west: (-length, 0),
+    west: (-length, 0)
   ).at(side)
-
+  
   let name-offset = (
     north: (name-offset, length),
     east: (length, name-offset),
     south: (name-offset, -length),
-    west: (-length, name-offset),
+    west: (-length, name-offset)
   ).at(side)
 
-  let mark = (fill: color)
-  if directed != none {
-    mark = ((directed): ">", fill: color)
-  }
   draw.line(
     port-id,
-    (rel: end-offset, to: port-id),
-    mark: mark,
+    (rel: end-offset, to: port-id)
   )
   if name != none {
     let text-anchor = if vertical {
@@ -314,21 +292,15 @@
         "north": "west",
         "south": "east",
         "west": "south",
-        "east": "north",
+        "east": "north"
       ).at(side)
-    } else {
-      opposite-anchor(side)
-    }
+    } else { opposite-anchor(side) }
     draw.content(
       anchor: text-anchor,
       padding: 0.2em,
-      angle: if vertical {
-        90deg
-      } else {
-        0deg
-      },
+      angle: if vertical {90deg} else {0deg},
       (rel: name-offset, to: port-id),
-      name,
+      name
     )
   }
 }

typst.toml

@@ -1,7 +1,7 @@
 [package]
 name = "circuiteria"
-version = "0.1.0"
-compiler = "0.11.0"
+version = "0.2.0"
+compiler = "0.13.0"
 repository = "https://git.kb28.ch/HEL/circuiteria"
 entrypoint = "src/lib.typ"
 authors = [
@@ -11,4 +11,4 @@ categories = [ "visualization" ]
 license = "Apache-2.0"
 description = "Drawing block circuits with Typst made easy, using CeTZ"
 keywords = [ "circuit", "block", "draw" ]
-exclude = [ "gallery", "gallery.bash", "doc" ]
+exclude = [ "gallery", "justfile", "doc" ]