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
.TmfTimeRange
;
156 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
157 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
158 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
159 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTrace
;
160 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
161 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.location
.ITmfLocation
;
162 import org
.eclipse
.tracecompass
.tmf
.core
.util
.Pair
;
163 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.TmfEventsCache
.CachedEvent
;
164 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.TmfEventsTableHeader
.IEventsTableHeaderListener
;
165 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
.columns
.TmfEventTableColumn
;
166 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.ColorSetting
;
167 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.ColorSettingsManager
;
168 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.colors
.IColorSettingsListener
;
169 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.filter
.FilterManager
;
170 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.rawviewer
.TmfRawEventViewer
;
171 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.TmfVirtualTable
;
172 import org
.eclipse
.ui
.IEditorPart
;
173 import org
.eclipse
.ui
.IEditorSite
;
174 import org
.eclipse
.ui
.IWorkbenchPage
;
175 import org
.eclipse
.ui
.IWorkbenchPartSite
;
176 import org
.eclipse
.ui
.PlatformUI
;
177 import org
.eclipse
.ui
.commands
.ICommandService
;
178 import org
.eclipse
.ui
.dialogs
.ListDialog
;
179 import org
.eclipse
.ui
.handlers
.IHandlerService
;
180 import org
.eclipse
.ui
.ide
.IDE
;
181 import org
.eclipse
.ui
.ide
.IGotoMarker
;
182 import org
.eclipse
.ui
.texteditor
.ITextEditor
;
183 import org
.eclipse
.ui
.themes
.ColorUtil
;
184 import org
.eclipse
.ui
.themes
.IThemeManager
;
186 import com
.google
.common
.base
.Joiner
;
187 import com
.google
.common
.collect
.HashMultimap
;
188 import com
.google
.common
.collect
.ImmutableList
;
189 import com
.google
.common
.collect
.Multimap
;
192 * The generic TMF Events table
194 * This is a view that will list events that are read from a trace.
196 * @author Francois Chouinard
197 * @author Patrick Tasse
199 public class TmfEventsTable
extends TmfComponent
implements IGotoMarker
, IColorSettingsListener
, ISelectionProvider
, IPropertyChangeListener
{
202 * Empty string array, used by {@link #getItemStrings}.
204 protected static final String
@NonNull [] EMPTY_STRING_ARRAY
= new String
[0];
209 protected static final @NonNull String EMPTY_STRING
= ""; //$NON-NLS-1$
211 private static final boolean IS_LINUX
= System
.getProperty("os.name").contains("Linux") ?
true : false; //$NON-NLS-1$ //$NON-NLS-2$
213 private static final String FONT_DEFINITION_ID
= "org.eclipse.tracecompass.tmf.ui.font.eventtable"; //$NON-NLS-1$
214 private static final String HIGHLIGHT_COLOR_DEFINITION_ID
= "org.eclipse.tracecompass.tmf.ui.color.eventtable.highlight"; //$NON-NLS-1$
216 private static final Image BOOKMARK_IMAGE
= Activator
.getDefault().getImageFromPath(
217 "icons/elcl16/bookmark_obj.gif"); //$NON-NLS-1$
218 private static final Image SEARCH_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/search.gif"); //$NON-NLS-1$
219 private static final Image SEARCH_MATCH_IMAGE
= Activator
.getDefault().getImageFromPath(
220 "icons/elcl16/search_match.gif"); //$NON-NLS-1$
221 private static final Image SEARCH_MATCH_BOOKMARK_IMAGE
= Activator
.getDefault().getImageFromPath(
222 "icons/elcl16/search_match_bookmark.gif"); //$NON-NLS-1$
223 private static final Image FILTER_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/filter_items.gif"); //$NON-NLS-1$
224 private static final Image FILTER_ADD_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/filter_add.gif"); //$NON-NLS-1$
225 private static final Image STOP_IMAGE
= Activator
.getDefault().getImageFromPath("icons/elcl16/stop.gif"); //$NON-NLS-1$
226 private static final String SEARCH_HINT
= Messages
.TmfEventsTable_SearchHint
;
227 private static final int MAX_CACHE_SIZE
= 1000;
229 private static final int MARGIN_COLUMN_INDEX
= 0;
230 private static final int FILTER_SUMMARY_INDEX
= 1;
231 private static final int EVENT_COLUMNS_START_INDEX
= MARGIN_COLUMN_INDEX
+ 1;
233 private final class ColumnMovedListener
extends ControlAdapter
{
235 * Make sure that the margin column is always first and keep the column
236 * order variable up to date.
239 public void controlMoved(ControlEvent e
) {
240 int[] order
= fTable
.getColumnOrder();
241 if (order
[0] == MARGIN_COLUMN_INDEX
) {
242 fColumnOrder
= order
;
245 for (int i
= order
.length
- 1; i
> 0; i
--) {
246 if (order
[i
] == MARGIN_COLUMN_INDEX
) {
247 order
[i
] = order
[i
- 1];
248 order
[i
- 1] = MARGIN_COLUMN_INDEX
;
251 fTable
.setColumnOrder(order
);
252 fColumnOrder
= fTable
.getColumnOrder();
256 private final class TableSelectionListener
extends SelectionAdapter
{
258 public void widgetSelected(final SelectionEvent e
) {
259 if (e
.item
== null) {
262 updateStatusLine(null);
263 if (fTable
.getSelectionIndices().length
> 0) {
264 if (e
.item
.getData(Key
.RANK
) instanceof Long
) {
265 fSelectedRank
= (Long
) e
.item
.getData(Key
.RANK
);
266 fRawViewer
.selectAndReveal((Long
) e
.item
.getData(Key
.RANK
));
270 if (fTable
.getSelectionIndices().length
== 1) {
271 fSelectedBeginRank
= fSelectedRank
;
273 if (e
.item
.getData(Key
.TIMESTAMP
) instanceof ITmfTimestamp
) {
274 final ITmfTimestamp ts
= NonNullUtils
.checkNotNull((ITmfTimestamp
) e
.item
.getData(Key
.TIMESTAMP
));
275 if (fTable
.getSelectionIndices().length
== 1) {
276 fSelectedBeginTimestamp
= ts
;
278 ITmfTimestamp selectedBeginTimestamp
= fSelectedBeginTimestamp
;
279 if (selectedBeginTimestamp
!= null) {
280 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, selectedBeginTimestamp
, ts
));
281 if (fTable
.getSelectionIndices().length
== 2) {
282 updateStatusLine(ts
.getDelta(selectedBeginTimestamp
));
286 if (fTable
.getSelectionIndices().length
== 1) {
287 fSelectedBeginTimestamp
= null;
291 if (e
.item
.getData() instanceof ITmfEvent
) {
292 broadcast(new TmfEventSelectedSignal(TmfEventsTable
.this, (ITmfEvent
) e
.item
.getData()));
293 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, new StructuredSelection(e
.item
.getData())));
295 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, StructuredSelection
.EMPTY
));
300 private final class MouseDoubleClickListener
extends MouseAdapter
{
302 public void mouseDoubleClick(final MouseEvent event
) {
303 if (event
.button
!= 1) {
306 // Identify the selected row
307 final Point point
= new Point(event
.x
, event
.y
);
308 final TableItem item
= fTable
.getItem(point
);
310 final Rectangle imageBounds
= item
.getImageBounds(0);
311 imageBounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
312 if (imageBounds
.contains(point
)) {
313 final Long rank
= (Long
) item
.getData(Key
.RANK
);
315 toggleBookmark(rank
);
322 private final class RawSelectionListener
implements Listener
{
324 public void handleEvent(final Event e
) {
325 if (fTrace
== null) {
329 if (e
.data
instanceof Long
) {
330 rank
= (Long
) e
.data
;
331 } else if (e
.data
instanceof ITmfLocation
) {
332 rank
= findRank((ITmfLocation
) e
.data
);
336 int index
= (int) rank
;
337 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
338 // +1 for top filter status row
339 index
= fCache
.getFilteredEventIndex(rank
) + 1;
342 fTable
.setSelection(index
+ 1);
343 fSelectedRank
= rank
;
344 fSelectedBeginRank
= fSelectedRank
;
345 updateStatusLine(null);
346 final TableItem
[] selection
= fTable
.getSelection();
347 if ((selection
!= null) && (selection
.length
> 0)) {
348 TableItem item
= fTable
.getSelection()[0];
349 final TmfTimestamp ts
= (TmfTimestamp
) item
.getData(Key
.TIMESTAMP
);
351 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, ts
));
353 if (item
.getData() instanceof ITmfEvent
) {
354 broadcast(new TmfEventSelectedSignal(TmfEventsTable
.this, (ITmfEvent
) item
.getData()));
355 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, new StructuredSelection(item
.getData())));
357 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, StructuredSelection
.EMPTY
));
362 private long findRank(final ITmfLocation selectedLocation
) {
363 final double selectedRatio
= fTrace
.getLocationRatio(selectedLocation
);
365 long high
= fTrace
.getNbEvents();
366 long rank
= high
/ 2;
368 while (ratio
!= selectedRatio
) {
369 ITmfContext context
= fTrace
.seekEvent(rank
);
370 ratio
= fTrace
.getLocationRatio(context
.getLocation());
372 if (ratio
< selectedRatio
) {
374 rank
= (rank
+ high
) / 2;
375 } else if (ratio
> selectedRatio
) {
377 rank
= (rank
+ low
) / 2;
379 if ((high
- low
) < 2) {
387 private final class SetDataListener
implements Listener
{
389 public void handleEvent(final Event event
) {
391 final TableItem item
= (TableItem
) event
.item
;
392 int index
= event
.index
- 1; // -1 for the header row
394 if (event
.index
== 0) {
395 setHeaderRowItemData(item
);
399 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
400 if ((event
.index
== 1) || (event
.index
== (fTable
.getItemCount() - 1))) {
401 setFilterStatusRowItemData(item
);
404 /* -1 for top filter status row */
408 final CachedEvent cachedEvent
= fCache
.getEvent(index
);
409 if (cachedEvent
!= null) {
410 setItemData(item
, cachedEvent
, cachedEvent
.rank
);
414 // Else, fill the cache asynchronously (and off the UI thread)
419 private static final class PainItemListener
implements Listener
{
421 public void handleEvent(Event event
) {
422 TableItem item
= (TableItem
) event
.item
;
424 // we promised to paint the table item's foreground
426 Image image
= item
.getImage(event
.index
);
428 Rectangle imageBounds
= item
.getImageBounds(event
.index
);
430 * The image bounds don't match the default image position.
433 gc
.drawImage(image
, imageBounds
.x
+ 1, imageBounds
.y
+ 3);
435 gc
.drawImage(image
, imageBounds
.x
, imageBounds
.y
+ 1);
438 gc
.setForeground(item
.getForeground(event
.index
));
439 gc
.setFont(item
.getFont(event
.index
));
440 String text
= item
.getText(event
.index
);
441 Rectangle textBounds
= item
.getTextBounds(event
.index
);
443 * The text bounds don't match the default text position.
446 gc
.drawText(text
, textBounds
.x
+ 1, textBounds
.y
+ 3, true);
448 gc
.drawText(text
, textBounds
.x
- 1, textBounds
.y
+ 2, true);
453 private static final class EraseItemListener
implements Listener
{
455 public void handleEvent(Event event
) {
456 TableItem item
= (TableItem
) event
.item
;
457 List
<?
> styleRanges
= (List
<?
>) item
.getData(Key
.STYLE_RANGES
);
460 Color background
= item
.getBackground(event
.index
);
462 * Paint the background if it is not the default system color. In
463 * Windows, if you let the widget draw the background, it will not
464 * show the item's background color if the item is selected or hot.
465 * If there are no style ranges and the item background is the
466 * default system color, we do not want to paint it or otherwise we
467 * would override the platform theme (e.g. alternating colors).
469 if (styleRanges
!= null || !background
.equals(item
.getParent().getBackground())) {
470 // we will paint the table item's background
471 event
.detail
&= ~SWT
.BACKGROUND
;
473 // paint the item's default background
474 gc
.setBackground(background
);
475 gc
.fillRectangle(event
.x
, event
.y
, event
.width
, event
.height
);
479 * We will paint the table item's foreground. In Windows, if you
480 * paint the background but let the widget draw the foreground, it
481 * will override your background, unless the item is selected or
484 event
.detail
&= ~SWT
.FOREGROUND
;
486 // paint the highlighted background for all style ranges
487 if (styleRanges
!= null) {
488 Rectangle textBounds
= item
.getTextBounds(event
.index
);
489 String text
= item
.getText(event
.index
);
490 for (Object o
: styleRanges
) {
491 if (o
instanceof StyleRange
) {
492 StyleRange styleRange
= (StyleRange
) o
;
493 if (styleRange
.data
.equals(event
.index
)) {
494 int startIndex
= styleRange
.start
;
495 int endIndex
= startIndex
+ styleRange
.length
;
496 int startX
= gc
.textExtent(text
.substring(0, startIndex
)).x
;
497 int endX
= gc
.textExtent(text
.substring(0, endIndex
)).x
;
498 gc
.setBackground(styleRange
.background
);
499 gc
.fillRectangle(textBounds
.x
+ startX
, textBounds
.y
, (endX
- startX
), textBounds
.height
);
507 private final class TooltipListener
implements Listener
{
508 Shell tooltipShell
= null;
511 public void handleEvent(final Event event
) {
512 switch (event
.type
) {
514 final TableItem item
= fTable
.getItem(new Point(event
.x
, event
.y
));
519 if (fTable
.indexOf(item
) == 0) {
520 if (fHeaderState
== HeaderState
.SEARCH
&& item
.getBounds(0).contains(event
.x
, event
.y
)) {
521 text
= Messages
.TmfEventsTable_AddAsFilterText
;
526 final Long rank
= (Long
) item
.getData(Key
.RANK
);
530 final String tooltipText
= (String
) item
.getData(Key
.BOOKMARK
);
531 final Rectangle bounds
= item
.getImageBounds(0);
532 bounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
533 if (!bounds
.contains(event
.x
, event
.y
)) {
536 text
= rank
.toString() + (tooltipText
!= null ?
": " + tooltipText
: EMPTY_STRING
); //$NON-NLS-1$
538 if ((tooltipShell
!= null) && !tooltipShell
.isDisposed()) {
539 tooltipShell
.dispose();
541 tooltipShell
= new Shell(fTable
.getShell(), SWT
.ON_TOP
| SWT
.NO_FOCUS
| SWT
.TOOL
);
542 tooltipShell
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
543 final FillLayout layout
= new FillLayout();
544 layout
.marginWidth
= 2;
545 tooltipShell
.setLayout(layout
);
546 final Label label
= new Label(tooltipShell
, SWT
.WRAP
);
547 label
.setForeground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_FOREGROUND
));
548 label
.setBackground(PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_INFO_BACKGROUND
));
550 label
.addListener(SWT
.MouseExit
, this);
551 label
.addListener(SWT
.MouseDown
, this);
552 label
.addListener(SWT
.MouseWheel
, this);
553 final Point size
= tooltipShell
.computeSize(SWT
.DEFAULT
, SWT
.DEFAULT
);
555 * Bug in Linux. The coordinates of the event have an origin
556 * that excludes the table header but the method toDisplay()
557 * expects coordinates relative to an origin that includes the
562 y
+= fTable
.getHeaderHeight();
564 Point pt
= fTable
.toDisplay(event
.x
, y
);
565 pt
.x
+= BOOKMARK_IMAGE
.getBounds().width
;
566 pt
.y
+= item
.getBounds().height
;
567 tooltipShell
.setBounds(pt
.x
, pt
.y
, size
.x
, size
.y
);
568 tooltipShell
.setVisible(true);
576 if (tooltipShell
!= null) {
577 tooltipShell
.dispose();
588 * The events table search/filter/data keys
590 * @author Patrick Tasse
591 * @noimplement This interface only contains Event Table specific static
594 public interface Key
{
597 String SEARCH_TXT
= "$srch_txt"; //$NON-NLS-1$
600 String SEARCH_OBJ
= "$srch_obj"; //$NON-NLS-1$
603 String FILTER_TXT
= "$fltr_txt"; //$NON-NLS-1$
606 String FILTER_OBJ
= "$fltr_obj"; //$NON-NLS-1$
609 String TIMESTAMP
= "$time"; //$NON-NLS-1$
612 String RANK
= "$rank"; //$NON-NLS-1$
614 /** Bookmark indicator */
615 String BOOKMARK
= "$bookmark"; //$NON-NLS-1$
617 /** Event aspect represented by this column */
618 String ASPECT
= "$aspect"; //$NON-NLS-1$
621 * Table item list of style ranges
625 String STYLE_RANGES
= "$style_ranges"; //$NON-NLS-1$
628 * The width of a table item
632 String WIDTH
= "$width"; //$NON-NLS-1$
636 * The events table search/filter state
639 * @author Patrick Tasse
641 public static enum HeaderState
{
642 /** No search filter is applied
646 /** A search filter is applied */
650 interface Direction
{
655 // ------------------------------------------------------------------------
657 // ------------------------------------------------------------------------
659 /** The header bar */
660 private TmfEventsTableHeader fHeaderBar
;
662 /** The virtual event table */
663 protected TmfVirtualTable fTable
;
665 private Composite fComposite
;
666 private SashForm fSashForm
;
667 private TmfRawEventViewer fRawViewer
;
668 private ITmfTrace fTrace
;
669 private volatile boolean fPackDone
= false;
670 private HeaderState fHeaderState
= HeaderState
.NO_SEARCH
;
671 private long fSelectedRank
= -1;
672 private long fSelectedBeginRank
= -1;
673 private ITmfTimestamp fSelectedBeginTimestamp
= null;
674 private IStatusLineManager fStatusLineManager
= null;
677 private long fFilterMatchCount
;
678 private long fFilterCheckCount
;
679 private FilterThread fFilterThread
;
680 private boolean fFilterThreadResume
= false;
681 private final Object fFilterSyncObj
= new Object();
682 private SearchThread fSearchThread
;
683 private final Object fSearchSyncObj
= new Object();
684 private boolean fCollapseFilterEnabled
= false;
687 * List of selection change listeners (element type:
688 * <code>ISelectionChangedListener</code>).
690 * @see #fireSelectionChanged
692 private ListenerList selectionChangedListeners
= new ListenerList();
694 // Bookmark map <Rank, MarkerId>
695 private Multimap
<Long
, Long
> fBookmarksMap
= HashMultimap
.create();
696 private IFile fBookmarksFile
;
697 private long fPendingGotoRank
= -1;
700 private LocalResourceManager fResourceManager
= new LocalResourceManager(JFaceResources
.getResources());
701 private Color fGrayColor
;
702 private Color fGreenColor
;
703 private Color fHighlightColor
;
705 private Font fBoldFont
;
707 private final List
<TmfEventTableColumn
> fColumns
= new LinkedList
<>();
710 private final TmfEventsCache fCache
;
711 private boolean fCacheUpdateBusy
= false;
712 private boolean fCacheUpdatePending
= false;
713 private boolean fCacheUpdateCompleted
= false;
714 private final Object fCacheUpdateSyncObj
= new Object();
716 // Keep track of column order, it is needed after table is disposed
717 private int[] fColumnOrder
;
719 private boolean fDisposeOnClose
;
721 private Menu fHeaderMenu
;
723 private Menu fTablePopup
;
725 private Menu fRawTablePopup
;
727 private Point fLastMenuCursorLocation
;
728 private MenuManager fRawViewerPopupMenuManager
;
729 private MenuManager fTablePopupMenuManager
;
730 private MenuManager fHeaderPopupMenuManager
;
732 // ------------------------------------------------------------------------
734 // ------------------------------------------------------------------------
737 * Basic constructor, using the default set of columns
740 * The parent composite UI object
742 * The size of the event table cache
744 public TmfEventsTable(final Composite parent
, final int cacheSize
) {
745 this(parent
, cacheSize
, TmfTrace
.BASE_ASPECTS
);
749 * Legacy constructor, using ColumnData to define columns
752 * The parent composite UI object
754 * The size of the event table cache
756 * The column data array
757 * @deprecated Deprecated constructor, use
758 * {@link #TmfEventsTable(Composite, int, Collection)}
761 public TmfEventsTable(final Composite parent
, int cacheSize
,
762 final org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
764 * We'll do a "best-effort" to keep trace types still using this API to
765 * keep working, by defining a TmfEventTableColumn for each ColumnData
768 this(parent
, cacheSize
, convertFromColumnData(columnData
));
772 private static @NonNull Iterable
<ITmfEventAspect
<?
>> convertFromColumnData(
773 org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
775 ImmutableList
.Builder
<ITmfEventAspect
<?
>> builder
= new ImmutableList
.Builder
<>();
776 for (org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData col
: columnData
) {
777 String fieldName
= col
.header
;
778 if (fieldName
!= null) {
779 builder
.add(new TmfContentFieldAspect(fieldName
, fieldName
));
782 return builder
.build();
786 * Standard constructor, where we define which columns to use.
789 * The parent composite UI object
791 * The size of the event table cache
793 * The event aspects to display in this table. One column per
794 * aspect will be created.
796 * The iteration order of this collection will correspond to the
797 * initial ordering of the columns in the table.
800 public TmfEventsTable(final Composite parent
, int cacheSize
,
801 @NonNull Iterable
<ITmfEventAspect
<?
>> aspects
) {
802 super("TmfEventsTable"); //$NON-NLS-1$
804 fComposite
= new Composite(parent
, SWT
.NONE
);
805 GridLayout gl
= new GridLayout(1, false);
808 gl
.verticalSpacing
= 0;
809 fComposite
.setLayout(gl
);
811 fSashForm
= new SashForm(fComposite
, SWT
.HORIZONTAL
);
812 fSashForm
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
814 // Create a composite for the table and its header bar
815 Composite tableComposite
= new Composite(fSashForm
, SWT
.NONE
);
816 tableComposite
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
817 gl
= new GridLayout(1, false);
820 gl
.verticalSpacing
= 0;
821 tableComposite
.setLayout(gl
);
823 // Create an events table header bar
824 fHeaderBar
= new TmfEventsTableHeader(tableComposite
, SWT
.NONE
, new IEventsTableHeaderListener() {
826 public void filterSelected(ITmfFilter filter
) {
827 if (filter
instanceof TmfFilterMatchesNode
) {
828 TmfFilterMatchesNode matchFilter
= (TmfFilterMatchesNode
) filter
;
829 for (TableColumn col
: fTable
.getColumns()) {
830 if (col
.getData(Key
.ASPECT
) == matchFilter
.getEventAspect()) {
831 col
.setData(Key
.FILTER_TXT
, matchFilter
.getRegex());
833 col
.setData(Key
.FILTER_TXT
, null);
842 public void filterRemoved(ITmfFilter filter
) {
843 for (TableColumn col
: fTable
.getColumns()) {
844 col
.setData(Key
.FILTER_TXT
, null);
846 removeFilter(filter
);
850 // Create a virtual table
851 final int style
= SWT
.H_SCROLL
| SWT
.V_SCROLL
| SWT
.MULTI
| SWT
.FULL_SELECTION
;
852 fTable
= new TmfVirtualTable(tableComposite
, style
);
854 // Set the table layout
855 final GridData layoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, true);
856 fTable
.setLayoutData(layoutData
);
858 // Some cosmetic enhancements
859 fTable
.setHeaderVisible(true);
860 fTable
.setLinesVisible(true);
863 for (ITmfEventAspect
<?
> aspect
: aspects
) {
864 if (aspect
!= null) {
865 fColumns
.add(new TmfEventTableColumn(aspect
));
869 TmfMarginColumn collapseCol
= new TmfMarginColumn();
870 fColumns
.add(MARGIN_COLUMN_INDEX
, collapseCol
);
872 fHeaderMenu
= new Menu(fTable
);
873 // Create the UI columns in the table
874 for (TmfEventTableColumn col
: fColumns
) {
875 TableColumn column
= fTable
.newTableColumn(SWT
.LEFT
);
876 column
.setText(col
.getHeaderName());
877 column
.setToolTipText(col
.getHeaderTooltip());
878 column
.setData(Key
.ASPECT
, col
.getEventAspect());
880 if (col
instanceof TmfMarginColumn
) {
881 column
.setResizable(false);
883 column
.setMoveable(true);
884 column
.setData(Key
.WIDTH
, -1);
886 column
.addControlListener(new ColumnMovedListener());
888 fColumnOrder
= fTable
.getColumnOrder();
890 // Set the frozen row for header row
891 fTable
.setFrozenRowCount(1);
893 // Create the header row cell editor
894 createHeaderEditor();
896 // Handle the table item selection
897 fTable
.addSelectionListener(new TableSelectionListener());
899 int realCacheSize
= Math
.max(cacheSize
, Display
.getDefault().getBounds().height
/ fTable
.getItemHeight());
900 realCacheSize
= Math
.min(realCacheSize
, MAX_CACHE_SIZE
);
901 fCache
= new TmfEventsCache(realCacheSize
, this);
903 // Handle the table item requests
904 fTable
.addListener(SWT
.SetData
, new SetDataListener());
906 fTable
.addListener(SWT
.MenuDetect
, new Listener() {
908 public void handleEvent(Event event
) {
909 fLastMenuCursorLocation
= new Point(event
.x
, event
.y
);
910 Point pt
= fTable
.getDisplay().map(null, fTable
, fLastMenuCursorLocation
);
911 Rectangle clientArea
= fTable
.getClientArea();
912 boolean header
= clientArea
.y
<= pt
.y
&& pt
.y
< (clientArea
.y
+ fTable
.getHeaderHeight());
913 fTable
.setMenu(header ? fHeaderMenu
: fTablePopup
);
917 fTable
.addMouseListener(new MouseDoubleClickListener());
919 final Listener tooltipListener
= new TooltipListener();
921 fTable
.addListener(SWT
.MouseHover
, tooltipListener
);
922 fTable
.addListener(SWT
.Dispose
, tooltipListener
);
923 fTable
.addListener(SWT
.KeyDown
, tooltipListener
);
924 fTable
.addListener(SWT
.MouseMove
, tooltipListener
);
925 fTable
.addListener(SWT
.MouseExit
, tooltipListener
);
926 fTable
.addListener(SWT
.MouseDown
, tooltipListener
);
927 fTable
.addListener(SWT
.MouseWheel
, tooltipListener
);
929 fTable
.addListener(SWT
.EraseItem
, new EraseItemListener());
931 fTable
.addListener(SWT
.PaintItem
, new PainItemListener());
938 PlatformUI
.getWorkbench().getThemeManager().addPropertyChangeListener(this);
940 ColorSettingsManager
.addColorSettingsListener(this);
942 fTable
.setItemCount(1); // +1 for header row
944 fRawViewer
= new TmfRawEventViewer(fSashForm
, SWT
.H_SCROLL
| SWT
.V_SCROLL
);
946 fRawViewer
.addSelectionListener(new RawSelectionListener());
948 fSashForm
.setWeights(new int[] { 1, 1 });
949 fRawViewer
.setVisible(false);
953 fComposite
.addDisposeListener((e
) -> {
959 * Checked menu creator to make columns visible or not.
966 private static IAction
createHeaderAction(final TableColumn column
) {
967 final IAction columnMenuAction
= new Action(column
.getText(), IAction
.AS_CHECK_BOX
) {
971 column
.setWidth((int) column
.getData(Key
.WIDTH
));
972 column
.setResizable(true);
974 column
.setData(Key
.WIDTH
, column
.getWidth());
976 column
.setResizable(false);
980 columnMenuAction
.setChecked(column
.getResizable());
981 return columnMenuAction
;
984 private IAction
createResetHeaderAction() {
985 return new Action(Messages
.TmfEventsTable_ShowAll
) {
988 for (TableColumn column
: fTable
.getColumns()) {
989 final Object widthVal
= column
.getData(Key
.WIDTH
);
990 if (widthVal
instanceof Integer
) {
991 Integer width
= (Integer
) widthVal
;
992 if (!column
.getResizable()) {
993 column
.setWidth(width
);
994 column
.setResizable(true);
996 * This is because Linux always resizes the last
997 * column to fill in the void, this means that
998 * hiding a column resizes others and we can have 10
999 * columns that are 1000 pixels wide by hiding the
1000 * last one progressively.
1012 // ------------------------------------------------------------------------
1014 // ------------------------------------------------------------------------
1017 * Create a pop-up menu.
1019 private void createPopupMenu() {
1020 final IAction copyAction
= new Action(Messages
.TmfEventsTable_CopyToClipboardActionText
) {
1023 ITmfTrace trace
= fTrace
;
1024 if (trace
== null || (fSelectedRank
== -1 && fSelectedBeginRank
== -1)) {
1028 List
<TmfEventTableColumn
> columns
= new ArrayList
<>();
1029 for (int i
: fTable
.getColumnOrder()) {
1030 TableColumn column
= fTable
.getColumns()[i
];
1031 // Omit the margin column and hidden columns
1032 if (isVisibleEventColumn(column
)) {
1033 columns
.add(fColumns
.get(i
));
1037 long start
= Math
.min(fSelectedBeginRank
, fSelectedRank
);
1038 long end
= Math
.max(fSelectedBeginRank
, fSelectedRank
);
1039 final ITmfFilter filter
= (ITmfFilter
) fTable
.getData(Key
.FILTER_OBJ
);
1040 IRunnableWithProgress operation
= new CopyToClipboardOperation(trace
, filter
, columns
, start
, end
);
1042 PlatformUI
.getWorkbench().getProgressService().busyCursorWhile(operation
);
1043 } catch (InvocationTargetException e
) {
1044 Activator
.getDefault().logError("Invocation target exception copying to clipboard ", e
); //$NON-NLS-1$
1045 } catch (InterruptedException e
) {
1051 final IAction showTableAction
= new Action(Messages
.TmfEventsTable_ShowTableActionText
) {
1054 fTable
.setVisible(true);
1059 final IAction hideTableAction
= new Action(Messages
.TmfEventsTable_HideTableActionText
) {
1062 fTable
.setVisible(false);
1067 final IAction showRawAction
= new Action(Messages
.TmfEventsTable_ShowRawActionText
) {
1070 fRawViewer
.setVisible(true);
1072 final int index
= fTable
.getSelectionIndex();
1074 fRawViewer
.selectAndReveal(index
- 1);
1079 final IAction hideRawAction
= new Action(Messages
.TmfEventsTable_HideRawActionText
) {
1082 fRawViewer
.setVisible(false);
1087 final IAction openCallsiteAction
= new Action(Messages
.TmfEventsTable_OpenSourceCodeActionText
) {
1090 final TableItem items
[] = fTable
.getSelection();
1091 if (items
.length
!= 1) {
1094 final TableItem item
= items
[0];
1096 final Object data
= item
.getData();
1097 if (!(data
instanceof ITmfSourceLookup
)) {
1100 ITmfSourceLookup event
= (ITmfSourceLookup
) data
;
1101 ITmfCallsite cs
= event
.getCallsite();
1106 String fileName
= cs
.getFileName();
1107 final String trimmedPath
= fileName
.replaceAll("\\.\\./", EMPTY_STRING
); //$NON-NLS-1$
1108 File fileToOpen
= new File(trimmedPath
);
1111 if (fileToOpen
.exists() && fileToOpen
.isFile()) {
1113 * The path points to a "real" file, attempt to open
1116 IFileStore fileStore
= EFS
.getLocalFileSystem().getStore(fileToOpen
.toURI());
1117 IWorkbenchPage page
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
1119 IEditorPart editor
= IDE
.openEditorOnFileStore(page
, fileStore
);
1120 if (editor
instanceof ITextEditor
) {
1122 * Calculate the "document offset" corresponding to
1123 * the line number, then seek there.
1125 ITextEditor textEditor
= (ITextEditor
) editor
;
1126 int lineNumber
= Long
.valueOf(cs
.getLineNumber()).intValue();
1127 IDocument document
= textEditor
.getDocumentProvider().getDocument(textEditor
.getEditorInput());
1129 IRegion region
= document
.getLineInformation(lineNumber
- 1);
1130 if (region
!= null) {
1131 textEditor
.selectAndReveal(region
.getOffset(), region
.getLength());
1137 * The file was not found on disk, attempt to find it in
1138 * the workspace instead.
1140 IMarker marker
= null;
1141 final ArrayList
<IFile
> files
= new ArrayList
<>();
1142 IPath p
= new Path(trimmedPath
);
1143 ResourcesPlugin
.getWorkspace().getRoot().accept(new IResourceVisitor() {
1145 public boolean visit(IResource resource
) throws CoreException
{
1146 if (resource
instanceof IFile
&& resource
.getFullPath().toString().endsWith(p
.lastSegment())) {
1147 files
.add((IFile
) resource
);
1153 if (files
.size() > 1) {
1154 ListDialog dialog
= new ListDialog(getTable().getShell());
1155 dialog
.setContentProvider(ArrayContentProvider
.getInstance());
1156 dialog
.setLabelProvider(new LabelProvider() {
1158 public String
getText(Object element
) {
1159 return ((IFile
) element
).getFullPath().toString();
1162 dialog
.setInput(files
);
1163 dialog
.setTitle(Messages
.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle
);
1164 dialog
.setMessage(Messages
.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle
+ '\n' + cs
.toString());
1166 Object
[] result
= dialog
.getResult();
1167 if (result
!= null && result
.length
> 0) {
1168 file
= (IFile
) result
[0];
1170 } else if (files
.size() == 1) {
1171 file
= files
.get(0);
1174 marker
= file
.createMarker(IMarker
.MARKER
);
1175 marker
.setAttribute(IMarker
.LINE_NUMBER
, Long
.valueOf(cs
.getLineNumber()).intValue());
1176 IDE
.openEditor(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage(), marker
);
1178 } else if (files
.isEmpty()) {
1179 displayException(new FileNotFoundException('\'' + cs
.toString() + '\'' + '\n' + Messages
.TmfEventsTable_OpenSourceCodeNotFound
));
1182 } catch (BadLocationException
| CoreException e
) {
1183 displayException(e
);
1188 final IAction openModelAction
= new Action(Messages
.TmfEventsTable_OpenModelActionText
) {
1192 final TableItem items
[] = fTable
.getSelection();
1193 if (items
.length
!= 1) {
1196 final TableItem item
= items
[0];
1198 final Object eventData
= item
.getData();
1199 if (eventData
instanceof ITmfModelLookup
) {
1200 String modelURI
= ((ITmfModelLookup
) eventData
).getModelUri();
1202 if (modelURI
!= null) {
1203 IWorkbenchPage activePage
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
1206 final URI uri
= URI
.createURI(modelURI
);
1207 if (uri
.isPlatformResource()) {
1208 IPath path
= new Path(uri
.toPlatformString(true));
1209 file
= ResourcesPlugin
.getWorkspace().getRoot().getFile(path
);
1210 } else if (uri
.isFile() && !uri
.isRelative()) {
1211 file
= ResourcesPlugin
.getWorkspace().getRoot().getFileForLocation(
1212 new Path(uri
.toFileString()));
1218 * create a temporary validation marker on the
1219 * model file, remove it afterwards thus,
1220 * navigation works with all model editors
1221 * supporting the navigation to a marker
1223 IMarker marker
= file
.createMarker(EValidator
.MARKER
);
1224 marker
.setAttribute(EValidator
.URI_ATTRIBUTE
, modelURI
);
1225 marker
.setAttribute(IMarker
.SEVERITY
, IMarker
.SEVERITY_INFO
);
1227 IDE
.openEditor(activePage
, marker
, OpenStrategy
.activateOnOpen());
1229 } catch (CoreException e
) {
1230 displayException(e
);
1233 displayException(new FileNotFoundException('\'' + modelURI
+ '\'' + '\n' + Messages
.TmfEventsTable_OpenModelUnsupportedURI
));
1240 final IAction exportToTextAction
= new Action(Messages
.TmfEventsTable_Export_to_text
) {
1243 IWorkbenchPage activePage
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getActivePage();
1244 Object handlerServiceObject
= activePage
.getActiveEditor().getSite().getService(IHandlerService
.class);
1245 IHandlerService handlerService
= (IHandlerService
) handlerServiceObject
;
1246 Object cmdServiceObject
= activePage
.getActiveEditor().getSite().getService(ICommandService
.class);
1247 ICommandService cmdService
= (ICommandService
) cmdServiceObject
;
1249 HashMap
<String
, Object
> parameters
= new HashMap
<>();
1250 Command command
= cmdService
.getCommand(ExportToTextCommandHandler
.COMMAND_ID
);
1251 ParameterizedCommand cmd
= ParameterizedCommand
.generateCommand(command
, parameters
);
1253 IEvaluationContext context
= handlerService
.getCurrentState();
1254 List
<TmfEventTableColumn
> exportColumns
= new ArrayList
<>();
1255 for (int i
: fTable
.getColumnOrder()) {
1256 TableColumn column
= fTable
.getColumns()[i
];
1257 // Omit the margin column and hidden columns
1258 if (isVisibleEventColumn(column
)) {
1259 exportColumns
.add(fColumns
.get(i
));
1262 context
.addVariable(ExportToTextCommandHandler
.TMF_EVENT_TABLE_COLUMNS_ID
, exportColumns
);
1264 handlerService
.executeCommandInContext(cmd
, null, context
);
1265 } catch (ExecutionException
| NotDefinedException
| NotEnabledException
| NotHandledException e
) {
1266 displayException(e
);
1271 final IAction addAsFilterAction
= new Action(Messages
.TmfEventsTable_AddAsFilterText
) {
1274 applySearchAsFilter();
1278 final IAction clearFiltersAction
= new Action(Messages
.TmfEventsTable_ClearFiltersActionText
) {
1285 final IAction collapseAction
= new Action(Messages
.TmfEventsTable_CollapseFilterMenuName
) {
1288 applyFilter(new TmfCollapseFilter());
1292 class ToggleBookmarkAction
extends Action
{
1295 public ToggleBookmarkAction(final String text
, final Long rank
) {
1302 toggleBookmark(fRank
);
1306 fHeaderPopupMenuManager
= new MenuManager();
1307 fHeaderPopupMenuManager
.setRemoveAllWhenShown(true);
1308 fHeaderPopupMenuManager
.addMenuListener(new IMenuListener() {
1310 public void menuAboutToShow(IMenuManager manager
) {
1311 for (int index
: fTable
.getColumnOrder()) {
1312 if (fTable
.getColumns()[index
].getData(Key
.WIDTH
) != null) {
1313 fHeaderPopupMenuManager
.add(createHeaderAction(fTable
.getColumns()[index
]));
1316 fHeaderPopupMenuManager
.add(new Separator());
1317 fHeaderPopupMenuManager
.add(createResetHeaderAction());
1321 fTablePopupMenuManager
= new MenuManager();
1322 fTablePopupMenuManager
.setRemoveAllWhenShown(true);
1323 fTablePopupMenuManager
.addMenuListener(new IMenuListener() {
1325 public void menuAboutToShow(final IMenuManager manager
) {
1326 if (fTable
.getSelectionIndices().length
== 1 && fTable
.getSelectionIndices()[0] == 0) {
1327 // Right-click on header row
1328 if (fHeaderState
== HeaderState
.SEARCH
) {
1329 fTablePopupMenuManager
.add(addAsFilterAction
);
1333 final Point point
= fTable
.toControl(fLastMenuCursorLocation
);
1334 final TableItem item
= fTable
.getSelection().length
> 0 ? fTable
.getSelection()[0] : null;
1336 final Rectangle imageBounds
= item
.getImageBounds(0);
1337 imageBounds
.width
= BOOKMARK_IMAGE
.getBounds().width
;
1338 if (point
.x
<= (imageBounds
.x
+ imageBounds
.width
)) {
1339 // Right-click on left margin
1340 final Long rank
= (Long
) item
.getData(Key
.RANK
);
1341 if ((rank
!= null) && (fBookmarksFile
!= null)) {
1342 if (fBookmarksMap
.containsKey(rank
)) {
1343 fTablePopupMenuManager
.add(new ToggleBookmarkAction(
1344 Messages
.TmfEventsTable_RemoveBookmarkActionText
, rank
));
1346 fTablePopupMenuManager
.add(new ToggleBookmarkAction(
1347 Messages
.TmfEventsTable_AddBookmarkActionText
, rank
));
1354 // Right-click on table
1355 if (fSelectedRank
!= -1 && fSelectedBeginRank
!= -1) {
1356 fTablePopupMenuManager
.add(copyAction
);
1357 fTablePopupMenuManager
.add(new Separator());
1359 if (fTable
.isVisible() && fRawViewer
.isVisible()) {
1360 fTablePopupMenuManager
.add(hideTableAction
);
1361 fTablePopupMenuManager
.add(hideRawAction
);
1362 } else if (!fTable
.isVisible()) {
1363 fTablePopupMenuManager
.add(showTableAction
);
1364 } else if (!fRawViewer
.isVisible()) {
1365 fTablePopupMenuManager
.add(showRawAction
);
1367 fTablePopupMenuManager
.add(exportToTextAction
);
1368 fTablePopupMenuManager
.add(new Separator());
1371 final Object data
= item
.getData();
1372 Separator separator
= null;
1373 if (data
instanceof ITmfSourceLookup
) {
1374 ITmfSourceLookup event
= (ITmfSourceLookup
) data
;
1375 if (event
.getCallsite() != null) {
1376 fTablePopupMenuManager
.add(openCallsiteAction
);
1377 separator
= new Separator();
1381 if (data
instanceof ITmfModelLookup
) {
1382 ITmfModelLookup event
= (ITmfModelLookup
) data
;
1383 if (event
.getModelUri() != null) {
1384 fTablePopupMenuManager
.add(openModelAction
);
1385 separator
= new Separator();
1388 if (separator
!= null) {
1389 fTablePopupMenuManager
.add(separator
);
1395 * Only show collapse filter if at least one trace can be
1398 boolean isCollapsible
= false;
1399 if (fTrace
!= null) {
1400 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(fTrace
)) {
1401 Class
<?
extends ITmfEvent
> eventClass
= trace
.getEventType();
1402 isCollapsible
= ITmfCollapsibleEvent
.class.isAssignableFrom(eventClass
);
1403 if (isCollapsible
) {
1409 if (isCollapsible
&& !fCollapseFilterEnabled
) {
1410 fTablePopupMenuManager
.add(collapseAction
);
1411 fTablePopupMenuManager
.add(new Separator());
1414 fTablePopupMenuManager
.add(clearFiltersAction
);
1415 final ITmfFilterTreeNode
[] savedFilters
= FilterManager
.getSavedFilters();
1416 if (savedFilters
.length
> 0) {
1417 final MenuManager subMenu
= new MenuManager(Messages
.TmfEventsTable_ApplyPresetFilterMenuName
);
1418 for (final ITmfFilterTreeNode node
: savedFilters
) {
1419 if (node
instanceof TmfFilterNode
) {
1420 final TmfFilterNode filter
= (TmfFilterNode
) node
;
1421 subMenu
.add(new Action(filter
.getFilterName()) {
1424 applyFilter(filter
);
1429 fTablePopupMenuManager
.add(subMenu
);
1431 appendToTablePopupMenu(fTablePopupMenuManager
, item
);
1435 fRawViewerPopupMenuManager
= new MenuManager();
1436 fRawViewerPopupMenuManager
.setRemoveAllWhenShown(true);
1437 fRawViewerPopupMenuManager
.addMenuListener(new IMenuListener() {
1439 public void menuAboutToShow(final IMenuManager manager
) {
1440 if (fTable
.isVisible() && fRawViewer
.isVisible()) {
1441 fRawViewerPopupMenuManager
.add(hideTableAction
);
1442 fRawViewerPopupMenuManager
.add(hideRawAction
);
1443 } else if (!fTable
.isVisible()) {
1444 fRawViewerPopupMenuManager
.add(showTableAction
);
1445 } else if (!fRawViewer
.isVisible()) {
1446 fRawViewerPopupMenuManager
.add(showRawAction
);
1448 appendToRawPopupMenu(fRawViewerPopupMenuManager
);
1452 fHeaderMenu
= fHeaderPopupMenuManager
.createContextMenu(fTable
);
1454 fTablePopup
= fTablePopupMenuManager
.createContextMenu(fTable
);
1455 fTable
.setMenu(fTablePopup
);
1457 fRawTablePopup
= fRawViewerPopupMenuManager
.createContextMenu(fRawViewer
);
1458 fRawViewer
.setMenu(fRawTablePopup
);
1462 * Append an item to the event table's pop-up menu.
1464 * @param tablePopupMenu
1466 * @param selectedItem
1467 * The item to append
1469 protected void appendToTablePopupMenu(final MenuManager tablePopupMenu
, final TableItem selectedItem
) {
1470 // override to append more actions
1474 * Append an item to the raw viewer's pop-up menu.
1476 * @param rawViewerPopupMenu
1479 protected void appendToRawPopupMenu(final MenuManager rawViewerPopupMenu
) {
1480 // override to append more actions
1484 public void dispose() {
1485 fComposite
.dispose();
1488 private void internalDispose() {
1491 PlatformUI
.getWorkbench().getThemeManager().removePropertyChangeListener(this);
1492 ColorSettingsManager
.removeColorSettingsListener(this);
1494 if ((fTrace
!= null) && fDisposeOnClose
) {
1497 fResourceManager
.dispose();
1498 if (fRawViewerPopupMenuManager
!= null) {
1499 fRawViewerPopupMenuManager
.dispose();
1501 if (fHeaderPopupMenuManager
!= null) {
1502 fHeaderPopupMenuManager
.dispose();
1504 if (fTablePopupMenuManager
!= null) {
1505 fTablePopupMenuManager
.dispose();
1512 * Assign a layout data object to this view.
1515 * The layout data to assign
1517 public void setLayoutData(final Object layoutData
) {
1518 fComposite
.setLayoutData(layoutData
);
1522 * Get the virtual table contained in this event table.
1524 * @return The TMF virtual table
1526 public TmfVirtualTable
getTable() {
1533 * @deprecated The column headers are now set at the constructor, this
1534 * shouldn't be called anymore.
1537 protected void setColumnHeaders(final org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.virtualtable
.ColumnData
[] columnData
) {
1542 * Set a table item's data.
1547 * Which trace event to link with this entry
1549 * Which rank this event has in the trace/experiment
1551 protected void setItemData(final TableItem item
, final ITmfEvent event
, final long rank
) {
1552 String
[] itemStrings
= getItemStrings(fColumns
, event
);
1554 // Get the actual ITmfEvent from the CachedEvent
1555 ITmfEvent tmfEvent
= event
;
1556 if (event
instanceof CachedEvent
) {
1557 tmfEvent
= ((CachedEvent
) event
).event
;
1559 item
.setText(itemStrings
);
1560 item
.setData(tmfEvent
);
1561 item
.setData(Key
.TIMESTAMP
, tmfEvent
.getTimestamp());
1562 item
.setData(Key
.RANK
, rank
);
1564 final Collection
<Long
> markerIds
= fBookmarksMap
.get(rank
);
1565 if (!markerIds
.isEmpty()) {
1566 Joiner joiner
= Joiner
.on("\n -").skipNulls(); //$NON-NLS-1$
1567 List
<Object
> parts
= new ArrayList
<>();
1568 if (markerIds
.size() > 1) {
1569 parts
.add(Messages
.TmfEventsTable_MultipleBookmarksToolTip
);
1572 for (long markerId
: markerIds
) {
1573 final IMarker marker
= fBookmarksFile
.findMarker(markerId
);
1574 if (marker
!= null) {
1575 parts
.add(marker
.getAttribute(IMarker
.MESSAGE
));
1578 } catch (CoreException e
) {
1579 displayException(e
);
1581 item
.setData(Key
.BOOKMARK
, joiner
.join(parts
));
1583 item
.setData(Key
.BOOKMARK
, null);
1586 boolean searchMatch
= false;
1587 boolean searchNoMatch
= false;
1588 final ITmfFilter searchFilter
= (ITmfFilter
) fTable
.getData(Key
.SEARCH_OBJ
);
1589 if (searchFilter
!= null) {
1590 if (searchFilter
.matches(tmfEvent
)) {
1593 searchNoMatch
= true;
1597 final ColorSetting colorSetting
= ColorSettingsManager
.getColorSetting(tmfEvent
);
1598 if (searchNoMatch
) {
1599 item
.setForeground(colorSetting
.getDimmedForegroundColor());
1600 item
.setBackground(colorSetting
.getDimmedBackgroundColor());
1602 item
.setForeground(colorSetting
.getForegroundColor());
1603 item
.setBackground(colorSetting
.getBackgroundColor());
1605 item
.setFont(fFont
);
1608 if (!markerIds
.isEmpty()) {
1609 item
.setImage(SEARCH_MATCH_BOOKMARK_IMAGE
);
1611 item
.setImage(SEARCH_MATCH_IMAGE
);
1613 } else if (!markerIds
.isEmpty()) {
1614 item
.setImage(BOOKMARK_IMAGE
);
1616 item
.setImage((Image
) null);
1619 List
<StyleRange
> styleRanges
= new ArrayList
<>();
1620 for (int index
= 0; index
< fTable
.getColumns().length
; index
++) {
1621 TableColumn column
= fTable
.getColumns()[index
];
1622 String regex
= null;
1623 if (fHeaderState
== HeaderState
.SEARCH
) {
1625 regex
= (String
) column
.getData(Key
.SEARCH_TXT
);
1628 regex
= (String
) column
.getData(Key
.FILTER_TXT
);
1630 if (regex
!= null) {
1631 String text
= item
.getText(index
);
1633 Pattern pattern
= Pattern
.compile(regex
);
1634 Matcher matcher
= pattern
.matcher(text
);
1635 while (matcher
.find()) {
1636 int start
= matcher
.start();
1637 int length
= matcher
.end() - start
;
1638 Color foreground
= colorSetting
.getForegroundColor();
1639 Color background
= fHighlightColor
;
1640 StyleRange styleRange
= new StyleRange(start
, length
, foreground
, background
);
1641 styleRange
.data
= index
;
1642 styleRanges
.add(styleRange
);
1644 } catch (PatternSyntaxException e
) {
1649 if (styleRanges
.isEmpty()) {
1650 item
.setData(Key
.STYLE_RANGES
, null);
1652 item
.setData(Key
.STYLE_RANGES
, styleRanges
);
1654 item
.getParent().redraw();
1656 if ((itemStrings
[MARGIN_COLUMN_INDEX
] != null) && !itemStrings
[MARGIN_COLUMN_INDEX
].isEmpty()) {
1662 * Set the item data of the header row.
1665 * The item to use as table header
1667 protected void setHeaderRowItemData(final TableItem item
) {
1668 if (fHeaderState
== HeaderState
.NO_SEARCH
) {
1669 item
.setImage(SEARCH_IMAGE
);
1670 } else if (fHeaderState
== HeaderState
.SEARCH
) {
1671 item
.setImage(FILTER_ADD_IMAGE
);
1673 item
.setForeground(fGrayColor
);
1674 // Ignore collapse and image column
1675 for (int i
= EVENT_COLUMNS_START_INDEX
; i
< fTable
.getColumns().length
; i
++) {
1676 final TableColumn column
= fTable
.getColumns()[i
];
1677 final String filter
= (String
) column
.getData(Key
.SEARCH_TXT
);
1678 if (filter
== null) {
1679 item
.setText(i
, SEARCH_HINT
);
1680 item
.setForeground(i
, fGrayColor
);
1681 item
.setFont(i
, fFont
);
1683 item
.setText(i
, filter
);
1684 item
.setForeground(i
, fGreenColor
);
1685 item
.setFont(i
, fBoldFont
);
1691 * Set the item data of the "filter status" row.
1694 * The item to use as filter status row
1696 protected void setFilterStatusRowItemData(final TableItem item
) {
1697 for (int i
= 0; i
< fTable
.getColumns().length
; i
++) {
1698 if (i
== MARGIN_COLUMN_INDEX
) {
1699 if ((fTrace
== null) || (fFilterCheckCount
== fTrace
.getNbEvents())) {
1700 item
.setImage(FILTER_IMAGE
);
1702 item
.setImage(STOP_IMAGE
);
1706 if (i
== FILTER_SUMMARY_INDEX
) {
1707 item
.setText(FILTER_SUMMARY_INDEX
, fFilterMatchCount
+ "/" + fFilterCheckCount
); //$NON-NLS-1$
1709 item
.setText(i
, EMPTY_STRING
);
1713 item
.setData(Key
.TIMESTAMP
, null);
1714 item
.setData(Key
.RANK
, null);
1715 item
.setData(Key
.STYLE_RANGES
, null);
1716 item
.setForeground(null);
1717 item
.setBackground(null);
1718 item
.setFont(fFont
);
1722 * Create an editor for the header.
1724 private void createHeaderEditor() {
1725 final TableEditor tableEditor
= fTable
.createTableEditor();
1726 tableEditor
.horizontalAlignment
= SWT
.LEFT
;
1727 tableEditor
.verticalAlignment
= SWT
.CENTER
;
1728 tableEditor
.grabHorizontal
= true;
1729 tableEditor
.minimumWidth
= 50;
1731 // Handle the header row selection
1732 fTable
.addMouseListener(new MouseAdapter() {
1738 public void mouseDown(final MouseEvent event
) {
1739 if (event
.button
!= 1) {
1742 // Identify the selected row
1743 final Point point
= new Point(event
.x
, event
.y
);
1744 item
= fTable
.getItem(point
);
1746 // Header row selected
1747 if ((item
!= null) && (fTable
.indexOf(item
) == 0)) {
1749 // Margin column selected
1750 if (item
.getBounds(0).contains(point
)) {
1751 if (fHeaderState
== HeaderState
.SEARCH
) {
1752 applySearchAsFilter();
1757 // Identify the selected column
1759 for (int i
= 0; i
< fTable
.getColumns().length
; i
++) {
1760 final Rectangle rect
= item
.getBounds(i
);
1761 if (rect
.contains(point
)) {
1767 if (columnIndex
== -1) {
1771 column
= fTable
.getColumns()[columnIndex
];
1774 * The control that will be the editor must be a child of
1777 final Text newEditor
= (Text
) fTable
.createTableEditorControl(Text
.class);
1778 final String headerString
= (String
) column
.getData(Key
.SEARCH_TXT
);
1779 if (headerString
!= null) {
1780 newEditor
.setText(headerString
);
1782 newEditor
.addFocusListener(new FocusAdapter() {
1784 public void focusLost(final FocusEvent e
) {
1785 final boolean changed
= updateHeader(newEditor
.getText());
1791 newEditor
.addKeyListener(new KeyAdapter() {
1793 public void keyPressed(final KeyEvent e
) {
1794 if (e
.character
== SWT
.CR
) {
1795 updateHeader(newEditor
.getText());
1797 if ((e
.stateMask
& SWT
.CTRL
) != 0) {
1798 applySearchAsFilter();
1801 * Set focus on the table so that the next
1802 * carriage return goes to the next result
1804 TmfEventsTable
.this.getTable().setFocus();
1806 } else if (e
.character
== SWT
.ESC
) {
1807 tableEditor
.getEditor().dispose();
1811 newEditor
.selectAll();
1812 newEditor
.setFocus();
1813 tableEditor
.setEditor(newEditor
, item
, columnIndex
);
1818 * returns true is value was changed
1820 private boolean updateHeader(final String regex
) {
1821 if (regex
.length() > 0) {
1823 Pattern
.compile(regex
);
1824 if (regex
.equals(column
.getData(Key
.SEARCH_TXT
))) {
1825 tableEditor
.getEditor().dispose();
1828 final TmfFilterMatchesNode filter
= new TmfFilterMatchesNode(null);
1829 ITmfEventAspect
<?
> aspect
= (ITmfEventAspect
<?
>) column
.getData(Key
.ASPECT
);
1830 filter
.setEventAspect(aspect
);
1831 filter
.setRegex(regex
);
1832 column
.setData(Key
.SEARCH_OBJ
, filter
);
1833 column
.setData(Key
.SEARCH_TXT
, regex
);
1834 } catch (final PatternSyntaxException ex
) {
1835 tableEditor
.getEditor().dispose();
1836 MessageDialog
.openError(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(),
1837 ex
.getDescription(), ex
.getMessage());
1841 if (column
.getData(Key
.SEARCH_TXT
) == null) {
1842 tableEditor
.getEditor().dispose();
1845 column
.setData(Key
.SEARCH_OBJ
, null);
1846 column
.setData(Key
.SEARCH_TXT
, null);
1851 private void applyHeader() {
1853 final TmfFilterRootNode filter
= new TmfFilterRootNode();
1854 for (final TableColumn col
: fTable
.getColumns()) {
1855 final Object filterObj
= col
.getData(Key
.SEARCH_OBJ
);
1856 if (filterObj
instanceof ITmfFilterTreeNode
) {
1857 filter
.addChild((ITmfFilterTreeNode
) filterObj
);
1860 if (filter
.getChildrenCount() > 0) {
1861 fHeaderState
= HeaderState
.SEARCH
;
1862 fTable
.setData(Key
.SEARCH_OBJ
, filter
);
1865 fireSearchApplied(filter
);
1867 fHeaderState
= HeaderState
.NO_SEARCH
;
1868 fTable
.setData(Key
.SEARCH_OBJ
, null);
1870 fireSearchApplied(null);
1873 tableEditor
.getEditor().dispose();
1877 fTable
.addKeyListener(new KeyAdapter() {
1879 public void keyPressed(final KeyEvent e
) {
1881 if (e
.character
== SWT
.ESC
) {
1885 } else if (e
.character
== SWT
.DEL
) {
1886 if (fHeaderState
== HeaderState
.SEARCH
) {
1887 fHeaderState
= HeaderState
.NO_SEARCH
;
1889 for (final TableColumn column
: fTable
.getColumns()) {
1890 column
.setData(Key
.SEARCH_OBJ
, null);
1891 column
.setData(Key
.SEARCH_TXT
, null);
1892 column
.setData(Key
.FILTER_TXT
, null);
1894 fTable
.setData(Key
.SEARCH_OBJ
, null);
1896 fireSearchApplied(null);
1898 for (final TableColumn column
: fTable
.getColumns()) {
1899 column
.setData(Key
.FILTER_TXT
, null);
1903 } else if (e
.character
== SWT
.CR
) {
1904 if ((e
.stateMask
& SWT
.CTRL
) != 0) {
1905 if (fHeaderState
== HeaderState
.SEARCH
) {
1906 applySearchAsFilter();
1908 } else if ((e
.stateMask
& SWT
.SHIFT
) == 0) {
1919 * Apply the current search condition as a new filter.
1923 protected void applySearchAsFilter() {
1924 Object searchObj
= fTable
.getData(Key
.SEARCH_OBJ
);
1925 if (searchObj
instanceof ITmfFilter
) {
1926 ITmfFilter filter
= (ITmfFilter
) searchObj
;
1927 fTable
.setData(Key
.SEARCH_OBJ
, null);
1928 fireSearchApplied(null);
1929 fHeaderState
= HeaderState
.NO_SEARCH
;
1930 for (final TableColumn col
: fTable
.getColumns()) {
1931 col
.setData(Key
.FILTER_TXT
, col
.getData(Key
.SEARCH_TXT
));
1932 col
.setData(Key
.SEARCH_TXT
, null);
1933 col
.setData(Key
.SEARCH_OBJ
, null);
1935 applyFilter(filter
);
1940 * Send an event indicating a filter has been applied.
1943 * The filter that was just applied
1945 protected void fireFilterApplied(final ITmfFilter filter
) {
1946 broadcast(new TmfEventFilterAppliedSignal(this, fTrace
, filter
));
1950 * Send an event indicating that a search has been applied.
1953 * The search filter that was just applied
1955 protected void fireSearchApplied(final ITmfFilter filter
) {
1956 broadcast(new TmfEventSearchAppliedSignal(this, fTrace
, filter
));
1960 * Start the filtering thread.
1962 protected void startFilterThread() {
1963 synchronized (fFilterSyncObj
) {
1964 final ITmfFilterTreeNode filter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
1965 if (fFilterThread
== null || fFilterThread
.filter
!= filter
) {
1966 if (fFilterThread
!= null) {
1967 fFilterThread
.cancel();
1968 fFilterThreadResume
= false;
1970 fFilterThread
= new FilterThread(filter
);
1971 fFilterThread
.start();
1973 fFilterThreadResume
= true;
1979 * Stop the filtering thread.
1981 protected void stopFilterThread() {
1982 synchronized (fFilterSyncObj
) {
1983 if (fFilterThread
!= null) {
1984 fFilterThread
.cancel();
1985 fFilterThread
= null;
1986 fFilterThreadResume
= false;
1992 * Apply a filter. It is added to the existing filters.
1995 * The filter to apply
1997 protected void applyFilter(ITmfFilter filter
) {
2000 fFilterMatchCount
= 0;
2001 fFilterCheckCount
= 0;
2002 ITmfFilterTreeNode rootFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2003 if (rootFilter
== null) {
2004 rootFilter
= new TmfFilterRootNode();
2006 if (filter
instanceof TmfFilterRootNode
) {
2007 TmfFilterRootNode parentFilter
= (TmfFilterRootNode
) filter
;
2008 for (ITmfFilterTreeNode child
: parentFilter
.getChildren()) {
2009 rootFilter
.addChild(child
);
2011 } else if (filter
instanceof TmfCollapseFilter
) {
2012 fCollapseFilterEnabled
= true;
2013 } else if (filter
instanceof ITmfFilterTreeNode
) {
2014 rootFilter
.addChild((ITmfFilterTreeNode
) filter
);
2016 rootFilter
.addChild(new TmfFilterObjectNode(filter
));
2018 fCache
.applyFilter(rootFilter
, fCollapseFilterEnabled
);
2019 fHeaderBar
.addFilter(filter
);
2021 fTable
.setData(Key
.FILTER_OBJ
, rootFilter
);
2022 /* +1 for header row, +2 for top and bottom filter status rows */
2023 fTable
.setItemCount(3);
2024 startFilterThread();
2025 fireFilterApplied(rootFilter
);
2029 * Remove a filter. Any other existing filters remain applied.
2032 * The filter to remove
2035 protected void removeFilter(ITmfFilter filter
) {
2036 ITmfFilterTreeNode rootFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2037 if (rootFilter
== null) {
2042 fFilterMatchCount
= 0;
2043 fFilterCheckCount
= 0;
2044 if (filter
instanceof TmfCollapseFilter
) {
2045 fCollapseFilterEnabled
= false;
2046 } else if (filter
instanceof ITmfFilterTreeNode
) {
2047 rootFilter
.removeChild((ITmfFilterTreeNode
) filter
);
2049 for (ITmfFilterTreeNode child
: rootFilter
.getChildren()) {
2050 if (child
instanceof TmfFilterObjectNode
) {
2051 if (((TmfFilterObjectNode
) child
).getFilter().equals(filter
)) {
2052 rootFilter
.removeChild(child
);
2058 if (!rootFilter
.hasChildren() && !fCollapseFilterEnabled
) {
2062 fCache
.applyFilter(rootFilter
, fCollapseFilterEnabled
);
2063 fHeaderBar
.removeFilter(filter
);
2065 fTable
.setData(Key
.FILTER_OBJ
, rootFilter
);
2066 /* +1 for header row, +2 for top and bottom filter status rows */
2067 fTable
.setItemCount(3);
2068 startFilterThread();
2069 fireFilterApplied(rootFilter
);
2071 // Set original width
2072 fTable
.getColumns()[MARGIN_COLUMN_INDEX
].setWidth(0);
2077 * Clear all currently active filters.
2079 protected void clearFilters() {
2080 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
2085 fCache
.clearFilter();
2086 fHeaderBar
.clearFilters();
2087 fCollapseFilterEnabled
= false;
2089 for (final TableColumn column
: fTable
.getColumns()) {
2090 column
.setData(Key
.FILTER_OBJ
, null);
2091 column
.setData(Key
.FILTER_TXT
, null);
2093 fTable
.setData(Key
.FILTER_OBJ
, null);
2094 if (fTrace
!= null) {
2095 /* +1 for header row */
2096 fTable
.setItemCount((int) fTrace
.getNbEvents() + 1);
2098 /* +1 for header row */
2099 fTable
.setItemCount(1);
2101 fFilterMatchCount
= 0;
2102 fFilterCheckCount
= 0;
2103 if (fSelectedRank
>= 0) {
2104 /* +1 for header row */
2105 fTable
.setSelection((int) fSelectedRank
+ 1);
2107 fTable
.setSelection(0);
2109 fireFilterApplied(null);
2110 updateStatusLine(null);
2112 // Set original width
2113 fTable
.getColumns()[MARGIN_COLUMN_INDEX
].setWidth(0);
2118 * Wrapper Thread object for the filtering thread.
2120 protected class FilterThread
extends Thread
{
2121 private final ITmfFilterTreeNode filter
;
2122 private TmfCollapseFilter collapseFilter
= null;
2123 private TmfEventRequest request
;
2124 private boolean refreshBusy
= false;
2125 private boolean refreshPending
= false;
2126 private final Object syncObj
= new Object();
2132 * The filter this thread will be processing
2134 public FilterThread(final ITmfFilterTreeNode filter
) {
2135 super("Filter Thread"); //$NON-NLS-1$
2136 this.filter
= filter
;
2141 if (fTrace
== null) {
2144 if (fCollapseFilterEnabled
) {
2145 collapseFilter
= new TmfCollapseFilter();
2147 final int nbRequested
= (int) (fTrace
.getNbEvents() - fFilterCheckCount
);
2148 if (nbRequested
<= 0) {
2151 request
= new TmfEventRequest(ITmfEvent
.class, TmfTimeRange
.ETERNITY
,
2152 (int) fFilterCheckCount
, nbRequested
, ExecutionType
.BACKGROUND
) {
2154 public void handleData(final ITmfEvent event
) {
2155 super.handleData(event
);
2156 if (request
.isCancelled()) {
2159 boolean refresh
= false;
2160 if (filter
.matches(event
)) {
2161 if (collapseFilter
== null || collapseFilter
.matches(event
)) {
2162 final long rank
= fFilterCheckCount
;
2163 final int index
= (int) fFilterMatchCount
;
2164 fFilterMatchCount
++;
2165 fCache
.storeEvent(event
, rank
, index
);
2166 } else if (collapseFilter
!= null) {
2167 fCache
.updateCollapsedEvent((int) fFilterMatchCount
- 1);
2172 if (refresh
|| (fFilterCheckCount
% 100) == 0) {
2175 fFilterCheckCount
++;
2178 ((ITmfEventProvider
) fTrace
).sendRequest(request
);
2180 request
.waitForCompletion();
2181 } catch (final InterruptedException e
) {
2184 synchronized (fFilterSyncObj
) {
2185 fFilterThread
= null;
2186 if (fFilterThreadResume
) {
2187 fFilterThreadResume
= false;
2188 fFilterThread
= new FilterThread(filter
);
2189 fFilterThread
.start();
2195 * Refresh the filter.
2197 public void refreshTable() {
2198 synchronized (syncObj
) {
2200 refreshPending
= true;
2205 Display
.getDefault().asyncExec(new Runnable() {
2208 if (request
.isCancelled()) {
2211 if (fTable
.isDisposed()) {
2215 * +1 for header row, +2 for top and bottom filter status
2218 fTable
.setItemCount((int) fFilterMatchCount
+ 3);
2220 synchronized (syncObj
) {
2221 refreshBusy
= false;
2222 if (refreshPending
) {
2223 refreshPending
= false;
2232 * Cancel this filtering thread.
2234 public void cancel() {
2235 if (request
!= null) {
2242 * Go to the next item of a search.
2244 protected void searchNext() {
2245 synchronized (fSearchSyncObj
) {
2246 if (fSearchThread
!= null) {
2249 final ITmfFilterTreeNode searchFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.SEARCH_OBJ
);
2250 if (searchFilter
== null) {
2253 final int selectionIndex
= fTable
.getSelectionIndex();
2255 if (selectionIndex
> 0) {
2256 /* -1 for header row, +1 for next event */
2257 startIndex
= selectionIndex
;
2260 * header row is selected, start at top event
2262 /* -1 for header row */
2263 startIndex
= Math
.max(0, fTable
.getTopIndex() - 1);
2265 final ITmfFilterTreeNode eventFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2266 if (eventFilter
!= null) {
2267 // -1 for top filter status row
2268 startIndex
= Math
.max(0, startIndex
- 1);
2270 fSearchThread
= new SearchThread(searchFilter
, eventFilter
, startIndex
, fSelectedRank
, Direction
.FORWARD
);
2271 fSearchThread
.schedule();
2276 * Go to the previous item of a search.
2278 protected void searchPrevious() {
2279 synchronized (fSearchSyncObj
) {
2280 if (fSearchThread
!= null) {
2283 final ITmfFilterTreeNode searchFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.SEARCH_OBJ
);
2284 if (searchFilter
== null) {
2287 final int selectionIndex
= fTable
.getSelectionIndex();
2289 if (selectionIndex
> 0) {
2290 /* -1 for header row, -1 for previous event */
2291 startIndex
= selectionIndex
- 2;
2294 * Header row is selected, start at precedent of top event
2296 /* -1 for header row, -1 for previous event */
2297 startIndex
= fTable
.getTopIndex() - 2;
2299 final ITmfFilterTreeNode eventFilter
= (ITmfFilterTreeNode
) fTable
.getData(Key
.FILTER_OBJ
);
2300 if (eventFilter
!= null) {
2301 /* -1 for top filter status row */
2302 startIndex
= startIndex
- 1;
2304 fSearchThread
= new SearchThread(searchFilter
, eventFilter
, startIndex
, fSelectedRank
, Direction
.BACKWARD
);
2305 fSearchThread
.schedule();
2310 * Stop the search thread.
2312 protected void stopSearchThread() {
2313 fPendingGotoRank
= -1;
2314 synchronized (fSearchSyncObj
) {
2315 if (fSearchThread
!= null) {
2316 fSearchThread
.cancel();
2317 fSearchThread
= null;
2323 * Wrapper for the search thread.
2325 protected class SearchThread
extends Job
{
2327 private ITmfFilterTreeNode searchFilter
;
2328 private ITmfFilterTreeNode eventFilter
;
2329 private int startIndex
;
2330 private int direction
;
2332 private long foundRank
= -1;
2333 private TmfEventRequest request
;
2334 private ITmfTimestamp foundTimestamp
= null;
2339 * @param searchFilter
2341 * @param eventFilter
2344 * The index at which we should start searching
2345 * @param currentRank
2348 * In which direction should we search, forward or backwards
2350 public SearchThread(final ITmfFilterTreeNode searchFilter
,
2351 final ITmfFilterTreeNode eventFilter
, final int startIndex
,
2352 final long currentRank
, final int direction
) {
2353 super(Messages
.TmfEventsTable_SearchingJobName
);
2354 this.searchFilter
= searchFilter
;
2355 this.eventFilter
= eventFilter
;
2356 this.startIndex
= startIndex
;
2357 this.rank
= currentRank
;
2358 this.direction
= direction
;
2362 protected IStatus
run(final IProgressMonitor monitor
) {
2363 final ITmfTrace trace
= fTrace
;
2364 if (trace
== null) {
2365 return Status
.OK_STATUS
;
2367 final Display display
= Display
.getDefault();
2368 if (startIndex
< 0) {
2369 rank
= (int) trace
.getNbEvents() - 1;
2371 * -1 for header row, -3 for header and top and bottom filter
2374 } else if (startIndex
>= (fTable
.getItemCount() - (eventFilter
== null ?
1 : 3))) {
2377 int idx
= startIndex
;
2378 while (foundRank
== -1) {
2379 final CachedEvent event
= fCache
.peekEvent(idx
);
2380 if (event
== null) {
2384 if (searchFilter
.matches(event
.event
) && ((eventFilter
== null) || eventFilter
.matches(event
.event
))) {
2385 foundRank
= event
.rank
;
2386 foundTimestamp
= event
.event
.getTimestamp();
2389 if (direction
== Direction
.FORWARD
) {
2395 if (foundRank
== -1) {
2396 if (direction
== Direction
.FORWARD
) {
2398 if (rank
> (trace
.getNbEvents() - 1)) {
2404 rank
= (int) trace
.getNbEvents() - 1;
2409 final int startRank
= (int) rank
;
2410 boolean wrapped
= false;
2411 while (!monitor
.isCanceled() && (foundRank
== -1)) {
2412 int nbRequested
= (direction
== Direction
.FORWARD ? Integer
.MAX_VALUE
: Math
.min((int) rank
+ 1, trace
.getCacheSize()));
2413 if (direction
== Direction
.BACKWARD
) {
2414 rank
= Math
.max(0, rank
- trace
.getCacheSize() + 1);
2416 request
= new TmfEventRequest(ITmfEvent
.class, TmfTimeRange
.ETERNITY
,
2417 (int) rank
, nbRequested
, ExecutionType
.BACKGROUND
) {
2418 long currentRank
= rank
;
2421 public void handleData(final ITmfEvent event
) {
2422 super.handleData(event
);
2423 if (searchFilter
.matches(event
) && ((eventFilter
== null) || eventFilter
.matches(event
))) {
2424 foundRank
= currentRank
;
2425 foundTimestamp
= event
.getTimestamp();
2426 if (direction
== Direction
.FORWARD
) {
2434 ((ITmfEventProvider
) trace
).sendRequest(request
);
2436 request
.waitForCompletion();
2437 if (request
.isCancelled()) {
2438 return Status
.OK_STATUS
;
2440 } catch (final InterruptedException e
) {
2441 synchronized (fSearchSyncObj
) {
2442 fSearchThread
= null;
2444 return Status
.OK_STATUS
;
2446 if (foundRank
== -1) {
2447 if (direction
== Direction
.FORWARD
) {
2449 synchronized (fSearchSyncObj
) {
2450 fSearchThread
= null;
2452 return Status
.OK_STATUS
;
2454 nbRequested
= (int) rank
;
2460 rank
= (int) trace
.getNbEvents() - 1;
2463 if ((rank
<= startRank
) && wrapped
) {
2464 synchronized (fSearchSyncObj
) {
2465 fSearchThread
= null;
2467 return Status
.OK_STATUS
;
2472 int index
= (int) foundRank
;
2473 if (eventFilter
!= null) {
2474 index
= fCache
.getFilteredEventIndex(foundRank
);
2476 /* +1 for header row, +1 for top filter status row */
2477 final int selection
= index
+ 1 + (eventFilter
!= null ?
+1 : 0);
2479 display
.asyncExec(new Runnable() {
2482 if (monitor
.isCanceled()) {
2485 if (fTable
.isDisposed()) {
2488 fTable
.setSelection(selection
);
2489 fSelectedRank
= foundRank
;
2490 fSelectedBeginRank
= fSelectedRank
;
2491 fRawViewer
.selectAndReveal(fSelectedRank
);
2492 if (foundTimestamp
!= null) {
2493 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, foundTimestamp
));
2495 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable
.this, getSelection()));
2496 synchronized (fSearchSyncObj
) {
2497 fSearchThread
= null;
2499 updateStatusLine(null);
2502 return Status
.OK_STATUS
;
2506 protected void canceling() {
2507 if (request
!= null) {
2510 synchronized (fSearchSyncObj
) {
2511 fSearchThread
= null;
2517 * Create the resources.
2519 private void createResources() {
2520 fGrayColor
= fResourceManager
.createColor(ColorUtil
.blend(fTable
.getBackground().getRGB(), fTable
.getForeground().getRGB()));
2521 fGreenColor
= PlatformUI
.getWorkbench().getDisplay().getSystemColor(SWT
.COLOR_DARK_GREEN
);
2525 * Initialize the fonts.
2527 private void initializeFonts() {
2528 FontRegistry fontRegistry
= PlatformUI
.getWorkbench().getThemeManager().getCurrentTheme().getFontRegistry();
2529 fFont
= fontRegistry
.get(FONT_DEFINITION_ID
);
2530 fBoldFont
= fontRegistry
.getBold(FONT_DEFINITION_ID
);
2531 fTable
.setFont(fFont
);
2532 /* Column header font cannot be set. See Bug 63038 */
2536 * Initialize the colors.
2538 private void initializeColors() {
2539 ColorRegistry colorRegistry
= PlatformUI
.getWorkbench().getThemeManager().getCurrentTheme().getColorRegistry();
2540 fHighlightColor
= colorRegistry
.get(HIGHLIGHT_COLOR_DEFINITION_ID
);
2547 public void propertyChange(PropertyChangeEvent event
) {
2548 if ((IThemeManager
.CHANGE_CURRENT_THEME
.equals(event
.getProperty())) ||
2549 (FONT_DEFINITION_ID
.equals(event
.getProperty()))) {
2553 if ((IThemeManager
.CHANGE_CURRENT_THEME
.equals(event
.getProperty())) ||
2554 (HIGHLIGHT_COLOR_DEFINITION_ID
.equals(event
.getProperty()))) {
2564 * Whether or not a pack was done in this call. Otherwise, it was already done by a
2569 protected boolean packColumns() {
2573 fTable
.setRedraw(false);
2575 TableColumn tableColumns
[] = fTable
.getColumns();
2576 for (int i
= 0; i
< tableColumns
.length
; i
++) {
2577 final TableColumn column
= tableColumns
[i
];
2578 packSingleColumn(i
, column
);
2582 // Make sure that redraw is always enabled.
2583 fTable
.setRedraw(true);
2589 private void packMarginColumn() {
2590 TableColumn
[] columns
= fTable
.getColumns();
2591 if (columns
.length
> 0) {
2592 packSingleColumn(0, columns
[0]);
2596 private void packSingleColumn(int i
, final TableColumn column
) {
2597 final int headerWidth
= column
.getWidth();
2600 * Workaround for Linux which doesn't consider the image width of
2601 * search/filter row in TableColumn.pack() after having executed
2602 * TableItem.setImage(null) for other rows than search/filter row.
2604 if (IS_LINUX
&& (i
== 0) && fCollapseFilterEnabled
) {
2605 column
.setWidth(column
.getWidth() + SEARCH_IMAGE
.getBounds().width
);
2608 if (column
.getWidth() < headerWidth
) {
2609 column
.setWidth(headerWidth
);
2614 * Returns true if the column is a visible event column.
2618 * @return false if the column is the margin column or hidden, true
2621 private static boolean isVisibleEventColumn(TableColumn column
) {
2622 if (column
.getData(Key
.ASPECT
) == TmfMarginColumn
.MARGIN_ASPECT
) {
2625 if (!column
.getResizable() && column
.getWidth() == 0) {
2632 * Get the array of item strings (e.g., what to display in each cell of the
2633 * table row) corresponding to the columns and trace event passed in
2634 * parameter. The order of the Strings in the returned array will correspond
2635 * to the iteration order of 'columns'.
2638 * To ensure consistent results, make sure only call this within a scope
2639 * synchronized on 'columns'! If the order of 'columns' changes right after
2640 * this method is called, the returned value won't be ordered correctly
2643 private static String
[] getItemStrings(List
<TmfEventTableColumn
> columns
, ITmfEvent event
) {
2644 if (event
== null) {
2645 return EMPTY_STRING_ARRAY
;
2647 synchronized (columns
) {
2648 List
<String
> itemStrings
= new ArrayList
<>(columns
.size());
2649 for (TmfEventTableColumn column
: columns
) {
2650 ITmfEvent passedEvent
= event
;
2651 if (!(column
instanceof TmfMarginColumn
) && (event
instanceof CachedEvent
)) {
2653 * Make sure that the event object from the trace is passed
2654 * to all columns but the TmfMarginColumn
2656 passedEvent
= ((CachedEvent
) event
).event
;
2658 if (passedEvent
== null) {
2659 itemStrings
.add(EMPTY_STRING
);
2661 itemStrings
.add(column
.getItemString(passedEvent
));
2665 return itemStrings
.toArray(new String
[0]);
2670 * Get the contents of the row in the events table corresponding to an
2671 * event. The order of the elements corresponds to the current order of the
2675 * The event printed in this row
2676 * @return The event row entries
2678 public String
[] getItemStrings(ITmfEvent event
) {
2679 List
<TmfEventTableColumn
> columns
= new ArrayList
<>();
2680 for (int i
: fTable
.getColumnOrder()) {
2681 columns
.add(fColumns
.get(i
));
2683 return getItemStrings(columns
, event
);
2687 * Returns an array of zero-relative integers that map the creation order of
2688 * the receiver's columns to the order in which they are currently being
2691 * Specifically, the indices of the returned array represent the current
2692 * visual order of the columns, and the contents of the array represent the
2693 * creation order of the columns.
2695 * @return the current visual order of the receiver's columns
2698 public int[] getColumnOrder() {
2699 return fColumnOrder
;
2703 * Sets the order that the columns in the receiver should be displayed in to
2704 * the given argument which is described in terms of the zero-relative
2705 * ordering of when the columns were added.
2707 * Specifically, the contents of the array represent the original position
2708 * of each column at the time its creation.
2711 * the new order to display the columns
2714 public void setColumnOrder(int[] order
) {
2715 if (order
== null || order
.length
!= fTable
.getColumns().length
) {
2718 fTable
.setColumnOrder(order
);
2719 fColumnOrder
= fTable
.getColumnOrder();
2723 * Notify this table that is got the UI focus.
2725 public void setFocus() {
2730 * Registers context menus with a site for extension. This method can be
2731 * called for part sites so that context menu contributions can be added.
2734 * the site that the context menus will be registered for
2738 public void registerContextMenus(IWorkbenchPartSite site
) {
2739 if (site
instanceof IEditorSite
) {
2740 IEditorSite editorSite
= (IEditorSite
) site
;
2741 // Don't use the editor input when adding contributions, otherwise
2742 // we get too many unwanted things.
2743 editorSite
.registerContextMenu(fTablePopupMenuManager
, this, false);
2748 * Assign a new trace to this event table.
2751 * The trace to assign to this event table
2752 * @param disposeOnClose
2753 * true if the trace should be disposed when the table is
2756 public void setTrace(final ITmfTrace trace
, final boolean disposeOnClose
) {
2757 if ((fTrace
!= null) && fDisposeOnClose
) {
2762 fDisposeOnClose
= disposeOnClose
;
2764 // Perform the updates on the UI thread
2765 PlatformUI
.getWorkbench().getDisplay().syncExec(new Runnable() {
2769 fSelectedBeginRank
= -1;
2771 fCache
.setTrace(trace
); // Clear the cache
2772 if (trace
!= null) {
2773 if (!fTable
.isDisposed()) {
2774 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
2775 // +1 for header row
2776 fTable
.setItemCount((int) trace
.getNbEvents() + 1);
2779 fFilterMatchCount
= 0;
2780 fFilterCheckCount
= 0;
2782 * +1 for header row, +2 for top and bottom filter
2785 fTable
.setItemCount(3);
2786 startFilterThread();
2790 fRawViewer
.setTrace(trace
);
2796 * Assign the status line manager
2798 * @param statusLineManager
2799 * The status line manager, or null to disable status line
2802 public void setStatusLineManager(IStatusLineManager statusLineManager
) {
2803 if (fStatusLineManager
!= null && statusLineManager
== null) {
2804 fStatusLineManager
.setMessage(EMPTY_STRING
);
2806 fStatusLineManager
= statusLineManager
;
2809 private void updateStatusLine(ITmfTimestamp delta
) {
2810 if (fStatusLineManager
!= null) {
2811 if (delta
!= null) {
2812 fStatusLineManager
.setMessage("\u0394: " + delta
); //$NON-NLS-1$
2814 fStatusLineManager
.setMessage(null);
2819 // ------------------------------------------------------------------------
2821 // ------------------------------------------------------------------------
2824 * Notify that the event cache has been updated
2827 * Also notify if the populating of the cache is complete, or
2830 public void cacheUpdated(final boolean completed
) {
2831 synchronized (fCacheUpdateSyncObj
) {
2832 if (fCacheUpdateBusy
) {
2833 fCacheUpdatePending
= true;
2834 fCacheUpdateCompleted
= completed
;
2837 fCacheUpdateBusy
= true;
2839 // Event cache is now updated. Perform update on the UI thread
2840 PlatformUI
.getWorkbench().getDisplay().asyncExec(new Runnable() {
2843 if (!fTable
.isDisposed()) {
2848 populateCompleted();
2850 synchronized (fCacheUpdateSyncObj
) {
2851 fCacheUpdateBusy
= false;
2852 if (fCacheUpdatePending
) {
2853 fCacheUpdatePending
= false;
2854 cacheUpdated(fCacheUpdateCompleted
);
2862 * Callback for when populating the table is complete.
2864 protected void populateCompleted() {
2865 // Nothing by default;
2868 // ------------------------------------------------------------------------
2869 // ISelectionProvider
2870 // ------------------------------------------------------------------------
2873 public void addSelectionChangedListener(ISelectionChangedListener listener
) {
2874 selectionChangedListeners
.add(listener
);
2878 public ISelection
getSelection() {
2879 if (fTable
== null || fTable
.isDisposed()) {
2880 return StructuredSelection
.EMPTY
;
2882 List
<Object
> list
= new ArrayList
<>(fTable
.getSelection().length
);
2883 for (TableItem item
: fTable
.getSelection()) {
2884 if (item
.getData() != null) {
2885 list
.add(item
.getData());
2888 return new StructuredSelection(list
);
2892 public void removeSelectionChangedListener(ISelectionChangedListener listener
) {
2893 selectionChangedListeners
.remove(listener
);
2897 public void setSelection(ISelection selection
) {
2902 * Notifies any selection changed listeners that the viewer's selection has
2903 * changed. Only listeners registered at the time this method is called are
2907 * a selection changed event
2909 * @see ISelectionChangedListener#selectionChanged
2911 protected void fireSelectionChanged(final SelectionChangedEvent event
) {
2912 Object
[] listeners
= selectionChangedListeners
.getListeners();
2913 for (int i
= 0; i
< listeners
.length
; ++i
) {
2914 final ISelectionChangedListener l
= (ISelectionChangedListener
) listeners
[i
];
2915 SafeRunnable
.run(new SafeRunnable() {
2918 l
.selectionChanged(event
);
2924 // ------------------------------------------------------------------------
2925 // Bookmark handling
2926 // ------------------------------------------------------------------------
2929 * Add a bookmark to this event table.
2931 * @param bookmarksFile
2932 * The file to use for the bookmarks
2934 public void addBookmark(final IFile bookmarksFile
) {
2935 fBookmarksFile
= bookmarksFile
;
2936 final TableItem
[] selection
= fTable
.getSelection();
2937 if (selection
.length
> 0) {
2938 final TableItem tableItem
= selection
[0];
2939 if (tableItem
.getData(Key
.RANK
) != null) {
2940 final StringBuffer defaultMessage
= new StringBuffer();
2941 for (int i
: fTable
.getColumnOrder()) {
2942 TableColumn column
= fTable
.getColumns()[i
];
2943 // Omit the margin column and hidden columns
2944 if (isVisibleEventColumn(column
)) {
2945 if (defaultMessage
.length() > 0) {
2946 defaultMessage
.append(", "); //$NON-NLS-1$
2948 defaultMessage
.append(tableItem
.getText(i
));
2951 final AddBookmarkDialog dialog
= new AddBookmarkDialog(
2952 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell(), defaultMessage
.toString());
2953 if (dialog
.open() == Window
.OK
) {
2954 final String message
= dialog
.getValue();
2956 final Long rank
= (Long
) tableItem
.getData(Key
.RANK
);
2957 final String location
= NLS
.bind(Messages
.TmfMarker_LocationRank
, rank
.toString());
2958 final ITmfTimestamp timestamp
= (ITmfTimestamp
) tableItem
.getData(Key
.TIMESTAMP
);
2959 final long[] id
= new long[1];
2960 ResourcesPlugin
.getWorkspace().run(new IWorkspaceRunnable() {
2962 public void run(IProgressMonitor monitor
) throws CoreException
{
2963 final IMarker bookmark
= bookmarksFile
.createMarker(IMarker
.BOOKMARK
);
2964 bookmark
.setAttribute(IMarker
.MESSAGE
, message
.toString());
2965 bookmark
.setAttribute(IMarker
.LOCATION
, location
);
2966 bookmark
.setAttribute(ITmfMarker
.MARKER_RANK
, rank
.toString());
2967 bookmark
.setAttribute(ITmfMarker
.MARKER_TIME
, Long
.toString(timestamp
.toNanos()));
2968 bookmark
.setAttribute(ITmfMarker
.MARKER_COLOR
, dialog
.getColorValue().toString());
2969 id
[0] = bookmark
.getId();
2972 fBookmarksMap
.put(rank
, id
[0]);
2974 } catch (final CoreException e
) {
2975 displayException(e
);
2984 * Add one or more bookmarks to this event table.
2987 * The bookmarks to add
2990 public void addBookmark(final IMarker
... bookmarks
) {
2991 for (IMarker bookmark
: bookmarks
) {
2992 /* try location as an integer for backward compatibility */
2993 long rank
= bookmark
.getAttribute(IMarker
.LOCATION
, -1);
2995 String rankString
= bookmark
.getAttribute(ITmfMarker
.MARKER_RANK
, (String
) null);
2996 if (rankString
!= null) {
2998 rank
= Long
.parseLong(rankString
);
2999 } catch (NumberFormatException e
) {
3000 Activator
.getDefault().logError("Invalid marker rank", e
); //$NON-NLS-1$
3005 fBookmarksMap
.put(rank
, bookmark
.getId());
3012 * Remove one or more bookmarks from this event table.
3015 * The bookmarks to remove
3018 public void removeBookmark(final IMarker
... bookmarks
) {
3019 for (IMarker bookmark
: bookmarks
) {
3020 for (final Entry
<Long
, Long
> entry
: fBookmarksMap
.entries()) {
3021 if (entry
.getValue().equals(bookmark
.getId())) {
3022 fBookmarksMap
.remove(entry
.getKey(), entry
.getValue());
3030 private void toggleBookmark(final Long rank
) {
3031 if (fBookmarksFile
== null) {
3034 if (fBookmarksMap
.containsKey(rank
)) {
3035 final Collection
<Long
> markerIds
= fBookmarksMap
.removeAll(rank
);
3038 for (long markerId
: markerIds
) {
3039 final IMarker bookmark
= fBookmarksFile
.findMarker(markerId
);
3040 if (bookmark
!= null) {
3044 } catch (final CoreException e
) {
3045 displayException(e
);
3048 addBookmark(fBookmarksFile
);
3053 * Refresh the bookmarks assigned to this trace, from the contents of a
3056 * @param bookmarksFile
3057 * The bookmark file to use
3059 public void refreshBookmarks(final IFile bookmarksFile
) {
3060 fBookmarksFile
= bookmarksFile
;
3061 if (bookmarksFile
== null) {
3062 fBookmarksMap
.clear();
3067 fBookmarksMap
.clear();
3068 IMarker
[] bookmarks
= bookmarksFile
.findMarkers(IMarker
.BOOKMARK
, false, IResource
.DEPTH_ZERO
);
3069 addBookmark(bookmarks
);
3070 } catch (final CoreException e
) {
3071 displayException(e
);
3076 public void gotoMarker(final IMarker marker
) {
3077 ITmfTimestamp tsBegin
= null;
3078 ITmfTimestamp tsEnd
= null;
3079 /* try location as an integer for backward compatibility */
3080 long rank
= marker
.getAttribute(IMarker
.LOCATION
, -1);
3082 String rankString
= marker
.getAttribute(ITmfMarker
.MARKER_RANK
, (String
) null);
3084 rank
= Long
.parseLong(rankString
);
3085 } catch (NumberFormatException e
) {
3090 String timeString
= marker
.getAttribute(ITmfMarker
.MARKER_TIME
, (String
) null);
3091 long time
= Long
.parseLong(timeString
);
3092 tsBegin
= TmfTimestamp
.fromNanos(time
);
3093 String durationString
= marker
.getAttribute(ITmfMarker
.MARKER_DURATION
, (String
) null);
3094 long duration
= Long
.parseLong(durationString
);
3095 tsEnd
= TmfTimestamp
.fromNanos(time
+ duration
);
3096 } catch (NumberFormatException e
) {
3099 if (rank
== -1 && tsBegin
!= null) {
3100 final ITmfContext context
= fTrace
.seekEvent(tsBegin
);
3101 rank
= context
.getRank();
3105 int index
= (int) rank
;
3106 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
3107 // +1 for top filter status row
3108 index
= fCache
.getFilteredEventIndex(rank
) + 1;
3109 } else if (rank
>= fTable
.getItemCount()) {
3110 fPendingGotoRank
= rank
;
3112 fSelectedRank
= rank
;
3113 fSelectedBeginRank
= fSelectedRank
;
3114 fTable
.setSelection(index
+ 1); // +1 for header row
3115 updateStatusLine(null);
3116 if (tsBegin
!= null) {
3117 if (tsEnd
!= null) {
3118 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, tsBegin
, tsEnd
));
3120 broadcast(new TmfSelectionRangeUpdatedSignal(TmfEventsTable
.this, tsBegin
));
3126 // ------------------------------------------------------------------------
3128 // ------------------------------------------------------------------------
3131 public void colorSettingsChanged(final ColorSetting
[] colorSettings
) {
3135 // ------------------------------------------------------------------------
3137 // ------------------------------------------------------------------------
3140 * Handler for the trace updated signal
3143 * The incoming signal
3146 public void traceUpdated(final TmfTraceUpdatedSignal signal
) {
3147 if ((signal
.getTrace() != fTrace
) || fTable
.isDisposed()) {
3150 // Perform the refresh on the UI thread
3151 Display
.getDefault().asyncExec(new Runnable() {
3154 if (!fTable
.isDisposed() && (fTrace
!= null)) {
3155 if (fTable
.getData(Key
.FILTER_OBJ
) == null) {
3156 /* +1 for header row */
3157 fTable
.setItemCount((int) fTrace
.getNbEvents() + 1);
3158 /* +1 for header row */
3159 if ((fPendingGotoRank
!= -1) && ((fPendingGotoRank
+ 1) < fTable
.getItemCount())) {
3160 /* +1 for header row */
3161 fTable
.setSelection((int) fPendingGotoRank
+ 1);
3162 fPendingGotoRank
= -1;
3163 updateStatusLine(null);
3166 startFilterThread();
3169 if (!fRawViewer
.isDisposed() && (fTrace
!= null)) {
3170 fRawViewer
.refreshEventCount();
3177 * Handler for the selection range signal.
3180 * The incoming signal
3184 public void selectionRangeUpdated(final TmfSelectionRangeUpdatedSignal signal
) {
3185 if ((signal
.getSource() != this) && (fTrace
!= null) && (!fTable
.isDisposed())) {
3188 * Create a request for one event that will be queued after other
3189 * ongoing requests. When this request is completed do the work to
3190 * select the actual event with the timestamp specified in the
3191 * signal. This procedure prevents the method fTrace.getRank() from
3192 * interfering and delaying ongoing requests.
3194 final TmfEventRequest subRequest
= new TmfEventRequest(ITmfEvent
.class,
3195 TmfTimeRange
.ETERNITY
, 0, 1, ExecutionType
.FOREGROUND
) {
3197 ITmfTimestamp ts
= signal
.getBeginTime();
3198 ITmfTimestamp tf
= signal
.getEndTime();
3201 public void handleSuccess() {
3202 super.handleSuccess();
3203 if (fTrace
== null) {
3207 final Pair
<Long
, Long
> selection
= getSelectedRanks();
3208 updateDisplayWithSelection(selection
.getFirst().longValue(), selection
.getSecond().longValue());
3212 * Verify if the event is within the trace range and adjust if
3215 * @return A pair of rank representing the selected area
3217 private Pair
<Long
, Long
> getSelectedRanks() {
3219 /* Clamp the timestamp value to fit inside of the trace */
3220 ITmfTimestamp timestampBegin
= ts
;
3221 if (timestampBegin
.compareTo(fTrace
.getStartTime()) < 0) {
3222 timestampBegin
= fTrace
.getStartTime();
3224 if (timestampBegin
.compareTo(fTrace
.getEndTime()) > 0) {
3225 timestampBegin
= fTrace
.getEndTime();
3228 ITmfTimestamp timestampEnd
= tf
;
3229 if (timestampEnd
.compareTo(fTrace
.getStartTime()) < 0) {
3230 timestampEnd
= fTrace
.getStartTime();
3232 if (timestampEnd
.compareTo(fTrace
.getEndTime()) > 0) {
3233 timestampEnd
= fTrace
.getEndTime();
3240 ITmfContext contextBegin
;
3241 ITmfContext contextEnd
;
3243 /* Adjust the rank of the selection to the right range */
3244 if (timestampBegin
.compareTo(timestampEnd
) > 0) {
3246 contextEnd
= fTrace
.seekEvent(te
);
3247 rankEnd
= contextEnd
.getRank();
3248 contextEnd
.dispose();
3250 * To include all events at the begin time, seek at the
3251 * next nanosecond and then use the previous rank
3253 tb
= timestampBegin
.normalize(1, ITmfTimestamp
.NANOSECOND_SCALE
);
3254 if (tb
.compareTo(fTrace
.getEndTime()) <= 0) {
3255 contextBegin
= fTrace
.seekEvent(tb
);
3256 rankBegin
= contextBegin
.getRank();
3257 contextBegin
.dispose();
3259 rankBegin
= ITmfContext
.UNKNOWN_RANK
;
3261 rankBegin
= (rankBegin
== ITmfContext
.UNKNOWN_RANK ? fTrace
.getNbEvents() : rankBegin
) - 1;
3263 * If no events in selection range, select only the next
3266 rankBegin
= rankBegin
>= rankEnd ? rankBegin
: rankEnd
;
3268 tb
= timestampBegin
;
3269 contextBegin
= fTrace
.seekEvent(tb
);
3270 rankBegin
= contextBegin
.getRank();
3271 contextBegin
.dispose();
3273 * To include all events at the end time, seek at the
3274 * next nanosecond and then use the previous rank
3276 te
= timestampEnd
.normalize(1, ITmfTimestamp
.NANOSECOND_SCALE
);
3277 if (te
.compareTo(fTrace
.getEndTime()) <= 0) {
3278 contextEnd
= fTrace
.seekEvent(te
);
3279 rankEnd
= contextEnd
.getRank();
3280 contextEnd
.dispose();
3282 rankEnd
= ITmfContext
.UNKNOWN_RANK
;
3284 rankEnd
= (rankEnd
== ITmfContext
.UNKNOWN_RANK ? fTrace
.getNbEvents() : rankEnd
) - 1;
3286 * If no events in selection range, select only the next
3289 rankEnd
= rankEnd
>= rankBegin ? rankEnd
: rankBegin
;
3291 return new Pair
<>(Long
.valueOf(rankBegin
), Long
.valueOf(rankEnd
));
3294 private void updateDisplayWithSelection(final long rankBegin
, final long rankEnd
) {
3295 PlatformUI
.getWorkbench().getDisplay().asyncExec(new Runnable() {
3298 // Return if table is disposed
3299 if (fTable
.isDisposed()) {
3303 fSelectedRank
= rankEnd
;
3304 long toReveal
= fSelectedBeginRank
!= rankBegin ? rankBegin
: rankEnd
;
3305 fSelectedBeginRank
= rankBegin
;
3306 int indexBegin
= (int) rankBegin
;
3307 int indexEnd
= (int) rankEnd
;
3309 if (fTable
.getData(Key
.FILTER_OBJ
) != null) {
3310 /* +1 for top filter status row */
3311 indexBegin
= fCache
.getFilteredEventIndex(rankBegin
) + 1;
3312 indexEnd
= rankEnd
== rankBegin ? indexBegin
: fCache
.getFilteredEventIndex(rankEnd
) + 1;
3314 /* +1 for header row */
3315 fTable
.setSelectionRange(indexBegin
+ 1, indexEnd
+ 1);
3316 fRawViewer
.selectAndReveal(toReveal
);
3317 updateStatusLine(null);
3323 ((ITmfEventProvider
) fTrace
).sendRequest(subRequest
);
3327 // ------------------------------------------------------------------------
3329 // ------------------------------------------------------------------------
3332 * Display an exception in a message box
3337 private static void displayException(final Exception e
) {
3338 final MessageBox mb
= new MessageBox(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell());
3339 mb
.setText(e
.getClass().getSimpleName());
3340 mb
.setMessage(e
.getMessage());
3347 public void refresh() {
3354 * Margin column for images and special text (e.g. collapse count)
3356 private static final class TmfMarginColumn
extends TmfEventTableColumn
{
3358 private static final @NonNull ITmfEventAspect
<String
> MARGIN_ASPECT
=
3359 new ITmfEventAspect
<String
>() {
3362 public String
getName() {
3363 return EMPTY_STRING
;
3367 public String
resolve(ITmfEvent event
) {
3368 if (!(event
instanceof CachedEvent
) || ((CachedEvent
) event
).repeatCount
== 0) {
3369 return EMPTY_STRING
;
3371 return "+" + ((CachedEvent
) event
).repeatCount
; //$NON-NLS-1$
3375 public String
getHelpText() {
3376 return EMPTY_STRING
;
3383 public TmfMarginColumn() {
3384 super(MARGIN_ASPECT
);