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,
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))
85 * @return true if HTML5 JavaScript
87 public static boolean isJS()
93 * sorry folks - Macs really are different
95 * BH: disabled for SwingJS -- will need to check key-press issues
97 * @return true if we do things in a special way.
99 public static boolean isAMacAndNotJS()
101 return (isNoJSMac == null ? (isNoJSMac = !isJS && isMac()) : isNoJSMac);
105 * Check if we are on a Microsoft plaform...
107 * @return true if we have to cope with another platform variation
109 public static boolean isWindowsAndNotJS()
111 return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin);
116 * @return true if we are running in non-interactive no UI mode
118 public static boolean isHeadless()
120 if (isHeadless == null)
122 isHeadless = "true".equals(System.getProperty("java.awt.headless"));
129 * @return nominal maximum command line length for this platform
131 public static int getMaxCommandLineLength()
133 // TODO: determine nominal limits for most platforms.
134 return 2046; // this is the max length for a windows NT system.
138 * Answers the input with every backslash replaced with a double backslash (an
139 * 'escaped' single backslash)
144 public static String escapeBackslashes(String s)
146 return s == null ? null : s.replace("\\", "\\\\");
150 * Answers true if the mouse event has Meta-down (Command key on Mac) or
151 * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
152 * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-pressed on
153 * Mac, you can use e.isPopupTrigger().
158 public static boolean isControlDown(MouseEvent e)
160 return isControlDown(e, isMac());
164 * Overloaded version of method (to allow unit testing)
170 protected static boolean isControlDown(MouseEvent e, boolean aMac)
174 return e.isControlDown();
176 // Jalview 2.11 code below: above is as amended for JalviewJS
178 // * answer false for right mouse button
180 // if (e.isPopupTrigger())
185 // (jalview.util.ShortcutKeyMaskExWrapper.getMenuShortcutKeyMaskEx() //
186 // .getMenuShortcutKeyMaskEx()
187 // & jalview.util.ShortcutKeyMaskExWrapper
188 // .getModifiersEx(e)) != 0; // getModifiers()) != 0;
190 // answer false for right mouse button
191 // shortcut key will be META for a Mac
192 return !e.isPopupTrigger()
193 && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()
194 & e.getModifiers()) != 0;
195 // could we use e.isMetaDown() here?
198 // BH: I don't know about that previous method. Here is what SwingJS uses.
199 // Notice the distinction in mouse events. (BUTTON3_MASK == META)
201 // private static boolean isPopupTrigger(int id, int mods, boolean isWin) {
202 // boolean rt = ((mods & InputEvent.BUTTON3_MASK) != 0);
204 // if (id != MouseEvent.MOUSE_RELEASED)
207 //// // Oddly, Windows returns InputEvent.META_DOWN_MASK on release, though
208 //// // BUTTON3_DOWN_MASK for pressed. So here we just accept both.
210 //// actually, we can use XXX_MASK, not XXX_DOWN_MASK and avoid this issue,
212 //// J2S adds the appropriate extended (0x3FC0) and simple (0x3F) modifiers.
216 // // mac, linux, unix
217 // if (id != MouseEvent.MOUSE_PRESSED)
219 // boolean lt = ((mods & InputEvent.BUTTON1_MASK) != 0);
220 // boolean ctrl = ((mods & InputEvent.CTRL_MASK) != 0);
221 // return rt || (ctrl && lt);
227 * Windows (not Mac, Linux, or Unix) and right button to test for the
228 * right-mouse pressed event in Windows that would have opened a menu or a
234 public static boolean isWinRightButton(MouseEvent e)
236 // was !isAMac(), but that is true also for Linux and Unix and JS,
238 return isWin() && SwingUtilities.isRightMouseButton(e);
242 * Windows (not Mac, Linux, or Unix) and middle button -- for mouse wheeling
243 * without pressing the button.
248 public static boolean isWinMiddleButton(MouseEvent e)
250 // was !isAMac(), but that is true also for Linux and Unix and JS
251 return isWin() && SwingUtilities.isMiddleMouseButton(e);
254 public static boolean allowMnemonics()
259 public final static int TIME_RESET = 0;
261 public final static int TIME_MARK = 1;
263 public static final int TIME_SET = 2;
265 public static final int TIME_GET = 3;
267 public static long time, mark, set, duration;
269 public static void timeCheck(String msg, int mode)
271 long t = System.currentTimeMillis();
278 System.err.println("Platform: timer reset\t\t\t" + msg);
284 duration += (t - set);
294 System.err.println("Platform: timer mark\t" + ((t - time) / 1000f)
295 + "\t" + ((t - mark) / 1000f) + "\t" + msg);
306 System.err.println("Platform: timer dur\t" + ((t - time) / 1000f)
307 + "\t" + ((duration) / 1000f) + "\t" + msg);
314 public static void cacheFileData(String path, Object data)
316 if (!isJS() || data == null)
323 * swingjs.JSUtil.cacheFileData$S$O(path, data);
328 public static void cacheFileData(File file)
331 if (!isJS() || (data = Platform.getFileBytes(file)) == null)
335 cacheFileData(file.toString(), data);
338 public static byte[] getFileBytes(File f)
340 return /** @j2sNative f && swingjs.JSUtil.getFileBytes$java_io_File(f) || */
344 public static byte[] getFileAsBytes(String fileStr)
347 // BH 2018 hack for no support for access-origin
349 * @j2sNative bytes = swingjs.JSUtil.getFileAsBytes$O(fileStr)
351 cacheFileData(fileStr, bytes);
355 @SuppressWarnings("unused")
356 public static String getFileAsString(String url)
362 * ret = swingjs.JSUtil.getFileAsString$S(url);
366 cacheFileData(url, ret);
370 public static boolean setFileBytes(File f, String urlstring)
376 @SuppressWarnings("unused")
377 byte[] bytes = getFileAsBytes(urlstring);
378 // TODO temporary doubling of 秘bytes and _bytes;
379 // just remove _bytes when new transpiler has been installed
381 * @j2sNative f.\u79d8bytes = f._bytes = bytes;
386 public static void addJ2SBinaryType(String ext)
391 * J2S._binaryTypes.push("." + ext + "?");
397 * Encode the URI using JavaScript encodeURIComponent
400 * @return encoded value
402 public static String encodeURI(String value)
405 * @j2sNative value = encodeURIComponent(value);
411 * Open the URL using a simple window call if this is JavaScript
414 * @return true if window has been opened
416 public static boolean openURL(String url)
431 public static String getUniqueAppletID()
434 * @j2sNative return swingjs.JSUtil.getApplet$()._uniqueId;
442 * Read the Info block for this applet.
447 * @return unique id for this applet
449 public static void readInfoProperties(String prefix, Properties p)
455 String id = getUniqueAppletID();
456 String key = "", value = "";
458 * @j2sNative var info = swingjs.JSUtil.getApplet$().__Info || {}; for (var
459 * key in info) { if (key.indexOf(prefix) == 0) { value = "" +
464 "Platform id=" + id + " reading Info." + key + " = " + value);
465 p.put(id + "_" + key, value);
475 public static void setAjaxJSON(URL url)
483 public static Object parseJSON(InputStream response)
484 throws IOException, ParseException
488 return JSON.parse(response);
491 BufferedReader br = null;
494 br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
495 return new JSONParser().parse(br);
503 } catch (IOException e)
511 public static Object parseJSON(String json) throws ParseException
513 return (isJS() ? JSON.parse(json)
514 : new JSONParser().parse(json));
517 public static Object parseJSON(Reader r)
518 throws IOException, ParseException
527 return new JSONParser().parse(r);
529 // Using a file reader is not currently supported in SwingJS JavaScript
531 if (r instanceof FileReader)
533 throw new IOException(
534 "StringJS does not support FileReader parsing for JSON -- but it could...");
536 return JSON.parse(r);
541 * Dump the input stream to an output file.
545 * @throws IOException
546 * if the file cannot be created or there is a problem
547 * reading the input stream.
549 public static void streamToFile(InputStream is, File outFile)
553 * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
559 FileOutputStream fio = new FileOutputStream(outFile);
562 byte[] bb = new byte[32 * 1024];
564 while ((l = is.read(bb)) > 0)
575 * Add a known domain that implements access-control-allow-origin:*
577 * These should be reviewed periodically.
580 * for a service that is not allowing ajax
582 * @author hansonr@stolaf.edu
585 public static void addJ2SDirectDatabaseCall(String domain)
591 "Platform adding known access-control-allow-origin * for domain "
596 * J2S.addDirectDatabaseCall(domain);
602 public static void getURLCommandArguments()
606 * Retrieve the first query field as command arguments to Jalview. Include
607 * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's __Info.args
608 * element to this value.
611 * decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
612 * + "?").split("?")[1].split("#")[0]); a &&
613 * (J2S.thisApplet.__Info.args = a.split(" "));
619 * A (case sensitive) file path comparator that ignores the difference between /
626 public static boolean pathEquals(String path1, String path2)
630 return path2 == null;
636 String p1 = path1.replace('\\', '/');
637 String p2 = path2.replace('\\', '/');
638 return p1.equals(p2);