Changeset 2748

Timestamp:

02/04/10 09:38:25 (14 years ago)

Author:

gkronber

Message:

Fixed issues in plugin infrastructure as identified by abeham. #863 (Code review)

Location:

trunk/sources/HeuristicLab.PluginInfrastructure

Files:

• Advanced/InstallationManagerForm.Designer.cs (added)
• Advanced/InstallationManagerForm.cs (added)
• Advanced/InstallationManagerForm.resx (added)
• ApplicationManager.cs (modified) (7 diffs)
• Attributes/PluginAttribute.cs (modified) (2 diffs)
• Attributes/PluginDependencyAttribute.cs (modified) (1 diff)
• BaseClasses/PluginBase.cs (modified) (1 diff)
• HeuristicLab.PluginInfrastructure.csproj (modified) (2 diffs)
• Starter/StarterForm.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.PluginInfrastructure/ApplicationManager.cs

@@ -46 +46 @@
     }
 
+    /// <summary>
+    /// Fired when a plugin is loaded.
+    /// </summary>
     internal event EventHandler<PluginInfrastructureEventArgs> PluginLoaded;
+    /// <summary>
+    /// Fired when a plugin is unloaded (when the application terminates).
+    /// </summary>
     internal event EventHandler<PluginInfrastructureEventArgs> PluginUnloaded;
 
@@ -83 +89 @@
     }
 
+    /// <summary>
+    /// Prepares the application domain for the execution of an HL application.
+    /// Pre-loads all <paramref name="plugins"/>.
+    /// </summary>
+    /// <param name="apps">Enumerable of available HL applications.</param>
+    /// <param name="plugins">Enumerable of plugins that should be pre-loaded.</param>
     internal void PrepareApplicationDomain(IEnumerable<ApplicationDescription> apps, IEnumerable<PluginDescription> plugins) {
       this.plugins = new List<PluginDescription>(plugins);
@@ -99 +111 @@
     }
 
+    /// <summary>
+    /// Loads the <paramref name="plugins"/> into this application domain.
+    /// </summary>
+    /// <param name="plugins">Enumerable of plugins that should be loaded.</param>
     private void LoadPlugins(IEnumerable<PluginDescription> plugins) {
       // load all loadable plugins (all dependencies available) into the execution context
@@ -116 +132 @@
     }
 
+    /// <summary>
+    /// Runs the application declared in <paramref name="appInfo"/>.
+    /// This is a synchronous call. When the application is terminated all plugins are unloaded.
+    /// </summary>
+    /// <param name="appInfo">Description of the application to run</param>
     internal void Run(ApplicationDescription appInfo) {
       IApplication runnablePlugin = (IApplication)Activator.CreateInstance(appInfo.DeclaringAssemblyName, appInfo.DeclaringTypeName).Unwrap();
@@ -193 +214 @@
     /// </summary>
     /// <param name="type">Most general type for which to find matching types.</param>
-    /// <param name="onlyInstantiable">Return only types that are instantiable (instance, abstract... are not returned)</param>
+    /// <param name="onlyInstantiable">Return only types that are instantiable 
+    /// (interfaces, abstract classes... are not returned)</param>
     /// <returns>Enumerable of the discovered types.</returns>
     internal static IEnumerable<Type> GetTypes(Type type, bool onlyInstantiable) {
@@ -207 +229 @@
     /// <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>
-    /// <param name="onlyInstantiable">Return only types that are instantiable (instance, abstract... are not returned)</param>
+    /// <param name="onlyInstantiable">Return only types that are instantiable 
+    /// (interfaces, abstract classes... are not returned)</param>
     /// <returns>Enumerable of the discovered types.</returns>
     internal static IEnumerable<Type> GetTypes(Type type, IPluginDescription pluginDescription, bool onlyInstantiable) {
@@ -223 +246 @@
     /// <param name="type">Most general type we want to find.</param>
     /// <param name="assembly">Assembly that should be searched for types.</param>
-    /// <param name="onlyInstantiable">Return only types that are instantiable (instance, abstract... are not returned)</param>
+    /// <param name="onlyInstantiable">Return only types that are instantiable 
+    /// (interfaces, abstract classes...  are not returned)</param>
     /// <returns>Enumerable of the discovered types.</returns>
     private static IEnumerable<Type> GetTypes(Type type, Assembly assembly, bool onlyInstantiable) {

trunk/sources/HeuristicLab.PluginInfrastructure/Attributes/PluginAttribute.cs

@@ -52 +52 @@
     /// </summary>
     public PluginAttribute(string name)
-      : this(name, "") {
+      : this(name, string.Empty) {
     }
 
@@ -61 +61 @@
     /// </summary>
     public PluginAttribute(string name, string description) {
+      if (string.IsNullOrEmpty(name)) throw new ArgumentException("Plugin name is null or empty.");
+      if (description == null) throw new ArgumentNullException("description");
       this.name = name;
       this.description = description;

trunk/sources/HeuristicLab.PluginInfrastructure/Attributes/PluginDependencyAttribute.cs

@@ -26 +26 @@
 namespace HeuristicLab.PluginInfrastructure {
   /// <summary>
-  /// This attribute can be used to declare that an plugin depends on a another plugin.
+  /// This attribute can be used to declare that a plugin depends on a another plugin.
   /// </summary>
   [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]

trunk/sources/HeuristicLab.PluginInfrastructure/BaseClasses/PluginBase.cs

@@ -58 +58 @@
     }
 
-    /// <inhertitdoc>
+    /// <inhertitdoc />
     public virtual void OnLoad() { }
-    /// <inhertitdoc>
+    /// <inhertitdoc />
     public virtual void OnUnload() { }
     #endregion

trunk/sources/HeuristicLab.PluginInfrastructure/HeuristicLab.PluginInfrastructure.csproj

@@ -94 +94 @@
     <Compile Include="Advanced\InstallationManagerConsole.cs" />
     <Compile Include="Advanced\InstallationManager.cs" />
+    <Compile Include="Advanced\InstallationManagerForm.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="Advanced\InstallationManagerForm.Designer.cs">
+      <DependentUpon>InstallationManagerForm.cs</DependentUpon>
+    </Compile>
     <Compile Include="Attributes\ApplicationAttribute.cs" />
     <Compile Include="Attributes\AssemblyBuildDateAttribute.cs" />
@@ -122 +128 @@
     <Compile Include="Main.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <EmbeddedResource Include="Advanced\InstallationManagerForm.resx">
+      <DependentUpon>InstallationManagerForm.cs</DependentUpon>
+    </EmbeddedResource>
     <EmbeddedResource Include="Properties\Resources.resx">
       <Generator>ResXFileCodeGenerator</Generator>

trunk/sources/HeuristicLab.PluginInfrastructure/Starter/StarterForm.cs

@@ -33 +33 @@
 using HeuristicLab.PluginInfrastructure.Manager;
 using System.IO;
+using HeuristicLab.PluginInfrastructure.Advanced;
 
 namespace HeuristicLab.PluginInfrastructure.Starter {
@@ -45 +46 @@
       InitializeComponent();
 
-      string pluginPath = Path.GetFullPath(Application.StartupPath);      
+      string pluginPath = Path.GetFullPath(Application.StartupPath);
       pluginManager = new PluginManager(pluginPath);
       SplashScreen splashScreen = new SplashScreen(pluginManager, 1000, "Loading HeuristicLab...");
@@ -77 +78 @@
       var appDesc = (from desc in pluginManager.Applications
                      where desc.Name == appName
-                     select desc).Single();
+                     select desc).SingleOrDefault();
       if (appDesc != null) {
         StartApplication(appDesc);
@@ -93 +94 @@
         if (selected == pluginManagerListViewItem) {
           try {
-            //Cursor = Cursors.AppStarting;
-            //ManagerForm form = new ManagerForm();
-            //this.Visible = false;
-            //form.ShowDialog(this);
-            //// RefreshApplicationsList();
-            //this.Visible = true;
+            Cursor = Cursors.AppStarting;
+            InstallationManagerForm form = new InstallationManagerForm();
+            this.Visible = false;
+            form.ShowDialog(this);
+            // RefreshApplicationsList();
+            this.Visible = true;
           }
           finally {