From 5387e94b4c2de06fc2005288a27e325819e094e9 Mon Sep 17 00:00:00 2001
From: LoneWandererProductions <petergeinitz@freenet.de>
Date: Wed, 5 Jun 2024 11:52:04 +0200
Subject: [PATCH] Sync back library

---
 .../Image/example Polaris.png                 | Bin 1812 -> 1812 bytes
 CommonLibraryGuiTests/Image/example.png       | Bin 938 -> 938 bytes
 Plugin/IAsyncPlugin.cs                        |  99 ++++++++++++++++++
 Plugin/IPlugin.cs                             |   2 +-
 PluginLoader/PluginLoad.cs                    |  36 ++++---
 5 files changed, 123 insertions(+), 14 deletions(-)
 create mode 100644 Plugin/IAsyncPlugin.cs

diff --git a/CommonLibraryGuiTests/Image/example Polaris.png b/CommonLibraryGuiTests/Image/example Polaris.png
index fbaf0d61449a4e03572982a2da72ddc798364198..b3927c533e282263760f8a87f283bbd547fb7afa 100644
GIT binary patch
delta 22
dcmbQjH-&G42e(iO1A|Zr<GnQbijBbs*#JoN2HOAt

delta 22
ecmbQjH-&G42RGkg1_r*vjK}j=q-+d6$OZsXO$XQj

diff --git a/CommonLibraryGuiTests/Image/example.png b/CommonLibraryGuiTests/Image/example.png
index c4b23ba10e24fed0c1cdd224d4df846c31adc49c..56fabda57bae242233d630857deb62c10a8d464c 100644
GIT binary patch
delta 22
dcmZ3*zKVT<2e(iO1A|Zr<GnQbijBeH%m7NE28;jz

delta 22
ecmZ3*zKVT<2RGkg1_r*vjK}j=q-+chX9fUM`Ui;s

diff --git a/Plugin/IAsyncPlugin.cs b/Plugin/IAsyncPlugin.cs
new file mode 100644
index 0000000..75393c9
--- /dev/null
+++ b/Plugin/IAsyncPlugin.cs
@@ -0,0 +1,99 @@
+/*
+ * COPYRIGHT:   See COPYING in the top level directory
+ * PROJECT:     Plugin
+ * FILE:        Plugin/IAsyncPlugin.cs
+ * PURPOSE:     Basic Plugin Support, in this case async
+ * PROGRAMER:   Peter Geinitz (Wayfarer)
+ * SOURCES:     https://docs.microsoft.com/en-us/dotnet/core/tutorials/creating-app-with-plugin-support
+ */
+
+// ReSharper disable UnusedParameter.Global, future proofing, it is up to the person how to use this ids
+// ReSharper disable UnusedMember.Global
+
+
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Plugin
+{
+    /// <summary>
+    /// Async version of the Plugin Interface
+    /// </summary>
+    public interface IAsyncPlugin
+    {
+        /// <summary>
+        /// Gets the name.
+        /// </summary>
+        /// <value>
+        /// The name.
+        /// </value>
+        string Name { get; }
+
+        /// <summary>
+        /// Gets the type.
+        /// </summary>
+        /// <value>
+        /// The type.
+        /// </value>
+        string Type { get; }
+
+        /// <summary>
+        /// Gets the description.
+        /// </summary>
+        /// <value>
+        /// The description.
+        /// </value>
+        string Description { get; }
+
+        /// <summary>
+        /// Gets the version.
+        /// </summary>
+        /// <value>
+        /// The version.
+        /// </value>
+        Version Version { get; }
+
+        /// <summary>
+        /// Gets the commands.
+        /// </summary>
+        /// <value>
+        /// The commands.
+        /// </value>
+        List<Command> Commands { get; }
+
+        /// <summary>
+        /// Executes the asynchronous.
+        /// </summary>
+        /// <returns>Status Code asnc</returns>
+        Task<int> ExecuteAsync();
+
+        /// <summary>
+        /// Executes the command asynchronous.
+        /// </summary>
+        /// <param name="id">The identifier.</param>
+        /// <returns>Result object, async.</returns>
+        Task<object> ExecuteCommandAsync(int id);
+
+        /// <summary>
+        /// Gets the plugin type asynchronous.
+        /// </summary>
+        /// <param name="id">The identifier.</param>
+        /// <returns>Status Code asnc</returns>
+        Task<int> GetPluginTypeAsync(int id);
+
+        /// <summary>
+        /// Gets the information.
+        /// </summary>
+        /// <returns>
+        ///     Info about the plugin
+        /// </returns>
+        string GetInfo();
+
+        /// <summary>
+        /// Closes asynchronous.
+        /// </summary>
+        /// <returns>Status Code</returns>
+        Task<int> CloseAsync();
+    }
+}
diff --git a/Plugin/IPlugin.cs b/Plugin/IPlugin.cs
index c98a09e..c2554ec 100644
--- a/Plugin/IPlugin.cs
+++ b/Plugin/IPlugin.cs
@@ -84,7 +84,7 @@ public interface IPlugin
         ///     This method is optional.
         /// </summary>
         /// <param name="id">The identifier of the command.</param>
-        /// <returns>Status Code</returns>
+        /// <returns>Result object</returns>
         object ExecuteCommand(int id);
 
         /// <summary>
diff --git a/PluginLoader/PluginLoad.cs b/PluginLoader/PluginLoad.cs
index 86ad065..85171e6 100644
--- a/PluginLoader/PluginLoad.cs
+++ b/PluginLoader/PluginLoad.cs
@@ -38,6 +38,14 @@ public static class PluginLoad
         /// </value>
         public static List<IPlugin> PluginContainer { get; private set; }
 
+        /// <summary>
+        /// Gets the asynchronous plugin container.
+        /// </summary>
+        /// <value>
+        /// The asynchronous plugin container.
+        /// </value>
+        public static List<IAsyncPlugin> AsyncPluginContainer { get; private set; }
+
         /// <summary>
         ///     Loads all.
         /// </summary>
@@ -56,14 +64,18 @@ public static bool LoadAll(string path, string extension = PluginLoaderResources
             }
 
             PluginContainer = new List<IPlugin>();
+            AsyncPluginContainer = new List<IAsyncPlugin>();
 
             foreach (var pluginPath in pluginPaths)
             {
                 try
                 {
                     var pluginAssembly = LoadPlugin(pluginPath);
-                    var lst = CreateCommands(pluginAssembly).ToList();
-                    PluginContainer.AddRange(lst);
+                    var syncPlugins = CreateCommands<IPlugin>(pluginAssembly).ToList();
+                    var asyncPlugins = CreateCommands<IAsyncPlugin>(pluginAssembly).ToList();
+
+                    PluginContainer.AddRange(syncPlugins);
+                    AsyncPluginContainer.AddRange(asyncPlugins);
                 }
                 catch (Exception ex) when (ex is ArgumentException or FileLoadException or ApplicationException
                                                or ReflectionTypeLoadException or BadImageFormatException
@@ -74,7 +86,7 @@ public static bool LoadAll(string path, string extension = PluginLoaderResources
                 }
             }
 
-            return PluginContainer.Count != 0;
+            return PluginContainer.Count != 0 || AsyncPluginContainer.Count != 0;
         }
 
         /// <summary>
@@ -138,20 +150,21 @@ private static Assembly LoadPlugin(string pluginLocation)
         /// <summary>
         ///     Creates the commands.
         /// </summary>
+        /// <typeparam name="T">Type of Plugin</typeparam>
         /// <param name="assembly">The assembly.</param>
-        /// <returns>Adds References to the Commands</returns>
-        /// <exception cref="ApplicationException">
+        /// <returns>
+        /// Adds References to the Commands
         ///     Can't find any type which implements IPlugin in {assembly} from {assembly.Location}.\n" +
         ///     $"Available types: {availableTypes}
-        /// </exception>
+        /// $"Available types: {availableTypes}</exception>
         /// <exception cref="ArgumentException">Could not find the Plugin</exception>
-        private static IEnumerable<IPlugin> CreateCommands(Assembly assembly)
+        private static IEnumerable<T> CreateCommands<T>(Assembly assembly) where T : class
         {
             var count = 0;
 
-            foreach (var type in assembly.GetTypes().Where(type => typeof(IPlugin).IsAssignableFrom(type)))
+            foreach (var type in assembly.GetTypes().Where(type => typeof(T).IsAssignableFrom(type)))
             {
-                if (Activator.CreateInstance(type) is not IPlugin result)
+                if (Activator.CreateInstance(type) is not T result)
                 {
                     continue;
                 }
@@ -165,12 +178,9 @@ private static IEnumerable<IPlugin> CreateCommands(Assembly assembly)
                 yield break;
             }
 
-            var availableTypes =
-                string.Join(PluginLoaderResources.Separator, assembly.GetTypes().Select(t => t.FullName));
-
+            var availableTypes = string.Join(PluginLoaderResources.Separator, assembly.GetTypes().Select(t => t.FullName));
             var message = string.Concat(PluginLoaderResources.ErrorCouldNotFindPlugin,
                 PluginLoaderResources.Information(assembly, availableTypes));
-
             throw new ArgumentException(message);
         }
     }