Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement preview on highlighting quickpick in quick search #202306

Merged
merged 9 commits into from
Jan 18, 2024
Merged

Implement preview on highlighting quickpick in quick search #202306

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
41b4581
Implement preview on highlighting quickpick in quick search
andreamah Jan 12, 2024
fa466c9
reduce diff by only extracting editorViewState
andreamah Jan 12, 2024
eb8e756
move EditorViewState to src/vs/workbench/browser/quickaccess.ts
andreamah Jan 15, 2024
450696e
Merge branch 'main' into andreamah/issue191259
bpasero Jan 16, 2024
1c09a05
Fix item undefined error
andreamah Jan 16, 2024
142bf28
use item?.match
andreamah Jan 16, 2024
53c1e16
Implement preview on highlighting quickpick in quick search
andreamah Jan 16, 2024
79c82bc
Implement preview on highlighting quickpick in quick search
andreamah Jan 17, 2024
96cc606
viewsservice conflict
andreamah Jan 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 49 additions & 37 deletions src/vs/workbench/contrib/search/browser/anythingQuickAccess.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,46 @@ function isEditorSymbolQuickPickItem(pick?: IAnythingQuickPickItem): pick is IEd
return !!candidate?.range && !!candidate.resource;
}

export class EditorViewState {
bpasero marked this conversation as resolved.
Show resolved Hide resolved
private _editorViewState: {
editor: EditorInput;
group: IEditorGroup;
state: ICodeEditorViewState | IDiffEditorViewState | undefined;
} | undefined = undefined;

constructor(private readonly editorService: IEditorService) { }

set(): void {
if (this._editorViewState) {
return; // return early if already done
}

const activeEditorPane = this.editorService.activeEditorPane;
if (activeEditorPane) {
this._editorViewState = {
group: activeEditorPane.group,
editor: activeEditorPane.input,
state: getIEditor(activeEditorPane.getControl())?.saveViewState() ?? undefined,
};
}
}

async restore(): Promise<void> {
if (this._editorViewState) {
const options: IEditorOptions = {
viewState: this._editorViewState.state,
preserveFocus: true /* import to not close the picker as a result */
};

await this._editorViewState.group.openEditor(this._editorViewState.editor, options);
}
}

reset() {
this._editorViewState = undefined;
}
}

export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnythingQuickPickItem> {

static PREFIX = '';
Expand All @@ -89,11 +129,7 @@ export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnyt

picker: IQuickPick<IAnythingQuickPickItem> | undefined = undefined;

editorViewState: {
editor: EditorInput;
group: IEditorGroup;
state: ICodeEditorViewState | IDiffEditorViewState | undefined;
} | undefined = undefined;
editorViewState: EditorViewState;

scorerCache: FuzzyScorerCache = Object.create(null);
fileQueryCache: FileQueryCacheState | undefined = undefined;
Expand All @@ -106,7 +142,9 @@ export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnyt

isQuickNavigating: boolean | undefined = undefined;

constructor(private readonly provider: AnythingQuickAccessProvider, private readonly editorService: IEditorService) { }
constructor(private readonly provider: AnythingQuickAccessProvider, editorService: IEditorService) {
this.editorViewState = new EditorViewState(editorService);
}

set(picker: IQuickPick<IAnythingQuickPickItem>): void {

Expand All @@ -131,33 +169,7 @@ export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnyt
this.lastFilter = undefined;
this.lastRange = undefined;
this.lastGlobalPicks = undefined;
this.editorViewState = undefined;
}

rememberEditorViewState(): void {
if (this.editorViewState) {
return; // return early if already done
}

const activeEditorPane = this.editorService.activeEditorPane;
if (activeEditorPane) {
this.editorViewState = {
group: activeEditorPane.group,
editor: activeEditorPane.input,
state: getIEditor(activeEditorPane.getControl())?.saveViewState() ?? undefined,
};
}
}

async restoreEditorViewState(): Promise<void> {
if (this.editorViewState) {
const options: IEditorOptions = {
viewState: this.editorViewState.state,
preserveFocus: true /* import to not close the picker as a result */
};

await this.editorViewState.group.openEditor(this.editorViewState.editor, options);
}
this.editorViewState.reset();
}
}(this, this.editorService);

Expand Down Expand Up @@ -237,7 +249,7 @@ export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnyt
// could mean the user clicked into the editor directly.
disposables.add(Event.once(picker.onDidHide)(({ reason }) => {
if (reason === QuickInputHideReason.Gesture) {
this.pickState.restoreEditorViewState();
this.pickState.editorViewState.restore();
}
}));

Expand All @@ -259,7 +271,7 @@ export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnyt
}

// we must remember our curret view state to be able to restore
this.pickState.rememberEditorViewState();
this.pickState.editorViewState.set();

// Reveal
activeEditorControl.revealRangeInCenter(pick.range.selection, ScrollType.Smooth);
Expand Down Expand Up @@ -871,7 +883,7 @@ export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnyt
try {

// we must remember our curret view state to be able to restore
this.pickState.rememberEditorViewState();
this.pickState.editorViewState.set();

// open it
await this.editorService.openEditor({
Expand Down Expand Up @@ -1039,7 +1051,7 @@ export class AnythingQuickAccessProvider extends PickerQuickAccessProvider<IAnyt

// Restore any view state if the target is the side group
if (targetGroup === SIDE_GROUP) {
await this.pickState.restoreEditorViewState();
await this.pickState.editorViewState.restore();
}

// Open editor (typed)
Expand Down
58 changes: 48 additions & 10 deletions src/vs/workbench/contrib/search/browser/quickTextSearch/textSearchQuickAccess.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { ILabelService } from 'vs/platform/label/common/label';
import { WorkbenchCompressibleObjectTree, getSelectionKeyboardEvent } from 'vs/platform/list/browser/listService';
import { FastAndSlowPicks, IPickerQuickAccessItem, PickerQuickAccessProvider, Picks, TriggerAction } from 'vs/platform/quickinput/browser/pickerQuickAccess';
import { DefaultQuickAccessFilterValue, IQuickAccessProviderRunOptions } from 'vs/platform/quickinput/common/quickAccess';
import { IKeyMods, IQuickPick, IQuickPickItem, IQuickPickSeparator } from 'vs/platform/quickinput/common/quickInput';
import { IKeyMods, IQuickPick, IQuickPickItem, IQuickPickSeparator, QuickInputHideReason } from 'vs/platform/quickinput/common/quickInput';
import { IWorkspaceContextService, IWorkspaceFolder } from 'vs/platform/workspace/common/workspace';
import { IWorkbenchEditorConfiguration } from 'vs/workbench/common/editor';
import { IViewsService } from 'vs/workbench/services/views/common/viewsService';
Expand All @@ -28,6 +28,8 @@ import { IWorkbenchSearchConfiguration, getOutOfWorkspaceEditorResources } from
import { ACTIVE_GROUP, IEditorService, SIDE_GROUP } from 'vs/workbench/services/editor/common/editorService';
import { ITextQueryBuilderOptions, QueryBuilder } from 'vs/workbench/services/search/common/queryBuilder';
import { IPatternInfo, ITextQuery, VIEW_ID } from 'vs/workbench/services/search/common/search';
import { EditorViewState } from 'vs/workbench/contrib/search/browser/anythingQuickAccess';
import { Event } from 'vs/base/common/event';

export const TEXT_SEARCH_QUICK_ACCESS_PREFIX = '%';

Expand All @@ -42,9 +44,16 @@ const DEFAULT_TEXT_QUERY_BUILDER_OPTIONS: ITextQueryBuilderOptions = {
const MAX_FILES_SHOWN = 30;
const MAX_RESULTS_PER_FILE = 10;

export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuickAccessItem> {
interface ITextSearchQuickAccessItem extends IPickerQuickAccessItem {
match?: Match;
}
export class TextSearchQuickAccess extends PickerQuickAccessProvider<ITextSearchQuickAccessItem> {
private queryBuilder: QueryBuilder;
private searchModel: SearchModel;
private storedOriginalLocation = false;
private readonly editorViewState = new EditorViewState(
this._editorService
);

private _getTextQueryBuilderOptions(charsPerLine: number): ITextQueryBuilderOptions {
return {
Expand All @@ -68,7 +77,7 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
@IEditorService private readonly _editorService: IEditorService,
@ILabelService private readonly _labelService: ILabelService,
@IViewsService private readonly _viewsService: IViewsService,
@IConfigurationService private readonly _configurationService: IConfigurationService,
@IConfigurationService private readonly _configurationService: IConfigurationService
) {
super(TEXT_SEARCH_QUICK_ACCESS_PREFIX, { canAcceptInBackground: true, shouldSkipTrimPickFilter: true });

Expand All @@ -81,19 +90,47 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
super.dispose();
}

override provide(picker: IQuickPick<IPickerQuickAccessItem>, token: CancellationToken, runOptions?: IQuickAccessProviderRunOptions): IDisposable {
override provide(picker: IQuickPick<ITextSearchQuickAccessItem>, token: CancellationToken, runOptions?: IQuickAccessProviderRunOptions): IDisposable {
const disposables = new DisposableStore();
if (TEXT_SEARCH_QUICK_ACCESS_PREFIX.length < picker.value.length) {
picker.valueSelection = [TEXT_SEARCH_QUICK_ACCESS_PREFIX.length, picker.value.length];
}
picker.customButton = true;
picker.customLabel = '$(link-external)';
picker.onDidCustom(() => {
disposables.add(picker.onDidCustom(() => {
this.moveToSearchViewlet(this.searchModel, undefined);
picker.hide();
});
}));
disposables.add(picker.onDidChangeActive(() => {
const [item] = picker.activeItems;

if (item.match) {
// only store location once, or else it will store new state every time we change active pick
if (!this.storedOriginalLocation) {
// we must remember our curret view state to be able to restore
this.editorViewState.set();
this.storedOriginalLocation = true;
}
// open it
this._editorService.openEditor({
resource: item.match.parent().resource,
options: { preserveFocus: true, revealIfOpened: true, ignoreError: true, selection: item.match.range() }
});
}
}));

disposables.add(Event.once(picker.onDidHide)(({ reason }) => {
// Restore view state upon cancellation if we changed it
// but only when the picker was closed via explicit user
// gesture and not e.g. when focus was lost because that
// could mean the user clicked into the editor directly.
if (reason === QuickInputHideReason.Gesture) {
this.editorViewState.restore();
}
this.searchModel.searchResult.toggleHighlights(false);
}));

disposables.add(super.provide(picker, token, runOptions));
disposables.add(picker.onDidHide(() => this.searchModel.searchResult.toggleHighlights(false)));
disposables.add(picker.onDidAccept(() => this.searchModel.searchResult.toggleHighlights(false)));
return disposables;
}
Expand Down Expand Up @@ -164,11 +201,11 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
}
}

private _getPicksFromMatches(matches: FileMatch[], limit: number): (IQuickPickSeparator | IPickerQuickAccessItem)[] {
private _getPicksFromMatches(matches: FileMatch[], limit: number): (IQuickPickSeparator | ITextSearchQuickAccessItem)[] {
matches = matches.sort(searchComparer);

const files = matches.length > limit ? matches.slice(0, limit) : matches;
const picks: Array<IPickerQuickAccessItem | IQuickPickSeparator> = [];
const picks: Array<ITextSearchQuickAccessItem | IQuickPickSeparator> = [];

for (let fileIndex = 0; fileIndex < matches.length; fileIndex++) {
if (fileIndex === limit) {
Expand Down Expand Up @@ -245,7 +282,8 @@ export class TextSearchQuickAccess extends PickerQuickAccessProvider<IPickerQuic
trigger: (): TriggerAction => {
this.moveToSearchViewlet(this.searchModel, element);
return TriggerAction.CLOSE_PICKER;
}
},
match: element
});
}
}
Expand Down
Loading