X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbin%2FLauncher.java;h=e1415beb5886bd37cff01c61209d0392d23f4fb2;hb=f5c326f68b6fe17a0abb1336d9f291f934a5c891;hp=412f119221d4a19e936a0ea32f9af84f0e12dfe5;hpb=1f6504bd0b7187c99cd4a2551c15e854d14583b5;p=jalview.git
diff --git a/src/jalview/bin/Launcher.java b/src/jalview/bin/Launcher.java
index 412f119..e1415be 100644
--- a/src/jalview/bin/Launcher.java
+++ b/src/jalview/bin/Launcher.java
@@ -1,33 +1,187 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.bin;
import java.io.File;
import java.io.IOException;
import java.lang.management.ManagementFactory;
import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+import java.util.concurrent.TimeUnit;
+import jalview.util.ChannelProperties;
+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
+ * -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
+ * argument will NOT be passed on to the main application launch.
+ *
+ * @author bsoares
+ *
+ */
public class Launcher
{
-
private final static String startClass = "jalview.bin.Jalview";
- private final static int maxHeapSizePerCent = 90;
-
- private final static String maxHeapSizePerCentProperty = "jvmmempc";
-
- private final static String dockIconPath = "JalviewLogo_Huge.png";
+ private final static String headlessProperty = "java.awt.headless";
+ /**
+ * 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
+ * dock:name arguments are also set.
+ *
+ * @param args
+ */
public static void main(String[] args)
{
- final String javaBin = System.getProperty("java.home") + File.separator
- + "bin" + File.separator + "java";
+ if (!LaunchUtils.checkJavaVersion())
+ {
+ 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() + ".");
+ }
- ArrayList command = new ArrayList<>();
+ String jvmmempc = null;
+ String jvmmemmax = null;
+ boolean debug = false;
+ boolean wait = true;
+ boolean quiet = false;
+ boolean headless = false;
+ boolean gui = 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;
+ for (String arg : args)
+ {
+ if (arg.equals("--debug"))
+ {
+ debug = true;
+ }
+ if (arg.equals("--quiet"))
+ {
+ quiet = true;
+ }
+ if (arg.equals("--headless"))
+ {
+ headless = true;
+ }
+ if (arg.equals("--gui"))
+ {
+ gui = true;
+ }
+ if (arg.equals("--output=-")
+ || (arg.equals("-") && "--output".equals(previousArg)))
+ {
+ stdout = true;
+ }
+ if (debug && arg.equals("--launcherprint"))
+ {
+ launcherprint = true;
+ }
+ if (debug && arg.equals("--launcherstop"))
+ {
+ launcherstop = true;
+ }
+ if (debug && arg.equals("--launcherwait"))
+ {
+ launcherwait = true;
+ }
+ // this ends the launcher immediately
+ if (debug && arg.equals("--launchernowait"))
+ {
+ wait = false;
+ }
+ previousArg = arg;
+ // Don't add the --launcher... args to Jalview launch
+ if (arg.startsWith("--launcher"))
+ {
+ continue;
+ }
+ // jvmmempc and jvmmemmax args used to set memory and are not passed on to
+ // startClass
+ if (arg.startsWith(
+ "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
+ {
+ jvmmempc = arg.substring(
+ MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
+ + 2);
+ }
+ else if (arg.startsWith(
+ "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
+ {
+ jvmmemmax = arg.substring(
+ MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2);
+ }
+ // --doubledash versions
+ else if (arg.startsWith("--"
+ + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
+ {
+ jvmmempc = arg.substring(
+ MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
+ + 3);
+ }
+ else if (arg.startsWith(
+ "--" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
+ {
+ jvmmemmax = arg.substring(
+ MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 3);
+ }
+ // retain arg
+ else
+ {
+ arguments.add(arg);
+ }
+ }
+ if (gui)
+ {
+ // --gui takes precedence over --headless
+ headless = false;
+ }
+
+ 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;
- boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
-
for (String jvmArg : ManagementFactory.getRuntimeMXBean()
.getInputArguments())
{
@@ -35,23 +189,40 @@ public class Launcher
}
command.add("-cp");
command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
- ArrayList arguments = new ArrayList<>();
- for (String arg : args)
+
+ // use saved preferences if no cmdline args
+ boolean useCustomisedSettings = LaunchUtils
+ .getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS);
+ if (useCustomisedSettings)
{
- arguments.add(arg);
+ if (jvmmempc == null)
+ {
+ jvmmempc = LaunchUtils
+ .getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
+ }
+ if (jvmmemmax == null)
+ {
+ jvmmemmax = LaunchUtils
+ .getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
+ }
}
- // add memory setting if not specified
+ // add these settings if not already specified
boolean memSet = false;
boolean dockIcon = false;
boolean dockName = false;
- ARG: for (int i = 0; i < command.size(); i++)
+ boolean headlessProp = false;
+ for (int i = 0; i < command.size(); i++)
{
String arg = command.get(i);
if (arg.startsWith("-Xmx"))
{
- memSetting = arg;
- memSet = true;
+ // only use -Xmx if jvmmemmax and jvmmempc have not been set
+ if (jvmmempc == null && jvmmemmax == null)
+ {
+ memSetting = arg;
+ memSet = true;
+ }
}
else if (arg.startsWith("-Xdock:icon"))
{
@@ -61,86 +232,107 @@ public class Launcher
{
dockName = true;
}
+ else if (arg.startsWith("-D" + headlessProperty + "="))
+ {
+ headlessProp = true;
+ }
}
if (!memSet)
{
- long maxMemLong = -1;
- int percent = maxHeapSizePerCent;
- String jvmmempc = System.getProperty(maxHeapSizePerCentProperty);
- try
- {
- if (jvmmempc != null)
- {
- int trypercent = Integer.parseInt(jvmmempc);
- if (0 < trypercent && trypercent <= 100)
- {
- percent = trypercent;
- }
- else
- {
- System.out.println("Property '" + maxHeapSizePerCentProperty
- + "' should be in range 1..100");
- }
- }
- } catch (Exception e)
- {
- System.out.println("Error parsing " + maxHeapSizePerCentProperty
- + " '" + jvmmempc + "'");
- }
-
- try
- {
- maxMemLong = MemorySetting.memPercent(percent);
- } catch (Exception e)
- {
- e.printStackTrace();
- } catch (Throwable t)
- {
- t.printStackTrace();
- }
+ long maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
if (maxMemLong > 0)
{
memSetting = "-Xmx" + Long.toString(maxMemLong);
+ memSet = true;
command.add(memSetting);
}
}
- if (isAMac)
+ if (LaunchUtils.isMac)
{
if (!dockIcon)
{
+ String dockIconPath = System.getProperty("getdownappdir", ".")
+ + File.separator + "resource/jalview_logo.png";
command.add("-Xdock:icon=" + dockIconPath);
}
if (!dockName)
{
// -Xdock:name=... doesn't actually work :(
// Leaving it in in case it gets fixed
- command.add("-Xdock:name=" + "Jalview");
+ 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);
}
}
+ if (headless && !headlessProp)
+ {
+ System.setProperty(headlessProperty, "true");
+ command.add("-D" + headlessProperty + "=true");
+ }
+
+ String scalePropertyArg = HiDPISetting.getScalePropertyArg();
+ if (scalePropertyArg != null)
+ {
+ syserr(debug, quiet, "Running " + startClass + " with scale setting "
+ + scalePropertyArg);
+ command.add(scalePropertyArg);
+ }
command.add(startClass);
command.addAll(arguments);
final ProcessBuilder builder = new ProcessBuilder(command);
- // System.out.println("COMMAND: " + String.join(" ", builder.command()));
- System.out.println("Running " + startClass + " with "
- + (memSetting == null ? "no memSetting" : memSetting));
+ if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
+ || launcherprint))
+ {
+ syserr(debug, quiet,
+ "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
+ }
+ syserr(debug, quiet,
+ "Running " + startClass + " with "
+ + (memSetting == null ? "no memory setting"
+ : ("memory setting " + memSetting)));
+ if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
+ || (debug && launcherstop))
+ {
+ syserr(debug, quiet,
+ "System property 'launcherstop' is set and not 'false'. Exiting.");
+ System.exit(0);
+ }
try
{
builder.inheritIO();
Process process = builder.start();
- process.waitFor();
+ if (wait || launcherwait)
+ {
+ syserr(debug, quiet, "Launching application process");
+ process.waitFor();
+ }
+ else
+ {
+ int waitInt = 0;
+ syserr(debug, quiet,
+ "Wait time for application process is " + waitInt + "ms");
+ process.waitFor(waitInt, TimeUnit.MILLISECONDS);
+ }
+ syserr(debug, quiet, "Launcher process ending");
} catch (IOException e)
{
- if (e.getMessage().toLowerCase().contains("memory"))
+ if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
{
- System.out.println("Caught a memory exception: " + e.getMessage());
- // Probably the "Cannot allocate memory" error, try without the memory setting
+ 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<>();
for (int i = 0; i < command.size(); i++)
{
@@ -151,7 +343,7 @@ public class Launcher
}
final ProcessBuilder builderNoMem = new ProcessBuilder(
commandNoMem);
- System.out.println("NO MEM COMMAND: "
+ jalview.bin.Console.errPrintln("Command without memory setting: "
+ String.join(" ", builderNoMem.command()));
try
{
@@ -171,8 +363,14 @@ public class Launcher
{
e.printStackTrace();
}
- // System.exit(0);
+ }
+ private static void syserr(boolean debug, boolean quiet, String message)
+ {
+ if (debug && !quiet)
+ {
+ jalview.bin.Console.errPrintln("LAUNCHERDEBUG - " + message);
+ }
}
}