diff --git a/src/BizHawk.Client.Common/Api/APISubsetContainer.cs b/src/BizHawk.Client.Common/Api/APISubsetContainer.cs index 0fc261c6a0..276a44f9d5 100644 --- a/src/BizHawk.Client.Common/Api/APISubsetContainer.cs +++ b/src/BizHawk.Client.Common/Api/APISubsetContainer.cs @@ -7,15 +7,15 @@ namespace BizHawk.Client.Common { public Dictionary Libraries { get; set; } - public IEmu Emu => (IEmu) Libraries[typeof(EmuApi)]; - public IGameInfo GameInfo => (IGameInfo) Libraries[typeof(GameInfoApi)]; - public IJoypad Joypad => (IJoypad) Libraries[typeof(JoypadApi)]; - public IMem Mem => (IMem) Libraries[typeof(MemApi)]; - public IMemEvents MemEvents => (IMemEvents) Libraries[typeof(MemEventsApi)]; - public IMemorySaveState MemorySaveState => (IMemorySaveState) Libraries[typeof(MemorySaveStateApi)]; - public IInputMovie Movie => (IInputMovie) Libraries[typeof(MovieApi)]; - public ISql Sql => (ISql) Libraries[typeof(SqlApi)]; - public IUserData UserData => (IUserData) Libraries[typeof(UserDataApi)]; + public IEmu Emu => (IEmu) Libraries[typeof(IEmu)]; + public IGameInfo GameInfo => (IGameInfo) Libraries[typeof(IGameInfo)]; + public IJoypad Joypad => (IJoypad) Libraries[typeof(IJoypad)]; + public IMem Mem => (IMem) Libraries[typeof(IMem)]; + public IMemEvents MemEvents => (IMemEvents) Libraries[typeof(IMemEvents)]; + public IMemorySaveState MemorySaveState => (IMemorySaveState) Libraries[typeof(IMemorySaveState)]; + public IInputMovie Movie => (IInputMovie) Libraries[typeof(IInputMovie)]; + public ISql Sql => (ISql) Libraries[typeof(ISql)]; + public IUserData UserData => (IUserData) Libraries[typeof(IUserData)]; public ApiSubsetContainer(Dictionary libs) { diff --git a/src/BizHawk.Client.Common/Api/ApiHawkExtensions.cs b/src/BizHawk.Client.Common/Api/ApiHawkExtensions.cs new file mode 100644 index 0000000000..71bccd55ff --- /dev/null +++ b/src/BizHawk.Client.Common/Api/ApiHawkExtensions.cs @@ -0,0 +1,17 @@ +#nullable enable + +namespace BizHawk.Client.Common +{ + public static class ApiHawkExtensions + { + /// an instance of the iff available else + public static T? GetApi(this IExternalApiProvider apiProvider) + where T : class, IExternalApi + => apiProvider.GetApi(typeof(T)) as T; + + /// iff an instance of the is available + public static bool HasApi(this IExternalApiProvider apiProvider) + where T : class, IExternalApi + => apiProvider.HasApi(typeof(T)); + } +} diff --git a/src/BizHawk.Client.Common/Api/BasicApiProvider.cs b/src/BizHawk.Client.Common/Api/BasicApiProvider.cs index 8ba920cccf..0e9fc41dd1 100644 --- a/src/BizHawk.Client.Common/Api/BasicApiProvider.cs +++ b/src/BizHawk.Client.Common/Api/BasicApiProvider.cs @@ -1,67 +1,21 @@ -using System; +#nullable enable + +using System; using System.Collections.Generic; using System.Linq; namespace BizHawk.Client.Common { - /// - /// A generic implementation of IExternalApi provider that provides - /// this functionality to any core. - /// The provider will scan an IExternal and register all IExternalApis - /// that the core object itself implements. In addition it provides - /// a Register() method to allow the core to pass in any additional Apis - /// - /// public class BasicApiProvider : IExternalApiProvider { - private readonly Dictionary _apis; + private readonly IReadOnlyDictionary _libs; - public BasicApiProvider(IApiContainer container) - { - // simplified logic here doesn't scan for possible Apis; just adds what it knows is implemented by the PluginApi - // this removes the possibility of automagically picking up a Api in a nested class, (find the type, then - // find the field), but we're going to keep such logic out of the basic provider. Anything the passed - // container doesn't implement directly needs to be added with Register() - // this also fully allows apis that are not IExternalApi - var libs = container.Libraries; + public IReadOnlyCollection AvailableApis => _libs.Keys.ToList(); - _apis = libs; - } + public BasicApiProvider(IReadOnlyDictionary libs) => _libs = libs; - /// the client can call this to register an additional API - /// the type, inheriting , to be registered - /// is null - public void Register(T api) - where T : IExternalApi - { - if (api == null) - { - throw new ArgumentNullException(nameof(api)); - } + public object? GetApi(Type t) => _libs.TryGetValue(t, out var api) ? api : null; - _apis[typeof(T)] = api; - } - - public T GetApi() - where T : IExternalApi - { - return (T)GetApi(typeof(T)); - } - - public object GetApi(Type t) - { - var k = _apis.Where(kvp => t.IsAssignableFrom(kvp.Key)).ToArray(); - return k.Length > 0 ? k[0].Value : null; - } - - public bool HasApi() - where T : IExternalApi - { - return HasApi(typeof(T)); - } - - public bool HasApi(Type t) => _apis.ContainsKey(t); - - public IEnumerable AvailableApis => _apis.Select(d => d.Key); + public bool HasApi(Type t) => _libs.ContainsKey(t); } } diff --git a/src/BizHawk.Client.Common/Api/IExternalApiProvider.cs b/src/BizHawk.Client.Common/Api/IExternalApiProvider.cs index 70f6efe88a..eefa6c855c 100644 --- a/src/BizHawk.Client.Common/Api/IExternalApiProvider.cs +++ b/src/BizHawk.Client.Common/Api/IExternalApiProvider.cs @@ -1,46 +1,19 @@ -using System; +#nullable enable + +using System; using System.Collections.Generic; namespace BizHawk.Client.Common { - /// - /// This interface defines the mechanism by which External tools can retrieve - /// from a client implementation - /// An implementation should collect all available IExternalApi instances. - /// This interface defines only the external interaction. This interface does not specify the means - /// by which a api provider will be populated with available apis. However, an implementation - /// by design must provide this mechanism - /// - /// public interface IExternalApiProvider { - /// e - /// Returns whether or not T is available - /// - /// The to check - bool HasApi() where T : IExternalApi; + /// a list of all currently registered APIs that are available + IReadOnlyCollection AvailableApis { get; } - /// - /// Returns whether or not t is available - /// + /// an instance of the iff available else + object? GetApi(Type t); + + /// iff an instance of the is available bool HasApi(Type t); - - /// - /// Returns an instance of T if T is available - /// Else returns null - /// - /// The requested - T GetApi() where T : IExternalApi; - - /// - /// Returns an instance of t if t is available - /// Else returns null - /// - object GetApi(Type t); - - /// - /// Gets a list of all currently registered Apis available to be retrieved - /// - IEnumerable AvailableApis { get; } } } diff --git a/src/BizHawk.Client.EmuHawk/Api/ApiContainer.cs b/src/BizHawk.Client.EmuHawk/Api/ApiContainer.cs index 7e981d87f2..25bd548b5c 100644 --- a/src/BizHawk.Client.EmuHawk/Api/ApiContainer.cs +++ b/src/BizHawk.Client.EmuHawk/Api/ApiContainer.cs @@ -7,11 +7,11 @@ namespace BizHawk.Client.EmuHawk { public sealed class ApiContainer : ApiSubsetContainer { - public IComm Comm => (IComm) Libraries[typeof(CommApi)]; - public IGui Gui => (IGui) Libraries[typeof(GuiApi)]; - public IInput Input => (IInput) Libraries[typeof(InputApi)]; - public ISaveState SaveState => (ISaveState) Libraries[typeof(SaveStateApi)]; - public ITool Tool => (ITool) Libraries[typeof(ToolApi)]; + public IComm Comm => (IComm) Libraries[typeof(IComm)]; + public IGui Gui => (IGui) Libraries[typeof(IGui)]; + public IInput Input => (IInput) Libraries[typeof(IInput)]; + public ISaveState SaveState => (ISaveState) Libraries[typeof(ISaveState)]; + public ITool Tool => (ITool) Libraries[typeof(ITool)]; public ApiContainer(Dictionary libs) : base(libs) {} } diff --git a/src/BizHawk.Client.EmuHawk/Api/ApiManager.cs b/src/BizHawk.Client.EmuHawk/Api/ApiManager.cs index 7a4cf0ccca..4548170eaf 100644 --- a/src/BizHawk.Client.EmuHawk/Api/ApiManager.cs +++ b/src/BizHawk.Client.EmuHawk/Api/ApiManager.cs @@ -11,22 +11,25 @@ namespace BizHawk.Client.EmuHawk { public static class ApiManager { + /// TODO do we need to keep this reference around? --yoshi private static ApiContainer _container; + private static IExternalApiProvider Register(IEmulatorServiceProvider serviceProvider) { foreach (var api in Assembly.GetAssembly(typeof(ApiSubsetContainer)).GetTypes() .Concat(Assembly.GetAssembly(typeof(ApiContainer)).GetTypes()) - .Where(t => typeof(IExternalApi).IsAssignableFrom(t) && t.IsSealed && ServiceInjector.IsAvailable(serviceProvider, t))) + .Where(t => /*t.IsClass && */t.IsSealed && typeof(IExternalApi).IsAssignableFrom(t) && ServiceInjector.IsAvailable(serviceProvider, t))) { var instance = (IExternalApi)Activator.CreateInstance(api); ServiceInjector.UpdateServices(serviceProvider, instance); - Libraries.Add(api, instance); + Libraries.Add(api.GetInterfaces().First(intf => typeof(IExternalApi).IsAssignableFrom(intf) && intf != typeof(IExternalApi)), instance); } _container = new ApiContainer(Libraries); - return new BasicApiProvider(_container); + return new BasicApiProvider(Libraries); } private static readonly Dictionary Libraries = new Dictionary(); + public static IExternalApiProvider Restart(IEmulatorServiceProvider newServiceProvider) { Libraries.Clear();