Merge pull request 'v0.2.0: updates and minor fixes' (#4) from dev into main

Reviewed-on: HEL/rivet-typst#4

CHANGELOG.md

@@ -1,13 +1,5 @@
 # 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

README.md

@@ -35,7 +35,7 @@ For more information, see the [manual](manual.pdf)
 
 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
-#import "@preview/rivet:0.3.0": schema
+#import "@preview/rivet:0.2.0": schema
-#let doc = schema.load(yaml("path/to/schema.yaml"))
+#let doc = schema.load("path/to/schema.yaml")
 #schema.render(doc)
 ```

docs/config.typ

@@ -25,7 +25,6 @@
 /// - height (float): TODO -> remove
 /// - 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
-/// - ltr-bits (bool): If true, bits are placed with the LSB on the left instead of the right
 /// -> dictionary
 #let config(
   default-font-family: "Ubuntu Mono",
@@ -52,8 +51,7 @@
   width: 1200,
   height: 800,
   full-page: false,
-  all-bit-i: true,
+  all-bit-i: true
-  ltr-bits: false
 ) = {}
 
 /// Dark theme config

docs/schema.typ

@@ -1,6 +1,5 @@
 /// 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(", ")
 /// - path-or-schema (str, raw, dictionary):
@@ -13,6 +12,7 @@
 #let load(path-or-schema) = {}
 
 /// Renders the given schema
+/// This functions
 /// - schema (dictionary): A schema dictionary, as returned by @@load()
 /// - config (auto, dictionary): The configuration parameters, as returned by #doc-ref("config.config")
 /// - width (ratio, length): The width of the generated figure

manual.typ

@@ -1,6 +1,6 @@
-#import "@preview/tidy:0.4.2"
+#import "@preview/tidy:0.4.1"
-#import "@preview/codly:1.3.0": codly-init, codly
+#import "@preview/codly:1.2.0": codly-init, codly
-#import "@preview/codly-languages:0.1.8": codly-languages
+#import "@preview/codly-languages:0.1.7": codly-languages
 #import "@preview/showybox:2.0.4": showybox
 #import "src/lib.typ"
 #import "src/schema.typ"
@@ -84,26 +84,22 @@ This is a port of the #link("https://git.kb28.ch/HEL/rivet")[homonymous Python s
 
 = Usage
 
-#let import-stmt = "#import \"@preview/rivet:" + str(lib.version) + "\""
+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à !
-
+#pad(left: 1em)[```typ
-Simply import the `schema` module and call `schema.load` to parse a schema description. Then use `schema.render` to render it, et voilà !
+#import "@preview/rivet:0.1.0": schema
-#raw(block: true, lang: "typ", ```typ
+#let doc = schema.load("path/to/schema.yaml")
-$import: schema
-#let doc = schema.load(yaml("path/to/schema.yaml"))
 #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
 
 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 in the #link("https://git.kb28.ch/HEL/rivet-typst/src/branch/main/gallery/")[Gitea repo] 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 on GitHub to get familiar with it.
 
 == Main layout
 
-A schema contains a dictionary of structures. There must be at least one defined structure named "main".
+A schema contains a dictionary of structures. The 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]
 
@@ -130,7 +126,7 @@ 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]).
 
-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.
+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.
 
 ```json
 "main": {
@@ -181,7 +177,7 @@ 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.
 
-Then, in its values, indicate which structure to use. A description can also be added (displayed below the horizontal dependency arrow)
+Then, in its values, indicate which structure to use. A description can also be added (displayed above the horizontal dependency arrow)
 
 ```json
 "7-4": {
@@ -274,81 +270,6 @@ Valid color formats are:
 
 #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
 
 Aside from the default config, some example presets are also provided:

src/config.typ

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

src/lib.typ

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

src/range.typ

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

src/renderer.typ

@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.3.4": canvas, draw
+#import "@preview/cetz:0.3.2": canvas, draw
 
 #import "range.typ" as rng
 #import "structure.typ"
@@ -253,15 +253,7 @@
   let bit-h = config.bit-height
   let arrow-margin = config.arrow-margin
 
-  let to-real-i(i) = {
+  let start-i = struct.bits - range_.end - 1
-    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 width = rng.bits(range_) * bit-w
 
@@ -276,7 +268,7 @@
     depend-range.last-value-y
   }
 
-  let depend-start-i = to-real-i(depend-range.end)
+  let depend-start-i = struct.bits - depend-range.end - 1
   let depend-start-x = bits-x + depend-start-i * bit-w
   let depend-width = rng.bits(depend-range) * bit-w
   let depend-mid = depend-start-x + depend-width / 2
@@ -310,9 +302,7 @@
     let x2
 
     // Arrow from left to right
-    let i1 = to-real-i(range_.start)
+    if depend-range.end > range_.start {
-    let i2 = to-real-i(depend-range.end)
-    if i2 < i1 {
       x1 = depend-start-x + depend-width + arrow-margin
       x2 = start-x - arrow-margin
     
@@ -356,23 +346,6 @@
   let bits-width = struct.bits * bit-w
   let start-bit = struct.start
   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) {
     bit-colors.insert(str(i), bg-col)
   }
@@ -380,14 +353,14 @@
     for (s, col) in colors.at(struct.name) {
       let (start, end) = rng.parse-span(s)
       for i in range(start, end + 1) {
-        let real-i = to-real-i(i)
+        let real-i = struct.bits - i - 1 + start-bit
         bit-colors.insert(str(real-i), col)
       }
     }
   }
   let range-boundaries = ()
   for r in struct.ranges.values() {
-    let i = to-real-i(if config.ltr-bits {r.start} else {r.end})
+    let i = struct.bits - r.end - 1 + start-bit
     range-boundaries.push(i)
   }
 
@@ -407,20 +380,15 @@
       indices.push(r.start)
       indices.push(r.end)
     }
-    // ensure first and last bits are included
-    if not indices.contains(0) { indices.insert(0, struct.start) }
-    if not indices.contains(struct.bits + struct.start - 1) {
-      indices.push(struct.bits + struct.start - 1)
-    }
   }
 
   for i in range(struct.bits) {
     let bit-x = ox + i * bit-w
-    let bit-i = to-bit-i(i)
+    let real-i = struct.bits - i - 1 + start-bit
 
-    if bit-i in indices {
+    if real-i in indices {
       shapes += draw-text(
-        str(bit-i),
+        str(real-i),
         txt-col,
         bit-x + bit-w / 2,
         oy + bit-h / 2 
@@ -435,16 +403,13 @@
   }
 
   let ranges = structure.get-sorted-ranges(struct)
-  if config.ltr-bits {
-    ranges = ranges.rev()
-  }
   if config.left-labels {
     ranges = ranges.rev()
   }
 
   let desc-x
   if config.force-descs-on-side {
-    desc-x = config.margins.at(3) + schema.structures.main.bits * bit-w
+    desc-x = config.margins.at(3) + structures.main.bits * bit-w
     if config.left-labels {
       desc-x = config.width - desc-x
     }
@@ -458,41 +423,17 @@
   let desc-y = bits-y + bit-h * 2
 
   // Names + simple descriptions
-  for (i, range_) in ranges.enumerate() {
+  for range_ in ranges {
-    let start-i = to-real-i(if config.ltr-bits {range_.start} else {range_.end})
+    let start-i = struct.bits - range_.end + start-bit - 1
-    let end-i = to-real-i(if config.ltr-bits {range_.end} else {range_.start})
     let start-x = bits-x + start-i * bit-w
     let width = rng.bits(range_) * bit-w
 
     let name-x = start-x + width / 2
     let name-y = bits-y + bit-h / 2
     
-    let line-x = if config.ltr-bits {start-x + width} else {start-x}
+    shapes += draw-line(border-col, (start-x, bits-y), (start-x, bits-y + bit-h))
-    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)
     
-    // paint end line only if needed
-    if (
-      start-i != 0
-        and end-i != struct.bits - 1
-        and ranges
-          .at(
-            i
-              + {
-                if config.ltr-bits and i < ranges.len() - 1 { 1 } else { -1 }
-              },
-          )
-          .end
-          != range_.start - 1
-    ) {
-      line-x += if config.ltr-bits { -width } else { width }
-      shapes += draw-line(
-        border-col,
-        (line-x, bits-y),
-        (line-x, bits-y + bit-h),
-      )
-    }
-    
     if range_.description != "" {
       let shapes_
       (shapes_, desc-x, desc-y) = draw-description(

typst.toml

@@ -1,7 +1,7 @@
 [package]
 name = "rivet"
-version = "0.3.0"
+version = "0.2.0"
-compiler = "0.13.1"
+compiler = "0.13.0"
 repository = "https://git.kb28.ch/HEL/rivet-typst"
 entrypoint = "src/lib.typ"
 authors = [