Package com.intellij.psi.impl.source.codeStyle

Interface PreFormatProcessor

All Known Implementing Classes:

FormatCommentsProcessor, HtmlQuotesFormatPreprocessor, JsonTrailingCommaRemover, PyPreFormatProcessor

public interface PreFormatProcessor

Allows to extends the code formatting process by performing additional changes before the code formatting.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<PreFormatProcessor>	EP_NAME

Method Summary

Modifier and Type	Method and Description
default boolean	changesWhitespacesOnly() Returns true if this preprocessor changes only whitespaces and can run when the canChangeWhiteSpacesOnly flag is passed to the formatter.
TextRange	process(ASTNode element, TextRange range) Callback to be invoked before formatting.

Field Detail

EP_NAME

static final ExtensionPointName<PreFormatProcessor> EP_NAME

Method Detail

process

TextRange process(ASTNode element,
                  TextRange range)

Callback to be invoked before formatting. Implementation is allowed to do the following:

 

   

     return not given text range but adjusted one. E.g. we want to reformat a field at a java class but 
     have 'align field in columns' settings on. That's why the range should be expanded in order to
     cover all fields group;
   
   

     another use-case might be target PSI file/document modification (e.g. change words case). The only requirement here
     is that given element stays valid;
   
 
 

Note: the callback might expect to be called for every injected root at the target formatting context.

Parameters:

element - target element which contents can be adjusted if necessary

range - target range within the given element

Returns:

range recommended to use for further processing

changesWhitespacesOnly

default boolean changesWhitespacesOnly()

Returns true if this preprocessor changes only whitespaces and can run when the canChangeWhiteSpacesOnly flag is passed to the formatter.