src/vs/workbench/services/search/node/ripgrepSearchProvider.ts

73 LOC · 29 covered · 44 uncovered · 3 ranges · 60 concepts · 1 introducers · 32 tests

File neighbourhood

The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.

Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.

  1
  >
  /*---------------------------------------------------------------------------------------------
  
fileSearch.ts ×31

  2
  >
   *  Copyright (c) Microsoft Corporation. All rights reserved.
  
  3
  >
   *  Licensed under the MIT License. See License.txt in the project root for license information.
  
  4
  >
   *--------------------------------------------------------------------------------------------*/
  
  5
  >
  
  6
  >
  import { CancellationTokenSource, CancellationToken } from '../../../../base/common/cancellation.js';
  
  7
  >
  import { OutputChannel } from './ripgrepSearchUtils.js';
  
  8
  >
  import { RipgrepTextSearchEngine } from './ripgrepTextSearchEngine.js';
  
  9
  >
  import { TextSearchProvider2, TextSearchComplete2, TextSearchResult2, TextSearchQuery2, TextSearchProviderOptions, } from '../common/searchExtTypes.js';
  
  10
  >
  import { Progress } from '../../../../platform/progress/common/progress.js';
  
  11
  >
  import { Schemas } from '../../../../base/common/network.js';
  
  12
  >
  import type { RipgrepTextSearchOptions } from '../common/searchExtTypesInternal.js';
  
  13
  >
  
  14
  >
  export class RipgrepSearchProvider implements TextSearchProvider2 {
  
  15
  >
  	private inProgress: Set<CancellationTokenSource> = new Set();
  
  16
  >
  
  17
  >
  	constructor(private outputChannel: OutputChannel, private getNumThreads: () => Promise<number | undefined>) {
  
  18
  >
  		process.once('exit', () => this.dispose());
  
  19
  >
  	}
  
  20
  >
  
  21
  >
  	async provideTextSearchResults(query: TextSearchQuery2, options: TextSearchProviderOptions, progress: Progress<TextSearchResult2>, token: CancellationToken): Promise<TextSearchComplete2> {
  
  22
  
  		const numThreads = await this.getNumThreads();
  
  23
  
  		const engine = new RipgrepTextSearchEngine(this.outputChannel, numThreads);
  
  24
  
  25
  
  		return Promise.all(options.folderOptions.map(folderOption => {
  
  26
  
  27
  
  			const extendedOptions: RipgrepTextSearchOptions = {
  
  28
  
  				folderOptions: folderOption,
  
  29
  
  				numThreads,
  
  30
  
  				maxResults: options.maxResults,
  
  31
  
  				previewOptions: options.previewOptions,
  
  32
  
  				maxFileSize: options.maxFileSize,
  
  33
  
  				surroundingContext: options.surroundingContext
  
  34
  
  			};
  
  35
  
  			if (folderOption.folder.scheme === Schemas.vscodeUserData) {
  
  36
  
  				// Ripgrep search engine can only provide file-scheme results, but we want to use it to search some schemes that are backed by the filesystem, but with some other provider as the frontend,
  
  37
  
  				// case in point vscode-userdata. In these cases we translate the query to a file, and translate the results back to the frontend scheme.
  
  38
  
  				const translatedOptions = { ...extendedOptions, folder: folderOption.folder.with({ scheme: Schemas.file }) };
  
  39
  
  				const progressTranslator = new Progress<TextSearchResult2>(data => progress.report({ ...data, uri: data.uri.with({ scheme: folderOption.folder.scheme }) }));
  
  40
  
  				return this.withToken(token, token => engine.provideTextSearchResultsWithRgOptions(query, translatedOptions, progressTranslator, token));
  
  41
  
  			} else {
  
  42
  
  				return this.withToken(token, token => engine.provideTextSearchResultsWithRgOptions(query, extendedOptions, progress, token));
  
  43
  
  			}
  
  44
  
  		})).then((e => {
  
  45
  
  			const complete: TextSearchComplete2 = {
  
  46
  
  				// todo: get this to actually check
  
  47
  
  				limitHit: e.some(complete => !!complete && complete.limitHit)
  
  48
  
  			};
  
  49
  
  			return complete;
  
  50
  
  		}));
  
  51
  
  52
  
  	}
  
  53
  >
  
fileSearch.ts ×31

  54
  >
  	private async withToken<T>(token: CancellationToken, fn: (token: CancellationToken) => Promise<T>): Promise<T> {
  
  55
  
  		const merged = mergedTokenSource(token);
  
  56
  
  		this.inProgress.add(merged);
  
  57
  
  		const result = await fn(merged.token);
  
  58
  
  		this.inProgress.delete(merged);
  
  59
  
  60
  
  		return result;
  
  61
  
  	}
  
  62
  >
  
fileSearch.ts ×31

  63
  >
  	private dispose() {
  
  64
  >
  		this.inProgress.forEach(engine => engine.cancel());
  
  65
  >
  	}
  
  66
  >
  }
  
  67
  >
  
  68
  
  function mergedTokenSource(token: CancellationToken): CancellationTokenSource {
  
  69
  
  	const tokenSource = new CancellationTokenSource();
  
  70
  
  	token.onCancellationRequested(() => tokenSource.cancel());
  
  71
  
  72
  
  	return tokenSource;
  
  73
  
  }