Package com.intellij.ide.highlighter.custom

Class AbstractCustomLexer

java.lang.Object

com.intellij.lexer.Lexer

com.intellij.lexer.LexerBase

com.intellij.ide.highlighter.custom.AbstractCustomLexer

Direct Known Subclasses:

CustomFileTypeLexer

public class AbstractCustomLexer
extends LexerBase

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.CharSequence	myBuffer
protected TokenInfo	myCurrentToken
protected int	myEndOffset
protected int	myPosition
protected int	myStartOffset

Constructor Summary

Constructors

Constructor and Description
AbstractCustomLexer(java.util.List<TokenParser> tokenParsers)

Method Summary

Modifier and Type	Method and Description
void	advance() Advances the lexer to the next token.
int	getBufferEnd() Returns the offset at which the lexer will stop lexing.
java.lang.CharSequence	getBufferSequence() Returns the buffer sequence over which the lexer is running.
int	getState() Returns the current state of the lexer.
int	getTokenEnd() Returns the end offset of the current token.
int	getTokenStart() Returns the start offset of the current token.
IElementType	getTokenType() Returns the token at the current position of the lexer or null if lexing is finished.
protected void	handleTokenNotFound()
void	start(java.lang.CharSequence buffer, int startOffset, int endOffset, int initialState) Prepare for lexing character data from buffer passed.

Methods inherited from class com.intellij.lexer.LexerBase

getCurrentPosition, restore

Methods inherited from class com.intellij.lexer.Lexer

getTokenSequence, getTokenText, start, start

Methods inherited from class java.lang.Object

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

Field Detail

myBuffer

protected java.lang.CharSequence myBuffer

myStartOffset

protected int myStartOffset

myEndOffset

protected int myEndOffset

myCurrentToken

protected TokenInfo myCurrentToken

myPosition

protected int myPosition

Constructor Detail

AbstractCustomLexer

public AbstractCustomLexer(java.util.List<TokenParser> tokenParsers)

Method Detail

start

public void start(java.lang.CharSequence buffer,
                  int startOffset,
                  int endOffset,
                  int initialState)

Description copied from class: Lexer

Prepare for lexing character data from buffer passed. Internal lexer state is supposed to be initialState. It is guaranteed that the value of initialState is the same as returned by Lexer.getState() method of this lexer at condition startOffset=getTokenStart(). This method is used to incrementally re-lex changed characters using lexing data acquired from this particular lexer sometime in the past.

Specified by:

start in class Lexer

Parameters:

buffer - character data for lexing.

startOffset - offset to start lexing from

endOffset - offset to stop lexing at

initialState - the initial state of the lexer.

getState

public int getState()

Description copied from class: Lexer

Returns the current state of the lexer.

Specified by:

getState in class Lexer

Returns:

the lexer state.

getTokenType

public IElementType getTokenType()

Description copied from class: Lexer

Returns the token at the current position of the lexer or null if lexing is finished.

Specified by:

getTokenType in class Lexer

Returns:

the current token.

getTokenStart

public int getTokenStart()

Description copied from class: Lexer

Returns the start offset of the current token.

Specified by:

getTokenStart in class Lexer

Returns:

the current token start offset.

getTokenEnd

public int getTokenEnd()

Description copied from class: Lexer

Returns the end offset of the current token.

Specified by:

getTokenEnd in class Lexer

Returns:

the current token end offset.

advance

public void advance()

Description copied from class: Lexer

Advances the lexer to the next token.

Specified by:

advance in class Lexer

handleTokenNotFound

protected void handleTokenNotFound()

getBufferSequence

public java.lang.CharSequence getBufferSequence()

Description copied from class: Lexer

Returns the buffer sequence over which the lexer is running. This method should return the same buffer instance which was passed to the start() method.

Specified by:

getBufferSequence in class Lexer

Returns:

the lexer buffer.

getBufferEnd

public int getBufferEnd()

Description copied from class: Lexer

Returns the offset at which the lexer will stop lexing. This method should return the length of the buffer or the value passed in the endOffset parameter to the start() method.

Specified by:

getBufferEnd in class Lexer

Returns:

the lexing end offset