[WIP] Relax a few files to welcome a port to Uno Platform

ICSharpCode.AvalonEdit/Editing/Caret.cs

@@ -1,14 +1,14 @@
-// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
-// 
+// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
+//
 // Permission is hereby granted, free of charge, to any person obtaining a copy of this
 // software and associated documentation files (the "Software"), to deal in the Software
 // without restriction, including without limitation the rights to use, copy, modify, merge,
 // publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
 // to whom the Software is furnished to do so, subject to the following conditions:
-// 
+//
 // The above copyright notice and this permission notice shall be included in all copies or
 // substantial portions of the Software.
-// 
+//
 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 // INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
@@ -20,9 +20,6 @@
 using System.Diagnostics;
 using System.Windows;
 using System.Windows.Documents;
-using System.Windows.Media;
-using System.Windows.Media.TextFormatting;
-using System.Windows.Threading;
 
 using ICSharpCode.AvalonEdit.Document;
 using ICSharpCode.AvalonEdit.Rendering;
@@ -33,11 +30,10 @@ namespace ICSharpCode.AvalonEdit.Editing
 	/// <summary>
 	/// Helper class with caret-related methods.
 	/// </summary>
-	public sealed class Caret
+	public sealed partial class Caret
 	{
 		readonly TextArea textArea;
 		readonly TextView textView;
-		readonly CaretLayer caretAdorner;
 		bool visible;
 
 		internal Caret(TextArea textArea)
@@ -46,12 +42,14 @@ internal Caret(TextArea textArea)
 			this.textView = textArea.TextView;
 			position = new TextViewPosition(1, 1, 0);
 
-			caretAdorner = new CaretLayer(textArea);
-			textView.InsertLayer(caretAdorner, KnownLayer.Caret, LayerInsertionPosition.Replace);
 			textView.VisualLinesChanged += TextView_VisualLinesChanged;
 			textView.ScrollOffsetChanged += TextView_ScrollOffsetChanged;
+
+			Initialize();
 		}
 
+		partial void Initialize();
+
 		internal void UpdateIfVisible()
 		{
 			if (visible) {
@@ -72,11 +70,11 @@ void TextView_VisualLinesChanged(object sender, EventArgs e)
 
 		void TextView_ScrollOffsetChanged(object sender, EventArgs e)
 		{
-			if (caretAdorner != null) {
-				caretAdorner.InvalidateVisual();
-			}
+			InvalidateCaretVisual();
 		}
 
+		partial void InvalidateCaretVisual();
+
 		double desiredXPos = double.NaN;
 		TextViewPosition position;
 
@@ -371,56 +369,20 @@ void RevalidateVisualColumn(VisualLine visualLine)
 			isInVirtualSpace = (position.VisualColumn > visualLine.VisualLength);
 		}
 
-		Rect CalcCaretRectangle(VisualLine visualLine)
-		{
-			if (!visualColumnValid) {
-				RevalidateVisualColumn(visualLine);
-			}
-
-			TextLine textLine = visualLine.GetTextLine(position.VisualColumn, position.IsAtEndOfLine);
-			double xPos = visualLine.GetTextLineVisualXPosition(textLine, position.VisualColumn);
-			double lineTop = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextTop);
-			double lineBottom = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextBottom);
-
-			return new Rect(xPos,
-							lineTop,
-							SystemParameters.CaretWidth,
-							lineBottom - lineTop);
-		}
+		partial void GetCaretWidthCore(ref double width);
 
-		Rect CalcCaretOverstrikeRectangle(VisualLine visualLine)
+		double GetCaretWidth()
 		{
-			if (!visualColumnValid) {
-				RevalidateVisualColumn(visualLine);
-			}
-
-			int currentPos = position.VisualColumn;
-			// The text being overwritten in overstrike mode is everything up to the next normal caret stop
-			int nextPos = visualLine.GetNextCaretPosition(currentPos, LogicalDirection.Forward, CaretPositioningMode.Normal, true);
-			TextLine textLine = visualLine.GetTextLine(currentPos);
-
-			Rect r;
-			if (currentPos < visualLine.VisualLength) {
-				// If the caret is within the text, use GetTextBounds() for the text being overwritten.
-				// This is necessary to ensure the rectangle is calculated correctly in bidirectional text.
-				var textBounds = textLine.GetTextBounds(currentPos, nextPos - currentPos)[0];
-				r = textBounds.Rectangle;
-				r.Y += visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.LineTop);
-			} else {
-				// If the caret is at the end of the line (or in virtual space),
-				// use the visual X position of currentPos and nextPos (one or more of which will be in virtual space)
-				double xPos = visualLine.GetTextLineVisualXPosition(textLine, currentPos);
-				double xPos2 = visualLine.GetTextLineVisualXPosition(textLine, nextPos);
-				double lineTop = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextTop);
-				double lineBottom = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextBottom);
-				r = new Rect(xPos, lineTop, xPos2 - xPos, lineBottom - lineTop);
-			}
-			// If the caret is too small (e.g. in front of zero-width character), ensure it's still visible
-			if (r.Width < SystemParameters.CaretWidth)
-				r.Width = SystemParameters.CaretWidth;
-			return r;
+			double width = 1.0;
+			GetCaretWidthCore(ref width);
+			return width;
 		}
 
+		// These methods use System.Windows.Media.TextFormatting.TextLine (WPF TextFormatting API).
+		// Implementations live in Caret.wpf.cs (WPF) and Caret.uno.cs (Uno).
+		private partial Rect CalcCaretRectangle(VisualLine visualLine);
+		private partial Rect CalcCaretOverstrikeRectangle(VisualLine visualLine);
+
 		/// <summary>
 		/// Returns the caret rectangle. The coordinate system is in device-independent pixels from the top of the document.
 		/// </summary>
@@ -465,10 +427,18 @@ public void Show()
 			visible = true;
 			if (!showScheduled) {
 				showScheduled = true;
-				textArea.Dispatcher.BeginInvoke(DispatcherPriority.Normal, new Action(ShowInternal));
+				// ShowCaretAsync (wpf) clears showScheduled and posts a dispatcher call to ShowInternal.
+				// If ShowCaretAsync has no implementation (Uno), showScheduled stays true and we fall
+				// through to call ShowInternal synchronously.
+				ShowCaretAsync();
+				if (showScheduled) {
+					ShowInternal();
+				}
 			}
 		}
 
+		partial void ShowCaretAsync();
+
 		bool showScheduled;
 		bool hasWin32Caret;
 
@@ -480,55 +450,38 @@ void ShowInternal()
 			if (!visible)
 				return;
 
-			if (caretAdorner != null && textView != null) {
+			if (textView != null) {
 				VisualLine visualLine = textView.GetVisualLine(position.Line);
 				if (visualLine != null) {
 					Rect caretRect = this.textArea.OverstrikeMode ? CalcCaretOverstrikeRectangle(visualLine) : CalcCaretRectangle(visualLine);
-					// Create Win32 caret so that Windows knows where our managed caret is. This is necessary for
-					// features like 'Follow text editing' in the Windows Magnifier.
-					if (!hasWin32Caret) {
-						hasWin32Caret = Win32.CreateCaret(textView, caretRect.Size);
-					}
-					if (hasWin32Caret) {
-						Win32.SetCaretPosition(textView, caretRect.Location - textView.ScrollOffset);
-					}
-					caretAdorner.Show(caretRect);
-					textArea.ime.UpdateCompositionWindow();
+					ShowCaretInternal(caretRect);
 				} else {
-					caretAdorner.Hide();
+					HideCaretInternal();
 				}
 			}
 		}
 
+		partial void ShowCaretInternal(Rect caretRect);
+		partial void HideCaretInternal();
+
 		/// <summary>
 		/// Makes the caret invisible.
 		/// </summary>
 		public void Hide()
 		{
 			Log("Caret.Hide()");
 			visible = false;
-			if (hasWin32Caret) {
-				Win32.DestroyCaret();
-				hasWin32Caret = false;
-			}
-			if (caretAdorner != null) {
-				caretAdorner.Hide();
-			}
+			DestroyWin32Caret();
+			HideCaretInternal();
 		}
 
+		partial void DestroyWin32Caret();
+
 		[Conditional("DEBUG")]
 		static void Log(string text)
 		{
 			// commented out to make debug output less noisy - add back if there are any problems with the caret
 			//Debug.WriteLine(text);
 		}
-
-		/// <summary>
-		/// Gets/Sets the color of the caret.
-		/// </summary>
-		public Brush CaretBrush {
-			get { return caretAdorner.CaretBrush; }
-			set { caretAdorner.CaretBrush = value; }
-		}
 	}
 }

ICSharpCode.AvalonEdit/Editing/Caret.wpf.cs

@@ -0,0 +1,137 @@
+// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this
+// software and associated documentation files (the "Software"), to deal in the Software
+// without restriction, including without limitation the rights to use, copy, modify, merge,
+// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+// to whom the Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all copies or
+// substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+
+using System;
+using System.Windows;
+using System.Windows.Documents;
+using System.Windows.Media;
+using System.Windows.Media.TextFormatting;
+using System.Windows.Threading;
+
+using ICSharpCode.AvalonEdit.Document;
+using ICSharpCode.AvalonEdit.Rendering;
+using ICSharpCode.AvalonEdit.Utils;
+
+namespace ICSharpCode.AvalonEdit.Editing
+{
+	public sealed partial class Caret
+	{
+		CaretLayer caretAdorner;
+
+		partial void Initialize()
+		{
+			caretAdorner = new CaretLayer(textArea);
+			textView.InsertLayer(caretAdorner, KnownLayer.Caret, LayerInsertionPosition.Replace);
+		}
+
+		partial void InvalidateCaretVisual()
+		{
+			if (caretAdorner != null) {
+				caretAdorner.InvalidateVisual();
+			}
+		}
+
+		partial void ShowCaretAsync()
+		{
+			// Clear showScheduled now so Show()'s fallback guard does not fire synchronously.
+			// The dispatcher callback will call ShowInternal() when it runs.
+			showScheduled = false;
+			textArea.Dispatcher.BeginInvoke(DispatcherPriority.Normal, new Action(ShowInternal));
+		}
+
+		partial void ShowCaretInternal(Rect caretRect)
+		{
+			if (caretAdorner != null) {
+				if (!hasWin32Caret) {
+					hasWin32Caret = Win32.CreateCaret(textView, caretRect.Size);
+				}
+				if (hasWin32Caret) {
+					Win32.SetCaretPosition(textView, caretRect.Location - textView.ScrollOffset);
+				}
+				caretAdorner.Show(caretRect);
+				textArea.ime.UpdateCompositionWindow();
+			}
+		}
+
+		partial void HideCaretInternal()
+		{
+			if (caretAdorner != null) {
+				caretAdorner.Hide();
+			}
+		}
+
+		partial void DestroyWin32Caret()
+		{
+			if (hasWin32Caret) {
+				Win32.DestroyCaret();
+				hasWin32Caret = false;
+			}
+		}
+
+		private partial Rect CalcCaretRectangle(VisualLine visualLine)
+		{
+			if (!visualColumnValid) {
+				RevalidateVisualColumn(visualLine);
+			}
+			TextLine textLine = visualLine.GetTextLine(position.VisualColumn, position.IsAtEndOfLine);
+			double xPos = visualLine.GetTextLineVisualXPosition(textLine, position.VisualColumn);
+			double lineTop = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextTop);
+			double lineBottom = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextBottom);
+			return new Rect(xPos, lineTop, GetCaretWidth(), lineBottom - lineTop);
+		}
+
+		partial void GetCaretWidthCore(ref double width)
+		{
+			width = SystemParameters.CaretWidth;
+		}
+
+		private partial Rect CalcCaretOverstrikeRectangle(VisualLine visualLine)
+		{
+			if (!visualColumnValid) {
+				RevalidateVisualColumn(visualLine);
+			}
+			int currentPos = position.VisualColumn;
+			int nextPos = visualLine.GetNextCaretPosition(currentPos, LogicalDirection.Forward, CaretPositioningMode.Normal, true);
+			TextLine textLine = visualLine.GetTextLine(currentPos);
+			Rect r;
+			if (currentPos < visualLine.VisualLength) {
+				var textBounds = textLine.GetTextBounds(currentPos, nextPos - currentPos)[0];
+				r = textBounds.Rectangle;
+				r.Y += visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.LineTop);
+			} else {
+				double xPos = visualLine.GetTextLineVisualXPosition(textLine, currentPos);
+				double xPos2 = visualLine.GetTextLineVisualXPosition(textLine, nextPos);
+				double lineTop = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextTop);
+				double lineBottom = visualLine.GetTextLineVisualYPosition(textLine, VisualYPosition.TextBottom);
+				r = new Rect(xPos, lineTop, xPos2 - xPos, lineBottom - lineTop);
+			}
+			double caretWidth = GetCaretWidth();
+			if (r.Width < caretWidth)
+				r.Width = caretWidth;
+			return r;
+		}
+
+		/// <summary>
+		/// Gets/Sets the color of the caret.
+		/// </summary>
+		public Brush CaretBrush {
+			get { return caretAdorner.CaretBrush; }
+			set { caretAdorner.CaretBrush = value; }
+		}
+	}
+}