Add Discord Presence Extension + Restructure SharedStatic.Generic

This changes wouldn't introduce breaking changes and still works on legacy APIs

Author: neon-nyan

DiscordPresence/DiscordPresenceExtension.cs

@@ -0,0 +1,134 @@
+using Hi3Helper.Plugin.Core.Management.PresetConfig;
+using Hi3Helper.Plugin.Core.Utility;
+using System;
+using System.Runtime.InteropServices;
+using System.Runtime.InteropServices.Marshalling;
+using static Hi3Helper.Plugin.Core.SharedStaticV1Ext;
+
+namespace Hi3Helper.Plugin.Core.DiscordPresence;
+
+/// <summary>
+/// This extension provides a method to get the Discord Presence information for the current game region.
+/// </summary>
+/// <remarks>
+/// This extension IS ONLY SUPPOSEDLY BE USED by the launcher, NOT by the plugin.
+/// </remarks>
+public static class DiscordPresenceExtension
+{
+    /// <summary>
+    /// A context used to manage the context of Discord Presence information.
+    /// </summary>
+    public unsafe class DiscordPresenceContext : IDisposable
+    {
+        // Fields
+        private DiscordPresenceInfo* _data;
+
+        internal DiscordPresenceContext(IPluginPresetConfig presetConfig) : this(0, presetConfig)
+        {
+        }
+
+        public DiscordPresenceContext(nint pluginHandle, IPluginPresetConfig presetConfig)
+        {
+            if (pluginHandle == nint.Zero)
+            {
+                return;
+            }
+
+            if (!pluginHandle.TryGetExport("GetCurrentDiscordPresenceInfo",
+                                           out GetCurrentDiscordPresenceInfoDelegate method))
+            {
+                return;
+            }
+
+            DiscordPresenceInfo** info = null;
+
+            void* ptr = ComInterfaceMarshaller<IPluginPresetConfig>.ConvertToUnmanaged(presetConfig);
+            HResult result = method(ptr, info);
+
+            if (result == HResult.Ok && info != null && *info != null)
+            {
+                _data = *info;
+            }
+        }
+
+        /// <summary>
+        /// Indicates whether the Discord Presence feature is available.
+        /// </summary>
+        public bool IsFeatureAvailable => _data != null;
+
+        /// <inheritdoc cref="DiscordPresenceInfo.PresenceId"/>
+        public ulong PresenceId => _data != null ? _data->PresenceId : 0;
+
+        /// <inheritdoc cref="DiscordPresenceInfo.LargeIconUrl"/>
+        public string? LargeIconUrl
+        {
+            get
+            {
+                if (_data == null || _data->LargeIconUrl == null)
+                {
+                    return null;
+                }
+
+                return field ??= Utf16StringMarshaller.ConvertToManaged(_data->LargeIconUrl);
+            }
+        }
+
+        /// <inheritdoc cref="DiscordPresenceInfo.LargeIconTooltip"/>
+        public string? LargeIconTooltip
+        {
+            get
+            {
+                if (_data == null || _data->LargeIconTooltip == null)
+                {
+                    return null;
+                }
+
+                return field ??= Utf16StringMarshaller.ConvertToManaged(_data->LargeIconTooltip);
+            }
+        }
+
+        /// <inheritdoc cref="DiscordPresenceInfo.SmallIconUrl"/>
+        public string? SmallIconUrl
+        {
+            get
+            {
+                if (_data == null || _data->SmallIconUrl == null)
+                {
+                    return null;
+                }
+
+                return field ??= Utf16StringMarshaller.ConvertToManaged(_data->SmallIconUrl);
+            }
+        }
+
+        /// <inheritdoc cref="DiscordPresenceInfo.SmallIconTooltip"/>
+        public string? SmallIconTooltip
+        {
+            get
+            {
+                if (_data == null || _data->SmallIconTooltip == null)
+                {
+                    return null;
+                }
+
+                return field ??= Utf16StringMarshaller.ConvertToManaged(_data->SmallIconTooltip);
+            }
+        }
+
+        /// <inheritdoc cref="IDisposable.Dispose"/>
+        public void Dispose()
+        {
+            if (_data == null)
+            {
+                return;
+            }
+
+            _data->Dispose();
+            NativeMemory.Free(_data);
+
+            _data = null;
+
+            GC.SuppressFinalize(this);
+        }
+    }
+}

DiscordPresence/DiscordPresenceInfo.cs

@@ -0,0 +1,60 @@
+using System;
+using System.Runtime.InteropServices;
+using System.Runtime.InteropServices.Marshalling;
+using Hi3Helper.Plugin.Core.Utility;
+
+namespace Hi3Helper.Plugin.Core.DiscordPresence;
+
+/// <summary>
+/// Represents presence information for a Discord user, including logo URLs and tooltips for display in rich presence
+/// integrations.
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+public unsafe struct DiscordPresenceInfo : IDisposable
+{
+    /// <summary>
+    /// Represents the UID of the Discord Application ID.
+    /// </summary>
+    public ulong PresenceId; // 00 - 08
+
+    /// <summary>
+    /// Represents which logo to be used for large-icon display in Discord.<br/>
+    /// The format of the URL can be just the name of the asset inside the Discord Application -> Rich Presence -> Art Assets menu or a full URL to an external logo (max: 256 chars).<br/>
+    /// </summary>
+    public ushort* LargeIconUrl; // 08 - 16
+
+    /// <summary>
+    /// The tooltip text to be displayed when hovering over the large-icon in Discord.
+    /// </summary>
+    public ushort* LargeIconTooltip; // 16 - 24
+
+    /// <summary>
+    /// Represents which logo to be used for small-icon display in Discord.<br/>
+    /// The format of the URL can be just the name of the asset inside the Discord Application -> Rich Presence -> Art Assets menu or a full URL to an external logo (max: 256 chars).<br/>
+    /// </summary>
+    public ushort* SmallIconUrl; // 24 - 32
+
+    /// <summary>
+    /// The tooltip text to be displayed when hovering over the small-icon in Discord.
+    /// </summary>
+    public ushort* SmallIconTooltip; // 32 - 40
+
+    /// <summary>
+    /// Reserved for future use. Should be unused for now.
+    /// </summary>
+    public void* Reserved; // 40 - 48 (For future use)
+
+    /// <inheritdoc cref="IDisposable.Dispose"/>
+    public void Dispose()
+    {
+        Utf16StringMarshaller.Free(LargeIconUrl);
+        Utf16StringMarshaller.Free(LargeIconTooltip);
+        Utf16StringMarshaller.Free(SmallIconUrl);
+        Utf16StringMarshaller.Free(SmallIconTooltip);
+
+        if (Reserved != null)
+        {
+            Mem.Free(Reserved);
+        }
+    }
+}

SharedStatic.V1Ext.cs

@@ -0,0 +1,51 @@
+using Hi3Helper.Plugin.Core.DiscordPresence;
+using Hi3Helper.Plugin.Core.Management;
+using Hi3Helper.Plugin.Core.Utility;
+using System;
+
+namespace Hi3Helper.Plugin.Core;
+
+public class SharedStaticV1Ext : SharedStatic
+{
+    // Update1
+    internal delegate HResult LaunchGameFromGameManagerAsyncDelegate(nint gameManagerP, nint pluginP, nint presetConfigP, nint printGameLogCallbackP, nint arguments, int argumentsLen, int runBoostedInt, int processPriorityInt, ref Guid cancelToken, out nint taskResult);
+    internal delegate HResult WaitRunningGameAsyncDelegate(nint gameManagerP, nint pluginP, nint presetConfigP, ref Guid cancelToken, out nint taskResult);
+    internal delegate HResult IsGameRunningDelegate(nint gameManagerP, nint presetConfigP, out int isGameRunning, out DateTime processStartTime);
+
+    // Update2
+    internal unsafe delegate HResult GetCurrentDiscordPresenceInfoDelegate(void*                 presetConfigP,
+                                                                           DiscordPresenceInfo** presenceInfoP);
+
+}
+
+/// <summary>
+/// Inherited <see cref="SharedStatic"/> with additional supports for API extensions which require call or property access to derived exports.
+/// </summary>
+public partial class SharedStaticV1Ext<T> : SharedStaticV1Ext where T : SharedStatic, new()
+{
+    private static readonly SharedStaticV1Ext<T> ThisExtensionExport;
+
+    static SharedStaticV1Ext()
+    {
+        ThisExtensionExport = new SharedStaticV1Ext<T>();
+
+        /* ----------------------------------------------------------------------
+         * Plugin extension exports
+         * ----------------------------------------------------------------------
+         * These exports are optional and can be removed if it's not necessarily
+         * used. These optional exports are included under additional
+         * functionalities used as a subset of v0.1, which is called "update1"
+         * feature sets.
+         */
+        InitExtension_Update1Exports();
+        InitExtension_Update2Exports();
+    }
+
+    /// <summary>
+    /// Specify which <see cref="IPlugin"/> instance to load and use in this plugin.
+    /// </summary>
+    /// <typeparam name="TPlugin">A member of COM Interface of <see cref="IPlugin"/>.</typeparam>
+    protected new static void Load<TPlugin>(GameVersion interceptDllVersionTo = default)
+        where TPlugin : class, IPlugin, new()
+        => SharedStatic.Load<TPlugin>(interceptDllVersionTo);
+}