Changeset 3483 for trunk/sources/HeuristicLab.Optimizer

Timestamp:

04/22/10 05:14:39 (15 years ago)

Author:

swagner

Message:

Worked on the refactoring of saving and loading items (#990)

Location:

trunk/sources/HeuristicLab.Optimizer/3.3

Files:

• FileManager.cs (modified) (7 diffs)
• MenuItems/CopyToClipboardMenuItem.cs (modified) (2 diffs)
• MenuItems/SaveAllMenuItem.cs (modified) (2 diffs)
• MenuItems/SaveAsMenuItem.cs (modified) (2 diffs)
• MenuItems/SaveMenuItem.cs (modified) (2 diffs)
• OptimizerMainForm.cs (modified) (4 diffs)
• ToolBarItems/SaveAllToolBarItem.cs (modified) (2 diffs)
• ToolBarItems/SaveToolBarItem.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Optimizer/3.3/FileManager.cs

@@ -21 +21 @@
 
 using System;
-using System.Collections.Generic;
-using System.IO;
 using System.Linq;
-using System.Threading;
 using System.Windows.Forms;
+using HeuristicLab.Common;
 using HeuristicLab.Core.Views;
 using HeuristicLab.MainForm;
-using HeuristicLab.MainForm.WindowsForms;
-using HeuristicLab.Persistence.Default.Xml;
 
 namespace HeuristicLab.Optimizer {
   internal static class FileManager {
-
-    #region Private Class FileInfo
-    private class FileInfo {
-      public string Filename { get; set; }
-      public bool Compressed { get; set; }
-
-      public FileInfo(string filename, bool compressed) {
-        Filename = filename;
-        Compressed = compressed;
-      }
-      public FileInfo(string filename)
-        : this(filename, true) {
-      }
-      public FileInfo()
-        : this(string.Empty, true) {
-      }
-    }
-    #endregion
-
-    private static Dictionary<IContentView, FileInfo> files;
     private static NewItemDialog newItemDialog;
     private static OpenFileDialog openFileDialog;
     private static SaveFileDialog saveFileDialog;
-    private static int waitingCursors;
-    private static int newDocumentsCounter;
 
     static FileManager() {
-      files = new Dictionary<IContentView, FileInfo>();
       newItemDialog = null;
       openFileDialog = null;
       saveFileDialog = null;
-      waitingCursors = 0;
-      newDocumentsCounter = 1;
-      // NOTE: Events fired by the main form are registered in HeuristicLabOptimizerApplication.
     }
 
@@ -73 +43 @@
       if (newItemDialog.ShowDialog() == DialogResult.OK) {
         IView view = MainFormManager.CreateDefaultView(newItemDialog.Item);
-        if (view == null) {
-          MessageBox.Show("There is no view for the new item. It cannot be displayed. ", "No View Available", MessageBoxButtons.OK, MessageBoxIcon.Error);
-        } else {
-          if (view is IContentView) {
-            view.Caption = "Item" + newDocumentsCounter.ToString() + ".hl";
-            newDocumentsCounter++;
-          }
-          view.Show();
-        }
+        if (view == null) MessageBox.Show("There is no view for the new item. It cannot be displayed.", "No View Available", MessageBoxButtons.OK, MessageBoxIcon.Error);
+        else view.Show();
       }
     }
@@ -96 +59 @@
 
       if (openFileDialog.ShowDialog() == DialogResult.OK) {
-        foreach (string filename in openFileDialog.FileNames)
-          LoadItemAsync(filename);
+        foreach (string filename in openFileDialog.FileNames) {
+          ((OptimizerMainForm)MainFormManager.MainForm).SetAppStartingCursor();
+          ContentManager.LoadAsync(filename, LoadingCompleted);
+        }
+      }
+    }
+    private static void LoadingCompleted(IStorableContent content, Exception error) {
+      try {
+        if (error != null) throw error;
+        Invoke(delegate() {
+          IView view = MainFormManager.CreateDefaultView(content);
+          if (view == null) MessageBox.Show("There is no view for the loaded item. It cannot be displayed.", "No View Available", MessageBoxButtons.OK, MessageBoxIcon.Error);
+          else view.Show();
+        });
+      }
+      catch (Exception ex) {
+        Auxiliary.ShowErrorMessageBox(ex);
+      }
+      finally {
+        ((OptimizerMainForm)MainFormManager.MainForm).ResetAppStartingCursor();
       }
     }
@@ -108 +89 @@
     }
     private static void Save(IContentView view) {
-      if (!view.Locked) {
-        if ((!files.ContainsKey(view)) || (!File.Exists(files[view].Filename))) {
+      IStorableContent content = view.Content as IStorableContent;
+      if (!view.Locked && (content != null)) {
+        if (string.IsNullOrEmpty(content.Filename))
           SaveAs(view);
-        } else {
-          if (files[view].Compressed)
-            SaveItemAsync(view, files[view].Filename, 9);
-          else
-            SaveItemAsync(view, files[view].Filename, 0);
+        else {
+          ((OptimizerMainForm)MainFormManager.MainForm).SetAppStartingCursor();
+          ((Form)MainFormManager.MainForm).Enabled = false;
+          ContentManager.SaveAsync(content, content.Filename, true, SavingCompleted);
         }
       }
     }
-
     public static void SaveAs() {
       IContentView activeView = MainFormManager.MainForm.ActiveView as IContentView;
@@ -127 +107 @@
     }
     public static void SaveAs(IContentView view) {
-      if (!view.Locked) {
+      IStorableContent content = view.Content as IStorableContent;
+      if (!view.Locked && (content != null)) {
         if (saveFileDialog == null) {
           saveFileDialog = new SaveFileDialog();
@@ -135 +116 @@
           saveFileDialog.FilterIndex = 2;
         }
-
-        if (!files.ContainsKey(view)) {
-          files.Add(view, new FileInfo());
-          saveFileDialog.FileName = view.Caption;
-        } else {
-          saveFileDialog.FileName = files[view].Filename;
-        }
-        if (!files[view].Compressed)
-          saveFileDialog.FilterIndex = 1;
-        else
-          saveFileDialog.FilterIndex = 2;
+        saveFileDialog.FileName = string.IsNullOrEmpty(content.Filename) ? "Item" : content.Filename;
 
         if (saveFileDialog.ShowDialog() == DialogResult.OK) {
+          ((OptimizerMainForm)MainFormManager.MainForm).SetAppStartingCursor();
+          ((Form)MainFormManager.MainForm).Enabled = false;
           if (saveFileDialog.FilterIndex == 1) {
-            SaveItemAsync(view, saveFileDialog.FileName, 0);
+            ContentManager.SaveAsync(content, saveFileDialog.FileName, false, SavingCompleted);
           } else {
-            SaveItemAsync(view, saveFileDialog.FileName, 9);
+            ContentManager.SaveAsync(content, saveFileDialog.FileName, true, SavingCompleted);
           }
         }
       }
     }
-
     public static void SaveAll() {
       foreach (IContentView view in MainFormManager.MainForm.Views.OfType<IContentView>())
         Save(view);
     }
-
-    // NOTE: This event is fired by the main form. It is registered in HeuristicLabOptimizerApplication.
-    internal static void ViewClosed(object sender, ViewEventArgs e) {
-      IContentView view = e.View as IContentView;
-      if (view != null) files.Remove(view);
+    private static void SavingCompleted(IStorableContent content, Exception error) {
+      try {
+        if (error != null) throw error;
+        Invoke(delegate() {
+          ((OptimizerMainForm)MainFormManager.MainForm).UpdateTitle();
+          ((Form)MainFormManager.MainForm).Enabled = true;
+        });
+      }
+      catch (Exception ex) {
+        Auxiliary.ShowErrorMessageBox(ex);
+      }
+      finally {
+        ((OptimizerMainForm)MainFormManager.MainForm).ResetAppStartingCursor();
+      }
     }
 
-    #region Asynchronous Save/Load Operations
     private static void Invoke(Action a) {
       Form form = MainFormManager.MainForm as Form;
@@ -176 +156 @@
         a.Invoke();
     }
-
-    private static void SaveItemAsync(IContentView view, string filename, int compression) {
-      ThreadPool.QueueUserWorkItem(
-        new WaitCallback(
-          delegate(object arg) {
-            try {
-              DisableView(view);
-              SetWaitingCursor();
-              XmlGenerator.Serialize(view.Content, filename, compression);
-              Invoke(delegate() {
-                view.Caption = Path.GetFileName(filename);
-                files[view].Filename = filename;
-                files[view].Compressed = compression > 0;
-              });
-            }
-            catch (Exception ex) {
-              Auxiliary.ShowErrorMessageBox(ex);
-            } finally {
-              ResetWaitingCursor();
-              EnableView(view);
-            }
-          }
-        )
-      );
-    }
-    private static void LoadItemAsync(string filename) {
-      ThreadPool.QueueUserWorkItem(
-        new WaitCallback(
-          delegate(object arg) {
-            try {
-              SetWaitingCursor();
-              object content = XmlParser.Deserialize(filename);
-              Invoke(delegate() {
-                IContentView view = MainFormManager.CreateDefaultView(content) as IContentView;
-                if (view == null) {
-                  MessageBox.Show("There is no view for the loaded item. It cannot be displayed. ", "No View Available", MessageBoxButtons.OK, MessageBoxIcon.Error);
-                } else {
-                  view.Caption = Path.GetFileName(filename);
-                  files.Add(view, new FileInfo(filename));
-                  view.Show();
-                }
-              });
-            } catch (Exception ex) {
-              Auxiliary.ShowErrorMessageBox(ex);
-            } finally {
-              ResetWaitingCursor();
-            }
-          }
-        )
-      );
-    }
-
-    private static void SetWaitingCursor() {
-      Invoke(delegate() {
-        waitingCursors++;
-        ((Form)MainFormManager.MainForm).Cursor = Cursors.AppStarting;
-      });
-    }
-    private static void ResetWaitingCursor() {
-      Invoke(delegate() {
-        waitingCursors--;
-        if (waitingCursors == 0) ((Form)MainFormManager.MainForm).Cursor = Cursors.Default;
-      });
-    }
-    private static void DisableView(IView view) {
-      Invoke(delegate() {
-        ((Control)view).SuspendRepaint();
-        ((Control)view).Enabled = false;
-        ((Control)view).ResumeRepaint(true);
-      });
-    }
-    private static void EnableView(IView view) {
-      Invoke(delegate() {
-        ((Control)view).SuspendRepaint();
-        ((Control)view).Enabled = true;
-        ((Control)view).ResumeRepaint(true);
-      });
-    }
-    #endregion
   }
 }

trunk/sources/HeuristicLab.Optimizer/3.3/MenuItems/CopyToClipboardMenuItem.cs

@@ -39 +39 @@
       get { return 2100; }
     }
-    public override Keys ShortCutKeys {
-      get { return Keys.Control | Keys.C; }
-    }
 
     protected override void OnToolStripItemSet(EventArgs e) {
@@ -48 +45 @@
     protected override void OnActiveViewChanged(object sender, EventArgs e) {
       ItemView activeView = MainFormManager.MainForm.ActiveView as ItemView;
-      ToolStripItem.Enabled = (activeView != null) && (!activeView.Locked);
+      ToolStripItem.Enabled = (activeView != null) && (activeView.Content != null) && !activeView.Locked;
     }
 
     public override void Execute() {
       ItemView activeView = MainFormManager.MainForm.ActiveView as ItemView;
-      if ((activeView != null) && (!activeView.Locked)) {
+      if ((activeView != null) && (activeView.Content != null) && !activeView.Locked) {
         Clipboard<IItem> clipboard = ((OptimizerMainForm)MainFormManager.MainForm).Clipboard;
         clipboard.AddItem((IItem)activeView.Content.Clone());

trunk/sources/HeuristicLab.Optimizer/3.3/MenuItems/SaveAllMenuItem.cs

@@ -25 +25 @@
 using System.Linq;
 using System.Windows.Forms;
+using HeuristicLab.Common;
 using HeuristicLab.MainForm;
 
@@ -47 +48 @@
     protected override void OnActiveViewChanged(object sender, EventArgs e) {
       var views = from v in MainFormManager.MainForm.Views.OfType<IContentView>()
+                  where v.Content != null
+                  where v.Content is IStorableContent
                   where !v.Locked
                   select v;

trunk/sources/HeuristicLab.Optimizer/3.3/MenuItems/SaveAsMenuItem.cs

@@ -23 +23 @@
 using System.Collections.Generic;
 using System.Windows.Forms;
+using HeuristicLab.Common;
 using HeuristicLab.MainForm;
 
@@ -45 +46 @@
     protected override void OnActiveViewChanged(object sender, EventArgs e) {
       IContentView activeView = MainFormManager.MainForm.ActiveView as IContentView;
-      ToolStripItem.Enabled = (activeView != null) && (!activeView.Locked);
+      ToolStripItem.Enabled = (activeView != null) && (activeView.Content != null) &&
+                              (activeView.Content is IStorableContent) && !activeView.Locked;
     }
 

trunk/sources/HeuristicLab.Optimizer/3.3/MenuItems/SaveMenuItem.cs

@@ -24 +24 @@
 using System.Drawing;
 using System.Windows.Forms;
+using HeuristicLab.Common;
 using HeuristicLab.MainForm;
 
@@ -49 +50 @@
     protected override void OnActiveViewChanged(object sender, EventArgs e) {
       IContentView activeView = MainFormManager.MainForm.ActiveView as IContentView;
-      ToolStripItem.Enabled = (activeView != null) && (!activeView.Locked);
+      ToolStripItem.Enabled = (activeView != null) && (activeView.Content != null) &&
+                              (activeView.Content is IStorableContent) && !activeView.Locked;
     }
 

trunk/sources/HeuristicLab.Optimizer/3.3/OptimizerMainForm.cs

@@ -32 +32 @@
 namespace HeuristicLab.Optimizer {
   internal partial class OptimizerMainForm : DockingMainForm {
+    private string title;
+    private int appStartingCursors;
+    private int waitingCursors;
+
     private Clipboard<IItem> clipboard;
     public Clipboard<IItem> Clipboard {
@@ -40 +44 @@
       : base() {
       InitializeComponent();
+      appStartingCursors = 0;
+      waitingCursors = 0;
     }
     public OptimizerMainForm(Type userInterfaceItemType)
       : base(userInterfaceItemType) {
       InitializeComponent();
+      appStartingCursors = 0;
+      waitingCursors = 0;
     }
     public OptimizerMainForm(Type userInterfaceItemType, bool showViewsInViewHost)
@@ -54 +62 @@
       AssemblyFileVersionAttribute version = Assembly.GetExecutingAssembly().GetCustomAttributes(typeof(AssemblyFileVersionAttribute), true).
                                              Cast<AssemblyFileVersionAttribute>().FirstOrDefault();
-      Title = "HeuristicLab Optimizer";
-      if (version != null) Title += " " + version.Version;
-      ViewClosed += new EventHandler<ViewEventArgs>(FileManager.ViewClosed);
+      title = "HeuristicLab Optimizer";
+      if (version != null) title += " " + version.Version;
+      Title = title;
+
+      ContentManager.Initialize(new PersistenceContentManager());
 
       clipboard = new Clipboard<IItem>();
@@ -73 +83 @@
       }
     }
+
+    protected override void OnActiveViewChanged() {
+      base.OnActiveViewChanged();
+      UpdateTitle();
+    }
+
+    public void UpdateTitle() {
+      if (InvokeRequired)
+        Invoke(new Action(UpdateTitle));
+      else {
+        IContentView activeView = ActiveView as IContentView;
+        if ((activeView != null) && (activeView.Content != null) && (activeView.Content is IStorableContent)) {
+          IStorableContent content = (IStorableContent)activeView.Content;
+          Title = title + " [" + (string.IsNullOrEmpty(content.Filename) ? "Unsaved" : content.Filename) + "]";
+        } else {
+          Title = title;
+        }
+      }
+    }
+
+    #region Cursor Handling
+    public void SetAppStartingCursor() {
+      if (InvokeRequired)
+        Invoke(new Action(SetAppStartingCursor));
+      else {
+        appStartingCursors++;
+        SetCursor();
+      }
+    }
+    public void ResetAppStartingCursor() {
+      if (InvokeRequired)
+        Invoke(new Action(ResetAppStartingCursor));
+      else {
+        appStartingCursors--;
+        SetCursor();
+      }
+    }
+    public void SetWaitCursor() {
+      if (InvokeRequired)
+        Invoke(new Action(SetWaitCursor));
+      else {
+        waitingCursors++;
+        SetCursor();
+      }
+    }
+    public void ResetWaitCursor() {
+      if (InvokeRequired)
+        Invoke(new Action(ResetWaitCursor));
+      else {
+        waitingCursors--;
+        SetCursor();
+      }
+    }
+    private void SetCursor() {
+      if (waitingCursors > 0) Cursor = Cursors.WaitCursor;
+      else if (appStartingCursors > 0) Cursor = Cursors.AppStarting;
+      else Cursor = Cursors.Default;
+    }
+    #endregion
   }
 }

trunk/sources/HeuristicLab.Optimizer/3.3/ToolBarItems/SaveAllToolBarItem.cs

@@ -24 +24 @@
 using System.Linq;
 using System.Windows.Forms;
+using HeuristicLab.Common;
 using HeuristicLab.MainForm;
 
@@ -46 +47 @@
     protected override void OnActiveViewChanged(object sender, EventArgs e) {
       var views = from v in MainFormManager.MainForm.Views.OfType<IContentView>()
+                  where v.Content != null
+                  where v.Content is IStorableContent
                   where !v.Locked
                   select v;

trunk/sources/HeuristicLab.Optimizer/3.3/ToolBarItems/SaveToolBarItem.cs

@@ -23 +23 @@
 using System.Drawing;
 using System.Windows.Forms;
+using HeuristicLab.Common;
 using HeuristicLab.MainForm;
 
@@ -45 +46 @@
     protected override void OnActiveViewChanged(object sender, EventArgs e) {
       IContentView activeView = MainFormManager.MainForm.ActiveView as IContentView;
-      ToolStripItem.Enabled = (activeView != null) && (!activeView.Locked);
+      ToolStripItem.Enabled = (activeView != null) && (activeView.Content != null) &&
+                              (activeView.Content is IStorableContent) && !activeView.Locked;
     }