feat: DBGp stream redirect support

src/phpDebug.ts

@@ -561,6 +561,13 @@ class PhpDebugSession extends vscode.DebugSession {
             throw new Error(`Error applying xdebugSettings: ${String(error instanceof Error ? error.message : error)}`)
         }
 
+        if (this._args.externalConsole) {
+            await connection.sendStdout('1')
+            connection.on('stream', (stream: xdebug.Stream) =>
+                this.sendEvent(new vscode.OutputEvent(stream.value, 'stdout'))
+            )
+        }
+
         this.sendEvent(new vscode.ThreadEvent('started', connection.id))
 
         // wait for all breakpoints

src/xdebugConnection.ts

@@ -179,6 +179,24 @@ export class UserNotify extends Notify {
     }
 }
 
+export class Stream {
+    /** Type of stream */
+    type: string
+    /** Data of the stream */
+    value: string
+
+    /** Constructs a stream object from an XML node from a Xdebug response */
+    constructor(document: XMLDocument) {
+        this.type = document.documentElement.getAttribute('type')!
+        const encoding = document.documentElement.getAttribute('encoding')
+        if (encoding) {
+            this.value = iconv.encode(document.documentElement.textContent!, encoding).toString()
+        } else {
+            this.value = document.documentElement.textContent!
+        }
+    }
+}
+
 export type BreakpointType = 'line' | 'call' | 'return' | 'exception' | 'conditional' | 'watch'
 export type BreakpointState = 'enabled' | 'disabled'
 export type BreakpointResolved = 'resolved' | 'unresolved'
@@ -745,6 +763,7 @@ export declare interface Connection extends DbgpConnection {
     on(event: 'log', listener: (text: string) => void): this
     on(event: 'notify_user', listener: (notify: UserNotify) => void): this
     on(event: 'notify_breakpoint_resolved', listener: (notify: BreakpointResolvedNotify) => void): this
+    on(event: 'stream', listener: (stream: Stream) => void): this
 }
 
 /**
@@ -809,6 +828,9 @@ export class Connection extends DbgpConnection {
             } else if (response.documentElement.nodeName === 'notify') {
                 const n = Notify.fromXml(response, this)
                 this.emit('notify_' + n.name, n)
+            } else if (response.documentElement.nodeName === 'stream') {
+                const s = new Stream(response)
+                this.emit('stream', s)
             } else {
                 const transactionId = parseInt(response.documentElement.getAttribute('transaction_id')!)
                 if (this._pendingCommands.has(transactionId)) {
@@ -1109,4 +1131,14 @@ export class Connection extends DbgpConnection {
     public async sendEvalCommand(expression: string): Promise<EvalResponse> {
         return new EvalResponse(await this._enqueueCommand('eval', undefined, expression), this)
     }
+
+    // ------------------------------ stream ----------------------------------------
+
+    public async sendStdout(mode: '0' | '1' | '2'): Promise<Response> {
+        return new Response(await this._enqueueCommand('stdout', `-c ${mode}`), this)
+    }
+
+    public async sendStderr(mode: '0' | '1' | '2'): Promise<Response> {
+        return new Response(await this._enqueueCommand('stdout', `-c ${mode}`), this)
+    }
 }