Plartform update
[jalview.git] / src / jalview / util / Platform.java
index 8ebc67e..eec1e2a 100644 (file)
@@ -22,6 +22,8 @@ package jalview.util;
 
 import jalview.javascript.json.JSON;
 
+import java.awt.Component;
+import java.awt.Dimension;
 import java.awt.Toolkit;
 import java.awt.event.MouseEvent;
 import java.io.BufferedReader;
@@ -33,13 +35,24 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.net.URL;
+import java.util.Locale;
+import java.util.Map;
 import java.util.Properties;
+import java.util.logging.ConsoleHandler;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import javax.swing.SwingUtilities;
 
 import org.json.simple.parser.JSONParser;
 import org.json.simple.parser.ParseException;
 
+import com.stevesoft.pat.Regex;
+
+import swingjs.api.JSUtilI;
+
+////////THIS FILE IS NOW OUTDATED /////////////
+
 /**
  * System platform information used by Applet and Application
  * 
@@ -54,7 +67,21 @@ public class Platform
   private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null,
           isWin = null;
 
-  private static Boolean isHeadless = null;
+  private static swingjs.api.JSUtilI jsutil;
+
+  static {
+          if (isJS) {
+      try
+      {
+        jsutil = ((JSUtilI) Class.forName("swingjs.JSUtil").newInstance());
+      } catch (InstantiationException | IllegalAccessException
+              | ClassNotFoundException e)
+      {
+        e.printStackTrace();
+      }
+          }
+  }
+  // private static Boolean isHeadless = null;
 
   /**
    * added to group mouse events into Windows and nonWindows (mac, unix, linux)
@@ -111,18 +138,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;
+  // }
 
   /**
    * 
@@ -135,23 +162,17 @@ public class Platform
   }
 
   /**
-   * escape a string according to the local platform's escape character
+   * An earlier version of escapeString()? Looks fine to me -- BH
+   * 
+   * Answers the input with every backslash replaced with a double backslash (an
+   * 'escaped' single backslash)
    * 
-   * @param file
-   * @return escaped file
+   * @param s
+   * @return
    */
-  public static String escapeString(String file)
+  public static String escapeBackslashes(String s)
   {
-    StringBuffer f = new StringBuffer();
-    int p = 0, lastp = 0;
-    while ((p = file.indexOf('\\', lastp)) > -1)
-    {
-      f.append(file.subSequence(lastp, p));
-      f.append("\\\\");
-      lastp = p + 1;
-    }
-    f.append(file.substring(lastp));
-    return f.toString();
+    return s == null ? null : s.replace("\\", "\\\\");
   }
 
   /**
@@ -260,6 +281,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 +302,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 +311,7 @@ public class Platform
     case TIME_MARK:
       if (set > 0)
       {
+        // total time between set/mark points
         duration += (t - set);
       }
       else
@@ -297,7 +334,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,61 +342,38 @@ public class Platform
     }
   }
 
-  public static void cacheFileData(String path, byte[] data)
+  /**
+   * Dump the input stream to an output file.
+   * 
+   * @param is
+   * @param outFile
+   * @throws IOException
+   *           if the file cannot be created or there is a problem reading the
+   *           input stream.
+   */
+  public static void streamToFile(InputStream is, File outFile)
+          throws IOException
   {
-    if (!isJS())
+
+    if (isJS)
     {
+      jsutil.setFileBytes(outFile, is);
       return;
     }
-    /**
-     * @j2sNative
-     * 
-     *            swingjs.JSUtil.cacheFileData$S$O(path, data);
-     * 
-     */
-  }
-
-  public static byte[] getFileBytes(File f)
-  {
-    return /** @j2sNative f && f._bytes || */
-    null;
-  }
-
-  public static byte[] getFileAsBytes(String fileStr)
-  {
-    // BH 2018 hack for no support for access-origin
-    return /** @j2sNative swingjs.JSUtil.getFileAsBytes$O(fileStr) || */
-    null;
-  }
 
-  public static String getFileAsString(String data)
-  {
-    return /** @j2sNative swingjs.JSUtil.getFileAsString$S(data) || */
-    null;
-  }
-
-  public static boolean setFileBytes(File f, String urlstring)
-  {
-    if (!isJS())
+    FileOutputStream fio = new FileOutputStream(outFile);
+    try
     {
-      return false;
+      byte[] bb = new byte[32 * 1024];
+      int l;
+      while ((l = is.read(bb)) > 0)
+      {
+        fio.write(bb, 0, l);
+      }
+    } finally
+    {
+      fio.close();
     }
-    @SuppressWarnings("unused")
-    byte[] bytes = getFileAsBytes(urlstring);
-    /**
-     * @j2sNative f._bytes = bytes;
-     */
-    return true;
-  }
-
-  public static void addJ2SBinaryType(String ext)
-  {
-    /**
-     * @j2sNative
-     * 
-     *            J2S._binaryTypes.push("." + ext + "?");
-     * 
-     */
   }
 
   /**
@@ -382,10 +396,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())
+    if (!isJS)
     {
+      BrowserLauncher.openURL(url);
       return false;
     }
     /**
@@ -397,65 +412,10 @@ public class Platform
     return true;
   }
 
-  public static String getUniqueAppletID()
-  {
-    @SuppressWarnings("unused")
-    ThreadGroup g = Thread.currentThread().getThreadGroup();
-    /**
-     * @j2sNative return g.html5Applet._uniqueId;
-     *
-     */
-    return null;
-
-  }
-
-  /**
-   * Read the Info block for this applet.
-   * 
-   * @param prefix
-   *          "jalview_"
-   * @param p
-   * @return unique id for this applet
-   */
-  public static void readInfoProperties(String prefix, Properties p)
-  {
-    if (!isJS())
-    {
-      return;
-    }
-    @SuppressWarnings("unused")
-    ThreadGroup g = Thread.currentThread().getThreadGroup();
-    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];
-     */
-
-    System.out.println(
-            "Platform id=" + id + " reading Info." + key + " = " + value);
-    p.put(id + "_" + key, value);
-
-    /**
-     * @j2sNative
-     * 
-     * 
-     *            } }
-     */
-  }
-
-  public static void setAjaxJSON(URL url)
-  {
-    if (isJS())
-    {
-      JSON.setAjax(url);
-    }
-  }
-
   public static Object parseJSON(InputStream response)
           throws IOException, ParseException
   {
-    if (isJS())
+    if (isJS)
     {
       return JSON.parse(response);
     }
@@ -482,8 +442,7 @@ public class Platform
 
   public static Object parseJSON(String json) throws ParseException
   {
-    return (isJS() ? JSON.parse(json)
-            : new JSONParser().parse(json));
+    return (isJS ? JSON.parse(json) : new JSONParser().parse(json));
   }
 
   public static Object parseJSON(Reader r)
@@ -494,7 +453,7 @@ public class Platform
       return null;
     }
 
-    if (!isJS())
+    if (!isJS)
     {
       return new JSONParser().parse(r);
     }
@@ -510,39 +469,208 @@ public class Platform
   }
 
   /**
-   * Dump the input stream to an output file.
+   * Retrieve the object's embedded size from a div's style on a page if
+   * embedded in SwingJS.
    * 
-   * @param is
-   * @param outFile
-   * @throws IOException
-   *           if the file cannot be created or there is a problem reading the
-   *           input stream.
+   * @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 void streamToFile(InputStream is, File outFile)
-          throws IOException
+  public static Dimension getDimIfEmbedded(Component frame,
+          int defaultWidth, int defaultHeight)
   {
-    if (isJS() && /**
-                   * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
-                   */
-            true)
+    Dimension d = null;
+    if (isJS)
     {
-      return;
+      d = (Dimension) getEmbeddedAttribute(frame, "dim");
     }
-    FileOutputStream fio = new FileOutputStream(outFile);
-    try
+    return (d == null && defaultWidth >= 0
+            ? new Dimension(defaultWidth, defaultHeight)
+            : d);
+
+  }
+
+  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
+     */
     {
-      byte[] bb = new byte[32 * 1024];
-      int l;
-      while ((l = is.read(bb)) > 0)
+      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;)
       {
-        fio.write(bb, 0, l);
+        Logger logger = Logger.getLogger(classNames[i]);
+        logger.setLevel(Level.ALL);
+        logger.addHandler(consoleHandler);
       }
-    } finally
+    }
+  }
+
+  /// JavaScript-only methods ///
+
+  public static void cacheFileData(String path, Object data)
+  {
+    if (isJS && data != null)
     {
-      fio.close();
+      jsutil.cachePathData(path, data);
+    }
+  }
+
+  public static void cacheFileData(File file)
+  {
+    if (isJS)
+    {
+      byte[] data = Platform.getFileBytes(file);
+      {
+        if (data != null)
+        {
+          cacheFileData(file.toString(), data);
+        }
+      }
+    }
+  }
+
+  public static byte[] getFileBytes(File f)
+  {
+    return (isJS && f != null ? jsutil.getBytes(f) : null);
+  }
+
+  public static byte[] getFileAsBytes(String fileStr)
+  {
+    if (isJS && fileStr != null)
+    {
+      byte[] bytes = (byte[]) jsutil.getFile(fileStr, false);
+      cacheFileData(fileStr, bytes);
+      return bytes;
+    }
+    return null;
+  }
+
+  @SuppressWarnings("unused")
+  public static String getFileAsString(String url)
+  {
+    if (isJS && url != null)
+    {
+      String ret = (String) jsutil.getFile(url, true);
+      cacheFileData(url, ret);
+      return ret;
+    }
+    return null;
+  }
+
+  public static boolean setFileBytes(File f, String urlstring)
+  {
+    if (isJS && f != null && urlstring != null)
+    {
+      @SuppressWarnings("unused")
+      byte[] bytes = getFileAsBytes(urlstring);
+      jsutil.setFileBytes(f, bytes);
+      return true;
+    }
+    return false;
+  }
+
+  public static void addJ2SBinaryType(String ext)
+  {
+    if (isJS)
+    {
+      jsutil.addBinaryFileType(ext);
     }
   }
 
+  public static String getUniqueAppletID()
+  {
+    return (isJS ? (String) jsutil.getAppletAttribute("_uniqueId") : null);
+  }
+
+  /**
+   * Read the Info block for this applet.
+   * 
+   * @param prefix
+   *          "jalview_"
+   * @param p
+   * @return unique id for this applet
+   */
+  public static void readInfoProperties(String prefix, Properties p)
+  {
+    if (isJS)
+    {
+      String id = getUniqueAppletID();
+
+      String key = "";
+      String value = "";
+      @SuppressWarnings("unused")
+      Object info = getAppletInfo(null);
+      /**
+       * @j2sNative for (key in info) { value = info[key];
+       */
+
+      if (key.indexOf(prefix) == 0)
+      {
+        System.out.println("Platform id=" + id + " reading Info." + key
+                + " = " + value);
+        p.put(key, value);
+
+      }
+
+      /**
+       * @j2sNative }
+       */
+    }
+  }
+
+  public static void setAjaxJSON(URL url)
+  {
+    if (isJS)
+    {
+      JSON.setAjax(url);
+    }
+  }
+
+
   /**
    * Add a known domain that implements access-control-allow-origin:*
    * 
@@ -557,15 +685,15 @@ public class Platform
   public static void addJ2SDirectDatabaseCall(String domain)
   {
 
-    System.out.println(
-            "Platform adding no-access-control-allow-origin domain "
+    if (isJS)
+    {
+      jsutil.addDirectDatabaseCall(domain);
+
+      System.out.println(
+            "Platform adding known access-control-allow-origin * for domain "
                     + domain);
+    }
 
-    /**
-     * @j2sNative
-     * 
-     *            J2S.addDirectDatabaseCall(domain);
-     */
   }
 
   public static void getURLCommandArguments()
@@ -577,10 +705,131 @@ 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(" "));
      */
 
   }
 
+  /**
+   * A (case sensitive) file path comparator that ignores the difference between
+   * / and \
+   * 
+   * @param path1
+   * @param path2
+   * @return
+   */
+  public static boolean pathEquals(String path1, String path2)
+  {
+    if (path1 == null)
+    {
+      return path2 == null;
+    }
+    if (path2 == null)
+    {
+      return false;
+    }
+    String p1 = path1.replace('\\', '/');
+    String p2 = path2.replace('\\', '/');
+    return p1.equals(p2);
+  }
+
+  public static URL getDocumentBase()
+  {
+    return (isJS ? jsutil.getDocumentBase() : null);
+  }
+
+  public static URL getCodeBase()
+  {
+    return (isJS ? jsutil.getCodeBase() : 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(String resourcePath,
+          String className)
+  {
+    if (isJS)
+    {
+      jsutil.loadResourceIfClassUnknown(resourcePath, className);
+    }
+  }
+
+  public static void ensureRegex()
+  {
+    if (isJS)
+    {
+      loadStaticResource("core/core_stevesoft.z.js",
+              "com.stevesoft.pat.Regex");
+    }
+  }
+
+  /**
+   * 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)
+    {
+      jsutil.setAppletAttribute("app", j);
+    }
+  }
+
+  /**
+   *
+   * If this frame ia 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(Component frame, String type)
+  {
+    return (isJS ? jsutil.getEmbeddedAttribute(frame, type) : null);
+  }
+
+  public static void stackTrace()
+  {
+    try
+    {
+      throw new NullPointerException();
+    } catch (Exception e)
+    {
+      e.printStackTrace();
+    }
+
+  }
+
+  @SuppressWarnings("unchecked")
+  public static Object getAppletInfo(String key)
+  {
+    return (isJS ? (Map<String, Object>) jsutil.getAppletInfo(key) : null);
+  }
+
+  /**
+   * Option to avoid unnecessary seeking of nonexistent resources in JavaScript.
+   * Works in Java as well.
+   * 
+   * @param loc
+   * @return
+   */
+  public static Locale getLocaleOrNone(Locale loc)
+  {
+    return (isJS && loc.getCountry() == "en" ? new Locale("") : loc);
+  }
+
 }