mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-03-20 12:00:24 -04:00
bd7aac8ee0
* Merge from vscode a234f13c45b40a0929777cb440ee011b7549eed2 * update distro * fix layering * update distro * fix tests
354 lines
13 KiB
TypeScript
354 lines
13 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 'vs/css!./goToDefinitionAtPosition';
|
|
import * as nls from 'vs/nls';
|
|
import { createCancelablePromise, CancelablePromise } from 'vs/base/common/async';
|
|
import { CancellationToken } from 'vs/base/common/cancellation';
|
|
import { onUnexpectedError } from 'vs/base/common/errors';
|
|
import { MarkdownString } from 'vs/base/common/htmlContent';
|
|
import { IModeService } from 'vs/editor/common/services/modeService';
|
|
import { Range, IRange } from 'vs/editor/common/core/range';
|
|
import { IEditorContribution } from 'vs/editor/common/editorCommon';
|
|
import { DefinitionProviderRegistry, LocationLink } from 'vs/editor/common/modes';
|
|
import { ICodeEditor, MouseTargetType } from 'vs/editor/browser/editorBrowser';
|
|
import { registerEditorContribution } from 'vs/editor/browser/editorExtensions';
|
|
import { getDefinitionsAtPosition } from '../goToSymbol';
|
|
import { DisposableStore } from 'vs/base/common/lifecycle';
|
|
import { ITextModelService } from 'vs/editor/common/services/resolverService';
|
|
import { registerThemingParticipant } from 'vs/platform/theme/common/themeService';
|
|
import { editorActiveLinkForeground } from 'vs/platform/theme/common/colorRegistry';
|
|
import { EditorState, CodeEditorStateFlag } from 'vs/editor/browser/core/editorState';
|
|
import { DefinitionAction } from '../goToCommands';
|
|
import { ClickLinkGesture, ClickLinkMouseEvent, ClickLinkKeyboardEvent } from 'vs/editor/contrib/gotoSymbol/link/clickLinkGesture';
|
|
import { IWordAtPosition, IModelDeltaDecoration, ITextModel, IFoundBracket } from 'vs/editor/common/model';
|
|
import { Position } from 'vs/editor/common/core/position';
|
|
import { withNullAsUndefined } from 'vs/base/common/types';
|
|
import { IKeyboardEvent } from 'vs/base/browser/keyboardEvent';
|
|
|
|
export class GotoDefinitionAtPositionEditorContribution implements IEditorContribution {
|
|
|
|
public static readonly ID = 'editor.contrib.gotodefinitionatposition';
|
|
static readonly MAX_SOURCE_PREVIEW_LINES = 8;
|
|
|
|
private readonly editor: ICodeEditor;
|
|
private readonly toUnhook = new DisposableStore();
|
|
private readonly toUnhookForKeyboard = new DisposableStore();
|
|
private linkDecorations: string[] = [];
|
|
private currentWordAtPosition: IWordAtPosition | null = null;
|
|
private previousPromise: CancelablePromise<LocationLink[] | null> | null = null;
|
|
|
|
constructor(
|
|
editor: ICodeEditor,
|
|
@ITextModelService private readonly textModelResolverService: ITextModelService,
|
|
@IModeService private readonly modeService: IModeService
|
|
) {
|
|
this.editor = editor;
|
|
|
|
let linkGesture = new ClickLinkGesture(editor);
|
|
this.toUnhook.add(linkGesture);
|
|
|
|
this.toUnhook.add(linkGesture.onMouseMoveOrRelevantKeyDown(([mouseEvent, keyboardEvent]) => {
|
|
this.startFindDefinitionFromMouse(mouseEvent, withNullAsUndefined(keyboardEvent));
|
|
}));
|
|
|
|
this.toUnhook.add(linkGesture.onExecute((mouseEvent: ClickLinkMouseEvent) => {
|
|
if (this.isEnabled(mouseEvent)) {
|
|
this.gotoDefinition(mouseEvent.target.position!, mouseEvent.hasSideBySideModifier).then(() => {
|
|
this.removeLinkDecorations();
|
|
}, (error: Error) => {
|
|
this.removeLinkDecorations();
|
|
onUnexpectedError(error);
|
|
});
|
|
}
|
|
}));
|
|
|
|
this.toUnhook.add(linkGesture.onCancel(() => {
|
|
this.removeLinkDecorations();
|
|
this.currentWordAtPosition = null;
|
|
}));
|
|
}
|
|
|
|
static get(editor: ICodeEditor): GotoDefinitionAtPositionEditorContribution {
|
|
return editor.getContribution<GotoDefinitionAtPositionEditorContribution>(GotoDefinitionAtPositionEditorContribution.ID);
|
|
}
|
|
|
|
startFindDefinitionFromCursor(position: Position) {
|
|
// For issue: https://github.com/microsoft/vscode/issues/46257
|
|
// equivalent to mouse move with meta/ctrl key
|
|
|
|
// First find the definition and add decorations
|
|
// to the editor to be shown with the content hover widget
|
|
return this.startFindDefinition(position).then(() => {
|
|
|
|
// Add listeners for editor cursor move and key down events
|
|
// Dismiss the "extended" editor decorations when the user hides
|
|
// the hover widget. There is no event for the widget itself so these
|
|
// serve as a best effort. After removing the link decorations, the hover
|
|
// widget is clean and will only show declarations per next request.
|
|
this.toUnhookForKeyboard.add(this.editor.onDidChangeCursorPosition(() => {
|
|
this.currentWordAtPosition = null;
|
|
this.removeLinkDecorations();
|
|
this.toUnhookForKeyboard.clear();
|
|
}));
|
|
|
|
this.toUnhookForKeyboard.add(this.editor.onKeyDown((e: IKeyboardEvent) => {
|
|
if (e) {
|
|
this.currentWordAtPosition = null;
|
|
this.removeLinkDecorations();
|
|
this.toUnhookForKeyboard.clear();
|
|
}
|
|
}));
|
|
});
|
|
}
|
|
|
|
private startFindDefinitionFromMouse(mouseEvent: ClickLinkMouseEvent, withKey?: ClickLinkKeyboardEvent): void {
|
|
|
|
// check if we are active and on a content widget
|
|
if (mouseEvent.target.type === MouseTargetType.CONTENT_WIDGET && this.linkDecorations.length > 0) {
|
|
return;
|
|
}
|
|
|
|
if (!this.editor.hasModel() || !this.isEnabled(mouseEvent, withKey)) {
|
|
this.currentWordAtPosition = null;
|
|
this.removeLinkDecorations();
|
|
return;
|
|
}
|
|
|
|
const position = mouseEvent.target.position!;
|
|
|
|
this.startFindDefinition(position);
|
|
}
|
|
|
|
private startFindDefinition(position: Position): Promise<number | undefined> {
|
|
|
|
// Dispose listeners for updating decorations when using keyboard to show definition hover
|
|
this.toUnhookForKeyboard.clear();
|
|
|
|
// Find word at mouse position
|
|
const word = position ? this.editor.getModel()?.getWordAtPosition(position) : null;
|
|
if (!word) {
|
|
this.currentWordAtPosition = null;
|
|
this.removeLinkDecorations();
|
|
return Promise.resolve(0);
|
|
}
|
|
|
|
// Return early if word at position is still the same
|
|
if (this.currentWordAtPosition && this.currentWordAtPosition.startColumn === word.startColumn && this.currentWordAtPosition.endColumn === word.endColumn && this.currentWordAtPosition.word === word.word) {
|
|
return Promise.resolve(0);
|
|
}
|
|
|
|
this.currentWordAtPosition = word;
|
|
|
|
// Find definition and decorate word if found
|
|
let state = new EditorState(this.editor, CodeEditorStateFlag.Position | CodeEditorStateFlag.Value | CodeEditorStateFlag.Selection | CodeEditorStateFlag.Scroll);
|
|
|
|
if (this.previousPromise) {
|
|
this.previousPromise.cancel();
|
|
this.previousPromise = null;
|
|
}
|
|
|
|
this.previousPromise = createCancelablePromise(token => this.findDefinition(position, token));
|
|
|
|
return this.previousPromise.then(results => {
|
|
if (!results || !results.length || !state.validate(this.editor)) {
|
|
this.removeLinkDecorations();
|
|
return;
|
|
}
|
|
|
|
// Multiple results
|
|
if (results.length > 1) {
|
|
this.addDecoration(
|
|
new Range(position.lineNumber, word.startColumn, position.lineNumber, word.endColumn),
|
|
new MarkdownString().appendText(nls.localize('multipleResults', "Click to show {0} definitions.", results.length))
|
|
);
|
|
}
|
|
|
|
// Single result
|
|
else {
|
|
let result = results[0];
|
|
|
|
if (!result.uri) {
|
|
return;
|
|
}
|
|
|
|
this.textModelResolverService.createModelReference(result.uri).then(ref => {
|
|
|
|
if (!ref.object || !ref.object.textEditorModel) {
|
|
ref.dispose();
|
|
return;
|
|
}
|
|
|
|
const { object: { textEditorModel } } = ref;
|
|
const { startLineNumber } = result.range;
|
|
|
|
if (startLineNumber < 1 || startLineNumber > textEditorModel.getLineCount()) {
|
|
// invalid range
|
|
ref.dispose();
|
|
return;
|
|
}
|
|
|
|
const previewValue = this.getPreviewValue(textEditorModel, startLineNumber, result);
|
|
|
|
let wordRange: Range;
|
|
if (result.originSelectionRange) {
|
|
wordRange = Range.lift(result.originSelectionRange);
|
|
} else {
|
|
wordRange = new Range(position.lineNumber, word.startColumn, position.lineNumber, word.endColumn);
|
|
}
|
|
|
|
const modeId = this.modeService.getModeIdByFilepathOrFirstLine(textEditorModel.uri);
|
|
this.addDecoration(
|
|
wordRange,
|
|
new MarkdownString().appendCodeblock(modeId ? modeId : '', previewValue)
|
|
);
|
|
ref.dispose();
|
|
});
|
|
}
|
|
}).then(undefined, onUnexpectedError);
|
|
}
|
|
|
|
private getPreviewValue(textEditorModel: ITextModel, startLineNumber: number, result: LocationLink) {
|
|
let rangeToUse = result.targetSelectionRange ? result.range : this.getPreviewRangeBasedOnBrackets(textEditorModel, startLineNumber);
|
|
const numberOfLinesInRange = rangeToUse.endLineNumber - rangeToUse.startLineNumber;
|
|
if (numberOfLinesInRange >= GotoDefinitionAtPositionEditorContribution.MAX_SOURCE_PREVIEW_LINES) {
|
|
rangeToUse = this.getPreviewRangeBasedOnIndentation(textEditorModel, startLineNumber);
|
|
}
|
|
|
|
const previewValue = this.stripIndentationFromPreviewRange(textEditorModel, startLineNumber, rangeToUse);
|
|
return previewValue;
|
|
}
|
|
|
|
private stripIndentationFromPreviewRange(textEditorModel: ITextModel, startLineNumber: number, previewRange: IRange) {
|
|
const startIndent = textEditorModel.getLineFirstNonWhitespaceColumn(startLineNumber);
|
|
let minIndent = startIndent;
|
|
|
|
for (let endLineNumber = startLineNumber + 1; endLineNumber < previewRange.endLineNumber; endLineNumber++) {
|
|
const endIndent = textEditorModel.getLineFirstNonWhitespaceColumn(endLineNumber);
|
|
minIndent = Math.min(minIndent, endIndent);
|
|
}
|
|
|
|
const previewValue = textEditorModel.getValueInRange(previewRange).replace(new RegExp(`^\\s{${minIndent - 1}}`, 'gm'), '').trim();
|
|
return previewValue;
|
|
}
|
|
|
|
private getPreviewRangeBasedOnIndentation(textEditorModel: ITextModel, startLineNumber: number) {
|
|
const startIndent = textEditorModel.getLineFirstNonWhitespaceColumn(startLineNumber);
|
|
const maxLineNumber = Math.min(textEditorModel.getLineCount(), startLineNumber + GotoDefinitionAtPositionEditorContribution.MAX_SOURCE_PREVIEW_LINES);
|
|
let endLineNumber = startLineNumber + 1;
|
|
|
|
for (; endLineNumber < maxLineNumber; endLineNumber++) {
|
|
let endIndent = textEditorModel.getLineFirstNonWhitespaceColumn(endLineNumber);
|
|
|
|
if (startIndent === endIndent) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
return new Range(startLineNumber, 1, endLineNumber + 1, 1);
|
|
}
|
|
|
|
private getPreviewRangeBasedOnBrackets(textEditorModel: ITextModel, startLineNumber: number) {
|
|
const maxLineNumber = Math.min(textEditorModel.getLineCount(), startLineNumber + GotoDefinitionAtPositionEditorContribution.MAX_SOURCE_PREVIEW_LINES);
|
|
|
|
const brackets: IFoundBracket[] = [];
|
|
|
|
let ignoreFirstEmpty = true;
|
|
let currentBracket = textEditorModel.findNextBracket(new Position(startLineNumber, 1));
|
|
while (currentBracket !== null) {
|
|
|
|
if (brackets.length === 0) {
|
|
brackets.push(currentBracket);
|
|
} else {
|
|
const lastBracket = brackets[brackets.length - 1];
|
|
if (lastBracket.open[0] === currentBracket.open[0] && lastBracket.isOpen && !currentBracket.isOpen) {
|
|
brackets.pop();
|
|
} else {
|
|
brackets.push(currentBracket);
|
|
}
|
|
|
|
if (brackets.length === 0) {
|
|
if (ignoreFirstEmpty) {
|
|
ignoreFirstEmpty = false;
|
|
} else {
|
|
return new Range(startLineNumber, 1, currentBracket.range.endLineNumber + 1, 1);
|
|
}
|
|
}
|
|
}
|
|
|
|
const maxColumn = textEditorModel.getLineMaxColumn(startLineNumber);
|
|
let nextLineNumber = currentBracket.range.endLineNumber;
|
|
let nextColumn = currentBracket.range.endColumn;
|
|
if (maxColumn === currentBracket.range.endColumn) {
|
|
nextLineNumber++;
|
|
nextColumn = 1;
|
|
}
|
|
|
|
if (nextLineNumber > maxLineNumber) {
|
|
return new Range(startLineNumber, 1, maxLineNumber + 1, 1);
|
|
}
|
|
|
|
currentBracket = textEditorModel.findNextBracket(new Position(nextLineNumber, nextColumn));
|
|
}
|
|
|
|
return new Range(startLineNumber, 1, maxLineNumber + 1, 1);
|
|
}
|
|
|
|
private addDecoration(range: Range, hoverMessage: MarkdownString): void {
|
|
|
|
const newDecorations: IModelDeltaDecoration = {
|
|
range: range,
|
|
options: {
|
|
inlineClassName: 'goto-definition-link',
|
|
hoverMessage
|
|
}
|
|
};
|
|
|
|
this.linkDecorations = this.editor.deltaDecorations(this.linkDecorations, [newDecorations]);
|
|
}
|
|
|
|
private removeLinkDecorations(): void {
|
|
if (this.linkDecorations.length > 0) {
|
|
this.linkDecorations = this.editor.deltaDecorations(this.linkDecorations, []);
|
|
}
|
|
}
|
|
|
|
private isEnabled(mouseEvent: ClickLinkMouseEvent, withKey?: ClickLinkKeyboardEvent): boolean {
|
|
return this.editor.hasModel() &&
|
|
mouseEvent.isNoneOrSingleMouseDown &&
|
|
(mouseEvent.target.type === MouseTargetType.CONTENT_TEXT) &&
|
|
(mouseEvent.hasTriggerModifier || (withKey ? withKey.keyCodeIsTriggerKey : false)) &&
|
|
DefinitionProviderRegistry.has(this.editor.getModel());
|
|
}
|
|
|
|
private findDefinition(position: Position, token: CancellationToken): Promise<LocationLink[] | null> {
|
|
const model = this.editor.getModel();
|
|
if (!model) {
|
|
return Promise.resolve(null);
|
|
}
|
|
|
|
return getDefinitionsAtPosition(model, position, token);
|
|
}
|
|
|
|
private gotoDefinition(position: Position, openToSide: boolean): Promise<any> {
|
|
this.editor.setPosition(position);
|
|
const action = new DefinitionAction({ openToSide, openInPeek: false, muteMessage: true }, { alias: '', label: '', id: '', precondition: undefined });
|
|
return this.editor.invokeWithinContext(accessor => action.run(accessor, this.editor));
|
|
}
|
|
|
|
public dispose(): void {
|
|
this.toUnhook.dispose();
|
|
}
|
|
}
|
|
|
|
registerEditorContribution(GotoDefinitionAtPositionEditorContribution.ID, GotoDefinitionAtPositionEditorContribution);
|
|
|
|
registerThemingParticipant((theme, collector) => {
|
|
const activeLinkForeground = theme.getColor(editorActiveLinkForeground);
|
|
if (activeLinkForeground) {
|
|
collector.addRule(`.monaco-editor .goto-definition-link { color: ${activeLinkForeground} !important; }`);
|
|
}
|
|
});
|