37 Commits

Author SHA1 Message Date
9ab454045e extracted cetz import for easier updating 2025-04-20 12:12:05 +02:00
aba66ed442 extracted cetz import for easier updating 2025-04-20 12:10:43 +02:00
0a108fdc73 improved error message 2025-04-19 17:21:24 +02:00
cd8784fcee adapted ALU + minor fix in add-ports 2025-04-19 17:16:09 +02:00
4733f69b51 adapted extender + improved bound anchors 2025-04-19 16:49:46 +02:00
33d79f35fa minor fix to port margins 2025-04-19 16:04:11 +02:00
3e9272255c improved wire arguments 2025-04-19 15:56:20 +02:00
4930b53c84 reworked ports layout + adapted multiplexer 2025-04-19 15:10:09 +02:00
26231b2f48 adapted wire stubs with auto side detection 2025-04-19 00:11:53 +02:00
5616544707 added checks + fixed auto ids 2025-04-19 00:10:57 +02:00
358de4825d initial rewrite of drawing pipeline + positioning 2025-04-18 17:27:01 +02:00
2bb7e3b5a9 Merge pull request 'v0.2.0: Updates' (#5) from dev into main
Reviewed-on: #5
2025-03-01 21:28:24 +00:00
371caf094c updated README and manual with new version 2025-03-01 22:23:52 +01:00
841f53e76c Merge pull request 'updated compiler version + dependencies' (#4) from feat/updates-1 into dev
Reviewed-on: #4
2025-03-01 21:17:27 +00:00
ff0b91e683 updated compiler version + dependencies 2025-03-01 21:22:08 +01:00
e1e561bb6c fixed y-alignment for north/south ports 2024-11-09 23:03:03 +01:00
9a1fda087c prepared for publication + bumped to 0.1.0 2024-10-02 21:09:48 +02:00
c5a0cf7ecc fixed typo in default param value 2024-10-02 21:04:40 +02:00
9a6973fb89 fixed README links 2024-05-18 23:55:06 +02:00
d8094384ad added examples to README.md 2024-05-18 23:50:29 +02:00
86ca91920f added gallery/platypus 2024-05-18 23:46:29 +02:00
64d6635d5f added gallery/test6 2024-05-18 22:36:38 +02:00
6a6ae96a96 changed AND design (circle arc instead of bezier) 2024-05-18 22:36:27 +02:00
a856b7f634 added doc for wire.intersection 2024-05-18 21:52:46 +02:00
011802ffbe fixed minor issues + changed some default styles 2024-05-18 21:45:12 +02:00
4fae4fe19a fixed gates y alignment 2024-05-18 18:27:57 +02:00
d6248865b3 added gallery rendering script 2024-05-18 18:08:36 +02:00
2317fec71d fixed wire name rotation 2024-05-18 18:08:22 +02:00
ff9ad9e94a changed version number 2024-05-18 17:08:08 +02:00
4dc69a92c5 updated manual 2024-05-18 17:07:14 +02:00
ba7630c03c added test5 in gallery 2024-05-18 17:03:03 +02:00
f9916e5856 adapted corner anchors for ALU, EXT and MUX 2024-05-18 17:02:42 +02:00
7731159dd0 added h-ratio to MUX + fixed inputs spacing 2024-05-18 16:50:14 +02:00
699b3c0189 added name anchor to ALU 2024-05-18 16:48:25 +02:00
08f931bbde added small clock ports 2024-05-18 16:46:32 +02:00
7da2bb2b64 fixed extender ports + added align-out param 2024-05-18 16:46:18 +02:00
e4194d0925 added horizontal zigzag wires 2024-05-18 16:45:09 +02:00
47 changed files with 1835 additions and 437 deletions

View File

@ -1,3 +1,64 @@
# circuiteria
Drawing block circuits with Typst made easy, using CeTZ
Circuiteria is a [Typst](https://typst.app) package for drawing block circuit diagrams using the [CeTZ](https://typst.app/universe/package/cetz) package.
<p align="center">
<img src="./gallery/platypus.png" alt="Perry the platypus">
</p>
## Examples
<table>
<tr>
<td colspan="2">
<a href="./gallery/test.typ">
<img src="./gallery/test.png" width="500px">
</a>
</td>
</tr>
<tr>
<td colspan="2">A bit of eveything</td>
</tr>
<tr>
<td colspan="2">
<a href="./gallery/test5.typ">
<img src="./gallery/test5.png" width="500px">
</a>
</td>
</tr>
<tr>
<td colspan="2">Wires everywhere</td>
</tr>
<tr>
<td>
<a href="./gallery/test4.typ">
<img src="./gallery/test4.png" width="250px">
</a>
</td>
<td>
<a href="./gallery/test6.typ">
<img src="./gallery/test6.png" width="250px">
</a>
</td>
</tr>
<tr>
<td>Groups</td>
<td>Rotated</td>
</tr>
</table>
> **Note**\
> These circuit layouts were copied from a digital design course given by prof. S. Zahno and recreated using this package
*Click on the example image to jump to the code.*
## Usage
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.2.0"
#circuiteria.circuit({
import circuiteria: *
...
})
```

View File

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

View File

@ -141,3 +141,10 @@ wire.wire("w1", ("b1-port-out", "b3-port-in1"))
wire.wire("w2", ("b2-port-out", "b3-port-in2"),
style: "zigzag")
```)
#let intersection = example(```
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")
```)

BIN
gallery/platypus.pdf Normal file

Binary file not shown.

BIN
gallery/platypus.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

77
gallery/platypus.typ Normal file
View File

@ -0,0 +1,77 @@
#import "../src/lib.typ": *
#set page(width: auto, height: auto, margin: .5cm)
#let teal = rgb(37, 155, 166)
#let orange = rgb(254, 160, 93)
#let brown = rgb(97, 54, 60)
#circuit({
element.group(id: "platypus", name: "A platypus", {
element.block(
x: 0, y: 0, w: 2, h: 3, id: "body",
fill: teal,
ports: (
east: (
(id: "out"),
)
),
ports-margins: (
east: (50%, 10%)
)
)
element.block(
x: 2.5, y: 1.5, w: 1.5, h: 1, id: "beak",
fill: orange,
ports: (
south: (
(id: "in"),
)
)
)
wire.wire("w1", ("body-port-out", "beak-port-in"), style: "zigzag", zigzag-ratio: 100%)
})
let O = (rel: (2, 0), to: "platypus.south-east")
element.group(id: "perry", name: "Perry the platypus", {
element.block(
x: (rel: 0, to: O), y: 0, w: 2, h: 3, id: "body",
fill: teal,
ports: (
east: (
(id: "out"),
)
),
ports-margins: (
east: (50%, 10%)
)
)
element.block(
x: (rel: 2.5, to: O), y: 1.5, w: 1.5, h: 1, id: "beak",
fill: orange,
ports: (
south: (
(id: "in"),
)
)
)
element.block(
x: (rel: 0.25, to: O), y: 3.2, w: 1.5, h: 0.5, id: "hat",
fill: brown
)
wire.wire("w2", ("body-port-out", "beak-port-in"), style: "zigzag", zigzag-ratio: 100%)
})
wire.wire(
"w3",
("platypus.east", (horizontal: "perry.west", vertical: ())),
directed: true,
bus: true
)
})

BIN
gallery/target_api.pdf Normal file

Binary file not shown.

286
gallery/target_api.typ Normal file
View File

@ -0,0 +1,286 @@
#import "../src/lib.typ": *
#import "/src/cetz.typ": draw
#set text(font: "Source Sans 3")
#set page(width: auto, height: auto, margin: .5cm)
#circuit({
element.block(
size: (1.5, 2.2),
id: "PCBuf",
fill: util.colors.orange,
ports: (
west: "PCNext",
north: (id: "CLK", clock: true),
east: "PC",
south: (("EN", "EN"),)
)
)
wire.stub("PCBuf.CLK", name: "CLK")
wire.stub("PCBuf.EN", name: "PCWrite")
element.multiplexer(
pos: (
3, (align: "in0", with: "PCBuf.PC")
),
size: (1, 2),
id: "AdrSrc-MP",
fill: util.colors.orange,
entries: 2
)
wire.wire(
"PCBuf.PC",
"AdrSrc-MP.in0",
id: "wPCBuf-InstDataMgr",
name: "PC",
bus: true
)
wire.stub("AdrSrc-MP.north", side: "north", name: "AdrSrc")
element.block(
pos: (
6, (align: "A", with: "AdrSrc-MP.out")
),
size: (3, 4),
id: "InstDataMgr",
fill: util.colors.yellow,
ports: (
west: (
("A", "A"),
("WD", "WD")
),
north: (
(id: "CLK", clock: true),
(id: "WE", name: "WE", vertical: true),
(id: "IRWrite", name: "IRWrite", vertical: true)
),
east: (
("Instr", "Instr."),
("RD", "RD")
)
),
ports-margins: (
west: (30%, 0%),
east: (40%, 0%)
)
)
wire.wire(
"AdrSrc-MP.out",
"InstDataMgr.A",
id: "wAdrSrcMP-InstDataMgr",
name: (none, "Adr"),
bus: true
)
wire.stub("InstDataMgr.CLK", name: "CLK")
wire.stub("InstDataMgr.WE")
wire.stub("InstDataMgr.IRWrite")
wire.stub("InstDataMgr.WD")
element.block(
pos: (
15, (align: "WD3", with: "InstDataMgr.RD")
),
size: (3, 4),
id: "RegFile",
fill: util.colors.pink,
ports: (
west: (
("A1", "A1"),
("A2", "A2"),
("A3", "A3"),
("WD3", "WD3"),
),
north: (
(id: "CLK", clock: true),
(id: "WE3", name: "WE3", vertical: true)
),
east: (
("RD1", "RD1"),
("RD2", "RD2"),
)
),
ports-margins: (
east: (20%, 20%)
)
)
wire.stub("RegFile.CLK", name: "CLK")
wire.stub("RegFile.WE3", name: "Regwrite", name-offset: 0.6)
wire.stub("RegFile.A2")
wire.stub("RegFile.RD2")
element.extender(
pos: (15, -3.5),
size: (3, 1),
id: "Extender",
fill: util.colors.green
)
wire.wire(
"Extender.north",
(18, -2),
id: "wExtender-ImmSrc",
style: "zigzag",
zigzag-ratio: 0%,
name: (none, "ImmSrc"),
bus: true
)
let mid = ("InstDataMgr.east", 50%, "RegFile.west")
wire.wire(
"InstDataMgr.Instr",
(vertical: (), horizontal: mid),
id: "wInstDataMgr-Bus",
name: ("Instr", none),
bus: true
)
wire.wire(
(v => (v.at(0), -3.5), mid),
(horizontal: (), vertical: (0, 3.5)),
id: "wBus",
bus: true
)
wire.wire(
"RegFile.A1",
(horizontal: mid, vertical: ()),
id: "wBus-RegFile-A1",
name: (none, "RS1"),
slice: (19, 15),
reverse: true,
bus: true
)
wire.wire(
"RegFile.A3",
(horizontal: mid, vertical: ()),
id: "wBus-RegFile-A3",
name: (none, "RD"),
slice: (11, 7),
reverse: true,
bus: true
)
wire.wire(
"Extender.in",
(horizontal: mid, vertical: ()),
id: "wBus-Extender",
slice: (31, 7),
reverse: true,
bus: true
)
element.alu(
pos: (
22, (align: "in1", with: "RegFile.RD1")
),
size: (1, 2),
id: "ALU",
fill: util.colors.purple
)
wire.wire(
"RegFile.RD1",
"ALU.in1",
id: "wRegFile-ALU",
name: ("A", "SrcA"),
bus: true
)
wire.stub("ALU.north", side: "north")
element.block(
pos: (
26, (align: "in", with: "ALU.out")
),
size: (1.5, 2),
id: "OutBuf",
fill: util.colors.orange,
ports: (
west: "in",
north: (id: "CLK", clock: true),
east: "out"
)
)
wire.stub("OutBuf.CLK", name: "CLK")
wire.wire(
"ALU.out",
"OutBuf.in",
id: "wALU-OutBuf",
name: "ALUResult",
bus: true
)
element.multiplexer(
pos: (
30, (align: "in0", with: "OutBuf.out")
),
size: (1, 2.5),
id: "Res-MP",
fill: util.colors.orange,
entries: 3
)
wire.stub("Res-MP.north", side: "north", name: "ResultSrc")
wire.stub("Res-MP.in2")
wire.wire(
"OutBuf.out",
"Res-MP.in0",
id: "wOutBuf-ResMP",
name: "ALUOut",
bus: true
)
wire.wire(
"Extender.out",
"ALU.in2",
id: "wExt-ALU",
name: ("ImmExt", "SrcB"),
bus: true,
style: "zigzag",
zigzag-ratio: 60%
)
wire.wire(
"InstDataMgr.RD",
"Res-MP.in1",
id: "wInstDataMgr-ResMP",
style: "dodge",
dodge-y: -4,
dodge-sides: ("east", "west"),
name: ("Data", none),
bus: true
)
wire.wire(
"Res-MP.out",
"AdrSrc-MP.in1",
id: "wResMP-AdrSrc",
style: "dodge",
dodge-y: -5,
dodge-sides: ("east", "west"),
dodge-margins: (0.5, 1),
bus: true
)
wire.wire(
"Res-MP.out",
"RegFile.WD3",
id: "wResMP-RegFile",
style: "dodge",
dodge-y: -5,
dodge-sides: ("east", "west"),
dodge-margins: (0.5, 1),
bus: true
)
wire.wire(
"Res-MP.out",
"PCBuf.PCNext",
id: "wResMP-PCBuf",
style: "dodge",
dodge-y: -5,
dodge-sides: ("east", "west"),
dodge-margins: (0.5, 1.5),
name: (none, "PCNext"),
bus: true
)
wire.intersection("wResMP-RegFile.dodge-end", radius: .2)
wire.intersection("wResMP-AdrSrc.dodge-end", radius: .2)
})

Binary file not shown.

BIN
gallery/test.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

View File

@ -1,6 +1,6 @@
#import "../src/lib.typ": circuit, element, util, wire
#set page(flipped: true)
#set page(width: auto, height: auto, margin: .5cm)
#circuit({
element.block(
@ -294,6 +294,6 @@
bus: true
)
wire.intersection("wResMP-RegFile.dodge-end")
wire.intersection("wResMP-AdrSrc.dodge-end")
wire.intersection("wResMP-RegFile.dodge-end", radius: .2)
wire.intersection("wResMP-AdrSrc.dodge-end", radius: .2)
})

Binary file not shown.

BIN
gallery/test2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

View File

@ -1,6 +1,6 @@
#import "../src/lib.typ": circuit, element, util, wire
#set page(flipped: true)
#set page(width: auto, height: auto, margin: .5cm)
#circuit({
element.block(
@ -307,6 +307,6 @@
bus: true
)
wire.intersection("wResMP-RegFile.dodge-end")
wire.intersection("wResMP-AdrSrc.dodge-end")
wire.intersection("wResMP-RegFile.dodge-end", radius: .2)
wire.intersection("wResMP-AdrSrc.dodge-end", radius: .2)
})

Binary file not shown.

BIN
gallery/test3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

View File

@ -1,8 +1,7 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "../src/lib.typ": circuit, element, util, wire
#set page(flipped: true)
#let debug = false
#set page(width: auto, height: auto, margin: .5cm)
#circuit({
element.block(
@ -14,18 +13,14 @@
(id: "out1"),
(id: "out2"),
)
),
debug: (
ports: debug
)
)
element.gate-and(
x: 4, y: 0, w: 2, h: 2, id: "and1", debug: (ports: debug),
x: 4, y: 0, w: 2, h: 2, id: "and1",
inverted: ("in1")
)
element.gate-or(
x: 7, y: 0, w: 2, h: 2, id: "or1", debug: (ports: debug),
x: 7, y: 0, w: 2, h: 2, id: "or1",
inverted: ("in0", "out")
)
@ -47,7 +42,7 @@
)
element.gate-and(
x: 11, y: 0, w: 2, h: 2, id: "and2", inputs: 3, debug: (ports: debug),
x: 11, y: 0, w: 2, h: 2, id: "and2", inputs: 3,
inverted: ("in0", "in2")
)
for i in range(3) {
@ -55,35 +50,35 @@
}
element.gate-xor(
x: 14, y: 0, w: 2, h: 2, id: "xor", debug: (ports: debug),
x: 14, y: 0, w: 2, h: 2, id: "xor",
inverted: ("in1")
)
element.gate-buf(
x: 0, y: -3, w: 2, h: 2, id: "buf", debug: (ports: debug)
x: 0, y: -3, w: 2, h: 2, id: "buf"
)
element.gate-not(
x: 0, y: -6, w: 2, h: 2, id: "not", debug: (ports: debug)
x: 0, y: -6, w: 2, h: 2, id: "not"
)
element.gate-and(
x: 3, y: -3, w: 2, h: 2, id: "and", debug: (ports: debug)
x: 3, y: -3, w: 2, h: 2, id: "and"
)
element.gate-nand(
x: 3, y: -6, w: 2, h: 2, id: "nand", debug: (ports: debug)
x: 3, y: -6, w: 2, h: 2, id: "nand"
)
element.gate-or(
x: 6, y: -3, w: 2, h: 2, id: "or", debug: (ports: debug)
x: 6, y: -3, w: 2, h: 2, id: "or"
)
element.gate-nor(
x: 6, y: -6, w: 2, h: 2, id: "nor", debug: (ports: debug)
x: 6, y: -6, w: 2, h: 2, id: "nor"
)
element.gate-xor(
x: 9, y: -3, w: 2, h: 2, id: "xor", debug: (ports: debug)
x: 9, y: -3, w: 2, h: 2, id: "xor"
)
element.gate-xnor(
x: 9, y: -6, w: 2, h: 2, id: "xnor", debug: (ports: debug)
x: 9, y: -6, w: 2, h: 2, id: "xnor"
)
})

Binary file not shown.

BIN
gallery/test4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

View File

@ -1,7 +1,7 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "../src/lib.typ": *
#set page(flipped: true)
#set page(width: auto, height: auto, margin: .5cm)
#circuit({
element.group(id: "toplvl", name: "Toplevel", {
@ -18,7 +18,7 @@
name: "Datapath",
ports: (
north: (
(id: "clk", clock: true),
(id: "clk", clock: true, small: true),
(id: "Zero"),
(id: "Regsrc"),
(id: "PCSrc"),
@ -104,7 +104,7 @@
name: "Data\n Memory",
ports: (
north: (
(id: "clk", clock: true),
(id: "clk", clock: true, small: true),
(id: "WE", name: "WE")
),
west: (
@ -200,18 +200,22 @@
draw.content("dmem.south-west", [*External Memories*], anchor: "north", padding: 10pt)
})
wire.wire(
"w-dp-clk",
("dp-port-clk", (-1, 4.2)),
style: "zigzag",
zigzag-dir: "horizontal",
zigzag-ratio: 100%
draw.line(name: "w-dp-clk",
"dp-port-clk",
(rel: (0, .5), to: ()),
(
rel: (-.5, 0),
to: (horizontal: "toplvl.west", vertical: ())
)
)
draw.content("w-dp-clk.end", "clk", anchor: "east", padding: 3pt)
wire.wire(
"w-dp-rst",
("dp-port-rst", (horizontal: (-1, 0), vertical: ()))
draw.line(name: "w-dp-rst",
"dp-port-rst",
(
rel: (-.5, 0),
to: (horizontal: "toplvl.west", vertical: ())
)
)
draw.content("w-dp-rst.end", "rst", anchor: "east", padding: 3pt)
})

BIN
gallery/test5.pdf Normal file

Binary file not shown.

BIN
gallery/test5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 275 KiB

435
gallery/test5.typ Normal file
View File

@ -0,0 +1,435 @@
#import "/src/cetz.typ": draw
#import "../src/lib.typ": *
#set page(width: auto, height: auto, margin: .5cm)
#circuit({
element.multiplexer(
x: 0, y: 0, w: .5, h: 1.5, id: "PCMux",
entries: 2,
fill: util.colors.blue,
h-ratio: 80%
)
element.block(
x: (rel: 2, to: "PCMux.east"),
y: (from: "PCMux-port-out", to: "in"),
w: 1, h: 1.5, id: "PCBuf",
ports: (
north: ((id: "clk", clock: true),),
west: ((id: "in"),),
east: ((id: "out"),)
),
fill: util.colors.green
)
element.block(
x: (rel: 2, to: "PCBuf.east"),
y: (from: "PCBuf-port-out", to: "A"),
w: 3, h: 4, id: "IMem",
ports: (
west: (
(id: "A", name: "A"),
),
east: (
(id: "RD", name: "RD"),
)
),
ports-margins: (
west: (0%, 50%),
east: (0%, 50%)
),
fill: util.colors.green,
name: "Instruction\nMemory"
)
element.block(
x: (rel: 3, to: "IMem.east"),
y: (from: "IMem-port-RD", to: "A1"),
w: 4.5, h: 4, id: "RegFile",
ports: (
north: (
(id: "clk", clock: true, small: true),
(id: "WE3", name: "WE3"),
(id: "dummy1")
),
west: (
(id: "dummy2"),
(id: "A1", name: "A1"),
(id: "dummy3"),
(id: "A2", name: "A2"),
(id: "A3", name: "A3"),
(id: "dummy4"),
(id: "WD3", name: "WD3"),
),
east: (
(id: "RD1", name: "RD1"),
(id: "RD2", name: "RD2"),
)
),
ports-margins: (
north: (-20%, -20%),
east: (0%, 10%)
),
fill: util.colors.green,
name: "Register\nFile"
)
element.alu(
x: (rel: -.7, to: "IMem.center"),
y: -7,
w: 1.4, h: 2.8, id: "PCAdd",
name: text("+", size: 1.5em),
name-anchor: "name",
fill: util.colors.pink
)
element.extender(
x: (rel: 0, to: "RegFile.west"),
y: (from: "PCAdd-port-out", to: "in"),
w: 4, h: 1.5, id: "Ext",
h-ratio: 50%,
name: "Extend",
name-anchor: "south",
align-out: false,
fill: util.colors.green
)
element.multiplexer(
x: (rel: 3, to: "RegFile.east"),
y: (from: "RegFile-port-RD2", to: "in0"),
w: .5, h: 1.5, id: "SrcBMux",
fill: util.colors.blue,
h-ratio: 80%
)
element.alu(
x: (rel: 2, to: "SrcBMux.east"),
y: (from: "SrcBMux-port-out", to: "in2"),
w: 1.4, h: 2.8, id: "ALU",
name: rotate("ALU", -90deg),
name-anchor: "name",
fill: util.colors.pink
)
element.alu(
x: (rel: 2, to: "SrcBMux.east"),
y: (from: "Ext-port-out", to: "in2"),
w: 1.4, h: 2.8, id: "JumpAdd",
name: text("+", size: 1.5em),
name-anchor: "name",
fill: util.colors.pink
)
element.block(
x: (rel: 4, to: "ALU.east"),
y: (from: "ALU-port-out", to: "A"),
w: 3, h: 4, id: "DMem",
name: "Data\nMemory",
ports: (
north: (
(id: "clk", clock: true, small: true),
(id: "dummy1"),
(id: "WE", name: "WE")
),
west: (
(id: "A", name: "A"),
(id: "WD", name: "WD")
),
east: (
(id: "RD", name: "RD"),
(id: "dummy2")
)
),
ports-margins: (
north: (-10%, -10%),
west: (-20%, -30%),
east: (-10%, -20%)
),
fill: util.colors.green
)
element.multiplexer(
x: (rel: 3, to: "DMem.east"),
y: (from: "DMem-port-RD", to: "in1"),
w: .5, h: 1.5, id: "ResMux",
entries: 2,
fill: util.colors.blue,
h-ratio: 80%
)
element.block(
x: (rel: 0, to: "RegFile.west"),
y: 3.5, w: 2.5, h: 5, id: "Ctrl",
name: "Control\nUnit",
name-anchor: "north",
ports: (
west: (
(id: "op", name: "op"),
(id: "funct3", name: "funct3"),
(id: "funct7", name: [funct7#sub("[5]")]),
(id: "zero", name: "Zero"),
),
east: (
(id: "PCSrc"),
(id: "ResSrc"),
(id: "MemWrite"),
(id: "ALUCtrl"),
(id: "ALUSrc"),
(id: "ImmSrc"),
(id: "RegWrite"),
)
),
ports-margins: (
west: (40%, 0%)
),
fill: util.colors.orange
)
// Wires
wire.wire(
"wPCNext", ("PCMux-port-out", "PCBuf-port-in"),
name: "PCNext"
)
wire.stub("PCBuf-port-clk", "north", name: "clk", length: 0.25)
wire.wire(
"wPC1", ("PCBuf-port-out", "IMem-port-A"),
name: "PC"
)
wire.wire(
"wPC2", ("PCBuf-port-out", "JumpAdd-port-in1"),
style: "zigzag",
zigzag-ratio: 1
)
wire.wire(
"wPC3", ("PCBuf-port-out", "PCAdd-port-in1"),
style: "zigzag",
zigzag-ratio: 1
)
wire.intersection("wPC2.zig")
wire.intersection("wPC2.zag")
wire.stub("PCAdd-port-in2", "west", name: "4", length: 1.5)
wire.wire(
"wPC+4", ("PCAdd-port-out", "PCMux-port-in0"),
style: "dodge",
dodge-sides: ("east", "west"),
dodge-y: -7.5,
dodge-margins: (1.2, .5),
name: "PC+4",
name-pos: "start"
)
let mid = ("IMem-port-RD", 50%, "RegFile-port-A1")
wire.wire(
"wInstr", ("IMem-port-RD", mid),
bus: true,
name: "Instr",
name-pos: "start"
)
draw.hide({
draw.line(name: "bus-top",
mid,
(horizontal: (), vertical: "Ctrl-port-op")
)
draw.line(name: "bus-bot",
mid,
(horizontal: (), vertical: "Ext-port-in")
)
})
wire.wire(
"wInstrBus", ("bus-top.end", "bus-bot.end"),
bus: true
)
wire.wire(
"wOp", ("Ctrl-port-op", (horizontal: mid, vertical: ())),
bus: true,
reverse: true,
slice: (6, 0)
)
wire.wire(
"wF3", ("Ctrl-port-funct3", (horizontal: mid, vertical: ())),
bus: true,
reverse: true,
slice: (14, 12)
)
wire.wire(
"wF7", ("Ctrl-port-funct7", (horizontal: mid, vertical: ())),
bus: true,
reverse: true,
slice: (30,)
)
wire.wire(
"wA1", ("RegFile-port-A1", (horizontal: mid, vertical: ())),
bus: true,
reverse: true,
slice: (19, 15)
)
wire.wire(
"wA2", ("RegFile-port-A2", (horizontal: mid, vertical: ())),
bus: true,
reverse: true,
slice: (24, 20)
)
wire.wire(
"wA3", ("RegFile-port-A3", (horizontal: mid, vertical: ())),
bus: true,
reverse: true,
slice: (11, 7)
)
wire.wire(
"wExt", ("Ext-port-in", (horizontal: mid, vertical: ())),
bus: true,
reverse: true,
slice: (31, 7)
)
wire.intersection("wF3.end")
wire.intersection("wF7.end")
wire.intersection("wA1.end")
wire.intersection("wA2.end")
wire.intersection("wA3.end")
wire.stub("RegFile-port-clk", "north", name: "clk", length: 0.25)
wire.wire("wRD2", ("RegFile-port-RD2", "SrcBMux-port-in0"))
wire.wire(
"wWD", ("RegFile-port-RD2", "DMem-port-WD"),
style: "zigzag",
zigzag-ratio: 1.5,
name: "WriteData",
name-pos: "end"
)
wire.intersection("wWD.zig")
wire.wire(
"wImmALU", ("Ext-port-out", "SrcBMux-port-in1"),
style: "zigzag",
zigzag-ratio: 2.5,
name: "ImmExt",
name-pos: "start"
)
wire.wire(
"wImmJump", ("Ext-port-out", "JumpAdd-port-in2")
)
wire.intersection("wImmALU.zig")
wire.wire(
"wJumpPC", ("JumpAdd-port-out", "PCMux-port-in1"),
style: "dodge",
dodge-sides: ("east", "west"),
dodge-y: -8,
dodge-margins: (1, 1),
name: "PCTarget",
name-pos: "start"
)
wire.wire(
"wSrcA", ("RegFile-port-RD1", "ALU-port-in1"),
name: "SrcA",
name-pos: "end"
)
wire.wire(
"wSrcB", ("SrcBMux-port-out", "ALU-port-in2"),
name: "SrcB",
name-pos: "end"
)
wire.wire(
"wZero", (
("ALU.north-east", 50%, "ALU-port-out"),
"Ctrl-port-zero"
),
style: "dodge",
dodge-sides: ("east", "west"),
dodge-y: 3,
dodge-margins: (1.5, 1),
name: "Zero",
name-pos: "start"
)
wire.wire(
"wALURes1", ("ALU-port-out", "DMem-port-A"),
name: "ALUResult",
name-pos: "start"
)
wire.wire(
"wALURes2", ("ALU-port-out", "ResMux-port-in0"),
style: "dodge",
dodge-sides: ("east", "west"),
dodge-y: 2,
dodge-margins: (3, 2)
)
wire.intersection("wALURes2.start2")
wire.stub("DMem-port-clk", "north", name: "clk", length: 0.25)
wire.wire(
"wRD", ("DMem-port-RD", "ResMux-port-in1"),
name: "ReadData",
name-pos: "start"
)
wire.wire(
"wRes", ("ResMux-port-out", "RegFile-port-WD3"),
style: "dodge",
dodge-sides: ("east", "west"),
dodge-y: -7.5,
dodge-margins: (1, 2)
)
draw.content(
"wRes.dodge-start",
"Result",
anchor: "south-east",
padding: 5pt
)
// Other wires
draw.group({
draw.stroke(util.colors.blue)
draw.line(name: "wPCSrc",
"Ctrl-port-PCSrc",
(horizontal: "RegFile.east", vertical: ()),
(horizontal: (), vertical: (rel: (0, 0.5), to: "Ctrl.north")),
(horizontal: "PCMux.north", vertical: ()),
"PCMux.north"
)
draw.line(name: "wResSrc",
"Ctrl-port-ResSrc",
(horizontal: "ResMux.north", vertical: ()),
"ResMux.north"
)
draw.line(name: "wMemWrite",
"Ctrl-port-MemWrite",
(horizontal: "DMem-port-WE", vertical: ()),
"DMem-port-WE"
)
draw.line(name: "wALUCtrl",
"Ctrl-port-ALUCtrl",
(horizontal: "ALU.north", vertical: ()),
"ALU.north"
)
draw.line(name: "wALUSrc",
"Ctrl-port-ALUSrc",
(horizontal: "SrcBMux.north", vertical: ()),
"SrcBMux.north"
)
draw.line(name: "wImmSrc",
"Ctrl-port-ImmSrc",
(rel: (1, 0), to: (horizontal: "RegFile.east", vertical: ())),
(horizontal: (), vertical: (rel: (0, -.5), to: "RegFile.south")),
(horizontal: "Ext.north", vertical: ()),
"Ext.north"
)
draw.line(name: "wRegWrite",
"Ctrl-port-RegWrite",
(rel: (.5, 0), to: (horizontal: "RegFile.east", vertical: ())),
(horizontal: (), vertical: ("Ctrl.south", 50%, "RegFile.north")),
(horizontal: "RegFile-port-WE3", vertical: ()),
"RegFile-port-WE3"
)
let names = (
"PCSrc": "PCSrc",
"ResSrc": "ResultSrc",
"MemWrite": "MemWrite",
"ALUCtrl": [ALUControl#sub("[2:0]")],
"ALUSrc": "ALUSrc",
"ImmSrc": [ImmSrc#sub("[1:0]")],
"RegWrite": "RegWrite"
)
for (port, name) in names {
draw.content("Ctrl-port-"+port, name, anchor: "south-west", padding: 3pt)
}
})
})

BIN
gallery/test6.pdf Normal file

Binary file not shown.

BIN
gallery/test6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

194
gallery/test6.typ Normal file
View File

@ -0,0 +1,194 @@
#import "/src/cetz.typ": draw, vector
#import "../src/lib.typ": *
#set page(width: auto, height: auto, margin: .5cm)
#circuit({
element.multiplexer(
x: 10, y: 0, w: 1, h: 6, id: "ResMux",
entries: ("000", "001", "010", "011", "101"),
h-ratio: 90%,
fill: util.colors.blue
)
element.extender(
x: (rel: -3, to: "ResMux.west"),
y: (from: "ResMux-port-in4", to: "out"),
w: 2, h: 1, id: "Ext",
name: "Zero Ext",
name-anchor: "south",
fill: util.colors.green
)
gates.gate-or(
x: (rel: -2, to: "ResMux.west"),
y: (from: "ResMux-port-in3", to: "out"),
w: 1, h: 1, id: "Or"
)
gates.gate-and(
x: (rel: -2, to: "ResMux.west"),
y: (from: "ResMux-port-in2", to: "out"),
w: 1, h: 1, id: "And"
)
element.alu(
x: (rel: -2.5, to: "Ext.west"),
y: (from: "ResMux-port-in0", to: "out"),
w: 1.5, h: 3, id: "Add",
name: text("+", size: 1.5em),
name-anchor: "name",
fill: util.colors.pink
)
element.multiplexer(
x: (rel: -1.5, to: "Add.west"),
y: (from: "Add-port-in1", to: "out"),
w: 0.5, h: 1.5, id: "NotMux",
h-ratio: 80%,
fill: util.colors.blue
)
gates.gate-not(
x: (rel: -2, to: "NotMux.west"),
y: (from: "NotMux-port-in1", to: "out"),
w: 1, h: 1, id: "Not"
)
draw.hide(
draw.line(name: "l1",
"Not-port-in0",
(rel: (-2, 0), to: ()),
(horizontal: (), vertical: "NotMux-port-in0")
)
)
let b = "l1.end"
draw.hide(
draw.line(name: "l2",
b,
(horizontal: (), vertical: "Add-port-in2")
)
)
let a = "l2.end"
wire.wire("wB0", (b, "NotMux-port-in0"), bus: true)
wire.wire(
"wB1", (b, "Not-port-in0"),
style: "zigzag",
zigzag-ratio: 1.5,
bus: true
)
wire.wire(
"wB2", (b, "And-port-in0"),
style: "zigzag",
zigzag-ratio: 1,
bus: true
)
wire.wire(
"wB3", (b, "Or-port-in0"),
style: "zigzag",
zigzag-ratio: 1,
bus: true
)
wire.intersection("wB1.zig")
wire.intersection("wB2.zig")
wire.intersection("wB2.zag")
wire.wire("wNot", ("Not-port-out", "NotMux-port-in1"), bus: true)
wire.wire("wAddA", ("NotMux-port-out", "Add-port-in1"), bus: true)
wire.wire("wA0", (a, "Add-port-in2"), bus: true)
wire.wire(
"wA1", (a, "And-port-in1"),
style: "zigzag",
zigzag-ratio: 0.5,
bus: true
)
wire.wire(
"wA2", (a, "Or-port-in1"),
style: "zigzag",
zigzag-ratio: 0.5,
bus: true
)
wire.intersection("wA1.zig")
wire.intersection("wA1.zag")
wire.wire("wMux0", ("Add-port-out", "ResMux-port-in0"), bus: true)
wire.wire(
"wMux1", ("Add-port-out", "ResMux-port-in1"),
style: "zigzag",
zigzag-ratio: 2,
bus: true
)
wire.wire("wMux2", ("And-port-out", "ResMux-port-in2"), bus: true)
wire.wire("wMux3", ("Or-port-out", "ResMux-port-in3"), bus: true)
wire.wire("wMux4", ("Ext-port-out", "ResMux-port-in4"), bus: true)
wire.wire(
"wAdd", ("Add-port-out", "Ext-port-in"),
style: "zigzag",
zigzag-ratio: 0.5,
bus: true
)
wire.intersection("wMux1.zig")
wire.intersection("wAdd.zig")
let c = (rel: (0, 2), to: "ResMux.north")
wire.wire("wResCtrl", (c, "ResMux.north"), bus: true)
wire.wire(
"wAddCtrl", (c, "Add.north"),
style: "zigzag",
zigzag-dir: "horizontal"
)
let d = (rel: (1, 0), to: "ResMux-port-out")
wire.wire("wRes", ("ResMux-port-out", d), bus: true)
draw.content(
"wAddCtrl.zag",
[ALUControl#sub("[1]")],
anchor: "south-west",
padding: 3pt
)
wire.wire(
"wCout", ("Add.south", (horizontal: (), vertical: "Ext.north-east"))
)
draw.content(
"wCout.end",
[C#sub("out")],
angle: 90deg,
anchor: "east",
padding: 3pt
)
draw.content(
a,
[A],
angle: 90deg,
anchor: "south",
padding: 3pt
)
draw.content(
b,
[B],
angle: 90deg,
anchor: "south",
padding: 3pt
)
draw.content(
c,
[ALUControl#sub("[2:0]")],
angle: 90deg,
anchor: "west",
padding: 3pt
)
draw.content(
d,
[Result],
angle: 90deg,
anchor: "north",
padding: 3pt
)
draw.content(
("wAdd.zig", 0.2, "wAdd.zag"),
text("[N-1]", size: 0.8em),
angle: 90deg,
anchor: "north-east",
padding: 3pt
)
})

11
justfile Normal file
View File

@ -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

Binary file not shown.

View File

@ -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 "/src/cetz.typ": 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,

1
src/cetz.typ Normal file
View File

@ -0,0 +1 @@
#import "@preview/cetz:0.3.4": *

View File

@ -1,4 +1,4 @@
#import "@preview/cetz:0.2.2": canvas
#import "/src/cetz.typ": canvas
#import "@preview/tidy:0.3.0"
/// Draws a block circuit diagram
@ -9,6 +9,52 @@
/// - length (length, ratio): Optional base unit
/// -> none
#let circuit(body, length: 2em) = {
set text(font: "Source Sans 3")
canvas(length: length, body)
let next-id = 0
let elements = (:)
let ids = ()
for e in body {
if type(e) == dictionary and "id" in e {
ids.push(e.id)
}
}
for element in body {
let internal = type(element) == dictionary and "id" in element
let eid = if internal {element.id} else {auto}
if eid == auto {
while str(next-id) in ids {
next-id += 1
}
eid = str(next-id)
ids.push(eid)
if internal {
element.id = eid
}
next-id += 1
}
if eid in elements {
panic("An element with the id '" + eid + "' already exists. Please use a different id")
}
elements.insert(eid, element)
}
for element in elements.values() {
if type(element) == dictionary and "pre-process" in element {
elements = (element.pre-process)(elements, element)
assert(
type(elements) == dictionary,
message: "The `pre-process` method of element '" + element.id + "' did not return the elements dictionary"
)
}
}
canvas(length: length, {
for element in elements.values() {
if type(element) == dictionary and "draw" in element {
(element.draw)(element)
} else {
(element,)
}
}
})
}

View File

@ -1,40 +1,40 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "element.typ"
#import "ports.typ": add-port
#import "../util.typ"
#let draw-shape(elmt, bounds) = {
let tl = bounds.tl
let tr = bounds.tr
let bl = bounds.bl
let br = bounds.br
#let draw-shape(id, tl, tr, br, bl, fill, stroke) = {
let p0 = tl
let p1 = (tr, 10%, br)
let p2 = (tr, 90%, br)
let p1 = util.lerp(tr, 10%, br)
let p2 = util.lerp(tr, 90%, br)
let p3 = bl
let p4 = (tl, 55%, bl)
let p5 = (tl, 50%, br)
let p6 = (tl, 45%, bl)
let p4 = util.lerp(tl, 55%, bl)
let p5 = util.lerp(tl, 50%, br)
let p6 = util.lerp(tl, 45%, bl)
let f1 = draw.group(name: id, {
draw.merge-path(
inset: 0.5em,
fill: fill,
stroke: stroke,
close: true,
draw.line(p0, p1, p2, p3, p4, p5, p6)
)
draw.anchor("north", (p0, 50%, p1))
draw.anchor("south", (p2, 50%, p3))
draw.anchor("west", (p0, 50%, p3))
draw.anchor("east", (p1, 50%, p2))
})
let f2 = add-port(id, "west", (id: "in1"), (p0, 50%, p6))
let f3 = add-port(id, "west", (id: "in2"), (p3, 50%, p4))
let f4 = add-port(id, "east", (id: "out"), (p1, 50%, p2))
let bounds2 = element.complete-bounds(elmt, (
tl: p0,
tr: p1,
br: p2,
bl: p3
))
let f = {
f1; f2; f3; f4
draw.line(
p0, p1, p2, p3, p4, p5, p6,
fill: elmt.fill,
stroke: elmt.stroke,
close: true
)
draw.anchor("name", (p5, 50%, (p1, 50%, p2)))
}
return (f, tl, tr, br, bl)
return (f, bounds2)
}
/// Draws an ALU with two inputs
@ -42,18 +42,7 @@
/// #examples.alu
/// For parameters description, see #doc-ref("element.elmt")
#let alu(
x: none,
y: none,
w: none,
h: none,
name: none,
name-anchor: "center",
fill: none,
stroke: black + 1pt,
id: "",
debug: (
ports: false
)
..args
) = {
let ports = (
west: (
@ -65,23 +54,18 @@
)
)
element.elmt(
return element.elmt(
draw-shape: draw-shape,
x: x,
y: y,
w: w,
h: h,
name: name,
name-anchor: name-anchor,
ports: ports,
fill: fill,
stroke: stroke,
id: id,
auto-ports: false,
ports-y: (
in1: (h) => {h * 0.225},
in2: (h) => {h * 0.775},
ports-pos: (
west: (
in1: l => l * 0.225,
in2: l => l * 0.775,
),
debug: debug
east: (
out: l => l * 0.5
)
),
..args
)
}

View File

@ -1,16 +1,15 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "element.typ"
#let draw-shape(id, tl, tr, br, bl, fill, stroke) = {
#let draw-shape(elmt, bounds) = {
let f = draw.rect(
radius: 0.5em,
inset: 0.5em,
fill: fill,
stroke: stroke,
name: id,
bl, tr
fill: elmt.fill,
stroke: elmt.stroke,
bounds.bl, bounds.tr
)
return (f, tl, tr, br, bl)
return (f, bounds)
}
/// Draws a block element
@ -18,32 +17,9 @@
/// #examples.block
/// For parameters description, see #doc-ref("element.elmt")
#let block(
x: none,
y: none,
w: none,
h: none,
name: none,
name-anchor: "center",
ports: (),
ports-margins: (),
fill: none,
stroke: black + 1pt,
id: "",
debug: (
ports: false
)
..args
) = element.elmt(
cls: "block",
draw-shape: draw-shape,
x: x,
y: y,
w: w,
h: h,
name: name,
name-anchor: name-anchor,
ports: ports,
ports-margins: ports-margins,
fill: fill,
stroke: stroke,
id: id,
debug: debug
..args
)

View File

@ -1,5 +1,6 @@
#import "@preview/cetz:0.2.2": draw, coordinate
#import "ports.typ": add-ports, add-port
#import "/src/cetz.typ": draw, coordinate, matrix, vector
#import "ports.typ": add-ports, add-port, get-port-pos, get-port-idx
#import "../util.typ"
#let find-port(ports, id) = {
for (side, side-ports) in ports {
@ -9,13 +10,234 @@
}
}
}
panic("Could not find port with id " + str(id))
panic("Could not find port with id '" + str(id) + "' in ports " + repr(ports))
}
#let default-draw-shape(id, tl, tr, br, bl, fill, stroke) = {
return ({}, tl, tr, br, bl)
#let local-to-global(origin, u, v, points) = {
return points-real = points.map(p => {
let (pu, pv) = p
return vector.add(
origin,
vector.add(
vector.scale(u, pu),
vector.scale(v, pv)
)
)
})
}
#let default-draw-shape(elmt, bounds) = {
return ({}, bounds)
}
#let default-pre-process(elements, element) = {
return elements
}
#let resolve-offset(ctx, offset, from, axis) = {
let (ctx, pos) = coordinate.resolve(
ctx,
(rel: offset, to: from)
)
return pos.at(axis)
}
#let resolve-align(ctx, elmt, bounds, align, with, axis) = {
let (align-side, i) = find-port(elmt.ports, align)
let margins = (0%, 0%)
if align-side in elmt.ports-margins {
margins = elmt.ports-margins.at(align-side)
}
let parallel-sides = (
("north", "south"),
("west", "east")
).at(axis)
let ortho-sides = (
("west", "east"),
("north", "south")
).at(axis)
let dl
let start-margin
let len = elmt.size.at(axis)
if align-side in parallel-sides {
let used-pct = 100% - margins.at(0) - margins.at(1)
let used-len = len * used-pct / 100%
start-margin = len * margins.at(0) / 100%
//dl = used-len * (i + 1) / (elmt.ports.at(align-side).len() + 1)
dl = get-port-pos(elmt, bounds, align-side, align, get-port-idx(elmt, align, side: align-side))
/*if not elmt.auto-ports {
start-margin = 0
dl = elmt.ports-pos.at(align)(len)
}*/
} else if align-side == ortho-sides.first() {
dl = 0
start-margin = 0
} else {
dl = len
start-margin = 0
}
if axis == 1 {
dl = len - dl
}
let (ctx, with-pos) = coordinate.resolve(ctx, with)
return with-pos.at(axis) - dl + start-margin
}
#let resolve-coordinate(ctx, elmt, bounds, coord, axis) = {
if type(coord) == dictionary {
let offset = coord.at("offset", default: none)
let from = coord.at("from", default: none)
let align = coord.at("align", default: none)
let with = coord.at("with", default: none)
if none not in (offset, from) {
if type(offset) != array {
let a = (0, 0)
a.at(axis) = offset
offset = a
}
return resolve-offset(ctx, offset, from, axis)
} else if none not in (align, with) {
return resolve-align(ctx, elmt, bounds, align, with, axis)
} else {
panic("Dictionnary must either provide both 'offset' and 'from', or 'align' and 'with'")
}
}
if type(coord) not in (int, float, length) {
panic("Invalid " + "xy".at(axis) + " coordinate: " + repr(coord))
}
return coord
}
#let complete-bounds(elmt, bounds) = {
let b = bounds
bounds += (
center: (
(b.br.at(0) + b.tl.at(0))/2,
(b.br.at(1) + b.tl.at(1))/2
),
b: (
(b.br.at(0) + b.bl.at(0))/2,
(b.br.at(1) + b.bl.at(1))/2
),
t: (
(b.tr.at(0) + b.tl.at(0))/2,
(b.tr.at(1) + b.tl.at(1))/2
),
l: (
(b.bl.at(0) + b.tl.at(0))/2,
(b.bl.at(1) + b.tl.at(1))/2
),
r: (
(b.br.at(0) + b.tr.at(0))/2,
(b.br.at(1) + b.tr.at(1))/2
),
sides: (
north: (bounds.tl, bounds.tr),
south: (bounds.bl, bounds.br),
west: (bounds.tl, bounds.bl),
east: (bounds.tr, bounds.br),
),
lengths: (
north: (bounds.tr.at(0) - bounds.tl.at(0)),
south: (bounds.br.at(0) - bounds.bl.at(0)),
west: (bounds.tl.at(1) - bounds.bl.at(1)),
east: (bounds.tr.at(1) - bounds.br.at(1)),
),
ports: (:)
)
for (side, props) in bounds.sides.pairs() {
let props2 = props
if side in elmt.ports-margins {
let (pt0, pt1) = props
let margins = elmt.ports-margins.at(side)
let a = util.lerp(pt0, margins.at(0), pt1)
let b = util.lerp(pt0, 100% - margins.at(1), pt1)
props2 = (a, b)
}
bounds.ports.insert(side, props2)
}
return bounds
}
#let make-bounds(elmt, x, y, w, h) = {
let w2 = w / 2
let h2 = h / 2
let bounds = (
bl: (x, y),
tl: (x, y + h),
tr: (x + w, y + h),
br: (x + w, y),
)
return complete-bounds(elmt, bounds)
}
#let render(draw-shape, elmt) = draw.group(name: elmt.id, ctx => {
let width = elmt.size.first()
let height = elmt.size.last()
let x = elmt.pos.first()
let y = elmt.pos.last()
let bounds = make-bounds(elmt, 0, 0, width, height)
x = resolve-coordinate(ctx, elmt, bounds, x, 0)
y = resolve-coordinate(ctx, elmt, bounds, y, 1)
bounds = make-bounds(elmt, x, y, width, height)
// Workaround because CeTZ needs to have all draw functions in the body
let func = {}
let res = draw-shape(elmt, bounds)
assert(
type(res) == array and res.len() == 2,
message: "The drawing function of element '" + elmt.id + "' did not return a function and new bounds"
)
(func, bounds) = res
if type(func) == function {
func = (func,)
}
assert(
type(bounds) == dictionary,
message: "The drawing function of element '" + elmt.id + "' did not return the correct bounds dictionary"
)
func
draw.anchor("north", bounds.t)
draw.anchor("south", bounds.b)
draw.anchor("west", bounds.l)
draw.anchor("east", bounds.r)
draw.anchor("north-west", bounds.tl)
draw.anchor("north-east", bounds.tr)
draw.anchor("south-east", bounds.br)
draw.anchor("south-west", bounds.bl)
if elmt.name != none {
draw.content(
(name: elmt.id, anchor: elmt.name-anchor),
anchor: if elmt.name-anchor in util.valid-anchors {elmt.name-anchor} else {"center"},
padding: 0.5em,
align(center)[*#elmt.name*]
)
}
add-ports(elmt, bounds)
if elmt.debug.bounds {
draw.line(
bounds.tl, bounds.tr, bounds.br, bounds.bl,
stroke: red,
close: true
)
}
})
/// Draws an element
/// - draw-shape (function): Draw function
/// - x (number, dictionary): The x position (bottom-left corner).
@ -44,90 +266,59 @@
/// Supported fields include:
/// - `ports`: if true, shows dots on all ports of the element
#let elmt(
cls: "element",
draw-shape: default-draw-shape,
x: none,
y: none,
w: none,
h: none,
pre-process: default-pre-process,
pos: (0, 0),
size: (1, 1),
name: none,
name-anchor: "center",
ports: (),
ports-margins: (),
ports: (:),
ports-margins: (:),
fill: none,
stroke: black + 1pt,
id: "",
auto-ports: true,
ports-y: (),
id: auto,
ports-pos: auto,
debug: (
bounds: false,
ports: false
),
extra: (:)
) = {
for (key, side-ports) in ports.pairs() {
if type(side-ports) == str {
side-ports = ((id: side-ports),)
} else if type(side-ports) == dictionary {
side-ports = (side-ports,)
}
for (i, port) in side-ports.enumerate() {
if type(port) == array {
side-ports.at(i) = (
id: port.at(0, default: ""),
name: port.at(1, default: "")
)
) = draw.get-ctx(ctx => {
let width = w
let height = h
let x = x
let y = y
if x == none { panic("Parameter x must be set") }
if y == none { panic("Parameter y must be set") }
if w == none { panic("Parameter w must be set") }
if h == none { panic("Parameter h must be set") }
if (type(x) == dictionary) {
let offset = x.rel
let to = x.to
let (ctx, to-pos) = coordinate.resolve(ctx, (rel: (offset, 0), to: to))
x = to-pos.at(0)
} else if type(port) == str {
side-ports.at(i) = (id: port)
}
}
ports.at(key) = side-ports
}
if (type(y) == dictionary) {
let from = y.from
let to = y.to
let (to-side, i) = find-port(ports, to)
let margins = (0%, 0%)
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 {
top-margin = 0
dy = ports-y.at(to)(height)
}
let (ctx, from-pos) = coordinate.resolve(ctx, from)
y = from-pos.at(1) + dy - height + top-margin
}
let tl = (x, y + height)
let tr = (x + width, y + height)
let br = (x + width, y)
let bl = (x, y)
// Workaround because CeTZ needs to have all draw functions in the body
let func = {}
(func, tl, tr, br, bl) = draw-shape(id, tl, tr, br, bl, fill, stroke)
func
if (name != none) {
draw.content(
(name: id, anchor: name-anchor),
anchor: name-anchor,
padding: 0.5em,
align(center)[*#name*]
)
}
if auto-ports {
add-ports(
id,
tl, tr, br, bl,
ports,
ports-margins,
debug: debug.ports
)
}
})
return ((
cls: cls,
id: id,
draw: render.with(draw-shape),
pre-process: pre-process,
pos: pos,
size: size,
name: name,
name-anchor: name-anchor,
ports: ports,
ports-margins: ports-margins,
fill: fill,
stroke: stroke,
ports-pos: ports-pos,
debug: debug
) + extra,)
}

View File

@ -1,69 +1,56 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "element.typ"
#import "ports.typ": add-port
#import "../util.typ"
#let draw-shape(id, tl, tr, br, bl, fill, stroke) = {
let (x, y) = bl
let (width, height) = (tr.at(0) - x, tr.at(1) - y)
#let draw-shape(elmt, bounds) = {
let ratio = elmt.l-ratio / 100%
let tl2 = util.lerp(bounds.bl, elmt.l-ratio, bounds.tl)
let bounds2 = element.complete-bounds(elmt, (
tl: tl2,
tr: bounds.tr,
br: bounds.br,
bl: bounds.bl,
))
tl = (x, y + height * 0.75)
let tr2 = (x + width, y + height * 0.75)
let br = (x + width, y)
(tr, tr2) = (tr2, tr)
let f = draw.group(name: id, {
draw.merge-path(
inset: 0.5em,
fill: fill,
stroke: stroke,
close: true,
draw.line(tl, tr2, br, bl)
let f = draw.line(
bounds2.tl, bounds2.tr, bounds2.br, bounds2.bl,
fill: elmt.fill,
stroke: elmt.stroke,
close: true
)
draw.anchor("north", (tl, 50%, tr2))
draw.anchor("south", (bl, 50%, br))
draw.anchor("west", (tl, 50%, bl))
draw.anchor("east", (tr2, 50%, br))
})
return (f, tl, tr, br, bl)
return (f, bounds2)
}
/// Draws a bit extender
///
/// #examples.extender
/// For parameters description, see #doc-ref("element.elmt")
/// For other parameters description, see #doc-ref("element.elmt")
/// - h-ratio (ratio): The height ratio of the left side relative to the full height
/// - align-out (bool): If true, the output and input ports are aligned, otherwise, the output port is centered on the right side
#let extender(
x: none,
y: none,
w: none,
h: none,
name: none,
name-anchor: "center",
fill: none,
stroke: black + 1pt,
id: "",
debug: (
ports: false
)
l-ratio: 75%,
align-out: true,
..args
) = {
let ports = (
west: (
(id: "in"),
),
east: (
(id: "out"),
west: ((id: "in"),),
east: ((id: "out"),)
)
let out-pct = if align-out {l-ratio / 2} else {50%}
let ports-pos = (
"east": (l, i) => {l - l * (out-pct / 100%)}
)
element.elmt(
return element.elmt(
cls: "extender",
draw-shape: draw-shape,
x: x,
y: y,
w: w,
h: h,
name: name,
name-anchor: name-anchor,
ports: ports,
fill: fill,
stroke: stroke,
id: id,
debug: debug
ports-pos: ports-pos,
extra: (
l-ratio: l-ratio,
align-out: align-out
),
..args
)
}

View File

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

View File

@ -1,12 +1,12 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "gate.typ"
#let draw-shape(id, tl, tr, br, bl, fill, stroke) = {
let (x, y) = bl
let (width, height) = (tr.at(0) - x, tr.at(1) - y)
let t = (x + width / 4, y + height)
let b = (x + width / 4, y)
let t = (x + width / 2, y + height)
let b = (x + width / 2, y)
let f = draw.group(name: id, {
draw.merge-path(
@ -16,7 +16,7 @@
name: id + "-path",
close: true, {
draw.line(bl, tl, t)
draw.bezier((), b, tr, br)
draw.arc-through((), (tr , 50%, br), b)
draw.line((), b)
}
)

View File

@ -1,4 +1,4 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "gate.typ"
#let draw-shape(id, tl, tr, br, bl, fill, stroke) = {
@ -33,7 +33,7 @@
y: none,
w: none,
h: none,
inputs: 2,
inputs: 1,
fill: none,
stroke: black + 1pt,
id: "",
@ -65,7 +65,7 @@
y: none,
w: none,
h: none,
inputs: 2,
inputs: 1,
fill: none,
stroke: black + 1pt,
id: "",

View File

@ -1,4 +1,4 @@
#import "@preview/cetz:0.2.2": draw, coordinate
#import "/src/cetz.typ": draw, coordinate
#import "../ports.typ": add-ports, add-port
#import "../element.typ"
@ -33,7 +33,7 @@
stroke: black + 1pt,
id: "",
inverted: (),
inverted-radius: 0.2,
inverted-radius: 0.1,
debug: (
ports: false
)
@ -58,19 +58,16 @@
if (type(y) == dictionary) {
let from = y.from
let to = y.to
let (to-side, i) = find-port(ports, to)
let margins = (0%, 0%)
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)
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 + top-margin
y = from-pos.at(1) + dy - height
}
let tl = (x, y + height)

View File

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

View File

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

View File

@ -1,24 +1,26 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "../util.typ"
#import "element.typ"
#import "ports.typ": add-port
#let draw-shape(id, tl, tr, br, bl, fill, stroke) = {
let tr2 = (tr, 20%, br)
let br2 = (tr, 80%, br)
let f = draw.group(name: id, {
draw.merge-path(
inset: 0.5em,
fill: fill,
stroke: stroke,
#let draw-shape(elmt, bounds) = {
let margin = (100% - elmt.l-ratio) / 2
let tr2 = util.lerp(bounds.tr, margin, bounds.br)
let br2 = util.lerp(bounds.br, margin, bounds.tr)
let bounds2 = element.complete-bounds(elmt, (
tl: bounds.tl,
bl: bounds.bl,
tr: tr2,
br: br2,
))
let f = draw.line(
bounds2.tl, bounds2.tr, bounds2.br, bounds2.bl,
close: true,
draw.line(tl, tr2, br2, bl)
fill: elmt.fill,
stroke: elmt.stroke
)
draw.anchor("north", (tl, 50%, tr2))
draw.anchor("south", (bl, 50%, br2))
draw.anchor("west", (tl, 50%, bl))
draw.anchor("east", (tr2, 50%, br2))
})
return (f, tl, tr, br, bl)
return (f, bounds2)
}
/// Draws a multiplexer
@ -26,47 +28,46 @@
/// #examples.multiplexer
/// For other parameters description, see #doc-ref("element.elmt")
/// - entries (int, array): If it is an integer, it defines the number of input ports (automatically named with their binary index). If it is an array of strings, it defines the name of each input.
/// - h-ratio (ratio): The height ratio of the right side relative to the full height
#let multiplexer(
x: none,
y: none,
w: none,
h: none,
name: none,
name-anchor: "center",
entries: 2,
fill: none,
stroke: black + 1pt,
id: "",
debug: (
ports: false
)
l-ratio: 60%,
..args
) = {
let ports = ()
let in-ports = ()
let ports-pos = (
"east": auto,
)
if (type(entries) == int) {
let nbits = calc.ceil(calc.log(entries, base: 2))
for i in range(entries) {
let bits = util.lpad(str(i, base: 2), nbits)
ports.push((id: "in" + str(i), name: bits))
in-ports.push((id: "in" + str(i), name: bits))
}
} else {
for (i, port) in entries.enumerate() {
ports.push((id: "in" + str(i), name: port))
in-ports.push((id: "in" + str(i), name: port))
}
}
let n = in-ports.len()
ports-pos.insert("west", (l, i) => {l * (i + 0.5) / n})
element.elmt(
cls: "multiplexer",
draw-shape: draw-shape,
x: x,
y: y,
w: w,
h: h,
name: name,
name-anchor: name-anchor,
ports: (west: ports, east: ((id: "out"),)),
fill: fill,
stroke: stroke,
id: id,
debug: debug
ports: (west: in-ports, east: ((id: "out"),)),
ports-pos: ports-pos,
extra: (l-ratio: l-ratio),
..args
)
/*
for (i, port) in ports.enumerate() {
let pct = (i + 0.5) * space
add-port(id, "west", port, (id+".north-west", pct, id+".south-west"))
}
add-port(id, "east", (id: "out"), (id+".north-east", 50%, id+".south-east"))
*/
}

View File

@ -1,6 +1,76 @@
#import "@preview/cetz:0.2.2": draw
#import "/src/cetz.typ": draw
#import "../util.typ": rotate-anchor
#let get-port-side(elmt, port) = {
for (side, ports) in elmt.ports {
for p in ports {
if p.id == port {
return side
}
}
}
panic(
"Unknown port '" + port + "' on element '" + elmt.id + "', could not automatically determine side"
)
}
#let get-port-idx(elmt, port, side: auto) = {
if side == auto {
side = get-port-side(elmt, port)
}
assert(
side in elmt.ports,
message: "No ports on side '" + side + "' of element '" + elmt.id + "'"
)
let i = elmt.ports.at(side).position(p => p.id == port)
assert(
i != none,
message: "Could not find port '" + port + "' on side '" + side + "' of element '" + elmt.id + "'"
)
return i
}
#let get-port-pos(elmt, bounds, side, port, port-i) = {
let (pt0, pt1) = bounds.ports.at(side)
let side-len = if side in ("north", "south") {
pt1.at(0) - pt0.at(0)
} else {
pt0.at(1) - pt1.at(1)
}
let offset = if (
elmt.ports-pos == auto or
elmt.ports-pos.at(side, default: auto) == auto
) {
let space = 100% / (elmt.ports.at(side, default: ()).len() + 1)
(port-i + 1) * space
} else {
assert(
side in elmt.ports-pos,
message: "Could not reliably compute port position (missing side)"
)
let side-pos = elmt.ports-pos.at(side)
if type(side-pos) == function {
(side-pos)(side-len, port-i)
} else if type(side-pos) == array {
(side-pos.at(i))(side-len)
} else if type(side-pos) == dictionary {
assert(
port in side-pos,
message: "Could not reliably compute port position (missing port)"
)
(side-pos.at(port))(side-len)
} else {
panic("Could not reliably compute port position (invalid type)")
}
}
if type(offset) == ratio {
offset = offset * side-len / 100%
}
return offset
}
#let add-port(
elmt-id, side, port, pos,
prev: none,
@ -15,11 +85,12 @@
panic("Clock port must have previous and next positions")
}
let size = if port.at("small", default: false) {8pt} else {1em}
let offset
if (side == "north") { offset = ( 0, -1em) }
else if (side == "east") { offset = (-1em, 0) }
else if (side == "south") { offset = ( 0, 1em) }
else if (side == "west") { offset = ( 1em, 0) }
if (side == "north") { offset = ( 0, -size) }
else if (side == "east") { offset = (-size, 0) }
else if (side == "south") { offset = ( 0, size) }
else if (side == "west") { offset = ( size, 0) }
let pos1 = (rel: offset, to: pos)
@ -33,12 +104,10 @@
angle: if name-rotate {90deg} else {0deg},
name
)
let id = elmt-id + "-port-" + port.at("id")
if debug {
draw.circle(
pos,
name: id,
radius: .1,
stroke: none,
fill: red
@ -48,56 +117,56 @@
draw.hide(draw.circle(
pos,
radius: 0,
stroke: none,
name: id
stroke: none
))
}
draw.anchor(port.id, pos)
}
#let add-ports(
elmt-id,
tl, tr, br, bl,
ports,
ports-margins,
debug: false
elmt,
bounds
) = {
let sides = (
"north": (tl, tr),
"east": (tr, br),
"south": (bl, br),
"west": (tl, bl)
)
let debug = elmt.debug.at("ports", default: false)
if type(ports) != dictionary {
if type(elmt.ports) != dictionary {
return
}
for (side, props) in sides {
let side-ports = ports.at(side, default: ())
for (side, props) in bounds.ports {
let side-ports = elmt.ports.at(side, default: ())
let space = 100% / (side-ports.len() + 1)
let (pt0, pt1) = props
let side-len = if side in ("north", "south") {
pt1.at(0) - pt0.at(0)
} else {
pt0.at(1) - pt1.at(1)
}
for (i, port) in side-ports.enumerate() {
let pct = (i + 1) * space
let pt0 = props.at(0)
let pt1 = props.at(1)
let offset = get-port-pos(elmt, bounds, side, port.id, i)
if side in ports-margins {
let (a, b) = (pt0, pt1)
let margins = ports-margins.at(side)
a = (pt0, margins.at(0), pt1)
b = (pt0, 100% - margins.at(1), pt1)
pt0 = a
pt1 = b
let pos = (pt0, offset, pt1)
let offset-prev = if type(offset) == ratio {
offset - space / 2
} else {
offset - space * side-len / 200%
}
let offset-next = if type(offset) == ratio {
offset + space / 2
} else {
offset + space * side-len / 200%
}
let pos-prev = (pt0, offset-prev, pt1)
let pos-next = (pt0, offset-next, pt1)
if port.at("small", default: false) {
pos-prev = (pos, 4pt, pt0)
pos-next = (pos, 4pt, pt1)
}
let pos = (pt0, pct, pt1)
let pct-prev = (i + 0.5) * space
let pct-next = (i + 1.5) * space
let pos-prev = (pt0, pct-prev, pt1)
let pos-next = (pt0, pct-next, pt1)
add-port(
elmt-id,
elmt.id,
side,
port,
pos,

View File

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

View File

@ -69,3 +69,15 @@
south-west: "north-west"
).at(anchor)
}
#let valid-anchors = (
"center", "north", "east", "west", "south",
"north-east", "north-west", "south-east", "south-west"
)
#let lerp(pt0, ratio, pt1) = {
return (
(pt1.at(0) - pt0.at(0)) * ratio / 100% + pt0.at(0),
(pt1.at(1) - pt0.at(1)) * ratio / 100% + pt0.at(1)
)
}

View File

@ -1,5 +1,7 @@
#import "@preview/cetz:0.2.2": draw, coordinate
#import "/src/cetz.typ": draw, coordinate
#import "util.typ": opposite-anchor
#import "elements/ports.typ": get-port-side
#import "elements/element.typ"
/// List of valid wire styles
/// #examples.wires
@ -7,7 +9,12 @@
#let signal-width = 1pt
#let bus-width = 1.5pt
#let intersection(pt, radius: .2, fill: black) = {
/// Draws a wire intersection at the given anchor
/// #examples.intersection
/// - pt (point): A CeTZ compatible point / anchor
/// - radius (number): The radius of the intersection
/// - fill (color): The fill color
#let intersection(pt, radius: .1, fill: black) = {
draw.circle(pt, radius: radius, stroke: none, fill: fill)
}
@ -22,7 +29,11 @@
#let get-zigzag-wire(pts, ratio, dir) = {
let start = pts.first()
let end = pts.last()
let mid = (start, ratio, end)
let mid = if dir == "vertical" {
(start, ratio, (horizontal: end, vertical: ()))
} else {
(start, ratio, (horizontal: (), vertical: end))
}
let points = if dir == "vertical" {
(
@ -119,10 +130,11 @@
/// - 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,
pt0,
pt1,
id: none,
bus: false,
name: none,
name-pos: "middle",
slice: none,
color: black,
dashed: false,
@ -134,15 +146,14 @@
zigzag-dir: "vertical",
dodge-y: 0,
dodge-sides: ("east", "west"),
dodge-margins: (5%, 5%)
dodge-margins: (5%, 5%),
..args
) = draw.get-ctx(ctx => {
if not style in wire-styles {
panic("Invalid wire style '" + style + "'")
}
if pts.len() != 2 {
panic("Wrong number of points (got " + str(pts.len()) + " instead of 2)")
}
let pts = (pt0, pt1)
let stroke = (
paint: color,
@ -188,15 +199,18 @@
let second-pos = points.at(1)
if reverse {
(first-pt, last-pt) = (last-pt, first-pt)
(first-pos, second-pos) = (second-pos, first-pos)
}
let angle = 0deg
if rotate-name {
(ctx, first-pos) = coordinate.resolve(ctx, first-pos)
(ctx, second-pos) = coordinate.resolve(ctx, second-pos)
let (x1, y1, _) = first-pos
let (x2, y2, _) = second-pos
if reverse {
(first-pos, second-pos) = (second-pos, first-pos)
}
let (x1, y1, ..) = first-pos
let (x2, y2, ..) = second-pos
angle = calc.atan2(x2 - x1, y2 - y1)
}
@ -204,7 +218,7 @@
let names = ()
if type(name) == str {
names = ((name, name-pos),)
names = ((name, "middle"),)
} else if type(name) == array {
names = (
@ -214,6 +228,9 @@
}
for (name, pos) in names {
if name == none {
continue
}
let point
let anchor
@ -235,8 +252,7 @@
}
if slice != none {
let (start, end) = slice
let slice-txt = "[" + str(start) + ":" + str(end) + "]"
let slice-txt = "[" + slice.map(b => str(b)).join(":") + "]"
draw.content(
first-pt,
@ -256,7 +272,31 @@
/// - 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) = {
#let stub(anchor, side: auto, name: none, vertical: false, length: 1em, name-offset: 0) = {
if "." not in anchor {
panic("`anchor` must be a valid anchor of an element")
}
let parts = anchor.split(".")
let port-id = parts.last()
let port-elmt-id = parts.slice(0, -1).join(".")
let pre-process = (elements, elmt) => {
let eid = elmt.id
let side = side
if side == auto {
if port-elmt-id not in elements {
panic("Unknown element " + port-elmt-id)
}
let port-elmt = elements.at(port-elmt-id)
side = get-port-side(port-elmt, port-id)
}
elements.at(eid).insert("side", side)
return elements
}
let draw-func(elmt, bounds) = {
let side = elmt.side
let end-offset = (
north: (0, length),
east: (length, 0),
@ -271,9 +311,10 @@
west: (-length, name-offset)
).at(side)
draw.line(
port-id,
(rel: end-offset, to: port-id)
let shapes = ()
shapes += draw.line(
anchor,
(rel: end-offset, to: anchor)
)
if name != none {
let text-anchor = if vertical {
@ -284,12 +325,20 @@
"east": "north"
).at(side)
} else { opposite-anchor(side) }
draw.content(
shapes += draw.content(
anchor: text-anchor,
padding: 0.2em,
angle: if vertical {90deg} else {0deg},
(rel: name-offset, to: port-id),
(rel: name-offset, to: anchor),
name
)
}
return (shapes, bounds)
}
return element.elmt(
draw-shape: draw-func,
pre-process: pre-process
)
}

View File

@ -1,7 +1,7 @@
[package]
name = "circuiteria"
version = "0.0.2"
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/*" ]
exclude = [ "gallery", "justfile", "doc" ]