Package com.intellij.codeInsight.editorActions.enter

Class EnterAfterUnmatchedBraceHandler

java.lang.Object

com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegateAdapter

com.intellij.codeInsight.editorActions.enter.EnterAfterUnmatchedBraceHandler

All Implemented Interfaces:

EnterHandlerDelegate

Direct Known Subclasses:

JavaEnterAfterUnmatchedBraceHandler

public class EnterAfterUnmatchedBraceHandler
extends EnterHandlerDelegateAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate

EnterHandlerDelegate.Result

Field Summary

Fields inherited from interface com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate

EP_NAME

Constructor Summary

Constructors

Constructor and Description
EnterAfterUnmatchedBraceHandler()

Method Summary

Modifier and Type	Method and Description
protected Pair<PsiElement,java.lang.Integer>	calculateOffsetToInsertClosingBrace(PsiFile file, java.lang.CharSequence text, int offset) Current handler inserts closing curly brace (right brace) if necessary.
protected int	calculateOffsetToInsertClosingBraceInsideElement(PsiElement element)
protected void	formatCodeFragmentBetweenBraces(PsiFile file, Document document, Editor editor, int caretOffset, int rBracesInsertOffset, java.lang.String generatedRBraces) Formats the code block between caret and inserted braces.
protected java.lang.String	generateStringToInsert(Editor editor, int caretOffset, int maxRBraceCount) Calculates the string of '}' that have to be inserted by handler.
protected int	getMaxRBraceCount(PsiFile file, Editor editor, int caretOffset) Calculates the maximum number of '}' that can be inserted by handler.
protected int	getRBraceOffset(PsiFile file, Editor editor, int caretOffset) Calculates the position for insertion of one or more '}'.
protected static int	getUnmatchedLBracesNumberBefore(Editor editor, int offset, FileType fileType) Calculates number of unmatched left braces before the given offset.
protected void	insertRBraces(PsiFile file, Editor editor, int caretOffset, int rBracesInsertOffset, java.lang.String generatedRBraces) Inserts the generatedRBraces at the rBracesInsertOffset position and formats the code block.
protected void	insertRBracesAtPosition(Document document, int caretOffset, int rBracesInsertOffset, java.lang.String generatedRBraces) Inserts the rBracesCount of '}' at the rBracesInsertOffset position.
static boolean	isAfterUnmatchedLBrace(Editor editor, int offset, FileType fileType)
boolean	isApplicable(PsiFile file, int caretOffset) Checks that the text context is in responsibility of the handler.
protected boolean	isStopChar(char c) Checks the character before the inserted '}' to reduce the count of inserted '}'.
EnterHandlerDelegate.Result	preprocessEnter(PsiFile file, Editor editor, Ref<java.lang.Integer> caretOffsetRef, Ref<java.lang.Integer> caretAdvance, DataContext dataContext, EditorActionHandler originalHandler) Called before the actual Enter processing is done.

Methods inherited from class com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegateAdapter

postProcessEnter

Methods inherited from class java.lang.Object

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

Constructor Detail

EnterAfterUnmatchedBraceHandler

public EnterAfterUnmatchedBraceHandler()

Method Detail

preprocessEnter

public EnterHandlerDelegate.Result preprocessEnter(PsiFile file,
                                                   Editor editor,
                                                   Ref<java.lang.Integer> caretOffsetRef,
                                                   Ref<java.lang.Integer> caretAdvance,
                                                   DataContext dataContext,
                                                   EditorActionHandler originalHandler)

Description copied from interface: EnterHandlerDelegate

Called before the actual Enter processing is done. Important Note: A document associated with the editor may have modifications which are not reflected yet in the PSI file. If any operations with PSI are needed including a search for PSI elements, the document must be committed first to update the PSI. For example:

   PsiDocumentManager.getInstance(file.getProject()).commitDocument(editor.getDocument);
 

Specified by:

preprocessEnter in interface EnterHandlerDelegate

Overrides:

preprocessEnter in class EnterHandlerDelegateAdapter

Parameters:

file - The PSI file associated with the document.

editor - The editor.

caretOffsetRef - Indicates a place where line break is to be inserted (it's a caret position initially). Method implementation can change this value to adjust target line break position.

caretAdvance - A reference to the number of columns by which the caret must be moved forward.

dataContext - The data context passed to the enter handler.

originalHandler - The original handler.

Returns:

One of EnterHandlerDelegate.Result values.

isApplicable

public boolean isApplicable(PsiFile file,
                            int caretOffset)

Checks that the text context is in responsibility of the handler.

Parameters:

file - target PSI file

caretOffset - target caret offset

Returns:

true, if handler is in charge

getMaxRBraceCount

protected int getMaxRBraceCount(PsiFile file,
                                Editor editor,
                                int caretOffset)

Calculates the maximum number of '}' that can be inserted by handler. Can return 0 or less in custom implementation to skip '}' insertion in the preprocessEnter call and switch to default implementation.

Parameters:

file - target PSI file

editor - target editor

caretOffset - target caret offset

Returns:

maximum number of '}' that can be inserted by handler, 0 or less to switch to default implementation

generateStringToInsert

protected java.lang.String generateStringToInsert(Editor editor,
                                                  int caretOffset,
                                                  int maxRBraceCount)

Calculates the string of '}' that have to be inserted by handler. Some languages can expand the string by additional characters (i.e. '\', ';')

Parameters:

editor - target editor

caretOffset - target caret offset

maxRBraceCount - the maximum number of '}' for insert at position, it always positive

Returns:

the string of '}' that has to be inserted by handler, it must have at least one '}'

isStopChar

protected boolean isStopChar(char c)

Checks the character before the inserted '}' to reduce the count of inserted '}'. The number of inserted '}' will increase for each found '{'.

Parameters:

c - character to check

Returns:

true, to stop back iteration

getRBraceOffset

protected int getRBraceOffset(PsiFile file,
                              Editor editor,
                              int caretOffset)

Calculates the position for insertion of one or more '}'.

Parameters:

file - target PSI file

editor - target editor

caretOffset - target caret offset

Returns:

the position between caretOffset and the end of file

insertRBraces

protected void insertRBraces(PsiFile file,
                             Editor editor,
                             int caretOffset,
                             int rBracesInsertOffset,
                             java.lang.String generatedRBraces)

Inserts the generatedRBraces at the rBracesInsertOffset position and formats the code block.

Parameters:

file - target PSI file

editor - target editor

caretOffset - target caret offset

rBracesInsertOffset - target position to insert

generatedRBraces - string of '}' to insert

insertRBracesAtPosition

protected void insertRBracesAtPosition(Document document,
                                       int caretOffset,
                                       int rBracesInsertOffset,
                                       java.lang.String generatedRBraces)

Inserts the rBracesCount of '}' at the rBracesInsertOffset position.

Parameters:

document - target document

caretOffset - target caret offset

rBracesInsertOffset - target position to insert

generatedRBraces - string of '}' to insert

formatCodeFragmentBetweenBraces

protected void formatCodeFragmentBetweenBraces(PsiFile file,
                                               Document document,
                                               Editor editor,
                                               int caretOffset,
                                               int rBracesInsertOffset,
                                               java.lang.String generatedRBraces)

Formats the code block between caret and inserted braces.

Parameters:

file - target PSI file

document - target document

editor - target editor

caretOffset - target caret offset

rBracesInsertOffset - target position to insert

generatedRBraces - string of '}' to insert

calculateOffsetToInsertClosingBrace

protected Pair<PsiElement,java.lang.Integer> calculateOffsetToInsertClosingBrace(PsiFile file,
                                                                                 java.lang.CharSequence text,
                                                                                 int offset)

Current handler inserts closing curly brace (right brace) if necessary. There is a possible case that it should be located more than one line forward.

Example

     if (test1()) {
     } else { if (test2()) {
         foo();
     }
 

We want to get this after the processing:

     if (test1()) {
     } else {
         if (test2()) {
             foo();
         }
     }
 

I.e. closing brace should be inserted two lines below current caret line. Hence, we need to calculate correct offset to use for brace inserting. This method is responsible for that.

In essence it inspects PSI structure and finds PSE elements with the max length that starts at caret offset. End offset of that element is used as an insertion point.

Parameters:

file - target PSI file

text - text from the given file

offset - target offset where line feed will be inserted

Returns:

pair of (element, offset). The element is the '}' owner, if applicable; the offset is the position for inserting closing brace

calculateOffsetToInsertClosingBraceInsideElement

protected int calculateOffsetToInsertClosingBraceInsideElement(PsiElement element)

isAfterUnmatchedLBrace

public static boolean isAfterUnmatchedLBrace(Editor editor,
                                             int offset,
                                             FileType fileType)

getUnmatchedLBracesNumberBefore

protected static int getUnmatchedLBracesNumberBefore(Editor editor,
                                                     int offset,
                                                     FileType fileType)

Calculates number of unmatched left braces before the given offset.

Parameters:

editor - target editor

offset - target offset

fileType - target file type

Returns:

number of unmatched braces before the given offset; negative value if it's not possible to perform the calculation or if there are no unmatched left braces before the given offset