-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
336 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
| /****************************************************************************** | ||
| * Copyright 2024 TypeFox GmbH | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the MIT License, which is available in the project root. | ||
| ******************************************************************************/ | ||
|
|
||
| import type { | ||
| Connection, DidOpenTextDocumentParams, DidChangeTextDocumentParams, DidCloseTextDocumentParams, TextDocumentsConfiguration, TextDocumentChangeEvent, | ||
| TextDocumentWillSaveEvent, RequestHandler, TextEdit, Event, WillSaveTextDocumentParams, CancellationToken, DidSaveTextDocumentParams | ||
| } from 'vscode-languageserver'; | ||
| import { TextDocumentSyncKind, Disposable, Emitter } from 'vscode-languageserver'; | ||
| import type { URI } from '../utils/uri-utils.js'; | ||
| import { UriUtils } from '../utils/uri-utils.js'; | ||
|
|
||
| /** | ||
| * A manager service that keeps track of all currently opened text documents. | ||
| * | ||
| * Designed to be compatible with the `TextDocuments` class in the `vscode-languageserver` package. | ||
| */ | ||
| export interface TextDocuments<T extends { uri: string }> { | ||
| /** | ||
| * An event that fires when a text document managed by this manager | ||
| * has been opened. | ||
| */ | ||
| readonly onDidOpen: Event<TextDocumentChangeEvent<T>>; | ||
| /** | ||
| * An event that fires when a text document managed by this manager | ||
| * has been opened or the content changes. | ||
| */ | ||
| readonly onDidChangeContent: Event<TextDocumentChangeEvent<T>>; | ||
| /** | ||
| * An event that fires when a text document managed by this manager | ||
| * will be saved. | ||
| */ | ||
| readonly onWillSave: Event<TextDocumentWillSaveEvent<T>>; | ||
| /** | ||
| * Sets a handler that will be called if a participant wants to provide | ||
| * edits during a text document save. | ||
| */ | ||
| onWillSaveWaitUntil(handler: RequestHandler<TextDocumentWillSaveEvent<T>, TextEdit[], void>): void; | ||
| /** | ||
| * An event that fires when a text document managed by this manager | ||
| * has been saved. | ||
| */ | ||
| readonly onDidSave: Event<TextDocumentChangeEvent<T>>; | ||
| /** | ||
| * An event that fires when a text document managed by this manager | ||
| * has been closed. | ||
| */ | ||
| readonly onDidClose: Event<TextDocumentChangeEvent<T>>; | ||
| /** | ||
| * Returns the document for the given URI. Returns undefined if | ||
| * the document is not managed by this instance. | ||
| * | ||
| * @param uri The text document's URI to retrieve. | ||
| * @return the text document or `undefined`. | ||
| */ | ||
| get(uri: string | URI): T | undefined; | ||
| /** | ||
| * Sets the text document managed by this instance. | ||
| * @param document The text document to add. | ||
| * @returns `true` if the document didn't exist yet, `false` if it was already present. | ||
| */ | ||
| set(document: T): boolean; | ||
| /** | ||
| * Deletes a text document managed by this instance. | ||
| */ | ||
| delete(uri: string | URI | T): void; | ||
| /** | ||
| * Returns all text documents managed by this instance. | ||
| * | ||
| * @return all text documents. | ||
| */ | ||
| all(): T[]; | ||
| /** | ||
| * Returns the URIs of all text documents managed by this instance. | ||
| * | ||
| * @return the URI's of all text documents. | ||
| */ | ||
| keys(): string[]; | ||
| /** | ||
| * Listens for `low level` notification on the given connection to | ||
| * update the text documents managed by this instance. | ||
| * | ||
| * Please note that the connection only provides handlers not an event model. Therefore | ||
| * listening on a connection will overwrite the following handlers on a connection: | ||
| * `onDidOpenTextDocument`, `onDidChangeTextDocument`, `onDidCloseTextDocument`, | ||
| * `onWillSaveTextDocument`, `onWillSaveTextDocumentWaitUntil` and `onDidSaveTextDocument`. | ||
| * | ||
| * Use the corresponding events on the TextDocuments instance instead. | ||
| * | ||
| * @param connection The connection to listen on. | ||
| */ | ||
| listen(connection: Connection): Disposable; | ||
| } | ||
|
|
||
| // Adapted from: | ||
| // https://github.com/microsoft/vscode-languageserver-node/blob/8f5fa710d3a9f60ff5e7583a9e61b19f86e39da3/server/src/common/textDocuments.ts | ||
|
|
||
| /* -------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| * ------------------------------------------------------------------------------------------ */ | ||
|
|
||
| /** | ||
| * Normalizing text document manager. Normalizes all incoming URIs to the same format used by VS Code. | ||
| */ | ||
| export class NormalizedTextDocuments<T extends { uri: string }> implements TextDocuments<T> { | ||
|
|
||
| private readonly _configuration: TextDocumentsConfiguration<T>; | ||
|
|
||
| private readonly _syncedDocuments: Map<string, T>; | ||
|
|
||
| private readonly _onDidChangeContent: Emitter<TextDocumentChangeEvent<T>>; | ||
| private readonly _onDidOpen: Emitter<TextDocumentChangeEvent<T>>; | ||
| private readonly _onDidClose: Emitter<TextDocumentChangeEvent<T>>; | ||
| private readonly _onDidSave: Emitter<TextDocumentChangeEvent<T>>; | ||
| private readonly _onWillSave: Emitter<TextDocumentWillSaveEvent<T>>; | ||
| private _willSaveWaitUntil: RequestHandler<TextDocumentWillSaveEvent<T>, TextEdit[], void> | undefined; | ||
|
|
||
| public constructor(configuration: TextDocumentsConfiguration<T>) { | ||
| this._configuration = configuration; | ||
| this._syncedDocuments = new Map(); | ||
|
|
||
| this._onDidChangeContent = new Emitter<TextDocumentChangeEvent<T>>(); | ||
| this._onDidOpen = new Emitter<TextDocumentChangeEvent<T>>(); | ||
| this._onDidClose = new Emitter<TextDocumentChangeEvent<T>>(); | ||
| this._onDidSave = new Emitter<TextDocumentChangeEvent<T>>(); | ||
| this._onWillSave = new Emitter<TextDocumentWillSaveEvent<T>>(); | ||
| } | ||
|
|
||
| public get onDidOpen(): Event<TextDocumentChangeEvent<T>> { | ||
| return this._onDidOpen.event; | ||
| } | ||
|
|
||
| public get onDidChangeContent(): Event<TextDocumentChangeEvent<T>> { | ||
| return this._onDidChangeContent.event; | ||
| } | ||
|
|
||
| public get onWillSave(): Event<TextDocumentWillSaveEvent<T>> { | ||
| return this._onWillSave.event; | ||
| } | ||
|
|
||
| public onWillSaveWaitUntil(handler: RequestHandler<TextDocumentWillSaveEvent<T>, TextEdit[], void>) { | ||
| this._willSaveWaitUntil = handler; | ||
| } | ||
|
|
||
| public get onDidSave(): Event<TextDocumentChangeEvent<T>> { | ||
| return this._onDidSave.event; | ||
| } | ||
|
|
||
| public get onDidClose(): Event<TextDocumentChangeEvent<T>> { | ||
| return this._onDidClose.event; | ||
| } | ||
|
|
||
| public get(uri: string | URI): T | undefined { | ||
| return this._syncedDocuments.get(UriUtils.normalize(uri)); | ||
| } | ||
|
|
||
| public set(document: T): boolean { | ||
| const uri = UriUtils.normalize(document.uri); | ||
| let result = true; | ||
| if (this._syncedDocuments.has(uri)) { | ||
| result = false; | ||
| } | ||
| this._syncedDocuments.set(uri, document); | ||
| const toFire = Object.freeze({ document }); | ||
| this._onDidOpen.fire(toFire); | ||
| this._onDidChangeContent.fire(toFire); | ||
| return result; | ||
| } | ||
|
|
||
| public delete(uri: string | T | URI): void { | ||
| const uriString = UriUtils.normalize(typeof uri === 'object' && 'uri' in uri ? uri.uri : uri); | ||
| const syncedDocument = this._syncedDocuments.get(uriString); | ||
| if (syncedDocument !== undefined) { | ||
| this._syncedDocuments.delete(uriString); | ||
| this._onDidClose.fire(Object.freeze({ document: syncedDocument })); | ||
| } | ||
| } | ||
|
|
||
| public all(): T[] { | ||
| return Array.from(this._syncedDocuments.values()); | ||
| } | ||
|
|
||
| public keys(): string[] { | ||
| return Array.from(this._syncedDocuments.keys()); | ||
| } | ||
|
|
||
| public listen(connection: Connection): Disposable { | ||
| // Required for interoperability with the the vscode-languageserver package | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| (connection as any).__textDocumentSync = TextDocumentSyncKind.Incremental; | ||
| const disposables: Disposable[] = []; | ||
| disposables.push(connection.onDidOpenTextDocument((event: DidOpenTextDocumentParams) => { | ||
| const td = event.textDocument; | ||
| const uri = UriUtils.normalize(td.uri); | ||
| const document = this._configuration.create(uri, td.languageId, td.version, td.text); | ||
|
|
||
| this._syncedDocuments.set(uri, document); | ||
| const toFire = Object.freeze({ document }); | ||
| this._onDidOpen.fire(toFire); | ||
| this._onDidChangeContent.fire(toFire); | ||
| })); | ||
| disposables.push(connection.onDidChangeTextDocument((event: DidChangeTextDocumentParams) => { | ||
| const td = event.textDocument; | ||
| const changes = event.contentChanges; | ||
| if (changes.length === 0) { | ||
| return; | ||
| } | ||
|
|
||
| const { version } = td; | ||
| if (version === null || version === undefined) { | ||
| throw new Error(`Received document change event for ${td.uri} without valid version identifier`); | ||
| } | ||
| const uri = UriUtils.normalize(td.uri); | ||
|
|
||
| let syncedDocument = this._syncedDocuments.get(uri); | ||
| if (syncedDocument !== undefined) { | ||
| syncedDocument = this._configuration.update(syncedDocument, changes, version); | ||
| this._syncedDocuments.set(uri, syncedDocument); | ||
| this._onDidChangeContent.fire(Object.freeze({ document: syncedDocument })); | ||
| } | ||
| })); | ||
| disposables.push(connection.onDidCloseTextDocument((event: DidCloseTextDocumentParams) => { | ||
| const uri = UriUtils.normalize(event.textDocument.uri); | ||
| const syncedDocument = this._syncedDocuments.get(uri); | ||
| if (syncedDocument !== undefined) { | ||
| this._syncedDocuments.delete(uri); | ||
| this._onDidClose.fire(Object.freeze({ document: syncedDocument })); | ||
| } | ||
| })); | ||
| disposables.push(connection.onWillSaveTextDocument((event: WillSaveTextDocumentParams) => { | ||
| const syncedDocument = this._syncedDocuments.get(UriUtils.normalize(event.textDocument.uri)); | ||
| if (syncedDocument !== undefined) { | ||
| this._onWillSave.fire(Object.freeze({ document: syncedDocument, reason: event.reason })); | ||
| } | ||
| })); | ||
| disposables.push(connection.onWillSaveTextDocumentWaitUntil((event: WillSaveTextDocumentParams, token: CancellationToken) => { | ||
| const syncedDocument = this._syncedDocuments.get(UriUtils.normalize(event.textDocument.uri)); | ||
| if (syncedDocument !== undefined && this._willSaveWaitUntil) { | ||
| return this._willSaveWaitUntil(Object.freeze({ document: syncedDocument, reason: event.reason }), token); | ||
| } else { | ||
| return []; | ||
| } | ||
| })); | ||
| disposables.push(connection.onDidSaveTextDocument((event: DidSaveTextDocumentParams) => { | ||
| const syncedDocument = this._syncedDocuments.get(UriUtils.normalize(event.textDocument.uri)); | ||
| if (syncedDocument !== undefined) { | ||
| this._onDidSave.fire(Object.freeze({ document: syncedDocument })); | ||
| } | ||
| })); | ||
| return Disposable.create(() => { disposables.forEach(disposable => disposable.dispose()); }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.