TextBoxHandler.cs

using System.Runtime;
using swd = System.Windows.Documents;
namespace Eto.Wpf.Forms.Controls
{
	public class EtoWatermarkTextBox : xwt.WatermarkTextBox, IEtoWpfControl
	{
		public IWpfFrameworkElement Handler { get; set; }

		protected override sw.Size MeasureOverride(sw.Size constraint)
		{
			return Handler?.MeasureOverride(constraint, base.MeasureOverride) ?? base.MeasureOverride(constraint);
		}
	}

	public class TextBoxHandler : TextBoxHandler<xwt.WatermarkTextBox, TextBox, TextBox.ICallback>, TextBox.IHandler
	{
		internal static object CurrentText_Key = new object();
		internal static object CurrentSelection_Key = new object();
		internal static object DisableTextChanged_Key = new object();
		internal static object EnableNoGCRegion_Key = new object();

		/// <summary>
		/// Gets or sets the default value indicating to use GC.TryStartNoGCRegion() when setting TextBox.Text
		/// to avoid performance issues with WPF.
		/// See https://github.com/dotnet/wpf/issues/5887
		/// </summary>
		public static bool EnableNoGCRegionDefault = true;

		protected override swc.TextBox TextBox => Control;

		public TextBoxHandler()
		{
			Control = new EtoWatermarkTextBox { Handler = this, KeepWatermarkOnGotFocus = true };
		}

		public override string PlaceholderText
		{
			get { return Control.Watermark as string; }
			set { Control.Watermark = value; }
		}
	}

	public abstract class TextBoxHandler<TControl, TWidget, TCallback> : WpfControl<TControl, TWidget, TCallback>, TextBox.IHandler
		where TControl : swc.Control
		where TWidget : TextBox
		where TCallback: TextBox.ICallback
	{
		bool initialSelection;

		protected override sw.Size DefaultSize => new sw.Size(100, double.NaN);

		protected override bool PreventUserResize { get { return true; } }

		protected abstract swc.TextBox TextBox { get; }

		protected virtual swc.Control BorderControl => TextBox;

		public override bool ShowBorder
		{
			get { return BorderControl.ReadLocalValue(swc.Control.BorderThicknessProperty) == sw.DependencyProperty.UnsetValue; }
			set
			{
				if (value)
					BorderControl.ClearValue(swc.Control.BorderThicknessProperty);
				else
					BorderControl.BorderThickness = new sw.Thickness(0);
			}
		}

		/// <summary>
		/// Gets or sets a value indicating to use GC.TryStartNoGCRegion() when setting TextBox.Text
		/// to avoid performance issues with WPF.
		/// See https://github.com/dotnet/wpf/issues/5887
		/// </summary>
		/// <seealso cref="TextBoxHandler.EnableNoGCRegionDefault" />
		public bool EnableNoGCRegion
		{
			get => Widget.Properties.Get<bool?>(TextBoxHandler.EnableNoGCRegion_Key) ?? TextBoxHandler.EnableNoGCRegionDefault;
			set => Widget.Properties.Set(TextBoxHandler.EnableNoGCRegion_Key, value);
		}

		public TextAlignment TextAlignment
		{
			get { return TextBox.TextAlignment.ToEto(); }
			set
			{
				TextBox.TextAlignment = value.ToWpfTextAlignment();
				TextBox.HorizontalContentAlignment = value.ToWpf();
			}
		}

		public TextBoxHandler ()
		{
		}

		protected override void Initialize()
		{
			base.Initialize();
			TextBox.GotKeyboardFocus += Control_GotKeyboardFocus;
			TextBox.PreviewMouseLeftButtonDown += TextBox_PreviewMouseLeftButtonDown;
		}

		void TextBox_PreviewMouseLeftButtonDown(object sender, swi.MouseButtonEventArgs e)
		{
			if (AutoSelectMode == AutoSelectMode.Always && !TextBox.IsKeyboardFocusWithin)
			{
				TextBox.SelectAll();
				TextBox.Focus();
				e.Handled = true;
			}
		}

		void Control_GotKeyboardFocus(object sender, sw.Input.KeyboardFocusChangedEventArgs e)
		{
			if (initialSelection)
			{
				initialSelection = false;
				return;
			}
			if (AutoSelectMode == AutoSelectMode.OnFocus || AutoSelectMode == AutoSelectMode.Always)
				TextBox.SelectAll();
		}

		public override bool UseMousePreview { get { return true; } }

		public override bool UseKeyPreview { get { return true; } }

		static Func<char, bool> testIsNonWord = ch => char.IsWhiteSpace(ch) || char.IsPunctuation(ch);

		static Clipboard clipboard;

		public override void AttachEvent (string id)
		{
			switch (id) {
				case TextControl.TextChangedEvent:
					TextBox.TextChanged += TextBox_TextChanged;
					break;
				case Eto.Forms.TextBox.TextChangingEvent:
					if (clipboard == null)
						clipboard = new Clipboard();
					bool didUpdate = false;

					swi.TextCompositionManager.AddPreviewTextInputStartHandler(TextBox, (sender, e) =>
					{
						// ensure we only fire TextChanging after any IME composition is completed
						DisableTextChanged++;
						didUpdate = false;
						// keep selection/text as they change during composition
						CurrentSelection = Selection;
						CurrentText = Text;
					});
					swi.TextCompositionManager.AddPreviewTextInputUpdateHandler(TextBox, (sender, e) =>
					{
						didUpdate = true;
					});
					swi.TextCompositionManager.AddPreviewTextInputHandler(TextBox, (sender, e) =>
					{
						// composition is finished, fire textchanging event unless it was cancelled
						DisableTextChanged--;
						if (!string.IsNullOrEmpty(e.Text) || Selection.Length() > 0)
						{
							var tia = new TextChangingEventArgs(e.Text, Selection, Text, true);
							Callback.OnTextChanging(Widget, tia);
							e.Handled = tia.Cancel;
							if (didUpdate && tia.Cancel && CurrentText != null)
							{
								// restore last text value if the event was cancelled and the text wasn't changed manually.
								DisableTextChanged++;
								Text = CurrentText;
								DisableTextChanged--;
							}
						}

						CurrentText = null;
						CurrentSelection = null;
						didUpdate = false;
					});
					TextBox.AddHandler(swi.CommandManager.PreviewExecutedEvent, new swi.ExecutedRoutedEventHandler((sender, e) =>
					{
						var command = e.Command as swi.RoutedUICommand;
						if (command == null)
							return;
						if (command == swi.ApplicationCommands.Cut || command == swi.ApplicationCommands.Delete)
						{
							var text = TextBox.SelectedText;
							var tia = new TextChangingEventArgs(string.Empty, Selection, true);
							Callback.OnTextChanging(Widget, tia);
							if (tia.Cancel)
							{
								if (command == swi.ApplicationCommands.Cut)
									clipboard.Text = text;
								e.Handled = true;
							}
						}
						else if (command == swi.ApplicationCommands.Paste)
						{
							var text = clipboard.Text;
							var tia = new TextChangingEventArgs(text, Selection, true);
							Callback.OnTextChanging(Widget, tia);
							e.Handled = tia.Cancel;
						}
						else if (command == swd.EditingCommands.Delete || command == swd.EditingCommands.Backspace)
						{
							var range = Selection;
							if (range.Length() == 0)
								range = new Range<int>(command == swd.EditingCommands.Delete ? range.Start : range.Start - 1);
							if (range.Start >= 0)
							{
								var tia = new TextChangingEventArgs(string.Empty, range, true);
								Callback.OnTextChanging(Widget, tia);
								e.Handled = tia.Cancel;
							}
						}
						else if (command == swd.EditingCommands.DeletePreviousWord)
						{
							string text = Text;
							int end = CaretIndex;
							int start = end;

							// find start of previous word
							while (start > 0 && testIsNonWord(text[start - 1]))
								start--;
							while (start > 0 && !testIsNonWord(text[start - 1]))
								start--;

							if (end > start)
							{
								var tia = new TextChangingEventArgs(string.Empty, new Range<int>(start, end - 1), true);
								Callback.OnTextChanging(Widget, tia);
								e.Handled = tia.Cancel;
							}
						}
						else if (command == swd.EditingCommands.DeleteNextWord)
						{
							string text = Text;
							int start = CaretIndex;
							int end = start;
							int length = text.Length;

							// find end of next word
							while (end < length && !testIsNonWord(text[end]))
								end++;
							while (end < length && testIsNonWord(text[end]))
								end++;

							if (end > start)
							{
								var tia = new TextChangingEventArgs(string.Empty, new Range<int>(start, end - 1), true);
								Callback.OnTextChanging(Widget, tia);
								e.Handled = tia.Cancel;
							}
						}
						else if (command.OwnerType == typeof(swd.EditingCommands) && command.Name == "Space")
						{
							// space doesn't trigger TextInput (which you'd expect) as it can be interpreted through IME
							var text = " ";
							var tia = new TextChangingEventArgs(text, Selection, true);
							Callback.OnTextChanging(Widget, tia);
							e.Handled = tia.Cancel;
						}
					}));
					break;
				default:
					base.AttachEvent (id);
					break;
			}
		}

		private void TextBox_TextChanged(object sender, swc.TextChangedEventArgs e)
		{
			if (DisableTextChanged == 0)
				Callback.OnTextChanged(Widget, EventArgs.Empty);
		}

		public bool ReadOnly
		{
			get { return TextBox.IsReadOnly; }
			set { TextBox.IsReadOnly = value; }
		}

		public int MaxLength
		{
			get { return TextBox.MaxLength; }
			set { TextBox.MaxLength = value; }
		}

		string CurrentText
		{
			get => Widget.Properties.Get<string>(TextBoxHandler.CurrentText_Key);
			set => Widget.Properties.Set(TextBoxHandler.CurrentText_Key, value);
		}

		public string Text
		{
			get => CurrentText ?? TextBox.Text;
			set
			{
				var oldText = Text;
				CurrentText = null;
				var newText = value ?? string.Empty;
				TextBox.BeginChange();
				if (newText != oldText)
				{
					var args = new TextChangingEventArgs(oldText, newText, false);
					Callback.OnTextChanging(Widget, args);
					if (args.Cancel)
					{
						TextBox.EndChange();
						return;
					}

					var needsTextChanged = TextBox.Text == newText;

					// Improve performance when setting text often
					// See https://github.com/dotnet/wpf/issues/5887#issuecomment-1604577981
					var endNoGCRegion = EnableNoGCRegion
						&& GCSettings.LatencyMode != GCLatencyMode.NoGCRegion;

					try
					{
						endNoGCRegion &= GC.TryStartNoGCRegion(1000000); // is this magic number reasonable??
					}
					catch
					{
						// Ignore any exceptions, they can apparently still happen even though we check the LatencyMode above
						endNoGCRegion = false;
					}

					try 
					{
						TextBox.Text = newText; 
					}
					finally
					{
						if (endNoGCRegion && GCSettings.LatencyMode == GCLatencyMode.NoGCRegion)
							GC.EndNoGCRegion();
					}
					
					if (needsTextChanged)
					{
						Callback.OnTextChanged(Widget, EventArgs.Empty);
					}
				}
				if (value != null && AutoSelectMode == AutoSelectMode.Never && !HasFocus)
				{
					TextBox.SelectionStart = value.Length;
					TextBox.SelectionLength = 0;
				}
				TextBox.EndChange();
			}
		}

		public abstract string PlaceholderText { get; set; }

		public int CaretIndex
		{
			get => CurrentSelection?.Start ?? TextBox.CaretIndex;
			set
			{
				CurrentSelection = null;
				TextBox.CaretIndex = value;
				if (!HasFocus)
					initialSelection = true;
			}
		}

		public void SelectAll()
		{
			TextBox.SelectAll();
			if (!HasFocus)
				initialSelection = true;
		}

		int DisableTextChanged
		{
			get => Widget.Properties.Get<int>(TextBoxHandler.DisableTextChanged_Key);
			set => Widget.Properties.Set(TextBoxHandler.DisableTextChanged_Key, value);
		}

		Range<int>? CurrentSelection
		{
			get => Widget.Properties.Get<Range<int>?>(TextBoxHandler.CurrentSelection_Key);
			set => Widget.Properties.Set(TextBoxHandler.CurrentSelection_Key, value);
		}

		public Range<int> Selection
		{
			get => CurrentSelection ??　new Range<int>(TextBox.SelectionStart, TextBox.SelectionStart + TextBox.SelectionLength - 1);
			set
			{
				CurrentSelection = null;
				TextBox.BeginChange();
				TextBox.SelectionStart = value.Start;
				TextBox.SelectionLength = value.Length();
				TextBox.EndChange();
				if (!HasFocus)
					initialSelection = true;
			}
		}

		public AutoSelectMode AutoSelectMode { get; set; }
	}
}