Changeset 16984 for branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces

Timestamp:

05/24/19 12:28:29 (6 years ago)

Author:

dpiringe

Message:

#2924:

• merged projects HeuristicLab.PluginInfrastructure.Runner and HeuristicLab.PluginInfrastructure
• applied changes of code reviews (13.05.2019 and 22.05.2019) -> the old Runner is now RunnerHost and uses a Runner, which is executed on the child process
• added Type GetType(string) to IApplicationManager and implemented it for LightweightApplicationManager
• removed IActivator and IActivatorContext
• deleted unused types like PluginDescriptionIterator

Location:

branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces

Files:

• IActivator.cs (deleted)
• IActivatorContext.cs (deleted)
• IApplication.cs (modified) (1 diff)
• IApplicationManager.cs (modified) (1 diff)
• IAssemblyLoader.cs (modified) (2 diffs)
• IPluginLoader.cs (modified) (1 diff)
• IRunner.cs (modified) (1 diff)

branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces/IApplication.cs

@@ -38 +38 @@
     /// </summary>
     void Run(ICommandLineArgument[] args);
+
+    /// <summary>
+    /// This method gets called when a cancellation is invoked.
+    /// </summary>
+    void OnCancel();
+
+    /// <summary>
+    /// This method gets called when a pause is invoked.
+    /// </summary>
+    void OnPause();
+
+    /// <summary>
+    /// This method gets called when a resume is invoked.
+    /// </summary>
+    void OnResume();
   }
 }

branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces/IApplicationManager.cs

@@ -52 +52 @@
     /// <returns>An enumerable of instances of the discovered types.</returns>
     IEnumerable<object> GetInstances(Type type);
+
+    /// <summary>
+    /// Discovers a specific type by its name.
+    /// </summary>
+    /// <param name="typeName">Full name of the type.</param>
+    /// <returns>A type or null, if nothing was found.</returns>
+    Type GetType(string typeName);
 
     /// <summary>

branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces/IAssemblyLoader.cs

@@ -2 +2 @@
 using System.Collections.Generic;
 using System.Reflection;
-using System.Text;
 
 namespace HeuristicLab.PluginInfrastructure {
+  /// <summary>
+  /// Interface for an assembly loading mechanism
+  /// </summary>
   public interface IAssemblyLoader {
-    string BasePath { get; set; }
-
     /// <summary>
     /// Returns all loaded assemblies.
     /// </summary>
     IEnumerable<Assembly> Assemblies { get; }
+
     /// <summary>
     /// Returns all types.
@@ -18 +19 @@
 
     /// <summary>
-    /// Returns all assemblies included in BasePath. 
+    /// Loads all assemblies (.dll/.exe) in the specified path.
     /// </summary>
-    /// <returns></returns>
-    IEnumerable<Assembly> GetReflectionOnlyAssemblies();
+    /// <param name="basePath">Path to root directory of all assemblies to load.</param>
+    /// <returns>An IEnumerable of assemblies.</returns>
+    IEnumerable<Assembly> LoadAssemblies(string basePath);
 
     /// <summary>
-    /// Loads all assembliesm which are given by the assemblyName argument, into the current context. 
+    /// Loads all specified assemblies.
     /// </summary>
-    /// <param name="assemblyNames"></param>
-    /// <returns>All loaded assemblies.</returns>
-    IEnumerable<Assembly> LoadAssemblies(IEnumerable<AssemblyName> assemblyNames);
-
+    /// <param name="assemblyInfos">Infos for all assemblies to load.</param>
+    /// <returns>An IEnumerable of assemblies.</returns>
+    IEnumerable<Assembly> LoadAssemblies(IEnumerable<AssemblyInfo> assemblyInfos);
   }
 }

branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces/IPluginLoader.cs

@@ -1 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-using HeuristicLab.PluginInfrastructure;
+using System.Collections.Generic;
 
 namespace HeuristicLab.PluginInfrastructure {
+  /// <summary>
+  /// Interface for a plugin load mechanism.
+  /// </summary>
   public interface IPluginLoader {
-    /// <summary>
-    /// Returns all activators found.
-    /// </summary>
-    IList<IActivator> Activators { get; }
-
     /// <summary>
     /// Returns all plugins found.
     /// </summary>
-    IList<IPlugin> Plugins { get; }
+    IEnumerable<IPlugin> Plugins { get; }
 
     /// <summary>
     /// Returns all Applications found.
     /// </summary>
-    IList<IApplication> Applications { get; }
+    IEnumerable<IApplication> Applications { get; }
+
+    /// <summary>
+    /// Load plugins, definied by the given AssemblyInfos.
+    /// </summary>
+    /// <param name="assemblyInfos">AssemblyInfos for the assemblies, which should be loaded.</param>
+    void LoadPlugins(IEnumerable<AssemblyInfo> assemblyInfos);
+
+    /// <summary>
+    /// Searches for .dll/.exe files and validates them.
+    /// </summary>
+    /// <param name="basePath">Path of the root directory for the assemblies to validate.</param>
+    /// <returns>A IEnumerable of AssemblyInfos, which contains all loadable assemblies. </returns>
+    IEnumerable<AssemblyInfo> Validate(string basePath);
   }
 }

branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces/IRunner.cs

@@ -1 +1 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Text;
 
 namespace HeuristicLab.PluginInfrastructure {
-
-  /// <summary>
-  /// Interface for all runner implementations.
-  /// </summary>
   public interface IRunner {
     /// <summary>
-    /// Method to start the runner which scans all assemblies in the given basePath argument. 
-    /// Additionally, arguments can be specified, which are forwarded to all activators.
+    /// Set this to true, if console output should be disabled.
     /// </summary>
-    /// <param name="basePath"></param>
-    /// <param name="args"></param>
-    void Start(string basePath, string[] args);
+    bool QuietMode { get; set; }
 
-    void Stop();
+    /// <summary>
+    /// Assemblies which the child process needs to load.
+    /// </summary>
+    IEnumerable<AssemblyInfo> AssembliesToLoad { get; set; }
+
+    /// <summary>
+    /// Method to run the runner.
+    /// </summary>
+    void Run();
   }
 }