Package com.intellij.psi.codeStyle

Interface ExternalFormatProcessor

All Known Implementing Classes:

ShExternalFormatter

public interface ExternalFormatProcessor

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static ExternalFormatProcessor	activeExternalFormatProcessor(PsiFile source)
boolean	activeForFile(PsiFile source)
default void	createConfiguration(Project project)
static java.util.Optional<ExternalFormatProcessor>	findExternalFormatter(java.lang.String externalFormatterId)
TextRange	format(PsiFile source, TextRange range, boolean canChangeWhiteSpacesOnly, boolean keepLineBreaks) Formats the range in a source file.
static PsiElement	formatElement(PsiElement elementToFormat, TextRange range, boolean canChangeWhiteSpacesOnly)
static TextRange	formatRangeInFile(PsiFile source, TextRange range, boolean canChangeWhiteSpacesOnly, boolean keepLineBreaks)
java.lang.String	getId()
java.lang.String	indent(PsiFile source, int lineStartOffset) Indents the line.
static java.lang.String	indentLine(PsiFile source, int lineStartOffset) Indents the line.
static boolean	useExternalFormatter(PsiFile source)

Field Detail

EP_NAME

static final ExtensionPointName<ExternalFormatProcessor> EP_NAME

Method Detail

activeForFile

boolean activeForFile(PsiFile source)

Parameters:

source - the source file with code

Returns:

true, if external processor selected as active (enabled) for the source file

format

TextRange format(PsiFile source,
                 TextRange range,
                 boolean canChangeWhiteSpacesOnly,
                 boolean keepLineBreaks)

Formats the range in a source file.

Parameters:

source - the source file with code

range - the range for formatting

canChangeWhiteSpacesOnly - procedure can change only whitespaces

Returns:

the range after formatting or null, if external format procedure cannot be applied to the source

indent

java.lang.String indent(PsiFile source,
                        int lineStartOffset)

Indents the line.

Parameters:

source - the source file with code

lineStartOffset - the offset of the indented line

Returns:

the indentation String or null if nothing to be changed

createConfiguration

default void createConfiguration(Project project)

getId

java.lang.String getId()

Returns:

the unique id for external formatter

useExternalFormatter

static boolean useExternalFormatter(PsiFile source)

Parameters:

source - the source file with code

Returns:

true, if there is an active external (enabled) formatter for the source

findExternalFormatter

static java.util.Optional<ExternalFormatProcessor> findExternalFormatter(java.lang.String externalFormatterId)

Parameters:

externalFormatterId - the unique id for external formatter

Returns:

the external formatter with the unique id, if any

activeExternalFormatProcessor

static ExternalFormatProcessor activeExternalFormatProcessor(PsiFile source)

indentLine

static java.lang.String indentLine(PsiFile source,
                                   int lineStartOffset)

Indents the line.

Parameters:

source - the source file with code

lineStartOffset - the offset of the indented line

Returns:

the range after indentation or null if nothing to be changed

formatRangeInFile

static TextRange formatRangeInFile(PsiFile source,
                                   TextRange range,
                                   boolean canChangeWhiteSpacesOnly,
                                   boolean keepLineBreaks)

Parameters:

source - the source file with code

range - the range for formatting

canChangeWhiteSpacesOnly - procedure can change only whitespaces

Returns:

the range after formatting or null, if external format procedure was not found or inactive (disabled)

formatElement

static PsiElement formatElement(PsiElement elementToFormat,
                                TextRange range,
                                boolean canChangeWhiteSpacesOnly)

Parameters:

elementToFormat - the element from code file

range - the range for formatting

canChangeWhiteSpacesOnly - procedure can change only whitespaces

Returns:

the element after formatting