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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Jan-Hendrik Diederich, Bredex GmbH - bug 201052
* Lars Vogel <Lars.Vogel@vogella.com> - Bug 430616, 441267, 441282, 445609, 441280, 472654
* Simon Scholz <scholzsimon@vogella.com> - Bug 473845
*******************************************************************************/
package org.eclipse.ui.internal.registry;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.PostConstruct;
import javax.inject.Inject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtension;
import org.eclipse.core.runtime.IExtensionPoint;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.Platform;
import org.eclipse.e4.core.services.log.Logger;
import org.eclipse.e4.ui.model.application.MApplication;
import org.eclipse.e4.ui.model.application.descriptor.basic.MPartDescriptor;
import org.eclipse.e4.ui.workbench.IPresentationEngine;
import org.eclipse.e4.ui.workbench.modeling.EModelService;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.activities.WorkbenchActivityHelper;
import org.eclipse.ui.internal.IWorkbenchConstants;
import org.eclipse.ui.internal.e4.compatibility.CompatibilityPart;
import org.eclipse.ui.internal.menus.MenuHelper;
import org.eclipse.ui.part.ViewPart;
import org.eclipse.ui.views.IStickyViewDescriptor;
import org.eclipse.ui.views.IViewCategory;
import org.eclipse.ui.views.IViewDescriptor;
import org.eclipse.ui.views.IViewRegistry;
import org.osgi.framework.Bundle;
public class ViewRegistry implements IViewRegistry {
public static final String VIEW_TAG = "View"; //$NON-NLS-1$
/**
* This constant is used as key for persisting the original class for a legacy
* {@link ViewPart} in the persisted state of a {@link MPartDescriptor}.
*/
public static final String ORIGINAL_COMPATIBILITY_VIEW_CLASS = "originalCompatibilityViewClass"; //$NON-NLS-1$
/**
* This constant is used as key for persisting the original bundle for a legacy
* {@link ViewPart} in the persisted state of a {@link MPartDescriptor}.
*/
public static final String ORIGINAL_COMPATIBILITY_VIEW_BUNDLE = "originalCompatibilityViewBundle"; //$NON-NLS-1$
@Inject
private MApplication application;
@Inject
private EModelService modelService;
@Inject
private IExtensionRegistry extensionRegistry;
@Inject
private IWorkbench workbench;
@Inject
Logger logger;
private Map<String, IViewDescriptor> descriptors = new HashMap<>();
private List<IStickyViewDescriptor> stickyDescriptors = new ArrayList<>();
private HashMap<String, ViewCategory> categories = new HashMap<>();
private Category miscCategory = new Category();
@PostConstruct
void postConstruct() {
IExtensionPoint point = extensionRegistry.getExtensionPoint("org.eclipse.ui.views"); //$NON-NLS-1$
for (IExtension extension : point.getExtensions()) {
// find the category first
for (IConfigurationElement element : extension.getConfigurationElements()) {
if (element.getName().equals(IWorkbenchRegistryConstants.TAG_CATEGORY)) {
ViewCategory category = new ViewCategory(element.getAttribute(IWorkbenchRegistryConstants.ATT_ID),
element.getAttribute(IWorkbenchRegistryConstants.ATT_NAME));
categories.put(category.getId(), category);
} else if (element.getName().equals(IWorkbenchRegistryConstants.TAG_STICKYVIEW)) {
try {
stickyDescriptors.add(new StickyViewDescriptor(element));
} catch (CoreException e) {
// log an error since its not safe to open a dialog here
logger.error("Unable to create sticky view descriptor.", e.getStatus()); //$NON-NLS-1$
}
}
}
}
if (!categories.containsKey(miscCategory.getId())) {
categories.put(miscCategory.getId(), new ViewCategory(miscCategory.getId(), miscCategory.getLabel()));
}
for (IExtension extension : point.getExtensions()) {
for (IConfigurationElement element : extension.getConfigurationElements()) {
if (element.getName().equals(IWorkbenchRegistryConstants.TAG_VIEW)) {
createDescriptor(element, false);
}
if (element.getName().equals(IWorkbenchRegistryConstants.TAG_E4VIEW)) {
createDescriptor(element, true);
}
}
}
}
private void createDescriptor(IConfigurationElement element, boolean e4View) {
String id = element.getAttribute(IWorkbenchRegistryConstants.ATT_ID);
MPartDescriptor descriptor = null;
List<MPartDescriptor> currentDescriptors = application.getDescriptors();
for (MPartDescriptor desc : currentDescriptors) {
// do we have a matching descriptor?
if (desc.getElementId().equals(id)) {
descriptor = desc;
break;
}
}
if (descriptor == null) { // create a new descriptor
descriptor = modelService.createModelElement(MPartDescriptor.class);
descriptor.setElementId(id);
application.getDescriptors().add(descriptor);
}
// ==> Update descriptor
descriptor.setLabel(element.getAttribute(IWorkbenchRegistryConstants.ATT_NAME));
List<String> tags = descriptor.getTags();
tags.add(VIEW_TAG);
descriptor.setCloseable(true);
descriptor.setAllowMultiple(
Boolean.parseBoolean(element.getAttribute(IWorkbenchRegistryConstants.ATT_ALLOW_MULTIPLE)));
// make view description available as tooltip
String viewDescription = RegistryReader.getDescription(element);
descriptor.setTooltip(viewDescription);
// Is this an E4 part or a legacy IViewPart ?
String clsSpec = element.getAttribute(IWorkbenchConstants.TAG_CLASS);
String implementationURI = CompatibilityPart.COMPATIBILITY_VIEW_URI;
if (e4View) {
implementationURI = "bundleclass://" + element.getContributor().getName() + "/" + clsSpec; //$NON-NLS-1$//$NON-NLS-2$
} else {
IExtension declaringExtension = element.getDeclaringExtension();
String name = declaringExtension.getContributor().getName();
Bundle bundle = Platform.getBundle(name);
// the indexOf operation removes potential additional information
// from the qualified classname
int colonIndex = clsSpec.indexOf(':');
String viewClass = colonIndex == -1 ? clsSpec : clsSpec.substring(0, colonIndex);
descriptor.getPersistedState().put(ORIGINAL_COMPATIBILITY_VIEW_CLASS, viewClass);
descriptor.getPersistedState().put(ORIGINAL_COMPATIBILITY_VIEW_BUNDLE, bundle.getSymbolicName());
boolean useDependencyInjection = Boolean
.parseBoolean(element.getAttribute(IWorkbenchConstants.TAG_USE_DEPENDENCY_INJECTION));
if (useDependencyInjection) {
descriptor.getTags().add(IWorkbenchConstants.TAG_USE_DEPENDENCY_INJECTION);
}
}
descriptor.setContributionURI(implementationURI);
String iconURI = MenuHelper.getIconURI(element, IWorkbenchRegistryConstants.ATT_ICON);
if (iconURI == null) {
descriptor.setIconURI(
MenuHelper.getImageUrl(workbench.getSharedImages().getImageDescriptor(ISharedImages.IMG_DEF_VIEW)));
} else {
descriptor.setIconURI(iconURI);
}
String categoryId = element.getAttribute(IWorkbenchRegistryConstants.ATT_CATEGORY);
ViewCategory category = findCategory(categoryId);
if (category == null) {
category = findCategory(miscCategory.getId());
}
if (category != null) {
tags.add("categoryTag:" + category.getLabel()); //$NON-NLS-1$
descriptor.setCategory(category.getLabel());
}
String restorable = element.getAttribute(IWorkbenchRegistryConstants.ATT_RESTORABLE);
if (!(restorable == null ? true : Boolean.parseBoolean(restorable))) {
descriptor.getTags().add(IPresentationEngine.NO_RESTORE);
}
// ==> End of update descriptor
ViewDescriptor viewDescriptor = new ViewDescriptor(application, descriptor, element);
descriptors.put(descriptor.getElementId(), viewDescriptor);
if (category != null) {
category.addDescriptor(viewDescriptor);
}
}
@Override
public IViewDescriptor find(String id) {
IViewDescriptor candidate = descriptors.get(id);
if (WorkbenchActivityHelper.restrictUseOf(candidate)) {
return null;
}
return candidate;
}
@Override
public IViewCategory[] getCategories() {
return categories.values().toArray(new IViewCategory[categories.size()]);
}
@Override
public IViewDescriptor[] getViews() {
Collection<?> allowedViews = WorkbenchActivityHelper.restrictCollection(descriptors.values(),
new ArrayList<>());
return allowedViews.toArray(new IViewDescriptor[allowedViews.size()]);
}
@Override
public IStickyViewDescriptor[] getStickyViews() {
Collection<?> allowedViews = WorkbenchActivityHelper.restrictCollection(stickyDescriptors, new ArrayList<>());
return allowedViews.toArray(new IStickyViewDescriptor[allowedViews.size()]);
}
/**
* Returns the {@link ViewCategory} for the given id or <code>null</code> if one
* cannot be found or the id is <code>null</code>
*
* @param id the {@link ViewCategory} id
* @return the {@link ViewCategory} with the given id or <code>null</code>
*/
public ViewCategory findCategory(String id) {
if (id == null) {
return categories.get(miscCategory.getId());
}
return categories.get(id);
}
public Category getMiscCategory() {
return miscCategory;
}
}
|
