JAL-3130 Lots of deprecation fixes. See utils/deprecation_auto_fixes.sh for commands...
[jalview.git] / src / jalview / gui / Desktop.java
index 9e8624a..4c0faa8 100644 (file)
@@ -24,6 +24,7 @@ import jalview.api.AlignViewportI;
 import jalview.api.AlignmentViewPanel;
 import jalview.bin.Cache;
 import jalview.bin.Jalview;
+import jalview.io.BackupFiles;
 import jalview.io.DataSourceType;
 import jalview.io.FileFormat;
 import jalview.io.FileFormatException;
@@ -381,83 +382,84 @@ public class Desktop extends jalview.jbgui.GDesktop
       try
       {
 
-       if (Platform.isAMac())
-       {
-               if (desktopClass.getDeclaredMethod("setAboutHandler",
-                       new Class[]
-                       { AboutHandler.class }) != null)
-               {
-
-                 hdesktop.setAboutHandler(new AboutHandler()
-                 {
-                   @Override
-                   public void handleAbout(AboutEvent e)
-                   {
-                     aboutMenuItem_actionPerformed(null);
-                   }
-                 });
-
-               }
-
-               if (desktopClass.getDeclaredMethod("setPreferencesHandler",
-                       new Class[]
-                       { PreferencesHandler.class }) != null)
-               {
-
-                 hdesktop.setPreferencesHandler(new PreferencesHandler()
-                 {
-                   @Override
-                   public void handlePreferences(PreferencesEvent e)
-                   {
-                     preferences_actionPerformed(null);
-                   }
-                 });
-
-               }
-
-               if (desktopClass.getDeclaredMethod("setQuitHandler",
-                       new Class[]
-                       { QuitHandler.class }) != null)
-               {
-
-                 hdesktop.setQuitHandler(new QuitHandler()
-                 {
-                   @Override
-                   public void handleQuitRequestWith(QuitEvent e, QuitResponse r)
-                   {
-                     boolean confirmQuit = jalview.bin.Cache
-                             .getDefault(CONFIRM_KEYBOARD_QUIT, true);
-                     int n;
-                     if (confirmQuit)
-                     {
-                       n = JOptionPane.showConfirmDialog(null,
-                               MessageManager.getString("label.quit_jalview"),
-                               MessageManager.getString("action.quit"),
-                               JOptionPane.OK_CANCEL_OPTION,
-                               JOptionPane.PLAIN_MESSAGE, null);
-                     }
-                     else
-                     {
-                       n = JOptionPane.OK_OPTION;
-                     }
-                     if (n == JOptionPane.OK_OPTION)
-                     {
-                       System.out.println("Shortcut Quit confirmed by user");
-                       quit();
-                       r.performQuit(); // probably won't reach this line, but just in
-                                        // case
-                     }
-                     else
-                     {
-                       r.cancelQuit();
-                       System.out.println("Shortcut Quit cancelled by user");
-                     }
-                   }
-                 });
-                 hdesktop.setQuitStrategy(QuitStrategy.CLOSE_ALL_WINDOWS);
-
-               }
-       }
+        if (Platform.isAMac())
+        {
+          if (desktopClass.getDeclaredMethod("setAboutHandler",
+                  new Class[]
+                  { AboutHandler.class }) != null)
+          {
+
+            hdesktop.setAboutHandler(new AboutHandler()
+            {
+              @Override
+              public void handleAbout(AboutEvent e)
+              {
+                aboutMenuItem_actionPerformed(null);
+              }
+            });
+
+          }
+
+          if (desktopClass.getDeclaredMethod("setPreferencesHandler",
+                  new Class[]
+                  { PreferencesHandler.class }) != null)
+          {
+
+            hdesktop.setPreferencesHandler(new PreferencesHandler()
+            {
+              @Override
+              public void handlePreferences(PreferencesEvent e)
+              {
+                preferences_actionPerformed(null);
+              }
+            });
+
+          }
+
+          if (desktopClass.getDeclaredMethod("setQuitHandler",
+                  new Class[]
+                  { QuitHandler.class }) != null)
+          {
+
+            hdesktop.setQuitHandler(new QuitHandler()
+            {
+              @Override
+              public void handleQuitRequestWith(QuitEvent e, QuitResponse r)
+              {
+                boolean confirmQuit = jalview.bin.Cache
+                        .getDefault(CONFIRM_KEYBOARD_QUIT, true);
+                int n;
+                if (confirmQuit)
+                {
+                  n = JOptionPane.showConfirmDialog(null,
+                          MessageManager.getString("label.quit_jalview"),
+                          MessageManager.getString("action.quit"),
+                          JOptionPane.OK_CANCEL_OPTION,
+                          JOptionPane.PLAIN_MESSAGE, null);
+                }
+                else
+                {
+                  n = JOptionPane.OK_OPTION;
+                }
+                if (n == JOptionPane.OK_OPTION)
+                {
+                  System.out.println("Shortcut Quit confirmed by user");
+                  quit();
+                  r.performQuit(); // probably won't reach this line, but just
+                                   // in
+                                   // case
+                }
+                else
+                {
+                  r.cancelQuit();
+                  System.out.println("Shortcut Quit cancelled by user");
+                }
+              }
+            });
+            hdesktop.setQuitStrategy(QuitStrategy.CLOSE_ALL_WINDOWS);
+
+          }
+        }
 
       } catch (NoSuchMethodException e)
       {
@@ -1106,7 +1108,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     KeyStroke ctrlWKey = KeyStroke.getKeyStroke(KeyEvent.VK_W,
             InputEvent.CTRL_DOWN_MASK);
     KeyStroke cmdWKey = KeyStroke.getKeyStroke(KeyEvent.VK_W,
-            Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
+            Toolkit.getDefaultToolkit().getMenuShortcutKeyMaskEx());
 
     InputMap inputMap = frame
             .getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
@@ -1220,7 +1222,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   {
     String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
     JalviewFileChooser chooser = JalviewFileChooser
-            .forRead(Cache.getProperty("LAST_DIRECTORY"), fileFormat);
+            .forRead(Cache.getProperty("LAST_DIRECTORY"), fileFormat, true);
 
     chooser.setFileView(new JalviewFileView());
     chooser.setDialogTitle(
@@ -1385,8 +1387,8 @@ public class Desktop extends jalview.jbgui.GDesktop
   @Override
   public void quit()
   {
-    System.out.println("********** Desktop.quit()");
-    System.out.println(savingFiles.toString());
+    //System.out.println("********** Desktop.quit()");
+    //System.out.println(savingFiles.toString());
     Dimension screen = Toolkit.getDefaultToolkit().getScreenSize();
     jalview.bin.Cache.setProperty("SCREENGEOMETRY_WIDTH",
             screen.width + "");
@@ -1741,20 +1743,43 @@ public class Desktop extends jalview.jbgui.GDesktop
   @Override
   public void saveState_actionPerformed()
   {
-    JalviewFileChooser chooser = new JalviewFileChooser("jvp",
-            "Jalview Project");
+    saveState_actionPerformed(false);
+  }
 
-    chooser.setFileView(new JalviewFileView());
-    chooser.setDialogTitle(MessageManager.getString("label.save_state"));
+  public void saveState_actionPerformed(boolean saveAs)
+  {
+    java.io.File projectFile = getProjectFile();
+    // autoSave indicates we already have a file and don't need to ask
+    boolean autoSave = projectFile != null && !saveAs
+            && BackupFiles.getEnabled();
 
-    int value = chooser.showSaveDialog(this);
+    // System.out.println("autoSave="+autoSave+", projectFile='"+projectFile+"',
+    // saveAs="+saveAs+", Backups
+    // "+(BackupFiles.getEnabled()?"enabled":"disabled"));
 
-    if (value == JalviewFileChooser.APPROVE_OPTION)
+    boolean approveSave = false;
+    if (!autoSave)
     {
-      final Desktop me = this;
-      final java.io.File choice = chooser.getSelectedFile();
-      setProjectFile(choice);
+      JalviewFileChooser chooser = new JalviewFileChooser("jvp",
+              "Jalview Project");
+
+      chooser.setFileView(new JalviewFileView());
+      chooser.setDialogTitle(MessageManager.getString("label.save_state"));
+
+      int value = chooser.showSaveDialog(this);
+
+      if (value == JalviewFileChooser.APPROVE_OPTION)
+      {
+        projectFile = chooser.getSelectedFile();
+        setProjectFile(projectFile);
+        approveSave = true;
+      }
+    }
 
+    if (approveSave || autoSave)
+    {
+      final Desktop me = this;
+      final java.io.File chosenFile = projectFile;
       new Thread(new Runnable()
       {
         @Override
@@ -1763,38 +1788,47 @@ public class Desktop extends jalview.jbgui.GDesktop
           // TODO: refactor to Jalview desktop session controller action.
           setProgressBar(MessageManager.formatMessage(
                   "label.saving_jalview_project", new Object[]
-                  { choice.getName() }), choice.hashCode());
+                  { chosenFile.getName() }), chosenFile.hashCode());
           jalview.bin.Cache.setProperty("LAST_DIRECTORY",
-                  choice.getParent());
+                  chosenFile.getParent());
           // TODO catch and handle errors for savestate
           // TODO prevent user from messing with the Desktop whilst we're saving
           try
           {
-            new Jalview2XML().saveState(choice);
+            BackupFiles backupfiles = new BackupFiles(chosenFile);
+
+            new Jalview2XML().saveState(backupfiles.getTempFile());
+
+            backupfiles.setWriteSuccess(true);
+            backupfiles.rollBackupsAndRenameTempFile();
           } catch (OutOfMemoryError oom)
           {
-            new OOMWarning(
-                    "Whilst saving current state to " + choice.getName(),
-                    oom);
+            new OOMWarning("Whilst saving current state to "
+                    + chosenFile.getName(), oom);
           } catch (Exception ex)
           {
-            Cache.log.error(
-                    "Problems whilst trying to save to " + choice.getName(),
-                    ex);
+            Cache.log.error("Problems whilst trying to save to "
+                    + chosenFile.getName(), ex);
             JvOptionPane.showMessageDialog(me,
                     MessageManager.formatMessage(
                             "label.error_whilst_saving_current_state_to",
                             new Object[]
-                            { choice.getName() }),
+                            { chosenFile.getName() }),
                     MessageManager.getString("label.couldnt_save_project"),
                     JvOptionPane.WARNING_MESSAGE);
           }
-          setProgressBar(null, choice.hashCode());
+          setProgressBar(null, chosenFile.hashCode());
         }
       }).start();
     }
   }
 
+  @Override
+  public void saveAsState_actionPerformed(ActionEvent e)
+  {
+    saveState_actionPerformed(true);
+  }
+
   private void setProjectFile(File choice)
   {
     this.projectFile = choice;
@@ -1816,9 +1850,9 @@ public class Desktop extends jalview.jbgui.GDesktop
     final String[] desc = new String[] { "Jalview Project",
         "Jalview Project (old)" };
     JalviewFileChooser chooser = new JalviewFileChooser(
-            Cache.getProperty("LAST_DIRECTORY"), suffix,
-            desc,
-            "Jalview Project");
+            Cache.getProperty("LAST_DIRECTORY"), suffix, desc,
+            "Jalview Project", true, true); // last two booleans: allFiles,
+                                            // allowBackupFiles
     chooser.setFileView(new JalviewFileView());
     chooser.setDialogTitle(MessageManager.getString("label.restore_state"));
 
@@ -2822,7 +2856,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   {
     getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
             .put(KeyStroke.getKeyStroke(KeyEvent.VK_Q,
-                    Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()),
+                    Toolkit.getDefaultToolkit().getMenuShortcutKeyMaskEx()),
                     "Quit");
     getRootPane().getActionMap().put("Quit", new AbstractAction()
     {
@@ -2879,18 +2913,18 @@ public class Desktop extends jalview.jbgui.GDesktop
       progressBarHandlers = new Hashtable<>();
     }
 
-    if (progressBars.get(new Long(id)) != null)
+    if (progressBars.get(Long.valueOf(id)) != null)
     {
-      JPanel panel = progressBars.remove(new Long(id));
-      if (progressBarHandlers.contains(new Long(id)))
+      JPanel panel = progressBars.remove(Long.valueOf(id));
+      if (progressBarHandlers.contains(Long.valueOf(id)))
       {
-        progressBarHandlers.remove(new Long(id));
+        progressBarHandlers.remove(Long.valueOf(id));
       }
       removeProgressPanel(panel);
     }
     else
     {
-      progressBars.put(new Long(id), addProgressPanel(message));
+      progressBars.put(Long.valueOf(id), addProgressPanel(message));
     }
   }
 
@@ -2905,13 +2939,13 @@ public class Desktop extends jalview.jbgui.GDesktop
           final IProgressIndicatorHandler handler)
   {
     if (progressBarHandlers == null
-            || !progressBars.containsKey(new Long(id)))
+            || !progressBars.containsKey(Long.valueOf(id)))
     {
       throw new Error(MessageManager.getString(
               "error.call_setprogressbar_before_registering_handler"));
     }
-    progressBarHandlers.put(new Long(id), handler);
-    final JPanel progressPanel = progressBars.get(new Long(id));
+    progressBarHandlers.put(Long.valueOf(id), handler);
+    final JPanel progressPanel = progressBars.get(Long.valueOf(id));
     if (handler.canCancel())
     {
       JButton cancel = new JButton(