1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/*
* Copyright 2000-2013 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.openapi.options.ex;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.options.Configurable;
import com.intellij.openapi.options.ConfigurableEP;
import com.intellij.openapi.options.ConfigurableProvider;
import com.intellij.openapi.options.OptionalConfigurable;
import com.intellij.openapi.project.Project;
import com.intellij.util.containers.ContainerUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
/**
* @author nik
*/
public class ConfigurableExtensionPointUtil {
private final static Logger LOG = Logger.getInstance(ConfigurableExtensionPointUtil.class);
private ConfigurableExtensionPointUtil() {
}
public static List<Configurable> buildConfigurablesList(final ConfigurableEP<Configurable>[] extensions,
final Configurable[] components,
@Nullable ConfigurableFilter filter) {
final List<Configurable> result = new ArrayList<Configurable>();
for (Configurable component : components) {
if (!isSuppressed(component, filter)) {
result.add(component);
}
}
final Map<String, ConfigurableWrapper> idToConfigurable = new LinkedHashMap<String, ConfigurableWrapper>();
for (ConfigurableEP<Configurable> ep : extensions) {
final Configurable configurable = ConfigurableWrapper.wrapConfigurable(ep);
if (isSuppressed(configurable, filter)) continue;
if (configurable instanceof ConfigurableWrapper) {
final ConfigurableWrapper wrapper = (ConfigurableWrapper)configurable;
idToConfigurable.put(wrapper.getId(), wrapper);
}
else {
// dumpConfigurable(configurablesExtensionPoint, ep, configurable);
ContainerUtil.addIfNotNull(configurable, result);
}
}
//modify configurables (append children)
for (final String id : idToConfigurable.keySet()) {
final ConfigurableWrapper wrapper = idToConfigurable.get(id);
final String parentId = wrapper.getParentId();
if (parentId != null) {
final ConfigurableWrapper parent = idToConfigurable.get(parentId);
if (parent != null) {
idToConfigurable.put(parentId, parent.addChild(wrapper));
}
else {
LOG.debug("Can't find parent for " + parentId + " (" + wrapper + ")");
}
}
}
// add roots only (i.e. configurables without parents)
for (ConfigurableWrapper wrapper : idToConfigurable.values()) {
String parentId = wrapper.getParentId();
if (parentId == null || !idToConfigurable.containsKey(parentId)) {
result.add(wrapper);
}
}
return result;
}
private static boolean isSuppressed(Configurable each, ConfigurableFilter filter) {
return each instanceof Configurable.Assistant
|| each instanceof OptionalConfigurable && !((OptionalConfigurable) each).needDisplay()
|| filter != null && !filter.isIncluded(each);
}
/*
private static void dumpConfigurable(ExtensionPointName<ConfigurableEP<Configurable>> configurablesExtensionPoint,
ConfigurableEP<Configurable> ep,
Configurable configurable) {
if (configurable != null && !(configurable instanceof ConfigurableGroup)) {
if (ep.instanceClass != null && (configurable instanceof SearchableConfigurable) && (configurable instanceof Configurable.Composite)) {
Element element = dump(ep, configurable, StringUtil.getShortName(configurablesExtensionPoint.getName()));
final Configurable[] configurables = ((Configurable.Composite)configurable).getConfigurables();
for (Configurable child : configurables) {
final Element dump = dump(null, child, "configurable");
element.addContent(dump);
}
final StringWriter out = new StringWriter();
try {
new XMLOutputter(Format.getPrettyFormat()).output(element, out);
}
catch (IOException e) {
}
System.out.println(out);
}
}
}
private static Element dump(@Nullable ConfigurableEP ep,
Configurable configurable, String name) {
Element element = new Element(name);
if (ep != null) {
element.setAttribute("instance", ep.instanceClass);
String id = ep.id == null ? ((SearchableConfigurable)configurable).getId() : ep.id;
element.setAttribute("id", id);
}
else {
element.setAttribute("instance", configurable.getClass().getName());
if (configurable instanceof SearchableConfigurable) {
element.setAttribute("id", ((SearchableConfigurable)configurable).getId());
}
}
CommonBundle.lastKey = null;
String displayName = configurable.getDisplayName();
if (CommonBundle.lastKey != null) {
element.setAttribute("key", CommonBundle.lastKey).setAttribute("bundle", CommonBundle.lastBundle);
}
else {
element.setAttribute("displayName", displayName);
}
if (configurable instanceof NonDefaultProjectConfigurable) {
element.setAttribute("nonDefaultProject", "true");
}
return element;
}
*/
/**
* @deprecated create a new instance of configurable instead
*/
@NotNull
public static <T extends Configurable> T findProjectConfigurable(@NotNull Project project, @NotNull Class<T> configurableClass) {
return findConfigurable(project.getExtensions(Configurable.PROJECT_CONFIGURABLE), configurableClass);
}
@NotNull
public static <T extends Configurable> T findApplicationConfigurable(@NotNull Class<T> configurableClass) {
return findConfigurable(Configurable.APPLICATION_CONFIGURABLE.getExtensions(), configurableClass);
}
@NotNull
private static <T extends Configurable> T findConfigurable(ConfigurableEP<Configurable>[] extensions, Class<T> configurableClass) {
for (ConfigurableEP<Configurable> extension : extensions) {
if (extension.canCreateConfigurable()) {
final Configurable configurable = extension.createConfigurable();
if (configurableClass.isInstance(configurable)) {
return configurableClass.cast(configurable);
}
}
}
throw new IllegalArgumentException("Cannot find configurable of " + configurableClass);
}
@Nullable
public static Configurable createProjectConfigurableForProvider(@NotNull Project project, Class<? extends ConfigurableProvider> providerClass) {
return createConfigurableForProvider(project.getExtensions(Configurable.PROJECT_CONFIGURABLE), providerClass);
}
@Nullable
public static Configurable createApplicationConfigurableForProvider(Class<? extends ConfigurableProvider> providerClass) {
return createConfigurableForProvider(Configurable.APPLICATION_CONFIGURABLE.getExtensions(), providerClass);
}
@Nullable
private static Configurable createConfigurableForProvider(ConfigurableEP<Configurable>[] extensions, Class<? extends ConfigurableProvider> providerClass) {
for (ConfigurableEP<Configurable> extension : extensions) {
if (extension.providerClass != null) {
final Class<Object> aClass = extension.findClassNoExceptions(extension.providerClass);
if (aClass != null && providerClass.isAssignableFrom(aClass)) {
return extension.createConfigurable();
}
}
}
return null;
}
}
|
