ILSpy/Debugger/ILSpy.Debugger/AvalonEdit/IconBarMargin.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.ComponentModel.Composition;
using System.Linq;
using System.Windows;
using System.Windows.Input;
using System.Windows.Media;

using ICSharpCode.AvalonEdit.Editing;
using ICSharpCode.AvalonEdit.Rendering;
using ICSharpCode.AvalonEdit.Utils;
using ICSharpCode.Decompiler;
using ICSharpCode.ILSpy.Debugger.Bookmarks;
using ICSharpCode.ILSpy.Debugger.Services;
using ICSharpCode.NRefactory.CSharp;
using Mono.Cecil;

namespace ICSharpCode.ILSpy.Debugger.AvalonEdit
{
	[Export("IconMargin"), PartCreationPolicy(CreationPolicy.Shared)]
	public class IconBarMargin : AbstractMargin, IDisposable
	{
		public IconBarMargin()
		{
			BookmarkManager.Added += delegate { InvalidateVisual(); };
			BookmarkManager.Removed += delegate { InvalidateVisual(); };
		}
		
		public virtual void Dispose()
		{
			this.TextView = null; // detach from TextView (will also detach from manager)
		}
		
		/// <inheritdoc/>
		protected override HitTestResult HitTestCore(PointHitTestParameters hitTestParameters)
		{
			// accept clicks even when clicking on the background
			return new PointHitTestResult(this, hitTestParameters.HitPoint);
		}
		
		/// <inheritdoc/>
		protected override Size MeasureOverride(Size availableSize)
		{
			return new Size(18, 0);
		}
		
		protected override void OnRender(DrawingContext drawingContext)
		{
			Size renderSize = this.RenderSize;
			drawingContext.DrawRectangle(SystemColors.ControlBrush, null,
			                             new Rect(0, 0, renderSize.Width, renderSize.Height));
			drawingContext.DrawLine(new Pen(SystemColors.ControlDarkBrush, 1),
			                        new Point(renderSize.Width - 0.5, 0),
			                        new Point(renderSize.Width - 0.5, renderSize.Height));
			
			TextView textView = this.TextView;
			if (textView != null && textView.VisualLinesValid) {
				// create a dictionary line number => first bookmark
				Dictionary<int, BookmarkBase> bookmarkDict = new Dictionary<int, BookmarkBase>();
				foreach (var bm in BookmarkManager.Bookmarks) {
					if (DebugData.DecompiledMemberReferences == null || DebugData.DecompiledMemberReferences.Count == 0 ||
					    !DebugData.DecompiledMemberReferences.ContainsKey(bm.MemberReference.FullName))
						continue;
					
					int line = bm.LineNumber;
					BookmarkBase existingBookmark;
					if (!bookmarkDict.TryGetValue(line, out existingBookmark) || bm.ZOrder > existingBookmark.ZOrder)
						bookmarkDict[line] = bm;
				}
				Size pixelSize = PixelSnapHelpers.GetPixelSize(this);
				foreach (VisualLine line in textView.VisualLines) {
					int lineNumber = line.FirstDocumentLine.LineNumber;
					BookmarkBase bm;
					if (bookmarkDict.TryGetValue(lineNumber, out bm)) {
						Rect rect = new Rect(0, PixelSnapHelpers.Round(line.VisualTop - textView.VerticalOffset, pixelSize.Height), 16, 16);
						if (dragDropBookmark == bm && dragStarted)
							drawingContext.PushOpacity(0.5);
						drawingContext.DrawImage(bm.Image, rect);
						if (dragDropBookmark == bm && dragStarted)
							drawingContext.Pop();
					}
				}
				if (dragDropBookmark != null && dragStarted) {
					Rect rect = new Rect(0, PixelSnapHelpers.Round(dragDropCurrentPoint - 8, pixelSize.Height), 16, 16);
					drawingContext.DrawImage(dragDropBookmark.Image, rect);
				}
			}
		}
		
		IBookmark dragDropBookmark; // bookmark being dragged (!=null if drag'n'drop is active)
		double dragDropStartPoint;
		double dragDropCurrentPoint;
		bool dragStarted; // whether drag'n'drop operation has started (mouse was moved minimum distance)
		
		protected override void OnMouseDown(MouseButtonEventArgs e)
		{
			base.OnMouseDown(e);
			int line = GetLineFromMousePosition(e);
			if (!e.Handled && line > 0) {
				IBookmark bm = GetBookmarkFromLine(line);
				if (bm != null) {
					bm.MouseDown(e);
					if (!e.Handled) {
						if (e.ChangedButton == MouseButton.Left && bm.CanDragDrop && CaptureMouse()) {
							StartDragDrop(bm, e);
							e.Handled = true;
						}
					}
				}
			}
			// don't allow selecting text through the IconBarMargin
			if (e.ChangedButton == MouseButton.Left)
				e.Handled = true;
		}
		
		BookmarkBase GetBookmarkFromLine(int line)
		{
			BookmarkBase result = null;
			foreach (BookmarkBase bm in BookmarkManager.Bookmarks) {
				if (bm.LineNumber == line &&
				    DebugData.DecompiledMemberReferences != null && DebugData.DecompiledMemberReferences.ContainsKey(bm.MemberReference.FullName)) {
					if (result == null || bm.ZOrder > result.ZOrder)
						result = bm;
				}
			}
			return result;
		}
		
		protected override void OnLostMouseCapture(MouseEventArgs e)
		{
			CancelDragDrop();
			base.OnLostMouseCapture(e);
		}
		
		void StartDragDrop(IBookmark bm, MouseEventArgs e)
		{
			dragDropBookmark = bm;
			dragDropStartPoint = dragDropCurrentPoint = e.GetPosition(this).Y;
			if (TextView != null) {
				TextArea area = TextView.Services.GetService(typeof(TextArea)) as TextArea;
				if (area != null)
					area.PreviewKeyDown += TextArea_PreviewKeyDown;
			}
		}
		
		void CancelDragDrop()
		{
			if (dragDropBookmark != null) {
				dragDropBookmark = null;
				dragStarted = false;
				if (TextView != null) {
					TextArea area = TextView.Services.GetService(typeof(TextArea)) as TextArea;
					if (area != null)
						area.PreviewKeyDown -= TextArea_PreviewKeyDown;
				}
				ReleaseMouseCapture();
				InvalidateVisual();
			}
		}
		
		void TextArea_PreviewKeyDown(object sender, KeyEventArgs e)
		{
			// any key press cancels drag'n'drop
			CancelDragDrop();
			if (e.Key == Key.Escape)
				e.Handled = true;
		}
		
		int GetLineFromMousePosition(MouseEventArgs e)
		{
			TextView textView = this.TextView;
			if (textView == null)
				return 0;
			VisualLine vl = textView.GetVisualLineFromVisualTop(e.GetPosition(textView).Y + textView.ScrollOffset.Y);
			if (vl == null)
				return 0;
			return vl.FirstDocumentLine.LineNumber;
		}
		
		protected override void OnMouseMove(MouseEventArgs e)
		{
			base.OnMouseMove(e);
			if (dragDropBookmark != null) {
				dragDropCurrentPoint = e.GetPosition(this).Y;
				if (Math.Abs(dragDropCurrentPoint - dragDropStartPoint) > SystemParameters.MinimumVerticalDragDistance)
					dragStarted = true;
				InvalidateVisual();
			}
			
			BreakpointBookmark bm = BookmarkManager.Bookmarks.Find(
				b => DebugData.CodeMappings.ContainsKey(b.MemberReference.FullName) &&
				b.LineNumber == GetLineFromMousePosition(e)
				&& b is BreakpointBookmark) as BreakpointBookmark;
			
			this.ToolTip = (bm != null) ? bm.Tooltip : null;
		}
		
		protected override void OnMouseUp(MouseButtonEventArgs e)
		{
			base.OnMouseUp(e);
			int line = GetLineFromMousePosition(e);
			if (!e.Handled && dragDropBookmark != null) {
				if (dragStarted) {
					if (line != 0)
						dragDropBookmark.Drop(line);
					e.Handled = true;
				}
				CancelDragDrop();
			}
			if (!e.Handled && line != 0) {
				BookmarkBase bm = GetBookmarkFromLine(line);
				if (bm != null) {
					bm.MouseUp(e);
					
					if (bm.CanToggle) {
						BookmarkManager.RemoveMark(bm);
						InvalidateVisual();
					}
					
					if (e.Handled)
						return;
				}
				if (e.ChangedButton == MouseButton.Left) {
					if (DebugData.DecompiledMemberReferences != null && DebugData.DecompiledMemberReferences.Count > 0) {
						
						// check if the codemappings exists for this line
						var storage = DebugData.CodeMappings;
						uint token = 0;
						foreach (var member in DebugData.DecompiledMemberReferences.Values) {
							string memberName = member.FullName;
							var instruction = storage[memberName].GetInstructionByLineNumber(line, out token);
							
							if (instruction == null) {
								continue;
							}
							
							// no bookmark on the line: create a new breakpoint
							DebuggerService.ToggleBreakpointAt(
								member,
								line,
								instruction.ILInstructionOffset,
								DebugData.Language);
							break;
						}
						
						if (token == 0) {
							MessageBox.Show(string.Format("Missing code mappings at line {0}.", line),
							                "Code mappings", MessageBoxButton.OK, MessageBoxImage.Information);
							return;
						}
					}
				}
				InvalidateVisual();
			}
		}
		
		public void SyncBookmarks()
		{
			if (DebugData.CodeMappings == null || DebugData.CodeMappings.Count == 0)
				return;
			
			//remove existing bookmarks and create new ones
			List<BreakpointBookmark> newBookmarks = new List<BreakpointBookmark>();
			for (int i = BookmarkManager.Bookmarks.Count - 1; i >= 0; --i) {
				var breakpoint = BookmarkManager.Bookmarks[i] as BreakpointBookmark;
				if (breakpoint == null)
					continue;
				
				foreach (var key in DebugData.CodeMappings.Keys) {
					var member = DebugData.DecompiledMemberReferences[key];
					
					uint token;
					if (member is TypeDefinition) {
						var m = member as TypeDefinition;
						if (breakpoint.MemberReference is TypeDefinition) {
							if (member != breakpoint.MemberReference)
								continue;
							token = (uint)member.MetadataToken.ToInt32();
						} else {
							if (!m.ContainsMember(breakpoint.MemberReference))
								continue;
							token = (uint)breakpoint.MemberReference.MetadataToken.ToInt32();
						}
					} else {
						if (breakpoint.MemberReference is TypeDefinition) {
							if (!(breakpoint.MemberReference as TypeDefinition).ContainsMember(member))
								continue;
							token = (uint)member.MetadataToken.ToInt32();
						} else {
							if (breakpoint.MemberReference != member)
								continue;
							token = (uint)breakpoint.MemberReference.MetadataToken.ToInt32();
						}
					}
					
					bool isMatch;
					SourceCodeMapping map = DebugData.CodeMappings[key]
						.GetInstructionByTokenAndOffset(token, breakpoint.ILRange.From, out isMatch);
					
					if (map != null) {
						newBookmarks.Add(new BreakpointBookmark(
							DebugData.DecompiledMemberReferences[key],
							new AstLocation(map.SourceCodeLine, 0),
							map.ILInstructionOffset, BreakpointAction.Break, DebugData.Language));
						
						BookmarkManager.RemoveMark(breakpoint);
						break;
					}
				}
			}
			
			newBookmarks.ForEach(m => BookmarkManager.AddMark(m));
		}
	}
}