Package org.opencypher.railroad

Class AsciiArtRenderer

java.lang.Object

org.opencypher.railroad.AsciiArtRenderer

All Implemented Interfaces:

Function<org.opencypher.railroad.PositionedText,String>, Diagram.CanvasProvider<org.opencypher.railroad.PositionedText,RuntimeException>, Diagram.Renderer<org.opencypher.railroad.PositionedText,String,RuntimeException>

public class AsciiArtRenderer
extends Object

Constructor Summary

Constructors

Constructor	Description
AsciiArtRenderer()

Method Summary

Modifier and Type	Method	Description
String	apply(org.opencypher.railroad.PositionedText text)
org.opencypher.railroad.PositionedText	newCanvas(String name, double width, double height)
void	renderAnyCase(org.opencypher.railroad.PositionedText target, double x, double y, String text)	Example: /FOO/
void	renderBranch(org.opencypher.railroad.PositionedText target, double x, double y, org.opencypher.railroad.Size size, Collection<Diagram.Figure> branches, boolean forward)	Examples:
void	renderBullet(org.opencypher.railroad.PositionedText target, double x, double y)	Example: o
void	renderCharset(org.opencypher.railroad.PositionedText target, double x, double y, String text, String set)	Examples: [:ID_Start:] [^a-z]
void	renderDiagram(String name, org.opencypher.railroad.PositionedText text, Diagram.Figure root)
void	renderLine(org.opencypher.railroad.PositionedText target, double x, double y, org.opencypher.railroad.Size size, List<Diagram.Figure> sequence, boolean forward)	Example:
void	renderLoop(org.opencypher.railroad.PositionedText target, double x, double y, org.opencypher.railroad.Size size, Diagram.Figure forward, Diagram.Figure backward, String description, boolean forwardDirection)	Example:
void	renderNothing(org.opencypher.railroad.PositionedText target, double x, double y, boolean forward)	Example: >
void	renderReference(org.opencypher.railroad.PositionedText canvas, double x, double y, String target, String name)	Example: |foo|
String	renderText(String type, String text)
void	renderText(org.opencypher.railroad.PositionedText target, double x, double y, String text)	Example: (FOO)
org.opencypher.railroad.Size	sizeOfAnyCase(String text)
org.opencypher.railroad.Size	sizeOfBranch(Collection<Diagram.Figure> branches)
org.opencypher.railroad.Size	sizeOfBullet()
org.opencypher.railroad.Size	sizeOfCharset(String text)
org.opencypher.railroad.Size	sizeOfLine(Collection<Diagram.Figure> sequence)
org.opencypher.railroad.Size	sizeOfLoop(Diagram.Figure forward, Diagram.Figure backward, String description)
org.opencypher.railroad.Size	sizeOfNothing()
org.opencypher.railroad.Size	sizeOfReference(String name)
org.opencypher.railroad.Size	sizeOfText(String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opencypher.railroad.Diagram.Renderer

diagramSize

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

AsciiArtRenderer

public AsciiArtRenderer()

Method Detail

sizeOfBullet

public org.opencypher.railroad.Size sizeOfBullet()

renderBullet

public void renderBullet(org.opencypher.railroad.PositionedText target,
                         double x,
                         double y)

Example: o

sizeOfNothing

public org.opencypher.railroad.Size sizeOfNothing()

renderNothing

public void renderNothing(org.opencypher.railroad.PositionedText target,
                          double x,
                          double y,
                          boolean forward)

Example: >

sizeOfText

public org.opencypher.railroad.Size sizeOfText(String text)

renderText

public void renderText(org.opencypher.railroad.PositionedText target,
                       double x,
                       double y,
                       String text)

Example: (FOO)

sizeOfAnyCase

public org.opencypher.railroad.Size sizeOfAnyCase(String text)

renderAnyCase

public void renderAnyCase(org.opencypher.railroad.PositionedText target,
                          double x,
                          double y,
                          String text)

Example: /FOO/

sizeOfReference

public org.opencypher.railroad.Size sizeOfReference(String name)

renderReference

public void renderReference(org.opencypher.railroad.PositionedText canvas,
                            double x,
                            double y,
                            String target,
                            String name)

Example: |foo|

sizeOfCharset

public org.opencypher.railroad.Size sizeOfCharset(String text)

renderCharset

public void renderCharset(org.opencypher.railroad.PositionedText target,
                          double x,
                          double y,
                          String text,
                          String set)

Examples:

• [:ID_Start:]
• [^a-z]

sizeOfLine

public org.opencypher.railroad.Size sizeOfLine(Collection<Diagram.Figure> sequence)

renderLine

public void renderLine(org.opencypher.railroad.PositionedText target,
                       double x,
                       double y,
                       org.opencypher.railroad.Size size,
                       List<Diagram.Figure> sequence,
                       boolean forward)

Example:

 o->|alpha|->(,)->|beta|->o
 

sizeOfBranch

public org.opencypher.railroad.Size sizeOfBranch(Collection<Diagram.Figure> branches)

renderBranch

public void renderBranch(org.opencypher.railroad.PositionedText target,
                         double x,
                         double y,
                         org.opencypher.railroad.Size size,
                         Collection<Diagram.Figure> branches,
                         boolean forward)

Examples:

 o-+-->|one|--+->o
   |          |
   +-->|two|--+
   |          |
   +->|three|-+
 

sizeOfLoop

public org.opencypher.railroad.Size sizeOfLoop(Diagram.Figure forward,
                                               Diagram.Figure backward,
                                               String description)

renderLoop

public void renderLoop(org.opencypher.railroad.PositionedText target,
                       double x,
                       double y,
                       org.opencypher.railroad.Size size,
                       Diagram.Figure forward,
                       Diagram.Figure backward,
                       String description,
                       boolean forwardDirection)

Example:

   +--|two|<-+
   |         |
 o-+->|one|--+->o
 

newCanvas

public org.opencypher.railroad.PositionedText newCanvas(String name,
                                                        double width,
                                                        double height)

Specified by:

newCanvas in interface Diagram.CanvasProvider<org.opencypher.railroad.PositionedText,RuntimeException>

apply

public String apply(org.opencypher.railroad.PositionedText text)

Specified by:

apply in interface Function<org.opencypher.railroad.PositionedText,String>

renderDiagram

public void renderDiagram(String name,
                          org.opencypher.railroad.PositionedText text,
                          Diagram.Figure root)

Specified by:

renderDiagram in interface Diagram.Renderer<org.opencypher.railroad.PositionedText,String,RuntimeException>

renderText

public String renderText(String type,
                         String text)

Specified by:

renderText in interface Diagram.Renderer<org.opencypher.railroad.PositionedText,String,RuntimeException>