Module aya.ij.parsing.core

Package com.intellij.psi.templateLanguages

Class TemplateDataElementType

java.lang.Object

com.intellij.psi.templateLanguages.TemplateDataElementType

public class TemplateDataElementType
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TemplateDataElementType.OuterLanguageRangePatcher	Customizes template data language-specific parsing in templates.
static class	TemplateDataElementType.RangeCollector	This collector is used for storing ranges of outer elements and ranges of artificial elements, that should be stripped from the resulting tree At the time of creating source code for the data language we need to memorize positions with template language elements.

Constructor Summary

Constructors

Constructor	Description
TemplateDataElementType(@NotNull ParserDefinition templateParserDefinition, @NotNull IElementType templateElementType, @NotNull IElementType outerElementType)

Method Summary

Modifier and Type	Method	Description
protected @NotNull TemplateDataModifications	appendCurrentTemplateToken(int tokenEndOffset, @NotNull CharSequence tokenText)	Collects modifications for tokens having myTemplateElementType type.
protected void	appendCurrentTemplateToken(@NotNull StringBuilder result, @NotNull CharSequence buf, @NotNull Lexer lexer, TemplateDataElementType.RangeCollector collector)	Deprecated. Override appendCurrentTemplateToken(int, CharSequence) instead.
ArrayTokenSequence	buildTemplateDataLexemes(@NotNull CharSequence sourceCode, @NotNull Lexer lexer)
protected @NotNull TemplateDataModifications	collectTemplateModifications(@NotNull CharSequence sourceCode, @NotNull Lexer baseLexer)	Collects changes to apply to template source code for later parsing by underlying language.
protected Lexer	createBaseLexer()
protected CharSequence	createTemplateFile(CharSequence sourceCode, TemplateDataElementType.RangeCollector rangeCollector)	Creates psi tree without base language elements.
protected CharSequence	createTemplateText(@NotNull CharSequence sourceCode, @NotNull Lexer baseLexer, TemplateDataElementType.RangeCollector rangeCollector)	Creates source code without template tokens.
protected @NotNull TokenSet	getTemplateDataInsertionTokens()	Deprecated, for removal: This API element is subject to removal in a future version. Use isInsertionToken(IElementType, CharSequence) instead.
protected boolean	isInsertionToken(@Nullable IElementType tokenType, @NotNull CharSequence tokenSequence)	Returns true if a string is expected to be inserted into resulting file in place of a current token.
MarkerPsiBuilder<Object>	parse(@NotNull CharSequence sourceCode, @NotNull ParserDefinition dataParserDefinition)
static @NotNull ASTNode	parseWithOuterAndRemoveRangesApplied(@NotNull ASTNode chameleon, @NotNull Language language, @NotNull Function<? super @NotNull CharSequence,? extends @NotNull ASTNode> parser)

Methods inherited from class java.lang.Object

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

Constructor Details

TemplateDataElementType

public TemplateDataElementType(@NotNull
 @NotNull ParserDefinition templateParserDefinition,
 @NotNull
 @NotNull IElementType templateElementType,
 @NotNull
 @NotNull IElementType outerElementType)

Method Details

createBaseLexer

protected Lexer createBaseLexer()

parse

public MarkerPsiBuilder<Object> parse(@NotNull
 @NotNull CharSequence sourceCode,
 @NotNull
 @NotNull ParserDefinition dataParserDefinition)

buildTemplateDataLexemes

public ArrayTokenSequence buildTemplateDataLexemes(@NotNull
 @NotNull CharSequence sourceCode,
 @NotNull
 @NotNull Lexer lexer)

createTemplateFile

protected CharSequence createTemplateFile(CharSequence sourceCode,
 @NotNull
 TemplateDataElementType.RangeCollector rangeCollector)

Creates psi tree without base language elements. The result PsiFile can contain additional elements. Ranges of the removed tokens/additional elements should be stored in the rangeCollector

Parameters:

sourceCode - source code: base language with template language

rangeCollector - collector for ranges with non-template/additional elements

Returns:

template psiFile

createTemplateText

protected CharSequence createTemplateText(@NotNull
 @NotNull CharSequence sourceCode,
 @NotNull
 @NotNull Lexer baseLexer,
 @NotNull
 TemplateDataElementType.RangeCollector rangeCollector)

Creates source code without template tokens. May add additional pieces of code. Ranges of such additions should be added in rangeCollector using TemplateDataElementType.RangeCollector.addRangeToRemove(TextRange) for later removal from the resulting tree. Consider overriding collectTemplateModifications(CharSequence, Lexer) instead.

Parameters:

sourceCode - source code with base and template languages

baseLexer - base language lexer

rangeCollector - collector for ranges with non-template/additional symbols

Returns:

template source code

collectTemplateModifications

@NotNull
protected @NotNull TemplateDataModifications collectTemplateModifications(@NotNull
 @NotNull CharSequence sourceCode,
 @NotNull
 @NotNull Lexer baseLexer)

Collects changes to apply to template source code for later parsing by underlying language.

Parameters:

sourceCode - source code with base and template languages

baseLexer - base language lexer

appendCurrentTemplateToken

@Deprecated
protected void appendCurrentTemplateToken(@NotNull
 @NotNull StringBuilder result,
 @NotNull
 @NotNull CharSequence buf,
 @NotNull
 @NotNull Lexer lexer,
 @NotNull
 TemplateDataElementType.RangeCollector collector)

Deprecated.

Override appendCurrentTemplateToken(int, CharSequence) instead.

appendCurrentTemplateToken

@NotNull
protected @NotNull TemplateDataModifications appendCurrentTemplateToken(int tokenEndOffset,
 @NotNull
 @NotNull CharSequence tokenText)

Collects modifications for tokens having myTemplateElementType type.

Returns:

modifications need to be applied for the current token

getTemplateDataInsertionTokens

@Deprecated(forRemoval=true)
@NotNull
protected @NotNull TokenSet getTemplateDataInsertionTokens()

Deprecated, for removal: This API element is subject to removal in a future version.

Use isInsertionToken(IElementType, CharSequence) instead.

isInsertionToken

protected boolean isInsertionToken(@Nullable
 @Nullable IElementType tokenType,
 @NotNull
 @NotNull CharSequence tokenSequence)

Returns true if a string is expected to be inserted into resulting file in place of a current token. If insertion range contains several tokens, true may be returned only for the starting one. For example, if <?=$myVar?> has three tokens <?=, $myVar and ?>, only <?= may be an insertion token. Override this method when overriding collectTemplateModifications(CharSequence, Lexer) is not required.

See Also:

• TemplateDataElementType.RangeCollector.addOuterRange(TextRange, boolean)

parseWithOuterAndRemoveRangesApplied

@NotNull
public static @NotNull ASTNode parseWithOuterAndRemoveRangesApplied(@NotNull
 @NotNull ASTNode chameleon,
 @NotNull
 @NotNull Language language,
 @NotNull
 @NotNull Function<? super @NotNull CharSequence,? extends @NotNull ASTNode> parser)