Add ability to prevent terminal title updates from ANSI Escape sequence

When a more complete implementation of ANSI Escape sequence for
renaming terminal titles was added in
[CDT 10.2](https://github.com/eclipse-cdt/cdt/blob/main/NewAndNoteworthy/CDT-10.2.md#rename-terminal-tab)
it caused a regression in use cases where extenders of the terminal
wanted to retain control of the terminal's title.

This commit adds a new flag that will prevent the title of the
terminal tab from being updated from ANSI escape sequences.

Fixes #494

Author: mmx85

terminal/plugins/org.eclipse.tm.terminal.control/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.tm.terminal.control; singleton:=true
-Bundle-Version: 5.4.100.qualifier
+Bundle-Version: 5.5.0.qualifier
 Bundle-Activator: org.eclipse.tm.internal.terminal.control.impl.TerminalPlugin
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin

terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalListener.java

@@ -28,8 +28,10 @@ public interface ITerminalListener {
 	void setState(TerminalState state);
 
 	/**
-	 * Set the title of the terminal.
+	 * @deprecated Migrate to implementing {@link ITerminalListener3} and
+	 * override {@link ITerminalListener3#setTerminalTitle(String, String)
 	 * @param title
 	 */
+	@Deprecated(forRemoval = true)
 	void setTerminalTitle(String title);
 }

terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalListener3.java

@@ -0,0 +1,40 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Infineon Technologies AG. All Rights Reserved.
+ *
+ * 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
+ *******************************************************************************/
+package org.eclipse.tm.internal.terminal.control;
+
+/**
+ * Terminal listener allowing to listen to terminal selection changes.
+ * The interface overrides the deprecated {@link #setTerminalTitle(String)} with
+ * {@link #setTerminalTitle(String, String)} that should be called instead.
+ *
+ * @since 5.5
+ */
+public interface ITerminalListener3 extends ITerminalListener2 {
+
+	/**
+	 * Enum defines terminal title change requestors for
+	 * setTerminalTitle method.
+	 *
+	 * @since 5.5
+	 */
+	enum TerminalTitleRequestor {
+		ANSI, // Terminal tab title change requested using ANSI command in terminal.
+		MENU, // Terminal tab title change requested from menu.
+		OTHER; // Terminal tab title change requested by other requestors.
+	}
+
+	/**
+	 * Set the title of the terminal.
+	 *
+	 * @param title Terminal title.
+	 * @param requestor Item that requests terminal title update.
+	 */
+	void setTerminalTitle(String title, TerminalTitleRequestor requestor);
+}

terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalViewControl.java

@@ -22,6 +22,7 @@
 import org.eclipse.swt.dnd.Clipboard;
 import org.eclipse.swt.graphics.Font;
 import org.eclipse.swt.widgets.Control;
+import org.eclipse.tm.internal.terminal.control.ITerminalListener3.TerminalTitleRequestor;
 import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
 import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;
 import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
@@ -192,9 +193,19 @@ public interface ITerminalViewControl {
 
 	/**
 	 * @since 5.1
+	 * @deprecated call {@link #setTerminalTitle(String, String)} instead
 	 */
+	@Deprecated(forRemoval = true)
 	void setTerminalTitle(String newTitle);
 
+	/**
+	 * Set the title of the terminal.
+	 * @param newTitle
+	 * @param requestor Item that requests terminal title update.
+	 * @since 5.5
+	 */
+	void setTerminalTitle(String newTitle, TerminalTitleRequestor requestor);
+
 	/**
 	 * @since 5.2
 	 */

terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/impl/ITerminalControlForText.java

@@ -14,6 +14,7 @@
 
 import java.io.OutputStream;
 
+import org.eclipse.tm.internal.terminal.control.ITerminalListener3.TerminalTitleRequestor;
 import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
 import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
 
@@ -28,7 +29,13 @@ public interface ITerminalControlForText {
 
 	void setState(TerminalState state);
 
-	void setTerminalTitle(String title);
+	/**
+	 * Set the title of the terminal.
+	 *
+	 * @param title Termianl title.
+	 * @param requestor Item that requests terminal title update.
+	 */
+	void setTerminalTitle(String title, TerminalTitleRequestor requestor);
 
 	ITerminalConnector getTerminalConnector();
 

terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/VT100Emulator.java

@@ -45,6 +45,7 @@
 import org.eclipse.swt.events.ControlEvent;
 import org.eclipse.swt.events.ControlListener;
 import org.eclipse.swt.graphics.RGB;
+import org.eclipse.tm.internal.terminal.control.ITerminalListener3.TerminalTitleRequestor;
 import org.eclipse.tm.internal.terminal.control.impl.ITerminalControlForText;
 import org.eclipse.tm.internal.terminal.control.impl.TerminalPlugin;
 import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
@@ -486,7 +487,7 @@ private void processAnsiOsCommand() {
 			Logger.log("Ignoring unsupported ANSI OSC sequence: '" + ansiOsCommand + "'"); //$NON-NLS-1$ //$NON-NLS-2$
 			return;
 		}
-		terminal.setTerminalTitle(ansiOsCommand.substring(2));
+		terminal.setTerminalTitle(ansiOsCommand.substring(2), TerminalTitleRequestor.ANSI);
 	}
 
 	/**

terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/VT100TerminalControl.java

@@ -98,6 +98,8 @@
 import org.eclipse.tm.internal.terminal.control.ICommandInputField;
 import org.eclipse.tm.internal.terminal.control.ITerminalListener;
 import org.eclipse.tm.internal.terminal.control.ITerminalListener2;
+import org.eclipse.tm.internal.terminal.control.ITerminalListener3;
+import org.eclipse.tm.internal.terminal.control.ITerminalListener3.TerminalTitleRequestor;
 import org.eclipse.tm.internal.terminal.control.ITerminalMouseListener;
 import org.eclipse.tm.internal.terminal.control.ITerminalViewControl;
 import org.eclipse.tm.internal.terminal.control.impl.ITerminalControlForText;
@@ -1261,7 +1263,17 @@ private void processKeyBinding(KeyEvent event, int accelerator) {
 
 	@Override
 	public void setTerminalTitle(String title) {
-		fTerminalListener.setTerminalTitle(title);
+		setTerminalTitle(title, TerminalTitleRequestor.OTHER);
+	}
+
+	@Override
+	public void setTerminalTitle(String title, TerminalTitleRequestor requestor) {
+		if (fTerminalListener instanceof ITerminalListener3 listener3) {
+			listener3.setTerminalTitle(title, requestor);
+		} else {
+			fTerminalListener.setTerminalTitle(title);
+		}
+
 	}
 
 	@Override

terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java

@@ -22,6 +22,7 @@
 
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Shell;
+import org.eclipse.tm.internal.terminal.control.ITerminalListener3.TerminalTitleRequestor;
 
 /**
  * Represents the terminal view as seen by a terminal connection.
@@ -155,11 +156,19 @@ public interface ITerminalControl {
 	OutputStream getRemoteToTerminalOutputStream();
 
 	/**
-	 * Set the title of the terminal view.
-	 * @param title
+	 * @deprecated call {@link #setTerminalTitle(String, String)} instead
 	 */
+	@Deprecated(forRemoval = true)
 	void setTerminalTitle(String title);
 
+	/**
+	 * Set the title of the terminal view.
+	 * @param title Termianl title.
+	 * @param requestor Item that requests terminal title update.
+	 * @since 5.5
+	 */
+	void setTerminalTitle(String title, TerminalTitleRequestor requestor);
+
 	/**
 	 * Show an error message during connect.
 	 * @param msg