1 /*******************************************************************************
2 * Copyright (c) 2010, 2016 Ericsson and others.
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 * Matthew Khouzam - Add hide columns
17 *******************************************************************************/
19 package org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
;
22 import java
.io
.FileNotFoundException
;
23 import java
.lang
.reflect
.InvocationTargetException
;
24 import java
.util
.ArrayList
;
25 import java
.util
.Collection
;
26 import java
.util
.HashMap
;
27 import java
.util
.LinkedList
;
28 import java
.util
.List
;
29 import java
.util
.Map
.Entry
;
30 import java
.util
.regex
.Matcher
;
31 import java
.util
.regex
.Pattern
;
32 import java
.util
.regex
.PatternSyntaxException
;
34 import org
.eclipse
.core
.commands
.Command
;
35 import org
.eclipse
.core
.commands
.ExecutionException
;
36 import org
.eclipse
.core
.commands
.NotEnabledException
;
37 import org
.eclipse
.core
.commands
.NotHandledException
;
38 import org
.eclipse
.core
.commands
.ParameterizedCommand
;
39 import org
.eclipse
.core
.commands
.common
.NotDefinedException
;
40 import org
.eclipse
.core
.expressions
.IEvaluationContext
;
41 import org
.eclipse
.core
.filesystem
.EFS
;
42 import org
.eclipse
.core
.filesystem
.IFileStore
;
43 import org
.eclipse
.core
.resources
.IFile
;
44 import org
.eclipse
.core
.resources
.IMarker
;
45 import org
.eclipse
.core
.resources
.IResource
;
46 import org
.eclipse
.core
.resources
.IResourceVisitor
;
47 import org
.eclipse
.core
.resources
.IWorkspaceRunnable
;
48 import org
.eclipse
.core
.resources
.ResourcesPlugin
;
49 import org
.eclipse
.core
.runtime
.CoreException
;
50 import org
.eclipse
.core
.runtime
.IPath
;
51 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
52 import org
.eclipse
.core
.runtime
.IStatus
;
53 import org
.eclipse
.core
.runtime
.ListenerList
;
54 import org
.eclipse
.core
.runtime
.Path
;
55 import org
.eclipse
.core
.runtime
.Status
;
56 import org
.eclipse
.core
.runtime
.jobs
.Job
;
57 import org
.eclipse
.emf
.common
.util
.URI
;
58 import org
.eclipse
.emf
.ecore
.EValidator
;
59 import org
.eclipse
.jdt
.annotation
.NonNull
;
60 import org
.eclipse
.jface
.action
.Action
;
61 import org
.eclipse
.jface
.action
.IAction
;
62 import org
.eclipse
.jface
.action
.IMenuListener
;
63 import org
.eclipse
.jface
.action
.IMenuManager
;
64 import org
.eclipse
.jface
.action
.IStatusLineManager
;
65 import org
.eclipse
.jface
.action
.MenuManager
;
66 import org
.eclipse
.jface
.action
.Separator
;
67 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
68 import org
.eclipse
.jface
.operation
.IRunnableWithProgress
;
69 import org
.eclipse
.jface
.resource
.ColorRegistry
;
70 import org
.eclipse
.jface
.resource
.FontRegistry
;
71 import org
.eclipse
.jface
.resource
.JFaceResources
;
72 import org
.eclipse
.jface
.resource
.LocalResourceManager
;
73 import org
.eclipse
.jface
.text
.BadLocationException
;
74 import org
.eclipse
.jface
.text
.IDocument
;
75 import org
.eclipse
.jface
.text
.IRegion
;
76 import org
.eclipse
.jface
.util
.IPropertyChangeListener
;
77 import org
.eclipse
.jface
.util
.OpenStrategy
;
78 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
79 import org
.eclipse
.jface
.util
.SafeRunnable
;
80 import org
.eclipse
.jface
.viewers
.ArrayContentProvider
;
81 import org
.eclipse
.jface
.viewers
.ISelection
;
82 import org
.eclipse
.jface
.viewers
.ISelectionChangedListener
;
83 import org
.eclipse
.jface
.viewers
.ISelectionProvider
;
84 import org
.eclipse
.jface
.viewers
.LabelProvider
;
85 import org
.eclipse
.jface
.viewers
.SelectionChangedEvent
;
86 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
87 import org
.eclipse
.jface
.window
.Window
;
88 import org
.eclipse
.osgi
.util
.NLS
;
89 import org
.eclipse
.swt
.SWT
;
90 import org
.eclipse
.swt
.custom
.SashForm
;
91 import org
.eclipse
.swt
.custom
.StyleRange
;
92 import org
.eclipse
.swt
.custom
.TableEditor
;
93 import org
.eclipse
.swt
.events
.ControlAdapter
;
94 import org
.eclipse
.swt
.events
.ControlEvent
;
95 import org
.eclipse
.swt
.events
.FocusAdapter
;
96 import org
.eclipse
.swt
.events
.FocusEvent
;
97 import org
.eclipse
.swt
.events
.KeyAdapter
;
98 import org
.eclipse
.swt
.events
.KeyEvent
;
99 import org
.eclipse
.swt
.events
.MouseAdapter
;
100 import org
.eclipse
.swt
.events
.MouseEvent
;
101 import org
.eclipse
.swt
.events
.SelectionAdapter
;
102 import org
.eclipse
.swt
.events
.SelectionEvent
;
103 import org
.eclipse
.swt
.graphics
.Color
;
104 import org
.eclipse
.swt
.graphics
.Font
;
105 import org
.eclipse
.swt
.graphics
.GC
;
106 import org
.eclipse
.swt
.graphics
.Image
;
107 import org
.eclipse
.swt
.graphics
.Point
;
108 import org
.eclipse
.swt
.graphics
.Rectangle
;
109 import org
.eclipse
.swt
.layout
.FillLayout
;
110 import org
.eclipse
.swt
.layout
.GridData
;
111 import org
.eclipse
.swt
.layout
.GridLayout
;
112 import org
.eclipse
.swt
.widgets
.Composite
;
113 import org
.eclipse
.swt
.widgets
.Display
;
114 import org
.eclipse
.swt
.widgets
.Event
;
115 import org
.eclipse
.swt
.widgets
.Label
;
116 import org
.eclipse
.swt
.widgets
.Listener
;
117 import org
.eclipse
.swt
.widgets
.Menu
;
118 import org
.eclipse
.swt
.widgets
.MessageBox
;
119 import org
.eclipse
.swt
.widgets
.Shell
;
120 import org
.eclipse
.swt
.widgets
.TableColumn
;
121 import org
.eclipse
.swt
.widgets
.TableItem
;
122 import org
.eclipse
.swt
.widgets
.Text
;
123 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
124 import org
.eclipse
.tracecompass
.internal
.tmf
.core
.filter
.TmfCollapseFilter
;
125 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Activator
;
126 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Messages
;
127 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.commands
.CopyToClipboardOperation
;
128 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.commands
.ExportToTextCommandHandler
;
129 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.dialogs
.AddBookmarkDialog
;
130 import org
.eclipse
.tracecompass
.tmf
.core
.component
.ITmfEventProvider
;
131 import org
.eclipse
.tracecompass
.tmf
.core
.component
.TmfComponent
;
132 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
133 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.ITmfEventAspect
;
134 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.TmfContentFieldAspect
;
135 import org
.eclipse
.tracecompass
.tmf
.core
.event
.collapse
.ITmfCollapsibleEvent
;
136 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfCallsite
;
137 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfModelLookup
;
138 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfSourceLookup
;
139 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.ITmfFilter
;
140 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.ITmfFilterTreeNode
;
141 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.TmfFilterMatchesNode
;
142 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.TmfFilterNode
;
143 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.TmfFilterObjectNode
;
144 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.model
.TmfFilterRootNode
;
145 import org
.eclipse
.tracecompass
.tmf
.core
.request
.ITmfEventRequest
.ExecutionType
;
146 import org
.eclipse
.tracecompass
.tmf
.core
.request
.TmfEventRequest
;
147 import org
.eclipse
.tracecompass
.tmf
.core
.resources
.ITmfMarker
;
148 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfEventFilterAppliedSignal
;
149 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfEventSearchAppliedSignal
;
150 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfEventSelectedSignal
;
151 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSelectionRangeUpdatedSignal
;
152 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
153 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceUpdatedSignal
;
154 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
155 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfNanoTimestamp
;
156 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
157 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
158 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
159 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
160 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTrace
;
161 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
162 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.location
.ITmfLocation
;
163 import org
.eclipse
.tracecompass
.tmf
.core
.util
.Pair
;
164 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.TmfEventsCache
.CachedEvent
;
165 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.TmfEventsTableHeader
.IEventsTableHeaderListener
;
166 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.columns
.TmfEventTableColumn
;
167 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.ColorSetting
;
168 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.ColorSettingsManager
;
169 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.IColorSettingsListener
;
170 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.filter
.FilterManager
;
171 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.rawviewer
.TmfRawEventViewer
;
172 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.TmfVirtualTable
;
173 import org
.eclipse
.ui
.IEditorPart
;
174 import org
.eclipse
.ui
.IEditorSite
;
175 import org
.eclipse
.ui
.IWorkbenchPage
;
176 import org
.eclipse
.ui
.IWorkbenchPartSite
;
177 import org
.eclipse
.ui
.PlatformUI
;
178 import org
.eclipse
.ui
.commands
.ICommandService
;
179 import org
.eclipse
.ui
.dialogs
.ListDialog
;
180 import org
.eclipse
.ui
.handlers
.IHandlerService
;
181 import org
.eclipse
.ui
.ide
.IDE
;
182 import org
.eclipse
.ui
.ide
.IGotoMarker
;
183 import org
.eclipse
.ui
.texteditor
.ITextEditor
;
184 import org
.eclipse
.ui
.themes
.ColorUtil
;
185 import org
.eclipse
.ui
.themes
.IThemeManager
;
187 import com
.google
.common
.base
.Joiner
;
188 import com
.google
.common
.collect
.HashMultimap
;
189 import com
.google
.common
.collect
.ImmutableList
;
190 import com
.google
.common
.collect
.Multimap
;
193 * The generic TMF Events table
195 * This is a view that will list events that are read from a trace.
197 * @author Francois Chouinard
198 * @author Patrick Tasse
200 public class TmfEventsTable
extends TmfComponent
implements IGotoMarker
, IColorSettingsListener
, ISelectionProvider
, IPropertyChangeListener
{
203 * Empty string array, used by {@link #getItemStrings}.
205 protected static final String
@NonNull [] EMPTY_STRING_ARRAY
= new String
[0];
210 protected static final @NonNull String EMPTY_STRING
= ""; //$NON-NLS-1$
212 private static final boolean IS_LINUX
= System
.getProperty("os.name").contains("Linux") ?
true : false; //$NON-NLS-1$ //$NON-NLS-2$
214 private static final String FONT_DEFINITION_ID
= "org.eclipse.tracecompass.tmf.ui.font.eventtable"; //$NON-NLS-1$
215 private static final String HIGHLIGHT_COLOR_DEFINITION_ID
= "org.eclipse.tracecompass.tmf.ui.color.eventtable.highlight"; //$NON-NLS-1$
217 private static final Image BOOKMARK_IMAGE
= Activator
.getDefault().getImageFromPath(
218 "icons/elcl16/bookmark_obj.gif"); //$NON-NLS-1$
219 private static final Image SEARCH_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/search.gif"); //$NON-NLS-1$
220 private static final Image SEARCH_MATCH_IMAGE
= Activator
.getDefault().getImageFromPath(
221 "icons/elcl16/search_match.gif"); //$NON-NLS-1$
222 private static final Image SEARCH_MATCH_BOOKMARK_IMAGE
= Activator
.getDefault().getImageFromPath(
223 "icons/elcl16/search_match_bookmark.gif"); //$NON-NLS-1$
224 private static final Image FILTER_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/filter_items.gif"); //$NON-NLS-1$
225 private static final Image FILTER_ADD_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/filter_add.gif"); //$NON-NLS-1$
226 private static final Image STOP_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/stop.gif"); //$NON-NLS-1$
227 private static final String SEARCH_HINT
= Messages
.TmfEventsTable_SearchHint
;
228 private static final int MAX_CACHE_SIZE
= 1000;
230 private static final int MARGIN_COLUMN_INDEX
= 0;
231 private static final int FILTER_SUMMARY_INDEX
= 1;
232 private static final int EVENT_COLUMNS_START_INDEX
= MARGIN_COLUMN_INDEX
+ 1;
234 private final class ColumnMovedListener
extends ControlAdapter
{
236 * Make sure that the margin column is always first and keep the
237 * column order variable up to date.
240 public void controlMoved(ControlEvent e
) {
241 int[] order
= fTable
.getColumnOrder();
242 if (order
[0] == MARGIN_COLUMN_INDEX
) {
243 fColumnOrder
= order
;
246 for (int i
= order
.length
- 1; i
> 0; i
--) {
247 if (order
[i
] == MARGIN_COLUMN_INDEX
) {
248 order
[i
] = order
[i
- 1];
249 order
[i
- 1] = MARGIN_COLUMN_INDEX
;
252 fTable
.setColumnOrder(order
);
253 fColumnOrder
= fTable
.getColumnOrder();
257 private final class TableSelectionListener
extends SelectionAdapter
{
259 public void widgetSelected(final SelectionEvent e
) {
260 if (e
.item
== null) {
263 updateStatusLine(null);
264 if (fTable
.getSelectionIndices().length
> 0) {
265 if (e
.item
.getData(Key
.RANK
) instanceof Long
) {
266 fSelectedRank
= (Long
) e
.item
.getData(Key
.RANK
);
267 fRawViewer
.selectAndReveal((Long
) e
.item
.getData(Key
.RANK
));
271 if (fTable
.getSelectionIndices().length
== 1) {
272 fSelectedBeginRank
= fSelectedRank
;
274 if (e
.item
.getData(Key
.TIMESTAMP
) instanceof ITmfTimestamp
) {
275 final ITmfTimestamp ts
= NonNullUtils
.checkNotNull((ITmfTimestamp
) e
.item
.getData(Key
.TIMESTAMP
));
276 if (fTable
.getSelectionIndices().length
== 1) {
277 fSelectedBeginTimestamp
= ts
;
279 ITmfTimestamp selectedBeginTimestamp
= fSelectedBeginTimestamp
;
280 if (selectedBeginTimestamp
!= null) {
281 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, selectedBeginTimestamp
, ts
));
282 if (fTable
.getSelectionIndices().length
== 2) {
283 updateStatusLine(ts
.getDelta(selectedBeginTimestamp
));
287 if (fTable
.getSelectionIndices().length
== 1) {
288 fSelectedBeginTimestamp
= null;
292 if (e
.item
.getData() instanceof ITmfEvent
) {
293 broadcast(new TmfEventSelectedSignal(TmfEventsTable
.this, (ITmfEvent
) e
.item
.getData()));
294 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, new StructuredSelection(e
.item
.getData())));
296 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, StructuredSelection
.EMPTY
));
301 private final class MouseDoubleClickListener
extends MouseAdapter
{
303 public void mouseDoubleClick(final MouseEvent event
) {
304 if (event
.button
!= 1) {
307 // Identify the selected row
308 final Point point
= new Point(event
.x
, event
.y
);
309 final TableItem item
= fTable
.getItem(point
);
311 final Rectangle imageBounds
= item
.getImageBounds(0);
312 imageBounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
313 if (imageBounds
.contains(point
)) {
314 final Long rank
= (Long
) item
.getData(Key
.RANK
);
316 toggleBookmark(rank
);
323 private final class RawSelectionListener
implements Listener
{
325 public void handleEvent(final Event e
) {
326 if (fTrace
== null) {
330 if (e
.data
instanceof Long
) {
331 rank
= (Long
) e
.data
;
332 } else if (e
.data
instanceof ITmfLocation
) {
333 rank
= findRank((ITmfLocation
) e
.data
);
337 int index
= (int) rank
;
338 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
339 // +1 for top filter status row
340 index
= fCache
.getFilteredEventIndex(rank
) + 1;
343 fTable
.setSelection(index
+ 1);
344 fSelectedRank
= rank
;
345 fSelectedBeginRank
= fSelectedRank
;
346 updateStatusLine(null);
347 final TableItem
[] selection
= fTable
.getSelection();
348 if ((selection
!= null) && (selection
.length
> 0)) {
349 TableItem item
= fTable
.getSelection()[0];
350 final TmfTimestamp ts
= (TmfTimestamp
) item
.getData(Key
.TIMESTAMP
);
352 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, ts
));
354 if (item
.getData() instanceof ITmfEvent
) {
355 broadcast(new TmfEventSelectedSignal(TmfEventsTable
.this, (ITmfEvent
) item
.getData()));
356 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, new StructuredSelection(item
.getData())));
358 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, StructuredSelection
.EMPTY
));
363 private long findRank(final ITmfLocation selectedLocation
) {
364 final double selectedRatio
= fTrace
.getLocationRatio(selectedLocation
);
366 long high
= fTrace
.getNbEvents();
367 long rank
= high
/ 2;
369 while (ratio
!= selectedRatio
) {
370 ITmfContext context
= fTrace
.seekEvent(rank
);
371 ratio
= fTrace
.getLocationRatio(context
.getLocation());
373 if (ratio
< selectedRatio
) {
375 rank
= (rank
+ high
) / 2;
376 } else if (ratio
> selectedRatio
) {
378 rank
= (rank
+ low
) / 2;
380 if ((high
- low
) < 2) {
388 private final class SetDataListener
implements Listener
{
390 public void handleEvent(final Event event
) {
392 final TableItem item
= (TableItem
) event
.item
;
393 int index
= event
.index
- 1; // -1 for the header row
395 if (event
.index
== 0) {
396 setHeaderRowItemData(item
);
400 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
401 if ((event
.index
== 1) || (event
.index
== (fTable
.getItemCount() - 1))) {
402 setFilterStatusRowItemData(item
);
405 /* -1 for top filter status row */
409 final CachedEvent cachedEvent
= fCache
.getEvent(index
);
410 if (cachedEvent
!= null) {
411 setItemData(item
, cachedEvent
, cachedEvent
.rank
);
415 // Else, fill the cache asynchronously (and off the UI thread)
420 private static final class PainItemListener
implements Listener
{
422 public void handleEvent(Event event
) {
423 TableItem item
= (TableItem
) event
.item
;
425 // we promised to paint the table item's foreground
427 Image image
= item
.getImage(event
.index
);
429 Rectangle imageBounds
= item
.getImageBounds(event
.index
);
431 * The image bounds don't match the default image position.
434 gc
.drawImage(image
, imageBounds
.x
+ 1, imageBounds
.y
+ 3);
436 gc
.drawImage(image
, imageBounds
.x
, imageBounds
.y
+ 1);
439 gc
.setForeground(item
.getForeground(event
.index
));
440 gc
.setFont(item
.getFont(event
.index
));
441 String text
= item
.getText(event
.index
);
442 Rectangle textBounds
= item
.getTextBounds(event
.index
);
444 * The text bounds don't match the default text position.
447 gc
.drawText(text
, textBounds
.x
+ 1, textBounds
.y
+ 3, true);
449 gc
.drawText(text
, textBounds
.x
- 1, textBounds
.y
+ 2, true);
454 private static final class EraseItemListener
implements Listener
{
456 public void handleEvent(Event event
) {
457 TableItem item
= (TableItem
) event
.item
;
458 List
<?
> styleRanges
= (List
<?
>) item
.getData(Key
.STYLE_RANGES
);
461 Color background
= item
.getBackground(event
.index
);
463 * Paint the background if it is not the default system color.
464 * In Windows, if you let the widget draw the background, it
465 * will not show the item's background color if the item is
466 * selected or hot. If there are no style ranges and the item
467 * background is the default system color, we do not want to
468 * paint it or otherwise we would override the platform theme
469 * (e.g. alternating colors).
471 if (styleRanges
!= null || !background
.equals(item
.getParent().getBackground())) {
472 // we will paint the table item's background
473 event
.detail
&= ~SWT
.BACKGROUND
;
475 // paint the item's default background
476 gc
.setBackground(background
);
477 gc
.fillRectangle(event
.x
, event
.y
, event
.width
, event
.height
);
481 * We will paint the table item's foreground. In Windows, if you
482 * paint the background but let the widget draw the foreground,
483 * it will override your background, unless the item is selected
486 event
.detail
&= ~SWT
.FOREGROUND
;
488 // paint the highlighted background for all style ranges
489 if (styleRanges
!= null) {
490 Rectangle textBounds
= item
.getTextBounds(event
.index
);
491 String text
= item
.getText(event
.index
);
492 for (Object o
: styleRanges
) {
493 if (o
instanceof StyleRange
) {
494 StyleRange styleRange
= (StyleRange
) o
;
495 if (styleRange
.data
.equals(event
.index
)) {
496 int startIndex
= styleRange
.start
;
497 int endIndex
= startIndex
+ styleRange
.length
;
498 int startX
= gc
.textExtent(text
.substring(0, startIndex
)).x
;
499 int endX
= gc
.textExtent(text
.substring(0, endIndex
)).x
;
500 gc
.setBackground(styleRange
.background
);
501 gc
.fillRectangle(textBounds
.x
+ startX
, textBounds
.y
, (endX
- startX
), textBounds
.height
);
509 private final class TooltipListener
implements Listener
{
510 Shell tooltipShell
= null;
513 public void handleEvent(final Event event
) {
514 switch (event
.type
) {
516 final TableItem item
= fTable
.getItem(new Point(event
.x
, event
.y
));
521 if (fTable
.indexOf(item
) == 0) {
522 if (fHeaderState
== HeaderState
.SEARCH
&& item
.getBounds(0).contains(event
.x
, event
.y
)) {
523 text
= Messages
.TmfEventsTable_AddAsFilterText
;
528 final Long rank
= (Long
) item
.getData(Key
.RANK
);
532 final String tooltipText
= (String
) item
.getData(Key
.BOOKMARK
);
533 final Rectangle bounds
= item
.getImageBounds(0);
534 bounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
535 if (!bounds
.contains(event
.x
, event
.y
)) {
538 text
= rank
.toString() + (tooltipText
!= null ?
": " + tooltipText
: EMPTY_STRING
); //$NON-NLS-1$
540 if ((tooltipShell
!= null) && !tooltipShell
.isDisposed()) {
541 tooltipShell
.dispose();
543 tooltipShell
= new Shell(fTable
.getShell(), SWT
.ON_TOP
| SWT
.NO_FOCUS
| SWT
.TOOL
);
544 tooltipShell
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
545 final FillLayout layout
= new FillLayout();
546 layout
.marginWidth
= 2;
547 tooltipShell
.setLayout(layout
);
548 final Label label
= new Label(tooltipShell
, SWT
.WRAP
);
549 label
.setForeground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_FOREGROUND
));
550 label
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
552 label
.addListener(SWT
.MouseExit
, this);
553 label
.addListener(SWT
.MouseDown
, this);
554 label
.addListener(SWT
.MouseWheel
, this);
555 final Point size
= tooltipShell
.computeSize(SWT
.DEFAULT
, SWT
.DEFAULT
);
557 * Bug in Linux. The coordinates of the event have an origin
558 * that excludes the table header but the method toDisplay()
559 * expects coordinates relative to an origin that includes
564 y
+= fTable
.getHeaderHeight();
566 Point pt
= fTable
.toDisplay(event
.x
, y
);
567 pt
.x
+= BOOKMARK_IMAGE
.getBounds().width
;
568 pt
.y
+= item
.getBounds().height
;
569 tooltipShell
.setBounds(pt
.x
, pt
.y
, size
.x
, size
.y
);
570 tooltipShell
.setVisible(true);
578 if (tooltipShell
!= null) {
579 tooltipShell
.dispose();
590 * The events table search/filter/data keys
592 * @author Patrick Tasse
593 * @noimplement This interface only contains Event Table specific
594 * static definitions.
596 public interface Key
{
599 String SEARCH_TXT
= "$srch_txt"; //$NON-NLS-1$
602 String SEARCH_OBJ
= "$srch_obj"; //$NON-NLS-1$
605 String FILTER_TXT
= "$fltr_txt"; //$NON-NLS-1$
608 String FILTER_OBJ
= "$fltr_obj"; //$NON-NLS-1$
611 String TIMESTAMP
= "$time"; //$NON-NLS-1$
614 String RANK
= "$rank"; //$NON-NLS-1$
616 /** Bookmark indicator */
617 String BOOKMARK
= "$bookmark"; //$NON-NLS-1$
619 /** Event aspect represented by this column */
620 String ASPECT
= "$aspect"; //$NON-NLS-1$
623 * Table item list of style ranges
627 String STYLE_RANGES
= "$style_ranges"; //$NON-NLS-1$
630 * The width of a table item
634 String WIDTH
= "$width"; //$NON-NLS-1$
638 * The events table search/filter state
641 * @author Patrick Tasse
643 public static enum HeaderState
{
644 /** No search filter is applied
648 /** A search filter is applied */
652 interface Direction
{
657 // ------------------------------------------------------------------------
659 // ------------------------------------------------------------------------
661 /** The header bar */
662 private TmfEventsTableHeader fHeaderBar
;
664 /** The virtual event table */
665 protected TmfVirtualTable fTable
;
667 private Composite fComposite
;
668 private SashForm fSashForm
;
669 private TmfRawEventViewer fRawViewer
;
670 private ITmfTrace fTrace
;
671 private volatile boolean fPackDone
= false;
672 private HeaderState fHeaderState
= HeaderState
.NO_SEARCH
;
673 private long fSelectedRank
= -1;
674 private long fSelectedBeginRank
= -1;
675 private ITmfTimestamp fSelectedBeginTimestamp
= null;
676 private IStatusLineManager fStatusLineManager
= null;
679 private long fFilterMatchCount
;
680 private long fFilterCheckCount
;
681 private FilterThread fFilterThread
;
682 private boolean fFilterThreadResume
= false;
683 private final Object fFilterSyncObj
= new Object();
684 private SearchThread fSearchThread
;
685 private final Object fSearchSyncObj
= new Object();
686 private boolean fCollapseFilterEnabled
= false;
689 * List of selection change listeners (element type:
690 * <code>ISelectionChangedListener</code>).
692 * @see #fireSelectionChanged
694 private ListenerList selectionChangedListeners
= new ListenerList();
696 // Bookmark map <Rank, MarkerId>
697 private Multimap
<Long
, Long
> fBookmarksMap
= HashMultimap
.create();
698 private IFile fBookmarksFile
;
699 private long fPendingGotoRank
= -1;
702 private LocalResourceManager fResourceManager
= new LocalResourceManager(JFaceResources
.getResources());
703 private Color fGrayColor
;
704 private Color fGreenColor
;
705 private Color fHighlightColor
;
707 private Font fBoldFont
;
709 private final List
<TmfEventTableColumn
> fColumns
= new LinkedList
<>();
712 private final TmfEventsCache fCache
;
713 private boolean fCacheUpdateBusy
= false;
714 private boolean fCacheUpdatePending
= false;
715 private boolean fCacheUpdateCompleted
= false;
716 private final Object fCacheUpdateSyncObj
= new Object();
718 // Keep track of column order, it is needed after table is disposed
719 private int[] fColumnOrder
;
721 private boolean fDisposeOnClose
;
723 private Menu fHeaderMenu
;
725 private Menu fTablePopup
;
727 private Menu fRawTablePopup
;
729 private Point fLastMenuCursorLocation
;
730 private MenuManager fRawViewerPopupMenuManager
;
731 private MenuManager fTablePopupMenuManager
;
732 private MenuManager fHeaderPopupMenuManager
;
734 // ------------------------------------------------------------------------
736 // ------------------------------------------------------------------------
739 * Basic constructor, using the default set of columns
742 * The parent composite UI object
744 * The size of the event table cache
746 public TmfEventsTable(final Composite parent
, final int cacheSize
) {
747 this(parent
, cacheSize
, TmfTrace
.BASE_ASPECTS
);
751 * Legacy constructor, using ColumnData to define columns
754 * The parent composite UI object
756 * The size of the event table cache
758 * The column data array
759 * @deprecated Deprecated constructor, use
760 * {@link #TmfEventsTable(Composite, int, Collection)}
763 public TmfEventsTable(final Composite parent
, int cacheSize
,
764 final org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
766 * We'll do a "best-effort" to keep trace types still using this API to
767 * keep working, by defining a TmfEventTableColumn for each ColumnData
770 this(parent
, cacheSize
, convertFromColumnData(columnData
));
774 private static @NonNull Iterable
<ITmfEventAspect
<?
>> convertFromColumnData(
775 org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
777 ImmutableList
.Builder
<ITmfEventAspect
<?
>> builder
= new ImmutableList
.Builder
<>();
778 for (org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData col
: columnData
) {
779 String fieldName
= col
.header
;
780 if (fieldName
!= null) {
781 builder
.add(new TmfContentFieldAspect(fieldName
, fieldName
));
784 return builder
.build();
788 * Standard constructor, where we define which columns to use.
791 * The parent composite UI object
793 * The size of the event table cache
795 * The event aspects to display in this table. One column per
796 * aspect will be created.
798 * The iteration order of this collection will correspond to the
799 * initial ordering of the columns in the table.
802 public TmfEventsTable(final Composite parent
, int cacheSize
,
803 @NonNull Iterable
<ITmfEventAspect
<?
>> aspects
) {
804 super("TmfEventsTable"); //$NON-NLS-1$
806 fComposite
= new Composite(parent
, SWT
.NONE
);
807 GridLayout gl
= new GridLayout(1, false);
810 gl
.verticalSpacing
= 0;
811 fComposite
.setLayout(gl
);
813 fSashForm
= new SashForm(fComposite
, SWT
.HORIZONTAL
);
814 fSashForm
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
816 // Create a composite for the table and its header bar
817 Composite tableComposite
= new Composite(fSashForm
, SWT
.NONE
);
818 tableComposite
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
819 gl
= new GridLayout(1, false);
822 gl
.verticalSpacing
= 0;
823 tableComposite
.setLayout(gl
);
825 // Create an events table header bar
826 fHeaderBar
= new TmfEventsTableHeader(tableComposite
, SWT
.NONE
, new IEventsTableHeaderListener() {
828 public void filterSelected(ITmfFilter filter
) {
829 if (filter
instanceof TmfFilterMatchesNode
) {
830 TmfFilterMatchesNode matchFilter
= (TmfFilterMatchesNode
) filter
;
831 for (TableColumn col
: fTable
.getColumns()) {
832 if (col
.getData(Key
.ASPECT
) == matchFilter
.getEventAspect()) {
833 col
.setData(Key
.FILTER_TXT
, matchFilter
.getRegex());
835 col
.setData(Key
.FILTER_TXT
, null);
844 public void filterRemoved(ITmfFilter filter
) {
845 for (TableColumn col
: fTable
.getColumns()) {
846 col
.setData(Key
.FILTER_TXT
, null);
848 removeFilter(filter
);
852 // Create a virtual table
853 final int style
= SWT
.H_SCROLL
| SWT
.V_SCROLL
| SWT
.MULTI
| SWT
.FULL_SELECTION
;
854 fTable
= new TmfVirtualTable(tableComposite
, style
);
856 // Set the table layout
857 final GridData layoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, true);
858 fTable
.setLayoutData(layoutData
);
860 // Some cosmetic enhancements
861 fTable
.setHeaderVisible(true);
862 fTable
.setLinesVisible(true);
865 for (ITmfEventAspect
<?
> aspect
: aspects
) {
866 if (aspect
!= null) {
867 fColumns
.add(new TmfEventTableColumn(aspect
));
871 TmfMarginColumn collapseCol
= new TmfMarginColumn();
872 fColumns
.add(MARGIN_COLUMN_INDEX
, collapseCol
);
874 fHeaderMenu
= new Menu(fTable
);
875 // Create the UI columns in the table
876 for (TmfEventTableColumn col
: fColumns
) {
877 TableColumn column
= fTable
.newTableColumn(SWT
.LEFT
);
878 column
.setText(col
.getHeaderName());
879 column
.setToolTipText(col
.getHeaderTooltip());
880 column
.setData(Key
.ASPECT
, col
.getEventAspect());
882 if (col
instanceof TmfMarginColumn
) {
883 column
.setResizable(false);
885 column
.setMoveable(true);
886 column
.setData(Key
.WIDTH
, -1);
888 column
.addControlListener(new ColumnMovedListener());
890 fColumnOrder
= fTable
.getColumnOrder();
892 // Set the frozen row for header row
893 fTable
.setFrozenRowCount(1);
895 // Create the header row cell editor
896 createHeaderEditor();
898 // Handle the table item selection
899 fTable
.addSelectionListener(new TableSelectionListener());
901 int realCacheSize
= Math
.max(cacheSize
, Display
.getDefault().getBounds().height
/ fTable
.getItemHeight());
902 realCacheSize
= Math
.min(realCacheSize
, MAX_CACHE_SIZE
);
903 fCache
= new TmfEventsCache(realCacheSize
, this);
905 // Handle the table item requests
906 fTable
.addListener(SWT
.SetData
, new SetDataListener());
908 fTable
.addListener(SWT
.MenuDetect
, new Listener() {
910 public void handleEvent(Event event
) {
911 fLastMenuCursorLocation
= new Point(event
.x
, event
.y
);
912 Point pt
= fTable
.getDisplay().map(null, fTable
, fLastMenuCursorLocation
);
913 Rectangle clientArea
= fTable
.getClientArea();
914 boolean header
= clientArea
.y
<= pt
.y
&& pt
.y
< (clientArea
.y
+ fTable
.getHeaderHeight());
915 fTable
.setMenu(header ? fHeaderMenu
: fTablePopup
);
919 fTable
.addMouseListener(new MouseDoubleClickListener());
921 final Listener tooltipListener
= new TooltipListener();
923 fTable
.addListener(SWT
.MouseHover
, tooltipListener
);
924 fTable
.addListener(SWT
.Dispose
, tooltipListener
);
925 fTable
.addListener(SWT
.KeyDown
, tooltipListener
);
926 fTable
.addListener(SWT
.MouseMove
, tooltipListener
);
927 fTable
.addListener(SWT
.MouseExit
, tooltipListener
);
928 fTable
.addListener(SWT
.MouseDown
, tooltipListener
);
929 fTable
.addListener(SWT
.MouseWheel
, tooltipListener
);
931 fTable
.addListener(SWT
.EraseItem
, new EraseItemListener());
933 fTable
.addListener(SWT
.PaintItem
, new PainItemListener());
940 PlatformUI
.getWorkbench().getThemeManager().addPropertyChangeListener(this);
942 ColorSettingsManager
.addColorSettingsListener(this);
944 fTable
.setItemCount(1); // +1 for header row
946 fRawViewer
= new TmfRawEventViewer(fSashForm
, SWT
.H_SCROLL
| SWT
.V_SCROLL
);
948 fRawViewer
.addSelectionListener(new RawSelectionListener());
950 fSashForm
.setWeights(new int[] { 1, 1 });
951 fRawViewer
.setVisible(false);
955 fComposite
.addDisposeListener((e
) -> {
961 * Checked menu creator to make columns visible or not.
968 private static IAction
createHeaderAction(final TableColumn column
) {
969 final IAction columnMenuAction
= new Action(column
.getText(), IAction
.AS_CHECK_BOX
) {
973 column
.setWidth((int) column
.getData(Key
.WIDTH
));
974 column
.setResizable(true);
976 column
.setData(Key
.WIDTH
, column
.getWidth());
978 column
.setResizable(false);
982 columnMenuAction
.setChecked(column
.getResizable());
983 return columnMenuAction
;
986 private IAction
createResetHeaderAction() {
987 return new Action(Messages
.TmfEventsTable_ShowAll
) {
990 for (TableColumn column
: fTable
.getColumns()) {
991 final Object widthVal
= column
.getData(Key
.WIDTH
);
992 if (widthVal
instanceof Integer
) {
993 Integer width
= (Integer
) widthVal
;
994 if (!column
.getResizable()) {
995 column
.setWidth(width
);
996 column
.setResizable(true);
998 * This is because Linux always resizes the last
999 * column to fill in the void, this means that
1000 * hiding a column resizes others and we can have 10
1001 * columns that are 1000 pixels wide by hiding the
1002 * last one progressively.
1014 // ------------------------------------------------------------------------
1016 // ------------------------------------------------------------------------
1019 * Create a pop-up menu.
1021 private void createPopupMenu() {
1022 final IAction copyAction
= new Action(Messages
.TmfEventsTable_CopyToClipboardActionText
) {
1025 ITmfTrace trace
= fTrace
;
1026 if (trace
== null || (fSelectedRank
== -1 && fSelectedBeginRank
== -1)) {
1030 List
<TmfEventTableColumn
> columns
= new ArrayList
<>();
1031 for (int i
: fTable
.getColumnOrder()) {
1032 TableColumn column
= fTable
.getColumns()[i
];
1033 // Omit the margin column and hidden columns
1034 if (isVisibleEventColumn(column
)) {
1035 columns
.add(fColumns
.get(i
));
1039 long start
= Math
.min(fSelectedBeginRank
, fSelectedRank
);
1040 long end
= Math
.max(fSelectedBeginRank
, fSelectedRank
);
1041 final ITmfFilter filter
= (ITmfFilter
) fTable
.getData(Key
.FILTER_OBJ
);
1042 IRunnableWithProgress operation
= new CopyToClipboardOperation(trace
, filter
, columns
, start
, end
);
1044 PlatformUI
.getWorkbench().getProgressService().busyCursorWhile(operation
);
1045 } catch (InvocationTargetException e
) {
1046 Activator
.getDefault().logError("Invocation target exception copying to clipboard ", e
); //$NON-NLS-1$
1047 } catch (InterruptedException e
) {
1053 final IAction showTableAction
= new Action(Messages
.TmfEventsTable_ShowTableActionText
) {
1056 fTable
.setVisible(true);
1061 final IAction hideTableAction
= new Action(Messages
.TmfEventsTable_HideTableActionText
) {
1064 fTable
.setVisible(false);
1069 final IAction showRawAction
= new Action(Messages
.TmfEventsTable_ShowRawActionText
) {
1072 fRawViewer
.setVisible(true);
1074 final int index
= fTable
.getSelectionIndex();
1076 fRawViewer
.selectAndReveal(index
- 1);
1081 final IAction hideRawAction
= new Action(Messages
.TmfEventsTable_HideRawActionText
) {
1084 fRawViewer
.setVisible(false);
1089 final IAction openCallsiteAction
= new Action(Messages
.TmfEventsTable_OpenSourceCodeActionText
) {
1092 final TableItem items
[] = fTable
.getSelection();
1093 if (items
.length
!= 1) {
1096 final TableItem item
= items
[0];
1098 final Object data
= item
.getData();
1099 if (!(data
instanceof ITmfSourceLookup
)) {
1102 ITmfSourceLookup event
= (ITmfSourceLookup
) data
;
1103 ITmfCallsite cs
= event
.getCallsite();
1108 String fileName
= cs
.getFileName();
1109 final String trimmedPath
= fileName
.replaceAll("\\.\\./", EMPTY_STRING
); //$NON-NLS-1$
1110 File fileToOpen
= new File(trimmedPath
);
1113 if (fileToOpen
.exists() && fileToOpen
.isFile()) {
1115 * The path points to a "real" file, attempt to open
1118 IFileStore fileStore
= EFS
.getLocalFileSystem().getStore(fileToOpen
.toURI());
1119 IWorkbenchPage page
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
1121 IEditorPart editor
= IDE
.openEditorOnFileStore(page
, fileStore
);
1122 if (editor
instanceof ITextEditor
) {
1124 * Calculate the "document offset" corresponding to
1125 * the line number, then seek there.
1127 ITextEditor textEditor
= (ITextEditor
) editor
;
1128 int lineNumber
= Long
.valueOf(cs
.getLineNumber()).intValue();
1129 IDocument document
= textEditor
.getDocumentProvider().getDocument(textEditor
.getEditorInput());
1131 IRegion region
= document
.getLineInformation(lineNumber
- 1);
1132 if (region
!= null) {
1133 textEditor
.selectAndReveal(region
.getOffset(), region
.getLength());
1139 * The file was not found on disk, attempt to find it in
1140 * the workspace instead.
1142 IMarker marker
= null;
1143 final ArrayList
<IFile
> files
= new ArrayList
<>();
1144 ResourcesPlugin
.getWorkspace().getRoot().accept(new IResourceVisitor() {
1146 public boolean visit(IResource resource
) throws CoreException
{
1147 if (resource
instanceof IFile
&& resource
.getFullPath().toString().endsWith(trimmedPath
)) {
1148 files
.add((IFile
) resource
);
1154 if (files
.size() > 1) {
1155 ListDialog dialog
= new ListDialog(getTable().getShell());
1156 dialog
.setContentProvider(ArrayContentProvider
.getInstance());
1157 dialog
.setLabelProvider(new LabelProvider() {
1159 public String
getText(Object element
) {
1160 return ((IFile
) element
).getFullPath().toString();
1163 dialog
.setInput(files
);
1164 dialog
.setTitle(Messages
.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle
);
1165 dialog
.setMessage(Messages
.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle
+ '\n' + cs
.toString());
1167 Object
[] result
= dialog
.getResult();
1168 if (result
!= null && result
.length
> 0) {
1169 file
= (IFile
) result
[0];
1171 } else if (files
.size() == 1) {
1172 file
= files
.get(0);
1175 marker
= file
.createMarker(IMarker
.MARKER
);
1176 marker
.setAttribute(IMarker
.LINE_NUMBER
, Long
.valueOf(cs
.getLineNumber()).intValue());
1177 IDE
.openEditor(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage(), marker
);
1179 } else if (files
.isEmpty()) {
1180 displayException(new FileNotFoundException('\'' + cs
.toString() + '\'' + '\n' + Messages
.TmfEventsTable_OpenSourceCodeNotFound
));
1183 } catch (BadLocationException
| CoreException e
) {
1184 displayException(e
);
1189 final IAction openModelAction
= new Action(Messages
.TmfEventsTable_OpenModelActionText
) {
1193 final TableItem items
[] = fTable
.getSelection();
1194 if (items
.length
!= 1) {
1197 final TableItem item
= items
[0];
1199 final Object eventData
= item
.getData();
1200 if (eventData
instanceof ITmfModelLookup
) {
1201 String modelURI
= ((ITmfModelLookup
) eventData
).getModelUri();
1203 if (modelURI
!= null) {
1204 IWorkbenchPage activePage
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
1207 final URI uri
= URI
.createURI(modelURI
);
1208 if (uri
.isPlatformResource()) {
1209 IPath path
= new Path(uri
.toPlatformString(true));
1210 file
= ResourcesPlugin
.getWorkspace().getRoot().getFile(path
);
1211 } else if (uri
.isFile() && !uri
.isRelative()) {
1212 file
= ResourcesPlugin
.getWorkspace().getRoot().getFileForLocation(
1213 new Path(uri
.toFileString()));
1219 * create a temporary validation marker on the
1220 * model file, remove it afterwards thus,
1221 * navigation works with all model editors
1222 * supporting the navigation to a marker
1224 IMarker marker
= file
.createMarker(EValidator
.MARKER
);
1225 marker
.setAttribute(EValidator
.URI_ATTRIBUTE
, modelURI
);
1226 marker
.setAttribute(IMarker
.SEVERITY
, IMarker
.SEVERITY_INFO
);
1228 IDE
.openEditor(activePage
, marker
, OpenStrategy
.activateOnOpen());
1230 } catch (CoreException e
) {
1231 displayException(e
);
1234 displayException(new FileNotFoundException('\'' + modelURI
+ '\'' + '\n' + Messages
.TmfEventsTable_OpenModelUnsupportedURI
));
1241 final IAction exportToTextAction
= new Action(Messages
.TmfEventsTable_Export_to_text
) {
1244 IWorkbenchPage activePage
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
1245 Object handlerServiceObject
= activePage
.getActiveEditor().getSite().getService(IHandlerService
.class);
1246 IHandlerService handlerService
= (IHandlerService
) handlerServiceObject
;
1247 Object cmdServiceObject
= activePage
.getActiveEditor().getSite().getService(ICommandService
.class);
1248 ICommandService cmdService
= (ICommandService
) cmdServiceObject
;
1250 HashMap
<String
, Object
> parameters
= new HashMap
<>();
1251 Command command
= cmdService
.getCommand(ExportToTextCommandHandler
.COMMAND_ID
);
1252 ParameterizedCommand cmd
= ParameterizedCommand
.generateCommand(command
, parameters
);
1254 IEvaluationContext context
= handlerService
.getCurrentState();
1255 List
<TmfEventTableColumn
> exportColumns
= new ArrayList
<>();
1256 for (int i
: fTable
.getColumnOrder()) {
1257 TableColumn column
= fTable
.getColumns()[i
];
1258 // Omit the margin column and hidden columns
1259 if (isVisibleEventColumn(column
)) {
1260 exportColumns
.add(fColumns
.get(i
));
1263 context
.addVariable(ExportToTextCommandHandler
.TMF_EVENT_TABLE_COLUMNS_ID
, exportColumns
);
1265 handlerService
.executeCommandInContext(cmd
, null, context
);
1266 } catch (ExecutionException
| NotDefinedException
| NotEnabledException
| NotHandledException e
) {
1267 displayException(e
);
1272 final IAction addAsFilterAction
= new Action(Messages
.TmfEventsTable_AddAsFilterText
) {
1275 applySearchAsFilter();
1279 final IAction clearFiltersAction
= new Action(Messages
.TmfEventsTable_ClearFiltersActionText
) {
1286 final IAction collapseAction
= new Action(Messages
.TmfEventsTable_CollapseFilterMenuName
) {
1289 applyFilter(new TmfCollapseFilter());
1293 class ToggleBookmarkAction
extends Action
{
1296 public ToggleBookmarkAction(final String text
, final Long rank
) {
1303 toggleBookmark(fRank
);
1307 fHeaderPopupMenuManager
= new MenuManager();
1308 fHeaderPopupMenuManager
.setRemoveAllWhenShown(true);
1309 fHeaderPopupMenuManager
.addMenuListener(new IMenuListener() {
1311 public void menuAboutToShow(IMenuManager manager
) {
1312 for (int index
: fTable
.getColumnOrder()) {
1313 if (fTable
.getColumns()[index
].getData(Key
.WIDTH
) != null) {
1314 fHeaderPopupMenuManager
.add(createHeaderAction(fTable
.getColumns()[index
]));
1317 fHeaderPopupMenuManager
.add(new Separator());
1318 fHeaderPopupMenuManager
.add(createResetHeaderAction());
1322 fTablePopupMenuManager
= new MenuManager();
1323 fTablePopupMenuManager
.setRemoveAllWhenShown(true);
1324 fTablePopupMenuManager
.addMenuListener(new IMenuListener() {
1326 public void menuAboutToShow(final IMenuManager manager
) {
1327 if (fTable
.getSelectionIndices().length
== 1 && fTable
.getSelectionIndices()[0] == 0) {
1328 // Right-click on header row
1329 if (fHeaderState
== HeaderState
.SEARCH
) {
1330 fTablePopupMenuManager
.add(addAsFilterAction
);
1334 final Point point
= fTable
.toControl(fLastMenuCursorLocation
);
1335 final TableItem item
= fTable
.getSelection().length
> 0 ? fTable
.getSelection()[0] : null;
1337 final Rectangle imageBounds
= item
.getImageBounds(0);
1338 imageBounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
1339 if (point
.x
<= (imageBounds
.x
+ imageBounds
.width
)) {
1340 // Right-click on left margin
1341 final Long rank
= (Long
) item
.getData(Key
.RANK
);
1342 if ((rank
!= null) && (fBookmarksFile
!= null)) {
1343 if (fBookmarksMap
.containsKey(rank
)) {
1344 fTablePopupMenuManager
.add(new ToggleBookmarkAction(
1345 Messages
.TmfEventsTable_RemoveBookmarkActionText
, rank
));
1347 fTablePopupMenuManager
.add(new ToggleBookmarkAction(
1348 Messages
.TmfEventsTable_AddBookmarkActionText
, rank
));
1355 // Right-click on table
1356 if (fSelectedRank
!= -1 && fSelectedBeginRank
!= -1) {
1357 fTablePopupMenuManager
.add(copyAction
);
1358 fTablePopupMenuManager
.add(new Separator());
1360 if (fTable
.isVisible() && fRawViewer
.isVisible()) {
1361 fTablePopupMenuManager
.add(hideTableAction
);
1362 fTablePopupMenuManager
.add(hideRawAction
);
1363 } else if (!fTable
.isVisible()) {
1364 fTablePopupMenuManager
.add(showTableAction
);
1365 } else if (!fRawViewer
.isVisible()) {
1366 fTablePopupMenuManager
.add(showRawAction
);
1368 fTablePopupMenuManager
.add(exportToTextAction
);
1369 fTablePopupMenuManager
.add(new Separator());
1372 final Object data
= item
.getData();
1373 Separator separator
= null;
1374 if (data
instanceof ITmfSourceLookup
) {
1375 ITmfSourceLookup event
= (ITmfSourceLookup
) data
;
1376 if (event
.getCallsite() != null) {
1377 fTablePopupMenuManager
.add(openCallsiteAction
);
1378 separator
= new Separator();
1382 if (data
instanceof ITmfModelLookup
) {
1383 ITmfModelLookup event
= (ITmfModelLookup
) data
;
1384 if (event
.getModelUri() != null) {
1385 fTablePopupMenuManager
.add(openModelAction
);
1386 separator
= new Separator();
1389 if (separator
!= null) {
1390 fTablePopupMenuManager
.add(separator
);
1396 * Only show collapse filter if at least one trace can be
1399 boolean isCollapsible
= false;
1400 if (fTrace
!= null) {
1401 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(fTrace
)) {
1402 Class
<?
extends ITmfEvent
> eventClass
= trace
.getEventType();
1403 isCollapsible
= ITmfCollapsibleEvent
.class.isAssignableFrom(eventClass
);
1404 if (isCollapsible
) {
1410 if (isCollapsible
&& !fCollapseFilterEnabled
) {
1411 fTablePopupMenuManager
.add(collapseAction
);
1412 fTablePopupMenuManager
.add(new Separator());
1415 fTablePopupMenuManager
.add(clearFiltersAction
);
1416 final ITmfFilterTreeNode
[] savedFilters
= FilterManager
.getSavedFilters();
1417 if (savedFilters
.length
> 0) {
1418 final MenuManager subMenu
= new MenuManager(Messages
.TmfEventsTable_ApplyPresetFilterMenuName
);
1419 for (final ITmfFilterTreeNode node
: savedFilters
) {
1420 if (node
instanceof TmfFilterNode
) {
1421 final TmfFilterNode filter
= (TmfFilterNode
) node
;
1422 subMenu
.add(new Action(filter
.getFilterName()) {
1425 applyFilter(filter
);
1430 fTablePopupMenuManager
.add(subMenu
);
1432 appendToTablePopupMenu(fTablePopupMenuManager
, item
);
1436 fRawViewerPopupMenuManager
= new MenuManager();
1437 fRawViewerPopupMenuManager
.setRemoveAllWhenShown(true);
1438 fRawViewerPopupMenuManager
.addMenuListener(new IMenuListener() {
1440 public void menuAboutToShow(final IMenuManager manager
) {
1441 if (fTable
.isVisible() && fRawViewer
.isVisible()) {
1442 fRawViewerPopupMenuManager
.add(hideTableAction
);
1443 fRawViewerPopupMenuManager
.add(hideRawAction
);
1444 } else if (!fTable
.isVisible()) {
1445 fRawViewerPopupMenuManager
.add(showTableAction
);
1446 } else if (!fRawViewer
.isVisible()) {
1447 fRawViewerPopupMenuManager
.add(showRawAction
);
1449 appendToRawPopupMenu(fRawViewerPopupMenuManager
);
1453 fHeaderMenu
= fHeaderPopupMenuManager
.createContextMenu(fTable
);
1455 fTablePopup
= fTablePopupMenuManager
.createContextMenu(fTable
);
1456 fTable
.setMenu(fTablePopup
);
1458 fRawTablePopup
= fRawViewerPopupMenuManager
.createContextMenu(fRawViewer
);
1459 fRawViewer
.setMenu(fRawTablePopup
);
1463 * Append an item to the event table's pop-up menu.
1465 * @param tablePopupMenu
1467 * @param selectedItem
1468 * The item to append
1470 protected void appendToTablePopupMenu(final MenuManager tablePopupMenu
, final TableItem selectedItem
) {
1471 // override to append more actions
1475 * Append an item to the raw viewer's pop-up menu.
1477 * @param rawViewerPopupMenu
1480 protected void appendToRawPopupMenu(final MenuManager rawViewerPopupMenu
) {
1481 // override to append more actions
1485 public void dispose() {
1486 fComposite
.dispose();
1489 private void internalDispose() {
1492 PlatformUI
.getWorkbench().getThemeManager().removePropertyChangeListener(this);
1493 ColorSettingsManager
.removeColorSettingsListener(this);
1495 if ((fTrace
!= null) && fDisposeOnClose
) {
1498 fResourceManager
.dispose();
1499 if (fRawViewerPopupMenuManager
!= null) {
1500 fRawViewerPopupMenuManager
.dispose();
1502 if (fHeaderPopupMenuManager
!= null) {
1503 fHeaderPopupMenuManager
.dispose();
1505 if (fTablePopupMenuManager
!= null) {
1506 fTablePopupMenuManager
.dispose();
1513 * Assign a layout data object to this view.
1516 * The layout data to assign
1518 public void setLayoutData(final Object layoutData
) {
1519 fComposite
.setLayoutData(layoutData
);
1523 * Get the virtual table contained in this event table.
1525 * @return The TMF virtual table
1527 public TmfVirtualTable
getTable() {
1534 * @deprecated The column headers are now set at the constructor, this
1535 * shouldn't be called anymore.
1538 protected void setColumnHeaders(final org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
1543 * Set a table item's data.
1548 * Which trace event to link with this entry
1550 * Which rank this event has in the trace/experiment
1552 protected void setItemData(final TableItem item
, final ITmfEvent event
, final long rank
) {
1553 String
[] itemStrings
= getItemStrings(fColumns
, event
);
1555 // Get the actual ITmfEvent from the CachedEvent
1556 ITmfEvent tmfEvent
= event
;
1557 if (event
instanceof CachedEvent
) {
1558 tmfEvent
= ((CachedEvent
) event
).event
;
1560 item
.setText(itemStrings
);
1561 item
.setData(tmfEvent
);
1562 item
.setData(Key
.TIMESTAMP
, new TmfTimestamp(tmfEvent
.getTimestamp()));
1563 item
.setData(Key
.RANK
, rank
);
1565 final Collection
<Long
> markerIds
= fBookmarksMap
.get(rank
);
1566 if (!markerIds
.isEmpty()) {
1567 Joiner joiner
= Joiner
.on("\n -").skipNulls(); //$NON-NLS-1$
1568 List
<Object
> parts
= new ArrayList
<>();
1569 if (markerIds
.size() > 1) {
1570 parts
.add(Messages
.TmfEventsTable_MultipleBookmarksToolTip
);
1573 for (long markerId
: markerIds
) {
1574 final IMarker marker
= fBookmarksFile
.findMarker(markerId
);
1575 if (marker
!= null) {
1576 parts
.add(marker
.getAttribute(IMarker
.MESSAGE
));
1579 } catch (CoreException e
) {
1580 displayException(e
);
1582 item
.setData(Key
.BOOKMARK
, joiner
.join(parts
));
1584 item
.setData(Key
.BOOKMARK
, null);
1587 boolean searchMatch
= false;
1588 boolean searchNoMatch
= false;
1589 final ITmfFilter searchFilter
= (ITmfFilter
) fTable
.getData(Key
.SEARCH_OBJ
);
1590 if (searchFilter
!= null) {
1591 if (searchFilter
.matches(tmfEvent
)) {
1594 searchNoMatch
= true;
1598 final ColorSetting colorSetting
= ColorSettingsManager
.getColorSetting(tmfEvent
);
1599 if (searchNoMatch
) {
1600 item
.setForeground(colorSetting
.getDimmedForegroundColor());
1601 item
.setBackground(colorSetting
.getDimmedBackgroundColor());
1603 item
.setForeground(colorSetting
.getForegroundColor());
1604 item
.setBackground(colorSetting
.getBackgroundColor());
1606 item
.setFont(fFont
);
1609 if (!markerIds
.isEmpty()) {
1610 item
.setImage(SEARCH_MATCH_BOOKMARK_IMAGE
);
1612 item
.setImage(SEARCH_MATCH_IMAGE
);
1614 } else if (!markerIds
.isEmpty()) {
1615 item
.setImage(BOOKMARK_IMAGE
);
1617 item
.setImage((Image
) null);
1620 List
<StyleRange
> styleRanges
= new ArrayList
<>();
1621 for (int index
= 0; index
< fTable
.getColumns().length
; index
++) {
1622 TableColumn column
= fTable
.getColumns()[index
];
1623 String regex
= null;
1624 if (fHeaderState
== HeaderState
.SEARCH
) {
1626 regex
= (String
) column
.getData(Key
.SEARCH_TXT
);
1629 regex
= (String
) column
.getData(Key
.FILTER_TXT
);
1631 if (regex
!= null) {
1632 String text
= item
.getText(index
);
1634 Pattern pattern
= Pattern
.compile(regex
);
1635 Matcher matcher
= pattern
.matcher(text
);
1636 while (matcher
.find()) {
1637 int start
= matcher
.start();
1638 int length
= matcher
.end() - start
;
1639 Color foreground
= colorSetting
.getForegroundColor();
1640 Color background
= fHighlightColor
;
1641 StyleRange styleRange
= new StyleRange(start
, length
, foreground
, background
);
1642 styleRange
.data
= index
;
1643 styleRanges
.add(styleRange
);
1645 } catch (PatternSyntaxException e
) {
1650 if (styleRanges
.isEmpty()) {
1651 item
.setData(Key
.STYLE_RANGES
, null);
1653 item
.setData(Key
.STYLE_RANGES
, styleRanges
);
1655 item
.getParent().redraw();
1657 if ((itemStrings
[MARGIN_COLUMN_INDEX
] != null) && !itemStrings
[MARGIN_COLUMN_INDEX
].isEmpty()) {
1663 * Set the item data of the header row.
1666 * The item to use as table header
1668 protected void setHeaderRowItemData(final TableItem item
) {
1669 if (fHeaderState
== HeaderState
.NO_SEARCH
) {
1670 item
.setImage(SEARCH_IMAGE
);
1671 } else if (fHeaderState
== HeaderState
.SEARCH
) {
1672 item
.setImage(FILTER_ADD_IMAGE
);
1674 item
.setForeground(fGrayColor
);
1675 // Ignore collapse and image column
1676 for (int i
= EVENT_COLUMNS_START_INDEX
; i
< fTable
.getColumns().length
; i
++) {
1677 final TableColumn column
= fTable
.getColumns()[i
];
1678 final String filter
= (String
) column
.getData(Key
.SEARCH_TXT
);
1679 if (filter
== null) {
1680 item
.setText(i
, SEARCH_HINT
);
1681 item
.setForeground(i
, fGrayColor
);
1682 item
.setFont(i
, fFont
);
1684 item
.setText(i
, filter
);
1685 item
.setForeground(i
, fGreenColor
);
1686 item
.setFont(i
, fBoldFont
);
1692 * Set the item data of the "filter status" row.
1695 * The item to use as filter status row
1697 protected void setFilterStatusRowItemData(final TableItem item
) {
1698 for (int i
= 0; i
< fTable
.getColumns().length
; i
++) {
1699 if (i
== MARGIN_COLUMN_INDEX
) {
1700 if ((fTrace
== null) || (fFilterCheckCount
== fTrace
.getNbEvents())) {
1701 item
.setImage(FILTER_IMAGE
);
1703 item
.setImage(STOP_IMAGE
);
1707 if (i
== FILTER_SUMMARY_INDEX
) {
1708 item
.setText(FILTER_SUMMARY_INDEX
, fFilterMatchCount
+ "/" + fFilterCheckCount
); //$NON-NLS-1$
1710 item
.setText(i
, EMPTY_STRING
);
1714 item
.setData(Key
.TIMESTAMP
, null);
1715 item
.setData(Key
.RANK
, null);
1716 item
.setData(Key
.STYLE_RANGES
, null);
1717 item
.setForeground(null);
1718 item
.setBackground(null);
1719 item
.setFont(fFont
);
1723 * Create an editor for the header.
1725 private void createHeaderEditor() {
1726 final TableEditor tableEditor
= fTable
.createTableEditor();
1727 tableEditor
.horizontalAlignment
= SWT
.LEFT
;
1728 tableEditor
.verticalAlignment
= SWT
.CENTER
;
1729 tableEditor
.grabHorizontal
= true;
1730 tableEditor
.minimumWidth
= 50;
1732 // Handle the header row selection
1733 fTable
.addMouseListener(new MouseAdapter() {
1739 public void mouseDown(final MouseEvent event
) {
1740 if (event
.button
!= 1) {
1743 // Identify the selected row
1744 final Point point
= new Point(event
.x
, event
.y
);
1745 item
= fTable
.getItem(point
);
1747 // Header row selected
1748 if ((item
!= null) && (fTable
.indexOf(item
) == 0)) {
1750 // Margin column selected
1751 if (item
.getBounds(0).contains(point
)) {
1752 if (fHeaderState
== HeaderState
.SEARCH
) {
1753 applySearchAsFilter();
1758 // Identify the selected column
1760 for (int i
= 0; i
< fTable
.getColumns().length
; i
++) {
1761 final Rectangle rect
= item
.getBounds(i
);
1762 if (rect
.contains(point
)) {
1768 if (columnIndex
== -1) {
1772 column
= fTable
.getColumns()[columnIndex
];
1775 * The control that will be the editor must be a child of
1778 final Text newEditor
= (Text
) fTable
.createTableEditorControl(Text
.class);
1779 final String headerString
= (String
) column
.getData(Key
.SEARCH_TXT
);
1780 if (headerString
!= null) {
1781 newEditor
.setText(headerString
);
1783 newEditor
.addFocusListener(new FocusAdapter() {
1785 public void focusLost(final FocusEvent e
) {
1786 final boolean changed
= updateHeader(newEditor
.getText());
1792 newEditor
.addKeyListener(new KeyAdapter() {
1794 public void keyPressed(final KeyEvent e
) {
1795 if (e
.character
== SWT
.CR
) {
1796 updateHeader(newEditor
.getText());
1798 if ((e
.stateMask
& SWT
.CTRL
) != 0) {
1799 applySearchAsFilter();
1802 * Set focus on the table so that the next
1803 * carriage return goes to the next result
1805 TmfEventsTable
.this.getTable().setFocus();
1807 } else if (e
.character
== SWT
.ESC
) {
1808 tableEditor
.getEditor().dispose();
1812 newEditor
.selectAll();
1813 newEditor
.setFocus();
1814 tableEditor
.setEditor(newEditor
, item
, columnIndex
);
1819 * returns true is value was changed
1821 private boolean updateHeader(final String regex
) {
1822 if (regex
.length() > 0) {
1824 Pattern
.compile(regex
);
1825 if (regex
.equals(column
.getData(Key
.SEARCH_TXT
))) {
1826 tableEditor
.getEditor().dispose();
1829 final TmfFilterMatchesNode filter
= new TmfFilterMatchesNode(null);
1830 ITmfEventAspect
<?
> aspect
= (ITmfEventAspect
<?
>) column
.getData(Key
.ASPECT
);
1831 filter
.setEventAspect(aspect
);
1832 filter
.setRegex(regex
);
1833 column
.setData(Key
.SEARCH_OBJ
, filter
);
1834 column
.setData(Key
.SEARCH_TXT
, regex
);
1835 } catch (final PatternSyntaxException ex
) {
1836 tableEditor
.getEditor().dispose();
1837 MessageDialog
.openError(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(),
1838 ex
.getDescription(), ex
.getMessage());
1842 if (column
.getData(Key
.SEARCH_TXT
) == null) {
1843 tableEditor
.getEditor().dispose();
1846 column
.setData(Key
.SEARCH_OBJ
, null);
1847 column
.setData(Key
.SEARCH_TXT
, null);
1852 private void applyHeader() {
1854 final TmfFilterRootNode filter
= new TmfFilterRootNode();
1855 for (final TableColumn col
: fTable
.getColumns()) {
1856 final Object filterObj
= col
.getData(Key
.SEARCH_OBJ
);
1857 if (filterObj
instanceof ITmfFilterTreeNode
) {
1858 filter
.addChild((ITmfFilterTreeNode
) filterObj
);
1861 if (filter
.getChildrenCount() > 0) {
1862 fHeaderState
= HeaderState
.SEARCH
;
1863 fTable
.setData(Key
.SEARCH_OBJ
, filter
);
1866 fireSearchApplied(filter
);
1868 fHeaderState
= HeaderState
.NO_SEARCH
;
1869 fTable
.setData(Key
.SEARCH_OBJ
, null);
1871 fireSearchApplied(null);
1874 tableEditor
.getEditor().dispose();
1878 fTable
.addKeyListener(new KeyAdapter() {
1880 public void keyPressed(final KeyEvent e
) {
1882 if (e
.character
== SWT
.ESC
) {
1886 } else if (e
.character
== SWT
.DEL
) {
1887 if (fHeaderState
== HeaderState
.SEARCH
) {
1888 fHeaderState
= HeaderState
.NO_SEARCH
;
1890 for (final TableColumn column
: fTable
.getColumns()) {
1891 column
.setData(Key
.SEARCH_OBJ
, null);
1892 column
.setData(Key
.SEARCH_TXT
, null);
1893 column
.setData(Key
.FILTER_TXT
, null);
1895 fTable
.setData(Key
.SEARCH_OBJ
, null);
1897 fireSearchApplied(null);
1899 for (final TableColumn column
: fTable
.getColumns()) {
1900 column
.setData(Key
.FILTER_TXT
, null);
1904 } else if (e
.character
== SWT
.CR
) {
1905 if ((e
.stateMask
& SWT
.CTRL
) != 0) {
1906 if (fHeaderState
== HeaderState
.SEARCH
) {
1907 applySearchAsFilter();
1909 } else if ((e
.stateMask
& SWT
.SHIFT
) == 0) {
1920 * Apply the current search condition as a new filter.
1924 protected void applySearchAsFilter() {
1925 Object searchObj
= fTable
.getData(Key
.SEARCH_OBJ
);
1926 if (searchObj
instanceof ITmfFilter
) {
1927 ITmfFilter filter
= (ITmfFilter
) searchObj
;
1928 fTable
.setData(Key
.SEARCH_OBJ
, null);
1929 fireSearchApplied(null);
1930 fHeaderState
= HeaderState
.NO_SEARCH
;
1931 for (final TableColumn col
: fTable
.getColumns()) {
1932 col
.setData(Key
.FILTER_TXT
, col
.getData(Key
.SEARCH_TXT
));
1933 col
.setData(Key
.SEARCH_TXT
, null);
1934 col
.setData(Key
.SEARCH_OBJ
, null);
1936 applyFilter(filter
);
1941 * Send an event indicating a filter has been applied.
1944 * The filter that was just applied
1946 protected void fireFilterApplied(final ITmfFilter filter
) {
1947 broadcast(new TmfEventFilterAppliedSignal(this, fTrace
, filter
));
1951 * Send an event indicating that a search has been applied.
1954 * The search filter that was just applied
1956 protected void fireSearchApplied(final ITmfFilter filter
) {
1957 broadcast(new TmfEventSearchAppliedSignal(this, fTrace
, filter
));
1961 * Start the filtering thread.
1963 protected void startFilterThread() {
1964 synchronized (fFilterSyncObj
) {
1965 final ITmfFilterTreeNode filter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
1966 if (fFilterThread
== null || fFilterThread
.filter
!= filter
) {
1967 if (fFilterThread
!= null) {
1968 fFilterThread
.cancel();
1969 fFilterThreadResume
= false;
1971 fFilterThread
= new FilterThread(filter
);
1972 fFilterThread
.start();
1974 fFilterThreadResume
= true;
1980 * Stop the filtering thread.
1982 protected void stopFilterThread() {
1983 synchronized (fFilterSyncObj
) {
1984 if (fFilterThread
!= null) {
1985 fFilterThread
.cancel();
1986 fFilterThread
= null;
1987 fFilterThreadResume
= false;
1993 * Apply a filter. It is added to the existing filters.
1996 * The filter to apply
1998 protected void applyFilter(ITmfFilter filter
) {
2001 fFilterMatchCount
= 0;
2002 fFilterCheckCount
= 0;
2003 ITmfFilterTreeNode rootFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2004 if (rootFilter
== null) {
2005 rootFilter
= new TmfFilterRootNode();
2007 if (filter
instanceof TmfFilterRootNode
) {
2008 TmfFilterRootNode parentFilter
= (TmfFilterRootNode
) filter
;
2009 for (ITmfFilterTreeNode child
: parentFilter
.getChildren()) {
2010 rootFilter
.addChild(child
);
2012 } else if (filter
instanceof TmfCollapseFilter
) {
2013 fCollapseFilterEnabled
= true;
2014 } else if (filter
instanceof ITmfFilterTreeNode
) {
2015 rootFilter
.addChild((ITmfFilterTreeNode
) filter
);
2017 rootFilter
.addChild(new TmfFilterObjectNode(filter
));
2019 fCache
.applyFilter(rootFilter
, fCollapseFilterEnabled
);
2020 fHeaderBar
.addFilter(filter
);
2022 fTable
.setData(Key
.FILTER_OBJ
, rootFilter
);
2023 /* +1 for header row, +2 for top and bottom filter status rows */
2024 fTable
.setItemCount(3);
2025 startFilterThread();
2026 fireFilterApplied(rootFilter
);
2030 * Remove a filter. Any other existing filters remain applied.
2033 * The filter to remove
2036 protected void removeFilter(ITmfFilter filter
) {
2037 ITmfFilterTreeNode rootFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2038 if (rootFilter
== null) {
2043 fFilterMatchCount
= 0;
2044 fFilterCheckCount
= 0;
2045 if (filter
instanceof TmfCollapseFilter
) {
2046 fCollapseFilterEnabled
= false;
2047 } else if (filter
instanceof ITmfFilterTreeNode
) {
2048 rootFilter
.removeChild((ITmfFilterTreeNode
) filter
);
2050 for (ITmfFilterTreeNode child
: rootFilter
.getChildren()) {
2051 if (child
instanceof TmfFilterObjectNode
) {
2052 if (((TmfFilterObjectNode
) child
).getFilter().equals(filter
)) {
2053 rootFilter
.removeChild(child
);
2059 if (!rootFilter
.hasChildren() && !fCollapseFilterEnabled
) {
2063 fCache
.applyFilter(rootFilter
, fCollapseFilterEnabled
);
2064 fHeaderBar
.removeFilter(filter
);
2066 fTable
.setData(Key
.FILTER_OBJ
, rootFilter
);
2067 /* +1 for header row, +2 for top and bottom filter status rows */
2068 fTable
.setItemCount(3);
2069 startFilterThread();
2070 fireFilterApplied(rootFilter
);
2072 // Set original width
2073 fTable
.getColumns()[MARGIN_COLUMN_INDEX
].setWidth(0);
2078 * Clear all currently active filters.
2080 protected void clearFilters() {
2081 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
2086 fCache
.clearFilter();
2087 fHeaderBar
.clearFilters();
2088 fCollapseFilterEnabled
= false;
2090 for (final TableColumn column
: fTable
.getColumns()) {
2091 column
.setData(Key
.FILTER_OBJ
, null);
2092 column
.setData(Key
.FILTER_TXT
, null);
2094 fTable
.setData(Key
.FILTER_OBJ
, null);
2095 if (fTrace
!= null) {
2096 /* +1 for header row */
2097 fTable
.setItemCount((int) fTrace
.getNbEvents() + 1);
2099 /* +1 for header row */
2100 fTable
.setItemCount(1);
2102 fFilterMatchCount
= 0;
2103 fFilterCheckCount
= 0;
2104 if (fSelectedRank
>= 0) {
2105 /* +1 for header row */
2106 fTable
.setSelection((int) fSelectedRank
+ 1);
2108 fTable
.setSelection(0);
2110 fireFilterApplied(null);
2111 updateStatusLine(null);
2113 // Set original width
2114 fTable
.getColumns()[MARGIN_COLUMN_INDEX
].setWidth(0);
2119 * Wrapper Thread object for the filtering thread.
2121 protected class FilterThread
extends Thread
{
2122 private final ITmfFilterTreeNode filter
;
2123 private TmfCollapseFilter collapseFilter
= null;
2124 private TmfEventRequest request
;
2125 private boolean refreshBusy
= false;
2126 private boolean refreshPending
= false;
2127 private final Object syncObj
= new Object();
2133 * The filter this thread will be processing
2135 public FilterThread(final ITmfFilterTreeNode filter
) {
2136 super("Filter Thread"); //$NON-NLS-1$
2137 this.filter
= filter
;
2142 if (fTrace
== null) {
2145 if (fCollapseFilterEnabled
) {
2146 collapseFilter
= new TmfCollapseFilter();
2148 final int nbRequested
= (int) (fTrace
.getNbEvents() - fFilterCheckCount
);
2149 if (nbRequested
<= 0) {
2152 request
= new TmfEventRequest(ITmfEvent
.class, TmfTimeRange
.ETERNITY
,
2153 (int) fFilterCheckCount
, nbRequested
, ExecutionType
.BACKGROUND
) {
2155 public void handleData(final ITmfEvent event
) {
2156 super.handleData(event
);
2157 if (request
.isCancelled()) {
2160 boolean refresh
= false;
2161 if (filter
.matches(event
)) {
2162 if (collapseFilter
== null || collapseFilter
.matches(event
)) {
2163 final long rank
= fFilterCheckCount
;
2164 final int index
= (int) fFilterMatchCount
;
2165 fFilterMatchCount
++;
2166 fCache
.storeEvent(event
, rank
, index
);
2167 } else if (collapseFilter
!= null) {
2168 fCache
.updateCollapsedEvent((int) fFilterMatchCount
- 1);
2173 if (refresh
|| (fFilterCheckCount
% 100) == 0) {
2176 fFilterCheckCount
++;
2179 ((ITmfEventProvider
) fTrace
).sendRequest(request
);
2181 request
.waitForCompletion();
2182 } catch (final InterruptedException e
) {
2185 synchronized (fFilterSyncObj
) {
2186 fFilterThread
= null;
2187 if (fFilterThreadResume
) {
2188 fFilterThreadResume
= false;
2189 fFilterThread
= new FilterThread(filter
);
2190 fFilterThread
.start();
2196 * Refresh the filter.
2198 public void refreshTable() {
2199 synchronized (syncObj
) {
2201 refreshPending
= true;
2206 Display
.getDefault().asyncExec(new Runnable() {
2209 if (request
.isCancelled()) {
2212 if (fTable
.isDisposed()) {
2216 * +1 for header row, +2 for top and bottom filter status
2219 fTable
.setItemCount((int) fFilterMatchCount
+ 3);
2221 synchronized (syncObj
) {
2222 refreshBusy
= false;
2223 if (refreshPending
) {
2224 refreshPending
= false;
2233 * Cancel this filtering thread.
2235 public void cancel() {
2236 if (request
!= null) {
2243 * Go to the next item of a search.
2245 protected void searchNext() {
2246 synchronized (fSearchSyncObj
) {
2247 if (fSearchThread
!= null) {
2250 final ITmfFilterTreeNode searchFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.SEARCH_OBJ
);
2251 if (searchFilter
== null) {
2254 final int selectionIndex
= fTable
.getSelectionIndex();
2256 if (selectionIndex
> 0) {
2257 /* -1 for header row, +1 for next event */
2258 startIndex
= selectionIndex
;
2261 * header row is selected, start at top event
2263 /* -1 for header row */
2264 startIndex
= Math
.max(0, fTable
.getTopIndex() - 1);
2266 final ITmfFilterTreeNode eventFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2267 if (eventFilter
!= null) {
2268 // -1 for top filter status row
2269 startIndex
= Math
.max(0, startIndex
- 1);
2271 fSearchThread
= new SearchThread(searchFilter
, eventFilter
, startIndex
, fSelectedRank
, Direction
.FORWARD
);
2272 fSearchThread
.schedule();
2277 * Go to the previous item of a search.
2279 protected void searchPrevious() {
2280 synchronized (fSearchSyncObj
) {
2281 if (fSearchThread
!= null) {
2284 final ITmfFilterTreeNode searchFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.SEARCH_OBJ
);
2285 if (searchFilter
== null) {
2288 final int selectionIndex
= fTable
.getSelectionIndex();
2290 if (selectionIndex
> 0) {
2291 /* -1 for header row, -1 for previous event */
2292 startIndex
= selectionIndex
- 2;
2295 * Header row is selected, start at precedent of top event
2297 /* -1 for header row, -1 for previous event */
2298 startIndex
= fTable
.getTopIndex() - 2;
2300 final ITmfFilterTreeNode eventFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2301 if (eventFilter
!= null) {
2302 /* -1 for top filter status row */
2303 startIndex
= startIndex
- 1;
2305 fSearchThread
= new SearchThread(searchFilter
, eventFilter
, startIndex
, fSelectedRank
, Direction
.BACKWARD
);
2306 fSearchThread
.schedule();
2311 * Stop the search thread.
2313 protected void stopSearchThread() {
2314 fPendingGotoRank
= -1;
2315 synchronized (fSearchSyncObj
) {
2316 if (fSearchThread
!= null) {
2317 fSearchThread
.cancel();
2318 fSearchThread
= null;
2324 * Wrapper for the search thread.
2326 protected class SearchThread
extends Job
{
2328 private ITmfFilterTreeNode searchFilter
;
2329 private ITmfFilterTreeNode eventFilter
;
2330 private int startIndex
;
2331 private int direction
;
2333 private long foundRank
= -1;
2334 private TmfEventRequest request
;
2335 private ITmfTimestamp foundTimestamp
= null;
2340 * @param searchFilter
2342 * @param eventFilter
2345 * The index at which we should start searching
2346 * @param currentRank
2349 * In which direction should we search, forward or backwards
2351 public SearchThread(final ITmfFilterTreeNode searchFilter
,
2352 final ITmfFilterTreeNode eventFilter
, final int startIndex
,
2353 final long currentRank
, final int direction
) {
2354 super(Messages
.TmfEventsTable_SearchingJobName
);
2355 this.searchFilter
= searchFilter
;
2356 this.eventFilter
= eventFilter
;
2357 this.startIndex
= startIndex
;
2358 this.rank
= currentRank
;
2359 this.direction
= direction
;
2363 protected IStatus
run(final IProgressMonitor monitor
) {
2364 final ITmfTrace trace
= fTrace
;
2365 if (trace
== null) {
2366 return Status
.OK_STATUS
;
2368 final Display display
= Display
.getDefault();
2369 if (startIndex
< 0) {
2370 rank
= (int) trace
.getNbEvents() - 1;
2372 * -1 for header row, -3 for header and top and bottom filter
2375 } else if (startIndex
>= (fTable
.getItemCount() - (eventFilter
== null ?
1 : 3))) {
2378 int idx
= startIndex
;
2379 while (foundRank
== -1) {
2380 final CachedEvent event
= fCache
.peekEvent(idx
);
2381 if (event
== null) {
2385 if (searchFilter
.matches(event
.event
) && ((eventFilter
== null) || eventFilter
.matches(event
.event
))) {
2386 foundRank
= event
.rank
;
2387 foundTimestamp
= event
.event
.getTimestamp();
2390 if (direction
== Direction
.FORWARD
) {
2396 if (foundRank
== -1) {
2397 if (direction
== Direction
.FORWARD
) {
2399 if (rank
> (trace
.getNbEvents() - 1)) {
2405 rank
= (int) trace
.getNbEvents() - 1;
2410 final int startRank
= (int) rank
;
2411 boolean wrapped
= false;
2412 while (!monitor
.isCanceled() && (foundRank
== -1)) {
2413 int nbRequested
= (direction
== Direction
.FORWARD ? Integer
.MAX_VALUE
: Math
.min((int) rank
+ 1, trace
.getCacheSize()));
2414 if (direction
== Direction
.BACKWARD
) {
2415 rank
= Math
.max(0, rank
- trace
.getCacheSize() + 1);
2417 request
= new TmfEventRequest(ITmfEvent
.class, TmfTimeRange
.ETERNITY
,
2418 (int) rank
, nbRequested
, ExecutionType
.BACKGROUND
) {
2419 long currentRank
= rank
;
2422 public void handleData(final ITmfEvent event
) {
2423 super.handleData(event
);
2424 if (searchFilter
.matches(event
) && ((eventFilter
== null) || eventFilter
.matches(event
))) {
2425 foundRank
= currentRank
;
2426 foundTimestamp
= event
.getTimestamp();
2427 if (direction
== Direction
.FORWARD
) {
2435 ((ITmfEventProvider
) trace
).sendRequest(request
);
2437 request
.waitForCompletion();
2438 if (request
.isCancelled()) {
2439 return Status
.OK_STATUS
;
2441 } catch (final InterruptedException e
) {
2442 synchronized (fSearchSyncObj
) {
2443 fSearchThread
= null;
2445 return Status
.OK_STATUS
;
2447 if (foundRank
== -1) {
2448 if (direction
== Direction
.FORWARD
) {
2450 synchronized (fSearchSyncObj
) {
2451 fSearchThread
= null;
2453 return Status
.OK_STATUS
;
2455 nbRequested
= (int) rank
;
2461 rank
= (int) trace
.getNbEvents() - 1;
2464 if ((rank
<= startRank
) && wrapped
) {
2465 synchronized (fSearchSyncObj
) {
2466 fSearchThread
= null;
2468 return Status
.OK_STATUS
;
2473 int index
= (int) foundRank
;
2474 if (eventFilter
!= null) {
2475 index
= fCache
.getFilteredEventIndex(foundRank
);
2477 /* +1 for header row, +1 for top filter status row */
2478 final int selection
= index
+ 1 + (eventFilter
!= null ?
+1 : 0);
2480 display
.asyncExec(new Runnable() {
2483 if (monitor
.isCanceled()) {
2486 if (fTable
.isDisposed()) {
2489 fTable
.setSelection(selection
);
2490 fSelectedRank
= foundRank
;
2491 fSelectedBeginRank
= fSelectedRank
;
2492 fRawViewer
.selectAndReveal(fSelectedRank
);
2493 if (foundTimestamp
!= null) {
2494 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, foundTimestamp
));
2496 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, getSelection()));
2497 synchronized (fSearchSyncObj
) {
2498 fSearchThread
= null;
2500 updateStatusLine(null);
2503 return Status
.OK_STATUS
;
2507 protected void canceling() {
2508 if (request
!= null) {
2511 synchronized (fSearchSyncObj
) {
2512 fSearchThread
= null;
2518 * Create the resources.
2520 private void createResources() {
2521 fGrayColor
= fResourceManager
.createColor(ColorUtil
.blend(fTable
.getBackground().getRGB(), fTable
.getForeground().getRGB()));
2522 fGreenColor
= PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_DARK_GREEN
);
2526 * Initialize the fonts.
2528 private void initializeFonts() {
2529 FontRegistry fontRegistry
= PlatformUI
.getWorkbench().getThemeManager().getCurrentTheme().getFontRegistry();
2530 fFont
= fontRegistry
.get(FONT_DEFINITION_ID
);
2531 fBoldFont
= fontRegistry
.getBold(FONT_DEFINITION_ID
);
2532 fTable
.setFont(fFont
);
2533 /* Column header font cannot be set. See Bug 63038 */
2537 * Initialize the colors.
2539 private void initializeColors() {
2540 ColorRegistry colorRegistry
= PlatformUI
.getWorkbench().getThemeManager().getCurrentTheme().getColorRegistry();
2541 fHighlightColor
= colorRegistry
.get(HIGHLIGHT_COLOR_DEFINITION_ID
);
2548 public void propertyChange(PropertyChangeEvent event
) {
2549 if ((IThemeManager
.CHANGE_CURRENT_THEME
.equals(event
.getProperty())) ||
2550 (FONT_DEFINITION_ID
.equals(event
.getProperty()))) {
2554 if ((IThemeManager
.CHANGE_CURRENT_THEME
.equals(event
.getProperty())) ||
2555 (HIGHLIGHT_COLOR_DEFINITION_ID
.equals(event
.getProperty()))) {
2565 * Whether or not a pack was done in this call. Otherwise, it was already done by a
2570 protected boolean packColumns() {
2574 fTable
.setRedraw(false);
2576 TableColumn tableColumns
[] = fTable
.getColumns();
2577 for (int i
= 0; i
< tableColumns
.length
; i
++) {
2578 final TableColumn column
= tableColumns
[i
];
2579 packSingleColumn(i
, column
);
2583 // Make sure that redraw is always enabled.
2584 fTable
.setRedraw(true);
2590 private void packMarginColumn() {
2591 TableColumn
[] columns
= fTable
.getColumns();
2592 if (columns
.length
> 0) {
2593 packSingleColumn(0, columns
[0]);
2597 private void packSingleColumn(int i
, final TableColumn column
) {
2598 final int headerWidth
= column
.getWidth();
2601 * Workaround for Linux which doesn't consider the image width of
2602 * search/filter row in TableColumn.pack() after having executed
2603 * TableItem.setImage(null) for other rows than search/filter row.
2605 if (IS_LINUX
&& (i
== 0) && fCollapseFilterEnabled
) {
2606 column
.setWidth(column
.getWidth() + SEARCH_IMAGE
.getBounds().width
);
2609 if (column
.getWidth() < headerWidth
) {
2610 column
.setWidth(headerWidth
);
2615 * Returns true if the column is a visible event column.
2617 * @param column the column
2618 * @return false if the column is the margin column or hidden, true otherwise
2620 private static boolean isVisibleEventColumn(TableColumn column
) {
2621 if (column
.getData(Key
.ASPECT
) == TmfMarginColumn
.MARGIN_ASPECT
) {
2624 if (!column
.getResizable() && column
.getWidth() == 0) {
2631 * Get the array of item strings (e.g., what to display in each cell of the
2632 * table row) corresponding to the columns and trace event passed in
2633 * parameter. The order of the Strings in the returned array will correspond
2634 * to the iteration order of 'columns'.
2637 * To ensure consistent results, make sure only call this within a scope
2638 * synchronized on 'columns'! If the order of 'columns' changes right after
2639 * this method is called, the returned value won't be ordered correctly
2642 private static String
[] getItemStrings(List
<TmfEventTableColumn
> columns
, ITmfEvent event
) {
2643 if (event
== null) {
2644 return EMPTY_STRING_ARRAY
;
2646 synchronized (columns
) {
2647 List
<String
> itemStrings
= new ArrayList
<>(columns
.size());
2648 for (TmfEventTableColumn column
: columns
) {
2649 ITmfEvent passedEvent
= event
;
2650 if (!(column
instanceof TmfMarginColumn
) && (event
instanceof CachedEvent
)) {
2652 * Make sure that the event object from the trace is passed
2653 * to all columns but the TmfMarginColumn
2655 passedEvent
= ((CachedEvent
) event
).event
;
2657 if (passedEvent
== null) {
2658 itemStrings
.add(EMPTY_STRING
);
2660 itemStrings
.add(column
.getItemString(passedEvent
));
2664 return itemStrings
.toArray(new String
[0]);
2669 * Get the contents of the row in the events table corresponding to an
2670 * event. The order of the elements corresponds to the current order of the
2674 * The event printed in this row
2675 * @return The event row entries
2677 public String
[] getItemStrings(ITmfEvent event
) {
2678 List
<TmfEventTableColumn
> columns
= new ArrayList
<>();
2679 for (int i
: fTable
.getColumnOrder()) {
2680 columns
.add(fColumns
.get(i
));
2682 return getItemStrings(columns
, event
);
2686 * Returns an array of zero-relative integers that map the creation order of
2687 * the receiver's columns to the order in which they are currently being
2690 * Specifically, the indices of the returned array represent the current
2691 * visual order of the columns, and the contents of the array represent the
2692 * creation order of the columns.
2694 * @return the current visual order of the receiver's columns
2697 public int[] getColumnOrder() {
2698 return fColumnOrder
;
2702 * Sets the order that the columns in the receiver should be displayed in to
2703 * the given argument which is described in terms of the zero-relative
2704 * ordering of when the columns were added.
2706 * Specifically, the contents of the array represent the original position
2707 * of each column at the time its creation.
2710 * the new order to display the columns
2713 public void setColumnOrder(int[] order
) {
2714 if (order
== null || order
.length
!= fTable
.getColumns().length
) {
2717 fTable
.setColumnOrder(order
);
2718 fColumnOrder
= fTable
.getColumnOrder();
2722 * Notify this table that is got the UI focus.
2724 public void setFocus() {
2729 * Registers context menus with a site for extension. This method can be
2730 * called for part sites so that context menu contributions can be added.
2733 * the site that the context menus will be registered for
2737 public void registerContextMenus(IWorkbenchPartSite site
) {
2738 if (site
instanceof IEditorSite
) {
2739 IEditorSite editorSite
= (IEditorSite
) site
;
2740 // Don't use the editor input when adding contributions, otherwise
2741 // we get too many unwanted things.
2742 editorSite
.registerContextMenu(fTablePopupMenuManager
, this, false);
2747 * Assign a new trace to this event table.
2750 * The trace to assign to this event table
2751 * @param disposeOnClose
2752 * true if the trace should be disposed when the table is
2755 public void setTrace(final ITmfTrace trace
, final boolean disposeOnClose
) {
2756 if ((fTrace
!= null) && fDisposeOnClose
) {
2761 fDisposeOnClose
= disposeOnClose
;
2763 // Perform the updates on the UI thread
2764 PlatformUI
.getWorkbench().getDisplay().syncExec(new Runnable() {
2768 fSelectedBeginRank
= -1;
2770 fCache
.setTrace(trace
); // Clear the cache
2771 if (trace
!= null) {
2772 if (!fTable
.isDisposed()) {
2773 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
2774 // +1 for header row
2775 fTable
.setItemCount((int) trace
.getNbEvents() + 1);
2778 fFilterMatchCount
= 0;
2779 fFilterCheckCount
= 0;
2781 * +1 for header row, +2 for top and bottom filter
2784 fTable
.setItemCount(3);
2785 startFilterThread();
2789 fRawViewer
.setTrace(trace
);
2795 * Assign the status line manager
2797 * @param statusLineManager
2798 * The status line manager, or null to disable status line
2801 public void setStatusLineManager(IStatusLineManager statusLineManager
) {
2802 if (fStatusLineManager
!= null && statusLineManager
== null) {
2803 fStatusLineManager
.setMessage(EMPTY_STRING
);
2805 fStatusLineManager
= statusLineManager
;
2808 private void updateStatusLine(ITmfTimestamp delta
) {
2809 if (fStatusLineManager
!= null) {
2810 if (delta
!= null) {
2811 fStatusLineManager
.setMessage("\u0394: " + delta
); //$NON-NLS-1$
2813 fStatusLineManager
.setMessage(null);
2818 // ------------------------------------------------------------------------
2820 // ------------------------------------------------------------------------
2823 * Notify that the event cache has been updated
2826 * Also notify if the populating of the cache is complete, or
2829 public void cacheUpdated(final boolean completed
) {
2830 synchronized (fCacheUpdateSyncObj
) {
2831 if (fCacheUpdateBusy
) {
2832 fCacheUpdatePending
= true;
2833 fCacheUpdateCompleted
= completed
;
2836 fCacheUpdateBusy
= true;
2838 // Event cache is now updated. Perform update on the UI thread
2839 PlatformUI
.getWorkbench().getDisplay().asyncExec(new Runnable() {
2842 if (!fTable
.isDisposed()) {
2847 populateCompleted();
2849 synchronized (fCacheUpdateSyncObj
) {
2850 fCacheUpdateBusy
= false;
2851 if (fCacheUpdatePending
) {
2852 fCacheUpdatePending
= false;
2853 cacheUpdated(fCacheUpdateCompleted
);
2861 * Callback for when populating the table is complete.
2863 protected void populateCompleted() {
2864 // Nothing by default;
2867 // ------------------------------------------------------------------------
2868 // ISelectionProvider
2869 // ------------------------------------------------------------------------
2872 public void addSelectionChangedListener(ISelectionChangedListener listener
) {
2873 selectionChangedListeners
.add(listener
);
2877 public ISelection
getSelection() {
2878 if (fTable
== null || fTable
.isDisposed()) {
2879 return StructuredSelection
.EMPTY
;
2881 List
<Object
> list
= new ArrayList
<>(fTable
.getSelection().length
);
2882 for (TableItem item
: fTable
.getSelection()) {
2883 if (item
.getData() != null) {
2884 list
.add(item
.getData());
2887 return new StructuredSelection(list
);
2891 public void removeSelectionChangedListener(ISelectionChangedListener listener
) {
2892 selectionChangedListeners
.remove(listener
);
2896 public void setSelection(ISelection selection
) {
2901 * Notifies any selection changed listeners that the viewer's selection has
2902 * changed. Only listeners registered at the time this method is called are
2906 * a selection changed event
2908 * @see ISelectionChangedListener#selectionChanged
2910 protected void fireSelectionChanged(final SelectionChangedEvent event
) {
2911 Object
[] listeners
= selectionChangedListeners
.getListeners();
2912 for (int i
= 0; i
< listeners
.length
; ++i
) {
2913 final ISelectionChangedListener l
= (ISelectionChangedListener
) listeners
[i
];
2914 SafeRunnable
.run(new SafeRunnable() {
2917 l
.selectionChanged(event
);
2923 // ------------------------------------------------------------------------
2924 // Bookmark handling
2925 // ------------------------------------------------------------------------
2928 * Add a bookmark to this event table.
2930 * @param bookmarksFile
2931 * The file to use for the bookmarks
2933 public void addBookmark(final IFile bookmarksFile
) {
2934 fBookmarksFile
= bookmarksFile
;
2935 final TableItem
[] selection
= fTable
.getSelection();
2936 if (selection
.length
> 0) {
2937 final TableItem tableItem
= selection
[0];
2938 if (tableItem
.getData(Key
.RANK
) != null) {
2939 final StringBuffer defaultMessage
= new StringBuffer();
2940 for (int i
: fTable
.getColumnOrder()) {
2941 TableColumn column
= fTable
.getColumns()[i
];
2942 // Omit the margin column and hidden columns
2943 if (isVisibleEventColumn(column
)) {
2944 if (defaultMessage
.length() > 0) {
2945 defaultMessage
.append(", "); //$NON-NLS-1$
2947 defaultMessage
.append(tableItem
.getText(i
));
2950 final AddBookmarkDialog dialog
= new AddBookmarkDialog(
2951 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(), defaultMessage
.toString());
2952 if (dialog
.open() == Window
.OK
) {
2953 final String message
= dialog
.getValue();
2955 final Long rank
= (Long
) tableItem
.getData(Key
.RANK
);
2956 final String location
= NLS
.bind(Messages
.TmfMarker_LocationRank
, rank
.toString());
2957 final ITmfTimestamp timestamp
= (ITmfTimestamp
) tableItem
.getData(Key
.TIMESTAMP
);
2958 final long[] id
= new long[1];
2959 ResourcesPlugin
.getWorkspace().run(new IWorkspaceRunnable() {
2961 public void run(IProgressMonitor monitor
) throws CoreException
{
2962 final IMarker bookmark
= bookmarksFile
.createMarker(IMarker
.BOOKMARK
);
2963 bookmark
.setAttribute(IMarker
.MESSAGE
, message
.toString());
2964 bookmark
.setAttribute(IMarker
.LOCATION
, location
);
2965 bookmark
.setAttribute(ITmfMarker
.MARKER_RANK
, rank
.toString());
2966 bookmark
.setAttribute(ITmfMarker
.MARKER_TIME
, Long
.toString(new TmfNanoTimestamp(timestamp
).getValue()));
2967 bookmark
.setAttribute(ITmfMarker
.MARKER_COLOR
, dialog
.getColorValue().toString());
2968 id
[0] = bookmark
.getId();
2971 fBookmarksMap
.put(rank
, id
[0]);
2973 } catch (final CoreException e
) {
2974 displayException(e
);
2983 * Add one or more bookmarks to this event table.
2986 * The bookmarks to add
2989 public void addBookmark(final IMarker
... bookmarks
) {
2990 for (IMarker bookmark
: bookmarks
) {
2991 /* try location as an integer for backward compatibility */
2992 long rank
= bookmark
.getAttribute(IMarker
.LOCATION
, -1);
2994 String rankString
= bookmark
.getAttribute(ITmfMarker
.MARKER_RANK
, (String
) null);
2995 if (rankString
!= null) {
2997 rank
= Long
.parseLong(rankString
);
2998 } catch (NumberFormatException e
) {
2999 Activator
.getDefault().logError("Invalid marker rank", e
); //$NON-NLS-1$
3004 fBookmarksMap
.put(rank
, bookmark
.getId());
3011 * Remove one or more bookmarks from this event table.
3014 * The bookmarks to remove
3017 public void removeBookmark(final IMarker
... bookmarks
) {
3018 for (IMarker bookmark
: bookmarks
) {
3019 for (final Entry
<Long
, Long
> entry
: fBookmarksMap
.entries()) {
3020 if (entry
.getValue().equals(bookmark
.getId())) {
3021 fBookmarksMap
.remove(entry
.getKey(), entry
.getValue());
3029 private void toggleBookmark(final Long rank
) {
3030 if (fBookmarksFile
== null) {
3033 if (fBookmarksMap
.containsKey(rank
)) {
3034 final Collection
<Long
> markerIds
= fBookmarksMap
.removeAll(rank
);
3037 for (long markerId
: markerIds
) {
3038 final IMarker bookmark
= fBookmarksFile
.findMarker(markerId
);
3039 if (bookmark
!= null) {
3043 } catch (final CoreException e
) {
3044 displayException(e
);
3047 addBookmark(fBookmarksFile
);
3052 * Refresh the bookmarks assigned to this trace, from the contents of a
3055 * @param bookmarksFile
3056 * The bookmark file to use
3058 public void refreshBookmarks(final IFile bookmarksFile
) {
3059 fBookmarksFile
= bookmarksFile
;
3060 if (bookmarksFile
== null) {
3061 fBookmarksMap
.clear();
3066 fBookmarksMap
.clear();
3067 IMarker
[] bookmarks
= bookmarksFile
.findMarkers(IMarker
.BOOKMARK
, false, IResource
.DEPTH_ZERO
);
3068 addBookmark(bookmarks
);
3069 } catch (final CoreException e
) {
3070 displayException(e
);
3075 public void gotoMarker(final IMarker marker
) {
3076 ITmfTimestamp tsBegin
= null;
3077 ITmfTimestamp tsEnd
= null;
3078 /* try location as an integer for backward compatibility */
3079 long rank
= marker
.getAttribute(IMarker
.LOCATION
, -1);
3081 String rankString
= marker
.getAttribute(ITmfMarker
.MARKER_RANK
, (String
) null);
3083 rank
= Long
.parseLong(rankString
);
3084 } catch (NumberFormatException e
) {
3089 String timeString
= marker
.getAttribute(ITmfMarker
.MARKER_TIME
, (String
) null);
3090 long time
= Long
.parseLong(timeString
);
3091 tsBegin
= new TmfNanoTimestamp(time
);
3092 String durationString
= marker
.getAttribute(ITmfMarker
.MARKER_DURATION
, (String
) null);
3093 long duration
= Long
.parseLong(durationString
);
3094 tsEnd
= new TmfNanoTimestamp(time
+ duration
);
3095 } catch (NumberFormatException e
) {
3098 if (rank
== -1 && tsBegin
!= null) {
3099 final ITmfContext context
= fTrace
.seekEvent(tsBegin
);
3100 rank
= context
.getRank();
3104 int index
= (int) rank
;
3105 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
3106 // +1 for top filter status row
3107 index
= fCache
.getFilteredEventIndex(rank
) + 1;
3108 } else if (rank
>= fTable
.getItemCount()) {
3109 fPendingGotoRank
= rank
;
3111 fSelectedRank
= rank
;
3112 fSelectedBeginRank
= fSelectedRank
;
3113 fTable
.setSelection(index
+ 1); // +1 for header row
3114 updateStatusLine(null);
3115 if (tsBegin
!= null) {
3116 if (tsEnd
!= null) {
3117 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, tsBegin
, tsEnd
));
3119 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, tsBegin
));
3125 // ------------------------------------------------------------------------
3127 // ------------------------------------------------------------------------
3130 public void colorSettingsChanged(final ColorSetting
[] colorSettings
) {
3134 // ------------------------------------------------------------------------
3136 // ------------------------------------------------------------------------
3139 * Handler for the trace updated signal
3142 * The incoming signal
3145 public void traceUpdated(final TmfTraceUpdatedSignal signal
) {
3146 if ((signal
.getTrace() != fTrace
) || fTable
.isDisposed()) {
3149 // Perform the refresh on the UI thread
3150 Display
.getDefault().asyncExec(new Runnable() {
3153 if (!fTable
.isDisposed() && (fTrace
!= null)) {
3154 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
3155 /* +1 for header row */
3156 fTable
.setItemCount((int) fTrace
.getNbEvents() + 1);
3157 /* +1 for header row */
3158 if ((fPendingGotoRank
!= -1) && ((fPendingGotoRank
+ 1) < fTable
.getItemCount())) {
3159 /* +1 for header row */
3160 fTable
.setSelection((int) fPendingGotoRank
+ 1);
3161 fPendingGotoRank
= -1;
3162 updateStatusLine(null);
3165 startFilterThread();
3168 if (!fRawViewer
.isDisposed() && (fTrace
!= null)) {
3169 fRawViewer
.refreshEventCount();
3176 * Handler for the selection range signal.
3179 * The incoming signal
3183 public void selectionRangeUpdated(final TmfSelectionRangeUpdatedSignal signal
) {
3184 if ((signal
.getSource() != this) && (fTrace
!= null) && (!fTable
.isDisposed())) {
3187 * Create a request for one event that will be queued after other
3188 * ongoing requests. When this request is completed do the work to
3189 * select the actual event with the timestamp specified in the
3190 * signal. This procedure prevents the method fTrace.getRank() from
3191 * interfering and delaying ongoing requests.
3193 final TmfEventRequest subRequest
= new TmfEventRequest(ITmfEvent
.class,
3194 TmfTimeRange
.ETERNITY
, 0, 1, ExecutionType
.FOREGROUND
) {
3196 TmfTimestamp ts
= new TmfTimestamp(signal
.getBeginTime());
3197 TmfTimestamp tf
= new TmfTimestamp(signal
.getEndTime());
3200 public void handleSuccess() {
3201 super.handleSuccess();
3202 if (fTrace
== null) {
3206 final Pair
<Long
, Long
> selection
= getSelectedRanks();
3207 updateDisplayWithSelection(selection
.getFirst().longValue(), selection
.getSecond().longValue());
3211 * Verify if the event is within the trace range and adjust if
3214 * @return A pair of rank representing the selected area
3216 private Pair
<Long
, Long
> getSelectedRanks() {
3218 /* Clamp the timestamp value to fit inside of the trace */
3219 ITmfTimestamp timestampBegin
= ts
;
3220 if (timestampBegin
.compareTo(fTrace
.getStartTime()) < 0) {
3221 timestampBegin
= fTrace
.getStartTime();
3223 if (timestampBegin
.compareTo(fTrace
.getEndTime()) > 0) {
3224 timestampBegin
= fTrace
.getEndTime();
3227 ITmfTimestamp timestampEnd
= tf
;
3228 if (timestampEnd
.compareTo(fTrace
.getStartTime()) < 0) {
3229 timestampEnd
= fTrace
.getStartTime();
3231 if (timestampEnd
.compareTo(fTrace
.getEndTime()) > 0) {
3232 timestampEnd
= fTrace
.getEndTime();
3239 ITmfContext contextBegin
;
3240 ITmfContext contextEnd
;
3242 /* Adjust the rank of the selection to the right range */
3243 if (timestampBegin
.compareTo(timestampEnd
) > 0) {
3245 contextEnd
= fTrace
.seekEvent(te
);
3246 rankEnd
= contextEnd
.getRank();
3247 contextEnd
.dispose();
3248 /* To include all events at the begin time, seek at the next nanosecond and then use the previous rank */
3249 tb
= timestampBegin
.normalize(1, ITmfTimestamp
.NANOSECOND_SCALE
);
3250 if (tb
.compareTo(fTrace
.getEndTime()) <= 0) {
3251 contextBegin
= fTrace
.seekEvent(tb
);
3252 rankBegin
= contextBegin
.getRank();
3253 contextBegin
.dispose();
3255 rankBegin
= ITmfContext
.UNKNOWN_RANK
;
3257 rankBegin
= (rankBegin
== ITmfContext
.UNKNOWN_RANK ? fTrace
.getNbEvents() : rankBegin
) - 1;
3258 /* If no events in selection range, select only the next event */
3259 rankBegin
= rankBegin
>= rankEnd ? rankBegin
: rankEnd
;
3261 tb
= timestampBegin
;
3262 contextBegin
= fTrace
.seekEvent(tb
);
3263 rankBegin
= contextBegin
.getRank();
3264 contextBegin
.dispose();
3265 /* To include all events at the end time, seek at the next nanosecond and then use the previous rank */
3266 te
= timestampEnd
.normalize(1, ITmfTimestamp
.NANOSECOND_SCALE
);
3267 if (te
.compareTo(fTrace
.getEndTime()) <= 0) {
3268 contextEnd
= fTrace
.seekEvent(te
);
3269 rankEnd
= contextEnd
.getRank();
3270 contextEnd
.dispose();
3272 rankEnd
= ITmfContext
.UNKNOWN_RANK
;
3274 rankEnd
= (rankEnd
== ITmfContext
.UNKNOWN_RANK ? fTrace
.getNbEvents() : rankEnd
) - 1;
3275 /* If no events in selection range, select only the next event */
3276 rankEnd
= rankEnd
>= rankBegin ? rankEnd
: rankBegin
;
3278 return new Pair
<>(Long
.valueOf(rankBegin
), Long
.valueOf(rankEnd
));
3281 private void updateDisplayWithSelection(final long rankBegin
, final long rankEnd
) {
3282 PlatformUI
.getWorkbench().getDisplay().asyncExec(new Runnable() {
3285 // Return if table is disposed
3286 if (fTable
.isDisposed()) {
3290 fSelectedRank
= rankEnd
;
3291 long toReveal
= fSelectedBeginRank
!= rankBegin ? rankBegin
: rankEnd
;
3292 fSelectedBeginRank
= rankBegin
;
3293 int indexBegin
= (int) rankBegin
;
3294 int indexEnd
= (int) rankEnd
;
3296 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
3297 /* +1 for top filter status row */
3298 indexBegin
= fCache
.getFilteredEventIndex(rankBegin
) + 1;
3299 indexEnd
= rankEnd
== rankBegin ? indexBegin
: fCache
.getFilteredEventIndex(rankEnd
) + 1;
3301 /* +1 for header row */
3302 fTable
.setSelectionRange(indexBegin
+ 1, indexEnd
+ 1);
3303 fRawViewer
.selectAndReveal(toReveal
);
3304 updateStatusLine(null);
3310 ((ITmfEventProvider
) fTrace
).sendRequest(subRequest
);
3314 // ------------------------------------------------------------------------
3316 // ------------------------------------------------------------------------
3319 * Display an exception in a message box
3324 private static void displayException(final Exception e
) {
3325 final MessageBox mb
= new MessageBox(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell());
3326 mb
.setText(e
.getClass().getSimpleName());
3327 mb
.setMessage(e
.getMessage());
3334 public void refresh() {
3341 * Margin column for images and special text (e.g. collapse count)
3343 private static final class TmfMarginColumn
extends TmfEventTableColumn
{
3345 private static final @NonNull ITmfEventAspect
<String
> MARGIN_ASPECT
=
3346 new ITmfEventAspect
<String
>() {
3349 public String
getName() {
3350 return EMPTY_STRING
;
3354 public String
resolve(ITmfEvent event
) {
3355 if (!(event
instanceof CachedEvent
) || ((CachedEvent
) event
).repeatCount
== 0) {
3356 return EMPTY_STRING
;
3358 return "+" + ((CachedEvent
) event
).repeatCount
; //$NON-NLS-1$
3362 public String
getHelpText() {
3363 return EMPTY_STRING
;
3370 public TmfMarginColumn() {
3371 super(MARGIN_ASPECT
);