fix: write openocd debug output to a file

Author: kolipakakondal

bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/process/IdfRuntimeProcess.java

@@ -10,13 +10,13 @@
 import java.util.Map;
 
 import org.eclipse.cdt.dsf.gdb.launching.GDBProcess;
+import org.eclipse.core.runtime.CoreException;
 import org.eclipse.debug.core.DebugPlugin;
 import org.eclipse.debug.core.ILaunch;
 import org.eclipse.debug.core.model.IStreamsProxy;
-import org.eclipse.debug.core.model.RuntimeProcess;
 import org.eclipse.debug.internal.core.NullStreamsProxy;
+import org.eclipse.debug.ui.IDebugUIConstants;
 
-import com.espressif.idf.core.util.StringUtil;
 import com.espressif.idf.debug.gdbjtag.openocd.dsf.process.monitors.StreamsProxy;
 
 /**
@@ -60,7 +60,32 @@ protected IStreamsProxy createStreamsProxy()
 				DebugPlugin.log(e);
 			}
 		}
-		StreamsProxy streamsProxy = new StreamsProxy(this, getSystemProcess(), charset, getLabel());
+		// Use Eclipse Common tab attribute for output file and append
+		final String outputFileName = getAttributeSafe(getLaunch().getLaunchConfiguration()::getAttribute,
+				IDebugUIConstants.ATTR_CAPTURE_IN_FILE, "");
+
+		final boolean append = getAttributeSafe(getLaunch().getLaunchConfiguration()::getAttribute,
+				IDebugUIConstants.ATTR_APPEND_TO_FILE, false);
+		StreamsProxy streamsProxy = new StreamsProxy(this, getSystemProcess(), charset, getLabel(), outputFileName, append);
 		return streamsProxy;
 	}
+	
+	private <T> T getAttributeSafe(AttributeGetter<T> getter, String attribute, T defaultValue)
+	{
+		try
+		{
+			return getter.get(attribute, defaultValue);
+		}
+		catch (CoreException e)
+		{
+			DebugPlugin.log(e);
+			return defaultValue;
+		}
+	}
+
+	@FunctionalInterface
+	interface AttributeGetter<T>
+	{
+		T get(String attribute, T defaultValue) throws CoreException;
+	}
 }

bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/process/StreamListener.java

@@ -6,11 +6,14 @@
 
 import java.io.BufferedReader;
 import java.io.File;
+import java.io.FileWriter;
 import java.io.IOException;
+import java.io.PrintWriter;
 import java.io.StringReader;
 import java.nio.charset.Charset;
 import java.util.List;
 
+import org.eclipse.core.variables.VariablesPlugin;
 import org.eclipse.debug.core.IStreamListener;
 import org.eclipse.debug.core.model.IFlushableStreamMonitor;
 import org.eclipse.debug.core.model.IProcess;
@@ -50,11 +53,24 @@ public class StreamListener implements IStreamListener
 	private boolean fStreamClosed = false;
 	private List<ReHintPair> reHintsList;
 
+	private String outputFile;
+	private PrintWriter fileWriter;
+
 	public StreamListener(IProcess iProcess, IStreamMonitor errorStreamMonitor, IStreamMonitor outputStreamMonitor,
-			Charset charset)
+			Charset charset, String outputFile, boolean append)
 	{
 		fErrorStreamMonitor = errorStreamMonitor;
 		fOutputStreamMonitor = outputStreamMonitor;
+		this.outputFile = outputFile;
+		String resolvedOutputFile = resolveOutputFilePath(outputFile);
+		if (resolvedOutputFile != null && !resolvedOutputFile.isEmpty()) {
+			try {
+				fileWriter = new PrintWriter(new FileWriter(resolvedOutputFile, append), true);
+			} catch (IOException e) {
+				Logger.log(e);
+				fileWriter = null;
+			}
+		}
 
 		idfProcessConsole = IdfProcessConsoleFactory.showAndActivateConsole(charset);
 		// Clear the console only at the beginning, when OpenOCD starts
@@ -112,6 +128,9 @@ public void streamAppended(String text, IStreamMonitor monitor)
 		{
 			while ((line = bufferedReader.readLine()) != null)
 			{
+				if (outputFile != null && !outputFile.isEmpty() && fileWriter != null) {
+					fileWriter.println(line);
+				}
 
 				if (line.startsWith("Error:") && fConsoleErrorOutputStream != null) //$NON-NLS-1$
 				{
@@ -186,5 +205,38 @@ public void dispose()
 		}
 		fErrorStreamMonitor = null;
 		fOutputStreamMonitor = null;
+		if (fileWriter != null) {
+			fileWriter.close();
+			fileWriter = null;
+		}
+	}
+
+	/**
+	 * Resolves the output file path, expands variables, handles directory case, and ensures file/parent directories exist.
+	 */
+	private static String resolveOutputFilePath(String outputFile) {
+		if (outputFile == null || outputFile.isEmpty()) {
+			return null;
+		}
+		try {
+			// Expand Eclipse variables (e.g., ${workspace_loc:...})
+			String expanded = VariablesPlugin.getDefault().getStringVariableManager().performStringSubstitution(outputFile);
+			File file = new File(expanded);
+			if (file.isDirectory() || (!file.exists() && expanded.endsWith(File.separator))) {
+				// If it's a directory or ends with a separator, append openocd.log
+				file = new File(file, "openocd.log");
+			}
+			File parent = file.getParentFile();
+			if (parent != null && !parent.exists()) {
+				parent.mkdirs();
+			}
+			if (!file.exists()) {
+				file.createNewFile();
+			}
+			return file.getAbsolutePath();
+		} catch (Exception e) {
+			Logger.log(e);
+			return null;
+		}
 	}
 }

bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/process/monitors/StreamsProxy.java

@@ -62,14 +62,14 @@ public class StreamsProxy implements IBinaryStreamsProxy {
 	 * @param charset the process's charset or <code>null</code> if default
 	 * @param processLabel The name for the process label
 	 */
-	public StreamsProxy(IProcess iProcess, Process process, Charset charset, String processLabel) {
+	public StreamsProxy(IProcess iProcess, Process process, Charset charset, String processLabel, String outputFile, boolean append) {
 		if (process == null) {
 			return;
 		}
 		fOutputMonitor = new CustomOutputStreamMonitor(process.getInputStream(), charset);
 		fErrorMonitor = new CustomOutputStreamMonitor(process.getErrorStream(), charset);
 		// Our own addition to make sure that we utilize only one listener for all streams
-		StreamListener streamListener = new StreamListener(iProcess, fErrorMonitor, fOutputMonitor, charset);
+		StreamListener streamListener = new StreamListener(iProcess, fErrorMonitor, fOutputMonitor, charset, outputFile, append);
 		fOutputMonitor.addListener(streamListener);
 		fErrorMonitor.addListener(streamListener);
 		fInputMonitor = new InputStreamMonitor(process.getOutputStream(), charset);