/******************************************************************************** * Copyright (c) 2022 TypeFox and others. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v. 2.0 which is available at * http://www.eclipse.org/legal/epl-2.0. * * This Source Code may also be made available under the following Secondary * Licenses when the conditions for such availability set forth in the Eclipse * Public License v. 2.0 are satisfied: GNU General Public License, version 2 * with the GNU Classpath Exception which is available at * https://www.gnu.org/software/classpath/license.html. * * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 ********************************************************************************/ import { ActionMessage } from 'sprotty-protocol'; import { SprottyDiagramIdentifier } from 'sprotty-vscode-protocol'; import * as vscode from 'vscode'; import { LanguageClient } from 'vscode-languageclient/node'; import { SprottyViewProvider, SprottyViewProviderOptions } from '../sprotty-view-provider'; import { WebviewEndpoint } from '../webview-endpoint'; import { openInTextEditor } from './lsp-utils'; import { LspWebviewEndpoint } from './lsp-webview-endpoint'; import { acceptMessageType, didCloseMessageType, openInTextEditorMessageType } from './protocol'; export interface LspSprottyViewProviderOptions extends SprottyViewProviderOptions { languageClient: LanguageClient } /** * A view provider to be connected with a language server to provide diagram contents. */ export class LspSprottyViewProvider extends SprottyViewProvider { constructor(options: LspSprottyViewProviderOptions) { super(options); options.languageClient.onNotification(acceptMessageType, message => this.acceptFromLanguageServer(message)); options.languageClient.onNotification(openInTextEditorMessageType, message => openInTextEditor(message)); } get languageClient(): LanguageClient { return (this.options as LspSprottyViewProviderOptions).languageClient; } protected override createEndpoint(webviewContainer: vscode.WebviewView, identifier?: SprottyDiagramIdentifier): WebviewEndpoint { const participant = this.messenger.registerWebviewView(webviewContainer); const endpoint = new LspWebviewEndpoint({ languageClient: this.languageClient, webviewContainer, messenger: this.messenger, messageParticipant: participant, identifier }); this.options.configureEndpoint?.(endpoint); return endpoint; } protected override didCloseWebview(endpoint: WebviewEndpoint): void { super.didCloseWebview(endpoint); try { this.languageClient.sendNotification(didCloseMessageType, endpoint.diagramIdentifier?.clientId); } catch (err) { // Ignore the error and proceed } } protected acceptFromLanguageServer(message: ActionMessage): void { if (this.endpoint) { this.endpoint.sendAction(message); } } }