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
.IFile
;
21 import org
.eclipse
.core
.resources
.IMarker
;
22 import org
.eclipse
.core
.resources
.IMarkerDelta
;
23 import org
.eclipse
.core
.resources
.IResource
;
24 import org
.eclipse
.core
.resources
.IResourceChangeEvent
;
25 import org
.eclipse
.core
.resources
.IResourceChangeListener
;
26 import org
.eclipse
.core
.resources
.IResourceDelta
;
27 import org
.eclipse
.core
.resources
.ResourcesPlugin
;
28 import org
.eclipse
.core
.runtime
.CoreException
;
29 import org
.eclipse
.core
.runtime
.IConfigurationElement
;
30 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
31 import org
.eclipse
.core
.runtime
.InvalidRegistryObjectException
;
32 import org
.eclipse
.core
.runtime
.Platform
;
33 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.parsers
.custom
.CustomEventsTable
;
34 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.parsers
.custom
.CustomTxtTrace
;
35 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.parsers
.custom
.CustomXmlTrace
;
36 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.project
.handlers
.Messages
;
37 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
38 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfEvent
;
39 import org
.eclipse
.linuxtools
.tmf
.core
.experiment
.TmfExperiment
;
40 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignalHandler
;
41 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
42 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
43 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.TmfTrace
;
44 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.ITmfProjectModelElement
;
45 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfExperimentElement
;
46 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfNavigatorContentProvider
;
47 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectElement
;
48 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectRegistry
;
49 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTraceElement
;
50 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTraceType
;
51 import org
.eclipse
.linuxtools
.tmf
.ui
.signal
.TmfTraceClosedSignal
;
52 import org
.eclipse
.linuxtools
.tmf
.ui
.signal
.TmfTraceOpenedSignal
;
53 import org
.eclipse
.linuxtools
.tmf
.ui
.signal
.TmfTraceParserUpdatedSignal
;
54 import org
.eclipse
.linuxtools
.tmf
.ui
.viewers
.events
.TmfEventsTable
;
55 import org
.eclipse
.swt
.widgets
.Composite
;
56 import org
.eclipse
.swt
.widgets
.Display
;
57 import org
.eclipse
.ui
.IEditorInput
;
58 import org
.eclipse
.ui
.IEditorPart
;
59 import org
.eclipse
.ui
.IEditorSite
;
60 import org
.eclipse
.ui
.IFileEditorInput
;
61 import org
.eclipse
.ui
.IPropertyListener
;
62 import org
.eclipse
.ui
.IReusableEditor
;
63 import org
.eclipse
.ui
.PartInitException
;
64 import org
.eclipse
.ui
.ide
.IGotoMarker
;
65 import org
.eclipse
.ui
.part
.FileEditorInput
;
66 import org
.osgi
.framework
.Bundle
;
69 * <b><u>TmfEventsEditor</u></b>
71 public class TmfEventsEditor
extends TmfEditor
implements ITmfTraceEditor
, IReusableEditor
, IPropertyListener
, IResourceChangeListener
{
73 public static final String ID
= "org.eclipse.linuxtools.tmf.ui.editors.events"; //$NON-NLS-1$
75 private TmfEventsTable fEventsTable
;
77 @SuppressWarnings("rawtypes")
78 private ITmfTrace fTrace
;
79 private Composite fParent
;
82 public void doSave(final IProgressMonitor monitor
) {
86 public void doSaveAs() {
89 @SuppressWarnings({ "unchecked", "rawtypes" })
91 public void init(final IEditorSite site
, IEditorInput input
) throws PartInitException
{
92 if (input
instanceof TmfEditorInput
) {
93 fFile
= ((TmfEditorInput
) input
).getFile();
94 fTrace
= ((TmfEditorInput
) input
).getTrace();
95 input
= new FileEditorInput(fFile
);
96 } else if (input
instanceof IFileEditorInput
) {
97 fFile
= ((IFileEditorInput
) input
).getFile();
99 throw new PartInitException("Invalid IFileEditorInput: " + input
); //$NON-NLS-1$
101 final String traceTypeId
= fFile
.getPersistentProperty(TmfTraceElement
.TRACETYPE
);
102 if (traceTypeId
== null)
103 throw new PartInitException(Messages
.OpenTraceHandler_NoTraceType
);
104 if (traceTypeId
.equals(TmfExperiment
.class.getCanonicalName())) {
105 // Special case: experiment bookmark resource
106 final TmfNavigatorContentProvider ncp
= new TmfNavigatorContentProvider();
107 ncp
.getChildren(fFile
.getProject()); // force the model to be populated
108 final TmfProjectElement project
= TmfProjectRegistry
.getProject(fFile
.getProject());
110 throw new PartInitException(Messages
.OpenExperimentHandler_NoTraceType
);
111 for (final ITmfProjectModelElement projectElement
: project
.getExperimentsFolder().getChildren()) {
112 final String traceName
= fFile
.getParent().getName();
113 if (projectElement
.getName().equals(traceName
)) {
114 final TmfExperimentElement experimentElement
= (TmfExperimentElement
) projectElement
;
115 // Instantiate the experiment's traces
116 final List
<TmfTraceElement
> traceEntries
= experimentElement
.getTraces();
117 final int nbTraces
= traceEntries
.size();
118 int cacheSize
= Integer
.MAX_VALUE
;
119 final ITmfTrace
<?
>[] traces
= new ITmfTrace
[nbTraces
];
120 for (int i
= 0; i
< nbTraces
; i
++) {
121 final TmfTraceElement traceElement
= traceEntries
.get(i
);
122 final ITmfTrace trace
= traceElement
.instantiateTrace();
123 final ITmfEvent traceEvent
= traceElement
.instantiateEvent();
124 if ((trace
== null) || (traceEvent
== null)) {
125 for (int j
= 0; j
< i
; j
++)
127 throw new PartInitException(Messages
.OpenExperimentHandler_NoTraceType
);
130 trace
.initTrace(traceElement
.getResource(), traceElement
.getLocation().getPath(), traceEvent
.getClass());
131 } catch (final FileNotFoundException e
) {
133 cacheSize
= Math
.min(cacheSize
, trace
.getCacheSize());
136 final TmfExperiment experiment
= new TmfExperiment(TmfEvent
.class, experimentElement
.getName(), traces
, cacheSize
);
137 experiment
.setBookmarksFile(fFile
);
139 experiment
.initTrace(null, null, null);
143 } else if (traceTypeId
.equals(TmfTrace
.class.getCanonicalName())) {
144 // Special case: trace bookmark resource
145 final TmfNavigatorContentProvider ncp
= new TmfNavigatorContentProvider();
146 ncp
.getChildren(fFile
.getProject()); // force the model to be populated
147 final TmfProjectElement project
= TmfProjectRegistry
.getProject(fFile
.getProject());
148 for (final ITmfProjectModelElement projectElement
: project
.getTracesFolder().getChildren()) {
149 final String traceName
= fFile
.getParent().getName();
150 if (projectElement
.getName().equals(traceName
)) {
151 final TmfTraceElement traceElement
= (TmfTraceElement
) projectElement
;
152 // Instantiate the trace
153 final ITmfTrace trace
= traceElement
.instantiateTrace();
154 final ITmfEvent traceEvent
= traceElement
.instantiateEvent();
155 if ((trace
== null) || (traceEvent
== null))
156 throw new PartInitException(Messages
.OpenTraceHandler_NoTraceType
);
158 trace
.initTrace(traceElement
.getResource(), traceElement
.getLocation().getPath(), traceEvent
.getClass());
159 } catch (final FileNotFoundException e
) {
166 final TmfNavigatorContentProvider ncp
= new TmfNavigatorContentProvider();
167 ncp
.getChildren(fFile
.getProject()); // force the model to be populated
168 final TmfProjectElement project
= TmfProjectRegistry
.getProject(fFile
.getProject());
169 for (final ITmfProjectModelElement projectElement
: project
.getTracesFolder().getChildren())
170 if (projectElement
.getResource().equals(fFile
)) {
171 final TmfTraceElement traceElement
= (TmfTraceElement
) projectElement
;
172 // Instantiate the trace
173 final ITmfTrace trace
= traceElement
.instantiateTrace();
174 final ITmfEvent traceEvent
= traceElement
.instantiateEvent();
175 if ((trace
== null) || (traceEvent
== null))
176 throw new PartInitException(Messages
.OpenTraceHandler_NoTraceType
);
178 trace
.initTrace(traceElement
.getResource(), traceElement
.getLocation().getPath(), traceEvent
.getClass());
179 } catch (final FileNotFoundException e
) {
185 } catch (final InvalidRegistryObjectException e
) {
187 } catch (final PartInitException e
) {
189 } catch (final CoreException e
) {
193 throw new PartInitException("Invalid IEditorInput: " + input
.getClass()); //$NON-NLS-1$
195 throw new PartInitException("Invalid IEditorInput: " + fFile
.getName()); //$NON-NLS-1$
197 super.setInput(input
);
201 public boolean isDirty() {
206 public boolean isSaveAsAllowed() {
211 public void setInput(final IEditorInput input
) {
212 super.setInput(input
);
213 firePropertyChange(IEditorPart
.PROP_INPUT
);
217 public void propertyChanged(final Object source
, final int propId
) {
218 if (propId
== IEditorPart
.PROP_INPUT
) {
219 broadcast(new TmfTraceClosedSignal(this, fTrace
));
220 fFile
= ((TmfEditorInput
) getEditorInput()).getFile();
221 fTrace
= ((TmfEditorInput
) getEditorInput()).getTrace();
222 super.setInput(new FileEditorInput(fFile
));
223 fEventsTable
.dispose();
224 if (fTrace
!= null) {
225 fEventsTable
= createEventsTable(fParent
, fTrace
.getCacheSize());
226 fEventsTable
.setTrace(fTrace
, true);
227 fEventsTable
.refreshBookmarks(fFile
);
228 broadcast(new TmfTraceOpenedSignal(this, fTrace
, fFile
, fEventsTable
));
230 fEventsTable
= new TmfEventsTable(fParent
, 0);
236 public void createPartControl(final Composite parent
) {
238 if (fTrace
!= null) {
239 setPartName(fTrace
.getName());
240 fEventsTable
= createEventsTable(parent
, fTrace
.getCacheSize());
241 fEventsTable
.setTrace(fTrace
, true);
242 fEventsTable
.refreshBookmarks(fFile
);
243 broadcast(new TmfTraceOpenedSignal(this, fTrace
, fFile
, fEventsTable
));
245 setPartName(getEditorInput().getName());
246 fEventsTable
= new TmfEventsTable(parent
, 0);
248 addPropertyListener(this);
249 ResourcesPlugin
.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent
.POST_CHANGE
);
253 public void dispose() {
254 ResourcesPlugin
.getWorkspace().removeResourceChangeListener(this);
255 removePropertyListener(this);
257 broadcast(new TmfTraceClosedSignal(this, fTrace
));
258 if (fEventsTable
!= null)
259 fEventsTable
.dispose();
263 protected TmfEventsTable
createEventsTable(final Composite parent
, final int cacheSize
) {
264 TmfEventsTable eventsTable
= getEventsTable(parent
, cacheSize
);
265 if (eventsTable
== null)
266 eventsTable
= new TmfEventsTable(parent
, cacheSize
);
270 private TmfEventsTable
getEventsTable(final Composite parent
, final int cacheSize
) {
271 if (fTrace
instanceof TmfExperiment
)
272 return getExperimentEventsTable((TmfExperiment
<?
>) fTrace
, parent
, cacheSize
);
273 TmfEventsTable eventsTable
= null;
275 if (fTrace
.getResource() == null)
277 final String traceType
= fTrace
.getResource().getPersistentProperty(TmfTraceElement
.TRACETYPE
);
278 if (traceType
== null)
280 if (traceType
.startsWith(CustomTxtTrace
.class.getCanonicalName()))
281 return new CustomEventsTable(((CustomTxtTrace
) fTrace
).getDefinition(), parent
, cacheSize
);
282 if (traceType
.startsWith(CustomXmlTrace
.class.getCanonicalName()))
283 return new CustomEventsTable(((CustomXmlTrace
) fTrace
).getDefinition(), parent
, cacheSize
);
284 for (final IConfigurationElement ce
: TmfTraceType
.getTypeElements())
285 if (ce
.getAttribute(TmfTraceType
.ID_ATTR
).equals(traceType
)) {
286 final IConfigurationElement
[] eventsTableTypeCE
= ce
.getChildren(TmfTraceType
.EVENTS_TABLE_TYPE_ELEM
);
287 if (eventsTableTypeCE
.length
!= 1)
289 final String eventsTableType
= eventsTableTypeCE
[0].getAttribute(TmfTraceType
.CLASS_ATTR
);
290 if ((eventsTableType
== null) || (eventsTableType
.length() == 0))
292 final Bundle bundle
= Platform
.getBundle(ce
.getContributor().getName());
293 final Class
<?
> c
= bundle
.loadClass(eventsTableType
);
294 final Class
<?
>[] constructorArgs
= new Class
[] { Composite
.class, int.class };
295 final Constructor
<?
> constructor
= c
.getConstructor(constructorArgs
);
296 final Object
[] args
= new Object
[] { parent
, cacheSize
};
297 eventsTable
= (TmfEventsTable
) constructor
.newInstance(args
);
300 } catch (final InvalidRegistryObjectException e
) {
302 } catch (final CoreException e
) {
304 } catch (final ClassNotFoundException e
) {
306 } catch (final SecurityException e
) {
308 } catch (final NoSuchMethodException e
) {
310 } catch (final IllegalArgumentException e
) {
312 } catch (final InstantiationException e
) {
314 } catch (final IllegalAccessException e
) {
316 } catch (final InvocationTargetException e
) {
323 * Get the events table for an experiment.
324 * If all traces in the experiment are of the same type,
325 * use the extension point specified event table
326 * @param experiment the experiment
327 * @param parent the parent Composite
328 * @param cacheSize the event table cache size
329 * @return an events table of the appropriate type
331 private TmfEventsTable
getExperimentEventsTable(final TmfExperiment
<?
> experiment
, final Composite parent
, final int cacheSize
) {
332 TmfEventsTable eventsTable
= null;
333 String commonTraceType
= null;
335 for (final ITmfTrace
<?
> trace
: experiment
.getTraces()) {
336 final IResource resource
= trace
.getResource();
337 if (resource
== null)
339 final String traceType
= resource
.getPersistentProperty(TmfTraceElement
.TRACETYPE
);
340 if ((commonTraceType
!= null) && !commonTraceType
.equals(traceType
))
342 commonTraceType
= traceType
;
344 if (commonTraceType
== null)
346 if (commonTraceType
.startsWith(CustomTxtTrace
.class.getCanonicalName()))
347 return new CustomEventsTable(((CustomTxtTrace
) experiment
.getTraces()[0]).getDefinition(), parent
, cacheSize
);
348 if (commonTraceType
.startsWith(CustomXmlTrace
.class.getCanonicalName()))
349 return new CustomEventsTable(((CustomXmlTrace
) experiment
.getTraces()[0]).getDefinition(), parent
, cacheSize
);
350 for (final IConfigurationElement ce
: TmfTraceType
.getTypeElements())
351 if (ce
.getAttribute(TmfTraceType
.ID_ATTR
).equals(commonTraceType
)) {
352 final IConfigurationElement
[] eventsTableTypeCE
= ce
.getChildren(TmfTraceType
.EVENTS_TABLE_TYPE_ELEM
);
353 if (eventsTableTypeCE
.length
!= 1)
355 final String eventsTableType
= eventsTableTypeCE
[0].getAttribute(TmfTraceType
.CLASS_ATTR
);
356 if ((eventsTableType
== null) || (eventsTableType
.length() == 0))
358 final Bundle bundle
= Platform
.getBundle(ce
.getContributor().getName());
359 final Class
<?
> c
= bundle
.loadClass(eventsTableType
);
360 final Class
<?
>[] constructorArgs
= new Class
[] { Composite
.class, int.class };
361 final Constructor
<?
> constructor
= c
.getConstructor(constructorArgs
);
362 final Object
[] args
= new Object
[] { parent
, cacheSize
};
363 eventsTable
= (TmfEventsTable
) constructor
.newInstance(args
);
366 } catch (final CoreException e
) {
368 } catch (final InvalidRegistryObjectException e
) {
370 } catch (final SecurityException e
) {
372 } catch (final IllegalArgumentException e
) {
374 } catch (final ClassNotFoundException e
) {
376 } catch (final NoSuchMethodException e
) {
378 } catch (final InstantiationException e
) {
380 } catch (final IllegalAccessException e
) {
382 } catch (final InvocationTargetException e
) {
389 public ITmfTrace
<?
> getTrace() {
394 public IFile
getBookmarksFile() {
399 public void setFocus() {
400 fEventsTable
.setFocus();
402 broadcast(new TmfTraceSelectedSignal(this, fTrace
));
406 @SuppressWarnings("rawtypes")
407 public Object
getAdapter(final Class adapter
) {
408 if (IGotoMarker
.class.equals(adapter
))
410 return super.getAdapter(adapter
);
414 public void resourceChanged(final IResourceChangeEvent event
) {
415 for (final IMarkerDelta delta
: event
.findMarkerDeltas(IMarker
.BOOKMARK
, false))
416 if (delta
.getResource().equals(fFile
))
417 if (delta
.getKind() == IResourceDelta
.REMOVED
) {
418 final IMarker bookmark
= delta
.getMarker();
419 Display
.getDefault().asyncExec(new Runnable() {
422 fEventsTable
.removeBookmark(bookmark
);
425 } else if (delta
.getKind() == IResourceDelta
.CHANGED
)
426 Display
.getDefault().asyncExec(new Runnable() {
429 fEventsTable
.getTable().refresh();
434 // ------------------------------------------------------------------------
436 // ------------------------------------------------------------------------
438 public void addBookmark() {
439 fEventsTable
.addBookmark(fFile
);
443 // ------------------------------------------------------------------------
445 // ------------------------------------------------------------------------
447 @SuppressWarnings("unchecked")
449 public void traceParserUpdated(final TmfTraceParserUpdatedSignal signal
) {
450 if (signal
.getTraceResource().equals(fFile
)) {
451 broadcast(new TmfTraceClosedSignal(this, fTrace
));
455 final String traceTypeId
= fFile
.getPersistentProperty(TmfTraceElement
.TRACETYPE
);
456 if (traceTypeId
!= null)
457 for (final IConfigurationElement ce
: TmfTraceType
.getTypeElements())
458 if (traceTypeId
.equals(ce
.getAttribute(TmfTraceType
.ID_ATTR
))) {
459 fTrace
= (ITmfTrace
<?
>) ce
.createExecutableExtension(TmfTraceType
.TRACE_TYPE_ATTR
);
460 final TmfEvent event
= (TmfEvent
) ce
.createExecutableExtension(TmfTraceType
.EVENT_TYPE_ATTR
);
461 final String path
= fFile
.getLocationURI().getPath();
462 fTrace
.initTrace(null, path
, event
.getClass());
465 } catch (final InvalidRegistryObjectException e
) {
467 } catch (final FileNotFoundException e
) {
469 } catch (final CoreException e
) {
472 fEventsTable
.dispose();
473 if (fTrace
!= null) {
474 fEventsTable
= createEventsTable(fParent
, fTrace
.getCacheSize());
475 fEventsTable
.setTrace(fTrace
, true);
476 broadcast(new TmfTraceOpenedSignal(this, fTrace
, fFile
, fEventsTable
));
478 fEventsTable
= new TmfEventsTable(fParent
, 0);
484 public void traceSelected(final TmfTraceSelectedSignal signal
) {
485 if ((signal
.getSource() != this) && signal
.getTrace().equals(fTrace
))
486 getSite().getPage().bringToTop(this);