org.stekikun.dolmen.syntax

Class Lexer

java.lang.Object

org.stekikun.dolmen.syntax.Lexer

public final class Lexer
extends Object

A lexer definition is a set of lexer rules along with arbitrary header and footer sections. The rules come in no particular order, as every rule can theoretically be used as an entry point to the generated lexer. When only one entry point really makes sense, it is conventionally the first rule.

Author:

Stéphane Lescuyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Lexer.Builder A builder class for Lexer, where entries can be added incrementally, and which takes care of collecting problem reports along the way
static class	Lexer.Clause A clause associates a regular expression to a Java semantic action.
static class	Lexer.Entry A lexer rule entry is a sequence of regular expressions associated to semantic actions.
static class	Lexer.IllFormedException Exception raised by the lexer builder class when trying to construct an ill-formed lexer description.

Field Summary

Fields

Modifier and Type	Field and Description
List<Lexer.Entry>	entryPoints The list of entrypoints
Extent	footer The extent of this lexer's footer
Extent	header The extent of this lexer's class header
List<Located<String>>	imports The Java imports to be added to the generated lexer
List<Option>	options The configuration options specified in this grammar
Map<Located<String>,Regular>	regulars The named auxiliary regular expressions defined in this lexer NB: These expressions are already inlined in entryPoints during the parsing so they are only stored in the lexer description for UI feedback purposes.

Method Summary

Modifier and Type	Method and Description
static Lexer	of(List<Option> options, List<Located<String>> imports, Extent header, Map<Located<String>,Regular> regulars, Iterable<Lexer.Entry> entryPoints, Extent footer)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

options

public final List<Option> options

The configuration options specified in this grammar

imports

public final List<Located<String>> imports

The Java imports to be added to the generated lexer

header

public final Extent header

The extent of this lexer's class header

regulars

public final Map<Located<String>,Regular> regulars

The named auxiliary regular expressions defined in this lexer NB: These expressions are already inlined in entryPoints during the parsing so they are only stored in the lexer description for UI feedback purposes.

entryPoints

public final List<Lexer.Entry> entryPoints

The list of entrypoints

footer

public final Extent footer

The extent of this lexer's footer

Method Detail

toString

public String toString()

Overrides:

toString in class Object

of

public static Lexer of(List<Option> options,
                       List<Located<String>> imports,
                       Extent header,
                       Map<Located<String>,Regular> regulars,
                       Iterable<Lexer.Entry> entryPoints,
                       Extent footer)

Parameters:

options -

imports -

header -

regulars -

entryPoints -

footer -

Returns:

a lexer description built out of the given data, using the builder class to detect potential problems

Throws:

Lexer.IllFormedException - if the description is ill-formed