support new writeMemory request

Author: weinand

adapter/package-lock.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-debugadapter",
 	"description": "Debug adapter implementation for node",
-	"version": "1.47.0",
+	"version": "1.48.0-pre.0",
 	"author": "Microsoft Corporation",
 	"license": "MIT",
 	"repository": {
@@ -19,7 +19,7 @@
 	"typings": "./lib/main",
 	"dependencies": {
 		"mkdirp": "^0.5.5",
-		"vscode-debugprotocol": "1.47.0"
+		"vscode-debugprotocol": "1.48.0-pre.0"
 	},
 	"devDependencies": {
 		"@types/mkdirp": "^0.5.2",

adapter/package.json

@@ -583,6 +583,9 @@ export class DebugSession extends ProtocolServer {
 			} else if (request.command === 'readMemory') {
 				this.readMemoryRequest(<DebugProtocol.ReadMemoryResponse> response, request.arguments, request);
 
+			} else if (request.command === 'writeMemory') {
+				this.writeMemoryRequest(<DebugProtocol.WriteMemoryResponse> response, request.arguments, request);
+
 			} else if (request.command === 'disassemble') {
 				this.disassembleRequest(<DebugProtocol.DisassembleResponse> response, request.arguments, request);
 
@@ -842,6 +845,10 @@ export class DebugSession extends ProtocolServer {
 		this.sendResponse(response);
 	}
 
+	protected writeMemoryRequest(response: DebugProtocol.WriteMemoryResponse, args: DebugProtocol.WriteMemoryArguments, request?: DebugProtocol.Request): void {
+		this.sendResponse(response);
+	}
+
 	protected disassembleRequest(response: DebugProtocol.DisassembleResponse, args: DebugProtocol.DisassembleArguments, request?: DebugProtocol.Request): void {
 		this.sendResponse(response);
 	}

adapter/src/debugSession.ts

@@ -2020,7 +2020,7 @@
 		"SetVariableRequest": {
 			"allOf": [ { "$ref": "#/definitions/Request" }, {
 				"type": "object",
-				"description": "Set the variable with the given name in the variable container to a new value. Clients should only call this request if the capability 'supportsSetVariable' is true.",
+				"description": "Set the variable with the given name in the variable container to a new value. Clients should only call this request if the capability 'supportsSetVariable' is true.\nIf a debug adapter implements both setVariable and setExpression, a client will only use setExpression if the variable has an evaluateName property.",
 				"properties": {
 					"command": {
 						"type": "string",
@@ -2412,7 +2412,7 @@
 		"SetExpressionRequest": {
 			"allOf": [ { "$ref": "#/definitions/Request" }, {
 				"type": "object",
-				"description": "Evaluates the given 'value' expression and assigns it to the 'expression' which must be a modifiable l-value.\nThe expressions have access to any variables and arguments that are in scope of the specified frame.\nClients should only call this request if the capability 'supportsSetExpression' is true.",
+				"description": "Evaluates the given 'value' expression and assigns it to the 'expression' which must be a modifiable l-value.\nThe expressions have access to any variables and arguments that are in scope of the specified frame.\nClients should only call this request if the capability 'supportsSetExpression' is true.\nIf a debug adapter implements both setExpression and setVariable, a client will only use setExpression if the variable has an evaluateName property.",
 				"properties": {
 					"command": {
 						"type": "string",
@@ -2779,6 +2779,67 @@
 			}]
 		},
 
+		"WriteMemoryRequest": {
+			"allOf": [ { "$ref": "#/definitions/Request" }, {
+				"type": "object",
+				"description": "Writes bytes to memory at the provided location.\nClients should only call this request if the capability 'supportsWriteMemoryRequest' is true.",
+				"properties": {
+					"command": {
+						"type": "string",
+						"enum": [ "writeMemory" ]
+					},
+					"arguments": {
+						"$ref": "#/definitions/WriteMemoryArguments"
+					}
+				},
+				"required": [ "command", "arguments" ]
+			}]
+		},
+		"WriteMemoryArguments": {
+			"type": "object",
+			"description": "Arguments for 'writeMemory' request.",
+			"properties": {
+				"memoryReference": {
+					"type": "string",
+					"description": "Memory reference to the base location to which data should be written."
+				},
+				"offset": {
+					"type": "integer",
+					"description": "Optional offset (in bytes) to be applied to the reference location before writing data. Can be negative."
+				},
+				"allowPartial": {
+					"type": "boolean",
+					"description": "Optional property to control partial writes. If true, the debug adapter should attempt to write memory even if the entire memory region is not writable. In such a case the debug adapter should stop after hitting the first byte of memory that cannot be written and return the number of bytes written in the response via the 'offset' and 'bytesWritten' properties.\nIf false or missing, a debug adapter should attempt to verify the region is writable before writing, and fail the response if it is not."
+				},
+				"data": {
+					"type": "string",
+					"description": "Bytes to write, encoded using base64."
+				}
+			},
+			"required": [ "memoryReference", "data" ]
+		},
+		"WriteMemoryResponse": {
+			"allOf": [ { "$ref": "#/definitions/Response" }, {
+				"type": "object",
+				"description": "Response to 'writeMemory' request.",
+				"properties": {
+					"body": {
+						"type": "object",
+						"properties": {
+							"offset": {
+								"type": "integer",
+								"description": "Optional property that should be returned when 'allowPartial' is true to indicate the offset of the first byte of data successfully written. Can be negative."
+							},
+							"bytesWritten": {
+								"type": "integer",
+								"description": "Optional property that should be returned when 'allowPartial' is true to indicate the number of bytes starting from address that were successfully written."
+							}
+						}
+					}
+				}
+			}]
+		},
+
 		"DisassembleRequest": {
 			"allOf": [ { "$ref": "#/definitions/Request" }, {
 				"type": "object",
@@ -2981,6 +3042,10 @@
 					"type": "boolean",
 					"description": "The debug adapter supports the 'readMemory' request."
 				},
+				"supportsWriteMemoryRequest": {
+					"type": "boolean",
+					"description": "The debug adapter supports the 'writeMemory' request."
+				},
 				"supportsDisassembleRequest": {
 					"type": "boolean",
 					"description": "The debug adapter supports the 'disassemble' request."

debugProtocol.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-debugprotocol",
 	"description": "Npm module with declarations for the Visual Studio Code debug protocol",
-	"version": "1.47.0",
+	"version": "1.48.0-pre.0",
 	"author": "Microsoft Corporation",
 	"license": "MIT",
 	"repository": {

protocol/package-lock.json

@@ -1126,6 +1126,7 @@ export module DebugProtocol {
 
 	/** SetVariable request; value of command field is 'setVariable'.
 		Set the variable with the given name in the variable container to a new value. Clients should only call this request if the capability 'supportsSetVariable' is true.
+		If a debug adapter implements both setVariable and setExpression, a client will only use setExpression if the variable has an evaluateName property.
 	*/
 	export interface SetVariableRequest extends Request {
 		// command: 'setVariable';
@@ -1346,6 +1347,7 @@ export module DebugProtocol {
 		Evaluates the given 'value' expression and assigns it to the 'expression' which must be a modifiable l-value.
 		The expressions have access to any variables and arguments that are in scope of the specified frame.
 		Clients should only call this request if the capability 'supportsSetExpression' is true.
+		If a debug adapter implements both setExpression and setVariable, a client will only use setExpression if the variable has an evaluateName property.
 	*/
 	export interface SetExpressionRequest extends Request {
 		// command: 'setExpression';
@@ -1538,6 +1540,39 @@ export module DebugProtocol {
 		};
 	}
 
+	/** WriteMemory request; value of command field is 'writeMemory'.
+		Writes bytes to memory at the provided location.
+		Clients should only call this request if the capability 'supportsWriteMemoryRequest' is true.
+	*/
+	export interface WriteMemoryRequest extends Request {
+		// command: 'writeMemory';
+		arguments: WriteMemoryArguments;
+	}
+
+	/** Arguments for 'writeMemory' request. */
+	export interface WriteMemoryArguments {
+		/** Memory reference to the base location to which data should be written. */
+		memoryReference: string;
+		/** Optional offset (in bytes) to be applied to the reference location before writing data. Can be negative. */
+		offset?: number;
+		/** Optional property to control partial writes. If true, the debug adapter should attempt to write memory even if the entire memory region is not writable. In such a case the debug adapter should stop after hitting the first byte of memory that cannot be written and return the number of bytes written in the response via the 'offset' and 'bytesWritten' properties.
+			If false or missing, a debug adapter should attempt to verify the region is writable before writing, and fail the response if it is not.
+		*/
+		allowPartial?: boolean;
+		/** Bytes to write, encoded using base64. */
+		data: string;
+	}
+
+	/** Response to 'writeMemory' request. */
+	export interface WriteMemoryResponse extends Response {
+		body?: {
+			/** Optional property that should be returned when 'allowPartial' is true to indicate the offset of the first byte of data successfully written. Can be negative. */
+			offset?: number;
+			/** Optional property that should be returned when 'allowPartial' is true to indicate the number of bytes starting from address that were successfully written. */
+			bytesWritten?: number;
+		};
+	}
+
 	/** Disassemble request; value of command field is 'disassemble'.
 		Disassembles code stored at the provided location.
 		Clients should only call this request if the capability 'supportsDisassembleRequest' is true.
@@ -1633,6 +1668,8 @@ export module DebugProtocol {
 		supportsDataBreakpoints?: boolean;
 		/** The debug adapter supports the 'readMemory' request. */
 		supportsReadMemoryRequest?: boolean;
+		/** The debug adapter supports the 'writeMemory' request. */
+		supportsWriteMemoryRequest?: boolean;
 		/** The debug adapter supports the 'disassemble' request. */
 		supportsDisassembleRequest?: boolean;
 		/** The debug adapter supports the 'cancel' request. */

protocol/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-debugadapter-testsupport",
 	"description": "Npm module with mocha test support for Visual Studio Code debug adapters",
-	"version": "1.47.0",
+	"version": "1.48.0-pre.0",
 	"author": "Microsoft Corporation",
 	"license": "MIT",
 	"repository": {
@@ -14,7 +14,7 @@
 	"main": "./lib/main.js",
 	"typings": "./lib/main",
 	"dependencies": {
-		"vscode-debugprotocol": "^1.47.0"
+		"vscode-debugprotocol": "^1.48.0-pre.0"
 	},
 	"devDependencies": {
 		"@types/node": "8.9.3",