Package com.intellij.codeInsight.highlighting

Interface CodeBlockSupportHandler

All Known Implementing Classes:

AbstractCodeBlockSupportHandler

public interface CodeBlockSupportHandler

Provides information about complex language structures, like multi-block expressions (if/elsif/else/end).

Used to:

• highlight markers or keywords if one of them is under cursor
• navigate to the begin/end of the block

See Also:

AbstractCodeBlockSupportHandler, BraceMatcher, CodeBlockProvider

Field Summary

Fields

Modifier and Type	Field and Description
static LanguageExtension<CodeBlockSupportHandler>	EP

Method Summary

Modifier and Type	Method and Description
static TextRange	findCodeBlockRange(Editor editor, PsiFile psiFile) Attempts to find code block range using extension points.
static java.util.List<TextRange>	findMarkersRanges(PsiElement markerPsiElement)
static java.util.List<TextRange>	findMarkersRanges(PsiFile psiFile, Language language, int offset)
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.

Field Detail

EP

static final LanguageExtension<CodeBlockSupportHandler> EP

Method Detail

getCodeBlockMarkerRanges

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

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.

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

TextRange getCodeBlockRange(PsiElement elementAtCursor)

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

Returns:

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

findCodeBlockRange

static TextRange findCodeBlockRange(Editor editor,
                                    PsiFile psiFile)

Attempts to find code block range using extension points.

findMarkersRanges

static java.util.List<TextRange> findMarkersRanges(PsiElement markerPsiElement)

Returns:

ranges of markers to highlight iff markerPsiElement is one of these markers.

findMarkersRanges

static java.util.List<TextRange> findMarkersRanges(PsiFile psiFile,
                                                   Language language,
                                                   int offset)

Parameters:

language - language helps to use a proper psi subtree in case of multi-root psi trees

Returns:

ranges of markers to highlight iff there is a marker in psiFile at offset.

See Also:

findMarkersRanges(PsiElement)