Package com.intellij.psi.formatter

Class FormatterUtil

java.lang.Object

com.intellij.psi.formatter.FormatterUtil

public class FormatterUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Collection<java.lang.String>	FORMATTER_ACTION_NAMES
static java.lang.String	REFORMAT_BEFORE_COMMIT_COMMAND_NAME Deprecated. Use getReformatBeforeCommitCommandName() instead

Method Summary

Modifier and Type	Method and Description
static boolean	containsWhiteSpacesOnly(ASTNode node)
static ASTNode	getNext(ASTNode node, IElementType... typesToIgnore)
static ASTNode	getNextNonWhitespaceLeaf(ASTNode node)
static ASTNode	getNextNonWhitespaceSibling(ASTNode node)
static ASTNode	getPrevious(ASTNode node, IElementType... typesToIgnore)
static ASTNode	getPreviousLeaf(ASTNode node, IElementType... typesToIgnore)
static ASTNode	getPreviousNonWhitespaceLeaf(ASTNode node)
static ASTNode	getPreviousNonWhitespaceSibling(ASTNode node)
static java.lang.String	getReformatBeforeCommitCommandName()
static boolean	hasPrecedingSiblingOfType(ASTNode node, IElementType expectedSiblingType, IElementType... skipTypes)
static boolean	isFollowedBy(ASTNode node, IElementType expectedType)
static boolean	isFollowedBy(ASTNode node, IElementType expectedType, IElementType... skipTypes)
static boolean	isFollowedBy(ASTNode node, IElementType expectedType, TokenSet skipTypes)
static boolean	isFollowedBy(ASTNode node, TokenSet expectedTypes, IElementType... skipTypes)
static boolean	isFollowedBy(ASTNode node, TokenSet expectedTypes, TokenSet skipTypes)
static boolean	isFormatterCalledExplicitly()
static boolean	isIncomplete(ASTNode node)
static boolean	isOneOf(ASTNode node, IElementType... types)
static boolean	isPrecededBy(ASTNode node, IElementType expectedType)
static boolean	isPrecededBy(ASTNode node, IElementType expectedType, IElementType... skipTypes)
static boolean	isPrecededBy(ASTNode node, IElementType expectedType, TokenSet skipTypes)
static boolean	isPrecededBy(ASTNode node, TokenSet expectedTypes)
static boolean	isPrecededBy(ASTNode node, TokenSet expectedTypes, IElementType... skipTypes)
static boolean	isPrecededBy(ASTNode node, TokenSet expectedTypes, TokenSet skipTypes)
static boolean	isWhitespaceOrEmpty(ASTNode node)
static void	replaceInnerWhiteSpace(java.lang.String newWhiteSpaceText, ASTNode holder, TextRange whiteSpaceRange) There is a possible case that we want to adjust white space which is not represented at the AST/PSI tree, e.g.
static void	replaceLastWhiteSpace(ASTNode astNode, java.lang.String whiteSpace, TextRange textRange)
static void	replaceWhiteSpace(java.lang.String whiteSpace, ASTNode leafElement, IElementType whiteSpaceToken, TextRange textRange)

Methods inherited from class java.lang.Object

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

Field Detail

REFORMAT_BEFORE_COMMIT_COMMAND_NAME

@Deprecated
public static final java.lang.String REFORMAT_BEFORE_COMMIT_COMMAND_NAME

Deprecated. Use getReformatBeforeCommitCommandName() instead

See Also:

Constant Field Values

FORMATTER_ACTION_NAMES

public static final java.util.Collection<java.lang.String> FORMATTER_ACTION_NAMES

Method Detail

isWhitespaceOrEmpty

public static boolean isWhitespaceOrEmpty(ASTNode node)

isOneOf

public static boolean isOneOf(ASTNode node,
                              IElementType... types)

getPrevious

public static ASTNode getPrevious(ASTNode node,
                                  IElementType... typesToIgnore)

getNext

public static ASTNode getNext(ASTNode node,
                              IElementType... typesToIgnore)

getPreviousLeaf

public static ASTNode getPreviousLeaf(ASTNode node,
                                      IElementType... typesToIgnore)

getPreviousNonWhitespaceLeaf

public static ASTNode getPreviousNonWhitespaceLeaf(ASTNode node)

getNextNonWhitespaceLeaf

public static ASTNode getNextNonWhitespaceLeaf(ASTNode node)

getPreviousNonWhitespaceSibling

public static ASTNode getPreviousNonWhitespaceSibling(ASTNode node)

getNextNonWhitespaceSibling

public static ASTNode getNextNonWhitespaceSibling(ASTNode node)

isPrecededBy

public static boolean isPrecededBy(ASTNode node,
                                   IElementType expectedType)

isPrecededBy

public static boolean isPrecededBy(ASTNode node,
                                   IElementType expectedType,
                                   TokenSet skipTypes)

isPrecededBy

public static boolean isPrecededBy(ASTNode node,
                                   IElementType expectedType,
                                   IElementType... skipTypes)

isPrecededBy

public static boolean isPrecededBy(ASTNode node,
                                   TokenSet expectedTypes)

isPrecededBy

public static boolean isPrecededBy(ASTNode node,
                                   TokenSet expectedTypes,
                                   TokenSet skipTypes)

isPrecededBy

public static boolean isPrecededBy(ASTNode node,
                                   TokenSet expectedTypes,
                                   IElementType... skipTypes)

hasPrecedingSiblingOfType

public static boolean hasPrecedingSiblingOfType(ASTNode node,
                                                IElementType expectedSiblingType,
                                                IElementType... skipTypes)

isFollowedBy

public static boolean isFollowedBy(ASTNode node,
                                   IElementType expectedType)

isFollowedBy

public static boolean isFollowedBy(ASTNode node,
                                   IElementType expectedType,
                                   TokenSet skipTypes)

isFollowedBy

public static boolean isFollowedBy(ASTNode node,
                                   IElementType expectedType,
                                   IElementType... skipTypes)

isFollowedBy

public static boolean isFollowedBy(ASTNode node,
                                   TokenSet expectedTypes,
                                   TokenSet skipTypes)

isFollowedBy

public static boolean isFollowedBy(ASTNode node,
                                   TokenSet expectedTypes,
                                   IElementType... skipTypes)

isIncomplete

public static boolean isIncomplete(ASTNode node)

containsWhiteSpacesOnly

public static boolean containsWhiteSpacesOnly(ASTNode node)

replaceInnerWhiteSpace

public static void replaceInnerWhiteSpace(java.lang.String newWhiteSpaceText,
                                          ASTNode holder,
                                          TextRange whiteSpaceRange)

There is a possible case that we want to adjust white space which is not represented at the AST/PSI tree, e.g. we might have a multiline comment which uses tabs for inner lines indents and want to replace them by spaces. There is no white space element then, the only leaf is the comment itself.

This method allows such 'inner element modifications', i.e. it receives information on what new text should be used at the target inner element range and performs corresponding replacement by generating new leaf with adjusted text and replacing the old one by it.

Parameters:

newWhiteSpaceText - new text to use at the target inner element range

holder - target range holder

whiteSpaceRange - target range which text should be replaced by the given one

replaceWhiteSpace

public static void replaceWhiteSpace(java.lang.String whiteSpace,
                                     ASTNode leafElement,
                                     IElementType whiteSpaceToken,
                                     TextRange textRange)

replaceLastWhiteSpace

public static void replaceLastWhiteSpace(ASTNode astNode,
                                         java.lang.String whiteSpace,
                                         TextRange textRange)

isFormatterCalledExplicitly

public static boolean isFormatterCalledExplicitly()

Returns:

true explicitly called 'reformat' is in progress at the moment; false otherwise

getReformatBeforeCommitCommandName

public static java.lang.String getReformatBeforeCommitCommandName()