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.Component;
26 import java.awt.Dimension;
27 import java.awt.Toolkit;
28 import java.awt.event.MouseEvent;
29 import java.io.BufferedReader;
31 import java.io.FileOutputStream;
32 import java.io.FileReader;
33 import java.io.IOException;
34 import java.io.InputStream;
35 import java.io.InputStreamReader;
36 import java.io.Reader;
38 import java.util.HashMap;
39 import java.util.Properties;
40 import java.util.logging.ConsoleHandler;
41 import java.util.logging.Level;
42 import java.util.logging.Logger;
44 import javax.swing.SwingUtilities;
46 import org.json.simple.parser.JSONParser;
47 import org.json.simple.parser.ParseException;
49 import com.stevesoft.pat.Regex;
51 import swingjs.api.JSUtilI;
54 * System platform information used by Applet and Application
61 private static boolean isJS = /** @j2sNative true || */
64 private static JSUtilI jsutil = /**
65 * @j2sNative new Clazz.new_("swingjs.JSUtil")
71 private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null,
74 // private static Boolean isHeadless = null;
77 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
81 public static boolean isMac()
84 ? (isMac = (System.getProperty("os.name").indexOf("Mac") >= 0))
89 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
93 public static boolean isWin()
96 ? (isWin = (System.getProperty("os.name").indexOf("Win") >= 0))
102 * @return true if HTML5 JavaScript
104 public static boolean isJS()
110 * sorry folks - Macs really are different
112 * BH: disabled for SwingJS -- will need to check key-press issues
114 * @return true if we do things in a special way.
116 public static boolean isAMacAndNotJS()
118 return (isNoJSMac == null ? (isNoJSMac = !isJS && isMac()) : isNoJSMac);
122 * Check if we are on a Microsoft plaform...
124 * @return true if we have to cope with another platform variation
126 public static boolean isWindowsAndNotJS()
128 return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin);
133 // * @return true if we are running in non-interactive no UI mode
135 // public static boolean isHeadless()
137 // if (isHeadless == null)
139 // isHeadless = "true".equals(System.getProperty("java.awt.headless"));
141 // return isHeadless;
146 * @return nominal maximum command line length for this platform
148 public static int getMaxCommandLineLength()
150 // TODO: determine nominal limits for most platforms.
151 return 2046; // this is the max length for a windows NT system.
155 * escape a string according to the local platform's escape character
158 * @return escaped file
160 public static String escapeString(String file)
162 StringBuffer f = new StringBuffer();
163 int p = 0, lastp = 0;
164 while ((p = file.indexOf('\\', lastp)) > -1)
166 f.append(file.subSequence(lastp, p));
170 f.append(file.substring(lastp));
175 * Answers true if the mouse event has Meta-down (Command key on Mac) or
176 * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
177 * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-pressed on
178 * Mac, you can use e.isPopupTrigger().
183 public static boolean isControlDown(MouseEvent e)
185 return isControlDown(e, isMac());
189 * Overloaded version of method (to allow unit testing)
195 protected static boolean isControlDown(MouseEvent e, boolean aMac)
199 return e.isControlDown();
201 // answer false for right mouse button
202 // shortcut key will be META for a Mac
203 return !e.isPopupTrigger()
204 && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()
205 & e.getModifiers()) != 0;
206 // could we use e.isMetaDown() here?
209 // BH: I don't know about that previous method. Here is what SwingJS uses.
210 // Notice the distinction in mouse events. (BUTTON3_MASK == META)
212 // private static boolean isPopupTrigger(int id, int mods, boolean isWin) {
213 // boolean rt = ((mods & InputEvent.BUTTON3_MASK) != 0);
215 // if (id != MouseEvent.MOUSE_RELEASED)
218 //// // Oddly, Windows returns InputEvent.META_DOWN_MASK on release, though
219 //// // BUTTON3_DOWN_MASK for pressed. So here we just accept both.
221 //// actually, we can use XXX_MASK, not XXX_DOWN_MASK and avoid this issue,
223 //// J2S adds the appropriate extended (0x3FC0) and simple (0x3F) modifiers.
227 // // mac, linux, unix
228 // if (id != MouseEvent.MOUSE_PRESSED)
230 // boolean lt = ((mods & InputEvent.BUTTON1_MASK) != 0);
231 // boolean ctrl = ((mods & InputEvent.CTRL_MASK) != 0);
232 // return rt || (ctrl && lt);
238 * Windows (not Mac, Linux, or Unix) and right button to test for the
239 * right-mouse pressed event in Windows that would have opened a menu or a
245 public static boolean isWinRightButton(MouseEvent e)
247 // was !isAMac(), but that is true also for Linux and Unix and JS,
249 return isWin() && SwingUtilities.isRightMouseButton(e);
253 * Windows (not Mac, Linux, or Unix) and middle button -- for mouse wheeling
254 * without pressing the button.
259 public static boolean isWinMiddleButton(MouseEvent e)
261 // was !isAMac(), but that is true also for Linux and Unix and JS
262 return isWin() && SwingUtilities.isMiddleMouseButton(e);
265 public static boolean allowMnemonics()
270 public final static int TIME_RESET = 0;
272 public final static int TIME_MARK = 1;
274 public static final int TIME_SET = 2;
276 public static final int TIME_GET = 3;
278 public static long time, mark, set, duration;
283 * Platform.timeCheck(null, Platform.TIME_MARK);
287 * Platform.timeCheck("some message", Platform.TIME_MARK);
289 * reset...[set/mark]n...get
294 public static void timeCheck(String msg, int mode)
296 long t = System.currentTimeMillis();
304 System.err.println("Platform: timer reset\t\t\t" + msg);
310 // total time between set/mark points
311 duration += (t - set);
321 System.err.println("Platform: timer mark\t" + ((t - time) / 1000f)
322 + "\t" + ((t - mark) / 1000f) + "\t" + msg);
333 System.err.println("Platform: timer get\t" + ((t - time) / 1000f)
334 + "\t" + ((duration) / 1000f) + "\t" + msg);
342 * Encode the URI using JavaScript encodeURIComponent
345 * @return encoded value
347 public static String encodeURI(String value)
350 * @j2sNative value = encodeURIComponent(value);
356 * Open the URL using a simple window call if this is JavaScript
359 * @return true if window has been opened
361 public static boolean openURL(String url) throws IOException
365 BrowserLauncher.openURL(url);
377 public static void stackTrace()
379 new NullPointerException("testing only").printStackTrace();
382 public static void cacheFileData(String path, Object data)
386 jsutil.cachePathData(path, data);
390 public static void cacheFileData(File file)
394 byte[] bytes = getFileBytes(file);
397 cacheFileData(file.toString(), bytes);
402 public static byte[] getFileBytes(File f)
404 return (isJS() && f != null ? jsutil.getBytes(f) : null);
407 public static byte[] getFileAsBytes(String fileStr)
409 byte[] bytes = (isJS() && fileStr != null
410 ? (byte[]) jsutil.getFile(fileStr, false)
414 cacheFileData(fileStr, bytes);
419 public static String getFileAsString(String url)
424 ret = (String) jsutil.getFile(url, true);
427 cacheFileData(url, ret);
433 public static boolean setFileBytes(File f, String urlstring)
439 byte[] bytes = getFileAsBytes(urlstring);
443 jsutil.setFileBytes(f, bytes);
444 } catch (Throwable t)
446 System.out.println("Platform.setFileBytes failed: " + t);
451 public static void addJ2SBinaryType(String ext)
454 jsutil.addBinaryFileType(ext);
458 * Read the Info block for this applet.
463 * @return unique id for this applet
465 public static void readInfoProperties(String prefix, Properties p)
469 jsutil.readInfoProperties(prefix, p);
473 public static void setAjaxJSON(URL url)
481 public static Object parseJSON(InputStream response)
482 throws IOException, ParseException
486 return JSON.parse(response);
489 BufferedReader br = null;
492 br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
493 return new JSONParser().parse(br);
501 } catch (IOException e)
509 public static Object parseJSON(String json) throws ParseException
511 return (isJS() ? JSON.parse(json)
512 : new JSONParser().parse(json));
515 public static Object parseJSON(Reader r)
516 throws IOException, ParseException
525 return new JSONParser().parse(r);
527 // Using a file reader is not currently supported in SwingJS JavaScript
529 if (r instanceof FileReader)
531 throw new IOException(
532 "StringJS does not support FileReader parsing for JSON -- but it could...");
534 return JSON.parse(r);
539 * Dump the input stream to an output file.
543 * @throws IOException
544 * if the file cannot be created or there is a problem reading the
547 public static void streamToFile(InputStream is, File outFile)
550 if (isJS() && jsutil.streamToFile(is, outFile))
554 FileOutputStream fio = new FileOutputStream(outFile);
557 byte[] bb = new byte[32 * 1024];
559 while ((l = is.read(bb)) > 0)
570 * Add a known domain that implements access-control-allow-origin:*
572 * These should be reviewed periodically.
575 * for a service that is not allowing ajax
577 * @author hansonr@stolaf.edu
580 public static void addJ2SDirectDatabaseCall(String domain)
585 jsutil.addDirectDatabaseCall(domain);
590 * Retrieve the first query field as command arguments to Jalview. Include
591 * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's __Info.args
592 * element to this value.
595 @SuppressWarnings("unused")
596 public static void getURLCommandArguments()
603 String[] args = null;
606 * decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
607 * + "?").split("?")[1].split("#")[0]); args && (args =
612 jsutil.setAppletInfo("args", args);
617 public static URL getDocumentBase()
619 return (isJS() ? jsutil.getDocumentBase() : null);
622 public static URL getCodeBase()
624 return (isJS() ? jsutil.getCodeBase() : null);
627 public static void ensureJmol()
629 jsutil.loadResourceIfClassUnknown("core/core_jvjmol.z.js",
630 "org.jmol.viewer.Viewer");
633 public static void ensureRegex()
635 jsutil.loadResourceIfClassUnknown("core/core_stevesoft.z.js",
636 "com.stevesoft.pat.Regex");
639 public static Regex newRegex(String searchString, String replaceString)
642 return (replaceString == null ? new Regex(searchString)
643 : new Regex(searchString, replaceString));
646 public static Regex newRegexPerl(String code)
649 return Regex.perlCode(code);
653 * Initialize Java debug logging. A representative sample -- adapt as desired.
655 public static void startJavaLogging()
661 logClass("java.awt.EventDispatchThread", "java.awt.EventQueue",
662 "java.awt.Component", "java.awt.focus.Component",
663 "java.awt.event.Component",
664 "java.awt.focus.DefaultKeyboardFocusManager");
669 * Initiate Java logging for a given class. Only for Java, not JavaScript;
670 * Allows debugging of complex event processing.
674 public static void logClass(String... classNames)
682 Logger rootLogger = Logger.getLogger("");
683 rootLogger.setLevel(Level.ALL);
684 ConsoleHandler consoleHandler = new ConsoleHandler();
685 consoleHandler.setLevel(Level.ALL);
686 for (int i = classNames.length; --i >= 0;)
688 Logger logger = Logger.getLogger(classNames[i]);
689 logger.setLevel(Level.ALL);
690 logger.addHandler(consoleHandler);
696 * Set the "app" property of the HTML5 applet object, for example,
697 * "testApplet.app", to point to the Jalview instance. This will be the object
698 * that page developers use that is similar to the original Java applet object
699 * that was accessed via LiveConnect.
703 public static void setAppClass(Object app)
707 jsutil.setAppletAttribute("app", app);
712 * Retrieve the object's embedded size from a div's style on a page if
713 * embedded in SwingJS.
716 * JFrame or JInternalFrame
717 * @param defaultWidth
718 * use -1 to return null (no default size)
719 * @param defaultHeight
720 * @return the embedded dimensions or null (no default size or not embedded)
722 public static Dimension getDimIfEmbedded(Component frame,
723 int defaultWidth, int defaultHeight)
725 Dimension d = (Dimension) getEmbeddedAttribute(frame, "dim");
726 return (d == null && defaultWidth >= 0
727 ? new Dimension(defaultWidth, defaultHeight)
733 * If this frame Is this frame embedded in a web page, return a known type.
736 * a JFrame or JInternalFrame
738 * @return null if frame is not embedded.
740 public static Object getEmbeddedAttribute(Component frame, String type)
742 return (isJS() ? jsutil.getEmbeddedAttribute(frame, type) : null);
746 * Only called for JavaScript.
748 * @return Map for static singleton classes unique to a given applet
750 public static HashMap<?,?> getJSSingletons()
752 return (isJS() ? jsutil.getJSContext("jssingletons") : null);