com.massa.dsl.block

Interface LexerBlockResolver

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractInjectableLexerBlock.AbstractInjectableLexerBlockResolver, AbstractLexerBlockResolver, AndLexerBlock.AndBlockResolver, LexerBlockResolverWrapper, LexerClassBlock.LexerClassBlockResolver, LexerIdBlock.LexerIdBlockResolver, LexerIdsBlock.LexerIdsBlockResolver, LexerTypeBlock.LexerTypeBlockResolver, OrLexerBlock.OrBlockResolver

public interface LexerBlockResolver
extends Serializable

Block resolver linked to a block. A resolver instance is dedicated to a specific and atomic parsing operation and should not be reused after this operation finishes. The life cycle of an instance should in general be the same as a LexerParser instance using it.

Method Summary

Modifier and Type	Method and Description
void	consume(LexerParser parser) Indicates that this parser has been consumed.
LexerBlock	getBlock()
LexerParser	identify(LexerParser parentParser) Should Calls identify(LexerParser, boolean) with safe mode computed from unicity, mandatory flag min/max occur and already consumed parsers.
LexerParser	identify(LexerParser parentParser, boolean safeMode) Identifies the lexer to use between candidates identified by resolveLexers(Grammar) to handle the following source part.
LexerParser	identifyAndConsume(LexerParser parentParser) Short cut to call both identity and consume
LexerParser	identifyAndConsume(LexerParser parentParser, boolean safeMode) Short cut to call both identity and consume
void	inject(Object target, LexerParser value) Method used to inject result.
boolean	isExcluded(Matcher matcher)
boolean	isHasBeenConsumed()
boolean	isMaxConsommationReached()
boolean	isMinConsommationReached()
List<Lexer>	resolveLexers(Grammar grammar) Resolves the lexer(s) described by this block's configuration that can still be candidate in this parsing operation.

Method Detail

resolveLexers

List<Lexer> resolveLexers(Grammar grammar)
                   throws DslException

Resolves the lexer(s) described by this block's configuration that can still be candidate in this parsing operation.

Throws:

DslException

identify

LexerParser identify(LexerParser parentParser)
              throws IOException,
                     DslException

Should Calls identify(LexerParser, boolean) with safe mode computed from unicity, mandatory flag min/max occur and already consumed parsers.

Throws:

IOException

DslException

identify

LexerParser identify(LexerParser parentParser,
                     boolean safeMode)
              throws IOException,
                     DslException

Identifies the lexer to use between candidates identified by resolveLexers(Grammar) to handle the following source part.
The chosen one will be the lexer with the longuest start matching the source.

Parameters:

parentParser - Parent parser

safeMode - If false, an exception will be thrown if no lexer is identified

Returns:

Identified Lexer

Throws:

IOException

DslException

consume

void consume(LexerParser parser)
      throws DslException

Indicates that this parser has been consumed. Depending on the type and configuration (unicity, etc ...) of the block, different action can be taken: none, the parser will not be candidate anymore, no candidate will be resolved anymore.

Parameters:

parser -

Throws:

DslException

identifyAndConsume

LexerParser identifyAndConsume(LexerParser parentParser)
                        throws IOException,
                               DslException

Short cut to call both identity and consume

Throws:

IOException

DslException

identifyAndConsume

LexerParser identifyAndConsume(LexerParser parentParser,
                               boolean safeMode)
                        throws IOException,
                               DslException

Short cut to call both identity and consume

Throws:

IOException

DslException

isHasBeenConsumed

boolean isHasBeenConsumed()

Returns:

Consumed at least once ?

isMinConsommationReached

boolean isMinConsommationReached()

Returns:

Has been consumed enough to respect mandatory flag and min-occur ?

isMaxConsommationReached

boolean isMaxConsommationReached()

Returns:

Can still be consumed and respect unicity flag and max-occur ?

inject

void inject(Object target,
            LexerParser value)
     throws UtilsException

Method used to inject result.

Throws:

UtilsException

isExcluded

boolean isExcluded(Matcher matcher)
            throws DslException

Returns:

true if the matcher has been specified as excluded.

Throws:

DslException

getBlock

LexerBlock getBlock()

Returns:

Parent block at the origin of this current instance.