Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean-up LaunchManager attempt 2 #1618

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clean-up LaunchManager attempt 2 #1618

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c95b821
Clean-up and modernize eclipse debug LaunchManager
HannesWell Nov 14, 2024
0d45dcf
Make LaunchManager's IResourceDeltaVisitors more light weight
HannesWell Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
230 changes: 80 additions & 150 deletions debug/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2000, 2022 IBM Corporation and others.
* Copyright (c) 2000, 2024 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
Expand Down Expand Up @@ -38,8 +38,8 @@
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
Expand All @@ -64,7 +64,6 @@
import org.eclipse.core.resources.IResourceChangeListener;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.IResourceProxy;
import org.eclipse.core.resources.IResourceProxyVisitor;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
Expand Down Expand Up @@ -307,79 +306,6 @@ public void run() throws Exception {
}
}

/**
* Visitor for handling a resource begin deleted, and the need to check mapped configurations
* for auto-deletion
* @since 3.4
*/
class MappedResourceVisitor implements IResourceDeltaVisitor {

@Override
public boolean visit(IResourceDelta delta) throws CoreException {
if (0 != (delta.getFlags() & IResourceDelta.OPEN)) {
return false;
}
if(delta.getKind() == IResourceDelta.REMOVED && delta.getFlags() != IResourceDelta.MOVED_TO) {
ArrayList<ILaunchConfiguration> configs = collectAssociatedLaunches(delta.getResource());
for (ILaunchConfiguration config : configs) {
try {
config.delete();
} catch (CoreException e) {
DebugPlugin.log(e.getStatus());
}
}
return false;
}
return true;
}
}

/**
* Visitor for handling resource deltas.
*/
class LaunchManagerVisitor implements IResourceDeltaVisitor {

@Override
public boolean visit(IResourceDelta delta) {
if (delta == null) {
return false;
}
if (0 != (delta.getFlags() & IResourceDelta.OPEN)) {
if (delta.getResource() instanceof IProject) {
IProject project = (IProject)delta.getResource();
if (project.isOpen()) {
LaunchManager.this.projectOpened(project);
} else {
LaunchManager.this.projectClosed(project);
}
}
return false;
}
IResource resource = delta.getResource();
if (resource instanceof IFile) {
IFile file = (IFile)resource;
if (ILaunchConfiguration.LAUNCH_CONFIGURATION_FILE_EXTENSION.equals(file.getFileExtension()) || ILaunchConfiguration.LAUNCH_CONFIGURATION_PROTOTYPE_FILE_EXTENSION.equals(file.getFileExtension())) {
ILaunchConfiguration handle = new LaunchConfiguration(file);
switch (delta.getKind()) {
case IResourceDelta.ADDED :
LaunchManager.this.launchConfigurationAdded(handle);
break;
case IResourceDelta.REMOVED :
LaunchManager.this.launchConfigurationDeleted(handle);
break;
case IResourceDelta.CHANGED :
LaunchManager.this.launchConfigurationChanged(handle);
break;
default:
break;
}
}
return false;
}
return true;
}
}

/**
* Notifies a launch listener (single launch) in a safe runnable to handle
* exceptions.
Expand Down Expand Up @@ -433,30 +359,6 @@ public void run() throws Exception {
}
}

/**
* Collects files whose extension matches the launch configuration file
* extension.
*/
static class ResourceProxyVisitor implements IResourceProxyVisitor {

private final List<IResource> fList;

protected ResourceProxyVisitor(List<IResource> list) {
fList= list;
}

@Override
public boolean visit(IResourceProxy proxy) {
if (proxy.getType() == IResource.FILE) {
if (ILaunchConfiguration.LAUNCH_CONFIGURATION_FILE_EXTENSION.equalsIgnoreCase(proxy.requestFullPath().getFileExtension()) || ILaunchConfiguration.LAUNCH_CONFIGURATION_PROTOTYPE_FILE_EXTENSION.equalsIgnoreCase(proxy.requestFullPath().getFileExtension())) {
fList.add(proxy.requestResource());
}
return false;
}
return true;
}
}

/**
* Internal class used to hold information about a preferred delegate
*
Expand Down Expand Up @@ -627,11 +529,49 @@ public static String serializeDocument(Document doc, String lineDelimiter) throw
*/
private ListenerList<ILaunchesListener> fLaunchesListeners = new ListenerList<>();

private static final Set<String> LAUNCH_CONFIG_FILE_EXTENSIONS = Set.of( //
ILaunchConfiguration.LAUNCH_CONFIGURATION_FILE_EXTENSION, //
ILaunchConfiguration.LAUNCH_CONFIGURATION_PROTOTYPE_FILE_EXTENSION);

/**
* Visitor used to process resource deltas,
* to update launch configuration index.
*/
private LaunchManagerVisitor fgVisitor;
private final IResourceDeltaVisitor fLaunchManagerVisitor = delta -> {
if (delta == null) {
return false;
}
if (0 != (delta.getFlags() & IResourceDelta.OPEN)) {
if (delta.getFullPath().segmentCount() == 1 && delta.getResource() instanceof IProject project) {
if (project.isOpen()) {
LaunchManager.this.projectOpened(project);
} else {
LaunchManager.this.projectClosed(project);
}
}
return false;
}
if (LAUNCH_CONFIG_FILE_EXTENSIONS.contains(delta.getFullPath().getFileExtension())) {
if (delta.getResource() instanceof IFile file) {
ILaunchConfiguration handle = new LaunchConfiguration(file);
switch (delta.getKind()) {
case IResourceDelta.ADDED:
LaunchManager.this.launchConfigurationAdded(handle);
break;
case IResourceDelta.REMOVED:
LaunchManager.this.launchConfigurationDeleted(handle);
break;
case IResourceDelta.CHANGED:
LaunchManager.this.launchConfigurationChanged(handle);
break;
default:
break;
}
}
return false;
}
return true;
};

/**
* Visitor used to process a deleted resource,
Expand All @@ -640,7 +580,23 @@ public static String serializeDocument(Document doc, String lineDelimiter) throw
*
* @since 3.4
*/
private MappedResourceVisitor fgMRVisitor;
private final IResourceDeltaVisitor fMappedResourceVisitor = delta -> {
if (0 != (delta.getFlags() & IResourceDelta.OPEN)) {
return false;
}
if (delta.getKind() == IResourceDelta.REMOVED && delta.getFlags() != IResourceDelta.MOVED_TO) {
List<ILaunchConfiguration> configs = collectAssociatedLaunches(delta.getResource());
for (ILaunchConfiguration config : configs) {
try {
config.delete();
} catch (CoreException e) {
DebugPlugin.log(e.getStatus());
}
}
return false;
}
return true;
};

/**
* Whether this manager is listening for resource change events
Expand Down Expand Up @@ -842,7 +798,16 @@ protected List<ILaunchConfiguration> findLaunchConfigurations(IContainer contain
return Collections.emptyList();
}
List<IResource> list = new ArrayList<>(10);
ResourceProxyVisitor visitor= new ResourceProxyVisitor(list);
IResourceProxyVisitor visitor = proxy -> {
if (proxy.getType() == IResource.FILE) {
String fileExtension = proxy.requestFullPath().getFileExtension();
if (LAUNCH_CONFIG_FILE_EXTENSIONS.contains(fileExtension.toLowerCase(Locale.ENGLISH))) {
list.add(proxy.requestResource());
}
return false;
}
return true;
};
try {
container.accept(visitor, IResource.NONE);
} catch (CoreException ce) {
Expand Down Expand Up @@ -1129,31 +1094,6 @@ public IDebugTarget[] getDebugTargets() {
}
}

/**
* Returns the resource delta visitor for the launch manager.
*
* @return the resource delta visitor for the launch manager
*/
private LaunchManagerVisitor getDeltaVisitor() {
if (fgVisitor == null) {
fgVisitor= new LaunchManagerVisitor();
}
return fgVisitor;
}

/**
* Returns the resource delta visitor for auto-removal of mapped launch configurations
* @return the resource delta visitor for auto-removal of mapped launch configurations
*
* @since 3.4
*/
private MappedResourceVisitor getMappedResourceVisitor() {
if(fgMRVisitor == null) {
fgMRVisitor = new MappedResourceVisitor();
}
return fgMRVisitor;
}

@Override
public String[] getEnvironment(ILaunchConfiguration configuration) throws CoreException {
Map<String, String> configEnv = configuration.getAttribute(ATTR_ENVIRONMENT_VARIABLES, (Map<String, String>) null);
Expand Down Expand Up @@ -1314,9 +1254,7 @@ public ILaunchConfiguration[] getLaunchConfigurations(int kinds) {
return allConfigs.toArray(new ILaunchConfiguration[allConfigs.size()]);
} else {
List<ILaunchConfiguration> select = new ArrayList<>(allConfigs.size());
Iterator<ILaunchConfiguration> iterator = allConfigs.iterator();
while (iterator.hasNext()) {
ILaunchConfiguration config = iterator.next();
for (ILaunchConfiguration config : allConfigs) {
try {
if ((config.getKind() & kinds) > 0) {
select.add(config);
Expand Down Expand Up @@ -1499,19 +1437,16 @@ private synchronized void initializePreferredDelegates() {
try {
Element root = DebugPlugin.parseDocument(preferred);
NodeList nodes = root.getElementsByTagName(IConfigurationElementConstants.DELEGATE);
Element element = null;
String typeid = null;
Set<String> modeset = null;
for(int i = 0; i < nodes.getLength(); i++) {
element = (Element) nodes.item(i);
Element element = (Element) nodes.item(i);
String delegateid = element.getAttribute(IConfigurationElementConstants.ID);
typeid = element.getAttribute(IConfigurationElementConstants.TYPE_ID);
String typeid = element.getAttribute(IConfigurationElementConstants.TYPE_ID);
String[] modes = element.getAttribute(IConfigurationElementConstants.MODES).split(","); //$NON-NLS-1$
modeset = new HashSet<>(Arrays.asList(modes));
Set<String> modeset = new HashSet<>(Arrays.asList(modes));
LaunchDelegate delegate = getLaunchDelegateExtension(typeid, delegateid, modeset);
if (delegate != null) {
//take type id, modeset, delegate and create entry
if(!IInternalDebugCoreConstants.EMPTY_STRING.equals(typeid) && modeset != null) {
if (!typeid.isEmpty() && modeset != null) {
fPreferredDelegates.add(new PreferredDelegate(delegate, typeid, modeset));
}
}
Expand Down Expand Up @@ -2126,15 +2061,11 @@ public void removeLaunchListener(ILaunchListener listener) {
public void resourceChanged(IResourceChangeEvent event) {
IResourceDelta delta = event.getDelta();
if (delta != null) {
LaunchManagerVisitor visitor = getDeltaVisitor();
MappedResourceVisitor v = null;
if (isDeleteConfigurations()) {
v = getMappedResourceVisitor();
}
try {
delta.accept(visitor);
if (v != null) {
delta.accept(v);
boolean deleteConfigurations = isDeleteConfigurations();
delta.accept(fLaunchManagerVisitor);
if (deleteConfigurations) {
delta.accept(fMappedResourceVisitor);
}
} catch (CoreException e) {
DebugPlugin.log(e.getStatus());
Expand All @@ -2150,14 +2081,13 @@ public void resourceChanged(IResourceChangeEvent event) {
* @param resource the resource to collect launch configurations for
* @return the list of associated launch configurations
*/
private ArrayList<ILaunchConfiguration> collectAssociatedLaunches(IResource resource) {
ArrayList<ILaunchConfiguration> list = new ArrayList<>();
private static List<ILaunchConfiguration> collectAssociatedLaunches(IResource resource) {
List<ILaunchConfiguration> list = new ArrayList<>();
try {
ILaunchConfiguration[] configs = DebugPlugin.getDefault().getLaunchManager().getLaunchConfigurations();
IResource[] resources = null;
for (ILaunchConfiguration config : configs) {
if(config.isLocal()) {
resources = config.getMappedResources();
IResource[] resources = config.getMappedResources();
if(resources != null) {
for (IResource res : resources) {
if(resource.equals(res) ||
Expand Down
Loading