Package com.intellij.codeInsight.highlighting

Class PairedBraceMatcherAdapter

java.lang.Object

com.intellij.codeInsight.highlighting.PairedBraceMatcherAdapter

All Implemented Interfaces:

BraceMatcher, NontrivialBraceMatcher, PairedBraceMatcher

Direct Known Subclasses:

JavaPairedBraceMatcher, MarkdownBraceMatcher

public class PairedBraceMatcherAdapter
extends java.lang.Object
implements NontrivialBraceMatcher, PairedBraceMatcher

Field Summary

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

EP_NAME

Constructor Summary

Constructors

Constructor and Description
PairedBraceMatcherAdapter(PairedBraceMatcher matcher, Language language)

Method Summary

Modifier and Type	Method and Description
BracePair	findPair(boolean left, HighlighterIterator iterator, java.lang.CharSequence fileText, FileType fileType)
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)
java.util.List<IElementType>	getOppositeBraceTokenTypes(IElementType type)
BracePair []	getPairs() Returns the array of definitions for brace pairs that need to be matched when editing code in the language.
boolean	isLBraceToken(HighlighterIterator iterator, java.lang.CharSequence fileText, FileType fileType)
boolean	isPairBraces(IElementType tokenType, IElementType tokenType2)
boolean	isPairedBracesAllowedBeforeType(IElementType lbraceType, IElementType contextType) Returns true if paired rbrace should be inserted after lbrace of given type when lbrace is encountered before contextType token.
boolean	isRBraceToken(HighlighterIterator iterator, java.lang.CharSequence fileText, FileType fileType)
boolean	isStructuralBrace(HighlighterIterator iterator, java.lang.CharSequence text, FileType fileType)
boolean	shouldStopMatch(boolean forward, IElementType braceType, HighlighterIterator iterator)

Methods inherited from class java.lang.Object

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

Constructor Detail

PairedBraceMatcherAdapter

public PairedBraceMatcherAdapter(PairedBraceMatcher matcher,
                                 Language language)

Method Detail

getPairs

public BracePair [] getPairs()

Description copied from interface: PairedBraceMatcher

Returns the array of definitions for brace pairs that need to be matched when editing code in the language.

Specified by:

getPairs in interface PairedBraceMatcher

Returns:

the array of brace pair definitions.

getBraceTokenGroupId

public int getBraceTokenGroupId(IElementType tokenType)

Specified by:

getBraceTokenGroupId in interface BraceMatcher

findPair

public BracePair findPair(boolean left,
                          HighlighterIterator iterator,
                          java.lang.CharSequence fileText,
                          FileType fileType)

isLBraceToken

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

Specified by:

isLBraceToken in interface BraceMatcher

isRBraceToken

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

Specified by:

isRBraceToken in interface BraceMatcher

getOppositeBraceTokenType

public IElementType getOppositeBraceTokenType(IElementType type)

Specified by:

getOppositeBraceTokenType in interface BraceMatcher

isPairBraces

public boolean isPairBraces(IElementType tokenType,
                            IElementType tokenType2)

Specified by:

isPairBraces in interface BraceMatcher

isStructuralBrace

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

Specified by:

isStructuralBrace in interface BraceMatcher

isPairedBracesAllowedBeforeType

public boolean isPairedBracesAllowedBeforeType(IElementType lbraceType,
                                               IElementType contextType)

Description copied from interface: PairedBraceMatcher

Returns true if paired rbrace should be inserted after lbrace of given type when lbrace is encountered before contextType token. It is safe to always return true, then paired brace will be inserted anyway.

Specified by:

isPairedBracesAllowedBeforeType in interface BraceMatcher

Specified by:

isPairedBracesAllowedBeforeType in interface PairedBraceMatcher

Parameters:

lbraceType - lbrace for which information is queried

contextType - token type that follows lbrace

Returns:

true / false as described

getCodeConstructStart

public int getCodeConstructStart(PsiFile file,
                                 int openingBraceOffset)

Description copied from interface: BraceMatcher

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.

Specified by:

getCodeConstructStart in interface BraceMatcher

Specified by:

getCodeConstructStart in interface PairedBraceMatcher

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.

getOppositeBraceTokenTypes

public java.util.List<IElementType> getOppositeBraceTokenTypes(IElementType type)

Specified by:

getOppositeBraceTokenTypes in interface NontrivialBraceMatcher

shouldStopMatch

public boolean shouldStopMatch(boolean forward,
                               IElementType braceType,
                               HighlighterIterator iterator)

Specified by:

shouldStopMatch in interface NontrivialBraceMatcher