using System.Collections.Generic; using System.Linq; using StardewModdingAPI.Framework.Reflection; namespace StardewModdingAPI.Framework.ModHelpers { /// <summary>Provides metadata about installed mods.</summary> internal class ModRegistryHelper : BaseHelper, IModRegistry { /********* ** Properties *********/ /// <summary>The underlying mod registry.</summary> private readonly ModRegistry Registry; /// <summary>Encapsulates monitoring and logging for the mod.</summary> private readonly IMonitor Monitor; /// <summary>The mod IDs for APIs accessed by this instanced.</summary> private readonly HashSet<string> AccessedModApis = new HashSet<string>(); /// <summary>Generates proxy classes to access mod APIs through an arbitrary interface.</summary> private readonly InterfaceProxyFactory ProxyFactory; /********* ** Public methods *********/ /// <summary>Construct an instance.</summary> /// <param name="modID">The unique ID of the relevant mod.</param> /// <param name="registry">The underlying mod registry.</param> /// <param name="proxyFactory">Generates proxy classes to access mod APIs through an arbitrary interface.</param> /// <param name="monitor">Encapsulates monitoring and logging for the mod.</param> public ModRegistryHelper(string modID, ModRegistry registry, InterfaceProxyFactory proxyFactory, IMonitor monitor) : base(modID) { this.Registry = registry; this.ProxyFactory = proxyFactory; this.Monitor = monitor; } /// <summary>Get metadata for all loaded mods.</summary> public IEnumerable<IModInfo> GetAll() { return this.Registry.GetAll(); } /// <summary>Get metadata for a loaded mod.</summary> /// <param name="uniqueID">The mod's unique ID.</param> /// <returns>Returns the matching mod's metadata, or <c>null</c> if not found.</returns> public IModInfo Get(string uniqueID) { return this.Registry.Get(uniqueID); } /// <summary>Get whether a mod has been loaded.</summary> /// <param name="uniqueID">The mod's unique ID.</param> public bool IsLoaded(string uniqueID) { return this.Registry.Get(uniqueID) != null; } /// <summary>Get the API provided by a mod, or <c>null</c> if it has none. This signature requires using the <see cref="IModHelper.Reflection"/> API to access the API's properties and methods.</summary> public object GetApi(string uniqueID) { IModMetadata mod = this.Registry.Get(uniqueID); if (mod?.Api != null && this.AccessedModApis.Add(mod.Manifest.UniqueID)) this.Monitor.Log($"Accessed mod-provided API for {mod.DisplayName}.", LogLevel.Trace); return mod?.Api; } /// <summary>Get the API provided by a mod, mapped to a given interface which specifies the expected properties and methods. If the mod has no API or it's not compatible with the given interface, get <c>null</c>.</summary> /// <typeparam name="TInterface">The interface which matches the properties and methods you intend to access.</typeparam> /// <param name="uniqueID">The mod's unique ID.</param> public TInterface GetApi<TInterface>(string uniqueID) where TInterface : class { // validate if (!this.Registry.AreAllModsInitialised) { this.Monitor.Log("Tried to access a mod-provided API before all mods were initialised.", LogLevel.Error); return null; } if (!typeof(TInterface).IsInterface) { this.Monitor.Log($"Tried to map a mod-provided API to class '{typeof(TInterface).FullName}'; must be a public interface.", LogLevel.Error); return null; } if (!typeof(TInterface).IsPublic) { this.Monitor.Log($"Tried to map a mod-provided API to non-public interface '{typeof(TInterface).FullName}'; must be a public interface.", LogLevel.Error); return null; } // get raw API object api = this.GetApi(uniqueID); if (api == null) return null; // get API of type if (api is TInterface castApi) return castApi; return this.ProxyFactory.CreateProxy<TInterface>(api, this.ModID, uniqueID); } } }