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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
|
package org.eclipse.debug.internal.ui.launchConfigurations;
/**********************************************************************
Copyright (c) 2000, 2002 IBM Corp. All rights reserved.
This file is made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/cpl-v10.html
**********************************************************************/
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.xerces.dom.DocumentImpl;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionPoint;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IPluginDescriptor;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchListener;
import org.eclipse.debug.core.ILaunchManager;
import org.eclipse.debug.internal.ui.DebugPluginImages;
import org.eclipse.debug.internal.ui.DebugUIPlugin;
import org.eclipse.debug.internal.ui.IInternalDebugUIConstants;
import org.eclipse.debug.internal.ui.ILaunchHistoryChangedListener;
import org.eclipse.debug.ui.IDebugUIConstants;
import org.eclipse.debug.ui.ILaunchConfigurationTab;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
public class LaunchConfigurationManager implements ILaunchListener {
/**
* The singleton instance of the launch configuration manager
*/
private static LaunchConfigurationManager fgLaunchConfigurationManager;
/**
* Launch group extensions, keyed by launch group identifier.
*/
protected Map fLaunchGroups;
/**
* Launch histories keyed by launch group identifier
*/
protected Map fLaunchHistories;
/**
* The list of registered implementors of <code>ILaunchHistoryChangedListener</code>
*/
protected List fLaunchHistoryChangedListeners = new ArrayList(3);
/**
* Launch shortcuts
*/
private List fLaunchShortcuts = null;
/**
* Launch shortcuts, cached by perspective ids
*/
private Map fLaunchShortcutsByPerspective = null;
/**
* Cache of launch configuration tab images with error overlays
*/
protected ImageRegistry fErrorImages = null;
/**
* true when restoring launch history
*/
protected boolean fRestoring = false;
/**
* The name of the file used to persist the launch history.
*/
private static final String LAUNCH_CONFIGURATION_HISTORY_FILENAME = "launchConfigurationHistory.xml"; //$NON-NLS-1$
/**
* The 'HISTORY_' fields are constants that represent node & attribute names used when
* writing out the launch history XML file.
*/
private static final String HISTORY_ROOT_NODE = "launchHistory"; //$NON-NLS-1$
private static final String HISTORY_LAUNCH_NODE = "launch"; //$NON-NLS-1$
private static final String HISTORY_LAST_LAUNCH_NODE = "lastLaunch"; //$NON-NLS-1$
private static final String HISTORY_MEMENTO_ATT = "memento"; //$NON-NLS-1$
private static final String HISTORY_MODE_ATT = "mode"; //$NON-NLS-1$
private LaunchConfigurationManager() {
ILaunchManager launchManager= DebugPlugin.getDefault().getLaunchManager();
launchManager.addLaunchListener(this);
//update histories for launches already registered
ILaunch[] launches= launchManager.getLaunches();
for (int i = 0; i < launches.length; i++) {
launchAdded(launches[i]);
}
}
public static LaunchConfigurationManager getDefault() {
if (fgLaunchConfigurationManager == null) {
fgLaunchConfigurationManager= new LaunchConfigurationManager();
}
return fgLaunchConfigurationManager;
}
/**
* Returns whether the given launch configuraiton should be visible in the
* debug ui. If the config is marked as private, or belongs to a different
* category (i.e. non-null), then this configuration should not be displayed
* in the debug ui.
*
* @param launchConfiguration
* @return boolean
*/
public static boolean isVisible(ILaunchConfiguration launchConfiguration) {
try {
return !(launchConfiguration.getAttribute(IDebugUIConstants.ATTR_PRIVATE, false));
} catch (CoreException e) {
DebugUIPlugin.log(e);
}
return false;
}
/**
* Returns whether the singleton instance of the manager exists
*/
public static boolean defaultExists() {
return fgLaunchConfigurationManager != null;
}
public void shutdown() throws CoreException {
ILaunchManager launchManager= DebugPlugin.getDefault().getLaunchManager();
launchManager.removeLaunchListener(this);
if (fLaunchHistories != null) {
Iterator histories = fLaunchHistories.values().iterator();
while (histories.hasNext()) {
LaunchHistory history = (LaunchHistory)histories.next();
history.dispose();
}
}
}
/**
* @see ILaunchListener#launchRemoved(ILaunch)
*/
public void launchRemoved(ILaunch launch) {
}
/**
* @see ILaunchListener#launchChanged(ILaunch)
*/
public void launchChanged(ILaunch launch) {
}
/**
* Must not assume that will only be called from the UI thread.
*
* @see ILaunchListener#launchAdded(ILaunch)
*/
public void launchAdded(final ILaunch launch) {
removeTerminatedLaunches(launch);
}
protected void removeTerminatedLaunches(ILaunch newLaunch) {
if (DebugUIPlugin.getDefault().getPreferenceStore().getBoolean(IDebugUIConstants.PREF_AUTO_REMOVE_OLD_LAUNCHES)) {
ILaunchManager lManager= DebugPlugin.getDefault().getLaunchManager();
Object[] launches= lManager.getLaunches();
for (int i= 0; i < launches.length; i++) {
ILaunch launch= (ILaunch)launches[i];
if (launch != newLaunch && launch.isTerminated()) {
lManager.removeLaunch(launch);
}
}
}
}
/**
* Returns the most recent launch for the given group, or <code>null</code>
* if none.
*
* @return the last launch, or <code>null</code> if none
*/
public ILaunchConfiguration getLastLaunch(String groupId) {
LaunchHistory history = getLaunchHistory(groupId);
return history.getRecentLaunch();
}
/**
* Add the specified listener to the list of listeners that will be notified when the
* launch history changes.
*/
public void addLaunchHistoryListener(ILaunchHistoryChangedListener listener) {
if (!fLaunchHistoryChangedListeners.contains(listener)) {
fLaunchHistoryChangedListeners.add(listener);
}
}
/**
* Remove the specified listener from the list of listeners that will be notified when the
* launch history changes.
*/
public void removeLaunchHistoryListener(ILaunchHistoryChangedListener listener) {
fLaunchHistoryChangedListeners.remove(listener);
}
/**
* Notify all launch history listeners that the launch history has changed in some way.
*/
protected void fireLaunchHistoryChanged() {
Iterator iterator = fLaunchHistoryChangedListeners.iterator();
while (iterator.hasNext()) {
ILaunchHistoryChangedListener listener = (ILaunchHistoryChangedListener) iterator.next();
listener.launchHistoryChanged();
}
}
protected String getHistoryAsXML() throws IOException, CoreException {
Document doc = new DocumentImpl();
Element historyRootElement = doc.createElement(HISTORY_ROOT_NODE);
doc.appendChild(historyRootElement);
Iterator histories = fLaunchHistories.values().iterator();
while (histories.hasNext()) {
LaunchHistory history = (LaunchHistory)histories.next();
createEntry(doc, historyRootElement, history.getLaunchGroup().getMode(), history.getHistory());
createEntry(doc, historyRootElement, history.getLaunchGroup().getMode(), history.getFavorites());
ILaunchConfiguration configuration = history.getRecentLaunch();
if (configuration != null) {
Element last = doc.createElement(HISTORY_LAST_LAUNCH_NODE);
last.setAttribute(HISTORY_MEMENTO_ATT, configuration.getMemento());
last.setAttribute(HISTORY_MODE_ATT, history.getLaunchGroup().getMode());
historyRootElement.appendChild(last);
}
}
return DebugUIPlugin.serializeDocument(doc);
}
protected void createEntry(Document doc, Element historyRootElement, String mode, ILaunchConfiguration[] configurations) throws CoreException {
for (int i = 0; i < configurations.length; i++) {
ILaunchConfiguration configuration = configurations[i];
Element launch = doc.createElement(HISTORY_LAUNCH_NODE);
launch.setAttribute(HISTORY_MEMENTO_ATT, configuration.getMemento());
launch.setAttribute(HISTORY_MODE_ATT, mode);
historyRootElement.appendChild(launch);
}
}
protected IPath getHistoryFilePath() {
return DebugUIPlugin.getDefault().getStateLocation().append(LAUNCH_CONFIGURATION_HISTORY_FILENAME);
}
/**
* Write out an XML file indicating the entries on the run & debug history lists and
* the most recent launch.
*/
protected void persistLaunchHistory() throws IOException, CoreException {
if (fRestoring) {
return;
}
IPath historyPath = getHistoryFilePath();
String osHistoryPath = historyPath.toOSString();
String xml = getHistoryAsXML();
File file = new File(osHistoryPath);
file.createNewFile();
FileOutputStream stream = new FileOutputStream(file);
stream.write(xml.getBytes("UTF8")); //$NON-NLS-1$
stream.close();
fireLaunchHistoryChanged();
}
/**
* Find the XML history file and parse it. Place the corresponding configs
* in the appropriate history, and set the most recent launch.
*/
private void restoreLaunchHistory() {
// Find the history file
IPath historyPath = getHistoryFilePath();
String osHistoryPath = historyPath.toOSString();
File file = new File(osHistoryPath);
// If no history file, nothing to do
if (!file.exists()) {
return;
}
FileInputStream stream= null;
Element rootHistoryElement= null;
try {
// Parse the history file
stream = new FileInputStream(file);
rootHistoryElement = null;
try {
DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder();
rootHistoryElement = parser.parse(new InputSource(stream)).getDocumentElement();
} catch (SAXException e) {
DebugUIPlugin.log(e);
return;
} catch (ParserConfigurationException e) {
DebugUIPlugin.log(e);
return;
} finally {
stream.close();
}
} catch (IOException exception) {
DebugUIPlugin.log(exception);
return;
}
// If root node isn't what we expect, return
if (!rootHistoryElement.getNodeName().equalsIgnoreCase(HISTORY_ROOT_NODE)) {
return;
}
// For each child of the root node, construct a launch config handle and add it to
// the appropriate history, or set the most recent launch
Collection l = fLaunchHistories.values();
LaunchHistory[] histories = (LaunchHistory[])l.toArray(new LaunchHistory[l.size()]);
NodeList list = rootHistoryElement.getChildNodes();
int length = list.getLength();
for (int i = 0; i < length; ++i) {
Node node = list.item(i);
short type = node.getNodeType();
if (type == Node.ELEMENT_NODE) {
Element entry = (Element) node;
if (entry.getNodeName().equalsIgnoreCase(HISTORY_LAUNCH_NODE)) {
createHistoryElement(entry, histories);
} else if (entry.getNodeName().equalsIgnoreCase(HISTORY_LAST_LAUNCH_NODE)) {
createRecentElement(entry, histories);
}
}
}
}
/**
* Construct a launch configuration corresponding to the specified XML
* element, and place it in the approriate history.
*/
private void createHistoryElement(Element entry, LaunchHistory[] histories) {
String memento = entry.getAttribute(HISTORY_MEMENTO_ATT);
String mode = entry.getAttribute(HISTORY_MODE_ATT);
try {
ILaunchConfiguration launchConfig = DebugPlugin.getDefault().getLaunchManager().getLaunchConfiguration(memento);
if (launchConfig.exists()) {
for (int i = 0; i < histories.length; i++) {
LaunchHistory history = histories[i];
if (history.accepts(launchConfig) && history.getLaunchGroup().getMode().equals(mode)) {
history.addHistory(launchConfig);
}
}
}
} catch (CoreException e) {
DebugUIPlugin.log(e);
}
}
/**
* Construct a launch configuration corresponding to the specified XML
* element, and place it in the approriate history's recent launch
*/
private void createRecentElement(Element entry, LaunchHistory[] histories) {
String memento = entry.getAttribute(HISTORY_MEMENTO_ATT);
String mode = entry.getAttribute(HISTORY_MODE_ATT);
try {
ILaunchConfiguration launchConfig = DebugPlugin.getDefault().getLaunchManager().getLaunchConfiguration(memento);
if (launchConfig.exists()) {
for (int i = 0; i < histories.length; i++) {
LaunchHistory history = histories[i];
if (history.accepts(launchConfig) && history.getLaunchGroup().getMode().equals(mode)) {
history.setRecentLaunch(launchConfig);
}
}
}
} catch (CoreException e) {
DebugUIPlugin.log(e);
}
}
/**
* Load all registered extensions of the 'launch shortcut' extension point.
*/
private void loadLaunchShortcuts() {
// Get the configuration elements
IPluginDescriptor descriptor= DebugUIPlugin.getDefault().getDescriptor();
IExtensionPoint extensionPoint= descriptor.getExtensionPoint(IDebugUIConstants.EXTENSION_POINT_LAUNCH_SHORTCUTS);
IConfigurationElement[] infos= extensionPoint.getConfigurationElements();
// Load the configuration elements into a Map
fLaunchShortcuts = new ArrayList(infos.length);
for (int i = 0; i < infos.length; i++) {
LaunchShortcutExtension ext = new LaunchShortcutExtension(infos[i]);
fLaunchShortcuts.add(ext);
}
}
/**
* Load all registered extensions of the 'launch groups' extension point.
*/
private void loadLaunchGroups() {
if (fLaunchGroups == null) {
// Get the configuration elements
IPluginDescriptor descriptor= DebugUIPlugin.getDefault().getDescriptor();
IExtensionPoint extensionPoint= descriptor.getExtensionPoint(IDebugUIConstants.EXTENSION_POINT_LAUNCH_GROUPS);
IConfigurationElement[] infos= extensionPoint.getConfigurationElements();
// Load the configuration elements into a Map
fLaunchGroups = new HashMap(infos.length);
for (int i = 0; i < infos.length; i++) {
LaunchGroupExtension ext = new LaunchGroupExtension(infos[i]);
fLaunchGroups.put(ext.getIdentifier(), ext);
}
}
}
/**
* Returns all launch shortcuts
*
* @return all launch shortcuts
*/
public List getLaunchShortcuts() {
if (fLaunchShortcuts == null) {
loadLaunchShortcuts();
}
return fLaunchShortcuts;
}
/**
* Returns all launch shortcuts defined for the given perspective,
* or <code>null</code> if none
*
* @param perpsective perspective identifier
* @return all launch shortcuts defined for the given perspective,
* or <code>null</code> if none
*/
public List getLaunchShortcuts(String perpsective) {
if (fLaunchShortcutsByPerspective == null) {
Iterator shortcuts = getLaunchShortcuts().iterator();
fLaunchShortcutsByPerspective = new HashMap(10);
while (shortcuts.hasNext()) {
LaunchShortcutExtension ext = (LaunchShortcutExtension)shortcuts.next();
Iterator perspectives = ext.getPerspectives().iterator();
while (perspectives.hasNext()) {
String id = (String)perspectives.next();
List list = (List)fLaunchShortcutsByPerspective.get(id);
if (list == null) {
list = new ArrayList(4);
fLaunchShortcutsByPerspective.put(id, list);
}
list.add(ext);
}
}
// sort the lists
Iterator perspectives = fLaunchShortcutsByPerspective.keySet().iterator();
while (perspectives.hasNext()) {
String id = (String)perspectives.next();
List list = (List)fLaunchShortcutsByPerspective.get(id);
Collections.sort(list, new ShortcutComparator());
}
}
return (List)fLaunchShortcutsByPerspective.get(perpsective);
}
/**
* Returns the image used to display an error in the given tab
*/
public Image getErrorTabImage(ILaunchConfigurationTab tab) {
if (fErrorImages == null) {
fErrorImages = new ImageRegistry();
}
String key = tab.getClass().getName();
Image image = fErrorImages.get(key);
if (image == null) {
// create image
Image base = tab.getImage();
if (base == null) {
base = DebugPluginImages.getImage(IInternalDebugUIConstants.IMG_OVR_TRANSPARENT);
}
base = new Image(Display.getCurrent(), base, SWT.IMAGE_COPY);
LaunchConfigurationTabImageDescriptor desc = new LaunchConfigurationTabImageDescriptor(base, LaunchConfigurationTabImageDescriptor.ERROR);
image = desc.createImage();
fErrorImages.put(key, image);
}
return image;
}
/**
* Return the launch group with the given id, or <code>null</code>
*
* @return the launch group with the given id, or <code>null</code>
*/
public LaunchGroupExtension getLaunchGroup(String id) {
if (fLaunchGroups == null) {
loadLaunchGroups();
}
return (LaunchGroupExtension)fLaunchGroups.get(id);
}
/**
* Return all defined launch groups
*
* @return all defined launch groups
*/
public LaunchGroupExtension[] getLaunchGroups() {
if (fLaunchGroups == null) {
loadLaunchGroups();
}
Collection groups = fLaunchGroups.values();
return (LaunchGroupExtension[])groups.toArray(new LaunchGroupExtension[groups.size()]);
}
/**
* Return the launch history with the given group id, or <code>null</code>
*
* @return the launch history with the given group id, or <code>null</code>
*/
public LaunchHistory getLaunchHistory(String id) {
if (fLaunchHistories == null) {
loadLaunchHistories();
}
return (LaunchHistory)fLaunchHistories.get(id);
}
/**
* Restore launch history
*/
private void loadLaunchHistories() {
if (fLaunchHistories == null) {
fRestoring = true;
LaunchGroupExtension[] groups = getLaunchGroups();
fLaunchHistories = new HashMap(groups.length);
for (int i = 0; i < groups.length; i++) {
LaunchGroupExtension extension = groups[i];
fLaunchHistories.put(extension.getIdentifier(), new LaunchHistory(extension));
}
restoreLaunchHistory();
fRestoring = false;
}
}
/**
* Returns the default lanuch group for the given mode.
*
* @param mode
* @return launch group
*/
public LaunchGroupExtension getDefaultLanuchGroup(String mode) {
if (mode.equals(ILaunchManager.DEBUG_MODE)) {
return getLaunchGroup(IDebugUIConstants.ID_DEBUG_LAUNCH_GROUP);
} else {
return getLaunchGroup(IDebugUIConstants.ID_RUN_LAUNCH_GROUP);
}
}
}
class ShortcutComparator implements Comparator {
/**
* @see Comparator#compare(Object, Object)
*/
public int compare(Object a, Object b) {
String labelA = ((LaunchShortcutExtension)a).getLabel();
String labelB = ((LaunchShortcutExtension)b).getLabel();
// null labels sort last (i.e. highest)
if (labelA == labelB) {
return 0;
}
if (labelA == null) {
return 1;
}
if (labelB == null) {
return -1;
}
return labelA.compareToIgnoreCase(labelB);
}
}
|