Package com.intellij.psi.codeStyle

Class LanguageCodeStyleSettingsProvider

java.lang.Object

com.intellij.psi.codeStyle.CodeStyleSettingsProvider

com.intellij.psi.codeStyle.LanguageCodeStyleSettingsProvider

Direct Known Subclasses:

GroovyLanguageCodeStyleSettingsProvider, HtmlLanguageCodeStyleSettings, JavaLanguageCodeStyleSettingsProvider, JsonLanguageCodeStyleSettingsProvider, PropertiesLanguageCodeStyleSettingsProvider, PyLanguageCodeStyleSettingsProvider, ShLanguageCodeStyleSettingsProvider, XmlLanguageCodeStyleSettingsProvider, YAMLLanguageCodeStyleSettingsProvider

public abstract class LanguageCodeStyleSettingsProvider
extends CodeStyleSettingsProvider

Base class and extension point for common code style settings for a specific language.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LanguageCodeStyleSettingsProvider.SettingsType

Field Summary

Fields

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

Fields inherited from class com.intellij.psi.codeStyle.CodeStyleSettingsProvider

EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
LanguageCodeStyleSettingsProvider()

Method Summary

Modifier and Type	Method and Description
protected static java.util.List<LanguageCodeStyleSettingsProvider>	calcSettingPagesProviders()
CodeStyleConfigurable	createConfigurable(CodeStyleSettings baseSettings, CodeStyleSettings modelSettings) Create a code style configurable for the given base settings and model settings.
static PsiFile	createFileFromText(Language language, Project project, java.lang.String text)
PsiFile	createFileFromText(Project project, java.lang.String text) Allows to customize PSI file creation for a language settings preview panel.
protected void	customizeDefaults(CommonCodeStyleSettings commonSettings, CommonCodeStyleSettings.IndentOptions indentOptions) Customize default settings: set values which are different from the ones after CommonCodeStyleSettings initialization.
void	customizeSettings(CodeStyleSettingsCustomizable consumer, LanguageCodeStyleSettingsProvider.SettingsType settingsType)
static LanguageCodeStyleSettingsProvider	findUsingBaseLanguage(Language language) Searches a provider for a specific language or its base language.
static LanguageCodeStyleSettingsProvider	forLanguage(Language language)
CodeStyleFieldAccessor	getAccessor(java.lang.Object codeStyleObject, java.lang.reflect.Field field)
java.util.List<CodeStylePropertyAccessor>	getAdditionalAccessors(java.lang.Object codeStyleObject)
java.util.List<Language>	getApplicableLanguages()
abstract java.lang.String	getCodeSample(LanguageCodeStyleSettingsProvider.SettingsType settingsType)
static java.lang.String	getCodeSample(Language lang, LanguageCodeStyleSettingsProvider.SettingsType settingsType)
CommonCodeStyleSettings	getDefaultCommonSettings() Deprecated. Override #customizeDefaults(CommonCodeStyleSettings, IndentOptions) method instead.
static CommonCodeStyleSettings	getDefaultCommonSettings(Language lang)
DisplayPriority	getDisplayPriority()
static DisplayPriority	getDisplayPriority(Language language)
DocCommentSettings	getDocCommentSettings(CodeStyleSettings rootSettings) Returns a wrapper around language's own code documentation comment settings from the given rootSettings.
java.lang.String	getExternalLanguageId()
java.lang.String	getFileExt() Override this method if file extension to be used with samples is different from the one returned by associated file type.
static java.lang.String	getFileExt(Language lang)
IndentOptionsEditor	getIndentOptionsEditor()
abstract Language	getLanguage() Specifies a language this provider applies to.
static Language	getLanguage(java.lang.String langName)
java.lang.String	getLanguageName() Override this method if language name shown in preview tab must be different from the name returned by Language class itself.
static java.lang.String	getLanguageName(Language lang) Returns a language name to be shown in UI.
static java.util.List<Language>	getLanguagesWithCodeStyleSettings()
PredefinedCodeStyle []	getPredefinedCodeStyles() Deprecated. use PredefinedCodeStyle extension point instead
AbstractCodeStylePropertyMapper	getPropertyMapper(CodeStyleSettings settings)
int	getRightMargin(LanguageCodeStyleSettingsProvider.SettingsType settingsType)
static int	getRightMargin(Language lang, LanguageCodeStyleSettingsProvider.SettingsType settingsType)
static java.util.List<LanguageCodeStyleSettingsProvider>	getSettingsPagesProviders()
java.util.Set<java.lang.String>	getSupportedFields()
java.util.Set<java.lang.String>	getSupportedFields(LanguageCodeStyleSettingsProvider.SettingsType type)
static void	resetSettingsPagesProviders()
boolean	supportsExternalFormats() Tells is the provider supports external formats such as Json and .editorconfig.

Methods inherited from class com.intellij.psi.codeStyle.CodeStyleSettingsProvider

createCustomSettings, createSettingsPage, getConfigurableDisplayName, getGroup, getPriority, hasSettingsPage

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<LanguageCodeStyleSettingsProvider> EP_NAME

Constructor Detail

LanguageCodeStyleSettingsProvider

public LanguageCodeStyleSettingsProvider()

Method Detail

getCodeSample

public abstract java.lang.String getCodeSample(LanguageCodeStyleSettingsProvider.SettingsType settingsType)

getRightMargin

public int getRightMargin(LanguageCodeStyleSettingsProvider.SettingsType settingsType)

customizeSettings

public void customizeSettings(CodeStyleSettingsCustomizable consumer,
                              LanguageCodeStyleSettingsProvider.SettingsType settingsType)

getFileExt

public java.lang.String getFileExt()

Override this method if file extension to be used with samples is different from the one returned by associated file type.

Returns:

The file extension for samples (null by default).

getLanguageName

public java.lang.String getLanguageName()

Override this method if language name shown in preview tab must be different from the name returned by Language class itself.

Returns:

The language name to show in preview tab (null by default).

getExternalLanguageId

public java.lang.String getExternalLanguageId()

Returns:

Language ID to be used in external formats like Json and .editorconfig. Must consist only of low case 'a'..'z' characters.

createFileFromText

public PsiFile createFileFromText(Project project,
                                  java.lang.String text)

Allows to customize PSI file creation for a language settings preview panel.

IMPORTANT: The created file must be a non-physical one with PSI events disabled. For more information see PsiFileFactory.createFileFromText(String, Language, CharSequence, boolean, boolean) where eventSystemEnabled parameter must be false

Parameters:

project - current project

text - code sample to demonstrate formatting settings (see getCodeSample(LanguageCodeStyleSettingsProvider.SettingsType)

Returns:

a PSI file instance with given text, or null for default implementation using provider's language.

getDefaultCommonSettings

@Deprecated
public CommonCodeStyleSettings getDefaultCommonSettings()

Deprecated. Override #customizeDefaults(CommonCodeStyleSettings, IndentOptions) method instead.

Creates an instance of CommonCodeStyleSettings and sets initial default values for those settings which differ from the original.

Returns:

Created instance of CommonCodeStyleSettings or null if associated language doesn't use its own language-specific common settings (the settings are shared with other languages).

customizeDefaults

protected void customizeDefaults(CommonCodeStyleSettings commonSettings,
                                 CommonCodeStyleSettings.IndentOptions indentOptions)

Customize default settings: set values which are different from the ones after CommonCodeStyleSettings initialization.

Parameters:

commonSettings - Customizable instance of common settings for the language.

indentOptions - Customizable instance of indent options for the language.

getPredefinedCodeStyles

@Deprecated
public PredefinedCodeStyle [] getPredefinedCodeStyles()

Deprecated. use PredefinedCodeStyle extension point instead

getDisplayPriority

public DisplayPriority getDisplayPriority()

getApplicableLanguages

public java.util.List<Language> getApplicableLanguages()

Returns:

A list of languages from which code style settings can be copied to this provider's language settings. By default all languages with code style settings are returned. In UI the languages are shown in the same order they are in the list.

See Also:

getLanguagesWithCodeStyleSettings()

getLanguagesWithCodeStyleSettings

public static java.util.List<Language> getLanguagesWithCodeStyleSettings()

Returns:

A list of languages with code style settings, namely for which LanguageCodeStyleSettingsProvider exists. The list is ordered by language names as returned by getLanguageName(Language) method.

getCodeSample

public static java.lang.String getCodeSample(Language lang,
                                             LanguageCodeStyleSettingsProvider.SettingsType settingsType)

getRightMargin

public static int getRightMargin(Language lang,
                                 LanguageCodeStyleSettingsProvider.SettingsType settingsType)

getLanguage

public abstract Language getLanguage()

Description copied from class: CodeStyleSettingsProvider

Specifies a language this provider applies to. If the language is not null, its display name will be used as a configurable name by default if getConfigurableDisplayName() is not overridden.

Overrides:

getLanguage in class CodeStyleSettingsProvider

Returns:

null by default.

getLanguage

public static Language getLanguage(java.lang.String langName)

getDefaultCommonSettings

public static CommonCodeStyleSettings getDefaultCommonSettings(Language lang)

getFileExt

public static java.lang.String getFileExt(Language lang)

getLanguageName

public static java.lang.String getLanguageName(Language lang)

Returns a language name to be shown in UI. Used to overwrite language's display name by another name to be shown in UI.

Parameters:

lang - The language whose display name must be return.

Returns:

Alternative UI name defined by provider.getLanguageName() method or (if the method returns null) language's own display name.

createFileFromText

public static PsiFile createFileFromText(Language language,
                                         Project project,
                                         java.lang.String text)

forLanguage

public static LanguageCodeStyleSettingsProvider forLanguage(Language language)

findUsingBaseLanguage

public static LanguageCodeStyleSettingsProvider findUsingBaseLanguage(Language language)

Searches a provider for a specific language or its base language.

Parameters:

language - The original language.

Returns:

Found provider or null if it doesn't exist neither for the language itself nor for any of its base languages.

getDisplayPriority

public static DisplayPriority getDisplayPriority(Language language)

getIndentOptionsEditor

public IndentOptionsEditor getIndentOptionsEditor()

getSupportedFields

public java.util.Set<java.lang.String> getSupportedFields()

getSupportedFields

public java.util.Set<java.lang.String> getSupportedFields(LanguageCodeStyleSettingsProvider.SettingsType type)

getDocCommentSettings

public DocCommentSettings getDocCommentSettings(CodeStyleSettings rootSettings)

Returns a wrapper around language's own code documentation comment settings from the given rootSettings.

Parameters:

rootSettings - Root code style setting to retrieve doc comment settings from.

Returns:

DocCommentSettings wrapper object object which allows to retrieve and modify language's own settings related to doc comment. The object is used then by common platform doc comment handling algorithms.

createConfigurable

public CodeStyleConfigurable createConfigurable(CodeStyleSettings baseSettings,
                                                CodeStyleSettings modelSettings)

Create a code style configurable for the given base settings and model settings.

Overrides:

createConfigurable in class CodeStyleSettingsProvider

Parameters:

baseSettings - The base (initial) settings before changes.

modelSettings - The settings to which UI changes are applied.

Returns:

The code style configurable.

See Also:

CodeStyleConfigurable

resetSettingsPagesProviders

public static void resetSettingsPagesProviders()

getSettingsPagesProviders

public static java.util.List<LanguageCodeStyleSettingsProvider> getSettingsPagesProviders()

Returns:

A list of providers implementing createConfigurable(CodeStyleSettings, CodeStyleSettings)

calcSettingPagesProviders

protected static java.util.List<LanguageCodeStyleSettingsProvider> calcSettingPagesProviders()

getPropertyMapper

public final AbstractCodeStylePropertyMapper getPropertyMapper(CodeStyleSettings settings)

getAccessor

public CodeStyleFieldAccessor getAccessor(java.lang.Object codeStyleObject,
                                          java.lang.reflect.Field field)

getAdditionalAccessors

public java.util.List<CodeStylePropertyAccessor> getAdditionalAccessors(java.lang.Object codeStyleObject)

supportsExternalFormats

public boolean supportsExternalFormats()

Tells is the provider supports external formats such as Json and .editorconfig. By default it is assumed that language code style settings use a standard way to define settings, namely via public fields which have a straightforward mapping between the fields and human-readable stored values without extra transformation. If not, the provider must implement getAccessor() method for fields using magic constants, specially encoded strings and etc. and getAdditionalAccessors() method for non-stanard properties using their own writer/readExternal() methods for serialization.

Returns:

True (default) if standard properties are supported, false to disable language settings to avoid export partial, non-readable etc. data till proper accessors are implemented.