From 4039834bac5cc597b9e90a1e59557f5b0009fff3 Mon Sep 17 00:00:00 2001
From: Martin Jobst <martin.jobst@posteo.de>
Date: Tue, 21 Jan 2025 10:01:31 +0100
Subject: [PATCH] Provide text action bar contributor for text editors in type
 editor

The text editors inside a multi-page type editor need to have a proper
text action contributor to properly support switching of actions between
pages and also for the new search overlay. This provides a text action
bar contributor for text editors inside a type editor.
---
 .../plugin.xml                                |  2 +-
 .../GraphicalMultipageEditorContributor.java  |  7 +-
 .../plugin.xml                                |  2 +-
 .../META-INF/MANIFEST.MF                      |  3 +-
 .../plugin.xml                                |  2 +-
 .../META-INF/MANIFEST.MF                      |  3 +
 .../ide/typeeditor/AbstractTypeEditor.java    |  3 +
 .../ide/typeeditor/TypeEditorContributor.java | 77 +++++++++++++++++++
 .../TypeTextMultiPageEditorSite.java          | 33 ++++++++
 9 files changed, 124 insertions(+), 8 deletions(-)
 create mode 100644 plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeEditorContributor.java
 create mode 100644 plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeTextMultiPageEditorSite.java

diff --git a/plugins/org.eclipse.fordiac.ide.fbtypeeditor/plugin.xml b/plugins/org.eclipse.fordiac.ide.fbtypeeditor/plugin.xml
index 71e3972542..f30124a871 100644
--- a/plugins/org.eclipse.fordiac.ide.fbtypeeditor/plugin.xml
+++ b/plugins/org.eclipse.fordiac.ide.fbtypeeditor/plugin.xml
@@ -14,7 +14,7 @@
          point="org.eclipse.ui.editors">
       <editor
             class="org.eclipse.fordiac.ide.fbtypeeditor.editors.FBTypeEditor"
-            contributorClass="org.eclipse.fordiac.ide.gef.editors.GraphicalMultipageEditorContributor"
+            contributorClass="org.eclipse.fordiac.ide.typeeditor.TypeEditorContributor"
             extensions="fbt, fct, adp"
             icon="fordiacimage://ICON_FB_TYPE"
             id="org.eclipse.fordiac.ide.fbtypeeditor.editors.FBTypeEditor"
diff --git a/plugins/org.eclipse.fordiac.ide.gef/src/org/eclipse/fordiac/ide/gef/editors/GraphicalMultipageEditorContributor.java b/plugins/org.eclipse.fordiac.ide.gef/src/org/eclipse/fordiac/ide/gef/editors/GraphicalMultipageEditorContributor.java
index 13eb778d8b..422841b977 100644
--- a/plugins/org.eclipse.fordiac.ide.gef/src/org/eclipse/fordiac/ide/gef/editors/GraphicalMultipageEditorContributor.java
+++ b/plugins/org.eclipse.fordiac.ide.gef/src/org/eclipse/fordiac/ide/gef/editors/GraphicalMultipageEditorContributor.java
@@ -16,6 +16,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.eclipse.core.runtime.Adapters;
 import org.eclipse.draw2d.PositionConstants;
 import org.eclipse.gef.ui.actions.ActionRegistry;
 import org.eclipse.gef.ui.actions.AlignmentRetargetAction;
@@ -37,16 +38,14 @@ public class GraphicalMultipageEditorContributor extends MultiPageEditorActionBa
 
 	@Override
 	public void setActiveEditor(final IEditorPart editor) {
-		setGlobalActionHandler(editor.getAdapter(ActionRegistry.class));
+		setGlobalActionHandler(Adapters.adapt(editor, ActionRegistry.class));
 		super.setActiveEditor(editor);
 
 	}
 
 	@Override
 	public void setActivePage(final IEditorPart activeEditor) {
-		if (null != activeEditor) {
-			setGlobalActionHandler(activeEditor.getAdapter(ActionRegistry.class));
-		}
+		setGlobalActionHandler(Adapters.adapt(activeEditor, ActionRegistry.class));
 	}
 
 	private void setGlobalActionHandler(final ActionRegistry editorRegistry) {
diff --git a/plugins/org.eclipse.fordiac.ide.subapptypeeditor/plugin.xml b/plugins/org.eclipse.fordiac.ide.subapptypeeditor/plugin.xml
index 89b84dee0e..167abc9b96 100644
--- a/plugins/org.eclipse.fordiac.ide.subapptypeeditor/plugin.xml
+++ b/plugins/org.eclipse.fordiac.ide.subapptypeeditor/plugin.xml
@@ -16,7 +16,7 @@
             extensions="sub"
             default="true"
             icon="fordiacimage://ICON_SUB_APP_TYPE"
-            contributorClass="org.eclipse.fordiac.ide.gef.editors.GraphicalMultipageEditorContributor"
+            contributorClass="org.eclipse.fordiac.ide.typeeditor.TypeEditorContributor"
             class="org.eclipse.fordiac.ide.subapptypeeditor.SubAppTypeEditor"
             id="org.eclipse.fordiac.ide.subapptypeeditor.SubAppTypeEditor"
             matchingStrategy="org.eclipse.fordiac.ide.ui.editors.FordiacEditorMatchingStrategy"/>
diff --git a/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/META-INF/MANIFEST.MF b/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/META-INF/MANIFEST.MF
index da0d267245..707d659e17 100644
--- a/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/META-INF/MANIFEST.MF
+++ b/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/META-INF/MANIFEST.MF
@@ -35,7 +35,8 @@ Require-Bundle: org.eclipse.ui,
  org.eclipse.fordiac.ide.subapptypeeditor,
  org.eclipse.fordiac.ide.fbtypeeditor.network,
  org.eclipse.fordiac.ide.library.model,
- org.eclipse.fordiac.ide.library.ui
+ org.eclipse.fordiac.ide.library.ui,
+ org.eclipse.fordiac.ide.typeeditor
 Bundle-Vendor: %Bundle-Vendor
 Bundle-Version: 3.0.0.qualifier
 Bundle-ManifestVersion: 2
diff --git a/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/plugin.xml b/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/plugin.xml
index 8e190aec78..f328f0af1f 100644
--- a/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/plugin.xml
+++ b/plugins/org.eclipse.fordiac.ide.systemmanagement.ui/plugin.xml
@@ -68,7 +68,7 @@
          point="org.eclipse.ui.editors">
       <editor
             class="org.eclipse.fordiac.ide.systemmanagement.ui.editors.AutomationSystemEditor"
-            contributorClass="org.eclipse.fordiac.ide.gef.editors.GraphicalMultipageEditorContributor"
+            contributorClass="org.eclipse.fordiac.ide.typeeditor.TypeEditorContributor"
             default="true"
             extensions="sys"
             icon="fordiacimage://ICON_SYSTEM_PERSPECTIVE"
diff --git a/plugins/org.eclipse.fordiac.ide.typeeditor/META-INF/MANIFEST.MF b/plugins/org.eclipse.fordiac.ide.typeeditor/META-INF/MANIFEST.MF
index a296d58712..27fa1aa26c 100644
--- a/plugins/org.eclipse.fordiac.ide.typeeditor/META-INF/MANIFEST.MF
+++ b/plugins/org.eclipse.fordiac.ide.typeeditor/META-INF/MANIFEST.MF
@@ -19,6 +19,7 @@ Import-Package: org.eclipse.core.commands.common,
  org.eclipse.emf.ecore.resource,
  org.eclipse.fordiac.ide.application.editors,
  org.eclipse.fordiac.ide.gef.annotation,
+ org.eclipse.fordiac.ide.gef.editors,
  org.eclipse.fordiac.ide.gef.validation,
  org.eclipse.fordiac.ide.model.edit,
  org.eclipse.fordiac.ide.model.libraryElement,
@@ -30,6 +31,7 @@ Import-Package: org.eclipse.core.commands.common,
  org.eclipse.fordiac.ide.ui.widget,
  org.eclipse.gef,
  org.eclipse.gef.commands,
+ org.eclipse.jface.action,
  org.eclipse.jface.dialogs,
  org.eclipse.jface.layout,
  org.eclipse.jface.resource,
@@ -42,6 +44,7 @@ Import-Package: org.eclipse.core.commands.common,
  org.eclipse.swt.widgets,
  org.eclipse.ui,
  org.eclipse.ui.actions,
+ org.eclipse.ui.editors.text,
  org.eclipse.ui.forms.editor,
  org.eclipse.ui.ide,
  org.eclipse.ui.part,
diff --git a/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/AbstractTypeEditor.java b/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/AbstractTypeEditor.java
index c9810aef8e..32168a315d 100644
--- a/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/AbstractTypeEditor.java
+++ b/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/AbstractTypeEditor.java
@@ -149,6 +149,9 @@ public void createPartControl(final Composite parent) {
 
 	@Override
 	protected IEditorSite createSite(final IEditorPart editor) {
+		if (editor instanceof ITextEditor) {
+			return new TypeTextMultiPageEditorSite(this, editor);
+		}
 		return new TypeMultiPageEditorSite(this, editor);
 	}
 
diff --git a/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeEditorContributor.java b/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeEditorContributor.java
new file mode 100644
index 0000000000..28b0829f24
--- /dev/null
+++ b/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeEditorContributor.java
@@ -0,0 +1,77 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Martin Erich Jobst
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Martin Jobst - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+package org.eclipse.fordiac.ide.typeeditor;
+
+import java.util.Map;
+
+import org.eclipse.fordiac.ide.gef.editors.GraphicalMultipageEditorContributor;
+import org.eclipse.jface.action.IAction;
+import org.eclipse.ui.IActionBars;
+import org.eclipse.ui.IEditorActionBarContributor;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.SubActionBars;
+import org.eclipse.ui.editors.text.TextEditorActionContributor;
+import org.eclipse.ui.texteditor.ITextEditor;
+
+public class TypeEditorContributor extends GraphicalMultipageEditorContributor {
+	private final TextEditorActionContributor textContributor = createTextContributor();
+	private SubActionBars textActionBars;
+
+	@Override
+	public void init(final IActionBars bars) {
+		super.init(bars);
+		textActionBars = new SubActionBars(bars);
+		textContributor.init(textActionBars);
+	}
+
+	@Override
+	public void dispose() {
+		textActionBars.dispose();
+		textContributor.dispose();
+		super.dispose();
+	}
+
+	@Override
+	public void setActivePage(final IEditorPart newEditor) {
+		if (newEditor instanceof final ITextEditor newTextEditor) {
+			super.setActivePage(null);
+			textContributor.setActiveEditor(newTextEditor);
+			textActionBars.activate();
+			forwardGlobalActionHandlers(true);
+		} else {
+			forwardGlobalActionHandlers(false);
+			textActionBars.deactivate();
+			textContributor.setActiveEditor(null);
+			super.setActivePage(newEditor);
+		}
+		getActionBars().updateActionBars();
+	}
+
+	protected void forwardGlobalActionHandlers(final boolean active) {
+		final Map<String, IAction> handlers = textActionBars.getGlobalActionHandlers();
+		if (handlers != null) {
+			for (final var action : handlers.entrySet()) {
+				getActionBars().setGlobalActionHandler(action.getKey(), active ? action.getValue() : null);
+			}
+		}
+	}
+
+	@SuppressWarnings("static-method") // subclasses may override
+	protected TextEditorActionContributor createTextContributor() {
+		return new TextEditorActionContributor();
+	}
+
+	public IEditorActionBarContributor getTextContributor() {
+		return textContributor;
+	}
+}
diff --git a/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeTextMultiPageEditorSite.java b/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeTextMultiPageEditorSite.java
new file mode 100644
index 0000000000..649a964a90
--- /dev/null
+++ b/plugins/org.eclipse.fordiac.ide.typeeditor/src/org/eclipse/fordiac/ide/typeeditor/TypeTextMultiPageEditorSite.java
@@ -0,0 +1,33 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Martin Erich Jobst
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Martin Jobst - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+package org.eclipse.fordiac.ide.typeeditor;
+
+import org.eclipse.ui.IEditorActionBarContributor;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.part.MultiPageEditorPart;
+
+public class TypeTextMultiPageEditorSite extends TypeMultiPageEditorSite {
+
+	public TypeTextMultiPageEditorSite(final MultiPageEditorPart multiPageEditor, final IEditorPart editor) {
+		super(multiPageEditor, editor);
+	}
+
+	@Override
+	public IEditorActionBarContributor getActionBarContributor() {
+		if (getMultiPageEditor().getEditorSite()
+				.getActionBarContributor() instanceof final TypeEditorContributor typeEditorContributor) {
+			return typeEditorContributor.getTextContributor();
+		}
+		return null;
+	}
+}