1 /*******************************************************************************
2 * Copyright (c) 2010 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Patrick Tasse - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.ui
.editors
;
15 import java
.io
.FileNotFoundException
;
16 import java
.lang
.reflect
.Constructor
;
17 import java
.lang
.reflect
.InvocationTargetException
;
18 import java
.util
.List
;
20 import org
.eclipse
.core
.resources
.IMarker
;
21 import org
.eclipse
.core
.resources
.IMarkerDelta
;
22 import org
.eclipse
.core
.resources
.IResource
;
23 import org
.eclipse
.core
.resources
.IResourceChangeEvent
;
24 import org
.eclipse
.core
.resources
.IResourceChangeListener
;
25 import org
.eclipse
.core
.resources
.IResourceDelta
;
26 import org
.eclipse
.core
.resources
.ResourcesPlugin
;
27 import org
.eclipse
.core
.runtime
.CoreException
;
28 import org
.eclipse
.core
.runtime
.IConfigurationElement
;
29 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
30 import org
.eclipse
.core
.runtime
.InvalidRegistryObjectException
;
31 import org
.eclipse
.core
.runtime
.Platform
;
32 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfEvent
;
33 import org
.eclipse
.linuxtools
.tmf
.core
.experiment
.TmfExperiment
;
34 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignalHandler
;
35 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
36 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
37 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.TmfTrace
;
38 import org
.eclipse
.linuxtools
.tmf
.core
.util
.TmfTraceType
;
39 import org
.eclipse
.linuxtools
.tmf
.ui
.parsers
.custom
.CustomEventsTable
;
40 import org
.eclipse
.linuxtools
.tmf
.ui
.parsers
.custom
.CustomTxtTrace
;
41 import org
.eclipse
.linuxtools
.tmf
.ui
.parsers
.custom
.CustomXmlTrace
;
42 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.handlers
.Messages
;
43 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.ITmfProjectModelElement
;
44 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfExperimentElement
;
45 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfNavigatorContentProvider
;
46 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectElement
;
47 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectRegistry
;
48 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTraceElement
;
49 import org
.eclipse
.linuxtools
.tmf
.ui
.signal
.TmfTraceClosedSignal
;
50 import org
.eclipse
.linuxtools
.tmf
.ui
.signal
.TmfTraceOpenedSignal
;
51 import org
.eclipse
.linuxtools
.tmf
.ui
.signal
.TmfTraceParserUpdatedSignal
;
52 import org
.eclipse
.linuxtools
.tmf
.ui
.viewers
.events
.TmfEventsTable
;
53 import org
.eclipse
.swt
.widgets
.Composite
;
54 import org
.eclipse
.swt
.widgets
.Display
;
55 import org
.eclipse
.ui
.IEditorInput
;
56 import org
.eclipse
.ui
.IEditorPart
;
57 import org
.eclipse
.ui
.IEditorSite
;
58 import org
.eclipse
.ui
.IFileEditorInput
;
59 import org
.eclipse
.ui
.IPropertyListener
;
60 import org
.eclipse
.ui
.IReusableEditor
;
61 import org
.eclipse
.ui
.PartInitException
;
62 import org
.eclipse
.ui
.ide
.IGotoMarker
;
63 import org
.osgi
.framework
.Bundle
;
66 * <b><u>TmfEventsEditor</u></b>
68 public class TmfEventsEditor
extends TmfEditor
implements ITmfTraceEditor
, IReusableEditor
, IPropertyListener
, IResourceChangeListener
{
70 public static final String ID
= "org.eclipse.linuxtools.tmf.ui.editors.events"; //$NON-NLS-1$
72 private TmfEventsTable fEventsTable
;
73 private IResource fResource
;
74 @SuppressWarnings("rawtypes")
75 private ITmfTrace fTrace
;
76 private Composite fParent
;
79 public void doSave(IProgressMonitor monitor
) {
83 public void doSaveAs() {
86 @SuppressWarnings({ "unchecked", "rawtypes" })
88 public void init(IEditorSite site
, IEditorInput input
) throws PartInitException
{
89 if (input
instanceof TmfEditorInput
) {
90 fResource
= ((TmfEditorInput
) input
).getResource();
91 fTrace
= ((TmfEditorInput
) input
).getTrace();
92 } else if (input
instanceof IFileEditorInput
) {
93 fResource
= ((IFileEditorInput
) input
).getFile();
94 if (fResource
== null) {
95 throw new PartInitException("Invalid IFileEditorInput: " + input
); //$NON-NLS-1$
98 String traceTypeId
= fResource
.getPersistentProperty(TmfTraceElement
.TRACETYPE
);
99 if (traceTypeId
== null) {
100 throw new PartInitException(Messages
.OpenTraceHandler_NoTraceType
);
102 if (traceTypeId
.equals(TmfExperiment
.class.getCanonicalName())) {
103 // Special case: experiment bookmark resource
104 TmfNavigatorContentProvider ncp
= new TmfNavigatorContentProvider();
105 ncp
.getChildren(fResource
.getProject()); // force the model to be populated
106 TmfProjectElement project
= TmfProjectRegistry
.getProject(fResource
.getProject());
107 if (project
== null) {
108 throw new PartInitException(Messages
.OpenExperimentHandler_NoTraceType
);
110 for (ITmfProjectModelElement projectElement
: project
.getExperimentsFolder().getChildren()) {
111 String traceName
= fResource
.getParent().getName();
112 if (projectElement
.getName().equals(traceName
)) {
113 TmfExperimentElement experimentElement
= (TmfExperimentElement
) projectElement
;
114 // Instantiate the experiment's traces
115 List
<TmfTraceElement
> traceEntries
= experimentElement
.getTraces();
116 int nbTraces
= traceEntries
.size();
117 int cacheSize
= Integer
.MAX_VALUE
;
118 ITmfTrace
<?
>[] traces
= new ITmfTrace
[nbTraces
];
119 for (int i
= 0; i
< nbTraces
; i
++) {
120 TmfTraceElement traceElement
= traceEntries
.get(i
);
121 ITmfTrace trace
= traceElement
.instantiateTrace();
122 TmfEvent traceEvent
= traceElement
.instantiateEvent();
123 if (trace
== null || traceEvent
== null) {
124 for (int j
= 0; j
< i
; j
++) {
127 throw new PartInitException(Messages
.OpenExperimentHandler_NoTraceType
);
130 trace
.initTrace(traceElement
.getName(), traceElement
.getLocation().getPath(), traceEvent
.getClass(), false);
131 } catch (FileNotFoundException e
) {
133 if (trace
instanceof TmfTrace
) {
134 ((TmfTrace
) trace
).setResource(traceElement
.getResource());
136 cacheSize
= Math
.min(cacheSize
, trace
.getCacheSize());
139 TmfExperiment experiment
= new TmfExperiment(TmfEvent
.class, experimentElement
.getName(), traces
, cacheSize
);
140 experiment
.setResource(fResource
);
142 experiment
.initTrace(null, null, null, true);
146 } else if (traceTypeId
.equals(TmfTrace
.class.getCanonicalName())) {
147 // Special case: trace bookmark resource
148 TmfNavigatorContentProvider ncp
= new TmfNavigatorContentProvider();
149 ncp
.getChildren(fResource
.getProject()); // force the model to be populated
150 TmfProjectElement project
= TmfProjectRegistry
.getProject(fResource
.getProject());
151 for (ITmfProjectModelElement projectElement
: project
.getTracesFolder().getChildren()) {
152 String traceName
= fResource
.getParent().getName();
153 if (projectElement
.getName().equals(traceName
)) {
154 TmfTraceElement traceElement
= (TmfTraceElement
) projectElement
;
155 // Instantiate the trace
156 ITmfTrace trace
= traceElement
.instantiateTrace();
157 TmfEvent traceEvent
= traceElement
.instantiateEvent();
158 if (trace
== null || traceEvent
== null) {
159 throw new PartInitException(Messages
.OpenTraceHandler_NoTraceType
);
162 trace
.initTrace(traceElement
.getName(), traceElement
.getLocation().getPath(), traceEvent
.getClass(), true);
163 } catch (FileNotFoundException e
) {
165 if (trace
instanceof TmfTrace
) {
166 ((TmfTrace
) trace
).setResource(traceElement
.getResource());
173 TmfNavigatorContentProvider ncp
= new TmfNavigatorContentProvider();
174 ncp
.getChildren(fResource
.getProject()); // force the model to be populated
175 TmfProjectElement project
= TmfProjectRegistry
.getProject(fResource
.getProject());
176 for (ITmfProjectModelElement projectElement
: project
.getTracesFolder().getChildren()) {
177 if (projectElement
.getResource().equals(fResource
)) {
178 TmfTraceElement traceElement
= (TmfTraceElement
) projectElement
;
179 // Instantiate the trace
180 ITmfTrace trace
= traceElement
.instantiateTrace();
181 TmfEvent traceEvent
= traceElement
.instantiateEvent();
182 if (trace
== null || traceEvent
== null) {
183 throw new PartInitException(Messages
.OpenTraceHandler_NoTraceType
);
186 trace
.initTrace(traceElement
.getName(), traceElement
.getLocation().getPath(), traceEvent
.getClass(), true);
187 } catch (FileNotFoundException e
) {
189 if (trace
instanceof TmfTrace
) {
190 ((TmfTrace
) trace
).setResource(traceElement
.getResource());
197 } catch (InvalidRegistryObjectException e
) {
199 } catch (PartInitException e
) {
201 } catch (CoreException e
) {
204 input
= new TmfEditorInput(fResource
, fTrace
);
206 throw new PartInitException("Invalid IEditorInput: " + input
.getClass()); //$NON-NLS-1$
208 if (fTrace
== null) {
209 throw new PartInitException("Invalid IEditorInput: " + fResource
.getName()); //$NON-NLS-1$
212 super.setInput(input
);
216 public boolean isDirty() {
221 public boolean isSaveAsAllowed() {
226 public void setInput(IEditorInput input
) {
227 super.setInput(input
);
228 firePropertyChange(IEditorPart
.PROP_INPUT
);
232 public void propertyChanged(Object source
, int propId
) {
233 if (propId
== IEditorPart
.PROP_INPUT
) {
234 broadcast(new TmfTraceClosedSignal(this, fTrace
));
235 fResource
= ((TmfEditorInput
) getEditorInput()).getResource();
236 fTrace
= ((TmfEditorInput
) getEditorInput()).getTrace();
237 fEventsTable
.dispose();
238 if (fTrace
!= null) {
239 fEventsTable
= createEventsTable(fParent
, fTrace
.getCacheSize());
240 fEventsTable
.setTrace(fTrace
, true);
241 fEventsTable
.refreshBookmarks(fResource
);
242 broadcast(new TmfTraceOpenedSignal(this, fTrace
, fResource
, fEventsTable
));
244 fEventsTable
= new TmfEventsTable(fParent
, 0);
251 public void createPartControl(Composite parent
) {
253 setPartName(getEditorInput().getName());
254 if (fTrace
!= null) {
255 fEventsTable
= createEventsTable(parent
, fTrace
.getCacheSize());
256 fEventsTable
.setTrace(fTrace
, true);
257 fEventsTable
.refreshBookmarks(fResource
);
258 broadcast(new TmfTraceOpenedSignal(this, fTrace
, fResource
, fEventsTable
));
260 fEventsTable
= new TmfEventsTable(parent
, 0);
262 addPropertyListener(this);
263 ResourcesPlugin
.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent
.POST_CHANGE
);
267 public void dispose() {
268 ResourcesPlugin
.getWorkspace().removeResourceChangeListener(this);
269 removePropertyListener(this);
270 if (fTrace
!= null) {
271 broadcast(new TmfTraceClosedSignal(this, fTrace
));
273 if (fEventsTable
!= null) {
274 fEventsTable
.dispose();
279 protected TmfEventsTable
createEventsTable(Composite parent
, int cacheSize
) {
280 TmfEventsTable eventsTable
= getEventsTable(parent
, cacheSize
);
281 if (eventsTable
== null) {
282 eventsTable
= new TmfEventsTable(parent
, cacheSize
);
287 private TmfEventsTable
getEventsTable(Composite parent
, int cacheSize
) {
288 if (fTrace
instanceof TmfExperiment
) {
289 return getExperimentEventsTable((TmfExperiment
<?
>) fTrace
, parent
, cacheSize
);
291 TmfEventsTable eventsTable
= null;
293 String traceType
= fResource
.getPersistentProperty(TmfTraceElement
.TRACETYPE
);
294 if (traceType
.startsWith(CustomTxtTrace
.class.getCanonicalName())) {
295 return new CustomEventsTable(((CustomTxtTrace
) fTrace
).getDefinition(), parent
, cacheSize
);
297 if (traceType
.startsWith(CustomXmlTrace
.class.getCanonicalName())) {
298 return new CustomEventsTable(((CustomXmlTrace
) fTrace
).getDefinition(), parent
, cacheSize
);
300 for (IConfigurationElement ce
: TmfTraceType
.getTypeElements()) {
301 if (ce
.getAttribute(TmfTraceType
.ID_ATTR
).equals(traceType
)) {
302 IConfigurationElement
[] eventsTableTypeCE
= ce
.getChildren(TmfTraceType
.EVENTS_TABLE_TYPE_ELEM
);
303 if (eventsTableTypeCE
.length
!= 1) {
306 String eventsTableType
= eventsTableTypeCE
[0].getAttribute(TmfTraceType
.CLASS_ATTR
);
307 if (eventsTableType
== null || eventsTableType
.length() == 0) {
310 Bundle bundle
= Platform
.getBundle(ce
.getContributor().getName());
311 Class
<?
> c
= bundle
.loadClass(eventsTableType
);
312 Class
<?
>[] constructorArgs
= new Class
[] { Composite
.class, int.class };
313 Constructor
<?
> constructor
= c
.getConstructor(constructorArgs
);
314 Object
[] args
= new Object
[] { parent
, cacheSize
};
315 eventsTable
= (TmfEventsTable
) constructor
.newInstance(args
);
319 } catch (InvalidRegistryObjectException e
) {
321 } catch (CoreException e
) {
323 } catch (ClassNotFoundException e
) {
325 } catch (SecurityException e
) {
327 } catch (NoSuchMethodException e
) {
329 } catch (IllegalArgumentException e
) {
331 } catch (InstantiationException e
) {
333 } catch (IllegalAccessException e
) {
335 } catch (InvocationTargetException e
) {
342 * Get the events table for an experiment.
343 * If all traces in the experiment are of the same type,
344 * use the extension point specified event table
345 * @param experiment the experiment
346 * @param parent the parent Composite
347 * @param cacheSize the event table cache size
348 * @return an events table of the appropriate type
350 private TmfEventsTable
getExperimentEventsTable(TmfExperiment
<?
> experiment
, Composite parent
, int cacheSize
) {
351 TmfEventsTable eventsTable
= null;
352 String commonTraceType
= null;
354 for (ITmfTrace
<?
> trace
: experiment
.getTraces()) {
355 IResource resource
= null;
356 if (trace
instanceof TmfTrace
) {
357 resource
= ((TmfTrace
<?
>) trace
).getResource();
359 if (resource
== null) {
362 String traceType
= resource
.getPersistentProperty(TmfTraceElement
.TRACETYPE
);
363 if (commonTraceType
!= null && !commonTraceType
.equals(traceType
)) {
366 commonTraceType
= traceType
;
368 if (commonTraceType
== null) {
371 if (commonTraceType
.startsWith(CustomTxtTrace
.class.getCanonicalName())) {
372 return new CustomEventsTable(((CustomTxtTrace
) experiment
.getTraces()[0]).getDefinition(), parent
, cacheSize
);
374 if (commonTraceType
.startsWith(CustomXmlTrace
.class.getCanonicalName())) {
375 return new CustomEventsTable(((CustomXmlTrace
) experiment
.getTraces()[0]).getDefinition(), parent
, cacheSize
);
377 for (IConfigurationElement ce
: TmfTraceType
.getTypeElements()) {
378 if (ce
.getAttribute(TmfTraceType
.ID_ATTR
).equals(commonTraceType
)) {
379 IConfigurationElement
[] eventsTableTypeCE
= ce
.getChildren(TmfTraceType
.EVENTS_TABLE_TYPE_ELEM
);
380 if (eventsTableTypeCE
.length
!= 1) {
383 String eventsTableType
= eventsTableTypeCE
[0].getAttribute(TmfTraceType
.CLASS_ATTR
);
384 if (eventsTableType
== null || eventsTableType
.length() == 0) {
387 Bundle bundle
= Platform
.getBundle(ce
.getContributor().getName());
388 Class
<?
> c
= bundle
.loadClass(eventsTableType
);
389 Class
<?
>[] constructorArgs
= new Class
[] { Composite
.class, int.class };
390 Constructor
<?
> constructor
= c
.getConstructor(constructorArgs
);
391 Object
[] args
= new Object
[] { parent
, cacheSize
};
392 eventsTable
= (TmfEventsTable
) constructor
.newInstance(args
);
396 } catch (CoreException e
) {
398 } catch (InvalidRegistryObjectException e
) {
400 } catch (SecurityException e
) {
402 } catch (IllegalArgumentException e
) {
404 } catch (ClassNotFoundException e
) {
406 } catch (NoSuchMethodException e
) {
408 } catch (InstantiationException e
) {
410 } catch (IllegalAccessException e
) {
412 } catch (InvocationTargetException e
) {
419 public ITmfTrace
<?
> getTrace() {
424 public IResource
getResource() {
429 public void setFocus() {
430 fEventsTable
.setFocus();
431 if (fTrace
!= null) {
432 broadcast(new TmfTraceSelectedSignal(this, fTrace
));
437 @SuppressWarnings("rawtypes")
438 public Object
getAdapter(Class adapter
) {
439 if (IGotoMarker
.class.equals(adapter
)) {
442 return super.getAdapter(adapter
);
446 public void resourceChanged(IResourceChangeEvent event
) {
447 for (IMarkerDelta delta
: event
.findMarkerDeltas(IMarker
.BOOKMARK
, false)) {
448 if (delta
.getResource().equals(fResource
)) {
449 if (delta
.getKind() == IResourceDelta
.REMOVED
) {
450 final IMarker bookmark
= delta
.getMarker();
451 Display
.getDefault().asyncExec(new Runnable() {
454 fEventsTable
.removeBookmark(bookmark
);
457 } else if (delta
.getKind() == IResourceDelta
.CHANGED
) {
458 Display
.getDefault().asyncExec(new Runnable() {
461 fEventsTable
.getTable().refresh();
469 // ------------------------------------------------------------------------
471 // ------------------------------------------------------------------------
473 public void addBookmark() {
474 fEventsTable
.addBookmark(fResource
);
478 // ------------------------------------------------------------------------
480 // ------------------------------------------------------------------------
482 @SuppressWarnings("unchecked")
484 public void traceParserUpdated(TmfTraceParserUpdatedSignal signal
) {
485 if (signal
.getTraceResource().equals(fResource
)) {
486 broadcast(new TmfTraceClosedSignal(this, fTrace
));
488 String name
= fTrace
.getName();
490 String traceTypeId
= fResource
.getPersistentProperty(TmfTraceElement
.TRACETYPE
);
491 if (traceTypeId
!= null) {
492 for (IConfigurationElement ce
: TmfTraceType
.getTypeElements()) {
493 if (traceTypeId
.equals(ce
.getAttribute(TmfTraceType
.ID_ATTR
))) {
494 fTrace
= (ITmfTrace
<?
>) ce
.createExecutableExtension(TmfTraceType
.TRACE_TYPE_ATTR
);
495 TmfEvent event
= (TmfEvent
) ce
.createExecutableExtension(TmfTraceType
.EVENT_TYPE_ATTR
);
496 String path
= fResource
.getLocationURI().getPath();
497 fTrace
.initTrace(name
, path
, event
.getClass(), true);
502 } catch (InvalidRegistryObjectException e
) {
504 } catch (FileNotFoundException e
) {
506 } catch (CoreException e
) {
509 fEventsTable
.dispose();
510 if (fTrace
!= null) {
511 fEventsTable
= createEventsTable(fParent
, fTrace
.getCacheSize());
512 fEventsTable
.setTrace(fTrace
, true);
513 broadcast(new TmfTraceOpenedSignal(this, fTrace
, fResource
, fEventsTable
));
515 fEventsTable
= new TmfEventsTable(fParent
, 0);
522 public void traceSelected(TmfTraceSelectedSignal signal
) {
523 if (signal
.getSource() != this && signal
.getTrace().equals(fTrace
)) {
524 getSite().getPage().bringToTop(this);