Changeset 8748

Timestamp:

10/05/12 17:13:25 (12 years ago)

Author:

jkarder

Message:

#1926:

• addressed the suggestion by abeham in comment:13:ticket:1926
• applied the changes suggested by mkommend in comment:14:ticket:1926
• refactored argument handling infrastructure

Location:

trunk/sources/HeuristicLab.PluginInfrastructure/3.3

Files:

• CommandLineArgumentHandling (moved) (moved from trunk/sources/HeuristicLab.PluginInfrastructure/3.3/ArgumentHandling)
• CommandLineArgumentHandling/ArgumentHandling.cs (deleted)
• CommandLineArgumentHandling/Arguments (added)
• CommandLineArgumentHandling/Arguments.cs (deleted)
• CommandLineArgumentHandling/Arguments/HideStarterArgument.cs (added)
• CommandLineArgumentHandling/Arguments/StartArgument.cs (added)
• CommandLineArgumentHandling/CommandLineArgument.cs (copied) (copied from trunk/sources/HeuristicLab.PluginInfrastructure/3.3/ArgumentHandling/Arguments.cs) (1 diff)
• CommandLineArgumentHandling/CommandLineArgumentHandling.cs (copied) (copied from trunk/sources/HeuristicLab.PluginInfrastructure/3.3/ArgumentHandling/ArgumentHandling.cs) (2 diffs)
• CommandLineArgumentHandling/IArgument.cs (deleted)
• CommandLineArgumentHandling/ICommandLineArgument.cs (copied) (copied from trunk/sources/HeuristicLab.PluginInfrastructure/3.3/ArgumentHandling/IArgument.cs) (1 diff)
• HeuristicLab.PluginInfrastructure-3.3.csproj (modified) (1 diff)
• Starter/StarterForm.Designer.cs (modified) (1 diff)
• Starter/StarterForm.cs (modified) (7 diffs)

trunk/sources/HeuristicLab.PluginInfrastructure/3.3/CommandLineArgumentHandling/CommandLineArgument.cs

@@ -21 +21 @@
 
 namespace HeuristicLab.PluginInfrastructure {
-  public class Argument : IArgument {
-    public const string START = "start";
-
-    public string Token { get; private set; }
-    public string Value { get; private set; }
-    public bool Valid { get { return !string.IsNullOrEmpty(Value); } }
-
-    public Argument(string token, string value) {
-      Token = token;
-      Value = value;
-    }
+  public abstract class CommandLineArgument<T> : ICommandLineArgument<T> {
+    object ICommandLineArgument.Value { get { return Value; } }
+    public T Value { get; protected set; }
+    public bool Valid { get { return CheckValidity(); } }
 
     public override bool Equals(object obj) {
       if (obj == null || this.GetType() != obj.GetType()) return false;
-      var other = (Argument)obj;
-      return this.Token == other.Token && this.Value == other.Value;
+      var other = (ICommandLineArgument<T>)obj;
+      return this.Value.Equals(other.Value);
     }
 
     public override int GetHashCode() {
-      return GetType().GetHashCode();
+      return GetType().GetHashCode() ^ Value.GetHashCode();
     }
+
+    protected abstract bool CheckValidity();
   }
 }

trunk/sources/HeuristicLab.PluginInfrastructure/3.3/CommandLineArgumentHandling/CommandLineArgumentHandling.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.PluginInfrastructure {
-  public static class ArgumentHandling {
-    public static IArgument[] GetArguments(string[] args) {
-      var arguments = new HashSet<IArgument>();
+  public static class CommandLineArgumentHandling {
+    public static ICommandLineArgument[] GetArguments(string[] args) {
+      var arguments = new HashSet<ICommandLineArgument>();
       var exceptions = new List<Exception>();
 
@@ -41 +41 @@
     }
 
-    private static Argument ParseArgument(string entry) {
-      var regex = new Regex(@"^/[a-z]+(:[A-Za-z0-9\s]+)?$");
+    private static ICommandLineArgument ParseArgument(string entry) {
+      var regex = new Regex(@"^/[A-Za-z]+(:[A-Za-z0-9\s]+)?$");
       if (!regex.IsMatch(entry)) return null;
       entry = entry.Remove(0, 1);
       var parts = entry.Split(':');
-      string key = parts[0];
+      string key = parts[0].Trim();
       string value = parts.Length == 2 ? parts[1].Trim() : string.Empty;
-      return new Argument(key.ToLower(), value);
+      switch (key) {
+        case StartArgument.TOKEN: return new StartArgument(value);
+        case HideStarterArgument.TOKEN: return new HideStarterArgument(value);
+        default: return null;
+      }
     }
   }

trunk/sources/HeuristicLab.PluginInfrastructure/3.3/CommandLineArgumentHandling/ICommandLineArgument.cs

@@ -21 +21 @@
 
 namespace HeuristicLab.PluginInfrastructure {
-  public interface IArgument {
-    string Token { get; }
-    string Value { get; }
+  public interface ICommandLineArgument {
+    object Value { get; }
     bool Valid { get; }
   }
+
+  public interface ICommandLineArgument<out T> : ICommandLineArgument {
+    new T Value { get; }
+  }
 }

trunk/sources/HeuristicLab.PluginInfrastructure/3.3/HeuristicLab.PluginInfrastructure-3.3.csproj

@@ -215 +215 @@
       <DependentUpon>PluginView.cs</DependentUpon>
     </Compile>
-    <Compile Include="ArgumentHandling\ArgumentHandling.cs" />
-    <Compile Include="ArgumentHandling\Arguments.cs" />
-    <Compile Include="ArgumentHandling\IArgument.cs" />
+    <Compile Include="CommandLineArgumentHandling\Arguments\HideStarterArgument.cs" />
+    <Compile Include="CommandLineArgumentHandling\Arguments\StartArgument.cs" />
+    <Compile Include="CommandLineArgumentHandling\CommandLineArgument.cs" />
+    <Compile Include="CommandLineArgumentHandling\CommandLineArgumentHandling.cs" />
+    <Compile Include="CommandLineArgumentHandling\ICommandLineArgument.cs" />
     <Compile Include="Attributes\ApplicationAttribute.cs" />
     <Compile Include="Attributes\ContactInformationAttribute.cs" />

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

@@ -182 +182 @@
       this.Text = "HeuristicLab Starter";
       this.FormClosing += new System.Windows.Forms.FormClosingEventHandler(this.StarterForm_FormClosing);
-      this.Shown += new System.EventHandler(this.StarterForm_Shown);
+      this.Load += new System.EventHandler(this.StarterForm_Load);
       this.ResumeLayout(false);
 

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

@@ -40 +40 @@
     private const string updatePluginsItemName = "Updates Available";
 
+    private readonly ICommandLineArgument[] arguments;
 
     private ListViewItem pluginManagerListViewItem;
@@ -46 +47 @@
     private SplashScreen splashScreen;
     private bool updatesAvailable = false;
-    private string[] arguments;
 
     /// <summary>
@@ -65 +65 @@
       pluginManager = new PluginManager(pluginPath);
       splashScreen = new SplashScreen(pluginManager, 1000);
+      splashScreen.VisibleChanged += new EventHandler(splashScreen_VisibleChanged);
       splashScreen.Show(this, "Loading HeuristicLab...");
 
@@ -71 +72 @@
 
       CheckUpdatesAvailableAsync();
+    }
+
+    /// <summary>
+    /// Creates a new StarterForm and passes the arguments in <paramref name="args"/>.
+    /// </summary>
+    /// <param name="args">The arguments that should be processed</param>
+    public StarterForm(string[] args)
+      : this() {
+      arguments = CommandLineArgumentHandling.GetArguments(args);
+    }
+
+    protected override void SetVisibleCore(bool value) {
+      value &= !arguments.OfType<HideStarterArgument>().Any();
+      if (!value) HandleArguments();
+      base.SetVisibleCore(value);
+    }
+
+    #region Events
+    private void StarterForm_Load(object sender, EventArgs e) {
+      HandleArguments();
+    }
+
+    private void StarterForm_FormClosing(object sender, FormClosingEventArgs e) {
+      splashScreen.Close();
+      abortRequested = true;
+    }
+
+    private void applicationsListView_SelectedIndexChanged(object sender, EventArgs e) {
+      startButton.Enabled = applicationsListView.SelectedItems.Count > 0;
+    }
+
+    private void applicationsListView_ItemActivate(object sender, EventArgs e) {
+      if (applicationsListView.SelectedItems.Count > 0) {
+        ListViewItem selected = applicationsListView.SelectedItems[0];
+        if (selected.Text == pluginManagerItemName) {
+          if (pluginManager.Plugins.Any(x => x.PluginState == PluginState.Loaded)) {
+            MessageBox.Show("Installation Manager cannot be started while another HeuristicLab application is active." + Environment.NewLine +
+              "Please stop all active HeuristicLab applications and try again.", "Plugin Manager",
+              MessageBoxButtons.OK, MessageBoxIcon.Information);
+          } else {
+            try {
+              Cursor = Cursors.AppStarting;
+              using (InstallationManagerForm form = new InstallationManagerForm(pluginManager)) {
+                form.ShowDialog(this);
+              }
+              UpdateApplicationsList();
+            }
+            finally {
+              Cursor = Cursors.Arrow;
+            }
+          }
+        } else if (selected.Text == updatePluginsItemName) {
+          if (pluginManager.Plugins.Any(x => x.PluginState == PluginState.Loaded)) {
+            MessageBox.Show("Updating is not possible while another HeuristicLab application is active." + Environment.NewLine +
+              "Please stop all active HeuristicLab applications and try again.", "Update plugins",
+              MessageBoxButtons.OK, MessageBoxIcon.Information);
+          } else {
+            try {
+              Cursor = Cursors.AppStarting;
+              using (PluginUpdaterForm form = new PluginUpdaterForm(pluginManager)) {
+                form.ShowDialog(this);
+              }
+              updatesAvailable = false;
+              CheckUpdatesAvailableAsync();
+              UpdateApplicationsList();
+            }
+            finally {
+              Cursor = Cursors.Arrow;
+            }
+          }
+        } else {
+          ApplicationDescription app = (ApplicationDescription)applicationsListView.SelectedItems[0].Tag;
+          StartApplication(app);
+        }
+      }
+    }
+
+    private void largeIconsButton_Click(object sender, EventArgs e) {
+      applicationsListView.View = View.LargeIcon;
+    }
+
+    private void detailsButton_Click(object sender, EventArgs e) {
+      applicationsListView.View = View.Details;
+      foreach (ColumnHeader column in applicationsListView.Columns) {
+        if (applicationsListView.Items.Count > 0)
+          column.AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
+        else column.AutoResize(ColumnHeaderAutoResizeStyle.HeaderSize);
+      }
+    }
+
+    private void aboutButton_Click(object sender, EventArgs e) {
+      List<IPluginDescription> plugins = new List<IPluginDescription>(pluginManager.Plugins.OfType<IPluginDescription>());
+      using (var dialog = new AboutDialog(plugins)) {
+        dialog.ShowDialog();
+      }
+    }
+
+    private void splashScreen_VisibleChanged(object sender, EventArgs e) {
+      // close hidden starter form
+      if (!splashScreen.Visible && arguments != null && arguments.OfType<HideStarterArgument>().Any())
+        Close();
+    }
+    #endregion
+
+    #region Helpers
+    private void UpdateApplicationsList() {
+      if (InvokeRequired) Invoke((Action)UpdateApplicationsList);
+      else {
+        applicationsListView.Items.Clear();
+        AddPluginManagerItem();
+        AddUpdatePluginsItem();
+
+        foreach (ApplicationDescription info in pluginManager.Applications) {
+          ListViewItem item = new ListViewItem(info.Name, 0);
+          item.Tag = info;
+          item.Group = applicationsListView.Groups["Applications"];
+          item.SubItems.Add(new ListViewItem.ListViewSubItem(item, info.Version.ToString()));
+          item.SubItems.Add(new ListViewItem.ListViewSubItem(item, info.Description));
+          item.ToolTipText = info.Description;
+          applicationsListView.Items.Add(item);
+        }
+        foreach (ColumnHeader column in applicationsListView.Columns) {
+          if (applicationsListView.Items.Count > 0)
+            column.AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
+          else column.AutoResize(ColumnHeaderAutoResizeStyle.HeaderSize);
+        }
+      }
+    }
+
+    private void AddPluginManagerItem() {
+      FileVersionInfo pluginInfrastructureVersion = FileVersionInfo.GetVersionInfo(GetType().Assembly.Location);
+      pluginManagerListViewItem = new ListViewItem(pluginManagerItemName, 0);
+      pluginManagerListViewItem.Group = applicationsListView.Groups["Plugin Management"];
+      pluginManagerListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(pluginManagerListViewItem, pluginInfrastructureVersion.FileVersion));
+      pluginManagerListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(pluginManagerListViewItem, "Install, upgrade or delete plugins"));
+      pluginManagerListViewItem.ToolTipText = "Install, upgrade or delete plugins";
+
+      applicationsListView.Items.Add(pluginManagerListViewItem);
+    }
+
+    private void AddUpdatePluginsItem() {
+      if (updatesAvailable) {
+        var updateListViewItem = new ListViewItem(updatePluginsItemName, 1);
+        updateListViewItem.Group = applicationsListView.Groups["Plugin Management"];
+        updateListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(updateListViewItem, ""));
+        updateListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(updateListViewItem, "Download and install updates"));
+        updateListViewItem.ToolTipText = "Download and install updates";
+
+        applicationsListView.Items.Add(updateListViewItem);
+      }
     }
 
@@ -110 +261 @@
     }
 
-    /// <summary>
-    /// Creates a new StarterForm and passes the arguments in <paramref name="args"/>.
-    /// </summary>
-    /// <param name="args">The arguments that should be processed</param>
-    public StarterForm(string[] args)
-      : this() {
-      this.arguments = args;
-    }
-
-    private void StarterForm_Shown(object sender, EventArgs e) {
+    private void HandleArguments() {
       try {
-        foreach (var argument in ArgumentHandling.GetArguments(arguments)) {
-          if (argument.Token == Argument.START) {
+        foreach (var argument in arguments) {
+          if (argument is StartArgument) {
             var appDesc = (from desc in pluginManager.Applications
-                           where desc.Name == argument.Value
+                           where desc.Name.Equals(argument.Value)
                            select desc).SingleOrDefault();
             if (appDesc != null) {
@@ -142 +284 @@
     }
 
-    private void applicationsListView_ItemActivate(object sender, EventArgs e) {
-      if (applicationsListView.SelectedItems.Count > 0) {
-        ListViewItem selected = applicationsListView.SelectedItems[0];
-        if (selected.Text == pluginManagerItemName) {
-          if (pluginManager.Plugins.Any(x => x.PluginState == PluginState.Loaded)) {
-            MessageBox.Show("Installation Manager cannot be started while another HeuristicLab application is active." + Environment.NewLine +
-              "Please stop all active HeuristicLab applications and try again.", "Plugin Manager",
-              MessageBoxButtons.OK, MessageBoxIcon.Information);
-          } else {
-            try {
-              Cursor = Cursors.AppStarting;
-              using (InstallationManagerForm form = new InstallationManagerForm(pluginManager)) {
-                form.ShowDialog(this);
-              }
-              UpdateApplicationsList();
-            }
-            finally {
-              Cursor = Cursors.Arrow;
-            }
-          }
-        } else if (selected.Text == updatePluginsItemName) {
-          if (pluginManager.Plugins.Any(x => x.PluginState == PluginState.Loaded)) {
-            MessageBox.Show("Updating is not possible while another HeuristicLab application is active." + Environment.NewLine +
-              "Please stop all active HeuristicLab applications and try again.", "Update plugins",
-              MessageBoxButtons.OK, MessageBoxIcon.Information);
-          } else {
-            try {
-              Cursor = Cursors.AppStarting;
-              using (PluginUpdaterForm form = new PluginUpdaterForm(pluginManager)) {
-                form.ShowDialog(this);
-              }
-              updatesAvailable = false;
-              CheckUpdatesAvailableAsync();
-              UpdateApplicationsList();
-            }
-            finally {
-              Cursor = Cursors.Arrow;
-            }
-          }
-        } else {
-          ApplicationDescription app = (ApplicationDescription)applicationsListView.SelectedItems[0].Tag;
-          StartApplication(app);
-        }
-      }
-    }
-
-    private void UpdateApplicationsList() {
-      if (InvokeRequired) Invoke((Action)UpdateApplicationsList);
-      else {
-        applicationsListView.Items.Clear();
-        AddPluginManagerItem();
-        AddUpdatePluginsItem();
-
-        foreach (ApplicationDescription info in pluginManager.Applications) {
-          ListViewItem item = new ListViewItem(info.Name, 0);
-          item.Tag = info;
-          item.Group = applicationsListView.Groups["Applications"];
-          item.SubItems.Add(new ListViewItem.ListViewSubItem(item, info.Version.ToString()));
-          item.SubItems.Add(new ListViewItem.ListViewSubItem(item, info.Description));
-          item.ToolTipText = info.Description;
-          applicationsListView.Items.Add(item);
-        }
-        foreach (ColumnHeader column in applicationsListView.Columns) {
-          if (applicationsListView.Items.Count > 0)
-            column.AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
-          else column.AutoResize(ColumnHeaderAutoResizeStyle.HeaderSize);
-        }
-      }
-    }
-
-    private void AddPluginManagerItem() {
-      FileVersionInfo pluginInfrastructureVersion = FileVersionInfo.GetVersionInfo(GetType().Assembly.Location);
-      pluginManagerListViewItem = new ListViewItem(pluginManagerItemName, 0);
-      pluginManagerListViewItem.Group = applicationsListView.Groups["Plugin Management"];
-      pluginManagerListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(pluginManagerListViewItem, pluginInfrastructureVersion.FileVersion));
-      pluginManagerListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(pluginManagerListViewItem, "Install, upgrade or delete plugins"));
-      pluginManagerListViewItem.ToolTipText = "Install, upgrade or delete plugins";
-
-      applicationsListView.Items.Add(pluginManagerListViewItem);
-    }
-
-    private void AddUpdatePluginsItem() {
-      if (updatesAvailable) {
-        var updateListViewItem = new ListViewItem(updatePluginsItemName, 1);
-        updateListViewItem.Group = applicationsListView.Groups["Plugin Management"];
-        updateListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(updateListViewItem, ""));
-        updateListViewItem.SubItems.Add(new ListViewItem.ListViewSubItem(updateListViewItem, "Download and install updates"));
-        updateListViewItem.ToolTipText = "Download and install updates";
-
-        applicationsListView.Items.Add(updateListViewItem);
-      }
-    }
-
     private void StartApplication(ApplicationDescription app) {
       splashScreen.Show("Loading " + app.Name);
@@ -256 +305 @@
       t.Start();
     }
-
-    private void applicationsListView_SelectedIndexChanged(object sender, EventArgs e) {
-      startButton.Enabled = applicationsListView.SelectedItems.Count > 0;
-    }
-
-    private void largeIconsButton_Click(object sender, EventArgs e) {
-      applicationsListView.View = View.LargeIcon;
-    }
-
-    private void detailsButton_Click(object sender, EventArgs e) {
-      applicationsListView.View = View.Details;
-      foreach (ColumnHeader column in applicationsListView.Columns) {
-        if (applicationsListView.Items.Count > 0)
-          column.AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
-        else column.AutoResize(ColumnHeaderAutoResizeStyle.HeaderSize);
-      }
-    }
-
-    private void StarterForm_FormClosing(object sender, FormClosingEventArgs e) {
-      splashScreen.Close();
-      abortRequested = true;
-    }
-
-    private void aboutButton_Click(object sender, EventArgs e) {
-      List<IPluginDescription> plugins = new List<IPluginDescription>(pluginManager.Plugins.OfType<IPluginDescription>());
-      using (var dialog = new AboutDialog(plugins)) {
-        dialog.ShowDialog();
-      }
-    }
+    #endregion
   }
 }