aboutsummaryrefslogtreecommitdiff
path: root/editors/code/src/commands/inlay_hints.ts
blob: 3157c04c8b27bca1770af163bed4de4bc7da3dc5 (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
130
131
132
133
134
135
import * as vscode from 'vscode';
import { Range, TextDocumentChangeEvent, 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 maxHintLength = 20;

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

export class HintsUpdater {
    private displayHints = true;

    public async toggleHintsDisplay(displayHints: boolean): Promise<void> {
        if (this.displayHints !== displayHints) {
            this.displayHints = displayHints;
            return this.refreshVisibleEditorsHints(
                displayHints ? undefined : []
            );
        }
    }

    public async refreshHintsForVisibleEditors(
        cause?: TextDocumentChangeEvent
    ): Promise<void> {
        if (!this.displayHints) {
            return;
        }
        if (
            cause !== undefined &&
            (cause.contentChanges.length === 0 ||
                !this.isRustDocument(cause.document))
        ) {
            return;
        }
        return this.refreshVisibleEditorsHints();
    }

    private async refreshVisibleEditorsHints(
        newDecorations?: vscode.DecorationOptions[]
    ) {
        const promises: Array<Promise<void>> = [];

        for (const rustEditor of vscode.window.visibleTextEditors.filter(
            editor => this.isRustDocument(editor.document)
        )) {
            if (newDecorations !== undefined) {
                promises.push(
                    Promise.resolve(
                        rustEditor.setDecorations(
                            typeHintDecorationType,
                            newDecorations
                        )
                    )
                );
            } else {
                promises.push(this.updateDecorationsFromServer(rustEditor));
            }
        }

        for (const promise of promises) {
            await promise;
        }
    }

    private isRustDocument(document: vscode.TextDocument): boolean {
        return document && document.languageId === 'rust';
    }

    private async updateDecorationsFromServer(
        editor: TextEditor
    ): Promise<void> {
        const newHints = await this.queryHints(editor.document.uri.toString());
        if (newHints !== null) {
            const newDecorations = newHints.map(hint => {
                let label = hint.label.substring(0, maxHintLength);
                if (hint.label.length > maxHintLength) {
                    label += '…';
                }
                return {
                    range: this.truncateHint(hint.range),
                    renderOptions: {
                        after: {
                            contentText: `: ${label}`
                        }
                    }
                };
            });
            return editor.setDecorations(
                typeHintDecorationType,
                newDecorations
            );
        }
    }

    private truncateHint(range: Range): Range {
        if (!range.isSingleLine) {
            return range;
        }
        const maxEnd = new vscode.Position(
            range.start.line,
            range.start.character + maxHintLength
        );
        const end = range.end.isAfter(maxEnd) ? maxEnd : range.end;
        return new Range(range.start, end);
    }

    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
                )
            );
    }
}