refactor: NativeBindingContext

NativeBindingInfo -> NativeBindingContext

Author: moomiji

src/MaaFramework.Binding.Native/Interop/NativeLibrary.cs

@@ -8,25 +8,23 @@ internal static partial class NativeLibrary
 {
     private static readonly Assembly s_assembly = typeof(NativeLibrary).Assembly;
 
-    private static bool s_isAgentServer;
-    private static readonly List<string> s_searchPath = [];
-    private static readonly Dictionary<string, nint> s_libraryHandles = [];
-
 #pragma warning disable CA2255 // 不应在库中使用 “ModuleInitializer” 属性
-    [ModuleInitializer]
-    internal static void SetNativeAssemblyResolver() => SetDllImportResolver(s_assembly, NativeAssemblyResolver);
-#pragma warning restore CA2255 // 不应在库中使用 “ModuleInitializer” 属性
+#pragma warning disable S2223 // Non-constant static fields should not be visible
 
-    public static void Init(bool isAgentServer, params string[] paths)
-    {
-        if (s_libraryHandles.Count != 0)
-            throw new InvalidOperationException("NativeLibrary is already loaded.");
+    internal static bool IsLoaded;
+    internal static string LoadedDirectory = string.Empty;
+    internal static readonly Dictionary<string, nint> LoadedLibraryHandles = [];
 
-        s_isAgentServer = isAgentServer;
-        s_searchPath.AddRange(paths);
-    }
+    internal static ApiInfoFlags ApiInfo;
+    internal static readonly List<string> SearchPath = [];
+
+    [ModuleInitializer]
+    internal static void SetNativeLibraryResolver() => SetDllImportResolver(s_assembly, NativeLibraryResolver);
+
+#pragma warning restore S2223 // Non-constant static fields should not be visible
+#pragma warning restore CA2255 // 不应在库中使用 “ModuleInitializer” 属性
 
-    public static IntPtr NativeAssemblyResolver(string libraryName, Assembly assembly, DllImportSearchPath? searchPath) => libraryName switch
+    public static nint NativeLibraryResolver(string libraryName, Assembly assembly, DllImportSearchPath? searchPath) => libraryName switch
     {
         "MaaFramework" or "MaaToolkit"
         or "MaaAgentServer" or "MaaAgentClient" => GetLibraryHandle(libraryName),
@@ -36,32 +34,36 @@ public static void Init(bool isAgentServer, params string[] paths)
 
     private static nint GetLibraryHandle(string libraryName)
     {
-        if (s_libraryHandles.TryGetValue(libraryName, out var libraryHandle))
+        if (LoadedLibraryHandles.TryGetValue(libraryName, out var libraryHandle))
             return libraryHandle;
 
-        if (!TryGetRuntimesPath(libraryName, out var dllPath) || !TryLoad(dllPath, out libraryHandle))
-        {
-            s_libraryHandles.Add(libraryName, nint.Zero);
-            NativeBindingInfo.NativeAssemblyDirectory = null;
-            NativeBindingInfo.IsStatelessMode = false;
-            NativeBindingInfo.ApiInfo = "Using default dll resolver.";
-            return nint.Zero;
-        }
+        IsLoaded = true;
+        var resolver = TryGetRuntimesPath(libraryName, out var dllPath) && TryLoad(dllPath, out libraryHandle)
+            ? ApiInfoFlags.UseBindingResolver
+            : ApiInfoFlags.UseDefaultResolver;
+        SetBindingContext(
+            resolver,
+            dllDir: Path.GetDirectoryName(dllPath) ?? string.Empty,
+            isFirst: LoadedLibraryHandles.Count == 0);
+
+        LoadedLibraryHandles.Add(libraryName, libraryHandle);
+        return libraryHandle;
+    }
 
-        s_libraryHandles.Add(libraryName, libraryHandle);
+    private static void SetBindingContext(ApiInfoFlags resolver, string dllDir, bool isFirst)
+    {
+        if (ApiInfo.HasFlag_ResolverExcept(resolver))
+            throw new InvalidOperationException($"The resolver '{ApiInfo}' was attempted to switch to '{resolver}'.");
 
-        var dllDir = Path.GetDirectoryName(dllPath);
-        if (s_libraryHandles.Count == 1)
-        {
-            NativeBindingInfo.NativeAssemblyDirectory ??= dllDir;
-            NativeBindingInfo.IsStatelessMode = s_isAgentServer;
-            NativeBindingInfo.ApiInfo = s_isAgentServer ? "In MaaAgentServer context." : "In MaaFramework context.";
-        }
+        if (isFirst)
+            LoadedDirectory = dllDir;
 
-        if (NativeBindingInfo.NativeAssemblyDirectory != dllDir)
-            throw new InvalidOperationException($"The native assembly directory '{NativeBindingInfo.NativeAssemblyDirectory}' was switched to '{dllDir}'.");
+        if (LoadedDirectory != dllDir)
+            throw new InvalidOperationException($"The native library directory '{LoadedDirectory}' was attempted to switch to '{dllDir}'.");
 
-        return libraryHandle;
+        ApiInfo |= resolver;
+        if (!ApiInfo.HasFlag_Context())
+            ApiInfo |= ApiInfoFlags.InFrameworkContext;
     }
 
     private static bool TryGetRuntimesPath(string libraryName, out string dllPath)
@@ -73,7 +75,7 @@ private static bool TryGetRuntimesPath(string libraryName, out string dllPath)
 
     private static IEnumerable<string> GetRuntimesPaths(string libraryFullName)
     {
-        var searchPaths = s_searchPath.Concat(
+        var searchPaths = SearchPath.Concat(
         [
             Environment.GetEnvironmentVariable("MAAFW_BINARY_PATH"),
             Path.GetDirectoryName(s_assembly.Location),
@@ -82,8 +84,8 @@ private static IEnumerable<string> GetRuntimesPaths(string libraryFullName)
 
         var runtimePaths = new[]
         {
+            "./",
             $"./runtimes/{GetArchitectureName()}/native/",
-            "./"
         };
 
         return from searchPath in searchPaths
@@ -109,7 +111,7 @@ select Path.GetFullPath(
 
     private static string GetFullLibraryName(string libraryName)
     {
-        if (s_isAgentServer && libraryName == "MaaFramework")
+        if (libraryName == "MaaFramework" && ApiInfo.HasFlag(ApiInfoFlags.InAgentServerContext))
             libraryName = "MaaAgentServer";
 
         if (IsWindows)

src/MaaFramework.Binding.Native/MaaAgentClient.cs

@@ -157,16 +157,8 @@ public bool LinkStart(IMaaAgentClient.AgentServerStartupMethod method, Cancellat
     {
         if (_agentServerProcess is null or { HasExited: true })
         {
-            if (string.IsNullOrEmpty(Id) || string.IsNullOrEmpty(NativeBindingInfo.NativeAssemblyDirectory))
-            {
-                throw new InvalidOperationException(
-                    $"The {nameof(Id)}({Id ?? "<null>"})" +
-                    $" or {nameof(NativeBindingInfo.NativeAssemblyDirectory)}({NativeBindingInfo.NativeAssemblyDirectory ?? "<null>"})" +
-                    $" is invalid.");
-            }
-
             _agentServerProcess?.Dispose();
-            _agentServerProcess = method.Invoke(Id, NativeBindingInfo.NativeAssemblyDirectory);
+            _agentServerProcess = method.Invoke(Id, NativeBindingContext.LoadedNativeLibraryDirectory);
 
             if (_agentServerProcess is null or { HasExited: true })
                 return false;

src/MaaFramework.Binding.Native/MaaAgentServer.cs

@@ -28,7 +28,7 @@ public sealed class MaaAgentServer : IMaaAgentServer
     private MaaAgentServer() { }
     static MaaAgentServer()
     {
-        NativeLibrary.Init(isAgentServer: true);
+        NativeBindingContext.SwitchToAgentServerContext();
         CurrentId = string.Empty;
         Current = new();
     }
@@ -146,7 +146,7 @@ public static MaaAgentServer WithToolkitConfig_InitOption(this MaaAgentServer se
     /// <param name="paths">The directory paths to search for native libraries.</param>
     public static MaaAgentServer WithNativeLibrary(this MaaAgentServer server, params string[] paths)
     {
-        NativeLibrary.Init(true, paths);
+        NativeBindingContext.AppendNativeLibrarySearchPaths(paths);
         return server;
     }
 }

src/MaaFramework.Binding.Native/MaaContext.cs

@@ -102,7 +102,7 @@ public MaaTasker Tasker
         get
         {
             var taskerHandle = MaaContextGetTasker(Handle);
-            if (NativeBindingInfo.IsStatelessMode)
+            if (NativeBindingContext.IsStatelessMode)
                 return new MaaTasker(taskerHandle);
             else
                 return MaaTasker.Instances[taskerHandle];

src/MaaFramework.Binding.Native/NativeBindingContext.cs

@@ -0,0 +1,85 @@
+using MaaFramework.Binding.Interop.Native;
+using System.Diagnostics;
+
+namespace MaaFramework.Binding;
+
+/// <summary>
+///     Provides information and configuration for native bindings in the MaaFramework.
+/// </summary>
+public static class NativeBindingContext
+{
+    /// <summary>
+    ///     Gets a value indicating whether NativeLibrary is already loaded.
+    /// </summary>
+    public static bool IsLoaded => NativeLibrary.IsLoaded;
+
+    /// <summary>
+    ///     Gets the loaded directory path where native libraries are located.
+    /// </summary>
+    public static string LoadedNativeLibraryDirectory
+    {
+        get
+        {
+            if (!NativeLibrary.ApiInfo.HasFlag(ApiInfoFlags.UseDefaultResolver))
+                return NativeLibrary.LoadedDirectory;
+
+            var name = NativeLibrary.LoadedLibraryHandles.First().Key;
+            foreach (var obj in Process.GetCurrentProcess().Modules)
+            {
+                if (obj is not ProcessModule module || Path.GetFileNameWithoutExtension(module.ModuleName) != name)
+                    continue;
+                return Path.GetDirectoryName(module.FileName) ?? string.Empty;
+            }
+            return string.Empty;
+        }
+    }
+
+    /// <summary>
+    ///     Gets the API information, which provides details about the current API context.
+    /// </summary>
+    public static ApiInfoFlags ApiInfo => NativeLibrary.ApiInfo;
+
+    /// <summary>
+    ///     Gets a value indicating whether the current API is interoperating in the stateless mode.
+    ///     <para>Stateless mode is typically used in server contexts.</para>
+    /// </summary>
+    public static bool IsStatelessMode => ApiInfo.HasFlag(ApiInfoFlags.InAgentServerContext);
+
+    /// <summary>
+    ///     Switches the context to the MaaAgentServer context.
+    /// </summary>
+    /// <exception cref="InvalidOperationException">NativeLibrary is already loaded.</exception>
+    public static void SwitchToAgentServerContext()
+    {
+        ThrowIfLoaded();
+        NativeLibrary.ApiInfo = ApiInfoFlags.InAgentServerContext;
+    }
+
+    /// <summary>
+    ///     Switches the context to the MaaFramework context.
+    /// </summary>
+    /// <exception cref="InvalidOperationException">NativeLibrary is already loaded.</exception>
+    public static void SwitchToFrameworkContext()
+    {
+        ThrowIfLoaded();
+        NativeLibrary.ApiInfo = ApiInfoFlags.InFrameworkContext;
+    }
+
+    /// <summary>
+    ///    Appends the specified paths to the native library search paths.
+    /// </summary>
+    /// <param name="paths"></param>
+    /// <exception cref="InvalidOperationException">NativeLibrary is already loaded.</exception>
+    public static void AppendNativeLibrarySearchPaths(params IEnumerable<string> paths)
+    {
+        ThrowIfLoaded();
+        NativeLibrary.SearchPath.AddRange(paths);
+    }
+
+    /// <exception cref="InvalidOperationException">NativeLibrary is already loaded.</exception>
+    internal static void ThrowIfLoaded()
+    {
+        if (NativeLibrary.IsLoaded)
+            throw new InvalidOperationException("NativeLibrary is already loaded.");
+    }
+}

src/MaaFramework.Binding.Native/NativeBindingInfo.cs

@@ -6,7 +6,7 @@
         <PackageReference Include="MSTest.TestFramework" />
         <PackageReference Include="SixLabors.ImageSharp" />
 
-        <ProjectReference Include="..\MaaFramework\MaaFramework.csproj" />
+        <ProjectReference Include="..\MaaFramework\MaaFramework.csproj" Private="false" />
         <ProjectReference Include="..\MaaFramework.Binding.Extensions\MaaFramework.Binding.Extensions.csproj" />
 
         <None Include="..\Common\TestParam.runsettings" />

src/MaaFramework.Binding.UnitTests/MaaFramework.Binding.UnitTests.csproj

@@ -0,0 +1,44 @@
+namespace MaaFramework.Binding;
+
+#pragma warning disable S2344 // Enumeration type names should not have "Flags" or "Enum" suffixes
+
+/// <summary>
+///     Represents information about binding interoperable API.
+/// </summary>
+[Flags]
+public enum ApiInfoFlags
+{
+    /// <summary>
+    ///     No flags.
+    /// </summary>
+    None = 0,
+
+    /// <summary>
+    ///     Indicates that the API is in MaaFramework context.
+    /// </summary>
+    InFrameworkContext = 1,
+
+    /// <summary>
+    ///     Indicates that the API is in MaaAgentServer context.
+    /// </summary>
+    InAgentServerContext = 2,
+
+    /// <summary>
+    ///    Indicates that the API uses the default resolver.
+    /// </summary>
+    UseDefaultResolver = 1 << 8,
+
+    /// <summary>
+    ///    Indicates that the API uses the resolver from binding.
+    /// </summary>
+    UseBindingResolver = 2 << 8,
+}
+
+internal static class ApiInfoFlagsExtensions
+{
+    internal const ApiInfoFlags ContextMask = ApiInfoFlags.InFrameworkContext | ApiInfoFlags.InAgentServerContext;
+    internal const ApiInfoFlags ResolverMask = ApiInfoFlags.UseDefaultResolver | ApiInfoFlags.UseBindingResolver;
+
+    internal static bool HasFlag_Context(this ApiInfoFlags flags) => (flags & ContextMask) != ApiInfoFlags.None;
+    internal static bool HasFlag_ResolverExcept(this ApiInfoFlags flags, ApiInfoFlags other) => (flags & ~other & ResolverMask) != ApiInfoFlags.None;
+}

src/MaaFramework.Binding/Enums/Binding/ApiInfoFlags.cs

@@ -49,7 +49,6 @@ public interface IMaaAgentClient : IMaaDisposable
     /// <param name="method">The delegate method that defines how to start the agent server process.</param>
     /// <param name="cancellationToken">An optional token to cancel the asynchronous operation waiting for the connection.</param>
     /// <returns><see langword="true"/> if the connection was started successfully; otherwise, <see langword="false"/>.</returns>
-    /// <exception cref="InvalidOperationException">One or more parameters required by the <paramref name="method"/> are invalid.</exception>
     /// <exception cref="OperationCanceledException">The <paramref name="cancellationToken"/> has had cancellation requested.</exception>
     bool LinkStart(AgentServerStartupMethod method, CancellationToken cancellationToken = default);
 
@@ -79,6 +78,10 @@ public interface IMaaAgentClient : IMaaDisposable
     /// <returns>
     ///     A new <see cref="Process"/> that is associated with the process resource, or <see langword="null"/> if no process resource is started.
     /// </returns>
+    /// <remarks>
+    ///     <para>The implementation of this delegate is responsible for validating the provided parameters.</para>
+    ///     <para>Ensure that <paramref name="identifier"/> and <paramref name="nativeAssemblyDirectory"/> are valid and meet the requirements of the agent server process.</para>
+    /// </remarks>
     delegate Process? AgentServerStartupMethod(string identifier, string nativeAssemblyDirectory);
 
     /// <summary>

src/MaaFramework.Binding/IMaaAgentClient.cs

@@ -12,4 +12,8 @@
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     </PropertyGroup>
 
+    <ItemGroup>
+        <InternalsVisibleTo Include="MaaFramework.Binding.Native" />
+    </ItemGroup>
+
 </Project>