Cleanup Terminal from deprecated code and extension interfaces

As we now have a new namespace we can use the opportunity to remove any
deprecated code and squash previous extension interfaces into one.

Author: laeubi

.github/workflows/doCleanCode.yml

@@ -14,6 +14,6 @@ jobs:
       author: Eclipse Platform Bot <[email protected]>
       do-quickfix: false
       do-cleanups: true
-      bundle-folders: ant/*/ debug/*/ resources/bundles/*/ runtime/bundles/*/ team/bundles/*/ ua/*/ update/*/ platform/*/
+      bundle-folders: ant/*/ debug/*/ resources/bundles/*/ runtime/bundles/*/ team/bundles/*/ ua/*/ update/*/ platform/*/ terminal/plugins/*/
     secrets:
       token: ${{ secrets.PLATFORM_BOT_PAT }}

debug/org.eclipse.debug.terminal/src/org/eclipse/debug/terminal/ui/ConsoleTerminalListener.java

@@ -24,8 +24,13 @@ public void setState(TerminalState state) {
 	}
 
 	@Override
-	public void setTerminalTitle(String title) {
-		// TODO redirect to the console?
+	public void setTerminalSelectionChanged() {
+
+	}
+
+	@Override
+	public void setTerminalTitle(String title, TerminalTitleRequestor requestor) {
+
 	}
 
 }

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

@@ -13,7 +13,6 @@
  *******************************************************************************/
 package org.eclipse.terminal.internal.control;
 
-import org.eclipse.terminal.internal.control.ITerminalListener3.TerminalTitleRequestor;
 import org.eclipse.terminal.internal.provisional.api.TerminalState;
 
 /**
@@ -29,10 +28,31 @@ public interface ITerminalListener {
 	void setState(TerminalState state);
 
 	/**
-	 * @deprecated Migrate to implementing {@link ITerminalListener3} and
-	 * override {@link ITerminalListener3#setTerminalTitle(String, TerminalTitleRequestor)}
-	 * @param title
+	 * selection has been changed internally e.g. select all
+	 * clients might want to react on that
+	 * NOTE: this does not include mouse selections
+	 * those are handled in separate MouseListeners
+	 * TODO should be unified
 	 */
-	@Deprecated(forRemoval = true)
-	void setTerminalTitle(String title);
+	void setTerminalSelectionChanged();
+
+	/**
+	 * 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/terminal/internal/control/ITerminalListener2.java

@@ -19,30 +19,42 @@
  * @see ITerminalMouseListener2
  */
 public interface ITerminalMouseListener {
+
 	/**
 	 * Invoked when a double-click has happend inside the terminal control.<br>
 	 * <br>
 	 * <strong>Important:</strong> the event fires for every click, even outside the text region.
 	 * @param terminalText a read-only view of the current terminal text
 	 * @param button see {@link org.eclipse.swt.events.MouseEvent#button} for the meaning of the button values
+	 * @param stateMask see {@link org.eclipse.swt.events.MouseEvent#stateMask} for the meaning of the values
 	 */
-	void mouseDoubleClick(ITerminalTextDataReadOnly terminalText, int line, int column, int button);
+	default void mouseDoubleClick(ITerminalTextDataReadOnly terminalText, int line, int column, int button,
+			int stateMask) {
+		// do nothing by default so that implementors only need to implement methods they care about
+	}
 
 	/**
 	 * Invoked when a mouse button is pushed down inside the terminal control.<br>
 	 * <br>
 	 * <strong>Important:</strong> the event fires for every mouse down, even outside the text region.
 	 * @param terminalText a read-only view of the current terminal text
 	 * @param button see {@link org.eclipse.swt.events.MouseEvent#button} for the meaning of the button values
+	 * @param stateMask see {@link org.eclipse.swt.events.MouseEvent#stateMask} for the meaning of the values
 	 */
-	void mouseDown(ITerminalTextDataReadOnly terminalText, int line, int column, int button);
+	default void mouseDown(ITerminalTextDataReadOnly terminalText, int line, int column, int button, int stateMask) {
+		// do nothing by default so that implementors only need to implement methods they care about
+	}
 
 	/**
 	 * Invoked when a mouse button is released inside the terminal control.<br>
 	 * <br>
 	 * <strong>Important:</strong> the event fires for every mouse up, even outside the text region.
 	 * @param terminalText a read-only view of the current terminal text
 	 * @param button see {@link org.eclipse.swt.events.MouseEvent#button} for the meaning of the button values
+	 * @param stateMask see {@link org.eclipse.swt.events.MouseEvent#stateMask} for the meaning of the values
 	 */
-	void mouseUp(ITerminalTextDataReadOnly terminalText, int line, int column, int button);
+	default void mouseUp(ITerminalTextDataReadOnly terminalText, int line, int column, int button, int stateMask) {
+		// do nothing by default so that implementors only need to implement methods they care about
+	}
+
 }

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

@@ -16,13 +16,12 @@
  ******************************************************************************/
 package org.eclipse.terminal.internal.control;
 
-import java.io.UnsupportedEncodingException;
 import java.nio.charset.Charset;
 
 import org.eclipse.swt.dnd.Clipboard;
 import org.eclipse.swt.graphics.Font;
 import org.eclipse.swt.widgets.Control;
-import org.eclipse.terminal.internal.control.ITerminalListener3.TerminalTitleRequestor;
+import org.eclipse.terminal.internal.control.ITerminalListener.TerminalTitleRequestor;
 import org.eclipse.terminal.internal.provisional.api.ITerminalConnector;
 import org.eclipse.terminal.internal.provisional.api.ITerminalControl;
 import org.eclipse.terminal.internal.provisional.api.TerminalState;
@@ -34,15 +33,6 @@
  * @noimplement This interface is not intended to be implemented by clients.
  */
 public interface ITerminalViewControl {
-	/**
-	 * Set the encoding that the Terminal uses to decode byte streams into
-	 * characters.
-	 *
-	 * @see ITerminalControl#setEncoding(String)
-	 * @deprecated Use {@link #setCharset(Charset)} and do the error handling in the UI code.
-	 */
-	@Deprecated
-	void setEncoding(String encoding) throws UnsupportedEncodingException;
 
 	/**
 	 * Set the charset that the Terminal uses to decode byte streams into
@@ -53,16 +43,6 @@ public interface ITerminalViewControl {
 	 */
 	void setCharset(Charset charset);
 
-	/**
-	 * Get the Terminal's current encoding.
-	 *
-	 * @return the current Encoding of the Terminal.
-	 * @see ITerminalControl#getEncoding()
-	 * @deprecated Use {@link #getCharset()} and call {@link Charset#name()} on the result
-	 */
-	@Deprecated
-	String getEncoding();
-
 	/**
 	 * @return the non-<code>null</code> current Charset of the Terminal.
 	 * @see ITerminalControl#getCharset()
@@ -72,14 +52,6 @@ public interface ITerminalViewControl {
 
 	boolean isEmpty();
 
-	/**
-	 * Sets the Terminal font
-	 * @deprecated use {@link #setFont(String)} in order to support bold and italic variants of the given font
-	 * @param font
-	 */
-	@Deprecated
-	void setFont(Font font);
-
 	/**
 	 * Sets the font for the Terminal, using a JFace symbolic font name, such
 	 * that bold and italic variants can be leveraged.
@@ -190,13 +162,6 @@ public interface ITerminalViewControl {
 	 */
 	void removeMouseListener(ITerminalMouseListener listener);
 
-	/**
-	 * @since 5.1
-	 * @deprecated call {@link #setTerminalTitle(String, TerminalTitleRequestor)} instead
-	 */
-	@Deprecated(forRemoval = true)
-	void setTerminalTitle(String newTitle);
-
 	/**
 	 * Set the title of the terminal.
 	 * @param newTitle

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

@@ -14,7 +14,7 @@
 
 import java.io.OutputStream;
 
-import org.eclipse.terminal.internal.control.ITerminalListener3.TerminalTitleRequestor;
+import org.eclipse.terminal.internal.control.ITerminalListener.TerminalTitleRequestor;
 import org.eclipse.terminal.internal.provisional.api.ITerminalConnector;
 import org.eclipse.terminal.internal.provisional.api.TerminalState;
 

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

@@ -45,7 +45,7 @@
 import org.eclipse.swt.events.ControlEvent;
 import org.eclipse.swt.events.ControlListener;
 import org.eclipse.swt.graphics.RGB;
-import org.eclipse.terminal.internal.control.ITerminalListener3.TerminalTitleRequestor;
+import org.eclipse.terminal.internal.control.ITerminalListener.TerminalTitleRequestor;
 import org.eclipse.terminal.internal.control.impl.ITerminalControlForText;
 import org.eclipse.terminal.internal.control.impl.TerminalPlugin;
 import org.eclipse.terminal.internal.provisional.api.ITerminalConnector;