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";
105 if (javaBin == null && checkJVMSymlink(javaBinDir + "java"))
107 javaBin = javaBinDir + "java";
114 List<String> command = new ArrayList<>();
115 command.add(javaBin);
117 String memSetting = null;
119 boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
121 for (String jvmArg : ManagementFactory.getRuntimeMXBean()
122 .getInputArguments())
127 command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
129 String jvmmempc = null;
130 String jvmmemmax = null;
131 boolean debug = false;
133 boolean quiet = false;
134 // must set --debug before --launcher...
135 boolean launcherstop = false;
136 boolean launcherprint = false;
137 boolean launcherwait = false;
138 ArrayList<String> arguments = new ArrayList<>();
139 for (String arg : args)
141 if (arg.equals("--debug"))
145 if (arg.equals("--quiet"))
149 if (debug && arg.equals("--launcherprint"))
151 launcherprint = true;
153 if (debug && arg.equals("--launcherstop"))
157 if (debug && arg.equals("--launcherwait"))
161 // this ends the launcher immediately
162 if (debug && arg.equals("--launchernowait"))
166 // Don't add the --launcher... args to Jalview launch
167 if (arg.startsWith("--launcher"))
171 // jvmmempc and jvmmemmax args used to set memory and are not passed on to
174 "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
176 jvmmempc = arg.substring(
177 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
180 else if (arg.startsWith(
181 "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
183 jvmmemmax = arg.substring(
184 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2);
186 // --doubledash versions
187 else if (arg.startsWith("--"
188 + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
190 jvmmempc = arg.substring(
191 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
194 else if (arg.startsWith(
195 "--" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
197 jvmmemmax = arg.substring(
198 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 3);
207 // use saved preferences if no cmdline args
208 boolean useCustomisedSettings = LaunchUtils
209 .getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS);
210 if (useCustomisedSettings)
212 if (jvmmempc == null)
214 jvmmempc = LaunchUtils
215 .getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
217 if (jvmmemmax == null)
219 jvmmemmax = LaunchUtils
220 .getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
224 // add these settings if not already specified
225 boolean memSet = false;
226 boolean dockIcon = false;
227 boolean dockName = false;
228 for (int i = 0; i < command.size(); i++)
230 String arg = command.get(i);
231 if (arg.startsWith("-Xmx"))
233 // only use -Xmx if jvmmemmax and jvmmempc have not been set
234 if (jvmmempc == null && jvmmemmax == null)
240 else if (arg.startsWith("-Xdock:icon"))
244 else if (arg.startsWith("-Xdock:name"))
252 long maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
256 memSetting = "-Xmx" + Long.toString(maxMemLong);
258 command.add(memSetting);
266 String dockIconPath = System.getProperty("getdownappdir", ".")
267 + File.separator + "resource/jalview_logo.png";
268 command.add("-Xdock:icon=" + dockIconPath);
272 // -Xdock:name=... doesn't actually work :(
273 // Leaving it in in case it gets fixed
274 command.add("-Xdock:name=" + appName);
275 // this launches WITHOUT an icon in the macOS dock. Could be useful for
277 // command.add("-Dapple.awt.UIElement=false");
278 // This also does not work for the dock
279 command.add("-Dcom.apple.mrj.application.apple.menu.about.name="
284 String scalePropertyArg = HiDPISetting.getScalePropertyArg();
285 if (scalePropertyArg != null)
287 sysout(debug, quiet, "Running " + startClass + " with scale setting "
289 command.add(scalePropertyArg);
292 command.add(startClass);
293 command.addAll(arguments);
295 final ProcessBuilder builder = new ProcessBuilder(command);
297 if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
301 "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
304 "Running " + startClass + " with "
305 + (memSetting == null ? "no memory setting"
306 : ("memory setting " + memSetting)));
308 if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
309 || (debug && launcherstop))
312 "System property 'launcherstop' is set and not 'false'. Exiting.");
318 Process process = builder.start();
319 if (wait || launcherwait)
321 sysout(debug, quiet, "Launching application process");
328 "Wait time for application process is " + waitInt + "ms");
329 process.waitFor(waitInt, TimeUnit.MILLISECONDS);
331 sysout(debug, quiet, "Launcher process ending");
332 } catch (IOException e)
334 if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
336 System.err.println("Caught a memory exception: " + e.getMessage());
337 // Probably the "Cannot allocate memory" error, try without the memory
339 ArrayList<String> commandNoMem = new ArrayList<>();
340 for (int i = 0; i < command.size(); i++)
342 if (!command.get(i).startsWith("-Xmx"))
344 commandNoMem.add(command.get(i));
347 final ProcessBuilder builderNoMem = new ProcessBuilder(
349 System.err.println("Command without memory setting: "
350 + String.join(" ", builderNoMem.command()));
353 builderNoMem.inheritIO();
354 Process processNoMem = builderNoMem.start();
355 processNoMem.waitFor();
356 } catch (Exception ex)
358 ex.printStackTrace();
365 } catch (Exception e)
371 private static void sysout(boolean debug, boolean quiet, String message)
375 System.out.println("LAUNCHERDEBUG - " + message);