2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import jalview.javascript.json.JSON;
25 import java.awt.Toolkit;
26 import java.awt.event.MouseEvent;
27 import java.io.BufferedReader;
29 import java.io.FileOutputStream;
30 import java.io.FileReader;
31 import java.io.IOException;
32 import java.io.InputStream;
33 import java.io.InputStreamReader;
34 import java.io.Reader;
36 import java.util.Properties;
38 import javax.swing.SwingUtilities;
40 import org.json.simple.parser.JSONParser;
41 import org.json.simple.parser.ParseException;
44 * System platform information used by Applet and Application
51 private static boolean isJS = /** @j2sNative true || */
54 private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null,
55 isWin = null, isLinux = null;
57 private static Boolean isHeadless = null;
60 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
64 public static boolean isMac()
67 ? (isMac = (System.getProperty("os.name").indexOf("Mac") >= 0))
72 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
76 public static boolean isWin()
79 ? (isWin = (System.getProperty("os.name").indexOf("Win") >= 0))
84 * added to check LaF for Linux
88 public static boolean isLinux()
90 return (isLinux == null
91 ? (isLinux = (System.getProperty("os.name")
92 .indexOf("Linux") >= 0))
98 * @return true if HTML5 JavaScript
100 public static boolean isJS()
106 * sorry folks - Macs really are different
108 * BH: disabled for SwingJS -- will need to check key-press issues
110 * @return true if we do things in a special way.
112 public static boolean isAMacAndNotJS()
114 return (isNoJSMac == null ? (isNoJSMac = !isJS && isMac()) : isNoJSMac);
118 * Check if we are on a Microsoft plaform...
120 * @return true if we have to cope with another platform variation
122 public static boolean isWindowsAndNotJS()
124 return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin);
129 * @return true if we are running in non-interactive no UI mode
131 public static boolean isHeadless()
133 if (isHeadless == null)
135 isHeadless = "true".equals(System.getProperty("java.awt.headless"));
142 * @return nominal maximum command line length for this platform
144 public static int getMaxCommandLineLength()
146 // TODO: determine nominal limits for most platforms.
147 return 2046; // this is the max length for a windows NT system.
151 * Answers the input with every backslash replaced with a double backslash (an
152 * 'escaped' single backslash)
157 public static String escapeBackslashes(String s)
159 return s == null ? null : s.replace("\\", "\\\\");
163 * Answers true if the mouse event has Meta-down (Command key on Mac) or
164 * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
165 * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-pressed on
166 * Mac, you can use e.isPopupTrigger().
171 public static boolean isControlDown(MouseEvent e)
173 return isControlDown(e, isMac());
177 * Overloaded version of method (to allow unit testing)
183 protected static boolean isControlDown(MouseEvent e, boolean aMac)
187 return e.isControlDown();
189 // Jalview 2.11 code below: above is as amended for JalviewJS
191 // * answer false for right mouse button
193 // if (e.isPopupTrigger())
198 // (jalview.util.ShortcutKeyMaskExWrapper.getMenuShortcutKeyMaskEx() //
199 // .getMenuShortcutKeyMaskEx()
200 // & jalview.util.ShortcutKeyMaskExWrapper
201 // .getModifiersEx(e)) != 0; // getModifiers()) != 0;
203 // answer false for right mouse button
204 // shortcut key will be META for a Mac
205 return !e.isPopupTrigger()
206 && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()
207 & e.getModifiers()) != 0;
208 // could we use e.isMetaDown() here?
211 // BH: I don't know about that previous method. Here is what SwingJS uses.
212 // Notice the distinction in mouse events. (BUTTON3_MASK == META)
214 // private static boolean isPopupTrigger(int id, int mods, boolean isWin) {
215 // boolean rt = ((mods & InputEvent.BUTTON3_MASK) != 0);
217 // if (id != MouseEvent.MOUSE_RELEASED)
220 //// // Oddly, Windows returns InputEvent.META_DOWN_MASK on release, though
221 //// // BUTTON3_DOWN_MASK for pressed. So here we just accept both.
223 //// actually, we can use XXX_MASK, not XXX_DOWN_MASK and avoid this issue,
225 //// J2S adds the appropriate extended (0x3FC0) and simple (0x3F) modifiers.
229 // // mac, linux, unix
230 // if (id != MouseEvent.MOUSE_PRESSED)
232 // boolean lt = ((mods & InputEvent.BUTTON1_MASK) != 0);
233 // boolean ctrl = ((mods & InputEvent.CTRL_MASK) != 0);
234 // return rt || (ctrl && lt);
240 * Windows (not Mac, Linux, or Unix) and right button to test for the
241 * right-mouse pressed event in Windows that would have opened a menu or a
247 public static boolean isWinRightButton(MouseEvent e)
249 // was !isAMac(), but that is true also for Linux and Unix and JS,
251 return isWin() && SwingUtilities.isRightMouseButton(e);
255 * Windows (not Mac, Linux, or Unix) and middle button -- for mouse wheeling
256 * without pressing the button.
261 public static boolean isWinMiddleButton(MouseEvent e)
263 // was !isAMac(), but that is true also for Linux and Unix and JS
264 return isWin() && SwingUtilities.isMiddleMouseButton(e);
267 public static boolean allowMnemonics()
272 public final static int TIME_RESET = 0;
274 public final static int TIME_MARK = 1;
276 public static final int TIME_SET = 2;
278 public static final int TIME_GET = 3;
280 public static long time, mark, set, duration;
282 public static void timeCheck(String msg, int mode)
284 long t = System.currentTimeMillis();
291 System.err.println("Platform: timer reset\t\t\t" + msg);
297 duration += (t - set);
307 System.err.println("Platform: timer mark\t" + ((t - time) / 1000f)
308 + "\t" + ((t - mark) / 1000f) + "\t" + msg);
319 System.err.println("Platform: timer dur\t" + ((t - time) / 1000f)
320 + "\t" + ((duration) / 1000f) + "\t" + msg);
327 public static void cacheFileData(String path, Object data)
329 if (!isJS() || data == null)
336 * swingjs.JSUtil.cacheFileData$S$O(path, data);
341 public static void cacheFileData(File file)
344 if (!isJS() || (data = Platform.getFileBytes(file)) == null)
348 cacheFileData(file.toString(), data);
351 public static byte[] getFileBytes(File f)
353 return /** @j2sNative f && swingjs.JSUtil.getFileAsBytes$O(f) || */
357 public static byte[] getFileAsBytes(String fileStr)
360 // BH 2018 hack for no support for access-origin
362 * @j2sNative bytes = swingjs.JSUtil.getFileAsBytes$O(fileStr)
364 cacheFileData(fileStr, bytes);
368 @SuppressWarnings("unused")
369 public static String getFileAsString(String url)
375 * ret = swingjs.JSUtil.getFileAsString$S(url);
379 cacheFileData(url, ret);
383 public static boolean setFileBytes(File f, String urlstring)
389 @SuppressWarnings("unused")
390 byte[] bytes = getFileAsBytes(urlstring);
391 // TODO temporary doubling of 秘bytes and _bytes;
392 // just remove _bytes when new transpiler has been installed
394 * @j2sNative f.\u79d8bytes = f._bytes = bytes;
399 public static void addJ2SBinaryType(String ext)
404 * J2S._binaryTypes.push("." + ext + "?");
410 * Encode the URI using JavaScript encodeURIComponent
413 * @return encoded value
415 public static String encodeURI(String value)
418 * @j2sNative value = encodeURIComponent(value);
424 * Open the URL using a simple window call if this is JavaScript
427 * @return true if window has been opened
429 public static boolean openURL(String url)
444 public static String getUniqueAppletID()
447 * @j2sNative return swingjs.JSUtil.getApplet$()._uniqueId;
455 * Read the Info block for this applet.
460 * @return unique id for this applet
462 public static void readInfoProperties(String prefix, Properties p)
468 String id = getUniqueAppletID();
469 String key = "", value = "";
471 * @j2sNative var info = swingjs.JSUtil.getApplet$().__Info || {}; for (var
472 * key in info) { if (key.indexOf(prefix) == 0) { value = "" +
477 "Platform id=" + id + " reading Info." + key + " = " + value);
478 p.put(id + "_" + key, value);
488 public static void setAjaxJSON(URL url)
496 public static Object parseJSON(InputStream response)
497 throws IOException, ParseException
501 return JSON.parse(response);
504 BufferedReader br = null;
507 br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
508 return new JSONParser().parse(br);
516 } catch (IOException e)
524 public static Object parseJSON(String json) throws ParseException
526 return (isJS() ? JSON.parse(json) : new JSONParser().parse(json));
529 public static Object parseJSON(Reader r)
530 throws IOException, ParseException
539 return new JSONParser().parse(r);
541 // Using a file reader is not currently supported in SwingJS JavaScript
543 if (r instanceof FileReader)
545 throw new IOException(
546 "StringJS does not support FileReader parsing for JSON -- but it could...");
548 return JSON.parse(r);
553 * Dump the input stream to an output file.
557 * @throws IOException
558 * if the file cannot be created or there is a problem reading the
561 public static void streamToFile(InputStream is, File outFile)
565 * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
571 FileOutputStream fio = new FileOutputStream(outFile);
574 byte[] bb = new byte[32 * 1024];
576 while ((l = is.read(bb)) > 0)
587 * Add a known domain that implements access-control-allow-origin:*
589 * These should be reviewed periodically.
592 * for a service that is not allowing ajax
594 * @author hansonr@stolaf.edu
597 public static void addJ2SDirectDatabaseCall(String domain)
603 "Platform adding known access-control-allow-origin * for domain "
608 * J2S.addDirectDatabaseCall(domain);
614 public static void getURLCommandArguments()
619 * Retrieve the first query field as command arguments to Jalview. Include
620 * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's
621 * __Info.args element to this value.
624 * decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
625 * + "?").split("?")[1].split("#")[0]); a &&
626 * (System.out.println("URL arguments detected were "+a)) &&
627 * (J2S.thisApplet.__Info.urlargs = a.split(" "));
628 * (!J2S.thisApplet.__Info.args || J2S.thisApplet.__Info.args
629 * == "" || J2S.thisApplet.__Info.args == "??") &&
630 * (J2S.thisApplet.__Info.args = a) && (System.out.println("URL
631 * arguments were passed to J2S main."));
633 } catch (Throwable t)
639 * A (case sensitive) file path comparator that ignores the difference between
646 public static boolean pathEquals(String path1, String path2)
650 return path2 == null;
656 String p1 = path1.replace('\\', '/');
657 String p2 = path2.replace('\\', '/');
658 return p1.equals(p2);