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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* Copyright 2000-2009 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.util.gotoByName;
import com.intellij.concurrency.JobLauncher;
import com.intellij.diagnostic.PluginException;
import com.intellij.ide.plugins.PluginManager;
import com.intellij.ide.util.NavigationItemListCellRenderer;
import com.intellij.navigation.ChooseByNameContributor;
import com.intellij.navigation.NavigationItem;
import com.intellij.openapi.application.ReadActionProcessor;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.extensions.PluginId;
import com.intellij.openapi.progress.ProcessCanceledException;
import com.intellij.openapi.progress.ProgressIndicator;
import com.intellij.openapi.progress.ProgressManager;
import com.intellij.openapi.progress.util.ProgressIndicatorBase;
import com.intellij.openapi.project.DumbService;
import com.intellij.openapi.project.IndexNotReadyException;
import com.intellij.openapi.project.Project;
import com.intellij.util.ArrayUtil;
import com.intellij.util.Processor;
import com.intellij.util.containers.ContainerUtil;
import gnu.trove.THashSet;
import org.jetbrains.annotations.NotNull;
import javax.swing.*;
import java.awt.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
/**
* Contributor-based goto model
*/
public abstract class ContributorsBasedGotoByModel implements ChooseByNameModel {
public static final Logger LOG = Logger.getInstance("#com.intellij.ide.util.gotoByName.ContributorsBasedGotoByModel");
protected final Project myProject;
private final ChooseByNameContributor[] myContributors;
protected ContributorsBasedGotoByModel(@NotNull Project project, @NotNull ChooseByNameContributor[] contributors) {
myProject = project;
myContributors = contributors;
}
@Override
public ListCellRenderer getListCellRenderer() {
return new NavigationItemListCellRenderer() {
@Override
public Component getListCellRendererComponent(JList list, Object value, int index, boolean isSelected, boolean cellHasFocus) {
if (value == ChooseByNameBase.NON_PREFIX_SEPARATOR) {
Object previousElement = index > 0 ? list.getModel().getElementAt(index - 1) : null;
return ChooseByNameBase.renderNonPrefixSeparatorComponent(getBackgroundColor(previousElement));
}
else {
return super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
}
}
};
}
@NotNull
@Override
public String[] getNames(final boolean checkBoxState) {
final THashSet<String> allNames = ContainerUtil.newTroveSet();
long start = System.currentTimeMillis();
List<ChooseByNameContributor> liveContribs = filterDumb(myContributors);
ProgressIndicator indicator = ProgressManager.getInstance().getProgressIndicator();
Processor<ChooseByNameContributor> processor = new ReadActionProcessor<ChooseByNameContributor>() {
@Override
public boolean processInReadAction(ChooseByNameContributor contributor) {
try {
if (!myProject.isDisposed()) {
String[] names = contributor.getNames(myProject, checkBoxState);
synchronized (allNames) {
allNames.ensureCapacity(names.length);
ContainerUtil.addAll(allNames, names);
}
}
}
catch (ProcessCanceledException ex) {
// index corruption detected, ignore
}
catch (IndexNotReadyException ex) {
// index corruption detected, ignore
}
catch (Exception ex) {
LOG.error(ex);
}
return true;
}
};
JobLauncher.getInstance().invokeConcurrentlyUnderProgress(liveContribs, indicator, false, processor);
if (indicator != null) {
indicator.checkCanceled();
}
long finish = System.currentTimeMillis();
if (LOG.isDebugEnabled()) {
LOG.debug("getNames(): "+(finish-start)+"ms; (got "+allNames.size()+" elements)");
}
return ArrayUtil.toStringArray(allNames);
}
private List<ChooseByNameContributor> filterDumb(ChooseByNameContributor[] contributors) {
if (!DumbService.getInstance(myProject).isDumb()) return Arrays.asList(contributors);
List<ChooseByNameContributor> answer = new ArrayList<ChooseByNameContributor>(contributors.length);
for (ChooseByNameContributor contributor : contributors) {
if (DumbService.isDumbAware(contributor)) {
answer.add(contributor);
}
}
return answer;
}
@NotNull
public Object[] getElementsByName(final String name, final boolean checkBoxState, final String pattern, @NotNull final ProgressIndicator canceled) {
final List<NavigationItem> items = Collections.synchronizedList(new ArrayList<NavigationItem>());
Processor<ChooseByNameContributor> processor = new Processor<ChooseByNameContributor>() {
@Override
public boolean process(ChooseByNameContributor contributor) {
if (myProject.isDisposed()) {
return true;
}
try {
for (NavigationItem item : contributor.getItemsByName(name, pattern, myProject, checkBoxState)) {
canceled.checkCanceled();
if (item == null) {
PluginId pluginId = PluginManager.getPluginByClassName(contributor.getClass().getName());
if (pluginId != null) {
LOG.error(new PluginException("null item from contributor " + contributor + " for name " + name, pluginId));
}
else {
LOG.error("null item from contributor " + contributor + " for name " + name);
}
continue;
}
if (acceptItem(item)) {
items.add(item);
}
}
}
catch (ProcessCanceledException ex) {
// index corruption detected, ignore
}
catch (Exception ex) {
LOG.error(ex);
}
return true;
}
};
JobLauncher.getInstance().invokeConcurrentlyUnderProgress(filterDumb(myContributors), canceled, false, processor);
canceled.checkCanceled(); // if parallel job execution was canceled because of PCE, rethrow it from here
return ArrayUtil.toObjectArray(items);
}
/**
* Get elements by name from contributors.
*
* @param name a name
* @param checkBoxState if true, non-project files are considered as well
* @param pattern a pattern to use
* @return a list of navigation items from contributors for
* which {@link #acceptItem(NavigationItem) returns true.
*
*/
@NotNull
@Override
public Object[] getElementsByName(final String name, final boolean checkBoxState, final String pattern) {
return getElementsByName(name, checkBoxState, pattern, new ProgressIndicatorBase());
}
@Override
public String getElementName(Object element) {
return ((NavigationItem)element).getName();
}
@Override
public String getHelpId() {
return null;
}
protected ChooseByNameContributor[] getContributors() {
return myContributors;
}
/**
* This method allows extending classes to introduce additional filtering criteria to model
* beyond pattern and project/non-project files. The default implementation just returns true.
*
* @param item an item to filter
* @return true if the item is acceptable according to additional filtering criteria.
*/
protected boolean acceptItem(NavigationItem item) {
return true;
}
@Override
public boolean useMiddleMatching() {
return true;
}
public @NotNull String removeModelSpecificMarkup(@NotNull String pattern) {
return pattern;
}
}
|
