JAL-3210 Barebones gradle/buildship/eclipse. See README
[jalview.git] / src / jalview / util / Platform.java
index fba669b..bf0dfcd 100644 (file)
@@ -22,7 +22,6 @@ package jalview.util;
 
 import jalview.javascript.json.JSON;
 
-import java.awt.Color;
 import java.awt.Toolkit;
 import java.awt.event.MouseEvent;
 import java.io.BufferedReader;
@@ -33,20 +32,14 @@ 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.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
  * 
@@ -61,7 +54,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)
@@ -118,18 +111,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;
+  }
 
   /**
    * 
@@ -142,23 +135,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("\\", "\\\\");
   }
 
   /**
@@ -184,17 +169,20 @@ public class Platform
    */
   protected static boolean isControlDown(MouseEvent e, boolean aMac)
   {
-    if (!aMac)
-    {
-      return 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?
-  }
+           if (aMac)
+           {
+             /*
+              * answer false for right mouse button
+              */
+             if (e.isPopupTrigger())
+             {
+               return false;
+             }
+             return (jalview.util.ShortcutKeyMaskExWrapper.getMenuShortcutKeyMaskEx() // .getMenuShortcutKeyMaskEx()
+                     & e.getModifiersEx()) != 0; // getModifiers()) != 0;
+           }
+           return e.isControlDown();
+         }
 
   // BH: I don't know about that previous method. Here is what SwingJS uses.
   // Notice the distinction in mouse events. (BUTTON3_MASK == META)
@@ -267,20 +255,6 @@ 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();
@@ -288,7 +262,6 @@ public class Platform
     {
     case TIME_RESET:
       time = mark = t;
-      duration = 0;
       if (msg != null)
       {
         System.err.println("Platform: timer reset\t\t\t" + msg);
@@ -297,7 +270,6 @@ public class Platform
     case TIME_MARK:
       if (set > 0)
       {
-        // total time between set/mark points
         duration += (t - set);
       }
       else
@@ -320,7 +292,7 @@ public class Platform
     case TIME_GET:
       if (msg != null)
       {
-        System.err.println("Platform: timer get\t" + ((t - time) / 1000f)
+        System.err.println("Platform: timer dur\t" + ((t - time) / 1000f)
                 + "\t" + ((duration) / 1000f) + "\t" + msg);
       }
       set = 0;
@@ -354,9 +326,7 @@ public class Platform
 
   public static byte[] getFileBytes(File f)
   {
-    // TODO temporary doubling of 秘bytes and _bytes;
-    // just remove _bytes when new transpiler has been installed
-    return /** @j2sNative f && (f.秘bytes || f._bytes) || */
+    return /** @j2sNative f && f._bytes || */
     null;
   }
 
@@ -394,10 +364,8 @@ 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 = f._bytes = bytes;
+     * @j2sNative f._bytes = bytes;
      */
     return true;
   }
@@ -432,11 +400,10 @@ public class Platform
    * @param url
    * @return true if window has been opened
    */
-  public static boolean openURL(String url) throws IOException
+  public static boolean openURL(String url)
   {
     if (!isJS())
     {
-      BrowserLauncher.openURL(url);
       return false;
     }
     /**
@@ -453,7 +420,7 @@ public class Platform
     @SuppressWarnings("unused")
     ThreadGroup g = Thread.currentThread().getThreadGroup();
     /**
-     * @j2sNative return g.秘html5Applet._uniqueId;
+     * @j2sNative return g.html5Applet._uniqueId;
      *
      */
     return null;
@@ -479,13 +446,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(key, value);
+    p.put(id + "_" + key, value);
 
     /**
      * @j2sNative
@@ -639,234 +606,26 @@ public class Platform
 
   }
 
-  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.
+   * A (case sensitive) file path comparator that ignores the difference between /
+   * and \
    * 
-   * @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 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);
-  }
-
-  /**
-   * @param c
-   */
-  public static Color getColorFromName(String name)
-  {
-    if (name == null)
-    {
-      return null;
-    }
-    /**
-     * @j2sNative
-     * 
-     *            return swingjs.JSUtil.getColorFromName$S(name);
-     */
-    {
-      // or make a static map; or use reflection on the field name
-      switch (name.toLowerCase())
-      {
-      case "black":
-        return Color.black;
-      case "blue":
-        return Color.blue;
-      case "cyan":
-        return Color.cyan;
-      case "darkgray":
-        return Color.darkGray;
-      case "gray":
-        return Color.gray;
-      case "green":
-        return Color.green;
-      case "lightgray":
-        return Color.lightGray;
-      case "magenta":
-        return Color.magenta;
-      case "orange":
-        return Color.orange;
-      case "pink":
-        return Color.pink;
-      case "red":
-        return Color.red;
-      case "white":
-        return Color.white;
-      case "yellow":
-        return Color.yellow;
-      default:
-        return null;
-      }
-
-    }
-  }
-
-  /**
-   * 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){}
-     */
-  }
-
-  public final static String EMBEDDED_DIM = "dim";
-
-  /**
-   *
-   * 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.
+   * @param path1
+   * @param path2
+   * @return
    */
-  public static Object getEmbeddedAttribute(Object frame, String type)
+  public static boolean pathEquals(String path1, String path2)
   {
-    if (!isJS())
+    if (path1 == null)
     {
-      return null;
+      return path2 == null;
     }
-    return (/** swingjs@j2sNative || frame.ui.getEmbedded(type) */
-    null);
-  }
-
-  public static void stackTrace()
-  {
-    try
+    if (path2 == null)
     {
-      throw new NullPointerException();
-    } catch (Exception e)
-    {
-      e.printStackTrace();
+      return false;
     }
-
+    String p1 = path1.replace('\\', '/');
+    String p2 = path2.replace('\\', '/');
+    return p1.equals(p2);
   }
-
 }