Clarify property name encodings

derickr / dbgp

Common DeBugGer Protocol as used by Xdebug and other implementations.

http://xdebug.org/docs-dbgp.php

MIT License

23 stars 5 forks source link

Clarify property name encodings #17

Closed derickr closed 6 years ago

derickr commented 6 years ago

6.0 Added section detailing escaping rules for sending arguments to the debugger engine. Specifically crafted to prevent confusion around sending property names.
7.11 Clarify that IDEs must not apply any default escaping rules to read/write properties through property_get, property_set, and property_value.
7.11.1 Added header and describe extended properties better.

SvetlanaZem commented 6 years ago

Would you please improve descriptions of "name" and "fullname" attributes in 'get_property' response? It's not clear that Xdebug sends "name" and "fullname" without any escaping and IDE should use this name as is in the next 'property_get' request.

For example, "name" -> "variable name. This is the short part of the name. For instance, in PHP: $v = 0; // short name 'v' class:$v; // short name 'v'. The value is encoded in XML and does not follow 6.0 Escaping Rules".

https://xdebug.org/docs-dbgp.php#properties-variables-and-values

derickr commented 6 years ago

Sure, I'll have had a go at improving that. However, section 6.0 — "Escaping Rules" is for input into the Debugger Engine. It says nothing about data retrieved through XML. I've moved that to 6.3.1, which hopefully makes this clearer.

derickr commented 6 years ago

I've now merged this, and I'm working on getting this on the Xdebug website (at https://xdebug.org/docs-dbgp.php as I write this)