1 /*******************************************************************************
2 * Copyright (c) 2010, 2015 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 * Francois Chouinard - Initial API and implementation, replaced Table by TmfVirtualTable
11 * Patrick Tasse - Factored out from events view,
12 * Filter implementation (inspired by www.eclipse.org/mat)
13 * Ansgar Radermacher - Support navigation to model URIs (Bug 396956)
14 * Bernd Hufmann - Updated call site and model URI implementation
15 * Alexandre Montplaisir - Update to new column API
16 *******************************************************************************/
18 package org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
;
20 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
22 import java
.io
.FileNotFoundException
;
23 import java
.util
.ArrayList
;
24 import java
.util
.Collection
;
25 import java
.util
.HashMap
;
26 import java
.util
.LinkedList
;
27 import java
.util
.List
;
28 import java
.util
.Map
.Entry
;
29 import java
.util
.regex
.Pattern
;
30 import java
.util
.regex
.PatternSyntaxException
;
32 import org
.eclipse
.core
.commands
.Command
;
33 import org
.eclipse
.core
.commands
.ExecutionException
;
34 import org
.eclipse
.core
.commands
.NotEnabledException
;
35 import org
.eclipse
.core
.commands
.NotHandledException
;
36 import org
.eclipse
.core
.commands
.ParameterizedCommand
;
37 import org
.eclipse
.core
.commands
.common
.NotDefinedException
;
38 import org
.eclipse
.core
.expressions
.IEvaluationContext
;
39 import org
.eclipse
.core
.resources
.IFile
;
40 import org
.eclipse
.core
.resources
.IMarker
;
41 import org
.eclipse
.core
.resources
.IResource
;
42 import org
.eclipse
.core
.resources
.IResourceVisitor
;
43 import org
.eclipse
.core
.resources
.ResourcesPlugin
;
44 import org
.eclipse
.core
.runtime
.CoreException
;
45 import org
.eclipse
.core
.runtime
.IPath
;
46 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
47 import org
.eclipse
.core
.runtime
.IStatus
;
48 import org
.eclipse
.core
.runtime
.ListenerList
;
49 import org
.eclipse
.core
.runtime
.Path
;
50 import org
.eclipse
.core
.runtime
.Status
;
51 import org
.eclipse
.core
.runtime
.jobs
.Job
;
52 import org
.eclipse
.emf
.common
.util
.URI
;
53 import org
.eclipse
.emf
.ecore
.EValidator
;
54 import org
.eclipse
.jdt
.annotation
.NonNull
;
55 import org
.eclipse
.jface
.action
.Action
;
56 import org
.eclipse
.jface
.action
.IAction
;
57 import org
.eclipse
.jface
.action
.IMenuListener
;
58 import org
.eclipse
.jface
.action
.IMenuManager
;
59 import org
.eclipse
.jface
.action
.IStatusLineManager
;
60 import org
.eclipse
.jface
.action
.MenuManager
;
61 import org
.eclipse
.jface
.action
.Separator
;
62 import org
.eclipse
.jface
.dialogs
.InputDialog
;
63 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
64 import org
.eclipse
.jface
.resource
.FontDescriptor
;
65 import org
.eclipse
.jface
.resource
.JFaceResources
;
66 import org
.eclipse
.jface
.resource
.LocalResourceManager
;
67 import org
.eclipse
.jface
.util
.OpenStrategy
;
68 import org
.eclipse
.jface
.util
.SafeRunnable
;
69 import org
.eclipse
.jface
.viewers
.ArrayContentProvider
;
70 import org
.eclipse
.jface
.viewers
.ISelection
;
71 import org
.eclipse
.jface
.viewers
.ISelectionChangedListener
;
72 import org
.eclipse
.jface
.viewers
.ISelectionProvider
;
73 import org
.eclipse
.jface
.viewers
.LabelProvider
;
74 import org
.eclipse
.jface
.viewers
.SelectionChangedEvent
;
75 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
76 import org
.eclipse
.jface
.window
.Window
;
77 import org
.eclipse
.swt
.SWT
;
78 import org
.eclipse
.swt
.custom
.SashForm
;
79 import org
.eclipse
.swt
.custom
.TableEditor
;
80 import org
.eclipse
.swt
.events
.ControlAdapter
;
81 import org
.eclipse
.swt
.events
.ControlEvent
;
82 import org
.eclipse
.swt
.events
.FocusAdapter
;
83 import org
.eclipse
.swt
.events
.FocusEvent
;
84 import org
.eclipse
.swt
.events
.KeyAdapter
;
85 import org
.eclipse
.swt
.events
.KeyEvent
;
86 import org
.eclipse
.swt
.events
.MouseAdapter
;
87 import org
.eclipse
.swt
.events
.MouseEvent
;
88 import org
.eclipse
.swt
.events
.SelectionAdapter
;
89 import org
.eclipse
.swt
.events
.SelectionEvent
;
90 import org
.eclipse
.swt
.graphics
.Color
;
91 import org
.eclipse
.swt
.graphics
.Font
;
92 import org
.eclipse
.swt
.graphics
.Image
;
93 import org
.eclipse
.swt
.graphics
.Point
;
94 import org
.eclipse
.swt
.graphics
.Rectangle
;
95 import org
.eclipse
.swt
.layout
.FillLayout
;
96 import org
.eclipse
.swt
.layout
.GridData
;
97 import org
.eclipse
.swt
.layout
.GridLayout
;
98 import org
.eclipse
.swt
.widgets
.Composite
;
99 import org
.eclipse
.swt
.widgets
.Display
;
100 import org
.eclipse
.swt
.widgets
.Event
;
101 import org
.eclipse
.swt
.widgets
.Label
;
102 import org
.eclipse
.swt
.widgets
.Listener
;
103 import org
.eclipse
.swt
.widgets
.Menu
;
104 import org
.eclipse
.swt
.widgets
.MessageBox
;
105 import org
.eclipse
.swt
.widgets
.Shell
;
106 import org
.eclipse
.swt
.widgets
.TableColumn
;
107 import org
.eclipse
.swt
.widgets
.TableItem
;
108 import org
.eclipse
.swt
.widgets
.Text
;
109 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
110 import org
.eclipse
.tracecompass
.internal
.tmf
.core
.filter
.TmfCollapseFilter
;
111 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Activator
;
112 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Messages
;
113 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.commands
.ExportToTextCommandHandler
;
114 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.dialogs
.MultiLineInputDialog
;
115 import org
.eclipse
.tracecompass
.tmf
.core
.component
.ITmfEventProvider
;
116 import org
.eclipse
.tracecompass
.tmf
.core
.component
.TmfComponent
;
117 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
118 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.ITmfEventAspect
;
119 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.TmfContentFieldAspect
;
120 import org
.eclipse
.tracecompass
.tmf
.core
.event
.collapse
.ITmfCollapsibleEvent
;
121 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfCallsite
;
122 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfModelLookup
;
123 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfSourceLookup
;
124 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.ITmfFilter
;
125 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.ITmfFilterTreeNode
;
126 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.TmfFilterAndNode
;
127 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.TmfFilterMatchesNode
;
128 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.TmfFilterNode
;
129 import org
.eclipse
.tracecompass
.tmf
.core
.request
.ITmfEventRequest
.ExecutionType
;
130 import org
.eclipse
.tracecompass
.tmf
.core
.request
.TmfEventRequest
;
131 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfEventFilterAppliedSignal
;
132 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfEventSearchAppliedSignal
;
133 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfEventSelectedSignal
;
134 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
135 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTimeSynchSignal
;
136 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceUpdatedSignal
;
137 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
138 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
139 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
140 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
141 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
142 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTrace
;
143 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
144 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.location
.ITmfLocation
;
145 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.TmfEventsCache
.CachedEvent
;
146 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.columns
.TmfEventTableColumn
;
147 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.ColorSetting
;
148 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.ColorSettingsManager
;
149 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.IColorSettingsListener
;
150 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.filter
.FilterManager
;
151 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.rawviewer
.TmfRawEventViewer
;
152 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.TmfVirtualTable
;
153 import org
.eclipse
.ui
.IWorkbenchPage
;
154 import org
.eclipse
.ui
.PlatformUI
;
155 import org
.eclipse
.ui
.commands
.ICommandService
;
156 import org
.eclipse
.ui
.dialogs
.ListDialog
;
157 import org
.eclipse
.ui
.handlers
.IHandlerService
;
158 import org
.eclipse
.ui
.ide
.IDE
;
159 import org
.eclipse
.ui
.ide
.IGotoMarker
;
160 import org
.eclipse
.ui
.themes
.ColorUtil
;
162 import com
.google
.common
.base
.Joiner
;
163 import com
.google
.common
.collect
.HashMultimap
;
164 import com
.google
.common
.collect
.ImmutableList
;
165 import com
.google
.common
.collect
.Multimap
;
168 * The generic TMF Events table
170 * This is a view that will list events that are read from a trace.
172 * @author Francois Chouinard
173 * @author Patrick Tasse
175 public class TmfEventsTable
extends TmfComponent
implements IGotoMarker
, IColorSettingsListener
, ISelectionProvider
{
178 * Empty string array, used by {@link #getItemStrings}.
180 protected static final @NonNull String
[] EMPTY_STRING_ARRAY
= new String
[0];
185 protected static final @NonNull String EMPTY_STRING
= ""; //$NON-NLS-1$
187 private static final boolean IS_LINUX
= System
.getProperty("os.name").contains("Linux") ?
true : false; //$NON-NLS-1$ //$NON-NLS-2$
189 private static final Image BOOKMARK_IMAGE
= Activator
.getDefault().getImageFromPath(
190 "icons/elcl16/bookmark_obj.gif"); //$NON-NLS-1$
191 private static final Image SEARCH_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/search.gif"); //$NON-NLS-1$
192 private static final Image SEARCH_MATCH_IMAGE
= Activator
.getDefault().getImageFromPath(
193 "icons/elcl16/search_match.gif"); //$NON-NLS-1$
194 private static final Image SEARCH_MATCH_BOOKMARK_IMAGE
= Activator
.getDefault().getImageFromPath(
195 "icons/elcl16/search_match_bookmark.gif"); //$NON-NLS-1$
196 private static final Image FILTER_IMAGE
= Activator
.getDefault()
197 .getImageFromPath("icons/elcl16/filter_items.gif"); //$NON-NLS-1$
198 private static final Image STOP_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/stop.gif"); //$NON-NLS-1$
199 private static final String SEARCH_HINT
= Messages
.TmfEventsTable_SearchHint
;
200 private static final String FILTER_HINT
= Messages
.TmfEventsTable_FilterHint
;
201 private static final int MAX_CACHE_SIZE
= 1000;
203 private static final int MARGIN_COLUMN_INDEX
= 0;
204 private static final int FILTER_SUMMARY_INDEX
= 1;
205 private static final int EVENT_COLUMNS_START_INDEX
= MARGIN_COLUMN_INDEX
+ 1;
208 * The events table search/filter keys
211 * @author Patrick Tasse
213 public interface Key
{
215 String SEARCH_TXT
= "$srch_txt"; //$NON-NLS-1$
218 String SEARCH_OBJ
= "$srch_obj"; //$NON-NLS-1$
221 String FILTER_TXT
= "$fltr_txt"; //$NON-NLS-1$
224 String FILTER_OBJ
= "$fltr_obj"; //$NON-NLS-1$
227 String TIMESTAMP
= "$time"; //$NON-NLS-1$
230 String RANK
= "$rank"; //$NON-NLS-1$
232 /** Bookmark indicator */
233 String BOOKMARK
= "$bookmark"; //$NON-NLS-1$
235 /** Event aspect represented by this column */
236 String ASPECT
= "$aspect"; //$NON-NLS-1$
240 * The events table search/filter state
243 * @author Patrick Tasse
245 public static enum HeaderState
{
246 /** A search is being run */
249 /** A filter is applied */
253 interface Direction
{
258 // ------------------------------------------------------------------------
260 // ------------------------------------------------------------------------
262 /** The virtual event table */
263 protected TmfVirtualTable fTable
;
265 private Composite fComposite
;
266 private SashForm fSashForm
;
267 private TmfRawEventViewer fRawViewer
;
268 private ITmfTrace fTrace
;
269 volatile private boolean fPackDone
= false;
270 private HeaderState fHeaderState
= HeaderState
.SEARCH
;
271 private long fSelectedRank
= 0;
272 private ITmfTimestamp fSelectedBeginTimestamp
= null;
273 private IStatusLineManager fStatusLineManager
= null;
276 private long fFilterMatchCount
;
277 private long fFilterCheckCount
;
278 private FilterThread fFilterThread
;
279 private boolean fFilterThreadResume
= false;
280 private final Object fFilterSyncObj
= new Object();
281 private SearchThread fSearchThread
;
282 private final Object fSearchSyncObj
= new Object();
285 * List of selection change listeners (element type: <code>ISelectionChangedListener</code>).
287 * @see #fireSelectionChanged
289 private ListenerList selectionChangedListeners
= new ListenerList();
291 // Bookmark map <Rank, MarkerId>
292 private Multimap
<Long
, Long
> fBookmarksMap
= HashMultimap
.create();
293 private IFile fBookmarksFile
;
294 private long fPendingGotoRank
= -1;
297 private LocalResourceManager fResourceManager
= new LocalResourceManager(JFaceResources
.getResources());
298 private Color fGrayColor
;
299 private Color fGreenColor
;
300 private Font fBoldFont
;
302 private final List
<TmfEventTableColumn
> fColumns
= new LinkedList
<>();
305 private final TmfEventsCache fCache
;
306 private boolean fCacheUpdateBusy
= false;
307 private boolean fCacheUpdatePending
= false;
308 private boolean fCacheUpdateCompleted
= false;
309 private final Object fCacheUpdateSyncObj
= new Object();
311 private boolean fDisposeOnClose
;
313 // ------------------------------------------------------------------------
315 // ------------------------------------------------------------------------
318 * Basic constructor, using the default set of columns
321 * The parent composite UI object
323 * The size of the event table cache
325 public TmfEventsTable(final Composite parent
, final int cacheSize
) {
326 this(parent
, cacheSize
, TmfTrace
.BASE_ASPECTS
);
330 * Legacy constructor, using ColumnData to define columns
333 * The parent composite UI object
335 * The size of the event table cache
337 * The column data array
338 * @deprecated Deprecated constructor, use
339 * {@link #TmfEventsTable(Composite, int, Collection)}
342 public TmfEventsTable(final Composite parent
, int cacheSize
,
343 final org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
345 * We'll do a "best-effort" to keep trace types still using this API to
346 * keep working, by defining a TmfEventTableColumn for each
347 * ColumnData they passed.
349 this(parent
, cacheSize
, convertFromColumnData(columnData
));
353 private static @NonNull Iterable
<ITmfEventAspect
> convertFromColumnData(
354 org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
356 ImmutableList
.Builder
<ITmfEventAspect
> builder
= new ImmutableList
.Builder
<>();
357 for (org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData col
: columnData
) {
358 String fieldName
= col
.header
;
359 if (fieldName
!= null) {
360 builder
.add(new TmfContentFieldAspect(fieldName
, fieldName
));
363 return checkNotNull(builder
.build());
367 * Standard constructor, where we define which columns to use.
370 * The parent composite UI object
372 * The size of the event table cache
374 * The event aspects to display in this table. One column per
375 * aspect will be created.
377 * The iteration order of this collection will correspond to the
378 * initial ordering of the columns in the table.
381 public TmfEventsTable(final Composite parent
, int cacheSize
,
382 @NonNull Iterable
<ITmfEventAspect
> aspects
) {
383 super("TmfEventsTable"); //$NON-NLS-1$
385 fComposite
= new Composite(parent
, SWT
.NONE
);
386 final GridLayout gl
= new GridLayout(1, false);
389 gl
.verticalSpacing
= 0;
390 fComposite
.setLayout(gl
);
392 fSashForm
= new SashForm(fComposite
, SWT
.HORIZONTAL
);
393 fSashForm
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
395 // Create a virtual table
396 final int style
= SWT
.H_SCROLL
| SWT
.V_SCROLL
| SWT
.MULTI
| SWT
.FULL_SELECTION
;
397 fTable
= new TmfVirtualTable(fSashForm
, style
);
399 // Set the table layout
400 final GridData layoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, true);
401 fTable
.setLayoutData(layoutData
);
403 // Some cosmetic enhancements
404 fTable
.setHeaderVisible(true);
405 fTable
.setLinesVisible(true);
408 for (ITmfEventAspect aspect
: aspects
) {
409 if (aspect
!= null) {
410 fColumns
.add(new TmfEventTableColumn(aspect
));
414 TmfMarginColumn collapseCol
= new TmfMarginColumn();
415 fColumns
.add(MARGIN_COLUMN_INDEX
, collapseCol
);
417 // Create the UI columns in the table
418 for (TmfEventTableColumn col
: fColumns
) {
419 TableColumn column
= fTable
.newTableColumn(SWT
.LEFT
);
420 column
.setText(col
.getHeaderName());
421 column
.setToolTipText(col
.getHeaderTooltip());
422 column
.setData(Key
.ASPECT
, col
.getEventAspect());
424 if (col
instanceof TmfMarginColumn
) {
425 column
.setResizable(false);
426 column
.addControlListener(new ControlAdapter() {
428 * Make sure that the margin column is always first
431 public void controlMoved(ControlEvent e
) {
432 int[] order
= fTable
.getColumnOrder();
433 if (order
[0] == MARGIN_COLUMN_INDEX
) {
436 for (int i
= order
.length
- 1; i
> 0; i
--) {
437 if (order
[i
] == MARGIN_COLUMN_INDEX
) {
438 order
[i
] = order
[i
- 1];
439 order
[i
- 1] = MARGIN_COLUMN_INDEX
;
442 fTable
.setColumnOrder(order
);
446 column
.setMoveable(true);
450 // Set the frozen row for header row
451 fTable
.setFrozenRowCount(1);
453 // Create the header row cell editor
454 createHeaderEditor();
456 // Handle the table item selection
457 fTable
.addSelectionListener(new SelectionAdapter() {
459 public void widgetSelected(final SelectionEvent e
) {
460 if (e
.item
== null) {
463 updateStatusLine(null);
464 if (fTable
.getSelectionIndices().length
> 0) {
465 if (e
.item
.getData(Key
.RANK
) instanceof Long
) {
466 fSelectedRank
= (Long
) e
.item
.getData(Key
.RANK
);
467 fRawViewer
.selectAndReveal((Long
) e
.item
.getData(Key
.RANK
));
469 if (e
.item
.getData(Key
.TIMESTAMP
) instanceof ITmfTimestamp
) {
470 final ITmfTimestamp ts
= NonNullUtils
.checkNotNull((ITmfTimestamp
) e
.item
.getData(Key
.TIMESTAMP
));
471 if (fTable
.getSelectionIndices().length
== 1) {
472 fSelectedBeginTimestamp
= ts
;
474 ITmfTimestamp selectedBeginTimestamp
= fSelectedBeginTimestamp
;
475 if (selectedBeginTimestamp
!= null) {
476 if (selectedBeginTimestamp
.compareTo(ts
) <= 0) {
477 broadcast(new TmfTimeSynchSignal(TmfEventsTable
.this, selectedBeginTimestamp
, ts
));
478 if (fTable
.getSelectionIndices().length
== 2) {
479 updateStatusLine(ts
.getDelta(selectedBeginTimestamp
));
482 broadcast(new TmfTimeSynchSignal(TmfEventsTable
.this, checkNotNull(ts
), checkNotNull(fSelectedBeginTimestamp
)));
483 updateStatusLine(fSelectedBeginTimestamp
.getDelta(ts
));
487 if (fTable
.getSelectionIndices().length
== 1) {
488 fSelectedBeginTimestamp
= null;
492 if (e
.item
.getData() instanceof ITmfEvent
) {
493 broadcast(new TmfEventSelectedSignal(TmfEventsTable
.this, (ITmfEvent
) e
.item
.getData()));
494 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, new StructuredSelection(e
.item
.getData())));
496 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, StructuredSelection
.EMPTY
));
501 int realCacheSize
= Math
.max(cacheSize
, Display
.getDefault().getBounds().height
/ fTable
.getItemHeight());
502 realCacheSize
= Math
.min(realCacheSize
, MAX_CACHE_SIZE
);
503 fCache
= new TmfEventsCache(realCacheSize
, this);
505 // Handle the table item requests
506 fTable
.addListener(SWT
.SetData
, new Listener() {
509 public void handleEvent(final Event event
) {
511 final TableItem item
= (TableItem
) event
.item
;
512 int index
= event
.index
- 1; // -1 for the header row
514 if (event
.index
== 0) {
515 setHeaderRowItemData(item
);
519 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
520 if ((event
.index
== 1) || (event
.index
== (fTable
.getItemCount() - 1))) {
521 setFilterStatusRowItemData(item
);
524 index
= index
- 1; // -1 for top filter status row
527 final CachedEvent cachedEvent
= fCache
.getEvent(index
);
528 if (cachedEvent
!= null) {
529 setItemData(item
, cachedEvent
, cachedEvent
.rank
);
533 // Else, fill the cache asynchronously (and off the UI thread)
538 fTable
.addMouseListener(new MouseAdapter() {
540 public void mouseDoubleClick(final MouseEvent event
) {
541 if (event
.button
!= 1) {
544 // Identify the selected row
545 final Point point
= new Point(event
.x
, event
.y
);
546 final TableItem item
= fTable
.getItem(point
);
548 final Rectangle imageBounds
= item
.getImageBounds(0);
549 imageBounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
550 if (imageBounds
.contains(point
)) {
551 final Long rank
= (Long
) item
.getData(Key
.RANK
);
553 toggleBookmark(rank
);
560 final Listener tooltipListener
= new Listener () {
561 Shell tooltipShell
= null;
563 public void handleEvent(final Event event
) {
564 switch (event
.type
) {
566 final TableItem item
= fTable
.getItem(new Point(event
.x
, event
.y
));
570 final Long rank
= (Long
) item
.getData(Key
.RANK
);
574 final String tooltipText
= (String
) item
.getData(Key
.BOOKMARK
);
575 final Rectangle bounds
= item
.getImageBounds(0);
576 bounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
577 if (!bounds
.contains(event
.x
,event
.y
)) {
580 if ((tooltipShell
!= null) && !tooltipShell
.isDisposed()) {
581 tooltipShell
.dispose();
583 tooltipShell
= new Shell(fTable
.getShell(), SWT
.ON_TOP
| SWT
.NO_FOCUS
| SWT
.TOOL
);
584 tooltipShell
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
585 final FillLayout layout
= new FillLayout();
586 layout
.marginWidth
= 2;
587 tooltipShell
.setLayout(layout
);
588 final Label label
= new Label(tooltipShell
, SWT
.WRAP
);
589 String text
= rank
.toString() + (tooltipText
!= null ?
": " + tooltipText
: EMPTY_STRING
); //$NON-NLS-1$
590 label
.setForeground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_FOREGROUND
));
591 label
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
593 label
.addListener(SWT
.MouseExit
, this);
594 label
.addListener(SWT
.MouseDown
, this);
595 label
.addListener(SWT
.MouseWheel
, this);
596 final Point size
= tooltipShell
.computeSize(SWT
.DEFAULT
, SWT
.DEFAULT
);
598 * Bug in Linux. The coordinates of the event have an origin that excludes the table header but
599 * the method toDisplay() expects coordinates relative to an origin that includes the table header.
603 y
+= fTable
.getHeaderHeight();
605 Point pt
= fTable
.toDisplay(event
.x
, y
);
606 pt
.x
+= BOOKMARK_IMAGE
.getBounds().width
;
607 pt
.y
+= item
.getBounds().height
;
608 tooltipShell
.setBounds(pt
.x
, pt
.y
, size
.x
, size
.y
);
609 tooltipShell
.setVisible(true);
617 if (tooltipShell
!= null) {
618 tooltipShell
.dispose();
628 fTable
.addListener(SWT
.MouseHover
, tooltipListener
);
629 fTable
.addListener(SWT
.Dispose
, tooltipListener
);
630 fTable
.addListener(SWT
.KeyDown
, tooltipListener
);
631 fTable
.addListener(SWT
.MouseMove
, tooltipListener
);
632 fTable
.addListener(SWT
.MouseExit
, tooltipListener
);
633 fTable
.addListener(SWT
.MouseDown
, tooltipListener
);
634 fTable
.addListener(SWT
.MouseWheel
, tooltipListener
);
639 ColorSettingsManager
.addColorSettingsListener(this);
641 fTable
.setItemCount(1); // +1 for header row
643 fRawViewer
= new TmfRawEventViewer(fSashForm
, SWT
.H_SCROLL
| SWT
.V_SCROLL
);
645 fRawViewer
.addSelectionListener(new Listener() {
647 public void handleEvent(final Event e
) {
648 if (e
.data
instanceof Long
) {
649 final long rank
= (Long
) e
.data
;
650 int index
= (int) rank
;
651 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
652 index
= fCache
.getFilteredEventIndex(rank
) + 1; // +1 for top filter status row
654 fTable
.setSelection(index
+ 1); // +1 for header row
655 fSelectedRank
= rank
;
656 updateStatusLine(null);
657 } else if (e
.data
instanceof ITmfLocation
) {
658 // DOES NOT WORK: rank undefined in context from seekLocation()
659 // ITmfLocation<?> location = (ITmfLocation<?>) e.data;
660 // TmfContext context = fTrace.seekLocation(location);
661 // fTable.setSelection((int) context.getRank());
666 final TableItem
[] selection
= fTable
.getSelection();
667 if ((selection
!= null) && (selection
.length
> 0)) {
668 TableItem item
= fTable
.getSelection()[0];
669 final TmfTimestamp ts
= (TmfTimestamp
) item
.getData(Key
.TIMESTAMP
);
671 broadcast(new TmfTimeSynchSignal(TmfEventsTable
.this, ts
));
673 if (item
.getData() instanceof ITmfEvent
) {
674 broadcast(new TmfEventSelectedSignal(TmfEventsTable
.this, (ITmfEvent
) item
.getData()));
675 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, new StructuredSelection(item
.getData())));
677 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, StructuredSelection
.EMPTY
));
683 fSashForm
.setWeights(new int[] { 1, 1 });
684 fRawViewer
.setVisible(false);
689 // ------------------------------------------------------------------------
691 // ------------------------------------------------------------------------
694 * Create a pop-up menu.
696 protected void createPopupMenu() {
697 final IAction showTableAction
= new Action(Messages
.TmfEventsTable_ShowTableActionText
) {
700 fTable
.setVisible(true);
705 final IAction hideTableAction
= new Action(Messages
.TmfEventsTable_HideTableActionText
) {
708 fTable
.setVisible(false);
713 final IAction showRawAction
= new Action(Messages
.TmfEventsTable_ShowRawActionText
) {
716 fRawViewer
.setVisible(true);
718 final int index
= fTable
.getSelectionIndex();
720 fRawViewer
.selectAndReveal(index
- 1);
725 final IAction hideRawAction
= new Action(Messages
.TmfEventsTable_HideRawActionText
) {
728 fRawViewer
.setVisible(false);
733 final IAction openCallsiteAction
= new Action(Messages
.TmfEventsTable_OpenSourceCodeActionText
) {
736 final TableItem items
[] = fTable
.getSelection();
737 if (items
.length
!= 1) {
740 final TableItem item
= items
[0];
742 final Object data
= item
.getData();
743 if (data
instanceof ITmfSourceLookup
) {
744 ITmfSourceLookup event
= (ITmfSourceLookup
) data
;
745 ITmfCallsite cs
= event
.getCallsite();
746 if (cs
== null || cs
.getFileName() == null) {
749 IMarker marker
= null;
751 String fileName
= cs
.getFileName();
752 final String trimmedPath
= fileName
.replaceAll("\\.\\./", EMPTY_STRING
); //$NON-NLS-1$
753 final ArrayList
<IFile
> files
= new ArrayList
<>();
754 ResourcesPlugin
.getWorkspace().getRoot().accept(new IResourceVisitor() {
756 public boolean visit(IResource resource
) throws CoreException
{
757 if (resource
instanceof IFile
&& resource
.getFullPath().toString().endsWith(trimmedPath
)) {
758 files
.add((IFile
) resource
);
764 if (files
.size() > 1) {
765 ListDialog dialog
= new ListDialog(getTable().getShell());
766 dialog
.setContentProvider(ArrayContentProvider
.getInstance());
767 dialog
.setLabelProvider(new LabelProvider() {
769 public String
getText(Object element
) {
770 return ((IFile
) element
).getFullPath().toString();
773 dialog
.setInput(files
);
774 dialog
.setTitle(Messages
.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle
);
775 dialog
.setMessage(Messages
.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle
+ '\n' + cs
.toString());
777 Object
[] result
= dialog
.getResult();
778 if (result
!= null && result
.length
> 0) {
779 file
= (IFile
) result
[0];
781 } else if (files
.size() == 1) {
785 marker
= file
.createMarker(IMarker
.MARKER
);
786 marker
.setAttribute(IMarker
.LINE_NUMBER
, Long
.valueOf(cs
.getLineNumber()).intValue());
787 IDE
.openEditor(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage(), marker
);
789 } else if (files
.size() == 0){
790 displayException(new FileNotFoundException('\'' + cs
.toString() + '\'' + '\n' + Messages
.TmfEventsTable_OpenSourceCodeNotFound
));
792 } catch (CoreException e
) {
799 final IAction openModelAction
= new Action(Messages
.TmfEventsTable_OpenModelActionText
) {
803 final TableItem items
[] = fTable
.getSelection();
804 if (items
.length
!= 1) {
807 final TableItem item
= items
[0];
809 final Object eventData
= item
.getData();
810 if (eventData
instanceof ITmfModelLookup
) {
811 String modelURI
= ((ITmfModelLookup
) eventData
).getModelUri();
813 if (modelURI
!= null) {
814 IWorkbenchPage activePage
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
817 final URI uri
= URI
.createURI(modelURI
);
818 if (uri
.isPlatformResource()) {
819 IPath path
= new Path(uri
.toPlatformString(true));
820 file
= ResourcesPlugin
.getWorkspace().getRoot().getFile(path
);
821 } else if (uri
.isFile() && !uri
.isRelative()) {
822 file
= ResourcesPlugin
.getWorkspace().getRoot().getFileForLocation(
823 new Path(uri
.toFileString()));
829 * create a temporary validation marker on the
830 * model file, remove it afterwards thus,
831 * navigation works with all model editors
832 * supporting the navigation to a marker
834 IMarker marker
= file
.createMarker(EValidator
.MARKER
);
835 marker
.setAttribute(EValidator
.URI_ATTRIBUTE
, modelURI
);
836 marker
.setAttribute(IMarker
.SEVERITY
, IMarker
.SEVERITY_INFO
);
838 IDE
.openEditor(activePage
, marker
, OpenStrategy
.activateOnOpen());
841 catch (CoreException e
) {
845 displayException(new FileNotFoundException('\'' + modelURI
+ '\'' + '\n' + Messages
.TmfEventsTable_OpenModelUnsupportedURI
));
852 final IAction exportToTextAction
= new Action(Messages
.TmfEventsTable_Export_to_text
) {
855 IWorkbenchPage activePage
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
856 Object handlerServiceObject
= activePage
.getActiveEditor().getSite().getService(IHandlerService
.class);
857 IHandlerService handlerService
= (IHandlerService
) handlerServiceObject
;
858 Object cmdServiceObject
= activePage
.getActiveEditor().getSite().getService(ICommandService
.class);
859 ICommandService cmdService
= (ICommandService
) cmdServiceObject
;
861 HashMap
<String
, Object
> parameters
= new HashMap
<>();
862 Command command
= cmdService
.getCommand(ExportToTextCommandHandler
.COMMAND_ID
);
863 ParameterizedCommand cmd
= ParameterizedCommand
.generateCommand(command
, parameters
);
865 IEvaluationContext context
= handlerService
.getCurrentState();
866 List
<TmfEventTableColumn
> exportColumns
= new ArrayList
<>();
867 for (int i
: fTable
.getColumnOrder()) {
868 // Omit the margin column
869 if (i
>= EVENT_COLUMNS_START_INDEX
) {
870 exportColumns
.add(fColumns
.get(i
));
873 context
.addVariable(ExportToTextCommandHandler
.TMF_EVENT_TABLE_COLUMNS_ID
, exportColumns
);
875 handlerService
.executeCommandInContext(cmd
, null, context
);
876 } catch (ExecutionException
| NotDefinedException
| NotEnabledException
| NotHandledException e
) {
882 final IAction showSearchBarAction
= new Action(Messages
.TmfEventsTable_ShowSearchBarActionText
) {
885 fHeaderState
= HeaderState
.SEARCH
;
890 final IAction showFilterBarAction
= new Action(Messages
.TmfEventsTable_ShowFilterBarActionText
) {
893 fHeaderState
= HeaderState
.FILTER
;
898 final IAction clearFiltersAction
= new Action(Messages
.TmfEventsTable_ClearFiltersActionText
) {
905 final IAction collapseAction
= new Action(Messages
.TmfEventsTable_CollapseFilterMenuName
) {
908 applyFilter(new TmfCollapseFilter());
912 class ToggleBookmarkAction
extends Action
{
915 public ToggleBookmarkAction(final String text
, final Long rank
) {
922 toggleBookmark(fRank
);
926 final MenuManager tablePopupMenu
= new MenuManager();
927 tablePopupMenu
.setRemoveAllWhenShown(true);
928 tablePopupMenu
.addMenuListener(new IMenuListener() {
930 public void menuAboutToShow(final IMenuManager manager
) {
931 if (fTable
.getSelectionIndex() == 0) {
932 // Right-click on header row
933 if (fHeaderState
== HeaderState
.FILTER
) {
934 tablePopupMenu
.add(showSearchBarAction
);
936 tablePopupMenu
.add(showFilterBarAction
);
940 final Point point
= fTable
.toControl(Display
.getDefault().getCursorLocation());
941 final TableItem item
= fTable
.getSelection().length
> 0 ? fTable
.getSelection()[0] : null;
943 final Rectangle imageBounds
= item
.getImageBounds(0);
944 imageBounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
945 if (point
.x
<= (imageBounds
.x
+ imageBounds
.width
)) {
946 // Right-click on left margin
947 final Long rank
= (Long
) item
.getData(Key
.RANK
);
948 if ((rank
!= null) && (fBookmarksFile
!= null)) {
949 if (fBookmarksMap
.containsKey(rank
)) {
950 tablePopupMenu
.add(new ToggleBookmarkAction(
951 Messages
.TmfEventsTable_RemoveBookmarkActionText
, rank
));
953 tablePopupMenu
.add(new ToggleBookmarkAction(
954 Messages
.TmfEventsTable_AddBookmarkActionText
, rank
));
961 // Right-click on table
962 if (fTable
.isVisible() && fRawViewer
.isVisible()) {
963 tablePopupMenu
.add(hideTableAction
);
964 tablePopupMenu
.add(hideRawAction
);
965 } else if (!fTable
.isVisible()) {
966 tablePopupMenu
.add(showTableAction
);
967 } else if (!fRawViewer
.isVisible()) {
968 tablePopupMenu
.add(showRawAction
);
970 tablePopupMenu
.add(exportToTextAction
);
971 tablePopupMenu
.add(new Separator());
974 final Object data
= item
.getData();
975 Separator separator
= null;
976 if (data
instanceof ITmfSourceLookup
) {
977 ITmfSourceLookup event
= (ITmfSourceLookup
) data
;
978 if (event
.getCallsite() != null) {
979 tablePopupMenu
.add(openCallsiteAction
);
980 separator
= new Separator();
984 if (data
instanceof ITmfModelLookup
) {
985 ITmfModelLookup event
= (ITmfModelLookup
) data
;
986 if (event
.getModelUri() != null) {
987 tablePopupMenu
.add(openModelAction
);
988 separator
= new Separator();
991 if (separator
!= null) {
992 tablePopupMenu
.add(separator
);
997 // only show collapse filter if at least one trace can be collapsed
998 boolean isCollapsible
= false;
999 if (fTrace
!= null) {
1000 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(fTrace
)) {
1001 Class
<?
extends ITmfEvent
> eventClass
= trace
.getEventType();
1002 isCollapsible
= ITmfCollapsibleEvent
.class.isAssignableFrom(eventClass
);
1003 if (isCollapsible
) {
1009 if (isCollapsible
&& !(fTable
.getData(Key
.FILTER_OBJ
) instanceof TmfCollapseFilter
)) {
1010 tablePopupMenu
.add(collapseAction
);
1011 tablePopupMenu
.add(new Separator());
1014 tablePopupMenu
.add(clearFiltersAction
);
1015 final ITmfFilterTreeNode
[] savedFilters
= FilterManager
.getSavedFilters();
1016 if (savedFilters
.length
> 0) {
1017 final MenuManager subMenu
= new MenuManager(Messages
.TmfEventsTable_ApplyPresetFilterMenuName
);
1018 for (final ITmfFilterTreeNode node
: savedFilters
) {
1019 if (node
instanceof TmfFilterNode
) {
1020 final TmfFilterNode filter
= (TmfFilterNode
) node
;
1021 subMenu
.add(new Action(filter
.getFilterName()) {
1024 applyFilter(filter
);
1029 tablePopupMenu
.add(subMenu
);
1031 appendToTablePopupMenu(tablePopupMenu
, item
);
1035 final MenuManager rawViewerPopupMenu
= new MenuManager();
1036 rawViewerPopupMenu
.setRemoveAllWhenShown(true);
1037 rawViewerPopupMenu
.addMenuListener(new IMenuListener() {
1039 public void menuAboutToShow(final IMenuManager manager
) {
1040 if (fTable
.isVisible() && fRawViewer
.isVisible()) {
1041 rawViewerPopupMenu
.add(hideTableAction
);
1042 rawViewerPopupMenu
.add(hideRawAction
);
1043 } else if (!fTable
.isVisible()) {
1044 rawViewerPopupMenu
.add(showTableAction
);
1045 } else if (!fRawViewer
.isVisible()) {
1046 rawViewerPopupMenu
.add(showRawAction
);
1048 appendToRawPopupMenu(tablePopupMenu
);
1052 Menu menu
= tablePopupMenu
.createContextMenu(fTable
);
1053 fTable
.setMenu(menu
);
1055 menu
= rawViewerPopupMenu
.createContextMenu(fRawViewer
);
1056 fRawViewer
.setMenu(menu
);
1061 * Append an item to the event table's pop-up menu.
1063 * @param tablePopupMenu
1065 * @param selectedItem
1066 * The item to append
1068 protected void appendToTablePopupMenu(final MenuManager tablePopupMenu
, final TableItem selectedItem
) {
1069 // override to append more actions
1073 * Append an item to the raw viewer's pop-up menu.
1075 * @param rawViewerPopupMenu
1078 protected void appendToRawPopupMenu(final MenuManager rawViewerPopupMenu
) {
1079 // override to append more actions
1083 public void dispose() {
1086 ColorSettingsManager
.removeColorSettingsListener(this);
1087 fComposite
.dispose();
1088 if ((fTrace
!= null) && fDisposeOnClose
) {
1091 fResourceManager
.dispose();
1092 fRawViewer
.dispose();
1097 * Assign a layout data object to this view.
1100 * The layout data to assign
1102 public void setLayoutData(final Object layoutData
) {
1103 fComposite
.setLayoutData(layoutData
);
1107 * Get the virtual table contained in this event table.
1109 * @return The TMF virtual table
1111 public TmfVirtualTable
getTable() {
1118 * @deprecated The column headers are now set at the constructor, this
1119 * shouldn't be called anymore.
1122 protected void setColumnHeaders(final org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
1127 * Set a table item's data.
1132 * Which trace event to link with this entry
1134 * Which rank this event has in the trace/experiment
1136 protected void setItemData(final TableItem item
, final ITmfEvent event
, final long rank
) {
1137 String
[] itemStrings
= getItemStrings(fColumns
, event
);
1139 // Get the actual ITmfEvent from the CachedEvent
1140 ITmfEvent tmfEvent
= event
;
1141 if (event
instanceof CachedEvent
) {
1142 tmfEvent
= ((CachedEvent
) event
).event
;
1144 item
.setText(itemStrings
);
1145 item
.setData(tmfEvent
);
1146 item
.setData(Key
.TIMESTAMP
, new TmfTimestamp(tmfEvent
.getTimestamp()));
1147 item
.setData(Key
.RANK
, rank
);
1149 final Collection
<Long
> markerIds
= fBookmarksMap
.get(rank
);
1150 if (!markerIds
.isEmpty()) {
1151 Joiner joiner
= Joiner
.on("\n -").skipNulls(); //$NON-NLS-1$
1152 List
<Object
> parts
= new ArrayList
<>();
1153 if (markerIds
.size() > 1) {
1154 parts
.add(Messages
.TmfEventsTable_MultipleBookmarksToolTip
);
1157 for (long markerId
: markerIds
) {
1158 final IMarker marker
= fBookmarksFile
.findMarker(markerId
);
1159 parts
.add(marker
.getAttribute(IMarker
.MESSAGE
));
1161 } catch (CoreException e
) {
1162 displayException(e
);
1164 item
.setData(Key
.BOOKMARK
, joiner
.join(parts
));
1166 item
.setData(Key
.BOOKMARK
, null);
1169 boolean searchMatch
= false;
1170 boolean searchNoMatch
= false;
1171 final ITmfFilter searchFilter
= (ITmfFilter
) fTable
.getData(Key
.SEARCH_OBJ
);
1172 if (searchFilter
!= null) {
1173 if (searchFilter
.matches(tmfEvent
)) {
1176 searchNoMatch
= true;
1180 final ColorSetting colorSetting
= ColorSettingsManager
.getColorSetting(tmfEvent
);
1181 if (searchNoMatch
) {
1182 item
.setForeground(colorSetting
.getDimmedForegroundColor());
1183 item
.setBackground(colorSetting
.getDimmedBackgroundColor());
1185 item
.setForeground(colorSetting
.getForegroundColor());
1186 item
.setBackground(colorSetting
.getBackgroundColor());
1190 if (!markerIds
.isEmpty()) {
1191 item
.setImage(SEARCH_MATCH_BOOKMARK_IMAGE
);
1193 item
.setImage(SEARCH_MATCH_IMAGE
);
1195 } else if (!markerIds
.isEmpty()) {
1196 item
.setImage(BOOKMARK_IMAGE
);
1198 item
.setImage((Image
) null);
1201 if ((itemStrings
[MARGIN_COLUMN_INDEX
] != null) && !itemStrings
[MARGIN_COLUMN_INDEX
].isEmpty()) {
1207 * Set the item data of the header row.
1210 * The item to use as table header
1212 protected void setHeaderRowItemData(final TableItem item
) {
1213 String txtKey
= null;
1214 if (fHeaderState
== HeaderState
.SEARCH
) {
1215 item
.setImage(SEARCH_IMAGE
);
1216 txtKey
= Key
.SEARCH_TXT
;
1217 } else if (fHeaderState
== HeaderState
.FILTER
) {
1218 item
.setImage(FILTER_IMAGE
);
1219 txtKey
= Key
.FILTER_TXT
;
1221 item
.setForeground(fGrayColor
);
1222 // Ignore collapse and image column
1223 for (int i
= EVENT_COLUMNS_START_INDEX
; i
< fTable
.getColumns().length
; i
++) {
1224 final TableColumn column
= fTable
.getColumns()[i
];
1225 final String filter
= (String
) column
.getData(txtKey
);
1226 if (filter
== null) {
1227 if (fHeaderState
== HeaderState
.SEARCH
) {
1228 item
.setText(i
, SEARCH_HINT
);
1229 } else if (fHeaderState
== HeaderState
.FILTER
) {
1230 item
.setText(i
, FILTER_HINT
);
1232 item
.setForeground(i
, fGrayColor
);
1233 item
.setFont(i
, fTable
.getFont());
1235 item
.setText(i
, filter
);
1236 item
.setForeground(i
, fGreenColor
);
1237 item
.setFont(i
, fBoldFont
);
1243 * Set the item data of the "filter status" row.
1246 * The item to use as filter status row
1248 protected void setFilterStatusRowItemData(final TableItem item
) {
1249 for (int i
= 0; i
< fTable
.getColumns().length
; i
++) {
1250 if (i
== MARGIN_COLUMN_INDEX
) {
1251 if ((fTrace
== null) || (fFilterCheckCount
== fTrace
.getNbEvents())) {
1252 item
.setImage(FILTER_IMAGE
);
1254 item
.setImage(STOP_IMAGE
);
1258 if (i
== FILTER_SUMMARY_INDEX
) {
1259 item
.setText(FILTER_SUMMARY_INDEX
, fFilterMatchCount
+ "/" + fFilterCheckCount
); //$NON-NLS-1$
1261 item
.setText(i
, EMPTY_STRING
);
1265 item
.setData(Key
.TIMESTAMP
, null);
1266 item
.setData(Key
.RANK
, null);
1267 item
.setForeground(null);
1268 item
.setBackground(null);
1272 * Create an editor for the header.
1274 protected void createHeaderEditor() {
1275 final TableEditor tableEditor
= fTable
.createTableEditor();
1276 tableEditor
.horizontalAlignment
= SWT
.LEFT
;
1277 tableEditor
.verticalAlignment
= SWT
.CENTER
;
1278 tableEditor
.grabHorizontal
= true;
1279 tableEditor
.minimumWidth
= 50;
1281 // Handle the header row selection
1282 fTable
.addMouseListener(new MouseAdapter() {
1288 public void mouseDown(final MouseEvent event
) {
1289 if (event
.button
!= 1) {
1292 // Identify the selected row
1293 final Point point
= new Point(event
.x
, event
.y
);
1294 item
= fTable
.getItem(point
);
1296 // Header row selected
1297 if ((item
!= null) && (fTable
.indexOf(item
) == 0)) {
1300 if (item
.getImageBounds(0).contains(point
)) {
1301 if (fHeaderState
== HeaderState
.SEARCH
) {
1302 fHeaderState
= HeaderState
.FILTER
;
1303 } else if (fHeaderState
== HeaderState
.FILTER
) {
1304 fHeaderState
= HeaderState
.SEARCH
;
1306 fTable
.setSelection(0);
1311 // Identify the selected column
1313 for (int i
= 0; i
< fTable
.getColumns().length
; i
++) {
1314 final Rectangle rect
= item
.getBounds(i
);
1315 if (rect
.contains(point
)) {
1321 if (columnIndex
== -1) {
1325 column
= fTable
.getColumns()[columnIndex
];
1327 String txtKey
= null;
1328 if (fHeaderState
== HeaderState
.SEARCH
) {
1329 txtKey
= Key
.SEARCH_TXT
;
1330 } else if (fHeaderState
== HeaderState
.FILTER
) {
1331 txtKey
= Key
.FILTER_TXT
;
1334 // The control that will be the editor must be a child of the Table
1335 final Text newEditor
= (Text
) fTable
.createTableEditorControl(Text
.class);
1336 final String headerString
= (String
) column
.getData(txtKey
);
1337 if (headerString
!= null) {
1338 newEditor
.setText(headerString
);
1340 newEditor
.addFocusListener(new FocusAdapter() {
1342 public void focusLost(final FocusEvent e
) {
1343 final boolean changed
= updateHeader(newEditor
.getText());
1349 newEditor
.addKeyListener(new KeyAdapter() {
1351 public void keyPressed(final KeyEvent e
) {
1352 if (e
.character
== SWT
.CR
) {
1353 updateHeader(newEditor
.getText());
1356 // Set focus on the table so that the next carriage return goes to the next result
1357 TmfEventsTable
.this.getTable().setFocus();
1358 } else if (e
.character
== SWT
.ESC
) {
1359 tableEditor
.getEditor().dispose();
1363 newEditor
.selectAll();
1364 newEditor
.setFocus();
1365 tableEditor
.setEditor(newEditor
, item
, columnIndex
);
1370 * returns true is value was changed
1372 private boolean updateHeader(final String text
) {
1373 String objKey
= null;
1374 String txtKey
= null;
1375 if (fHeaderState
== HeaderState
.SEARCH
) {
1376 objKey
= Key
.SEARCH_OBJ
;
1377 txtKey
= Key
.SEARCH_TXT
;
1378 } else if (fHeaderState
== HeaderState
.FILTER
) {
1379 objKey
= Key
.FILTER_OBJ
;
1380 txtKey
= Key
.FILTER_TXT
;
1382 if (text
.trim().length() > 0) {
1384 final String regex
= TmfFilterMatchesNode
.regexFix(text
);
1385 Pattern
.compile(regex
);
1386 if (regex
.equals(column
.getData(txtKey
))) {
1387 tableEditor
.getEditor().dispose();
1390 final TmfFilterMatchesNode filter
= new TmfFilterMatchesNode(null);
1391 ITmfEventAspect aspect
= (ITmfEventAspect
) column
.getData(Key
.ASPECT
);
1392 filter
.setEventAspect(aspect
);
1393 filter
.setRegex(regex
);
1394 column
.setData(objKey
, filter
);
1395 column
.setData(txtKey
, regex
);
1396 } catch (final PatternSyntaxException ex
) {
1397 tableEditor
.getEditor().dispose();
1398 MessageDialog
.openError(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(),
1399 ex
.getDescription(), ex
.getMessage());
1403 if (column
.getData(txtKey
) == null) {
1404 tableEditor
.getEditor().dispose();
1407 column
.setData(objKey
, null);
1408 column
.setData(txtKey
, null);
1413 private void applyHeader() {
1414 if (fHeaderState
== HeaderState
.SEARCH
) {
1416 final TmfFilterAndNode filter
= new TmfFilterAndNode(null);
1417 for (final TableColumn col
: fTable
.getColumns()) {
1418 final Object filterObj
= col
.getData(Key
.SEARCH_OBJ
);
1419 if (filterObj
instanceof ITmfFilterTreeNode
) {
1420 filter
.addChild((ITmfFilterTreeNode
) filterObj
);
1423 if (filter
.getChildrenCount() > 0) {
1424 fTable
.setData(Key
.SEARCH_OBJ
, filter
);
1427 fireSearchApplied(filter
);
1429 fTable
.setData(Key
.SEARCH_OBJ
, null);
1431 fireSearchApplied(null);
1433 } else if (fHeaderState
== HeaderState
.FILTER
) {
1434 final TmfFilterAndNode filter
= new TmfFilterAndNode(null);
1435 for (final TableColumn col
: fTable
.getColumns()) {
1436 final Object filterObj
= col
.getData(Key
.FILTER_OBJ
);
1437 if (filterObj
instanceof ITmfFilterTreeNode
) {
1438 filter
.addChild((ITmfFilterTreeNode
) filterObj
);
1441 if (filter
.getChildrenCount() > 0) {
1442 applyFilter(filter
);
1448 tableEditor
.getEditor().dispose();
1452 fTable
.addKeyListener(new KeyAdapter() {
1454 public void keyPressed(final KeyEvent e
) {
1456 if (e
.character
== SWT
.ESC
) {
1460 } else if (e
.character
== SWT
.DEL
) {
1461 if (fHeaderState
== HeaderState
.SEARCH
) {
1463 for (final TableColumn column
: fTable
.getColumns()) {
1464 column
.setData(Key
.SEARCH_OBJ
, null);
1465 column
.setData(Key
.SEARCH_TXT
, null);
1467 fTable
.setData(Key
.SEARCH_OBJ
, null);
1469 fireSearchApplied(null);
1470 } else if (fHeaderState
== HeaderState
.FILTER
) {
1473 } else if (e
.character
== SWT
.CR
) {
1474 if ((e
.stateMask
& SWT
.SHIFT
) == 0) {
1485 * Send an event indicating a filter has been applied.
1488 * The filter that was just applied
1490 protected void fireFilterApplied(final ITmfFilter filter
) {
1491 broadcast(new TmfEventFilterAppliedSignal(this, fTrace
, filter
));
1495 * Send an event indicating that a search has been applied.
1498 * The search filter that was just applied
1500 protected void fireSearchApplied(final ITmfFilter filter
) {
1501 broadcast(new TmfEventSearchAppliedSignal(this, fTrace
, filter
));
1505 * Start the filtering thread.
1507 protected void startFilterThread() {
1508 synchronized (fFilterSyncObj
) {
1509 final ITmfFilterTreeNode filter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
1510 if (fFilterThread
== null || fFilterThread
.filter
!= filter
) {
1511 if (fFilterThread
!= null) {
1512 fFilterThread
.cancel();
1513 fFilterThreadResume
= false;
1515 fFilterThread
= new FilterThread(filter
);
1516 fFilterThread
.start();
1518 fFilterThreadResume
= true;
1524 * Stop the filtering thread.
1526 protected void stopFilterThread() {
1527 synchronized (fFilterSyncObj
) {
1528 if (fFilterThread
!= null) {
1529 fFilterThread
.cancel();
1530 fFilterThread
= null;
1531 fFilterThreadResume
= false;
1540 * The filter to apply
1542 protected void applyFilter(ITmfFilter filter
) {
1545 fFilterMatchCount
= 0;
1546 fFilterCheckCount
= 0;
1547 fCache
.applyFilter(filter
);
1549 fTable
.setData(Key
.FILTER_OBJ
, filter
);
1550 fTable
.setItemCount(3); // +1 for header row, +2 for top and bottom filter status rows
1551 startFilterThread();
1552 fireFilterApplied(filter
);
1556 * Clear all currently active filters.
1558 protected void clearFilters() {
1559 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
1564 fCache
.clearFilter();
1566 for (final TableColumn column
: fTable
.getColumns()) {
1567 column
.setData(Key
.FILTER_OBJ
, null);
1568 column
.setData(Key
.FILTER_TXT
, null);
1570 fTable
.setData(Key
.FILTER_OBJ
, null);
1571 if (fTrace
!= null) {
1572 fTable
.setItemCount((int) fTrace
.getNbEvents() + 1); // +1 for header row
1574 fTable
.setItemCount(1); // +1 for header row
1576 fFilterMatchCount
= 0;
1577 fFilterCheckCount
= 0;
1578 if (fSelectedRank
>= 0) {
1579 fTable
.setSelection((int) fSelectedRank
+ 1); // +1 for header row
1581 fTable
.setSelection(0);
1583 fireFilterApplied(null);
1584 updateStatusLine(null);
1586 // Set original width
1587 fTable
.getColumns()[MARGIN_COLUMN_INDEX
].setWidth(0);
1592 * Wrapper Thread object for the filtering thread.
1594 protected class FilterThread
extends Thread
{
1595 private final ITmfFilterTreeNode filter
;
1596 private TmfEventRequest request
;
1597 private boolean refreshBusy
= false;
1598 private boolean refreshPending
= false;
1599 private final Object syncObj
= new Object();
1605 * The filter this thread will be processing
1607 public FilterThread(final ITmfFilterTreeNode filter
) {
1608 super("Filter Thread"); //$NON-NLS-1$
1609 this.filter
= filter
;
1614 if (fTrace
== null) {
1617 final int nbRequested
= (int) (fTrace
.getNbEvents() - fFilterCheckCount
);
1618 if (nbRequested
<= 0) {
1621 request
= new TmfEventRequest(ITmfEvent
.class, TmfTimeRange
.ETERNITY
,
1622 (int) fFilterCheckCount
, nbRequested
, ExecutionType
.BACKGROUND
) {
1624 public void handleData(final ITmfEvent event
) {
1625 super.handleData(event
);
1626 if (request
.isCancelled()) {
1629 boolean refresh
= false;
1630 if (filter
.matches(event
)) {
1631 final long rank
= fFilterCheckCount
;
1632 final int index
= (int) fFilterMatchCount
;
1633 fFilterMatchCount
++;
1634 fCache
.storeEvent(event
, rank
, index
);
1637 if (filter
instanceof TmfCollapseFilter
) {
1638 fCache
.updateCollapsedEvent((int) fFilterMatchCount
- 1);
1642 if (refresh
|| (fFilterCheckCount
% 100) == 0) {
1645 fFilterCheckCount
++;
1648 ((ITmfEventProvider
) fTrace
).sendRequest(request
);
1650 request
.waitForCompletion();
1651 } catch (final InterruptedException e
) {
1654 synchronized (fFilterSyncObj
) {
1655 fFilterThread
= null;
1656 if (fFilterThreadResume
) {
1657 fFilterThreadResume
= false;
1658 fFilterThread
= new FilterThread(filter
);
1659 fFilterThread
.start();
1665 * Refresh the filter.
1667 public void refreshTable() {
1668 synchronized (syncObj
) {
1670 refreshPending
= true;
1675 Display
.getDefault().asyncExec(new Runnable() {
1678 if (request
.isCancelled()) {
1681 if (fTable
.isDisposed()) {
1684 fTable
.setItemCount((int) fFilterMatchCount
+ 3); // +1 for header row, +2 for top and bottom filter status rows
1686 synchronized (syncObj
) {
1687 refreshBusy
= false;
1688 if (refreshPending
) {
1689 refreshPending
= false;
1698 * Cancel this filtering thread.
1700 public void cancel() {
1701 if (request
!= null) {
1708 * Go to the next item of a search.
1710 protected void searchNext() {
1711 synchronized (fSearchSyncObj
) {
1712 if (fSearchThread
!= null) {
1715 final ITmfFilterTreeNode searchFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.SEARCH_OBJ
);
1716 if (searchFilter
== null) {
1719 final int selectionIndex
= fTable
.getSelectionIndex();
1721 if (selectionIndex
> 0) {
1722 startIndex
= selectionIndex
; // -1 for header row, +1 for next event
1724 // header row is selected, start at top event
1725 startIndex
= Math
.max(0, fTable
.getTopIndex() - 1); // -1 for header row
1727 final ITmfFilterTreeNode eventFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
1728 if (eventFilter
!= null) {
1729 startIndex
= Math
.max(0, startIndex
- 1); // -1 for top filter status row
1731 fSearchThread
= new SearchThread(searchFilter
, eventFilter
, startIndex
, fSelectedRank
, Direction
.FORWARD
);
1732 fSearchThread
.schedule();
1737 * Go to the previous item of a search.
1739 protected void searchPrevious() {
1740 synchronized (fSearchSyncObj
) {
1741 if (fSearchThread
!= null) {
1744 final ITmfFilterTreeNode searchFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.SEARCH_OBJ
);
1745 if (searchFilter
== null) {
1748 final int selectionIndex
= fTable
.getSelectionIndex();
1750 if (selectionIndex
> 0) {
1751 startIndex
= selectionIndex
- 2; // -1 for header row, -1 for previous event
1753 // header row is selected, start at precedent of top event
1754 startIndex
= fTable
.getTopIndex() - 2; // -1 for header row, -1 for previous event
1756 final ITmfFilterTreeNode eventFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
1757 if (eventFilter
!= null) {
1758 startIndex
= startIndex
- 1; // -1 for top filter status row
1760 fSearchThread
= new SearchThread(searchFilter
, eventFilter
, startIndex
, fSelectedRank
, Direction
.BACKWARD
);
1761 fSearchThread
.schedule();
1766 * Stop the search thread.
1768 protected void stopSearchThread() {
1769 fPendingGotoRank
= -1;
1770 synchronized (fSearchSyncObj
) {
1771 if (fSearchThread
!= null) {
1772 fSearchThread
.cancel();
1773 fSearchThread
= null;
1779 * Wrapper for the search thread.
1781 protected class SearchThread
extends Job
{
1783 private ITmfFilterTreeNode searchFilter
;
1784 private ITmfFilterTreeNode eventFilter
;
1785 private int startIndex
;
1786 private int direction
;
1788 private long foundRank
= -1;
1789 private TmfEventRequest request
;
1790 private ITmfTimestamp foundTimestamp
= null;
1795 * @param searchFilter
1797 * @param eventFilter
1800 * The index at which we should start searching
1801 * @param currentRank
1804 * In which direction should we search, forward or backwards
1806 public SearchThread(final ITmfFilterTreeNode searchFilter
,
1807 final ITmfFilterTreeNode eventFilter
, final int startIndex
,
1808 final long currentRank
, final int direction
) {
1809 super(Messages
.TmfEventsTable_SearchingJobName
);
1810 this.searchFilter
= searchFilter
;
1811 this.eventFilter
= eventFilter
;
1812 this.startIndex
= startIndex
;
1813 this.rank
= currentRank
;
1814 this.direction
= direction
;
1818 protected IStatus
run(final IProgressMonitor monitor
) {
1819 if (fTrace
== null) {
1820 return Status
.OK_STATUS
;
1822 final Display display
= Display
.getDefault();
1823 if (startIndex
< 0) {
1824 rank
= (int) fTrace
.getNbEvents() - 1;
1825 } else if (startIndex
>= (fTable
.getItemCount() - (eventFilter
== null ?
1 : 3))) { // -1 for header row, -2 for top and bottom filter status rows
1828 int idx
= startIndex
;
1829 while (foundRank
== -1) {
1830 final CachedEvent event
= fCache
.peekEvent(idx
);
1831 if (event
== null) {
1835 if (searchFilter
.matches(event
.event
) && ((eventFilter
== null) || eventFilter
.matches(event
.event
))) {
1836 foundRank
= event
.rank
;
1837 foundTimestamp
= event
.event
.getTimestamp();
1840 if (direction
== Direction
.FORWARD
) {
1846 if (foundRank
== -1) {
1847 if (direction
== Direction
.FORWARD
) {
1849 if (rank
> (fTrace
.getNbEvents() - 1)) {
1855 rank
= (int) fTrace
.getNbEvents() - 1;
1860 final int startRank
= (int) rank
;
1861 boolean wrapped
= false;
1862 while (!monitor
.isCanceled() && (foundRank
== -1) && (fTrace
!= null)) {
1863 int nbRequested
= (direction
== Direction
.FORWARD ? Integer
.MAX_VALUE
: Math
.min((int) rank
+ 1, fTrace
.getCacheSize()));
1864 if (direction
== Direction
.BACKWARD
) {
1865 rank
= Math
.max(0, rank
- fTrace
.getCacheSize() + 1);
1867 request
= new TmfEventRequest(ITmfEvent
.class, TmfTimeRange
.ETERNITY
,
1868 (int) rank
, nbRequested
, ExecutionType
.BACKGROUND
) {
1869 long currentRank
= rank
;
1872 public void handleData(final ITmfEvent event
) {
1873 super.handleData(event
);
1874 if (searchFilter
.matches(event
) && ((eventFilter
== null) || eventFilter
.matches(event
))) {
1875 foundRank
= currentRank
;
1876 foundTimestamp
= event
.getTimestamp();
1877 if (direction
== Direction
.FORWARD
) {
1885 ((ITmfEventProvider
) fTrace
).sendRequest(request
);
1887 request
.waitForCompletion();
1888 if (request
.isCancelled()) {
1889 return Status
.OK_STATUS
;
1891 } catch (final InterruptedException e
) {
1892 synchronized (fSearchSyncObj
) {
1893 fSearchThread
= null;
1895 return Status
.OK_STATUS
;
1897 if (foundRank
== -1) {
1898 if (direction
== Direction
.FORWARD
) {
1900 synchronized (fSearchSyncObj
) {
1901 fSearchThread
= null;
1903 return Status
.OK_STATUS
;
1905 nbRequested
= (int) rank
;
1911 rank
= (int) fTrace
.getNbEvents() - 1;
1914 if ((rank
<= startRank
) && wrapped
) {
1915 synchronized (fSearchSyncObj
) {
1916 fSearchThread
= null;
1918 return Status
.OK_STATUS
;
1923 int index
= (int) foundRank
;
1924 if (eventFilter
!= null) {
1925 index
= fCache
.getFilteredEventIndex(foundRank
);
1927 final int selection
= index
+ 1 + (eventFilter
!= null ?
+1 : 0); // +1 for header row, +1 for top filter status row
1929 display
.asyncExec(new Runnable() {
1932 if (monitor
.isCanceled()) {
1935 if (fTable
.isDisposed()) {
1938 fTable
.setSelection(selection
);
1939 fSelectedRank
= foundRank
;
1940 fRawViewer
.selectAndReveal(fSelectedRank
);
1941 if (foundTimestamp
!= null) {
1942 broadcast(new TmfTimeSynchSignal(TmfEventsTable
.this, foundTimestamp
));
1944 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, getSelection()));
1945 synchronized (fSearchSyncObj
) {
1946 fSearchThread
= null;
1948 updateStatusLine(null);
1951 return Status
.OK_STATUS
;
1955 protected void canceling() {
1957 synchronized (fSearchSyncObj
) {
1958 fSearchThread
= null;
1964 * Create the resources.
1966 protected void createResources() {
1967 fGrayColor
= fResourceManager
.createColor(ColorUtil
.blend(fTable
.getBackground().getRGB(), fTable
1968 .getForeground().getRGB()));
1969 fGreenColor
= fTable
.getDisplay().getSystemColor(SWT
.COLOR_DARK_GREEN
);
1970 fBoldFont
= fResourceManager
.createFont(FontDescriptor
.createFrom(fTable
.getFont()).setStyle(SWT
.BOLD
));
1976 protected void packColumns() {
1980 fTable
.setRedraw(false);
1982 TableColumn tableColumns
[] = fTable
.getColumns();
1983 for (int i
= 0; i
< tableColumns
.length
; i
++) {
1984 final TableColumn column
= tableColumns
[i
];
1985 packSingleColumn(i
, column
);
1988 // Make sure that redraw is always enabled.
1989 fTable
.setRedraw(true);
1995 private void packMarginColumn() {
1996 TableColumn
[] columns
= fTable
.getColumns();
1997 if (columns
.length
> 0) {
1998 packSingleColumn(0, columns
[0]);
2002 private void packSingleColumn(int i
, final TableColumn column
) {
2003 final int headerWidth
= column
.getWidth();
2005 // Workaround for Linux which doesn't consider the image width of
2006 // search/filter row in TableColumn.pack() after having executed
2007 // TableItem.setImage((Image)null) for other rows than search/filter row.
2008 boolean isCollapseFilter
= fTable
.getData(Key
.FILTER_OBJ
) instanceof TmfCollapseFilter
;
2009 if (IS_LINUX
&& (i
== 0) && isCollapseFilter
) {
2010 column
.setWidth(column
.getWidth() + SEARCH_IMAGE
.getBounds().width
);
2013 if (column
.getWidth() < headerWidth
) {
2014 column
.setWidth(headerWidth
);
2019 * Get the array of item strings (e.g., what to display in each cell of the
2020 * table row) corresponding to the columns and trace event passed in
2021 * parameter. The order of the Strings in the returned array will correspond
2022 * to the iteration order of 'columns'.
2025 * To ensure consistent results, make sure only call this within a scope
2026 * synchronized on 'columns'! If the order of 'columns' changes right after
2027 * this method is called, the returned value won't be ordered correctly
2030 private static String
[] getItemStrings(List
<TmfEventTableColumn
> columns
, ITmfEvent event
) {
2031 if (event
== null) {
2032 return EMPTY_STRING_ARRAY
;
2034 synchronized (columns
) {
2035 List
<String
> itemStrings
= new ArrayList
<>(columns
.size());
2036 for (TmfEventTableColumn column
: columns
) {
2037 ITmfEvent passedEvent
= event
;
2038 if (!(column
instanceof TmfMarginColumn
) && (event
instanceof CachedEvent
)) {
2039 // Make sure that the event object from the trace is passed
2040 // to all columns but the TmfMarginColumn
2041 passedEvent
= ((CachedEvent
) event
).event
;
2043 if (passedEvent
== null) {
2044 itemStrings
.add(EMPTY_STRING
);
2046 itemStrings
.add(column
.getItemString(passedEvent
));
2050 return itemStrings
.toArray(new String
[0]);
2055 * Get the contents of the row in the events table corresponding to an
2056 * event. The order of the elements corresponds to the current order of the
2060 * The event printed in this row
2061 * @return The event row entries
2063 public String
[] getItemStrings(ITmfEvent event
) {
2064 List
<TmfEventTableColumn
> columns
= new ArrayList
<>();
2065 for (int i
: fTable
.getColumnOrder()) {
2066 columns
.add(fColumns
.get(i
));
2068 return getItemStrings(columns
, event
);
2072 * Notify this table that is got the UI focus.
2074 public void setFocus() {
2079 * Assign a new trace to this event table.
2082 * The trace to assign to this event table
2083 * @param disposeOnClose
2084 * true if the trace should be disposed when the table is
2087 public void setTrace(final ITmfTrace trace
, final boolean disposeOnClose
) {
2088 if ((fTrace
!= null) && fDisposeOnClose
) {
2094 fDisposeOnClose
= disposeOnClose
;
2096 // Perform the updates on the UI thread
2097 fTable
.getDisplay().syncExec(new Runnable() {
2101 fCache
.setTrace(fTrace
); // Clear the cache
2102 if (fTrace
!= null) {
2103 if (!fTable
.isDisposed() && (fTrace
!= null)) {
2104 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
2105 fTable
.setItemCount((int) fTrace
.getNbEvents() + 1); // +1 for header row
2108 fFilterMatchCount
= 0;
2109 fFilterCheckCount
= 0;
2110 fTable
.setItemCount(3); // +1 for header row, +2 for top and bottom filter status rows
2111 startFilterThread();
2115 fRawViewer
.setTrace(fTrace
);
2121 * Assign the status line manager
2123 * @param statusLineManager
2124 * The status line manager, or null to disable status line messages
2126 public void setStatusLineManager(IStatusLineManager statusLineManager
) {
2127 if (fStatusLineManager
!= null && statusLineManager
== null) {
2128 fStatusLineManager
.setMessage(EMPTY_STRING
);
2130 fStatusLineManager
= statusLineManager
;
2133 private void updateStatusLine(ITmfTimestamp delta
) {
2134 if (fStatusLineManager
!= null) {
2135 if (delta
!= null) {
2136 fStatusLineManager
.setMessage("\u0394: " + delta
); //$NON-NLS-1$
2138 fStatusLineManager
.setMessage(null);
2143 // ------------------------------------------------------------------------
2145 // ------------------------------------------------------------------------
2148 * Notify that the event cache has been updated
2151 * Also notify if the populating of the cache is complete, or
2154 public void cacheUpdated(final boolean completed
) {
2155 synchronized (fCacheUpdateSyncObj
) {
2156 if (fCacheUpdateBusy
) {
2157 fCacheUpdatePending
= true;
2158 fCacheUpdateCompleted
= completed
;
2161 fCacheUpdateBusy
= true;
2163 // Event cache is now updated. Perform update on the UI thread
2164 if (!fTable
.isDisposed()) {
2165 fTable
.getDisplay().asyncExec(new Runnable() {
2168 if (!fTable
.isDisposed()) {
2173 populateCompleted();
2175 synchronized (fCacheUpdateSyncObj
) {
2176 fCacheUpdateBusy
= false;
2177 if (fCacheUpdatePending
) {
2178 fCacheUpdatePending
= false;
2179 cacheUpdated(fCacheUpdateCompleted
);
2188 * Callback for when populating the table is complete.
2190 protected void populateCompleted() {
2191 // Nothing by default;
2194 // ------------------------------------------------------------------------
2195 // ISelectionProvider
2196 // ------------------------------------------------------------------------
2199 public void addSelectionChangedListener(ISelectionChangedListener listener
) {
2200 selectionChangedListeners
.add(listener
);
2204 public ISelection
getSelection() {
2205 if (fTable
== null || fTable
.isDisposed()) {
2206 return StructuredSelection
.EMPTY
;
2208 List
<Object
> list
= new ArrayList
<>(fTable
.getSelection().length
);
2209 for (TableItem item
: fTable
.getSelection()) {
2210 if (item
.getData() != null) {
2211 list
.add(item
.getData());
2214 return new StructuredSelection(list
);
2218 public void removeSelectionChangedListener(ISelectionChangedListener listener
) {
2219 selectionChangedListeners
.remove(listener
);
2223 public void setSelection(ISelection selection
) {
2228 * Notifies any selection changed listeners that the viewer's selection has changed.
2229 * Only listeners registered at the time this method is called are notified.
2231 * @param event a selection changed event
2233 * @see ISelectionChangedListener#selectionChanged
2235 protected void fireSelectionChanged(final SelectionChangedEvent event
) {
2236 Object
[] listeners
= selectionChangedListeners
.getListeners();
2237 for (int i
= 0; i
< listeners
.length
; ++i
) {
2238 final ISelectionChangedListener l
= (ISelectionChangedListener
) listeners
[i
];
2239 SafeRunnable
.run(new SafeRunnable() {
2242 l
.selectionChanged(event
);
2248 // ------------------------------------------------------------------------
2249 // Bookmark handling
2250 // ------------------------------------------------------------------------
2253 * Add a bookmark to this event table.
2255 * @param bookmarksFile
2256 * The file to use for the bookmarks
2258 public void addBookmark(final IFile bookmarksFile
) {
2259 fBookmarksFile
= bookmarksFile
;
2260 final TableItem
[] selection
= fTable
.getSelection();
2261 if (selection
.length
> 0) {
2262 final TableItem tableItem
= selection
[0];
2263 if (tableItem
.getData(Key
.RANK
) != null) {
2264 final StringBuffer defaultMessage
= new StringBuffer();
2265 for (int i
= 0; i
< fTable
.getColumns().length
; i
++) {
2267 defaultMessage
.append(", "); //$NON-NLS-1$
2269 defaultMessage
.append(tableItem
.getText(i
));
2271 final InputDialog dialog
= new MultiLineInputDialog(
2272 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(),
2273 Messages
.TmfEventsTable_AddBookmarkDialogTitle
,
2274 Messages
.TmfEventsTable_AddBookmarkDialogMessage
,
2275 defaultMessage
.toString());
2276 if (dialog
.open() == Window
.OK
) {
2277 final String message
= dialog
.getValue();
2279 final IMarker bookmark
= bookmarksFile
.createMarker(IMarker
.BOOKMARK
);
2280 if (bookmark
.exists()) {
2281 bookmark
.setAttribute(IMarker
.MESSAGE
, message
.toString());
2282 final Long rank
= (Long
) tableItem
.getData(Key
.RANK
);
2283 final int location
= rank
.intValue();
2284 bookmark
.setAttribute(IMarker
.LOCATION
, Integer
.valueOf(location
));
2285 fBookmarksMap
.put(rank
, bookmark
.getId());
2288 } catch (final CoreException e
) {
2289 displayException(e
);
2298 * Remove a bookmark from this event table.
2301 * The bookmark to remove
2303 public void removeBookmark(final IMarker bookmark
) {
2304 for (final Entry
<Long
, Long
> entry
: fBookmarksMap
.entries()) {
2305 if (entry
.getValue().equals(bookmark
.getId())) {
2306 fBookmarksMap
.remove(entry
.getKey(), entry
.getValue());
2313 private void toggleBookmark(final Long rank
) {
2314 if (fBookmarksFile
== null) {
2317 if (fBookmarksMap
.containsKey(rank
)) {
2318 final Collection
<Long
> markerIds
= fBookmarksMap
.removeAll(rank
);
2321 for (long markerId
: markerIds
) {
2322 final IMarker bookmark
= fBookmarksFile
.findMarker(markerId
);
2323 if (bookmark
!= null) {
2327 } catch (final CoreException e
) {
2328 displayException(e
);
2331 addBookmark(fBookmarksFile
);
2336 * Refresh the bookmarks assigned to this trace, from the contents of a
2339 * @param bookmarksFile
2340 * The bookmark file to use
2342 public void refreshBookmarks(final IFile bookmarksFile
) {
2343 fBookmarksFile
= bookmarksFile
;
2344 if (bookmarksFile
== null) {
2345 fBookmarksMap
.clear();
2350 fBookmarksMap
.clear();
2351 for (final IMarker bookmark
: bookmarksFile
.findMarkers(IMarker
.BOOKMARK
, false, IResource
.DEPTH_ZERO
)) {
2352 final int location
= bookmark
.getAttribute(IMarker
.LOCATION
, -1);
2353 if (location
!= -1) {
2354 final long rank
= location
;
2355 fBookmarksMap
.put(rank
, bookmark
.getId());
2359 } catch (final CoreException e
) {
2360 displayException(e
);
2365 public void gotoMarker(final IMarker marker
) {
2366 final int rank
= marker
.getAttribute(IMarker
.LOCATION
, -1);
2369 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
2370 index
= fCache
.getFilteredEventIndex(rank
) + 1; // +1 for top filter status row
2371 } else if (rank
>= fTable
.getItemCount()) {
2372 fPendingGotoRank
= rank
;
2374 fSelectedRank
= rank
;
2375 fTable
.setSelection(index
+ 1); // +1 for header row
2376 updateStatusLine(null);
2380 // ------------------------------------------------------------------------
2382 // ------------------------------------------------------------------------
2385 public void colorSettingsChanged(final ColorSetting
[] colorSettings
) {
2389 // ------------------------------------------------------------------------
2391 // ------------------------------------------------------------------------
2394 * Handler for the trace updated signal
2397 * The incoming signal
2400 public void traceUpdated(final TmfTraceUpdatedSignal signal
) {
2401 if ((signal
.getTrace() != fTrace
) || fTable
.isDisposed()) {
2404 // Perform the refresh on the UI thread
2405 Display
.getDefault().asyncExec(new Runnable() {
2408 if (!fTable
.isDisposed() && (fTrace
!= null)) {
2409 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
2410 fTable
.setItemCount((int) fTrace
.getNbEvents() + 1); // +1 for header row
2411 if ((fPendingGotoRank
!= -1) && ((fPendingGotoRank
+ 1) < fTable
.getItemCount())) { // +1 for header row
2412 fTable
.setSelection((int) fPendingGotoRank
+ 1); // +1 for header row
2413 fPendingGotoRank
= -1;
2414 updateStatusLine(null);
2417 startFilterThread();
2420 if (!fRawViewer
.isDisposed() && (fTrace
!= null)) {
2421 fRawViewer
.refreshEventCount();
2428 * Handler for the time synch signal.
2431 * The incoming signal
2434 public void currentTimeUpdated(final TmfTimeSynchSignal signal
) {
2435 if ((signal
.getSource() != this) && (fTrace
!= null) && (!fTable
.isDisposed())) {
2437 // Create a request for one event that will be queued after other ongoing requests. When this request is completed
2438 // do the work to select the actual event with the timestamp specified in the signal. This procedure prevents
2439 // the method fTrace.getRank() from interfering and delaying ongoing requests.
2440 final TmfEventRequest subRequest
= new TmfEventRequest(ITmfEvent
.class,
2441 TmfTimeRange
.ETERNITY
, 0, 1, ExecutionType
.FOREGROUND
) {
2443 TmfTimestamp ts
= new TmfTimestamp(signal
.getBeginTime());
2446 public void handleData(final ITmfEvent event
) {
2447 super.handleData(event
);
2451 public void handleSuccess() {
2452 super.handleSuccess();
2453 if (fTrace
== null) {
2457 // Verify if the event is within the trace range and adjust if necessary
2458 ITmfTimestamp timestamp
= ts
;
2459 if (timestamp
.compareTo(fTrace
.getStartTime()) == -1) {
2460 timestamp
= fTrace
.getStartTime();
2462 if (timestamp
.compareTo(fTrace
.getEndTime()) == 1) {
2463 timestamp
= fTrace
.getEndTime();
2466 // Get the rank of the selected event in the table
2467 final ITmfContext context
= fTrace
.seekEvent(timestamp
);
2468 final long rank
= context
.getRank();
2470 fSelectedRank
= rank
;
2472 fTable
.getDisplay().asyncExec(new Runnable() {
2475 // Return if table is disposed
2476 if (fTable
.isDisposed()) {
2480 int index
= (int) rank
;
2481 if (fTable
.isDisposed()) {
2484 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
2485 index
= fCache
.getFilteredEventIndex(rank
) + 1; // +1 for top filter status row
2487 fTable
.setSelection(index
+ 1); // +1 for header row
2488 fRawViewer
.selectAndReveal(rank
);
2489 updateStatusLine(null);
2495 ((ITmfEventProvider
) fTrace
).sendRequest(subRequest
);
2499 // ------------------------------------------------------------------------
2501 // ------------------------------------------------------------------------
2504 * Display an exception in a message box
2506 * @param e the exception
2508 private static void displayException(final Exception e
) {
2509 final MessageBox mb
= new MessageBox(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell());
2510 mb
.setText(e
.getClass().getSimpleName());
2511 mb
.setMessage(e
.getMessage());
2518 public void refresh() {
2525 * Margin column for images and special text (e.g. collapse count)
2527 private static final class TmfMarginColumn
extends TmfEventTableColumn
{
2529 private static final @NonNull ITmfEventAspect MARGIN_ASPECT
= new ITmfEventAspect() {
2532 public String
getName() {
2533 return EMPTY_STRING
;
2537 public String
resolve(ITmfEvent event
) {
2538 if (!(event
instanceof CachedEvent
) || ((CachedEvent
) event
).repeatCount
== 0) {
2539 return EMPTY_STRING
;
2541 return "+" + ((CachedEvent
) event
).repeatCount
; //$NON-NLS-1$
2545 public String
getHelpText() {
2546 return EMPTY_STRING
;
2553 public TmfMarginColumn() {
2554 super(MARGIN_ASPECT
);