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 * escape a string according to the local platform's escape character
141 * @return escaped file
143 public static String escapeString(String file)
145 StringBuffer f = new StringBuffer();
146 int p = 0, lastp = 0;
147 while ((p = file.indexOf('\\', lastp)) > -1)
149 f.append(file.subSequence(lastp, p));
153 f.append(file.substring(lastp));
158 * Answers true if the mouse event has Meta-down (Command key on Mac) or
159 * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
160 * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-pressed on
161 * Mac, you can use e.isPopupTrigger().
166 public static boolean isControlDown(MouseEvent e)
168 return isControlDown(e, isMac());
172 * Overloaded version of method (to allow unit testing)
178 protected static boolean isControlDown(MouseEvent e, boolean aMac)
182 return e.isControlDown();
184 // answer false for right mouse button
185 // shortcut key will be META for a Mac
186 return !e.isPopupTrigger()
187 && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()
188 & e.getModifiers()) != 0;
189 // could we use e.isMetaDown() here?
192 // BH: I don't know about that previous method. Here is what SwingJS uses.
193 // Notice the distinction in mouse events. (BUTTON3_MASK == META)
195 // private static boolean isPopupTrigger(int id, int mods, boolean isWin) {
196 // boolean rt = ((mods & InputEvent.BUTTON3_MASK) != 0);
198 // if (id != MouseEvent.MOUSE_RELEASED)
201 //// // Oddly, Windows returns InputEvent.META_DOWN_MASK on release, though
202 //// // BUTTON3_DOWN_MASK for pressed. So here we just accept both.
204 //// actually, we can use XXX_MASK, not XXX_DOWN_MASK and avoid this issue,
206 //// J2S adds the appropriate extended (0x3FC0) and simple (0x3F) modifiers.
210 // // mac, linux, unix
211 // if (id != MouseEvent.MOUSE_PRESSED)
213 // boolean lt = ((mods & InputEvent.BUTTON1_MASK) != 0);
214 // boolean ctrl = ((mods & InputEvent.CTRL_MASK) != 0);
215 // return rt || (ctrl && lt);
221 * Windows (not Mac, Linux, or Unix) and right button to test for the
222 * right-mouse pressed event in Windows that would have opened a menu or a
228 public static boolean isWinRightButton(MouseEvent e)
230 // was !isAMac(), but that is true also for Linux and Unix and JS,
232 return isWin() && SwingUtilities.isRightMouseButton(e);
236 * Windows (not Mac, Linux, or Unix) and middle button -- for mouse wheeling
237 * without pressing the button.
242 public static boolean isWinMiddleButton(MouseEvent e)
244 // was !isAMac(), but that is true also for Linux and Unix and JS
245 return isWin() && SwingUtilities.isMiddleMouseButton(e);
248 public static boolean allowMnemonics()
253 public final static int TIME_RESET = 0;
255 public final static int TIME_MARK = 1;
257 public static final int TIME_SET = 2;
259 public static final int TIME_GET = 3;
261 public static long time, mark, set, duration;
263 public static void timeCheck(String msg, int mode)
265 long t = System.currentTimeMillis();
272 System.err.println("Platform: timer reset\t\t\t" + msg);
278 duration += (t - set);
288 System.err.println("Platform: timer mark\t" + ((t - time) / 1000f)
289 + "\t" + ((t - mark) / 1000f) + "\t" + msg);
300 System.err.println("Platform: timer dur\t" + ((t - time) / 1000f)
301 + "\t" + ((duration) / 1000f) + "\t" + msg);
308 public static void cacheFileData(String path, Object data)
310 if (!isJS() || data == null)
317 * swingjs.JSUtil.cacheFileData$S$O(path, data);
322 public static byte[] getFileBytes(File f)
324 return /** @j2sNative f && f._bytes || */
328 public static byte[] getFileAsBytes(String fileStr)
331 // BH 2018 hack for no support for access-origin
333 * @j2sNative bytes = swingjs.JSUtil.getFileAsBytes$O(fileStr)
335 cacheFileData(fileStr, bytes);
339 @SuppressWarnings("unused")
340 public static String getFileAsString(String url)
346 * ret = swingjs.JSUtil.getFileAsString$S(url);
350 cacheFileData(url, ret);
354 public static boolean setFileBytes(File f, String urlstring)
360 @SuppressWarnings("unused")
361 byte[] bytes = getFileAsBytes(urlstring);
363 * @j2sNative f._bytes = bytes;
368 public static void addJ2SBinaryType(String ext)
373 * J2S._binaryTypes.push("." + ext + "?");
379 * Encode the URI using JavaScript encodeURIComponent
382 * @return encoded value
384 public static String encodeURI(String value)
387 * @j2sNative value = encodeURIComponent(value);
393 * Open the URL using a simple window call if this is JavaScript
396 * @return true if window has been opened
398 public static boolean openURL(String url)
413 public static String getUniqueAppletID()
415 @SuppressWarnings("unused")
416 ThreadGroup g = Thread.currentThread().getThreadGroup();
418 * @j2sNative return g.html5Applet._uniqueId;
426 * Read the Info block for this applet.
431 * @return unique id for this applet
433 public static void readInfoProperties(String prefix, Properties p)
439 @SuppressWarnings("unused")
440 ThreadGroup g = Thread.currentThread().getThreadGroup();
441 String id = getUniqueAppletID();
442 String key = "", value = "";
444 * @j2sNative var info = g.html5Applet.__Info || {}; for (var key in info) {
445 * if (key.indexOf(prefix) == 0) { value = "" + info[key];
449 "Platform id=" + id + " reading Info." + key + " = " + value);
450 p.put(id + "_" + key, value);
460 public static void setAjaxJSON(URL url)
468 public static Object parseJSON(InputStream response)
469 throws IOException, ParseException
473 return JSON.parse(response);
476 BufferedReader br = null;
479 br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
480 return new JSONParser().parse(br);
488 } catch (IOException e)
496 public static Object parseJSON(String json) throws ParseException
498 return (isJS() ? JSON.parse(json)
499 : new JSONParser().parse(json));
502 public static Object parseJSON(Reader r)
503 throws IOException, ParseException
512 return new JSONParser().parse(r);
514 // Using a file reader is not currently supported in SwingJS JavaScript
516 if (r instanceof FileReader)
518 throw new IOException(
519 "StringJS does not support FileReader parsing for JSON -- but it could...");
521 return JSON.parse(r);
526 * Dump the input stream to an output file.
530 * @throws IOException
531 * if the file cannot be created or there is a problem reading the
534 public static void streamToFile(InputStream is, File outFile)
537 FileOutputStream fio = new FileOutputStream(outFile);
542 * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
548 byte[] bb = new byte[32 * 1024];
550 while ((l = is.read(bb)) > 0)
561 * Add a known domain that implements access-control-allow-origin:*
563 * These should be reviewed periodically.
566 * for a service that is not allowing ajax
568 * @author hansonr@stolaf.edu
571 public static void addJ2SDirectDatabaseCall(String domain)
577 "Platform adding known access-control-allow-origin * for domain "
582 * J2S.addDirectDatabaseCall(domain);
588 public static void getURLCommandArguments()
592 * Retrieve the first query field as command arguments to Jalview. Include
593 * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's __Info.args
594 * element to this value.
597 * decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
598 * + "?").split("?")[1].split("#")[0]); a &&
599 * (J2S.thisApplet.__Info.args = a.split(" "));