X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2FPlatform.java;h=c06c75552776e4e8a12a67134d16650255656281;hb=58f14dfdbea524e0f28841a65f2fa64ddb4d8889;hp=f9eb2a6bd853fc6087f933c1dab7bac58b416025;hpb=6d9ff99acf35278e6dc1c85bbc65f8e419cd91b6;p=jalview.git

diff --git a/src/jalview/util/Platform.java b/src/jalview/util/Platform.java
index f9eb2a6..c06c755 100644
--- a/src/jalview/util/Platform.java
+++ b/src/jalview/util/Platform.java
@@ -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;
@@ -34,12 +36,19 @@ import java.io.InputStreamReader;
 import java.io.Reader;
 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.SwingUtilities;
 
 import org.json.simple.parser.JSONParser;
 import org.json.simple.parser.ParseException;
 
+import com.stevesoft.pat.Regex;
+
+import swingjs.api.JSUtilI;
+
 /**
  * System platform information used by Applet and Application
  * 
@@ -55,6 +64,22 @@ public class Platform
           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 +136,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,25 +160,17 @@ public class Platform
   }
 
   /**
-   * escape a string according to the local platform's escape character
+   * 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("\\", "\\\\");
   }
-
+  
   /**
    * Answers true if the mouse event has Meta-down (Command key on Mac) or
    * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
@@ -180,6 +197,20 @@ public class Platform
     if (!aMac)
     {
       return e.isControlDown();
+
+      // Jalview 2.11 code below: above is as amended for JalviewJS
+      // /*
+      // * answer false for right mouse button
+      // */
+      // if (e.isPopupTrigger())
+      // {
+      // return false;
+      // }
+      // return
+      // (jalview.util.ShortcutKeyMaskExWrapper.getMenuShortcutKeyMaskEx() //
+      // .getMenuShortcutKeyMaskEx()
+      // & jalview.util.ShortcutKeyMaskExWrapper
+      // .getModifiersEx(e)) != 0; // getModifiers()) != 0;
     }
     // answer false for right mouse button
     // shortcut key will be META for a Mac
@@ -260,6 +291,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 +312,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 +321,7 @@ public class Platform
     case TIME_MARK:
       if (set > 0)
       {
+        // total time between set/mark points
         duration += (t - set);
       }
       else
@@ -307,84 +354,75 @@ public class Platform
 
   public static void cacheFileData(String path, Object data)
   {
-    if (!isJS() || data == null)
+    if (isJS && data != null)
     {
-      return;
+      jsutil.cachePathData(path, data);
     }
-    /**
-     * @j2sNative
-     * 
-     *            swingjs.JSUtil.cacheFileData$S$O(path, data);
-     * 
-     */
   }
 
+
   public static void cacheFileData(File file)
   {
-    byte[] data;
-    if (!isJS() || (data = Platform.getFileBytes(file)) == null)
+    if (isJS)
     {
-      return;
+      byte[] data = Platform.getFileBytes(file);
+      {
+        if (data != null)
+        {
+          cacheFileData(file.toString(), data);
+        }
+      }
     }
-    cacheFileData(file.toString(), data);
   }
 
   public static byte[] getFileBytes(File f)
   {
-    return /** @j2sNative f && f._bytes || */
-    null;
+    return (isJS && f != null ? jsutil.getBytes(f) : null);
   }
 
   public static byte[] getFileAsBytes(String fileStr)
   {
-    byte[] bytes = null;
-    // BH 2018 hack for no support for access-origin
-    /**
-     * @j2sNative bytes = swingjs.JSUtil.getFileAsBytes$O(fileStr)
-     */
-    cacheFileData(fileStr, bytes);
-    return bytes;
+    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)
   {
-    String ret = null;
-    /**
-     * @j2sNative
-     * 
-     *            ret = swingjs.JSUtil.getFileAsString$S(url);
-     * 
-     * 
-     */
-    cacheFileData(url, ret);
-    return ret;
+    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())
+    if (isJS && f != null && urlstring != null)
     {
-      return false;
+      @SuppressWarnings("unused")
+      byte[] bytes = getFileAsBytes(urlstring);
+      jsutil.setFileBytes(f, bytes);
+      return true;
     }
-    @SuppressWarnings("unused")
-    byte[] bytes = getFileAsBytes(urlstring);
-    /**
-     * @j2sNative f._bytes = bytes;
-     */
-    return true;
+    return false;
   }
 
+
   public static void addJ2SBinaryType(String ext)
   {
-    /**
-     * @j2sNative
-     * 
-     *            J2S._binaryTypes.push("." + ext + "?");
-     * 
-     */
+    if (isJS)
+    {
+      jsutil.addBinaryFileType(ext);
+    }
   }
-
+  
   /**
    * Encode the URI using JavaScript encodeURIComponent
    * 
@@ -405,7 +443,7 @@ 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())
     {
@@ -422,16 +460,10 @@ public class Platform
 
   public static String getUniqueAppletID()
   {
-    @SuppressWarnings("unused")
-    ThreadGroup g = Thread.currentThread().getThreadGroup();
-    /**
-     * @j2sNative return g.html5Applet._uniqueId;
-     *
-     */
-    return null;
-
+    return (isJS ? (String) jsutil.getAppletAttribute("_uniqueId") : null);
   }
 
+
   /**
    * Read the Info block for this applet.
    * 
@@ -442,29 +474,30 @@ public class Platform
    */
   public static void readInfoProperties(String prefix, Properties p)
   {
-    if (!isJS())
+    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];
-     */
+      String id = getUniqueAppletID();
 
-    System.out.println(
-            "Platform id=" + id + " reading Info." + key + " = " + value);
-    p.put(id + "_" + key, value);
+      String key = "";
+      String value = "";
+      @SuppressWarnings("unused")
+      Object info = jsutil.getAppletAttribute("__Info");
+      /**
+       * @j2sNative for (key in info) { value = info[key];
+       */
 
-    /**
-     * @j2sNative
-     * 
-     * 
-     *            } }
-     */
+      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)
@@ -529,7 +562,6 @@ public class Platform
               "StringJS does not support FileReader parsing for JSON -- but it could...");
     }
     return JSON.parse(r);
-
   }
 
   /**
@@ -538,23 +570,22 @@ public class Platform
    * @param is
    * @param outFile
    * @throws IOException
-   *           if the file cannot be created or there is a problem reading the
-   *           input stream.
+   *                       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)
+    {
+      jsutil.setFileBytes(outFile, is);
+      return;
+    }
+
     FileOutputStream fio = new FileOutputStream(outFile);
     try
     {
-      if (isJS()
-              && /**
-                  * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
-                  */
-              true)
-      {
-        return;
-      }
       byte[] bb = new byte[32 * 1024];
       int l;
       while ((l = is.read(bb)) > 0)
@@ -581,16 +612,13 @@ public class Platform
   public static void addJ2SDirectDatabaseCall(String domain)
   {
 
-    if (isJS())
+    if (isJS)
     {
+      jsutil.addDirectDatabaseCall(domain);
+
       System.out.println(
             "Platform adding known access-control-allow-origin * for domain "
                     + domain);
-      /**
-       * @j2sNative
-       * 
-       *            J2S.addDirectDatabaseCall(domain);
-       */
     }
 
   }
@@ -611,4 +639,199 @@ public class Platform
 
   }
 
+  /**
+   * 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);
+  }
+
+
+
+///////////// JAL-3253 Applet additions //////////////
+  
+  
+  /**
+   * 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(Component frame,
+          int defaultWidth, int defaultHeight)
+  {
+    Dimension d = null;
+    if (isJS)
+    {
+      d = (Dimension) getEmbeddedAttribute(frame, "dim");
+    }
+    return (d == null && defaultWidth >= 0
+            ? new Dimension(defaultWidth, defaultHeight)
+            : d);
+
+  }
+
+  public static Regex newRegex(String regex)
+  {
+    return newRegex(regex, null);
+  }
+
+  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);
+      }
+    }
+  }
+
+
+  /**
+   * 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();
+    }
+
+  }
+
+  public static URL getDocumentBase()
+  {
+    return (isJS ? jsutil.getDocumentBase() : null);
+  }
+
+  public static URL getCodeBase()
+  {
+    return (isJS ? jsutil.getCodeBase() : null);
+  }
+
+
 }