Add support for open a Terminal in the Console View

laeubi · laeubi · commit 31001828ef17 · 2025-06-18T18:27:48.000+02:00
Currently one needs to create one or more Terminal View instances to
open a command prompt or SSH session.

With the new Console View Integration it is now possible to offer
similar for the Console View to make this more accessible and visible to
the users.
diff --git a/debug/org.eclipse.debug.terminal/META-INF/MANIFEST.MF b/debug/org.eclipse.debug.terminal/META-INF/MANIFEST.MF
@@ -9,7 +9,9 @@ Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.tm.terminal.control;bundle-version="5.6.0",
  org.eclipse.cdt.core.native;bundle-version="[6.4.0,7.0.0)",
  org.eclipse.swt;bundle-version="3.130.0",
- org.eclipse.ui;bundle-version="3.207.100"
+ org.eclipse.ui;bundle-version="3.207.100",
+ org.eclipse.ui.console,
+ org.eclipse.core.expressions
 Bundle-RequiredExecutionEnvironment: JavaSE-21
 Bundle-Localization: plugin
 Automatic-Module-Name: org.eclipse.debug.terminal
diff --git a/debug/org.eclipse.debug.terminal/build.properties b/debug/org.eclipse.debug.terminal/build.properties
@@ -6,4 +6,5 @@ bin.includes = META-INF/,\
                OSGI-INF/,\
                about.html,\
                plugin.properties
-src.includes = about.html
+src.includes = about.html,\
+               icons/
diff --git a/debug/org.eclipse.debug.terminal/icons/console_view.png b/debug/org.eclipse.debug.terminal/icons/console_view.png
diff --git a/debug/org.eclipse.debug.terminal/icons/console_view@2x.png b/debug/org.eclipse.debug.terminal/icons/console_view@2x.png
diff --git a/debug/org.eclipse.debug.terminal/plugin.xml b/debug/org.eclipse.debug.terminal/plugin.xml
@@ -16,5 +16,13 @@
             id="org.eclipse.debug.terminal.processFactory">
       </processFactory>
    </extension>
+   <extension
+         point="org.eclipse.ui.console.consoleFactories">
+      <consoleFactory
+            class="org.eclipse.debug.terminal.ui.TerminalConsoleFactory"
+            icon="icons/console_view.png"
+            label="Terminal">
+      </consoleFactory>
+   </extension>
 
 </plugin>
diff --git a/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/PageBookAdapter.java b/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/PageBookAdapter.java
@@ -13,9 +13,14 @@
  *******************************************************************************/
 package org.eclipse.debug.terminal.ui;
 
+import java.io.IOException;
+import java.io.OutputStream;
+
 import org.eclipse.cdt.utils.spawner.Spawner;
 import org.eclipse.core.runtime.AdapterTypes;
 import org.eclipse.core.runtime.IAdapterFactory;
+import org.eclipse.debug.core.model.IBinaryStreamMonitor;
+import org.eclipse.debug.core.model.IStreamMonitor;
 import org.eclipse.debug.terminal.PtyRuntimeProcess;
 import org.eclipse.ui.part.IPageBookViewPage;
 import org.osgi.service.component.annotations.Component;
@@ -29,7 +34,19 @@ public <T> T getAdapter(Object adaptableObject, Class<T> adapterType) {
 		if (adaptableObject instanceof PtyRuntimeProcess rt) {
 			Spawner spawner = rt.getSpawner();
 			if (spawner != null) {
-				return adapterType.cast(new TerminalConsolePage(spawner, rt.getStreamsProxy()));
+				return adapterType.cast(new TerminalConsolePage(new ConsoleConnector(spawner), terminal -> {
+					IStreamMonitor streamMonitor = rt.getStreamsProxy().getOutputStreamMonitor();
+					if (streamMonitor instanceof IBinaryStreamMonitor bin) {
+						OutputStream outputStream = terminal.getRemoteToTerminalOutputStream();
+						bin.addBinaryListener((data, monitor) -> {
+							try {
+								outputStream.write(data);
+							} catch (IOException e1) {
+								e1.printStackTrace();
+							}
+						});
+					}
+				}));
 			}
 		}
 		return null;
diff --git a/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/TerminalConsole.java b/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/TerminalConsole.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Christoph Läubrich 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:
+ *     Christoph Läubrich - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.debug.terminal.ui;
+
+import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
+import org.eclipse.ui.console.AbstractConsole;
+import org.eclipse.ui.console.IConsoleView;
+import org.eclipse.ui.part.IPageBookViewPage;
+
+class TerminalConsole extends AbstractConsole {
+
+	public final static String TYPE = "terminalConsole"; //$NON-NLS-1$
+	private ITerminalConnector terminalConnector;
+
+	TerminalConsole(ITerminalConnector terminalConnector) {
+		super("Terminal", TYPE, null, true);
+		this.terminalConnector = terminalConnector;
+	}
+
+	@Override
+	public IPageBookViewPage createPage(IConsoleView view) {
+		return new TerminalConsolePage(terminalConnector, null);
+	}
+
+}
diff --git a/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/TerminalConsoleFactory.java b/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/TerminalConsoleFactory.java
@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Christoph Läubrich 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:
+ *     Christoph Läubrich - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.debug.terminal.ui;
+
+import java.util.Map;
+
+import org.eclipse.core.commands.Command;
+import org.eclipse.core.commands.ParameterizedCommand;
+import org.eclipse.core.runtime.ILog;
+import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
+import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.commands.ICommandService;
+import org.eclipse.ui.console.ConsolePlugin;
+import org.eclipse.ui.console.IConsole;
+import org.eclipse.ui.console.IConsoleFactory;
+import org.eclipse.ui.handlers.IHandlerService;
+
+/**
+ * A Factory that supports open new Terminal Console.
+ */
+public class TerminalConsoleFactory implements IConsoleFactory {
+
+	@Override
+	public void openConsole() {
+		ICommandService commandService = PlatformUI.getWorkbench().getService(ICommandService.class);
+		IHandlerService handlerService = PlatformUI.getWorkbench().getService(IHandlerService.class);
+		if (commandService == null || handlerService == null) {
+			return;
+		}
+		Command command = commandService.getCommand("org.eclipse.tm.terminal.view.ui.command.launchConsole");
+		if (command == null) {
+			return;
+		}
+		ParameterizedCommand parameterizedCommand = ParameterizedCommand.generateCommand(command, Map.of());
+		try {
+			Object result = handlerService.executeCommandInContext(parameterizedCommand, null,
+					handlerService.getCurrentState());
+			if (result instanceof ITerminalConnector terminalConnector) {
+				TerminalConsole console = new TerminalConsole(terminalConnector);
+				ConsolePlugin.getDefault().getConsoleManager().addConsoles(new IConsole[] { console });
+			}
+		} catch (Exception e) {
+			ILog.get().error("Can't launch terminal console", e);
+		}
+	}
+
+}
diff --git a/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/TerminalConsolePage.java b/debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/TerminalConsolePage.java
@@ -13,15 +13,10 @@
  *******************************************************************************/
 package org.eclipse.debug.terminal.ui;
 
-import java.io.IOException;
-import java.io.OutputStream;
 import java.nio.charset.Charset;
+import java.util.function.Consumer;
 
-import org.eclipse.cdt.utils.spawner.Spawner;
 import org.eclipse.core.runtime.IAdaptable;
-import org.eclipse.debug.core.model.IBinaryStreamMonitor;
-import org.eclipse.debug.core.model.IStreamMonitor;
-import org.eclipse.debug.core.model.IStreamsProxy;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.layout.FillLayout;
 import org.eclipse.swt.widgets.Composite;
@@ -37,15 +32,15 @@
 
 class TerminalConsolePage implements IPageBookViewPage, IAdaptable {
 
-	private final Spawner process;
 	private IPageSite site;
 	private ITerminalViewControl viewer;
 	private Composite composite;
-	private final IStreamsProxy streamsProxy;
+	private ITerminalConnector connector;
+	private Consumer<ITerminalControl> terminalControlHandler;
 
-	public TerminalConsolePage(Spawner spawner, IStreamsProxy streamsProxy) {
-		this.process = spawner;
-		this.streamsProxy = streamsProxy;
+	public TerminalConsolePage(ITerminalConnector connector, Consumer<ITerminalControl> terminalControlHandler) {
+		this.connector = connector;
+		this.terminalControlHandler = terminalControlHandler;
 	}
 
 	@Override
@@ -54,30 +49,23 @@ public void createControl(Composite parent) {
 		composite.setLayout(new FillLayout());
 		viewer = TerminalViewControlFactory.makeControl(new ConsoleTerminalListener(), composite,
 				new ITerminalConnector[] {}, true);
-		viewer.setConnector(new ConsoleConnector(process));
+		viewer.setConnector(connector);
 		viewer.setCharset(Charset.defaultCharset());
 		viewer.clearTerminal();
 		viewer.connectTerminal();
 		if (viewer instanceof ITerminalControl ctrl) {
 			ctrl.setConnectOnEnterIfClosed(false);
 			ctrl.setVT100LineWrapping(true);
-			IStreamMonitor streamMonitor = streamsProxy.getOutputStreamMonitor();
-			if (streamMonitor instanceof IBinaryStreamMonitor bin) {
-				OutputStream outputStream = ctrl.getRemoteToTerminalOutputStream();
-				bin.addBinaryListener((data, monitor) -> {
-					try {
-						outputStream.write(data);
-					} catch (IOException e1) {
-						e1.printStackTrace();
-					}
-				});
+			if (terminalControlHandler != null) {
+				terminalControlHandler.accept(ctrl);
 			}
 		}
 	}
 
 	@Override
 	public void dispose() {
 		viewer.disposeTerminal();
+		composite.dispose();
 	}
 
 	@Override
diff --git a/terminal/plugins/org.eclipse.tm.terminal.view.ui/plugin.xml b/terminal/plugins/org.eclipse.tm.terminal.view.ui/plugin.xml
@@ -362,6 +362,12 @@
             id="org.eclipse.tm.terminal.view.ui.command.launch"
             name="%command.launch.selection.name">
       </command>
+    <command
+            categoryId="org.eclipse.tm.terminal.view.ui.commands.category"
+            helpContextId="org.eclipse.tm.terminal.view.ui.command_Launch"
+            id="org.eclipse.tm.terminal.view.ui.command.launchConsole"
+            name="%command.launch.selection.name">
+      </command>
       <command
             categoryId="org.eclipse.tm.terminal.view.ui.commands.category"
             helpContextId="org.eclipse.tm.terminal.view.ui.command_Launch"
@@ -397,6 +403,10 @@
             class="org.eclipse.tm.terminal.view.ui.internal.handler.LaunchTerminalCommandHandler"
             commandId="org.eclipse.tm.terminal.view.ui.command.launchToolbar">
       </handler>
+      <handler
+            class="org.eclipse.tm.terminal.view.ui.internal.handler.LaunchTerminalCommandHandler"
+            commandId="org.eclipse.tm.terminal.view.ui.command.launchConsole">
+      </handler>
       <handler
             class="org.eclipse.tm.terminal.view.ui.internal.handler.DisconnectTerminalCommandHandler"
             commandId="org.eclipse.tm.terminal.view.ui.command.disconnect">
diff --git a/terminal/plugins/org.eclipse.tm.terminal.view.ui/src/org/eclipse/tm/terminal/view/ui/internal/handler/LaunchTerminalCommandHandler.java b/terminal/plugins/org.eclipse.tm.terminal.view.ui/src/org/eclipse/tm/terminal/view/ui/internal/handler/LaunchTerminalCommandHandler.java
@@ -60,7 +60,22 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 		Shell shell = HandlerUtil.getActiveShell(event);
 		// Get the current selection
 		ISelection selection = HandlerUtil.getCurrentSelection(event);
-
+		if (commandId.equals("org.eclipse.tm.terminal.view.ui.command.launchConsole")) { //$NON-NLS-1$
+			LaunchTerminalSettingsDialog dialog = new LaunchTerminalSettingsDialog(shell, start);
+			if (dialog.open() == Window.OK) {
+				// Get the terminal settings from the dialog
+				Map<String, Object> properties = dialog.getSettings();
+				if (properties != null) {
+					String delegateId = (String) properties.get(ITerminalsConnectorConstants.PROP_DELEGATE_ID);
+					Assert.isNotNull(delegateId);
+					ILauncherDelegate delegate = LauncherDelegateManager.getInstance().getLauncherDelegate(delegateId,
+							false);
+					Assert.isNotNull(delegateId);
+					return delegate.createTerminalConnector(properties);
+				}
+			}
+			return null;
+		}
 		if (commandId.equals("org.eclipse.tm.terminal.view.ui.command.launchToolbar")) { //$NON-NLS-1$
 			if (UIPlugin.getTraceHandler().isSlotEnabled(0, ITraceIds.TRACE_LAUNCH_TERMINAL_COMMAND_HANDLER)) {
 				UIPlugin.getTraceHandler().trace("(a) Attempt to open launch terminal settings dialog after " //$NON-NLS-1$
