Implement activity support filtering for e4 dynamic menu contribution.

Similar to PluginActionContributionItem we can support activity
filtering of menu item to be shown or not.

Fixes #2217

Author: raghucssit

bundles/org.eclipse.e4.ui.workbench.renderers.swt/META-INF/MANIFEST.MF

@@ -6,7 +6,7 @@ Bundle-Name: %pluginName
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin
 Bundle-RequiredExecutionEnvironment: JavaSE-17
-Require-Bundle: org.eclipse.e4.ui.workbench;bundle-version="0.9.0",
+Require-Bundle: org.eclipse.e4.ui.workbench;bundle-version="1.17.0",
  org.eclipse.e4.core.services;bundle-version="0.9.0",
  org.eclipse.e4.core.contexts;bundle-version="1.0.0",
  org.eclipse.e4.core.di;bundle-version="1.1.0",

bundles/org.eclipse.e4.ui.workbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/DynamicContributionContributionItem.java

@@ -14,6 +14,7 @@
 
 package org.eclipse.e4.ui.workbench.renderers.swt;
 
+import org.eclipse.e4.ui.activitysupport.EActivityManager;
 import org.eclipse.e4.ui.model.application.ui.menu.MDynamicMenuContribution;
 import org.eclipse.jface.action.ContributionItem;
 import org.eclipse.jface.action.IContributionManager;
@@ -29,12 +30,17 @@ class DynamicContributionContributionItem extends ContributionItem {
 
 	private IMenuListener menuListener = IMenuManager::markDirty;
 
+	private static final String BUNDLE_CLASS_PREFIX = "bundleclass://"; //$NON-NLS-1$
+
+	private final EActivityManager activitySupport;
+
 	/**
 	 * Create the item and associated model;
 	 */
-	public DynamicContributionContributionItem(MDynamicMenuContribution item) {
+	public DynamicContributionContributionItem(MDynamicMenuContribution item, EActivityManager activitySupport) {
 		super(item.getElementId());
 		model = item;
+		this.activitySupport = activitySupport;
 	}
 
 	@Override
@@ -66,4 +72,18 @@ public void setParent(IContributionManager parent) {
 		}
 		super.setParent(parent);
 	}
+
+	@Override
+	public boolean isVisible() {
+		if (activitySupport != null) {
+			// Contribution URI has the scheme bundleclass://. Ex:
+			// bundleclass://org.eclipse.pde.spy.core/org.eclipse.pde.spy.core.SpyProcessor
+			String contributionURI = this.getModel().getContributionURI();
+			if (contributionURI.startsWith(BUNDLE_CLASS_PREFIX)) {
+				return activitySupport.isIdentifierEnabled(contributionURI.substring(BUNDLE_CLASS_PREFIX.length()));
+			}
+		}
+		return true;
+	}
+
 }

bundles/org.eclipse.e4.ui.workbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/MenuManagerRenderer.java

@@ -46,6 +46,7 @@
 import org.eclipse.e4.core.contexts.RunAndTrack;
 import org.eclipse.e4.core.di.annotations.Optional;
 import org.eclipse.e4.core.services.log.Logger;
+import org.eclipse.e4.ui.activitysupport.EActivityManager;
 import org.eclipse.e4.ui.di.UIEventTopic;
 import org.eclipse.e4.ui.internal.workbench.ContributionsAnalyzer;
 import org.eclipse.e4.ui.internal.workbench.OpaqueElementUtil;
@@ -116,6 +117,9 @@ public class MenuManagerRenderer extends SWTPartRenderer {
 	@Inject
 	private MApplication application;
 
+	@Inject
+	EActivityManager activityManager;
+
 	@Inject
 	@Optional
 	private void subscribeSelectionUpdated(@UIEventTopic(UIEvents.Item.TOPIC_SELECTED) Event event) {
@@ -783,7 +787,7 @@ private void processDynamicMenuContribution(MenuManager menuManager, MDynamicMen
 			return;
 		}
 		itemModel.setRenderer(this);
-		DynamicContributionContributionItem ci = new DynamicContributionContributionItem(itemModel);
+		DynamicContributionContributionItem ci = new DynamicContributionContributionItem(itemModel, activityManager);
 		addToManager(menuManager, itemModel, ci);
 		linkModelToContribution(itemModel, ci);
 	}

bundles/org.eclipse.e4.ui.workbench/META-INF/MANIFEST.MF

@@ -1,7 +1,7 @@
 Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-SymbolicName: org.eclipse.e4.ui.workbench;singleton:=true
-Bundle-Version: 1.16.100.qualifier
+Bundle-Version: 1.17.0.qualifier
 Bundle-Name: %pluginName
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin
@@ -20,7 +20,8 @@ Require-Bundle: org.eclipse.e4.ui.model.workbench;bundle-version="1.2.0",
  org.eclipse.core.runtime;bundle-version="[3.29.0,4.0.0)"
 Bundle-ActivationPolicy: lazy
 Bundle-RequiredExecutionEnvironment: JavaSE-17
-Export-Package: org.eclipse.e4.ui.internal.workbench;
+Export-Package: org.eclipse.e4.ui.activitysupport,
+ org.eclipse.e4.ui.internal.workbench;
   x-friends:="org.eclipse.e4.ui.workbench.fragment,
    org.eclipse.e4.ui.workbench.addons.swt,
    org.eclipse.e4.ui.workbench.renderers.swt,

bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/activitysupport/EActivityManager.java

@@ -0,0 +1,38 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Advantest Europe GmbH 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:
+ * 				Raghunandana Murthappa
+ *******************************************************************************/
+package org.eclipse.e4.ui.activitysupport;
+
+/**
+ * A bridge between org.eclipse.ui.workbench and
+ * org.eclipse.e4.ui.workbench.renderers.swt.
+ *
+ * Service for this interface is bound to Platform.class bundle at
+ * Workbench.class. We cannot depend on org.eclipse.ui.workbench from
+ * org.eclipse.e4.ui.workbench.renderers.swt
+ *
+ * @since 1.17
+ */
+public interface EActivityManager {
+	/**
+	 * Checks whether the given element is enabled or not in the workbench activity
+	 * support.
+	 *
+	 * @param identifierId A qualified id if the contribution. Which has format of
+	 *                     bundle-id/element. Ex:
+	 *                     org.eclipse.pde.spy.core/org.eclipse.pde.spy.core.SpyProcessor
+	 * @return {@code true} if the given identifierId is enabled within workbench
+	 *         activity support.
+	 */
+	public boolean isIdentifierEnabled(String identifierId);
+}

bundles/org.eclipse.ui.workbench/META-INF/MANIFEST.MF

@@ -113,7 +113,8 @@ Require-Bundle: org.eclipse.core.runtime;bundle-version="[3.33.0,4.0.0)",
  org.eclipse.e4.ui.workbench.addons.swt;bundle-version="0.10.0",
  org.eclipse.e4.ui.services;bundle-version="1.3.0",
  org.eclipse.emf.ecore.xmi;bundle-version="2.11.0",
- org.eclipse.e4.core.di.extensions;bundle-version="0.13.0"
+ org.eclipse.e4.core.di.extensions;bundle-version="0.13.0",
+ org.eclipse.e4.ui.workbench;bundle-version="1.17.0"
 Import-Package: com.ibm.icu.util,
  jakarta.annotation;version="[2.1.0,3.0.0)",
  jakarta.inject;version="[2.0.0,3.0.0)",
@@ -140,4 +141,5 @@ Service-Component: OSGI-INF/org.eclipse.ui.internal.BindingToModelProcessor.xml,
  OSGI-INF/org.eclipse.ui.internal.CommandToModelProcessor.xml,
  OSGI-INF/org.eclipse.ui.internal.ContextToModelProcessor.xml,
  OSGI-INF/org.eclipse.ui.internal.WindowsDefenderConfigurator.xml,
- OSGI-INF/org.eclipse.ui.internal.themes.ColorAndFontProviderImpl.xml
+ OSGI-INF/org.eclipse.ui.internal.themes.ColorAndFontProviderImpl.xml,
+ OSGI-INF/org.eclipse.ui.internal.util.ActivityManagerProxy.xml

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/Workbench.java

@@ -87,6 +87,7 @@
 import org.eclipse.e4.core.contexts.IEclipseContext;
 import org.eclipse.e4.core.di.InjectionException;
 import org.eclipse.e4.core.services.events.IEventBroker;
+import org.eclipse.e4.ui.activitysupport.EActivityManager;
 import org.eclipse.e4.ui.internal.workbench.E4Workbench;
 import org.eclipse.e4.ui.internal.workbench.E4XMIResource;
 import org.eclipse.e4.ui.internal.workbench.renderers.swt.IUpdateService;
@@ -246,6 +247,7 @@
 import org.eclipse.ui.internal.themes.FontDefinition;
 import org.eclipse.ui.internal.themes.ThemeElementHelper;
 import org.eclipse.ui.internal.themes.WorkbenchThemeManager;
+import org.eclipse.ui.internal.util.ActivityManagerProxy;
 import org.eclipse.ui.internal.util.PrefUtil;
 import org.eclipse.ui.intro.IIntroManager;
 import org.eclipse.ui.keys.IBindingService;
@@ -2212,6 +2214,10 @@ public Object compute(IEclipseContext context, String contextKey) {
 			}
 		});
 		WorkbenchPlugin.getDefault().initializeContext(e4Context);
+
+		BundleContext context = FrameworkUtil.getBundle(Platform.class).getBundleContext();
+		ActivityManagerProxy service = new ActivityManagerProxy();
+		context.registerService(EActivityManager.class.getName(), service, null);
 	}
 
 	private ArrayList<MCommand> commandsToRemove = new ArrayList<>();

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/quickaccess/providers/ViewProvider.java

@@ -23,6 +23,8 @@
 import org.eclipse.jface.resource.ImageDescriptor;
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.activities.IActivityManager;
+import org.eclipse.ui.activities.IIdentifier;
 import org.eclipse.ui.activities.WorkbenchActivityHelper;
 import org.eclipse.ui.internal.IWorkbenchGraphicConstants;
 import org.eclipse.ui.internal.WorkbenchImages;
@@ -39,6 +41,11 @@
  */
 public class ViewProvider extends QuickAccessProvider {
 
+	/**
+	 * URI of any view on the platform has this prefix. ex:
+	 * bundleclass://org.eclipse.pde.spy.bundle/org.eclipse.pde.spy.bundle.BundleSpyPart
+	 */
+	private static final String BUNDLE_CLASS_SCHEME = "bundleclass://"; //$NON-NLS-1$
 	private MApplication application;
 	private MWindow window;
 	private Map<String, QuickAccessElement> idToElement = new HashMap<>();
@@ -69,6 +76,7 @@ public QuickAccessElement[] getElements() {
 		}
 
 		if (idToElement.isEmpty()) {
+			IActivityManager activityManager = PlatformUI.getWorkbench().getActivitySupport().getActivityManager();
 			for (MPartDescriptor descriptor : application.getDescriptors()) {
 				String uri = descriptor.getContributionURI();
 				if (uri != null) {
@@ -85,7 +93,15 @@ public QuickAccessElement[] getElements() {
 								idToElement.put(element.getId(), element);
 							}
 						} else {
-							idToElement.put(id, element);
+							if (uri.startsWith(BUNDLE_CLASS_SCHEME)) {
+								String viewQualUri = uri.substring(BUNDLE_CLASS_SCHEME.length());
+								IIdentifier identifier = activityManager.getIdentifier(viewQualUri);
+								if (identifier.isEnabled()) {
+									idToElement.put(element.getId(), element);
+								}
+							} else {
+								idToElement.put(element.getId(), element);
+							}
 						}
 					}
 				}

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/util/ActivityManagerProxy.java

@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Advantest Europe GmbH 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:
+ * 				Raghunandana Murthappa
+ *******************************************************************************/
+package org.eclipse.ui.internal.util;
+import org.eclipse.e4.ui.activitysupport.EActivityManager;
+import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.activities.IActivityManager;
+import org.osgi.service.component.annotations.Component;
+
+@Component(service = { EActivityManager.class })
+public class ActivityManagerProxy implements EActivityManager {
+
+	private final IActivityManager activityManager;
+
+	public ActivityManagerProxy() {
+		activityManager = PlatformUI.getWorkbench().getActivitySupport().getActivityManager();
+	}
+
+	@Override
+	public boolean isIdentifierEnabled(String identifierId) {
+		boolean isEnabled = activityManager.getIdentifier(identifierId).isEnabled();
+		return isEnabled;
+	}
+}

docs/Eclipse4_RCP_EAS_List_of_All_Provided_Services.md

@@ -69,6 +69,7 @@ Application Context
 *   org.eclipse.ui.ISharedImages
 *   org.eclipse.ui.progress.IProgressService
 *   org.eclipse.e4.ui.services.help.EHelpService
+*   org.eclipse.e4.ui.activitysupport.EActivityManager
 
 ### Runtime Data