1 /**********************************************************************
2 * Copyright (c) 2011, 2014 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Bernd Hufmann - Initial API and implementation
11 **********************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.loader
;
15 import java
.util
.ArrayList
;
16 import java
.util
.HashMap
;
17 import java
.util
.List
;
19 import java
.util
.concurrent
.CopyOnWriteArrayList
;
20 import java
.util
.concurrent
.locks
.ReentrantLock
;
22 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
23 import org
.eclipse
.core
.runtime
.IStatus
;
24 import org
.eclipse
.core
.runtime
.Status
;
25 import org
.eclipse
.core
.runtime
.jobs
.Job
;
26 import org
.eclipse
.jface
.viewers
.ISelection
;
27 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
28 import org
.eclipse
.swt
.widgets
.Display
;
29 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Activator
;
30 import org
.eclipse
.tracecompass
.tmf
.core
.component
.TmfComponent
;
31 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
32 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEventField
;
33 import org
.eclipse
.tracecompass
.tmf
.core
.request
.ITmfEventRequest
;
34 import org
.eclipse
.tracecompass
.tmf
.core
.request
.TmfEventRequest
;
35 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfRangeSynchSignal
;
36 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignal
;
37 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
38 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTimeSynchSignal
;
39 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal
;
40 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
41 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
47 import org
.eclipse
.tracecompass
.tmf
.core
.uml2sd
.ITmfSyncSequenceDiagramEvent
;
48 import org
.eclipse
.tracecompass
.tmf
.core
.uml2sd
.TmfSyncSequenceDiagramEvent
;
49 import org
.eclipse
.tracecompass
.tmf
.ui
.editors
.ITmfTraceEditor
;
50 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.SDView
;
51 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.core
.Frame
;
52 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.core
.GraphNode
;
53 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.core
.Lifeline
;
54 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.dialogs
.Criteria
;
55 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.dialogs
.FilterCriteria
;
56 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.dialogs
.FilterListDialog
;
57 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDAdvancedPagingProvider
;
58 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDFilterProvider
;
59 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDFindProvider
;
60 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDGraphNodeSupporter
;
61 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.load
.IUml2SDLoader
;
62 import org
.eclipse
.ui
.IEditorPart
;
63 import org
.eclipse
.ui
.ISelectionListener
;
64 import org
.eclipse
.ui
.IWorkbenchPart
;
65 import org
.eclipse
.ui
.IWorkbenchWindow
;
66 import org
.eclipse
.ui
.PlatformUI
;
67 import org
.eclipse
.ui
.progress
.IProgressConstants
;
71 * This class is a reference implementation of the
72 * <code>org.eclipse.linuxtools.tmf.ui.Uml2SDLoader</code> extension point. It
73 * provides a Sequence Diagram loader for a user space trace with specific trace
74 * content for sending and receiving signals between components. I also includes
75 * a default implementation for the <code>ITmfEvent</code> parsing.
78 * The class <code>TmfUml2SDSyncLoader</code> analyzes events from type
79 * <code>ITmfEvent</code> and creates events type
80 * <code>ITmfSyncSequenceDiagramEvent</code> if the <code>ITmfEvent</code>
81 * contains all relevant information. The analysis checks that the event type
82 * strings contains either string SEND or RECEIVE. If event type matches these
83 * key words, the analyzer will look for strings sender, receiver and signal in
84 * the event fields of type <code>ITmfEventField</code>. If all the data is
85 * found a sequence diagram event from can be created. Note that Sync Messages
86 * are assumed, which means start and end time are the same. <br>
88 * The parsing of the <code>ITmfEvent</code> is done in the method
89 * <code>getSequnceDiagramEvent()</code> of class
90 * <code>TmfUml2SDSyncLoader</code>. By extending the class
91 * <code>TmfUml2SDSyncLoader</code> and overwriting
92 * <code>getSequnceDiagramEvent()</code> a customized parsing algorithm can be
95 * Note that combined traces of multiple components, that contain the trace
96 * information about the same interactions are not supported in the class
97 * <code>TmfUml2SDSyncLoader</code>.
100 * @author Bernd Hufmann
102 public class TmfUml2SDSyncLoader
extends TmfComponent
implements IUml2SDLoader
, ISDFindProvider
, ISDFilterProvider
, ISDAdvancedPagingProvider
, ISelectionListener
{
104 // ------------------------------------------------------------------------
106 // ------------------------------------------------------------------------
109 * Default title name.
111 protected static final String TITLE
= Messages
.TmfUml2SDSyncLoader_ViewName
;
114 * Maximum number of messages per page.
116 protected static final int MAX_NUM_OF_MSG
= 10000;
118 private static final int INDEXING_THREAD_SLEEP_VALUE
= 100;
120 // ------------------------------------------------------------------------
122 // ------------------------------------------------------------------------
124 // Experiment attributes
126 * The TMF trace reference.
129 protected ITmfTrace fTrace
= null;
131 * The current indexing event request.
133 protected ITmfEventRequest fIndexRequest
= null;
135 * The current request to fill a page.
137 protected ITmfEventRequest fPageRequest
= null;
139 * Flag whether the time range signal was sent by this loader class or not
141 protected volatile boolean fIsSignalSent
= false;
143 // The view and event attributes
145 * The sequence diagram view reference.
147 protected SDView fView
= null;
149 * The current sequence diagram frame reference.
151 protected Frame fFrame
= null;
153 * The list of sequence diagram events of current page.
155 protected List
<ITmfSyncSequenceDiagramEvent
> fEvents
= new ArrayList
<>();
157 // Checkpoint and page attributes
159 * The checkpoints of the whole sequence diagram trace (i.e. start time stamp of each page)
161 protected List
<TmfTimeRange
> fCheckPoints
= new ArrayList
<>(MAX_NUM_OF_MSG
);
163 * The current page displayed.
165 protected volatile int fCurrentPage
= 0;
167 * The current time selected.
169 protected ITmfTimestamp fCurrentTime
= null;
171 * Flag to specify that selection of message is done by selection or by signal.
173 protected volatile boolean fIsSelect
= false;
177 * The job for searching across pages.
179 protected SearchJob fFindJob
= null;
181 * List of found nodes within a page.
183 protected List
<GraphNode
> fFindResults
= new ArrayList
<>();
185 * The current find criteria reference
187 protected Criteria fFindCriteria
= null;
189 * The current find index within the list of found nodes (<code>fFindeResults</code> within a page.
191 protected volatile int fCurrentFindIndex
= 0;
195 * The list of active filters.
197 protected List
<FilterCriteria
> fFilterCriteria
= null;
199 // Thread synchronization
201 * The synchronization lock.
203 protected ReentrantLock fLock
= new ReentrantLock();
205 // ------------------------------------------------------------------------
207 // ------------------------------------------------------------------------
209 * Default constructor
211 public TmfUml2SDSyncLoader() {
218 * @param name Name of loader
220 public TmfUml2SDSyncLoader(String name
) {
224 // ------------------------------------------------------------------------
226 // ------------------------------------------------------------------------
229 * Returns the current time if available else null.
231 * @return the current time if available else null
234 public ITmfTimestamp
getCurrentTime() {
237 if (fCurrentTime
!= null) {
247 * Waits for the page request to be completed
249 public void waitForCompletion() {
251 ITmfEventRequest request
= fPageRequest
;
253 if (request
!= null) {
255 request
.waitForCompletion();
256 } catch (InterruptedException e
) {
263 * Handler for the trace opened signal.
264 * @param signal The trace opened signal
268 public void traceOpened(TmfTraceOpenedSignal signal
) {
269 fTrace
= signal
.getTrace();
275 * Signal handler for the trace selected signal.
277 * Spawns a request to index the trace (checkpoints creation) as well as it fills
280 * @param signal The trace selected signal
284 public void traceSelected(TmfTraceSelectedSignal signal
) {
285 // Update the trace reference
286 ITmfTrace trace
= signal
.getTrace();
287 if (!trace
.equals(fTrace
)) {
294 * Method for loading the current selected trace into the view.
295 * Sub-class need to override this method to add the view specific implementation.
298 protected void loadTrace() {
299 ITmfEventRequest indexRequest
= null;
303 final Job job
= new IndexingJob("Indexing " + getName() + "..."); //$NON-NLS-1$ //$NON-NLS-2$
307 indexRequest
= fIndexRequest
;
309 cancelOngoingRequests();
311 TmfTimeRange window
= TmfTimeRange
.ETERNITY
;
313 fIndexRequest
= new TmfEventRequest(ITmfEvent
.class, window
, 0,
314 ITmfEventRequest
.ALL_DATA
, ITmfEventRequest
.ExecutionType
.BACKGROUND
) {
316 private ITmfTimestamp fFirstTime
= null;
317 private ITmfTimestamp fLastTime
= null;
318 private int fNbSeqEvents
= 0;
319 private final List
<ITmfSyncSequenceDiagramEvent
> fSdEvents
= new ArrayList
<>(MAX_NUM_OF_MSG
);
322 public void handleData(ITmfEvent event
) {
323 super.handleData(event
);
325 ITmfSyncSequenceDiagramEvent sdEvent
= getSequenceDiagramEvent(event
);
327 if (sdEvent
!= null) {
330 if (fFirstTime
== null) {
331 fFirstTime
= event
.getTimestamp();
334 fLastTime
= event
.getTimestamp();
336 if ((fNbSeqEvents
% MAX_NUM_OF_MSG
) == 0) {
339 fCheckPoints
.add(new TmfTimeRange(fFirstTime
, fLastTime
));
341 fView
.updateCoolBar();
350 if (fNbSeqEvents
> MAX_NUM_OF_MSG
) {
355 fSdEvents
.add(sdEvent
);
357 if (fNbSeqEvents
== MAX_NUM_OF_MSG
) {
358 fillCurrentPage(fSdEvents
);
364 public void handleSuccess() {
365 if ((fFirstTime
!= null) && (fLastTime
!= null)) {
369 fCheckPoints
.add(new TmfTimeRange(fFirstTime
, fLastTime
));
371 fView
.updateCoolBar();
378 if (fNbSeqEvents
<= MAX_NUM_OF_MSG
) {
379 fillCurrentPage(fSdEvents
);
382 super.handleSuccess();
386 public void handleCompleted() {
387 if (fEvents
.isEmpty()) {
388 fFrame
= new Frame();
389 // make sure that view is not null when setting frame
397 if (sdView
!= null) {
398 sdView
.setFrameSync(fFrame
);
401 super.handleCompleted();
409 if (indexRequest
!= null && !indexRequest
.isCompleted()) {
410 indexRequest
.cancel();
413 fTrace
.sendRequest(fIndexRequest
);
417 * Signal handler for the trace closed signal.
419 * @param signal The trace closed signal
423 public void traceClosed(TmfTraceClosedSignal signal
) {
424 if (signal
.getTrace() != fTrace
) {
427 ITmfEventRequest indexRequest
= null;
430 indexRequest
= fIndexRequest
;
431 fIndexRequest
= null;
433 cancelOngoingRequests();
435 if (fFilterCriteria
!= null) {
436 fFilterCriteria
.clear();
439 FilterListDialog
.deactivateSavedGlobalFilters();
444 if (indexRequest
!= null && !indexRequest
.isCompleted()) {
445 indexRequest
.cancel();
452 * Moves to the page that contains the time provided by the signal. The messages will be selected
453 * if the provided time is the time of a message.
455 * @param signal The Time synch signal.
458 public void synchToTime(TmfTimeSynchSignal signal
) {
461 if ((signal
.getSource() != this) && (fFrame
!= null) && (fCheckPoints
.size() > 0)) {
462 fCurrentTime
= signal
.getBeginTime();
472 * Moves to the page that contains the current time provided by signal.
473 * No message will be selected however the focus will be set to the message
474 * if the provided time is the time of a message.
476 * @param signal The time range sync signal
479 public void synchToTimeRange(TmfRangeSynchSignal signal
) {
482 if ((signal
.getSource() != this) && (fFrame
!= null) && !fIsSignalSent
&& (fCheckPoints
.size() > 0)) {
483 TmfTimeRange newTimeRange
= signal
.getCurrentRange();
486 fCurrentTime
= newTimeRange
.getStartTime();
497 public void setViewer(SDView viewer
) {
502 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getSelectionService().addPostSelectionListener(this);
503 fView
.setSDFindProvider(this);
504 fView
.setSDPagingProvider(this);
505 fView
.setSDFilterProvider(this);
508 IEditorPart editor
= fView
.getSite().getPage().getActiveEditor();
509 if (editor
instanceof ITmfTraceEditor
) {
510 ITmfTrace trace
= ((ITmfTraceEditor
) editor
).getTrace();
512 traceSelected(new TmfTraceSelectedSignal(this, trace
));
521 public String
getTitleString() {
526 public void dispose() {
528 ITmfEventRequest indexRequest
= null;
531 IWorkbenchWindow window
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow();
532 // During Eclipse shutdown the active workbench window is null
533 if (window
!= null) {
534 window
.getSelectionService().removePostSelectionListener(this);
537 indexRequest
= fIndexRequest
;
538 fIndexRequest
= null;
539 cancelOngoingRequests();
541 fView
.setSDFindProvider(null);
542 fView
.setSDPagingProvider(null);
543 fView
.setSDFilterProvider(null);
548 if (indexRequest
!= null && !indexRequest
.isCompleted()) {
549 indexRequest
.cancel();
554 public boolean isNodeSupported(int nodeType
) {
556 case ISDGraphNodeSupporter
.LIFELINE
:
557 case ISDGraphNodeSupporter
.SYNCMESSAGE
:
567 public String
getNodeName(int nodeType
, String loaderClassName
) {
569 case ISDGraphNodeSupporter
.LIFELINE
:
570 return Messages
.TmfUml2SDSyncLoader_CategoryLifeline
;
571 case ISDGraphNodeSupporter
.SYNCMESSAGE
:
572 return Messages
.TmfUml2SDSyncLoader_CategoryMessage
;
576 return ""; //$NON-NLS-1$
580 public void selectionChanged(IWorkbenchPart part
, ISelection selection
) {
581 ISelection sel
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getSelectionService().getSelection();
582 if ((sel
!= null) && (sel
instanceof StructuredSelection
)) {
583 StructuredSelection stSel
= (StructuredSelection
) sel
;
584 if (stSel
.getFirstElement() instanceof TmfSyncMessage
) {
585 TmfSyncMessage syncMsg
= ((TmfSyncMessage
) stSel
.getFirstElement());
586 broadcast(new TmfTimeSynchSignal(this, syncMsg
.getStartTime()));
592 public boolean find(Criteria toSearch
) {
595 if (fFrame
== null) {
599 if ((fFindResults
== null) || (fFindCriteria
== null) || !fFindCriteria
.compareTo(toSearch
)) {
600 fFindResults
= new CopyOnWriteArrayList
<>();
601 fFindCriteria
= toSearch
;
602 if (fFindCriteria
.isLifeLineSelected()) {
603 for (int i
= 0; i
< fFrame
.lifeLinesCount(); i
++) {
604 if (fFindCriteria
.matches(fFrame
.getLifeline(i
).getName())) {
605 fFindResults
.add(fFrame
.getLifeline(i
));
610 ArrayList
<GraphNode
> msgs
= new ArrayList
<>();
611 if (fFindCriteria
.isSyncMessageSelected()) {
612 for (int i
= 0; i
< fFrame
.syncMessageCount(); i
++) {
613 if (fFindCriteria
.matches(fFrame
.getSyncMessage(i
).getName())) {
614 msgs
.add(fFrame
.getSyncMessage(i
));
619 if (!msgs
.isEmpty()) {
620 fFindResults
.addAll(msgs
);
623 List
<GraphNode
> selection
= fView
.getSDWidget().getSelection();
624 if ((selection
!= null) && (selection
.size() == 1)) {
625 fCurrentFindIndex
= fFindResults
.indexOf(selection
.get(0)) + 1;
627 fCurrentFindIndex
= 0;
633 if (fFindResults
.size() > fCurrentFindIndex
) {
634 GraphNode current
= fFindResults
.get(fCurrentFindIndex
);
635 fView
.getSDWidget().moveTo(current
);
639 fCurrentFindIndex
=0;
640 return findInNextPages(fFindCriteria
); // search in other page
647 public void cancel() {
648 cancelOngoingRequests();
652 public boolean filter(List
<FilterCriteria
> filters
) {
655 cancelOngoingRequests();
657 if (filters
== null) {
658 fFilterCriteria
= new ArrayList
<>();
660 List
<FilterCriteria
> list
= filters
;
661 fFilterCriteria
= new ArrayList
<>(list
);
664 fillCurrentPage(fEvents
);
673 public boolean hasNextPage() {
676 int size
= fCheckPoints
.size();
678 return fCurrentPage
< (size
- 1);
687 public boolean hasPrevPage() {
690 return fCurrentPage
> 0;
697 public void nextPage() {
701 if (fCurrentPage
>= (fCheckPoints
.size() - 1)) {
705 cancelOngoingRequests();
715 public void prevPage() {
719 if (fCurrentPage
<= 0) {
723 cancelOngoingRequests();
733 public void firstPage() {
737 cancelOngoingRequests();
747 public void lastPage() {
750 cancelOngoingRequests();
752 fCurrentPage
= fCheckPoints
.size() - 1;
760 public int currentPage() {
770 public int pagesCount() {
773 return fCheckPoints
.size();
780 public void pageNumberChanged(int pagenNumber
) {
781 int localPageNumber
= pagenNumber
;
785 cancelOngoingRequests();
787 if (localPageNumber
< 0) {
790 int size
= fCheckPoints
.size();
791 if (localPageNumber
> (size
- 1)) {
792 localPageNumber
= size
- 1;
794 fCurrentPage
= localPageNumber
;
802 public void broadcast(TmfSignal signal
) {
803 fIsSignalSent
= true;
804 super.broadcast(signal
);
805 fIsSignalSent
= false;
809 * Cancels any ongoing find operation
811 protected void cancelOngoingRequests() {
813 ITmfEventRequest pageRequest
= null;
815 // Cancel the search thread
816 if (fFindJob
!= null) {
821 fFindCriteria
= null;
822 fCurrentFindIndex
= 0;
824 pageRequest
= fPageRequest
;
829 if (pageRequest
!= null && !pageRequest
.isCompleted()) {
830 pageRequest
.cancel();
835 * Resets loader attributes
837 protected void resetLoader() {
842 fCheckPoints
.clear();
844 fCurrentFindIndex
= 0;
845 fFindCriteria
= null;
847 fView
.setFrameSync(new Frame());
857 * Fills current page with sequence diagram content.
859 * @param events sequence diagram events
861 protected void fillCurrentPage(List
<ITmfSyncSequenceDiagramEvent
> events
) {
865 fEvents
= new ArrayList
<>(events
);
866 if (fView
!= null && !events
.isEmpty()) {
867 fView
.toggleWaitCursorAsync(true);
873 final Frame frame
= new Frame();
875 if (!events
.isEmpty()) {
876 Map
<String
, Lifeline
> nodeToLifelineMap
= new HashMap
<>();
878 frame
.setName(Messages
.TmfUml2SDSyncLoader_FrameName
);
880 for (int i
= 0; i
< events
.size(); i
++) {
882 ITmfSyncSequenceDiagramEvent sdEvent
= events
.get(i
);
884 if ((nodeToLifelineMap
.get(sdEvent
.getSender()) == null) && (!filterLifeLine(sdEvent
.getSender()))) {
885 Lifeline lifeline
= new Lifeline();
886 lifeline
.setName(sdEvent
.getSender());
887 nodeToLifelineMap
.put(sdEvent
.getSender(), lifeline
);
888 frame
.addLifeLine(lifeline
);
891 if ((nodeToLifelineMap
.get(sdEvent
.getReceiver()) == null) && (!filterLifeLine(sdEvent
.getReceiver()))) {
892 Lifeline lifeline
= new Lifeline();
893 lifeline
.setName(sdEvent
.getReceiver());
894 nodeToLifelineMap
.put(sdEvent
.getReceiver(), lifeline
);
895 frame
.addLifeLine(lifeline
);
899 int eventOccurence
= 1;
901 for (int i
= 0; i
< events
.size(); i
++) {
902 ITmfSyncSequenceDiagramEvent sdEvent
= events
.get(i
);
904 // Check message filter
905 if (filterMessage(sdEvent
)) {
909 // Set the message sender and receiver
910 Lifeline startLifeline
= nodeToLifelineMap
.get(sdEvent
.getSender());
911 Lifeline endLifeline
= nodeToLifelineMap
.get(sdEvent
.getReceiver());
913 // Check if any of the lifelines were filtered
914 if ((startLifeline
== null) || (endLifeline
== null)) {
918 int tmp
= Math
.max(startLifeline
.getEventOccurrence(), endLifeline
.getEventOccurrence());
919 eventOccurence
= Math
.max(eventOccurence
, tmp
);
921 startLifeline
.setCurrentEventOccurrence(eventOccurence
);
922 endLifeline
.setCurrentEventOccurrence(eventOccurence
);
924 TmfSyncMessage message
= new TmfSyncMessage(sdEvent
, eventOccurence
++);
926 message
.setStartLifeline(startLifeline
);
927 message
.setEndLifeline(endLifeline
);
929 message
.setTime(sdEvent
.getStartTime());
931 // add the message to the frame
932 frame
.addMessage(message
);
937 if (!fView
.getSDWidget().isDisposed()) {
938 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
945 // check if view was disposed in the meanwhile
946 if ((fView
!= null) && (!fView
.getSDWidget().isDisposed())) {
948 fView
.setFrame(fFrame
);
950 if (fCurrentTime
!= null) {
951 moveToMessageInPage();
954 if (fFindCriteria
!= null) {
958 fView
.toggleWaitCursorAsync(false);
975 * Moves to a certain message defined by timestamp (across pages)
977 protected void moveToMessage() {
982 page
= getPage(fCurrentTime
);
984 if (page
== fCurrentPage
) {
985 moveToMessageInPage();
996 * Moves to a certain message defined by timestamp in current page
998 protected void moveToMessageInPage() {
1001 if (!fView
.getSDWidget().isDisposed()) {
1002 // Check for GUI thread
1003 if(Display
.getCurrent() != null) {
1004 // Already in GUI thread - execute directly
1005 TmfSyncMessage prevMessage
= null;
1006 TmfSyncMessage syncMessage
= null;
1007 boolean isExactTime
= false;
1008 for (int i
= 0; i
< fFrame
.syncMessageCount(); i
++) {
1009 if (fFrame
.getSyncMessage(i
) instanceof TmfSyncMessage
) {
1010 syncMessage
= (TmfSyncMessage
) fFrame
.getSyncMessage(i
);
1011 if (syncMessage
.getStartTime().compareTo(fCurrentTime
) == 0) {
1014 } else if ((syncMessage
.getStartTime().compareTo(fCurrentTime
) > 0) && (prevMessage
!= null)) {
1015 syncMessage
= prevMessage
;
1018 prevMessage
= syncMessage
;
1021 if (fIsSelect
&& isExactTime
) {
1022 fView
.getSDWidget().moveTo(syncMessage
);
1025 fView
.getSDWidget().ensureVisible(syncMessage
);
1026 fView
.getSDWidget().clearSelection();
1027 fView
.getSDWidget().redraw();
1031 // Not in GUI thread - queue action in GUI thread.
1032 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
1035 moveToMessageInPage();
1047 * Moves to a certain message defined by timestamp (across pages)
1049 protected void moveToPage() {
1054 * Moves to a certain page.
1056 * @param notifyAll true to broadcast time range signal to other signal handlers else false
1058 protected void moveToPage(boolean notifyAll
) {
1060 TmfTimeRange window
= null;
1065 if (fCurrentPage
> fCheckPoints
.size()) {
1068 window
= fCheckPoints
.get(fCurrentPage
);
1073 if (window
== null) {
1074 window
= TmfTimeRange
.ETERNITY
;
1077 fPageRequest
= new TmfEventRequest(ITmfEvent
.class, window
, 0,
1078 ITmfEventRequest
.ALL_DATA
, ITmfEventRequest
.ExecutionType
.FOREGROUND
) {
1079 private final List
<ITmfSyncSequenceDiagramEvent
> fSdEvent
= new ArrayList
<>();
1082 public void handleData(ITmfEvent event
) {
1083 super.handleData(event
);
1085 ITmfSyncSequenceDiagramEvent sdEvent
= getSequenceDiagramEvent(event
);
1087 if (sdEvent
!= null) {
1088 fSdEvent
.add(sdEvent
);
1093 public void handleSuccess() {
1094 fillCurrentPage(fSdEvent
);
1095 super.handleSuccess();
1100 fTrace
.sendRequest(fPageRequest
);
1103 TmfTimeRange timeRange
= getSignalTimeRange(window
.getStartTime());
1104 broadcast(new TmfRangeSynchSignal(this, timeRange
));
1109 * Gets page that contains timestamp
1111 * @param time The timestamp
1112 * @return page that contains the time
1115 protected int getPage(ITmfTimestamp time
) {
1120 size
= fCheckPoints
.size();
1121 for (page
= 0; page
< size
; page
++) {
1122 TmfTimeRange timeRange
= fCheckPoints
.get(page
);
1123 if (timeRange
.getEndTime().compareTo(time
) >= 0) {
1137 * Background search in trace for expression in criteria.
1139 * @param findCriteria The find criteria
1140 * @return true if background request was started else false
1142 protected boolean findInNextPages(Criteria findCriteria
) {
1145 if (fFindJob
!= null) {
1149 int nextPage
= fCurrentPage
+ 1;
1151 if ((nextPage
) >= fCheckPoints
.size()) {
1152 // we are at the end
1156 TmfTimeRange window
= new TmfTimeRange(fCheckPoints
.get(nextPage
).getStartTime(), fCheckPoints
.get(fCheckPoints
.size()-1).getEndTime());
1157 fFindJob
= new SearchJob(findCriteria
, window
);
1158 fFindJob
.schedule();
1159 fView
.toggleWaitCursorAsync(true);
1167 * Gets time range for time range signal.
1169 * @param startTime The start time of time range.
1170 * @return the time range
1173 protected TmfTimeRange
getSignalTimeRange(ITmfTimestamp startTime
) {
1176 TmfTimeRange currentRange
= TmfTraceManager
.getInstance().getCurrentRange();
1177 long offset
= fTrace
== null ?
0 : currentRange
.getEndTime().getDelta(currentRange
.getStartTime()).normalize(0, startTime
.getScale()).getValue();
1178 TmfTimestamp initialEndOfWindow
= new TmfTimestamp(startTime
.getValue() + offset
, startTime
.getScale());
1179 return new TmfTimeRange(startTime
, initialEndOfWindow
);
1187 * Checks if filter criteria matches the message name in given SD event.
1189 * @param sdEvent The SD event to check
1190 * @return true if match else false.
1192 protected boolean filterMessage(ITmfSyncSequenceDiagramEvent sdEvent
) {
1195 if (fFilterCriteria
!= null) {
1196 for(FilterCriteria criteria
: fFilterCriteria
) {
1197 if (criteria
.isActive() && criteria
.getCriteria().isSyncMessageSelected() && criteria
.getCriteria().matches(sdEvent
.getName())) {
1209 * Checks if filter criteria matches a lifeline name (sender or receiver) in given SD event.
1211 * @param lifeline the message receiver
1212 * @return true if match else false.
1214 protected boolean filterLifeLine(String lifeline
) {
1217 if (fFilterCriteria
!= null) {
1218 for(FilterCriteria criteria
: fFilterCriteria
) {
1219 if (criteria
.isActive() && criteria
.getCriteria().isLifeLineSelected() && criteria
.getCriteria().matches(lifeline
)) {
1231 * Job to search in trace for given time range.
1233 protected class SearchJob
extends Job
{
1236 * The search event request.
1238 protected final SearchEventRequest fSearchRequest
;
1243 * @param findCriteria The search criteria
1244 * @param window Time range to search in
1247 public SearchJob(Criteria findCriteria
, TmfTimeRange window
) {
1248 super(Messages
.TmfUml2SDSyncLoader_SearchJobDescrition
);
1249 fSearchRequest
= new SearchEventRequest(window
, ITmfEventRequest
.ALL_DATA
,
1250 ITmfEventRequest
.ExecutionType
.FOREGROUND
, findCriteria
);
1254 protected IStatus
run(IProgressMonitor monitor
) {
1255 fSearchRequest
.setMonitor(monitor
);
1257 fTrace
.sendRequest(fSearchRequest
);
1260 fSearchRequest
.waitForCompletion();
1261 } catch (InterruptedException e
) {
1262 Activator
.getDefault().logError("Search request interrupted!", e
); //$NON-NLS-1$
1265 IStatus status
= Status
.OK_STATUS
;
1266 if (fSearchRequest
.isFound() && (fSearchRequest
.getFoundTime() != null)) {
1267 fCurrentTime
= fSearchRequest
.getFoundTime();
1269 // Avoid double-selection. Selection will be done when calling find(criteria)
1270 // after moving to relevant page
1272 if (!fView
.getSDWidget().isDisposed()) {
1273 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
1283 if (monitor
.isCanceled()) {
1284 status
= Status
.CANCEL_STATUS
;
1287 // String was not found
1288 status
= new Status(IStatus
.WARNING
, Activator
.PLUGIN_ID
, Messages
.TmfUml2SDSyncLoader_SearchNotFound
);
1290 setProperty(IProgressConstants
.KEEP_PROPERTY
, Boolean
.TRUE
);
1296 fView
.toggleWaitCursorAsync(false);
1306 protected void canceling() {
1307 fSearchRequest
.cancel();
1318 * TMF event request for searching within trace.
1320 protected class SearchEventRequest
extends TmfEventRequest
{
1323 * The find criteria.
1325 private final Criteria fCriteria
;
1327 * A progress monitor
1329 private IProgressMonitor fMonitor
;
1331 * Flag to indicate that node was found according the criteria .
1333 private boolean fIsFound
= false;
1335 * Time stamp of found item.
1337 private ITmfTimestamp fFoundTime
= null;
1341 * @param range @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1342 * @param nbRequested @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1343 * @param execType @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1344 * @param criteria The search criteria
1346 public SearchEventRequest(TmfTimeRange range
, int nbRequested
, ExecutionType execType
, Criteria criteria
) {
1347 this(range
, nbRequested
, execType
, criteria
, null);
1352 * @param range @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1353 * @param nbRequested @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1354 * @param execType @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1355 * @param criteria The search criteria
1356 * @param monitor progress monitor
1358 public SearchEventRequest(TmfTimeRange range
, int nbRequested
, ExecutionType execType
, Criteria criteria
, IProgressMonitor monitor
) {
1359 super(ITmfEvent
.class, range
, 0, nbRequested
, execType
);
1360 fCriteria
= new Criteria(criteria
);
1365 public void handleData(ITmfEvent event
) {
1366 super.handleData(event
);
1368 if ((fMonitor
!= null) && fMonitor
.isCanceled()) {
1373 ITmfSyncSequenceDiagramEvent sdEvent
= getSequenceDiagramEvent(event
);
1375 if (sdEvent
!= null) {
1377 if (fCriteria
.isLifeLineSelected()) {
1378 if (fCriteria
.matches(sdEvent
.getSender())) {
1379 fFoundTime
= event
.getTimestamp();
1384 if (fCriteria
.matches(sdEvent
.getReceiver())) {
1385 fFoundTime
= event
.getTimestamp();
1391 if (fCriteria
.isSyncMessageSelected() && fCriteria
.matches(sdEvent
.getName())) {
1392 fFoundTime
= event
.getTimestamp();
1400 * Set progress monitor.
1402 * @param monitor The monitor to assign
1404 public void setMonitor(IProgressMonitor monitor
) {
1409 * Check if find criteria was met.
1411 * @return true if find criteria was met.
1413 public boolean isFound() {
1418 * Returns timestamp of found time.
1420 * @return timestamp of found time.
1423 public ITmfTimestamp
getFoundTime() {
1429 * Job class to provide progress monitor feedback.
1432 * @author Bernd Hufmann
1435 protected static class IndexingJob
extends Job
{
1438 * @param name The job name
1440 public IndexingJob(String name
) {
1445 protected IStatus
run(IProgressMonitor monitor
) {
1446 while (!monitor
.isCanceled()) {
1448 Thread
.sleep(INDEXING_THREAD_SLEEP_VALUE
);
1449 } catch (InterruptedException e
) {
1450 return Status
.OK_STATUS
;
1454 return Status
.OK_STATUS
;
1460 * Returns sequence diagram event if details in given event are available else null.
1462 * @param tmfEvent Event to parse for sequence diagram event details
1463 * @return sequence diagram event if details are available else null
1466 protected ITmfSyncSequenceDiagramEvent
getSequenceDiagramEvent(ITmfEvent tmfEvent
){
1467 //type = .*RECEIVE.* or .*SEND.*
1468 //content = sender:<sender name>:receiver:<receiver name>,signal:<signal name>
1469 String eventType
= tmfEvent
.getType().toString();
1470 if (eventType
.contains(Messages
.TmfUml2SDSyncLoader_EventTypeSend
) || eventType
.contains(Messages
.TmfUml2SDSyncLoader_EventTypeReceive
)) {
1471 Object sender
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncLoader_FieldSender
);
1472 Object receiver
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncLoader_FieldReceiver
);
1473 Object name
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncLoader_FieldSignal
);
1474 if ((sender
instanceof ITmfEventField
) && (receiver
instanceof ITmfEventField
) && (name
instanceof ITmfEventField
)) {
1475 ITmfSyncSequenceDiagramEvent sdEvent
= new TmfSyncSequenceDiagramEvent(tmfEvent
,
1476 ((ITmfEventField
) sender
).getValue().toString(),
1477 ((ITmfEventField
) receiver
).getValue().toString(),
1478 ((ITmfEventField
) name
).getValue().toString());