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

Re-use DisposableStores when rendering explorer items #163380

Merged
merged 1 commit into from Oct 12, 2022
Merged

Re-use DisposableStores when rendering explorer items #163380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 18 additions & 28 deletions src/vs/workbench/contrib/files/browser/views/explorerViewer.ts
View file
Open in desktop
Expand Up @@ -255,9 +255,9 @@ export class CompressedNavigationController implements ICompressedNavigationCont
}

export interface IFileTemplateData {
elementDisposable: IDisposable;
label: IResourceLabel;
container: HTMLElement;
readonly elementDisposables: DisposableStore;
readonly label: IResourceLabel;
readonly container: HTMLElement;
}

export class FilesRenderer implements ICompressibleTreeRenderer<ExplorerItem, FuzzyScore, IFileTemplateData>, IListAccessibilityProvider<ExplorerItem>, IDisposable {
Expand Down Expand Up @@ -312,14 +312,12 @@ export class FilesRenderer implements ICompressibleTreeRenderer<ExplorerItem, Fu
}

renderTemplate(container: HTMLElement): IFileTemplateData {
const elementDisposable = Disposable.None;
const label = this.labels.create(container, { supportHighlights: true });

return { elementDisposable, label, container };
return { elementDisposables: new DisposableStore(), label, container };
}

renderElement(node: ITreeNode<ExplorerItem, FuzzyScore>, index: number, templateData: IFileTemplateData): void {
templateData.elementDisposable.dispose();
const stat = node.element;
const editableData = this.explorerService.getEditableData(stat);

Expand All @@ -328,19 +326,17 @@ export class FilesRenderer implements ICompressibleTreeRenderer<ExplorerItem, Fu
// File Label
if (!editableData) {
templateData.label.element.style.display = 'flex';
templateData.elementDisposable = this.renderStat(stat, stat.name, undefined, node.filterData, templateData);
this.renderStat(stat, stat.name, undefined, node.filterData, templateData);
}

// Input Box
else {
templateData.label.element.style.display = 'none';
templateData.elementDisposable = this.renderInputBox(templateData.container, stat, editableData);
templateData.elementDisposables.add(this.renderInputBox(templateData.container, stat, editableData));
}
}

renderCompressedElements(node: ITreeNode<ICompressedTreeNode<ExplorerItem>, FuzzyScore>, index: number, templateData: IFileTemplateData, height: number | undefined): void {
templateData.elementDisposable.dispose();

const stat = node.element.elements[node.element.elements.length - 1];
const editable = node.element.elements.filter(e => this.explorerService.isEditable(e));
const editableData = editable.length === 0 ? undefined : this.explorerService.getEditableData(editable[0]);
Expand All @@ -350,42 +346,38 @@ export class FilesRenderer implements ICompressibleTreeRenderer<ExplorerItem, Fu
templateData.label.element.classList.add('compressed');
templateData.label.element.style.display = 'flex';

const disposables = new DisposableStore();
const id = `compressed-explorer_${CompressedNavigationController.ID++}`;

const label = node.element.elements.map(e => e.name);
disposables.add(this.renderStat(stat, label, id, node.filterData, templateData));
this.renderStat(stat, label, id, node.filterData, templateData);

const compressedNavigationController = new CompressedNavigationController(id, node.element.elements, templateData, node.depth, node.collapsed);
disposables.add(compressedNavigationController);
templateData.elementDisposables.add(compressedNavigationController);
this.compressedNavigationControllers.set(stat, compressedNavigationController);

// accessibility
disposables.add(this._onDidChangeActiveDescendant.add(compressedNavigationController.onDidChange));
templateData.elementDisposables.add(this._onDidChangeActiveDescendant.add(compressedNavigationController.onDidChange));

disposables.add(DOM.addDisposableListener(templateData.container, 'mousedown', e => {
templateData.elementDisposables.add(DOM.addDisposableListener(templateData.container, 'mousedown', e => {
const result = getIconLabelNameFromHTMLElement(e.target);

if (result) {
compressedNavigationController.setIndex(result.index);
}
}));

disposables.add(toDisposable(() => this.compressedNavigationControllers.delete(stat)));

templateData.elementDisposable = disposables;
templateData.elementDisposables.add(toDisposable(() => this.compressedNavigationControllers.delete(stat)));
}

// Input Box
else {
templateData.label.element.classList.remove('compressed');
templateData.label.element.style.display = 'none';
templateData.elementDisposable = this.renderInputBox(templateData.container, editable[0], editableData);
templateData.elementDisposables.add(this.renderInputBox(templateData.container, editable[0], editableData));
}
}

private renderStat(stat: ExplorerItem, label: string | string[], domId: string | undefined, filterData: FuzzyScore | undefined, templateData: IFileTemplateData): IDisposable {
const elementDisposables = new DisposableStore();
private renderStat(stat: ExplorerItem, label: string | string[], domId: string | undefined, filterData: FuzzyScore | undefined, templateData: IFileTemplateData): void {
templateData.label.element.style.display = 'flex';
const extraClasses = ['explorer-item'];
if (this.explorerService.isCut(stat)) {
Expand Down Expand Up @@ -421,18 +413,16 @@ export class FilesRenderer implements ICompressibleTreeRenderer<ExplorerItem, Fu
});
};

elementDisposables.add(this.themeService.onDidFileIconThemeChange(() => setResourceData()));
templateData.elementDisposables.add(this.themeService.onDidFileIconThemeChange(() => setResourceData()));
setResourceData();

elementDisposables.add(templateData.label.onDidRender(() => {
templateData.elementDisposables.add(templateData.label.onDidRender(() => {
try {
this.updateWidth(stat);
} catch (e) {
// noop since the element might no longer be in the tree, no update of width necessary
}
}));

return elementDisposables;
}

private renderInputBox(container: HTMLElement, stat: ExplorerItem, editableData: IEditableData): IDisposable {
Expand Down Expand Up @@ -560,15 +550,15 @@ export class FilesRenderer implements ICompressibleTreeRenderer<ExplorerItem, Fu
}

disposeElement(element: ITreeNode<ExplorerItem, FuzzyScore>, index: number, templateData: IFileTemplateData): void {
templateData.elementDisposable.dispose();
templateData.elementDisposables.clear();
}

disposeCompressedElements(node: ITreeNode<ICompressedTreeNode<ExplorerItem>, FuzzyScore>, index: number, templateData: IFileTemplateData): void {
templateData.elementDisposable.dispose();
templateData.elementDisposables.clear();
}

disposeTemplate(templateData: IFileTemplateData): void {
templateData.elementDisposable.dispose();
templateData.elementDisposables.dispose();
templateData.label.dispose();
}

Expand Down
4 changes: 2 additions & 2 deletions src/vs/workbench/contrib/files/test/browser/explorerView.test.ts
View file
Open in desktop
Expand Up @@ -12,7 +12,7 @@ import { getContext } from 'vs/workbench/contrib/files/browser/views/explorerVie
import { listInvalidItemForeground } from 'vs/platform/theme/common/colorRegistry';
import { CompressedNavigationController } from 'vs/workbench/contrib/files/browser/views/explorerViewer';
import * as dom from 'vs/base/browser/dom';
import { Disposable } from 'vs/base/common/lifecycle';
import { DisposableStore } from 'vs/base/common/lifecycle';
import { provideDecorations } from 'vs/workbench/contrib/files/browser/views/explorerDecorationsProvider';
import { TestConfigurationService } from 'vs/platform/configuration/test/common/testConfigurationService';
const $ = dom.$;
Expand Down Expand Up @@ -84,7 +84,7 @@ suite('Files - ExplorerView', () => {

const navigationController = new CompressedNavigationController('id', [s1, s2, s3], {
container,
elementDisposable: Disposable.None,
elementDisposables: new DisposableStore(),
label: <any>{
container: label,
onDidRender: emitter.event
Expand Down