From: BobHanson Date: Fri, 20 Mar 2020 05:16:36 +0000 (-0500) Subject: JAL-3560 rewritten Platform with JSUtilI interface X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=9d9e8df3fa57b530dd4550ee1cc5863d905638db;p=jalview.git JAL-3560 rewritten Platform with JSUtilI interface --- diff --git a/src/jalview/bin/ApplicationSingletonProvider.java b/src/jalview/bin/ApplicationSingletonProvider.java index b64f40c..1b90259 100644 --- a/src/jalview/bin/ApplicationSingletonProvider.java +++ b/src/jalview/bin/ApplicationSingletonProvider.java @@ -80,21 +80,13 @@ public class ApplicationSingletonProvider * * @return */ + @SuppressWarnings("unchecked") private static Map, ApplicationSingletonI> getContextMap() { - @SuppressWarnings("unused") - ThreadGroup g = (Platform.isJS() - ? Thread.currentThread().getThreadGroup() - : null); - Map, ApplicationSingletonI> map = singletons; - /** @j2sNative map = g._swingjsSingletons; */ - if (map == null) - { - map = new HashMap<>(); - /** @j2sNative g._swingjsSingletons = map; */ - } - - return map; + return (Platform.isJS() + ? (Map, ApplicationSingletonI>) Platform + .getJSSingletons() + : singletons); } /** diff --git a/src/jalview/util/Platform.java b/src/jalview/util/Platform.java index d9241b8..3bce7f0 100644 --- a/src/jalview/util/Platform.java +++ b/src/jalview/util/Platform.java @@ -22,6 +22,7 @@ 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; @@ -33,14 +34,13 @@ 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.HashMap; import java.util.Properties; import java.util.logging.ConsoleHandler; import java.util.logging.Level; import java.util.logging.Logger; -import javax.swing.JComponent; import javax.swing.SwingUtilities; import org.json.simple.parser.JSONParser; @@ -48,6 +48,8 @@ import org.json.simple.parser.ParseException; import com.stevesoft.pat.Regex; +import swingjs.api.JSUtilI; + /** * System platform information used by Applet and Application * @@ -59,6 +61,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; @@ -329,61 +338,95 @@ public class Platform } } - public static void cacheFileData(String path, Object data) + /** + * Encode the URI using JavaScript encodeURIComponent + * + * @param value + * @return encoded value + */ + public static String encodeURI(String value) + { + /** + * @j2sNative value = encodeURIComponent(value); + */ + return value; + } + + /** + * Open the URL using a simple window call if this is JavaScript + * + * @param url + * @return true if window has been opened + */ + public static boolean openURL(String url) throws IOException { - if (!isJS() || data == null) + if (!isJS()) { - return; + BrowserLauncher.openURL(url); + return false; } /** * @j2sNative * - * swingjs.JSUtil.cacheFileData$S$O(path, data); * + * window.open(url); */ + return true; + } + + public static void stackTrace() + { + new NullPointerException("testing only").printStackTrace(); + } + + public static void cacheFileData(String path, Object data) + { + if (isJS()) + { + jsutil.cachePathData(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) { - // TODO temporary doubling of 秘bytes and _bytes; - // just remove _bytes when new transpiler has been installed - return /** @j2sNative f && (f.秘bytes || 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); + 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; } @@ -393,72 +436,22 @@ 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.秘bytes = f._bytes = bytes; - */ - return true; - } - - public static void addJ2SBinaryType(String ext) - { - /** - * @j2sNative - * - * J2S._binaryTypes.push("." + ext + "?"); - * - */ - } - - /** - * Encode the URI using JavaScript encodeURIComponent - * - * @param value - * @return encoded value - */ - public static String encodeURI(String value) - { - /** - * @j2sNative value = encodeURIComponent(value); - */ - return value; - } - - /** - * Open the URL using a simple window call if this is JavaScript - * - * @param url - * @return true if window has been opened - */ - public static boolean openURL(String url) throws IOException - { - if (!isJS()) + boolean ok = false; + try { - BrowserLauncher.openURL(url); - return false; + jsutil.setFileBytes(f, bytes); + } catch (Throwable t) + { + System.out.println("Platform.setFileBytes failed: " + t); } - /** - * @j2sNative - * - * - * window.open(url); - */ - return true; + return ok; } - public static String getUniqueAppletID() + public static void addJ2SBinaryType(String ext) { - @SuppressWarnings("unused") - ThreadGroup g = Thread.currentThread().getThreadGroup(); - /** - * @j2sNative return g.秘html5Applet._uniqueId; - * - */ - return null; + jsutil.addBinaryFileType(ext); } /** @@ -471,29 +464,10 @@ public class Platform */ public static void readInfoProperties(String prefix, Properties p) { - if (!isJS()) + if (isJS()) { - return; + jsutil.readInfoProperties(prefix, p); } - @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(key, value); - - /** - * @j2sNative - * - * - * } } - */ } public static void setAjaxJSON(URL url) @@ -573,12 +547,7 @@ public class Platform public static void streamToFile(InputStream is, File outFile) throws IOException { - if (isJS() && /** - * JSTempFile direct transfer - * - * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) && - */ - true) + if (isJS() && jsutil.streamToFile(is, outFile)) { return; } @@ -613,101 +582,57 @@ 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); + } } 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; + return (isJS() ? jsutil.getDocumentBase() : 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. - * - * @param resourcePath - * @param className - */ - public static void loadStaticResource(Object resourcePath, - String className) - { - /** - * - * @j2sNative if (!swingjs.JSUtil.isClassLoaded$S(className)) - * swingjs.JSUtil.loadStaticResource$S(resourcePath); - */ + return (isJS() ? jsutil.getCodeBase() : null); } public static void ensureJmol() { - loadStaticResource("core/core_jvjmol.z.js", "org.jmol.viewer.Viewer"); + jsutil.loadResourceIfClassUnknown("core/core_jvjmol.z.js", + "org.jmol.viewer.Viewer"); } public static void ensureRegex() { - loadStaticResource("core/core_stevesoft.z.js", + jsutil.loadResourceIfClassUnknown("core/core_stevesoft.z.js", "com.stevesoft.pat.Regex"); } @@ -773,23 +698,14 @@ public class Platform * that page developers use that is similar to the original Java applet object * that was accessed via LiveConnect. * - * @param j + * @param app */ - public static void setAppClass(Object j) + public static void setAppClass(Object app) { - if (!isJS()) + if (isJS()) { - return; + jsutil.setAppletAttribute("app", app); } - @SuppressWarnings("unused") - Thread t = Thread.currentThread(); - /** - * Set up "testApplet.app" to be this instance - * - * @j2sNative - * - * try {self[t.name].app = j}catch(e){} - */ } /** @@ -803,11 +719,10 @@ public class Platform * @param defaultHeight * @return the embedded dimensions or null (no default size or not embedded) */ - public static Dimension getDimIfEmbedded(JComponent frame, + public static Dimension getDimIfEmbedded(Component frame, int defaultWidth, int defaultHeight) { - Dimension d = /** @j2sNative frame.ui.getEmbedded$S("dim") || */ - null; + Dimension d = (Dimension) getEmbeddedAttribute(frame, "dim"); return (d == null && defaultWidth >= 0 ? new Dimension(defaultWidth, defaultHeight) : d); @@ -822,27 +737,19 @@ public class Platform * @param type * @return null if frame is not embedded. */ - public static Object getEmbeddedAttribute(Object frame, String type) + public static Object getEmbeddedAttribute(Component frame, String type) { - if (!isJS()) - { - return null; - } - return (/** @j2sNative frame.ui.getEmbedded$S(type) || */ - null); + return (isJS() ? jsutil.getEmbeddedAttribute(frame, type) : null); } - public static void stackTrace() + /** + * Only called for JavaScript. + * + * @return Map for static singleton classes unique to a given applet + */ + public static HashMap getJSSingletons() { - try - { - throw new NullPointerException(); - } catch (Exception e) - { - e.printStackTrace(); - } - + return (isJS() ? jsutil.getJSContext("jssingletons") : null); } - } diff --git a/src/swingjs/api/JSUtilI.java b/src/swingjs/api/JSUtilI.java new file mode 100644 index 0000000..ddf4141 --- /dev/null +++ b/src/swingjs/api/JSUtilI.java @@ -0,0 +1,177 @@ +package swingjs.api; + +import java.awt.Component; +import java.io.File; +import java.io.InputStream; +import java.net.URL; +import java.util.HashMap; +import java.util.Properties; + +import swingjs.api.js.HTML5Applet; + +public interface JSUtilI { + + /** + * Indicate to SwingJS that the given file type is binary. + * + * @param ext + */ + void addBinaryFileType(String ext); + + /** + * Indicate to SwingJS that we can load files using AJAX from the given + * domain, such as "www.stolaf.edu", because we know that CORS access has been + * provided. + * + * @param domain + */ + void addDirectDatabaseCall(String domain); + + /** + * Cache or uncache data under the given path name. + * + * @param path + * @param data + * null to remove from the cache + */ + void cachePathData(String path, Object data); + + /** + * Get the HTML5 object corresponding to the specified Component, or the + * current thread if null. + * + * @param c + * the associated component, or null for the current thread + * @return HTML5 applet object + */ + HTML5Applet getAppletForComponent(Component c); + + /** + * Get an attribute applet.foo for the applet found using getApplet(null). + * + * @param key + * @return + */ + Object getAppletAttribute(String key); + + /** + * Get the code base (swingjs/j2s, probably) for the applet found using + * getApplet(null). + * + * @return + */ + URL getCodeBase(); + + /** + * Get the document base (wherever the page is) for the applet found using + * getApplet(null). + * + * @return + */ + + URL getDocumentBase(); + + /** + * Get an attribute from the div on the page that is associated with this + * frame, i.e. with id frame.getName() + "-div". + * + * @param frame + * @param type + * "node" or "dim" + * @return + */ + Object getEmbeddedAttribute(Component frame, String type); + + /** + * Get a file synchronously. + * + * @param path + * @param asString + * true for String; false for byte[] + * @return byte[] or String + */ + Object getFile(String path, boolean asString); + + /** + * Get the 秘bytes field associated with a file, but only if the File object + * itself has them attached, not downloading them. + * + * @param f + * @return + */ + byte[] getBytes(File f); + + /** + * Retrieve a HashMap consisting of whatever the application wants, but + * guaranteed to be unique to this app context, that is, for the applet found + * using getApplet(null). + * + * @param contextKey + * @return + */ + HashMap getJSContext(Object contextKey); + + /** + * 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 + */ + void loadResourceIfClassUnknown(String resource, String className); + + /** + * Read all applet.__Info properties for the applet found using + * getApplet(null) that start with the given prefix, such as "jalview_". A + * null prefix retrieves all properties. Note that non-string properties will + * be stringified. + * + * @param prefix + * an application prefix, or null for all properties + * @param p + * properties to be appended to + */ + void readInfoProperties(String prefix, Properties p); + + /** + * Set an attribute for the applet found using getApplet(null). That is, + * applet[key] = val. + * + * @param key + * @param val + */ + void setAppletAttribute(String key, Object val); + + /** + * Set an attribute of applet's Info map for the applet found using + * getApplet(null). That is, applet.__Info[key] = val. + * + * @param infoKey + * @param val + */ + void setAppletInfo(String infoKey, Object val); + + /** + * Set the given File object's 秘bytes field from an InputStream or a byte[] + * array. If the file is a JSTempFile, then also cache those bytes. + * + * @param f + * @param isOrBytes + * BufferedInputStream, ByteArrayInputStream, FileInputStream, or + * byte[] + * @return + */ + boolean setFileBytes(File f, Object isOrBytes); + + /** + * Same as setFileBytes, but also caches the data if it is a JSTempFile. + * + * @param is + * @param outFile + * @return + */ + boolean streamToFile(InputStream is, File outFile); + +} diff --git a/src/swingjs/api/js/HTML5Applet.java b/src/swingjs/api/js/HTML5Applet.java new file mode 100644 index 0000000..b844476 --- /dev/null +++ b/src/swingjs/api/js/HTML5Applet.java @@ -0,0 +1,35 @@ +package swingjs.api.js; + +public interface HTML5Applet { + + /** + * The canvas that is being used by the HTML5 applet + * + * @return + */ + Object _getHtml5Canvas(); + + int _getHeight(); + + int _getWidth(); + + /** + * The div associated with the HTML5 applet + * + * @return + */ + Object _getContentLayer(); + + /** + * Simple resizing for an inline applet + * + * @param widthHeight + */ + void _resizeApplet(int[] widthHeight); + + void _show(boolean b); + + String _getID(); + + +}