com.massa.dsl.lexer

Interface Lexer

All Superinterfaces:

Documented, MatcherAutoCompleter, Serializable

All Known Implementing Classes:

AbstractLexer, ActionLexer, BooleanLexer, CharacterLexer, DecimalLexer, EnumLexer, HardCodedLexer, IntegerLexer, MappedPropertyLexer, MatcherLexer, NextCharLexer, NextSpaceLexer, NullLexer, ObjectLexer, RegexLexer, StringLexer, SubParseLexer, TextLexer, TransformLexer, ValueLexer, ValuesLexer

public interface Lexer
extends Documented, Serializable, MatcherAutoCompleter

Describes all methods of the lexer implementations.
A lexer is an object describing how a part of the input source should be parsed. It consists in 3 steps :

• A mandatory start match, allowing to determine if this lexer is candidate to parse the next sourcce part
• The parsing process
• An optional end match

A lexer implementation must be thread safe and several sources can be parsed in parallel.

Method Summary

Modifier and Type	Method and Description
String	getId()
LexerParserListener	getListener() Retrieves the LexerParserListener if configured.
AutoCompleteConfiguration	getMatcherAutoCompleteConfiguration() Allows to configure a preferred autoComplete scheme for this lexer.
LexerParser	getParser(LexerParser parent) Returns a parser which is able to handles the text relative to this lexer
boolean	isOrdered()
boolean	isRoot()
boolean	isRootOnly()
LexerMatcher	resolveEnd(LexerParser lexerParser) Resolves the end matcher for this lexer.
LexerMatcher	resolveStart(LexerParser lexerParser) Resolves the start matcher for this lexer.
Class<?>	resolveType(Grammar grammar) Resolves the type of the object parsed by this lexer.
void	setId(String id)
void	validate(Grammar grammar) Allows to validate the lexer.

Methods inherited from interface com.massa.dsl.doc.Documented

getDslDoc, setDslDoc

Methods inherited from interface com.massa.dsl.autocomplete.MatcherAutoCompleter

setMatcherAutoCompleteConfiguration

Method Detail

getId

String getId()

Returns:

Lexer unique ID

setId

void setId(String id)

Parameters:

id - Lexer unique ID to set

isRoot

boolean isRoot()

Returns:

true if this lexer can be used as root, i.e. at first parsing level

isRootOnly

boolean isRootOnly()

Returns:

true if this lexer can be used only as root, i.e. at first parsing level

isOrdered

boolean isOrdered()

Returns:

true if the different elements of this lexer should be ordered

resolveStart

LexerMatcher resolveStart(LexerParser lexerParser)
                   throws DslException

Resolves the start matcher for this lexer. This method should be used mainly by the LexerParser to retrieve its matcher instance.

Throws:

DslException

See Also:

LexerParser.resolveStart()

resolveEnd

LexerMatcher resolveEnd(LexerParser lexerParser)
                 throws DslException

Resolves the end matcher for this lexer. This method should be used mainly by the LexerParser to retrieve its matcher instance.

Throws:

DslException

See Also:

LexerParser.resolveEnd()

resolveType

Class<?> resolveType(Grammar grammar)
              throws DslException

Resolves the type of the object parsed by this lexer.

Throws:

DslException

validate

void validate(Grammar grammar)
       throws DslException

Allows to validate the lexer.

Parameters:

grammar - Related grammar

Throws:

DslException

getParser

LexerParser getParser(LexerParser parent)
               throws DslException

Returns a parser which is able to handles the text relative to this lexer

Parameters:

parent - Parent parser

Returns:

Object generated by this lexer

Throws:

DslException

getListener

LexerParserListener getListener()

Retrieves the LexerParserListener if configured.

getMatcherAutoCompleteConfiguration

AutoCompleteConfiguration getMatcherAutoCompleteConfiguration()

Allows to configure a preferred autoComplete scheme for this lexer.
Allows to disable all automatic options for all matchers, but not configured options.

Specified by:

getMatcherAutoCompleteConfiguration in interface MatcherAutoCompleter

Returns:

AutoComplete configuration.