Merge branch 'eclipse-pde:master' into master

apitools/org.eclipse.pde.api.tools/forceQualifierUpdate.txt

@@ -7,4 +7,5 @@ https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/issues/11
 Comparator errors in I20230906-0400
 https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/issues/1378
 https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/issues/1781
-https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/issues/1923
+https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/issues/1923
+Comparator errors in I20241106-1800/ - Expected due to https://github.com/eclipse-jdt/eclipse.jdt.core/pull/3254

org.eclipse.pde.doc.user/forceQualifierUpdate.txt

@@ -7,3 +7,4 @@ Add missing reference/api content
 Pick-up javadoc changes
 https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/pull/2396
 Touch for build JVM change causing using newer jquery
+Add new TargetEvents constants

ui/org.eclipse.pde.core/.settings/.api_filters

@@ -1,5 +1,27 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <component id="org.eclipse.pde.core" version="2">
+    <resource path="META-INF/MANIFEST.MF">
+        <filter id="926941240">
+            <message_arguments>
+                <message_argument value="3.20.0"/>
+                <message_argument value="3.19.0"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="src/org/eclipse/pde/core/target/TargetEvents.java" type="org.eclipse.pde.core.target.TargetEvents">
+        <filter id="336658481">
+            <message_arguments>
+                <message_argument value="org.eclipse.pde.core.target.TargetEvents"/>
+                <message_argument value="TOPIC_TARGET_DELETED"/>
+            </message_arguments>
+        </filter>
+        <filter id="336658481">
+            <message_arguments>
+                <message_argument value="org.eclipse.pde.core.target.TargetEvents"/>
+                <message_argument value="TOPIC_TARGET_SAVED"/>
+            </message_arguments>
+        </filter>
+    </resource>
     <resource path="src/org/eclipse/pde/internal/core/project/BundleProjectService.java" type="org.eclipse.pde.internal.core.project.BundleProjectService">
         <filter comment="Platform Team allows use of bundle importers for PDE import from source repository" id="640712815">
             <message_arguments>

ui/org.eclipse.pde.core/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %name
 Bundle-SymbolicName: org.eclipse.pde.core; singleton:=true
-Bundle-Version: 3.19.100.qualifier
+Bundle-Version: 3.20.0.qualifier
 Bundle-Activator: org.eclipse.pde.internal.core.PDECore
 Bundle-Vendor: %provider-name
 Bundle-Localization: plugin
@@ -101,6 +101,7 @@ Import-Package: aQute.bnd.build;version="[4.4.0,5.0.0)",
  org.eclipse.equinox.internal.p2.publisher.eclipse,
  org.eclipse.equinox.p2.publisher,
  org.eclipse.equinox.p2.publisher.eclipse,
+ org.osgi.service.event;version="[1.4.0,2.0.0)",
  org.osgi.service.repository;version="[1.1.0,2.0.0)",
  org.osgi.util.promise;version="[1.3.0,2.0.0)"
 Require-Bundle: 

ui/org.eclipse.pde.core/src/org/eclipse/pde/core/target/TargetEvents.java

@@ -12,28 +12,84 @@
  ********************************************************************************/
 package org.eclipse.pde.core.target;
 
+import org.eclipse.e4.core.services.events.IEventBroker;
+import org.osgi.service.event.Event;
+import org.osgi.service.event.EventHandler;
+
 /**
- * Target events and event topic definitions
+ * Target events and event topic definitions.
+ *
+ * <p>
+ * The following code is an example of to subscribe to the
+ * {@link #TOPIC_TARGET_SAVED} event:
+ * </p>
+ *
+ * <pre>
+ * EventHandler eventHandler = event -> {
+ * 	if (event.getProperty(IEventBroker.DATA) instanceof ITargetHandle handle) {
+ * 		// Work with the target handle...
+ * 	}
+ * };
+ * IEclipseContext context = EclipseContextFactory.getServiceContext(bundleContext);
+ * IEventBroker broker = context.get(IEventBroker.class);
+ * if (broker != null) {
+ * 	broker.subscribe(TargetEvents.TOPIC_TARGET_SAVED, eventHandler);
+ * 	// Do not forget to unsubscribe later!
+ * }
+ * </pre>
  *
+ * @see ITargetPlatformService
+ * @see IEventBroker#subscribe(String, EventHandler)
+ * @see IEventBroker#subscribe(String, String, EventHandler, boolean)
+ * @see IEventBroker#unsubscribe(EventHandler)
  * @since 3.13
  */
 public class TargetEvents {
 
 	/**
-	 * Base topic for all Target events
+	 * Base topic for all target events.
 	 */
 	public static final String TOPIC_BASE = "org/eclipse/pde/core/target/TargetEvents"; //$NON-NLS-1$
 
 	/**
-	 * Topic for all Target events
+	 * Topic for all target events.
 	 */
 	public static final String TOPIC_ALL = TOPIC_BASE + "/*"; //$NON-NLS-1$
 
 	/**
-	 * Sent when workspace target definition is changed
+	 * Sent when workspace target definition is changed.
+	 * <p>
+	 * The {@link IEventBroker#DATA data} {@link Event#getProperty(String) event
+	 * property} of events with this topic is the changed
+	 * {@link ITargetDefinition}.
+	 * </p>
 	 *
 	 * @see ITargetPlatformService#getWorkspaceTargetDefinition()
 	 */
 	public static final String TOPIC_WORKSPACE_TARGET_CHANGED = TOPIC_BASE + "/workspaceTargetChanged"; //$NON-NLS-1$
 
+	/**
+	 * Sent when a target is saved.
+	 * <p>
+	 * The {@link IEventBroker#DATA data} {@link Event#getProperty(String) event
+	 * property} of events with this topic is the saved {@link ITargetHandle}.
+	 * </p>
+	 *
+	 * @see ITargetPlatformService#saveTargetDefinition(ITargetDefinition)
+	 * @see IEventBroker
+	 * @since 3.20
+	 */
+	public static final String TOPIC_TARGET_SAVED = TOPIC_BASE + "/targetSaved"; //$NON-NLS-1$
+
+	/**
+	 * Sent when a target is deleted.
+	 * <p>
+	 * The {@link IEventBroker#DATA data} {@link Event#getProperty(String) event
+	 * property} of events with this topic is the deleted {@link ITargetHandle}.
+	 * </p>
+	 *
+	 * @see ITargetPlatformService#deleteTarget(ITargetHandle)
+	 * @since 3.20
+	 */
+	public static final String TOPIC_TARGET_DELETED = TOPIC_BASE + "/targetDeleted"; //$NON-NLS-1$
 }

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/AbstractTargetHandle.java

@@ -20,6 +20,7 @@
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.pde.core.target.ITargetDefinition;
 import org.eclipse.pde.core.target.ITargetHandle;
+import org.eclipse.pde.core.target.TargetEvents;
 
 /**
  * Common implementation of target handles.
@@ -53,11 +54,16 @@ public ITargetDefinition getTargetDefinition() throws CoreException {
 	 */
 	abstract void delete() throws CoreException;
 
+	public final void save(ITargetDefinition definition) throws CoreException {
+		doSave(definition);
+		TargetPlatformService.scheduleEvent(TargetEvents.TOPIC_TARGET_SAVED, definition.getHandle());
+	}
+
 	/**
 	 * Saves the definition to underlying storage.
 	 *
 	 * @param definition target to save
 	 * @throws CoreException on failure
 	 */
-	abstract void save(ITargetDefinition definition) throws CoreException;
+	abstract void doSave(ITargetDefinition definition) throws CoreException;
 }

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/ExternalFileTargetHandle.java

@@ -81,7 +81,7 @@ protected InputStream getInputStream() throws CoreException {
 
 
 	@Override
-	void save(ITargetDefinition definition) throws CoreException {
+	void doSave(ITargetDefinition definition) throws CoreException {
 		try (OutputStream stream = new BufferedOutputStream(new FileOutputStream(fFile))) {
 			((TargetDefinition) definition).write(stream);
 		} catch (IOException e) {

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/LocalTargetHandle.java

@@ -193,7 +193,7 @@ protected OutputStream getOutputStream() throws CoreException {
 	}
 
 	@Override
-	void save(ITargetDefinition definition) throws CoreException {
+	void doSave(ITargetDefinition definition) throws CoreException {
 		try (OutputStream stream = getOutputStream()) {
 			((TargetDefinition) definition).write(stream);
 		} catch (IOException e) {

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/TargetPlatformService.java

@@ -33,18 +33,14 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
-import java.util.concurrent.ConcurrentLinkedQueue;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IResource;
-import org.eclipse.core.resources.IResourceProxy;
-import org.eclipse.core.resources.IResourceProxyVisitor;
 import org.eclipse.core.resources.ResourcesPlugin;
-import org.eclipse.core.runtime.Assert;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IConfigurationElement;
 import org.eclipse.core.runtime.IPath;
@@ -100,44 +96,14 @@ public class TargetPlatformService implements ITargetPlatformService {
 	 * The target definition currently being used as the target platform for
 	 * the workspace.
 	 */
-	private final AtomicReference<ITargetDefinition> fWorkspaceTarget;
+	private final AtomicReference<ITargetDefinition> fWorkspaceTarget = new AtomicReference<>();
 
 	/**
 	 * vm arguments for default target
 	 */
 	private StringBuilder fVMArguments;
 
-	private final EventDispatcher eventSendingJob;
-
-	/**
-	 * Collects target files in the workspace
-	 */
-	static class ResourceProxyVisitor implements IResourceProxyVisitor {
-
-		private final List<IResource> fList;
-
-		protected ResourceProxyVisitor(List<IResource> list) {
-			fList = list;
-		}
-
-		/**
-		 * @see org.eclipse.core.resources.IResourceProxyVisitor#visit(org.eclipse.core.resources.IResourceProxy)
-		 */
-		@Override
-		public boolean visit(IResourceProxy proxy) {
-			if (proxy.getType() == IResource.FILE) {
-				if (ICoreConstants.TARGET_FILE_EXTENSION.equalsIgnoreCase(IPath.fromOSString(proxy.getName()).getFileExtension())) {
-					fList.add(proxy.requestResource());
-				}
-				return false;
-			}
-			return true;
-		}
-	}
-
 	private TargetPlatformService() {
-		fWorkspaceTarget = new AtomicReference<>();
-		eventSendingJob = new EventDispatcher("Sending 'workspace target changed' event", TargetPlatformService.class); //$NON-NLS-1$
 	}
 
 	/**
@@ -160,6 +126,7 @@ public void deleteTarget(ITargetHandle handle) throws CoreException {
 		}
 		((AbstractTargetHandle) handle).delete();
 		TargetPlatformHelper.getTargetDefinitionMap().remove(handle);
+		scheduleEvent(TargetEvents.TOPIC_TARGET_DELETED, handle);
 	}
 
 	@Override
@@ -271,21 +238,23 @@ private List<ITargetHandle> findLocalTargetDefinitions() {
 	 * @return all target definition handles in the workspace
 	 */
 	private List<WorkspaceFileTargetHandle> findWorkspaceTargetDefinitions() {
-		List<IResource> files = new ArrayList<>(10);
-		ResourceProxyVisitor visitor = new ResourceProxyVisitor(files);
+		List<IFile> files = new ArrayList<>(10);
 		try {
-			ResourcesPlugin.getWorkspace().getRoot().accept(visitor, IResource.NONE);
+			ResourcesPlugin.getWorkspace().getRoot().accept(proxy -> {
+				if (proxy.getType() == IResource.FILE) {
+					if (ICoreConstants.TARGET_FILE_EXTENSION
+							.equalsIgnoreCase(IPath.fromOSString(proxy.getName()).getFileExtension())) {
+						files.add((IFile) proxy.requestResource());
+					}
+					return false;
+				}
+				return true;
+			}, IResource.NONE);
 		} catch (CoreException e) {
 			PDECore.log(e);
-			return new ArrayList<>(0);
+			return List.of();
 		}
-		Iterator<IResource> iter = files.iterator();
-		List<WorkspaceFileTargetHandle> handles = new ArrayList<>(files.size());
-		while (iter.hasNext()) {
-			IFile file = (IFile) iter.next();
-			handles.add(new WorkspaceFileTargetHandle(file));
-		}
-		return handles;
+		return files.stream().map(WorkspaceFileTargetHandle::new).toList();
 	}
 
 	@Override
@@ -361,71 +330,24 @@ public synchronized ITargetDefinition getWorkspaceTargetDefinition() throws Core
 	 */
 	public void setWorkspaceTargetDefinition(ITargetDefinition target, boolean asyncEvents) {
 		ITargetDefinition oldTarget = fWorkspaceTarget.getAndSet(target);
-		boolean changed = !Objects.equals(oldTarget, target);
-		if (changed) {
-			if (asyncEvents) {
-				eventSendingJob.schedule(target);
-			} else {
-				notifyTargetChanged(target);
-			}
+		if (!Objects.equals(oldTarget, target)) {
+			notifyEvent(TargetEvents.TOPIC_WORKSPACE_TARGET_CHANGED, target, asyncEvents);
 		}
 	}
 
-	static void notifyTargetChanged(ITargetDefinition target) {
+	public static void scheduleEvent(String topic, Object data) {
+		notifyEvent(topic, data, true);
+	}
+
+	private static void notifyEvent(String topic, Object data, boolean asyncEvents) {
 		IEclipseContext context = EclipseContextFactory.getServiceContext(PDECore.getDefault().getBundleContext());
 		IEventBroker broker = context.get(IEventBroker.class);
 		if (broker != null) {
-			broker.send(TargetEvents.TOPIC_WORKSPACE_TARGET_CHANGED, target);
-		}
-	}
-
-	static class EventDispatcher extends Job {
-
-		private final ConcurrentLinkedQueue<ITargetDefinition> queue;
-		private final Object myFamily;
-
-		/**
-		 * @param jobName
-		 *            descriptive job name
-		 * @param family
-		 *            non null object to control this job execution
-		 **/
-		public EventDispatcher(String jobName, Object family) {
-			super(jobName);
-			Assert.isNotNull(family);
-			this.myFamily = family;
-			this.queue = new ConcurrentLinkedQueue<>();
-			setSystem(true);
-		}
-
-		@Override
-		public boolean belongsTo(Object family) {
-			return myFamily == family;
-		}
-
-		@Override
-		protected IStatus run(IProgressMonitor monitor) {
-			ITargetDefinition target;
-			while ((target = queue.poll()) != null && !monitor.isCanceled()) {
-				notifyTargetChanged(target);
-			}
-			if (!queue.isEmpty() && !monitor.isCanceled()) {
-				// in case actions got faster scheduled then processed
-				schedule();
-			}
-			if (monitor.isCanceled()) {
-				queue.clear();
-				return Status.CANCEL_STATUS;
+			if (asyncEvents) {
+				broker.post(topic, data);
+			} else {
+				broker.send(topic, data);
 			}
-			return Status.OK_STATUS;
-		}
-
-		/**
-		 * Enqueue a task asynchronously.
-		 **/
-		public void schedule(ITargetDefinition target) {
-			queue.offer(target);
-			schedule(); // will reschedule if already running
 		}
 	}
 

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/target/WorkspaceFileTargetHandle.java

@@ -76,7 +76,7 @@ public String getMemento() throws CoreException {
 	}
 
 	@Override
-	public void save(ITargetDefinition definition) throws CoreException {
+	void doSave(ITargetDefinition definition) throws CoreException {
 		ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
 		((TargetDefinition) definition).write(outputStream);
 		ByteArrayInputStream stream = new ByteArrayInputStream(outputStream.toByteArray());