Skip to content

Commit 09c826a

Browse files
zobozobo
committed
Implement var_export in TS to format property
1 parent 091281e commit 09c826a

File tree

5 files changed

+86
-19
lines changed

5 files changed

+86
-19
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
66

7+
## [1.36.0]
8+
9+
- Implement copy to clipboard in var_export format
10+
711
## [1.35.0]
812

913
- Support for DBGp stream command

‎src/phpDebug.ts‎

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import { randomUUID } from 'crypto'
1919
import { getConfiguredEnvironment } from './envfile'
2020
import { XdebugCloudConnection } from './cloud'
2121
import { shouldIgnoreException } from './ignore'
22+
import { varExportProperty } from './varExport'
2223

2324
if (process.env['VSCODE_NLS_CONFIG']) {
2425
try {
@@ -1470,34 +1471,28 @@ class PhpDebugSession extends vscode.DebugSession {
14701471
if (args.context === 'hover') {
14711472
// try to get variable from property_get
14721473
const ctx = await stackFrame.getContexts() // TODO CACHE THIS
1473-
const response = await connection.sendPropertyGetNameCommand(args.expression, ctx[0])
1474-
if (response.property) {
1475-
result = response.property
1474+
const res = await connection.sendPropertyGetNameCommand(args.expression, ctx[0])
1475+
if (res.property) {
1476+
result = res.property
14761477
}
14771478
} else if (args.context === 'repl') {
14781479
const uuid = randomUUID()
14791480
await connection.sendEvalCommand(`$GLOBALS['eval_cache']['${uuid}']=${args.expression}`)
14801481
const ctx = await stackFrame.getContexts() // TODO CACHE THIS
1481-
const response = await connection.sendPropertyGetNameCommand(`$eval_cache['${uuid}']`, ctx[1])
1482-
if (response.property) {
1483-
result = response.property
1482+
const res = await connection.sendPropertyGetNameCommand(`$eval_cache['${uuid}']`, ctx[1])
1483+
if (res.property) {
1484+
result = res.property
14841485
}
14851486
} else if (args.context === 'clipboard') {
1486-
const uuid = randomUUID()
14871487
const ctx = await stackFrame.getContexts() // TODO CACHE THIS
1488-
await connection.sendEvalCommand(
1489-
`$GLOBALS['eval_cache']['${uuid}']=var_export(${args.expression}, true)`,
1490-
ctx[1]
1491-
)
1492-
const res = await connection.sendPropertyValueNameCommand(`$eval_cache['${uuid}']`, ctx[1])
1493-
// force a string response
1494-
response.body = { result: res.value, variablesReference: 0 }
1488+
const res = await connection.sendPropertyGetNameCommand(args.expression, ctx[0])
1489+
response.body = { result: await varExportProperty(res.property), variablesReference: 0 }
14951490
this.sendResponse(response)
14961491
return
14971492
} else {
1498-
const response = await connection.sendEvalCommand(args.expression)
1499-
if (response.result) {
1500-
result = response.result
1493+
const res = await connection.sendEvalCommand(args.expression)
1494+
if (res.result) {
1495+
result = res.result
15011496
}
15021497
}
15031498

‎src/test/adapter.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -863,7 +863,7 @@ describe('PHP Debug Adapter', () => {
863863

864864
assert.equal(
865865
response3.result,
866-
"array (\n 0 => 1,\n 'test' => 2,\n 'test2' => \n array (\n 't' => 123,\n ),\n)"
866+
'array (\n 0 => 1,\n test => 2,\n test2 => \n array (\n t => 123,\n ),\n)'
867867
)
868868
assert.equal(response3.variablesReference, 0)
869869
})

‎src/varExport.ts‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import * as xdebug from './xdebugConnection'
2+
3+
export async function varExportProperty(property: xdebug.Property, indent: string = ''): Promise<string> {
4+
if (indent.length >= 20) {
5+
// prevent infinite recursion
6+
return `...`
7+
}
8+
9+
let displayValue: string
10+
if (property.hasChildren || property.type === 'array' || property.type === 'object') {
11+
if (!property.children || property.children.length === 0) {
12+
// TODO: also take into account the number of children for pagination
13+
property.children = await property.getChildren()
14+
}
15+
displayValue = (
16+
await Promise.all(
17+
property.children.map(async property => {
18+
const indent2 = indent + ' '
19+
if (property.hasChildren) {
20+
return `${indent2}${property.name} => \n${indent2}${await varExportProperty(
21+
property,
22+
indent2
23+
)},`
24+
} else {
25+
return `${indent2}${property.name} => ${await varExportProperty(property, indent2)},`
26+
}
27+
})
28+
)
29+
).join('\n')
30+
31+
if (property.type === 'array') {
32+
// for arrays, show the length, like a var_dump would do
33+
displayValue = `array (\n${displayValue}\n${indent})`
34+
} else if (property.type === 'object' && property.class) {
35+
// for objects, show the class name as type (if specified)
36+
displayValue = `${property.class}::__set_state(array(\n${displayValue}\n${indent}))`
37+
} else {
38+
// edge case: show the type of the property as the value
39+
displayValue = `?${property.type}?(\n${displayValue})`
40+
}
41+
} else {
42+
// for null, uninitialized, resource, etc. show the type
43+
displayValue = property.value || property.type === 'string' ? property.value : property.type
44+
if (property.type === 'string') {
45+
// escaping ?
46+
if (property.size > property.value.length) {
47+
// get value
48+
const p2 = await property.context.stackFrame.connection.sendPropertyValueNameCommand(
49+
property.fullName,
50+
property.context
51+
)
52+
displayValue = p2.value
53+
}
54+
displayValue = `'${displayValue}'`
55+
} else if (property.type === 'bool') {
56+
displayValue = Boolean(parseInt(displayValue, 10)).toString()
57+
}
58+
}
59+
return displayValue
60+
}

‎src/xdebugConnection.ts‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,8 @@ export abstract class BaseProperty {
525525
hasChildren: boolean
526526
/** the number of children this property has, if any. Useful for showing array length. */
527527
numberOfChildren: number
528+
/** the size of the value */
529+
size: number
528530
/** the value of the property for primitive types */
529531
value: string
530532
/** children that were already included in the response */
@@ -550,6 +552,9 @@ export abstract class BaseProperty {
550552
if (propertyNode.hasAttribute('facet')) {
551553
this.facets = propertyNode.getAttribute('facet')!.split(' ')
552554
}
555+
if (propertyNode.hasAttribute('size')) {
556+
this.size = parseInt(propertyNode.getAttribute('size') ?? '0')
557+
}
553558
this.hasChildren = !!parseInt(propertyNode.getAttribute('children')!)
554559
if (this.hasChildren) {
555560
this.numberOfChildren = parseInt(propertyNode.getAttribute('numchildren')!)
@@ -1174,7 +1179,10 @@ export class Connection extends DbgpConnection {
11741179

11751180
/** sends an eval command */
11761181
public async sendEvalCommand(expression: string, context?: Context): Promise<EvalResponse> {
1177-
return new EvalResponse(await this._enqueueCommand('eval', context ? `-d ${context.stackFrame.level}` : undefined, expression), this)
1182+
return new EvalResponse(
1183+
await this._enqueueCommand('eval', context ? `-d ${context.stackFrame.level}` : undefined, expression),
1184+
this
1185+
)
11781186
}
11791187

11801188
// ------------------------------ stream ----------------------------------------

0 commit comments

Comments
 (0)