/*
* 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.ide.actions;
import com.intellij.ide.ui.search.SearchUtil;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.options.Configurable;
import com.intellij.openapi.options.ConfigurableGroup;
import com.intellij.openapi.options.ShowSettingsUtil;
import com.intellij.openapi.options.TabbedConfigurable;
import com.intellij.openapi.options.ex.ConfigurableExtensionPointUtil;
import com.intellij.openapi.options.ex.ConfigurableVisitor;
import com.intellij.openapi.options.ex.ConfigurableWrapper;
import com.intellij.openapi.options.newEditor.SettingsDialogFactory;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.project.ProjectManager;
import com.intellij.openapi.ui.DialogWrapper;
import com.intellij.ui.navigation.Place;
import com.intellij.util.ui.update.Activatable;
import com.intellij.util.ui.update.UiNotifyConnector;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.awt.*;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
/**
* @author max
*/
public class ShowSettingsUtilImpl extends ShowSettingsUtil {
private static final Logger LOG = Logger.getInstance("#com.intellij.ide.actions.ShowSettingsUtilImpl");
@NotNull
private static Project getProject(@Nullable Project project) {
return project != null ? project : ProjectManager.getInstance().getDefaultProject();
}
@NotNull
public static DialogWrapper getDialog(@Nullable Project project, @NotNull ConfigurableGroup[] groups, @Nullable Configurable toSelect) {
project = getProject(project);
final ConfigurableGroup[] filteredGroups = filterEmptyGroups(groups);
return SettingsDialogFactory.getInstance().create(project, filteredGroups, toSelect, null);
}
/**
* @param project a project used to load project settings or {@code null}
* @param withIdeSettings specifies whether to load application settings or not
* @return an array with the root configurable group
*/
@NotNull
public static ConfigurableGroup[] getConfigurableGroups(@Nullable Project project, boolean withIdeSettings) {
ConfigurableGroup group = ConfigurableExtensionPointUtil.getConfigurableGroup(project, withIdeSettings);
return new ConfigurableGroup[]{group};
}
/**
* @param project a project used to load project settings or {@code null}
* @param withIdeSettings specifies whether to load application settings or not
* @return all configurables as a plain list except the root configurable group
*/
@NotNull
public static Configurable[] getConfigurables(@Nullable Project project, boolean withIdeSettings) {
ConfigurableGroup group = ConfigurableExtensionPointUtil.getConfigurableGroup(project, withIdeSettings);
List<Configurable> list = new ArrayList<>();
collect(list, group.getConfigurables());
return list.toArray(new Configurable[0]);
}
private static void collect(List<Configurable> list, Configurable... configurables) {
for (Configurable configurable : configurables) {
list.add(configurable);
if (configurable instanceof Configurable.Composite) {
Configurable.Composite composite = (Configurable.Composite)configurable;
collect(list, composite.getConfigurables());
}
}
}
@Override
public void showSettingsDialog(@NotNull Project project, @NotNull ConfigurableGroup... group) {
try {
getDialog(project, group, null).show();
}
catch (Exception e) {
LOG.error(e);
}
}
@Override
public void showSettingsDialog(@Nullable final Project project, final Class configurableClass) {
//noinspection unchecked
showSettingsDialog(project, configurableClass, null);
}
public <T extends Configurable> void showSettingsDialog(@Nullable Project project,
@NotNull Class<T> configurableClass,
@Nullable Consumer<T> additionalConfiguration) {
assert Configurable.class.isAssignableFrom(configurableClass) : "Not a configurable: " + configurableClass.getName();
ConfigurableGroup[] groups = getConfigurableGroups(project, true);
Configurable config = new ConfigurableVisitor.ByType(configurableClass).find(groups);
assert config != null : "Cannot find configurable: " + configurableClass.getName();
if (additionalConfiguration != null) {
T toConfigure = ConfigurableWrapper.cast(configurableClass, config);
assert toConfigure != null : "Wrong configurable found: " + config.getClass();
additionalConfiguration.accept(toConfigure);
}
getDialog(project, groups, config).show();
}
@Override
public void showSettingsDialog(@Nullable final Project project, @NotNull final String nameToSelect) {
ConfigurableGroup[] groups = getConfigurableGroups(project, true);
Project actualProject = getProject(project);
groups = filterEmptyGroups(groups);
getDialog(actualProject, groups, findPreselectedByDisplayName(nameToSelect, groups)).show();
}
@Nullable
private static Configurable findPreselectedByDisplayName(final String preselectedConfigurableDisplayName, ConfigurableGroup[] groups) {
final List<Configurable> all = SearchUtil.expand(groups);
for (Configurable each : all) {
if (preselectedConfigurableDisplayName.equals(each.getDisplayName())) return each;
}
return null;
}
public static void showSettingsDialog(@Nullable Project project, final String id2Select, final String filter) {
ConfigurableGroup[] group = getConfigurableGroups(project, true);
group = filterEmptyGroups(group);
final Configurable configurable2Select = id2Select == null ? null : new ConfigurableVisitor.ByID(id2Select).find(group);
SettingsDialogFactory.getInstance().create(getProject(project), group, configurable2Select, filter).show();
}
@Override
public void showSettingsDialog(@NotNull final Project project, final Configurable toSelect) {
getDialog(project, getConfigurableGroups(project, true), toSelect).show();
}
@NotNull
private static ConfigurableGroup[] filterEmptyGroups(@NotNull final ConfigurableGroup[] group) {
List<ConfigurableGroup> groups = new ArrayList<>();
for (ConfigurableGroup g : group) {
if (g.getConfigurables().length > 0) {
groups.add(g);
}
}
return groups.toArray(new ConfigurableGroup[groups.size()]);
}
@Override
public boolean editConfigurable(Project project, Configurable configurable) {
return editConfigurable(project, createDimensionKey(configurable), configurable);
}
@Override
public <T extends Configurable> T findApplicationConfigurable(final Class<T> confClass) {
return ConfigurableExtensionPointUtil.findApplicationConfigurable(confClass);
}
@Override
public <T extends Configurable> T findProjectConfigurable(final Project project, final Class<T> confClass) {
//noinspection deprecation
return ConfigurableExtensionPointUtil.findProjectConfigurable(project, confClass);
}
@Override
public boolean editConfigurable(Project project, String dimensionServiceKey, @NotNull Configurable configurable) {
return editConfigurable(project, dimensionServiceKey, configurable, isWorthToShowApplyButton(configurable));
}
private static boolean isWorthToShowApplyButton(@NotNull Configurable configurable) {
return configurable instanceof Place.Navigator ||
configurable instanceof Composite ||
configurable instanceof TabbedConfigurable;
}
@Override
public boolean editConfigurable(Project project, String dimensionServiceKey, @NotNull Configurable configurable, boolean showApplyButton) {
return editConfigurable(null, project, configurable, dimensionServiceKey, null, showApplyButton);
}
@Override
public boolean editConfigurable(Project project, Configurable configurable, Runnable advancedInitialization) {
return editConfigurable(null, project, configurable, createDimensionKey(configurable), advancedInitialization, isWorthToShowApplyButton(configurable));
}
@Override
public boolean editConfigurable(@Nullable Component parent, @NotNull Configurable configurable) {
return editConfigurable(parent, configurable, null);
}
@Override
public boolean editConfigurable(@Nullable Component parent, @NotNull Configurable configurable, @Nullable Runnable advancedInitialization) {
return editConfigurable(parent, null, configurable, createDimensionKey(configurable), advancedInitialization, isWorthToShowApplyButton(configurable));
}
private static boolean editConfigurable(@Nullable Component parent,
@Nullable Project project,
@NotNull Configurable configurable,
String dimensionKey,
@Nullable final Runnable advancedInitialization,
boolean showApplyButton) {
final DialogWrapper editor;
if (parent == null) {
editor = SettingsDialogFactory.getInstance().create(project, dimensionKey, configurable, showApplyButton, false);
}
else {
editor = SettingsDialogFactory.getInstance().create(parent, dimensionKey, configurable, showApplyButton, false);
}
if (advancedInitialization != null) {
new UiNotifyConnector.Once(editor.getContentPane(), new Activatable.Adapter() {
@Override
public void showNotify() {
advancedInitialization.run();
}
});
}
return editor.showAndGet();
}
@NotNull
public static String createDimensionKey(@NotNull Configurable configurable) {
return '#' + configurable.getDisplayName().replace('\n', '_').replace(' ', '_');
}
@Override
public boolean editConfigurable(Component parent, String dimensionServiceKey, Configurable configurable) {
return editConfigurable(parent, null, configurable, dimensionServiceKey, null, isWorthToShowApplyButton(configurable));
}
}