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;
29 import jalview.util.ChannelProperties;
30 import jalview.util.LaunchUtils;
33 * A Launcher class for Jalview. This class is used to launch Jalview from the
34 * shadowJar when Getdown is not used or available. It attempts to take all the
35 * command line arguments to pass on to the jalview.bin.Jalview class, but to
36 * insert a -Xmx memory setting to a sensible default, using the -jvmmempc and
37 * -jvmmemmax application arguments if specified. If not specified then system
38 * properties will be looked for by jalview.bin.MemorySetting. If the user has
39 * provided the JVM with a -Xmx setting directly and not set -jvmmempc or
40 * -jvmmemmax then this setting will be used and system properties ignored. If
41 * -Xmx is set as well as -jvmmempc or -jvmmemmax as argument(s) then the -Xmx
42 * argument will NOT be passed on to the main application launch.
49 private final static String startClass = "jalview.bin.Jalview";
51 private final static String dockIconPath = ChannelProperties
52 .getProperty("logo.512");
55 * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with
56 * the same arguments but with memory adjusted based on extracted -jvmmempc
57 * and -jvmmemmax application arguments. If on a Mac then extra dock:icon and
58 * dock:name arguments are also set.
62 public static void main(String[] args)
64 final String javaBin = System.getProperty("java.home") + File.separator
65 + "bin" + File.separator + "java";
67 List<String> command = new ArrayList<>();
70 String memSetting = null;
72 boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
74 for (String jvmArg : ManagementFactory.getRuntimeMXBean()
80 command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
82 String jvmmempc = null;
83 String jvmmemmax = null;
84 ArrayList<String> arguments = new ArrayList<>();
85 for (String arg : args)
87 // jvmmempc and jvmmemmax args used to set memory and are not passed on to
90 "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
92 jvmmempc = arg.substring(
93 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
96 else if (arg.startsWith(
97 "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
99 jvmmemmax = arg.substring(
100 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2);
108 // use saved preferences if no cmdline args
109 boolean useCustomisedSettings = LaunchUtils
110 .getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS);
111 if (useCustomisedSettings)
113 if (jvmmempc == null)
115 jvmmempc = LaunchUtils
116 .getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
118 if (jvmmemmax == null)
120 jvmmemmax = LaunchUtils
121 .getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
125 // add memory setting if not specified
126 boolean memSet = false;
127 boolean dockIcon = false;
128 boolean dockName = false;
129 for (int i = 0; i < command.size(); i++)
131 String arg = command.get(i);
132 if (arg.startsWith("-Xmx"))
134 // only use -Xmx if jvmmemmax and jvmmempc have not been set
135 if (jvmmempc == null && jvmmemmax == null)
141 else if (arg.startsWith("-Xdock:icon"))
145 else if (arg.startsWith("-Xdock:name"))
153 long maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
157 memSetting = "-Xmx" + Long.toString(maxMemLong);
159 command.add(memSetting);
167 command.add("-Xdock:icon=" + dockIconPath);
171 // -Xdock:name=... doesn't actually work :(
172 // Leaving it in in case it gets fixed
174 "-Xdock:name=" + ChannelProperties.getProperty("app_name"));
178 String scalePropertyArg = HiDPISetting.getScalePropertyArg();
179 if (scalePropertyArg != null)
181 System.out.println("Running " + startClass + " with scale setting "
183 command.add(scalePropertyArg);
186 command.add(startClass);
187 command.addAll(arguments);
189 final ProcessBuilder builder = new ProcessBuilder(command);
191 if (Boolean.parseBoolean(System.getProperty("launcherprint", "false")))
194 "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
196 System.out.println("Running " + startClass + " with "
197 + (memSetting == null ? "no memory setting"
198 : ("memory setting " + memSetting)));
200 if (Boolean.parseBoolean(System.getProperty("launcherstop", "false")))
207 Process process = builder.start();
209 } catch (IOException e)
211 if (e.getMessage().toLowerCase().contains("memory"))
213 System.out.println("Caught a memory exception: " + e.getMessage());
214 // Probably the "Cannot allocate memory" error, try without the memory
216 ArrayList<String> commandNoMem = new ArrayList<>();
217 for (int i = 0; i < command.size(); i++)
219 if (!command.get(i).startsWith("-Xmx"))
221 commandNoMem.add(command.get(i));
224 final ProcessBuilder builderNoMem = new ProcessBuilder(
226 System.out.println("Command without memory setting: "
227 + String.join(" ", builderNoMem.command()));
230 builderNoMem.inheritIO();
231 Process processNoMem = builderNoMem.start();
232 processNoMem.waitFor();
233 } catch (Exception ex)
235 ex.printStackTrace();
242 } catch (Exception e)