X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2FPlatform.java;h=036ae17d32fcfe89033b74e1735701d3753bcfff;hb=50363b5d740fdf06f22db3812ebcfe32bd7908b8;hp=d80e3dec8177f5fab393888b44769667c8be54a8;hpb=eb630a0993bbc2372735c451b9c8fcbc451d11e7;p=jalview.git

diff --git a/src/jalview/util/Platform.java b/src/jalview/util/Platform.java
index d80e3de..036ae17 100644
--- a/src/jalview/util/Platform.java
+++ b/src/jalview/util/Platform.java
@@ -20,18 +20,43 @@
  */
 package jalview.util;
 
+import java.awt.Component;
+import java.awt.Dimension;
+import java.awt.GraphicsEnvironment;
 import java.awt.Toolkit;
+import java.awt.event.KeyEvent;
 import java.awt.event.MouseEvent;
+import java.io.BufferedReader;
 import java.io.File;
+import java.io.FileOutputStream;
+import java.io.FileReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.lang.reflect.Method;
+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 jalview.javascript.json.JSON;
+import swingjs.api.JSUtilI;
+
 /**
  * System platform information used by Applet and Application
  * 
  * @author Jim Procter
  */
+
 public class Platform
 {
 
@@ -43,6 +68,25 @@ public class Platform
 
   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)
    * 
@@ -55,6 +99,35 @@ public class Platform
             : isMac);
   }
 
+  public static int SHIFT_DOWN_MASK = KeyEvent.SHIFT_DOWN_MASK;
+
+  public static int ALT_DOWN_MASK = KeyEvent.ALT_DOWN_MASK;
+
+  public static int SHORTCUT_KEY_MASK = (Platform.isMac() ? KeyEvent.META_DOWN_MASK : KeyEvent.CTRL_DOWN_MASK);
+ 
+  static
+  {
+    if (!GraphicsEnvironment.isHeadless())
+    {
+      try
+      {
+
+        Class<? extends Toolkit> tk = Toolkit.getDefaultToolkit().getClass();
+        Method method = tk.getMethod("getMenuShortcutKeyMaskEx");
+        if (method == null)
+          method = tk.getMethod("getMenuShortcutKeyMask");
+        SHORTCUT_KEY_MASK = ((int) method.invoke(tk, new Object[0]));
+        if (SHORTCUT_KEY_MASK <= 0xF)
+        {
+          // shift this into the extended region (was Java 8)
+          SHORTCUT_KEY_MASK = SHORTCUT_KEY_MASK << 6;
+        }
+      } catch (Exception e)
+      {
+      }
+    }
+  }
+
   /**
    * added to group mouse events into Windows and nonWindows (mac, unix, linux)
    * 
@@ -99,7 +172,7 @@ public class Platform
   }
 
   /**
-   * 
+   *
    * @return true if we are running in non-interactive no UI mode
    */
   public static boolean isHeadless()
@@ -122,23 +195,15 @@ 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("\\", "\\\\");
   }
 
   /**
@@ -164,17 +229,14 @@ public class Platform
    */
   protected static boolean isControlDown(MouseEvent e, boolean aMac)
   {
-    if (!aMac)
-    {
-      return e.isControlDown();
+    
+    System.out.println(e.isPopupTrigger() 
+            + " " + ((SHORTCUT_KEY_MASK & e.getModifiersEx()) != 0) 
+            + " " + e.isControlDown());
+    return (aMac ? !e.isPopupTrigger()
+            && (SHORTCUT_KEY_MASK & e.getModifiersEx()) != 0
+            : e.isControlDown());
     }
-    // answer false for right mouse button
-    // shortcut key will be META for a Mac
-    return !e.isPopupTrigger()
-            && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()
-                    & e.getModifiers()) != 0;
-    // could we use e.isMetaDown() here?
-  }
 
   // BH: I don't know about that previous method. Here is what SwingJS uses.
   // Notice the distinction in mouse events. (BUTTON3_MASK == META)
@@ -247,6 +309,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();
@@ -254,6 +330,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);
@@ -262,6 +339,7 @@ public class Platform
     case TIME_MARK:
       if (set > 0)
       {
+        // total time between set/mark points
         duration += (t - set);
       }
       else
@@ -292,61 +370,73 @@ 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;
+      jsutil.cachePathData(path, data);
+    }
+  }
+
+  public static void cacheFileData(File file)
+  {
+    if (isJS)
+    {
+      byte[] data = Platform.getFileBytes(file);
+      {
+        if (data != null)
+        {
+          cacheFileData(file.toString(), data);
+        }
+      }
     }
-    /**
-     * @j2sNative
-     * 
-     *            swingjs.JSUtil.cacheFileData$S$O(path, 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)
   {
-    // BH 2018 hack for no support for access-origin
-    return /** @j2sNative swingjs.JSUtil.getFileAsBytes$O(fileStr) || */
-    null;
+    if (isJS && fileStr != null)
+    {
+      byte[] bytes = (byte[]) jsutil.getFile(fileStr, false);
+      cacheFileData(fileStr, bytes);
+      return bytes;
+    }
+    return null;
   }
 
-  public static String getFileAsString(String data)
+  public static String getFileAsString(String url)
   {
-    return /** @j2sNative swingjs.JSUtil.getFileAsString$S(data) || */
-    null;
+    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);
+    }
   }
 
   /**
@@ -369,7 +459,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())
     {
@@ -386,14 +476,7 @@ 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);
   }
 
   /**
@@ -406,25 +489,358 @@ public class Platform
    */
   public static void readInfoProperties(String prefix, Properties p)
   {
-    @SuppressWarnings("unused")
-    ThreadGroup g = Thread.currentThread().getThreadGroup();
-    String id = getUniqueAppletID();
-    String key = "", value = "";
+    if (isJS)
+    {
+      String id = getUniqueAppletID();
+
+      String key = "";
+      String value = "";
+      @SuppressWarnings("unused")
+      Object info = jsutil.getAppletAttribute("__Info");
+      /**
+       * @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);
+    }
+  }
+
+  public static Object parseJSON(InputStream response)
+          throws IOException, ParseException
+  {
+    if (isJS())
+    {
+      return JSON.parse(response);
+    }
+
+    BufferedReader br = null;
+    try
+    {
+      br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
+      return new JSONParser().parse(br);
+    } finally
+    {
+      if (br != null)
+      {
+        try
+        {
+          br.close();
+        } catch (IOException e)
+        {
+          // ignore
+        }
+      }
+    }
+  }
+
+  public static Object parseJSON(String json) throws ParseException
+  {
+    return (isJS() ? JSON.parse(json) : new JSONParser().parse(json));
+  }
+
+  public static Object parseJSON(Reader r)
+          throws IOException, ParseException
+  {
+    if (r == null)
+    {
+      return null;
+    }
+
+    if (!isJS())
+    {
+      return new JSONParser().parse(r);
+    }
+    // Using a file reader is not currently supported in SwingJS JavaScript
+
+    if (r instanceof FileReader)
+    {
+      throw new IOException(
+              "StringJS does not support FileReader parsing for JSON -- but it could...");
+    }
+    return JSON.parse(r);
+  }
+
+  /**
+   * 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)
+    {
+      jsutil.setFileBytes(outFile, is);
+      return;
+    }
+
+    FileOutputStream fio = new FileOutputStream(outFile);
+    try
+    {
+      byte[] bb = new byte[32 * 1024];
+      int l;
+      while ((l = is.read(bb)) > 0)
+      {
+        fio.write(bb, 0, l);
+      }
+    } finally
+    {
+      fio.close();
+    }
+  }
+
+  /**
+   * Add a known domain that implements access-control-allow-origin:*
+   * 
+   * These should be reviewed periodically.
+   * 
+   * @param domain
+   *          for a service that is not allowing ajax
+   * 
+   * @author hansonr@stolaf.edu
+   * 
+   */
+  public static void addJ2SDirectDatabaseCall(String domain)
+  {
+
+    if (isJS)
+    {
+      jsutil.addDirectDatabaseCall(domain);
+
+      System.out.println(
+              "Platform adding known access-control-allow-origin * for domain "
+                      + domain);
+    }
+
+  }
+
+  public static void getURLCommandArguments()
+  {
+
     /**
-     * @j2sNative var info = g.html5Applet.__Info || {}; for (var key in info) {
-     *            if (key.indexOf(prefix) == 0) { value = "" + info[key];
+     * Retrieve the first query field as command arguments to Jalview. Include
+     * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's __Info.args
+     * 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(" "));
      */
 
-    System.out.println(
-            "Platform id=" + id + " reading Info." + key + " = " + value);
-    p.put(id + "_" + key, value);
+  }
+
+  /**
+   * 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()
+  {
     /**
-     * @j2sNative
+     * @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);
   }
 
 }