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.
24 import java.io.IOException;
25 import java.lang.management.ManagementFactory;
26 import java.util.ArrayList;
27 import java.util.List;
28 import java.util.Locale;
29 import java.util.concurrent.TimeUnit;
31 import jalview.util.ChannelProperties;
32 import jalview.util.LaunchUtils;
35 * A Launcher class for Jalview. This class is used to launch Jalview from the
36 * shadowJar when Getdown is not used or available. It attempts to take all the
37 * command line arguments to pass on to the jalview.bin.Jalview class, but to
38 * insert a -Xmx memory setting to a sensible default, using the -jvmmempc and
39 * -jvmmemmax application arguments if specified. If not specified then system
40 * properties will be looked for by jalview.bin.MemorySetting. If the user has
41 * provided the JVM with a -Xmx setting directly and not set -jvmmempc or
42 * -jvmmemmax then this setting will be used and system properties ignored. If
43 * -Xmx is set as well as -jvmmempc or -jvmmemmax as argument(s) then the -Xmx
44 * argument will NOT be passed on to the main application launch.
51 private final static String startClass = "jalview.bin.Jalview";
53 private static boolean checkJVMSymlink(String testBin)
55 File testBinFile = new File(testBin);
56 if (!testBinFile.exists())
60 File targetFile = null;
63 targetFile = testBinFile.getCanonicalFile();
64 } catch (IOException e)
68 if (targetFile != null && ("java".equals(targetFile.getName())
69 || "java.exe".equals(targetFile.getName())))
77 * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with
78 * the same arguments but with memory adjusted based on extracted -jvmmempc
79 * and -jvmmemmax application arguments. If on a Mac then extra dock:icon and
80 * dock:name arguments are also set.
84 public static void main(String[] args)
86 if (!LaunchUtils.checkJavaVersion())
88 System.err.println("WARNING - The Java version being used (Java "
89 + LaunchUtils.getJavaVersion()
90 + ") may lead to problems. This installation of Jalview should be used with Java "
91 + LaunchUtils.getJavaCompileVersion() + ".");
93 final String appName = ChannelProperties.getProperty("app_name");
94 final String javaBinDir = System.getProperty("java.home")
95 + File.separator + "bin" + File.separator;
96 String javaBin = null;
97 if (javaBin == null && checkJVMSymlink(javaBinDir + appName))
99 javaBin = javaBinDir + appName;
101 if (javaBin == null && checkJVMSymlink(javaBinDir + "Jalview"))
103 javaBin = javaBinDir + "Jalview";
110 List<String> command = new ArrayList<>();
111 command.add(javaBin);
113 String memSetting = null;
115 boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
117 for (String jvmArg : ManagementFactory.getRuntimeMXBean()
118 .getInputArguments())
123 command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
125 String jvmmempc = null;
126 String jvmmemmax = null;
127 boolean debug = false;
129 boolean quiet = false;
130 boolean stdout = false;
131 // must set --debug before --launcher...
132 boolean launcherstop = false;
133 boolean launcherprint = false;
134 boolean launcherwait = false;
135 ArrayList<String> arguments = new ArrayList<>();
136 String previousArg = null;
137 for (String arg : args)
139 if (arg.equals("--debug"))
143 if (arg.equals("--quiet"))
147 if (arg.equals("--output=-")
148 || (arg.equals("-") && "--output".equals(previousArg)))
152 if (debug && arg.equals("--launcherprint"))
154 launcherprint = true;
156 if (debug && arg.equals("--launcherstop"))
160 if (debug && arg.equals("--launcherwait"))
164 // this ends the launcher immediately
165 if (debug && arg.equals("--launchernowait"))
170 // Don't add the --launcher... args to Jalview launch
171 if (arg.startsWith("--launcher"))
175 // jvmmempc and jvmmemmax args used to set memory and are not passed on to
178 "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
180 jvmmempc = arg.substring(
181 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
184 else if (arg.startsWith(
185 "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
187 jvmmemmax = arg.substring(
188 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2);
190 // --doubledash versions
191 else if (arg.startsWith("--"
192 + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
194 jvmmempc = arg.substring(
195 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
198 else if (arg.startsWith(
199 "--" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
201 jvmmemmax = arg.substring(
202 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 3);
211 // use saved preferences if no cmdline args
212 boolean useCustomisedSettings = LaunchUtils
213 .getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS);
214 if (useCustomisedSettings)
216 if (jvmmempc == null)
218 jvmmempc = LaunchUtils
219 .getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
221 if (jvmmemmax == null)
223 jvmmemmax = LaunchUtils
224 .getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
228 // add these settings if not already specified
229 boolean memSet = false;
230 boolean dockIcon = false;
231 boolean dockName = false;
232 for (int i = 0; i < command.size(); i++)
234 String arg = command.get(i);
235 if (arg.startsWith("-Xmx"))
237 // only use -Xmx if jvmmemmax and jvmmempc have not been set
238 if (jvmmempc == null && jvmmemmax == null)
244 else if (arg.startsWith("-Xdock:icon"))
248 else if (arg.startsWith("-Xdock:name"))
256 long maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
260 memSetting = "-Xmx" + Long.toString(maxMemLong);
262 command.add(memSetting);
270 String dockIconPath = System.getProperty("getdownappdir", ".")
271 + File.separator + "resource/jalview_logo.png";
272 command.add("-Xdock:icon=" + dockIconPath);
276 // -Xdock:name=... doesn't actually work :(
277 // Leaving it in in case it gets fixed
278 command.add("-Xdock:name=" + appName);
279 // this launches WITHOUT an icon in the macOS dock. Could be useful for
281 // command.add("-Dapple.awt.UIElement=false");
282 // This also does not work for the dock
283 command.add("-Dcom.apple.mrj.application.apple.menu.about.name="
288 String scalePropertyArg = HiDPISetting.getScalePropertyArg();
289 if (scalePropertyArg != null)
291 syserr(debug, quiet, "Running " + startClass + " with scale setting "
293 command.add(scalePropertyArg);
296 command.add(startClass);
297 command.addAll(arguments);
299 final ProcessBuilder builder = new ProcessBuilder(command);
301 if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
305 "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
308 "Running " + startClass + " with "
309 + (memSetting == null ? "no memory setting"
310 : ("memory setting " + memSetting)));
312 if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
313 || (debug && launcherstop))
316 "System property 'launcherstop' is set and not 'false'. Exiting.");
322 Process process = builder.start();
323 if (wait || launcherwait)
325 syserr(debug, quiet, "Launching application process");
332 "Wait time for application process is " + waitInt + "ms");
333 process.waitFor(waitInt, TimeUnit.MILLISECONDS);
335 syserr(debug, quiet, "Launcher process ending");
336 } catch (IOException e)
338 if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
340 System.err.println("Caught a memory exception: " + e.getMessage());
341 // Probably the "Cannot allocate memory" error, try without the memory
343 ArrayList<String> commandNoMem = new ArrayList<>();
344 for (int i = 0; i < command.size(); i++)
346 if (!command.get(i).startsWith("-Xmx"))
348 commandNoMem.add(command.get(i));
351 final ProcessBuilder builderNoMem = new ProcessBuilder(
353 System.err.println("Command without memory setting: "
354 + String.join(" ", builderNoMem.command()));
357 builderNoMem.inheritIO();
358 Process processNoMem = builderNoMem.start();
359 processNoMem.waitFor();
360 } catch (Exception ex)
362 ex.printStackTrace();
369 } catch (Exception e)
375 private static void syserr(boolean debug, boolean quiet, String message)
379 System.err.println("LAUNCHERDEBUG - " + message);