/*--------------------------------------------------------------------------------------------- * 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 { KeyCode, KeyMod } from 'vs/base/common/keyCodes'; import { List } from 'vs/base/browser/ui/list/listWidget'; import { KeybindingsRegistry, KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry'; import { IListService } from 'vs/platform/list/browser/listService'; import { IWorkspaceContextService, WorkbenchState } from 'vs/platform/workspace/common/workspace'; import { IDebugService, IEnablement, CONTEXT_BREAKPOINTS_FOCUSED, CONTEXT_WATCH_EXPRESSIONS_FOCUSED, CONTEXT_VARIABLES_FOCUSED, EDITOR_CONTRIBUTION_ID, IDebugEditorContribution, CONTEXT_IN_DEBUG_MODE, CONTEXT_EXPRESSION_SELECTED, CONTEXT_BREAKPOINT_SELECTED, IConfig, IStackFrame, IThread, IDebugSession, CONTEXT_DEBUG_STATE, REPL_ID, IDebugConfiguration, CONTEXT_JUMP_TO_CURSOR_SUPPORTED } from 'vs/workbench/contrib/debug/common/debug'; import { Expression, Variable, Breakpoint, FunctionBreakpoint, Thread } from 'vs/workbench/contrib/debug/common/debugModel'; import { IExtensionsViewlet, VIEWLET_ID as EXTENSIONS_VIEWLET_ID } from 'vs/workbench/contrib/extensions/common/extensions'; import { IViewletService } from 'vs/workbench/services/viewlet/browser/viewlet'; import { ICodeEditor, isCodeEditor } from 'vs/editor/browser/editorBrowser'; import { MenuRegistry, MenuId } from 'vs/platform/actions/common/actions'; import { IEditorService } from 'vs/workbench/services/editor/common/editorService'; import { EditorContextKeys } from 'vs/editor/common/editorContextKeys'; import { ContextKeyExpr } from 'vs/platform/contextkey/common/contextkey'; import { openBreakpointSource } from 'vs/workbench/contrib/debug/browser/breakpointsView'; import { INotificationService } from 'vs/platform/notification/common/notification'; import { InputFocusedContext } from 'vs/platform/contextkey/common/contextkeys'; import { ServicesAccessor } from 'vs/editor/browser/editorExtensions'; import { PanelFocusContext } from 'vs/workbench/common/panel'; import { CommandsRegistry } from 'vs/platform/commands/common/commands'; import { onUnexpectedError } from 'vs/base/common/errors'; import { ITextResourcePropertiesService } from 'vs/editor/common/services/resourceConfiguration'; import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService'; import { IHistoryService } from 'vs/workbench/services/history/common/history'; import { startDebugging } from 'vs/workbench/contrib/debug/common/debugUtils'; import { IPanelService } from 'vs/workbench/services/panel/common/panelService'; import { IConfigurationService } from 'vs/platform/configuration/common/configuration'; import { IQuickInputService } from 'vs/platform/quickinput/common/quickInput'; export const ADD_CONFIGURATION_ID = 'debug.addConfiguration'; export const TOGGLE_INLINE_BREAKPOINT_ID = 'editor.debug.action.toggleInlineBreakpoint'; export const COPY_STACK_TRACE_ID = 'debug.copyStackTrace'; export const REVERSE_CONTINUE_ID = 'workbench.action.debug.reverseContinue'; export const STEP_BACK_ID = 'workbench.action.debug.stepBack'; export const RESTART_SESSION_ID = 'workbench.action.debug.restart'; export const TERMINATE_THREAD_ID = 'workbench.action.debug.terminateThread'; export const STEP_OVER_ID = 'workbench.action.debug.stepOver'; export const STEP_INTO_ID = 'workbench.action.debug.stepInto'; export const STEP_OUT_ID = 'workbench.action.debug.stepOut'; export const PAUSE_ID = 'workbench.action.debug.pause'; export const DISCONNECT_ID = 'workbench.action.debug.disconnect'; export const STOP_ID = 'workbench.action.debug.stop'; export const RESTART_FRAME_ID = 'workbench.action.debug.restartFrame'; export const CONTINUE_ID = 'workbench.action.debug.continue'; export const FOCUS_REPL_ID = 'workbench.debug.action.focusRepl'; export const JUMP_TO_CURSOR_ID = 'debug.jumpToCursor'; function getThreadAndRun(accessor: ServicesAccessor, thread: IThread | undefined, run: (thread: IThread) => Promise, ): void { const debugService = accessor.get(IDebugService); if (!(thread instanceof Thread)) { thread = debugService.getViewModel().focusedThread; if (!thread) { const focusedSession = debugService.getViewModel().focusedSession; const threads = focusedSession ? focusedSession.getAllThreads() : undefined; thread = threads && threads.length ? threads[0] : undefined; } } if (thread) { run(thread).then(undefined, onUnexpectedError); } } export function registerCommands(): void { CommandsRegistry.registerCommand({ id: COPY_STACK_TRACE_ID, handler: async (accessor: ServicesAccessor, _: string, frame: IStackFrame) => { const textResourcePropertiesService = accessor.get(ITextResourcePropertiesService); const clipboardService = accessor.get(IClipboardService); const eol = textResourcePropertiesService.getEOL(frame.source.uri); await clipboardService.writeText(frame.thread.getCallStack().map(sf => sf.toString()).join(eol)); } }); CommandsRegistry.registerCommand({ id: REVERSE_CONTINUE_ID, handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { getThreadAndRun(accessor, thread, thread => thread.reverseContinue()); } }); CommandsRegistry.registerCommand({ id: STEP_BACK_ID, handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { getThreadAndRun(accessor, thread, thread => thread.stepBack()); } }); CommandsRegistry.registerCommand({ id: TERMINATE_THREAD_ID, handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { getThreadAndRun(accessor, thread, thread => thread.terminate()); } }); CommandsRegistry.registerCommand({ id: JUMP_TO_CURSOR_ID, handler: async (accessor: ServicesAccessor) => { const debugService = accessor.get(IDebugService); const stackFrame = debugService.getViewModel().focusedStackFrame; const editorService = accessor.get(IEditorService); const activeEditor = editorService.activeTextEditorWidget; const notificationService = accessor.get(INotificationService); const quickInputService = accessor.get(IQuickInputService); if (stackFrame && isCodeEditor(activeEditor) && activeEditor.hasModel()) { const position = activeEditor.getPosition(); const resource = activeEditor.getModel().uri; const source = stackFrame.thread.session.getSourceForUri(resource); if (source) { const response = await stackFrame.thread.session.gotoTargets(source.raw, position.lineNumber, position.column); const targets = response.body.targets; if (targets.length) { let id = targets[0].id; if (targets.length > 1) { const picks = targets.map(t => ({ label: t.label, _id: t.id })); const pick = await quickInputService.pick(picks, { placeHolder: nls.localize('chooseLocation', "Choose the specific location") }); if (!pick) { return; } id = pick._id; } return await stackFrame.thread.session.goto(stackFrame.thread.threadId, id).catch(e => notificationService.warn(e)); } } } return notificationService.warn(nls.localize('noExecutableCode', "No executable code is associated at the current cursor position.")); } }); MenuRegistry.appendMenuItem(MenuId.EditorContext, { command: { id: JUMP_TO_CURSOR_ID, title: nls.localize('jumpToCursor', "Jump to Cursor"), category: { value: nls.localize('debug', "Debug"), original: 'Debug' } }, when: ContextKeyExpr.and(CONTEXT_JUMP_TO_CURSOR_SUPPORTED, EditorContextKeys.editorTextFocus), group: 'debug', order: 3 }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: RESTART_SESSION_ID, weight: KeybindingWeight.WorkbenchContrib, primary: KeyMod.Shift | KeyMod.CtrlCmd | KeyCode.F5, when: CONTEXT_IN_DEBUG_MODE, handler: (accessor: ServicesAccessor, _: string, session: IDebugSession | undefined) => { const debugService = accessor.get(IDebugService); if (!session || !session.getId) { session = debugService.getViewModel().focusedSession; } if (!session) { const historyService = accessor.get(IHistoryService); startDebugging(debugService, historyService, false); } else { session.removeReplExpressions(); debugService.restartSession(session).then(undefined, onUnexpectedError); } } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: STEP_OVER_ID, weight: KeybindingWeight.WorkbenchContrib, primary: KeyCode.F10, when: CONTEXT_DEBUG_STATE.isEqualTo('stopped'), handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { getThreadAndRun(accessor, thread, thread => thread.next()); } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: STEP_INTO_ID, weight: KeybindingWeight.WorkbenchContrib + 10, // Have a stronger weight to have priority over full screen when debugging primary: KeyCode.F11, when: CONTEXT_IN_DEBUG_MODE, handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { getThreadAndRun(accessor, thread, thread => thread.stepIn()); } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: STEP_OUT_ID, weight: KeybindingWeight.WorkbenchContrib, primary: KeyMod.Shift | KeyCode.F11, when: CONTEXT_DEBUG_STATE.isEqualTo('stopped'), handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { getThreadAndRun(accessor, thread, thread => thread.stepOut()); } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: PAUSE_ID, weight: KeybindingWeight.WorkbenchContrib, primary: KeyCode.F6, when: CONTEXT_DEBUG_STATE.isEqualTo('running'), handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { const debugService = accessor.get(IDebugService); if (!(thread instanceof Thread)) { thread = debugService.getViewModel().focusedThread; if (!thread) { const session = debugService.getViewModel().focusedSession; const threads = session && session.getAllThreads(); thread = threads && threads.length ? threads[0] : undefined; } } if (thread) { thread.pause().then(undefined, onUnexpectedError); } } }); CommandsRegistry.registerCommand({ id: DISCONNECT_ID, handler: (accessor: ServicesAccessor) => { const debugService = accessor.get(IDebugService); const session = debugService.getViewModel().focusedSession; debugService.stopSession(session).then(undefined, onUnexpectedError); } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: STOP_ID, weight: KeybindingWeight.WorkbenchContrib, primary: KeyMod.Shift | KeyCode.F5, when: CONTEXT_IN_DEBUG_MODE, handler: (accessor: ServicesAccessor, _: string, session: IDebugSession | undefined) => { const debugService = accessor.get(IDebugService); if (!session || !session.getId) { session = debugService.getViewModel().focusedSession; const configurationService = accessor.get(IConfigurationService); const showSubSessions = configurationService.getValue('debug').showSubSessionsInToolBar; // Stop should be sent to the root parent session while (!showSubSessions && session && session.parentSession) { session = session.parentSession; } } debugService.stopSession(session).then(undefined, onUnexpectedError); } }); CommandsRegistry.registerCommand({ id: RESTART_FRAME_ID, handler: (accessor: ServicesAccessor, _: string, frame: IStackFrame | undefined) => { const debugService = accessor.get(IDebugService); if (!frame) { frame = debugService.getViewModel().focusedStackFrame; } return frame!.restart(); } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: CONTINUE_ID, weight: KeybindingWeight.WorkbenchContrib, primary: KeyCode.F5, when: CONTEXT_IN_DEBUG_MODE, handler: (accessor: ServicesAccessor, _: string, thread: IThread | undefined) => { getThreadAndRun(accessor, thread, thread => thread.continue()); } }); CommandsRegistry.registerCommand({ id: FOCUS_REPL_ID, handler: (accessor) => { const panelService = accessor.get(IPanelService); panelService.openPanel(REPL_ID, true); } }); CommandsRegistry.registerCommand({ id: 'debug.startFromConfig', handler: (accessor, config: IConfig) => { const debugService = accessor.get(IDebugService); debugService.startDebugging(undefined, config).then(undefined, onUnexpectedError); } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.toggleBreakpoint', weight: KeybindingWeight.WorkbenchContrib + 5, when: ContextKeyExpr.and(CONTEXT_BREAKPOINTS_FOCUSED, InputFocusedContext.toNegated()), primary: KeyCode.Space, handler: (accessor) => { const listService = accessor.get(IListService); const debugService = accessor.get(IDebugService); const list = listService.lastFocusedList; if (list instanceof List) { const focused = list.getFocusedElements(); if (focused && focused.length) { debugService.enableOrDisableBreakpoints(!focused[0].enabled, focused[0]); } } } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.enableOrDisableBreakpoint', weight: KeybindingWeight.WorkbenchContrib, primary: undefined, when: EditorContextKeys.editorTextFocus, handler: (accessor) => { const debugService = accessor.get(IDebugService); const editorService = accessor.get(IEditorService); const widget = editorService.activeTextEditorWidget; if (isCodeEditor(widget)) { const model = widget.getModel(); if (model) { const position = widget.getPosition(); if (position) { const bps = debugService.getModel().getBreakpoints({ uri: model.uri, lineNumber: position.lineNumber }); if (bps.length) { debugService.enableOrDisableBreakpoints(!bps[0].enabled, bps[0]); } } } } } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.renameWatchExpression', weight: KeybindingWeight.WorkbenchContrib + 5, when: CONTEXT_WATCH_EXPRESSIONS_FOCUSED, primary: KeyCode.F2, mac: { primary: KeyCode.Enter }, handler: (accessor) => { const listService = accessor.get(IListService); const debugService = accessor.get(IDebugService); const focused = listService.lastFocusedList; if (focused) { const elements = focused.getFocus(); if (Array.isArray(elements) && elements[0] instanceof Expression) { debugService.getViewModel().setSelectedExpression(elements[0]); } } } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.setVariable', weight: KeybindingWeight.WorkbenchContrib + 5, when: CONTEXT_VARIABLES_FOCUSED, primary: KeyCode.F2, mac: { primary: KeyCode.Enter }, handler: (accessor) => { const listService = accessor.get(IListService); const debugService = accessor.get(IDebugService); const focused = listService.lastFocusedList; if (focused) { const elements = focused.getFocus(); if (Array.isArray(elements) && elements[0] instanceof Variable) { debugService.getViewModel().setSelectedExpression(elements[0]); } } } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.removeWatchExpression', weight: KeybindingWeight.WorkbenchContrib, when: ContextKeyExpr.and(CONTEXT_WATCH_EXPRESSIONS_FOCUSED, CONTEXT_EXPRESSION_SELECTED.toNegated()), primary: KeyCode.Delete, mac: { primary: KeyMod.CtrlCmd | KeyCode.Backspace }, handler: (accessor) => { const listService = accessor.get(IListService); const debugService = accessor.get(IDebugService); const focused = listService.lastFocusedList; if (focused) { const elements = focused.getFocus(); if (Array.isArray(elements) && elements[0] instanceof Expression) { debugService.removeWatchExpressions(elements[0].getId()); } } } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.removeBreakpoint', weight: KeybindingWeight.WorkbenchContrib, when: ContextKeyExpr.and(CONTEXT_BREAKPOINTS_FOCUSED, CONTEXT_BREAKPOINT_SELECTED.toNegated()), primary: KeyCode.Delete, mac: { primary: KeyMod.CtrlCmd | KeyCode.Backspace }, handler: (accessor) => { const listService = accessor.get(IListService); const debugService = accessor.get(IDebugService); const list = listService.lastFocusedList; if (list instanceof List) { const focused = list.getFocusedElements(); const element = focused.length ? focused[0] : undefined; if (element instanceof Breakpoint) { debugService.removeBreakpoints(element.getId()); } else if (element instanceof FunctionBreakpoint) { debugService.removeFunctionBreakpoints(element.getId()); } } } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.installAdditionalDebuggers', weight: KeybindingWeight.WorkbenchContrib, when: undefined, primary: undefined, handler: (accessor) => { const viewletService = accessor.get(IViewletService); return viewletService.openViewlet(EXTENSIONS_VIEWLET_ID, true) .then(viewlet => viewlet as IExtensionsViewlet) .then(viewlet => { viewlet.search('tag:debuggers @sort:installs'); viewlet.focus(); }); } }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: ADD_CONFIGURATION_ID, weight: KeybindingWeight.WorkbenchContrib, when: undefined, primary: undefined, handler: (accessor, launchUri: string) => { const manager = accessor.get(IDebugService).getConfigurationManager(); if (accessor.get(IWorkspaceContextService).getWorkbenchState() === WorkbenchState.EMPTY) { accessor.get(INotificationService).info(nls.localize('noFolderDebugConfig', "Please first open a folder in order to do advanced debug configuration.")); return undefined; } const launch = manager.getLaunches().filter(l => l.uri.toString() === launchUri).pop() || manager.selectedConfiguration.launch; return launch!.openConfigFile(false, false).then(({ editor, created }) => { if (editor && !created) { const codeEditor = editor.getControl(); if (codeEditor) { return codeEditor.getContribution(EDITOR_CONTRIBUTION_ID).addLaunchConfiguration(); } } return undefined; }); } }); const inlineBreakpointHandler = (accessor: ServicesAccessor) => { const debugService = accessor.get(IDebugService); const editorService = accessor.get(IEditorService); const widget = editorService.activeTextEditorWidget; if (isCodeEditor(widget)) { const position = widget.getPosition(); if (position && widget.hasModel() && debugService.getConfigurationManager().canSetBreakpointsIn(widget.getModel())) { const modelUri = widget.getModel().uri; const breakpointAlreadySet = debugService.getModel().getBreakpoints({ lineNumber: position.lineNumber, uri: modelUri }) .some(bp => (bp.sessionAgnosticData.column === position.column || (!bp.column && position.column <= 1))); if (!breakpointAlreadySet) { debugService.addBreakpoints(modelUri, [{ lineNumber: position.lineNumber, column: position.column > 1 ? position.column : undefined }], 'debugCommands.inlineBreakpointCommand'); } } } }; KeybindingsRegistry.registerCommandAndKeybindingRule({ weight: KeybindingWeight.WorkbenchContrib, primary: KeyMod.Shift | KeyCode.F9, when: EditorContextKeys.editorTextFocus, id: TOGGLE_INLINE_BREAKPOINT_ID, handler: inlineBreakpointHandler }); MenuRegistry.appendMenuItem(MenuId.EditorContext, { command: { id: TOGGLE_INLINE_BREAKPOINT_ID, title: nls.localize('addInlineBreakpoint', "Add Inline Breakpoint"), category: { value: nls.localize('debug', "Debug"), original: 'Debug' } }, when: ContextKeyExpr.and(CONTEXT_IN_DEBUG_MODE, PanelFocusContext.toNegated(), EditorContextKeys.editorTextFocus), group: 'debug', order: 1 }); KeybindingsRegistry.registerCommandAndKeybindingRule({ id: 'debug.openBreakpointToSide', weight: KeybindingWeight.WorkbenchContrib, when: CONTEXT_BREAKPOINTS_FOCUSED, primary: KeyMod.CtrlCmd | KeyCode.Enter, secondary: [KeyMod.Alt | KeyCode.Enter], handler: (accessor) => { const listService = accessor.get(IListService); const list = listService.lastFocusedList; if (list instanceof List) { const focus = list.getFocusedElements(); if (focus.length && focus[0] instanceof Breakpoint) { return openBreakpointSource(focus[0], true, false, accessor.get(IDebugService), accessor.get(IEditorService)); } } return undefined; } }); }