Merge branch 'dev' into comp/electrical

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"
 

doc/examples.typ

@@ -147,4 +147,22 @@ wire.wire("w1", ((0, 0), (1, 1)), style: "zigzag")
 wire.wire("w2", ((0, 0), (1, -.5)),
           style: "zigzag", zigzag-ratio: 80%)
 wire.intersection("w1.zig")
-```)
+```)
+
+#let capacitor = example(```
+electrical.capacitor(
+  x: 0, y: 0, w: 2, h: 1, id: "a",
+  scales: (100%, 80%), gap: 0.3
+)
+
+electrical.capacitor(
+  x: 4, y: -0.5, w: 1, h: 2, id: "b",
+  vertical: true, symbols: ([+], none)
+)
+```, vertical: true)
+
+#let resistor = example(```
+electrical.resistor(x: 0, y: 0, w: 2, h: 0.5, id: "a", zigzags: 8)
+electrical.resistor(x: 4, y: -0.5, w: 0.5, h: 2, id: "b", vertical: true)
+electrical.resistor(x: 6.5, y: 0, w: 2, h: 0.5, id: "c", zigzags: none)
+```, vertical: true)

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)
@@ -81,4 +81,57 @@
   element.gate-xnor(
     x: 9, y: -6, w: 2, h: 2, id: "xnor"
   )
+
+  element.resistor(
+    x: 0, y: -8, w: 2, h: 0.5, id: "res1"
+  )
+
+  element.capacitor(
+    x: 3, y: (from: "res1-port-1", to: "0"),
+    w: 2, h: 0.6,
+    id: "cap1",
+    scales: (100%, 80%),
+    symbols: ([+], [-])
+  )
+
+  element.resistor(
+    x: (rel: 1, to: "cap1-port-1"),
+    y: (from: "cap1-port-1", to: "0"),
+    w: 0.5, h: 2,
+    id: "res2",
+    vertical: true,
+    zigzags: 8
+  )
+
+  element.capacitor(
+    x: (rel: 1, to: "res2.east"),
+    y: (from: "res2-port-1", to: "1"),
+    w: 0.5, h: 2,
+    id: "cap2",
+    vertical: true,
+    symbols: ([a], [b])
+  )
+
+  element.resistor(
+    x: (rel: 1, to: "cap2-port-0"),
+    y: (from: "cap2-port-0", to: "0"),
+    w: 2, h: 0.5,
+    id: "res3",
+    zigzags: none
+  )
+
+  element.resistor(
+    x: (rel: 1, to: "res3-port-1"),
+    y: (from: "res3-port-1", to: "0"),
+    w: 0.5, h: 2,
+    id: "res4",
+    zigzags: none,
+    vertical: true
+  )
+
+  wire.wire("w4", ("res1-port-1", "cap1-port-0"))
+  wire.wire("w5", ("cap1-port-1", "res2-port-0"))
+  wire.wire("w6", ("res2-port-1", "cap2-port-1"))
+  wire.wire("w7", ("cap2-port-0", "res3-port-0"))
+  wire.wire("w8", ("res3-port-1", "res4-port-0"))
 })

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,9 +1,10 @@
-#import "@preview/tidy:0.3.0"
+#import "@preview/tidy:0.4.1"
-#import "@preview/cetz:0.2.2": draw, canvas
+#import "@preview/cetz:0.3.2": draw, canvas
 #import "src/lib.typ"
 #import "doc/examples.typ"
 #import "src/circuit.typ": circuit
 #import "src/element.typ"
+#import "src/electrical.typ"
 #import "src/gates.typ"
 #import "src/util.typ"
 #import "src/wire.typ"
@@ -12,7 +13,7 @@
   numbering("1.1", ..num)
 })
 #{
-  outline(indent: true, depth: 3)
+  outline(indent: auto, depth: 3)
 }
 
 #show link: set text(blue)
@@ -47,7 +48,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 +66,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 +81,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 +95,7 @@
     label-name += "()"
     display-name += "()"
   }
-  link(label(label-name))[#display-name]
+  link(label(label-name), raw(display-name))
 }
 
 = Introduction
@@ -103,11 +104,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"
+#import "@preview/circuiteria:0.2.0"
-#lib.circuit({
+#circuiteria.circuit({
-  import lib: *
+  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 +128,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 +138,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 +153,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 +175,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 +198,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,
@@ -195,4 +211,24 @@ Simply import #link("src/lib.typ") and call the `circuit` function:
   )
 )
 
-#tidy.show-module(gates-docs, sort-functions: false)
+#tidy.show-module(gates-docs, sort-functions: false)
+
+#pagebreak()
+
+#let electrical-docs = tidy.parse-module(
+  read("src/elements/electrical/capacitor.typ") + "\n" +
+  read("src/elements/electrical/resistor.typ") + "\n",
+  name: "electrical",
+  scope: (
+    element: element,
+    circuit: circuit,
+    electrical: electrical,
+    draw: draw,
+    wire: wire,
+    tidy: tidy,
+    examples: examples,
+    doc-ref: doc-ref
+  )
+)
+
+#tidy.show-module(electrical-docs, sort-functions: false)

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

src/electrical.typ

@@ -0,0 +1,2 @@
+#import "elements/electrical/capacitor.typ": capacitor
+#import "elements/electrical/resistor.typ": resistor

src/element.typ

@@ -12,4 +12,7 @@
 #import "elements/logic/xor.typ": gate-xor, gate-xnor
 #import "elements/logic/buf.typ": gate-buf, gate-not
 
+#import "elements/electrical/resistor.typ": resistor
+#import "elements/electrical/capacitor.typ": capacitor
+
 #import "elements/group.typ": group

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/electrical/capacitor.typ

@@ -0,0 +1,138 @@
+#import "@preview/cetz:0.2.2": draw
+#import "../element.typ"
+#import "../ports.typ": add-port
+
+#let draw-shape(
+  id, tl, tr, br, bl,
+  fill, stroke,
+  vertical: false,
+  gap: 0.2,
+  scales: (100%, 100%),
+  symbols: (none, none)
+) = {
+  let (x0, y0) = tl
+  let (x1, y1) = br
+
+  let w = x1 - x0
+  let h = y1 - y0
+
+  let (o0, s0) = if vertical {(y0, h)} else {(x0, w)}
+  let (o1, s1) = if vertical {(x0, w)} else {(y0, h)}
+  let m1 = o1 + s1 / 2
+
+  let pt(i, j) = if vertical {
+    (j, i)
+  } else {
+    (i, j)
+  }
+
+  let size0 = s1 * scales.first() / 100%
+  let size1 = s1 * scales.last() / 100%
+
+  if type(gap) == ratio {
+    gap = gap / 100%
+  } else {
+    gap = gap / calc.abs(s0)
+  }
+  let r0 = 0.5 - gap / 2
+  let r1 = 0.5 + gap / 2
+
+  // Coordinates in (main axis, secondary axis) format
+  let p0 = pt(o0, m1)
+  let p1 = pt(o0 + r0 * s0, m1)
+  let p2 = pt(o0 + r1 * s0, m1)
+  let p3 = pt(o0 + s0, m1)
+  
+  let p4 = pt(o0 + r0 * s0, m1 - size0 / 2)
+  let p5 = pt(o0 + r0 * s0, m1 + size0 / 2)
+  
+  let p6 = pt(o0 + r1 * s0, m1 - size1 / 2)
+  let p7 = pt(o0 + r1 * s0, m1 + size1 / 2)
+
+  let line = draw.line.with(stroke: stroke)
+  let f = draw.group(name: id, {
+    line(p0, p1)
+    line(p2, p3)
+    line(p4, p5)
+    line(p6, p7)
+
+    if symbols.first() != none {
+      draw.content(
+        p1,
+        symbols.first(),
+        anchor: if vertical {"south-west"} else {"south-east"},
+        padding: 2pt
+      )
+    }
+
+    if symbols.last() != none {
+      draw.content(
+        p2,
+        symbols.last(),
+        anchor: if vertical {"north-west"} else {"south-west"},
+        padding: 2pt
+      )
+    }
+  })
+
+  return (f, tl, tr, br, bl)
+}
+
+/// Draws a capacitor
+///
+/// #examples.capacitor
+/// For other parameters description, see #doc-ref("element.elmt")
+/// - vertical (bool): Whether the element is vertical or horizontal.
+///   - If false, port 0 is placed on the west side and port 1 on the east.\
+///   - If true, they are on the north, respectively the south sides
+/// - gap (number, ratio): The gap between both sides
+///   - if it is a number (int or float), it is interpreted as an absolute canvas-unit length
+///   - if it is a ratio, it is interpreted as proportional to the capacitor's length (width if horizontal, height if vertical)
+/// - scales (array): A pair of ratios, the sizes of the sides relative to the capacitor's height (width if vertical).
+/// - symbols (array): A pair of content or strings (or none values) to attach on the sides of the capacitor
+#let capacitor(
+  x: none,
+  y: none,
+  w: none,
+  h: none,
+  name: none,
+  name-anchor: "center",
+  vertical: false,
+  gap: 0.2,
+  scales: (100%, 100%),
+  symbols: (none, none),
+  fill: none,
+  stroke: black + 1pt,
+  id: "",
+  debug: (
+    ports: false
+  )
+) = {
+  let ports = if vertical {(
+    north: ((id: "0"),),
+    south: ((id: "1"),)
+  )} else {(
+    west: ((id: "0"),),
+    east: ((id: "1"),)
+  )}
+  
+  element.elmt(
+    draw-shape: draw-shape.with(
+      vertical: vertical,
+      gap: gap,
+      scales: scales,
+      symbols: symbols
+    ),
+    x: x,
+    y: y,
+    w: w,
+    h: h,
+    name: name,
+    name-anchor: name-anchor,
+    ports: ports,
+    fill: fill,
+    stroke: stroke,
+    id: id,
+    debug: debug
+  )
+}

src/elements/electrical/resistor.typ

@@ -0,0 +1,106 @@
+#import "@preview/cetz:0.2.2": draw
+#import "../element.typ"
+#import "../ports.typ": add-port
+
+#let draw-shape(
+  id, tl, tr, br, bl,
+  fill, stroke,
+  zigzags: 6,
+  vertical: false
+) = {
+  let (x0, y0) = tl
+  let (x1, y1) = br
+
+  let w = x1 - x0
+  let h = y1 - y0
+
+  let (o0, s0) = if vertical {(y0, h)} else {(x0, w)}
+  let (o1, s1) = if vertical {(x0, w)} else {(y0, h)}
+  let m1 = o1 + s1 / 2
+
+  let pt(i, j) = if vertical {
+    (j, i)
+  } else {
+    (i, j)
+  }
+
+  let p0 = pt(o0, m1)
+  let p1 = pt(o0 + 0.2 * s0, m1)
+  let p2 = pt(o0 + 0.8 * s0, m1)
+  let p3 = pt(o0 + s0, m1)
+
+  if zigzags == none {
+    let p4 = pt(o0 + 0.2 * s0, o1)
+    let p5 = pt(o0 + 0.8 * s0, o1 + s1)
+    let f = draw.group(name: id, {
+      draw.line(p0, p1)
+      draw.line(p2, p3)
+      draw.rect(p4, p5, stroke: stroke, fill: fill)
+    })
+    return (f, tl, tr, br, bl)
+  }
+  
+  let pts = (p0, p1)
+  
+  for i in range(zigzags) {
+    let r = ((i+0.5) / zigzags * 0.6 + 0.2)
+    let pos = pt(o0 + r * s0, o1 + s1 * calc.rem(i, 2))
+    pts.push(pos)
+  }
+
+  pts += (p2, p3)
+
+  let f = draw.group(name: id, {
+    draw.line(..pts, stroke: stroke)
+  })
+  return (f, tl, tr, br, bl)
+}
+
+/// Draws a resistor
+///
+/// #examples.resistor
+/// For other parameters description, see #doc-ref("element.elmt")
+/// - vertical (bool): Whether the element is vertical or horizontal. If false, port 0 is placed on the west side and port 1 on the east. If true, they are on the north, respectively the south sides
+/// - zigzags (number, none): Number of zigzags to draw. If none, a rectangle is drawn
+#let resistor(
+  x: none,
+  y: none,
+  w: none,
+  h: none,
+  name: none,
+  name-anchor: "center",
+  vertical: false,
+  zigzags: 6,
+  fill: none,
+  stroke: black + 1pt,
+  id: "",
+  debug: (
+    ports: false
+  )
+) = {
+  let ports = if vertical {(
+    north: ((id: "0"),),
+    south: ((id: "1"),)
+  )} else {(
+    west: ((id: "0"),),
+    east: ((id: "1"),)
+  )}
+
+  element.elmt(
+    draw-shape: draw-shape.with(
+      vertical: vertical,
+      zigzags: zigzags
+    ),
+    x: x,
+    y: y,
+    w: w,
+    h: h,
+    name: name,
+    name-anchor: name-anchor,
+    ports: ports,
+    fill: fill,
+    stroke: stroke,
+    id: id,
+    debug: debug
+  )
+}

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"
 

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,6 +1,7 @@
-#let version = version(0, 1, 0)
+#let version = version(0, 2, 0)
 
 #import "circuit.typ": circuit
+#import "electrical.typ"
 #import "element.typ"
 #import "gates.typ"
 #import "util.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

typst.toml

@@ -1,7 +1,7 @@
 [package]
 name = "circuiteria"
-version = "0.1.0"
+version = "0.2.0"
-compiler = "0.11.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" ]