Package com.intellij.psi.codeStyle

Class CodeStyleManager

java.lang.Object

com.intellij.psi.codeStyle.CodeStyleManager

Direct Known Subclasses:

CodeStyleManagerImpl

public abstract class CodeStyleManager
extends java.lang.Object

Service for reformatting code fragments, getting names for elements according to the user's code style and working with import statements and full-qualified names.

See Also:

PreFormatProcessor, PostFormatProcessor

Constructor Summary

Constructors

Constructor and Description
CodeStyleManager()

Method Summary

Modifier and Type	Method and Description
abstract int	adjustLineIndent(Document document, int offset) Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.
abstract int	adjustLineIndent(PsiFile file, int offset) Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.
abstract void	adjustLineIndent(PsiFile file, TextRange rangeToAdjust) Re-formats the specified range of a file, modifying only line indents and leaving all other whitespace intact.
abstract java.lang.String	fillIndent(Indent indent, FileType fileType) Deprecated. obsolete
static FormattingMode	getCurrentFormattingMode(Project project) Retrieves the current formatting mode.
DocCommentSettings	getDocCommentSettings(PsiFile file)
abstract Indent	getIndent(java.lang.String text, FileType fileType) Deprecated. obsolete
static CodeStyleManager	getInstance(Project project) Returns the code style manager for the specified project.
static CodeStyleManager	getInstance(PsiManager manager) Returns the code style manager for the project associated with the specified PSI manager.
abstract java.lang.String	getLineIndent(Document document, int offset) Calculates the indent that should be used for the current line in the specified editor.
abstract java.lang.String	getLineIndent(PsiFile file, int offset) Calculates the indent that should be used for the specified line in the specified file.
java.lang.String	getLineIndent(PsiFile file, int offset, FormattingMode mode) Calculates the indent that should be used for the specified line in the specified file with the given formatting mode.
int	getMinLineFeeds(PsiFile file, int offset) Calculates minimum number of line feeds that should precede block starting at given offset, as dictated by formatting model.
abstract Project	getProject() Gets the project with which the code style manager is associated.
int	getSpacing(PsiFile file, int offset) Calculates minimum spacing, allowed by formatting model (in columns) for a block starting at given offset, relative to its previous sibling block.
abstract boolean	isLineToBeIndented(PsiFile file, int offset) Deprecated. this method is not intended to be used by plugins.
abstract boolean	isSequentialProcessingAllowed() Formatting may be executed sequentially, i.e.
abstract <T> T	performActionWithFormatterDisabled(Computable<T> r)
abstract void	performActionWithFormatterDisabled(java.lang.Runnable r) Disables automatic formatting of modified PSI elements, runs the specified operation and re-enables the formatting.
abstract <T extends java.lang.Throwable> void	performActionWithFormatterDisabled(ThrowableRunnable<T> r)
abstract PsiElement	reformat(PsiElement element) Reformats the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.
abstract PsiElement	reformat(PsiElement element, boolean canChangeWhiteSpacesOnly) Reformats the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.
abstract void	reformatNewlyAddedElement(ASTNode block, ASTNode addedElement) Reformats line indents inside new element and reformats white spaces around it
abstract PsiElement	reformatRange(PsiElement element, int startOffset, int endOffset) Reformats part of the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.
abstract PsiElement	reformatRange(PsiElement element, int startOffset, int endOffset, boolean canChangeWhiteSpacesOnly) Reformats part of the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.
abstract void	reformatText(PsiFile file, java.util.Collection<TextRange> ranges) Re-formats a ranges of text in the specified file.
abstract void	reformatText(PsiFile file, int startOffset, int endOffset) Delegates to the reformatText(PsiFile, Collection) with the single range defined by the given offsets.
abstract void	reformatTextWithContext(PsiFile file, ChangedRangesInfo info)
void	reformatTextWithContext(PsiFile file, java.util.Collection<TextRange> ranges)
void	runWithDocCommentFormattingDisabled(PsiFile file, java.lang.Runnable runnable) Run the given runnable disabling doc comment formatting.
void	scheduleIndentAdjustment(Document document, int offset) Performs a delayed indent adjustment for large documents bigger than FormatterBasedIndentAdjuster.MAX_SYNCHRONOUS_ADJUSTMENT_DOC_SIZE by scheduling it to a time when the document is committed.
abstract Indent	zeroIndent() Deprecated. obsolete

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeStyleManager

public CodeStyleManager()

Method Detail

getInstance

public static CodeStyleManager getInstance(Project project)

Returns the code style manager for the specified project.

Parameters:

project - the project to get the code style manager for.

Returns:

the code style manager instance.

getInstance

public static CodeStyleManager getInstance(PsiManager manager)

Returns the code style manager for the project associated with the specified PSI manager.

Parameters:

manager - the PSI manager to get the code style manager for.

Returns:

the code style manager instance.

getProject

public abstract Project getProject()

Gets the project with which the code style manager is associated.

Returns:

the project instance.

reformat

public abstract PsiElement reformat(PsiElement element)
                             throws IncorrectOperationException

Reformats the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.

Parameters:

element - the element to reformat.

Returns:

the element in the PSI tree after the reformat operation corresponding to the original element.

Throws:

IncorrectOperationException - if the file to reformat is read-only.

See Also:

reformatText(PsiFile, int, int)

reformat

public abstract PsiElement reformat(PsiElement element,
                                    boolean canChangeWhiteSpacesOnly)
                             throws IncorrectOperationException

Reformats the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.

Parameters:

element - the element to reformat.

canChangeWhiteSpacesOnly - if true, only reformatting is performed; if false, braces and import statements also can be modified if necessary.

Returns:

the element in the PSI tree after the reformat operation corresponding to the original element.

Throws:

IncorrectOperationException - if the file to reformat is read-only.

See Also:

reformatText(PsiFile, int, int)

reformatRange

public abstract PsiElement reformatRange(PsiElement element,
                                         int startOffset,
                                         int endOffset)
                                  throws IncorrectOperationException

Reformats part of the contents of the specified PSI element, enforces braces and splits import statements according to the user's code style.

Parameters:

element - the element to reformat.

startOffset - the start offset in the document of the text range to reformat.

endOffset - the end offset in the document of the text range to reformat.

Returns:

the element in the PSI tree after the reformat operation corresponding to the original element.

Throws:

IncorrectOperationException - if the file to reformat is read-only.

See Also:

reformatText(PsiFile, int, int)

reformatRange

public abstract PsiElement reformatRange(PsiElement element,
                                         int startOffset,
                                         int endOffset,
                                         boolean canChangeWhiteSpacesOnly)
                                  throws IncorrectOperationException

Reformats part of the contents of the specified PSI element, and optionally enforces braces and splits import statements according to the user's code style.

Parameters:

element - the element to reformat.

startOffset - the start offset in the document of the text range to reformat.

endOffset - the end offset in the document of the text range to reformat.

canChangeWhiteSpacesOnly - if true, only reformatting is performed; if false, braces and import statements also can be modified if necessary.

Returns:

the element in the PSI tree after the reformat operation corresponding to the original element.

Throws:

IncorrectOperationException - if the file to reformat is read-only.

See Also:

reformatText(PsiFile, int, int)

reformatText

public abstract void reformatText(PsiFile file,
                                  int startOffset,
                                  int endOffset)
                           throws IncorrectOperationException

Delegates to the reformatText(PsiFile, Collection) with the single range defined by the given offsets.

Parameters:

file - the file to reformat.

startOffset - the start of the text range to reformat.

endOffset - the end of the text range to reformat.

Throws:

IncorrectOperationException - if the file to reformat is read-only.

reformatText

public abstract void reformatText(PsiFile file,
                                  java.util.Collection<TextRange> ranges)
                           throws IncorrectOperationException

Re-formats a ranges of text in the specified file. This method works faster than reformatRange(PsiElement, int, int) but invalidates the PSI structure for the file.

Parameters:

file - the file to reformat

ranges - ranges to process

Throws:

IncorrectOperationException - if the file to reformat is read-only.

reformatTextWithContext

public abstract void reformatTextWithContext(PsiFile file,
                                             ChangedRangesInfo info)
                                      throws IncorrectOperationException

Throws:

IncorrectOperationException

reformatTextWithContext

public void reformatTextWithContext(PsiFile file,
                                    java.util.Collection<TextRange> ranges)
                             throws IncorrectOperationException

Throws:

IncorrectOperationException

adjustLineIndent

public abstract void adjustLineIndent(PsiFile file,
                                      TextRange rangeToAdjust)
                               throws IncorrectOperationException

Re-formats the specified range of a file, modifying only line indents and leaving all other whitespace intact.

Parameters:

file - the file to reformat.

rangeToAdjust - the range of text in which indents should be reformatted.

Throws:

IncorrectOperationException - if the file is read-only.

adjustLineIndent

public abstract int adjustLineIndent(PsiFile file,
                                     int offset)
                              throws IncorrectOperationException

Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.

Parameters:

file - the file to reformat.

offset - the offset the line at which should be reformatted.

Throws:

IncorrectOperationException - if the file is read-only.

See Also:

scheduleIndentAdjustment(Document, int)

adjustLineIndent

public abstract int adjustLineIndent(Document document,
                                     int offset)

Reformats the line at the specified offset in the specified file, modifying only the line indent and leaving all other whitespace intact.

Parameters:

document - the document to reformat.

offset - the offset the line at which should be reformatted.

Throws:

IncorrectOperationException - if the file is read-only.

See Also:

scheduleIndentAdjustment(Document, int)

scheduleIndentAdjustment

public void scheduleIndentAdjustment(Document document,
                                     int offset)

Performs a delayed indent adjustment for large documents bigger than FormatterBasedIndentAdjuster.MAX_SYNCHRONOUS_ADJUSTMENT_DOC_SIZE by scheduling it to a time when the document is committed. Uses formatter to calculate the new indent on a background thread. Only the actual change is done on EDT: the old indent is replaced with a new indent string directly in the document. Doesn't commit the document, thus a subsequent PsiDocumentManager.commitDocument(Document) may be required.

Note: visually it may lead to a text jump which becomes more obvious, more time it takes to calculate the new indent using a formatting model. A better way to handle large documents is to implement LineIndentProvider returning a non-null value when possible.

Parameters:

document - The document to be modified.

offset - The offset in the line whose indent is to be adjusted.

isLineToBeIndented

@Deprecated
public abstract boolean isLineToBeIndented(PsiFile file,
                                           int offset)

Deprecated. this method is not intended to be used by plugins.

getLineIndent

public abstract java.lang.String getLineIndent(PsiFile file,
                                               int offset)

Calculates the indent that should be used for the specified line in the specified file.

Parameters:

file - the file for which the indent should be calculated.

offset - the offset for the line at which the indent should be calculated.

Returns:

the indent string (containing of tabs and/or whitespaces), or null if it was not possible to calculate the indent.

getLineIndent

public java.lang.String getLineIndent(PsiFile file,
                                      int offset,
                                      FormattingMode mode)

Calculates the indent that should be used for the specified line in the specified file with the given formatting mode. Default implementation falls back to getLineIndent(PsiFile, int)

Parameters:

file - the file for which the indent should be calculated.

offset - the offset for the line at which the indent should be calculated.

mode - the formatting mode FormattingMode

Returns:

the indent string (containing of tabs and/or whitespaces), or null if it was not possible to calculate the indent.

getLineIndent

public abstract java.lang.String getLineIndent(Document document,
                                               int offset)

Calculates the indent that should be used for the current line in the specified editor.

Parameters:

document - for which the indent should be calculated.

Returns:

the indent string (containing of tabs and/or whitespaces), or null if it was not possible to calculate the indent.

getIndent

@Deprecated
public abstract Indent getIndent(java.lang.String text,
                                 FileType fileType)

Deprecated. obsolete

fillIndent

@Deprecated
public abstract java.lang.String fillIndent(Indent indent,
                                            FileType fileType)

Deprecated. obsolete

zeroIndent

@Deprecated
public abstract Indent zeroIndent()

Deprecated. obsolete

reformatNewlyAddedElement

public abstract void reformatNewlyAddedElement(ASTNode block,
                                               ASTNode addedElement)
                                        throws IncorrectOperationException

Reformats line indents inside new element and reformats white spaces around it

Parameters:

block - - added element parent

addedElement - - new element

Throws:

IncorrectOperationException - if the operation fails for some reason (for example, the file is read-only).

isSequentialProcessingAllowed

public abstract boolean isSequentialProcessingAllowed()

Formatting may be executed sequentially, i.e. the whole (re)formatting task is split into a number of smaller sub-tasks that are executed sequentially. That is done primarily for ability to show progress dialog during formatting (formatting is always performed from EDT, hence, the GUI freezes if we perform formatting as a single big iteration).

However, there are situation when we don't want to use such an approach - for example, the IDE sometimes inserts dummy text into file in order to calculate formatting-specific data and removes it after that. We don't want to allow Swing events dispatching during that in order to not show that dummy text to the end-user.

It's possible to configure that (implementation details are insignificant here) and current method serves as a read-only facade for obtaining information if 'sequential' processing is allowed at the moment.

Returns:

true if 'sequential' formatting is allowed now; false otherwise

performActionWithFormatterDisabled

public abstract void performActionWithFormatterDisabled(java.lang.Runnable r)

Disables automatic formatting of modified PSI elements, runs the specified operation and re-enables the formatting. Can be used to improve performance of PSI write operations.

Parameters:

r - the operation to run.

performActionWithFormatterDisabled

public abstract <T extends java.lang.Throwable> void performActionWithFormatterDisabled(ThrowableRunnable<T> r)
                                                                                 throws T extends java.lang.Throwable

Throws:

T extends java.lang.Throwable

performActionWithFormatterDisabled

public abstract <T> T performActionWithFormatterDisabled(Computable<T> r)

getSpacing

public int getSpacing(PsiFile file,
                      int offset)

Calculates minimum spacing, allowed by formatting model (in columns) for a block starting at given offset, relative to its previous sibling block. Returns -1, if required block cannot be found at provided offset, or spacing cannot be calculated due to some other reason.

getMinLineFeeds

public int getMinLineFeeds(PsiFile file,
                           int offset)

Calculates minimum number of line feeds that should precede block starting at given offset, as dictated by formatting model. Returns -1, if required block cannot be found at provided offset, or spacing cannot be calculated due to some other reason.

getCurrentFormattingMode

public static FormattingMode getCurrentFormattingMode(Project project)

Retrieves the current formatting mode.

Parameters:

project - The current project used to obtain CodeStyleManager instance.

Returns:

The current formatting mode.

See Also:

FormattingMode

runWithDocCommentFormattingDisabled

public void runWithDocCommentFormattingDisabled(PsiFile file,
                                                java.lang.Runnable runnable)

Run the given runnable disabling doc comment formatting.

Parameters:

file - The file for which doc comment formatting should be temporarily disabled.

runnable - The runnable to run.

getDocCommentSettings

public DocCommentSettings getDocCommentSettings(PsiFile file)