16 Commits
v0.0.2 ... dev

23 changed files with 258 additions and 118 deletions

View File

@ -1,5 +1,22 @@
# Changelog # Changelog
## [v0.3.0] - 2025-05-03
- updated CeTZ to 0.3.4
- updated to Typst 0.13.1
- updated Tidy to 0.4.2
- updated Codly to 1.3.0 and codly-languages to 0.1.8
- added `ltr-bits` config option
- added a "Loading" section to the manual
## [v0.2.0] - 2025-02-23
- updated CeTZ to 0.3.2
- updated to Typst 0.13.0
- fixed missing bit index on dependencies
- updated docs (Tidy, codelst -> codly)
## [v0.1.0] - 2024-10-02
- prepared for publication in Typst Universe
## [v0.0.2] - 2024-06-15 ## [v0.0.2] - 2024-06-15
### Added ### Added
- `width` parameter to `schema.render` for easier integration - `width` parameter to `schema.render` for easier integration

View File

@ -31,14 +31,11 @@ It is based on the [homonymous Python script](https://git.kb28.ch/HEL/rivet/)
*Click on the example image to jump to the code.* *Click on the example image to jump to the code.*
## Usage ## Usage
For information, see the [manual](manual.pdf) For more information, see the [manual](manual.pdf)
To use this package, simply import `schema` [src/lib.typ](src/lib.typ) and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà ! To use this package, simply import `schema` from [rivet](https://typst.app/universe/package/rivet) and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà !
```typ ```typ
#import "src/lib.typ": schema #import "@preview/rivet:0.3.0": schema
#let doc = schema.load("path/to/schema.yaml") #let doc = schema.load(yaml("path/to/schema.yaml"))
#schema.render(doc) #schema.render(doc)
``` ```
## Installing
> TODO

View File

@ -1,7 +1,7 @@
/// Creates a dictionary of all configuration parameters /// Creates a dictionary of all configuration parameters
/// ///
/// - default-font-family (str): The default font family /// - default-font-family (str): The default font family
/// - default font-size (length): The absolute default font size /// - default-font-size (length): The absolute default font size
/// - italic-font-family (str): The italic font family (for value descriptions) /// - italic-font-family (str): The italic font family (for value descriptions)
/// - italic-font-size (length): The absolute italic font size /// - italic-font-size (length): The absolute italic font size
/// - background (color): The diagram background color /// - background (color): The diagram background color
@ -15,7 +15,7 @@
/// - dash-length (float): The length of individual dashes (for dashed lines) /// - dash-length (float): The length of individual dashes (for dashed lines)
/// - dash-space (float): The space between two dashes (for dashed lines) /// - dash-space (float): The space between two dashes (for dashed lines)
/// - arrow-size (float): The size of arrow heads /// - arrow-size (float): The size of arrow heads
/// - margins (tuple[float]): TODO -> remove /// - margins (tuple): TODO -> remove
/// - arrow-margin (float): The margin between arrows and the structures they link /// - arrow-margin (float): The margin between arrows and the structures they link
/// - values-gap (float): The gap between individual values /// - values-gap (float): The gap between individual values
/// - arrow-label-distance (float): The distance between arrows and their labels /// - arrow-label-distance (float): The distance between arrows and their labels
@ -25,6 +25,7 @@
/// - height (float): TODO -> remove /// - height (float): TODO -> remove
/// - full-page (bool): If true, the page will be resized to fit the diagram and take the background color /// - full-page (bool): If true, the page will be resized to fit the diagram and take the background color
/// - all-bit-i (bool): If true, all bit indices will be rendered, otherwise, only the ends of each range will be displayed /// - all-bit-i (bool): If true, all bit indices will be rendered, otherwise, only the ends of each range will be displayed
/// - ltr-bits (bool): If true, bits are placed with the LSB on the left instead of the right
/// -> dictionary /// -> dictionary
#let config( #let config(
default-font-family: "Ubuntu Mono", default-font-family: "Ubuntu Mono",
@ -51,13 +52,14 @@
width: 1200, width: 1200,
height: 800, height: 800,
full-page: false, full-page: false,
all-bit-i: true all-bit-i: true,
ltr-bits: false
) = {} ) = {}
/// Dark theme config /// Dark theme config
/// - ..args (any): see #doc-ref("config.config") /// - ..args (any): see @@config()
#let dark(..args) = {} #let dark(..args) = {}
/// Blueprint theme config /// Blueprint theme config
/// - ..args (any): see #doc-ref("config.config") /// - ..args (any): see @@config()
#let blueprint(..args) = {} #let blueprint(..args) = {}

View File

@ -1,4 +1,3 @@
#import "@preview/cetz:0.2.2": draw
#import "../src/lib.typ": schema #import "../src/lib.typ": schema
#import "../src/util.typ" #import "../src/util.typ"
@ -14,7 +13,7 @@
box( box(
stroke: black + 1pt, stroke: black + 1pt,
radius: .5em, radius: .5em,
fill: if fill {yellow.lighten(80%)} else {none}, fill: if fill {orange.lighten(95%)} else {none},
if show-src { if show-src {
let src-block = align(left, raw(src, lang: "typc")) let src-block = align(left, raw(src, lang: "typc"))
table( table(

View File

@ -1,16 +1,19 @@
/// Loads a schema from a file or a raw block. /// Loads a schema from a file or a raw block.
/// This function returns a dictionary of structures /// This function returns a dictionary of structures\
/// See the #link(<loading>)[Loading] chapter for examples of schema loading for each supported format
/// ///
/// Supported formats: #schema.valid-extensions.map(e => raw("." + e)).join(", ") /// Supported formats: #schema.valid-extensions.map(e => raw("." + e)).join(", ")
/// - path-or-schema (str, raw, dictionary): If it is a string, defines the path to load. \ /// - path-or-schema (str, raw, dictionary):
/// If it is a raw block, its content is directly parsed (the block's language will define the format to use) \ /// #list(
/// If it is a dictionary, it directly defines the schema structure /// [If it is a string, defines the path to load.\ #emoji.warning Warning: this will only work if this package is part of your project, as packages installed in the `@local` or `@preview` namespace cannot access project files],
/// [If it is a raw block, its content is directly parsed (the block's language will define the format to use)],
/// [If it is a dictionary, it directly defines the schema structure]
/// )
/// -> dictionary /// -> dictionary
#let load(path-or-schema) = {} #let load(path-or-schema) = {}
/// Renders the given schema /// Renders the given schema
/// This functions /// - schema (dictionary): A schema dictionary, as returned by @@load()
/// - schema (dictionary): A schema dictionary, as returned by #doc-ref("schema.load")
/// - config (auto, dictionary): The configuration parameters, as returned by #doc-ref("config.config") /// - config (auto, dictionary): The configuration parameters, as returned by #doc-ref("config.config")
/// - width (ratio, length): The width of the generated figure /// - width (ratio, length): The width of the generated figure
#let render(schema, config: auto, width: 100%) = {} #let render(schema, config: auto, width: 100%) = {}

View File

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

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 376 KiB

After

Width:  |  Height:  |  Size: 378 KiB

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 302 KiB

After

Width:  |  Height:  |  Size: 303 KiB

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 487 KiB

After

Width:  |  Height:  |  Size: 485 KiB

Binary file not shown.

Binary file not shown.

12
justfile Normal file
View File

@ -0,0 +1,12 @@
# 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/pdf}"; done
for f in "{{gallery_dir}}"/example*.typ; do typst c --root . "$f" "${f/typ/png}"; done

Binary file not shown.

View File

@ -1,22 +1,24 @@
#import "@preview/tidy:0.3.0" #import "@preview/tidy:0.4.2"
#import "@preview/codelst:2.0.1": sourcecode #import "@preview/codly:1.3.0": codly-init, codly
#import "@preview/showybox:2.0.1": showybox #import "@preview/codly-languages:0.1.8": codly-languages
#import "@preview/showybox:2.0.4": showybox
#import "src/lib.typ" #import "src/lib.typ"
#import "src/schema.typ" #import "src/schema.typ"
#import "docs/examples.typ" #import "docs/examples.typ"
#show: codly-init
#codly(languages: codly-languages)
#set heading(numbering: (..num) => if num.pos().len() < 4 { #set heading(numbering: (..num) => if num.pos().len() < 4 {
numbering("1.1", ..num) numbering("1.1", ..num)
}) })
#{
outline(indent: true, depth: 3)
}
#set page(numbering: "1/1", header: align(right)[rivet #sym.dash.em v#lib.version]) #set page(numbering: "1/1", header: align(right)[rivet #sym.dash.em v#lib.version])
#let doc-ref(target, full: false, var: false) = { #let doc-ref(target, full: false, var: false) = {
let (module, func) = target.split(".") let (module, func) = target.split(".")
let label-name = module + func let label-name = module + "-" + func
let display-name = func let display-name = func
if full { if full {
display-name = target display-name = target
@ -25,7 +27,7 @@
label-name += "()" label-name += "()"
display-name += "()" display-name += "()"
} }
link(label(label-name))[#display-name] link(label(label-name), raw(display-name))
} }
#let note(it) = showybox( #let note(it) = showybox(
@ -43,6 +45,37 @@
#show link: set text(blue) #show link: set text(blue)
#let sch = schema.load(```yaml
structures:
main:
bits: 5
ranges:
4:
name: R
description: Register
3:
name: I
description: Instruction
2:
name: V
description: Visualizer
1:
name: E
description: Explainer
0:
name: T
description: Tool
```)
#align(center, schema.render(sch, width: 50%, config: lib.config.config(left-labels: true)))
#v(1fr)
#box(
width: 100%,
stroke: black,
inset: 1em,
outline(indent: auto, depth: 3)
)
#pagebreak(weak: true)
= Introduction = Introduction
This package provides a way to make beautiful register diagrams using the CeTZ package. It can be used to document Assembly instructions or binary registers This package provides a way to make beautiful register diagrams using the CeTZ package. It can be used to document Assembly instructions or binary registers
@ -51,26 +84,30 @@ This is a port of the #link("https://git.kb28.ch/HEL/rivet")[homonymous Python s
= Usage = Usage
Simply import `schema` from #link("src/lib.typ") and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà ! #let import-stmt = "#import \"@preview/rivet:" + str(lib.version) + "\""
#pad(left: 1em)[```typ
#import "src/lib.typ": schema Simply import the `schema` module and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà !
#let doc = schema.load("path/to/schema.yaml") #raw(block: true, lang: "typ", ```typ
$import: schema
#let doc = schema.load(yaml("path/to/schema.yaml"))
#schema.render(doc) #schema.render(doc)
```] ```.text.replace("$import", import-stmt))
Please read the #link(<loading>)[Loading] chapter for more detailed explanations on how to load schema descriptions.
= Format = Format
This section describes the structure of a schema definition. The examples given use the JSON syntax. For examples in different formats, see #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/test.yaml")[test.yaml], #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/test.json")[test.json] and #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/test.xml")[test.xml]. You can also directly define a schema using Typst dictionaries and arrays. This section describes the structure of a schema definition. The examples given use the JSON syntax. For examples in different formats, see #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/test.yaml")[test.yaml], #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/test.json")[test.json] and #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/test.xml")[test.xml]. You can also directly define a schema using Typst dictionaries and arrays.
Since the XML format is quite different from the other, you might find it helpful to look at the examples on GitHub to get familiar with it. Since the XML format is quite different from the other, you might find it helpful to look at the examples in the #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/")[Gitea repo] to get familiar with it.
== Main layout == Main layout
A schema contains a dictionary of structures. The must be at least one defined structure named "main". A schema contains a dictionary of structures. There must be at least one defined structure named "main".
It can also optionnaly contain a "colors" dictionary. More details about this in #link(<format-colors>)[Colors] It can also optionnaly contain a "colors" dictionary. More details about this in #link(<format-colors>)[Colors]
#sourcecode[```json ```json
{ {
"structures": { "structures": {
"main": { "main": {
@ -85,7 +122,7 @@ It can also optionnaly contain a "colors" dictionary. More details about this in
... ...
} }
} }
```] ```
#pagebreak(weak: true) #pagebreak(weak: true)
@ -93,9 +130,9 @@ It can also optionnaly contain a "colors" dictionary. More details about this in
A structure has a given number of bits and one or multiple ranges. Each range of bits can have a name, a description and / or values with special meaning (see #link(<format-range>)[Range]). A range's structure can also depend on another range's value (see #link(<format-dependencies>)[Dependencies]). A structure has a given number of bits and one or multiple ranges. Each range of bits can have a name, a description and / or values with special meaning (see #link(<format-range>)[Range]). A range's structure can also depend on another range's value (see #link(<format-dependencies>)[Dependencies]).
The range name (or key) defines the left- and rightmost bits (e.g. `7-4` goes from bit 7 down to bit 4). Bits are displayed in big-endian, i.e. the leftmost bit has the highest value. The range name (or key) defines the left- and rightmost bits (e.g. `7-4` goes from bit 7 down to bit 4). The order in which you write the range is not important, meaning `7-4` is equivalent to `4-7`. Bits are displayed in big-endian, i.e. the leftmost bit has the highest value, except if you enable the `ltr-bits` #doc-ref("config.config") option.
#sourcecode[```json ```json
"main": { "main": {
"bits": 8, "bits": 8,
"ranges": { "ranges": {
@ -113,7 +150,7 @@ The range name (or key) defines the left- and rightmost bits (e.g. `7-4` goes fr
} }
} }
} }
```] ```
== Range <format-range> == Range <format-range>
@ -125,7 +162,7 @@ For values depending on other ranges, see #link(<format-dependencies>)[Dependenc
In YAML, make sure to wrap values in quotes because some values can be interpreted as octal notation (e.g. 010 #sym.arrow.r 8) In YAML, make sure to wrap values in quotes because some values can be interpreted as octal notation (e.g. 010 #sym.arrow.r 8)
] ]
#sourcecode[```json ```json
"3-2": { "3-2": {
"name": "op", "name": "op",
"description": "Logical operation", "description": "Logical operation",
@ -136,7 +173,7 @@ For values depending on other ranges, see #link(<format-dependencies>)[Dependenc
"11": "NAND" "11": "NAND"
} }
} }
```] ```
#pagebreak(weak: true) #pagebreak(weak: true)
@ -144,9 +181,9 @@ For values depending on other ranges, see #link(<format-dependencies>)[Dependenc
The structure of one range may depend on the value of another. To represent this situation, first indicate on the child range the range on which it depends. The structure of one range may depend on the value of another. To represent this situation, first indicate on the child range the range on which it depends.
Then, in its values, indicate which structure to use. A description can also be added (displayed above the horizontal dependency arrow) Then, in its values, indicate which structure to use. A description can also be added (displayed below the horizontal dependency arrow)
#sourcecode[```json ```json
"7-4": { "7-4": {
... ...
"depends-on": "0", "depends-on": "0",
@ -161,11 +198,11 @@ Then, in its values, indicate which structure to use. A description can also be
} }
} }
} }
```] ```
Finally, add the sub-structures to the structure dictionary: Finally, add the sub-structures to the structure dictionary:
#sourcecode[```json ```json
{ {
"structures": { "structures": {
"main": { "main": {
@ -182,7 +219,7 @@ Finally, add the sub-structures to the structure dictionary:
... ...
} }
} }
```] ```
#pagebreak(weak: true) #pagebreak(weak: true)
@ -190,7 +227,7 @@ Finally, add the sub-structures to the structure dictionary:
You may want to highlight some ranges to make your diagram more readable. For this, you can use colors. Colors may be defined in a separate dictionary, at the same level as the "structures" dictionary: You may want to highlight some ranges to make your diagram more readable. For this, you can use colors. Colors may be defined in a separate dictionary, at the same level as the "structures" dictionary:
#sourcecode[```json ```json
{ {
"structures": { "structures": {
... ...
@ -199,11 +236,11 @@ You may want to highlight some ranges to make your diagram more readable. For th
... ...
} }
} }
```] ```
It can contain color definitions for any number of ranges. For each range, you may then define a dictionary mapping bit ranges to a particular color: It can contain color definitions for any number of ranges. For each range, you may then define a dictionary mapping bit ranges to a particular color:
#sourcecode[```json ```json
"colors": { "colors": {
"main": { "main": {
"31-28": "#ABCDEF", "31-28": "#ABCDEF",
@ -213,7 +250,7 @@ It can contain color definitions for any number of ranges. For each range, you m
"19-10": [12, 34, 56] "19-10": [12, 34, 56]
} }
} }
```] ```
Valid color formats are: Valid color formats are:
- hex string starting with `#`, e.g. `"#23fa78"` - hex string starting with `#`, e.g. `"#23fa78"`
@ -223,7 +260,7 @@ Valid color formats are:
#note[ #note[
The XML format implements colors a bit differently. Instead of having a "colors" dictionary, color definitions are directly put on the same level as structure definitions. For this, you can use a `color` node with the attributes "structure", "color", "start" and "end", like so: The XML format implements colors a bit differently. Instead of having a "colors" dictionary, color definitions are directly put on the same level as structure definitions. For this, you can use a `color` node with the attributes "structure", "color", "start" and "end", like so:
#sourcecode[```xml ```xml
<schema> <schema>
<structure id="main" bits="8"> <structure id="main" bits="8">
... ...
@ -232,11 +269,86 @@ Valid color formats are:
<color structure="main" color="#FF0000" start="4" end="7" /> <color structure="main" color="#FF0000" start="4" end="7" />
<color structure="main" color="255,0,0" start="0" end="3" /> <color structure="main" color="255,0,0" start="0" end="3" />
</schema> </schema>
```] ```
] ]
#pagebreak(weak: true) #pagebreak(weak: true)
= Loading <loading>
Due to current limitations of the Typst compiler, the package can only access its own files, unless directly included in your project. For this reason, rivet cannot load a schema from a path, and you will need to read the files yourself to pass their contents to the package.
Here are a number of ways you can load your schemas:
== JSON Format
````typ
// From file (ONLY IF PACKAGE INSTALLED IN PROJECT)
#let s = schema.load("schema.json")
// From file
#let s = schema.load(json("schema.json"))
// Raw block
#let s = schema.load(```json
{
"structures": {
"main": {
...
}
}
}
```)
````
== YAML Format
````typ
// From file (ONLY IF PACKAGE INSTALLED IN PROJECT)
#let s = schema.load("schema.yaml")
// From file
#let s = schema.load(yaml("schema.yaml"))
// Raw block
#let s = schema.load(```yaml
structures:
main:
...
```)
````
== Typst Format
```typ
#let s = schema.load((
structures: (
main: (
...
)
)
))
```
#pagebreak(weak: true)
== XML Format
````typ
// From file (ONLY IF PACKAGE INSTALLED IN PROJECT)
#let x = schema.xml-loader.load("schema.xml")
#let s = schema.load(x)
// From file
#let x = schema.xml-loader.parse(yaml("schema.yaml").first())
#let s = schema.load(x)
// Raw block
#let s = schema.load(```xml
<schema>
<structure id="main" bits="32">
...
</structure>
</schema>
```)
````
#pagebreak(weak: true)
= Config presets = Config presets
Aside from the default config, some example presets are also provided: Aside from the default config, some example presets are also provided:
@ -254,6 +366,7 @@ Aside from the default config, some example presets are also provided:
#let doc-config = tidy.parse-module( #let doc-config = tidy.parse-module(
read("docs/config.typ"), read("docs/config.typ"),
name: "config", name: "config",
old-syntax: true,
scope: ( scope: (
doc-ref: doc-ref doc-ref: doc-ref
) )
@ -265,6 +378,7 @@ Aside from the default config, some example presets are also provided:
#let doc-schema = tidy.parse-module( #let doc-schema = tidy.parse-module(
read("docs/schema.typ"), read("docs/schema.typ"),
name: "schema", name: "schema",
old-syntax: true,
scope: ( scope: (
schema: schema, schema: schema,
doc-ref: doc-ref doc-ref: doc-ref

View File

@ -23,7 +23,8 @@
width: 1200, width: 1200,
height: 800, height: 800,
full-page: false, full-page: false,
all-bit-i: true all-bit-i: true,
ltr-bits: false,
) = { ) = {
return ( return (
default-font-family: default-font-family, default-font-family: default-font-family,
@ -50,7 +51,8 @@
width: width, width: width,
height: height, height: height,
full-page: full-page, full-page: full-page,
all-bit-i: all-bit-i all-bit-i: all-bit-i,
ltr-bits: ltr-bits,
) )
} }

View File

@ -1,4 +1,4 @@
#let version = version((0,0,2)) #let version = version(0,3,0)
#import "config.typ" #import "config.typ"
#import "schema.typ" #import "schema.typ"

View File

@ -15,6 +15,9 @@
} }
let start = int(start-end.last()) let start = int(start-end.last())
let end = int(start-end.first()) let end = int(start-end.first())
if end < start {
(start, end) = (end, start)
}
return (start, end) return (start, end)
} }

View File

@ -1,4 +1,4 @@
#import "@preview/cetz:0.2.2": canvas, draw #import "@preview/cetz:0.3.4": canvas, draw
#import "range.typ" as rng #import "range.typ" as rng
#import "structure.typ" #import "structure.typ"
@ -253,7 +253,15 @@
let bit-h = config.bit-height let bit-h = config.bit-height
let arrow-margin = config.arrow-margin let arrow-margin = config.arrow-margin
let start-i = struct.bits - range_.end - 1 let to-real-i(i) = {
return if config.ltr-bits {
i
} else {
struct.bits - i - 1
}
}
let start-i = to-real-i(if config.ltr-bits {range_.start} else {range_.end})
let start-x = bits-x + start-i * bit-w let start-x = bits-x + start-i * bit-w
let width = rng.bits(range_) * bit-w let width = rng.bits(range_) * bit-w
@ -268,7 +276,7 @@
depend-range.last-value-y depend-range.last-value-y
} }
let depend-start-i = struct.bits - depend-range.end - 1 let depend-start-i = to-real-i(depend-range.end)
let depend-start-x = bits-x + depend-start-i * bit-w let depend-start-x = bits-x + depend-start-i * bit-w
let depend-width = rng.bits(depend-range) * bit-w let depend-width = rng.bits(depend-range) * bit-w
let depend-mid = depend-start-x + depend-width / 2 let depend-mid = depend-start-x + depend-width / 2
@ -302,7 +310,9 @@
let x2 let x2
// Arrow from left to right // Arrow from left to right
if depend-range.end > range_.start { let i1 = to-real-i(range_.start)
let i2 = to-real-i(depend-range.end)
if i2 < i1 {
x1 = depend-start-x + depend-width + arrow-margin x1 = depend-start-x + depend-width + arrow-margin
x2 = start-x - arrow-margin x2 = start-x - arrow-margin
@ -346,6 +356,23 @@
let bits-width = struct.bits * bit-w let bits-width = struct.bits * bit-w
let start-bit = struct.start let start-bit = struct.start
let bit-colors = (:) let bit-colors = (:)
let to-real-i(i) = {
return if config.ltr-bits {
i - start-bit
} else {
struct.bits - i - 1 + start-bit
}
}
let to-bit-i(real-i) = {
return if config.ltr-bits {
real-i + start-bit
} else {
struct.bits - real-i - 1 + start-bit
}
}
for i in range(struct.bits) { for i in range(struct.bits) {
bit-colors.insert(str(i), bg-col) bit-colors.insert(str(i), bg-col)
} }
@ -353,14 +380,14 @@
for (s, col) in colors.at(struct.name) { for (s, col) in colors.at(struct.name) {
let (start, end) = rng.parse-span(s) let (start, end) = rng.parse-span(s)
for i in range(start, end + 1) { for i in range(start, end + 1) {
let real-i = struct.bits - i - 1 + start-bit let real-i = to-real-i(i)
bit-colors.insert(str(real-i), col) bit-colors.insert(str(real-i), col)
} }
} }
} }
let range-boundaries = () let range-boundaries = ()
for r in struct.ranges.values() { for r in struct.ranges.values() {
let i = struct.bits - r.end - 1 + start-bit let i = to-real-i(if config.ltr-bits {r.start} else {r.end})
range-boundaries.push(i) range-boundaries.push(i)
} }
@ -373,7 +400,7 @@
// Draw rectangle around structure // Draw rectangle around structure
shapes += draw-rect(border-col, bits-x, bits-y, bits-width, bit-h, thickness: 2) shapes += draw-rect(border-col, bits-x, bits-y, bits-width, bit-h, thickness: 2)
let indices = range(struct.bits) let indices = range(struct.start, struct.start + struct.bits)
if not config.all-bit-i { if not config.all-bit-i {
indices = () indices = ()
for r in struct.ranges.values() { for r in struct.ranges.values() {
@ -384,11 +411,11 @@
for i in range(struct.bits) { for i in range(struct.bits) {
let bit-x = ox + i * bit-w let bit-x = ox + i * bit-w
let real-i = struct.bits - i - 1 + start-bit let bit-i = to-bit-i(i)
if real-i in indices { if bit-i in indices {
shapes += draw-text( shapes += draw-text(
str(real-i), str(bit-i),
txt-col, txt-col,
bit-x + bit-w / 2, bit-x + bit-w / 2,
oy + bit-h / 2 oy + bit-h / 2
@ -403,13 +430,16 @@
} }
let ranges = structure.get-sorted-ranges(struct) let ranges = structure.get-sorted-ranges(struct)
if config.ltr-bits {
ranges = ranges.rev()
}
if config.left-labels { if config.left-labels {
ranges = ranges.rev() ranges = ranges.rev()
} }
let desc-x let desc-x
if config.force-descs-on-side { if config.force-descs-on-side {
desc-x = config.margins.at(3) + structures.main.bits * bit-w desc-x = config.margins.at(3) + schema.structures.main.bits * bit-w
if config.left-labels { if config.left-labels {
desc-x = config.width - desc-x desc-x = config.width - desc-x
} }
@ -424,14 +454,15 @@
// Names + simple descriptions // Names + simple descriptions
for range_ in ranges { for range_ in ranges {
let start-i = struct.bits - range_.end + start-bit - 1 let start-i = to-real-i(if config.ltr-bits {range_.start} else {range_.end})
let start-x = bits-x + start-i * bit-w let start-x = bits-x + start-i * bit-w
let width = rng.bits(range_) * bit-w let width = rng.bits(range_) * bit-w
let name-x = start-x + width / 2 let name-x = start-x + width / 2
let name-y = bits-y + bit-h / 2 let name-y = bits-y + bit-h / 2
shapes += draw-line(border-col, (start-x, bits-y), (start-x, bits-y + bit-h)) let line-x = if config.ltr-bits {start-x + width} else {start-x}
shapes += draw-line(border-col, (line-x, bits-y), (line-x, bits-y + bit-h))
shapes += draw-text(range_.name, txt-col, name-x, name-y, fill: bg-col) shapes += draw-text(range_.name, txt-col, name-x, name-y, fill: bg-col)
if range_.description != "" { if range_.description != "" {

View File

@ -25,7 +25,7 @@
#let parse-raw(schema) = { #let parse-raw(schema) = {
let lang = schema.lang let lang = schema.lang
let content = schema.text let content = bytes(schema.text)
if not lang in valid-extensions { if not lang in valid-extensions {
let fmts = valid-extensions.join(", ") let fmts = valid-extensions.join(", ")
fmts = "(" + fmts + ")" fmts = "(" + fmts + ")"
@ -33,11 +33,11 @@
} }
if lang == "yaml" { if lang == "yaml" {
return yaml.decode(content) return yaml(content)
} else if lang == "json" { } else if lang == "json" {
return json.decode(content) return json(content)
} else if lang == "xml" { } else if lang == "xml" {
return xml-loader.parse(xml.decode(content).first()) return xml-loader.parse(xml(content).first())
} }
} }

View File

@ -1,7 +1,7 @@
[package] [package]
name = "rivet" name = "rivet"
version = "0.0.2" version = "0.3.0"
compiler = "0.11.0" compiler = "0.13.1"
repository = "https://git.kb28.ch/HEL/rivet-typst" repository = "https://git.kb28.ch/HEL/rivet-typst"
entrypoint = "src/lib.typ" entrypoint = "src/lib.typ"
authors = [ authors = [
@ -11,4 +11,4 @@ categories = [ "visualization" ]
license = "Apache-2.0" license = "Apache-2.0"
description = "Register / Instruction Visualizer & Explainer Tool with Typst, using CeTZ" description = "Register / Instruction Visualizer & Explainer Tool with Typst, using CeTZ"
keywords = [ "assembly", "instruction", "binary" ] keywords = [ "assembly", "instruction", "binary" ]
exclude = [ "/gallery/*" ] exclude = [ "gallery", "justfile", "docs" ]