From 1ec541a4c7c5ed92b13cd2c00d86724308f57881 Mon Sep 17 00:00:00 2001 From: BobHanson Date: Wed, 8 Apr 2020 10:08:58 -0500 Subject: [PATCH] JAL-3253 Platform reconciled with applet --- src/jalview/util/Platform.java | 446 +++++++++++++++++++++++++++++----------- 1 file changed, 328 insertions(+), 118 deletions(-) diff --git a/src/jalview/util/Platform.java b/src/jalview/util/Platform.java index d6627c4..99c82a4 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; @@ -40,6 +42,16 @@ import javax.swing.SwingUtilities; import org.json.simple.parser.JSONParser; import org.json.simple.parser.ParseException; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Set; +import java.util.logging.ConsoleHandler; +import java.util.logging.Level; +import java.util.logging.Logger; +import com.stevesoft.pat.Regex; + +import swingjs.api.JSUtilI; + /** * System platform information used by Applet and Application * @@ -51,6 +63,13 @@ public class Platform private static boolean isJS = /** @j2sNative true || */ false; + private static JSUtilI jsutil = /** + * @j2sNative new Clazz.new_("swingjs.JSUtil") + * || + */ + null; + + private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null, isWin = null; @@ -111,18 +130,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; - } + public static boolean isHeadless() + { + if (isHeadless == null) + { + isHeadless = "true".equals(System.getProperty("java.awt.headless")); + } + return isHeadless; + } /** * @@ -172,20 +191,6 @@ 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 @@ -266,6 +271,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(); @@ -273,6 +292,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); @@ -281,6 +301,7 @@ public class Platform case TIME_MARK: if (set > 0) { + // total time between set/mark points duration += (t - set); } else @@ -303,67 +324,64 @@ 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; break; } } - + + ////// jsutil additions, simplifications + public static void cacheFileData(String path, Object data) { - if (!isJS() || data == null) + if (isJS()) { - 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[] bytes = getFileBytes(file); + if (bytes != null) + { + cacheFileData(file.toString(), bytes); + } } - cacheFileData(file.toString(), data); } public static byte[] getFileBytes(File f) { - return /** @j2sNative f && swingjs.JSUtil.getFileBytes$java_io_File(f) || */ - 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); + byte[] bytes = (isJS() && fileStr != null + ? (byte[]) jsutil.getFile(fileStr, false) + : null); + if (bytes != null) + { + cacheFileData(fileStr, bytes); + } return bytes; } - @SuppressWarnings("unused") public static String getFileAsString(String url) { String ret = null; - /** - * @j2sNative - * - * ret = swingjs.JSUtil.getFileAsString$S(url); - * - * - */ - cacheFileData(url, ret); + if (isJS()) + { + ret = (String) jsutil.getFile(url, true); + if (ret != null) + { + cacheFileData(url, ret); + } + } return ret; } @@ -373,24 +391,24 @@ public class Platform { return false; } - @SuppressWarnings("unused") byte[] bytes = getFileAsBytes(urlstring); - // TODO temporary doubling of 秘bytes and _bytes; - // just remove _bytes when new transpiler has been installed - /** - * @j2sNative f.\u79d8bytes = f._bytes = bytes; - */ - return true; + boolean ok = false; + try + { + jsutil.setFileBytes(f, bytes); + } catch (Throwable t) + { + System.out.println("Platform.setFileBytes failed: " + t); + } + return ok; } public static void addJ2SBinaryType(String ext) { - /** - * @j2sNative - * - * J2S._binaryTypes.push("." + ext + "?"); - * - */ + if (isJS()) + { + jsutil.addBinaryFileType(ext); + } } /** @@ -413,10 +431,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; } /** @@ -430,12 +449,9 @@ public class Platform public static String getUniqueAppletID() { - /** - * @j2sNative return swingjs.JSUtil.getApplet$()._uniqueId; - * - */ - return null; - + // Caution -- null here means using current thread instead of a known component. + + return jsutil.getAppletForComponent(null)._getID(); } /** @@ -448,28 +464,10 @@ public class Platform */ public static void readInfoProperties(String prefix, Properties p) { - if (!isJS()) + if (isJS()) { - return; + jsutil.readInfoProperties(prefix, p); } - String id = getUniqueAppletID(); - String key = "", value = ""; - /** - * @j2sNative var info = swingjs.JSUtil.getApplet$().__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) @@ -543,16 +541,13 @@ 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() && /** - * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) && - */ - true) + if (isJS() && jsutil.streamToFile(is, outFile)) { return; } @@ -587,38 +582,43 @@ public class Platform if (isJS()) { - System.out.println( - "Platform adding known access-control-allow-origin * for domain " - + domain); - /** - * @j2sNative - * - * J2S.addDirectDatabaseCall(domain); - */ + jsutil.addDirectDatabaseCall(domain); } - } + /** + * 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. + */ + + @SuppressWarnings("unused") public static void getURLCommandArguments() { - + if (!isJS()) + { + return; + } + String[] args = null; /** - * 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 = + * @j2sNative args = * decodeURI((document.location.href.replace("&","?").split("?j2s")[0] - * + "?").split("?")[1].split("#")[0]); a && - * (J2S.thisApplet.__Info.args = a.split(" ")); + * + "?").split("?")[1].split("#")[0]); args && (args = + * args.split(" ")); */ + if (args != null) + { + jsutil.setAppletInfo("args", args); + } } + /** * A (case sensitive) file path comparator that ignores the difference between / * and \ * + * * @param path1 * @param path2 * @return @@ -637,4 +637,214 @@ public class Platform String p2 = path2.replace('\\', '/'); return p1.equals(p2); } + + ///// new methods from applet branch only + + + public static URL getDocumentBase() + { + return (isJS() ? jsutil.getDocumentBase() : null); + } + + public static URL getCodeBase() + { + return (isJS() ? jsutil.getCodeBase() : null); + } + + public static void ensureJmol() + { + if (isJS()) + { + jsutil.loadResourceIfClassUnknown("core/core_jvjmol.z.js", + "org.jmol.viewer.Viewer"); + } + } + + public static void ensureRegex() + { + if (isJS()) + { + jsutil.loadResourceIfClassUnknown("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 app + */ + public static void setAppClass(Object app) + { + if (isJS()) + { + jsutil.setAppletAttribute("app", app); + } + } + + /** + * 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 = (Dimension) getEmbeddedAttribute(frame, "dim"); + 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(Component frame, String type) + { + return (isJS() ? jsutil.getEmbeddedAttribute(frame, type) : null); + } + + /** + * Only called for JavaScript. + * + * @return Map for static singleton classes unique to a given applet + */ + public static HashMap getJSSingletons() + { + return (isJS() ? jsutil.getJSContext("jssingletons") : null); + } + + /** + * By designating initialCapacity and loadFactor, we tell SwingJS to use a + * standard (slower) Java HashMap to back this HashSet, thus providing exactly + * the same iterator order (until a new Java version changes it!) + * + * @return a standard Java HashSet + */ + public static Set getJavaOrderedHashSet() + { + return new HashSet<>(16, 0.75f); + } + + /** + * Switch the flag in SwingJS to use or not use the JavaScript Map object in + * any Hashtable, HashMap, or HashSet. Default is enabled. + * + * For testing purposes only. + * + */ + public static boolean setJavaScriptMapObjectEnabled(boolean enabled) + { + if (!isJS()) + { + return false; + } + jsutil.setJavaScriptMapObjectEnabled(enabled); + HashSet hs = new HashSet<>(); + // Java hash table iterator in HashMap will return "one" before "two" + // because of its hash code; + // JavaScript Map object will return "two" first because it was added first. + hs.add("two"); + hs.add("one"); + return (hs.iterator().next() == (enabled ? "two" : "one")); + } + + + public static void stackTrace() + { + new NullPointerException("testing only").printStackTrace(); + } + + + /** + * escape a string according to the local platform's escape character + * + * @param file + * @return escaped file + */ + public static String escapeString(String file) + { + 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(); + } + } -- 1.7.10.2