Package com.intellij.lang

Interface PsiBuilder

All Superinterfaces:

UserDataHolder, UserDataHolderUnprotected

All Known Implementing Classes:

GeneratedParserUtilBase.Builder, IndentPsiBuilder, MasqueradingPsiBuilderAdapter, PsiBuilderAdapter, PsiBuilderImpl

public interface PsiBuilder
extends UserDataHolder, UserDataHolderUnprotected

The IDE side of a custom language parser. Provides lexical analysis results to the plugin and allows the plugin to build the AST tree.

See Also:

PsiParser, ASTNode

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PsiBuilder.Marker A marker defines a range in the document text which becomes a node in the AST tree.

Method Summary

Modifier and Type	Method and Description
void	advanceLexer() Advances the lexer to the next token, skipping whitespace and comment tokens.
void	enforceCommentTokens(TokenSet tokens)
boolean	eof() Checks if the lexer has reached the end of file.
void	error(java.lang.String messageText) Adds an error marker with the specified message text at the current position in the tree.
int	getCurrentOffset() Returns the start offset of the current token, or the file length when the token stream is over.
LighterASTNode	getLatestDoneMarker()
FlyweightCapableTreeStructure<LighterASTNode>	getLightTree() Same as getTreeBuilt() but returns a light tree, which is build faster, produces less garbage but is incapable of creating a PSI over.
java.lang.CharSequence	getOriginalText() Returns the complete text being parsed.
Project	getProject() Returns a project for which PSI builder was created (see PsiBuilderFactory).
java.lang.String	getTokenText() Returns the text of the current token from the lexer.
IElementType	getTokenType() Returns the type of current token from the lexer.
ASTNode	getTreeBuilt() Returns the result of the parsing.
IElementType	lookAhead(int steps) See what token type is in steps ahead.
PsiBuilder.Marker	mark() Creates a marker at the current parsing position.
IElementType	rawLookup(int steps) See what token type is in steps ahead/behind.
int	rawTokenIndex() Returns the index of the current token in the original sequence.
int	rawTokenTypeStart(int steps) See what token type is in steps ahead/behind current position.
void	remapCurrentToken(IElementType type) Slightly easier way to what ITokenTypeRemapper does (i.e.
void	setDebugMode(boolean dbgMode) Enables or disables the builder debug mode.
void	setTokenTypeRemapper(ITokenTypeRemapper remapper) Sets optional remapper that can change the type of tokens.
void	setWhitespaceSkippedCallback(WhitespaceSkippedCallback callback) Subscribe for notification on default whitespace and comments skipped events.

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.UserDataHolderUnprotected

getUserDataUnprotected, putUserDataUnprotected

Method Detail

getProject

Project getProject()

Returns a project for which PSI builder was created (see PsiBuilderFactory).

Returns:

project.

getOriginalText

java.lang.CharSequence getOriginalText()

Returns the complete text being parsed.

Returns:

the text being parsed

advanceLexer

void advanceLexer()

Advances the lexer to the next token, skipping whitespace and comment tokens.

getTokenType

IElementType getTokenType()

Returns the type of current token from the lexer.

Returns:

the token type, or null when the token stream is over.

See Also:

setTokenTypeRemapper(ITokenTypeRemapper).

setTokenTypeRemapper

void setTokenTypeRemapper(ITokenTypeRemapper remapper)

Sets optional remapper that can change the type of tokens. Output of getTokenType() is affected by it.

Parameters:

remapper - the remapper object, or null.

remapCurrentToken

void remapCurrentToken(IElementType type)

Slightly easier way to what ITokenTypeRemapper does (i.e. it just remaps current token to a given type).

Parameters:

type - new type for the current token.

setWhitespaceSkippedCallback

void setWhitespaceSkippedCallback(WhitespaceSkippedCallback callback)

Subscribe for notification on default whitespace and comments skipped events.

Parameters:

callback - an implementation for the callback

lookAhead

IElementType lookAhead(int steps)

See what token type is in steps ahead.

Parameters:

steps - 0 is current token (i.e. the same getTokenType() returns)

Returns:

type element which getTokenType() will return if we call advance steps times in a row

rawLookup

IElementType rawLookup(int steps)

See what token type is in steps ahead/behind.

Parameters:

steps - 0 is current token (i.e. the same getTokenType() returns)

Returns:

type element ahead or behind, including whitespace/comment tokens

rawTokenTypeStart

int rawTokenTypeStart(int steps)

See what token type is in steps ahead/behind current position.

Parameters:

steps - 0 is current token (i.e. the same getTokenType() returns)

Returns:

offset type element ahead or behind, including whitespace/comment tokens, -1 if first token, getOriginalText().getLength() at end

rawTokenIndex

int rawTokenIndex()

Returns the index of the current token in the original sequence.

Returns:

token index

getTokenText

java.lang.String getTokenText()

Returns the text of the current token from the lexer.

Returns:

the token text, or null when the token stream is over.

getCurrentOffset

int getCurrentOffset()

Returns the start offset of the current token, or the file length when the token stream is over.

Returns:

the token offset.

mark

PsiBuilder.Marker mark()

Creates a marker at the current parsing position.

Returns:

the new marker instance.

error

void error(java.lang.String messageText)

Adds an error marker with the specified message text at the current position in the tree.
Note: from series of subsequent errors messages only first will be part of resulting tree.

Parameters:

messageText - the text of the error message displayed to the user.

eof

boolean eof()

Checks if the lexer has reached the end of file.

Returns:

true if the lexer is at end of file, false otherwise.

getTreeBuilt

ASTNode getTreeBuilt()

Returns the result of the parsing. All markers must be completed or dropped before this method is called.

Returns:

the built tree.

getLightTree

FlyweightCapableTreeStructure<LighterASTNode> getLightTree()

Same as getTreeBuilt() but returns a light tree, which is build faster, produces less garbage but is incapable of creating a PSI over.
Note: this method shouldn't be called if getTreeBuilt() was called before.

Returns:

the light tree built.

setDebugMode

void setDebugMode(boolean dbgMode)

Enables or disables the builder debug mode. In debug mode, the builder will print stack trace to marker allocation position if one is not done when calling getTreeBuilt().

Parameters:

dbgMode - the debug mode value.

enforceCommentTokens

void enforceCommentTokens(TokenSet tokens)

getLatestDoneMarker

LighterASTNode getLatestDoneMarker()

Returns:

latest left done node for context dependent parsing.