ipc: add custom serializer for IGameObject

fixes #1924

Dalamud/Interface/Internal/Windows/Data/Widgets/PluginIpcWidget.cs

@@ -1,4 +1,7 @@
-using Dalamud.Plugin.Ipc;
+using Dalamud.Game.ClientState;
+using Dalamud.Game.ClientState.Objects;
+using Dalamud.Game.ClientState.Objects.Types;
+using Dalamud.Plugin.Ipc;
 using Dalamud.Plugin.Ipc.Internal;
 using Dalamud.Utility;
 using ImGuiNET;
@@ -14,6 +17,11 @@ internal class PluginIpcWidget : IDataWindowWidget
     // IPC
     private ICallGateProvider<string, string>? ipcPub;
     private ICallGateSubscriber<string, string>? ipcSub;
+
+    // IPC
+    private ICallGateProvider<ICharacter?, string>? ipcPubGo;
+    private ICallGateSubscriber<ICharacter?, string>? ipcSubGo;
+
     private string callGateResponse = string.Empty;
 
     /// <inheritdoc/>
@@ -64,6 +72,28 @@ public void Draw()
             this.ipcSub.Subscribe(_ => throw new Exception("PONG3"));
         }
 
+        if (this.ipcPubGo == null)
+        {
+            this.ipcPubGo = new CallGatePubSub<ICharacter?, string>("dataDemo2");
+
+            this.ipcPubGo.RegisterAction(go =>
+            {
+                Log.Information("Data action was called: {Name}", go?.Name);
+            });
+
+            this.ipcPubGo.RegisterFunc(go =>
+            {
+                Log.Information("Data func was called: {Name}", go?.Name);
+                return "test";
+            });
+        }
+
+        if (this.ipcSubGo == null)
+        {
+            this.ipcSubGo = new CallGatePubSub<ICharacter?, string>("dataDemo2");
+            this.ipcSubGo.Subscribe(go => { Log.Information("GO: {Name}", go.Name); });
+        }
+
         if (ImGui.Button("PING"))
         {
             this.ipcPub.SendMessage("PING");
@@ -78,7 +108,17 @@ public void Draw()
         {
             this.callGateResponse = this.ipcSub.InvokeFunc("button2");
         }
-
+
+        if (ImGui.Button("Action GO"))
+        {
+            this.ipcSubGo.InvokeAction(Service<ClientState>.Get().LocalPlayer);
+        }
+
+        if (ImGui.Button("Func GO"))
+        {
+            this.callGateResponse = this.ipcSubGo.InvokeFunc(Service<ClientState>.Get().LocalPlayer);
+        }
+
         if (!this.callGateResponse.IsNullOrEmpty())
             ImGui.Text($"Response: {this.callGateResponse}");
     }

Dalamud/Plugin/Ipc/Internal/CallGateChannel.cs

@@ -4,6 +4,8 @@
 using System.Reflection;
 
 using Dalamud.Plugin.Ipc.Exceptions;
+using Dalamud.Plugin.Ipc.Internal.Converters;
+
 using Newtonsoft.Json;
 using Serilog;
 
@@ -206,7 +208,10 @@ private IEnumerable<Type> GenerateTypes(Type? type)
         if (obj is null)
             return null;
 
-        var json = JsonConvert.SerializeObject(obj);
+        var settings = new JsonSerializerSettings();
+        settings.Converters.Add(new GameObjectConverter());
+
+        var json = JsonConvert.SerializeObject(obj, settings);
 
         try
         {
@@ -241,7 +246,7 @@ private IEnumerable<Type> GenerateTypes(Type? type)
 
         try
         {
-            return JsonConvert.DeserializeObject(json, type);
+            return JsonConvert.DeserializeObject(json, type, settings);
         }
         catch (Exception ex)
         {

Dalamud/Plugin/Ipc/Internal/Converters/GameObjectConverter.cs

@@ -0,0 +1,49 @@
+using System.IO;
+
+using Dalamud.Game.ClientState.Objects;
+using Dalamud.Game.ClientState.Objects.Types;
+using Dalamud.Utility;
+
+using Newtonsoft.Json;
+
+namespace Dalamud.Plugin.Ipc.Internal.Converters;
+
+/// <summary>
+/// JSON converter for IGameObject and its derived types.
+/// </summary>
+internal sealed class GameObjectConverter : JsonConverter<IGameObject>
+{
+    /// <inheritdoc/>
+    public override void WriteJson(JsonWriter writer, IGameObject? value, JsonSerializer serializer) =>
+        writer.WriteValue(value?.Address.ToString());
+
+    /// <inheritdoc/>
+    public override IGameObject? ReadJson(
+        JsonReader reader,
+        Type objectType,
+        IGameObject? existingValue,
+        bool hasExistingValue,
+        JsonSerializer serializer)
+    {
+        if (reader.TokenType == JsonToken.Null)
+            return null;
+
+        if (reader.TokenType != JsonToken.String)
+            throw new InvalidDataException("String is expected.");
+
+        if (!nint.TryParse(reader.Value as string, out var v))
+            throw new InvalidDataException("Could not parse address.");
+
+        if (!ThreadSafety.IsMainThread)
+            throw new InvalidOperationException("Cannot send GameObjects from non-main thread over IPC.");
+
+        var ot = Service<ObjectTable>.Get();
+        foreach (var go in ot)
+        {
+            if (go.Address == v)
+                return go;
+        }
+
+        return ot.CreateObjectReference(v);
+    }
+}