Compare commits

...

11 Commits

24 changed files with 921 additions and 414 deletions

View File

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

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)
})

View File

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

View File

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

View File

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

View File

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

View File

@ -1,5 +1,5 @@
#import "@preview/tidy:0.4.1"
#import "@preview/cetz:0.3.2": draw, canvas
#import "/src/cetz.typ": draw, canvas
#import "src/lib.typ"
#import "doc/examples.typ"
#import "src/circuit.typ": 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.3.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,45 +1,40 @@
#import "@preview/cetz:0.3.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 bounds2 = element.complete-bounds(elmt, (
tl: p0,
tr: p1,
br: p2,
bl: p3
))
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))
draw.anchor("north-west", p0)
draw.anchor("north-east", p1)
draw.anchor("south-east", p2)
draw.anchor("south-west", p3)
draw.anchor("name", (p5, 50%, (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 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
@ -47,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: (
@ -70,24 +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},
out: (h) => {h * 0.5}
ports-pos: (
west: (
in1: l => l * 0.225,
in2: l => l * 0.775,
),
east: (
out: l => l * 0.5
)
),
debug: debug
..args
)
}

View File

@ -1,16 +1,15 @@
#import "@preview/cetz:0.3.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,5 @@
#import "@preview/cetz:0.3.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) = {
@ -10,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).
@ -45,101 +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: (:),
fill: none,
stroke: black + 1pt,
id: "",
auto-ports: true,
ports-y: (:),
id: auto,
ports-pos: auto,
debug: (
bounds: false,
ports: false
)
) = 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)
}
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)
),
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,)
}
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)
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: "")
)
} else if type(port) == str {
side-ports.at(i) = (id: port)
}
} else if to-side == "north" {
dy = 0
top-margin = 0
} else if to-side == "south" {
dy = height
top-margin = 0
}
let (ctx, from-pos) = coordinate.resolve(ctx, from)
y = from-pos.at(1) + dy - height + top-margin
ports.at(key) = side-ports
}
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: if name-anchor in util.valid-anchors {name-anchor} else {"center"},
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,41 +1,25 @@
#import "@preview/cetz:0.3.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, h-ratio: 75%, align-out: true) = {
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,
))
let ratio = h-ratio / 100%
tl = (x, y + height * ratio)
let tr2 = (x + width, y + height * ratio)
let br = (x + width, y)
if align-out {
(tr, tr2) = (tr2, tr)
} else {
(tr, tr2) = (tr, 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)
)
draw.anchor("north", (tl, 50%, tr2))
draw.anchor("south", (bl, 50%, br))
draw.anchor("west", (tl, 50%, bl))
draw.anchor("east", (tr2, 50%, br))
draw.anchor("north-west", tl)
draw.anchor("north-east", tr2)
draw.anchor("south-east", br)
draw.anchor("south-west", bl)
})
return (f, tl, tr, br, bl)
let f = draw.line(
bounds2.tl, bounds2.tr, bounds2.br, bounds2.bl,
fill: elmt.fill,
stroke: elmt.stroke,
close: true
)
return (f, bounds2)
}
/// Draws a bit extender
@ -45,54 +29,28 @@
/// - 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: "",
h-ratio: 75%,
l-ratio: 75%,
align-out: true,
debug: (
ports: false
)
..args
) = {
let ports = (
west: (
(id: "in"),
),
east: (
(id: "out"),
)
west: ((id: "in"),),
east: ((id: "out"),)
)
let out-pct = if align-out {h-ratio / 2} else {50%}
let ports-y = (
"in": (h) => {h - h * (h-ratio / 200%)},
"out": (h) => {h - h * (out-pct / 100%)}
let out-pct = if align-out {l-ratio / 2} else {50%}
let ports-pos = (
"east": (l, i) => {l - l * (out-pct / 100%)}
)
element.elmt(
draw-shape: draw-shape.with(h-ratio: h-ratio, align-out: align-out),
x: x,
y: y,
w: w,
h: h,
name: name,
name-anchor: name-anchor,
return element.elmt(
cls: "extender",
draw-shape: draw-shape,
ports: ports,
auto-ports: false,
ports-y: ports-y,
fill: fill,
stroke: stroke,
id: id,
debug: debug
ports-pos: ports-pos,
extra: (
l-ratio: l-ratio,
align-out: align-out
),
..args
)
let in-pos = (rel: (0, h * (h-ratio / 200%)), to: id+".south-west")
let out-pos = (id+".south-east", out-pct, id+".north-east")
add-port(id, "west", ports.west.first(), in-pos)
add-port(id, "east", ports.east.first(), out-pos)
}

View File

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

View File

@ -1,4 +1,4 @@
#import "@preview/cetz:0.3.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.3.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.3.2": draw, coordinate
#import "/src/cetz.typ": draw, coordinate
#import "../ports.typ": add-ports, add-port
#import "../element.typ"

View File

@ -1,4 +1,4 @@
#import "@preview/cetz:0.3.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.3.2": draw
#import "/src/cetz.typ": draw
#import "gate.typ"
#let space = 10%

View File

@ -1,31 +1,26 @@
#import "@preview/cetz:0.3.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, h-ratio: 60%) = {
let margin = (100% - h-ratio) / 2
let tr2 = (tr, margin, br)
let br2 = (br, margin, tr)
let f = draw.group(name: id, {
draw.merge-path(
inset: 0.5em,
fill: fill,
stroke: stroke,
close: true,
draw.line(tl, tr2, br2, bl)
)
draw.anchor("north", (tl, 50%, tr2))
draw.anchor("south", (bl, 50%, br2))
draw.anchor("west", (tl, 50%, bl))
draw.anchor("east", (tr2, 50%, br2))
draw.anchor("north-west", tl)
draw.anchor("north-east", tr2)
draw.anchor("south-east", br2)
draw.anchor("south-west", bl)
})
#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,
fill: elmt.fill,
stroke: elmt.stroke
)
return (f, tl, tr, br, bl)
return (f, bounds2)
}
/// Draws a multiplexer
@ -35,64 +30,44 @@
/// - 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,
h-ratio: 60%,
fill: none,
stroke: black + 1pt,
id: "",
debug: (
ports: false
)
l-ratio: 60%,
..args
) = {
let ports = ()
let ports-y = (
out: (h) => {h * 0.5}
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 space = 100% / ports.len()
let l = ports.len()
for (i, port) in ports.enumerate() {
ports-y.insert(port.id, (h) => {h * (i + 0.5) / l})
}
let n = in-ports.len()
ports-pos.insert("west", (l, i) => {l * (i + 0.5) / n})
element.elmt(
draw-shape: draw-shape.with(h-ratio: h-ratio),
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,
ports-y: ports-y,
auto-ports: false,
debug: debug
cls: "multiplexer",
draw-shape: draw-shape,
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.3.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,
@ -34,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
@ -49,53 +117,48 @@
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 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)
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)
@ -103,7 +166,7 @@
}
add-port(
elmt-id,
elmt.id,
side,
port,
pos,

View File

@ -73,4 +73,11 @@
#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.3.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
@ -128,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,
@ -143,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,
@ -216,7 +218,7 @@
let names = ()
if type(name) == str {
names = ((name, name-pos),)
names = ((name, "middle"),)
} else if type(name) == array {
names = (
@ -226,6 +228,9 @@
}
for (name, pos) in names {
if name == none {
continue
}
let point
let anchor
@ -267,40 +272,73 @@
/// - 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 end-offset = (
north: (0, length),
east: (length, 0),
south: (0, -length),
west: (-length, 0)
).at(side)
let name-offset = (
north: (name-offset, length),
east: (length, name-offset),
south: (name-offset, -length),
west: (-length, name-offset)
).at(side)
draw.line(
port-id,
(rel: end-offset, to: port-id)
)
if name != none {
let text-anchor = if vertical {
(
"north": "west",
"south": "east",
"west": "south",
"east": "north"
).at(side)
} else { opposite-anchor(side) }
draw.content(
anchor: text-anchor,
padding: 0.2em,
angle: if vertical {90deg} else {0deg},
(rel: name-offset, to: port-id),
name
)
#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),
south: (0, -length),
west: (-length, 0)
).at(side)
let name-offset = (
north: (name-offset, length),
east: (length, name-offset),
south: (name-offset, -length),
west: (-length, name-offset)
).at(side)
let shapes = ()
shapes += draw.line(
anchor,
(rel: end-offset, to: anchor)
)
if name != none {
let text-anchor = if vertical {
(
"north": "west",
"south": "east",
"west": "south",
"east": "north"
).at(side)
} else { opposite-anchor(side) }
shapes += draw.content(
anchor: text-anchor,
padding: 0.2em,
angle: if vertical {90deg} else {0deg},
(rel: name-offset, to: anchor),
name
)
}
return (shapes, bounds)
}
return element.elmt(
draw-shape: draw-func,
pre-process: pre-process
)
}