Module aya.ij.parsing.core
Package com.intellij.lang

Interface SyntaxTreeBuilder

All Known Subinterfaces:
PsiBuilder
All Known Implementing Classes:
FleetPsiBuilder, GeneratedParserUtilBase.Builder, IndentPsiBuilder, MarkerPsiBuilder, PsiBuilderAdapter, SyntaxTreeBuilderAdapter
public interface SyntaxTreeBuilder

  • Method Details

    • getOriginalText

      @NotNull @NotNull 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

      @Nullable @Nullable IElementType getTokenType()
      Returns the type of current token from the lexer.
      Returns:
      the token type, or null when the token stream is over.

    • setTokenTypeRemapper

      void setTokenTypeRemapper(@Nullable @Nullable 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(@Nullable @Nullable WhitespaceSkippedCallback callback)
      Subscribe for notification on default whitespace and comments skipped events.
      Parameters:
      callback - an implementation for the callback

    • lookAhead

      @Nullable @Nullable 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

      @Nullable @Nullable 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

      @NonNls @Nullable @NonNls @Nullable 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

      @NotNull @NotNull SyntaxTreeBuilder.Marker mark()
      Creates a marker at the current parsing position.
      Returns:
      the new marker instance.

    • error

      void error(@NotNull @NotNull 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.

    • 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(@NotNull @NotNull TokenSet tokens)

    • getLatestDoneMarker

      @Nullable @Nullable LighterASTNode getLatestDoneMarker()
      Returns:
      latest left done node for context dependent parsing.

    • isWhitespaceOrComment

      default boolean isWhitespaceOrComment(@NotNull @NotNull IElementType elementType)