aboutsummaryrefslogtreecommitdiff
path: root/editors/code/src/commands/inlay_hints.ts
blob: 056d7c8e3bdee32eb2822634e2002f22fd394722 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
import * as vscode from 'vscode';
import {
    Range,
    TextDocumentChangeEvent,
    TextDocumentContentChangeEvent,
    TextEditor
} from 'vscode';
import { TextDocumentIdentifier } from 'vscode-languageclient';
import { Server } from '../server';

interface InlayHintsParams {
    textDocument: TextDocumentIdentifier;
}

interface InlayHint {
    range: Range;
    kind: string;
    label: string;
}

const typeHintDecorationType = vscode.window.createTextEditorDecorationType({
    after: {
        color: new vscode.ThemeColor('ralsp.inlayHint')
    }
});

export class HintsUpdater {
    private displayHints = true;

    public async loadHints(
        editor: vscode.TextEditor | undefined
    ): Promise<void> {
        if (this.displayHints && editor !== undefined) {
            await this.updateDecorationsFromServer(
                editor.document.uri.toString(),
                editor
            );
        }
    }

    public async toggleHintsDisplay(displayHints: boolean): Promise<void> {
        if (this.displayHints !== displayHints) {
            this.displayHints = displayHints;

            if (displayHints) {
                return this.updateHints();
            } else {
                const editor = vscode.window.activeTextEditor;
                if (editor != null) {
                    return editor.setDecorations(typeHintDecorationType, []);
                }
            }
        }
    }

    public async updateHints(cause?: TextDocumentChangeEvent): Promise<void> {
        if (!this.displayHints) {
            return;
        }
        const editor = vscode.window.activeTextEditor;
        if (editor == null) {
            return;
        }
        const document = cause == null ? editor.document : cause.document;
        if (document.languageId !== 'rust') {
            return;
        }

        // If the dbg! macro is used in the lsp-server, an endless stream of events with `cause.contentChanges` with the dbg messages.
        // Should not be a real situation, but better to filter such things out.
        if (
            cause !== undefined &&
            cause.contentChanges.filter(changeEvent =>
                this.isEventInFile(document.lineCount, changeEvent)
            ).length === 0
        ) {
            return;
        }
        return await this.updateDecorationsFromServer(
            document.uri.toString(),
            editor
        );
    }

    private isEventInFile(
        documentLineCount: number,
        event: TextDocumentContentChangeEvent
    ): boolean {
        const eventText = event.text;
        if (eventText.length === 0) {
            return (
                event.range.start.line <= documentLineCount ||
                event.range.end.line <= documentLineCount
            );
        } else {
            return (
                event.range.start.line <= documentLineCount &&
                event.range.end.line <= documentLineCount
            );
        }
    }

    private async updateDecorationsFromServer(
        documentUri: string,
        editor: TextEditor
    ): Promise<void> {
        const newHints = (await this.queryHints(documentUri)) || [];
        const newDecorations = newHints.map(hint => ({
            range: hint.range,
            renderOptions: { after: { contentText: `: ${hint.label}` } }
        }));
        return editor.setDecorations(typeHintDecorationType, newDecorations);
    }

    private async queryHints(documentUri: string): Promise<InlayHint[] | null> {
        const request: InlayHintsParams = {
            textDocument: { uri: documentUri }
        };
        const client = Server.client;
        return client
            .onReady()
            .then(() =>
                client.sendRequest<InlayHint[] | null>(
                    'rust-analyzer/inlayHints',
                    request
                )
            );
    }
}