org.eclipse.pde.launching.EclipseApplicationLaunchConfiguration Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2005, 2021 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* EclipseSource Corporation - ongoing enhancements
*******************************************************************************/
package org.eclipse.pde.launching;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.core.variables.IStringVariableManager;
import org.eclipse.core.variables.VariablesPlugin;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.pde.core.plugin.IPluginModelBase;
import org.eclipse.pde.core.plugin.TargetPlatform;
import org.eclipse.pde.internal.core.ClasspathHelper;
import org.eclipse.pde.internal.core.TargetPlatformHelper;
import org.eclipse.pde.internal.core.ifeature.IFeature;
import org.eclipse.pde.internal.core.util.CoreUtility;
import org.eclipse.pde.internal.launching.IPDEConstants;
import org.eclipse.pde.internal.launching.launcher.BundleLauncherHelper;
import org.eclipse.pde.internal.launching.launcher.EclipsePluginValidationOperation;
import org.eclipse.pde.internal.launching.launcher.LaunchArgumentsHelper;
import org.eclipse.pde.internal.launching.launcher.LaunchConfigurationHelper;
import org.eclipse.pde.internal.launching.launcher.LaunchPluginValidator;
import org.eclipse.pde.internal.launching.launcher.LauncherUtils;
import org.eclipse.pde.internal.launching.launcher.RequirementHelper;
/**
* A launch delegate for launching Eclipse applications
*
* Clients may subclass and instantiate this class.
*
*
* This class originally existed in 3.2 as
* org.eclipse.pde.ui.launcher.EclipseApplicationLaunchConfiguration.
*
* @since 3.6
*/
public class EclipseApplicationLaunchConfiguration extends AbstractPDELaunchConfiguration {
static {
RequirementHelper.registerLaunchTypeRequirements(IPDELauncherConstants.ECLIPSE_APPLICATION_LAUNCH_CONFIGURATION_TYPE, lc -> {
if (lc.getAttribute(IPDELauncherConstants.USE_PRODUCT, false)) {
return RequirementHelper.getProductRequirements(lc);
}
String application = lc.getAttribute(IPDELauncherConstants.APPLICATION, TargetPlatform.getDefaultApplication());
if (!IPDEConstants.CORE_TEST_APPLICATION.equals(application)) {
return RequirementHelper.getApplicationRequirements(application);
}
return Collections.emptyList();
});
}
// used to generate the dev classpath entries
// key is bundle ID, value is a List of models
private Map> fAllBundles;
// key is a model, value is startLevel:autoStart
private Map fModels;
/**
* To avoid duplicating variable substitution (and duplicate prompts)
* this variable will store the substituted workspace location.
*/
private String fWorkspaceLocation;
private Map fFeatures;
@Override
public String[] getProgramArguments(ILaunchConfiguration configuration) throws CoreException {
ArrayList programArgs = new ArrayList<>();
// If a product is specified, then add it to the program args
if (configuration.getAttribute(IPDELauncherConstants.USE_PRODUCT, false)) {
String product = configuration.getAttribute(IPDELauncherConstants.PRODUCT, ""); //$NON-NLS-1$
if (product.length() > 0) {
programArgs.add("-product"); //$NON-NLS-1$
programArgs.add(product);
} else { // TODO product w/o an application and product... how to handle gracefully?
programArgs.add("-application"); //$NON-NLS-1$
programArgs.add(configuration.getAttribute(IPDELauncherConstants.APPLICATION, "")); //$NON-NLS-1$
}
} else {
// specify the application to launch
programArgs.add("-application"); //$NON-NLS-1$
programArgs.add(configuration.getAttribute(IPDELauncherConstants.APPLICATION, TargetPlatform.getDefaultApplication()));
}
// specify the workspace location for the runtime workbench
if (fWorkspaceLocation == null) {
fWorkspaceLocation = LaunchArgumentsHelper.getWorkspaceLocation(configuration);
}
if (fWorkspaceLocation.length() > 0) {
programArgs.add("-data"); //$NON-NLS-1$
programArgs.add(fWorkspaceLocation);
}
String productID = LaunchConfigurationHelper.getProductID(configuration);
Properties prop = LaunchConfigurationHelper.createConfigIniFile(configuration, productID, fAllBundles, fFeatures, fModels, getConfigDir(configuration));
boolean showSplash = prop.containsKey("osgi.splashPath") || prop.containsKey("splashLocation"); //$NON-NLS-1$ //$NON-NLS-2$
TargetPlatformHelper.checkPluginPropertiesConsistency(fAllBundles, getConfigDir(configuration));
programArgs.add("-configuration"); //$NON-NLS-1$
programArgs.add("file:" + IPath.fromOSString(getConfigDir(configuration).getPath()).addTrailingSeparator().toString()); //$NON-NLS-1$
// add the output folder names
programArgs.add("-dev"); //$NON-NLS-1$
programArgs.add(ClasspathHelper.getDevEntriesProperties(getConfigDir(configuration).toString() + "/dev.properties", fAllBundles)); //$NON-NLS-1$
String[] args = super.getProgramArguments(configuration);
Collections.addAll(programArgs, args);
if (!programArgs.contains("-nosplash") && showSplash) { //$NON-NLS-1$
if (TargetPlatformHelper.getTargetVersion() >= 3.1) {
programArgs.add(0, "-launcher"); //$NON-NLS-1$
IPath path = null;
if (TargetPlatform.getOS().equals("macosx")) { //$NON-NLS-1$
path = IPath.fromOSString(TargetPlatform.getLocation()).append("Eclipse.app/Contents/MacOS/eclipse"); //$NON-NLS-1$
} else {
path = IPath.fromOSString(TargetPlatform.getLocation()).append("eclipse"); //$NON-NLS-1$
if (TargetPlatform.getOS().equals("win32")) { //$NON-NLS-1$
path = path.addFileExtension("exe"); //$NON-NLS-1$
}
}
programArgs.add(1, path.toOSString()); //This could be the branded launcher if we want (also this does not bring much)
programArgs.add(2, "-name"); //$NON-NLS-1$
programArgs.add(3, "Eclipse"); //This should be the name of the product //$NON-NLS-1$
programArgs.add(4, "-showsplash"); //$NON-NLS-1$
programArgs.add(5, "600"); //$NON-NLS-1$
} else {
programArgs.add(0, "-showsplash"); //$NON-NLS-1$
programArgs.add(1, computeShowsplashArgument());
}
}
return programArgs.toArray(new String[programArgs.size()]);
}
private String computeShowsplashArgument() {
IPath eclipseHome = IPath.fromOSString(TargetPlatform.getLocation());
IPath fullPath = eclipseHome.append("eclipse"); //$NON-NLS-1$
return fullPath.toOSString() + " -showsplash 600"; //$NON-NLS-1$
}
@Override
protected File getConfigDir(ILaunchConfiguration config) {
if (fConfigDir == null) {
fConfigDir = LaunchConfigurationHelper.getConfigurationArea(config);
}
return fConfigDir;
}
/**
* Clears the workspace prior to launching if the workspace exists and the option to
* clear it is turned on. Also clears the configuration area if that option is chosen.
*
* @param configuration
* the launch configuration
* @param monitor
* the progress monitor
* @throws CoreException
* if unable to retrieve launch attribute values or the clear operation was cancelled
* @since 3.3
*/
@Override
protected void clear(ILaunchConfiguration configuration, IProgressMonitor monitor) throws CoreException {
SubMonitor subMon = SubMonitor.convert(monitor, 2);
if (fWorkspaceLocation == null) {
fWorkspaceLocation = LaunchArgumentsHelper.getWorkspaceLocation(configuration);
}
// Clear workspace and prompt, if necessary
LauncherUtils.clearWorkspace(configuration, fWorkspaceLocation, subMon.split(1));
// clear config area, if necessary
if (configuration.getAttribute(IPDELauncherConstants.CONFIG_CLEAR_AREA, false)) {
CoreUtility.deleteContent(getConfigDir(configuration), subMon.split(1));
}
subMon.setWorkRemaining(0);
}
@Override
protected void preLaunchCheck(ILaunchConfiguration configuration, ILaunch launch, IProgressMonitor monitor) throws CoreException {
fWorkspaceLocation = null;
if (configuration.getAttribute(IPDELauncherConstants.GENERATE_PROFILE, false)) {
fFeatures = new HashMap<>();
} else {
fFeatures = null;
}
fModels = BundleLauncherHelper.getMergedBundleMap(configuration, false, fFeatures);
fAllBundles = fModels.keySet().stream().collect(Collectors.groupingBy(m -> m.getPluginBase().getId()));
validateConfigIni(configuration);
super.preLaunchCheck(configuration, launch, monitor);
}
private void validateConfigIni(ILaunchConfiguration configuration) throws CoreException {
if (!configuration.getAttribute(IPDELauncherConstants.CONFIG_GENERATE_DEFAULT, true)) {
String templateLoc = configuration.getAttribute(IPDELauncherConstants.CONFIG_TEMPLATE_LOCATION, ""); //$NON-NLS-1$
IStringVariableManager mgr = VariablesPlugin.getDefault().getStringVariableManager();
templateLoc = mgr.performStringSubstitution(templateLoc);
File templateFile = new File(templateLoc);
if (!templateFile.exists()) {
if (!LauncherUtils.generateConfigIni())
throw new CoreException(Status.CANCEL_STATUS);
// with the way the launcher works, if a config.ini file is not found one will be generated automatically.
// This check was to warn the user a config.ini needs to be generated. - bug 161265, comment #7
}
}
}
@Override
protected void validatePluginDependencies(ILaunchConfiguration configuration, IProgressMonitor monitor) throws CoreException {
EclipsePluginValidationOperation op = new EclipsePluginValidationOperation(configuration, fModels.keySet());
LaunchPluginValidator.runValidationOperation(op, monitor);
}
@Override
public String[] getVMArguments(ILaunchConfiguration configuration) throws CoreException {
String[] vmArgs = super.getVMArguments(configuration);
// necessary for PDE to know how to load plugins when target platform = host platform
// see PluginPathFinder.getPluginPaths() and PluginPathFinder.isDevLaunchMode()
return Stream.concat(Arrays.stream(vmArgs), Stream.of("-Declipse.pde.launch=true")).toArray(String[]::new); //$NON-NLS-1$
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy