Package com.intellij.codeInsight.highlighting

Class AbstractCodeBlockSupportHandler

java.lang.Object

com.intellij.codeInsight.highlighting.AbstractCodeBlockSupportHandler

All Implemented Interfaces:

CodeBlockSupportHandler

public abstract class AbstractCodeBlockSupportHandler
extends java.lang.Object
implements CodeBlockSupportHandler

This implementation collects specific direct children of top level elements and specific direct children of specific composite elements.

Field Summary

Fields inherited from interface com.intellij.codeInsight.highlighting.CodeBlockSupportHandler

EP

Constructor Summary

Constructors

Constructor and Description
AbstractCodeBlockSupportHandler()

Method Summary

Modifier and Type	Method and Description
protected abstract TokenSet	getBlockElementTypes()
java.util.List<TextRange>	getCodeBlockMarkerRanges(PsiElement elementAtCursor) Checks if code block marker (or keyword) is under cursor and collects related markers: e.g.
TextRange	getCodeBlockRange(PsiElement elementAtCursor) Checks if cursor is inside the block supported by this handler.
protected abstract TokenSet	getDirectChildrenElementTypes(IElementType parentElementType) The method defines a highlighting tree.
protected abstract TokenSet	getKeywordElementTypes()
protected abstract TokenSet	getTopLevelElementTypes()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.highlighting.CodeBlockSupportHandler

findCodeBlockRange, findMarkersRanges, findMarkersRanges

Constructor Detail

AbstractCodeBlockSupportHandler

public AbstractCodeBlockSupportHandler()

Method Detail

getTopLevelElementTypes

protected abstract TokenSet getTopLevelElementTypes()

Returns:

All element types which don't have a parent, e.g. IF_STATEMENT. getDirectChildrenElementTypes(com.intellij.psi.tree.IElementType) should never return these element types

getKeywordElementTypes

protected abstract TokenSet getKeywordElementTypes()

Returns:

Elements which should be highlighted. These elements don't have children. getDirectChildrenElementTypes(com.intellij.psi.tree.IElementType) should return an empty TokenSet for an element type if it is a keyword.

getBlockElementTypes

protected abstract TokenSet getBlockElementTypes()

Returns:

Block element types which should be used for navigation.

getDirectChildrenElementTypes

protected abstract TokenSet getDirectChildrenElementTypes(IElementType parentElementType)

The method defines a highlighting tree. Highlighting tree nodes are PSI elements. A highlighting tree has an edge from A to B if and only if

• A is a parent for B in the PSI tree
• getDirectChildrenElementTypes(getElementType(A)).contains(getElementType(B))

If two keyword elements have a common ancestor in a highlighting tree they will be highlighted together. The method should be consistent with getTopLevelElementTypes() and getKeywordElementTypes().

For example, for the given if statement:

 if expr
 elsif expr
 else
 end
 

the children should be defined as follows:

 IF_STATEMENT => {kIF, ELSIF_BLOCK, ELSE_BLOCK, kEND}
 ELSIF_BLOCK => {kELSEIF}
 ELSE_BLOCK => {kELSE}
 

getCodeBlockMarkerRanges

public java.util.List<TextRange> getCodeBlockMarkerRanges(PsiElement elementAtCursor)

Description copied from interface: CodeBlockSupportHandler

Checks if code block marker (or keyword) is under cursor and collects related markers: e.g. finds if/elsif/else if cursor is on the else from this compound statement.

Specified by:

getCodeBlockMarkerRanges in interface CodeBlockSupportHandler

Returns:

List of ranges of related structural markers or empty list if there is no structural marker under cursor or it should not be handled (highlighted) for any reason.

getCodeBlockRange

public TextRange getCodeBlockRange(PsiElement elementAtCursor)

Description copied from interface: CodeBlockSupportHandler

Checks if cursor is inside the block supported by this handler.

Specified by:

getCodeBlockRange in interface CodeBlockSupportHandler

Returns:

range of the smallest code block cursor is in or empty range if not in code block.