Package com.intellij.psi.formatter

Class AbstractWhiteSpaceFormattingStrategy

java.lang.Object

com.intellij.psi.formatter.AbstractWhiteSpaceFormattingStrategy

All Implemented Interfaces:

WhiteSpaceFormattingStrategy

Direct Known Subclasses:

StaticSymbolWhiteSpaceDefinitionStrategy, StaticTextWhiteSpaceDefinitionStrategy

public abstract class AbstractWhiteSpaceFormattingStrategy
extends java.lang.Object
implements WhiteSpaceFormattingStrategy

Abstract common WhiteSpaceFormattingStrategy implementation that doesn't replace default strategy and doesn't adjust white space and

Constructor Summary

Constructors

Constructor and Description
AbstractWhiteSpaceFormattingStrategy()

Method Summary

Modifier and Type	Method and Description
boolean	addWhitespace(ASTNode treePrev, LeafElement whiteSpaceElement) Allows to customize addition of the given white space element to the AST referenced by the given node.
java.lang.CharSequence	adjustWhiteSpaceIfNecessary(java.lang.CharSequence whiteSpaceText, java.lang.CharSequence text, int startOffset, int endOffset, CodeStyleSettings codeStyleSettings, ASTNode nodeAfter) Main formatter's duty is to tweak white space symbols (add/remove/modify them).
java.lang.CharSequence	adjustWhiteSpaceIfNecessary(java.lang.CharSequence whiteSpaceText, PsiElement startElement, int startOffset, int endOffset, CodeStyleSettings codeStyleSettings) PSI-based version of WhiteSpaceFormattingStrategy.adjustWhiteSpaceIfNecessary(CharSequence, CharSequence, int, int, com.intellij.psi.codeStyle.CodeStyleSettings, com.intellij.lang.ASTNode).
boolean	containsWhitespacesOnly(ASTNode node) Allows to answer if given node should be treated as white space node.
boolean	replaceDefaultStrategy()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.formatter.WhiteSpaceFormattingStrategy

check

Constructor Detail

AbstractWhiteSpaceFormattingStrategy

public AbstractWhiteSpaceFormattingStrategy()

Method Detail

replaceDefaultStrategy

public boolean replaceDefaultStrategy()

Specified by:

replaceDefaultStrategy in interface WhiteSpaceFormattingStrategy

Returns:

true if default white space strategy used by formatter should be replaced by the current one; false to indicate that current strategy should be used in composition with default strategy if any, i.e. particular symbols sequence should be considered as white spaces if any of composed strategies defines so

adjustWhiteSpaceIfNecessary

public java.lang.CharSequence adjustWhiteSpaceIfNecessary(java.lang.CharSequence whiteSpaceText,
                                                          java.lang.CharSequence text,
                                                          int startOffset,
                                                          int endOffset,
                                                          CodeStyleSettings codeStyleSettings,
                                                          ASTNode nodeAfter)

Description copied from interface: WhiteSpaceFormattingStrategy

Main formatter's duty is to tweak white space symbols (add/remove/modify them). However, it may be necessary to pay special attention to that. For example it may be necessary to ensure that '\' symbol is used inside multiline expression in case of Python etc.

This method defines a callback that allows to modify white space symbols to use for replacing particular document symbols sub-sequence if necessary.

Specified by:

adjustWhiteSpaceIfNecessary in interface WhiteSpaceFormattingStrategy

Parameters:

whiteSpaceText - white space text to use by default for replacing sub-sequence of the given text

text - target text which region is to be replaced by the given white space symbols

startOffset - start offset to use with the given text (inclusive)

endOffset - end offset to use with the given text (exclusive)

codeStyleSettings - the code style settings

nodeAfter - the AST node following the whitespace, if known

Returns:

symbols to use for replacing [startOffset; endOffset) sub-sequence of the given text

adjustWhiteSpaceIfNecessary

public java.lang.CharSequence adjustWhiteSpaceIfNecessary(java.lang.CharSequence whiteSpaceText,
                                                          PsiElement startElement,
                                                          int startOffset,
                                                          int endOffset,
                                                          CodeStyleSettings codeStyleSettings)

Description copied from interface: WhiteSpaceFormattingStrategy

PSI-based version of WhiteSpaceFormattingStrategy.adjustWhiteSpaceIfNecessary(CharSequence, CharSequence, int, int, com.intellij.psi.codeStyle.CodeStyleSettings, com.intellij.lang.ASTNode).

There is a possible case that particular changes are performed to PSI tree and it's not yet synchronized with the underlying document. Hence, we can't directly work with document char sequence but need to traverse PSI tree instead. I.e. we start with particular PSI element that contains given start offset and process its right siblings/relatives until given end offset is reached.

Specified by:

adjustWhiteSpaceIfNecessary in interface WhiteSpaceFormattingStrategy

Parameters:

whiteSpaceText - white space text to use by default for replacing sub-sequence of the given text

startElement - PSI element that contains given start offset

startOffset - start offset to use with the given text (inclusive)

endOffset - end offset to use with the given text (exclusive)

codeStyleSettings - the code style settings

Returns:

symbols to use for replacing [startOffset; endOffset) sub-sequence of the given text

containsWhitespacesOnly

public boolean containsWhitespacesOnly(ASTNode node)

Description copied from interface: WhiteSpaceFormattingStrategy

Allows to answer if given node should be treated as white space node.

Specified by:

containsWhitespacesOnly in interface WhiteSpaceFormattingStrategy

Parameters:

node - node to check

Returns:

true if given node should be treated as white space; false otherwise

addWhitespace

public boolean addWhitespace(ASTNode treePrev,
                             LeafElement whiteSpaceElement)

Description copied from interface: WhiteSpaceFormattingStrategy

Allows to customize addition of the given white space element to the AST referenced by the given node.

Specified by:

addWhitespace in interface WhiteSpaceFormattingStrategy

Parameters:

treePrev - target node to use as an anchor for inserting given white space element

whiteSpaceElement - target white space element to insert

Returns:

true if given white space element was added in a custom way during the current method call processing; false as an indicator that given white space element has not been inserted during the current method call