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;
35 import java.net.MalformedURLException;
37 import java.util.Properties;
39 import javax.swing.SwingUtilities;
41 import org.json.simple.parser.JSONParser;
42 import org.json.simple.parser.ParseException;
44 import com.stevesoft.pat.Regex;
47 * System platform information used by Applet and Application
54 private static boolean isJS = /** @j2sNative true || */
57 private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null,
60 // private static Boolean isHeadless = null;
63 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
67 public static boolean isMac()
70 ? (isMac = (System.getProperty("os.name").indexOf("Mac") >= 0))
75 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
79 public static boolean isWin()
82 ? (isWin = (System.getProperty("os.name").indexOf("Win") >= 0))
88 * @return true if HTML5 JavaScript
90 public static boolean isJS()
96 * sorry folks - Macs really are different
98 * BH: disabled for SwingJS -- will need to check key-press issues
100 * @return true if we do things in a special way.
102 public static boolean isAMacAndNotJS()
104 return (isNoJSMac == null ? (isNoJSMac = !isJS && isMac()) : isNoJSMac);
108 * Check if we are on a Microsoft plaform...
110 * @return true if we have to cope with another platform variation
112 public static boolean isWindowsAndNotJS()
114 return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin);
119 // * @return true if we are running in non-interactive no UI mode
121 // public static boolean isHeadless()
123 // if (isHeadless == null)
125 // isHeadless = "true".equals(System.getProperty("java.awt.headless"));
127 // return isHeadless;
132 * @return nominal maximum command line length for this platform
134 public static int getMaxCommandLineLength()
136 // TODO: determine nominal limits for most platforms.
137 return 2046; // this is the max length for a windows NT system.
141 * escape a string according to the local platform's escape character
144 * @return escaped file
146 public static String escapeString(String file)
148 StringBuffer f = new StringBuffer();
149 int p = 0, lastp = 0;
150 while ((p = file.indexOf('\\', lastp)) > -1)
152 f.append(file.subSequence(lastp, p));
156 f.append(file.substring(lastp));
161 * Answers true if the mouse event has Meta-down (Command key on Mac) or
162 * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
163 * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-pressed on
164 * Mac, you can use e.isPopupTrigger().
169 public static boolean isControlDown(MouseEvent e)
171 return isControlDown(e, isMac());
175 * Overloaded version of method (to allow unit testing)
181 protected static boolean isControlDown(MouseEvent e, boolean aMac)
185 return e.isControlDown();
187 // answer false for right mouse button
188 // shortcut key will be META for a Mac
189 return !e.isPopupTrigger()
190 && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()
191 & e.getModifiers()) != 0;
192 // could we use e.isMetaDown() here?
195 // BH: I don't know about that previous method. Here is what SwingJS uses.
196 // Notice the distinction in mouse events. (BUTTON3_MASK == META)
198 // private static boolean isPopupTrigger(int id, int mods, boolean isWin) {
199 // boolean rt = ((mods & InputEvent.BUTTON3_MASK) != 0);
201 // if (id != MouseEvent.MOUSE_RELEASED)
204 //// // Oddly, Windows returns InputEvent.META_DOWN_MASK on release, though
205 //// // BUTTON3_DOWN_MASK for pressed. So here we just accept both.
207 //// actually, we can use XXX_MASK, not XXX_DOWN_MASK and avoid this issue,
209 //// J2S adds the appropriate extended (0x3FC0) and simple (0x3F) modifiers.
213 // // mac, linux, unix
214 // if (id != MouseEvent.MOUSE_PRESSED)
216 // boolean lt = ((mods & InputEvent.BUTTON1_MASK) != 0);
217 // boolean ctrl = ((mods & InputEvent.CTRL_MASK) != 0);
218 // return rt || (ctrl && lt);
224 * Windows (not Mac, Linux, or Unix) and right button to test for the
225 * right-mouse pressed event in Windows that would have opened a menu or a
231 public static boolean isWinRightButton(MouseEvent e)
233 // was !isAMac(), but that is true also for Linux and Unix and JS,
235 return isWin() && SwingUtilities.isRightMouseButton(e);
239 * Windows (not Mac, Linux, or Unix) and middle button -- for mouse wheeling
240 * without pressing the button.
245 public static boolean isWinMiddleButton(MouseEvent e)
247 // was !isAMac(), but that is true also for Linux and Unix and JS
248 return isWin() && SwingUtilities.isMiddleMouseButton(e);
251 public static boolean allowMnemonics()
256 public final static int TIME_RESET = 0;
258 public final static int TIME_MARK = 1;
260 public static final int TIME_SET = 2;
262 public static final int TIME_GET = 3;
264 public static long time, mark, set, duration;
266 public static void timeCheck(String msg, int mode)
268 long t = System.currentTimeMillis();
275 System.err.println("Platform: timer reset\t\t\t" + msg);
281 duration += (t - set);
291 System.err.println("Platform: timer mark\t" + ((t - time) / 1000f)
292 + "\t" + ((t - mark) / 1000f) + "\t" + msg);
303 System.err.println("Platform: timer dur\t" + ((t - time) / 1000f)
304 + "\t" + ((duration) / 1000f) + "\t" + msg);
311 public static void cacheFileData(String path, Object data)
313 if (!isJS() || data == null)
320 * swingjs.JSUtil.cacheFileData$S$O(path, data);
325 public static void cacheFileData(File file)
328 if (!isJS() || (data = Platform.getFileBytes(file)) == null)
332 cacheFileData(file.toString(), data);
335 public static byte[] getFileBytes(File f)
337 // TODO temporary doubling of 秘bytes and _bytes;
338 // just remove _bytes when new transpiler has been installed
339 return /** @j2sNative f && (f.秘bytes || f._bytes) || */
343 public static byte[] getFileAsBytes(String fileStr)
346 // BH 2018 hack for no support for access-origin
348 * @j2sNative bytes = swingjs.JSUtil.getFileAsBytes$O(fileStr)
350 cacheFileData(fileStr, bytes);
354 @SuppressWarnings("unused")
355 public static String getFileAsString(String url)
361 * ret = swingjs.JSUtil.getFileAsString$S(url);
365 cacheFileData(url, ret);
369 public static boolean setFileBytes(File f, String urlstring)
375 @SuppressWarnings("unused")
376 byte[] bytes = getFileAsBytes(urlstring);
377 // TODO temporary doubling of 秘bytes and _bytes;
378 // just remove _bytes when new transpiler has been installed
380 * @j2sNative f.秘bytes = f._bytes = bytes;
385 public static void addJ2SBinaryType(String ext)
390 * J2S._binaryTypes.push("." + ext + "?");
396 * Encode the URI using JavaScript encodeURIComponent
399 * @return encoded value
401 public static String encodeURI(String value)
404 * @j2sNative value = encodeURIComponent(value);
410 * Open the URL using a simple window call if this is JavaScript
413 * @return true if window has been opened
415 public static boolean openURL(String url) throws IOException
419 BrowserLauncher.openURL(url);
431 public static String getUniqueAppletID()
433 @SuppressWarnings("unused")
434 ThreadGroup g = Thread.currentThread().getThreadGroup();
436 * @j2sNative return g.秘html5Applet._uniqueId;
444 * Read the Info block for this applet.
449 * @return unique id for this applet
451 public static void readInfoProperties(String prefix, Properties p)
457 @SuppressWarnings("unused")
458 ThreadGroup g = Thread.currentThread().getThreadGroup();
459 String id = getUniqueAppletID();
460 String key = "", value = "";
462 * @j2sNative var info = g.秘html5Applet.__Info || {}; for (var key in info)
463 * { if (key.indexOf(prefix) == 0) { value = "" + info[key];
467 "Platform id=" + id + " reading Info." + key + " = " + value);
478 public static void setAjaxJSON(URL url)
486 public static Object parseJSON(InputStream response)
487 throws IOException, ParseException
491 return JSON.parse(response);
494 BufferedReader br = null;
497 br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
498 return new JSONParser().parse(br);
506 } catch (IOException e)
514 public static Object parseJSON(String json) throws ParseException
516 return (isJS() ? JSON.parse(json)
517 : new JSONParser().parse(json));
520 public static Object parseJSON(Reader r)
521 throws IOException, ParseException
530 return new JSONParser().parse(r);
532 // Using a file reader is not currently supported in SwingJS JavaScript
534 if (r instanceof FileReader)
536 throw new IOException(
537 "StringJS does not support FileReader parsing for JSON -- but it could...");
539 return JSON.parse(r);
544 * Dump the input stream to an output file.
548 * @throws IOException
549 * if the file cannot be created or there is a problem reading the
552 public static void streamToFile(InputStream is, File outFile)
555 FileOutputStream fio = new FileOutputStream(outFile);
560 * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
566 byte[] bb = new byte[32 * 1024];
568 while ((l = is.read(bb)) > 0)
579 * Add a known domain that implements access-control-allow-origin:*
581 * These should be reviewed periodically.
584 * for a service that is not allowing ajax
586 * @author hansonr@stolaf.edu
589 public static void addJ2SDirectDatabaseCall(String domain)
595 "Platform adding known access-control-allow-origin * for domain "
600 * J2S.addDirectDatabaseCall(domain);
606 public static void getURLCommandArguments()
610 * Retrieve the first query field as command arguments to Jalview. Include
611 * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's __Info.args
612 * element to this value.
615 * decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
616 * + "?").split("?")[1].split("#")[0]); a &&
617 * (J2S.thisApplet.__Info.args = a.split(" "));
622 public static URL getDocumentBase()
628 @SuppressWarnings("unused")
629 Object g = Thread.currentThread().getThreadGroup();
631 * @j2sNative g.秘html5Applet._appletPanel.appletDocumentBase
636 } catch (MalformedURLException e)
642 public static URL getCodeBase()
648 @SuppressWarnings("unused")
649 Object g = Thread.currentThread().getThreadGroup();
651 * @j2sNative g.秘html5Applet._appletPanel.appletCodeBase
656 } catch (MalformedURLException e)
663 * load a resource -- probably a core file -- if and only if a particular
664 * class has not been instantialized. We use a String here because if we used
665 * a .class object, that reference itself would simply load the class, and we
666 * want the core package to include that as well.
668 * @param resourcePath
671 public static void loadStaticResource(Object resourcePath,
676 * @j2sNative if (!swingjs.JSUtil.isClassLoaded$S(className))
677 * swingjs.JSUtil.loadStaticResource$S(resourcePath);
681 public static void ensureRegex()
683 loadStaticResource("core/core_stevesoft.z.js",
684 "com.stevesoft.pat.Regex");
687 public static Regex newRegex(String searchString, String replaceString)
690 return (replaceString == null ? new Regex(searchString)
691 : new Regex(searchString, replaceString));
694 public static Regex newRegexPerl(String code)
697 return Regex.perlCode(code);