Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 89785527cebd37f18e6752464fd719d4bedbb04a (plain) (blame)
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
/*******************************************************************************
 * Copyright (c) 2000, 2012 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Jan-Hendrik Diederich, Bredex GmbH - bug 201052
 *******************************************************************************/
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.e4.ui.model.application.MApplication;
import org.eclipse.e4.ui.model.application.descriptor.basic.MPartDescriptor;
import org.eclipse.e4.ui.model.application.descriptor.basic.impl.BasicFactoryImpl;
import org.eclipse.ui.IPageLayout;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.activities.WorkbenchActivityHelper;
import org.eclipse.ui.internal.WorkbenchMessages;
import org.eclipse.ui.internal.WorkbenchPlugin;
import org.eclipse.ui.internal.e4.compatibility.CompatibilityPart;
import org.eclipse.ui.internal.menus.MenuHelper;
import org.eclipse.ui.views.IStickyViewDescriptor;
import org.eclipse.ui.views.IViewCategory;
import org.eclipse.ui.views.IViewDescriptor;
import org.eclipse.ui.views.IViewRegistry;

public class ViewRegistry implements IViewRegistry {

	@Inject
	private MApplication application;

	@Inject
	private IExtensionRegistry extensionRegistry;

	@Inject
	private IWorkbench workbench;

	private Map<String, IViewDescriptor> descriptors = new HashMap<String, IViewDescriptor>();

	private List<IStickyViewDescriptor> stickyDescriptors = new ArrayList<IStickyViewDescriptor>();

	private HashMap<String, ViewCategory> categories = new HashMap<String, ViewCategory>();

	@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
						WorkbenchPlugin.log(
								"Unable to create sticky view descriptor.", e.getStatus());//$NON-NLS-1$
					}
				}
			}
		}

		for (IExtension extension : point.getExtensions()) {
			for (IConfigurationElement element : extension.getConfigurationElements()) {
				if (element.getName().equals(IWorkbenchRegistryConstants.TAG_VIEW)) {
					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;
						}
					}
					ViewCategory category = null;
					if (descriptor == null) { // create a new descriptor
						descriptor = BasicFactoryImpl.eINSTANCE.createPartDescriptor();
						descriptor.setLabel(element
								.getAttribute(IWorkbenchRegistryConstants.ATT_NAME));
						descriptor.setElementId(id);
						if (id.equals(IPageLayout.ID_RES_NAV)
								|| id.equals(IPageLayout.ID_PROJECT_EXPLORER)) {
							descriptor.setCategory("org.eclipse.e4.primaryNavigationStack"); //$NON-NLS-1$
						} else if (id.equals(IPageLayout.ID_OUTLINE)) {
							descriptor.setCategory("org.eclipse.e4.secondaryNavigationStack"); //$NON-NLS-1$
						} else {
							descriptor.setCategory("org.eclipse.e4.secondaryDataStack"); //$NON-NLS-1$
						}

						List<String> tags = descriptor.getTags();
						tags.add("View"); //$NON-NLS-1$

						descriptor.setCloseable(true);
						descriptor.setAllowMultiple(Boolean.parseBoolean(element
								.getAttribute(IWorkbenchRegistryConstants.ATT_ALLOW_MULTIPLE)));
						descriptor.setContributionURI(CompatibilityPart.COMPATIBILITY_VIEW_URI);

						String iconURI = element.getAttribute(IWorkbenchRegistryConstants.ATT_ICON);
						if (iconURI == null) {
							descriptor.setIconURI(MenuHelper.getImageUrl(workbench
									.getSharedImages().getImageDescriptor(
											ISharedImages.IMG_DEF_VIEW)));
						} else if (!iconURI.startsWith("platform:/plugin/")) { //$NON-NLS-1$
							StringBuilder builder = new StringBuilder("platform:/plugin/"); //$NON-NLS-1$
							builder.append(element.getContributor().getName()).append('/');

							// FIXME: need to get rid of $nl$ properly
							if (iconURI.startsWith("$nl$")) { //$NON-NLS-1$
								iconURI = iconURI.substring(4);
							}

							builder.append(iconURI);
							descriptor.setIconURI(builder.toString());
						} else {
							descriptor.setIconURI(iconURI);
						}

						String categoryId = element
								.getAttribute(IWorkbenchRegistryConstants.ATT_CATEGORY);
						category = findCategory(categoryId);
						if (category == null) {
							tags.add("categoryTag:" + WorkbenchMessages.ICategory_other); //$NON-NLS-1$	
						} else {
							tags.add("categoryTag:" + category.getLabel()); //$NON-NLS-1$
						}

						application.getDescriptors().add(descriptor);
					}

					ViewDescriptor viewDescriptor = new ViewDescriptor(application, descriptor,
							element);
					descriptors.put(descriptor.getElementId(), viewDescriptor);

					if (category == null) {
						String categoryId = element
								.getAttribute(IWorkbenchRegistryConstants.ATT_CATEGORY);
						category = findCategory(categoryId);
					}

					if (category != null) {
						category.addDescriptor(viewDescriptor);
					}
				}
			}
		}
	}

	public IViewDescriptor find(String id) {
		IViewDescriptor candidate = descriptors.get(id);
		if (WorkbenchActivityHelper.restrictUseOf(candidate)) {
			return null;
		}
		return candidate;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.views.IViewRegistry#getCategories()
	 */
	public IViewCategory[] getCategories() {
		return categories.values().toArray(new IViewCategory[categories.size()]);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.views.IViewRegistry#getViews()
	 */
	public IViewDescriptor[] getViews() {
		Collection<?> allowedViews = WorkbenchActivityHelper.restrictCollection(
				descriptors.values(), new ArrayList<Object>());
		return allowedViews.toArray(new IViewDescriptor[allowedViews.size()]);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.views.IViewRegistry#getStickyViews()
	 */
	public IStickyViewDescriptor[] getStickyViews() {
		Collection<?> allowedViews = WorkbenchActivityHelper.restrictCollection(stickyDescriptors,
				new ArrayList<Object>());
		return allowedViews.toArray(new IStickyViewDescriptor[allowedViews.size()]);
	}

	/**
	 * 
	 */
	public void dispose() {

	}

	/**
	 * 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 null;
		}
		return categories.get(id);
	}

	public Category getMiscCategory() {
		// TODO Auto-generated method stub
		return null;
	}

}

Back to the top