/*
* Copyright 2000-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.psi.codeStyle;
import com.intellij.application.options.IndentOptionsEditor;
import com.intellij.lang.Language;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.openapi.project.Project;
import com.intellij.psi.PsiFile;
import com.intellij.util.containers.ContainerUtil;
import gnu.trove.THashSet;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Set;
/**
* Base class and extension point for code style settings shared between multiple languages
*/
public abstract class LanguageCodeStyleSettingsProvider {
public static final ExtensionPointName<LanguageCodeStyleSettingsProvider> EP_NAME =
ExtensionPointName.create("com.intellij.langCodeStyleSettingsProvider");
public enum SettingsType {
BLANK_LINES_SETTINGS, SPACING_SETTINGS, WRAPPING_AND_BRACES_SETTINGS, INDENT_SETTINGS, COMMENTER_SETTINGS, LANGUAGE_SPECIFIC
}
@NotNull
public abstract Language getLanguage();
public abstract String getCodeSample(@NotNull SettingsType settingsType);
public int getRightMargin(@NotNull SettingsType settingsType) {
return settingsType == SettingsType.WRAPPING_AND_BRACES_SETTINGS ? 30 : -1;
}
public void customizeSettings(@NotNull CodeStyleSettingsCustomizable consumer, @NotNull SettingsType settingsType) {
}
/**
* Override this method if file extension to be used with samples is different from the one returned by associated file type.
*
* @return The file extension for samples (null by default).
*/
@Nullable
public String getFileExt() {
return null;
}
/**
* Override this method if language name shown in preview tab must be different from the name returned by Language class itself.
*
* @return The language name to show in preview tab (null by default).
*/
@Nullable
public String getLanguageName() {
return null;
}
/**
* Allows to customize PSI file creation for a language settings preview panel.
*
* @param project current project
* @param text code sample to demonstrate formatting settings (see {@link #getCodeSample(LanguageCodeStyleSettingsProvider.SettingsType)}
* @return a PSI file instance with given text, or null for use
*/
@Nullable
public PsiFile createFileFromText(final Project project, final String text) {
return null;
}
/**
* Creates an instance of {@code CommonCodeStyleSettings} and sets initial default values for those
* settings which differ from the original.
*
* @return Created instance of {@code CommonCodeStyleSettings} or null if associated language doesn't
* use its own language-specific common settings (the settings are shared with other languages).
*/
@Nullable
public CommonCodeStyleSettings getDefaultCommonSettings() {
return null;
}
/**
* @deprecated use PredefinedCodeStyle extension point instead
*/
@NotNull
@Deprecated
public PredefinedCodeStyle[] getPredefinedCodeStyles() {
return PredefinedCodeStyle.EMPTY_ARRAY;
}
public DisplayPriority getDisplayPriority() {
return DisplayPriority.LANGUAGE_SETTINGS;
}
@NotNull
public static Language[] getLanguagesWithCodeStyleSettings() {
final ArrayList<Language> languages = new ArrayList<>();
for (LanguageCodeStyleSettingsProvider provider : Extensions.getExtensions(EP_NAME)) {
languages.add(provider.getLanguage());
}
return languages.toArray(new Language[languages.size()]);
}
@Nullable
public static String getCodeSample(Language lang, @NotNull SettingsType settingsType) {
final LanguageCodeStyleSettingsProvider provider = forLanguage(lang);
return provider != null ? provider.getCodeSample(settingsType) : null;
}
public static int getRightMargin(Language lang, @NotNull SettingsType settingsType) {
final LanguageCodeStyleSettingsProvider provider = forLanguage(lang);
return provider != null ? provider.getRightMargin(settingsType) : -1;
}
@Nullable
public static Language getLanguage(String langName) {
for (LanguageCodeStyleSettingsProvider provider : Extensions.getExtensions(EP_NAME)) {
String name = provider.getLanguageName();
if (name == null) name = provider.getLanguage().getDisplayName();
if (langName.equals(name)) {
return provider.getLanguage();
}
}
return null;
}
@Nullable
public static CommonCodeStyleSettings getDefaultCommonSettings(Language lang) {
final LanguageCodeStyleSettingsProvider provider = forLanguage(lang);
return provider != null ? provider.getDefaultCommonSettings() : null;
}
@Nullable
public static String getFileExt(Language lang) {
final LanguageCodeStyleSettingsProvider provider = forLanguage(lang);
return provider != null ? provider.getFileExt() : null;
}
/**
* Returns a language name to be shown in UI. Used to overwrite language's display name by another name to
* be shown in UI.
*
* @param lang The language whose display name must be return.
* @return Alternative UI name defined by provider.getLanguageName() method or (if the method returns null)
* language's own display name.
*/
@Nullable
public static String getLanguageName(Language lang) {
final LanguageCodeStyleSettingsProvider provider = forLanguage(lang);
String providerLangName = provider != null ? provider.getLanguageName() : null;
return providerLangName != null ? providerLangName : lang.getDisplayName();
}
@Nullable
public static PsiFile createFileFromText(final Language language, final Project project, final String text) {
final LanguageCodeStyleSettingsProvider provider = forLanguage(language);
return provider != null ? provider.createFileFromText(project, text) : null;
}
@Nullable
public static LanguageCodeStyleSettingsProvider forLanguage(final Language language) {
for (LanguageCodeStyleSettingsProvider provider : Extensions.getExtensions(EP_NAME)) {
if (provider.getLanguage().equals(language)) {
return provider;
}
}
return null;
}
@SuppressWarnings("unused")
public static DisplayPriority getDisplayPriority(Language language) {
LanguageCodeStyleSettingsProvider langProvider = forLanguage(language);
if (langProvider == null) return DisplayPriority.LANGUAGE_SETTINGS;
return langProvider.getDisplayPriority();
}
@Nullable
public IndentOptionsEditor getIndentOptionsEditor() {
return null;
}
public Set<String> getSupportedFields() {
return new SupportedFieldCollector().collectFields();
}
public Set<String> getSupportedFields(SettingsType type) {
return new SupportedFieldCollector().collectFields(type);
}
private final class SupportedFieldCollector implements CodeStyleSettingsCustomizable {
private final Set<String> myCollectedFields = new THashSet<>();
private SettingsType myCurrSettingsType;
public Set<String> collectFields() {
for (SettingsType settingsType : SettingsType.values()) {
myCurrSettingsType = settingsType;
customizeSettings(this, settingsType);
}
return myCollectedFields;
}
public Set<String> collectFields(SettingsType type) {
myCurrSettingsType = type;
customizeSettings(this, type);
return myCollectedFields;
}
@Override
public void showAllStandardOptions() {
switch (myCurrSettingsType) {
case BLANK_LINES_SETTINGS:
for (BlankLinesOption blankLinesOption : BlankLinesOption.values()) {
myCollectedFields.add(blankLinesOption.name());
}
break;
case SPACING_SETTINGS:
for (SpacingOption spacingOption : SpacingOption.values()) {
myCollectedFields.add(spacingOption.name());
}
break;
case WRAPPING_AND_BRACES_SETTINGS:
for (WrappingOrBraceOption wrappingOrBraceOption : WrappingOrBraceOption.values()) {
myCollectedFields.add(wrappingOrBraceOption.name());
}
break;
case COMMENTER_SETTINGS:
for (CommenterOption commenterOption : CommenterOption.values()) {
myCollectedFields.add(commenterOption.name());
}
break;
default:
// ignore
}
}
@Override
public void showStandardOptions(String... optionNames) {
ContainerUtil.addAll(myCollectedFields, optionNames);
}
@Override
public void showCustomOption(Class<? extends CustomCodeStyleSettings> settingsClass,
String fieldName,
String title,
@Nullable String groupName,
Object... options) {
myCollectedFields.add(fieldName);
}
@Override
public void showCustomOption(Class<? extends CustomCodeStyleSettings> settingsClass,
String fieldName,
String title,
@Nullable String groupName,
@Nullable OptionAnchor anchor,
@Nullable String anchorFieldName,
Object... options) {
myCollectedFields.add(fieldName);
}
}
}