Package org.opencypher.tools.grammar

Class Antlr4

java.lang.Object

org.opencypher.tools.grammar.Antlr4

All Implemented Interfaces:

AutoCloseable, ProductionVisitor<RuntimeException>, TermVisitor<RuntimeException>

public class Antlr4
extends Object

Generates an ANTLR (version 4) grammar from a Grammar.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<Integer>	caseChars
protected Output	output

Method Summary

Modifier and Type	Method	Description
protected void	alternativesLinePrefix(int altPrefix)
protected void	alternativesSeparator()
protected void	caseInsensitive(String value)	Writes a case insensitive literal.
protected void	caseInsensitiveProductionStart(String name)
protected void	characterSet(CharacterSet characters)
void	close()
protected void	epsilon()
static Parser	generateParser(Grammar grammar, String root, Output output)
protected void	groupPrefix()
protected void	groupSuffix()
protected void	literal(String value)	Writes a case sensitive literal.
static void	main(String... args)
protected void	nonTerminal(NonTerminal nonTerminal)
protected boolean	optionalPrefix()
protected void	optionalSuffix()
protected String	prefix(String s)
protected void	productionCommentLinePrefix()
protected void	productionCommentPrefix()
protected void	productionCommentSuffix()
protected void	productionEnd()
protected void	productionStart(Production p)
protected void	repeat(int minTimes, Integer maxTimes, Runnable repeated)
static void	resetPrefix()
protected void	sequenceSeparator()
static void	setPrefix(String newPrefix)
void	visitAlternatives(Alternatives alternatives)
void	visitCharacters(CharacterSet characters)
void	visitEpsilon()
void	visitLiteral(Literal literal)
void	visitNonTerminal(NonTerminal nonTerminal)
void	visitOptional(Optional optional)
void	visitProduction(Production production)
void	visitRepetition(Repetition repetition)
void	visitSequence(Sequence sequence)
static void	write(Grammar grammar, OutputStream stream)
static void	write(Grammar grammar, Writer writer)
static void	write(Grammar grammar, Path path, OutputStream stream)
static void	write(Grammar grammar, Output output)

Methods inherited from class java.lang.Object

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

Field Detail

output

protected final Output output

caseChars

protected final Set<Integer> caseChars

Method Detail

setPrefix

public static void setPrefix(String newPrefix)

resetPrefix

public static void resetPrefix()

write

public static void write(Grammar grammar,
                         Writer writer)

write

public static void write(Grammar grammar,
                         OutputStream stream)

write

public static void write(Grammar grammar,
                         Path path,
                         OutputStream stream)

write

public static void write(Grammar grammar,
                         Output output)

main

public static void main(String... args)
                 throws Exception

Throws:

Exception

generateParser

public static Parser generateParser(Grammar grammar,
                                    String root,
                                    Output output)

close

public void close()

Specified by:

close in interface AutoCloseable

productionCommentPrefix

protected void productionCommentPrefix()

productionCommentLinePrefix

protected void productionCommentLinePrefix()

productionCommentSuffix

protected void productionCommentSuffix()

productionStart

protected void productionStart(Production p)

productionEnd

protected void productionEnd()

alternativesLinePrefix

protected void alternativesLinePrefix(int altPrefix)

alternativesSeparator

protected void alternativesSeparator()

sequenceSeparator

protected void sequenceSeparator()

groupPrefix

protected void groupPrefix()

groupSuffix

protected void groupSuffix()

optionalPrefix

protected boolean optionalPrefix()

Returns:

true if the prefix implies grouping.

optionalSuffix

protected void optionalSuffix()

repeat

protected void repeat(int minTimes,
                      Integer maxTimes,
                      Runnable repeated)

characterSet

protected void characterSet(CharacterSet characters)

nonTerminal

protected void nonTerminal(NonTerminal nonTerminal)

prefix

protected String prefix(String s)

literal

protected void literal(String value)

Writes a case sensitive literal.

Parameters:

value - the case sensitive literal to be written.

caseInsensitive

protected void caseInsensitive(String value)

Writes a case insensitive literal.

Parameters:

value - the case insensitive literal to be written.

caseInsensitiveProductionStart

protected void caseInsensitiveProductionStart(String name)

epsilon

protected void epsilon()

visitProduction

public final void visitProduction(Production production)
                           throws RuntimeException

Specified by:

visitProduction in interface ProductionVisitor<RuntimeException>

Throws:

RuntimeException

visitAlternatives

public final void visitAlternatives(Alternatives alternatives)

Specified by:

visitAlternatives in interface TermVisitor<RuntimeException>

visitSequence

public final void visitSequence(Sequence sequence)

Specified by:

visitSequence in interface TermVisitor<RuntimeException>

visitLiteral

public final void visitLiteral(Literal literal)

Specified by:

visitLiteral in interface TermVisitor<RuntimeException>

visitCharacters

public final void visitCharacters(CharacterSet characters)

Specified by:

visitCharacters in interface TermVisitor<RuntimeException>

visitNonTerminal

public final void visitNonTerminal(NonTerminal nonTerminal)

Specified by:

visitNonTerminal in interface TermVisitor<RuntimeException>

visitOptional

public final void visitOptional(Optional optional)

Specified by:

visitOptional in interface TermVisitor<RuntimeException>

visitRepetition

public final void visitRepetition(Repetition repetition)

Specified by:

visitRepetition in interface TermVisitor<RuntimeException>

visitEpsilon

public final void visitEpsilon()
                        throws RuntimeException

Specified by:

visitEpsilon in interface TermVisitor<RuntimeException>

Throws:

RuntimeException