Always consider fragments that specify a platform filter

laeubi · laeubi · commit 90c4bc13e005 · 2025-08-22T14:16:03.000+02:00
A fragment can declare a Eclipse-PlatformFilter to be only installed on a given platform. If such fragment is currently wired to a host bundle, it is quite likely that fragment is needed but the host usually do not declare an Eclipse-ExtensibleAPI so we currently miss to add such fragment making the native code loading fails. This now adds some code to store the platform filter and if one is given the fragment is always included. Fix #1929
diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/ClasspathUtilCore.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/ClasspathUtilCore.java
@@ -224,6 +224,17 @@ public static boolean hasExtensibleAPI(IPluginModelBase model) {
 		return false;
 	}
 
+	public static String getPlatformFilter(IPluginModelBase model) {
+		IPluginBase pluginBase = model.getPluginBase();
+		if (pluginBase instanceof BundlePlugin plugin) {
+			return plugin.getPlatformFilter();
+		}
+		if (pluginBase instanceof BundleFragment fragment) {
+			return fragment.getPlatformFilter();
+		}
+		return null;
+	}
+
 	public static boolean isPatchFragment(Resource desc) {
 		IPluginModelBase model = PluginRegistry.findModel(desc);
 		return model instanceof IFragmentModel i ? isPatchFragment(i.getFragment()) : false;
diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/DependencyManager.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/DependencyManager.java
@@ -68,7 +68,19 @@ public enum Options {
 		 * Specifies to include all non-test fragments into the closure (must
 		 * not be combined with {@link #INCLUDE_ALL_FRAGMENTS}).
 		 */
-		INCLUDE_NON_TEST_FRAGMENTS;
+		INCLUDE_NON_TEST_FRAGMENTS,
+		/**
+		 * Option that can be set to include native fragments, that are ones
+		 * that define an {@link ICoreConstants#PLATFORM_FILTER} in their
+		 * manifest.
+		 */
+		INCLUDE_PLATFORM_FRAGMENTS,
+		/**
+		 * Option that can be set to include native fragments, that are ones
+		 * that define an {@link ICoreConstants#PLATFORM_FILTER} in their
+		 * manifest.
+		 */
+		INCLUDE_EXTENSIBLE_FRAGMENTS;
 	}
 
 	/**
@@ -168,6 +180,8 @@ public static Set<BundleDescription> findRequirementsClosure(Collection<BundleDe
 		boolean includeOptional = optionSet.contains(Options.INCLUDE_OPTIONAL_DEPENDENCIES);
 		boolean includeAllFragments = optionSet.contains(Options.INCLUDE_ALL_FRAGMENTS);
 		boolean includeNonTestFragments = optionSet.contains(Options.INCLUDE_NON_TEST_FRAGMENTS);
+		boolean includeNativeFragments = optionSet.contains(Options.INCLUDE_PLATFORM_FRAGMENTS);
+		boolean includeExtensibleFragments = optionSet.contains(Options.INCLUDE_EXTENSIBLE_FRAGMENTS);
 		if (includeAllFragments && includeNonTestFragments) {
 			throw new AssertionError("Cannot combine INCLUDE_ALL_FRAGMENTS and INCLUDE_NON_TEST_FRAGMENTS"); //$NON-NLS-1$
 		}
@@ -188,14 +202,22 @@ public static Set<BundleDescription> findRequirementsClosure(Collection<BundleDe
 			if (wiring == null || !wiring.isInUse()) {
 				continue;
 			}
-			if (includeAllFragments || includeNonTestFragments || isExtensibleApi(bundle)) {
+			if (includeAllFragments || includeNonTestFragments
+					|| (includeExtensibleFragments && isExtensibleApi(bundle))) {
 				// A fragment's host is already required by a wire
 				for (BundleDescription fragment : bundle.getFragments()) {
 					if (includeAllFragments || !isTestWorkspaceProject(fragment)) {
 						addNewRequiredBundle(fragment, closure, pending);
 					}
 				}
 			}
+			if (includeNativeFragments) {
+				for (BundleDescription fragment : bundle.getFragments()) {
+					if (isNativeFragment(fragment) && !isTestWorkspaceProject(fragment)) {
+						addNewRequiredBundle(fragment, closure, pending);
+					}
+				}
+			}
 
 			if (isFragment(wiring.getRevision())) {
 				// Requirements of a fragment are hosted at the host, which
@@ -231,6 +253,14 @@ public static Set<BundleDescription> findRequirementsClosure(Collection<BundleDe
 		return closure;
 	}
 
+	private static boolean isNativeFragment(BundleDescription fragment) {
+		Object userObject = fragment.getUserObject();
+		if (userObject instanceof IPluginModelBase model) {
+			return ClasspathUtilCore.getPlatformFilter(model) != null;
+		}
+		return false;
+	}
+
 	private static boolean isExtensibleApi(BundleDescription bundleDescription) {
 		if (bundleDescription.getFragments().length == 0) {
 			return false;
diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/PDEAuxiliaryState.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/PDEAuxiliaryState.java
@@ -97,6 +97,7 @@ static class PluginInfo {
 		String localization;
 		String bundleSourceEntry;
 		boolean exportsExternalAnnotations;
+		String platformFilter;
 	}
 
 	/**
@@ -379,6 +380,7 @@ protected void addAuxiliaryData(BundleDescription desc, Map<String, String> mani
 		info.libraries = getClasspath(manifest);
 		info.hasExtensibleAPI = "true".equals(manifest.get(ICoreConstants.EXTENSIBLE_API)); //$NON-NLS-1$
 		info.isPatchFragment = "true".equals(manifest.get(ICoreConstants.PATCH_FRAGMENT)); //$NON-NLS-1$
+		info.platformFilter = manifest.get(ICoreConstants.PLATFORM_FILTER);
 		info.localization = manifest.get(Constants.BUNDLE_LOCALIZATION);
 		info.hasBundleStructure = hasBundleStructure;
 		info.bundleSourceEntry = manifest.get(ICoreConstants.ECLIPSE_SOURCE_BUNDLE);
diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/BundleFragment.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/BundleFragment.java
@@ -122,4 +122,8 @@ public boolean isPatch() {
 		return "true".equals(getValue(ICoreConstants.PATCH_FRAGMENT, false)); //$NON-NLS-1$
 	}
 
+	public String getPlatformFilter() {
+		return getValue(ICoreConstants.PLATFORM_FILTER, false);
+	}
+
 }
diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/BundlePlugin.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/BundlePlugin.java
@@ -57,4 +57,8 @@ public boolean exportsExternalAnnotations() {
 		return "true".equals(getValue(ICoreConstants.ECLIPSE_EXPORT_EXTERNAL_ANNOTATIONS, false)); //$NON-NLS-1$
 	}
 
+	public String getPlatformFilter() {
+		return getValue(ICoreConstants.PLATFORM_FILTER, false);
+	}
+
 }
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/ILaunchingPreferenceConstants.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/ILaunchingPreferenceConstants.java
@@ -25,6 +25,8 @@ public interface ILaunchingPreferenceConstants {
 
 	// Main preference page
 	public static final String PROP_AUTO_MANAGE = "Preferences.Launching.automanageDependencies"; //$NON-NLS-1$
+	public static final String PROP_AUTO_MANAGE_EXTENSIBLE_FRAGMENTS = "Preferences.Launching.automanageDependencies.includeExtensibleFragments"; //$NON-NLS-1$
+	public static final String PROP_AUTO_MANAGE_PLATFORM_FRAGMENTS = "Preferences.Launching.automanageDependencies.includePlatformFragments"; //$NON-NLS-1$
 	public static final String PROP_RUNTIME_WORKSPACE_LOCATION = "Preferences.Launching.runtimeWorkspaceLocation"; //$NON-NLS-1$
 	public static final String PROP_RUNTIME_WORKSPACE_LOCATION_IS_CONTAINER = "Preferences.Launching.runtimeWorkspaceLocationIsContainer"; //$NON-NLS-1$
 	public static final String PROP_JUNIT_WORKSPACE_LOCATION = "Preferences.Launching.junitWorkspaceLocation"; //$NON-NLS-1$
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/PreferenceInitializer.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/PreferenceInitializer.java
@@ -36,6 +36,8 @@ public void initializeDefaultPreferences() {
 		prefs.putBoolean(ILaunchingPreferenceConstants.PROP_JUNIT_ADD_NEW_WORKSPACE_PLUGINS, false);
 		prefs.putBoolean(ILaunchingPreferenceConstants.PROP_JUNIT_VALIDATE_LAUNCH, true);
 		prefs.putBoolean(ILaunchingPreferenceConstants.ADD_SWT_NON_DISPOSAL_REPORTING, true);
+		prefs.putBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_EXTENSIBLE_FRAGMENTS, true);
+		prefs.putBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_PLATFORM_FRAGMENTS, true);
 
 		// copy over instance scope prefs from UI plugin
 		IEclipsePreferences oldInstancePrefs = InstanceScope.INSTANCE.getNode(IPDEConstants.UI_PLUGIN_ID);
diff --git a/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/BundleLauncherHelper.java b/ui/org.eclipse.pde.launching/src/org/eclipse/pde/internal/launching/launcher/BundleLauncherHelper.java
@@ -66,6 +66,7 @@
 import org.eclipse.pde.internal.core.DependencyManager;
 import org.eclipse.pde.internal.core.FeatureModelManager;
 import org.eclipse.pde.internal.core.PDECore;
+import org.eclipse.pde.internal.core.PDEPreferencesManager;
 import org.eclipse.pde.internal.core.PluginModelManager;
 import org.eclipse.pde.internal.core.TargetPlatformHelper;
 import org.eclipse.pde.internal.core.ifeature.IFeature;
@@ -74,6 +75,7 @@
 import org.eclipse.pde.internal.core.ifeature.IFeatureModel;
 import org.eclipse.pde.internal.core.ifeature.IFeaturePlugin;
 import org.eclipse.pde.internal.core.util.VersionUtil;
+import org.eclipse.pde.internal.launching.ILaunchingPreferenceConstants;
 import org.eclipse.pde.internal.launching.IPDEConstants;
 import org.eclipse.pde.internal.launching.PDELaunchingPlugin;
 import org.eclipse.pde.internal.launching.PDEMessages;
@@ -557,10 +559,18 @@ private static Stream<IPluginModelBase> computeDependencies(Set<IPluginModelBase
 			return launchState.getBundle(descriptor.getId(), version);
 		}).forEach(launchBundles::add);
 
-		DependencyManager.Options[] options = includeOptional //
-				? new DependencyManager.Options[] {DependencyManager.Options.INCLUDE_OPTIONAL_DEPENDENCIES}
-				: new DependencyManager.Options[] {};
-		Set<BundleDescription> closure = DependencyManager.findRequirementsClosure(launchBundles, options);
+		PDEPreferencesManager launchingStore = PDELaunchingPlugin.getDefault().getPreferenceManager();
+		Set<DependencyManager.Options> options = new HashSet<>();
+		if (includeOptional) {
+			options.add(DependencyManager.Options.INCLUDE_OPTIONAL_DEPENDENCIES);
+		}
+		if (launchingStore.getBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_EXTENSIBLE_FRAGMENTS)) {
+			options.add(DependencyManager.Options.INCLUDE_EXTENSIBLE_FRAGMENTS);
+		}
+		if (launchingStore.getBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_PLATFORM_FRAGMENTS)) {
+			options.add(DependencyManager.Options.INCLUDE_PLATFORM_FRAGMENTS);
+		}
+		Set<BundleDescription> closure = DependencyManager.findRequirementsClosure(launchBundles, options.toArray(DependencyManager.Options[]::new));
 		return closure.stream().map(launchBundlePlugins::get).map(Objects::requireNonNull) //
 				.filter(p -> !includedPlugins.contains(p));
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/PDEUIMessages.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/PDEUIMessages.java
@@ -2711,6 +2711,12 @@ public class PDEUIMessages extends NLS {
 
 	public static String LaunchingPreferencePage_description;
 
+	public static String LaunchingPreferencePage_GroupComputingOptions;
+
+	public static String LaunchingPreferencePage_IncludeExtensibleFragments;
+
+	public static String LaunchingPreferencePage_IncludePlatformFragments;
+
 	public static String RemoveLazyLoadingDirectiveResolution_remove;
 
 	public static String RemoveAutomaticModuleResolution_remove;
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/pderesources.properties b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/pderesources.properties
@@ -2193,6 +2193,9 @@ LauncherSection_launcherName=Launcher Name:
 LauncherSection_dialogTitle=Image Selection
 LauncherSection_dialogMessage=Select an image:
 LaunchingPreferencePage_description=Settings for Plug-in launches
+LaunchingPreferencePage_GroupComputingOptions=When computing required Plug-ins
+LaunchingPreferencePage_IncludeExtensibleFragments=Include Fragment of Extensible-API Plug-ins
+LaunchingPreferencePage_IncludePlatformFragments=Include Platform Specific Fragment
 RemoveLazyLoadingDirectiveResolution_remove=Remove lazy activation header
 RemoveAutomaticModuleResolution_remove=Remove automatic module name header
 ProductDefinitonWizardPage_applicationDefinition=<form><p>An Eclipse product must be associated with an <a href="applications">application</a>, the default entry point for the product when it is running.</p></form>
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/preferences/LaunchingPreferencePage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/preferences/LaunchingPreferencePage.java
@@ -162,6 +162,10 @@ protected boolean isFile() {
 	private Button fJunitAddWorkspaceButton;
 	private Button fJunitAutoValidate;
 
+	private Button fFragmentsPlatformButton;
+
+	private Button fFragmentsExtensibleApiButton;
+
 	public LaunchingPreferencePage() {
 		setPreferenceStore(PDEPlugin.getDefault().getPreferenceStore());
 		setDescription(PDEUIMessages.LaunchingPreferencePage_description);
@@ -197,6 +201,17 @@ protected Control createContents(Composite parent) {
 		fRuntimeWorkspacesContainerRadio.setSelection(runtimeLocationIsContainer);
 
 		new DefaultJUnitWorkspaceBlock().createControl(composite);
+		Group group = SWTFactory.createGroup(composite, PDEUIMessages.LaunchingPreferencePage_GroupComputingOptions, 1,
+				1,
+				GridData.FILL_HORIZONTAL);
+		fFragmentsPlatformButton = SWTFactory.createCheckButton(group, PDEUIMessages.LaunchingPreferencePage_IncludePlatformFragments, null, false,
+				1);
+		fFragmentsExtensibleApiButton = SWTFactory.createCheckButton(group,
+				PDEUIMessages.LaunchingPreferencePage_IncludeExtensibleFragments, null, false, 1);
+		fFragmentsPlatformButton.setSelection(
+				launchingStore.getBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_PLATFORM_FRAGMENTS));
+		fFragmentsExtensibleApiButton.setSelection(
+				launchingStore.getBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_EXTENSIBLE_FRAGMENTS));
 		fJUnitWorkspaceLocation
 				.setText(launchingStore.getString(ILaunchingPreferenceConstants.PROP_JUNIT_WORKSPACE_LOCATION));
 		boolean jUnitLocationIsContainer = launchingStore
@@ -250,6 +265,10 @@ public boolean performOk() {
 				fJunitAutoValidate.getSelection());
 		launchingStore.setValueOrRemove(ILaunchingPreferenceConstants.ADD_SWT_NON_DISPOSAL_REPORTING,
 				fAddSwtNonDisposalReporting.getSelection());
+		launchingStore.setValueOrRemove(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_EXTENSIBLE_FRAGMENTS,
+				fFragmentsExtensibleApiButton.getSelection());
+		launchingStore.setValueOrRemove(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_PLATFORM_FRAGMENTS,
+				fFragmentsPlatformButton.getSelection());
 		try {
 			launchingStore.flush();
 		} catch (BackingStoreException e) {
@@ -287,6 +306,10 @@ protected void performDefaults() {
 				launchingStore.getDefaultBoolean(ILaunchingPreferenceConstants.PROP_JUNIT_ADD_NEW_WORKSPACE_PLUGINS));
 		fJunitAutoValidate.setSelection(
 				launchingStore.getDefaultBoolean(ILaunchingPreferenceConstants.PROP_JUNIT_VALIDATE_LAUNCH));
+		fFragmentsExtensibleApiButton.setSelection(
+				launchingStore.getBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_EXTENSIBLE_FRAGMENTS));
+		fFragmentsPlatformButton.setSelection(
+				launchingStore.getBoolean(ILaunchingPreferenceConstants.PROP_AUTO_MANAGE_PLATFORM_FRAGMENTS));
 	}
 
 	@Override

Original file line number	Diff line number	Diff line change
`@@ -122,4 +122,8 @@ public boolean isPatch() {`
`122`	`122`	`return "true".equals(getValue(ICoreConstants.PATCH_FRAGMENT, false)); //$NON-NLS-1$`
`123`	`123`	`}`
`124`	`124`
	`125`	`+ public String getPlatformFilter() {`
	`126`	`+ return getValue(ICoreConstants.PLATFORM_FILTER, false);`
	`127`	`+ }`
	`128`	`+`
`125`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,4 +57,8 @@ public boolean exportsExternalAnnotations() {`
`57`	`57`	`return "true".equals(getValue(ICoreConstants.ECLIPSE_EXPORT_EXTERNAL_ANNOTATIONS, false)); //$NON-NLS-1$`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ public String getPlatformFilter() {`
	`61`	`+ return getValue(ICoreConstants.PLATFORM_FILTER, false);`
	`62`	`+ }`
	`63`	`+`
`60`	`64`	`}`