Implement basic Terminal Debug View. See

#161

Author: angelozerr

eclipse/terminal/ts.eclipse.ide.terminal.interpreter.tests/src/ts/eclipse/ide/terminal/interpreter/TrackerTest.java

@@ -19,10 +19,6 @@
  */
 public class TrackerTest extends CommandTerminalTracker {
 
-	static {
-		CommandTerminalTracker.DEBUG = false;
-	}
-
 	private final String userHome;
 	private final StringBuilder result;
 

eclipse/terminal/ts.eclipse.ide.terminal.interpreter/plugin.properties

@@ -18,4 +18,7 @@ interpreter.del.name=Interpret 'del' commands to refresh the Project Explorer.
 interpreter.rd.name=Interpret 'rd' commands to refresh the Project Explorer.
 
 # Local Terminal - Interpreter
-terminal.interpreter.name=Local Terminal (Interpreter)
+terminal.interpreter.name=Local Terminal (Interpreter)
+
+# Command Terminal Debug
+CommandTerminalDebugView.name=Terminal Debug

eclipse/terminal/ts.eclipse.ide.terminal.interpreter/plugin.xml

@@ -55,4 +55,12 @@
             class="ts.eclipse.ide.terminal.interpreter.internal.commands.RdCommandInterpreterFactory">
       </factory>
    </extension>
+   
+	<extension point="org.eclipse.ui.views">
+      <view id="com.example.myplugin.view"
+         name="%CommandTerminalDebugView.name"
+         class="ts.eclipse.ide.terminal.interpreter.internal.view.CommandTerminalDebugView"
+      />
+ 	</extension>
+    
 </plugin>        

eclipse/terminal/ts.eclipse.ide.terminal.interpreter/src/ts/eclipse/ide/terminal/interpreter/CommandTerminalService.java

@@ -1,5 +1,6 @@
 package ts.eclipse.ide.terminal.interpreter;
 
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -17,8 +18,11 @@ public class CommandTerminalService extends TerminalService {
 
 	private final Map<String, TerminalConnectorWrapper> connectors;
 
+	private final List<ICommandInterpreterListener> listeners;
+
 	public CommandTerminalService() {
 		this.connectors = new HashMap<>();
+		this.listeners = new ArrayList<>();
 	}
 
 	public static CommandTerminalService getInstance() {
@@ -91,4 +95,22 @@ public void unregisterConnector(TerminalConnectorWrapper connector) {
 		}
 	}
 
+	public void addCommandTerminalListener(ICommandInterpreterListener listener) {
+		synchronized (listeners) {
+			if (!listeners.contains(listener)) {
+				listeners.add(listener);
+			}
+		}
+	}
+
+	public void removeCommandTerminalListener(ICommandInterpreterListener listener) {
+		synchronized (listeners) {
+			listeners.remove(listener);
+		}
+	}
+
+	public List<ICommandInterpreterListener> getInterpreterListeners() {
+		return listeners;
+	}
+
 }

eclipse/terminal/ts.eclipse.ide.terminal.interpreter/src/ts/eclipse/ide/terminal/interpreter/ICommandInterpreterListener.java

@@ -0,0 +1,25 @@
+/**
+ *  Copyright (c) 2015-2017 Angelo ZERR.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  Contributors:
+ *  Angelo Zerr <[email protected]> - initial API and implementation
+ */
+package ts.eclipse.ide.terminal.interpreter;
+
+/**
+ * Command interpreter listener.
+ *
+ */
+public interface ICommandInterpreterListener {
+
+	void onOpenTerminal(String initialWorkingDir, String initialCommand, String userHome);
+
+	void onProcessText(String text, int columns);
+
+	void onCarriageReturnLineFeed();
+
+}

eclipse/terminal/ts.eclipse.ide.terminal.interpreter/src/ts/eclipse/ide/terminal/interpreter/ICommandTerminalListener.java

@@ -13,6 +13,9 @@
 
 import java.io.File;
 
+import ts.eclipse.ide.terminal.interpreter.CommandTerminalService;
+import ts.eclipse.ide.terminal.interpreter.ICommandInterpreterListener;
+
 /**
  * Command terminal tracker.
  *
@@ -21,8 +24,6 @@ public abstract class CommandTerminalTracker extends AnsiHandler {
 
 	private static final String TILD = "~";
 
-	public static boolean DEBUG = false;
-
 	private final String initialWorkingDir;
 	private final String initialCommand;
 	private LineCommand lineCommand;
@@ -34,9 +35,7 @@ public CommandTerminalTracker(String initialWorkingDir, String initialCommand) {
 		this.initialWorkingDir = initialWorkingDir;
 		this.initialCommand = initialCommand;
 		this.columns = 80;
-		if (DEBUG) {
-			traceTrackerTest(initialWorkingDir, initialCommand, getUserHome());
-		}
+		onOpenTerminal(initialWorkingDir, initialCommand, getUserHome());
 	}
 
 	@Override
@@ -45,9 +44,7 @@ protected void processText(String text) {
 	}
 
 	protected void processText(String text, int columns) {
-		if (DEBUG) {
-			traceProcessText(text, columns);
-		}
+		onProcessText(text, columns);
 		processLine(text);
 	}
 
@@ -56,9 +53,7 @@ protected void processCarriageReturnLineFeed() {
 		// CRLF is thrown when:
 		// - User types 'Enter' to submit a command.
 		// - OR in Windows OS, when a new line is displayed in the DOS Command.
-		if (DEBUG) {
-			traceProcessCarriageReturnLineFeed();
-		}
+		onCarriageReturnLineFeed();
 		if (lineCommand == null) {
 			// Line command was not found in the terminal, ignore the CR event.
 			return;
@@ -174,7 +169,7 @@ private boolean updateLineCommand(String line) {
 			}
 			if (state == LineCommandState.SUBMITTED) {
 				// Case when command is terminated.
-				this.newWorkingDir =  resolveTild(workinDir);
+				this.newWorkingDir = resolveTild(workinDir);
 				this.terminate();
 			} else {
 				// Case when user is typing a command, update it.
@@ -231,13 +226,13 @@ private LineCommand tryToCreateLineCommand(String line, String initialWorkingDir
 				(initialCommandIndex != -1 ? initialCommandIndex : line.length())).trim();
 		return new LineCommand(initialWorkingDir, initialCommand, beforeWorkingDir, afterWorkingDir);
 	}
-	
-	private String resolveTild(String line)  {
+
+	private String resolveTild(String line) {
 		if (line.contains(TILD)) {
 			String home = getUserHome();
 			return line.replaceFirst("^~", home);
 		}
-		return line;		
+		return line;
 	}
 
 	protected String getUserHome() {
@@ -251,50 +246,28 @@ protected String getUserHome() {
 
 	// ---------------------- Trace to generate JUnit
 
-	private void traceTrackerTest(String initialWorkingDir, String initialCommand, String userHome) {
-		StringBuilder code = new StringBuilder("TrackerTest test = new TrackerTest(");		
-		if (initialWorkingDir == null) {
-			code.append("null");
-		} else {
-			code.append("\"");
-			code.append(initialWorkingDir.replaceAll("[\"]", "\\\"").replaceAll("\\\\", "\\\\\\\\"));
-			code.append("\"");
-		}
-		code.append(", ");
-		if (initialCommand == null) {
-			code.append("null");
-		} else {
-			code.append("\"");
-			code.append(initialCommand.replaceAll("[\"]", "\\\"").replaceAll("\\\\", "\\\\\\\\"));
-			code.append("\"");
+	private void onOpenTerminal(String initialWorkingDir, String initialCommand, String userHome) {
+		for (ICommandInterpreterListener listener : CommandTerminalService.getInstance().getInterpreterListeners()) {
+			listener.onOpenTerminal(initialWorkingDir, initialCommand, userHome);
 		}
-		code.append(", ");
-		code.append("\"");
-		code.append(userHome);
-		code.append("\"");
-		code.append(");");
-		System.err.println(code.toString());
 	}
 
-	private void traceProcessText(String text, int columns) {
-		StringBuilder code = new StringBuilder("test.processText(");
-		code.append("\"");
-		code.append(text.replaceAll("[\"]", "\\\"").replaceAll("\\\\", "\\\\\\\\"));
-		code.append("\", ");
-		code.append(columns);
-		code.append(");");
-		System.err.println(code.toString());
+	private void onProcessText(String text, int columns) {
+		for (ICommandInterpreterListener listener : CommandTerminalService.getInstance().getInterpreterListeners()) {
+			listener.onProcessText(text, columns);
+		}
 	}
 
-	private void traceProcessCarriageReturnLineFeed() {
-		StringBuilder code = new StringBuilder("test.processCarriageReturnLineFeed();");
-		System.err.println(code.toString());
+	private void onCarriageReturnLineFeed() {
+		for (ICommandInterpreterListener listener : CommandTerminalService.getInstance().getInterpreterListeners()) {
+			listener.onCarriageReturnLineFeed();
+		}
 	}
 
 	public void setColumns(int columns) {
 		this.columns = columns;
 	}
-	
+
 	private static String rtrim(String s) {
 		int i = s.length() - 1;
 		while (i >= 0 && Character.isWhitespace(s.charAt(i))) {