JAL-3560 moving JS-specific code to Platform, fix Platform.streamToFile
[jalview.git] / src / jalview / util / Platform.java
index 8ebc67e..d9241b8 100644 (file)
@@ -22,6 +22,7 @@ package jalview.util;
 
 import jalview.javascript.json.JSON;
 
+import java.awt.Dimension;
 import java.awt.Toolkit;
 import java.awt.event.MouseEvent;
 import java.io.BufferedReader;
@@ -32,14 +33,21 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.Reader;
+import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.Properties;
+import java.util.logging.ConsoleHandler;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
+import javax.swing.JComponent;
 import javax.swing.SwingUtilities;
 
 import org.json.simple.parser.JSONParser;
 import org.json.simple.parser.ParseException;
 
+import com.stevesoft.pat.Regex;
+
 /**
  * System platform information used by Applet and Application
  * 
@@ -54,7 +62,7 @@ public class Platform
   private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null,
           isWin = null;
 
-  private static Boolean isHeadless = null;
+  // private static Boolean isHeadless = null;
 
   /**
    * added to group mouse events into Windows and nonWindows (mac, unix, linux)
@@ -111,18 +119,18 @@ public class Platform
     return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin);
   }
 
-  /**
-   * 
-   * @return true if we are running in non-interactive no UI mode
-   */
-  public static boolean isHeadless()
-  {
-    if (isHeadless == null)
-    {
-      isHeadless = "true".equals(System.getProperty("java.awt.headless"));
-    }
-    return isHeadless;
-  }
+  // /**
+  // *
+  // * @return true if we are running in non-interactive no UI mode
+  // */
+  // public static boolean isHeadless()
+  // {
+  // if (isHeadless == null)
+  // {
+  // isHeadless = "true".equals(System.getProperty("java.awt.headless"));
+  // }
+  // return isHeadless;
+  // }
 
   /**
    * 
@@ -260,6 +268,20 @@ public class Platform
 
   public static long time, mark, set, duration;
 
+  /**
+   * typical usage:
+   * 
+   * Platform.timeCheck(null, Platform.TIME_MARK);
+   * 
+   * ...
+   * 
+   * Platform.timeCheck("some message", Platform.TIME_MARK);
+   * 
+   * reset...[set/mark]n...get
+   * 
+   * @param msg
+   * @param mode
+   */
   public static void timeCheck(String msg, int mode)
   {
     long t = System.currentTimeMillis();
@@ -267,6 +289,7 @@ public class Platform
     {
     case TIME_RESET:
       time = mark = t;
+      duration = 0;
       if (msg != null)
       {
         System.err.println("Platform: timer reset\t\t\t" + msg);
@@ -275,6 +298,7 @@ public class Platform
     case TIME_MARK:
       if (set > 0)
       {
+        // total time between set/mark points
         duration += (t - set);
       }
       else
@@ -297,7 +321,7 @@ public class Platform
     case TIME_GET:
       if (msg != null)
       {
-        System.err.println("Platform: timer dur\t" + ((t - time) / 1000f)
+        System.err.println("Platform: timer get\t" + ((t - time) / 1000f)
                 + "\t" + ((duration) / 1000f) + "\t" + msg);
       }
       set = 0;
@@ -305,9 +329,9 @@ public class Platform
     }
   }
 
-  public static void cacheFileData(String path, byte[] data)
+  public static void cacheFileData(String path, Object data)
   {
-    if (!isJS())
+    if (!isJS() || data == null)
     {
       return;
     }
@@ -319,23 +343,48 @@ public class Platform
      */
   }
 
+  public static void cacheFileData(File file)
+  {
+    byte[] data;
+    if (!isJS() || (data = Platform.getFileBytes(file)) == null)
+    {
+      return;
+    }
+    cacheFileData(file.toString(), data);
+  }
+
   public static byte[] getFileBytes(File f)
   {
-    return /** @j2sNative f && f._bytes || */
+    // TODO temporary doubling of 秘bytes and _bytes;
+    // just remove _bytes when new transpiler has been installed
+    return /** @j2sNative f && (f.秘bytes || f._bytes) || */
     null;
   }
 
   public static byte[] getFileAsBytes(String fileStr)
   {
+    byte[] bytes = null;
     // BH 2018 hack for no support for access-origin
-    return /** @j2sNative swingjs.JSUtil.getFileAsBytes$O(fileStr) || */
-    null;
+    /**
+     * @j2sNative bytes = swingjs.JSUtil.getFileAsBytes$O(fileStr)
+     */
+    cacheFileData(fileStr, bytes);
+    return bytes;
   }
 
-  public static String getFileAsString(String data)
+  @SuppressWarnings("unused")
+  public static String getFileAsString(String url)
   {
-    return /** @j2sNative swingjs.JSUtil.getFileAsString$S(data) || */
-    null;
+    String ret = null;
+    /**
+     * @j2sNative
+     * 
+     *            ret = swingjs.JSUtil.getFileAsString$S(url);
+     * 
+     * 
+     */
+    cacheFileData(url, ret);
+    return ret;
   }
 
   public static boolean setFileBytes(File f, String urlstring)
@@ -346,8 +395,10 @@ public class Platform
     }
     @SuppressWarnings("unused")
     byte[] bytes = getFileAsBytes(urlstring);
+    // TODO temporary doubling of 秘bytes and _bytes;
+    // just remove _bytes when new transpiler has been installed
     /**
-     * @j2sNative f._bytes = bytes;
+     * @j2sNative f.秘bytes = f._bytes = bytes;
      */
     return true;
   }
@@ -382,10 +433,11 @@ public class Platform
    * @param url
    * @return true if window has been opened
    */
-  public static boolean openURL(String url)
+  public static boolean openURL(String url) throws IOException
   {
     if (!isJS())
     {
+      BrowserLauncher.openURL(url);
       return false;
     }
     /**
@@ -402,7 +454,7 @@ public class Platform
     @SuppressWarnings("unused")
     ThreadGroup g = Thread.currentThread().getThreadGroup();
     /**
-     * @j2sNative return g.html5Applet._uniqueId;
+     * @j2sNative return g.秘html5Applet._uniqueId;
      *
      */
     return null;
@@ -428,13 +480,13 @@ public class Platform
     String id = getUniqueAppletID();
     String key = "", value = "";
     /**
-     * @j2sNative var info = g.html5Applet.__Info || {}; for (var key in info) {
-     *            if (key.indexOf(prefix) == 0) { value = "" + info[key];
+     * @j2sNative var info = g.秘html5Applet.__Info || {}; for (var key in info)
+     *            { if (key.indexOf(prefix) == 0) { value = "" + info[key];
      */
 
     System.out.println(
             "Platform id=" + id + " reading Info." + key + " = " + value);
-    p.put(id + "_" + key, value);
+    p.put(key, value);
 
     /**
      * @j2sNative
@@ -522,6 +574,8 @@ public class Platform
           throws IOException
   {
     if (isJS() && /**
+                   * JSTempFile direct transfer
+                   * 
                    * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
                    */
             true)
@@ -557,15 +611,18 @@ public class Platform
   public static void addJ2SDirectDatabaseCall(String domain)
   {
 
-    System.out.println(
-            "Platform adding no-access-control-allow-origin domain "
+    if (isJS())
+    {
+      System.out.println(
+            "Platform adding known access-control-allow-origin * for domain "
                     + domain);
+      /**
+       * @j2sNative
+       * 
+       *            J2S.addDirectDatabaseCall(domain);
+       */
+    }
 
-    /**
-     * @j2sNative
-     * 
-     *            J2S.addDirectDatabaseCall(domain);
-     */
   }
 
   public static void getURLCommandArguments()
@@ -577,10 +634,215 @@ public class Platform
      * element to this value.
      * 
      * @j2sNative var a =
-     *            decodeURI(document.location.href.replace("&","?").split("?j2s")[0].split("?")[1].split("#")[0]);
-     *            a && (J2S.thisApplet.__Info.args = a.split(" "));
+     *            decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
+     *            + "?").split("?")[1].split("#")[0]); a &&
+     *            (J2S.thisApplet.__Info.args = a.split(" "));
      */
 
   }
 
+  public static URL getDocumentBase()
+  {
+    try
+    {
+      if (isJS())
+      {
+        @SuppressWarnings("unused")
+        Object g = Thread.currentThread().getThreadGroup();
+        return new URL(/**
+                        * @j2sNative g.秘html5Applet._appletPanel.appletDocumentBase
+                        *            ||
+                        */
+                "");
+      }
+    } catch (MalformedURLException e)
+    {
+    }
+    return null;
+  }
+
+  public static URL getCodeBase()
+  {
+    try
+    {
+      if (isJS())
+      {
+        @SuppressWarnings("unused")
+        Object g = Thread.currentThread().getThreadGroup();
+        return new URL(/**
+                        * @j2sNative g.秘html5Applet._appletPanel.appletCodeBase
+                        *            ||
+                        */
+                "");
+      }
+    } catch (MalformedURLException e)
+    {
+    }
+    return null;
+  }
+
+  /**
+   * load a resource -- probably a core file -- if and only if a particular
+   * class has not been instantialized. We use a String here because if we used
+   * a .class object, that reference itself would simply load the class, and we
+   * want the core package to include that as well.
+   * 
+   * @param resourcePath
+   * @param className
+   */
+  public static void loadStaticResource(Object resourcePath,
+          String className)
+  {
+    /**
+     * 
+     * @j2sNative if (!swingjs.JSUtil.isClassLoaded$S(className))
+     *            swingjs.JSUtil.loadStaticResource$S(resourcePath);
+     */
+  }
+
+  public static void ensureJmol()
+  {
+    loadStaticResource("core/core_jvjmol.z.js", "org.jmol.viewer.Viewer");
+  }
+
+  public static void ensureRegex()
+  {
+    loadStaticResource("core/core_stevesoft.z.js",
+            "com.stevesoft.pat.Regex");
+  }
+
+  public static Regex newRegex(String searchString, String replaceString)
+  {
+    ensureRegex();
+    return (replaceString == null ? new Regex(searchString)
+            : new Regex(searchString, replaceString));
+  }
+
+  public static Regex newRegexPerl(String code)
+  {
+    ensureRegex();
+    return Regex.perlCode(code);
+  }
+
+  /**
+   * Initialize Java debug logging. A representative sample -- adapt as desired.
+   */
+  public static void startJavaLogging()
+  {
+    /**
+     * @j2sIgnore
+     */
+    {
+      logClass("java.awt.EventDispatchThread", "java.awt.EventQueue",
+              "java.awt.Component", "java.awt.focus.Component",
+              "java.awt.event.Component",
+              "java.awt.focus.DefaultKeyboardFocusManager");
+    }
+  }
+
+  /**
+   * Initiate Java logging for a given class. Only for Java, not JavaScript;
+   * Allows debugging of complex event processing.
+   * 
+   * @param className
+   */
+  public static void logClass(String... classNames)
+  {
+    /**
+     * @j2sIgnore
+     * 
+     * 
+     */
+    {
+      Logger rootLogger = Logger.getLogger("");
+      rootLogger.setLevel(Level.ALL);
+      ConsoleHandler consoleHandler = new ConsoleHandler();
+      consoleHandler.setLevel(Level.ALL);
+      for (int i = classNames.length; --i >= 0;)
+      {
+        Logger logger = Logger.getLogger(classNames[i]);
+        logger.setLevel(Level.ALL);
+        logger.addHandler(consoleHandler);
+      }
+    }
+  }
+
+  /**
+   * Set the "app" property of the HTML5 applet object, for example,
+   * "testApplet.app", to point to the Jalview instance. This will be the object
+   * that page developers use that is similar to the original Java applet object
+   * that was accessed via LiveConnect.
+   * 
+   * @param j
+   */
+  public static void setAppClass(Object j)
+  {
+    if (!isJS())
+    {
+      return;
+    }
+    @SuppressWarnings("unused")
+    Thread t = Thread.currentThread();
+    /**
+     * Set up "testApplet.app" to be this instance
+     * 
+     * @j2sNative
+     * 
+     *            try {self[t.name].app = j}catch(e){}
+     */
+  }
+
+  /**
+   * Retrieve the object's embedded size from a div's style on a page if
+   * embedded in SwingJS.
+   * 
+   * @param frame
+   *          JFrame or JInternalFrame
+   * @param defaultWidth
+   *          use -1 to return null (no default size)
+   * @param defaultHeight
+   * @return the embedded dimensions or null (no default size or not embedded)
+   */
+  public static Dimension getDimIfEmbedded(JComponent frame,
+          int defaultWidth, int defaultHeight)
+  {
+    Dimension d = /** @j2sNative frame.ui.getEmbedded$S("dim") || */
+            null;
+    return (d == null && defaultWidth >= 0
+            ? new Dimension(defaultWidth, defaultHeight)
+            : d);
+  }
+
+  /**
+   *
+   * If this frame Is this frame embedded in a web page, return a known type.
+   * 
+   * @param frame
+   *          a JFrame or JInternalFrame
+   * @param type
+   * @return null if frame is not embedded.
+   */
+  public static Object getEmbeddedAttribute(Object frame, String type)
+  {
+    if (!isJS())
+    {
+      return null;
+    }
+    return (/** @j2sNative frame.ui.getEmbedded$S(type) || */
+    null);
+  }
+
+  public static void stackTrace()
+  {
+    try
+    {
+      throw new NullPointerException();
+    } catch (Exception e)
+    {
+      e.printStackTrace();
+    }
+
+  }
+
+
 }