Changeset 2504 for branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/BaseClasses

Timestamp:

11/18/09 18:33:30 (15 years ago)

Author:

gkronber

Message:

Worked on core of plugin infrastructure.

• Collected all classes into a single assembly (HL.PluginInfrastructure)
• Moved SplashScreen and MainForm from HeuristicLab.exe project into the plugin infrastructure.
• Introduced namespaces
• Added strict access modifiers (internal)
• Fixed most FxCop warnings in plugin infrastructure core.
• Fixed issues with plugin load/unload events
• Deleted empty interface IControl

#799

Location:

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/BaseClasses

Files:

• ApplicationBase.cs (modified) (4 diffs)
• PluginBase.cs (modified) (4 diffs)

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

@@ -27 +27 @@
 namespace HeuristicLab.PluginInfrastructure {
   /// <summary>
-  /// Default implementation for the IApplication interface.
+  /// Abstract base implementation for the IApplication interface.
   /// </summary>
   public abstract class ApplicationBase : IApplication {
@@ -33 +33 @@
     /// Initializes a new instance of <see cref="ApplicationBase"/>.
     /// </summary>
-    public ApplicationBase() { }
+    protected ApplicationBase() { }
 
     private ApplicationAttribute ApplicationAttribute {
@@ -40 +40 @@
 
         // exactly one attribute of the type ClassInfoAttribute must be given
-        if (appAttributes.Length != 1) {
+        if (appAttributes.Length == 0) {
+          throw new InvalidPluginException("ApplicationAttribute on type " + this.GetType() + " is missing.");
+        } else if (appAttributes.Length > 1) {
           throw new InvalidPluginException("Found multiple ApplicationAttributes on type " + this.GetType());
         }
@@ -58 +60 @@
 
     /// <summary>
-    /// Gets the version of the application.
-    /// </summary>
-    public Version Version {
-      get {
-        return this.GetType().Assembly.GetName().Version;
-      }
-    }
-
-    /// <summary>
     /// Gets the description of the application.
     /// </summary>
     public string Description {
       get {
-        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)) {
-          return appDescAttribute.Name;
-        } else {
-          return appDescAttribute.Description;
-        }
-      }
-    }
-
-    /// <summary>
-    /// Gets the boolean flag whether the application should by restarted after exceptions.
-    /// </summary>
-    public bool RestartOnErrors {
-      get {
-        return ApplicationAttribute.RestartOnErrors;
+        return ApplicationAttribute.Description;
       }
     }

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

@@ -29 +29 @@
 namespace HeuristicLab.PluginInfrastructure {
   /// <summary>
-  /// Default implementation of the IPlugin interface.
+  /// Abstract base implementation of the IPlugin interface.
   /// </summary>
   public abstract class PluginBase : IPlugin {
@@ -35 +35 @@
     /// Initializes a new instance of <see cref="PluginBase"/>.
     /// </summary>
-    public PluginBase() { }
+    protected PluginBase() { }
 
     private PluginAttribute PluginAttribute {
@@ -41 +41 @@
         object[] pluginAttributes = this.GetType().GetCustomAttributes(typeof(PluginAttribute), false);
         // exactly one attribute of the type PluginDescriptionAttribute must be given
-        if (pluginAttributes.Length != 1) {
+        if (pluginAttributes.Length == 0) {
+          throw new InvalidPluginException("PluginAttribute on type " + this.GetType() + " is missing.");
+        } else if (pluginAttributes.Length > 1) {
           throw new InvalidPluginException("Found multiple PluginAttributes on type " + this.GetType());
         }
@@ -56 +58 @@
     }
 
-
-    /// <inheritdoc/>
-    public IEnumerable<string> FileNames {
-      get {
-        // get all attributes of type PluginFileAttribute, multiple usage is possible
-        return from x in this.GetType().GetCustomAttributes(typeof(PluginFileAttribute), false)
-               let pluginFileAttr = (PluginFileAttribute)x
-               select pluginFileAttr.Filename;
-      }
-    }
-
     /// <inhertitdoc>
     public virtual void OnLoad() { }