From 62b261ec97964d8fda38dbc1c4af2cd1ccaf8831 Mon Sep 17 00:00:00 2001 From: Andre Weinand Date: Thu, 3 Nov 2016 16:31:15 +0100 Subject: [PATCH] debug protocol: add 'supportsValueEscaping' capability --- src/vs/workbench/parts/debug/common/debugProtocol.d.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/vs/workbench/parts/debug/common/debugProtocol.d.ts b/src/vs/workbench/parts/debug/common/debugProtocol.d.ts index 585f70172b8..3ff4c1d795f 100644 --- a/src/vs/workbench/parts/debug/common/debugProtocol.d.ts +++ b/src/vs/workbench/parts/debug/common/debugProtocol.d.ts @@ -654,7 +654,7 @@ declare module DebugProtocol { /** Response to 'setVariable' request. */ export interface SetVariableResponse extends Response { body: { - /** The new value of the variable. */ + /** The new value of the variable. See capability 'supportsValueEscaping' for details about how to treat newlines in multi-line strings. */ value: string; /** The type of the new value. Typically shown in the UI when hovering over the value. */ type?: string; @@ -756,7 +756,7 @@ declare module DebugProtocol { /** Response to 'evaluate' request. */ export interface EvaluateResponse extends Response { body: { - /** The result of the evaluate request. */ + /** The result of the evaluate request. See capability 'supportsValueEscaping' for details about how to treat newlines in multi-lines strings. */ result: string; /** The optional type of the evaluate result. */ type?: string; @@ -886,6 +886,8 @@ declare module DebugProtocol { additionalModuleColumns?: ColumnDescriptor[]; /** Checksum algorithms supported by the debug adapter. */ supportedChecksumAlgorithms?: ChecksumAlgorithm[]; + /** The debug adapter will be responsible for escaping newlines in variable values and evaluation results, and the client will display them as-is. If missing or false the client will escape newlines as needed. */ + supportsValueEscaping?: boolean; } /** An ExceptionBreakpointsFilter is shown in the UI as an option for configuring how exceptions are dealt with. */ @@ -1059,7 +1061,7 @@ declare module DebugProtocol { export interface Variable { /** The variable's name. */ name: string; - /** The variable's value. For structured objects this can be a multi line text, e.g. for a function the body of a function. */ + /** The variable's value. This can be a multi-line text, e.g. for a function the body of a function. See capability 'supportsValueEscaping' for details about how to treat newlines in multi-line strings. */ value: string; /** The type of the variable's value. Typically shown in the UI when hovering over the value. */ type?: string; -- GitLab