Package com.sonar.sslr.api

Class Preprocessor2

java.lang.Object

com.sonar.sslr.api.Preprocessor2

Direct Known Subclasses:

CobolPreprocessor

public abstract class Preprocessor2
extends Object

A Preprocessor can be used to modify the content of the LexerOuput before launching the parser. A proprocessor can be used for instance to replace a token or a list of tokens by another token or list of tokens.

Constructor Summary

Constructors

Constructor	Description
Preprocessor2()

Method Summary

Modifier and Type	Method	Description
void	endLexing(LexerOutput output)	Method calls after having lexed a source code.
abstract boolean	process(Token token, LexerOutput output)	This method is called just before adding a new Token to the LexerOutput.
void	startLexing()	Method calls before starting lexing the source code.

Methods inherited from class java.lang.Object

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

Constructor Detail

Preprocessor2

public Preprocessor2()

Method Detail

process

public abstract boolean process(Token token,
                                LexerOutput output)

This method is called just before adding a new Token to the LexerOutput. The Preprocessor is able to intercept this token and do what ever it wants with it.

Parameters:

token - the token to preprocess

output - the lexer output that can be used to inject any tokens.

Returns:

false if that token hasn't been pre-processed and true otherwise. If the method returns true, no other preprocessing operations will be done on this token and this token won't be added to the LexerOutput

endLexing

public void endLexing(LexerOutput output)

Method calls after having lexed a source code. Some additional operations can be done by the Preprocessor on the LexerOuput if required.

startLexing

public void startLexing()

Method calls before starting lexing the source code. This method can be overridden to initialize a state for instance.