mirror of
https://github.com/microsoft/vscode.git
synced 2026-04-24 18:49:00 +01:00
337b02953f
* Move TernarySearchTree to own file This class is taking up most of `map.ts`. I think it's time to split it out into its own file * Adding missing file change * Update changed file
678 lines
26 KiB
TypeScript
678 lines
26 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
import { delta as arrayDelta, mapArrayOrNot } from 'vs/base/common/arrays';
|
|
import { Barrier } from 'vs/base/common/async';
|
|
import { CancellationToken } from 'vs/base/common/cancellation';
|
|
import { Emitter, Event } from 'vs/base/common/event';
|
|
import { toDisposable } from 'vs/base/common/lifecycle';
|
|
import { TernarySearchTree } from 'vs/base/common/ternarySearchTree';
|
|
import { Schemas } from 'vs/base/common/network';
|
|
import { Counter } from 'vs/base/common/numbers';
|
|
import { basename, basenameOrAuthority, dirname, ExtUri, relativePath } from 'vs/base/common/resources';
|
|
import { compare } from 'vs/base/common/strings';
|
|
import { withUndefinedAsNull } from 'vs/base/common/types';
|
|
import { URI, UriComponents } from 'vs/base/common/uri';
|
|
import { localize } from 'vs/nls';
|
|
import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensions/common/extensions';
|
|
import { FileSystemProviderCapabilities } from 'vs/platform/files/common/files';
|
|
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
|
|
import { ILogService } from 'vs/platform/log/common/log';
|
|
import { Severity } from 'vs/platform/notification/common/notification';
|
|
import { EditSessionIdentityMatch } from 'vs/platform/workspace/common/editSessions';
|
|
import { Workspace, WorkspaceFolder } from 'vs/platform/workspace/common/workspace';
|
|
import { IExtHostFileSystemInfo } from 'vs/workbench/api/common/extHostFileSystemInfo';
|
|
import { IExtHostInitDataService } from 'vs/workbench/api/common/extHostInitDataService';
|
|
import { IExtHostRpcService } from 'vs/workbench/api/common/extHostRpcService';
|
|
import { GlobPattern } from 'vs/workbench/api/common/extHostTypeConverters';
|
|
import { Range } from 'vs/workbench/api/common/extHostTypes';
|
|
import { IURITransformerService } from 'vs/workbench/api/common/extHostUriTransformerService';
|
|
import { ITextQueryBuilderOptions } from 'vs/workbench/services/search/common/queryBuilder';
|
|
import { IRawFileMatch2, resultIsMatch } from 'vs/workbench/services/search/common/search';
|
|
import * as vscode from 'vscode';
|
|
import { ExtHostWorkspaceShape, IRelativePatternDto, IWorkspaceData, MainContext, MainThreadMessageOptions, MainThreadMessageServiceShape, MainThreadWorkspaceShape } from './extHost.protocol';
|
|
|
|
export interface IExtHostWorkspaceProvider {
|
|
getWorkspaceFolder2(uri: vscode.Uri, resolveParent?: boolean): Promise<vscode.WorkspaceFolder | undefined>;
|
|
resolveWorkspaceFolder(uri: vscode.Uri): Promise<vscode.WorkspaceFolder | undefined>;
|
|
getWorkspaceFolders2(): Promise<vscode.WorkspaceFolder[] | undefined>;
|
|
resolveProxy(url: string): Promise<string | undefined>;
|
|
}
|
|
|
|
function isFolderEqual(folderA: URI, folderB: URI, extHostFileSystemInfo: IExtHostFileSystemInfo): boolean {
|
|
return new ExtUri(uri => ignorePathCasing(uri, extHostFileSystemInfo)).isEqual(folderA, folderB);
|
|
}
|
|
|
|
function compareWorkspaceFolderByUri(a: vscode.WorkspaceFolder, b: vscode.WorkspaceFolder, extHostFileSystemInfo: IExtHostFileSystemInfo): number {
|
|
return isFolderEqual(a.uri, b.uri, extHostFileSystemInfo) ? 0 : compare(a.uri.toString(), b.uri.toString());
|
|
}
|
|
|
|
function compareWorkspaceFolderByUriAndNameAndIndex(a: vscode.WorkspaceFolder, b: vscode.WorkspaceFolder, extHostFileSystemInfo: IExtHostFileSystemInfo): number {
|
|
if (a.index !== b.index) {
|
|
return a.index < b.index ? -1 : 1;
|
|
}
|
|
|
|
return isFolderEqual(a.uri, b.uri, extHostFileSystemInfo) ? compare(a.name, b.name) : compare(a.uri.toString(), b.uri.toString());
|
|
}
|
|
|
|
function delta(oldFolders: vscode.WorkspaceFolder[], newFolders: vscode.WorkspaceFolder[], compare: (a: vscode.WorkspaceFolder, b: vscode.WorkspaceFolder, extHostFileSystemInfo: IExtHostFileSystemInfo) => number, extHostFileSystemInfo: IExtHostFileSystemInfo): { removed: vscode.WorkspaceFolder[]; added: vscode.WorkspaceFolder[] } {
|
|
const oldSortedFolders = oldFolders.slice(0).sort((a, b) => compare(a, b, extHostFileSystemInfo));
|
|
const newSortedFolders = newFolders.slice(0).sort((a, b) => compare(a, b, extHostFileSystemInfo));
|
|
|
|
return arrayDelta(oldSortedFolders, newSortedFolders, (a, b) => compare(a, b, extHostFileSystemInfo));
|
|
}
|
|
|
|
function ignorePathCasing(uri: URI, extHostFileSystemInfo: IExtHostFileSystemInfo): boolean {
|
|
const capabilities = extHostFileSystemInfo.getCapabilities(uri.scheme);
|
|
return !(capabilities && (capabilities & FileSystemProviderCapabilities.PathCaseSensitive));
|
|
}
|
|
|
|
interface MutableWorkspaceFolder extends vscode.WorkspaceFolder {
|
|
name: string;
|
|
index: number;
|
|
}
|
|
|
|
class ExtHostWorkspaceImpl extends Workspace {
|
|
|
|
static toExtHostWorkspace(data: IWorkspaceData | null, previousConfirmedWorkspace: ExtHostWorkspaceImpl | undefined, previousUnconfirmedWorkspace: ExtHostWorkspaceImpl | undefined, extHostFileSystemInfo: IExtHostFileSystemInfo): { workspace: ExtHostWorkspaceImpl | null; added: vscode.WorkspaceFolder[]; removed: vscode.WorkspaceFolder[] } {
|
|
if (!data) {
|
|
return { workspace: null, added: [], removed: [] };
|
|
}
|
|
|
|
const { id, name, folders, configuration, transient, isUntitled } = data;
|
|
const newWorkspaceFolders: vscode.WorkspaceFolder[] = [];
|
|
|
|
// If we have an existing workspace, we try to find the folders that match our
|
|
// data and update their properties. It could be that an extension stored them
|
|
// for later use and we want to keep them "live" if they are still present.
|
|
const oldWorkspace = previousConfirmedWorkspace;
|
|
if (previousConfirmedWorkspace) {
|
|
folders.forEach((folderData, index) => {
|
|
const folderUri = URI.revive(folderData.uri);
|
|
const existingFolder = ExtHostWorkspaceImpl._findFolder(previousUnconfirmedWorkspace || previousConfirmedWorkspace, folderUri, extHostFileSystemInfo);
|
|
|
|
if (existingFolder) {
|
|
existingFolder.name = folderData.name;
|
|
existingFolder.index = folderData.index;
|
|
|
|
newWorkspaceFolders.push(existingFolder);
|
|
} else {
|
|
newWorkspaceFolders.push({ uri: folderUri, name: folderData.name, index });
|
|
}
|
|
});
|
|
} else {
|
|
newWorkspaceFolders.push(...folders.map(({ uri, name, index }) => ({ uri: URI.revive(uri), name, index })));
|
|
}
|
|
|
|
// make sure to restore sort order based on index
|
|
newWorkspaceFolders.sort((f1, f2) => f1.index < f2.index ? -1 : 1);
|
|
|
|
const workspace = new ExtHostWorkspaceImpl(id, name, newWorkspaceFolders, !!transient, configuration ? URI.revive(configuration) : null, !!isUntitled, uri => ignorePathCasing(uri, extHostFileSystemInfo));
|
|
const { added, removed } = delta(oldWorkspace ? oldWorkspace.workspaceFolders : [], workspace.workspaceFolders, compareWorkspaceFolderByUri, extHostFileSystemInfo);
|
|
|
|
return { workspace, added, removed };
|
|
}
|
|
|
|
private static _findFolder(workspace: ExtHostWorkspaceImpl, folderUriToFind: URI, extHostFileSystemInfo: IExtHostFileSystemInfo): MutableWorkspaceFolder | undefined {
|
|
for (let i = 0; i < workspace.folders.length; i++) {
|
|
const folder = workspace.workspaceFolders[i];
|
|
if (isFolderEqual(folder.uri, folderUriToFind, extHostFileSystemInfo)) {
|
|
return folder;
|
|
}
|
|
}
|
|
|
|
return undefined;
|
|
}
|
|
|
|
private readonly _workspaceFolders: vscode.WorkspaceFolder[] = [];
|
|
private readonly _structure: TernarySearchTree<URI, vscode.WorkspaceFolder>;
|
|
|
|
constructor(id: string, private _name: string, folders: vscode.WorkspaceFolder[], transient: boolean, configuration: URI | null, private _isUntitled: boolean, ignorePathCasing: (key: URI) => boolean) {
|
|
super(id, folders.map(f => new WorkspaceFolder(f)), transient, configuration, ignorePathCasing);
|
|
this._structure = TernarySearchTree.forUris<vscode.WorkspaceFolder>(ignorePathCasing);
|
|
|
|
// setup the workspace folder data structure
|
|
folders.forEach(folder => {
|
|
this._workspaceFolders.push(folder);
|
|
this._structure.set(folder.uri, folder);
|
|
});
|
|
}
|
|
|
|
get name(): string {
|
|
return this._name;
|
|
}
|
|
|
|
get isUntitled(): boolean {
|
|
return this._isUntitled;
|
|
}
|
|
|
|
get workspaceFolders(): vscode.WorkspaceFolder[] {
|
|
return this._workspaceFolders.slice(0);
|
|
}
|
|
|
|
getWorkspaceFolder(uri: URI, resolveParent?: boolean): vscode.WorkspaceFolder | undefined {
|
|
if (resolveParent && this._structure.get(uri)) {
|
|
// `uri` is a workspace folder so we check for its parent
|
|
uri = dirname(uri);
|
|
}
|
|
return this._structure.findSubstr(uri);
|
|
}
|
|
|
|
resolveWorkspaceFolder(uri: URI): vscode.WorkspaceFolder | undefined {
|
|
return this._structure.get(uri);
|
|
}
|
|
}
|
|
|
|
export class ExtHostWorkspace implements ExtHostWorkspaceShape, IExtHostWorkspaceProvider {
|
|
|
|
readonly _serviceBrand: undefined;
|
|
|
|
private readonly _onDidChangeWorkspace = new Emitter<vscode.WorkspaceFoldersChangeEvent>();
|
|
readonly onDidChangeWorkspace: Event<vscode.WorkspaceFoldersChangeEvent> = this._onDidChangeWorkspace.event;
|
|
|
|
private readonly _onDidGrantWorkspaceTrust = new Emitter<void>();
|
|
readonly onDidGrantWorkspaceTrust: Event<void> = this._onDidGrantWorkspaceTrust.event;
|
|
|
|
private readonly _logService: ILogService;
|
|
private readonly _requestIdProvider: Counter;
|
|
private readonly _barrier: Barrier;
|
|
|
|
private _confirmedWorkspace?: ExtHostWorkspaceImpl;
|
|
private _unconfirmedWorkspace?: ExtHostWorkspaceImpl;
|
|
|
|
private readonly _proxy: MainThreadWorkspaceShape;
|
|
private readonly _messageService: MainThreadMessageServiceShape;
|
|
private readonly _extHostFileSystemInfo: IExtHostFileSystemInfo;
|
|
private readonly _uriTransformerService: IURITransformerService;
|
|
|
|
private readonly _activeSearchCallbacks: ((match: IRawFileMatch2) => any)[] = [];
|
|
|
|
private _trusted: boolean = false;
|
|
|
|
private readonly _editSessionIdentityProviders = new Map<string, vscode.EditSessionIdentityProvider>();
|
|
|
|
constructor(
|
|
@IExtHostRpcService extHostRpc: IExtHostRpcService,
|
|
@IExtHostInitDataService initData: IExtHostInitDataService,
|
|
@IExtHostFileSystemInfo extHostFileSystemInfo: IExtHostFileSystemInfo,
|
|
@ILogService logService: ILogService,
|
|
@IURITransformerService uriTransformerService: IURITransformerService,
|
|
) {
|
|
this._logService = logService;
|
|
this._extHostFileSystemInfo = extHostFileSystemInfo;
|
|
this._uriTransformerService = uriTransformerService;
|
|
this._requestIdProvider = new Counter();
|
|
this._barrier = new Barrier();
|
|
|
|
this._proxy = extHostRpc.getProxy(MainContext.MainThreadWorkspace);
|
|
this._messageService = extHostRpc.getProxy(MainContext.MainThreadMessageService);
|
|
const data = initData.workspace;
|
|
this._confirmedWorkspace = data ? new ExtHostWorkspaceImpl(data.id, data.name, [], !!data.transient, data.configuration ? URI.revive(data.configuration) : null, !!data.isUntitled, uri => ignorePathCasing(uri, extHostFileSystemInfo)) : undefined;
|
|
}
|
|
|
|
$initializeWorkspace(data: IWorkspaceData | null, trusted: boolean): void {
|
|
this._trusted = trusted;
|
|
this.$acceptWorkspaceData(data);
|
|
this._barrier.open();
|
|
}
|
|
|
|
waitForInitializeCall(): Promise<boolean> {
|
|
return this._barrier.wait();
|
|
}
|
|
|
|
// --- workspace ---
|
|
|
|
get workspace(): Workspace | undefined {
|
|
return this._actualWorkspace;
|
|
}
|
|
|
|
get name(): string | undefined {
|
|
return this._actualWorkspace ? this._actualWorkspace.name : undefined;
|
|
}
|
|
|
|
get workspaceFile(): vscode.Uri | undefined {
|
|
if (this._actualWorkspace) {
|
|
if (this._actualWorkspace.configuration) {
|
|
if (this._actualWorkspace.isUntitled) {
|
|
return URI.from({ scheme: Schemas.untitled, path: basename(dirname(this._actualWorkspace.configuration)) }); // Untitled Workspace: return untitled URI
|
|
}
|
|
|
|
return this._actualWorkspace.configuration; // Workspace: return the configuration location
|
|
}
|
|
}
|
|
|
|
return undefined;
|
|
}
|
|
|
|
private get _actualWorkspace(): ExtHostWorkspaceImpl | undefined {
|
|
return this._unconfirmedWorkspace || this._confirmedWorkspace;
|
|
}
|
|
|
|
getWorkspaceFolders(): vscode.WorkspaceFolder[] | undefined {
|
|
if (!this._actualWorkspace) {
|
|
return undefined;
|
|
}
|
|
return this._actualWorkspace.workspaceFolders.slice(0);
|
|
}
|
|
|
|
async getWorkspaceFolders2(): Promise<vscode.WorkspaceFolder[] | undefined> {
|
|
await this._barrier.wait();
|
|
if (!this._actualWorkspace) {
|
|
return undefined;
|
|
}
|
|
return this._actualWorkspace.workspaceFolders.slice(0);
|
|
}
|
|
|
|
updateWorkspaceFolders(extension: IExtensionDescription, index: number, deleteCount: number, ...workspaceFoldersToAdd: { uri: vscode.Uri; name?: string }[]): boolean {
|
|
const validatedDistinctWorkspaceFoldersToAdd: { uri: vscode.Uri; name?: string }[] = [];
|
|
if (Array.isArray(workspaceFoldersToAdd)) {
|
|
workspaceFoldersToAdd.forEach(folderToAdd => {
|
|
if (URI.isUri(folderToAdd.uri) && !validatedDistinctWorkspaceFoldersToAdd.some(f => isFolderEqual(f.uri, folderToAdd.uri, this._extHostFileSystemInfo))) {
|
|
validatedDistinctWorkspaceFoldersToAdd.push({ uri: folderToAdd.uri, name: folderToAdd.name || basenameOrAuthority(folderToAdd.uri) });
|
|
}
|
|
});
|
|
}
|
|
|
|
if (!!this._unconfirmedWorkspace) {
|
|
return false; // prevent accumulated calls without a confirmed workspace
|
|
}
|
|
|
|
if ([index, deleteCount].some(i => typeof i !== 'number' || i < 0)) {
|
|
return false; // validate numbers
|
|
}
|
|
|
|
if (deleteCount === 0 && validatedDistinctWorkspaceFoldersToAdd.length === 0) {
|
|
return false; // nothing to delete or add
|
|
}
|
|
|
|
const currentWorkspaceFolders: MutableWorkspaceFolder[] = this._actualWorkspace ? this._actualWorkspace.workspaceFolders : [];
|
|
if (index + deleteCount > currentWorkspaceFolders.length) {
|
|
return false; // cannot delete more than we have
|
|
}
|
|
|
|
// Simulate the updateWorkspaceFolders method on our data to do more validation
|
|
const newWorkspaceFolders = currentWorkspaceFolders.slice(0);
|
|
newWorkspaceFolders.splice(index, deleteCount, ...validatedDistinctWorkspaceFoldersToAdd.map(f => ({ uri: f.uri, name: f.name || basenameOrAuthority(f.uri), index: undefined! /* fixed later */ })));
|
|
|
|
for (let i = 0; i < newWorkspaceFolders.length; i++) {
|
|
const folder = newWorkspaceFolders[i];
|
|
if (newWorkspaceFolders.some((otherFolder, index) => index !== i && isFolderEqual(folder.uri, otherFolder.uri, this._extHostFileSystemInfo))) {
|
|
return false; // cannot add the same folder multiple times
|
|
}
|
|
}
|
|
|
|
newWorkspaceFolders.forEach((f, index) => f.index = index); // fix index
|
|
const { added, removed } = delta(currentWorkspaceFolders, newWorkspaceFolders, compareWorkspaceFolderByUriAndNameAndIndex, this._extHostFileSystemInfo);
|
|
if (added.length === 0 && removed.length === 0) {
|
|
return false; // nothing actually changed
|
|
}
|
|
|
|
// Trigger on main side
|
|
if (this._proxy) {
|
|
const extName = extension.displayName || extension.name;
|
|
this._proxy.$updateWorkspaceFolders(extName, index, deleteCount, validatedDistinctWorkspaceFoldersToAdd).then(undefined, error => {
|
|
|
|
// in case of an error, make sure to clear out the unconfirmed workspace
|
|
// because we cannot expect the acknowledgement from the main side for this
|
|
this._unconfirmedWorkspace = undefined;
|
|
|
|
// show error to user
|
|
const options: MainThreadMessageOptions = { source: { identifier: extension.identifier, label: extension.displayName || extension.name } };
|
|
this._messageService.$showMessage(Severity.Error, localize('updateerror', "Extension '{0}' failed to update workspace folders: {1}", extName, error.toString()), options, []);
|
|
});
|
|
}
|
|
|
|
// Try to accept directly
|
|
this.trySetWorkspaceFolders(newWorkspaceFolders);
|
|
|
|
return true;
|
|
}
|
|
|
|
getWorkspaceFolder(uri: vscode.Uri, resolveParent?: boolean): vscode.WorkspaceFolder | undefined {
|
|
if (!this._actualWorkspace) {
|
|
return undefined;
|
|
}
|
|
return this._actualWorkspace.getWorkspaceFolder(uri, resolveParent);
|
|
}
|
|
|
|
async getWorkspaceFolder2(uri: vscode.Uri, resolveParent?: boolean): Promise<vscode.WorkspaceFolder | undefined> {
|
|
await this._barrier.wait();
|
|
if (!this._actualWorkspace) {
|
|
return undefined;
|
|
}
|
|
return this._actualWorkspace.getWorkspaceFolder(uri, resolveParent);
|
|
}
|
|
|
|
async resolveWorkspaceFolder(uri: vscode.Uri): Promise<vscode.WorkspaceFolder | undefined> {
|
|
await this._barrier.wait();
|
|
if (!this._actualWorkspace) {
|
|
return undefined;
|
|
}
|
|
return this._actualWorkspace.resolveWorkspaceFolder(uri);
|
|
}
|
|
|
|
getPath(): string | undefined {
|
|
|
|
// this is legacy from the days before having
|
|
// multi-root and we keep it only alive if there
|
|
// is just one workspace folder.
|
|
if (!this._actualWorkspace) {
|
|
return undefined;
|
|
}
|
|
|
|
const { folders } = this._actualWorkspace;
|
|
if (folders.length === 0) {
|
|
return undefined;
|
|
}
|
|
// #54483 @Joh Why are we still using fsPath?
|
|
return folders[0].uri.fsPath;
|
|
}
|
|
|
|
getRelativePath(pathOrUri: string | vscode.Uri, includeWorkspace?: boolean): string {
|
|
|
|
let resource: URI | undefined;
|
|
let path: string = '';
|
|
if (typeof pathOrUri === 'string') {
|
|
resource = URI.file(pathOrUri);
|
|
path = pathOrUri;
|
|
} else if (typeof pathOrUri !== 'undefined') {
|
|
resource = pathOrUri;
|
|
path = pathOrUri.fsPath;
|
|
}
|
|
|
|
if (!resource) {
|
|
return path;
|
|
}
|
|
|
|
const folder = this.getWorkspaceFolder(
|
|
resource,
|
|
true
|
|
);
|
|
|
|
if (!folder) {
|
|
return path;
|
|
}
|
|
|
|
if (typeof includeWorkspace === 'undefined' && this._actualWorkspace) {
|
|
includeWorkspace = this._actualWorkspace.folders.length > 1;
|
|
}
|
|
|
|
let result = relativePath(folder.uri, resource);
|
|
if (includeWorkspace && folder.name) {
|
|
result = `${folder.name}/${result}`;
|
|
}
|
|
return result!;
|
|
}
|
|
|
|
private trySetWorkspaceFolders(folders: vscode.WorkspaceFolder[]): void {
|
|
|
|
// Update directly here. The workspace is unconfirmed as long as we did not get an
|
|
// acknowledgement from the main side (via $acceptWorkspaceData)
|
|
if (this._actualWorkspace) {
|
|
this._unconfirmedWorkspace = ExtHostWorkspaceImpl.toExtHostWorkspace({
|
|
id: this._actualWorkspace.id,
|
|
name: this._actualWorkspace.name,
|
|
configuration: this._actualWorkspace.configuration,
|
|
folders,
|
|
isUntitled: this._actualWorkspace.isUntitled
|
|
} as IWorkspaceData, this._actualWorkspace, undefined, this._extHostFileSystemInfo).workspace || undefined;
|
|
}
|
|
}
|
|
|
|
$acceptWorkspaceData(data: IWorkspaceData | null): void {
|
|
|
|
const { workspace, added, removed } = ExtHostWorkspaceImpl.toExtHostWorkspace(data, this._confirmedWorkspace, this._unconfirmedWorkspace, this._extHostFileSystemInfo);
|
|
|
|
// Update our workspace object. We have a confirmed workspace, so we drop our
|
|
// unconfirmed workspace.
|
|
this._confirmedWorkspace = workspace || undefined;
|
|
this._unconfirmedWorkspace = undefined;
|
|
|
|
// Events
|
|
this._onDidChangeWorkspace.fire(Object.freeze({
|
|
added,
|
|
removed,
|
|
}));
|
|
}
|
|
|
|
// --- search ---
|
|
|
|
/**
|
|
* Note, null/undefined have different and important meanings for "exclude"
|
|
*/
|
|
findFiles(include: vscode.GlobPattern | undefined, exclude: vscode.GlobPattern | null | undefined, maxResults: number | undefined, extensionId: ExtensionIdentifier, token: vscode.CancellationToken = CancellationToken.None): Promise<vscode.Uri[]> {
|
|
this._logService.trace(`extHostWorkspace#findFiles: fileSearch, extension: ${extensionId.value}, entryPoint: findFiles`);
|
|
|
|
let excludePatternOrDisregardExcludes: string | false | undefined = undefined;
|
|
if (exclude === null) {
|
|
excludePatternOrDisregardExcludes = false;
|
|
} else if (exclude) {
|
|
if (typeof exclude === 'string') {
|
|
excludePatternOrDisregardExcludes = exclude;
|
|
} else {
|
|
excludePatternOrDisregardExcludes = exclude.pattern;
|
|
}
|
|
}
|
|
|
|
if (token && token.isCancellationRequested) {
|
|
return Promise.resolve([]);
|
|
}
|
|
|
|
const { includePattern, folder } = parseSearchInclude(GlobPattern.from(include));
|
|
return this._proxy.$startFileSearch(
|
|
withUndefinedAsNull(includePattern),
|
|
withUndefinedAsNull(folder),
|
|
withUndefinedAsNull(excludePatternOrDisregardExcludes),
|
|
withUndefinedAsNull(maxResults),
|
|
token
|
|
)
|
|
.then(data => Array.isArray(data) ? data.map(d => URI.revive(d)) : []);
|
|
}
|
|
|
|
async findTextInFiles(query: vscode.TextSearchQuery, options: vscode.FindTextInFilesOptions, callback: (result: vscode.TextSearchResult) => void, extensionId: ExtensionIdentifier, token: vscode.CancellationToken = CancellationToken.None): Promise<vscode.TextSearchComplete> {
|
|
this._logService.trace(`extHostWorkspace#findTextInFiles: textSearch, extension: ${extensionId.value}, entryPoint: findTextInFiles`);
|
|
|
|
const requestId = this._requestIdProvider.getNext();
|
|
|
|
const previewOptions: vscode.TextSearchPreviewOptions = typeof options.previewOptions === 'undefined' ?
|
|
{
|
|
matchLines: 100,
|
|
charsPerLine: 10000
|
|
} :
|
|
options.previewOptions;
|
|
|
|
const { includePattern, folder } = parseSearchInclude(GlobPattern.from(options.include));
|
|
const excludePattern = (typeof options.exclude === 'string') ? options.exclude :
|
|
options.exclude ? options.exclude.pattern : undefined;
|
|
const queryOptions: ITextQueryBuilderOptions = {
|
|
ignoreSymlinks: typeof options.followSymlinks === 'boolean' ? !options.followSymlinks : undefined,
|
|
disregardIgnoreFiles: typeof options.useIgnoreFiles === 'boolean' ? !options.useIgnoreFiles : undefined,
|
|
disregardGlobalIgnoreFiles: typeof options.useGlobalIgnoreFiles === 'boolean' ? !options.useGlobalIgnoreFiles : undefined,
|
|
disregardParentIgnoreFiles: typeof options.useParentIgnoreFiles === 'boolean' ? !options.useParentIgnoreFiles : undefined,
|
|
disregardExcludeSettings: typeof options.useDefaultExcludes === 'boolean' ? !options.useDefaultExcludes : true,
|
|
fileEncoding: options.encoding,
|
|
maxResults: options.maxResults,
|
|
previewOptions,
|
|
afterContext: options.afterContext,
|
|
beforeContext: options.beforeContext,
|
|
|
|
includePattern: includePattern,
|
|
excludePattern: excludePattern
|
|
};
|
|
|
|
const isCanceled = false;
|
|
|
|
this._activeSearchCallbacks[requestId] = p => {
|
|
if (isCanceled) {
|
|
return;
|
|
}
|
|
|
|
const uri = URI.revive(p.resource);
|
|
p.results!.forEach(result => {
|
|
if (resultIsMatch(result)) {
|
|
callback(<vscode.TextSearchMatch>{
|
|
uri,
|
|
preview: {
|
|
text: result.preview.text,
|
|
matches: mapArrayOrNot(
|
|
result.preview.matches,
|
|
m => new Range(m.startLineNumber, m.startColumn, m.endLineNumber, m.endColumn))
|
|
},
|
|
ranges: mapArrayOrNot(
|
|
result.ranges,
|
|
r => new Range(r.startLineNumber, r.startColumn, r.endLineNumber, r.endColumn))
|
|
});
|
|
} else {
|
|
callback(<vscode.TextSearchContext>{
|
|
uri,
|
|
text: result.text,
|
|
lineNumber: result.lineNumber
|
|
});
|
|
}
|
|
});
|
|
};
|
|
|
|
if (token.isCancellationRequested) {
|
|
return {};
|
|
}
|
|
|
|
try {
|
|
const result = await this._proxy.$startTextSearch(
|
|
query,
|
|
withUndefinedAsNull(folder),
|
|
queryOptions,
|
|
requestId,
|
|
token);
|
|
delete this._activeSearchCallbacks[requestId];
|
|
return result || {};
|
|
} catch (err) {
|
|
delete this._activeSearchCallbacks[requestId];
|
|
throw err;
|
|
}
|
|
}
|
|
|
|
$handleTextSearchResult(result: IRawFileMatch2, requestId: number): void {
|
|
this._activeSearchCallbacks[requestId]?.(result);
|
|
}
|
|
|
|
saveAll(includeUntitled?: boolean): Promise<boolean> {
|
|
return this._proxy.$saveAll(includeUntitled);
|
|
}
|
|
|
|
resolveProxy(url: string): Promise<string | undefined> {
|
|
return this._proxy.$resolveProxy(url);
|
|
}
|
|
|
|
// --- trust ---
|
|
|
|
get trusted(): boolean {
|
|
return this._trusted;
|
|
}
|
|
|
|
requestWorkspaceTrust(options?: vscode.WorkspaceTrustRequestOptions): Promise<boolean | undefined> {
|
|
return this._proxy.$requestWorkspaceTrust(options);
|
|
}
|
|
|
|
$onDidGrantWorkspaceTrust(): void {
|
|
if (!this._trusted) {
|
|
this._trusted = true;
|
|
this._onDidGrantWorkspaceTrust.fire();
|
|
}
|
|
}
|
|
|
|
// --- edit sessions ---
|
|
|
|
private _providerHandlePool = 0;
|
|
|
|
// called by ext host
|
|
registerEditSessionIdentityProvider(scheme: string, provider: vscode.EditSessionIdentityProvider) {
|
|
if (this._editSessionIdentityProviders.has(scheme)) {
|
|
throw new Error(`A provider has already been registered for scheme ${scheme}`);
|
|
}
|
|
|
|
this._editSessionIdentityProviders.set(scheme, provider);
|
|
const outgoingScheme = this._uriTransformerService.transformOutgoingScheme(scheme);
|
|
const handle = this._providerHandlePool++;
|
|
this._proxy.$registerEditSessionIdentityProvider(handle, outgoingScheme);
|
|
|
|
return toDisposable(() => {
|
|
this._editSessionIdentityProviders.delete(scheme);
|
|
this._proxy.$unregisterEditSessionIdentityProvider(handle);
|
|
});
|
|
}
|
|
|
|
// called by main thread
|
|
async $getEditSessionIdentifier(workspaceFolder: UriComponents, cancellationToken: CancellationToken): Promise<string | undefined> {
|
|
this._logService.info('Getting edit session identifier for workspaceFolder', workspaceFolder);
|
|
const folder = await this.resolveWorkspaceFolder(URI.revive(workspaceFolder));
|
|
if (!folder) {
|
|
this._logService.warn('Unable to resolve workspace folder');
|
|
return undefined;
|
|
}
|
|
|
|
this._logService.info('Invoking #provideEditSessionIdentity for workspaceFolder', folder);
|
|
|
|
const provider = this._editSessionIdentityProviders.get(folder.uri.scheme);
|
|
this._logService.info(`Provider for scheme ${folder.uri.scheme} is defined: `, !!provider);
|
|
if (!provider) {
|
|
return undefined;
|
|
}
|
|
|
|
const result = await provider.provideEditSessionIdentity(folder, cancellationToken);
|
|
this._logService.info('Provider returned edit session identifier: ', result);
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
async $provideEditSessionIdentityMatch(workspaceFolder: UriComponents, identity1: string, identity2: string, cancellationToken: CancellationToken): Promise<EditSessionIdentityMatch | undefined> {
|
|
this._logService.info('Getting edit session identifier for workspaceFolder', workspaceFolder);
|
|
const folder = await this.resolveWorkspaceFolder(URI.revive(workspaceFolder));
|
|
if (!folder) {
|
|
this._logService.warn('Unable to resolve workspace folder');
|
|
return undefined;
|
|
}
|
|
|
|
this._logService.info('Invoking #provideEditSessionIdentity for workspaceFolder', folder);
|
|
|
|
const provider = this._editSessionIdentityProviders.get(folder.uri.scheme);
|
|
this._logService.info(`Provider for scheme ${folder.uri.scheme} is defined: `, !!provider);
|
|
if (!provider) {
|
|
return undefined;
|
|
}
|
|
|
|
const result = await provider.provideEditSessionIdentityMatch?.(identity1, identity2, cancellationToken);
|
|
this._logService.info('Provider returned edit session identifier match result: ', result);
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
}
|
|
|
|
export const IExtHostWorkspace = createDecorator<IExtHostWorkspace>('IExtHostWorkspace');
|
|
export interface IExtHostWorkspace extends ExtHostWorkspace, ExtHostWorkspaceShape, IExtHostWorkspaceProvider { }
|
|
|
|
function parseSearchInclude(include: string | IRelativePatternDto | undefined | null): { includePattern?: string; folder?: URI } {
|
|
let includePattern: string | undefined;
|
|
let includeFolder: URI | undefined;
|
|
if (include) {
|
|
if (typeof include === 'string') {
|
|
includePattern = include;
|
|
} else {
|
|
includePattern = include.pattern;
|
|
includeFolder = URI.revive(include.baseUri);
|
|
}
|
|
}
|
|
|
|
return {
|
|
includePattern,
|
|
folder: includeFolder
|
|
};
|
|
}
|