JAL-3453 Some tests require different Desktop constructor
[jalview.git] / src / jalview / gui / Desktop.java
index 826a869..91e1948 100644 (file)
@@ -22,8 +22,10 @@ package jalview.gui;
 
 import jalview.api.AlignViewportI;
 import jalview.api.AlignmentViewPanel;
+import jalview.api.StructureSelectionManagerProvider;
+import jalview.bin.ApplicationSingletonProvider;
+import jalview.bin.ApplicationSingletonProvider.ApplicationSingletonI;
 import jalview.bin.Cache;
-import jalview.bin.Instance;
 import jalview.bin.Jalview;
 import jalview.gui.ImageExporter.ImageWriterI;
 import jalview.io.BackupFiles;
@@ -37,6 +39,7 @@ import jalview.io.FormatAdapter;
 import jalview.io.IdentifyFile;
 import jalview.io.JalviewFileChooser;
 import jalview.io.JalviewFileView;
+import jalview.jbgui.GDesktop;
 import jalview.jbgui.GSplitFrame;
 import jalview.jbgui.GStructureViewer;
 import jalview.project.Jalview2XML;
@@ -135,9 +138,9 @@ import org.stackoverflowusers.file.WindowsShortcut;
  * @version $Revision: 1.155 $
  */
 @SuppressWarnings("serial")
-public class Desktop extends jalview.jbgui.GDesktop
+public class Desktop extends GDesktop
         implements DropTargetListener, ClipboardOwner, IProgressIndicator,
-        jalview.api.StructureSelectionManagerProvider
+        StructureSelectionManagerProvider, ApplicationSingletonI
 {
 
   private final static int DEFAULT_MIN_WIDTH = 300;
@@ -196,13 +199,14 @@ public class Desktop extends jalview.jbgui.GDesktop
 
   public static MyDesktopPane getDesktopPane()
   {
-    return Desktop.getInstance().desktopPane;
+    Desktop desktop = Desktop.getInstance();
+    return desktop == null ? null : desktop.desktopPane;
   }
 
   public static StructureSelectionManager getStructureSelectionManager()
   {
     return StructureSelectionManager
-            .getStructureSelectionManager(Desktop.getInstance());
+            .getStructureSelectionManager(getInstance());
   }
 
   static int openFrameCount = 0;
@@ -219,12 +223,21 @@ public class Desktop extends jalview.jbgui.GDesktop
 
   private static int fileLoadingCount = 0;
 
-  public JInternalFrame conservationSlider, PIDSlider;
+  public JInternalFrame conservationSlider;
+
+  public JInternalFrame PIDSlider;
 
   /**
    * just an instance (for testng, probably); no actual frames
+   * 
+   * This flag, when set true, allows a headless-like operation, with a Desktop
+   * object but no actual frames. Though not headless, this option disallows
+   * dialogs to run in test environments.
+   * 
+   * It is set by invoking Desktop.getInstanceOnly().
+   * 
    */
-  private boolean instanceOnly;
+  boolean instanceOnly;
 
   class MyDesktopManager implements DesktopManager
   {
@@ -351,195 +364,224 @@ public class Desktop extends jalview.jbgui.GDesktop
 
   public MyDesktopPane desktopPane;
 
+  /**
+   * Answers an 'application scope' singleton instance of this class. Separate
+   * SwingJS 'applets' running in the same browser page will each have a
+   * distinct instance of Desktop.
+   * 
+   * @return
+   */
   public static Desktop getInstance()
   {
-    Instance i = Instance.getInstance();
-    return (i.desktop == null ? (i.desktop = new Desktop(true))
-            : i.desktop);
+    return Jalview.isHeadlessMode() ? null
+            : (Desktop) ApplicationSingletonProvider
+                    .getInstance(Desktop.class);
   }
 
   /**
-   * For testing.
+   * For TestNG, this constructor can be utilized to allow the creation of a
+   * singleton Desktop instance with the creation of frames, but no addition to
+   * the Desktop object, as in headless mode. Dialogs are not initiated.
+   * Cache.log is also initialized for some tests that require it despite there
+   * being no Desktop.
    * 
-   * @param forInstance
    */
-  public Desktop(boolean forInstance)
+  public static Desktop getInstanceOnly()
   {
-    instanceOnly = true;
+    Desktop d = (Desktop) ApplicationSingletonProvider
+            .getInstance(Desktop.class);
+    d.instanceOnly = true;
+    return d;
   }
+  
   /**
-   * Creates a new Desktop object.
+   * Private constructor enforces singleton pattern. It is called by reflection
+   * from ApplicationSingletonProvider.getInstance().
    */
-  public Desktop()
+  @SuppressWarnings("unused")
+  private Desktop()
   {
-    /**
-     * A note to implementors. It is ESSENTIAL that any activities that might
-     * block are spawned off as threads rather than waited for during this
-     * constructor.
-     */
-    Instance.getInstance().desktop = this;
-
-    if (!Platform.isJS())
+    Cache.initLogger();
+    try
     {
-      doVamsasClientCheck();
-    }
+      /**
+       * A note to implementors. It is ESSENTIAL that any activities that might
+       * block are spawned off as threads rather than waited for during this
+       * constructor.
+       */
+      if (!Platform.isJS())
+      {
+        doVamsasClientCheck();
+      }
 
-    doConfigureStructurePrefs();
-    setTitle("Jalview " + jalview.bin.Cache.getProperty("VERSION"));
-    setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
-    boolean selmemusage = jalview.bin.Cache.getDefault("SHOW_MEMUSAGE",
-            false);
-    boolean showjconsole = jalview.bin.Cache.getDefault("SHOW_JAVA_CONSOLE",
-            false);
-    desktopPane = new MyDesktopPane(selmemusage);
+      doConfigureStructurePrefs();
+      setTitle("Jalview " + jalview.bin.Cache.getProperty("VERSION"));
+      setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
+      boolean selmemusage = jalview.bin.Cache.getDefault("SHOW_MEMUSAGE",
+              false);
+      boolean showjconsole = jalview.bin.Cache
+              .getDefault("SHOW_JAVA_CONSOLE", false);
+      desktopPane = new MyDesktopPane(selmemusage);
 
-    showMemusage.setSelected(selmemusage);
-    desktopPane.setBackground(Color.white);
-    getContentPane().setLayout(new BorderLayout());
-    // alternate config - have scrollbars - see notes in JAL-153
-    // JScrollPane sp = new JScrollPane();
-    // sp.getViewport().setView(desktop);
-    // getContentPane().add(sp, BorderLayout.CENTER);
+      showMemusage.setSelected(selmemusage);
+      desktopPane.setBackground(Color.white);
+      getContentPane().setLayout(new BorderLayout());
+      // alternate config - have scrollbars - see notes in JAL-153
+      // JScrollPane sp = new JScrollPane();
+      // sp.getViewport().setView(desktop);
+      // getContentPane().add(sp, BorderLayout.CENTER);
 
-    // BH 2018 - just an experiment to try unclipped JInternalFrames.
-    if (Platform.isJS())
-    {
-      getRootPane().putClientProperty("swingjs.overflow.hidden", "false");
-    }
+      // BH 2018 - just an experiment to try unclipped JInternalFrames.
+      if (Platform.isJS())
+      {
+        getRootPane().putClientProperty("swingjs.overflow.hidden", "false");
+      }
 
-    getContentPane().add(desktopPane, BorderLayout.CENTER);
-    desktopPane.setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
+      getContentPane().add(desktopPane, BorderLayout.CENTER);
+      desktopPane.setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
 
-    // This line prevents Windows Look&Feel resizing all new windows to maximum
-    // if previous window was maximised
-    desktopPane.setDesktopManager(new MyDesktopManager(
-            (Platform.isWindowsAndNotJS() ? new DefaultDesktopManager()
-                    : Platform.isAMacAndNotJS()
-                            ? new AquaInternalFrameManager(
-                                    desktopPane.getDesktopManager())
-                            : desktopPane.getDesktopManager())));
+      // This line prevents Windows Look&Feel resizing all new windows to
+      // maximum
+      // if previous window was maximised
+      desktopPane.setDesktopManager(new MyDesktopManager(
+              (Platform.isWindowsAndNotJS() ? new DefaultDesktopManager()
+                      : Platform.isAMacAndNotJS()
+                              ? new AquaInternalFrameManager(
+                                      desktopPane.getDesktopManager())
+                              : desktopPane.getDesktopManager())));
 
-    Rectangle dims = getLastKnownDimensions("");
-    if (dims != null)
-    {
-      setBounds(dims);
-    }
-    else
-    {
-      Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
-      int xPos = Math.max(5, (screenSize.width - 900) / 2);
-      int yPos = Math.max(5, (screenSize.height - 650) / 2);
-      setBounds(xPos, yPos, 900, 650);
-    }
+      Rectangle dims = getLastKnownDimensions("");
+      if (dims != null)
+      {
+        setBounds(dims);
+      }
+      else
+      {
+        Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
+        int xPos = Math.max(5, (screenSize.width - 900) / 2);
+        int yPos = Math.max(5, (screenSize.height - 650) / 2);
+        setBounds(xPos, yPos, 900, 650);
+      }
 
-    if (!Platform.isJS())
-    /**
-     * Java only
-     * 
-     * @j2sIgnore
-     */
-    {
+      // Note that this next syntax, checking for Platform.isJS and also
+      // escaping the code using @j2sIgnore, serves two purposes. It gives
+      // us an easily findable tag, Platform.isJS(), to places in the code where
+      // there is something different about the SwingJS implementation. Second,
+      // it deletes the unneeded Java-only code form the JavaScript version
+      // completely (@j2sIgnore), since it will never be used there.
 
-      jconsole = new Console(this, showjconsole);
-      // add essential build information
-      jconsole.setHeader("Jalview Version: "
-              + jalview.bin.Cache.getProperty("VERSION") + "\n"
-              + "Jalview Installation: "
-              + jalview.bin.Cache.getDefault("INSTALLATION", "unknown")
-              + "\n" + "Build Date: "
-              + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown") + "\n"
-              + "Java version: " + System.getProperty("java.version") + "\n"
-              + System.getProperty("os.arch") + " "
-              + System.getProperty("os.name") + " "
-              + System.getProperty("os.version"));
+      if (!Platform.isJS())
+      /**
+       * Java only
+       * 
+       * @j2sIgnore
+       */
+      {
 
-      showConsole(showjconsole);
+        jconsole = new Console(this, showjconsole);
+        // add essential build information
+        jconsole.setHeader("Jalview Version: "
+                + jalview.bin.Cache.getProperty("VERSION") + "\n"
+                + "Jalview Installation: "
+                + jalview.bin.Cache.getDefault("INSTALLATION", "unknown")
+                + "\n" + "Build Date: "
+                + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown")
+                + "\n" + "Java version: "
+                + System.getProperty("java.version") + "\n"
+                + System.getProperty("os.arch") + " "
+                + System.getProperty("os.name") + " "
+                + System.getProperty("os.version"));
 
-      showNews.setVisible(false);
+        showConsole(showjconsole);
 
-      experimentalFeatures.setSelected(showExperimental());
+        showNews.setVisible(false);
 
-      getIdentifiersOrgData();
+        experimentalFeatures.setSelected(showExperimental());
 
-      checkURLLinks();
+        getIdentifiersOrgData();
 
-      // Spawn a thread that shows the splashscreen
+        checkURLLinks();
 
-      SwingUtilities.invokeLater(new Runnable()
-      {
-        @Override
-        public void run()
-        {
-          new SplashScreen();
-        }
-      });
+        // Spawn a thread that shows the splashscreen
 
-      // Thread off a new instance of the file chooser - this reduces the time
-      // it
-      // takes to open it later on.
-      new Thread(new Runnable()
-      {
-        @Override
-        public void run()
+        SwingUtilities.invokeLater(new Runnable()
         {
-          Cache.log.debug("Filechooser init thread started.");
-          String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
-          JalviewFileChooser.forRead(Cache.getProperty("LAST_DIRECTORY"),
-                  fileFormat);
-          Cache.log.debug("Filechooser init thread finished.");
-        }
-      }).start();
-      // Add the service change listener
-      changeSupport.addJalviewPropertyChangeListener("services",
-              new PropertyChangeListener()
-              {
+          @Override
+          public void run()
+          {
+            new SplashScreen();
+          }
+        });
 
-                @Override
-                public void propertyChange(PropertyChangeEvent evt)
+        // Thread off a new instance of the file chooser - this reduces the time
+        // it
+        // takes to open it later on.
+        new Thread(new Runnable()
+        {
+          @Override
+          public void run()
+          {
+            Cache.log.debug("Filechooser init thread started.");
+            String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
+            JalviewFileChooser.forRead(Cache.getProperty("LAST_DIRECTORY"),
+                    fileFormat);
+            Cache.log.debug("Filechooser init thread finished.");
+          }
+        }).start();
+        // Add the service change listener
+        changeSupport.addJalviewPropertyChangeListener("services",
+                new PropertyChangeListener()
                 {
-                  Cache.log.debug("Firing service changed event for "
-                          + evt.getNewValue());
-                  JalviewServicesChanged(evt);
-                }
 
-              });
-
-    }
+                  @Override
+                  public void propertyChange(PropertyChangeEvent evt)
+                  {
+                    Cache.log.debug("Firing service changed event for "
+                            + evt.getNewValue());
+                    JalviewServicesChanged(evt);
+                  }
 
-    this.setDropTarget(new java.awt.dnd.DropTarget(desktopPane, this));
+                });
 
-    this.addWindowListener(new WindowAdapter()
-    {
-      @Override
-      public void windowClosing(WindowEvent evt)
-      {
-        quit();
       }
-    });
 
-    MouseAdapter ma;
-    this.addMouseListener(ma = new MouseAdapter()
-    {
-      @Override
-      public void mousePressed(MouseEvent evt)
+      this.setDropTarget(new java.awt.dnd.DropTarget(desktopPane, this));
+
+      this.addWindowListener(new WindowAdapter()
       {
-        if (evt.isPopupTrigger()) // Mac
+        @Override
+        public void windowClosing(WindowEvent evt)
         {
-          showPasteMenu(evt.getX(), evt.getY());
+          quit();
         }
-      }
+      });
 
-      @Override
-      public void mouseReleased(MouseEvent evt)
+      MouseAdapter ma;
+      this.addMouseListener(ma = new MouseAdapter()
       {
-        if (evt.isPopupTrigger()) // Windows
+        @Override
+        public void mousePressed(MouseEvent evt)
         {
-          showPasteMenu(evt.getX(), evt.getY());
+          if (evt.isPopupTrigger()) // Mac
+          {
+            showPasteMenu(evt.getX(), evt.getY());
+          }
         }
-      }
-    });
-    desktopPane.addMouseListener(ma);
 
+        @Override
+        public void mouseReleased(MouseEvent evt)
+        {
+          if (evt.isPopupTrigger()) // Windows
+          {
+            showPasteMenu(evt.getX(), evt.getY());
+          }
+        }
+      });
+      desktopPane.addMouseListener(ma);
+    } catch (Throwable t)
+    {
+      t.printStackTrace();
+    }
   }
 
   /**
@@ -558,7 +600,8 @@ public class Desktop extends jalview.jbgui.GDesktop
   public void doConfigureStructurePrefs()
   {
     // configure services
-    StructureSelectionManager ssm = getStructureSelectionManager();
+    StructureSelectionManager ssm = StructureSelectionManager
+            .getStructureSelectionManager(this);
     if (jalview.bin.Cache.getDefault(Preferences.ADD_SS_ANN, true))
     {
       ssm.setAddTempFacAnnot(jalview.bin.Cache
@@ -614,7 +657,7 @@ public class Desktop extends jalview.jbgui.GDesktop
         }
       }
     }).start();
-    ;
+    
   }
 
   @Override
@@ -776,7 +819,7 @@ public class Desktop extends jalview.jbgui.GDesktop
         FileFormatI format = new IdentifyFile().identify(file,
                 DataSourceType.PASTE);
 
-        new FileLoader().LoadFile(file, DataSourceType.PASTE, format);
+        new FileLoader().loadFile(file, DataSourceType.PASTE, format);
 
       }
     } catch (Exception ex)
@@ -871,21 +914,22 @@ public class Desktop extends jalview.jbgui.GDesktop
           int w, int h, boolean resizable, boolean ignoreMinSize)
   {
 
+
     // TODO: allow callers to determine X and Y position of frame (eg. via
     // bounds object).
     // TODO: consider fixing method to update entries in the window submenu with
     // the current window title
 
     frame.setTitle(title);
-    if (frame.getWidth() < 1 || frame.getHeight() < 1)
+    if (w > 0 && (frame.getWidth() < 1 || frame.getHeight() < 1))
     {
       frame.setSize(w, h);
     }
     // THIS IS A PUBLIC STATIC METHOD, SO IT MAY BE CALLED EVEN IN
     // A HEADLESS STATE WHEN NO DESKTOP EXISTS. MUST RETURN
-    // IF JALVIEW IS RUNNING HEADLESS
+    // IF JALVIEW IS RUNNING HEADLESS OR IN INSTANCE-ONLY (testNG) MODE
     // ///////////////////////////////////////////////
-    if (Desktop.getInstance().instanceOnly || Jalview.isHeadlessMode())
+    if (Jalview.isHeadlessMode() || Desktop.getInstance().instanceOnly)
     {
       return;
     }
@@ -915,7 +959,8 @@ public class Desktop extends jalview.jbgui.GDesktop
     frame.setIconifiable(resizable);
     frame.setOpaque(Platform.isJS());
 
-    if (frame.getX() < 1 && frame.getY() < 1)
+    boolean isEmbedded = (Platform.getDimIfEmbedded(frame, -1, -1) != null);
+    if (!isEmbedded && frame.getX() < 1 && frame.getY() < 1)
     {
       frame.setLocation(xOffset * openFrameCount,
               yOffset * ((openFrameCount - 1) % 10) + yOffset);
@@ -964,7 +1009,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           menuItem.removeActionListener(menuItem.getActionListeners()[0]);
         }
         Desktop.getInstance().windowMenu.remove(menuItem);
-      };
+      }
     });
 
     menuItem.addActionListener(new ActionListener()
@@ -1123,7 +1168,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           {
             Platform.cacheFileData((File) file);
           }
-          new FileLoader().LoadFile(null, file, protocol, format);
+          new FileLoader().loadFile(null, file, protocol, format);
 
         }
       } catch (Exception ex)
@@ -1180,7 +1225,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           }
         }
 
-        new FileLoader().LoadFile(viewport, selectedFile,
+        new FileLoader().loadFile(viewport, selectedFile,
                 DataSourceType.FILE, format);
       }
     });
@@ -1254,12 +1299,12 @@ public class Desktop extends jalview.jbgui.GDesktop
         {
           if (viewport != null)
           {
-            new FileLoader().LoadFile(viewport, url, DataSourceType.URL,
+            new FileLoader().loadFile(viewport, url, DataSourceType.URL,
                     FileFormat.Jalview);
           }
           else
           {
-            new FileLoader().LoadFile(url, DataSourceType.URL,
+            new FileLoader().loadFile(url, DataSourceType.URL,
                     FileFormat.Jalview);
           }
         }
@@ -1289,12 +1334,12 @@ public class Desktop extends jalview.jbgui.GDesktop
 
           if (viewport != null)
           {
-            new FileLoader().LoadFile(viewport, url, DataSourceType.URL,
+            new FileLoader().loadFile(viewport, url, DataSourceType.URL,
                     format);
           }
           else
           {
-            new FileLoader().LoadFile(url, DataSourceType.URL, format);
+            new FileLoader().loadFile(url, DataSourceType.URL, format);
           }
         }
       }
@@ -2366,7 +2411,7 @@ public class Desktop extends jalview.jbgui.GDesktop
                 });
                 rthr.start();
               }
-            };
+            }
           });
           VamsasStMenu.add(sessit);
         }
@@ -3266,9 +3311,8 @@ public class Desktop extends jalview.jbgui.GDesktop
           } catch (InterruptedException x)
           {
           }
-          ;
         }
-        if (instanceOnly)
+        if (instanceOnly || Jalview.isHeadlessMode())
         {
           return;
         }
@@ -3477,7 +3521,8 @@ public class Desktop extends jalview.jbgui.GDesktop
 
   public static groovy.ui.Console getGroovyConsole()
   {
-    return Desktop.getInstance().groovyConsole;
+    Desktop desktop = Desktop.getInstance();
+    return desktop == null ? null : desktop.groovyConsole;
   }
 
   /**
@@ -3555,7 +3600,6 @@ public class Desktop extends jalview.jbgui.GDesktop
             System.err.println(
                     "Please ignore plist error - occurs due to problem with java 8 on OSX");
           }
-          ;
         }
       } catch (Throwable ex)
       {