A .Net Port of tabatkins' railroad-diagrams. A big chunk of the Readme is from tabatkins' project.
==========================
This is a small library for generating railroad diagrams (like what JSON.org uses) using SVGs.
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!
To use the library, just include the js and css files, and then call the Diagram() function. Its arguments are the components of the diagram (Diagram is a special form of Sequence).
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()).
Components are either leaves or containers.
The leaves:
- Terminal(text, href) or a bare string - represents literal text. The 'href' attribute is optional, and creates a hyperlink with the given destination.
- NonTerminal(text, href) - represents an instruction or another production. The 'href' attribute is optional, and creates a hyperlink with the given destination.
- Comment(text, href) - a comment. The 'href' attribute is optional, and creates a hyperlink with the given destination.
- Skip() - an empty line
- Start(type, label) and End(type) - the start/end shapes. These are supplied by default, but if you want to supply a label to the diagram, you can create a Start() explicitly (as the first child of the Diagram!). The "type" attribute takes either "simple" (the default) or "complex", a la Diagram() and ComplexDiagram(). All arguments are optional.
The containers:
-
Sequence(children) - like simple concatenation in a regex.
-
Stack(children) - identical to a Sequence, but the items are stacked vertically rather than horizontally. Best used when a simple Sequence would be too wide; instead, you can break the items up into a Stack of Sequences of an appropriate width.
-
OptionalSequence(children) - a Sequence where every item is individually optional, but at least one item must be chosen
-
Choice(index, children) - like
|in a regex. The index argument specifies which child is the "normal" choice and should go in the middle
-
MultipleChoice(index, type, children) - like
||or&&in a CSS grammar; it's similar to a Choice, but more than one branch can be taken. The index argument specifies which child is the "normal" choice and should go in the middle, while the type argument must be either "any" (1+ branches can be taken) or "all" (all branches must be taken).
-
HorizontalChoice(children) - Identical to Choice, but the items are stacked horizontally rather than vertically. There's no "straight-line" choice, so it just takes a list of children. Best used when a simple Choice would be too tall; instead, you can break up the items into a HorizontalChoice of Choices of an appropriate height.
-
Optional(child, skip) - like
?in a regex. A shorthand forChoice(1, Skip(), child). If the optionalskipparameter has the value"skip", it instead puts the Skip() in the straight-line path, for when the "normal" behavior is to omit the item.
-
OneOrMore(child, repeat) - like
+in a regex. The 'repeat' argument is optional, and specifies something that must go between the repetitions.
-
ZeroOrMore(child, repeat, skip) - like
*in a regex. A shorthand forOptional(OneOrMore(child, repeat)). The optionalskipparameter is identical to Optional().
After constructing a Diagram, call .format(x,y,width) on it, specifying 0-4 padding values (just like CSS) for some additional "breathing space" around the diagram (the paddings default to 20px).
There are a few options you can tweak, inside the defaultConfiguration object inside the Utilities 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 metrics for the leaf nodes as well.
- VerticalSeperation - sets the minimum amount of vertical separation between two items. Note that the stroke width isn't counted when computing the separation; this shouldn't be relevant unless you have a very small separation or very large stroke width.
- ArcRadius - the radius of the arcs used in the branching containers like Choice. This has a relatively large effect on the size of non-trivial diagrams. Both tight and loose values look good, depending on what you're going for.
- DiagramClass - the class set on the root
<svg>element of each diagram, for use in the CSS stylesheet. - IsStrokeOddPiexlLength - the default stylesheet uses odd pixel lengths for 'stroke'. Due to rasterization artifacts, they look best when the item has been translated half a pixel in both directions. If you change the styling to use a stroke with even pixel lengths, you'll want to set this variable to
false. - InternalAlignment - when some branches of a container are narrower than others, this determines how they're aligned in the extra space. Defaults to "center", but can be set to "left" or "right".
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.
This document and all associated files in the github project are licensed under CC0 