mirror of
https://github.com/microsoft/vscode.git
synced 2026-05-14 12:11:43 +01:00
isidor
1057 lines
32 KiB
TypeScript
1057 lines
32 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
import * as nls from 'vs/nls';
|
|
import { URI as uri } from 'vs/base/common/uri';
|
|
import * as resources from 'vs/base/common/resources';
|
|
import { TPromise } from 'vs/base/common/winjs.base';
|
|
import * as lifecycle from 'vs/base/common/lifecycle';
|
|
import { Event, Emitter } from 'vs/base/common/event';
|
|
import { generateUuid } from 'vs/base/common/uuid';
|
|
import { RunOnceScheduler } from 'vs/base/common/async';
|
|
import severity from 'vs/base/common/severity';
|
|
import { isObject, isString, isUndefinedOrNull } from 'vs/base/common/types';
|
|
import { distinct } from 'vs/base/common/arrays';
|
|
import { Range, IRange } from 'vs/editor/common/core/range';
|
|
import {
|
|
ITreeElement, IExpression, IExpressionContainer, IDebugSession, IStackFrame, IExceptionBreakpoint, IBreakpoint, IFunctionBreakpoint, IDebugModel, IReplElementSource,
|
|
IThread, IRawModelUpdate, IScope, IRawStoppedDetails, IEnablement, IBreakpointData, IExceptionInfo, IReplElement, IBreakpointsChangeEvent, IBreakpointUpdateData, IBaseBreakpoint, State
|
|
} from 'vs/workbench/parts/debug/common/debug';
|
|
import { Source } from 'vs/workbench/parts/debug/common/debugSource';
|
|
import { commonSuffixLength } from 'vs/base/common/strings';
|
|
import { sep } from 'vs/base/common/paths';
|
|
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
|
|
import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles';
|
|
|
|
export abstract class AbstractReplElement implements IReplElement {
|
|
private static ID_COUNTER = 0;
|
|
|
|
constructor(public sourceData: IReplElementSource, private id = AbstractReplElement.ID_COUNTER++) {
|
|
// noop
|
|
}
|
|
|
|
public getId(): string {
|
|
return `replelement:${this.id}`;
|
|
}
|
|
|
|
// Used by the copy all action in repl
|
|
abstract toString(): string;
|
|
}
|
|
|
|
export class SimpleReplElement extends AbstractReplElement {
|
|
|
|
constructor(
|
|
public value: string,
|
|
public severity: severity,
|
|
source: IReplElementSource,
|
|
) {
|
|
super(source);
|
|
}
|
|
|
|
public toString(): string {
|
|
return this.value;
|
|
}
|
|
}
|
|
|
|
export class RawObjectReplElement extends AbstractReplElement implements IExpression {
|
|
|
|
private static readonly MAX_CHILDREN = 1000; // upper bound of children per value
|
|
|
|
constructor(public name: string, public valueObj: any, source?: IReplElementSource, public annotation?: string) {
|
|
super(source);
|
|
}
|
|
|
|
public get value(): string {
|
|
if (this.valueObj === null) {
|
|
return 'null';
|
|
} else if (Array.isArray(this.valueObj)) {
|
|
return `Array[${this.valueObj.length}]`;
|
|
} else if (isObject(this.valueObj)) {
|
|
return 'Object';
|
|
} else if (isString(this.valueObj)) {
|
|
return `"${this.valueObj}"`;
|
|
}
|
|
|
|
return String(this.valueObj) || '';
|
|
}
|
|
|
|
public get hasChildren(): boolean {
|
|
return (Array.isArray(this.valueObj) && this.valueObj.length > 0) || (isObject(this.valueObj) && Object.getOwnPropertyNames(this.valueObj).length > 0);
|
|
}
|
|
|
|
public getChildren(): TPromise<IExpression[]> {
|
|
let result: IExpression[] = [];
|
|
if (Array.isArray(this.valueObj)) {
|
|
result = (<any[]>this.valueObj).slice(0, RawObjectReplElement.MAX_CHILDREN)
|
|
.map((v, index) => new RawObjectReplElement(String(index), v));
|
|
} else if (isObject(this.valueObj)) {
|
|
result = Object.getOwnPropertyNames(this.valueObj).slice(0, RawObjectReplElement.MAX_CHILDREN)
|
|
.map(key => new RawObjectReplElement(key, this.valueObj[key]));
|
|
}
|
|
|
|
return Promise.resolve(result);
|
|
}
|
|
|
|
public toString(): string {
|
|
return `${this.name}\n${this.value}`;
|
|
}
|
|
}
|
|
|
|
export class ExpressionContainer implements IExpressionContainer {
|
|
|
|
public static allValues: Map<string, string> = new Map<string, string>();
|
|
// Use chunks to support variable paging #9537
|
|
private static readonly BASE_CHUNK_SIZE = 100;
|
|
|
|
public valueChanged: boolean;
|
|
private _value: string;
|
|
protected children: TPromise<IExpression[]>;
|
|
|
|
constructor(
|
|
protected session: IDebugSession,
|
|
private _reference: number,
|
|
private id: string,
|
|
public namedVariables = 0,
|
|
public indexedVariables = 0,
|
|
private startOfVariables = 0
|
|
) { }
|
|
|
|
public get reference(): number {
|
|
return this._reference;
|
|
}
|
|
|
|
public set reference(value: number) {
|
|
this._reference = value;
|
|
this.children = undefined; // invalidate children cache
|
|
}
|
|
|
|
public getChildren(): TPromise<IExpression[]> {
|
|
if (!this.children) {
|
|
this.children = this.doGetChildren();
|
|
}
|
|
|
|
return this.children;
|
|
}
|
|
|
|
private doGetChildren(): TPromise<IExpression[]> {
|
|
if (!this.hasChildren) {
|
|
return Promise.resolve([]);
|
|
}
|
|
|
|
if (!this.getChildrenInChunks) {
|
|
return this.fetchVariables(undefined, undefined, undefined);
|
|
}
|
|
|
|
// Check if object has named variables, fetch them independent from indexed variables #9670
|
|
const childrenThenable: Thenable<Variable[]> = !!this.namedVariables ? this.fetchVariables(undefined, undefined, 'named') : Promise.resolve([]);
|
|
return childrenThenable.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.session, this, this.reference, `[${start}..${start + count - 1}]`, '', '', null, count, { kind: 'virtual' }, null, true, start));
|
|
}
|
|
|
|
return childrenArray;
|
|
}
|
|
|
|
return this.fetchVariables(this.startOfVariables, this.indexedVariables, 'indexed')
|
|
.then(variables => childrenArray.concat(variables));
|
|
});
|
|
}
|
|
|
|
public getId(): string {
|
|
return this.id;
|
|
}
|
|
|
|
public get value(): string {
|
|
return this._value;
|
|
}
|
|
|
|
public get hasChildren(): boolean {
|
|
// only variables with reference > 0 have children.
|
|
return this.reference > 0;
|
|
}
|
|
|
|
private fetchVariables(start: number, count: number, filter: 'indexed' | 'named'): TPromise<Variable[]> {
|
|
return this.session.variables(this.reference, filter, start, count).then(response => {
|
|
return response && response.body && response.body.variables
|
|
? distinct(response.body.variables.filter(v => !!v && isString(v.name)), v => v.name).map(
|
|
v => new Variable(this.session, this, v.variablesReference, v.name, v.evaluateName, v.value, v.namedVariables, v.indexedVariables, v.presentationHint, v.type))
|
|
: [];
|
|
}, (e: Error) => [new Variable(this.session, this, 0, e.message, e.message, '', 0, 0, { kind: 'virtual' }, null, false)]);
|
|
}
|
|
|
|
// 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 {
|
|
return !!this.indexedVariables;
|
|
}
|
|
|
|
public set value(value: string) {
|
|
this._value = value;
|
|
this.valueChanged = ExpressionContainer.allValues.get(this.getId()) &&
|
|
ExpressionContainer.allValues.get(this.getId()) !== Expression.DEFAULT_VALUE && ExpressionContainer.allValues.get(this.getId()) !== value;
|
|
ExpressionContainer.allValues.set(this.getId(), value);
|
|
}
|
|
|
|
public toString(): string {
|
|
return this.value;
|
|
}
|
|
}
|
|
|
|
export class Expression extends ExpressionContainer implements IExpression {
|
|
static DEFAULT_VALUE = nls.localize('notAvailable', "not available");
|
|
|
|
public available: boolean;
|
|
public type: string;
|
|
|
|
constructor(public name: string, id = generateUuid()) {
|
|
super(null, 0, id);
|
|
this.available = false;
|
|
// 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;
|
|
}
|
|
}
|
|
|
|
public evaluate(session: IDebugSession, stackFrame: IStackFrame, context: string): TPromise<void> {
|
|
if (!session || (!stackFrame && context !== 'repl')) {
|
|
this.value = context === 'repl' ? nls.localize('startDebugFirst', "Please start a debug session to evaluate") : Expression.DEFAULT_VALUE;
|
|
this.available = false;
|
|
this.reference = 0;
|
|
|
|
return Promise.resolve(null);
|
|
}
|
|
|
|
this.session = session;
|
|
return session.evaluate(this.name, 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;
|
|
});
|
|
}
|
|
|
|
public toString(): string {
|
|
return `${this.name}\n${this.value}`;
|
|
}
|
|
}
|
|
|
|
export class Variable extends ExpressionContainer implements IExpression {
|
|
|
|
// Used to show the error message coming from the adapter when setting the value #7807
|
|
public errorMessage: string;
|
|
|
|
constructor(
|
|
session: IDebugSession,
|
|
public parent: IExpressionContainer,
|
|
reference: number,
|
|
public name: string,
|
|
public evaluateName: string,
|
|
value: string,
|
|
namedVariables: number,
|
|
indexedVariables: number,
|
|
public presentationHint: DebugProtocol.VariablePresentationHint,
|
|
public type: string = null,
|
|
public available = true,
|
|
startOfVariables = 0
|
|
) {
|
|
super(session, reference, `variable:${parent.getId()}:${name}`, namedVariables, indexedVariables, startOfVariables);
|
|
this.value = value;
|
|
}
|
|
|
|
public setVariable(value: string): TPromise<any> {
|
|
return this.session.setVariable((<ExpressionContainer>this.parent).reference, name, value).then(response => {
|
|
if (response && response.body) {
|
|
this.value = response.body.value;
|
|
this.type = response.body.type || this.type;
|
|
this.reference = response.body.variablesReference;
|
|
this.namedVariables = response.body.namedVariables;
|
|
this.indexedVariables = response.body.indexedVariables;
|
|
}
|
|
}, err => {
|
|
this.errorMessage = err.message;
|
|
});
|
|
}
|
|
|
|
public toString(): string {
|
|
return `${this.name}: ${this.value}`;
|
|
}
|
|
}
|
|
|
|
export class Scope extends ExpressionContainer implements IScope {
|
|
|
|
constructor(
|
|
stackFrame: IStackFrame,
|
|
index: number,
|
|
public name: string,
|
|
reference: number,
|
|
public expensive: boolean,
|
|
namedVariables: number,
|
|
indexedVariables: number,
|
|
public range?: IRange
|
|
) {
|
|
super(stackFrame.thread.session, reference, `scope:${stackFrame.getId()}:${name}:${index}`, namedVariables, indexedVariables);
|
|
}
|
|
}
|
|
|
|
export class StackFrame implements IStackFrame {
|
|
|
|
private scopes: TPromise<Scope[]>;
|
|
|
|
constructor(
|
|
public thread: IThread,
|
|
public frameId: number,
|
|
public source: Source,
|
|
public name: string,
|
|
public presentationHint: string,
|
|
public range: IRange,
|
|
private index: number
|
|
) {
|
|
this.scopes = null;
|
|
}
|
|
|
|
public getId(): string {
|
|
return `stackframe:${this.thread.getId()}:${this.frameId}:${this.index}`;
|
|
}
|
|
|
|
public getScopes(): TPromise<IScope[]> {
|
|
if (!this.scopes) {
|
|
this.scopes = this.thread.session.scopes(this.frameId).then(response => {
|
|
return response && response.body && response.body.scopes ?
|
|
response.body.scopes.map((rs, index) => new Scope(this, index, rs.name, rs.variablesReference, rs.expensive, rs.namedVariables, rs.indexedVariables,
|
|
rs.line && rs.column && rs.endLine && rs.endColumn ? new Range(rs.line, rs.column, rs.endLine, rs.endColumn) : null)) : [];
|
|
}, err => []);
|
|
}
|
|
|
|
return this.scopes;
|
|
}
|
|
|
|
public getSpecificSourceName(): string {
|
|
const otherSources = this.thread.getCallStack().map(sf => sf.source).filter(s => s !== this.source);
|
|
let suffixLength = 0;
|
|
otherSources.forEach(s => {
|
|
if (s.name === this.source.name) {
|
|
suffixLength = Math.max(suffixLength, commonSuffixLength(this.source.uri.path, s.uri.path));
|
|
}
|
|
});
|
|
if (suffixLength === 0) {
|
|
return this.source.name;
|
|
}
|
|
|
|
const from = Math.max(0, this.source.uri.path.lastIndexOf(sep, this.source.uri.path.length - suffixLength - 1));
|
|
return (from > 0 ? '...' : '') + this.source.uri.path.substr(from);
|
|
}
|
|
|
|
public getMostSpecificScopes(range: IRange): TPromise<IScope[]> {
|
|
return this.getScopes().then(scopes => {
|
|
scopes = scopes.filter(s => !s.expensive);
|
|
const haveRangeInfo = scopes.some(s => !!s.range);
|
|
if (!haveRangeInfo) {
|
|
return scopes;
|
|
}
|
|
|
|
const scopesContainingRange = scopes.filter(scope => scope.range && Range.containsRange(scope.range, range))
|
|
.sort((first, second) => (first.range.endLineNumber - first.range.startLineNumber) - (second.range.endLineNumber - second.range.startLineNumber));
|
|
return scopesContainingRange.length ? scopesContainingRange : scopes;
|
|
});
|
|
}
|
|
|
|
public restart(): TPromise<void> {
|
|
return this.thread.session.restartFrame(this.frameId, this.thread.threadId);
|
|
}
|
|
|
|
public toString(): string {
|
|
return `${this.name} (${this.source.inMemory ? this.source.name : this.source.uri.fsPath}:${this.range.startLineNumber})`;
|
|
}
|
|
|
|
public openInEditor(editorService: IEditorService, preserveFocus?: boolean, sideBySide?: boolean, pinned?: boolean): TPromise<any> {
|
|
return !this.source.available ? Promise.resolve(null) :
|
|
this.source.openInEditor(editorService, this.range, preserveFocus, sideBySide, pinned);
|
|
}
|
|
}
|
|
|
|
export class Thread implements IThread {
|
|
private callStack: IStackFrame[];
|
|
private staleCallStack: IStackFrame[];
|
|
public stoppedDetails: IRawStoppedDetails;
|
|
public stopped: boolean;
|
|
|
|
constructor(public session: IDebugSession, public name: string, public threadId: number) {
|
|
this.stoppedDetails = null;
|
|
this.callStack = [];
|
|
this.staleCallStack = [];
|
|
this.stopped = false;
|
|
}
|
|
|
|
public getId(): string {
|
|
return `thread:${this.session.getId()}:${this.threadId}`;
|
|
}
|
|
|
|
public clearCallStack(): void {
|
|
if (this.callStack.length) {
|
|
this.staleCallStack = this.callStack;
|
|
}
|
|
this.callStack = [];
|
|
}
|
|
|
|
public getCallStack(): IStackFrame[] {
|
|
return this.callStack;
|
|
}
|
|
|
|
public getStaleCallStack(): IStackFrame[] {
|
|
return this.staleCallStack;
|
|
}
|
|
|
|
/**
|
|
* Queries the debug adapter for the callstack and returns a promise
|
|
* which completes once the call stack has been retrieved.
|
|
* If the thread is not stopped, it returns a promise to an empty array.
|
|
* Only fetches the first stack frame for performance reasons. Calling this method consecutive times
|
|
* gets the remainder of the call stack.
|
|
*/
|
|
public fetchCallStack(levels = 20): TPromise<void> {
|
|
if (!this.stopped) {
|
|
return Promise.resolve(null);
|
|
}
|
|
|
|
const start = this.callStack.length;
|
|
return this.getCallStackImpl(start, levels).then(callStack => {
|
|
if (start < this.callStack.length) {
|
|
// Set the stack frames for exact position we requested. To make sure no concurrent requests create duplicate stack frames #30660
|
|
this.callStack.splice(start, this.callStack.length - start);
|
|
}
|
|
this.callStack = this.callStack.concat(callStack || []);
|
|
});
|
|
}
|
|
|
|
private getCallStackImpl(startFrame: number, levels: number): TPromise<IStackFrame[]> {
|
|
return this.session.stackTrace(this.threadId, startFrame, levels).then(response => {
|
|
if (!response || !response.body) {
|
|
return [];
|
|
}
|
|
|
|
if (this.stoppedDetails) {
|
|
this.stoppedDetails.totalFrames = response.body.totalFrames;
|
|
}
|
|
|
|
return response.body.stackFrames.map((rsf, index) => {
|
|
const source = this.session.getSource(rsf.source);
|
|
|
|
return new StackFrame(this, rsf.id, source, rsf.name, rsf.presentationHint, new Range(
|
|
rsf.line,
|
|
rsf.column,
|
|
rsf.endLine,
|
|
rsf.endColumn
|
|
), startFrame + index);
|
|
});
|
|
}, (err: Error) => {
|
|
if (this.stoppedDetails) {
|
|
this.stoppedDetails.framesErrorMessage = err.message;
|
|
}
|
|
|
|
return [];
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Returns exception info promise if the exception was thrown, otherwise null
|
|
*/
|
|
public get exceptionInfo(): TPromise<IExceptionInfo> {
|
|
if (this.stoppedDetails && this.stoppedDetails.reason === 'exception') {
|
|
if (this.session.capabilities.supportsExceptionInfoRequest) {
|
|
return this.session.exceptionInfo(this.threadId);
|
|
}
|
|
return Promise.resolve({
|
|
description: this.stoppedDetails.text,
|
|
breakMode: null
|
|
});
|
|
}
|
|
return Promise.resolve(null);
|
|
}
|
|
|
|
public next(): TPromise<any> {
|
|
return this.session.next(this.threadId);
|
|
}
|
|
|
|
public stepIn(): TPromise<any> {
|
|
return this.session.stepIn(this.threadId);
|
|
}
|
|
|
|
public stepOut(): TPromise<any> {
|
|
return this.session.stepOut(this.threadId);
|
|
}
|
|
|
|
public stepBack(): TPromise<any> {
|
|
return this.session.stepBack(this.threadId);
|
|
}
|
|
|
|
public continue(): TPromise<any> {
|
|
return this.session.continue(this.threadId);
|
|
}
|
|
|
|
public pause(): TPromise<any> {
|
|
return this.session.pause(this.threadId);
|
|
}
|
|
|
|
public terminate(): TPromise<any> {
|
|
return this.session.terminateThreads([this.threadId]);
|
|
}
|
|
|
|
public reverseContinue(): TPromise<any> {
|
|
return this.session.reverseContinue(this.threadId);
|
|
}
|
|
}
|
|
|
|
export class Enablement implements IEnablement {
|
|
constructor(
|
|
public enabled: boolean,
|
|
private id: string
|
|
) { }
|
|
|
|
public getId(): string {
|
|
return this.id;
|
|
}
|
|
}
|
|
|
|
export class BaseBreakpoint extends Enablement implements IBaseBreakpoint {
|
|
|
|
private sessionData = new Map<string, DebugProtocol.Breakpoint>();
|
|
private sessionId: string;
|
|
|
|
constructor(
|
|
enabled: boolean,
|
|
public hitCondition: string,
|
|
public condition: string,
|
|
public logMessage: string,
|
|
id: string
|
|
) {
|
|
super(enabled, id);
|
|
if (enabled === undefined) {
|
|
this.enabled = true;
|
|
}
|
|
}
|
|
|
|
protected getSessionData() {
|
|
return this.sessionData.get(this.sessionId);
|
|
}
|
|
|
|
public setSessionData(sessionId: string, data: DebugProtocol.Breakpoint): void {
|
|
this.sessionData.set(sessionId, data);
|
|
}
|
|
|
|
public setSessionId(sessionId: string): void {
|
|
this.sessionId = sessionId;
|
|
}
|
|
|
|
public get verified(): boolean {
|
|
const data = this.getSessionData();
|
|
return data ? data.verified : true;
|
|
}
|
|
|
|
public get idFromAdapter(): number {
|
|
const data = this.getSessionData();
|
|
return data ? data.id : undefined;
|
|
}
|
|
|
|
public toJSON(): any {
|
|
const result = Object.create(null);
|
|
result.enabled = this.enabled;
|
|
result.condition = this.condition;
|
|
result.hitCondition = this.hitCondition;
|
|
result.logMessage = this.logMessage;
|
|
|
|
return result;
|
|
}
|
|
}
|
|
|
|
export class Breakpoint extends BaseBreakpoint implements IBreakpoint {
|
|
|
|
constructor(
|
|
public uri: uri,
|
|
private _lineNumber: number,
|
|
private _column: number,
|
|
enabled: boolean,
|
|
condition: string,
|
|
hitCondition: string,
|
|
logMessage: string,
|
|
private _adapterData: any,
|
|
private textFileService: ITextFileService,
|
|
id = generateUuid()
|
|
) {
|
|
super(enabled, hitCondition, condition, logMessage, id);
|
|
}
|
|
|
|
public get lineNumber(): number {
|
|
const data = this.getSessionData();
|
|
return this.verified && data && typeof data.line === 'number' ? data.line : this._lineNumber;
|
|
}
|
|
|
|
public get verified(): boolean {
|
|
const data = this.getSessionData();
|
|
if (data) {
|
|
return data.verified && !this.textFileService.isDirty(this.uri);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public get column(): number {
|
|
const data = this.getSessionData();
|
|
// Only respect the column if the user explictly set the column to have an inline breakpoint
|
|
return data && typeof data.column === 'number' && typeof this._column === 'number' ? data.column : this._column;
|
|
}
|
|
|
|
public get message(): string {
|
|
const data = this.getSessionData();
|
|
if (!data) {
|
|
return undefined;
|
|
}
|
|
if (this.textFileService.isDirty(this.uri)) {
|
|
return nls.localize('breakpointDirtydHover', "Unverified breakpoint. File is modified, please restart debug session.");
|
|
}
|
|
|
|
return data.message;
|
|
}
|
|
|
|
public get adapterData(): any {
|
|
const data = this.getSessionData();
|
|
return data && data.source && data.source.adapterData ? data.source.adapterData : this._adapterData;
|
|
}
|
|
|
|
public get endLineNumber(): number {
|
|
const data = this.getSessionData();
|
|
return data ? data.endLine : undefined;
|
|
}
|
|
|
|
public get endColumn(): number {
|
|
const data = this.getSessionData();
|
|
return data ? data.endColumn : undefined;
|
|
}
|
|
|
|
public toJSON(): any {
|
|
const result = super.toJSON();
|
|
result.uri = this.uri;
|
|
result.lineNumber = this._lineNumber;
|
|
result.column = this._column;
|
|
result.adapterData = this.adapterData;
|
|
|
|
return result;
|
|
}
|
|
|
|
public update(data: IBreakpointUpdateData): void {
|
|
if (!isUndefinedOrNull(data.lineNumber)) {
|
|
this._lineNumber = data.lineNumber;
|
|
}
|
|
if (!isUndefinedOrNull(data.column)) {
|
|
this._column = data.column;
|
|
}
|
|
if (!isUndefinedOrNull(data.condition)) {
|
|
this.condition = data.condition;
|
|
}
|
|
if (!isUndefinedOrNull(data.hitCondition)) {
|
|
this.hitCondition = data.hitCondition;
|
|
}
|
|
if (!isUndefinedOrNull(data.logMessage)) {
|
|
this.logMessage = data.logMessage;
|
|
}
|
|
}
|
|
}
|
|
|
|
export class FunctionBreakpoint extends BaseBreakpoint implements IFunctionBreakpoint {
|
|
|
|
constructor(
|
|
public name: string,
|
|
enabled: boolean,
|
|
hitCondition: string,
|
|
condition: string,
|
|
logMessage: string,
|
|
id = generateUuid()
|
|
) {
|
|
super(enabled, hitCondition, condition, logMessage, id);
|
|
}
|
|
|
|
public toJSON(): any {
|
|
const result = super.toJSON();
|
|
result.name = this.name;
|
|
|
|
return result;
|
|
}
|
|
}
|
|
|
|
export class ExceptionBreakpoint extends Enablement implements IExceptionBreakpoint {
|
|
|
|
constructor(public filter: string, public label: string, enabled: boolean) {
|
|
super(enabled, generateUuid());
|
|
}
|
|
|
|
public toJSON(): any {
|
|
const result = Object.create(null);
|
|
result.filter = this.filter;
|
|
result.label = this.label;
|
|
result.enabled = this.enabled;
|
|
|
|
return result;
|
|
}
|
|
}
|
|
|
|
export class ThreadAndSessionIds implements ITreeElement {
|
|
constructor(public sessionId: string, public threadId: number) { }
|
|
|
|
public getId(): string {
|
|
return `${this.sessionId}:${this.threadId}`;
|
|
}
|
|
}
|
|
|
|
export class DebugModel implements IDebugModel {
|
|
|
|
private sessions: IDebugSession[];
|
|
private toDispose: lifecycle.IDisposable[];
|
|
private schedulers = new Map<string, RunOnceScheduler>();
|
|
private breakpointsSessionId: string;
|
|
private readonly _onDidChangeBreakpoints: Emitter<IBreakpointsChangeEvent>;
|
|
private readonly _onDidChangeCallStack: Emitter<void>;
|
|
private readonly _onDidChangeWatchExpressions: Emitter<IExpression>;
|
|
|
|
constructor(
|
|
private breakpoints: Breakpoint[],
|
|
private breakpointsActivated: boolean,
|
|
private functionBreakpoints: FunctionBreakpoint[],
|
|
private exceptionBreakpoints: ExceptionBreakpoint[],
|
|
private watchExpressions: Expression[],
|
|
private textFileService: ITextFileService
|
|
) {
|
|
this.sessions = [];
|
|
this.toDispose = [];
|
|
this._onDidChangeBreakpoints = new Emitter<IBreakpointsChangeEvent>();
|
|
this._onDidChangeCallStack = new Emitter<void>();
|
|
this._onDidChangeWatchExpressions = new Emitter<IExpression>();
|
|
}
|
|
|
|
public getId(): string {
|
|
return 'root';
|
|
}
|
|
|
|
public getSessions(includeInactive = false): IDebugSession[] {
|
|
// By default do not return inactive sesions.
|
|
// However we are still holding onto inactive sessions due to repl and debug service session revival (eh scenario)
|
|
return this.sessions.filter(s => includeInactive || s.state !== State.Inactive);
|
|
}
|
|
|
|
public addSession(session: IDebugSession): void {
|
|
// Make sure to remove all inactive sessions once a new session is started
|
|
this.sessions = this.sessions.filter(s => s.state !== State.Inactive);
|
|
this.sessions.push(session);
|
|
this._onDidChangeCallStack.fire();
|
|
}
|
|
|
|
public get onDidChangeBreakpoints(): Event<IBreakpointsChangeEvent> {
|
|
return this._onDidChangeBreakpoints.event;
|
|
}
|
|
|
|
public get onDidChangeCallStack(): Event<void> {
|
|
return this._onDidChangeCallStack.event;
|
|
}
|
|
|
|
public get onDidChangeWatchExpressions(): Event<IExpression> {
|
|
return this._onDidChangeWatchExpressions.event;
|
|
}
|
|
|
|
public rawUpdate(data: IRawModelUpdate): void {
|
|
let session = this.sessions.filter(p => p.getId() === data.sessionId).pop();
|
|
if (session) {
|
|
session.rawUpdate(data);
|
|
this._onDidChangeCallStack.fire();
|
|
}
|
|
}
|
|
|
|
public clearThreads(id: string, removeThreads: boolean, reference: number = undefined): void {
|
|
const session = this.sessions.filter(p => p.getId() === id).pop();
|
|
this.schedulers.forEach(scheduler => scheduler.dispose());
|
|
this.schedulers.clear();
|
|
|
|
if (session) {
|
|
session.clearThreads(removeThreads, reference);
|
|
this._onDidChangeCallStack.fire();
|
|
}
|
|
}
|
|
|
|
public fetchCallStack(thread: Thread): TPromise<void> {
|
|
if (thread.session.capabilities.supportsDelayedStackTraceLoading) {
|
|
// For improved performance load the first stack frame and then load the rest async.
|
|
return thread.fetchCallStack(1).then(() => {
|
|
if (!this.schedulers.has(thread.getId())) {
|
|
this.schedulers.set(thread.getId(), new RunOnceScheduler(() => {
|
|
thread.fetchCallStack(19).then(() => this._onDidChangeCallStack.fire());
|
|
}, 420));
|
|
}
|
|
|
|
this.schedulers.get(thread.getId()).schedule();
|
|
this._onDidChangeCallStack.fire();
|
|
});
|
|
}
|
|
|
|
return thread.fetchCallStack();
|
|
}
|
|
|
|
public getBreakpoints(filter?: { uri?: uri, lineNumber?: number, column?: number, enabledOnly?: boolean }): IBreakpoint[] {
|
|
if (filter) {
|
|
const uriStr = filter.uri ? filter.uri.toString() : undefined;
|
|
return this.breakpoints.filter(bp => {
|
|
if (uriStr && bp.uri.toString() !== uriStr) {
|
|
return false;
|
|
}
|
|
if (filter.lineNumber && bp.lineNumber !== filter.lineNumber) {
|
|
return false;
|
|
}
|
|
if (filter.column && bp.column !== filter.column) {
|
|
return false;
|
|
}
|
|
if (filter.enabledOnly && (!this.breakpointsActivated || !bp.enabled)) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
});
|
|
}
|
|
|
|
return this.breakpoints;
|
|
}
|
|
|
|
public getFunctionBreakpoints(): IFunctionBreakpoint[] {
|
|
return this.functionBreakpoints;
|
|
}
|
|
|
|
public getExceptionBreakpoints(): IExceptionBreakpoint[] {
|
|
return this.exceptionBreakpoints;
|
|
}
|
|
|
|
public setExceptionBreakpoints(data: DebugProtocol.ExceptionBreakpointsFilter[]): void {
|
|
if (data) {
|
|
if (this.exceptionBreakpoints.length === data.length && this.exceptionBreakpoints.every((exbp, i) => exbp.filter === data[i].filter && exbp.label === data[i].label)) {
|
|
// No change
|
|
return;
|
|
}
|
|
|
|
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);
|
|
});
|
|
this._onDidChangeBreakpoints.fire();
|
|
}
|
|
}
|
|
|
|
public areBreakpointsActivated(): boolean {
|
|
return this.breakpointsActivated;
|
|
}
|
|
|
|
public setBreakpointsActivated(activated: boolean): void {
|
|
this.breakpointsActivated = activated;
|
|
this._onDidChangeBreakpoints.fire();
|
|
}
|
|
|
|
public addBreakpoints(uri: uri, rawData: IBreakpointData[], fireEvent = true): IBreakpoint[] {
|
|
const newBreakpoints = rawData.map(rawBp => new Breakpoint(uri, rawBp.lineNumber, rawBp.column, rawBp.enabled, rawBp.condition, rawBp.hitCondition, rawBp.logMessage, undefined, this.textFileService, rawBp.id));
|
|
newBreakpoints.forEach(bp => bp.setSessionId(this.breakpointsSessionId));
|
|
this.breakpoints = this.breakpoints.concat(newBreakpoints);
|
|
this.breakpointsActivated = true;
|
|
this.sortAndDeDup();
|
|
|
|
if (fireEvent) {
|
|
this._onDidChangeBreakpoints.fire({ added: newBreakpoints });
|
|
}
|
|
|
|
return newBreakpoints;
|
|
}
|
|
|
|
public removeBreakpoints(toRemove: IBreakpoint[]): void {
|
|
this.breakpoints = this.breakpoints.filter(bp => !toRemove.some(toRemove => toRemove.getId() === bp.getId()));
|
|
this._onDidChangeBreakpoints.fire({ removed: toRemove });
|
|
}
|
|
|
|
public updateBreakpoints(data: { [id: string]: IBreakpointUpdateData }): void {
|
|
const updated: IBreakpoint[] = [];
|
|
this.breakpoints.forEach(bp => {
|
|
const bpData = data[bp.getId()];
|
|
if (bpData) {
|
|
bp.update(bpData);
|
|
updated.push(bp);
|
|
}
|
|
});
|
|
this.sortAndDeDup();
|
|
this._onDidChangeBreakpoints.fire({ changed: updated });
|
|
}
|
|
|
|
public setBreakpointSessionData(sessionId: string, data: { [id: string]: DebugProtocol.Breakpoint }): void {
|
|
this.breakpoints.forEach(bp => {
|
|
const bpData = data[bp.getId()];
|
|
if (bpData) {
|
|
bp.setSessionData(sessionId, bpData);
|
|
}
|
|
});
|
|
this.functionBreakpoints.forEach(fbp => {
|
|
const fbpData = data[fbp.getId()];
|
|
if (fbpData) {
|
|
fbp.setSessionData(sessionId, fbpData);
|
|
}
|
|
});
|
|
|
|
this._onDidChangeBreakpoints.fire({
|
|
sessionOnly: true
|
|
});
|
|
}
|
|
|
|
public setBreakpointsSessionId(sessionId: string): void {
|
|
this.breakpointsSessionId = sessionId;
|
|
this.breakpoints.forEach(bp => bp.setSessionId(sessionId));
|
|
this.functionBreakpoints.forEach(fbp => fbp.setSessionId(sessionId));
|
|
|
|
this._onDidChangeBreakpoints.fire({
|
|
sessionOnly: true
|
|
});
|
|
}
|
|
|
|
private sortAndDeDup(): void {
|
|
this.breakpoints = this.breakpoints.sort((first, second) => {
|
|
if (first.uri.toString() !== second.uri.toString()) {
|
|
return resources.basenameOrAuthority(first.uri).localeCompare(resources.basenameOrAuthority(second.uri));
|
|
}
|
|
if (first.lineNumber === second.lineNumber) {
|
|
return first.column - second.column;
|
|
}
|
|
|
|
return first.lineNumber - second.lineNumber;
|
|
});
|
|
this.breakpoints = distinct(this.breakpoints, bp => `${bp.uri.toString()}:${bp.lineNumber}:${bp.column}`);
|
|
}
|
|
|
|
public setEnablement(element: IEnablement, enable: boolean): void {
|
|
if (element instanceof Breakpoint || element instanceof FunctionBreakpoint || element instanceof ExceptionBreakpoint) {
|
|
const changed: (IBreakpoint | IFunctionBreakpoint)[] = [];
|
|
if (element.enabled !== enable && (element instanceof Breakpoint || element instanceof FunctionBreakpoint)) {
|
|
changed.push(element);
|
|
}
|
|
|
|
element.enabled = enable;
|
|
|
|
this._onDidChangeBreakpoints.fire({ changed: changed });
|
|
}
|
|
}
|
|
|
|
public enableOrDisableAllBreakpoints(enable: boolean): void {
|
|
const changed: (IBreakpoint | IFunctionBreakpoint)[] = [];
|
|
|
|
this.breakpoints.forEach(bp => {
|
|
if (bp.enabled !== enable) {
|
|
changed.push(bp);
|
|
}
|
|
bp.enabled = enable;
|
|
});
|
|
this.functionBreakpoints.forEach(fbp => {
|
|
if (fbp.enabled !== enable) {
|
|
changed.push(fbp);
|
|
}
|
|
fbp.enabled = enable;
|
|
});
|
|
|
|
this._onDidChangeBreakpoints.fire({ changed: changed });
|
|
}
|
|
|
|
public addFunctionBreakpoint(functionName: string, id: string): IFunctionBreakpoint {
|
|
const newFunctionBreakpoint = new FunctionBreakpoint(functionName, true, undefined, undefined, undefined, id);
|
|
this.functionBreakpoints.push(newFunctionBreakpoint);
|
|
this._onDidChangeBreakpoints.fire({ added: [newFunctionBreakpoint] });
|
|
|
|
return newFunctionBreakpoint;
|
|
}
|
|
|
|
public renameFunctionBreakpoint(id: string, name: string): void {
|
|
const functionBreakpoint = this.functionBreakpoints.filter(fbp => fbp.getId() === id).pop();
|
|
if (functionBreakpoint) {
|
|
functionBreakpoint.name = name;
|
|
this._onDidChangeBreakpoints.fire({ changed: [functionBreakpoint] });
|
|
}
|
|
}
|
|
|
|
public removeFunctionBreakpoints(id?: string): void {
|
|
|
|
let removed: IFunctionBreakpoint[];
|
|
if (id) {
|
|
removed = this.functionBreakpoints.filter(fbp => fbp.getId() === id);
|
|
this.functionBreakpoints = this.functionBreakpoints.filter(fbp => fbp.getId() !== id);
|
|
} else {
|
|
removed = this.functionBreakpoints;
|
|
this.functionBreakpoints = [];
|
|
}
|
|
this._onDidChangeBreakpoints.fire({ removed: removed });
|
|
}
|
|
|
|
public getWatchExpressions(): Expression[] {
|
|
return this.watchExpressions;
|
|
}
|
|
|
|
public addWatchExpression(name: string): IExpression {
|
|
const we = new Expression(name);
|
|
this.watchExpressions.push(we);
|
|
this._onDidChangeWatchExpressions.fire(we);
|
|
|
|
return we;
|
|
}
|
|
|
|
public renameWatchExpression(id: string, newName: string): void {
|
|
const filtered = this.watchExpressions.filter(we => we.getId() === id);
|
|
if (filtered.length === 1) {
|
|
filtered[0].name = newName;
|
|
this._onDidChangeWatchExpressions.fire(filtered[0]);
|
|
}
|
|
}
|
|
|
|
public removeWatchExpressions(id: string = null): void {
|
|
this.watchExpressions = id ? this.watchExpressions.filter(we => we.getId() !== id) : [];
|
|
this._onDidChangeWatchExpressions.fire();
|
|
}
|
|
|
|
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();
|
|
}
|
|
|
|
public sourceIsNotAvailable(uri: uri): void {
|
|
this.sessions.forEach(s => {
|
|
const source = s.getSourceForUri(uri);
|
|
if (source) {
|
|
source.available = false;
|
|
}
|
|
});
|
|
this._onDidChangeCallStack.fire();
|
|
}
|
|
|
|
public dispose(): void {
|
|
// Make sure to shutdown each session, such that no debugged process is left laying around
|
|
this.sessions.forEach(s => s.shutdown());
|
|
this.toDispose = lifecycle.dispose(this.toDispose);
|
|
}
|
|
}
|