1 /*******************************************************************************
2 * Copyright (c) 2011, 2012 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 * Francois Chouinard - Initial API and implementation
11 * Bernd Hufmann - Changed to updated histogram data model
12 * Francois Chouinard - Initial API and implementation
13 *******************************************************************************/
15 package org
.eclipse
.linuxtools
.tmf
.ui
.views
.histogram
;
17 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.TmfView
;
18 import org
.eclipse
.swt
.SWT
;
19 import org
.eclipse
.swt
.events
.ControlEvent
;
20 import org
.eclipse
.swt
.events
.ControlListener
;
21 import org
.eclipse
.swt
.events
.KeyEvent
;
22 import org
.eclipse
.swt
.events
.KeyListener
;
23 import org
.eclipse
.swt
.events
.MouseEvent
;
24 import org
.eclipse
.swt
.events
.MouseListener
;
25 import org
.eclipse
.swt
.events
.MouseTrackListener
;
26 import org
.eclipse
.swt
.events
.PaintEvent
;
27 import org
.eclipse
.swt
.events
.PaintListener
;
28 import org
.eclipse
.swt
.graphics
.Color
;
29 import org
.eclipse
.swt
.graphics
.Font
;
30 import org
.eclipse
.swt
.graphics
.FontData
;
31 import org
.eclipse
.swt
.graphics
.GC
;
32 import org
.eclipse
.swt
.graphics
.Image
;
33 import org
.eclipse
.swt
.layout
.GridData
;
34 import org
.eclipse
.swt
.layout
.GridLayout
;
35 import org
.eclipse
.swt
.widgets
.Canvas
;
36 import org
.eclipse
.swt
.widgets
.Composite
;
37 import org
.eclipse
.swt
.widgets
.Display
;
38 import org
.eclipse
.swt
.widgets
.Text
;
41 * <b><u>Histogram</u></b>
43 * Re-usable histogram widget with the following features:
45 * <li>Y-axis labels displaying min/max count values
46 * <li>X-axis labels displaying time range
47 * <li>a histogram displaying the distribution of values over time (note that
48 * the histogram might not necessarily fill the whole canvas)
50 * The widget also has 2 'markers' to identify:
52 * <li>a red dashed line over the bar that contains the currently selected event
53 * <li>a dark red dashed line that delimits the right end of the histogram (if
54 * it doesn't fill the canvas)
56 * Clicking on the histogram will select the current event at the mouse
59 * Once the histogram is selected, there is some limited keyboard support:
61 * <li>Home: go to the first histogram bar
62 * <li>End: go to the last histogram bar
63 * <li>Left: go to the previous histogram
64 * <li>Right: go to the next histogram bar
66 * Finally, when the mouse hovers over the histogram, a tool tip showing the
67 * following information about the corresponding histogram bar time range:
69 * <li>start of the time range
70 * <li>end of the time range
71 * <li>number of events in that time range
74 public abstract class Histogram
implements ControlListener
, PaintListener
, KeyListener
, MouseListener
, MouseTrackListener
, IHistogramModelListener
{
76 // ------------------------------------------------------------------------
78 // ------------------------------------------------------------------------
81 private final Color fBackgroundColor
= Display
.getCurrent().getSystemColor(SWT
.COLOR_WHITE
);
82 private final Color fCurrentEventColor
= Display
.getCurrent().getSystemColor(SWT
.COLOR_RED
);
83 private final Color fLastEventColor
= Display
.getCurrent().getSystemColor(SWT
.COLOR_DARK_RED
);
84 private final Color fHistoBarColor
= new Color(Display
.getDefault(), 74, 112, 139);
86 // Timestamp scale (nanosecond)
87 public static final byte TIME_SCALE
= -9;
89 public static final int HISTOGRAM_BAR_WIDTH
= 1;
91 // ------------------------------------------------------------------------
93 // ------------------------------------------------------------------------
96 protected TmfView fParentView
;
98 // Histogram text fields
99 private Text fMaxNbEventsText
;
100 private Text fMinNbEventsText
;
101 private Text fTimeRangeStartText
;
102 private Text fTimeRangeEndText
;
104 // Histogram drawing area
105 protected Canvas fCanvas
;
108 protected final HistogramDataModel fDataModel
;
109 protected HistogramScaledData fScaledData
;
111 protected long fCurrentEventTime
= 0;
113 // ------------------------------------------------------------------------
115 // ------------------------------------------------------------------------
117 public Histogram(TmfView view
, Composite parent
) {
120 createWidget(parent
);
121 fDataModel
= new HistogramDataModel();
122 fDataModel
.addHistogramListener(this);
125 fCanvas
.addControlListener(this);
126 fCanvas
.addPaintListener(this);
127 fCanvas
.addKeyListener(this);
128 fCanvas
.addMouseListener(this);
129 fCanvas
.addMouseTrackListener(this);
132 public void dispose() {
133 fHistoBarColor
.dispose();
134 fDataModel
.removeHistogramListener(this);
137 private void createWidget(Composite parent
) {
139 final Color labelColor
= parent
.getBackground();
140 final Font fFont
= adjustFont(parent
);
142 final int initalWidth
= 10;
144 // --------------------------------------------------------------------
145 // Define the histogram
146 // --------------------------------------------------------------------
148 GridLayout gridLayout
= new GridLayout();
149 gridLayout
.numColumns
= 3;
150 gridLayout
.marginHeight
= 0;
151 gridLayout
.marginWidth
= 0;
152 gridLayout
.marginTop
= 0;
153 gridLayout
.horizontalSpacing
= 0;
154 gridLayout
.verticalSpacing
= 0;
155 gridLayout
.marginLeft
= 0;
156 gridLayout
.marginRight
= 0;
157 Composite composite
= new Composite(parent
, SWT
.FILL
);
158 composite
.setLayout(gridLayout
);
160 // Use all the horizontal space
161 GridData gridData
= new GridData();
162 gridData
.horizontalAlignment
= SWT
.FILL
;
163 gridData
.verticalAlignment
= SWT
.FILL
;
164 gridData
.grabExcessHorizontalSpace
= true;
165 composite
.setLayoutData(gridData
);
168 gridData
= new GridData();
169 gridData
.horizontalAlignment
= SWT
.RIGHT
;
170 gridData
.verticalAlignment
= SWT
.TOP
;
171 fMaxNbEventsText
= new Text(composite
, SWT
.READ_ONLY
| SWT
.RIGHT
);
172 fMaxNbEventsText
.setFont(fFont
);
173 fMaxNbEventsText
.setBackground(labelColor
);
174 fMaxNbEventsText
.setEditable(false);
175 fMaxNbEventsText
.setText("0"); //$NON-NLS-1$
176 fMaxNbEventsText
.setLayoutData(gridData
);
179 gridData
= new GridData();
180 gridData
.horizontalSpan
= 2;
181 gridData
.verticalSpan
= 2;
182 gridData
.horizontalAlignment
= SWT
.FILL
;
183 gridData
.verticalAlignment
= SWT
.FILL
;
184 gridData
.grabExcessHorizontalSpace
= true;
185 fCanvas
= new Canvas(composite
, SWT
.BORDER
| SWT
.DOUBLE_BUFFERED
);
186 fCanvas
.setLayoutData(gridData
);
188 // Y-axis min event (always 0...)
189 gridData
= new GridData();
190 gridData
.horizontalAlignment
= SWT
.RIGHT
;
191 gridData
.verticalAlignment
= SWT
.BOTTOM
;
192 fMinNbEventsText
= new Text(composite
, SWT
.READ_ONLY
| SWT
.RIGHT
);
193 fMinNbEventsText
.setFont(fFont
);
194 fMinNbEventsText
.setBackground(labelColor
);
195 fMinNbEventsText
.setEditable(false);
196 fMinNbEventsText
.setText("0"); //$NON-NLS-1$
197 fMinNbEventsText
.setLayoutData(gridData
);
200 gridData
= new GridData(initalWidth
, SWT
.DEFAULT
);
201 gridData
.horizontalAlignment
= SWT
.RIGHT
;
202 gridData
.verticalAlignment
= SWT
.BOTTOM
;
203 Text dummyText
= new Text(composite
, SWT
.READ_ONLY
);
204 dummyText
.setFont(fFont
);
205 dummyText
.setBackground(labelColor
);
206 dummyText
.setEditable(false);
207 dummyText
.setText(""); //$NON-NLS-1$
208 dummyText
.setLayoutData(gridData
);
210 // Window range start time
211 gridData
= new GridData();
212 gridData
.horizontalAlignment
= SWT
.LEFT
;
213 gridData
.verticalAlignment
= SWT
.BOTTOM
;
214 fTimeRangeStartText
= new Text(composite
, SWT
.READ_ONLY
);
215 fTimeRangeStartText
.setFont(fFont
);
216 fTimeRangeStartText
.setBackground(labelColor
);
217 fTimeRangeStartText
.setText(HistogramUtils
.nanosecondsToString(0));
218 fTimeRangeStartText
.setLayoutData(gridData
);
220 // Window range end time
221 gridData
= new GridData();
222 gridData
.horizontalAlignment
= SWT
.RIGHT
;
223 gridData
.verticalAlignment
= SWT
.BOTTOM
;
224 fTimeRangeEndText
= new Text(composite
, SWT
.READ_ONLY
);
225 fTimeRangeEndText
.setFont(fFont
);
226 fTimeRangeEndText
.setBackground(labelColor
);
227 fTimeRangeEndText
.setText(HistogramUtils
.nanosecondsToString(0));
228 fTimeRangeEndText
.setLayoutData(gridData
);
231 private Font
adjustFont(Composite composite
) {
232 // Reduce font size for a more pleasing rendering
233 int fontSizeAdjustment
= -2;
234 Font font
= composite
.getFont();
235 FontData fontData
= font
.getFontData()[0];
236 return new Font(font
.getDevice(), fontData
.getName(), fontData
.getHeight() + fontSizeAdjustment
, fontData
.getStyle());
239 // ------------------------------------------------------------------------
241 // ------------------------------------------------------------------------
243 public long getStartTime() {
244 return fDataModel
.getFirstBucketTime();
247 public long getEndTime() {
248 return fDataModel
.getEndTime();
251 public long getTimeLimit() {
252 return fDataModel
.getTimeLimit();
255 public HistogramDataModel
getDataModel() {
259 // ------------------------------------------------------------------------
261 // ------------------------------------------------------------------------
263 public abstract void updateTimeRange(long startTime
, long endTime
);
266 * Clear the histogram and reset the data
268 public void clear() {
274 * Increase the histogram bucket corresponding to [timestamp]
278 public void countEvent(long eventCount
, long timestamp
) {
279 fDataModel
.countEvent(eventCount
, timestamp
);
283 * Sets the current event time and refresh the display
287 public void setCurrentEvent(long timestamp
) {
288 fCurrentEventTime
= (timestamp
> 0) ? timestamp
: 0;
289 fDataModel
.setCurrentEventNotifyListeners(timestamp
);
293 * Computes the timestamp of the bucket at [offset]
295 * @param offset offset from the left on the histogram
296 * @return the start timestamp of the corresponding bucket
298 public synchronized long getTimestamp(int offset
) {
299 assert offset
> 0 && offset
< fScaledData
.fWidth
;
301 return fDataModel
.getFirstBucketTime() + fScaledData
.fBucketDuration
* offset
;
302 } catch (Exception e
) {
303 return 0; // TODO: Fix that racing condition (NPE)
308 * Computes the offset of the timestamp in the histogram
310 * @param timestamp the timestamp
311 * @return the offset of the corresponding bucket (-1 if invalid)
313 public synchronized int getOffset(long timestamp
) {
314 if (timestamp
< fDataModel
.getFirstBucketTime() || timestamp
> fDataModel
.getEndTime())
316 return (int) ((timestamp
- fDataModel
.getFirstBucketTime()) / fScaledData
.fBucketDuration
);
320 * Move the currently selected bar cursor to a non-empty bucket.
322 * @param keyCode the SWT key code
324 protected void moveCursor(int keyCode
) {
326 if (fScaledData
.fCurrentBucket
== HistogramScaledData
.OUT_OF_RANGE_BUCKET
)
334 while (index
< fScaledData
.fLastBucket
&& fScaledData
.fData
[index
] == 0)
336 if (index
< fScaledData
.fLastBucket
)
337 fScaledData
.fCurrentBucket
= index
;
340 case SWT
.ARROW_RIGHT
:
341 index
= fScaledData
.fCurrentBucket
+ 1;
342 while (index
< fScaledData
.fWidth
&& fScaledData
.fData
[index
] == 0)
344 if (index
< fScaledData
.fLastBucket
)
345 fScaledData
.fCurrentBucket
= index
;
349 index
= fScaledData
.fLastBucket
;
350 while (index
>= 0 && fScaledData
.fData
[index
] == 0)
353 fScaledData
.fCurrentBucket
= index
;
357 index
= fScaledData
.fCurrentBucket
- 1;
358 while (index
>= 0 && fScaledData
.fData
[index
] == 0)
361 fScaledData
.fCurrentBucket
= index
;
368 updateCurrentEventTime();
372 * Refresh the histogram display
375 public void modelUpdated() {
376 if (!fCanvas
.isDisposed() && fCanvas
.getDisplay() != null) {
377 fCanvas
.getDisplay().asyncExec(new Runnable() {
380 if (!fCanvas
.isDisposed()) {
381 // Retrieve and normalize the data
382 int canvasWidth
= fCanvas
.getBounds().width
;
383 int canvasHeight
= fCanvas
.getBounds().height
;
384 if (canvasWidth
<= 0 || canvasHeight
<= 0)
386 fDataModel
.setCurrentEvent(fCurrentEventTime
);
387 fScaledData
= fDataModel
.scaleTo(canvasWidth
, canvasHeight
, HISTOGRAM_BAR_WIDTH
);
389 // Display histogram and update X-,Y-axis labels
390 fTimeRangeStartText
.setText(HistogramUtils
.nanosecondsToString(fDataModel
.getFirstBucketTime()));
391 fTimeRangeEndText
.setText(HistogramUtils
.nanosecondsToString(fDataModel
.getEndTime()));
392 fMaxNbEventsText
.setText(Long
.toString(fScaledData
.fMaxValue
));
393 // The Y-axis area might need to be re-sized
394 fMaxNbEventsText
.getParent().layout();
401 // ------------------------------------------------------------------------
403 // ------------------------------------------------------------------------
405 private void updateCurrentEventTime() {
406 long bucketStartTime
= getTimestamp(fScaledData
.fCurrentBucket
);
407 ((HistogramView
) fParentView
).updateCurrentEventTime(bucketStartTime
);
410 // ------------------------------------------------------------------------
412 // ------------------------------------------------------------------------
414 protected final String IMAGE_KEY
= "double-buffer-image"; //$NON-NLS-1$
417 public void paintControl(PaintEvent event
) {
420 int canvasWidth
= fCanvas
.getBounds().width
;
421 int canvasHeight
= fCanvas
.getBounds().height
;
423 // Make sure we have something to draw upon
424 if (canvasWidth
<= 0 || canvasHeight
<= 0)
427 // Retrieve image; re-create only if necessary
428 Image image
= (Image
) fCanvas
.getData(IMAGE_KEY
);
429 if (image
== null || image
.getBounds().width
!= canvasWidth
|| image
.getBounds().height
!= canvasHeight
) {
430 image
= new Image(event
.display
, canvasWidth
, canvasHeight
);
431 fCanvas
.setData(IMAGE_KEY
, image
);
434 // Draw the histogram on its canvas
435 GC imageGC
= new GC(image
);
436 formatImage(imageGC
, image
);
437 event
.gc
.drawImage(image
, 0, 0);
441 private void formatImage(GC imageGC
, Image image
) {
443 if (fScaledData
== null)
446 HistogramScaledData scaledData
= new HistogramScaledData(fScaledData
);
449 // Get drawing boundaries
450 int width
= image
.getBounds().width
;
451 int height
= image
.getBounds().height
;
453 // Clear the drawing area
454 imageGC
.setBackground(fBackgroundColor
);
455 imageGC
.fillRectangle(0, 0, image
.getBounds().width
+ 1, image
.getBounds().height
+ 1);
457 // Draw the histogram bars
458 imageGC
.setBackground(fHistoBarColor
);
459 int limit
= width
< scaledData
.fWidth ? width
: scaledData
.fWidth
;
460 for (int i
= 1; i
< limit
; i
++) {
461 int value
= (int) (scaledData
.fData
[i
] * scaledData
.fScalingFactor
);
462 imageGC
.fillRectangle(i
, height
- value
, 1, value
);
465 // Draw the current event bar
466 int currentBucket
= scaledData
.fCurrentBucket
;
467 if (currentBucket
>= 0 && currentBucket
< limit
) {
468 drawDelimiter(imageGC
, fCurrentEventColor
, height
, currentBucket
);
471 // Add a dashed line as a delimiter (at the right of the last bar)
472 int lastEventIndex
= limit
- 1;
473 while (lastEventIndex
>= 0 && scaledData
.fData
[lastEventIndex
] == 0)
475 lastEventIndex
+= (lastEventIndex
< limit
- 1) ?
1 : 0;
476 drawDelimiter(imageGC
, fLastEventColor
, height
, lastEventIndex
);
477 } catch (Exception e
) {
482 private void drawDelimiter(GC imageGC
, Color color
, int height
, int index
) {
483 imageGC
.setBackground(color
);
484 int dash
= height
/ 4;
485 imageGC
.fillRectangle(index
, 0 * dash
, 1, dash
- 1);
486 imageGC
.fillRectangle(index
, 1 * dash
, 1, dash
- 1);
487 imageGC
.fillRectangle(index
, 2 * dash
, 1, dash
- 1);
488 imageGC
.fillRectangle(index
, 3 * dash
, 1, height
- 3 * dash
);
491 // ------------------------------------------------------------------------
493 // ------------------------------------------------------------------------
496 public void keyPressed(KeyEvent event
) {
497 moveCursor(event
.keyCode
);
501 public void keyReleased(KeyEvent event
) {
504 // ------------------------------------------------------------------------
506 // ------------------------------------------------------------------------
509 public void mouseDoubleClick(MouseEvent event
) {
513 public void mouseDown(MouseEvent event
) {
514 if (fDataModel
.getNbEvents() > 0 && fScaledData
.fLastBucket
>= event
.x
) {
515 fScaledData
.fCurrentBucket
= event
.x
;
516 updateCurrentEventTime();
521 public void mouseUp(MouseEvent event
) {
524 // ------------------------------------------------------------------------
525 // MouseTrackListener
526 // ------------------------------------------------------------------------
529 public void mouseEnter(MouseEvent event
) {
533 public void mouseExit(MouseEvent event
) {
537 public void mouseHover(MouseEvent event
) {
538 if (fDataModel
.getNbEvents() > 0 && fScaledData
!= null && fScaledData
.fLastBucket
>= event
.x
) {
539 String tooltip
= formatToolTipLabel(event
.x
);
540 fCanvas
.setToolTipText(tooltip
);
544 private String
formatToolTipLabel(int index
) {
545 long startTime
= fScaledData
.getBucketStartTime(fScaledData
.fCurrentBucket
);
546 // negative values are possible if time values came into the model in decreasing order
550 long endTime
= fScaledData
.getBucketEndTime(fScaledData
.fCurrentBucket
);
551 int nbEvents
= (index
>= 0) ? fScaledData
.fData
[index
] : 0;
553 StringBuffer buffer
= new StringBuffer();
554 buffer
.append("Range = ["); //$NON-NLS-1$
555 buffer
.append(HistogramUtils
.nanosecondsToString(startTime
));
556 buffer
.append(","); //$NON-NLS-1$
557 buffer
.append(HistogramUtils
.nanosecondsToString(endTime
));
558 buffer
.append(")\n"); //$NON-NLS-1$
559 buffer
.append("Event count = "); //$NON-NLS-1$
560 buffer
.append(nbEvents
);
561 return buffer
.toString();
564 // ------------------------------------------------------------------------
566 // ------------------------------------------------------------------------
569 public void controlMoved(ControlEvent event
) {
570 fDataModel
.complete();
574 public void controlResized(ControlEvent event
) {
575 fDataModel
.complete();