X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbin%2FLauncher.java;h=2a78d8e71ebe6c40417dbae3632fd0e2cb57c2c0;hb=d1d89672d38fb328eca3495177d651c396970fd1;hp=f199002b5bf3f8014322d35748fc642599cb2fda;hpb=5e462885d21193706d23e42cd5e21e88763788cb;p=jalview.git diff --git a/src/jalview/bin/Launcher.java b/src/jalview/bin/Launcher.java index f199002..2a78d8e 100644 --- a/src/jalview/bin/Launcher.java +++ b/src/jalview/bin/Launcher.java @@ -28,6 +28,7 @@ import java.util.List; import java.util.Locale; import java.util.concurrent.TimeUnit; +import jalview.bin.argparser.Arg; import jalview.util.ChannelProperties; import jalview.util.LaunchUtils; @@ -35,12 +36,12 @@ import jalview.util.LaunchUtils; * A Launcher class for Jalview. This class is used to launch Jalview from the * shadowJar when Getdown is not used or available. It attempts to take all the * command line arguments to pass on to the jalview.bin.Jalview class, but to - * insert a -Xmx memory setting to a sensible default, using the -jvmmempc and + * insert a -Xmx memory setting to a sensible default, using the --jvmmempc and * -jvmmemmax application arguments if specified. If not specified then system * properties will be looked for by jalview.bin.MemorySetting. If the user has - * provided the JVM with a -Xmx setting directly and not set -jvmmempc or - * -jvmmemmax then this setting will be used and system properties ignored. If - * -Xmx is set as well as -jvmmempc or -jvmmemmax as argument(s) then the -Xmx + * provided the JVM with a -Xmx setting directly and not set --jvmmempc or + * --jvmmemmax then this setting will be used and system properties ignored. If + * -Xmx is set as well as --jvmmempc or --jvmmemmax as argument(s) then the -Xmx * argument will NOT be passed on to the main application launch. * * @author bsoares @@ -50,35 +51,20 @@ public class Launcher { private final static String startClass = "jalview.bin.Jalview"; + // not setting this yet due to problem with Jmol private final static String headlessProperty = "java.awt.headless"; - private static boolean checkJVMSymlink(String testBin) - { - File testBinFile = new File(testBin); - if (!testBinFile.exists()) - { - return false; - } - File targetFile = null; - try - { - targetFile = testBinFile.getCanonicalFile(); - } catch (IOException e) - { - return false; - } - if (targetFile != null && ("java".equals(targetFile.getName()) - || "java.exe".equals(targetFile.getName()))) - { - return true; - } - return false; - } + // used for headless macOS + private final static String macosHeadlessProperty = "apple.awt.UIElement"; + + // arguments that assume headless mode + private final static String[] assumeHeadlessArgs = { "headless", "output", + "image", "structureimage" }; /** * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with - * the same arguments but with memory adjusted based on extracted -jvmmempc - * and -jvmmemmax application arguments. If on a Mac then extra dock:icon and + * the same arguments but with memory adjusted based on extracted --jvmmempc + * and --jvmmemmax application arguments. If on a Mac then extra dock:icon and * dock:name arguments are also set. * * @param args @@ -87,85 +73,95 @@ public class Launcher { if (!LaunchUtils.checkJavaVersion()) { - System.err.println("WARNING - The Java version being used (Java " - + LaunchUtils.getJavaVersion() - + ") may lead to problems. This installation of Jalview should be used with Java " - + LaunchUtils.getJavaCompileVersion() + "."); - } - final String appName = ChannelProperties.getProperty("app_name"); - final String javaBinDir = System.getProperty("java.home") - + File.separator + "bin" + File.separator; - String javaBin = null; - if (javaBin == null && checkJVMSymlink(javaBinDir + appName)) - { - javaBin = javaBinDir + appName; - } - if (javaBin == null && checkJVMSymlink(javaBinDir + "Jalview")) - { - javaBin = javaBinDir + "Jalview"; - } - if (javaBin == null) - { - javaBin = "java"; + jalview.bin.Console + .errPrintln("WARNING - The Java version being used (Java " + + LaunchUtils.getJavaVersion() + + ") may lead to problems. This installation of Jalview should be used with Java " + + LaunchUtils.getJavaCompileVersion() + "."); } - List command = new ArrayList<>(); - command.add(javaBin); - - String memSetting = null; - - boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1; - - for (String jvmArg : ManagementFactory.getRuntimeMXBean() - .getInputArguments()) - { - command.add(jvmArg); - } - command.add("-cp"); - command.add(ManagementFactory.getRuntimeMXBean().getClassPath()); - String jvmmempc = null; String jvmmemmax = null; boolean debug = false; boolean wait = true; boolean quiet = false; boolean headless = false; + boolean assumeheadless = false; + boolean gui = false; + boolean help = false; + boolean stdout = false; // must set --debug before --launcher... boolean launcherstop = false; boolean launcherprint = false; boolean launcherwait = false; ArrayList arguments = new ArrayList<>(); + String previousArg = null; + // set debug first for (String arg : args) { if (arg.equals("--debug")) { debug = true; } + } + for (String arg : args) + { if (arg.equals("--quiet")) { quiet = true; } - if (arg.equals("--headless")) + else if (arg.equals("--gui")) { - headless = true; + gui = true; } - if (debug && arg.equals("--launcherprint")) + else if (arg.equals("--help")) { - launcherprint = true; + help = true; } - if (debug && arg.equals("--launcherstop")) + else if (arg.equals("--version")) { - launcherstop = true; + help = true; } - if (debug && arg.equals("--launcherwait")) + + if (!assumeheadless) { - launcherwait = true; + for (String a : assumeHeadlessArgs) + { + if (arg.equals("--" + a) || arg.startsWith("--" + a + "=")) + { + assumeheadless = true; + } + } } - // this ends the launcher immediately - if (debug && arg.equals("--launchernowait")) + + if (arg.equals("--output=-") + || (arg.equals("-") && "--output".equals(previousArg))) { - wait = false; + stdout = true; + } + + if (debug) + { + if (arg.equals("--launcherprint")) + { + launcherprint = true; + } + else if (arg.equals("--launcherstop")) + { + launcherstop = true; + } + else if (arg.equals("--launcherwait")) + { + launcherwait = true; + } + else + // this ends the launcher immediately + if (arg.equals("--launchernowait")) + { + wait = false; + } } + previousArg = arg; // Don't add the --launcher... args to Jalview launch if (arg.startsWith("--launcher")) { @@ -173,32 +169,24 @@ public class Launcher } // jvmmempc and jvmmemmax args used to set memory and are not passed on to // startClass - if (arg.startsWith( - "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "=")) + final String jvmmempcArg = Arg.JVMMEMPC.getName(); + final String jvmmemmaxArg = Arg.JVMMEMMAX.getName(); + if (arg.startsWith("-" + jvmmempcArg + "=")) { - jvmmempc = arg.substring( - MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length() - + 2); + jvmmempc = arg.substring(jvmmempcArg.length() + 2); } - else if (arg.startsWith( - "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "=")) + else if (arg.startsWith("-" + jvmmemmaxArg + "=")) { - jvmmemmax = arg.substring( - MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2); + jvmmemmax = arg.substring(jvmmemmaxArg.length() + 2); } // --doubledash versions - else if (arg.startsWith("--" - + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "=")) + else if (arg.startsWith("--" + jvmmempcArg + "=")) { - jvmmempc = arg.substring( - MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length() - + 3); + jvmmempc = arg.substring(jvmmempcArg.length() + 3); } - else if (arg.startsWith( - "--" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "=")) + else if (arg.startsWith("--" + jvmmemmaxArg + "=")) { - jvmmemmax = arg.substring( - MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 3); + jvmmemmax = arg.substring(jvmmemmaxArg.length() + 3); } // retain arg else @@ -206,6 +194,39 @@ public class Launcher arguments.add(arg); } } + if (help) + { + // --help takes precedence over --gui + headless = true; + } + else if (gui) + { + // --gui takes precedence over --headless + headless = false; + } + else + { + // --output arguments assume headless mode + headless = assumeheadless; + } + + final String appName = ChannelProperties.getProperty("app_name"); + + // if we're using jalview.bin.Launcher we always assume a console is in use + final String javaBin = LaunchUtils.findJavaBin(true); + + List command = new ArrayList<>(); + command.add(javaBin); + + String memSetting = null; + + for (String jvmArg : ManagementFactory.getRuntimeMXBean() + .getInputArguments()) + { + command.add(jvmArg); + } + command.add("-cp"); + command.add(ManagementFactory.getRuntimeMXBean().getClassPath()); // use saved preferences if no cmdline args boolean useCustomisedSettings = LaunchUtils @@ -229,6 +250,7 @@ public class Launcher boolean dockIcon = false; boolean dockName = false; boolean headlessProp = false; + boolean macosHeadlessProp = false; for (int i = 0; i < command.size(); i++) { String arg = command.get(i); @@ -253,6 +275,10 @@ public class Launcher { headlessProp = true; } + else if (arg.startsWith("-D" + macosHeadlessProperty + "=")) + { + macosHeadlessProp = true; + } } if (!memSet) @@ -267,7 +293,7 @@ public class Launcher } } - if (isAMac) + if (LaunchUtils.isMac) { if (!dockIcon) { @@ -280,9 +306,6 @@ public class Launcher // -Xdock:name=... doesn't actually work :( // Leaving it in in case it gets fixed command.add("-Xdock:name=" + appName); - // this launches WITHOUT an icon in the macOS dock. Could be useful for - // getdown? - // command.add("-Dapple.awt.UIElement=false"); // This also does not work for the dock command.add("-Dcom.apple.mrj.application.apple.menu.about.name=" + appName); @@ -291,13 +314,22 @@ public class Launcher if (headless && !headlessProp) { System.setProperty(headlessProperty, "true"); - command.add("-D" + headlessProperty + "=true"); + /* not setting this in java invocation of running jalview due to problem with Jmol */ + if (help) + { + command.add("-D" + headlessProperty + "=true"); + } + } + if (headless && LaunchUtils.isMac && !macosHeadlessProp) + { + System.setProperty(macosHeadlessProperty, "true"); + command.add("-D" + macosHeadlessProperty + "=true"); } String scalePropertyArg = HiDPISetting.getScalePropertyArg(); if (scalePropertyArg != null) { - sysout(debug, quiet, "Running " + startClass + " with scale setting " + syserr(debug, quiet, "Running " + startClass + " with scale setting " + scalePropertyArg); command.add(scalePropertyArg); } @@ -310,10 +342,10 @@ public class Launcher if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false")) || launcherprint)) { - sysout(debug, quiet, + syserr(debug, quiet, "LAUNCHER COMMAND: " + String.join(" ", builder.command())); } - sysout(debug, quiet, + syserr(debug, quiet, "Running " + startClass + " with " + (memSetting == null ? "no memory setting" : ("memory setting " + memSetting))); @@ -321,7 +353,7 @@ public class Launcher if (Boolean.parseBoolean(System.getProperty("launcherstop", "false")) || (debug && launcherstop)) { - sysout(debug, quiet, + syserr(debug, quiet, "System property 'launcherstop' is set and not 'false'. Exiting."); System.exit(0); } @@ -331,22 +363,23 @@ public class Launcher Process process = builder.start(); if (wait || launcherwait) { - sysout(debug, quiet, "Launching application process"); + syserr(debug, quiet, "Launching application process"); process.waitFor(); } else { int waitInt = 0; - sysout(debug, quiet, + syserr(debug, quiet, "Wait time for application process is " + waitInt + "ms"); process.waitFor(waitInt, TimeUnit.MILLISECONDS); } - sysout(debug, quiet, "Launcher process ending"); + syserr(debug, quiet, "Launcher process ending"); } catch (IOException e) { if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory")) { - System.err.println("Caught a memory exception: " + e.getMessage()); + jalview.bin.Console + .errPrintln("Caught a memory exception: " + e.getMessage()); // Probably the "Cannot allocate memory" error, try without the memory // setting ArrayList commandNoMem = new ArrayList<>(); @@ -359,7 +392,7 @@ public class Launcher } final ProcessBuilder builderNoMem = new ProcessBuilder( commandNoMem); - System.err.println("Command without memory setting: " + jalview.bin.Console.errPrintln("Command without memory setting: " + String.join(" ", builderNoMem.command())); try { @@ -381,11 +414,11 @@ public class Launcher } } - private static void sysout(boolean debug, boolean quiet, String message) + private static void syserr(boolean debug, boolean quiet, String message) { if (debug && !quiet) { - System.out.println("LAUNCHERDEBUG - " + message); + jalview.bin.Console.errPrintln("LAUNCHERDEBUG - " + message); } }