SharpDevelop/src/AddIns/Analysis/Profiler/Frontend/Controls/TimeLineControl.cs

// Copyright (c) AlphaSierraPapa for the SharpDevelop Team (for details please see \doc\copyright.txt)
// This code is distributed under the GNU LGPL (for details please see \doc\license.txt)

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Globalization;
using System.Linq;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Threading;

using ICSharpCode.Profiler.Controller.Data;

namespace ICSharpCode.Profiler.Controls
{
	public class TimeLineSegment {
		public float Value { get; set; }
		public bool DisplayMarker { get; set; }
		public EventDataEntry[] Events { get; set; }
	}
	
	public class TimeLineControl : FrameworkElement
	{
		ObservableCollection<TimeLineSegment> valuesList;
		int selectedStartIndex, selectedEndIndex;
		double pieceWidth;

		public event EventHandler<RangeEventArgs> RangeChanged;

		protected virtual void OnRangeChanged(RangeEventArgs e)
		{
			if (RangeChanged != null)
			{
				RangeChanged(this, e);
			}
		}
		
		public int SelectedPerformanceCounter { get; set; }
		
		public float MaxValue { get; set; }

		public string Unit { get; set; }
		
		public string Format { get; set; }
		
		public ProfilingDataProvider Provider { get; set; }
		
		public int SelectedEndIndex
		{
			get { return selectedEndIndex; }
			set {
				selectedEndIndex = value;
				InvalidateMeasure();
				InvalidateVisual();
				OnRangeChanged(new RangeEventArgs(selectedStartIndex, selectedEndIndex));
			}
		}

		public int SelectedStartIndex
		{
			get { return selectedStartIndex; }
			set {
				selectedStartIndex = value;
				InvalidateMeasure();
				InvalidateVisual();
				OnRangeChanged(new RangeEventArgs(selectedStartIndex, selectedEndIndex));
			}
		}

		public ObservableCollection<TimeLineSegment> ValuesList
		{
			get { return valuesList; }
		}

		public TimeLineControl()
		{
			this.valuesList = new ObservableCollection<TimeLineSegment>();
			this.valuesList.CollectionChanged += delegate { this.InvalidateMeasure(); this.InvalidateVisual(); };
		}

		protected override Size MeasureOverride(Size availableSize)
		{
			pieceWidth = 25;
			Size calculatedSize = base.MeasureOverride(availableSize);
			return new Size(Math.Max(pieceWidth * valuesList.Count + 1, calculatedSize.Width), calculatedSize.Height + 10);
		}
		
		const int offset = 0;
		const int offsetFromTop = 40;
		
		protected override void OnRender(DrawingContext drawingContext)
		{
			base.OnRender(drawingContext);

			if (valuesList.Count == 0)
				return;
			
			double oldX = offsetFromTop, oldY = RenderSize.Height;

			StreamGeometry geometry = new StreamGeometry();

			using (StreamGeometryContext ctx = geometry.Open())
			{
				ctx.BeginFigure(new Point(0, RenderSize.Height), true, true);

				List<Point> points = new List<Point>();
				
				double maxHeight = RenderSize.Height - offsetFromTop;

				for (int i = 0; i < valuesList.Count; i++)
				{
					double x = pieceWidth / 2.0 + pieceWidth * i;
					// TODO : support MinValues other than 0
					double y = offsetFromTop + (maxHeight - maxHeight * (valuesList[i].Value / MaxValue));

					points.Add(new Point(x, y));

					oldX = x;
					oldY = y;
				}

				points.Add(new Point(oldX, offsetFromTop + RenderSize.Height));

				ctx.PolyLineTo(points, true, true);
			}

			geometry.Freeze();

			Brush b = new LinearGradientBrush(Colors.Red, Colors.Orange, 90);

			drawingContext.DrawRectangle(Brushes.White, new Pen(Brushes.White, 1), new Rect(new Point(0, 0), RenderSize));
			
			var p = new Pen(Brushes.DarkRed, 2);
			
			drawingContext.DrawGeometry(b, new Pen(b, 1), geometry);
			
			DateTime time = new DateTime(1,1,1,0,0,0,0);
			
			for (int i = 0; i < valuesList.Count; i++) {
				if (valuesList[i].DisplayMarker)
					drawingContext.DrawLine(p, new Point(pieceWidth * i, offsetFromTop),
					                        new Point(pieceWidth * i, RenderSize.Height));
				
				if (i % 3 == 0) {
					FormattedText textFormat = new FormattedText(
						time.ToString("mm:ss.fff"),
						CultureInfo.CurrentCulture, FlowDirection.LeftToRight,
						new Typeface("Segoe UI"), 12, Brushes.Black
					);
					
					drawingContext.DrawText(textFormat, new Point(pieceWidth * i, 0));
				}
				
				var events = valuesList[i].Events;
				
				if (events != null && events.Length > 0) {
					foreach (EventDataEntry @event in events) {
						drawingContext.DrawRectangle(
							Brushes.Red,
							new Pen(Brushes.Red, 1),
							new Rect(
								new Point(@event.DataSetId * pieceWidth, 25),
								new Point(@event.DataSetId * pieceWidth + pieceWidth, 35)
							)
						);
					}
				}
				
				time = time.AddMilliseconds(500);
			}
			
			drawingContext.DrawRectangle(
				new SolidColorBrush(Color.FromArgb(64, Colors.Blue.R, Colors.Blue.G, Colors.Blue.B)),
				new Pen(Brushes.Blue, 1),
				new Rect(
					new Point(Math.Min(selectedStartIndex, selectedEndIndex) * pieceWidth + offset, offsetFromTop),
					new Point(Math.Max(selectedStartIndex, selectedEndIndex) * pieceWidth + offset + pieceWidth, RenderSize.Height)
				)
			);
		}

		protected override void OnMouseUp(MouseButtonEventArgs e)
		{
			bool valid;
			Point pos = e.GetPosition(this);
			int index = TransformToIndex(pos, out valid);
			
			if (pos.Y >= 40) {
				if (index < selectedStartIndex) {
					selectedEndIndex = selectedStartIndex;
					selectedStartIndex = index;
				} else
					selectedEndIndex = index;
			}
						
			InvalidateMeasure();
			InvalidateVisual();
			ReleaseMouseCapture();
		}

		protected override void OnMouseDown(MouseButtonEventArgs e)
		{
			CaptureMouse();
			Point pos = e.GetPosition(this);
			bool valid;
			int index = TransformToIndex(pos, out valid);
			
			if (pos.Y >= 40)
				selectedStartIndex = selectedEndIndex = index;
			
			InvalidateMeasure();
			InvalidateVisual();
		}

		ToolTip tooltip;
		
		void HandleMovement(MouseEventArgs e)
		{
			bool valid;
			Point pos = e.GetPosition(this);
			int index = TransformToIndex(pos, out valid);
			
			if (e.LeftButton == MouseButtonState.Pressed) {
				selectedEndIndex = index;
				InvalidateMeasure();
				InvalidateVisual();
			} else if (tooltip == null && valid) {
				tooltip = new ToolTip();
				if (pos.Y < 20)
					tooltip.Content = "Time: " + new DateTime(0).AddMilliseconds(index * 500).ToString("mm:ss.fff");
				else if (pos.Y < 40)
					tooltip.Content = CreateTooltipForEvents(index);
				else
					tooltip.Content = "Value: " + valuesList[index].Value.ToString(Format) + " " + Unit;
				tooltip	.IsOpen = tooltip.Content != null;
			}
		}
		
		object CreateTooltipForEvents(int index)
		{
			EventDataEntry[] events = ValuesList[index].Events;
			
			TextBlock block = events.Any() ? new TextBlock() : null;
			
			foreach (var e in events) {
				if (block.Inlines.Any())
					block.Inlines.Add(new LineBreak());
				
				NameMapping mapping = Provider.GetMapping(e.NameId);
				string fullSignature = mapping.ReturnType + " " + mapping.Name + "(" + string.Join(", ", mapping.Parameters) + ")";
				block.Inlines.Add(new Bold { Inlines = { fullSignature } });
				
				
				switch (e.Type) {
					case EventType.Console:
						break;
					case EventType.WindowsForms:
						string target = e.Data.Substring(0, e.Data.IndexOf(':'));
						string text = e.Data.Substring(e.Data.IndexOf(':') + 1);
						block.Inlines.Add(new LineBreak());
						block.Inlines.Add(new Bold { Inlines = { "Source: " } });
						block.Inlines.Add(target);
						block.Inlines.Add(new LineBreak());
						block.Inlines.Add(new Bold { Inlines = { "Text: " } });
						block.Inlines.Add(text);
						break;
					case EventType.Exception:
					case EventType.WindowsPresentationFoundation:
						break;
				}
			}
			
			return block;
		}

		protected override void OnLostMouseCapture(MouseEventArgs e)
		{
			base.OnLostMouseCapture(e);
			OnRangeChanged(new RangeEventArgs(selectedStartIndex, selectedEndIndex));
		}

		int TransformToIndex(Point point, out bool valid)
		{
			int value = (int)Math.Floor(point.X / pieceWidth);
			valid = (0 >= value && value <= valuesList.Count - 1);
			return Math.Min(Math.Max(0, value), valuesList.Count - 1);
		}
		
		#region MouseHover
		/// <summary>
		/// The MouseHover event.
		/// </summary>
		public static readonly RoutedEvent MouseHoverEvent =
			EventManager.RegisterRoutedEvent("MouseHover", RoutingStrategy.Bubble,
			                                 typeof(MouseEventHandler), typeof(TimeLineControl));
		
		/// <summary>
		/// The MouseHoverStopped event.
		/// </summary>
		public static readonly RoutedEvent MouseHoverStoppedEvent =
			EventManager.RegisterRoutedEvent("MouseHoverStopped", RoutingStrategy.Bubble,
			                                 typeof(MouseEventHandler), typeof(TimeLineControl));
		
		/// <summary>
		/// Occurs when the mouse has hovered over a fixed location for some time.
		/// </summary>
		public event MouseEventHandler MouseHover {
			add { AddHandler(MouseHoverEvent, value); }
			remove { RemoveHandler(MouseHoverEvent, value); }
		}
		
		/// <summary>
		/// Occurs when the mouse had previously hovered but now started moving again.
		/// </summary>
		public event MouseEventHandler MouseHoverStopped {
			add { AddHandler(MouseHoverStoppedEvent, value); }
			remove { RemoveHandler(MouseHoverStoppedEvent, value); }
		}
		
		DispatcherTimer mouseHoverTimer;
		Point mouseHoverStartPoint;
		MouseEventArgs mouseHoverLastEventArgs;
		
		/// <inheritdoc/>
		protected override void OnMouseMove(MouseEventArgs e)
		{
			base.OnMouseMove(e);
			Point newPosition = e.GetPosition(this);
			Vector mouseMovement = mouseHoverStartPoint - newPosition;
			if (Math.Abs(mouseMovement.X) > SystemParameters.MouseHoverWidth
			    || Math.Abs(mouseMovement.Y) > SystemParameters.MouseHoverHeight)
			{
				StopHovering();
				mouseHoverStartPoint = newPosition;
				mouseHoverLastEventArgs = e;
				mouseHoverTimer = new DispatcherTimer(SystemParameters.MouseHoverTime, DispatcherPriority.Background,
				                                      OnMouseHoverTimerElapsed, Dispatcher);
				mouseHoverTimer.Start();
			}
			
			HandleMovement(e);
			// do not set e.Handled - allow others to also handle MouseMove
		}
		
		/// <inheritdoc/>
		protected override void OnMouseLeave(MouseEventArgs e)
		{
			base.OnMouseLeave(e);
			StopHovering();
			// do not set e.Handled - allow others to also handle MouseLeave
		}
		
		void StopHovering()
		{
			if (mouseHoverTimer != null) {
				mouseHoverTimer.Stop();
				mouseHoverTimer = null;
			}
			
			if (tooltip != null) {
				tooltip.IsOpen = false;
				tooltip = null;
			}
		}
		
		void OnMouseHoverTimerElapsed(object sender, EventArgs e)
		{
			mouseHoverTimer.Stop();
			mouseHoverTimer = null;
		}
		#endregion
	}
}