Add CJK IME Support

DX XNA (WinForms base) Only OGL UGL (SDL base) are not support Signed-off-by: 舰队的偶像-岛风酱! <[email protected]>
CnCNet · Jan 23, 2025 · 6fe7ef1 · 6fe7ef1
1 parent b865f27
commit 6fe7ef1
Show file tree

Hide file tree

Showing 6 changed files with 135 additions and 3 deletions.
diff --git a/ClientCore/ClientCore.csproj b/ClientCore/ClientCore.csproj
@@ -6,6 +6,17 @@
     <None Remove="Resources\*.png" />
     <EmbeddedResource Include="Resources\*.png" />
   </ItemGroup>
+  <ItemGroup Condition="$(Configuration.Contains('GL'))">
+    <!--Remove WinForm-->
+    <Compile Remove="IME\WinFormsIMEHandler.cs" />
+    <None Include="IME\WinFormsIMEHandler.cs" />
+  </ItemGroup>
+  <ItemGroup Condition="!$(Configuration.Contains('GL'))">
+    <!--Remove SDL-->
+    <Compile Remove="IME\SdlIMEHandler.cs" />
+    <None Include="IME\SdlIMEHandler.cs" />
+    <PackageReference Include="ImeSharp" />
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Rampastring.Tools" />
     <PackageReference Include="Rampastring.XNAUI.$(Engine)" Condition="'!$(Configuration.Contains(Debug))'" />

diff --git a/ClientCore/IME/IMEHandler.cs b/ClientCore/IME/IMEHandler.cs
@@ -0,0 +1,52 @@
+using System;
+
+using Microsoft.Xna.Framework;
+
+using Rampastring.XNAUI.Input;
+using Rampastring.XNAUI.XNAControls;
+
+namespace ClientCore.IME;
+
+public abstract class IMEHandler : IIMEHandler
+{
+    private string _composition = string.Empty;
+
+    public abstract bool Enabled { get; protected set; }
+
+    public XNAControl IMEFocus { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
+
+    public string Composition
+    {
+        get => _composition;
+        set
+        {
+            string old = _composition;
+            _composition = value;
+            CompositionChanged?.Invoke(null, new(old, value));
+        }
+    }
+
+    public virtual int CompositionCursorPosition { get; set; }
+
+    public event EventHandler<CharacterEventArgs> CharInput;
+    public event EventHandler<CompositionChangedEventArgs> CompositionChanged;
+    public static IMEHandler Create(Game game)
+    {
+#if !GL
+        return new WinFormsIMEHandler(game);
+#else
+        return new SdlIMEHandler(game);
+#endif
+    }
+
+    public virtual void SetTextInputRectangle(Rectangle rectangle)
+    {
+    }
+
+    public abstract void StartTextComposition();
+
+    public abstract void StopTextComposition();
+
+    protected virtual void OnTextInput(char character)
+    => CharInput?.Invoke(this, new(character));
+}
diff --git a/ClientCore/IME/SdlIMEHandler.cs b/ClientCore/IME/SdlIMEHandler.cs
@@ -0,0 +1,25 @@
+using Microsoft.Xna.Framework;
+
+namespace ClientCore.IME;
+
+/// <summary>
+/// Integrate IME to DesktopGL(SDL2) platform.
+/// </summary>
+/// <remarks>
+/// Note: We were unable to provide reliable input method support for
+/// SDL2 due to the lack of a way to be able to stabilize hooks for
+/// the SDL2 main loop.<br/>
+/// Perhaps this requires some changes in Monogame.
+/// </remarks>
+internal sealed class SdlIMEHandler(Game game) : IMEHandler
+{
+    public override bool Enabled { get => false; protected set => _ = value; }
+
+    public override void StartTextComposition()
+    {
+    }
+
+    public override void StopTextComposition()
+    {
+    }
+}
diff --git a/ClientCore/IME/WinFormsIMEHandler.cs b/ClientCore/IME/WinFormsIMEHandler.cs
@@ -0,0 +1,40 @@
+using ImeSharp;
+
+using Microsoft.Xna.Framework;
+
+namespace ClientCore.IME;
+
+/// <summary>
+/// Integrate IME to XNA framework.
+/// </summary>
+internal class WinFormsIMEHandler : IMEHandler
+{
+    public override bool Enabled
+    {
+        get => InputMethod.Enabled;
+        protected set => InputMethod.Enabled = value;
+    }
+
+    public WinFormsIMEHandler(Game game)
+    {
+        InputMethod.Initialize(game.Window.Handle);
+        InputMethod.TextInputCallback = OnTextInput;
+        InputMethod.TextCompositionCallback = (compositionText, cursorPosition) =>
+        {
+            Composition = compositionText.ToString();
+            CompositionCursorPosition = cursorPosition;
+        };
+    }
+
+
+    public override void StartTextComposition()
+        => Enabled = true;
+
+
+    public override void StopTextComposition()
+        => Enabled = false;
+
+
+    public override void SetTextInputRectangle(Rectangle rect)
+        => InputMethod.SetTextInputRect(rect.X, rect.Y, rect.Width, rect.Height);
+}
diff --git a/DXMainClient/DXGUI/GameClass.cs b/DXMainClient/DXGUI/GameClass.cs
@@ -1,5 +1,6 @@
-using ClientCore;
+using ClientCore;
 using ClientCore.CnCNet5;
+using ClientCore.IME;
 using ClientGUI;
 using DTAClient.Domain;
 using DTAClient.DXGUI.Generic;
@@ -144,7 +145,10 @@ protected override void Initialize()
 #endif
             InitializeUISettings();
 
-            WindowManager wm = new WindowManager(this, graphics);
+            WindowManager wm = new(this, graphics)
+            {
+                IMEHandler = IMEHandler.Create(this),
+            };
             wm.Initialize(content, ProgramConstants.GetBaseResourcePath());
 
             wm.ControlINIAttributeParsers.Add(new TranslationINIParser());

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -9,6 +9,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageVersion Include="DiscordRichPresence" Version="1.1.3.18" />
+    <PackageVersion Include="ImeSharp" Version="1.4.0" />
     <PackageVersion Include="lzo.net" Version="0.0.6" />
     <PackageVersion Include="Microsoft.AspNet.WebApi.Client" Version="6.0.0" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.3" />
@@ -51,7 +52,6 @@
     <!-- and -p:Engine=WindowsDX -f net48 -->
     <PackageReference Include="NETStandard.Library" />
     <PackageVersion Include="NETStandard.Library" Version="2.0.3" />
-
     <PackageReference Include="System.IO.FileSystem" />
     <PackageVersion Include="System.IO.FileSystem" Version="4.3.0" />
   </ItemGroup>