This repository has been archived on 2026-07-08. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
azuredatastudio/src/vs/workbench/contrib/debug/browser/callStackView.ts
T

1124 lines
41 KiB
TypeScript

/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as nls from 'vs/nls';
import { RunOnceScheduler } from 'vs/base/common/async';
import * as dom from 'vs/base/browser/dom';
import { IViewletViewOptions } from 'vs/workbench/browser/parts/views/viewsViewlet';
import { IDebugService, State, IStackFrame, IDebugSession, IThread, CONTEXT_CALLSTACK_ITEM_TYPE, IDebugModel } from 'vs/workbench/contrib/debug/common/debug';
import { Thread, StackFrame, ThreadAndSessionIds } from 'vs/workbench/contrib/debug/common/debugModel';
import { IContextMenuService } from 'vs/platform/contextview/browser/contextView';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { MenuId, IMenu, IMenuService, MenuItemAction, SubmenuItemAction } from 'vs/platform/actions/common/actions';
import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
import { renderViewTree } from 'vs/workbench/contrib/debug/browser/baseDebugView';
import { IAction, Action } from 'vs/base/common/actions';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { IContextKey, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { ViewPane } from 'vs/workbench/browser/parts/views/viewPaneContainer';
import { ILabelService } from 'vs/platform/label/common/label';
import { IListAccessibilityProvider } from 'vs/base/browser/ui/list/listWidget';
import { createAndFillInContextMenuActions, createAndFillInActionBarActions, MenuEntryActionViewItem, SubmenuEntryActionViewItem } from 'vs/platform/actions/browser/menuEntryActionViewItem';
import { IListVirtualDelegate } from 'vs/base/browser/ui/list/list';
import { ITreeNode, ITreeContextMenuEvent, IAsyncDataSource } from 'vs/base/browser/ui/tree/tree';
import { WorkbenchCompressibleAsyncDataTree } from 'vs/platform/list/browser/listService';
import { HighlightedLabel } from 'vs/base/browser/ui/highlightedlabel/highlightedLabel';
import { createMatches, FuzzyScore, IMatch } from 'vs/base/common/filters';
import { Event } from 'vs/base/common/event';
import { dispose, IDisposable } from 'vs/base/common/lifecycle';
import { ActionBar } from 'vs/base/browser/ui/actionbar/actionbar';
import { isSessionAttach } from 'vs/workbench/contrib/debug/common/debugUtils';
import { STOP_ID, STOP_LABEL, DISCONNECT_ID, DISCONNECT_LABEL, RESTART_SESSION_ID, RESTART_LABEL, STEP_OVER_ID, STEP_OVER_LABEL, STEP_INTO_LABEL, STEP_INTO_ID, STEP_OUT_LABEL, STEP_OUT_ID, PAUSE_ID, PAUSE_LABEL, CONTINUE_ID, CONTINUE_LABEL } from 'vs/workbench/contrib/debug/browser/debugCommands';
import { ICommandService } from 'vs/platform/commands/common/commands';
import { CollapseAction } from 'vs/workbench/browser/viewlet';
import { IViewDescriptorService } from 'vs/workbench/common/views';
import { textLinkForeground } from 'vs/platform/theme/common/colorRegistry';
import { IThemeService } from 'vs/platform/theme/common/themeService';
import { IOpenerService } from 'vs/platform/opener/common/opener';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
import { attachStylerCallback } from 'vs/platform/theme/common/styler';
import { INotificationService } from 'vs/platform/notification/common/notification';
import { commonSuffixLength } from 'vs/base/common/strings';
import { posix } from 'vs/base/common/path';
import { ITreeCompressionDelegate } from 'vs/base/browser/ui/tree/asyncDataTree';
import { ICompressibleTreeRenderer } from 'vs/base/browser/ui/tree/objectTree';
import { ICompressedTreeNode } from 'vs/base/browser/ui/tree/compressedObjectTreeModel';
const $ = dom.$;
type CallStackItem = IStackFrame | IThread | IDebugSession | string | ThreadAndSessionIds | IStackFrame[];
export function getContext(element: CallStackItem | null): any {
return element instanceof StackFrame ? {
sessionId: element.thread.session.getId(),
threadId: element.thread.getId(),
frameId: element.getId()
} : element instanceof Thread ? {
sessionId: element.session.getId(),
threadId: element.getId()
} : isDebugSession(element) ? {
sessionId: element.getId()
} : undefined;
}
// Extensions depend on this context, should not be changed even though it is not fully deterministic
export function getContextForContributedActions(element: CallStackItem | null): string | number {
if (element instanceof StackFrame) {
if (element.source.inMemory) {
return element.source.raw.path || element.source.reference || element.source.name;
}
return element.source.uri.toString();
}
if (element instanceof Thread) {
return element.threadId;
}
if (isDebugSession(element)) {
return element.getId();
}
return '';
}
export function getSpecificSourceName(stackFrame: IStackFrame): string {
// To reduce flashing of the path name and the way we fetch stack frames
// We need to compute the source name based on the other frames in the stale call stack
let callStack = (<Thread>stackFrame.thread).getStaleCallStack();
callStack = callStack.length > 0 ? callStack : stackFrame.thread.getCallStack();
const otherSources = callStack.map(sf => sf.source).filter(s => s !== stackFrame.source);
let suffixLength = 0;
otherSources.forEach(s => {
if (s.name === stackFrame.source.name) {
suffixLength = Math.max(suffixLength, commonSuffixLength(stackFrame.source.uri.path, s.uri.path));
}
});
if (suffixLength === 0) {
return stackFrame.source.name;
}
const from = Math.max(0, stackFrame.source.uri.path.lastIndexOf(posix.sep, stackFrame.source.uri.path.length - suffixLength - 1));
return (from > 0 ? '...' : '') + stackFrame.source.uri.path.substr(from);
}
async function expandTo(session: IDebugSession, tree: WorkbenchCompressibleAsyncDataTree<IDebugModel, CallStackItem, FuzzyScore>): Promise<void> {
if (session.parentSession) {
await expandTo(session.parentSession, tree);
}
await tree.expand(session);
}
export class CallStackView extends ViewPane {
private pauseMessage!: HTMLSpanElement;
private pauseMessageLabel!: HTMLSpanElement;
private onCallStackChangeScheduler: RunOnceScheduler;
private needsRefresh = false;
private ignoreSelectionChangedEvent = false;
private ignoreFocusStackFrameEvent = false;
private callStackItemType: IContextKey<string>;
private dataSource!: CallStackDataSource;
private tree!: WorkbenchCompressibleAsyncDataTree<IDebugModel, CallStackItem, FuzzyScore>;
private menu: IMenu;
private autoExpandedSessions = new Set<IDebugSession>();
private selectionNeedsUpdate = false;
constructor(
private options: IViewletViewOptions,
@IContextMenuService contextMenuService: IContextMenuService,
@IDebugService private readonly debugService: IDebugService,
@IKeybindingService keybindingService: IKeybindingService,
@IInstantiationService instantiationService: IInstantiationService,
@IViewDescriptorService viewDescriptorService: IViewDescriptorService,
@IEditorService private readonly editorService: IEditorService,
@IConfigurationService configurationService: IConfigurationService,
@IMenuService menuService: IMenuService,
@IContextKeyService readonly contextKeyService: IContextKeyService,
@IOpenerService openerService: IOpenerService,
@IThemeService themeService: IThemeService,
@ITelemetryService telemetryService: ITelemetryService,
) {
super(options, keybindingService, contextMenuService, configurationService, contextKeyService, viewDescriptorService, instantiationService, openerService, themeService, telemetryService);
this.callStackItemType = CONTEXT_CALLSTACK_ITEM_TYPE.bindTo(contextKeyService);
this.menu = menuService.createMenu(MenuId.DebugCallStackContext, contextKeyService);
this._register(this.menu);
// Create scheduler to prevent unnecessary flashing of tree when reacting to changes
this.onCallStackChangeScheduler = new RunOnceScheduler(async () => {
// Only show the global pause message if we do not display threads.
// Otherwise there will be a pause message per thread and there is no need for a global one.
const sessions = this.debugService.getModel().getSessions();
if (sessions.length === 0) {
this.autoExpandedSessions.clear();
}
const thread = sessions.length === 1 && sessions[0].getAllThreads().length === 1 ? sessions[0].getAllThreads()[0] : undefined;
if (thread && thread.stoppedDetails) {
this.pauseMessageLabel.textContent = thread.stoppedDetails.description || nls.localize('debugStopped', "Paused on {0}", thread.stoppedDetails.reason || '');
this.pauseMessageLabel.title = thread.stoppedDetails.text || '';
dom.toggleClass(this.pauseMessageLabel, 'exception', thread.stoppedDetails.reason === 'exception');
this.pauseMessage.hidden = false;
this.updateActions();
} else {
this.pauseMessage.hidden = true;
this.updateActions();
}
this.needsRefresh = false;
this.dataSource.deemphasizedStackFramesToShow = [];
await this.tree.updateChildren();
try {
const toExpand = new Set<IDebugSession>();
sessions.forEach(s => {
// Automatically expand sessions that have children, but only do this once.
if (s.parentSession && !this.autoExpandedSessions.has(s.parentSession)) {
toExpand.add(s.parentSession);
}
});
for (let session of toExpand) {
await expandTo(session, this.tree);
this.autoExpandedSessions.add(session);
}
} catch (e) {
// Ignore tree expand errors if element no longer present
}
if (this.selectionNeedsUpdate) {
this.selectionNeedsUpdate = false;
await this.updateTreeSelection();
}
}, 50);
}
protected renderHeaderTitle(container: HTMLElement): void {
const titleContainer = dom.append(container, $('.debug-call-stack-title'));
super.renderHeaderTitle(titleContainer, this.options.title);
this.pauseMessage = dom.append(titleContainer, $('span.pause-message'));
this.pauseMessage.hidden = true;
this.pauseMessageLabel = dom.append(this.pauseMessage, $('span.label'));
}
getActions(): IAction[] {
if (this.pauseMessage.hidden) {
return [new CollapseAction(() => this.tree, true, 'explorer-action codicon-collapse-all')];
}
return [];
}
renderBody(container: HTMLElement): void {
super.renderBody(container);
dom.addClass(this.element, 'debug-pane');
dom.addClass(container, 'debug-call-stack');
const treeContainer = renderViewTree(container);
this.dataSource = new CallStackDataSource(this.debugService);
const sessionsRenderer = this.instantiationService.createInstance(SessionsRenderer, this.menu);
this.tree = <WorkbenchCompressibleAsyncDataTree<IDebugModel, CallStackItem, FuzzyScore>>this.instantiationService.createInstance(WorkbenchCompressibleAsyncDataTree, 'CallStackView', treeContainer, new CallStackDelegate(), new CallStackCompressionDelegate(this.debugService), [
sessionsRenderer,
new ThreadsRenderer(this.instantiationService),
this.instantiationService.createInstance(StackFramesRenderer),
new ErrorsRenderer(),
new LoadMoreRenderer(this.themeService),
new ShowMoreRenderer(this.themeService)
], this.dataSource, {
accessibilityProvider: new CallStackAccessibilityProvider(),
compressionEnabled: true,
autoExpandSingleChildren: true,
identityProvider: {
getId: (element: CallStackItem) => {
if (typeof element === 'string') {
return element;
}
if (element instanceof Array) {
return `showMore ${element[0].getId()}`;
}
return element.getId();
}
},
keyboardNavigationLabelProvider: {
getKeyboardNavigationLabel: (e: CallStackItem) => {
if (isDebugSession(e)) {
return e.getLabel();
}
if (e instanceof Thread) {
return `${e.name} ${e.stateLabel}`;
}
if (e instanceof StackFrame || typeof e === 'string') {
return e;
}
if (e instanceof ThreadAndSessionIds) {
return LoadMoreRenderer.LABEL;
}
return nls.localize('showMoreStackFrames2', "Show More Stack Frames");
},
getCompressedNodeKeyboardNavigationLabel: (e: CallStackItem[]) => {
const firstItem = e[0];
if (isDebugSession(firstItem)) {
return firstItem.getLabel();
}
return '';
}
},
expandOnlyOnTwistieClick: true,
overrideStyles: {
listBackground: this.getBackgroundColor()
}
});
this.tree.setInput(this.debugService.getModel());
this._register(this.tree.onDidOpen(e => {
if (this.ignoreSelectionChangedEvent) {
return;
}
const focusStackFrame = (stackFrame: IStackFrame | undefined, thread: IThread | undefined, session: IDebugSession) => {
this.ignoreFocusStackFrameEvent = true;
try {
this.debugService.focusStackFrame(stackFrame, thread, session, true);
} finally {
this.ignoreFocusStackFrameEvent = false;
}
};
const element = e.element;
if (element instanceof StackFrame) {
focusStackFrame(element, element.thread, element.thread.session);
element.openInEditor(this.editorService, e.editorOptions.preserveFocus, e.sideBySide, e.editorOptions.pinned);
}
if (element instanceof Thread) {
focusStackFrame(undefined, element, element.session);
}
if (isDebugSession(element)) {
focusStackFrame(undefined, undefined, element);
}
if (element instanceof ThreadAndSessionIds) {
const session = this.debugService.getModel().getSession(element.sessionId);
const thread = session && session.getThread(element.threadId);
if (thread) {
(<Thread>thread).fetchCallStack()
.then(() => this.tree.updateChildren());
}
}
if (element instanceof Array) {
this.dataSource.deemphasizedStackFramesToShow.push(...element);
this.tree.updateChildren();
}
}));
this._register(this.debugService.getModel().onDidChangeCallStack(() => {
if (!this.isBodyVisible()) {
this.needsRefresh = true;
return;
}
if (!this.onCallStackChangeScheduler.isScheduled()) {
this.onCallStackChangeScheduler.schedule();
}
}));
const onFocusChange = Event.any<any>(this.debugService.getViewModel().onDidFocusStackFrame, this.debugService.getViewModel().onDidFocusSession);
this._register(onFocusChange(async () => {
if (this.ignoreFocusStackFrameEvent) {
return;
}
if (!this.isBodyVisible()) {
this.needsRefresh = true;
return;
}
if (this.onCallStackChangeScheduler.isScheduled()) {
this.selectionNeedsUpdate = true;
return;
}
await this.updateTreeSelection();
}));
this._register(this.tree.onContextMenu(e => this.onContextMenu(e)));
// Schedule the update of the call stack tree if the viewlet is opened after a session started #14684
if (this.debugService.state === State.Stopped) {
this.onCallStackChangeScheduler.schedule(0);
}
this._register(this.onDidChangeBodyVisibility(visible => {
if (visible && this.needsRefresh) {
this.onCallStackChangeScheduler.schedule();
}
}));
this._register(this.debugService.onDidNewSession(s => {
const sessionListeners: IDisposable[] = [];
sessionListeners.push(s.onDidChangeName(() => this.tree.rerender(s)));
sessionListeners.push(s.onDidEndAdapter(() => dispose(sessionListeners)));
if (s.parentSession) {
// A session we already expanded has a new child session, allow to expand it again.
this.autoExpandedSessions.delete(s.parentSession);
}
}));
}
layoutBody(height: number, width: number): void {
super.layoutBody(height, width);
this.tree.layout(height, width);
}
focus(): void {
this.tree.domFocus();
}
private async updateTreeSelection(): Promise<void> {
if (!this.tree || !this.tree.getInput()) {
// Tree not initialized yet
return;
}
const updateSelectionAndReveal = (element: IStackFrame | IDebugSession) => {
this.ignoreSelectionChangedEvent = true;
try {
this.tree.setSelection([element]);
// If the element is outside of the screen bounds,
// position it in the middle
if (this.tree.getRelativeTop(element) === null) {
this.tree.reveal(element, 0.5);
} else {
this.tree.reveal(element);
}
} catch (e) { }
finally {
this.ignoreSelectionChangedEvent = false;
}
};
const thread = this.debugService.getViewModel().focusedThread;
const session = this.debugService.getViewModel().focusedSession;
const stackFrame = this.debugService.getViewModel().focusedStackFrame;
if (!thread) {
if (!session) {
this.tree.setSelection([]);
} else {
updateSelectionAndReveal(session);
}
} else {
// Ignore errors from this expansions because we are not aware if we rendered the threads and sessions or we hide them to declutter the view
try {
await expandTo(thread.session, this.tree);
} catch (e) { }
try {
await this.tree.expand(thread);
} catch (e) { }
const toReveal = stackFrame || session;
if (toReveal) {
updateSelectionAndReveal(toReveal);
}
}
}
private onContextMenu(e: ITreeContextMenuEvent<CallStackItem>): void {
const element = e.element;
if (isDebugSession(element)) {
this.callStackItemType.set('session');
} else if (element instanceof Thread) {
this.callStackItemType.set('thread');
} else if (element instanceof StackFrame) {
this.callStackItemType.set('stackFrame');
} else {
this.callStackItemType.reset();
}
const primary: IAction[] = [];
const secondary: IAction[] = [];
const result = { primary, secondary };
const actionsDisposable = createAndFillInContextMenuActions(this.menu, { arg: getContextForContributedActions(element), shouldForwardArgs: true }, result, this.contextMenuService, g => /^inline/.test(g));
this.contextMenuService.showContextMenu({
getAnchor: () => e.anchor,
getActions: () => result.secondary,
getActionsContext: () => getContext(element),
onHide: () => dispose(actionsDisposable)
});
}
}
interface IThreadTemplateData {
thread: HTMLElement;
name: HTMLElement;
state: HTMLElement;
stateLabel: HTMLSpanElement;
label: HighlightedLabel;
actionBar: ActionBar;
}
interface ISessionTemplateData {
session: HTMLElement;
name: HTMLElement;
state: HTMLElement;
stateLabel: HTMLSpanElement;
label: HighlightedLabel;
actionBar: ActionBar;
elementDisposable: IDisposable[];
}
interface IErrorTemplateData {
label: HTMLElement;
}
interface ILabelTemplateData {
label: HTMLElement;
toDispose: IDisposable;
}
interface IStackFrameTemplateData {
stackFrame: HTMLElement;
file: HTMLElement;
fileName: HTMLElement;
lineNumber: HTMLElement;
label: HighlightedLabel;
actionBar: ActionBar;
}
class SessionsRenderer implements ICompressibleTreeRenderer<IDebugSession, FuzzyScore, ISessionTemplateData> {
static readonly ID = 'session';
constructor(
private menu: IMenu,
@IInstantiationService private readonly instantiationService: IInstantiationService,
@IDebugService private readonly debugService: IDebugService
) { }
get templateId(): string {
return SessionsRenderer.ID;
}
renderTemplate(container: HTMLElement): ISessionTemplateData {
const session = dom.append(container, $('.session'));
dom.append(session, $('.codicon.codicon-bug'));
const name = dom.append(session, $('.name'));
const state = dom.append(session, $('.state'));
const stateLabel = dom.append(state, $('span.label.monaco-count-badge.long'));
const label = new HighlightedLabel(name, false);
const actionBar = new ActionBar(session, {
actionViewItemProvider: action => {
if (action instanceof MenuItemAction) {
return this.instantiationService.createInstance(MenuEntryActionViewItem, action);
} else if (action instanceof SubmenuItemAction) {
return this.instantiationService.createInstance(SubmenuEntryActionViewItem, action);
}
return undefined;
}
});
return { session, name, state, stateLabel, label, actionBar, elementDisposable: [] };
}
renderElement(element: ITreeNode<IDebugSession, FuzzyScore>, _: number, data: ISessionTemplateData): void {
this.doRenderElement(element.element, createMatches(element.filterData), data);
}
renderCompressedElements(node: ITreeNode<ICompressedTreeNode<IDebugSession>, FuzzyScore>, index: number, templateData: ISessionTemplateData, height: number | undefined): void {
const lastElement = node.element.elements[node.element.elements.length - 1];
const matches = createMatches(node.filterData);
this.doRenderElement(lastElement, matches, templateData);
}
private doRenderElement(session: IDebugSession, matches: IMatch[], data: ISessionTemplateData): void {
data.session.title = nls.localize({ key: 'session', comment: ['Session is a noun'] }, "Session");
data.label.set(session.getLabel(), matches);
const thread = session.getAllThreads().find(t => t.stopped);
const setActionBar = () => {
const actions = getActions(this.instantiationService, session);
const primary: IAction[] = actions;
const secondary: IAction[] = [];
const result = { primary, secondary };
data.elementDisposable.push(createAndFillInActionBarActions(this.menu, { arg: getContextForContributedActions(session), shouldForwardArgs: true }, result, g => /^inline/.test(g)));
data.actionBar.clear();
data.actionBar.push(primary, { icon: true, label: false });
};
setActionBar();
data.elementDisposable.push(this.menu.onDidChange(() => setActionBar()));
data.stateLabel.hidden = false;
if (thread && thread.stoppedDetails) {
data.stateLabel.textContent = thread.stoppedDetails.description || nls.localize('debugStopped', "Paused on {0}", thread.stoppedDetails.reason || '');
} else {
const hasChildSessions = this.debugService.getModel().getSessions().find(s => s.parentSession === session);
if (!hasChildSessions) {
data.stateLabel.textContent = nls.localize({ key: 'running', comment: ['indicates state'] }, "Running");
} else {
data.stateLabel.hidden = true;
}
}
}
disposeTemplate(templateData: ISessionTemplateData): void {
templateData.actionBar.dispose();
}
disposeElement(_element: ITreeNode<IDebugSession, FuzzyScore>, _: number, templateData: ISessionTemplateData): void {
dispose(templateData.elementDisposable);
}
}
class ThreadsRenderer implements ICompressibleTreeRenderer<IThread, FuzzyScore, IThreadTemplateData> {
static readonly ID = 'thread';
constructor(private readonly instantiationService: IInstantiationService) { }
get templateId(): string {
return ThreadsRenderer.ID;
}
renderTemplate(container: HTMLElement): IThreadTemplateData {
const thread = dom.append(container, $('.thread'));
const name = dom.append(thread, $('.name'));
const state = dom.append(thread, $('.state'));
const stateLabel = dom.append(state, $('span.label'));
const label = new HighlightedLabel(name, false);
const actionBar = new ActionBar(thread);
return { thread, name, state, stateLabel, label, actionBar };
}
renderElement(element: ITreeNode<IThread, FuzzyScore>, index: number, data: IThreadTemplateData): void {
const thread = element.element;
data.thread.title = nls.localize('thread', "Thread");
data.label.set(thread.name, createMatches(element.filterData));
data.stateLabel.textContent = thread.stateLabel;
data.actionBar.clear();
const actions = getActions(this.instantiationService, thread);
data.actionBar.push(actions, { icon: true, label: false });
}
renderCompressedElements(node: ITreeNode<ICompressedTreeNode<IThread>, FuzzyScore>, index: number, templateData: IThreadTemplateData, height: number | undefined): void {
throw new Error('Method not implemented.');
}
disposeTemplate(templateData: IThreadTemplateData): void {
templateData.actionBar.dispose();
}
}
class StackFramesRenderer implements ICompressibleTreeRenderer<IStackFrame, FuzzyScore, IStackFrameTemplateData> {
static readonly ID = 'stackFrame';
constructor(
@ILabelService private readonly labelService: ILabelService,
@INotificationService private readonly notificationService: INotificationService
) { }
get templateId(): string {
return StackFramesRenderer.ID;
}
renderTemplate(container: HTMLElement): IStackFrameTemplateData {
const stackFrame = dom.append(container, $('.stack-frame'));
const labelDiv = dom.append(stackFrame, $('span.label.expression'));
const file = dom.append(stackFrame, $('.file'));
const fileName = dom.append(file, $('span.file-name'));
const wrapper = dom.append(file, $('span.line-number-wrapper'));
const lineNumber = dom.append(wrapper, $('span.line-number.monaco-count-badge'));
const label = new HighlightedLabel(labelDiv, false);
const actionBar = new ActionBar(stackFrame);
return { file, fileName, label, lineNumber, stackFrame, actionBar };
}
renderElement(element: ITreeNode<IStackFrame, FuzzyScore>, index: number, data: IStackFrameTemplateData): void {
const stackFrame = element.element;
dom.toggleClass(data.stackFrame, 'disabled', !stackFrame.source || !stackFrame.source.available || isDeemphasized(stackFrame));
dom.toggleClass(data.stackFrame, 'label', stackFrame.presentationHint === 'label');
dom.toggleClass(data.stackFrame, 'subtle', stackFrame.presentationHint === 'subtle');
const hasActions = !!stackFrame.thread.session.capabilities.supportsRestartFrame && stackFrame.presentationHint !== 'label' && stackFrame.presentationHint !== 'subtle';
dom.toggleClass(data.stackFrame, 'has-actions', hasActions);
data.file.title = stackFrame.source.inMemory ? stackFrame.source.uri.path : this.labelService.getUriLabel(stackFrame.source.uri);
if (stackFrame.source.raw.origin) {
data.file.title += `\n${stackFrame.source.raw.origin}`;
}
data.label.set(stackFrame.name, createMatches(element.filterData), stackFrame.name);
data.fileName.textContent = getSpecificSourceName(stackFrame);
if (stackFrame.range.startLineNumber !== undefined) {
data.lineNumber.textContent = `${stackFrame.range.startLineNumber}`;
if (stackFrame.range.startColumn) {
data.lineNumber.textContent += `:${stackFrame.range.startColumn}`;
}
dom.removeClass(data.lineNumber, 'unavailable');
} else {
dom.addClass(data.lineNumber, 'unavailable');
}
data.actionBar.clear();
if (hasActions) {
const action = new Action('debug.callStack.restartFrame', nls.localize('restartFrame', "Restart Frame"), 'codicon-debug-restart-frame', true, async () => {
try {
await stackFrame.restart();
} catch (e) {
this.notificationService.error(e);
}
});
data.actionBar.push(action, { icon: true, label: false });
}
}
renderCompressedElements(node: ITreeNode<ICompressedTreeNode<IStackFrame>, FuzzyScore>, index: number, templateData: IStackFrameTemplateData, height: number | undefined): void {
throw new Error('Method not implemented.');
}
disposeTemplate(templateData: IStackFrameTemplateData): void {
templateData.actionBar.dispose();
}
}
class ErrorsRenderer implements ICompressibleTreeRenderer<string, FuzzyScore, IErrorTemplateData> {
static readonly ID = 'error';
get templateId(): string {
return ErrorsRenderer.ID;
}
renderTemplate(container: HTMLElement): IErrorTemplateData {
const label = dom.append(container, $('.error'));
return { label };
}
renderElement(element: ITreeNode<string, FuzzyScore>, index: number, data: IErrorTemplateData): void {
const error = element.element;
data.label.textContent = error;
data.label.title = error;
}
renderCompressedElements(node: ITreeNode<ICompressedTreeNode<string>, FuzzyScore>, index: number, templateData: IErrorTemplateData, height: number | undefined): void {
throw new Error('Method not implemented.');
}
disposeTemplate(templateData: IErrorTemplateData): void {
// noop
}
}
class LoadMoreRenderer implements ICompressibleTreeRenderer<ThreadAndSessionIds, FuzzyScore, ILabelTemplateData> {
static readonly ID = 'loadMore';
static readonly LABEL = nls.localize('loadMoreStackFrames', "Load More Stack Frames");
constructor(private readonly themeService: IThemeService) { }
get templateId(): string {
return LoadMoreRenderer.ID;
}
renderTemplate(container: HTMLElement): ILabelTemplateData {
const label = dom.append(container, $('.load-more'));
const toDispose = attachStylerCallback(this.themeService, { textLinkForeground }, colors => {
if (colors.textLinkForeground) {
label.style.color = colors.textLinkForeground.toString();
}
});
return { label, toDispose };
}
renderElement(element: ITreeNode<ThreadAndSessionIds, FuzzyScore>, index: number, data: ILabelTemplateData): void {
data.label.textContent = LoadMoreRenderer.LABEL;
}
renderCompressedElements(node: ITreeNode<ICompressedTreeNode<ThreadAndSessionIds>, FuzzyScore>, index: number, templateData: ILabelTemplateData, height: number | undefined): void {
throw new Error('Method not implemented.');
}
disposeTemplate(templateData: ILabelTemplateData): void {
templateData.toDispose.dispose();
}
}
class ShowMoreRenderer implements ICompressibleTreeRenderer<IStackFrame[], FuzzyScore, ILabelTemplateData> {
static readonly ID = 'showMore';
constructor(private readonly themeService: IThemeService) { }
get templateId(): string {
return ShowMoreRenderer.ID;
}
renderTemplate(container: HTMLElement): ILabelTemplateData {
const label = dom.append(container, $('.show-more'));
const toDispose = attachStylerCallback(this.themeService, { textLinkForeground }, colors => {
if (colors.textLinkForeground) {
label.style.color = colors.textLinkForeground.toString();
}
});
return { label, toDispose };
}
renderElement(element: ITreeNode<IStackFrame[], FuzzyScore>, index: number, data: ILabelTemplateData): void {
const stackFrames = element.element;
if (stackFrames.every(sf => !!(sf.source && sf.source.origin && sf.source.origin === stackFrames[0].source.origin))) {
data.label.textContent = nls.localize('showMoreAndOrigin', "Show {0} More: {1}", stackFrames.length, stackFrames[0].source.origin);
} else {
data.label.textContent = nls.localize('showMoreStackFrames', "Show {0} More Stack Frames", stackFrames.length);
}
}
renderCompressedElements(node: ITreeNode<ICompressedTreeNode<IStackFrame[]>, FuzzyScore>, index: number, templateData: ILabelTemplateData, height: number | undefined): void {
throw new Error('Method not implemented.');
}
disposeTemplate(templateData: ILabelTemplateData): void {
templateData.toDispose.dispose();
}
}
class CallStackDelegate implements IListVirtualDelegate<CallStackItem> {
getHeight(element: CallStackItem): number {
if (element instanceof StackFrame && element.presentationHint === 'label') {
return 16;
}
if (element instanceof ThreadAndSessionIds || element instanceof Array) {
return 16;
}
return 22;
}
getTemplateId(element: CallStackItem): string {
if (isDebugSession(element)) {
return SessionsRenderer.ID;
}
if (element instanceof Thread) {
return ThreadsRenderer.ID;
}
if (element instanceof StackFrame) {
return StackFramesRenderer.ID;
}
if (typeof element === 'string') {
return ErrorsRenderer.ID;
}
if (element instanceof ThreadAndSessionIds) {
return LoadMoreRenderer.ID;
}
// element instanceof Array
return ShowMoreRenderer.ID;
}
}
function isDebugModel(obj: any): obj is IDebugModel {
return typeof obj.getSessions === 'function';
}
function isDebugSession(obj: any): obj is IDebugSession {
return obj && typeof obj.getAllThreads === 'function';
}
function isDeemphasized(frame: IStackFrame): boolean {
return frame.source.presentationHint === 'deemphasize' || frame.presentationHint === 'deemphasize';
}
class CallStackDataSource implements IAsyncDataSource<IDebugModel, CallStackItem> {
deemphasizedStackFramesToShow: IStackFrame[] = [];
constructor(private debugService: IDebugService) { }
hasChildren(element: IDebugModel | CallStackItem): boolean {
if (isDebugSession(element)) {
const threads = element.getAllThreads();
return (threads.length > 1) || (threads.length === 1 && threads[0].stopped) || !!(this.debugService.getModel().getSessions().find(s => s.parentSession === element));
}
return isDebugModel(element) || (element instanceof Thread && element.stopped);
}
async getChildren(element: IDebugModel | CallStackItem): Promise<CallStackItem[]> {
if (isDebugModel(element)) {
const sessions = element.getSessions();
if (sessions.length === 0) {
return Promise.resolve([]);
}
if (sessions.length > 1 || this.debugService.getViewModel().isMultiSessionView()) {
return Promise.resolve(sessions.filter(s => !s.parentSession));
}
const threads = sessions[0].getAllThreads();
// Only show the threads in the call stack if there is more than 1 thread.
return threads.length === 1 ? this.getThreadChildren(<Thread>threads[0]) : Promise.resolve(threads);
} else if (isDebugSession(element)) {
const childSessions = this.debugService.getModel().getSessions().filter(s => s.parentSession === element);
const threads: CallStackItem[] = element.getAllThreads();
if (threads.length === 1) {
// Do not show thread when there is only one to be compact.
const children = await this.getThreadChildren(<Thread>threads[0]);
return children.concat(childSessions);
}
return Promise.resolve(threads.concat(childSessions));
} else {
return this.getThreadChildren(<Thread>element);
}
}
private getThreadChildren(thread: Thread): Promise<CallStackItem[]> {
return this.getThreadCallstack(thread).then(children => {
// Check if some stack frames should be hidden under a parent element since they are deemphasized
const result: CallStackItem[] = [];
children.forEach((child, index) => {
if (child instanceof StackFrame && child.source && isDeemphasized(child)) {
// Check if the user clicked to show the deemphasized source
if (this.deemphasizedStackFramesToShow.indexOf(child) === -1) {
if (result.length) {
const last = result[result.length - 1];
if (last instanceof Array) {
// Collect all the stackframes that will be "collapsed"
last.push(child);
return;
}
}
const nextChild = index < children.length - 1 ? children[index + 1] : undefined;
if (nextChild instanceof StackFrame && nextChild.source && isDeemphasized(nextChild)) {
// Start collecting stackframes that will be "collapsed"
result.push([child]);
return;
}
}
}
result.push(child);
});
return result;
});
}
private getThreadCallstack(thread: Thread): Promise<Array<IStackFrame | string | ThreadAndSessionIds>> {
let callStack: any[] = thread.getCallStack();
let callStackPromise: Promise<any> = Promise.resolve(null);
if (!callStack || !callStack.length) {
callStackPromise = thread.fetchCallStack().then(() => callStack = thread.getCallStack());
}
return callStackPromise.then(() => {
if (callStack.length === 1 && thread.session.capabilities.supportsDelayedStackTraceLoading && thread.stoppedDetails && thread.stoppedDetails.totalFrames && thread.stoppedDetails.totalFrames > 1) {
// To reduce flashing of the call stack view simply append the stale call stack
// once we have the correct data the tree will refresh and we will no longer display it.
callStack = callStack.concat(thread.getStaleCallStack().slice(1));
}
if (thread.stoppedDetails && thread.stoppedDetails.framesErrorMessage) {
callStack = callStack.concat([thread.stoppedDetails.framesErrorMessage]);
}
if (thread.stoppedDetails && thread.stoppedDetails.totalFrames && thread.stoppedDetails.totalFrames > callStack.length && callStack.length > 1) {
callStack = callStack.concat([new ThreadAndSessionIds(thread.session.getId(), thread.threadId)]);
}
return callStack;
});
}
}
class CallStackAccessibilityProvider implements IListAccessibilityProvider<CallStackItem> {
getWidgetAriaLabel(): string {
return nls.localize({ comment: ['Debug is a noun in this context, not a verb.'], key: 'callStackAriaLabel' }, "Debug Call Stack");
}
getAriaLabel(element: CallStackItem): string {
if (element instanceof Thread) {
return nls.localize('threadAriaLabel', "Thread {0}, callstack, debug", (<Thread>element).name);
}
if (element instanceof StackFrame) {
return nls.localize('stackFrameAriaLabel', "Stack Frame {0}, line {1}, {2}, callstack, debug", element.name, element.range.startLineNumber, getSpecificSourceName(element));
}
if (isDebugSession(element)) {
return nls.localize('sessionLabel', "Debug Session {0}", element.getLabel());
}
if (typeof element === 'string') {
return element;
}
if (element instanceof Array) {
return nls.localize('showMoreStackFrames', "Show {0} More Stack Frames", element.length);
}
// element instanceof ThreadAndSessionIds
return nls.localize('loadMoreStackFrames', "Load More Stack Frames");
}
}
function getActions(instantiationService: IInstantiationService, element: IDebugSession | IThread): IAction[] {
const getThreadActions = (thread: IThread): IAction[] => {
return [
thread.stopped ? instantiationService.createInstance(ContinueAction, thread) : instantiationService.createInstance(PauseAction, thread),
instantiationService.createInstance(StepOverAction, thread),
instantiationService.createInstance(StepIntoAction, thread),
instantiationService.createInstance(StepOutAction, thread)
];
};
if (element instanceof Thread) {
return getThreadActions(element);
}
const session = <IDebugSession>element;
const stopOrDisconectAction = isSessionAttach(session) ? instantiationService.createInstance(DisconnectAction, session) : instantiationService.createInstance(StopAction, session);
const restartAction = instantiationService.createInstance(RestartAction, session);
const threads = session.getAllThreads();
if (threads.length === 1) {
return getThreadActions(threads[0]).concat([
restartAction,
stopOrDisconectAction
]);
}
return [
restartAction,
stopOrDisconectAction
];
}
class StopAction extends Action {
constructor(
private readonly session: IDebugSession,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${STOP_ID}`, STOP_LABEL, 'debug-action codicon-debug-stop');
}
public run(): Promise<any> {
return this.commandService.executeCommand(STOP_ID, undefined, getContext(this.session));
}
}
class DisconnectAction extends Action {
constructor(
private readonly session: IDebugSession,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${DISCONNECT_ID}`, DISCONNECT_LABEL, 'debug-action codicon-debug-disconnect');
}
public run(): Promise<any> {
return this.commandService.executeCommand(DISCONNECT_ID, undefined, getContext(this.session));
}
}
class RestartAction extends Action {
constructor(
private readonly session: IDebugSession,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${RESTART_SESSION_ID}`, RESTART_LABEL, 'debug-action codicon-debug-restart');
}
public run(): Promise<any> {
return this.commandService.executeCommand(RESTART_SESSION_ID, undefined, getContext(this.session));
}
}
class StepOverAction extends Action {
constructor(
private readonly thread: IThread,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${STEP_OVER_ID}`, STEP_OVER_LABEL, 'debug-action codicon-debug-step-over', thread.stopped);
}
public run(): Promise<any> {
return this.commandService.executeCommand(STEP_OVER_ID, undefined, getContext(this.thread));
}
}
class StepIntoAction extends Action {
constructor(
private readonly thread: IThread,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${STEP_INTO_ID}`, STEP_INTO_LABEL, 'debug-action codicon-debug-step-into', thread.stopped);
}
public run(): Promise<any> {
return this.commandService.executeCommand(STEP_INTO_ID, undefined, getContext(this.thread));
}
}
class StepOutAction extends Action {
constructor(
private readonly thread: IThread,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${STEP_OUT_ID}`, STEP_OUT_LABEL, 'debug-action codicon-debug-step-out', thread.stopped);
}
public run(): Promise<any> {
return this.commandService.executeCommand(STEP_OUT_ID, undefined, getContext(this.thread));
}
}
class PauseAction extends Action {
constructor(
private readonly thread: IThread,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${PAUSE_ID}`, PAUSE_LABEL, 'debug-action codicon-debug-pause', !thread.stopped);
}
public run(): Promise<any> {
return this.commandService.executeCommand(PAUSE_ID, undefined, getContext(this.thread));
}
}
class ContinueAction extends Action {
constructor(
private readonly thread: IThread,
@ICommandService private readonly commandService: ICommandService
) {
super(`action.${CONTINUE_ID}`, CONTINUE_LABEL, 'debug-action codicon-debug-continue', thread.stopped);
}
public run(): Promise<any> {
return this.commandService.executeCommand(CONTINUE_ID, undefined, getContext(this.thread));
}
}
class CallStackCompressionDelegate implements ITreeCompressionDelegate<CallStackItem> {
constructor(private readonly debugService: IDebugService) { }
isIncompressible(stat: CallStackItem): boolean {
if (isDebugSession(stat)) {
if (stat.compact) {
return false;
}
const sessions = this.debugService.getModel().getSessions();
if (sessions.some(s => s.parentSession === stat && s.compact)) {
return false;
}
return true;
}
return true;
}
}