Revamp text input event with the advanced ime support in SDL3; Remove ImeSharp package depedency; Upgrade UWP runtime package

Author: ryancheung

FNA.NET.csproj

@@ -426,7 +426,7 @@
 	</ItemGroup>
 
 	<ItemGroup Condition="'$(TargetFramework)' == 'net9.0-windows10.0.26100.0'">
-		<PackageReference Include="FNA.NET.NativeAssets.UWP" Version="2.0.3.2602" />
+		<PackageReference Include="FNA.NET.NativeAssets.UWP" Version="2.0.5.2602" />
 	</ItemGroup>
 
 	<PropertyGroup Condition="'$(TargetFramework)' == 'net9.0-windows10.0.26100.0'">
@@ -443,7 +443,6 @@
 	</PropertyGroup>
 
 	<ItemGroup Condition="'$(TargetFramework)' == 'net9.0-windows'">
-		<PackageReference Include="ImeSharp" Version="1.4.1" />
 	</ItemGroup>
 
 	<ItemGroup Condition="'$(TargetFramework)' == 'net9.0-android'">

src/FNAPlatform/SDL3_FNAPlatform.cs

@@ -1181,6 +1181,40 @@ ref bool textInputSuppress
 					}
 				}
 
+				else if (evt.type == (uint) SDL.SDL_EventType.SDL_EVENT_TEXT_EDITING_CANDIDATES)
+				{
+					if (evt.edit_candidates.num_candidates > 0)
+					{
+						string[] candidates = new string[evt.edit_candidates.num_candidates];
+						for (int i = 0; i < evt.edit_candidates.num_candidates; i++)
+						{
+							byte* candidatePtr = evt.edit_candidates.candidates[i];
+							int bytes = MeasureStringLength(candidatePtr);
+							if (bytes > 0)
+							{
+								int chars = Encoding.UTF8.GetChars(
+									candidatePtr,
+									bytes,
+									charsBuffer,
+									bytes
+								);
+								candidates[i] = new string(charsBuffer, 0, chars);
+							}
+							else
+							{
+								candidates[i] = string.Empty;
+							}
+						}
+						TextInputEXT.OnTextEditingCandidates(
+							candidates,
+							evt.edit_candidates.selected_candidate,
+							evt.edit_candidates.horizontal
+						);
+					}
+					else
+						TextInputEXT.OnTextEditingCandidates(Array.Empty<string>(), 0, false);
+				}
+
 				// Quit
 				else if (evt.type == (uint) SDL.SDL_EventType.SDL_EVENT_QUIT)
 				{

src/Input/TextInputEXT.cs

@@ -33,22 +33,16 @@ public static class TextInputEXT
 		/// </summary>
 		public static event Action<string, int, int> TextEditing;
 
+		public static event Action<string[], int, bool> TextEditingCandidates;
+
 		#endregion
 
 		#region Public Properties
 
-		static IntPtr windowHandle;
 		public static IntPtr WindowHandle
 		{
-			get => windowHandle;
-			set
-			{
-#if WINDOWS7_0_OR_GREATER && !WINDOWS10_0_17763_0_OR_GREATER
-				if (value != IntPtr.Zero && windowHandle != value)
-					AdvancedImeInit(value);
-#endif
-				windowHandle = value;
-			}
+			get;
+			set;
 		}
 
 		#endregion
@@ -65,11 +59,7 @@ public static IntPtr WindowHandle
 		/// <returns>True if text input state is active</returns>
 		public static bool IsTextInputActive()
 		{
-#if WINDOWS7_0_OR_GREATER && !WINDOWS10_0_17763_0_OR_GREATER
-			return ImeSharp.InputMethod.Enabled;
-#else
 			return FNAPlatform.IsTextInputActive(WindowHandle);
-#endif
 		}
 
 		public static bool IsScreenKeyboardShown()
@@ -84,22 +74,12 @@ public static bool IsScreenKeyboardShown(IntPtr window)
 
 		public static void StartTextInput()
 		{
-#if WINDOWS7_0_OR_GREATER && !WINDOWS10_0_17763_0_OR_GREATER
-			// Need to ensure SDL2 text input is stopped
-			FNAPlatform.StopTextInput(WindowHandle);
-			ImeSharp.InputMethod.Enabled = true;
-#else
 			FNAPlatform.StartTextInput(WindowHandle);
-#endif
 		}
 
 		public static void StopTextInput()
 		{
-#if WINDOWS7_0_OR_GREATER && !WINDOWS10_0_17763_0_OR_GREATER
-			ImeSharp.InputMethod.Enabled = false;
-#else
 			FNAPlatform.StopTextInput(WindowHandle);
-#endif
 		}
 
 		/// <summary>
@@ -109,12 +89,7 @@ public static void StopTextInput()
 		/// <param name="rectangle">Text input location relative to GameWindow.ClientBounds</param>
 		public static void SetInputRectangle(Rectangle rectangle)
 		{
-#if WINDOWS7_0_OR_GREATER && !WINDOWS10_0_17763_0_OR_GREATER
-			if (ImeSharp.InputMethod.Enabled)
-				ImeSharp.InputMethod.SetTextInputRect(rectangle.X, rectangle.Y, rectangle.Width, rectangle.Height);
-#else
 			FNAPlatform.SetTextInputRectangle(WindowHandle, rectangle);
-#endif
 		}
 
 		#endregion
@@ -137,51 +112,14 @@ internal static void OnTextEditing(string text, int start, int length)
 			}
 		}
 
-		#endregion
-
-#if WINDOWS7_0_OR_GREATER && !WINDOWS10_0_17763_0_OR_GREATER
-		internal static void AdvancedImeInit(IntPtr sdlWindowHandle)
+		internal static void OnTextEditingCandidates(string[] candidates, int selectedCandidate, bool horizontal)
 		{
-			var windowProps = SDL3.SDL.SDL_GetWindowProperties(sdlWindowHandle);
-			nint hwnd = SDL3.SDL.SDL_GetPointerProperty(windowProps, SDL3.SDL.SDL_PROP_WINDOW_WIN32_HWND_POINTER, IntPtr.Zero);
-
-			// Only initialize InputMethod once
-			if (ImeSharp.InputMethod.WindowHandle == IntPtr.Zero)
-				ImeSharp.InputMethod.Initialize(hwnd, ShowOSImeWindow);
-
-            ImeSharp.InputMethod.TextInputCallback = OnTextInput;
-            ImeSharp.InputMethod.TextCompositionCallback = (compositionText, cursorPosition) => {
-				OnTextEditing(compositionText, cursorPosition, 0);
-			};
+			if (TextEditingCandidates != null)
+			{
+				TextEditingCandidates(candidates, selectedCandidate, horizontal);
+			}
 		}
 
-		/// <summary>
-		/// Show the IME Candidate window rendered by the OS. Defaults to true.<br/>
-		/// Set to <c>false</c> if you want to render the IME candidate list yourself.<br/>
-		/// Note there's no way to toggle this option while game running! Please set this value main function or static initializer.<br/>
-		/// **This is a Windows only API.**
-		/// </summary>
-		public static bool ShowOSImeWindow;
-
-		/// <summary>
-		/// The candidate text list for the current composition.<br/>
-		/// If the composition string does not generate candidates, the candidate page size is zero.
-		/// This array is fixed length of 16.<br/>
-		/// **This property is only supported on Windows.**
-		/// </summary>
-		public static ImeSharp.IMEString[] CandidateList => ImeSharp.InputMethod.CandidateList;
-
-		/// <summary>
-		/// IME Candidate page size.<br/>
-		/// **This property is only supported on Windows.**
-		/// </summary>
-		public static int CandidatePageSize => ImeSharp.InputMethod.CandidatePageSize;
-
-		/// <summary>
-		/// The selected IME candidate index.<br/>
-		/// **This property is only supported on Windows.**
-		/// </summary>
-		public static int CandidateSelection => ImeSharp.InputMethod.CandidateSelection;
-#endif
+		#endregion
 	}
-}
+}