Package com.intellij.codeInsight.highlighting

Interface BraceMatcher

All Known Subinterfaces:

NontrivialBraceMatcher, XmlAwareBraceMatcher

All Known Implementing Classes:

JavaPairedBraceMatcher, MarkdownBraceMatcher, PairedBraceMatcherAdapter, TextMateBraceMatcher, XmlBraceMatcher

public interface BraceMatcher

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FileTypeExtensionPoint<BraceMatcher>>	EP_NAME

Method Summary

Modifier and Type	Method and Description
int	getBraceTokenGroupId(IElementType tokenType)
int	getCodeConstructStart(PsiFile file, int openingBraceOffset) Returns the start offset of the code construct which owns the opening structural brace at the specified offset.
IElementType	getOppositeBraceTokenType(IElementType type)
boolean	isLBraceToken(HighlighterIterator iterator, java.lang.CharSequence fileText, FileType fileType)
boolean	isPairBraces(IElementType tokenType, IElementType tokenType2)
boolean	isPairedBracesAllowedBeforeType(IElementType lbraceType, IElementType contextType)
boolean	isRBraceToken(HighlighterIterator iterator, java.lang.CharSequence fileText, FileType fileType)
boolean	isStructuralBrace(HighlighterIterator iterator, java.lang.CharSequence text, FileType fileType)

Field Detail

EP_NAME

static final ExtensionPointName<FileTypeExtensionPoint<BraceMatcher>> EP_NAME

Method Detail

getBraceTokenGroupId

int getBraceTokenGroupId(IElementType tokenType)

isLBraceToken

boolean isLBraceToken(HighlighterIterator iterator,
                      java.lang.CharSequence fileText,
                      FileType fileType)

isRBraceToken

boolean isRBraceToken(HighlighterIterator iterator,
                      java.lang.CharSequence fileText,
                      FileType fileType)

isPairBraces

boolean isPairBraces(IElementType tokenType,
                     IElementType tokenType2)

isStructuralBrace

boolean isStructuralBrace(HighlighterIterator iterator,
                          java.lang.CharSequence text,
                          FileType fileType)

getOppositeBraceTokenType

IElementType getOppositeBraceTokenType(IElementType type)

isPairedBracesAllowedBeforeType

boolean isPairedBracesAllowedBeforeType(IElementType lbraceType,
                                        IElementType contextType)

getCodeConstructStart

int getCodeConstructStart(PsiFile file,
                          int openingBraceOffset)

Returns the start offset of the code construct which owns the opening structural brace at the specified offset. For example, if the opening brace belongs to an 'if' statement, returns the start offset of the 'if' statement.

Parameters:

file - the file in which brace matching is performed.

openingBraceOffset - the offset of an opening structural brace.

Returns:

the offset of corresponding code construct, or the same offset if not defined.