模块 aya.ij.parsing.core

程序包 com.intellij.psi.builder

类 FleetPsiBuilder<N>

java.lang.Object

com.intellij.psi.builder.FleetPsiBuilder<N>

所有已实现的接口:

PsiBuilder, SyntaxTreeBuilder, UserDataHolder

直接已知子类:

MarkerPsiBuilder

public abstract class FleetPsiBuilder<N>
extends Object
implements PsiBuilder

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	FleetPsiBuilder.ProductionMarker

从接口继承的嵌套类/接口 com.intellij.lang.PsiBuilder

PsiBuilder.Marker

构造器概要

构造器

构造器	说明
FleetPsiBuilder(@NotNull CharSequence text, @NotNull ITokenSequence tokens, @NotNull TokenSet whitespaceTokens, @NotNull TokenSet commentTokens, int startLexeme, int lexemeCount)

方法概要

修饰符和类型	方法	说明
void	advanceLexer()	Advances the lexer to the next token, skipping whitespace and comment tokens.
void	enforceCommentTokens(@NotNull TokenSet tokens)
final boolean	eof()	Checks if the lexer has reached the end of file.
void	error(@NotNull 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.
static @Nullable String	getErrorMessage(@NotNull LighterASTNode node)
@Nullable com.intellij.psi.builder.FleetPsiBuilder.StartMarker	getLatestDoneMarker()
@NotNull CharSequence	getOriginalText()	Returns the complete text being parsed.
@Nullable List<FleetPsiBuilder.ProductionMarker>	getProductions()
abstract N	getRoot()
@Nullable String	getTokenText()	Returns the text of the current token from the lexer.
@Nullable IElementType	getTokenType()	Returns the type of current token from the lexer.
<T> T	getUserData(@NotNull Key<T> key)
boolean	isWhitespaceOrComment(@NotNull IElementType elementType)
@Nullable IElementType	lookAhead(int steps)	See what token type is in steps ahead.
@NotNull PsiBuilder.Marker	mark()	Creates a marker at the current parsing position.
<T> void	putUserData(@NotNull Key<T> key, T value)	Add a new user data value to this object.
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. it just remaps current token to a given type).
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(@Nullable WhitespaceSkippedCallback callback)	Subscribe for notification on default whitespace and comments skipped events.
boolean	whitespaceOrComment(IElementType token)

从类继承的方法 java.lang.Object

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

从接口继承的方法 com.intellij.lang.PsiBuilder

getTreeBuilt

构造器详细资料

FleetPsiBuilder

public FleetPsiBuilder(@NotNull
 @NotNull CharSequence text,
 @NotNull
 @NotNull ITokenSequence tokens,
 @NotNull
 @NotNull TokenSet whitespaceTokens,
 @NotNull
 @NotNull TokenSet commentTokens,
 int startLexeme,
 int lexemeCount)

方法详细资料

getRoot

@NotNull
public abstract N getRoot()

isWhitespaceOrComment

public boolean isWhitespaceOrComment(@NotNull
 @NotNull IElementType elementType)

指定者:

isWhitespaceOrComment 在接口中 SyntaxTreeBuilder

enforceCommentTokens

public void enforceCommentTokens(@NotNull
 @NotNull TokenSet tokens)

指定者:

enforceCommentTokens 在接口中 SyntaxTreeBuilder

getLatestDoneMarker

@Nullable
public @Nullable com.intellij.psi.builder.FleetPsiBuilder.StartMarker getLatestDoneMarker()

指定者:

getLatestDoneMarker 在接口中 SyntaxTreeBuilder

返回:

latest left done node for context dependent parsing.

getUserData

@Nullable
public <T> T getUserData(@NotNull
 @NotNull Key<T> key)

指定者:

getUserData 在接口中 PsiBuilder

指定者:

getUserData 在接口中 UserDataHolder

返回:

a user data value associated with this object. Doesn't require read action.

putUserData

public <T> void putUserData(@NotNull
 @NotNull Key<T> key,
 @Nullable
 T value)

从接口复制的说明: PsiBuilder

Add a new user data value to this object. Doesn't require write action.

指定者:

putUserData 在接口中 PsiBuilder

指定者:

putUserData 在接口中 UserDataHolder

getOriginalText

@NotNull
public @NotNull CharSequence getOriginalText()

从接口复制的说明: SyntaxTreeBuilder

Returns the complete text being parsed.

指定者:

getOriginalText 在接口中 SyntaxTreeBuilder

返回:

the text being parsed

getTokenType

@Nullable
public @Nullable IElementType getTokenType()

从接口复制的说明: SyntaxTreeBuilder

Returns the type of current token from the lexer.

指定者:

getTokenType 在接口中 SyntaxTreeBuilder

返回:

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

setTokenTypeRemapper

public void setTokenTypeRemapper(ITokenTypeRemapper remapper)

从接口复制的说明: SyntaxTreeBuilder

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

指定者:

setTokenTypeRemapper 在接口中 SyntaxTreeBuilder

参数:

remapper - the remapper object, or null.

remapCurrentToken

public void remapCurrentToken(IElementType type)

从接口复制的说明: SyntaxTreeBuilder

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

指定者:

remapCurrentToken 在接口中 SyntaxTreeBuilder

参数:

type - new type for the current token.

lookAhead

@Nullable
public @Nullable IElementType lookAhead(int steps)

从接口复制的说明: SyntaxTreeBuilder

See what token type is in steps ahead.

指定者:

lookAhead 在接口中 SyntaxTreeBuilder

参数:

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

返回:

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

rawLookup

public IElementType rawLookup(int steps)

从接口复制的说明: SyntaxTreeBuilder

See what token type is in steps ahead/behind.

指定者:

rawLookup 在接口中 SyntaxTreeBuilder

参数:

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

返回:

type element ahead or behind, including whitespace/comment tokens

rawTokenTypeStart

public int rawTokenTypeStart(int steps)

从接口复制的说明: SyntaxTreeBuilder

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

指定者:

rawTokenTypeStart 在接口中 SyntaxTreeBuilder

参数:

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

返回:

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

rawTokenIndex

public int rawTokenIndex()

从接口复制的说明: SyntaxTreeBuilder

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

指定者:

rawTokenIndex 在接口中 SyntaxTreeBuilder

返回:

token index

setWhitespaceSkippedCallback

public void setWhitespaceSkippedCallback(@Nullable
 @Nullable WhitespaceSkippedCallback callback)

从接口复制的说明: SyntaxTreeBuilder

Subscribe for notification on default whitespace and comments skipped events.

指定者:

setWhitespaceSkippedCallback 在接口中 SyntaxTreeBuilder

参数:

callback - an implementation for the callback

advanceLexer

public void advanceLexer()

从接口复制的说明: SyntaxTreeBuilder

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

指定者:

advanceLexer 在接口中 SyntaxTreeBuilder

getCurrentOffset

public int getCurrentOffset()

从接口复制的说明: SyntaxTreeBuilder

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

指定者:

getCurrentOffset 在接口中 SyntaxTreeBuilder

返回:

the token offset.

getTokenText

@Nullable
public @Nullable String getTokenText()

从接口复制的说明: SyntaxTreeBuilder

Returns the text of the current token from the lexer.

指定者:

getTokenText 在接口中 SyntaxTreeBuilder

返回:

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

whitespaceOrComment

public boolean whitespaceOrComment(IElementType token)

mark

@NotNull
public @NotNull PsiBuilder.Marker mark()

从接口复制的说明: SyntaxTreeBuilder

Creates a marker at the current parsing position.

指定者:

mark 在接口中 PsiBuilder

指定者:

mark 在接口中 SyntaxTreeBuilder

返回:

the new marker instance.

eof

public final boolean eof()

从接口复制的说明: SyntaxTreeBuilder

Checks if the lexer has reached the end of file.

指定者:

eof 在接口中 SyntaxTreeBuilder

返回:

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

error

public void error(@NotNull
 @NotNull String messageText)

从接口复制的说明: SyntaxTreeBuilder

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.

指定者:

error 在接口中 SyntaxTreeBuilder

参数:

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

getErrorMessage

@Nullable
public static @Nullable String getErrorMessage(@NotNull
 @NotNull LighterASTNode node)

setDebugMode

public void setDebugMode(boolean dbgMode)

从接口复制的说明: SyntaxTreeBuilder

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().

指定者:

setDebugMode 在接口中 SyntaxTreeBuilder

参数:

dbgMode - the debug mode value.

getProductions

@Nullable
public @Nullable List<FleetPsiBuilder.ProductionMarker> getProductions()