projects / deliverable / tracecompass.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
tmf: Use TmfFilterMatchesAspectNode's in the event table
[deliverable/tracecompass.git] / org.eclipse.tracecompass.tmf.ui / src / org / eclipse / tracecompass / tmf / ui / viewers / events / TmfEventsTable.java
1 /*******************************************************************************
2 * Copyright (c) 2010, 2014 Ericsson
3 *
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
8 *
9 * Contributors:
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 *******************************************************************************/
17
18 package org.eclipse.tracecompass.tmf.ui.viewers.events;
19
20 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
21
22 import java.io.FileNotFoundException;
23 import java.util.ArrayList;
24 import java.util.Collection;
25 import java.util.HashMap;
26 import java.util.LinkedList;
27 import java.util.List;
28 import java.util.Map.Entry;
29 import java.util.regex.Pattern;
30 import java.util.regex.PatternSyntaxException;
31
32 import org.eclipse.core.commands.Command;
33 import org.eclipse.core.commands.ExecutionException;
34 import org.eclipse.core.commands.NotEnabledException;
35 import org.eclipse.core.commands.NotHandledException;
36 import org.eclipse.core.commands.ParameterizedCommand;
37 import org.eclipse.core.commands.common.NotDefinedException;
38 import org.eclipse.core.expressions.IEvaluationContext;
39 import org.eclipse.core.resources.IFile;
40 import org.eclipse.core.resources.IMarker;
41 import org.eclipse.core.resources.IResource;
42 import org.eclipse.core.resources.IResourceVisitor;
43 import org.eclipse.core.resources.ResourcesPlugin;
44 import org.eclipse.core.runtime.CoreException;
45 import org.eclipse.core.runtime.IPath;
46 import org.eclipse.core.runtime.IProgressMonitor;
47 import org.eclipse.core.runtime.IStatus;
48 import org.eclipse.core.runtime.ListenerList;
49 import org.eclipse.core.runtime.Path;
50 import org.eclipse.core.runtime.Status;
51 import org.eclipse.core.runtime.jobs.Job;
52 import org.eclipse.emf.common.util.URI;
53 import org.eclipse.emf.ecore.EValidator;
54 import org.eclipse.jdt.annotation.NonNull;
55 import org.eclipse.jface.action.Action;
56 import org.eclipse.jface.action.IAction;
57 import org.eclipse.jface.action.IMenuListener;
58 import org.eclipse.jface.action.IMenuManager;
59 import org.eclipse.jface.action.IStatusLineManager;
60 import org.eclipse.jface.action.MenuManager;
61 import org.eclipse.jface.action.Separator;
62 import org.eclipse.jface.dialogs.InputDialog;
63 import org.eclipse.jface.dialogs.MessageDialog;
64 import org.eclipse.jface.resource.FontDescriptor;
65 import org.eclipse.jface.resource.JFaceResources;
66 import org.eclipse.jface.resource.LocalResourceManager;
67 import org.eclipse.jface.util.OpenStrategy;
68 import org.eclipse.jface.util.SafeRunnable;
69 import org.eclipse.jface.viewers.ArrayContentProvider;
70 import org.eclipse.jface.viewers.ISelection;
71 import org.eclipse.jface.viewers.ISelectionChangedListener;
72 import org.eclipse.jface.viewers.ISelectionProvider;
73 import org.eclipse.jface.viewers.LabelProvider;
74 import org.eclipse.jface.viewers.SelectionChangedEvent;
75 import org.eclipse.jface.viewers.StructuredSelection;
76 import org.eclipse.jface.window.Window;
77 import org.eclipse.swt.SWT;
78 import org.eclipse.swt.custom.SashForm;
79 import org.eclipse.swt.custom.TableEditor;
80 import org.eclipse.swt.events.ControlAdapter;
81 import org.eclipse.swt.events.ControlEvent;
82 import org.eclipse.swt.events.FocusAdapter;
83 import org.eclipse.swt.events.FocusEvent;
84 import org.eclipse.swt.events.KeyAdapter;
85 import org.eclipse.swt.events.KeyEvent;
86 import org.eclipse.swt.events.MouseAdapter;
87 import org.eclipse.swt.events.MouseEvent;
88 import org.eclipse.swt.events.SelectionAdapter;
89 import org.eclipse.swt.events.SelectionEvent;
90 import org.eclipse.swt.graphics.Color;
91 import org.eclipse.swt.graphics.Font;
92 import org.eclipse.swt.graphics.Image;
93 import org.eclipse.swt.graphics.Point;
94 import org.eclipse.swt.graphics.Rectangle;
95 import org.eclipse.swt.layout.FillLayout;
96 import org.eclipse.swt.layout.GridData;
97 import org.eclipse.swt.layout.GridLayout;
98 import org.eclipse.swt.widgets.Composite;
99 import org.eclipse.swt.widgets.Display;
100 import org.eclipse.swt.widgets.Event;
101 import org.eclipse.swt.widgets.Label;
102 import org.eclipse.swt.widgets.Listener;
103 import org.eclipse.swt.widgets.Menu;
104 import org.eclipse.swt.widgets.MessageBox;
105 import org.eclipse.swt.widgets.Shell;
106 import org.eclipse.swt.widgets.TableColumn;
107 import org.eclipse.swt.widgets.TableItem;
108 import org.eclipse.swt.widgets.Text;
109 import org.eclipse.tracecompass.internal.tmf.core.filter.TmfCollapseFilter;
110 import org.eclipse.tracecompass.internal.tmf.ui.Activator;
111 import org.eclipse.tracecompass.internal.tmf.ui.Messages;
112 import org.eclipse.tracecompass.internal.tmf.ui.commands.ExportToTextCommandHandler;
113 import org.eclipse.tracecompass.internal.tmf.ui.dialogs.MultiLineInputDialog;
114 import org.eclipse.tracecompass.tmf.core.component.ITmfEventProvider;
115 import org.eclipse.tracecompass.tmf.core.component.TmfComponent;
116 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
117 import org.eclipse.tracecompass.tmf.core.event.aspect.ITmfEventAspect;
118 import org.eclipse.tracecompass.tmf.core.event.aspect.TmfEventFieldAspect;
119 import org.eclipse.tracecompass.tmf.core.event.collapse.ITmfCollapsibleEvent;
120 import org.eclipse.tracecompass.tmf.core.event.lookup.ITmfCallsite;
121 import org.eclipse.tracecompass.tmf.core.event.lookup.ITmfModelLookup;
122 import org.eclipse.tracecompass.tmf.core.event.lookup.ITmfSourceLookup;
123 import org.eclipse.tracecompass.tmf.core.filter.ITmfFilter;
124 import org.eclipse.tracecompass.tmf.core.filter.model.ITmfFilterTreeNode;
125 import org.eclipse.tracecompass.tmf.core.filter.model.TmfFilterAndNode;
126 import org.eclipse.tracecompass.tmf.core.filter.model.TmfFilterMatchesAspectNode;
127 import org.eclipse.tracecompass.tmf.core.filter.model.TmfFilterMatchesNode;
128 import org.eclipse.tracecompass.tmf.core.filter.model.TmfFilterNode;
129 import org.eclipse.tracecompass.tmf.core.request.ITmfEventRequest.ExecutionType;
130 import org.eclipse.tracecompass.tmf.core.request.TmfEventRequest;
131 import org.eclipse.tracecompass.tmf.core.signal.TmfEventFilterAppliedSignal;
132 import org.eclipse.tracecompass.tmf.core.signal.TmfEventSearchAppliedSignal;
133 import org.eclipse.tracecompass.tmf.core.signal.TmfEventSelectedSignal;
134 import org.eclipse.tracecompass.tmf.core.signal.TmfSignalHandler;
135 import org.eclipse.tracecompass.tmf.core.signal.TmfTimeSynchSignal;
136 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceUpdatedSignal;
137 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
138 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange;
139 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp;
140 import org.eclipse.tracecompass.tmf.core.trace.ITmfContext;
141 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
142 import org.eclipse.tracecompass.tmf.core.trace.TmfTrace;
143 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceManager;
144 import org.eclipse.tracecompass.tmf.core.trace.location.ITmfLocation;
145 import org.eclipse.tracecompass.tmf.ui.viewers.events.TmfEventsCache.CachedEvent;
146 import org.eclipse.tracecompass.tmf.ui.viewers.events.columns.TmfEventTableColumn;
147 import org.eclipse.tracecompass.tmf.ui.views.colors.ColorSetting;
148 import org.eclipse.tracecompass.tmf.ui.views.colors.ColorSettingsManager;
149 import org.eclipse.tracecompass.tmf.ui.views.colors.IColorSettingsListener;
150 import org.eclipse.tracecompass.tmf.ui.views.filter.FilterManager;
151 import org.eclipse.tracecompass.tmf.ui.widgets.rawviewer.TmfRawEventViewer;
152 import org.eclipse.tracecompass.tmf.ui.widgets.virtualtable.TmfVirtualTable;
153 import org.eclipse.ui.IWorkbenchPage;
154 import org.eclipse.ui.PlatformUI;
155 import org.eclipse.ui.commands.ICommandService;
156 import org.eclipse.ui.dialogs.ListDialog;
157 import org.eclipse.ui.handlers.IHandlerService;
158 import org.eclipse.ui.ide.IDE;
159 import org.eclipse.ui.ide.IGotoMarker;
160 import org.eclipse.ui.themes.ColorUtil;
161
162 import com.google.common.base.Joiner;
163 import com.google.common.collect.HashMultimap;
164 import com.google.common.collect.ImmutableList;
165 import com.google.common.collect.Multimap;
166
167 /**
168 * The generic TMF Events table
169 *
170 * This is a view that will list events that are read from a trace.
171 *
172 * @author Francois Chouinard
173 * @author Patrick Tasse
174 * @since 2.0
175 */
176 public class TmfEventsTable extends TmfComponent implements IGotoMarker, IColorSettingsListener, ISelectionProvider {
177
178 /**
179 * Empty string array, used by {@link #getItemStrings}.
180 * @since 3.0
181 */
182 protected static final @NonNull String[] EMPTY_STRING_ARRAY = new String[0];
183
184 /**
185 * Empty string
186 * @since 3.1
187 */
188 protected static final @NonNull String EMPTY_STRING = ""; //$NON-NLS-1$
189
190 private static final boolean IS_LINUX = System.getProperty("os.name").contains("Linux") ? true : false; //$NON-NLS-1$ //$NON-NLS-2$
191
192 private static final Image BOOKMARK_IMAGE = Activator.getDefault().getImageFromPath(
193 "icons/elcl16/bookmark_obj.gif"); //$NON-NLS-1$
194 private static final Image SEARCH_IMAGE = Activator.getDefault().getImageFromPath("icons/elcl16/search.gif"); //$NON-NLS-1$
195 private static final Image SEARCH_MATCH_IMAGE = Activator.getDefault().getImageFromPath(
196 "icons/elcl16/search_match.gif"); //$NON-NLS-1$
197 private static final Image SEARCH_MATCH_BOOKMARK_IMAGE = Activator.getDefault().getImageFromPath(
198 "icons/elcl16/search_match_bookmark.gif"); //$NON-NLS-1$
199 private static final Image FILTER_IMAGE = Activator.getDefault()
200 .getImageFromPath("icons/elcl16/filter_items.gif"); //$NON-NLS-1$
201 private static final Image STOP_IMAGE = Activator.getDefault().getImageFromPath("icons/elcl16/stop.gif"); //$NON-NLS-1$
202 private static final String SEARCH_HINT = Messages.TmfEventsTable_SearchHint;
203 private static final String FILTER_HINT = Messages.TmfEventsTable_FilterHint;
204 private static final int MAX_CACHE_SIZE = 1000;
205
206 private static final int MARGIN_COLUMN_INDEX = 0;
207 private static final int FILTER_SUMMARY_INDEX = 1;
208 private static final int EVENT_COLUMNS_START_INDEX = MARGIN_COLUMN_INDEX + 1;
209
210 /**
211 * The events table search/filter keys
212 *
213 * @version 1.0
214 * @author Patrick Tasse
215 */
216 public interface Key {
217 /** Search text */
218 String SEARCH_TXT = "$srch_txt"; //$NON-NLS-1$
219
220 /** Search object */
221 String SEARCH_OBJ = "$srch_obj"; //$NON-NLS-1$
222
223 /** Filter text */
224 String FILTER_TXT = "$fltr_txt"; //$NON-NLS-1$
225
226 /** Filter object */
227 String FILTER_OBJ = "$fltr_obj"; //$NON-NLS-1$
228
229 /** Timestamp */
230 String TIMESTAMP = "$time"; //$NON-NLS-1$
231
232 /** Rank */
233 String RANK = "$rank"; //$NON-NLS-1$
234
235 /** Bookmark indicator */
236 String BOOKMARK = "$bookmark"; //$NON-NLS-1$
237
238 /** Event aspect represented by this column */
239 String ASPECT = "$aspect"; //$NON-NLS-1$
240 }
241
242 /**
243 * The events table search/filter state
244 *
245 * @version 1.0
246 * @author Patrick Tasse
247 */
248 public static enum HeaderState {
249 /** A search is being run */
250 SEARCH,
251
252 /** A filter is applied */
253 FILTER
254 }
255
256 interface Direction {
257 int FORWARD = +1;
258 int BACKWARD = -1;
259 }
260
261 // ------------------------------------------------------------------------
262 // Table data
263 // ------------------------------------------------------------------------
264
265 /** The virtual event table */
266 protected TmfVirtualTable fTable;
267
268 private Composite fComposite;
269 private SashForm fSashForm;
270 private TmfRawEventViewer fRawViewer;
271 private ITmfTrace fTrace;
272 volatile private boolean fPackDone = false;
273 private HeaderState fHeaderState = HeaderState.SEARCH;
274 private long fSelectedRank = 0;
275 private ITmfTimestamp fSelectedBeginTimestamp = null;
276 private IStatusLineManager fStatusLineManager = null;
277
278 // Filter data
279 private long fFilterMatchCount;
280 private long fFilterCheckCount;
281 private FilterThread fFilterThread;
282 private boolean fFilterThreadResume = false;
283 private final Object fFilterSyncObj = new Object();
284 private SearchThread fSearchThread;
285 private final Object fSearchSyncObj = new Object();
286
287 /**
288 * List of selection change listeners (element type: <code>ISelectionChangedListener</code>).
289 *
290 * @see #fireSelectionChanged
291 */
292 private ListenerList selectionChangedListeners = new ListenerList();
293
294 // Bookmark map <Rank, MarkerId>
295 private Multimap<Long, Long> fBookmarksMap = HashMultimap.create();
296 private IFile fBookmarksFile;
297 private long fPendingGotoRank = -1;
298
299 // SWT resources
300 private LocalResourceManager fResourceManager = new LocalResourceManager(JFaceResources.getResources());
301 private Color fGrayColor;
302 private Color fGreenColor;
303 private Font fBoldFont;
304
305 private final List<TmfEventTableColumn> fColumns = new LinkedList<>();
306
307 // Event cache
308 private final TmfEventsCache fCache;
309 private boolean fCacheUpdateBusy = false;
310 private boolean fCacheUpdatePending = false;
311 private boolean fCacheUpdateCompleted = false;
312 private final Object fCacheUpdateSyncObj = new Object();
313
314 private boolean fDisposeOnClose;
315
316 // ------------------------------------------------------------------------
317 // Constructors
318 // ------------------------------------------------------------------------
319
320 /**
321 * Basic constructor, using the default set of columns
322 *
323 * @param parent
324 * The parent composite UI object
325 * @param cacheSize
326 * The size of the event table cache
327 */
328 public TmfEventsTable(final Composite parent, final int cacheSize) {
329 this(parent, cacheSize, TmfTrace.BASE_ASPECTS);
330 }
331
332 /**
333 * Legacy constructor, using ColumnData to define columns
334 *
335 * @param parent
336 * The parent composite UI object
337 * @param cacheSize
338 * The size of the event table cache
339 * @param columnData
340 * Unused
341 * @deprecated Deprecated constructor, use
342 * {@link #TmfEventsTable(Composite, int, Collection)}
343 */
344 @Deprecated
345 public TmfEventsTable(final Composite parent, int cacheSize,
346 final org.eclipse.tracecompass.tmf.ui.widgets.virtualtable.ColumnData[] columnData) {
347 /*
348 * We'll do a "best-effort" to keep trace types still using this API to
349 * keep working, by defining a TmfEventTableFieldColumn for each
350 * ColumnData they passed.
351 */
352 this(parent, cacheSize, convertFromColumnData(columnData));
353 }
354
355 @Deprecated
356 private static @NonNull Iterable<ITmfEventAspect> convertFromColumnData(
357 org.eclipse.tracecompass.tmf.ui.widgets.virtualtable.ColumnData[] columnData) {
358
359 ImmutableList.Builder<ITmfEventAspect> builder = new ImmutableList.Builder<>();
360 for (org.eclipse.tracecompass.tmf.ui.widgets.virtualtable.ColumnData col : columnData) {
361 String fieldName = col.header;
362 if (fieldName != null) {
363 builder.add(new TmfEventFieldAspect(fieldName, fieldName));
364 }
365 }
366 return checkNotNull(builder.build());
367 }
368
369 /**
370 * Standard constructor, where we define which columns to use.
371 *
372 * @param parent
373 * The parent composite UI object
374 * @param cacheSize
375 * The size of the event table cache
376 * @param aspects
377 * The event aspects to display in this table. One column per
378 * aspect will be created.
379 * <p>
380 * The iteration order of this collection will correspond to the
381 * initial ordering of the columns in the table.
382 * </p>
383 * @since 3.1
384 */
385 public TmfEventsTable(final Composite parent, int cacheSize,
386 @NonNull Iterable<ITmfEventAspect> aspects) {
387 super("TmfEventsTable"); //$NON-NLS-1$
388
389 fComposite = new Composite(parent, SWT.NONE);
390 final GridLayout gl = new GridLayout(1, false);
391 gl.marginHeight = 0;
392 gl.marginWidth = 0;
393 gl.verticalSpacing = 0;
394 fComposite.setLayout(gl);
395
396 fSashForm = new SashForm(fComposite, SWT.HORIZONTAL);
397 fSashForm.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
398
399 // Create a virtual table
400 final int style = SWT.H_SCROLL | SWT.V_SCROLL | SWT.MULTI | SWT.FULL_SELECTION;
401 fTable = new TmfVirtualTable(fSashForm, style);
402
403 // Set the table layout
404 final GridData layoutData = new GridData(SWT.FILL, SWT.FILL, true, true);
405 fTable.setLayoutData(layoutData);
406
407 // Some cosmetic enhancements
408 fTable.setHeaderVisible(true);
409 fTable.setLinesVisible(true);
410
411 // Setup the columns
412 for (ITmfEventAspect aspect : aspects) {
413 if (aspect != null) {
414 fColumns.add(new TmfEventTableColumn(aspect));
415 }
416 }
417
418 TmfMarginColumn collapseCol = new TmfMarginColumn();
419 fColumns.add(MARGIN_COLUMN_INDEX, collapseCol);
420
421 // Create the UI columns in the table
422 for (TmfEventTableColumn col : fColumns) {
423 TableColumn column = fTable.newTableColumn(SWT.LEFT);
424 column.setText(col.getHeaderName());
425 column.setToolTipText(col.getHeaderTooltip());
426 column.setData(Key.ASPECT, col.getEventAspect());
427 column.pack();
428 if (col instanceof TmfMarginColumn) {
429 column.setResizable(false);
430 column.addControlListener(new ControlAdapter() {
431 /*
432 * Make sure that the margin column is always first
433 */
434 @Override
435 public void controlMoved(ControlEvent e) {
436 int[] order = fTable.getColumnOrder();
437 if (order[0] == MARGIN_COLUMN_INDEX) {
438 return;
439 }
440 for (int i = order.length - 1; i > 0; i--) {
441 if (order[i] == MARGIN_COLUMN_INDEX) {
442 order[i] = order[i - 1];
443 order[i - 1] = MARGIN_COLUMN_INDEX;
444 }
445 }
446 fTable.setColumnOrder(order);
447 }
448 });
449 } else {
450 column.setMoveable(true);
451 }
452 }
453
454 // Set the frozen row for header row
455 fTable.setFrozenRowCount(1);
456
457 // Create the header row cell editor
458 createHeaderEditor();
459
460 // Handle the table item selection
461 fTable.addSelectionListener(new SelectionAdapter() {
462 @Override
463 public void widgetSelected(final SelectionEvent e) {
464 if (e.item == null) {
465 return;
466 }
467 updateStatusLine(null);
468 if (fTable.getSelectionIndices().length > 0) {
469 if (e.item.getData(Key.RANK) instanceof Long) {
470 fSelectedRank = (Long) e.item.getData(Key.RANK);
471 fRawViewer.selectAndReveal((Long) e.item.getData(Key.RANK));
472 }
473 if (e.item.getData(Key.TIMESTAMP) instanceof ITmfTimestamp) {
474 final ITmfTimestamp ts = (ITmfTimestamp) e.item.getData(Key.TIMESTAMP);
475 if (fTable.getSelectionIndices().length == 1) {
476 fSelectedBeginTimestamp = ts;
477 }
478 if (fSelectedBeginTimestamp != null) {
479 if (fSelectedBeginTimestamp.compareTo(ts) <= 0) {
480 broadcast(new TmfTimeSynchSignal(TmfEventsTable.this, fSelectedBeginTimestamp, ts));
481 if (fTable.getSelectionIndices().length == 2) {
482 updateStatusLine(ts.getDelta(fSelectedBeginTimestamp));
483 }
484 } else {
485 broadcast(new TmfTimeSynchSignal(TmfEventsTable.this, ts, fSelectedBeginTimestamp));
486 updateStatusLine(fSelectedBeginTimestamp.getDelta(ts));
487 }
488 }
489 } else {
490 if (fTable.getSelectionIndices().length == 1) {
491 fSelectedBeginTimestamp = null;
492 }
493 }
494 }
495 if (e.item.getData() instanceof ITmfEvent) {
496 broadcast(new TmfEventSelectedSignal(TmfEventsTable.this, (ITmfEvent) e.item.getData()));
497 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable.this, new StructuredSelection(e.item.getData())));
498 } else {
499 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable.this, StructuredSelection.EMPTY));
500 }
501 }
502 });
503
504 int realCacheSize = Math.max(cacheSize, Display.getDefault().getBounds().height / fTable.getItemHeight());
505 realCacheSize = Math.min(realCacheSize, MAX_CACHE_SIZE);
506 fCache = new TmfEventsCache(realCacheSize, this);
507
508 // Handle the table item requests
509 fTable.addListener(SWT.SetData, new Listener() {
510
511 @Override
512 public void handleEvent(final Event event) {
513
514 final TableItem item = (TableItem) event.item;
515 int index = event.index - 1; // -1 for the header row
516
517 if (event.index == 0) {
518 setHeaderRowItemData(item);
519 return;
520 }
521
522 if (fTable.getData(Key.FILTER_OBJ) != null) {
523 if ((event.index == 1) || (event.index == (fTable.getItemCount() - 1))) {
524 setFilterStatusRowItemData(item);
525 return;
526 }
527 index = index - 1; // -1 for top filter status row
528 }
529
530 final CachedEvent cachedEvent = fCache.getEvent(index);
531 if (cachedEvent != null) {
532 setItemData(item, cachedEvent, cachedEvent.rank);
533 return;
534 }
535
536 // Else, fill the cache asynchronously (and off the UI thread)
537 event.doit = false;
538 }
539 });
540
541 fTable.addMouseListener(new MouseAdapter() {
542 @Override
543 public void mouseDoubleClick(final MouseEvent event) {
544 if (event.button != 1) {
545 return;
546 }
547 // Identify the selected row
548 final Point point = new Point(event.x, event.y);
549 final TableItem item = fTable.getItem(point);
550 if (item != null) {
551 final Rectangle imageBounds = item.getImageBounds(0);
552 imageBounds.width = BOOKMARK_IMAGE.getBounds().width;
553 if (imageBounds.contains(point)) {
554 final Long rank = (Long) item.getData(Key.RANK);
555 if (rank != null) {
556 toggleBookmark(rank);
557 }
558 }
559 }
560 }
561 });
562
563 final Listener tooltipListener = new Listener () {
564 Shell tooltipShell = null;
565 @Override
566 public void handleEvent(final Event event) {
567 switch (event.type) {
568 case SWT.MouseHover:
569 final TableItem item = fTable.getItem(new Point(event.x, event.y));
570 if (item == null) {
571 return;
572 }
573 final Long rank = (Long) item.getData(Key.RANK);
574 if (rank == null) {
575 return;
576 }
577 final String tooltipText = (String) item.getData(Key.BOOKMARK);
578 final Rectangle bounds = item.getImageBounds(0);
579 bounds.width = BOOKMARK_IMAGE.getBounds().width;
580 if (!bounds.contains(event.x,event.y)) {
581 return;
582 }
583 if ((tooltipShell != null) && !tooltipShell.isDisposed()) {
584 tooltipShell.dispose();
585 }
586 tooltipShell = new Shell(fTable.getShell(), SWT.ON_TOP | SWT.NO_FOCUS | SWT.TOOL);
587 tooltipShell.setBackground(PlatformUI.getWorkbench().getDisplay().getSystemColor(SWT.COLOR_INFO_BACKGROUND));
588 final FillLayout layout = new FillLayout();
589 layout.marginWidth = 2;
590 tooltipShell.setLayout(layout);
591 final Label label = new Label(tooltipShell, SWT.WRAP);
592 String text = rank.toString() + (tooltipText != null ? ": " + tooltipText : EMPTY_STRING); //$NON-NLS-1$
593 label.setForeground(PlatformUI.getWorkbench().getDisplay().getSystemColor(SWT.COLOR_INFO_FOREGROUND));
594 label.setBackground(PlatformUI.getWorkbench().getDisplay().getSystemColor(SWT.COLOR_INFO_BACKGROUND));
595 label.setText(text);
596 label.addListener(SWT.MouseExit, this);
597 label.addListener(SWT.MouseDown, this);
598 label.addListener(SWT.MouseWheel, this);
599 final Point size = tooltipShell.computeSize(SWT.DEFAULT, SWT.DEFAULT);
600 /*
601 * Bug in Linux. The coordinates of the event have an origin that excludes the table header but
602 * the method toDisplay() expects coordinates relative to an origin that includes the table header.
603 */
604 int y = event.y;
605 if (IS_LINUX) {
606 y += fTable.getHeaderHeight();
607 }
608 Point pt = fTable.toDisplay(event.x, y);
609 pt.x += BOOKMARK_IMAGE.getBounds().width;
610 pt.y += item.getBounds().height;
611 tooltipShell.setBounds(pt.x, pt.y, size.x, size.y);
612 tooltipShell.setVisible(true);
613 break;
614 case SWT.Dispose:
615 case SWT.KeyDown:
616 case SWT.MouseMove:
617 case SWT.MouseExit:
618 case SWT.MouseDown:
619 case SWT.MouseWheel:
620 if (tooltipShell != null) {
621 tooltipShell.dispose();
622 tooltipShell = null;
623 }
624 break;
625 default:
626 break;
627 }
628 }
629 };
630
631 fTable.addListener(SWT.MouseHover, tooltipListener);
632 fTable.addListener(SWT.Dispose, tooltipListener);
633 fTable.addListener(SWT.KeyDown, tooltipListener);
634 fTable.addListener(SWT.MouseMove, tooltipListener);
635 fTable.addListener(SWT.MouseExit, tooltipListener);
636 fTable.addListener(SWT.MouseDown, tooltipListener);
637 fTable.addListener(SWT.MouseWheel, tooltipListener);
638
639 // Create resources
640 createResources();
641
642 ColorSettingsManager.addColorSettingsListener(this);
643
644 fTable.setItemCount(1); // +1 for header row
645
646 fRawViewer = new TmfRawEventViewer(fSashForm, SWT.H_SCROLL | SWT.V_SCROLL);
647
648 fRawViewer.addSelectionListener(new Listener() {
649 @Override
650 public void handleEvent(final Event e) {
651 if (e.data instanceof Long) {
652 final long rank = (Long) e.data;
653 int index = (int) rank;
654 if (fTable.getData(Key.FILTER_OBJ) != null) {
655 index = fCache.getFilteredEventIndex(rank) + 1; // +1 for top filter status row
656 }
657 fTable.setSelection(index + 1); // +1 for header row
658 fSelectedRank = rank;
659 updateStatusLine(null);
660 } else if (e.data instanceof ITmfLocation) {
661 // DOES NOT WORK: rank undefined in context from seekLocation()
662 // ITmfLocation<?> location = (ITmfLocation<?>) e.data;
663 // TmfContext context = fTrace.seekLocation(location);
664 // fTable.setSelection((int) context.getRank());
665 return;
666 } else {
667 return;
668 }
669 final TableItem[] selection = fTable.getSelection();
670 if ((selection != null) && (selection.length > 0)) {
671 final TmfTimestamp ts = (TmfTimestamp) fTable.getSelection()[0].getData(Key.TIMESTAMP);
672 if (ts != null) {
673 broadcast(new TmfTimeSynchSignal(TmfEventsTable.this, ts));
674 }
675 }
676 }
677 });
678
679 fSashForm.setWeights(new int[] { 1, 1 });
680 fRawViewer.setVisible(false);
681
682 createPopupMenu();
683 }
684
685 // ------------------------------------------------------------------------
686 // Operations
687 // ------------------------------------------------------------------------
688
689 /**
690 * Create a pop-up menu.
691 */
692 protected void createPopupMenu() {
693 final IAction showTableAction = new Action(Messages.TmfEventsTable_ShowTableActionText) {
694 @Override
695 public void run() {
696 fTable.setVisible(true);
697 fSashForm.layout();
698 }
699 };
700
701 final IAction hideTableAction = new Action(Messages.TmfEventsTable_HideTableActionText) {
702 @Override
703 public void run() {
704 fTable.setVisible(false);
705 fSashForm.layout();
706 }
707 };
708
709 final IAction showRawAction = new Action(Messages.TmfEventsTable_ShowRawActionText) {
710 @Override
711 public void run() {
712 fRawViewer.setVisible(true);
713 fSashForm.layout();
714 final int index = fTable.getSelectionIndex();
715 if (index >= 1) {
716 fRawViewer.selectAndReveal(index - 1);
717 }
718 }
719 };
720
721 final IAction hideRawAction = new Action(Messages.TmfEventsTable_HideRawActionText) {
722 @Override
723 public void run() {
724 fRawViewer.setVisible(false);
725 fSashForm.layout();
726 }
727 };
728
729 final IAction openCallsiteAction = new Action(Messages.TmfEventsTable_OpenSourceCodeActionText) {
730 @Override
731 public void run() {
732 final TableItem items[] = fTable.getSelection();
733 if (items.length != 1) {
734 return;
735 }
736 final TableItem item = items[0];
737
738 final Object data = item.getData();
739 if (data instanceof ITmfSourceLookup) {
740 ITmfSourceLookup event = (ITmfSourceLookup) data;
741 ITmfCallsite cs = event.getCallsite();
742 if (cs == null || cs.getFileName() == null) {
743 return;
744 }
745 IMarker marker = null;
746 try {
747 String fileName = cs.getFileName();
748 final String trimmedPath = fileName.replaceAll("\\.\\./", EMPTY_STRING); //$NON-NLS-1$
749 final ArrayList<IFile> files = new ArrayList<>();
750 ResourcesPlugin.getWorkspace().getRoot().accept(new IResourceVisitor() {
751 @Override
752 public boolean visit(IResource resource) throws CoreException {
753 if (resource instanceof IFile && resource.getFullPath().toString().endsWith(trimmedPath)) {
754 files.add((IFile) resource);
755 }
756 return true;
757 }
758 });
759 IFile file = null;
760 if (files.size() > 1) {
761 ListDialog dialog = new ListDialog(getTable().getShell());
762 dialog.setContentProvider(ArrayContentProvider.getInstance());
763 dialog.setLabelProvider(new LabelProvider() {
764 @Override
765 public String getText(Object element) {
766 return ((IFile) element).getFullPath().toString();
767 }
768 });
769 dialog.setInput(files);
770 dialog.setTitle(Messages.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle);
771 dialog.setMessage(Messages.TmfEventsTable_OpenSourceCodeSelectFileDialogTitle + '\n' + cs.toString());
772 dialog.open();
773 Object[] result = dialog.getResult();
774 if (result != null && result.length > 0) {
775 file = (IFile) result[0];
776 }
777 } else if (files.size() == 1) {
778 file = files.get(0);
779 }
780 if (file != null) {
781 marker = file.createMarker(IMarker.MARKER);
782 marker.setAttribute(IMarker.LINE_NUMBER, Long.valueOf(cs.getLineNumber()).intValue());
783 IDE.openEditor(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage(), marker);
784 marker.delete();
785 } else if (files.size() == 0){
786 displayException(new FileNotFoundException('\'' + cs.toString() + '\'' + '\n' + Messages.TmfEventsTable_OpenSourceCodeNotFound));
787 }
788 } catch (CoreException e) {
789 displayException(e);
790 }
791 }
792 }
793 };
794
795 final IAction openModelAction = new Action(Messages.TmfEventsTable_OpenModelActionText) {
796 @Override
797 public void run() {
798
799 final TableItem items[] = fTable.getSelection();
800 if (items.length != 1) {
801 return;
802 }
803 final TableItem item = items[0];
804
805 final Object eventData = item.getData();
806 if (eventData instanceof ITmfModelLookup) {
807 String modelURI = ((ITmfModelLookup) eventData).getModelUri();
808
809 if (modelURI != null) {
810 IWorkbenchPage activePage = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
811
812 IFile file = null;
813 final URI uri = URI.createURI(modelURI);
814 if (uri.isPlatformResource()) {
815 IPath path = new Path(uri.toPlatformString(true));
816 file = ResourcesPlugin.getWorkspace().getRoot().getFile(path);
817 } else if (uri.isFile() && !uri.isRelative()) {
818 file = ResourcesPlugin.getWorkspace().getRoot().getFileForLocation(
819 new Path(uri.toFileString()));
820 }
821
822 if (file != null) {
823 try {
824 /*
825 * create a temporary validation marker on the
826 * model file, remove it afterwards thus,
827 * navigation works with all model editors
828 * supporting the navigation to a marker
829 */
830 IMarker marker = file.createMarker(EValidator.MARKER);
831 marker.setAttribute(EValidator.URI_ATTRIBUTE, modelURI);
832 marker.setAttribute(IMarker.SEVERITY, IMarker.SEVERITY_INFO);
833
834 IDE.openEditor(activePage, marker, OpenStrategy.activateOnOpen());
835 marker.delete();
836 }
837 catch (CoreException e) {
838 displayException(e);
839 }
840 } else {
841 displayException(new FileNotFoundException('\'' + modelURI + '\'' + '\n' + Messages.TmfEventsTable_OpenModelUnsupportedURI));
842 }
843 }
844 }
845 }
846 };
847
848 final IAction exportToTextAction = new Action(Messages.TmfEventsTable_Export_to_text) {
849 @Override
850 public void run() {
851 IWorkbenchPage activePage = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
852 Object handlerServiceObject = activePage.getActiveEditor().getSite().getService(IHandlerService.class);
853 IHandlerService handlerService = (IHandlerService) handlerServiceObject;
854 Object cmdServiceObject = activePage.getActiveEditor().getSite().getService(ICommandService.class);
855 ICommandService cmdService = (ICommandService) cmdServiceObject;
856 try {
857 HashMap<String, Object> parameters = new HashMap<>();
858 Command command = cmdService.getCommand(ExportToTextCommandHandler.COMMAND_ID);
859 ParameterizedCommand cmd = ParameterizedCommand.generateCommand(command, parameters);
860
861 IEvaluationContext context = handlerService.getCurrentState();
862 List<TmfEventTableColumn> exportColumns = new ArrayList<>();
863 for (int i : fTable.getColumnOrder()) {
864 // Omit the margin column
865 if (i >= EVENT_COLUMNS_START_INDEX) {
866 exportColumns.add(fColumns.get(i));
867 }
868 }
869 context.addVariable(ExportToTextCommandHandler.TMF_EVENT_TABLE_COLUMNS_ID, exportColumns);
870
871 handlerService.executeCommandInContext(cmd, null, context);
872 } catch (ExecutionException | NotDefinedException | NotEnabledException | NotHandledException e) {
873 displayException(e);
874 }
875 }
876 };
877
878 final IAction showSearchBarAction = new Action(Messages.TmfEventsTable_ShowSearchBarActionText) {
879 @Override
880 public void run() {
881 fHeaderState = HeaderState.SEARCH;
882 fTable.refresh();
883 }
884 };
885
886 final IAction showFilterBarAction = new Action(Messages.TmfEventsTable_ShowFilterBarActionText) {
887 @Override
888 public void run() {
889 fHeaderState = HeaderState.FILTER;
890 fTable.refresh();
891 }
892 };
893
894 final IAction clearFiltersAction = new Action(Messages.TmfEventsTable_ClearFiltersActionText) {
895 @Override
896 public void run() {
897 clearFilters();
898 }
899 };
900
901 final IAction collapseAction = new Action(Messages.TmfEventsTable_CollapseFilterMenuName) {
902 @Override
903 public void run() {
904 applyFilter(new TmfCollapseFilter());
905 }
906 };
907
908 class ToggleBookmarkAction extends Action {
909 Long fRank;
910
911 public ToggleBookmarkAction(final String text, final Long rank) {
912 super(text);
913 fRank = rank;
914 }
915
916 @Override
917 public void run() {
918 toggleBookmark(fRank);
919 }
920 }
921
922 final MenuManager tablePopupMenu = new MenuManager();
923 tablePopupMenu.setRemoveAllWhenShown(true);
924 tablePopupMenu.addMenuListener(new IMenuListener() {
925 @Override
926 public void menuAboutToShow(final IMenuManager manager) {
927 if (fTable.getSelectionIndex() == 0) {
928 // Right-click on header row
929 if (fHeaderState == HeaderState.FILTER) {
930 tablePopupMenu.add(showSearchBarAction);
931 } else {
932 tablePopupMenu.add(showFilterBarAction);
933 }
934 return;
935 }
936 final Point point = fTable.toControl(Display.getDefault().getCursorLocation());
937 final TableItem item = fTable.getSelection().length > 0 ? fTable.getSelection()[0] : null;
938 if (item != null) {
939 final Rectangle imageBounds = item.getImageBounds(0);
940 imageBounds.width = BOOKMARK_IMAGE.getBounds().width;
941 if (point.x <= (imageBounds.x + imageBounds.width)) {
942 // Right-click on left margin
943 final Long rank = (Long) item.getData(Key.RANK);
944 if ((rank != null) && (fBookmarksFile != null)) {
945 if (fBookmarksMap.containsKey(rank)) {
946 tablePopupMenu.add(new ToggleBookmarkAction(
947 Messages.TmfEventsTable_RemoveBookmarkActionText, rank));
948 } else {
949 tablePopupMenu.add(new ToggleBookmarkAction(
950 Messages.TmfEventsTable_AddBookmarkActionText, rank));
951 }
952 }
953 return;
954 }
955 }
956
957 // Right-click on table
958 if (fTable.isVisible() && fRawViewer.isVisible()) {
959 tablePopupMenu.add(hideTableAction);
960 tablePopupMenu.add(hideRawAction);
961 } else if (!fTable.isVisible()) {
962 tablePopupMenu.add(showTableAction);
963 } else if (!fRawViewer.isVisible()) {
964 tablePopupMenu.add(showRawAction);
965 }
966 tablePopupMenu.add(exportToTextAction);
967 tablePopupMenu.add(new Separator());
968
969 if (item != null) {
970 final Object data = item.getData();
971 Separator separator = null;
972 if (data instanceof ITmfSourceLookup) {
973 ITmfSourceLookup event = (ITmfSourceLookup) data;
974 if (event.getCallsite() != null) {
975 tablePopupMenu.add(openCallsiteAction);
976 separator = new Separator();
977 }
978 }
979
980 if (data instanceof ITmfModelLookup) {
981 ITmfModelLookup event = (ITmfModelLookup) data;
982 if (event.getModelUri() != null) {
983 tablePopupMenu.add(openModelAction);
984 separator = new Separator();
985 }
986
987 if (separator != null) {
988 tablePopupMenu.add(separator);
989 }
990 }
991 }
992
993 // only show collapse filter if at least one trace can be collapsed
994 boolean isCollapsible = false;
995 if (fTrace != null) {
996 ITmfTrace traces[] = TmfTraceManager.getTraceSet(fTrace);
997 for (ITmfTrace trace : traces) {
998 Class <? extends ITmfEvent> eventClass = trace.getEventType();
999 isCollapsible = ITmfCollapsibleEvent.class.isAssignableFrom(eventClass);
1000 if (isCollapsible) {
1001 break;
1002 }
1003 }
1004 }
1005
1006 if (isCollapsible && !(fTable.getData(Key.FILTER_OBJ) instanceof TmfCollapseFilter)) {
1007 tablePopupMenu.add(collapseAction);
1008 tablePopupMenu.add(new Separator());
1009 }
1010
1011 tablePopupMenu.add(clearFiltersAction);
1012 final ITmfFilterTreeNode[] savedFilters = FilterManager.getSavedFilters();
1013 if (savedFilters.length > 0) {
1014 final MenuManager subMenu = new MenuManager(Messages.TmfEventsTable_ApplyPresetFilterMenuName);
1015 for (final ITmfFilterTreeNode node : savedFilters) {
1016 if (node instanceof TmfFilterNode) {
1017 final TmfFilterNode filter = (TmfFilterNode) node;
1018 subMenu.add(new Action(filter.getFilterName()) {
1019 @Override
1020 public void run() {
1021 applyFilter(filter);
1022 }
1023 });
1024 }
1025 }
1026 tablePopupMenu.add(subMenu);
1027 }
1028 appendToTablePopupMenu(tablePopupMenu, item);
1029 }
1030 });
1031
1032 final MenuManager rawViewerPopupMenu = new MenuManager();
1033 rawViewerPopupMenu.setRemoveAllWhenShown(true);
1034 rawViewerPopupMenu.addMenuListener(new IMenuListener() {
1035 @Override
1036 public void menuAboutToShow(final IMenuManager manager) {
1037 if (fTable.isVisible() && fRawViewer.isVisible()) {
1038 rawViewerPopupMenu.add(hideTableAction);
1039 rawViewerPopupMenu.add(hideRawAction);
1040 } else if (!fTable.isVisible()) {
1041 rawViewerPopupMenu.add(showTableAction);
1042 } else if (!fRawViewer.isVisible()) {
1043 rawViewerPopupMenu.add(showRawAction);
1044 }
1045 appendToRawPopupMenu(tablePopupMenu);
1046 }
1047 });
1048
1049 Menu menu = tablePopupMenu.createContextMenu(fTable);
1050 fTable.setMenu(menu);
1051
1052 menu = rawViewerPopupMenu.createContextMenu(fRawViewer);
1053 fRawViewer.setMenu(menu);
1054 }
1055
1056
1057 /**
1058 * Append an item to the event table's pop-up menu.
1059 *
1060 * @param tablePopupMenu
1061 * The menu manager
1062 * @param selectedItem
1063 * The item to append
1064 */
1065 protected void appendToTablePopupMenu(final MenuManager tablePopupMenu, final TableItem selectedItem) {
1066 // override to append more actions
1067 }
1068
1069 /**
1070 * Append an item to the raw viewer's pop-up menu.
1071 *
1072 * @param rawViewerPopupMenu
1073 * The menu manager
1074 */
1075 protected void appendToRawPopupMenu(final MenuManager rawViewerPopupMenu) {
1076 // override to append more actions
1077 }
1078
1079 @Override
1080 public void dispose() {
1081 stopSearchThread();
1082 stopFilterThread();
1083 ColorSettingsManager.removeColorSettingsListener(this);
1084 fComposite.dispose();
1085 if ((fTrace != null) && fDisposeOnClose) {
1086 fTrace.dispose();
1087 }
1088 fResourceManager.dispose();
1089 fRawViewer.dispose();
1090 super.dispose();
1091 }
1092
1093 /**
1094 * Assign a layout data object to this view.
1095 *
1096 * @param layoutData
1097 * The layout data to assign
1098 */
1099 public void setLayoutData(final Object layoutData) {
1100 fComposite.setLayoutData(layoutData);
1101 }
1102
1103 /**
1104 * Get the virtual table contained in this event table.
1105 *
1106 * @return The TMF virtual table
1107 */
1108 public TmfVirtualTable getTable() {
1109 return fTable;
1110 }
1111
1112 /**
1113 * @param columnData
1114 * columnData
1115 * @deprecated The column headers are now set at the constructor, this
1116 * shouldn't be called anymore.
1117 */
1118 @Deprecated
1119 protected void setColumnHeaders(final org.eclipse.tracecompass.tmf.ui.widgets.virtualtable.ColumnData [] columnData) {
1120 /* No-op */
1121 }
1122
1123 /**
1124 * Set a table item's data.
1125 *
1126 * @param item
1127 * The item to set
1128 * @param event
1129 * Which trace event to link with this entry
1130 * @param rank
1131 * Which rank this event has in the trace/experiment
1132 */
1133 protected void setItemData(final TableItem item, final ITmfEvent event, final long rank) {
1134 String[] itemStrings = getItemStrings(fColumns, event);
1135
1136 // Get the actual ITmfEvent from the CachedEvent
1137 ITmfEvent tmfEvent = event;
1138 if (event instanceof CachedEvent) {
1139 tmfEvent = ((CachedEvent) event).event;
1140 }
1141 item.setText(itemStrings);
1142 item.setData(tmfEvent);
1143 item.setData(Key.TIMESTAMP, new TmfTimestamp(tmfEvent.getTimestamp()));
1144 item.setData(Key.RANK, rank);
1145
1146 final Collection<Long> markerIds = fBookmarksMap.get(rank);
1147 if (!markerIds.isEmpty()) {
1148 Joiner joiner = Joiner.on("\n -").skipNulls(); //$NON-NLS-1$
1149 List<Object> parts = new ArrayList<>();
1150 if (markerIds.size() > 1) {
1151 parts.add(Messages.TmfEventsTable_MultipleBookmarksToolTip);
1152 }
1153 try {
1154 for (long markerId : markerIds) {
1155 final IMarker marker = fBookmarksFile.findMarker(markerId);
1156 parts.add(marker.getAttribute(IMarker.MESSAGE));
1157 }
1158 } catch (CoreException e) {
1159 displayException(e);
1160 }
1161 item.setData(Key.BOOKMARK, joiner.join(parts));
1162 } else {
1163 item.setData(Key.BOOKMARK, null);
1164 }
1165
1166 boolean searchMatch = false;
1167 boolean searchNoMatch = false;
1168 final ITmfFilter searchFilter = (ITmfFilter) fTable.getData(Key.SEARCH_OBJ);
1169 if (searchFilter != null) {
1170 if (searchFilter.matches(tmfEvent)) {
1171 searchMatch = true;
1172 } else {
1173 searchNoMatch = true;
1174 }
1175 }
1176
1177 final ColorSetting colorSetting = ColorSettingsManager.getColorSetting(tmfEvent);
1178 if (searchNoMatch) {
1179 item.setForeground(colorSetting.getDimmedForegroundColor());
1180 item.setBackground(colorSetting.getDimmedBackgroundColor());
1181 } else {
1182 item.setForeground(colorSetting.getForegroundColor());
1183 item.setBackground(colorSetting.getBackgroundColor());
1184 }
1185
1186 if (searchMatch) {
1187 if (!markerIds.isEmpty()) {
1188 item.setImage(SEARCH_MATCH_BOOKMARK_IMAGE);
1189 } else {
1190 item.setImage(SEARCH_MATCH_IMAGE);
1191 }
1192 } else if (!markerIds.isEmpty()) {
1193 item.setImage(BOOKMARK_IMAGE);
1194 } else {
1195 item.setImage((Image) null);
1196 }
1197
1198 if ((itemStrings[MARGIN_COLUMN_INDEX] != null) && !itemStrings[MARGIN_COLUMN_INDEX].isEmpty()) {
1199 packMarginColumn();
1200 }
1201 }
1202
1203 /**
1204 * Set the item data of the header row.
1205 *
1206 * @param item
1207 * The item to use as table header
1208 */
1209 protected void setHeaderRowItemData(final TableItem item) {
1210 String txtKey = null;
1211 if (fHeaderState == HeaderState.SEARCH) {
1212 item.setImage(SEARCH_IMAGE);
1213 txtKey = Key.SEARCH_TXT;
1214 } else if (fHeaderState == HeaderState.FILTER) {
1215 item.setImage(FILTER_IMAGE);
1216 txtKey = Key.FILTER_TXT;
1217 }
1218 item.setForeground(fGrayColor);
1219 // Ignore collapse and image column
1220 for (int i = EVENT_COLUMNS_START_INDEX; i < fTable.getColumns().length; i++) {
1221 final TableColumn column = fTable.getColumns()[i];
1222 final String filter = (String) column.getData(txtKey);
1223 if (filter == null) {
1224 if (fHeaderState == HeaderState.SEARCH) {
1225 item.setText(i, SEARCH_HINT);
1226 } else if (fHeaderState == HeaderState.FILTER) {
1227 item.setText(i, FILTER_HINT);
1228 }
1229 item.setForeground(i, fGrayColor);
1230 item.setFont(i, fTable.getFont());
1231 } else {
1232 item.setText(i, filter);
1233 item.setForeground(i, fGreenColor);
1234 item.setFont(i, fBoldFont);
1235 }
1236 }
1237 }
1238
1239 /**
1240 * Set the item data of the "filter status" row.
1241 *
1242 * @param item
1243 * The item to use as filter status row
1244 */
1245 protected void setFilterStatusRowItemData(final TableItem item) {
1246 for (int i = 0; i < fTable.getColumns().length; i++) {
1247 if (i == MARGIN_COLUMN_INDEX) {
1248 if ((fTrace == null) || (fFilterCheckCount == fTrace.getNbEvents())) {
1249 item.setImage(FILTER_IMAGE);
1250 } else {
1251 item.setImage(STOP_IMAGE);
1252 }
1253 }
1254
1255 if (i == FILTER_SUMMARY_INDEX) {
1256 item.setText(FILTER_SUMMARY_INDEX, fFilterMatchCount + "/" + fFilterCheckCount); //$NON-NLS-1$
1257 } else {
1258 item.setText(i, EMPTY_STRING);
1259 }
1260 }
1261 item.setData(null);
1262 item.setData(Key.TIMESTAMP, null);
1263 item.setData(Key.RANK, null);
1264 item.setForeground(null);
1265 item.setBackground(null);
1266 }
1267
1268 /**
1269 * Create an editor for the header.
1270 */
1271 protected void createHeaderEditor() {
1272 final TableEditor tableEditor = fTable.createTableEditor();
1273 tableEditor.horizontalAlignment = SWT.LEFT;
1274 tableEditor.verticalAlignment = SWT.CENTER;
1275 tableEditor.grabHorizontal = true;
1276 tableEditor.minimumWidth = 50;
1277
1278 // Handle the header row selection
1279 fTable.addMouseListener(new MouseAdapter() {
1280 int columnIndex;
1281 TableColumn column;
1282 TableItem item;
1283
1284 @Override
1285 public void mouseDown(final MouseEvent event) {
1286 if (event.button != 1) {
1287 return;
1288 }
1289 // Identify the selected row
1290 final Point point = new Point(event.x, event.y);
1291 item = fTable.getItem(point);
1292
1293 // Header row selected
1294 if ((item != null) && (fTable.indexOf(item) == 0)) {
1295
1296 // Icon selected
1297 if (item.getImageBounds(0).contains(point)) {
1298 if (fHeaderState == HeaderState.SEARCH) {
1299 fHeaderState = HeaderState.FILTER;
1300 } else if (fHeaderState == HeaderState.FILTER) {
1301 fHeaderState = HeaderState.SEARCH;
1302 }
1303 fTable.setSelection(0);
1304 fTable.refresh();
1305 return;
1306 }
1307
1308 // Identify the selected column
1309 columnIndex = -1;
1310 for (int i = 0; i < fTable.getColumns().length; i++) {
1311 final Rectangle rect = item.getBounds(i);
1312 if (rect.contains(point)) {
1313 columnIndex = i;
1314 break;
1315 }
1316 }
1317
1318 if (columnIndex == -1) {
1319 return;
1320 }
1321
1322 column = fTable.getColumns()[columnIndex];
1323
1324 String txtKey = null;
1325 if (fHeaderState == HeaderState.SEARCH) {
1326 txtKey = Key.SEARCH_TXT;
1327 } else if (fHeaderState == HeaderState.FILTER) {
1328 txtKey = Key.FILTER_TXT;
1329 }
1330
1331 // The control that will be the editor must be a child of the Table
1332 final Text newEditor = (Text) fTable.createTableEditorControl(Text.class);
1333 final String headerString = (String) column.getData(txtKey);
1334 if (headerString != null) {
1335 newEditor.setText(headerString);
1336 }
1337 newEditor.addFocusListener(new FocusAdapter() {
1338 @Override
1339 public void focusLost(final FocusEvent e) {
1340 final boolean changed = updateHeader(newEditor.getText());
1341 if (changed) {
1342 applyHeader();
1343 }
1344 }
1345 });
1346 newEditor.addKeyListener(new KeyAdapter() {
1347 @Override
1348 public void keyPressed(final KeyEvent e) {
1349 if (e.character == SWT.CR) {
1350 updateHeader(newEditor.getText());
1351 applyHeader();
1352
1353 // Set focus on the table so that the next carriage return goes to the next result
1354 TmfEventsTable.this.getTable().setFocus();
1355 } else if (e.character == SWT.ESC) {
1356 tableEditor.getEditor().dispose();
1357 }
1358 }
1359 });
1360 newEditor.selectAll();
1361 newEditor.setFocus();
1362 tableEditor.setEditor(newEditor, item, columnIndex);
1363 }
1364 }
1365
1366 /*
1367 * returns true is value was changed
1368 */
1369 private boolean updateHeader(final String text) {
1370 String objKey = null;
1371 String txtKey = null;
1372 if (fHeaderState == HeaderState.SEARCH) {
1373 objKey = Key.SEARCH_OBJ;
1374 txtKey = Key.SEARCH_TXT;
1375 } else if (fHeaderState == HeaderState.FILTER) {
1376 objKey = Key.FILTER_OBJ;
1377 txtKey = Key.FILTER_TXT;
1378 }
1379 if (text.trim().length() > 0) {
1380 try {
1381 final String regex = TmfFilterMatchesNode.regexFix(text);
1382 Pattern.compile(regex);
1383 if (regex.equals(column.getData(txtKey))) {
1384 tableEditor.getEditor().dispose();
1385 return false;
1386 }
1387 final TmfFilterMatchesAspectNode filter = new TmfFilterMatchesAspectNode(null);
1388 ITmfEventAspect aspect = (ITmfEventAspect) column.getData(Key.ASPECT);
1389 filter.setEventAspect(aspect);
1390 filter.setRegex(regex);
1391 column.setData(objKey, filter);
1392 column.setData(txtKey, regex);
1393 } catch (final PatternSyntaxException ex) {
1394 tableEditor.getEditor().dispose();
1395 MessageDialog.openError(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell(),
1396 ex.getDescription(), ex.getMessage());
1397 return false;
1398 }
1399 } else {
1400 if (column.getData(txtKey) == null) {
1401 tableEditor.getEditor().dispose();
1402 return false;
1403 }
1404 column.setData(objKey, null);
1405 column.setData(txtKey, null);
1406 }
1407 return true;
1408 }
1409
1410 private void applyHeader() {
1411 if (fHeaderState == HeaderState.SEARCH) {
1412 stopSearchThread();
1413 final TmfFilterAndNode filter = new TmfFilterAndNode(null);
1414 for (final TableColumn col : fTable.getColumns()) {
1415 final Object filterObj = col.getData(Key.SEARCH_OBJ);
1416 if (filterObj instanceof ITmfFilterTreeNode) {
1417 filter.addChild((ITmfFilterTreeNode) filterObj);
1418 }
1419 }
1420 if (filter.getChildrenCount() > 0) {
1421 fTable.setData(Key.SEARCH_OBJ, filter);
1422 fTable.refresh();
1423 searchNext();
1424 fireSearchApplied(filter);
1425 } else {
1426 fTable.setData(Key.SEARCH_OBJ, null);
1427 fTable.refresh();
1428 fireSearchApplied(null);
1429 }
1430 } else if (fHeaderState == HeaderState.FILTER) {
1431 final TmfFilterAndNode filter = new TmfFilterAndNode(null);
1432 for (final TableColumn col : fTable.getColumns()) {
1433 final Object filterObj = col.getData(Key.FILTER_OBJ);
1434 if (filterObj instanceof ITmfFilterTreeNode) {
1435 filter.addChild((ITmfFilterTreeNode) filterObj);
1436 }
1437 }
1438 if (filter.getChildrenCount() > 0) {
1439 applyFilter(filter);
1440 } else {
1441 clearFilters();
1442 }
1443 }
1444
1445 tableEditor.getEditor().dispose();
1446 }
1447 });
1448
1449 fTable.addKeyListener(new KeyAdapter() {
1450 @Override
1451 public void keyPressed(final KeyEvent e) {
1452 e.doit = false;
1453 if (e.character == SWT.ESC) {
1454 stopFilterThread();
1455 stopSearchThread();
1456 fTable.refresh();
1457 } else if (e.character == SWT.DEL) {
1458 if (fHeaderState == HeaderState.SEARCH) {
1459 stopSearchThread();
1460 for (final TableColumn column : fTable.getColumns()) {
1461 column.setData(Key.SEARCH_OBJ, null);
1462 column.setData(Key.SEARCH_TXT, null);
1463 }
1464 fTable.setData(Key.SEARCH_OBJ, null);
1465 fTable.refresh();
1466 fireSearchApplied(null);
1467 } else if (fHeaderState == HeaderState.FILTER) {
1468 clearFilters();
1469 }
1470 } else if (e.character == SWT.CR) {
1471 if ((e.stateMask & SWT.SHIFT) == 0) {
1472 searchNext();
1473 } else {
1474 searchPrevious();
1475 }
1476 }
1477 }
1478 });
1479 }
1480
1481 /**
1482 * Send an event indicating a filter has been applied.
1483 *
1484 * @param filter
1485 * The filter that was just applied
1486 */
1487 protected void fireFilterApplied(final ITmfFilter filter) {
1488 broadcast(new TmfEventFilterAppliedSignal(this, fTrace, filter));
1489 }
1490
1491 /**
1492 * Send an event indicating that a search has been applied.
1493 *
1494 * @param filter
1495 * The search filter that was just applied
1496 */
1497 protected void fireSearchApplied(final ITmfFilter filter) {
1498 broadcast(new TmfEventSearchAppliedSignal(this, fTrace, filter));
1499 }
1500
1501 /**
1502 * Start the filtering thread.
1503 */
1504 protected void startFilterThread() {
1505 synchronized (fFilterSyncObj) {
1506 final ITmfFilterTreeNode filter = (ITmfFilterTreeNode) fTable.getData(Key.FILTER_OBJ);
1507 if (fFilterThread == null || fFilterThread.filter != filter) {
1508 if (fFilterThread != null) {
1509 fFilterThread.cancel();
1510 fFilterThreadResume = false;
1511 }
1512 fFilterThread = new FilterThread(filter);
1513 fFilterThread.start();
1514 } else {
1515 fFilterThreadResume = true;
1516 }
1517 }
1518 }
1519
1520 /**
1521 * Stop the filtering thread.
1522 */
1523 protected void stopFilterThread() {
1524 synchronized (fFilterSyncObj) {
1525 if (fFilterThread != null) {
1526 fFilterThread.cancel();
1527 fFilterThread = null;
1528 fFilterThreadResume = false;
1529 }
1530 }
1531 }
1532
1533 /**
1534 * Apply a filter.
1535 *
1536 * @param filter
1537 * The filter to apply
1538 * @since 1.1
1539 */
1540 protected void applyFilter(ITmfFilter filter) {
1541 stopFilterThread();
1542 stopSearchThread();
1543 fFilterMatchCount = 0;
1544 fFilterCheckCount = 0;
1545 fCache.applyFilter(filter);
1546 fTable.clearAll();
1547 fTable.setData(Key.FILTER_OBJ, filter);
1548 fTable.setItemCount(3); // +1 for header row, +2 for top and bottom filter status rows
1549 startFilterThread();
1550 fireFilterApplied(filter);
1551 }
1552
1553 /**
1554 * Clear all currently active filters.
1555 */
1556 protected void clearFilters() {
1557 if (fTable.getData(Key.FILTER_OBJ) == null) {
1558 return;
1559 }
1560 stopFilterThread();
1561 stopSearchThread();
1562 fCache.clearFilter();
1563 fTable.clearAll();
1564 for (final TableColumn column : fTable.getColumns()) {
1565 column.setData(Key.FILTER_OBJ, null);
1566 column.setData(Key.FILTER_TXT, null);
1567 }
1568 fTable.setData(Key.FILTER_OBJ, null);
1569 if (fTrace != null) {
1570 fTable.setItemCount((int) fTrace.getNbEvents() + 1); // +1 for header row
1571 } else {
1572 fTable.setItemCount(1); // +1 for header row
1573 }
1574 fFilterMatchCount = 0;
1575 fFilterCheckCount = 0;
1576 if (fSelectedRank >= 0) {
1577 fTable.setSelection((int) fSelectedRank + 1); // +1 for header row
1578 } else {
1579 fTable.setSelection(0);
1580 }
1581 fireFilterApplied(null);
1582 updateStatusLine(null);
1583
1584 // Set original width
1585 fTable.getColumns()[MARGIN_COLUMN_INDEX].setWidth(0);
1586 packMarginColumn();
1587 }
1588
1589 /**
1590 * Wrapper Thread object for the filtering thread.
1591 */
1592 protected class FilterThread extends Thread {
1593 private final ITmfFilterTreeNode filter;
1594 private TmfEventRequest request;
1595 private boolean refreshBusy = false;
1596 private boolean refreshPending = false;
1597 private final Object syncObj = new Object();
1598
1599 /**
1600 * Constructor.
1601 *
1602 * @param filter
1603 * The filter this thread will be processing
1604 */
1605 public FilterThread(final ITmfFilterTreeNode filter) {
1606 super("Filter Thread"); //$NON-NLS-1$
1607 this.filter = filter;
1608 }
1609
1610 @Override
1611 public void run() {
1612 if (fTrace == null) {
1613 return;
1614 }
1615 final int nbRequested = (int) (fTrace.getNbEvents() - fFilterCheckCount);
1616 if (nbRequested <= 0) {
1617 return;
1618 }
1619 request = new TmfEventRequest(ITmfEvent.class, TmfTimeRange.ETERNITY,
1620 (int) fFilterCheckCount, nbRequested, ExecutionType.BACKGROUND) {
1621 @Override
1622 public void handleData(final ITmfEvent event) {
1623 super.handleData(event);
1624 if (request.isCancelled()) {
1625 return;
1626 }
1627 boolean refresh = false;
1628 if (filter.matches(event)) {
1629 final long rank = fFilterCheckCount;
1630 final int index = (int) fFilterMatchCount;
1631 fFilterMatchCount++;
1632 fCache.storeEvent(event, rank, index);
1633 refresh = true;
1634 } else {
1635 if (filter instanceof TmfCollapseFilter) {
1636 fCache.updateCollapsedEvent((int) fFilterMatchCount - 1);
1637 }
1638 }
1639
1640 if (refresh || (fFilterCheckCount % 100) == 0) {
1641 refreshTable();
1642 }
1643 fFilterCheckCount++;
1644 }
1645 };
1646 ((ITmfEventProvider) fTrace).sendRequest(request);
1647 try {
1648 request.waitForCompletion();
1649 } catch (final InterruptedException e) {
1650 }
1651 refreshTable();
1652 synchronized (fFilterSyncObj) {
1653 fFilterThread = null;
1654 if (fFilterThreadResume) {
1655 fFilterThreadResume = false;
1656 fFilterThread = new FilterThread(filter);
1657 fFilterThread.start();
1658 }
1659 }
1660 }
1661
1662 /**
1663 * Refresh the filter.
1664 */
1665 public void refreshTable() {
1666 synchronized (syncObj) {
1667 if (refreshBusy) {
1668 refreshPending = true;
1669 return;
1670 }
1671 refreshBusy = true;
1672 }
1673 Display.getDefault().asyncExec(new Runnable() {
1674 @Override
1675 public void run() {
1676 if (request.isCancelled()) {
1677 return;
1678 }
1679 if (fTable.isDisposed()) {
1680 return;
1681 }
1682 fTable.setItemCount((int) fFilterMatchCount + 3); // +1 for header row, +2 for top and bottom filter status rows
1683 fTable.refresh();
1684 synchronized (syncObj) {
1685 refreshBusy = false;
1686 if (refreshPending) {
1687 refreshPending = false;
1688 refreshTable();
1689 }
1690 }
1691 }
1692 });
1693 }
1694
1695 /**
1696 * Cancel this filtering thread.
1697 */
1698 public void cancel() {
1699 if (request != null) {
1700 request.cancel();
1701 }
1702 }
1703 }
1704
1705 /**
1706 * Go to the next item of a search.
1707 */
1708 protected void searchNext() {
1709 synchronized (fSearchSyncObj) {
1710 if (fSearchThread != null) {
1711 return;
1712 }
1713 final ITmfFilterTreeNode searchFilter = (ITmfFilterTreeNode) fTable.getData(Key.SEARCH_OBJ);
1714 if (searchFilter == null) {
1715 return;
1716 }
1717 final int selectionIndex = fTable.getSelectionIndex();
1718 int startIndex;
1719 if (selectionIndex > 0) {
1720 startIndex = selectionIndex; // -1 for header row, +1 for next event
1721 } else {
1722 // header row is selected, start at top event
1723 startIndex = Math.max(0, fTable.getTopIndex() - 1); // -1 for header row
1724 }
1725 final ITmfFilterTreeNode eventFilter = (ITmfFilterTreeNode) fTable.getData(Key.FILTER_OBJ);
1726 if (eventFilter != null) {
1727 startIndex = Math.max(0, startIndex - 1); // -1 for top filter status row
1728 }
1729 fSearchThread = new SearchThread(searchFilter, eventFilter, startIndex, fSelectedRank, Direction.FORWARD);
1730 fSearchThread.schedule();
1731 }
1732 }
1733
1734 /**
1735 * Go to the previous item of a search.
1736 */
1737 protected void searchPrevious() {
1738 synchronized (fSearchSyncObj) {
1739 if (fSearchThread != null) {
1740 return;
1741 }
1742 final ITmfFilterTreeNode searchFilter = (ITmfFilterTreeNode) fTable.getData(Key.SEARCH_OBJ);
1743 if (searchFilter == null) {
1744 return;
1745 }
1746 final int selectionIndex = fTable.getSelectionIndex();
1747 int startIndex;
1748 if (selectionIndex > 0) {
1749 startIndex = selectionIndex - 2; // -1 for header row, -1 for previous event
1750 } else {
1751 // header row is selected, start at precedent of top event
1752 startIndex = fTable.getTopIndex() - 2; // -1 for header row, -1 for previous event
1753 }
1754 final ITmfFilterTreeNode eventFilter = (ITmfFilterTreeNode) fTable.getData(Key.FILTER_OBJ);
1755 if (eventFilter != null) {
1756 startIndex = startIndex - 1; // -1 for top filter status row
1757 }
1758 fSearchThread = new SearchThread(searchFilter, eventFilter, startIndex, fSelectedRank, Direction.BACKWARD);
1759 fSearchThread.schedule();
1760 }
1761 }
1762
1763 /**
1764 * Stop the search thread.
1765 */
1766 protected void stopSearchThread() {
1767 fPendingGotoRank = -1;
1768 synchronized (fSearchSyncObj) {
1769 if (fSearchThread != null) {
1770 fSearchThread.cancel();
1771 fSearchThread = null;
1772 }
1773 }
1774 }
1775
1776 /**
1777 * Wrapper for the search thread.
1778 */
1779 protected class SearchThread extends Job {
1780
1781 private ITmfFilterTreeNode searchFilter;
1782 private ITmfFilterTreeNode eventFilter;
1783 private int startIndex;
1784 private int direction;
1785 private long rank;
1786 private long foundRank = -1;
1787 private TmfEventRequest request;
1788 private ITmfTimestamp foundTimestamp = null;
1789
1790 /**
1791 * Constructor.
1792 *
1793 * @param searchFilter
1794 * The search filter
1795 * @param eventFilter
1796 * The event filter
1797 * @param startIndex
1798 * The index at which we should start searching
1799 * @param currentRank
1800 * The current rank
1801 * @param direction
1802 * In which direction should we search, forward or backwards
1803 */
1804 public SearchThread(final ITmfFilterTreeNode searchFilter,
1805 final ITmfFilterTreeNode eventFilter, final int startIndex,
1806 final long currentRank, final int direction) {
1807 super(Messages.TmfEventsTable_SearchingJobName);
1808 this.searchFilter = searchFilter;
1809 this.eventFilter = eventFilter;
1810 this.startIndex = startIndex;
1811 this.rank = currentRank;
1812 this.direction = direction;
1813 }
1814
1815 @Override
1816 protected IStatus run(final IProgressMonitor monitor) {
1817 if (fTrace == null) {
1818 return Status.OK_STATUS;
1819 }
1820 final Display display = Display.getDefault();
1821 if (startIndex < 0) {
1822 rank = (int) fTrace.getNbEvents() - 1;
1823 } else if (startIndex >= (fTable.getItemCount() - (eventFilter == null ? 1 : 3))) { // -1 for header row, -2 for top and bottom filter status rows
1824 rank = 0;
1825 } else {
1826 int idx = startIndex;
1827 while (foundRank == -1) {
1828 final CachedEvent event = fCache.peekEvent(idx);
1829 if (event == null) {
1830 break;
1831 }
1832 rank = event.rank;
1833 if (searchFilter.matches(event.event) && ((eventFilter == null) || eventFilter.matches(event.event))) {
1834 foundRank = event.rank;
1835 foundTimestamp = event.event.getTimestamp();
1836 break;
1837 }
1838 if (direction == Direction.FORWARD) {
1839 idx++;
1840 } else {
1841 idx--;
1842 }
1843 }
1844 if (foundRank == -1) {
1845 if (direction == Direction.FORWARD) {
1846 rank++;
1847 if (rank > (fTrace.getNbEvents() - 1)) {
1848 rank = 0;
1849 }
1850 } else {
1851 rank--;
1852 if (rank < 0) {
1853 rank = (int) fTrace.getNbEvents() - 1;
1854 }
1855 }
1856 }
1857 }
1858 final int startRank = (int) rank;
1859 boolean wrapped = false;
1860 while (!monitor.isCanceled() && (foundRank == -1) && (fTrace != null)) {
1861 int nbRequested = (direction == Direction.FORWARD ? Integer.MAX_VALUE : Math.min((int) rank + 1, fTrace.getCacheSize()));
1862 if (direction == Direction.BACKWARD) {
1863 rank = Math.max(0, rank - fTrace.getCacheSize() + 1);
1864 }
1865 request = new TmfEventRequest(ITmfEvent.class, TmfTimeRange.ETERNITY,
1866 (int) rank, nbRequested, ExecutionType.BACKGROUND) {
1867 long currentRank = rank;
1868
1869 @Override
1870 public void handleData(final ITmfEvent event) {
1871 super.handleData(event);
1872 if (searchFilter.matches(event) && ((eventFilter == null) || eventFilter.matches(event))) {
1873 foundRank = currentRank;
1874 foundTimestamp = event.getTimestamp();
1875 if (direction == Direction.FORWARD) {
1876 done();
1877 return;
1878 }
1879 }
1880 currentRank++;
1881 }
1882 };
1883 ((ITmfEventProvider) fTrace).sendRequest(request);
1884 try {
1885 request.waitForCompletion();
1886 if (request.isCancelled()) {
1887 return Status.OK_STATUS;
1888 }
1889 } catch (final InterruptedException e) {
1890 synchronized (fSearchSyncObj) {
1891 fSearchThread = null;
1892 }
1893 return Status.OK_STATUS;
1894 }
1895 if (foundRank == -1) {
1896 if (direction == Direction.FORWARD) {
1897 if (rank == 0) {
1898 synchronized (fSearchSyncObj) {
1899 fSearchThread = null;
1900 }
1901 return Status.OK_STATUS;
1902 }
1903 nbRequested = (int) rank;
1904 rank = 0;
1905 wrapped = true;
1906 } else {
1907 rank--;
1908 if (rank < 0) {
1909 rank = (int) fTrace.getNbEvents() - 1;
1910 wrapped = true;
1911 }
1912 if ((rank <= startRank) && wrapped) {
1913 synchronized (fSearchSyncObj) {
1914 fSearchThread = null;
1915 }
1916 return Status.OK_STATUS;
1917 }
1918 }
1919 }
1920 }
1921 int index = (int) foundRank;
1922 if (eventFilter != null) {
1923 index = fCache.getFilteredEventIndex(foundRank);
1924 }
1925 final int selection = index + 1 + (eventFilter != null ? +1 : 0); // +1 for header row, +1 for top filter status row
1926
1927 display.asyncExec(new Runnable() {
1928 @Override
1929 public void run() {
1930 if (monitor.isCanceled()) {
1931 return;
1932 }
1933 if (fTable.isDisposed()) {
1934 return;
1935 }
1936 fTable.setSelection(selection);
1937 fSelectedRank = foundRank;
1938 fRawViewer.selectAndReveal(fSelectedRank);
1939 if (foundTimestamp != null) {
1940 broadcast(new TmfTimeSynchSignal(TmfEventsTable.this, foundTimestamp));
1941 }
1942 fireSelectionChanged(new SelectionChangedEvent(TmfEventsTable.this, getSelection()));
1943 synchronized (fSearchSyncObj) {
1944 fSearchThread = null;
1945 }
1946 updateStatusLine(null);
1947 }
1948 });
1949 return Status.OK_STATUS;
1950 }
1951
1952 @Override
1953 protected void canceling() {
1954 request.cancel();
1955 synchronized (fSearchSyncObj) {
1956 fSearchThread = null;
1957 }
1958 }
1959 }
1960
1961 /**
1962 * Create the resources.
1963 */
1964 protected void createResources() {
1965 fGrayColor = fResourceManager.createColor(ColorUtil.blend(fTable.getBackground().getRGB(), fTable
1966 .getForeground().getRGB()));
1967 fGreenColor = fTable.getDisplay().getSystemColor(SWT.COLOR_DARK_GREEN);
1968 fBoldFont = fResourceManager.createFont(FontDescriptor.createFrom(fTable.getFont()).setStyle(SWT.BOLD));
1969 }
1970
1971 /**
1972 * Pack the columns.
1973 */
1974 protected void packColumns() {
1975 if (fPackDone) {
1976 return;
1977 }
1978 fTable.setRedraw(false);
1979 try {
1980 TableColumn tableColumns[] = fTable.getColumns();
1981 for (int i = 0; i < tableColumns.length; i++) {
1982 final TableColumn column = tableColumns[i];
1983 packSingleColumn(i, column);
1984 }
1985 } finally {
1986 // Make sure that redraw is always enabled.
1987 fTable.setRedraw(true);
1988 }
1989 fPackDone = true;
1990 }
1991
1992
1993 private void packMarginColumn() {
1994 TableColumn[] columns = fTable.getColumns();
1995 if (columns.length > 0) {
1996 packSingleColumn(0, columns[0]);
1997 }
1998 }
1999
2000 private void packSingleColumn(int i, final TableColumn column) {
2001 final int headerWidth = column.getWidth();
2002 column.pack();
2003 // Workaround for Linux which doesn't consider the image width of
2004 // search/filter row in TableColumn.pack() after having executed
2005 // TableItem.setImage((Image)null) for other rows than search/filter row.
2006 boolean isCollapseFilter = fTable.getData(Key.FILTER_OBJ) instanceof TmfCollapseFilter;
2007 if (IS_LINUX && (i == 0) && isCollapseFilter) {
2008 column.setWidth(column.getWidth() + SEARCH_IMAGE.getBounds().width);
2009 }
2010
2011 if (column.getWidth() < headerWidth) {
2012 column.setWidth(headerWidth);
2013 }
2014 }
2015
2016 /**
2017 * Get the array of item strings (e.g., what to display in each cell of the
2018 * table row) corresponding to the columns and trace event passed in
2019 * parameter. The order of the Strings in the returned array will correspond
2020 * to the iteration order of 'columns'.
2021 *
2022 * <p>
2023 * To ensure consistent results, make sure only call this within a scope
2024 * synchronized on 'columns'! If the order of 'columns' changes right after
2025 * this method is called, the returned value won't be ordered correctly
2026 * anymore.
2027 */
2028 private static String[] getItemStrings(List<TmfEventTableColumn> columns, ITmfEvent event) {
2029 if (event == null) {
2030 return EMPTY_STRING_ARRAY;
2031 }
2032 synchronized (columns) {
2033 List<String> itemStrings = new ArrayList<>(columns.size());
2034 for (TmfEventTableColumn column : columns) {
2035 ITmfEvent passedEvent = event;
2036 if (!(column instanceof TmfMarginColumn) && (event instanceof CachedEvent)) {
2037 // Make sure that the event object from the trace is passed
2038 // to all columns but the TmfMarginColumn
2039 passedEvent = ((CachedEvent) event).event;
2040 }
2041 if (passedEvent == null) {
2042 itemStrings.add(EMPTY_STRING);
2043 } else {
2044 itemStrings.add(column.getItemString(passedEvent));
2045 }
2046
2047 }
2048 return itemStrings.toArray(new String[0]);
2049 }
2050 }
2051
2052 /**
2053 * Get the contents of the row in the events table corresponding to an
2054 * event. The order of the elements corresponds to the current order of the
2055 * columns.
2056 *
2057 * @param event
2058 * The event printed in this row
2059 * @return The event row entries
2060 * @since 3.0
2061 */
2062 public String[] getItemStrings(ITmfEvent event) {
2063 List<TmfEventTableColumn> columns = new ArrayList<>();
2064 for (int i : fTable.getColumnOrder()) {
2065 columns.add(fColumns.get(i));
2066 }
2067 return getItemStrings(columns, event);
2068 }
2069
2070 /**
2071 * Notify this table that is got the UI focus.
2072 */
2073 public void setFocus() {
2074 fTable.setFocus();
2075 }
2076
2077 /**
2078 * Assign a new trace to this event table.
2079 *
2080 * @param trace
2081 * The trace to assign to this event table
2082 * @param disposeOnClose
2083 * true if the trace should be disposed when the table is
2084 * disposed
2085 */
2086 public void setTrace(final ITmfTrace trace, final boolean disposeOnClose) {
2087 if ((fTrace != null) && fDisposeOnClose) {
2088 fTrace.dispose();
2089 }
2090 fTrace = trace;
2091 fPackDone = false;
2092 fSelectedRank = 0;
2093 fDisposeOnClose = disposeOnClose;
2094
2095 // Perform the updates on the UI thread
2096 fTable.getDisplay().syncExec(new Runnable() {
2097 @Override
2098 public void run() {
2099 fTable.removeAll();
2100 fCache.setTrace(fTrace); // Clear the cache
2101 if (fTrace != null) {
2102 if (!fTable.isDisposed() && (fTrace != null)) {
2103 if (fTable.getData(Key.FILTER_OBJ) == null) {
2104 fTable.setItemCount((int) fTrace.getNbEvents() + 1); // +1 for header row
2105 } else {
2106 stopFilterThread();
2107 fFilterMatchCount = 0;
2108 fFilterCheckCount = 0;
2109 fTable.setItemCount(3); // +1 for header row, +2 for top and bottom filter status rows
2110 startFilterThread();
2111 }
2112 }
2113 }
2114 fRawViewer.setTrace(fTrace);
2115 }
2116 });
2117 }
2118
2119 /**
2120 * Assign the status line manager
2121 *
2122 * @param statusLineManager
2123 * The status line manager, or null to disable status line messages
2124 * @since 2.1
2125 */
2126 public void setStatusLineManager(IStatusLineManager statusLineManager) {
2127 if (fStatusLineManager != null && statusLineManager == null) {
2128 fStatusLineManager.setMessage(EMPTY_STRING);
2129 }
2130 fStatusLineManager = statusLineManager;
2131 }
2132
2133 private void updateStatusLine(ITmfTimestamp delta) {
2134 if (fStatusLineManager != null) {
2135 if (delta != null) {
2136 fStatusLineManager.setMessage("\u0394: " + delta); //$NON-NLS-1$
2137 } else {
2138 fStatusLineManager.setMessage(null);
2139 }
2140 }
2141 }
2142
2143 // ------------------------------------------------------------------------
2144 // Event cache
2145 // ------------------------------------------------------------------------
2146
2147 /**
2148 * Notify that the event cache has been updated
2149 *
2150 * @param completed
2151 * Also notify if the populating of the cache is complete, or
2152 * not.
2153 */
2154 public void cacheUpdated(final boolean completed) {
2155 synchronized (fCacheUpdateSyncObj) {
2156 if (fCacheUpdateBusy) {
2157 fCacheUpdatePending = true;
2158 fCacheUpdateCompleted = completed;
2159 return;
2160 }
2161 fCacheUpdateBusy = true;
2162 }
2163 // Event cache is now updated. Perform update on the UI thread
2164 if (!fTable.isDisposed()) {
2165 fTable.getDisplay().asyncExec(new Runnable() {
2166 @Override
2167 public void run() {
2168 if (!fTable.isDisposed()) {
2169 fTable.refresh();
2170 packColumns();
2171 }
2172 if (completed) {
2173 populateCompleted();
2174 }
2175 synchronized (fCacheUpdateSyncObj) {
2176 fCacheUpdateBusy = false;
2177 if (fCacheUpdatePending) {
2178 fCacheUpdatePending = false;
2179 cacheUpdated(fCacheUpdateCompleted);
2180 }
2181 }
2182 }
2183 });
2184 }
2185 }
2186
2187 /**
2188 * Callback for when populating the table is complete.
2189 */
2190 protected void populateCompleted() {
2191 // Nothing by default;
2192 }
2193
2194 // ------------------------------------------------------------------------
2195 // ISelectionProvider
2196 // ------------------------------------------------------------------------
2197
2198 /**
2199 * @since 2.0
2200 */
2201 @Override
2202 public void addSelectionChangedListener(ISelectionChangedListener listener) {
2203 selectionChangedListeners.add(listener);
2204 }
2205
2206 /**
2207 * @since 2.0
2208 */
2209 @Override
2210 public ISelection getSelection() {
2211 if (fTable == null || fTable.isDisposed()) {
2212 return StructuredSelection.EMPTY;
2213 }
2214 List<Object> list = new ArrayList<>(fTable.getSelection().length);
2215 for (TableItem item : fTable.getSelection()) {
2216 if (item.getData() != null) {
2217 list.add(item.getData());
2218 }
2219 }
2220 return new StructuredSelection(list);
2221 }
2222
2223 /**
2224 * @since 2.0
2225 */
2226 @Override
2227 public void removeSelectionChangedListener(ISelectionChangedListener listener) {
2228 selectionChangedListeners.remove(listener);
2229 }
2230
2231 /**
2232 * @since 2.0
2233 */
2234 @Override
2235 public void setSelection(ISelection selection) {
2236 // not implemented
2237 }
2238
2239 /**
2240 * Notifies any selection changed listeners that the viewer's selection has changed.
2241 * Only listeners registered at the time this method is called are notified.
2242 *
2243 * @param event a selection changed event
2244 *
2245 * @see ISelectionChangedListener#selectionChanged
2246 * @since 2.0
2247 */
2248 protected void fireSelectionChanged(final SelectionChangedEvent event) {
2249 Object[] listeners = selectionChangedListeners.getListeners();
2250 for (int i = 0; i < listeners.length; ++i) {
2251 final ISelectionChangedListener l = (ISelectionChangedListener) listeners[i];
2252 SafeRunnable.run(new SafeRunnable() {
2253 @Override
2254 public void run() {
2255 l.selectionChanged(event);
2256 }
2257 });
2258 }
2259 }
2260
2261 // ------------------------------------------------------------------------
2262 // Bookmark handling
2263 // ------------------------------------------------------------------------
2264
2265 /**
2266 * Add a bookmark to this event table.
2267 *
2268 * @param bookmarksFile
2269 * The file to use for the bookmarks
2270 */
2271 public void addBookmark(final IFile bookmarksFile) {
2272 fBookmarksFile = bookmarksFile;
2273 final TableItem[] selection = fTable.getSelection();
2274 if (selection.length > 0) {
2275 final TableItem tableItem = selection[0];
2276 if (tableItem.getData(Key.RANK) != null) {
2277 final StringBuffer defaultMessage = new StringBuffer();
2278 for (int i = 0; i < fTable.getColumns().length; i++) {
2279 if (i > 0) {
2280 defaultMessage.append(", "); //$NON-NLS-1$
2281 }
2282 defaultMessage.append(tableItem.getText(i));
2283 }
2284 final InputDialog dialog = new MultiLineInputDialog(
2285 PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell(),
2286 Messages.TmfEventsTable_AddBookmarkDialogTitle,
2287 Messages.TmfEventsTable_AddBookmarkDialogMessage,
2288 defaultMessage.toString());
2289 if (dialog.open() == Window.OK) {
2290 final String message = dialog.getValue();
2291 try {
2292 final IMarker bookmark = bookmarksFile.createMarker(IMarker.BOOKMARK);
2293 if (bookmark.exists()) {
2294 bookmark.setAttribute(IMarker.MESSAGE, message.toString());
2295 final Long rank = (Long) tableItem.getData(Key.RANK);
2296 final int location = rank.intValue();
2297 bookmark.setAttribute(IMarker.LOCATION, Integer.valueOf(location));
2298 fBookmarksMap.put(rank, bookmark.getId());
2299 fTable.refresh();
2300 }
2301 } catch (final CoreException e) {
2302 displayException(e);
2303 }
2304 }
2305 }
2306 }
2307
2308 }
2309
2310 /**
2311 * Remove a bookmark from this event table.
2312 *
2313 * @param bookmark
2314 * The bookmark to remove
2315 */
2316 public void removeBookmark(final IMarker bookmark) {
2317 for (final Entry<Long, Long> entry : fBookmarksMap.entries()) {
2318 if (entry.getValue().equals(bookmark.getId())) {
2319 fBookmarksMap.remove(entry.getKey(), entry.getValue());
2320 fTable.refresh();
2321 return;
2322 }
2323 }
2324 }
2325
2326 private void toggleBookmark(final Long rank) {
2327 if (fBookmarksFile == null) {
2328 return;
2329 }
2330 if (fBookmarksMap.containsKey(rank)) {
2331 final Collection<Long> markerIds = fBookmarksMap.removeAll(rank);
2332 fTable.refresh();
2333 try {
2334 for (long markerId : markerIds) {
2335 final IMarker bookmark = fBookmarksFile.findMarker(markerId);
2336 if (bookmark != null) {
2337 bookmark.delete();
2338 }
2339 }
2340 } catch (final CoreException e) {
2341 displayException(e);
2342 }
2343 } else {
2344 addBookmark(fBookmarksFile);
2345 }
2346 }
2347
2348 /**
2349 * Refresh the bookmarks assigned to this trace, from the contents of a
2350 * bookmark file.
2351 *
2352 * @param bookmarksFile
2353 * The bookmark file to use
2354 */
2355 public void refreshBookmarks(final IFile bookmarksFile) {
2356 fBookmarksFile = bookmarksFile;
2357 if (bookmarksFile == null) {
2358 fBookmarksMap.clear();
2359 fTable.refresh();
2360 return;
2361 }
2362 try {
2363 fBookmarksMap.clear();
2364 for (final IMarker bookmark : bookmarksFile.findMarkers(IMarker.BOOKMARK, false, IResource.DEPTH_ZERO)) {
2365 final int location = bookmark.getAttribute(IMarker.LOCATION, -1);
2366 if (location != -1) {
2367 final long rank = location;
2368 fBookmarksMap.put(rank, bookmark.getId());
2369 }
2370 }
2371 fTable.refresh();
2372 } catch (final CoreException e) {
2373 displayException(e);
2374 }
2375 }
2376
2377 @Override
2378 public void gotoMarker(final IMarker marker) {
2379 final int rank = marker.getAttribute(IMarker.LOCATION, -1);
2380 if (rank != -1) {
2381 int index = rank;
2382 if (fTable.getData(Key.FILTER_OBJ) != null) {
2383 index = fCache.getFilteredEventIndex(rank) + 1; // +1 for top filter status row
2384 } else if (rank >= fTable.getItemCount()) {
2385 fPendingGotoRank = rank;
2386 }
2387 fSelectedRank = rank;
2388 fTable.setSelection(index + 1); // +1 for header row
2389 updateStatusLine(null);
2390 }
2391 }
2392
2393 // ------------------------------------------------------------------------
2394 // Listeners
2395 // ------------------------------------------------------------------------
2396
2397 @Override
2398 public void colorSettingsChanged(final ColorSetting[] colorSettings) {
2399 fTable.refresh();
2400 }
2401
2402 // ------------------------------------------------------------------------
2403 // Signal handlers
2404 // ------------------------------------------------------------------------
2405
2406 /**
2407 * Handler for the trace updated signal
2408 *
2409 * @param signal
2410 * The incoming signal
2411 */
2412 @TmfSignalHandler
2413 public void traceUpdated(final TmfTraceUpdatedSignal signal) {
2414 if ((signal.getTrace() != fTrace) || fTable.isDisposed()) {
2415 return;
2416 }
2417 // Perform the refresh on the UI thread
2418 Display.getDefault().asyncExec(new Runnable() {
2419 @Override
2420 public void run() {
2421 if (!fTable.isDisposed() && (fTrace != null)) {
2422 if (fTable.getData(Key.FILTER_OBJ) == null) {
2423 fTable.setItemCount((int) fTrace.getNbEvents() + 1); // +1 for header row
2424 if ((fPendingGotoRank != -1) && ((fPendingGotoRank + 1) < fTable.getItemCount())) { // +1 for header row
2425 fTable.setSelection((int) fPendingGotoRank + 1); // +1 for header row
2426 fPendingGotoRank = -1;
2427 updateStatusLine(null);
2428 }
2429 } else {
2430 startFilterThread();
2431 }
2432 }
2433 if (!fRawViewer.isDisposed() && (fTrace != null)) {
2434 fRawViewer.refreshEventCount();
2435 }
2436 }
2437 });
2438 }
2439
2440 /**
2441 * Handler for the time synch signal.
2442 *
2443 * @param signal
2444 * The incoming signal
2445 */
2446 @TmfSignalHandler
2447 public void currentTimeUpdated(final TmfTimeSynchSignal signal) {
2448 if ((signal.getSource() != this) && (fTrace != null) && (!fTable.isDisposed())) {
2449
2450 // Create a request for one event that will be queued after other ongoing requests. When this request is completed
2451 // do the work to select the actual event with the timestamp specified in the signal. This procedure prevents
2452 // the method fTrace.getRank() from interfering and delaying ongoing requests.
2453 final TmfEventRequest subRequest = new TmfEventRequest(ITmfEvent.class,
2454 TmfTimeRange.ETERNITY, 0, 1, ExecutionType.FOREGROUND) {
2455
2456 TmfTimestamp ts = new TmfTimestamp(signal.getBeginTime());
2457
2458 @Override
2459 public void handleData(final ITmfEvent event) {
2460 super.handleData(event);
2461 }
2462
2463 @Override
2464 public void handleSuccess() {
2465 super.handleSuccess();
2466 if (fTrace == null) {
2467 return;
2468 }
2469
2470 // Verify if the event is within the trace range and adjust if necessary
2471 ITmfTimestamp timestamp = ts;
2472 if (timestamp.compareTo(fTrace.getStartTime()) == -1) {
2473 timestamp = fTrace.getStartTime();
2474 }
2475 if (timestamp.compareTo(fTrace.getEndTime()) == 1) {
2476 timestamp = fTrace.getEndTime();
2477 }
2478
2479 // Get the rank of the selected event in the table
2480 final ITmfContext context = fTrace.seekEvent(timestamp);
2481 final long rank = context.getRank();
2482 context.dispose();
2483 fSelectedRank = rank;
2484
2485 fTable.getDisplay().asyncExec(new Runnable() {
2486 @Override
2487 public void run() {
2488 // Return if table is disposed
2489 if (fTable.isDisposed()) {
2490 return;
2491 }
2492
2493 int index = (int) rank;
2494 if (fTable.isDisposed()) {
2495 return;
2496 }
2497 if (fTable.getData(Key.FILTER_OBJ) != null) {
2498 index = fCache.getFilteredEventIndex(rank) + 1; // +1 for top filter status row
2499 }
2500 fTable.setSelection(index + 1); // +1 for header row
2501 fRawViewer.selectAndReveal(rank);
2502 updateStatusLine(null);
2503 }
2504 });
2505 }
2506 };
2507
2508 ((ITmfEventProvider) fTrace).sendRequest(subRequest);
2509 }
2510 }
2511
2512 // ------------------------------------------------------------------------
2513 // Error handling
2514 // ------------------------------------------------------------------------
2515
2516 /**
2517 * Display an exception in a message box
2518 *
2519 * @param e the exception
2520 */
2521 private static void displayException(final Exception e) {
2522 final MessageBox mb = new MessageBox(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
2523 mb.setText(e.getClass().getSimpleName());
2524 mb.setMessage(e.getMessage());
2525 mb.open();
2526 }
2527
2528 /**
2529 * @since 2.0
2530 */
2531 public void refresh() {
2532 fCache.clear();
2533 fTable.refresh();
2534 fTable.redraw();
2535 }
2536
2537 /**
2538 * Margin column for images and special text (e.g. collapse count)
2539 */
2540 private static final class TmfMarginColumn extends TmfEventTableColumn {
2541
2542 private static final @NonNull ITmfEventAspect MARGIN_ASPECT = new ITmfEventAspect() {
2543
2544 @Override
2545 public String getName() {
2546 return EMPTY_STRING;
2547 }
2548
2549 @Override
2550 public String resolve(ITmfEvent event) {
2551 if (!(event instanceof CachedEvent) || ((CachedEvent) event).repeatCount == 0) {
2552 return EMPTY_STRING;
2553 }
2554 return "+" + ((CachedEvent) event).repeatCount; //$NON-NLS-1$
2555 }
2556
2557 @Override
2558 public String getHelpText() {
2559 return EMPTY_STRING;
2560 }
2561 };
2562
2563 /**
2564 * Constructor
2565 */
2566 public TmfMarginColumn() {
2567 super(MARGIN_ASPECT);
2568 }
2569 }
2570
2571 }
Tracecompass - Deliverables
This page took 0.101066 seconds and 5 git commands to generate.