coastalwhite/wavedrom-rs

Beautiful Digital Timing Diagrams with Rust

wavedrom-rs

A Rust Digital Timing Diagram generator based on WaveDrom

---

Demo | Tutorial

The wavedrom-rs crate provides an interface to shape beautiful Digital Timing Diagrams into an SVG. It is almost completely compatible with the WaveDrom project. It can be merged into document build tools, continuous integration or be used as a one off to generate beautiful diagrams.

There are currently four ways to use wavedrom-rs:

• On the editor website
• As a Rust crate
• As a Command-Line Application
• As a MdBook Preprocessor

Features

• All original WaveDrom Signal Types
• Signal Groups
• Arrows and Indicator Markers
• Headers and Footers
• Cycle Enumeration Markers
• Editor Website through WASM
• MdBook Preprocessor
• Full Customization via Skins

Documentation

This project uses the same syntax for WaveJson as the original WaveDrom project. Therefore, the original Hitchhiker's Guide to WaveDrom is still a good introduction into several concepts of of WaveJson. Additionally, this repository maintains a reference book.

Testing

Tests are written in the ./tests directory and can be generated using the ./tests/run.py scripts. This will generate a result.html in the tests directory that contains all the rendered SVGs for each json5 file in the ./tests directory.

# Usage:
cd ./tests
./run [path/to/skin.json5]

Fuzzing

This project is fuzzed with cargo-fuzz. This improves the stability of the project.

cargo +nightly fuzz run wavejson-render

MSRV

This crate currently only compiles with Rust 1.70. To select that version use:

rustup update 1.70 --no-self-update && rustup default 1.70

Contribution

Please report any bugs and possible improvements as an issue within this repository. Pull requests are also welcome.

License

Licensed under a MIT License. The demo website utilizes icons from Lucide which are licensed under an ISC license.

wavedrom-rs's Issues

Can only render one diagram per file

When you include a second diagram in a Markdown file neither one is rendered and you just see the fenced code. For example include this diagram.md file in SUMMARY.md:

# Waveform Test

Here we do a quick test of [MdBook-WaveDrom](https://github.com/coastalwhite/wavedrom-rs/tree/main/mdbook-wavedrom-rs).

```wavedrom
{
    signal: [
        { name: "clk", wave: "p......." },
        { name: "pulses", wave: "0..10.10" },
    ]
}

Another diagram:

{
            signal: [
                 { name: "clk", wave: "p.........." },
                    { name: "req", wave: "0.10......." },
                    { name: "data", wave: "x......2.x.", data: "0xBEEF" },
                    { name: "done", wave: "0......1.0." },
            ]
    }

End of Waveform Test

The output is:

![Output](https://github.com/coastalwhite/wavedrom-rs/assets/8484427/e76ed4e2-13ea-4f3f-8f47-5fd567138b0f)

Font does not contain full Unicode widths

SVG Text Anchor position for Inkscape PDF-TeX export

Hi !

I really appreciate this project as it is way simpler to customize the appearance of the diagrams. However, I noticed that on the exported SVG files, the anchor for text boxes is positioned in the middle. This is a problem since when converting the SVG to a PDF file with LaTeX text using Inkscape, the obtained text is positioned higher than it should be.

Here is an example of what I mean:
SVG file

Produced LaTeX PDF with Inkscape export

It would be awesome if the text anchor was by default as it is in Inkscape, enabling fast integration of the diagrams in LaTeX documents.

Seems like the property that is in charge of this is: dominant-baseline="middle"

Here is the SVG code for the example SVG file used above

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->

<svg
   width="210mm"
   height="297mm"
   viewBox="0 0 210 297"
   version="1.1"
   id="svg1"
   inkscape:version="1.3 (0e150ed6c4, 2023-07-21)"
   sodipodi:docname="testing.svg"
   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
   xmlns="http://www.w3.org/2000/svg"
   xmlns:svg="http://www.w3.org/2000/svg">
  <sodipodi:namedview
     id="namedview1"
     pagecolor="#ffffff"
     bordercolor="#000000"
     borderopacity="0.25"
     inkscape:showpageshadow="2"
     inkscape:pageopacity="0.0"
     inkscape:pagecheckerboard="0"
     inkscape:deskcolor="#d1d1d1"
     inkscape:document-units="mm"
     inkscape:zoom="4.1725703"
     inkscape:cx="394.72073"
     inkscape:cy="419.64542"
     inkscape:window-width="1920"
     inkscape:window-height="1164"
     inkscape:window-x="0"
     inkscape:window-y="36"
     inkscape:window-maximized="1"
     inkscape:current-layer="layer1"
     showguides="true">
    <sodipodi:guide
       position="118.59244,201.21439"
       orientation="0,-1"
       id="guide1"
       inkscape:locked="false" />
  </sodipodi:namedview>
  <defs
     id="defs1" />
  <g
     inkscape:label="Calque 1"
     inkscape:groupmode="layer"
     id="layer1">
    <rect
       style="fill:#e8d5c4;stroke-width:0.352777;stroke-linecap:square;stroke-linejoin:round"
       id="rect1"
       width="56.30822"
       height="5.9605546"
       x="76.845886"
       y="92.805336" />
    <text
       text-anchor="middle"
       dominant-baseline="middle"
       font-family="Helvetica"
       font-size="3.70417px"
       fill="#000000"
       letter-spacing="0"
       id="text55"
       x="110.42086"
       y="94.868874"
       style="text-align:center;text-anchor:middle;white-space:pre;inline-size:30.1773;stroke-width:0.264583"
       transform="translate(8.1011636,0.90747783)"
       xml:space="preserve"><tspan
         x="110.42086"
         y="94.868874"
         id="tspan2">Bad anchor pos</tspan></text>
    <text
       xml:space="preserve"
       style="font-size:3.88056px;line-height:normal;font-family:Carlito;-inkscape-font-specification:Carlito;text-align:center;text-decoration-color:#000000;text-anchor:middle;fill:#000000;stroke-width:1.05833;-inkscape-stroke:none;stop-color:#000000"
       x="91.673836"
       y="96.820175"
       id="text111"><tspan
         sodipodi:role="line"
         id="tspan111"
         x="91.673836"
         y="96.820175"
         style="stroke-width:1.05833">Good anchor pos</tspan></text>
  </g>
</svg>

wavedrom-rs won't build

It won't build because it's using an unstable library feature:

• once_cell
• nonzero_min_max

The cargo install mdbook-wavedrom-rs command itself also appears to pull in Rust 1.67.1 but we're at version 1.70 now.

Am I missing an incantation?

Yes, I am! It appears we need to use the nightly build of Rust to use unstable features:

rustup override set nightly
cargo install mdbook-wavedrom-rs

Link to CLI is a 404

This link in the readme and the book https://github.com/coastalwhite/wavedrom-rs/blob/main/wavedrom-cli is a 404. Is the binary still supported?