railroad-diagrams

Railroad-diagram Generator

<img src=”https://github.com/tabatkins/railroad-diagrams/raw/gh-pages/images/rr-title.svg?sanitize=true” alt=”Diagram(Stack(‘Generate’, ‘some’), OneOrMore(NonTerminal(‘railroad diagrams’), Comment(‘and more’)))” title=”Diagram(Stack(‘Generate’, ‘some’), OneOrMore(NonTerminal(‘railroad diagrams’), Comment(‘and more’)))” width=10000>

This is a small library for generating railroad diagrams (like what JSON.org uses) using SVG, with both JS and Python ports.

Railroad diagrams are a way of visually representing a grammar in a form that is more readable than using regular expressions or BNF. They can easily represent any context-free grammar, and some more powerful grammars. There are several railroad-diagram generators out there, but none of them had the visual appeal I wanted, so I wrote my own.

Here’s an online dingus for you to play with and get SVG code from!

(For Python, see the Python README, or just pip install railroad-diagrams.)

Diagrams

To use the library, include railroad.css in your page, and import the railroad.js module in your script, then call the Diagram() function. Its arguments are the components of the diagram (Diagram is a special form of Sequence).

The constructors for each node are named exports in the module; the default export is an object of same-named functions that just call the constructors, so you can construct diagrams without having to spam new all over the place:

// Use the constructors
import {Diagram, Choice} from "./railroad.js";
const d = new Diagram("foo", new Choice(0, "bar", "baz"));

// Or use the functions that call the constructors for you
import rr from "./railroad.js";
const d = rr.Diagram("foo", rr.Choice(0, "bar", "baz"));

Alternately, you can call ComplexDiagram(); it’s identical to Diagram(), but has slightly different start/end shapes, same as what JSON.org does to distinguish between “leaf” types like number (ordinary Diagram()) and “container” types like Array (ComplexDiagram()).

The Diagram class also has a few methods:

Components

Components are either leaves or containers.

The leaves:

The containers:

After constructing a Diagram, call .format(...padding) on it, specifying 0-4 padding values (just like CSS) for some additional “breathing space” around the diagram (the paddings default to 20px).

The result can either be .toString()‘d for the markup, or .toSVG()‘d for an <svg> element, which can then be immediately inserted to the document. As a convenience, Diagram also has an .addTo(element) method, which immediately converts it to SVG and appends it to the referenced element with default paddings. element defaults to document.body.

Options

There are a few options you can tweak, in an Options object exported from the module. Just tweak either until the diagram looks like what you want. You can also change the CSS file - feel free to tweak to your heart’s content. Note, though, that if you change the text sizes in the CSS, you’ll have to go adjust the options specifying the text metrics as well.

Caveats

SVG can’t actually respond to the sizes of content; in particular, there’s no way to make SVG adjust sizing/positioning based on the length of some text. Instead, I guess at some font metrics, which mostly work as long as you’re using a fairly standard monospace font. This works pretty well, but long text inside of a construct might eventually overflow the construct.

License

This document and all associated files in the github project are licensed under CC0 . This means you can reuse, remix, or otherwise appropriate this project for your own use without restriction. (The actual legal meaning can be found at the above link.) Don’t ask me for permission to use any part of this project, just use it. I would appreciate attribution, but that is not required by the license.