1 /*******************************************************************************
2 * Copyright (c) 2010, 2016 Ericsson, École Polytechnique de Montréal
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 * Geneviève Bastien - Experiment instantiated with experiment type
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.ui
.editors
;
16 import java
.util
.HashSet
;
17 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
.IProgressMonitor
;
30 import org
.eclipse
.core
.runtime
.InvalidRegistryObjectException
;
31 import org
.eclipse
.core
.runtime
.ListenerList
;
32 import org
.eclipse
.jdt
.annotation
.NonNull
;
33 import org
.eclipse
.jdt
.annotation
.Nullable
;
34 import org
.eclipse
.jface
.action
.IStatusLineManager
;
35 import org
.eclipse
.jface
.util
.SafeRunnable
;
36 import org
.eclipse
.jface
.viewers
.ISelection
;
37 import org
.eclipse
.jface
.viewers
.ISelectionChangedListener
;
38 import org
.eclipse
.jface
.viewers
.ISelectionProvider
;
39 import org
.eclipse
.jface
.viewers
.SelectionChangedEvent
;
40 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
41 import org
.eclipse
.swt
.widgets
.Composite
;
42 import org
.eclipse
.swt
.widgets
.Display
;
43 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Activator
;
44 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.editors
.ITmfEventsEditorConstants
;
45 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.editors
.TmfTableColumnUtils
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.TmfCommonConstants
;
47 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.ITmfEventAspect
;
48 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.TmfBaseAspects
;
49 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
50 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTimestampFormatUpdateSignal
;
51 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal
;
52 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
53 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
54 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
55 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
56 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.experiment
.TmfExperiment
;
57 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.Messages
;
58 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfExperimentElement
;
59 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfOpenTraceHelper
;
60 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfProjectElement
;
61 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfProjectRegistry
;
62 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfTraceElement
;
63 import org
.eclipse
.tracecompass
.tmf
.ui
.project
.model
.TmfTraceTypeUIUtils
;
64 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.TmfEventsTable
;
65 import org
.eclipse
.ui
.IEditorInput
;
66 import org
.eclipse
.ui
.IEditorPart
;
67 import org
.eclipse
.ui
.IEditorSite
;
68 import org
.eclipse
.ui
.IFileEditorInput
;
69 import org
.eclipse
.ui
.IPartListener
;
70 import org
.eclipse
.ui
.IPropertyListener
;
71 import org
.eclipse
.ui
.IReusableEditor
;
72 import org
.eclipse
.ui
.IWorkbenchPart
;
73 import org
.eclipse
.ui
.PartInitException
;
74 import org
.eclipse
.ui
.PlatformUI
;
75 import org
.eclipse
.ui
.ide
.IGotoMarker
;
76 import org
.eclipse
.ui
.part
.FileEditorInput
;
77 import org
.eclipse
.ui
.views
.properties
.IPropertySheetPage
;
79 import com
.google
.common
.collect
.ImmutableSet
;
80 import com
.google
.common
.collect
.Iterables
;
83 * Editor for TMF events
85 * @author Patrick Tasse
87 public class TmfEventsEditor
extends TmfEditor
implements ITmfTraceEditor
, IReusableEditor
, IPropertyListener
, IResourceChangeListener
, ISelectionProvider
, ISelectionChangedListener
, IPartListener
, IGotoMarker
{
89 /** ID for this class */
90 public static final String ID
= "org.eclipse.linuxtools.tmf.ui.editors.events"; //$NON-NLS-1$
92 private TmfEventsTable fEventsTable
;
94 private ITmfTrace fTrace
;
95 private Composite fParent
;
96 private ListenerList fSelectionChangedListeners
= new ListenerList();
97 private boolean fTraceSelected
;
98 private IMarker fPendingGotoMarker
;
101 public void doSave(final IProgressMonitor monitor
) {
105 public void doSaveAs() {
109 public void init(final IEditorSite site
, IEditorInput input
) throws PartInitException
{
110 IFileEditorInput fileEditorInput
;
111 if (input
instanceof TmfEditorInput
) {
112 fFile
= ((TmfEditorInput
) input
).getFile();
113 fTrace
= ((TmfEditorInput
) input
).getTrace();
114 /* change the input to a FileEditorInput to allow open handlers to find this editor */
115 fileEditorInput
= new FileEditorInput(fFile
);
116 } else if (input
instanceof IFileEditorInput
) {
117 fileEditorInput
= (IFileEditorInput
) input
;
118 fFile
= fileEditorInput
.getFile();
120 throw new PartInitException("Invalid IFileEditorInput: " + fileEditorInput
); //$NON-NLS-1$
123 final String traceTypeId
= fFile
.getPersistentProperty(TmfCommonConstants
.TRACETYPE
);
124 if (traceTypeId
== null) {
125 throw new PartInitException(Messages
.TmfOpenTraceHelper_NoTraceType
);
127 if (ITmfEventsEditorConstants
.EXPERIMENT_INPUT_TYPE_CONSTANTS
.contains(traceTypeId
)) {
128 // Special case: experiment bookmark resource
129 final TmfProjectElement project
= TmfProjectRegistry
.getProject(fFile
.getProject(), true);
130 if (project
== null) {
131 throw new PartInitException(Messages
.TmfOpenTraceHelper_NoTraceType
);
133 for (final TmfExperimentElement experimentElement
: project
.getExperimentsFolder().getExperiments()) {
134 if (experimentElement
.getResource().equals(fFile
.getParent())) {
135 setPartName(experimentElement
.getName());
137 super.setInput(fileEditorInput
);
138 TmfOpenTraceHelper
.reopenTraceFromElement(experimentElement
, this);
142 } else if (ITmfEventsEditorConstants
.TRACE_INPUT_TYPE_CONSTANTS
.contains(traceTypeId
)) {
143 // Special case: trace bookmark resource
144 final TmfProjectElement project
= TmfProjectRegistry
.getProject(fFile
.getProject(), true);
145 for (final TmfTraceElement traceElement
: project
.getTracesFolder().getTraces()) {
146 if (traceElement
.getResource().equals(fFile
.getParent())) {
147 setPartName(traceElement
.getElementPath());
149 super.setInput(fileEditorInput
);
150 TmfOpenTraceHelper
.reopenTraceFromElement(traceElement
, this);
155 final TmfProjectElement project
= TmfProjectRegistry
.getProject(fFile
.getProject(), true);
156 for (final TmfTraceElement traceElement
: project
.getTracesFolder().getTraces()) {
157 if (traceElement
.getResource().equals(fFile
)) {
158 setPartName(traceElement
.getElementPath());
160 super.setInput(fileEditorInput
);
161 TmfOpenTraceHelper
.reopenTraceFromElement(traceElement
, this);
166 } catch (final PartInitException e
) {
168 } catch (final InvalidRegistryObjectException e
) {
169 Activator
.getDefault().logError("Error initializing TmfEventsEditor", e
); //$NON-NLS-1$
170 } catch (final CoreException e
) {
171 Activator
.getDefault().logError("Error initializing TmfEventsEditor", e
); //$NON-NLS-1$
174 throw new PartInitException("Invalid IEditorInput: " + input
.getClass()); //$NON-NLS-1$
176 if (fTrace
== null) {
177 throw new PartInitException("Invalid IEditorInput: " + fFile
.getName()); //$NON-NLS-1$
180 super.setInput(fileEditorInput
);
184 public boolean isDirty() {
189 public boolean isSaveAsAllowed() {
194 public void setInput(final IEditorInput input
) {
195 super.setInput(input
);
196 firePropertyChange(IEditorPart
.PROP_INPUT
);
200 public void propertyChanged(final Object source
, final int propId
) {
201 if (propId
== IEditorPart
.PROP_INPUT
&& getEditorInput() instanceof TmfEditorInput
) {
202 if (fTrace
!= null) {
203 broadcast(new TmfTraceClosedSignal(this, fTrace
));
206 fEventsTable
.dispose();
207 fFile
= ((TmfEditorInput
) getEditorInput()).getFile();
208 fTrace
= ((TmfEditorInput
) getEditorInput()).getTrace();
209 /* change the input to a FileEditorInput to allow open handlers to find this editor */
210 super.setInput(new FileEditorInput(fFile
));
211 createAndInitializeTable();
212 // The table was swapped for a new one, make sure it gets focus if
213 // the editor is active. Otherwise, the new table will not get focus
214 // because the editor already had focus.
215 if (!PlatformUI
.getWorkbench().isClosing() && PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage().getActivePart() == getSite().getPart()) {
216 fEventsTable
.setFocus();
222 private void loadState() {
223 final @Nullable String traceTypeId
= fTrace
.getTraceTypeId();
224 fEventsTable
.setColumnOrder(TmfTableColumnUtils
.loadColumnOrder(traceTypeId
));
225 fEventsTable
.setColumnWidth(TmfTableColumnUtils
.loadColumnWidth(traceTypeId
), TmfTableColumnUtils
.loadColumnResizable(traceTypeId
));
228 private void saveState() {
229 final @Nullable String traceTypeId
= fTrace
.getTraceTypeId();
230 TmfTableColumnUtils
.saveColumnOrder(traceTypeId
, fEventsTable
.getColumnOrder());
231 TmfTableColumnUtils
.saveColumnWidth(traceTypeId
, fEventsTable
.getColumnWidth());
232 TmfTableColumnUtils
.saveColumnResizability(traceTypeId
, fEventsTable
.getColumnResizable());
236 public void createPartControl(final Composite parent
) {
238 createAndInitializeTable();
239 addPropertyListener(this);
240 ResourcesPlugin
.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent
.POST_CHANGE
);
241 // we need to wrap the ISelectionProvider interface in the editor because
242 // the events table can be replaced later while the selection changed listener
243 // is only added once by the platform to the selection provider set here
244 getSite().setSelectionProvider(this);
245 getSite().getPage().addPartListener(this);
248 private void createAndInitializeTable() {
249 if (fTrace
!= null) {
250 setPartName(fTrace
.getName());
251 fEventsTable
= createEventsTable(fParent
, fTrace
.getCacheSize());
252 fEventsTable
.registerContextMenus(getSite());
253 fEventsTable
.addSelectionChangedListener(this);
254 fEventsTable
.setTrace(fTrace
, true);
255 fEventsTable
.refreshBookmarks(fFile
);
258 /* ensure start time is set */
259 final ITmfContext context
= fTrace
.seekEvent(0);
260 fTrace
.getNext(context
);
263 broadcast(new TmfTraceOpenedSignal(this, fTrace
, fFile
));
264 if (fTraceSelected
) {
265 broadcast(new TmfTraceSelectedSignal(this, fTrace
));
268 /* go to marker after trace opened */
269 if (fPendingGotoMarker
!= null) {
270 fEventsTable
.gotoMarker(fPendingGotoMarker
);
271 fPendingGotoMarker
= null;
274 fEventsTable
= new TmfEventsTable(fParent
, 0);
275 fEventsTable
.addSelectionChangedListener(this);
277 IStatusLineManager statusLineManager
= getEditorSite().getActionBars().getStatusLineManager();
278 fEventsTable
.setStatusLineManager(statusLineManager
);
282 public void dispose() {
283 if (getSite() != null) {
284 getSite().getPage().removePartListener(this);
286 ResourcesPlugin
.getWorkspace().removeResourceChangeListener(this);
287 removePropertyListener(this);
288 if (fTrace
!= null) {
289 broadcast(new TmfTraceClosedSignal(this, fTrace
));
290 if (fEventsTable
!= null) {
298 * Create the event table
301 * The parent composite
304 * @return The event table instance
306 protected @NonNull TmfEventsTable
createEventsTable(final Composite parent
, final int cacheSize
) {
307 ITmfTrace trace
= fTrace
;
310 * Check if the trace (or experiment type) defines a specific event
311 * table in its extension point.
313 TmfEventsTable table
= TmfTraceTypeUIUtils
.getEventTable(trace
, parent
, cacheSize
);
319 * Use the aspects defined by the trace type (or each trace type in an
320 * experiment) to build a table consisting of these.
322 Iterable
<ITmfEventAspect
<?
>> aspects
= getTraceAspects(trace
);
323 if (Iterables
.isEmpty(aspects
)) {
324 /* Couldn't find any event aspects, use a default table */
325 return new TmfEventsTable(parent
, cacheSize
);
327 return new TmfEventsTable(parent
, cacheSize
, aspects
);
331 * Get the event table for the given trace. It will be of the type defined
332 * by the extension point if applicable, else it will be a default table
333 * with the extension-point-defined columns (if any).
336 * The event table is for this trace
338 * The parent composite of the table
340 * The cache size to use
341 * @return The event table for the trace
343 private static @NonNull Iterable
<ITmfEventAspect
<?
>> getTraceAspects(ITmfTrace trace
) {
344 if (trace
instanceof TmfExperiment
) {
345 return getExperimentAspects((TmfExperiment
) trace
);
347 return trace
.getEventAspects();
351 * Get the events table for an experiment. If all traces in the experiment
352 * are of the same type, use the same behavior as if it was one trace of
358 * the parent Composite
360 * the event table cache size
361 * @return An event table of the appropriate type
363 private static @NonNull Iterable
<ITmfEventAspect
<?
>> getExperimentAspects(
364 final TmfExperiment experiment
) {
365 List
<ITmfTrace
> traces
= experiment
.getTraces();
366 ImmutableSet
.Builder
<ITmfEventAspect
<?
>> builder
= new ImmutableSet
.Builder
<>();
368 /* For experiments, we'll add a "trace name" aspect/column */
369 builder
.add(TmfBaseAspects
.getTraceNameAspect());
371 String commonTraceType
= getCommonTraceType(experiment
);
372 if (commonTraceType
!= null) {
374 * All the traces in this experiment are of the same type, let's
375 * just use the normal table for that type.
377 builder
.addAll(traces
.get(0).getEventAspects());
381 * There are different trace types in the experiment, so we are
382 * definitely using a TmfEventsTable. Aggregate the columns from all
385 for (ITmfTrace trace
: traces
) {
386 Iterable
<ITmfEventAspect
<?
>> traceAspects
= trace
.getEventAspects();
387 builder
.addAll(traceAspects
);
390 return builder
.build();
394 * Check if an experiment contains traces of all the same type. If so,
395 * returns this type as a String. If not, returns null.
399 * @return The common trace type if there is one, or 'null' if there are
402 private static @Nullable String
getCommonTraceType(TmfExperiment experiment
) {
403 String commonTraceType
= null;
405 for (final ITmfTrace trace
: experiment
.getTraces()) {
406 final IResource resource
= trace
.getResource();
407 if (resource
== null) {
411 final String traceType
= resource
.getPersistentProperty(TmfCommonConstants
.TRACETYPE
);
412 if ((commonTraceType
!= null) && !commonTraceType
.equals(traceType
)) {
415 commonTraceType
= traceType
;
417 } catch (CoreException e
) {
419 * One of the traces didn't advertise its type, we can't infer
424 return commonTraceType
;
428 public ITmfTrace
getTrace() {
433 public void setFocus() {
434 fEventsTable
.setFocus();
438 public <T
> T
getAdapter(final Class
<T
> adapter
) {
439 if (IGotoMarker
.class.equals(adapter
)) {
440 if (fTrace
== null || fEventsTable
== null) {
441 return adapter
.cast(this);
443 return adapter
.cast(fEventsTable
);
444 } else if (IPropertySheetPage
.class.equals(adapter
)) {
445 return adapter
.cast(new UnsortedPropertySheetPage());
447 return super.getAdapter(adapter
);
451 public void gotoMarker(IMarker marker
) {
452 if (fTrace
== null || fEventsTable
== null) {
453 fPendingGotoMarker
= marker
;
455 fEventsTable
.gotoMarker(marker
);
460 public void resourceChanged(final IResourceChangeEvent event
) {
461 final Set
<@NonNull IMarker
> added
= new HashSet
<>();
462 final Set
<@NonNull IMarker
> removed
= new HashSet
<>();
463 boolean deltaFound
= false;
464 for (final IMarkerDelta delta
: event
.findMarkerDeltas(IMarker
.BOOKMARK
, false)) {
465 if (delta
.getResource().equals(fFile
)) {
466 if (delta
.getKind() == IResourceDelta
.REMOVED
) {
467 removed
.add(delta
.getMarker());
468 } else if (delta
.getKind() == IResourceDelta
.ADDED
) {
469 added
.add(delta
.getMarker());
471 /* this also covers IResourceDelta.CHANGED */
478 Display
.getDefault().asyncExec(new Runnable() {
481 if (removed
.isEmpty() && added
.isEmpty()) {
482 fEventsTable
.getTable().refresh();
484 if (!removed
.isEmpty()) {
485 fEventsTable
.removeBookmark(Iterables
.toArray(removed
, IMarker
.class));
487 if (!added
.isEmpty()) {
488 fEventsTable
.addBookmark(Iterables
.toArray(added
, IMarker
.class));
495 // ------------------------------------------------------------------------
496 // ISelectionProvider
497 // ------------------------------------------------------------------------
500 public void addSelectionChangedListener(ISelectionChangedListener listener
) {
501 fSelectionChangedListeners
.add(listener
);
505 public ISelection
getSelection() {
506 if (fEventsTable
== null) {
507 return StructuredSelection
.EMPTY
;
509 return fEventsTable
.getSelection();
513 public void removeSelectionChangedListener(ISelectionChangedListener listener
) {
514 fSelectionChangedListeners
.remove(listener
);
518 public void setSelection(ISelection selection
) {
523 * Notifies any selection changed listeners that the viewer's selection has changed.
524 * Only listeners registered at the time this method is called are notified.
526 * @param event a selection changed event
528 * @see ISelectionChangedListener#selectionChanged
530 protected void fireSelectionChanged(final SelectionChangedEvent event
) {
531 Object
[] listeners
= fSelectionChangedListeners
.getListeners();
532 for (int i
= 0; i
< listeners
.length
; ++i
) {
533 final ISelectionChangedListener l
= (ISelectionChangedListener
) listeners
[i
];
534 SafeRunnable
.run(new SafeRunnable() {
537 l
.selectionChanged(event
);
543 // ------------------------------------------------------------------------
544 // ISelectionChangedListener
545 // ------------------------------------------------------------------------
548 public void selectionChanged(SelectionChangedEvent event
) {
549 fireSelectionChanged(event
);
552 // ------------------------------------------------------------------------
554 // ------------------------------------------------------------------------
557 public void partActivated(IWorkbenchPart part
) {
558 if (part
== this && !fTraceSelected
) {
559 fTraceSelected
= true;
560 if (fTrace
== null) {
563 broadcast(new TmfTraceSelectedSignal(this, fTrace
));
568 public void partBroughtToTop(IWorkbenchPart part
) {
569 if (part
== this && !fTraceSelected
) {
570 fTraceSelected
= true;
571 if (fTrace
== null) {
574 broadcast(new TmfTraceSelectedSignal(this, fTrace
));
579 public void partClosed(IWorkbenchPart part
) {
583 public void partDeactivated(IWorkbenchPart part
) {
587 public void partOpened(IWorkbenchPart part
) {
590 // ------------------------------------------------------------------------
592 // ------------------------------------------------------------------------
597 public void addBookmark() {
598 fEventsTable
.addBookmark(fFile
);
602 // ------------------------------------------------------------------------
604 // ------------------------------------------------------------------------
607 * Handler for the Trace Selected signal
609 * @param signal The incoming signal
612 public void traceSelected(final TmfTraceSelectedSignal signal
) {
613 if ((signal
.getSource() != this)) {
614 if (signal
.getTrace().equals(fTrace
)) {
615 getSite().getPage().bringToTop(this);
617 fTraceSelected
= false;
623 * Update the display to use the updated timestamp format
625 * @param signal the incoming signal
628 public void timestampFormatUpdated(TmfTimestampFormatUpdateSignal signal
) {
629 if (fEventsTable
!= null) {
630 fEventsTable
.refresh();