Merge pull request #338 from brownts/bugfix/ssh_lldb_extraargs

Fix extra debugger args for LLDB and SSH.

Author: GitMensch

CHANGELOG.md

@@ -18,6 +18,7 @@
 * fix additional race conditions with setting breakpoints #313 (@brownts)
 * fix stack frame expansion in editor via use of the `startFrame` parameter #312 (@brownts)
 * allow specification of port/x11port via variable (as numeric string) #265 (@GitMensch)
+* Extra debugger arguments now work in all configurations #316, #338 fixing #206 (@GitMensch, @brownts)
 
 # 0.25.1
 

README.md

@@ -151,4 +151,52 @@ Because some builds requires one or more environment files to be sourced before
 command, you can use the `ssh.bootstrap` option to add some extra commands which will be prepended
 to the debugger call (using `&&` to join both).
 
+### Extra Debugger Arguments
+
+Additional arguments can be supplied to the debugger if needed.  These will be added when
+the debugger executable (e.g., gdb, lldb-mi, etc.) is launched.  Extra debugger arguments
+are supplied via the `debugger_args` setting.  Note that the behavior of escaping these
+options depends on the environment in which the debugger is started.  For non-SSH
+debugging, the options are passed directly to the application and therefore no escaping is
+necessary (other than what is necessary for the JSON configuration). However, as a result
+of the options being passed directly to the application, care must be taken to place
+switches and switch values as separate entities in `debugger_args`, if they would normally
+be separated by a space.   For example, supplying the option and value
+`-iex "set $foo = \"bar\""` would consist of the following `debugger_args`:
+```json
+"debugger_args" : ["-iex", "set $foo = \"bar\""]
+```
+If `=` is used to associate switches with their values, than the switch and value should
+be placed together instead.  In fact, the following example shows 4 different ways in
+which to specify the same switch and value, using both short and long format, as well as
+switch values supplied as a separate parameter or supplied via the `=`:
+- ```json
+  "debugger_args" : ["-iex", "set $foo = \"bar\""]
+  ```
+- ```json
+  "debugger_args" : ["-iex=set $foo = \"bar\""]
+  ```
+- ```json
+  "debugger_args" : ["--init-eval-command", "set $foo = \"bar\""]
+  ```
+- ```json
+  "debugger_args" : ["--init-eval-command=set $foo = \"bar\""]
+  ```
+Where escaping is really necessary is when running the debugger over SSH.  In this case,
+the options are not passed directly to the application, but are instead combined with the
+application name, joined together with any other options, and sent to the remote system to
+be parsed and executed.  Thus, depending on the remote system, different escaping may be
+necessary.  The following shows how the same command as above needs to be escaped
+differently based on whether the remote system is a POSIX or a Windows system.
+- SSH to Linux machine:
+  ```json
+  "debugger_args": ["-iex", "'set $foo = \"bar\"'"]
+  ```
+- SSH to Windows machine:
+  ```json
+  "debugger_args": ["-iex", "\"set $foo = \\\"bar\\\"\""]
+  ```
+You may need to experiment to find the correct escaping necessary for the command to be
+sent to the debugger as you intended.
+
 ## [Issues](https://github.com/WebFreak001/code-debug)

src/backend/mi2/mi2.ts

@@ -141,7 +141,7 @@ export class MI2 extends EventEmitter implements IBackend {
 						screen: args.remotex11screen
 					};
 				}
-				let sshCMD = this.application + " " + this.preargs.join(" ");
+				let sshCMD = this.application + " " + this.preargs.concat(this.extraargs || []).join(" ");
 				if (args.bootstrap) sshCMD = args.bootstrap + " && " + sshCMD;
 				if (attach)
 					sshCMD += " -p " + target;

src/backend/mi2/mi2lldb.ts

@@ -37,7 +37,8 @@ export class MI2_LLDB extends MI2 {
 
 	attach(cwd: string, executable: string, target: string): Thenable<any> {
 		return new Promise((resolve, reject) => {
-			this.process = ChildProcess.spawn(this.application, this.preargs, { cwd: cwd, env: this.procEnv });
+			const args = this.preargs.concat(this.extraargs || []);
+			this.process = ChildProcess.spawn(this.application, args, { cwd: cwd, env: this.procEnv });
 			this.process.stdout.on("data", this.stdout.bind(this));
 			this.process.stderr.on("data", this.stderr.bind(this));
 			this.process.on("exit", (() => { this.emit("quit"); }).bind(this));