feat: Implement additional evaluate contexts and extend variables and watch context menus

Author: zobo

package.json

@@ -568,6 +568,30 @@
           "command": "extension.php-debug.runEditorContents",
           "when": "resourceLangId == php && !inDiffEditor && resourceScheme == file"
         }
+      ],
+      "debug/variables/context": [
+        {
+          "command": "extension.php-debug.copyVarExport",
+          "group": "5_cutcopypaste@10",
+          "when": "debugType == php"
+        },
+        {
+          "command": "extension.php-debug.copyJson",
+          "group": "5_cutcopypaste@11",
+          "when": "debugType == php"
+        }
+      ],
+      "debug/watch/context": [
+        {
+          "command": "extension.php-debug.copyVarExport",
+          "group": "3_modification@51",
+          "when": "debugType == php"
+        },
+        {
+          "command": "extension.php-debug.copyJson",
+          "group": "3_modification@52",
+          "when": "debugType == php"
+        }
       ]
     },
     "commands": [
@@ -589,6 +613,14 @@
         "category": "PHP Debug",
         "enablement": "!inDebugMode",
         "icon": "$(play)"
+      },
+      {
+        "command": "extension.php-debug.copyVarExport",
+        "title": "Copy Value as var_export"
+      },
+      {
+        "command": "extension.php-debug.copyJson",
+        "title": "Copy Value as json_encode"
       }
     ],
     "keybindings": [

src/extension.ts

@@ -1,8 +1,9 @@
 import * as vscode from 'vscode'
 import { WorkspaceFolder, DebugConfiguration, CancellationToken } from 'vscode'
-import { LaunchRequestArguments } from './phpDebug'
+import { EvaluateExtendedArguments, LaunchRequestArguments } from './phpDebug'
 import * as which from 'which'
 import * as path from 'path'
+import { DebugProtocol } from '@vscode/debugprotocol'
 
 export function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(
@@ -143,4 +144,49 @@ export function activate(context: vscode.ExtensionContext) {
             })
         })
     )
+
+    /* This is coppied from vscode/src/vs/workbench/contrib/debug/browser/variablesView.ts */
+    interface IVariablesContext {
+        sessionId: string | undefined
+        container: DebugProtocol.Variable | DebugProtocol.Scope | DebugProtocol.EvaluateArguments
+        variable: DebugProtocol.Variable
+    }
+
+    /* This is coppied from @vscode/debugprotocol/lib/debugProtocol.d.ts because customRequest returns the body of the response and not the response itself */
+    interface EvaluateResponse {
+        /** The result of the evaluate request. */
+        result: string
+    }
+
+    const copyVar = async (arg: IVariablesContext, context: string) => {
+        const aci = vscode.debug.activeStackItem
+        if (aci && aci instanceof vscode.DebugStackFrame) {
+            const ret = (await vscode.debug.activeDebugSession?.customRequest('evaluate', <EvaluateExtendedArguments>{
+                context,
+                expression: arg.variable.evaluateName,
+                frameId: aci.frameId,
+                variablesReference: arg.variable.variablesReference,
+            })) as EvaluateResponse
+            await vscode.env.clipboard.writeText(ret.result)
+        } else {
+            await vscode.window.showErrorMessage('Cannot derermine active debug session')
+        }
+    }
+
+    context.subscriptions.push(
+        vscode.commands.registerCommand(
+            'extension.php-debug.copyVarExport',
+            async (arg: IVariablesContext, p2: any, p3: any) => {
+                await copyVar(arg, 'clipboard-var_export')
+            }
+        )
+    )
+    context.subscriptions.push(
+        vscode.commands.registerCommand(
+            'extension.php-debug.copyJson',
+            async (arg: IVariablesContext, p2: any, p3: any) => {
+                await copyVar(arg, 'clipboard-json')
+            }
+        )
+    )
 }

src/phpDebug.ts

@@ -20,6 +20,7 @@ import { XdebugCloudConnection } from './cloud'
 import { shouldIgnoreException } from './ignore'
 import { varExportProperty } from './varExport'
 import { supportedEngine } from './xdebugUtils'
+import { varJsonProperty } from './varJson'
 
 if (process.env['VSCODE_NLS_CONFIG']) {
     try {
@@ -56,6 +57,11 @@ function formatPropertyValue(property: xdebug.BaseProperty): string {
     return displayValue
 }
 
+export interface EvaluateExtendedArguments extends VSCodeDebugProtocol.EvaluateArguments {
+    /** The variable for which to retrieve its children. The `variablesReference` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the Overview section for details. */
+    variablesReference?: number
+}
+
 /**
  * This interface should always match the schema found in the mock-debug extension manifest.
  */
@@ -1496,9 +1502,18 @@ class PhpDebugSession extends vscode.DebugSession {
         this.shutdown()
     }
 
+    private getPropertyFromReference(variablesReference?: number): xdebug.Property | undefined {
+        if (variablesReference && this._properties.has(variablesReference)) {
+            return this._properties.get(variablesReference)!
+        } /*else if (variablesReference && this._evalResultProperties.has(variablesReference)) {
+                    return this._evalResultProperties.get(variablesReference)!
+                }*/
+        return
+    }
+
     protected async evaluateRequest(
         response: VSCodeDebugProtocol.EvaluateResponse,
-        args: VSCodeDebugProtocol.EvaluateArguments
+        args: EvaluateExtendedArguments
     ): Promise<void> {
         try {
             if (!args.frameId) {
@@ -1525,10 +1540,26 @@ class PhpDebugSession extends vscode.DebugSession {
                 if (res.property) {
                     result = res.property
                 }
-            } else if (args.context === 'clipboard') {
-                const ctx = await stackFrame.getContexts() // TODO CACHE THIS
-                const res = await connection.sendPropertyGetNameCommand(args.expression, ctx[0])
-                response.body = { result: await varExportProperty(res.property), variablesReference: 0 }
+            } else if (args.context === 'clipboard-var_export') {
+                const property =
+                    this.getPropertyFromReference(args.variablesReference) ??
+                    (await (async () => {
+                        const ctx = await stackFrame.getContexts() // TODO CACHE THIS
+                        const res = await connection.sendPropertyGetNameCommand(args.expression, ctx[0])
+                        return res.property
+                    })())
+                response.body = { result: await varExportProperty(property), variablesReference: 0 }
+                this.sendResponse(response)
+                return
+            } else if (args.context === 'clipboard-json') {
+                const property =
+                    this.getPropertyFromReference(args.variablesReference) ??
+                    (await (async () => {
+                        const ctx = await stackFrame.getContexts() // TODO CACHE THIS
+                        const res = await connection.sendPropertyGetNameCommand(args.expression, ctx[0])
+                        return res.property
+                    })())
+                response.body = { result: await varJsonProperty(property), variablesReference: 0 }
                 this.sendResponse(response)
                 return
             } else if (args.context === 'watch') {

src/varJson.ts

@@ -0,0 +1,61 @@
+import { randomUUID } from 'crypto'
+import * as xdebug from './xdebugConnection'
+
+const recursionMagic = `---MAGIC---${randomUUID()}---MAGIC---`
+
+/**
+ * Generate a JSON object and pretty print it
+ */
+export async function varJsonProperty(property: xdebug.Property): Promise<string> {
+    const obj = await _varJsonProperty(property)
+    const json = JSON.stringify(obj, null, ' ')
+    return json.replace(new RegExp(`"${recursionMagic}"`, 'g'), '...')
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+async function _varJsonProperty(property: xdebug.Property, depth: number = 0): Promise<any> {
+    if (depth >= 20) {
+        // prevent infinite recursion
+        return recursionMagic
+    }
+
+    let displayValue: string
+    if (property.hasChildren || property.type === 'array' || property.type === 'object') {
+        if (!property.children || property.children.length === 0) {
+            // TODO: also take into account the number of children for pagination
+            property.children = await property.getChildren()
+        }
+
+        const obj = await Promise.all(
+            property.children.map(async property => {
+                return [property.name, <object>await _varJsonProperty(property, depth + 1)]
+            })
+        )
+
+        // TODO: handle only numeric, sequential arrays?
+
+        return <object>Object.fromEntries(obj)
+    } else {
+        // for null, uninitialized, resource, etc. show the type
+        displayValue = property.value || property.type === 'string' ? property.value : property.type
+        if (property.type === 'string') {
+            // escaping ?
+            if (property.size > property.value.length) {
+                // get value
+                const p2 = await property.context.stackFrame.connection.sendPropertyValueNameCommand(
+                    property.fullName,
+                    property.context
+                )
+                displayValue = p2.value
+            }
+            return displayValue
+        } else if (property.type === 'bool') {
+            return Boolean(parseInt(displayValue, 10))
+        } else if (property.type === 'int') {
+            return parseInt(displayValue, 10)
+        } else if (property.type === 'float' || property.type === 'double') {
+            return parseFloat(displayValue)
+        } else {
+            return property.value
+        }
+    }
+}