// ***************************************************************************** // Copyright (C) 2018 Red Hat, Inc. 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-only WITH Classpath-exception-2.0 // ***************************************************************************** import { URI } from '@theia/core/shared/vscode-uri'; import * as theia from '@theia/plugin'; import { DocumentsExtImpl } from '../documents'; import { CodeLensSymbol } from '../../common/plugin-api-rpc-model'; import * as Converter from '../type-converters'; import { ObjectIdentifier } from '../../common/object-identifier'; import { CommandRegistryImpl } from '../command-registry'; import { DisposableCollection } from '@theia/core/lib/common/disposable'; /** Adapts the calls from main to extension thread for providing/resolving the code lenses. */ export class CodeLensAdapter { private static readonly BAD_CMD: theia.Command = { command: 'missing', title: '<>' }; private cacheId = 0; private readonly cache = new Map(); private readonly disposables = new Map(); constructor( private readonly provider: theia.CodeLensProvider, private readonly documents: DocumentsExtImpl, private readonly commands: CommandRegistryImpl ) { } provideCodeLenses(resource: URI, token: theia.CancellationToken): Promise { const document = this.documents.getDocumentData(resource); if (!document) { return Promise.reject(new Error(`There is no document for ${resource}`)); } const doc = document.document; return Promise.resolve(this.provider.provideCodeLenses(doc, token)).then(lenses => { if (Array.isArray(lenses)) { return lenses.map(lens => { const cacheId = this.cacheId++; const toDispose = new DisposableCollection(); const lensSymbol = ObjectIdentifier.mixin({ range: Converter.fromRange(lens.range)!, command: this.commands.converter.toSafeCommand(lens.command, toDispose) }, cacheId); this.cache.set(cacheId, lens); this.disposables.set(cacheId, toDispose); return lensSymbol; }); } return undefined; }); } async resolveCodeLens(resource: URI, symbol: CodeLensSymbol, token: theia.CancellationToken): Promise { const cacheId = ObjectIdentifier.of(symbol); const lens = this.cache.get(cacheId); if (!lens) { return undefined; } let newLens: theia.CodeLens | undefined | null; if (typeof this.provider.resolveCodeLens === 'function' && !lens.isResolved) { newLens = await this.provider.resolveCodeLens(lens, token); if (token.isCancellationRequested) { return undefined; } } newLens = newLens || lens; const disposables = this.disposables.get(cacheId); if (!disposables) { // already been disposed of return undefined; } symbol.command = this.commands.converter.toSafeCommand(newLens.command ? newLens.command : CodeLensAdapter.BAD_CMD, disposables); return symbol; } releaseCodeLenses(ids: number[]): void { ids.forEach(id => { this.cache.delete(id); const toDispose = this.disposables.get(id); if (toDispose) { toDispose.dispose(); this.disposables.delete(id); } }); } }