Package com.intellij.psi.templateLanguages

Class TemplateDataElementType

java.lang.Object

com.intellij.psi.tree.IElementType

com.intellij.psi.tree.ILazyParseableElementType

com.intellij.psi.tree.IFileElementType

com.intellij.psi.templateLanguages.TemplateDataElementType

All Implemented Interfaces:

ITemplateDataElementType, ILazyParseableElementTypeBase

Direct Known Subclasses:

RestPythonTemplateType

public class TemplateDataElementType
extends IFileElementType
implements ITemplateDataElementType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected 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.
protected static class	TemplateDataElementType.TemplateFileType

Nested classes/interfaces inherited from class com.intellij.psi.tree.IElementType

IElementType.Predicate

Field Summary

Fields

Modifier and Type	Field and Description
static LanguageExtension<TreePatcher>	TREE_PATCHER

Fields inherited from class com.intellij.psi.tree.ILazyParseableElementType

LANGUAGE_KEY

Fields inherited from class com.intellij.psi.tree.IElementType

ARRAY_FACTORY, EMPTY_ARRAY, FIRST_TOKEN_INDEX, TRUE

Constructor Summary

Constructors

Constructor and Description
TemplateDataElementType(java.lang.String debugName, Language language, IElementType templateElementType, IElementType outerElementType)

Method Summary

Modifier and Type	Method and Description
protected void	appendCurrentTemplateToken(java.lang.StringBuilder result, java.lang.CharSequence buf, Lexer lexer, TemplateDataElementType.RangeCollector collector)
protected Lexer	createBaseLexer(TemplateLanguageFileViewProvider viewProvider)
protected OuterLanguageElementImpl	createOuterLanguageElement(java.lang.CharSequence internedTokenText, IElementType outerElementType)
protected PsiFile	createPsiFileFromSource(Language language, java.lang.CharSequence sourceCode, PsiManager manager)
protected LanguageFileType	createTemplateFakeFileType(Language language)
protected PsiFile	createTemplateFile(PsiFile psiFile, Language templateLanguage, java.lang.CharSequence sourceCode, TemplateLanguageFileViewProvider viewProvider, TemplateDataElementType.RangeCollector rangeCollector) Creates psi tree without template tokens.
protected java.lang.CharSequence	createTemplateText(java.lang.CharSequence sourceCode, Lexer baseLexer, TemplateDataElementType.RangeCollector rangeCollector) Creates source code without template tokens.
protected Language	getTemplateFileLanguage(TemplateLanguageFileViewProvider viewProvider)
ASTNode	parseContents(ASTNode chameleon) Parses the contents of the specified chameleon node and returns the AST tree representing the parsed contents.
protected void	prepareParsedTemplateFile(FileElement root)

Methods inherited from class com.intellij.psi.tree.ILazyParseableElementType

createNode, doParseContents, getLanguageForParser, parseLight, reuseCollapsedTokens

Methods inherited from class com.intellij.psi.tree.IElementType

enumerate, find, getIndex, getLanguage, hashCode, isLeftBound, toString, unregisterElementTypes, unregisterElementTypes

Methods inherited from class java.lang.Object

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

Field Detail

TREE_PATCHER

public static final LanguageExtension<TreePatcher> TREE_PATCHER

Constructor Detail

TemplateDataElementType

public TemplateDataElementType(java.lang.String debugName,
                               Language language,
                               IElementType templateElementType,
                               IElementType outerElementType)

Method Detail

createBaseLexer

protected Lexer createBaseLexer(TemplateLanguageFileViewProvider viewProvider)

createTemplateFakeFileType

protected LanguageFileType createTemplateFakeFileType(Language language)

parseContents

public ASTNode parseContents(ASTNode chameleon)

Description copied from class: ILazyParseableElementType

Parses the contents of the specified chameleon node and returns the AST tree representing the parsed contents.

Specified by:

parseContents in interface ILazyParseableElementTypeBase

Overrides:

parseContents in class IFileElementType

Parameters:

chameleon - the node to parse.

Returns:

the parsed contents of the node.

prepareParsedTemplateFile

protected void prepareParsedTemplateFile(FileElement root)

getTemplateFileLanguage

protected Language getTemplateFileLanguage(TemplateLanguageFileViewProvider viewProvider)

createTemplateFile

protected PsiFile createTemplateFile(PsiFile psiFile,
                                     Language templateLanguage,
                                     java.lang.CharSequence sourceCode,
                                     TemplateLanguageFileViewProvider viewProvider,
                                     TemplateDataElementType.RangeCollector rangeCollector)

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

Parameters:

psiFile - chameleon's psi file

templateLanguage - template language to parse

sourceCode - source code: base language with template language

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

Returns:

template psiFile

createTemplateText

protected java.lang.CharSequence createTemplateText(java.lang.CharSequence sourceCode,
                                                    Lexer baseLexer,
                                                    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

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

appendCurrentTemplateToken

protected void appendCurrentTemplateToken(java.lang.StringBuilder result,
                                          java.lang.CharSequence buf,
                                          Lexer lexer,
                                          TemplateDataElementType.RangeCollector collector)

createOuterLanguageElement

protected OuterLanguageElementImpl createOuterLanguageElement(java.lang.CharSequence internedTokenText,
                                                              IElementType outerElementType)

createPsiFileFromSource

protected PsiFile createPsiFileFromSource(Language language,
                                          java.lang.CharSequence sourceCode,
                                          PsiManager manager)