Package com.intellij.psi.tree

Class IReparseableElementType

java.lang.Object

com.intellij.psi.tree.IElementType

com.intellij.psi.tree.ILazyParseableElementType

com.intellij.psi.tree.IReparseableElementType

All Implemented Interfaces:

ILazyParseableElementTypeBase, IReparseableElementTypeBase

Direct Known Subclasses:

GrCodeBlockElementType, IErrorCounterReparseableElementType, ShLazyBlockElementType, ShLazyDoBlockElementType

public class IReparseableElementType
extends ILazyParseableElementType
implements IReparseableElementTypeBase

A lazy-parseable element type which allows for incremental reparse. When the infrastructure detects that all the document's changes are inside an AST node with reparseable type, isParsable(ASTNode, CharSequence, Language, Project) is invoked, and if it's successful, only the contents inside this element are reparsed instead of the whole file. This can speed up reparse dramatically.

Nested Class Summary

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

IElementType.Predicate

Field Summary

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
IReparseableElementType(java.lang.String debugName)
IReparseableElementType(java.lang.String debugName, Language language)
IReparseableElementType(java.lang.String debugName, Language language, boolean register) Allows to construct element types without registering them, as in IElementType(String, Language, boolean).

Method Summary

Modifier and Type	Method and Description
boolean	isParsable(ASTNode parent, java.lang.CharSequence buffer, Language fileLanguage, Project project) The same as this#isParsable(CharSequence, Language, Project) but with parent ASTNode of the old node.
boolean	isParsable(java.lang.CharSequence buffer, Language fileLanguage, Project project) Checks if the specified character sequence can be parsed as a valid content of the chameleon node.
boolean	isValidReparse(ASTNode oldNode, ASTNode newNode)

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

createNode, doParseContents, getLanguageForParser, parseContents, 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

Methods inherited from interface com.intellij.psi.tree.ILazyParseableElementTypeBase

parseContents, reuseCollapsedTokens

Constructor Detail

IReparseableElementType

public IReparseableElementType(java.lang.String debugName)

IReparseableElementType

public IReparseableElementType(java.lang.String debugName,
                               Language language)

IReparseableElementType

public IReparseableElementType(java.lang.String debugName,
                               Language language,
                               boolean register)

Allows to construct element types without registering them, as in IElementType(String, Language, boolean).

Method Detail

isParsable

public boolean isParsable(java.lang.CharSequence buffer,
                          Language fileLanguage,
                          Project project)

Checks if the specified character sequence can be parsed as a valid content of the chameleon node.

Parameters:

buffer - the content to parse.

fileLanguage - language of the file

project - the project containing the content.

Returns:

true if the content is valid, false if not

isParsable

public boolean isParsable(ASTNode parent,
                          java.lang.CharSequence buffer,
                          Language fileLanguage,
                          Project project)

The same as this#isParsable(CharSequence, Language, Project) but with parent ASTNode of the old node. Override this method only if you really understand what are doing. In other cases override this#isParsable(CharSequence, Language, Project) Known valid use-case: Indent-based languages. You should know about parent indent in order to decide if block is reparseable with given text. Because if indent of some line became equals to parent indent then the block should have another parent or block is not block anymore. So it cannot be reparsed and whole file or parent block should be reparsed.

Specified by:

isParsable in interface IReparseableElementTypeBase

Parameters:

parent - parent node of old (or collapsed) reparseable node.

buffer - the content to parse.

fileLanguage - language of the file

project - the project containing the content.

Returns:

true if the content is valid, false if not

isValidReparse

public boolean isValidReparse(ASTNode oldNode,
                              ASTNode newNode)

Specified by:

isValidReparse in interface IReparseableElementTypeBase