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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
/** ****************************************************************************
* Copyright (c) 2012, 2013 Obeo.
* 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:
* Obeo - initial API and implementation
*******************************************************************************/
package org.eclipse.emf.compare.rcp.ui;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.compare.rcp.ui.internal.util.AbstractRegistryEventListener;
import org.eclipse.emf.compare.rcp.ui.structuremergeviewer.filters.IDifferenceFilter;
import org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups.IDifferenceGroupProvider;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;
/**
* The activator class controls the plug-in life cycle.
*
* @since 3.0
*/
public class EMFCompareRCPUIPlugin extends AbstractUIPlugin {
/**
* The plug-in ID.
*/
public static final String PLUGIN_ID = "org.eclipse.emf.compare.rcp.ui"; //$NON-NLS-1$
public static final String GROUP_PROVIDER_PPID = "groups"; //$NON-NLS-1$
public static final String FILTER_PROVIDER_PPID = "filters"; //$NON-NLS-1$
/**
* the shared instance.
*/
private static EMFCompareRCPUIPlugin plugin;
/** keep track of resources that should be freed when exiting. */
private static Map<String, Image> resourcesMapper = new HashMap<String, Image>();
private AbstractRegistryEventListener groupProviderRegistryListener;
private IDifferenceGroupProvider.Registry groupProviderRegistry;
private AbstractRegistryEventListener filterRegistryListener;
private IDifferenceFilter.Registry filterRegistry;
/**
* The constructor.
*/
public EMFCompareRCPUIPlugin() {
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
*/
@Override
public void start(BundleContext context) throws Exception {
super.start(context);
plugin = this;
IExtensionRegistry extensionRegistry = Platform.getExtensionRegistry();
groupProviderRegistry = new IDifferenceGroupProvider.RegistryImpl();
groupProviderRegistryListener = new DifferenceGroupProviderExtensionRegistryListener(PLUGIN_ID,
GROUP_PROVIDER_PPID);
extensionRegistry.addListener(groupProviderRegistryListener, PLUGIN_ID + "." + GROUP_PROVIDER_PPID); //$NON-NLS-1$
groupProviderRegistryListener.readRegistry(extensionRegistry);
filterRegistry = new IDifferenceFilter.RegistryImpl();
filterRegistryListener = new FilterExtensionRegistryListener(PLUGIN_ID, FILTER_PROVIDER_PPID);
extensionRegistry.addListener(filterRegistryListener, PLUGIN_ID + "." + FILTER_PROVIDER_PPID); //$NON-NLS-1$
filterRegistryListener.readRegistry(extensionRegistry);
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
*/
@Override
public void stop(BundleContext context) throws Exception {
Platform.getExtensionRegistry().removeListener(filterRegistryListener);
filterRegistry = null;
Platform.getExtensionRegistry().removeListener(groupProviderRegistryListener);
groupProviderRegistry = null;
plugin = null;
disposeCachedImages();
super.stop(context);
}
/**
* Returns the shared instance.
*
* @return the shared instance
*/
public static EMFCompareRCPUIPlugin getDefault() {
return plugin;
}
/**
* Log an {@link Exception} in the {@link #getLog() current logger}.
*
* @param e
* the exception to be logged.
*/
public void log(Throwable e) {
getLog().log(new Status(IStatus.ERROR, PLUGIN_ID, e.getMessage(), e));
}
/**
* Log the given message with the give severity level. Severity is one of {@link IStatus#INFO},
* {@link IStatus#WARNING} and {@link IStatus#ERROR}.
*
* @param severity
* the severity of the message
* @param message
* the message
*/
public void log(int severity, String message) {
getLog().log(new Status(severity, PLUGIN_ID, message));
}
/**
* @return the groupProviderRegistry
*/
public IDifferenceGroupProvider.Registry getDifferenceGroupProviderRegistry() {
return groupProviderRegistry;
}
public IDifferenceFilter.Registry getFilterActionRegistry() {
return filterRegistry;
}
/**
* <p>
* returns a plugin image. The returned image does not need to be explicitly disposed.
* </p>
*
* @param imagePath
* : plugin relative path to the image
* @return Image : plugin hosted image
*/
public static Image getImage(String imagePath) {
Image image = resourcesMapper.get(imagePath);
if (image == null) {
ImageDescriptor imageDescriptor = imageDescriptorFromPlugin(PLUGIN_ID, imagePath);
image = imageDescriptor.createImage();
resourcesMapper.put(imagePath, image);
}
return image;
}
/**
* <p>
* returns a plugin image descriptor.
* </p>
*
* @param imagePath
* : plugin relative path to the image
* @return ImageDescriptor : image descriptor.
*/
public static ImageDescriptor getImageDescriptor(String imagePath) {
return imageDescriptorFromPlugin(PLUGIN_ID, imagePath);
}
/**
* Dispose image with the given id.
*
* @param id
* : dispose system resources associated with the image with the given id.
*/
public static void disposeImage(String id) {
Image image = resourcesMapper.remove(id);
if (image != null) {
image.dispose();
}
}
/**
* dispose system resources associated with cached images.
*/
public static void disposeCachedImages() {
Iterator<Image> iterator = resourcesMapper.values().iterator();
while (iterator.hasNext()) {
iterator.next().dispose();
}
resourcesMapper.clear();
}
private class DifferenceGroupProviderExtensionRegistryListener extends AbstractRegistryEventListener {
static final String TAG_GROUP_PROVIDER = "group"; //$NON-NLS-1$
static final String ATT_CLASS = "class"; //$NON-NLS-1$
static final String ATT_LABEL = "label"; //$NON-NLS-1$
static final String ATT_ACTIVE = "activeByDefault"; //$NON-NLS-1$
/**
* @param pluginID
* @param extensionPointID
* @param registry
*/
public DifferenceGroupProviderExtensionRegistryListener(String pluginID, String extensionPointID) {
super(pluginID, extensionPointID);
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.compare.rcp.ui.internal.util.AbstractRegistryEventListener#readElement(org.eclipse.core.runtime.IConfigurationElement,
* org.eclipse.emf.compare.rcp.ui.internal.util.AbstractRegistryEventListener.Action)
*/
@SuppressWarnings("boxing")
@Override
protected boolean readElement(IConfigurationElement element, Action b) {
if (element.getName().equals(TAG_GROUP_PROVIDER)) {
if (element.getAttribute(ATT_CLASS) == null) {
logMissingAttribute(element, ATT_CLASS);
} else if (element.getAttribute(ATT_LABEL) == null) {
logMissingAttribute(element, ATT_LABEL);
} else if (element.getAttribute(ATT_ACTIVE) == null) {
logMissingAttribute(element, ATT_ACTIVE);
} else {
switch (b) {
case ADD:
try {
IDifferenceGroupProvider provider = (IDifferenceGroupProvider)element
.createExecutableExtension(ATT_CLASS);
provider.setLabel(element.getAttribute(ATT_LABEL));
if (Boolean.valueOf(element.getAttribute(ATT_ACTIVE))) {
provider.setDefaultSelected(true);
} else {
provider.setDefaultSelected(false);
}
IDifferenceGroupProvider previous = groupProviderRegistry.add(provider);
if (previous != null) {
log(IStatus.WARNING, "The provider '" + provider.getClass().getName() //$NON-NLS-1$
+ "' is registered twice."); //$NON-NLS-1$
}
} catch (CoreException e) {
logError(element, e.getMessage());
}
break;
case REMOVE:
groupProviderRegistry.remove(element.getAttribute(ATT_CLASS));
break;
}
return true;
}
}
return false;
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.compare.rcp.ui.internal.util.AbstractRegistryEventListener#logError(org.eclipse.core.runtime.IConfigurationElement,
* java.lang.String)
*/
@Override
protected void logError(IConfigurationElement element, String string) {
log(IStatus.ERROR, string);
}
}
private class FilterExtensionRegistryListener extends AbstractRegistryEventListener {
static final String TAG_FILTER_ACTION = "filter"; //$NON-NLS-1$
static final String ATT_CLASS = "class"; //$NON-NLS-1$
static final String ATT_LABEL = "label"; //$NON-NLS-1$
static final String ATT_ACTIVE = "activeByDefault"; //$NON-NLS-1$
/**
* @param pluginID
* @param extensionPointID
* @param registry
*/
public FilterExtensionRegistryListener(String pluginID, String extensionPointID) {
super(pluginID, extensionPointID);
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.compare.rcp.ui.internal.util.AbstractRegistryEventListener#readElement(org.eclipse.core.runtime.IConfigurationElement,
* org.eclipse.emf.compare.rcp.ui.internal.util.AbstractRegistryEventListener.Action)
*/
@SuppressWarnings("boxing")
@Override
protected boolean readElement(IConfigurationElement element, Action b) {
if (element.getName().equals(TAG_FILTER_ACTION)) {
if (element.getAttribute(ATT_CLASS) == null) {
logMissingAttribute(element, ATT_CLASS);
} else if (element.getAttribute(ATT_LABEL) == null) {
logMissingAttribute(element, ATT_LABEL);
} else if (element.getAttribute(ATT_ACTIVE) == null) {
logMissingAttribute(element, ATT_ACTIVE);
} else {
switch (b) {
case ADD:
try {
IDifferenceFilter filter = (IDifferenceFilter)element
.createExecutableExtension(ATT_CLASS);
filter.setLabel(element.getAttribute(ATT_LABEL));
if (Boolean.valueOf(element.getAttribute(ATT_ACTIVE))) {
filter.setDefaultSelected(true);
} else {
filter.setDefaultSelected(false);
}
IDifferenceFilter previous = filterRegistry.add(filter);
if (previous != null) {
log(IStatus.WARNING, "The filter '" + filter.getClass().getName() //$NON-NLS-1$
+ "' is registered twice."); //$NON-NLS-1$
}
} catch (CoreException e) {
logError(element, e.getMessage());
}
break;
case REMOVE:
filterRegistry.remove(element.getAttribute(ATT_CLASS));
break;
}
return true;
}
}
return false;
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.compare.rcp.ui.internal.util.AbstractRegistryEventListener#logError(org.eclipse.core.runtime.IConfigurationElement,
* java.lang.String)
*/
@Override
protected void logError(IConfigurationElement element, String string) {
log(IStatus.ERROR, string);
}
}
}
|
