Changeset 2488 for branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure

Timestamp:

11/12/09 17:45:45 (15 years ago)

Author:

gkronber

Message:

Worked on plugin infrastructure refactoring. (Fully functional revision). #799

Location:

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure

Files:

• ApplicationManager.cs (added)
• Attributes/ApplicationAttribute.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/ApplicationDescriptionAttribute.cs) (4 diffs)
• Attributes/PluginAttribute.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/PluginDescriptionAttribute.cs) (2 diffs)
• BaseClasses/ApplicationBase.cs (modified) (6 diffs)
• BaseClasses/PluginBase.cs (modified) (2 diffs)
• ControlManager.cs (modified) (1 diff)
• DiscoveryService.cs (modified) (4 diffs)
• HeuristicLab.PluginInfrastructure.csproj (modified) (1 diff)
• Interfaces/IApplicationDescription.cs (added)
• Interfaces/IApplicationManager.cs (added)
• Interfaces/IPluginDescription.cs (added)
• PluginDescriptionIterator.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/PluginDescriptionIterator.cs) (2 diffs)
• PluginState.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure.Manager/PluginState.cs) (1 diff)

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/ApplicationAttribute.cs

@@ -30 +30 @@
   /// </summary>
   [AttributeUsage(AttributeTargets.Class)]
-  public class ApplicationDescriptionAttribute : System.Attribute {
+  public class ApplicationAttribute : System.Attribute {
     private string name;
     /// <summary>
@@ -40 +40 @@
     }
 
-    private string version;
-    /// <summary>
-    /// Gets or sets the version of the application.
-    /// </summary>
-    public string Version {
-      get { return version; }
-      set { version = value; }
-    }
+    //private string version;
+    ///// <summary>
+    ///// Gets or sets the version of the application.
+    ///// </summary>
+    //public string Version {
+    //  get { return version; }
+    //  set { version = value; }
+    //}
 
     private string description;
@@ -68 +68 @@
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ApplicationDescriptionAttribute"/>.
+    /// Initializes a new instance of <see cref="ApplicationAttribute"/>.
     /// <param name="name">Name of the application</param>
     /// </summary>
-    public ApplicationDescriptionAttribute(string name)
+    public ApplicationAttribute(string name)
       : this(name, "") {
     }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ApplicationDescriptionAttribute"/>.
+    /// Initializes a new instance of <see cref="ApplicationAttribute"/>.
     /// <param name="name">Name of the application</param>
     /// <param name="description">Description of the application</param>
     /// </summary>
-    public ApplicationDescriptionAttribute(string name, string description)
-      : this(name, description, "") {
+    public ApplicationAttribute(string name, string description)
+      : this(name, description, false) {
     }
 
-    /// <summary>
-    /// Initializes a new instance of <see cref="ApplicationDescriptionAttribute"/>.
-    /// <param name="name">Name of the application</param>
-    /// <param name="description">Description of the application</param>
-    /// <param name="version">Version string of the application</param>
-    /// </summary>
-    public ApplicationDescriptionAttribute(string name, string description, string version)
-      : this(name, description, version, false) {
-    }
+    ///// <summary>
+    ///// Initializes a new instance of <see cref="ApplicationAttribute"/>.
+    ///// <param name="name">Name of the application</param>
+    ///// <param name="description">Description of the application</param>
+    ///// <param name="version">Version string of the application</param>
+    ///// </summary>
+    //public ApplicationAttribute(string name, string description, string version)
+    //  : this(name, description, version, false) {
+    //}
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ApplicationDescriptionAttribute"/>.
+    /// Initializes a new instance of <see cref="ApplicationAttribute"/>.
     /// <param name="name">Name of the application</param>
     /// <param name="description">Description of the application</param>
@@ -101 +101 @@
     /// <param name="restartOnErrors">Flag that indicates if the application should be restarted on exceptions (for services)</param>
     /// </summary>
-    public ApplicationDescriptionAttribute(string name, string description, string version, bool restartOnErrors) {
+    public ApplicationAttribute(string name, string description, bool restartOnErrors) {
       this.name = name;
-      this.version = version;
       this.description = description;
       this.restartOnErrors = restartOnErrors;

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/PluginAttribute.cs

@@ -30 +30 @@
   /// </summary>
   [AttributeUsage(AttributeTargets.Class)]
-  public class PluginDescriptionAttribute : System.Attribute {
+  public class PluginAttribute : System.Attribute {
     private string name;
     /// <summary>
@@ -49 +49 @@
     //}
 
-    //private string description;
-    ///// <summary>
-    ///// Gets or sets the description of the plugin.
-    ///// </summary>
-    //public string Description {
-    //  get { return description; }
-    //  set { description = value; }
-    //}
+    private string description;
+    /// <summary>
+    /// Gets or sets the description of the plugin.
+    /// </summary>
+    public string Description {
+      get { return description; }
+      // set { description = value; }
+    }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="PluginDescriptionAttribute"/>.
+    /// Initializes a new instance of <see cref="PluginAttribute"/>.
     /// <param name="name">Name of the plugin</param>
     /// </summary>
-    public PluginDescriptionAttribute(string name) {
-      this.name = name;
+    public PluginAttribute(string name)
+      : this(name, "") {
     }
 
-    ///// <summary>
-    ///// Initializes a new instance of <see cref="PluginDescriptionAttribute"/>.
-    ///// <param name="name">Name of the plugin</param>
-    ///// <param name="description">Description of the plugin</param>
-    ///// </summary>
-    //public PluginDescriptionAttribute(string name, string description)
-    //  : this(name, description, "") {
-    //}
+    /// <summary>
+    /// Initializes a new instance of <see cref="PluginAttribute"/>.
+    /// <param name="name">Name of the plugin</param>
+    /// <param name="description">Description of the plugin</param>
+    /// </summary>
+    public PluginAttribute(string name, string description) {
+      this.name = name;
+      this.description = description;
+    }
 
     ///// <summary>

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/BaseClasses/ApplicationBase.cs

@@ -29 +29 @@
   /// Default implementation for the IApplication interface.
   /// </summary>
-  internal abstract class ApplicationBase : IApplication {
+  public abstract class ApplicationBase : IApplication {
     /// <summary>
     /// Initializes a new instance of <see cref="ApplicationBase"/>.
@@ -35 +35 @@
     public ApplicationBase() { }
 
-    private ApplicationDescriptionAttribute ApplicationDescriptionAttribute {
+    private ApplicationAttribute ApplicationAttribute {
       get {
-        object[] appDescAttributes = this.GetType().GetCustomAttributes(typeof(ApplicationDescriptionAttribute), false);
+        object[] appAttributes = this.GetType().GetCustomAttributes(typeof(ApplicationAttribute), false);
 
         // exactly one attribute of the type ClassInfoAttribute must be given
-        if (appDescAttributes.Length != 1) {
-          throw new InvalidPluginException("Found multiple ApplicationDescriptionAttributes on type " + this.GetType());
+        if (appAttributes.Length != 1) {
+          throw new InvalidPluginException("Found multiple ApplicationAttributes on type " + this.GetType());
         }
 
-        return (ApplicationDescriptionAttribute)appDescAttributes[0];
+        return (ApplicationAttribute)appAttributes[0];
       }
     }
@@ -54 +54 @@
     /// </summary>
     public string Name {
-      get { return ApplicationDescriptionAttribute.Name; }
+      get { return ApplicationAttribute.Name; }
     }
 
@@ -62 +62 @@
     public Version Version {
       get {
-        var appDescAttribute = ApplicationDescriptionAttribute;
-        // if the version is not explicitly set in the attribute then the version of the assembly is used as default
-        if (string.IsNullOrEmpty(appDescAttribute.Version)) {
-          return this.GetType().Assembly.GetName().Version;
-        } else {
-          return new Version(appDescAttribute.Version);
-        }
+        return this.GetType().Assembly.GetName().Version;
       }
     }
@@ -77 +71 @@
     public string Description {
       get {
-        var appDescAttribute = ApplicationDescriptionAttribute;
+        var appDescAttribute = ApplicationAttribute;
         // if the description is not explicitly set in the attribute then the name of the application is used as default
         if (string.IsNullOrEmpty(appDescAttribute.Description)) {
@@ -92 +86 @@
     public bool RestartOnErrors {
       get {
-        return ApplicationDescriptionAttribute.RestartOnErrors;
+        return ApplicationAttribute.RestartOnErrors;
       }
     }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/BaseClasses/PluginBase.cs

@@ -37 +37 @@
     public PluginBase() { }
 
-    private PluginDescriptionAttribute PluginDescriptionAttribute {
+    private PluginAttribute PluginAttribute {
       get {
-        object[] pluginAttributes = this.GetType().GetCustomAttributes(typeof(PluginDescriptionAttribute), false);
+        object[] pluginAttributes = this.GetType().GetCustomAttributes(typeof(PluginAttribute), false);
         // exactly one attribute of the type PluginDescriptionAttribute must be given
         if (pluginAttributes.Length != 1) {
-          throw new InvalidPluginException("Found multiple PluginDescriptionAttributes on type " + this.GetType());
+          throw new InvalidPluginException("Found multiple PluginAttributes on type " + this.GetType());
         }
-        return (PluginDescriptionAttribute)pluginAttributes[0];
+        return (PluginAttribute)pluginAttributes[0];
       }
     }
@@ -52 +52 @@
     public string Name {
       get {
-        return PluginDescriptionAttribute.Name;
+        return PluginAttribute.Name;
       }
     }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/ControlManager.cs

@@ -38 +38 @@
     public static IControlManager Manager {
       get { return controlManager; }
-      set { controlManager = value; }
+    }
+
+    public static void RegisterManager(IControlManager manager) {
+      if (controlManager != null) throw new InvalidOperationException("An control manager has already been set.");
+      controlManager = manager;
     }
   }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/DiscoveryService.cs

@@ -24 +24 @@
 using System.Text;
 using System.Reflection;
+using System.Linq;
 
 namespace HeuristicLab.PluginInfrastructure {
@@ -30 +31 @@
   /// </summary>
   public class DiscoveryService {
+    //internal static IEnumerable<IPluginDescription> plugins;
 
-    //public PluginDescription[] Plugins {
+    //public IEnumerable<IPluginDescription> Plugins {
     //  get {
-    //    PluginInfo[] plugins = new PluginInfo[PluginManager.Manager.LoadedPlugins.Count];
-    //    PluginManager.Manager.LoadedPlugins.CopyTo(plugins, 0);
-    //    return plugins;
+    //    return DiscoveryService.plugins;
     //  }
     //}
 
     /// <summary>
-    /// Finds all types that are subtypes or equal to the specified type.
+    /// Creates an instance of all types that are subtypes or the same type of the specified type and declared in <paramref name="plugin"/>
     /// </summary>
-    /// <param name="type">Most general type for which to find matching types.</param>
-    /// <returns>The found types as array.</returns>
-    public Type[] GetTypes(Type type) {
-      Assembly[] assemblies = AppDomain.CurrentDomain.GetAssemblies();
-      List<Type> types = new List<Type>();
-      foreach (Assembly asm in assemblies) {
-        Array.ForEach<Type>(GetTypes(type, asm), delegate(Type t) {
-          types.Add(t);
-        });
-      }
-      return types.ToArray();
+    /// <typeparam name="T">Most general type.</typeparam>
+    /// <returns>Enumerable of the created instances.</returns>
+    public IEnumerable<T> GetInstances<T>(IPluginDescription plugin) where T : class {
+      return from t in GetTypes(typeof(T), plugin)
+             where !t.IsAbstract && !t.IsInterface && !t.HasElementType
+             select (T)Activator.CreateInstance(t);
     }
-
     /// <summary>
     /// Creates an instance of all types that are subtypes or the same type of the specified type
     /// </summary>
     /// <typeparam name="T">Most general type.</typeparam>
-    /// <returns>The created instances as array.</returns>
-    public T[] GetInstances<T>() where T : class {
-      Type[] types = GetTypes(typeof(T));
-      List<T> instances = new List<T>();
-      foreach (Type t in types) {
-        if (!t.IsAbstract && !t.IsInterface && !t.HasElementType) {
-          instances.Add((T)Activator.CreateInstance(t));
-        }
-      }
-      return instances.ToArray();
+    /// <returns>Enumerable of the created instances.</returns>
+    public IEnumerable<T> GetInstances<T>() where T : class {
+      return from i in GetInstances(typeof(T))
+             select (T)i;
     }
 
@@ -75 +63 @@
     /// </summary>
     /// <typeparam name="type">Most general type.</typeparam>
-    /// <returns>The created instances as array.</returns>
-    public object[] GetInstances(Type type) {
-      Type[] types = GetTypes(type);
-      List<object> instances = new List<object>();
-      foreach (Type t in types) {
-        if (!t.IsAbstract && !t.IsInterface && !t.HasElementType) {
-          instances.Add(Activator.CreateInstance(t));
-        }
-      }
-      return instances.ToArray();
+    /// <returns>Enumerable of the created instances.</returns>
+    public IEnumerable<object> GetInstances(Type type) {
+      return from t in GetTypes(type)
+             where !t.IsAbstract && !t.IsInterface && !t.HasElementType
+             select Activator.CreateInstance(t);
     }
 
-    ///// <summary>
-    ///// Finds all types that are subtypes or equal to the specified type if they are part of the given
-    ///// <paramref name="plugin"/>.
-    ///// </summary>
-    ///// <param name="type">Most general type for which to find matching types.</param>
-    ///// <param name="plugin">The plugin the subtypes must be part of.</param>
-    ///// <returns>The found types as array.</returns>
-    //public Type[] GetTypes(Type type, PluginInfo plugin) {
-    //  Assembly[] assemblies = AppDomain.CurrentDomain.GetAssemblies();
-    //  List<Type> types = new List<Type>();
-    //  foreach (Assembly asm in assemblies) {
-    //    if (plugin.Assemblies.Contains(asm.Location)) {
-    //      Array.ForEach<Type>(GetTypes(type, asm), delegate(Type t) {
-    //        types.Add(t);
-    //      });
-    //    }
-    //  }
+    /// <summary>
+    /// Finds all types that are subtypes or equal to the specified type.
+    /// </summary>
+    /// <param name="type">Most general type for which to find matching types.</param>
+    /// <returns>Enumerable of the discovered types.</returns>
+    public IEnumerable<Type> GetTypes(Type type) {
+      return from asm in AppDomain.CurrentDomain.GetAssemblies()
+             from t in GetTypes(type, asm)
+             select t;
+    }
 
-    //  return types.ToArray();
-    //}
+    /// <summary>
+    /// Finds all types that are subtypes or equal to the specified type if they are part of the given
+    /// <paramref name="plugin"/>.
+    /// </summary>
+    /// <param name="type">Most general type for which to find matching types.</param>
+    /// <param name="plugin">The plugin the subtypes must be part of.</param>
+    /// <returns>Enumerable of the discovered types.</returns>
+    public IEnumerable<Type> GetTypes(Type type, IPluginDescription pluginDescription) {
+      return from asm in AppDomain.CurrentDomain.GetAssemblies()
+             where pluginDescription.Assemblies.Contains(asm.Location)
+             from t in GetTypes(type, asm)
+             select t;
+    }
 
     ///// <summary>
@@ -130 +117 @@
     /// <param name="type">Most general type we want to find.</param>
     /// <param name="assembly">Assembly that should be searched for types.</param>
-    /// <returns>The found types as array.</returns>
-    internal Type[] GetTypes(Type type, Assembly assembly) {
-      List<Type> types = new List<Type>();
-      foreach (Type t in assembly.GetTypes()) {
-        if (type.IsAssignableFrom(t)) {
-          types.Add(t);
-        }
-      }
-      return types.ToArray();
+    /// <returns>Enumerable of the discovered types.</returns>
+    private IEnumerable<Type> GetTypes(Type type, Assembly assembly) {
+      return from t in assembly.GetTypes()
+             where type.IsAssignableFrom(t)
+             select t;
     }
 

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/HeuristicLab.PluginInfrastructure.csproj

@@ -86 +86 @@
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="Attributes\ApplicationDescriptionAttribute.cs" />
+    <Compile Include="Attributes\ApplicationAttribute.cs" />
     <Compile Include="Attributes\AssemblyBuildDateAttribute.cs" />
+    <Compile Include="Attributes\PluginAttribute.cs" />
     <Compile Include="Attributes\PluginDependencyAttribute.cs" />
-    <Compile Include="Attributes\PluginDescriptionAttribute.cs" />
     <Compile Include="Attributes\PluginFileAttribute.cs" />
     <Compile Include="BaseClasses\ApplicationBase.cs" />
     <Compile Include="BaseClasses\PluginBase.cs" />
+    <Compile Include="Interfaces\IApplicationManager.cs" />
+    <Compile Include="Interfaces\IApplicationDescription.cs" />
     <Compile Include="Interfaces\IApplication.cs" />
     <Compile Include="Interfaces\IControl.cs" />
     <Compile Include="Interfaces\IControlManager.cs" />
     <Compile Include="Interfaces\IPlugin.cs" />
-    <Compile Include="DiscoveryService.cs" />
     <Compile Include="ControlManager.cs" />
+    <Compile Include="Interfaces\IPluginDescription.cs" />
     <Compile Include="InvalidPluginException.cs" />
+    <Compile Include="PluginDescriptionIterator.cs" />
+    <Compile Include="ApplicationManager.cs" />
+    <Compile Include="PluginState.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <EmbeddedResource Include="Properties\Resources.resx">

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/PluginDescriptionIterator.cs

@@ -24 +24 @@
 using System.Text;
 
-namespace HeuristicLab.PluginInfrastructure.Manager {
+namespace HeuristicLab.PluginInfrastructure {
   public static class PluginDescriptionIterator {
-    public static IEnumerable<PluginDescription> IterateInDependencyOrder(IEnumerable<PluginDescription> pluginDescriptions) {
+    public static IEnumerable<IPluginDescription> IterateInDependencyOrder(IEnumerable<IPluginDescription> pluginDescriptions) {
       // list to make sure we yield each description only once
-      List<PluginDescription> yieldedDescriptions = new List<PluginDescription>();
+      List<IPluginDescription> yieldedDescriptions = new List<IPluginDescription>();
       foreach (var desc in pluginDescriptions) {
         foreach (var dependency in IterateInDependencyOrder(desc.Dependencies)) {
@@ -35 +35 @@
             yield return dependency;
           }
-          if (!yieldedDescriptions.Contains(desc)) {
-            yieldedDescriptions.Add(desc);
-            yield return desc;
-          }
+        }
+        if (!yieldedDescriptions.Contains(desc)) {
+          yieldedDescriptions.Add(desc);
+          yield return desc;
         }
       }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/PluginState.cs

@@ -24 +24 @@
 using System.Text;
 
-namespace HeuristicLab.PluginInfrastructure.Manager {
+namespace HeuristicLab.PluginInfrastructure {
   [Serializable]
   public enum PluginState {