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
|
/*******************************************************************************
* Copyright (c) 2005, 2010 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
* Wind River - Pawel Piech - added an evaluation context source provider (bug 229219)
* Patrick Chuong (Texas Instruments) and Pawel Piech (Wind River) -
* Allow multiple debug views and multiple debug context providers (Bug 327263)
*******************************************************************************/
package org.eclipse.debug.internal.ui.contexts;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.ISafeRunnable;
import org.eclipse.core.runtime.ListenerList;
import org.eclipse.core.runtime.SafeRunner;
import org.eclipse.debug.internal.ui.DebugUIPlugin;
import org.eclipse.debug.ui.contexts.DebugContextEvent;
import org.eclipse.debug.ui.contexts.IDebugContextListener;
import org.eclipse.debug.ui.contexts.IDebugContextProvider;
import org.eclipse.debug.ui.contexts.IDebugContextProvider2;
import org.eclipse.debug.ui.contexts.IDebugContextService;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.ui.IPartListener2;
import org.eclipse.ui.IViewSite;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchPartReference;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.services.IEvaluationService;
/**
* Context service for a specific window.
*
* @since 3.2
*/
public class DebugWindowContextService implements IDebugContextService, IPartListener2, IDebugContextListener {
private Map fListenersByPartId = new HashMap();
private Map fProvidersByPartId = new HashMap();
private Map fPostListenersByPartId = new HashMap();
private IWorkbenchWindow fWindow;
private List fProviders = new ArrayList();
private DebugContextSourceProvider fSourceProvider;
public DebugWindowContextService(IWorkbenchWindow window) {
fWindow = window;
fWindow.getPartService().addPartListener(this);
IEvaluationService evaluationService = (IEvaluationService)window.getService(IEvaluationService.class);
fSourceProvider = new DebugContextSourceProvider(this, evaluationService);
}
public void dispose() {
fSourceProvider.dispose();
fWindow.getPartService().removePartListener(this);
fWindow = null;
}
public synchronized void addDebugContextProvider(IDebugContextProvider provider) {
if (fWindow == null) return; // disposed
IWorkbenchPart part = provider.getPart();
fProvidersByPartId.put( getCombinedPartId(part), provider );
// Check if provider is a window context provider
boolean canSetActive = true;
if (provider instanceof IDebugContextProvider2) {
canSetActive = ((IDebugContextProvider2) provider).isWindowContextProvider();
}
// Make the provider active if matches the active part. Otherwise, it
// may still become the active provider if fProviders.isEmpty().
if (canSetActive) {
IWorkbenchPart activePart = null;
IWorkbenchPage activePage = fWindow.getActivePage();
if (activePage != null) {
activePart = activePage.getActivePart();
}
canSetActive = (activePart == null && part == null) || (activePart != null && activePart.equals(part));
}
if (canSetActive) {
fProviders.add(0, provider);
} else {
fProviders.add(provider);
}
notify(provider);
provider.addDebugContextListener(this);
}
public synchronized void removeDebugContextProvider(IDebugContextProvider provider) {
int index = fProviders.indexOf(provider);
if (index >= 0) {
fProvidersByPartId.remove( getCombinedPartId(provider.getPart()) );
fProviders.remove(index);
IDebugContextProvider activeProvider = getActiveProvider();
if (index == 0) {
if (activeProvider != null) {
notify(activeProvider);
} else {
// Removed last provider. Send empty selection to all listeners.
notify(new DebugContextEvent(provider, StructuredSelection.EMPTY, DebugContextEvent.ACTIVATED));
}
} else {
// Notify listeners of the removed provider with the active window context.
notifyPart(provider.getPart(),
new DebugContextEvent(activeProvider, getActiveContext(), DebugContextEvent.ACTIVATED));
}
}
provider.removeDebugContextListener(this);
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService#addDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener)
*/
public void addDebugContextListener(IDebugContextListener listener) {
addDebugContextListener(listener, null);
}
public void addPostDebugContextListener(IDebugContextListener listener, String partId) {
ListenerList list = (ListenerList) fPostListenersByPartId.get(partId);
if (list == null) {
list = new ListenerList();
fPostListenersByPartId.put(partId, list);
}
list.add(listener);
}
public void addPostDebugContextListener(IDebugContextListener listener) {
addPostDebugContextListener(listener, null);
}
public void removePostDebugContextListener(IDebugContextListener listener, String partId) {
ListenerList list = (ListenerList) fPostListenersByPartId.get(partId);
if (list != null) {
list.remove(listener);
}
}
public void removePostDebugContextListener(IDebugContextListener listener) {
removePostDebugContextListener(listener, null);
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService#removeDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener)
*/
public void removeDebugContextListener(IDebugContextListener listener) {
removeDebugContextListener(listener, null);
}
/**
* Notifies listeners of the context in the specified provider.
*
* @param provdier context provider
*/
protected void notify(IDebugContextProvider provdier) {
ISelection activeContext = provdier.getActiveContext();
if (activeContext == null) {
activeContext = new StructuredSelection();
}
notify(new DebugContextEvent(provdier, activeContext, DebugContextEvent.ACTIVATED));
}
protected void notify(DebugContextEvent event) {
// Allow handling for case where getActiveProvider() == null.
// This can happen upon removeContextProvider() called on last available
// provider (bug 360637).
IDebugContextProvider provider = getActiveProvider();
IWorkbenchPart part = event.getDebugContextProvider().getPart();
// Once for listeners
if (provider == null || provider == event.getDebugContextProvider()) {
notify(event, getListeners(null));
}
if (part != null) {
notify(event, getListeners(part));
}
// Again for post-listeners
if (provider == null || provider == event.getDebugContextProvider()) {
notify(event, getPostListeners(null));
}
if (part != null) {
notify(event, getPostListeners(part));
}
}
protected void notifyPart(IWorkbenchPart part, DebugContextEvent event) {
if (part != null) {
notify(event, getListeners(part));
notify(event, getPostListeners(part));
}
}
protected void notify(final DebugContextEvent event, Object[] listeners) {
for (int i = 0; i < listeners.length; i++) {
final IDebugContextListener listener = (IDebugContextListener) listeners[i];
SafeRunner.run(new ISafeRunnable() {
public void run() throws Exception {
listener.debugContextChanged(event);
}
public void handleException(Throwable exception) {
DebugUIPlugin.log(exception);
}
});
}
}
protected Object[] getListeners(IWorkbenchPart part) {
String id = null;
if (part != null) {
id = getCombinedPartId(part);
ListenerList listenerList = (ListenerList)fListenersByPartId.get(id);
return listenerList != null ? listenerList.getListeners() : new Object[0];
} else {
List retVal = new ArrayList();
retVal.addAll(Arrays.asList(((ListenerList)fListenersByPartId.get(null)).getListeners()) );
outer: for (Iterator itr = fListenersByPartId.keySet().iterator(); itr.hasNext();) {
String listenerPartId = (String)itr.next();
for (int i = 0; i < fProviders.size(); i++) {
String providerPartId = getCombinedPartId(((IDebugContextProvider)fProviders.get(i)).getPart());
if ((listenerPartId == null && providerPartId == null) ||
(listenerPartId != null && listenerPartId.equals(providerPartId)))
{
continue outer;
}
}
List toAdd = Arrays.asList(((ListenerList)fListenersByPartId.get(listenerPartId)).getListeners());
for (Iterator addItr = toAdd.iterator(); addItr.hasNext();) {
Object element = addItr.next();
if (!retVal.contains(element)) retVal.add(element);
}
}
return retVal.toArray();
}
}
protected Object[] getPostListeners(IWorkbenchPart part) {
String id = null;
if (part != null) {
id = getCombinedPartId(part);
ListenerList listenerList = (ListenerList)fPostListenersByPartId.get(id);
return listenerList != null ? listenerList.getListeners() : new Object[0];
} else {
List retVal = new ArrayList();
ListenerList postListenersList = (ListenerList)fPostListenersByPartId.get(null);
if (postListenersList != null) {
retVal.addAll( Arrays.asList(postListenersList.getListeners()) );
}
outer: for (Iterator itr = fPostListenersByPartId.keySet().iterator(); itr.hasNext();) {
String listenerPartId = (String)itr.next();
for (int i = 0; i < fProviders.size(); i++) {
String providerPartId = getCombinedPartId(((IDebugContextProvider)fProviders.get(i)).getPart());
if ((listenerPartId == null && providerPartId == null) ||
(listenerPartId != null && listenerPartId.equals(providerPartId)))
{
continue outer;
}
}
retVal.addAll( Arrays.asList(((ListenerList)fPostListenersByPartId.get(listenerPartId)).getListeners()) );
}
return retVal.toArray();
}
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService#addDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener, java.lang.String)
*/
public synchronized void addDebugContextListener(IDebugContextListener listener, String partId) {
ListenerList list = (ListenerList) fListenersByPartId.get(partId);
if (list == null) {
list = new ListenerList();
fListenersByPartId.put(partId, list);
}
list.add(listener);
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService#removeDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener, java.lang.String)
*/
public void removeDebugContextListener(IDebugContextListener listener, String partId) {
ListenerList list = (ListenerList) fListenersByPartId.get(partId);
if (list != null) {
list.remove(listener);
if (list.size() == 0)
fListenersByPartId.remove(partId);
}
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService#getActiveContext(java.lang.String)
*/
public ISelection getActiveContext(String partId) {
IDebugContextProvider provider = (IDebugContextProvider) fProvidersByPartId.get(partId);
if (provider != null) {
return provider.getActiveContext();
}
return getActiveContext();
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService#getActiveContext()
*/
public ISelection getActiveContext() {
IDebugContextProvider activeProvider = getActiveProvider();
if (activeProvider != null) {
return activeProvider.getActiveContext();
}
return null;
}
/**
* Returns the active provider or <code>null</code>
*
* @return active provider or <code>null</code>
*/
private IDebugContextProvider getActiveProvider() {
if (!fProviders.isEmpty()) {
return (IDebugContextProvider)fProviders.get(0);
}
return null;
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partActivated(org.eclipse.ui.IWorkbenchPartReference)
*/
public void partActivated(IWorkbenchPartReference partRef) {
IDebugContextProvider provider = (IDebugContextProvider) fProvidersByPartId.get(partRef.getId());
if (provider != null) {
boolean canSetActive = true;
if (provider instanceof IDebugContextProvider2) {
canSetActive = ((IDebugContextProvider2) provider).isWindowContextProvider();
}
if (canSetActive) {
int index = fProviders.indexOf(provider);
if (index > 0) {
fProviders.remove(index);
fProviders.add(0, provider);
notify(provider);
}
}
}
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partBroughtToTop(org.eclipse.ui.IWorkbenchPartReference)
*/
public void partBroughtToTop(IWorkbenchPartReference partRef) {
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partClosed(org.eclipse.ui.IWorkbenchPartReference)
*/
public synchronized void partClosed(IWorkbenchPartReference partRef) {
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partDeactivated(org.eclipse.ui.IWorkbenchPartReference)
*/
public void partDeactivated(IWorkbenchPartReference partRef) {
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partOpened(org.eclipse.ui.IWorkbenchPartReference)
*/
public void partOpened(IWorkbenchPartReference partRef) {
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partHidden(org.eclipse.ui.IWorkbenchPartReference)
*/
public void partHidden(IWorkbenchPartReference partRef) {
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partVisible(org.eclipse.ui.IWorkbenchPartReference)
*/
public void partVisible(IWorkbenchPartReference partRef) {
}
/* (non-Javadoc)
* @see org.eclipse.ui.IPartListener2#partInputChanged(org.eclipse.ui.IWorkbenchPartReference)
*/
public void partInputChanged(IWorkbenchPartReference partRef) {
}
/* (non-Javadoc)
* @see org.eclipse.debug.internal.ui.contexts.provisional.IDebugContextEventListener#contextEvent(org.eclipse.debug.internal.ui.contexts.provisional.DebugContextEvent)
*/
public void debugContextChanged(DebugContextEvent event) {
notify(event);
}
private String getCombinedPartId(IWorkbenchPart part) {
if (part == null) {
return null;
} else if (part.getSite() instanceof IViewSite) {
IViewSite site = (IViewSite)part.getSite();
return getCombinedPartId(site.getId(), site.getSecondaryId());
} else {
return part.getSite().getId();
}
}
private String getCombinedPartId(String id, String secondaryId) {
return id + (secondaryId != null ? ":" + secondaryId : ""); //$NON-NLS-1$//$NON-NLS-2$
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService2#addDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener, java.lang.String, java.lang.String)
*/
public void addDebugContextListener(IDebugContextListener listener, String partId, String partSecondaryId) {
addDebugContextListener(listener, getCombinedPartId(partId, partSecondaryId));
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService2#removeDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener, java.lang.String, java.lang.String)
*/
public void removeDebugContextListener(IDebugContextListener listener, String partId, String partSecondaryId) {
removeDebugContextListener(listener, getCombinedPartId(partId, partSecondaryId));
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService2#addPostDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener, java.lang.String, java.lang.String)
*/
public void addPostDebugContextListener(IDebugContextListener listener, String partId, String partSecondaryId) {
addPostDebugContextListener(listener, getCombinedPartId(partId, partSecondaryId));
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService2#removePostDebugContextListener(org.eclipse.debug.ui.contexts.IDebugContextListener, java.lang.String, java.lang.String)
*/
public void removePostDebugContextListener(IDebugContextListener listener, String partId, String partSecondaryId) {
removePostDebugContextListener(listener, getCombinedPartId(partId, partSecondaryId));
}
/* (non-Javadoc)
* @see org.eclipse.debug.ui.contexts.IDebugContextService2#getActiveContext(java.lang.String, java.lang.String)
*/
public ISelection getActiveContext(String partId, String partSecondaryId) {
return getActiveContext(getCombinedPartId(partId, partSecondaryId));
}
}
|
