debugModel.ts 29.7 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

I
isidor 已提交
6
import * as nls from 'vs/nls';
7 8
import uri from 'vs/base/common/uri';
import { TPromise } from 'vs/base/common/winjs.base';
I
isidor 已提交
9
import * as lifecycle from 'vs/base/common/lifecycle';
J
Johannes Rieken 已提交
10
import Event, { Emitter } from 'vs/base/common/event';
I
isidor 已提交
11 12
import { generateUuid } from 'vs/base/common/uuid';
import { clone } from 'vs/base/common/objects';
E
Erich Gamma 已提交
13
import severity from 'vs/base/common/severity';
I
isidor 已提交
14 15
import { isObject, isString } from 'vs/base/common/types';
import { distinct } from 'vs/base/common/arrays';
I
isidor 已提交
16 17
import { ISuggestion } from 'vs/editor/common/modes';
import { Position } from 'vs/editor/common/core/position';
I
isidor 已提交
18
import * as debug from 'vs/workbench/parts/debug/common/debug';
J
Johannes Rieken 已提交
19
import { Source } from 'vs/workbench/parts/debug/common/debugSource';
E
Erich Gamma 已提交
20

21
const MAX_REPL_LENGTH = 10000;
I
isidor 已提交
22
const UNKNOWN_SOURCE_LABEL = nls.localize('unknownSource', "Unknown Source");
23

E
Erich Gamma 已提交
24 25 26 27 28
function massageValue(value: string): string {
	return value ? value.replace(/\n/g, '\\n').replace(/\r/g, '\\r').replace(/\t/g, '\\t') : value;
}

export class OutputElement implements debug.ITreeElement {
29
	private static ID_COUNTER = 0;
E
Erich Gamma 已提交
30

31
	constructor(private id = OutputElement.ID_COUNTER++) {
I
isidor 已提交
32
		// noop
E
Erich Gamma 已提交
33 34 35
	}

	public getId(): string {
J
Johannes Rieken 已提交
36
		return `outputelement:${this.id}`;
E
Erich Gamma 已提交
37 38 39 40 41
	}
}

export class ValueOutputElement extends OutputElement {

I
isidor 已提交
42 43 44 45 46 47
	constructor(
		public value: string,
		public severity: severity,
		public category?: string,
		public counter: number = 1
	) {
I
isidor 已提交
48
		super();
E
Erich Gamma 已提交
49 50 51 52 53 54 55 56 57 58
	}
}

export class KeyValueOutputElement extends OutputElement {

	private static MAX_CHILDREN = 1000; // upper bound of children per value

	private children: debug.ITreeElement[];
	private _valueName: string;

I
isidor 已提交
59 60
	constructor(public key: string, public valueObj: any, public annotation?: string) {
		super();
E
Erich Gamma 已提交
61 62 63 64 65 66 67 68 69 70

		this._valueName = null;
	}

	public get value(): string {
		if (this._valueName === null) {
			if (this.valueObj === null) {
				this._valueName = 'null';
			} else if (Array.isArray(this.valueObj)) {
				this._valueName = `Array[${this.valueObj.length}]`;
I
isidor 已提交
71
			} else if (isObject(this.valueObj)) {
E
Erich Gamma 已提交
72
				this._valueName = 'Object';
I
isidor 已提交
73
			} else if (isString(this.valueObj)) {
E
Erich Gamma 已提交
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
				this._valueName = `"${massageValue(this.valueObj)}"`;
			} else {
				this._valueName = String(this.valueObj);
			}

			if (!this._valueName) {
				this._valueName = '';
			}
		}

		return this._valueName;
	}

	public getChildren(): debug.ITreeElement[] {
		if (!this.children) {
			if (Array.isArray(this.valueObj)) {
I
isidor 已提交
90
				this.children = (<any[]>this.valueObj).slice(0, KeyValueOutputElement.MAX_CHILDREN).map((v, index) => new KeyValueOutputElement(String(index), v, null));
I
isidor 已提交
91
			} else if (isObject(this.valueObj)) {
I
isidor 已提交
92
				this.children = Object.getOwnPropertyNames(this.valueObj).slice(0, KeyValueOutputElement.MAX_CHILDREN).map(key => new KeyValueOutputElement(key, this.valueObj[key], null));
E
Erich Gamma 已提交
93 94 95 96 97 98 99 100 101
			} else {
				this.children = [];
			}
		}

		return this.children;
	}
}

102
export abstract class ExpressionContainer implements debug.IExpressionContainer {
E
Erich Gamma 已提交
103

104
	public static allValues: { [id: string]: string } = {};
I
isidor 已提交
105
	// Use chunks to support variable paging #9537
106
	private static BASE_CHUNK_SIZE = 100;
I
isidor 已提交
107 108

	public valueChanged: boolean;
109
	private _value: string;
E
Erich Gamma 已提交
110

I
isidor 已提交
111
	constructor(
112
		public stackFrame: debug.IStackFrame,
I
isidor 已提交
113 114
		public reference: number,
		private id: string,
115 116
		public namedVariables: number,
		public indexedVariables: number,
117
		private startOfVariables = 0
118
	) { }
E
Erich Gamma 已提交
119

120
	public getChildren(): TPromise<debug.IExpression[]> {
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
		// only variables with reference > 0 have children.
		if (this.reference <= 0) {
			return TPromise.as([]);
		}

		if (!this.getChildrenInChunks) {
			return this.fetchVariables(undefined, undefined, undefined);
		}

		// Check if object has named variables, fetch them independent from indexed variables #9670
		return (!!this.namedVariables ? this.fetchVariables(undefined, undefined, 'named') : TPromise.as([])).then(childrenArray => {
			// Use a dynamic chunk size based on the number of elements #9774
			let chunkSize = ExpressionContainer.BASE_CHUNK_SIZE;
			while (this.indexedVariables > chunkSize * ExpressionContainer.BASE_CHUNK_SIZE) {
				chunkSize *= ExpressionContainer.BASE_CHUNK_SIZE;
			}

			if (this.indexedVariables > chunkSize) {
				// There are a lot of children, create fake intermediate values that represent chunks #9537
				const numberOfChunks = Math.ceil(this.indexedVariables / chunkSize);
				for (let i = 0; i < numberOfChunks; i++) {
					const start = this.startOfVariables + i * chunkSize;
					const count = Math.min(chunkSize, this.indexedVariables - i * chunkSize);
					childrenArray.push(new Variable(this.stackFrame, this, this.reference, `[${start}..${start + count - 1}]`, '', '', null, count, null, true, start));
145 146
				}

147
				return childrenArray;
I
isidor 已提交
148
			}
E
Erich Gamma 已提交
149

150 151 152
			return this.fetchVariables(this.startOfVariables, this.indexedVariables, 'indexed')
				.then(variables => childrenArray.concat(variables));
		});
E
Erich Gamma 已提交
153
	}
154 155 156 157 158

	public getId(): string {
		return this.id;
	}

159 160 161 162
	public get value(): string {
		return this._value;
	}

163 164 165 166
	public get hasChildren(): boolean {
		return this.reference > 0;
	}

167
	private fetchVariables(start: number, count: number, filter: 'indexed' | 'named'): TPromise<Variable[]> {
I
isidor 已提交
168
		return this.stackFrame.thread.process.session.variables({
169 170 171 172 173
			variablesReference: this.reference,
			start,
			count,
			filter
		}).then(response => {
I
isidor 已提交
174
			return response && response.body && response.body.variables ? distinct(response.body.variables.filter(v => !!v), v => v.name).map(
I
isidor 已提交
175
				v => new Variable(this.stackFrame, this, v.variablesReference, v.name, v.evaluateName, v.value, v.namedVariables, v.indexedVariables, v.type)
176
			) : [];
I
isidor 已提交
177
		}, (e: Error) => [new Variable(this.stackFrame, this, 0, null, e.message, '', 0, 0, null, false)]);
178 179
	}

180 181
	// The adapter explicitly sents the children count of an expression only if there are lots of children which should be chunked.
	private get getChildrenInChunks(): boolean {
182
		return !!this.indexedVariables;
183 184
	}

185 186 187 188 189 190
	public set value(value: string) {
		this._value = massageValue(value);
		this.valueChanged = ExpressionContainer.allValues[this.getId()] &&
			ExpressionContainer.allValues[this.getId()] !== Expression.DEFAULT_VALUE && ExpressionContainer.allValues[this.getId()] !== value;
		ExpressionContainer.allValues[this.getId()] = value;
	}
E
Erich Gamma 已提交
191 192
}

193 194
export class Expression extends ExpressionContainer implements debug.IExpression {
	static DEFAULT_VALUE = 'not available';
E
Erich Gamma 已提交
195

196
	public available: boolean;
197
	public type: string;
E
Erich Gamma 已提交
198

199 200
	constructor(public name: string, id = generateUuid()) {
		super(null, 0, id, 0, 0);
201
		this.available = false;
202 203 204 205 206
		// name is not set if the expression is just being added
		// in that case do not set default value to prevent flashing #14499
		if (name) {
			this.value = Expression.DEFAULT_VALUE;
		}
E
Erich Gamma 已提交
207
	}
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

	public evaluate(process: debug.IProcess, stackFrame: debug.IStackFrame, context: string): TPromise<void> {
		if (!process) {
			this.value = context === 'repl' ? nls.localize('startDebugFirst', "Please start a debug session to evaluate") : Expression.DEFAULT_VALUE;
			this.available = false;
			this.reference = 0;

			return TPromise.as(null);
		}

		// Create a fake stack frame which is just used as a container for the process.
		// TODO@Isidor revisit if variables should have a reference to the StackFrame or a process after all
		this.stackFrame = stackFrame || new StackFrame(new Thread(process, undefined, undefined), undefined, undefined, undefined, undefined, undefined);

		return process.session.evaluate({
			expression: this.name,
			frameId: stackFrame ? stackFrame.frameId : undefined,
			context
		}).then(response => {
			this.available = !!(response && response.body);
			if (response && response.body) {
				this.value = response.body.result;
				this.reference = response.body.variablesReference;
				this.namedVariables = response.body.namedVariables;
				this.indexedVariables = response.body.indexedVariables;
				this.type = response.body.type;
			}
		}, err => {
			this.value = err.message;
			this.available = false;
			this.reference = 0;
		});
	}
241
}
E
Erich Gamma 已提交
242

243 244
export class Variable extends ExpressionContainer implements debug.IExpression {

245 246
	// Used to show the error message coming from the adapter when setting the value #7807
	public errorMessage: string;
I
isidor 已提交
247 248
	private static NOT_PROPERTY_SYNTAX = /^[a-zA-Z_][a-zA-Z0-9_]*$/;
	private static ARRAY_ELEMENT_SYNTAX = /\[.*\]$/;
249

I
isidor 已提交
250
	constructor(
251
		stackFrame: debug.IStackFrame,
I
isidor 已提交
252 253 254
		public parent: debug.IExpressionContainer,
		reference: number,
		public name: string,
I
isidor 已提交
255
		private _evaluateName: string,
I
isidor 已提交
256
		value: string,
257 258
		namedVariables: number,
		indexedVariables: number,
I
isidor 已提交
259 260
		public type: string = null,
		public available = true,
261
		startOfVariables = 0
I
isidor 已提交
262
	) {
263
		super(stackFrame, reference, `variable:${parent.getId()}:${name}:${reference}`, namedVariables, indexedVariables, startOfVariables);
264
		this.value = massageValue(value);
E
Erich Gamma 已提交
265
	}
266

I
isidor 已提交
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
	public get evaluateName(): string {
		if (this._evaluateName) {
			return this._evaluateName;
		}

		let names = [this.name];
		let v = this.parent;
		while (v instanceof Variable || v instanceof Expression) {
			names.push((<Variable>v).name);
			v = (<Variable>v).parent;
		}
		names = names.reverse();

		let result = null;
		names.forEach(name => {
			if (!result) {
				result = name;
			} else if (Variable.ARRAY_ELEMENT_SYNTAX.test(name) || (this.stackFrame.thread.process.session.configuration.type === 'node' && !Variable.NOT_PROPERTY_SYNTAX.test(name))) {
				// use safe way to access node properties a['property_name']. Also handles array elements.
				result = name && name.indexOf('[') === 0 ? `${result}${name}` : `${result}['${name}']`;
			} else {
				result = `${result}.${name}`;
			}
		});

		return result;
	}

295 296 297 298
	public setVariable(value: string): TPromise<any> {
		return this.stackFrame.thread.process.session.setVariable({
			name: this.name,
			value,
299
			variablesReference: (<ExpressionContainer>this.parent).reference
300 301 302
		}).then(response => {
			if (response && response.body) {
				this.value = response.body.value;
303
				this.type = response.body.type || this.type;
304 305 306
				this.reference = response.body.variablesReference;
				this.namedVariables = response.body.namedVariables;
				this.indexedVariables = response.body.indexedVariables;
307 308 309 310 311 312
			}
			// TODO@Isidor notify stackFrame that a change has happened so watch expressions get revelauted
		}, err => {
			this.errorMessage = err.message;
		});
	}
E
Erich Gamma 已提交
313 314
}

315
export class Scope extends ExpressionContainer implements debug.IScope {
E
Erich Gamma 已提交
316

I
isidor 已提交
317
	constructor(
318
		stackFrame: debug.IStackFrame,
I
isidor 已提交
319 320 321
		public name: string,
		reference: number,
		public expensive: boolean,
322 323
		namedVariables: number,
		indexedVariables: number
I
isidor 已提交
324
	) {
325
		super(stackFrame, reference, `scope:${stackFrame.getId()}:${name}:${reference}`, namedVariables, indexedVariables);
E
Erich Gamma 已提交
326 327 328 329 330 331 332
	}
}

export class StackFrame implements debug.IStackFrame {

	private scopes: TPromise<Scope[]>;

I
isidor 已提交
333
	constructor(
334
		public thread: debug.IThread,
I
isidor 已提交
335 336 337 338 339 340
		public frameId: number,
		public source: Source,
		public name: string,
		public lineNumber: number,
		public column: number
	) {
E
Erich Gamma 已提交
341 342 343 344
		this.scopes = null;
	}

	public getId(): string {
345
		return `stackframe:${this.thread.getId()}:${this.frameId}`;
E
Erich Gamma 已提交
346 347
	}

348 349
	public getScopes(): TPromise<debug.IScope[]> {
		if (!this.scopes) {
I
isidor 已提交
350
			this.scopes = this.thread.process.session.scopes({ frameId: this.frameId }).then(response => {
351
				return response && response.body && response.body.scopes ?
352
					response.body.scopes.map(rs => new Scope(this, rs.name, rs.variablesReference, rs.expensive, rs.namedVariables, rs.indexedVariables)) : [];
353
			}, err => []);
E
Erich Gamma 已提交
354 355 356 357
		}

		return this.scopes;
	}
I
isidor 已提交
358 359

	public restart(): TPromise<any> {
I
isidor 已提交
360
		return this.thread.process.session.restartFrame({ frameId: this.frameId });
I
isidor 已提交
361
	}
I
isidor 已提交
362

363
	public completions(text: string, position: Position, overwriteBefore: number): TPromise<ISuggestion[]> {
I
isidor 已提交
364 365 366 367 368 369 370 371 372 373
		if (!this.thread.process.session.configuration.capabilities.supportsCompletionsRequest) {
			return TPromise.as([]);
		}

		return this.thread.process.session.completions({
			frameId: this.frameId,
			text,
			column: position.column,
			line: position.lineNumber
		}).then(response => {
374
			return response && response.body && response.body.targets ? response.body.targets.map(item => (<ISuggestion>{
I
isidor 已提交
375 376
				label: item.label,
				insertText: item.text || item.label,
377 378
				type: item.type,
				overwriteBefore: item.length || overwriteBefore
I
isidor 已提交
379 380 381
			})) : [];
		}, err => []);
	}
E
Erich Gamma 已提交
382 383
}

I
isidor 已提交
384 385 386 387 388
export class Thread implements debug.IThread {
	private promisedCallStack: TPromise<debug.IStackFrame[]>;
	private cachedCallStack: debug.IStackFrame[];
	public stoppedDetails: debug.IRawStoppedDetails;
	public stopped: boolean;
E
Erich Gamma 已提交
389

390
	constructor(public process: debug.IProcess, public name: string, public threadId: number) {
391 392 393
		this.promisedCallStack = null;
		this.stoppedDetails = null;
		this.cachedCallStack = null;
I
isidor 已提交
394
		this.stopped = false;
E
Erich Gamma 已提交
395 396 397
	}

	public getId(): string {
398
		return `thread:${this.process.getId()}:${this.name}:${this.threadId}`;
I
isidor 已提交
399
	}
I
isidor 已提交
400

I
isidor 已提交
401
	public clearCallStack(): void {
402 403
		this.promisedCallStack = null;
		this.cachedCallStack = null;
I
isidor 已提交
404 405
	}

406
	public getCallStack(): debug.IStackFrame[] {
I
isidor 已提交
407
		return this.cachedCallStack;
I
isidor 已提交
408 409
	}

410 411 412 413 414 415 416 417
	/**
	 * Queries the debug adapter for the callstack and returns a promise with
	 * the stack frames of the callstack.
	 * If the thread is not stopped, it returns a promise to an empty array.
	 * Only gets the first 20 stack frames. Calling this method consecutive times
	 * with getAdditionalStackFrames = true gets the remainder of the call stack.
	 */
	public fetchCallStack(getAdditionalStackFrames = false): TPromise<debug.IStackFrame[]> {
I
isidor 已提交
418 419 420
		if (!this.stopped) {
			return TPromise.as([]);
		}
E
Erich Gamma 已提交
421

I
isidor 已提交
422 423 424 425 426 427 428 429 430 431 432
		if (!this.promisedCallStack) {
			this.promisedCallStack = this.getCallStackImpl(0).then(callStack => {
				this.cachedCallStack = callStack;
				return callStack;
			});
		} else if (getAdditionalStackFrames) {
			this.promisedCallStack = this.promisedCallStack.then(callStackFirstPart => this.getCallStackImpl(callStackFirstPart.length).then(callStackSecondPart => {
				this.cachedCallStack = callStackFirstPart.concat(callStackSecondPart);
				return this.cachedCallStack;
			}));
		}
E
Erich Gamma 已提交
433

I
isidor 已提交
434
		return this.promisedCallStack;
E
Erich Gamma 已提交
435 436
	}

I
isidor 已提交
437
	private getCallStackImpl(startFrame: number): TPromise<debug.IStackFrame[]> {
I
isidor 已提交
438
		return this.process.session.stackTrace({ threadId: this.threadId, startFrame, levels: 20 }).then(response => {
I
isidor 已提交
439 440 441 442
			if (!response || !response.body) {
				return [];
			}

I
isidor 已提交
443 444 445 446
			if (this.stoppedDetails) {
				this.stoppedDetails.totalFrames = response.body.totalFrames;
			}

I
isidor 已提交
447 448
			return response.body.stackFrames.map((rsf, level) => {
				if (!rsf) {
449
					return new StackFrame(this, 0, new Source({ name: UNKNOWN_SOURCE_LABEL }, false), nls.localize('unknownStack', "Unknown stack location"), null, null);
I
isidor 已提交
450 451
				}

452
				return new StackFrame(this, rsf.id, rsf.source ? new Source(rsf.source) : new Source({ name: UNKNOWN_SOURCE_LABEL }, false), rsf.name, rsf.line, rsf.column);
I
isidor 已提交
453 454
			});
		}, (err: Error) => {
I
isidor 已提交
455 456 457 458
			if (this.stoppedDetails) {
				this.stoppedDetails.framesErrorMessage = err.message;
			}

I
isidor 已提交
459 460
			return [];
		});
E
Erich Gamma 已提交
461
	}
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485

	public next(): TPromise<any> {
		return this.process.session.next({ threadId: this.threadId });
	}

	public stepIn(): TPromise<any> {
		return this.process.session.stepIn({ threadId: this.threadId });
	}

	public stepOut(): TPromise<any> {
		return this.process.session.stepOut({ threadId: this.threadId });
	}

	public stepBack(): TPromise<any> {
		return this.process.session.stepBack({ threadId: this.threadId });
	}

	public continue(): TPromise<any> {
		return this.process.session.continue({ threadId: this.threadId });
	}

	public pause(): TPromise<any> {
		return this.process.session.pause({ threadId: this.threadId });
	}
E
Erich Gamma 已提交
486 487
}

488
export class Process implements debug.IProcess {
489

490
	private threads: { [reference: number]: Thread; };
491

I
isidor 已提交
492
	constructor(public name: string, private _session: debug.ISession & debug.ITreeElement) {
493 494 495
		this.threads = {};
	}

I
isidor 已提交
496 497 498 499
	public get session(): debug.ISession {
		return this._session;
	}

500
	public getThread(threadId: number): Thread {
I
isidor 已提交
501 502 503 504 505 506 507
		return this.threads[threadId];
	}

	public getAllThreads(): debug.IThread[] {
		return Object.keys(this.threads).map(key => this.threads[key]);
	}

508
	public getId(): string {
509
		return this._session.getId();
510 511 512 513 514 515
	}

	public rawUpdate(data: debug.IRawModelUpdate): void {

		if (data.thread && !this.threads[data.threadId]) {
			// A new thread came in, initialize it.
516
			this.threads[data.threadId] = new Thread(this, data.thread.name, data.thread.id);
517 518 519 520 521 522 523 524 525 526
		}

		if (data.stoppedDetails) {
			// Set the availability of the threads' callstacks depending on
			// whether the thread is stopped or not
			if (data.allThreadsStopped) {
				Object.keys(this.threads).forEach(ref => {
					// Only update the details if all the threads are stopped
					// because we don't want to overwrite the details of other
					// threads that have stopped for a different reason
I
isidor 已提交
527
					this.threads[ref].stoppedDetails = clone(data.stoppedDetails);
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
					this.threads[ref].stopped = true;
					this.threads[ref].clearCallStack();
				});
			} else {
				// One thread is stopped, only update that thread.
				this.threads[data.threadId].stoppedDetails = data.stoppedDetails;
				this.threads[data.threadId].clearCallStack();
				this.threads[data.threadId].stopped = true;
			}
		}
	}

	public clearThreads(removeThreads: boolean, reference: number = undefined): void {
		if (reference) {
			if (this.threads[reference]) {
				this.threads[reference].clearCallStack();
				this.threads[reference].stoppedDetails = undefined;
				this.threads[reference].stopped = false;

				if (removeThreads) {
					delete this.threads[reference];
				}
			}
		} else {
			Object.keys(this.threads).forEach(ref => {
				this.threads[ref].clearCallStack();
				this.threads[ref].stoppedDetails = undefined;
				this.threads[ref].stopped = false;
			});

			if (removeThreads) {
				this.threads = {};
				ExpressionContainer.allValues = {};
			}
		}
	}

	public sourceIsUnavailable(source: Source): void {
		Object.keys(this.threads).forEach(key => {
			if (this.threads[key].getCachedCallStack()) {
				this.threads[key].getCachedCallStack().forEach(stackFrame => {
					if (stackFrame.source.uri.toString() === source.uri.toString()) {
						stackFrame.source.available = false;
					}
				});
			}
		});
	}
I
isidor 已提交
576
}
577

I
isidor 已提交
578 579 580 581 582 583 584 585 586
export class Breakpoint implements debug.IBreakpoint {

	public lineNumber: number;
	public verified: boolean;
	public idFromAdapter: number;
	public message: string;
	private id: string;

	constructor(
587
		public uri: uri,
I
isidor 已提交
588 589 590 591 592 593 594 595 596 597
		public desiredLineNumber: number,
		public enabled: boolean,
		public condition: string,
		public hitCondition: string
	) {
		if (enabled === undefined) {
			this.enabled = true;
		}
		this.lineNumber = this.desiredLineNumber;
		this.verified = false;
I
isidor 已提交
598
		this.id = generateUuid();
I
isidor 已提交
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
	}

	public getId(): string {
		return this.id;
	}
}

export class FunctionBreakpoint implements debug.IFunctionBreakpoint {

	private id: string;
	public verified: boolean;
	public idFromAdapter: number;

	constructor(public name: string, public enabled: boolean, public hitCondition: string) {
		this.verified = false;
I
isidor 已提交
614
		this.id = generateUuid();
I
isidor 已提交
615 616 617 618 619 620 621 622 623 624 625 626
	}

	public getId(): string {
		return this.id;
	}
}

export class ExceptionBreakpoint implements debug.IExceptionBreakpoint {

	private id: string;

	constructor(public filter: string, public label: string, public enabled: boolean) {
I
isidor 已提交
627
		this.id = generateUuid();
I
isidor 已提交
628 629 630 631 632
	}

	public getId(): string {
		return this.id;
	}
633 634
}

635
export class Model implements debug.IModel {
E
Erich Gamma 已提交
636

637
	private processes: Process[];
E
Erich Gamma 已提交
638 639
	private toDispose: lifecycle.IDisposable[];
	private replElements: debug.ITreeElement[];
640 641 642 643
	private _onDidChangeBreakpoints: Emitter<void>;
	private _onDidChangeCallStack: Emitter<void>;
	private _onDidChangeWatchExpressions: Emitter<debug.IExpression>;
	private _onDidChangeREPLElements: Emitter<void>;
E
Erich Gamma 已提交
644

I
isidor 已提交
645
	constructor(
646
		private breakpoints: Breakpoint[],
I
isidor 已提交
647
		private breakpointsActivated: boolean,
648 649
		private functionBreakpoints: FunctionBreakpoint[],
		private exceptionBreakpoints: ExceptionBreakpoint[],
I
isidor 已提交
650 651
		private watchExpressions: Expression[]
	) {
652
		this.processes = [];
E
Erich Gamma 已提交
653 654
		this.replElements = [];
		this.toDispose = [];
655 656 657 658
		this._onDidChangeBreakpoints = new Emitter<void>();
		this._onDidChangeCallStack = new Emitter<void>();
		this._onDidChangeWatchExpressions = new Emitter<debug.IExpression>();
		this._onDidChangeREPLElements = new Emitter<void>();
E
Erich Gamma 已提交
659 660 661 662 663 664
	}

	public getId(): string {
		return 'root';
	}

665 666
	public getProcesses(): Process[] {
		return this.processes;
667 668
	}

669 670 671 672 673
	public addProcess(name: string, session: debug.ISession & debug.ITreeElement): Process {
		const process = new Process(name, session);
		this.processes.push(process);

		return process;
674 675
	}

676
	public removeProcess(id: string): void {
677
		this.processes = this.processes.filter(p => p.getId() !== id);
678 679 680
		this._onDidChangeCallStack.fire();
	}

681 682 683 684 685 686 687 688 689 690 691 692
	public get onDidChangeBreakpoints(): Event<void> {
		return this._onDidChangeBreakpoints.event;
	}

	public get onDidChangeCallStack(): Event<void> {
		return this._onDidChangeCallStack.event;
	}

	public get onDidChangeWatchExpressions(): Event<debug.IExpression> {
		return this._onDidChangeWatchExpressions.event;
	}

693
	public get onDidChangeReplElements(): Event<void> {
694 695 696
		return this._onDidChangeREPLElements.event;
	}

697
	public rawUpdate(data: debug.IRawModelUpdate): void {
698 699 700 701
		let process = this.processes.filter(p => p.getId() === data.sessionId).pop();
		if (process) {
			process.rawUpdate(data);
			this._onDidChangeCallStack.fire();
E
Erich Gamma 已提交
702 703 704
		}
	}

705 706
	public clearThreads(id: string, removeThreads: boolean, reference: number = undefined): void {
		const process = this.processes.filter(p => p.getId() === id).pop();
707 708
		if (process) {
			process.clearThreads(removeThreads, reference);
709 710 711 712
			this._onDidChangeCallStack.fire();
		}
	}

713
	public getBreakpoints(): Breakpoint[] {
E
Erich Gamma 已提交
714 715 716
		return this.breakpoints;
	}

I
isidor 已提交
717 718 719 720
	public getFunctionBreakpoints(): debug.IFunctionBreakpoint[] {
		return this.functionBreakpoints;
	}

E
Erich Gamma 已提交
721 722 723 724
	public getExceptionBreakpoints(): debug.IExceptionBreakpoint[] {
		return this.exceptionBreakpoints;
	}

725
	public setExceptionBreakpoints(data: DebugProtocol.ExceptionBreakpointsFilter[]): void {
726
		if (data) {
727 728 729 730
			this.exceptionBreakpoints = data.map(d => {
				const ebp = this.exceptionBreakpoints.filter(ebp => ebp.filter === d.filter).pop();
				return new ExceptionBreakpoint(d.filter, d.label, ebp ? ebp.enabled : d.default);
			});
731 732 733
		}
	}

E
Erich Gamma 已提交
734 735 736 737
	public areBreakpointsActivated(): boolean {
		return this.breakpointsActivated;
	}

738 739
	public setBreakpointsActivated(activated: boolean): void {
		this.breakpointsActivated = activated;
740
		this._onDidChangeBreakpoints.fire();
E
Erich Gamma 已提交
741 742
	}

743
	public addBreakpoints(uri: uri, rawData: debug.IRawBreakpoint[]): void {
744
		this.breakpoints = this.breakpoints.concat(rawData.map(rawBp =>
745
			new Breakpoint(uri, rawBp.lineNumber, rawBp.enabled, rawBp.condition, rawBp.hitCondition)));
746
		this.breakpointsActivated = true;
747
		this._onDidChangeBreakpoints.fire();
748
	}
E
Erich Gamma 已提交
749

750 751
	public removeBreakpoints(toRemove: debug.IBreakpoint[]): void {
		this.breakpoints = this.breakpoints.filter(bp => !toRemove.some(toRemove => toRemove.getId() === bp.getId()));
752
		this._onDidChangeBreakpoints.fire();
E
Erich Gamma 已提交
753 754
	}

I
isidor 已提交
755
	public updateBreakpoints(data: { [id: string]: DebugProtocol.Breakpoint }): void {
756 757 758
		this.breakpoints.forEach(bp => {
			const bpData = data[bp.getId()];
			if (bpData) {
759
				bp.lineNumber = bpData.line ? bpData.line : bp.lineNumber;
760
				bp.verified = bpData.verified;
761
				bp.idFromAdapter = bpData.id;
I
isidor 已提交
762
				bp.message = bpData.message;
763 764
			}
		});
765
		this._onDidChangeBreakpoints.fire();
766 767
	}

768 769
	public setEnablement(element: debug.IEnablement, enable: boolean): void {
		element.enabled = enable;
E
Erich Gamma 已提交
770
		if (element instanceof Breakpoint && !element.enabled) {
J
Johannes Rieken 已提交
771
			var breakpoint = <Breakpoint>element;
E
Erich Gamma 已提交
772
			breakpoint.lineNumber = breakpoint.desiredLineNumber;
773
			breakpoint.verified = false;
E
Erich Gamma 已提交
774 775
		}

776
		this._onDidChangeBreakpoints.fire();
E
Erich Gamma 已提交
777 778
	}

779
	public enableOrDisableAllBreakpoints(enable: boolean): void {
E
Erich Gamma 已提交
780
		this.breakpoints.forEach(bp => {
781 782
			bp.enabled = enable;
			if (!enable) {
E
Erich Gamma 已提交
783
				bp.lineNumber = bp.desiredLineNumber;
784
				bp.verified = false;
E
Erich Gamma 已提交
785 786
			}
		});
787 788
		this.exceptionBreakpoints.forEach(ebp => ebp.enabled = enable);
		this.functionBreakpoints.forEach(fbp => fbp.enabled = enable);
E
Erich Gamma 已提交
789

790
		this._onDidChangeBreakpoints.fire();
E
Erich Gamma 已提交
791 792
	}

I
isidor 已提交
793
	public addFunctionBreakpoint(functionName: string): void {
794
		this.functionBreakpoints.push(new FunctionBreakpoint(functionName, true, null));
795
		this._onDidChangeBreakpoints.fire();
I
isidor 已提交
796 797
	}

798
	public updateFunctionBreakpoints(data: { [id: string]: { name?: string, verified?: boolean; id?: number; hitCondition?: string } }): void {
I
isidor 已提交
799 800 801 802 803
		this.functionBreakpoints.forEach(fbp => {
			const fbpData = data[fbp.getId()];
			if (fbpData) {
				fbp.name = fbpData.name || fbp.name;
				fbp.verified = fbpData.verified;
804
				fbp.idFromAdapter = fbpData.id;
805
				fbp.hitCondition = fbpData.hitCondition;
I
isidor 已提交
806 807 808
			}
		});

809
		this._onDidChangeBreakpoints.fire();
I
isidor 已提交
810 811
	}

812
	public removeFunctionBreakpoints(id?: string): void {
I
isidor 已提交
813
		this.functionBreakpoints = id ? this.functionBreakpoints.filter(fbp => fbp.getId() !== id) : [];
814
		this._onDidChangeBreakpoints.fire();
815 816
	}

E
Erich Gamma 已提交
817 818 819 820
	public getReplElements(): debug.ITreeElement[] {
		return this.replElements;
	}

821
	public addReplExpression(process: debug.IProcess, stackFrame: debug.IStackFrame, name: string): TPromise<void> {
822
		const expression = new Expression(name);
823
		this.addReplElements([expression]);
824
		return expression.evaluate(process, stackFrame, 'repl')
825
			.then(() => this._onDidChangeREPLElements.fire());
E
Erich Gamma 已提交
826 827
	}

828
	public logToRepl(value: string | { [key: string]: any }, severity?: severity): void {
J
Johannes Rieken 已提交
829
		let elements: OutputElement[] = [];
E
Erich Gamma 已提交
830 831
		let previousOutput = this.replElements.length && (<ValueOutputElement>this.replElements[this.replElements.length - 1]);

I
isidor 已提交
832
		// string message
E
Erich Gamma 已提交
833 834 835 836
		if (typeof value === 'string') {
			if (value && value.trim() && previousOutput && previousOutput.value === value && previousOutput.severity === severity) {
				previousOutput.counter++; // we got the same output (but not an empty string when trimmed) so we just increment the counter
			} else {
I
isidor 已提交
837
				let lines = value.trim().split('\n');
E
Erich Gamma 已提交
838
				lines.forEach((line, index) => {
I
isidor 已提交
839
					elements.push(new ValueOutputElement(line, severity));
E
Erich Gamma 已提交
840 841 842 843
				});
			}
		}

I
isidor 已提交
844
		// key-value output
E
Erich Gamma 已提交
845
		else {
846
			elements.push(new KeyValueOutputElement((<any>value).prototype, value, nls.localize('snapshotObj', "Only primitive values are shown for this object.")));
E
Erich Gamma 已提交
847 848 849
		}

		if (elements.length) {
850
			this.addReplElements(elements);
E
Erich Gamma 已提交
851
		}
I
isidor 已提交
852
		this._onDidChangeREPLElements.fire();
E
Erich Gamma 已提交
853 854 855
	}

	public appendReplOutput(value: string, severity?: severity): void {
I
isidor 已提交
856
		const elements: OutputElement[] = [];
E
Erich Gamma 已提交
857
		let previousOutput = this.replElements.length && (<ValueOutputElement>this.replElements[this.replElements.length - 1]);
858 859
		let lines = value.split('\n');
		let groupTogether = !!previousOutput && (previousOutput.category === 'output' && severity === previousOutput.severity);
E
Erich Gamma 已提交
860 861

		if (groupTogether) {
862 863 864 865 866
			// append to previous line if same group
			previousOutput.value += lines.shift();
		} else if (previousOutput && previousOutput.value === '') {
			// remove potential empty lines between different output types
			this.replElements.pop();
E
Erich Gamma 已提交
867 868 869 870
		}

		// fill in lines as output value elements
		lines.forEach((line, index) => {
I
isidor 已提交
871
			elements.push(new ValueOutputElement(line, severity, 'output'));
E
Erich Gamma 已提交
872 873
		});

874
		this.addReplElements(elements);
875
		this._onDidChangeREPLElements.fire();
E
Erich Gamma 已提交
876 877
	}

878 879 880 881 882 883 884
	private addReplElements(newElements: debug.ITreeElement[]): void {
		this.replElements.push(...newElements);
		if (this.replElements.length > MAX_REPL_LENGTH) {
			this.replElements.splice(0, this.replElements.length - MAX_REPL_LENGTH);
		}
	}

885
	public removeReplExpressions(): void {
886 887
		if (this.replElements.length > 0) {
			this.replElements = [];
888
			this._onDidChangeREPLElements.fire();
889
		}
E
Erich Gamma 已提交
890 891 892 893 894 895
	}

	public getWatchExpressions(): Expression[] {
		return this.watchExpressions;
	}

896
	public addWatchExpression(process: debug.IProcess, stackFrame: debug.IStackFrame, name: string): TPromise<void> {
897
		const we = new Expression(name);
E
Erich Gamma 已提交
898 899
		this.watchExpressions.push(we);
		if (!name) {
900
			this._onDidChangeWatchExpressions.fire(we);
A
Alex Dima 已提交
901
			return TPromise.as(null);
E
Erich Gamma 已提交
902 903
		}

904
		return this.evaluateWatchExpressions(process, stackFrame, we.getId());
E
Erich Gamma 已提交
905 906
	}

907
	public renameWatchExpression(process: debug.IProcess, stackFrame: debug.IStackFrame, id: string, newName: string): TPromise<void> {
I
isidor 已提交
908
		const filtered = this.watchExpressions.filter(we => we.getId() === id);
E
Erich Gamma 已提交
909 910
		if (filtered.length === 1) {
			filtered[0].name = newName;
911
			return filtered[0].evaluate(process, stackFrame, 'watch').then(() => {
912
				this._onDidChangeWatchExpressions.fire(filtered[0]);
E
Erich Gamma 已提交
913 914 915
			});
		}

A
Alex Dima 已提交
916
		return TPromise.as(null);
E
Erich Gamma 已提交
917 918
	}

919
	public evaluateWatchExpressions(process: debug.IProcess, stackFrame: debug.IStackFrame, id: string = null): TPromise<void> {
E
Erich Gamma 已提交
920
		if (id) {
I
isidor 已提交
921
			const filtered = this.watchExpressions.filter(we => we.getId() === id);
E
Erich Gamma 已提交
922
			if (filtered.length !== 1) {
A
Alex Dima 已提交
923
				return TPromise.as(null);
E
Erich Gamma 已提交
924 925
			}

926
			return filtered[0].evaluate(process, stackFrame, 'watch').then(() => {
927
				this._onDidChangeWatchExpressions.fire(filtered[0]);
E
Erich Gamma 已提交
928 929 930
			});
		}

931
		return TPromise.join(this.watchExpressions.map(we => we.evaluate(process, stackFrame, 'watch'))).then(() => {
932
			this._onDidChangeWatchExpressions.fire();
E
Erich Gamma 已提交
933 934 935
		});
	}

936
	public removeWatchExpressions(id: string = null): void {
937
		this.watchExpressions = id ? this.watchExpressions.filter(we => we.getId() !== id) : [];
938
		this._onDidChangeWatchExpressions.fire();
E
Erich Gamma 已提交
939 940
	}

I
isidor 已提交
941 942 943 944 945 946 947 948
	public moveWatchExpression(id: string, position: number): void {
		const we = this.watchExpressions.filter(we => we.getId() === id).pop();
		this.watchExpressions = this.watchExpressions.filter(we => we.getId() !== id);
		this.watchExpressions = this.watchExpressions.slice(0, position).concat(we, this.watchExpressions.slice(position));

		this._onDidChangeWatchExpressions.fire();
	}

I
isidor 已提交
949
	public sourceIsUnavailable(source: Source): void {
950
		this.processes.forEach(p => p.sourceIsUnavailable(source));
951
		this._onDidChangeCallStack.fire();
E
Erich Gamma 已提交
952 953 954
	}

	public dispose(): void {
J
Joao Moreno 已提交
955
		this.toDispose = lifecycle.dispose(this.toDispose);
E
Erich Gamma 已提交
956 957
	}
}