org.eclipse.linuxtools.lttng.ui/src/org/eclipse/linuxtools/lttng/ui/views/timeframe/TimeFrameView.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009 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
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.lttng.ui.views.timeframe;
  14
  15 import org.eclipse.linuxtools.lttng.event.LttngEvent;
  16 import org.eclipse.linuxtools.tmf.event.TmfTimeRange;
  17 import org.eclipse.linuxtools.tmf.event.TmfTimestamp;
  18 import org.eclipse.linuxtools.tmf.experiment.TmfExperiment;
  19 import org.eclipse.linuxtools.tmf.signal.TmfExperimentSelectedSignal;
  20 import org.eclipse.linuxtools.tmf.signal.TmfExperimentUpdatedSignal;
  21 import org.eclipse.linuxtools.tmf.signal.TmfSignalHandler;
  22 import org.eclipse.linuxtools.tmf.signal.TmfTimeSynchSignal;
  23 import org.eclipse.linuxtools.tmf.ui.views.TmfView;
  24 import org.eclipse.swt.SWT;
  25 import org.eclipse.swt.layout.GridData;
  26 import org.eclipse.swt.layout.GridLayout;
  27 import org.eclipse.swt.widgets.Composite;
  28 import org.eclipse.swt.widgets.Event;
  29 import org.eclipse.swt.widgets.Listener;
  30 import org.eclipse.swt.widgets.Slider;
  31
  32 /**
  33  * <b><u>TimeFrameView</u></b>
  34  * <p>
  35  * The TimeFrameView provides a set of spinners to monitor and set the start
  36  * time, end time, the current time interval and current time of the trace
  37  * set at the nanosecond level.
  38  * <p>
  39  * It ensures that the following relations are always true:
  40  * <p>
  41  * <li>[ startTime >= start time of the trace ]
  42  * <li>[ endTime <= end time of the trace ]
  43  * <li>[ startTime <= currentTime <= endTime ]
  44  * <li>[ interval == (endTime - startTime) ]
  45  * </li>
  46  * <p>
  47  * It provides a slider to rapidly set the current time within the time range
  48  * (i.e. between startTime and endTime).
  49  * <p>
  50  * Finally, it allows modification of the time range and the current time. This
  51  * triggers notifications to the other LTTng views.
  52  * <p>
  53  * FIXME: The slider is very jumpy due to the large number of async updates
  54  * FIXME: Revisit the control flow between View, Spinners and Slider
  55  */
  56 public class TimeFrameView extends TmfView {
  57
  58     public static final String ID = "org.eclipse.linuxtools.lttng.ui.views.timeframe";
  59
  60     // ========================================================================
  61     // TimeFrameView
  62     // ========================================================================
  63
  64     // The event log timestamp characteristics
  65     private TmfTimestamp fTraceStartTime = new TmfTimestamp();
  66     private TmfTimestamp fTraceEndTime   = new TmfTimestamp();
  67
  68     private TmfTimestamp fCurrentTime   = new TmfTimestamp();
  69
  70     private TmfTimeRange fTraceTimeRange = new TmfTimeRange(fTraceStartTime, fTraceEndTime);
  71     private TmfTimeRange fTraceSpan      = new TmfTimeRange(fTraceStartTime, fTraceEndTime);
  72     private byte fScale = 0;
  73
  74     // Labels
  75     private static final String START_TIME_LABEL   = "Window Start Time";
  76     private static final String END_TIME_LABEL     = "Window End Time";
  77     private static final String TIME_RANGE_LABEL   = "Window Range";
  78     private static final String CURRENT_TIME_LABEL = "Current Time";
  79
  80     private static final int SLIDER_RANGE = 10000;
  81
  82     private SpinnerGroup fStartGroup;
  83     private SpinnerGroup fEndGroup;
  84     private SpinnerGroup fRangeGroup;
  85     private SpinnerGroup fCurrentGroup;
  86
  87     // The slider
  88     private Slider fSlider;
  89
  90     // The current experiment
  91     TmfExperiment<LttngEvent> fExperiment = null;
  92
  93     /**
  94      * Constructor
  95      */
  96     public TimeFrameView() {
  97         super("TimeFrameView");
  98     }
  99
 100     /* (non-Javadoc)
 101      * @see org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite)
 102      */
 103         @Override
 104         public void createPartControl(Composite parent) {
 105
 106         // Set the view layout
 107         GridLayout layout = new GridLayout(4, true);
 108         parent.setLayout(layout);
 109
 110         fStartGroup   = new SpinnerGroup(this, parent, START_TIME_LABEL,   fTraceTimeRange, fTraceStartTime);
 111         fEndGroup     = new SpinnerGroup(this, parent, END_TIME_LABEL,     fTraceTimeRange, fTraceEndTime);
 112         fRangeGroup   = new SpinnerGroup(this, parent, TIME_RANGE_LABEL,   fTraceTimeRange, fTraceEndTime);
 113         fCurrentGroup = new SpinnerGroup(this, parent, CURRENT_TIME_LABEL, fTraceTimeRange, fTraceStartTime);
 114
 115         // Create the slider
 116         createSlider(parent);
 117     }
 118
 119     /* (non-Javadoc)
 120      * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
 121      */
 122         @Override
 123         public void setFocus() {
 124         // TODO Auto-generated method stub
 125     }
 126
 127     // ========================================================================
 128     // Operators
 129     // ========================================================================
 130
 131     /**
 132      * One of the spinners has been updated. Synchronize the other widgets.
 133      */
 134     public void synchTimeFrameWidgets(SpinnerGroup trigger) {
 135
 136         // Collect the data
 137         TmfTimestamp startTime   = fStartGroup.getCurrentTime();
 138         TmfTimestamp endTime     = fEndGroup.getCurrentTime();
 139         TmfTimestamp timeRange   = fRangeGroup.getCurrentTime();
 140         TmfTimestamp currentTime = fCurrentGroup.getCurrentTime();
 141
 142         // If startTime was set beyond endTime, adjust endTime and interval
 143         if (trigger == fStartGroup) {
 144             if (startTime.compareTo(endTime, false) > 0) {
 145                 endTime = startTime;
 146             }
 147         }
 148
 149         // If endTime was set beyond startTime, adjust startTime and interval
 150         if (trigger == fEndGroup) {
 151             if (endTime.compareTo(startTime, false) < 0) {
 152                 startTime = endTime;
 153             }
 154         }
 155
 156         // If timeRange was set, adjust endTime
 157         if (trigger == fRangeGroup) {
 158             long start = startTime.getValue();
 159             long span  = timeRange.getValue();
 160             TmfTimestamp ts = new TmfTimestamp(start + span, startTime.getScale(), 0);
 161             if (ts.compareTo(fTraceEndTime, false) > 0) {
 162                 ts = fTraceEndTime.synchronize(fTraceEndTime.getValue(), startTime.getScale());
 163             }
 164             endTime = ts;
 165         }
 166
 167         // Compute the new time range
 168         TmfTimeRange subrange = new TmfTimeRange(startTime, endTime);
 169         byte scale = startTime.getScale();
 170         TmfTimestamp interval = new TmfTimestamp(startTime.getAdjustment(endTime, scale), scale, 0);
 171
 172         // Update the spinner groups
 173         fStartGroup.setContent(fTraceTimeRange, startTime);
 174         fEndGroup.setContent(fTraceTimeRange, endTime);
 175         fRangeGroup.setContent(fTraceSpan, interval);
 176         fCurrentGroup.setContent(subrange, currentTime);
 177
 178         updateSlider(subrange, currentTime);
 179
 180         // Notify other views
 181         if (!fCurrentTime.equals(currentTime)) {
 182             fCurrentTime = currentTime;
 183             broadcast(new TmfTimeSynchSignal(this, currentTime));
 184         }
 185     }
 186
 187     // ========================================================================
 188     // Slider Handling
 189     // ========================================================================
 190
 191     /**
 192      * @param parent
 193      */
 194     private void createSlider(Composite parent) {
 195         fSlider = new Slider(parent, SWT.SMOOTH | SWT.FILL);
 196         fSlider.setMinimum(0);
 197         fSlider.setMaximum(SLIDER_RANGE + fSlider.getThumb());
 198         fSlider.setIncrement(SLIDER_RANGE / 100);
 199         fSlider.setPageIncrement(SLIDER_RANGE / 10);
 200         fSlider.setSelection(0);
 201
 202         GridData gridData = new GridData(SWT.LEFT, SWT.TOP, true, false);
 203         gridData.horizontalAlignment = SWT.FILL;
 204         gridData.horizontalSpan = 4;
 205         fSlider.setLayoutData(gridData);
 206
 207         fSlider.addListener(SWT.Selection, new Listener() {
 208                 public void handleEvent(Event event) {
 209                                 int ratio = fSlider.getSelection();
 210                                 TmfTimestamp span = fCurrentGroup.getSpan();
 211                                 long value = span.getValue() * ratio / SLIDER_RANGE;
 212                                 TmfTimestamp start = fCurrentGroup.getStartTime();
 213                                 TmfTimestamp current = new TmfTimestamp(start.getValue() + value, start.getScale(), 0);
 214                                 fCurrentGroup.setValue(current);
 215                         }
 216         });
 217
 218     }
 219
 220     /**
 221      * @param range
 222      * @param timestamp
 223      */
 224     private void updateSlider(TmfTimeRange range, TmfTimestamp timestamp) {
 225
 226         // Determine the new relative position
 227         byte scale = range.getEndTime().getScale();
 228         long total    = range.getStartTime().getAdjustment(range.getEndTime(), scale);
 229         long relative = range.getStartTime().getAdjustment(timestamp, scale);
 230
 231         // Set the slider value
 232         final long position = (total > 0) ? (relative * SLIDER_RANGE / total) : 0;
 233
 234         // Update the slider on the UI thread
 235         long current = fSlider.getSelection();
 236         if (position != current) {
 237                 fSlider.getDisplay().asyncExec(new Runnable() {
 238                         public void run() {
 239                                 fSlider.setSelection((int) position);
 240                         }
 241                 });
 242         }
 243     }
 244
 245         /* (non-Javadoc)
 246          * @see java.lang.Object#toString()
 247          */
 248         @Override
 249         public String toString() {
 250                 return "[TimeFrameView]";
 251         }
 252
 253     // ========================================================================
 254     // TMF Signal Handling
 255     // ========================================================================
 256
 257         /**
 258      * @param signal
 259      */
 260     @SuppressWarnings("unchecked")
 261     @TmfSignalHandler
 262     public void experimentSelected(TmfExperimentSelectedSignal<LttngEvent> signal) {
 263
 264         // Update the trace reference
 265         fExperiment = (TmfExperiment<LttngEvent>) signal.getExperiment();
 266
 267         // Update the time frame
 268         fTraceTimeRange = fExperiment.getTimeRange();
 269         fTraceStartTime = fTraceTimeRange.getStartTime();
 270         fTraceEndTime   = fTraceTimeRange.getEndTime();
 271         fScale          = fTraceStartTime.getScale();
 272
 273         // Update the widgets
 274         fStartGroup.setContent(fTraceTimeRange, fTraceStartTime);
 275         fEndGroup.setContent(fTraceTimeRange, fTraceEndTime);
 276         fCurrentGroup.setContent(fTraceTimeRange, fTraceStartTime);
 277
 278         fCurrentTime = fTraceStartTime;
 279
 280         TmfTimestamp delta = new TmfTimestamp(fTraceStartTime.getAdjustment(fTraceEndTime, fScale), fScale, 0);
 281         fTraceSpan = new TmfTimeRange(new TmfTimestamp(0, fScale, 0), delta);
 282 //        fRangeGroup.setContent(fTraceSpan, delta);
 283         TmfTimestamp start = new TmfTimestamp(1, (byte) -1, 0);
 284         fRangeGroup.setContent(fTraceSpan, start);
 285     }
 286
 287     /**
 288      * @param signal
 289      */
 290     @TmfSignalHandler
 291     public void experimentUpdated(TmfExperimentUpdatedSignal signal) {
 292
 293         // Update the time frame
 294         fTraceTimeRange = signal.getTrace().getTimeRange();
 295         fTraceStartTime = fTraceTimeRange.getStartTime();
 296         fTraceEndTime   = fTraceTimeRange.getEndTime();
 297         fScale          = fTraceStartTime.getScale();
 298
 299         // Update the widgets
 300         fStartGroup.setContent(fTraceTimeRange, fStartGroup.getCurrentTime());
 301         fEndGroup.setContent(fTraceTimeRange, fTraceEndTime);
 302         fCurrentGroup.setContent(fTraceTimeRange, fCurrentGroup.getCurrentTime());
 303
 304         TmfTimestamp delta = new TmfTimestamp(fTraceStartTime.getAdjustment(fTraceEndTime, fScale), fScale, 0);
 305         fTraceSpan = new TmfTimeRange(new TmfTimestamp(0, fScale, 0), delta);
 306         fRangeGroup.setContent(fTraceSpan, delta);
 307     }
 308
 309     /**
 310      * @param signal
 311      */
 312     @TmfSignalHandler
 313     public void currentTimeUpdated(TmfTimeSynchSignal signal) {
 314         if (signal.getSource() != this) {
 315             fCurrentTime = signal.getCurrentTime().synchronize(0, fStartGroup.getCurrentTime().getScale());
 316             if (fStartGroup.getCurrentTime().compareTo(fCurrentTime, false) > 0) {
 317                 fStartGroup.setContent(new TmfTimeRange(fCurrentTime, fEndGroup.getCurrentTime()), fCurrentTime);
 318             }
 319             if (fEndGroup.getCurrentTime().compareTo(fCurrentTime, false) < 0) {
 320                 fEndGroup.setContent(new TmfTimeRange(fStartGroup.getCurrentTime(), fCurrentTime), fCurrentTime);
 321             }
 322             fCurrentGroup.setContent(null, fCurrentTime);
 323             updateSlider(fCurrentGroup.getTimeRange(), fCurrentTime);
 324         }
 325     }
 326
 327 }