/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ // import 'vs/css!./media/tree'; import { IDisposable, dispose, Disposable, toDisposable, DisposableStore, } from '../../../../../vs/base/common/lifecycle'; import { IListOptions, List, IListStyles, MouseController, DefaultKeyboardNavigationDelegate, isInputElement, isMonacoEditor, } from '../../../../../vs/base/browser/ui/list/listWidget'; import { IListVirtualDelegate, IListRenderer, IListMouseEvent, IListDragAndDrop, IListDragOverReaction, IKeyboardNavigationLabelProvider, IIdentityProvider, IKeyboardNavigationDelegate, } from '../../../../../vs/base/browser/ui/list/list'; import { append, $, getDomNodePagePosition, hasParentWithClass, createStyleSheet, clearNode, } from '../../../../../vs/base/browser/dom'; import { Event, Relay, Emitter, EventBufferer, } from '../../../../../vs/base/common/event'; import { StandardKeyboardEvent } from '../../../../../vs/base/browser/keyboardEvent'; import { KeyCode } from '../../../../../vs/base/common/keyCodes'; import { ITreeModel, ITreeNode, ITreeRenderer, ITreeEvent, ITreeMouseEvent, ITreeFilter, ICollapseStateChangeEvent, ITreeDragAndDrop, TreeDragOverBubble, TreeVisibility, TreeFilterResult, ITreeModelSpliceEvent, TreeMouseEventTarget, } from '../../../../../vs/base/browser/ui/tree/tree'; import { ISpliceable } from '../../../../../vs/base/common/sequence'; import { IDragAndDropData, StaticDND, DragAndDropData, } from '../../../../../vs/base/browser/dnd'; import { range, equals, distinctES6, } from '../../../../../vs/base/common/arrays'; import { ElementsDragAndDropData } from '../../../../../vs/base/browser/ui/list/listView'; import { domEvent } from '../../../../../vs/base/browser/event'; import { fuzzyScore, FuzzyScore } from '../../../../../vs/base/common/filters'; import { getVisibleState, isFilterResult, } from '../../../../../vs/base/browser/ui/tree/indexTreeModel'; import { localize } from '../../../../../vs/nls'; import { disposableTimeout } from '../../../../../vs/base/common/async'; import { isMacintosh } from '../../../../../vs/base/common/platform'; import { clamp } from '../../../../../vs/base/common/numbers'; import { SetMap } from '../../../../../vs/base/common/collections'; import { treeItemExpandedIcon, treeFilterOnTypeOnIcon, treeFilterOnTypeOffIcon, treeFilterClearIcon, } from '../../../../../vs/base/browser/ui/tree/treeIcons'; class TreeElementsDragAndDropData< T, TFilterData, TContext > extends ElementsDragAndDropData { constructor( private data: ElementsDragAndDropData, TContext> ) { super(data.elements.map((node) => node.element)); } } function asTreeDragAndDropData( data: IDragAndDropData ): IDragAndDropData { if (data instanceof ElementsDragAndDropData) { return new TreeElementsDragAndDropData(data); } return data; } class TreeNodeListDragAndDrop implements IListDragAndDrop> { private autoExpandNode: ITreeNode | undefined; private autoExpandDisposable: IDisposable = Disposable.None; constructor( private modelProvider: () => ITreeModel, private dnd: ITreeDragAndDrop ) {} getDragURI(node: ITreeNode): string | null { return this.dnd.getDragURI(node.element); } getDragLabel( nodes: ITreeNode[], originalEvent: DragEvent ): string | undefined { if (this.dnd.getDragLabel) { return this.dnd.getDragLabel( nodes.map((node) => node.element), originalEvent ); } return undefined; } onDragStart(data: IDragAndDropData, originalEvent: DragEvent): void { if (this.dnd.onDragStart) { this.dnd.onDragStart(asTreeDragAndDropData(data), originalEvent); } } onDragOver( data: IDragAndDropData, targetNode: ITreeNode | undefined, targetIndex: number | undefined, originalEvent: DragEvent, raw = true ): boolean | IListDragOverReaction { const result = this.dnd.onDragOver( asTreeDragAndDropData(data), targetNode && targetNode.element, targetIndex, originalEvent ); const didChangeAutoExpandNode = this.autoExpandNode !== targetNode; if (didChangeAutoExpandNode) { this.autoExpandDisposable.dispose(); this.autoExpandNode = targetNode; } if (typeof targetNode === 'undefined') { return result; } if ( didChangeAutoExpandNode && typeof result !== 'boolean' && result.autoExpand ) { this.autoExpandDisposable = disposableTimeout(() => { const model = this.modelProvider(); const ref = model.getNodeLocation(targetNode); if (model.isCollapsed(ref)) { model.setCollapsed(ref, false); } this.autoExpandNode = undefined; }, 500); } if ( typeof result === 'boolean' || !result.accept || typeof result.bubble === 'undefined' || result.feedback ) { if (!raw) { const accept = typeof result === 'boolean' ? result : result.accept; const effect = typeof result === 'boolean' ? undefined : result.effect; return { accept, effect, feedback: [targetIndex!] }; } return result; } if (result.bubble === TreeDragOverBubble.Up) { const model = this.modelProvider(); const ref = model.getNodeLocation(targetNode); const parentRef = model.getParentNodeLocation(ref); const parentNode = model.getNode(parentRef); const parentIndex = parentRef && model.getListIndex(parentRef); return this.onDragOver( data, parentNode, parentIndex, originalEvent, false ); } const model = this.modelProvider(); const ref = model.getNodeLocation(targetNode); const start = model.getListIndex(ref); const length = model.getListRenderCount(ref); return { ...result, feedback: range(start, start + length) }; } drop( data: IDragAndDropData, targetNode: ITreeNode | undefined, targetIndex: number | undefined, originalEvent: DragEvent ): void { this.autoExpandDisposable.dispose(); this.autoExpandNode = undefined; this.dnd.drop( asTreeDragAndDropData(data), targetNode && targetNode.element, targetIndex, originalEvent ); } onDragEnd(originalEvent: DragEvent): void { if (this.dnd.onDragEnd) { this.dnd.onDragEnd(originalEvent); } } } function asListOptions( modelProvider: () => ITreeModel, options?: IAbstractTreeOptions ): IListOptions> | undefined { return ( options && { ...options, identityProvider: options.identityProvider && { getId(el) { return options.identityProvider!.getId(el.element); }, }, dnd: options.dnd && new TreeNodeListDragAndDrop(modelProvider, options.dnd), multipleSelectionController: options.multipleSelectionController && { isSelectionSingleChangeEvent(e) { return options.multipleSelectionController!.isSelectionSingleChangeEvent( { ...e, element: e.element, } as any ); }, isSelectionRangeChangeEvent(e) { return options.multipleSelectionController!.isSelectionRangeChangeEvent( { ...e, element: e.element, } as any ); }, }, accessibilityProvider: options.accessibilityProvider && { ...options.accessibilityProvider, getSetSize(node) { const model = modelProvider(); const ref = model.getNodeLocation(node); const parentRef = model.getParentNodeLocation(ref); const parentNode = model.getNode(parentRef); return parentNode.visibleChildrenCount; }, getPosInSet(node) { return node.visibleChildIndex + 1; }, isChecked: options.accessibilityProvider && options.accessibilityProvider.isChecked ? (node) => { return options.accessibilityProvider!.isChecked!(node.element); } : undefined, getRole: options.accessibilityProvider && options.accessibilityProvider.getRole ? (node) => { return options.accessibilityProvider!.getRole!(node.element); } : () => 'treeitem', getAriaLabel(e) { return options.accessibilityProvider!.getAriaLabel(e.element); }, getWidgetAriaLabel() { return options.accessibilityProvider!.getWidgetAriaLabel(); }, getWidgetRole: options.accessibilityProvider && options.accessibilityProvider.getWidgetRole ? () => options.accessibilityProvider!.getWidgetRole!() : () => 'tree', getAriaLevel: options.accessibilityProvider && options.accessibilityProvider.getAriaLevel ? (node) => options.accessibilityProvider!.getAriaLevel!(node.element) : (node) => { return node.depth; }, getActiveDescendantId: options.accessibilityProvider.getActiveDescendantId && ((node) => { return options.accessibilityProvider!.getActiveDescendantId!( node.element ); }), }, keyboardNavigationLabelProvider: options.keyboardNavigationLabelProvider && { ...options.keyboardNavigationLabelProvider, getKeyboardNavigationLabel(node) { return options.keyboardNavigationLabelProvider!.getKeyboardNavigationLabel( node.element ); }, }, enableKeyboardNavigation: options.simpleKeyboardNavigation, } ); } export class ComposedTreeDelegate implements IListVirtualDelegate { constructor(private delegate: IListVirtualDelegate) {} getHeight(element: N): number { return this.delegate.getHeight(element.element); } getTemplateId(element: N): string { return this.delegate.getTemplateId(element.element); } hasDynamicHeight(element: N): boolean { return ( !!this.delegate.hasDynamicHeight && this.delegate.hasDynamicHeight(element.element) ); } setDynamicHeight(element: N, height: number): void { if (this.delegate.setDynamicHeight) { this.delegate.setDynamicHeight(element.element, height); } } } interface ITreeListTemplateData { readonly container: HTMLElement; readonly indent: HTMLElement; readonly twistie: HTMLElement; indentGuidesDisposable: IDisposable; readonly templateData: T; } export enum RenderIndentGuides { None = 'none', OnHover = 'onHover', Always = 'always', } interface ITreeRendererOptions { readonly indent?: number; readonly renderIndentGuides?: RenderIndentGuides; // TODO@joao replace this with collapsible: boolean | 'ondemand' readonly hideTwistiesOfChildlessElements?: boolean; } interface IRenderData { templateData: ITreeListTemplateData; height: number; } interface Collection { readonly elements: T[]; readonly onDidChange: Event; } class EventCollection implements Collection { readonly onDidChange: Event; get elements(): T[] { return this._elements; } constructor(onDidChange: Event, private _elements: T[] = []) { this.onDidChange = Event.forEach( onDidChange, (elements) => (this._elements = elements) ); } } class TreeRenderer implements IListRenderer< ITreeNode, ITreeListTemplateData > { private static readonly DefaultIndent = 8; readonly templateId: string; private renderedElements = new Map>(); private renderedNodes = new Map< ITreeNode, IRenderData >(); private indent: number = TreeRenderer.DefaultIndent; private hideTwistiesOfChildlessElements: boolean = false; private shouldRenderIndentGuides: boolean = false; private renderedIndentGuides = new SetMap< ITreeNode, HTMLDivElement >(); private activeIndentNodes = new Set>(); private indentGuidesDisposable: IDisposable = Disposable.None; private readonly disposables = new DisposableStore(); constructor( private renderer: ITreeRenderer, private modelProvider: () => ITreeModel, onDidChangeCollapseState: Event>, private activeNodes: Collection>, options: ITreeRendererOptions = {} ) { this.templateId = renderer.templateId; this.updateOptions(options); Event.map(onDidChangeCollapseState, (e) => e.node)( this.onDidChangeNodeTwistieState, this, this.disposables ); if (renderer.onDidChangeTwistieState) { renderer.onDidChangeTwistieState( this.onDidChangeTwistieState, this, this.disposables ); } } updateOptions(options: ITreeRendererOptions = {}): void { if (typeof options.indent !== 'undefined') { this.indent = clamp(options.indent, 0, 40); } if (typeof options.renderIndentGuides !== 'undefined') { const shouldRenderIndentGuides = options.renderIndentGuides !== RenderIndentGuides.None; if (shouldRenderIndentGuides !== this.shouldRenderIndentGuides) { this.shouldRenderIndentGuides = shouldRenderIndentGuides; this.indentGuidesDisposable.dispose(); if (shouldRenderIndentGuides) { const disposables = new DisposableStore(); this.activeNodes.onDidChange( this._onDidChangeActiveNodes, this, disposables ); this.indentGuidesDisposable = disposables; this._onDidChangeActiveNodes(this.activeNodes.elements); } } } if (typeof options.hideTwistiesOfChildlessElements !== 'undefined') { this.hideTwistiesOfChildlessElements = options.hideTwistiesOfChildlessElements; } } renderTemplate(container: HTMLElement): ITreeListTemplateData { const el = append(container, $('.monaco-tl-row')); const indent = append(el, $('.monaco-tl-indent')); const twistie = append(el, $('.monaco-tl-twistie')); const contents = append(el, $('.monaco-tl-contents')); const templateData = this.renderer.renderTemplate(contents); return { container, indent, twistie, indentGuidesDisposable: Disposable.None, templateData, }; } renderElement( node: ITreeNode, index: number, templateData: ITreeListTemplateData, height: number | undefined ): void { if (typeof height === 'number') { this.renderedNodes.set(node, { templateData, height }); this.renderedElements.set(node.element, node); } const indent = TreeRenderer.DefaultIndent + (node.depth - 1) * this.indent; templateData.twistie.style.paddingLeft = `${indent}px`; templateData.indent.style.width = `${indent + this.indent - 16}px`; this.renderTwistie(node, templateData); if (typeof height === 'number') { this.renderIndentGuides(node, templateData); } this.renderer.renderElement(node, index, templateData.templateData, height); } disposeElement( node: ITreeNode, index: number, templateData: ITreeListTemplateData, height: number | undefined ): void { templateData.indentGuidesDisposable.dispose(); if (this.renderer.disposeElement) { this.renderer.disposeElement( node, index, templateData.templateData, height ); } if (typeof height === 'number') { this.renderedNodes.delete(node); this.renderedElements.delete(node.element); } } disposeTemplate(templateData: ITreeListTemplateData): void { this.renderer.disposeTemplate(templateData.templateData); } private onDidChangeTwistieState(element: T): void { const node = this.renderedElements.get(element); if (!node) { return; } this.onDidChangeNodeTwistieState(node); } private onDidChangeNodeTwistieState(node: ITreeNode): void { const data = this.renderedNodes.get(node); if (!data) { return; } this.renderTwistie(node, data.templateData); this._onDidChangeActiveNodes(this.activeNodes.elements); this.renderIndentGuides(node, data.templateData); } private renderTwistie( node: ITreeNode, templateData: ITreeListTemplateData ) { templateData.twistie.classList.remove( ...treeItemExpandedIcon.classNamesArray ); let twistieRendered = false; if (this.renderer.renderTwistie) { twistieRendered = this.renderer.renderTwistie( node.element, templateData.twistie ); } if ( node.collapsible && (!this.hideTwistiesOfChildlessElements || node.visibleChildrenCount > 0) ) { if (!twistieRendered) { templateData.twistie.classList.add( ...treeItemExpandedIcon.classNamesArray ); } templateData.twistie.classList.add('collapsible'); templateData.twistie.classList.toggle('collapsed', node.collapsed); } else { templateData.twistie.classList.remove('collapsible', 'collapsed'); } if (node.collapsible) { templateData.container.setAttribute( 'aria-expanded', String(!node.collapsed) ); } else { templateData.container.removeAttribute('aria-expanded'); } } private renderIndentGuides( target: ITreeNode, templateData: ITreeListTemplateData ): void { clearNode(templateData.indent); templateData.indentGuidesDisposable.dispose(); if (!this.shouldRenderIndentGuides) { return; } const disposableStore = new DisposableStore(); const model = this.modelProvider(); let node = target; while (true) { const ref = model.getNodeLocation(node); const parentRef = model.getParentNodeLocation(ref); if (!parentRef) { break; } const parent = model.getNode(parentRef); const guide = $('.indent-guide', { style: `width: ${this.indent}px`, }); if (this.activeIndentNodes.has(parent)) { guide.classList.add('active'); } if (templateData.indent.childElementCount === 0) { templateData.indent.appendChild(guide); } else { templateData.indent.insertBefore( guide, templateData.indent.firstElementChild ); } this.renderedIndentGuides.add(parent, guide); disposableStore.add( toDisposable(() => this.renderedIndentGuides.delete(parent, guide)) ); node = parent; } templateData.indentGuidesDisposable = disposableStore; } private _onDidChangeActiveNodes(nodes: ITreeNode[]): void { if (!this.shouldRenderIndentGuides) { return; } const set = new Set>(); const model = this.modelProvider(); nodes.forEach((node) => { const ref = model.getNodeLocation(node); try { const parentRef = model.getParentNodeLocation(ref); if (node.collapsible && node.children.length > 0 && !node.collapsed) { set.add(node); } else if (parentRef) { set.add(model.getNode(parentRef)); } } catch { // noop } }); this.activeIndentNodes.forEach((node) => { if (!set.has(node)) { this.renderedIndentGuides.forEach(node, (line) => line.classList.remove('active') ); } }); set.forEach((node) => { if (!this.activeIndentNodes.has(node)) { this.renderedIndentGuides.forEach(node, (line) => line.classList.add('active') ); } }); this.activeIndentNodes = set; } dispose(): void { this.renderedNodes.clear(); this.renderedElements.clear(); this.indentGuidesDisposable.dispose(); dispose(this.disposables); } } export type LabelFuzzyScore = { label: string; score: FuzzyScore }; class TypeFilter implements ITreeFilter, IDisposable { private _totalCount = 0; get totalCount(): number { return this._totalCount; } private _matchCount = 0; get matchCount(): number { return this._matchCount; } private _pattern: string = ''; private _lowercasePattern: string = ''; private readonly disposables = new DisposableStore(); set pattern(pattern: string) { this._pattern = pattern; this._lowercasePattern = pattern.toLowerCase(); } constructor( private tree: AbstractTree, private keyboardNavigationLabelProvider: IKeyboardNavigationLabelProvider, private _filter?: ITreeFilter ) { tree.onWillRefilter(this.reset, this, this.disposables); } filter( element: T, parentVisibility: TreeVisibility ): TreeFilterResult { if (this._filter) { const result = this._filter.filter(element, parentVisibility); if (this.tree.options.simpleKeyboardNavigation) { return result; } let visibility: TreeVisibility; if (typeof result === 'boolean') { visibility = result ? TreeVisibility.Visible : TreeVisibility.Hidden; } else if (isFilterResult(result)) { visibility = getVisibleState(result.visibility); } else { visibility = result; } if (visibility === TreeVisibility.Hidden) { return false; } } this._totalCount++; if (this.tree.options.simpleKeyboardNavigation || !this._pattern) { this._matchCount++; return { data: FuzzyScore.Default, visibility: true }; } const label = this.keyboardNavigationLabelProvider.getKeyboardNavigationLabel(element); const labels = Array.isArray(label) ? label : [label]; for (const l of labels) { const labelStr = l && l.toString(); if (typeof labelStr === 'undefined') { return { data: FuzzyScore.Default, visibility: true }; } const score = fuzzyScore( this._pattern, this._lowercasePattern, 0, labelStr, labelStr.toLowerCase(), 0, true ); if (score) { this._matchCount++; return labels.length === 1 ? { data: score, visibility: true } : { data: { label: labelStr, score: score }, visibility: true }; } } if (this.tree.options.filterOnType) { return TreeVisibility.Recurse; } else { return { data: FuzzyScore.Default, visibility: true }; } } private reset(): void { this._totalCount = 0; this._matchCount = 0; } dispose(): void { dispose(this.disposables); } } class TypeFilterController implements IDisposable { private _enabled = false; get enabled(): boolean { return this._enabled; } private _pattern = ''; get pattern(): string { return this._pattern; } private _filterOnType: boolean; get filterOnType(): boolean { return this._filterOnType; } private _empty: boolean = false; private readonly _onDidChangeEmptyState = new Emitter(); private positionClassName = 'ne'; private domNode: HTMLElement; private messageDomNode: HTMLElement; private labelDomNode: HTMLElement; private filterOnTypeDomNode: HTMLInputElement; private clearDomNode: HTMLElement; private keyboardNavigationEventFilter?: IKeyboardNavigationEventFilter; private automaticKeyboardNavigation = true; private triggered = false; private readonly _onDidChangePattern = new Emitter(); private readonly enabledDisposables = new DisposableStore(); private readonly disposables = new DisposableStore(); constructor( private tree: AbstractTree, model: ITreeModel, private view: List>, private filter: TypeFilter, private keyboardNavigationDelegate: IKeyboardNavigationDelegate ) { this.domNode = $(`.monaco-list-type-filter.${this.positionClassName}`); this.domNode.draggable = true; domEvent(this.domNode, 'dragstart')( this.onDragStart, this, this.disposables ); this.messageDomNode = append( view.getHTMLElement(), $(`.monaco-list-type-filter-message`) ); this.labelDomNode = append(this.domNode, $('span.label')); const controls = append(this.domNode, $('.controls')); this._filterOnType = !!tree.options.filterOnType; this.filterOnTypeDomNode = append( controls, $('input.filter') ); this.filterOnTypeDomNode.type = 'checkbox'; this.filterOnTypeDomNode.checked = this._filterOnType; this.filterOnTypeDomNode.tabIndex = -1; this.updateFilterOnTypeTitleAndIcon(); domEvent(this.filterOnTypeDomNode, 'input')( this.onDidChangeFilterOnType, this, this.disposables ); this.clearDomNode = append( controls, $('button.clear' + treeFilterClearIcon.cssSelector) ); this.clearDomNode.tabIndex = -1; this.clearDomNode.title = localize('clear', 'Clear'); this.keyboardNavigationEventFilter = tree.options.keyboardNavigationEventFilter; model.onDidSplice(this.onDidSpliceModel, this, this.disposables); this.updateOptions(tree.options); } updateOptions(options: IAbstractTreeOptions): void { if (options.simpleKeyboardNavigation) { this.disable(); } else { this.enable(); } if (typeof options.filterOnType !== 'undefined') { this._filterOnType = !!options.filterOnType; this.filterOnTypeDomNode.checked = this._filterOnType; this.updateFilterOnTypeTitleAndIcon(); } if (typeof options.automaticKeyboardNavigation !== 'undefined') { this.automaticKeyboardNavigation = options.automaticKeyboardNavigation; } this.tree.refilter(); this.render(); if (!this.automaticKeyboardNavigation) { this.onEventOrInput(''); } } private enable(): void { if (this._enabled) { return; } const onKeyDown = Event.chain( domEvent(this.view.getHTMLElement(), 'keydown') ) .filter( (e) => !isInputElement(e.target as HTMLElement) || e.target === this.filterOnTypeDomNode ) .filter((e) => e.key !== 'Dead' && !/^Media/.test(e.key)) .map((e) => new StandardKeyboardEvent(e)) .filter(this.keyboardNavigationEventFilter || (() => true)) .filter(() => this.automaticKeyboardNavigation || this.triggered) .filter( (e) => (this.keyboardNavigationDelegate.mightProducePrintableCharacter(e) && !( e.keyCode === KeyCode.DownArrow || e.keyCode === KeyCode.UpArrow || e.keyCode === KeyCode.LeftArrow || e.keyCode === KeyCode.RightArrow )) || ((this.pattern.length > 0 || this.triggered) && (e.keyCode === KeyCode.Escape || e.keyCode === KeyCode.Backspace) && !e.altKey && !e.ctrlKey && !e.metaKey) || (e.keyCode === KeyCode.Backspace && (isMacintosh ? e.altKey && !e.metaKey : e.ctrlKey) && !e.shiftKey) ) .forEach((e) => { e.stopPropagation(); e.preventDefault(); }).event; const onClear = domEvent(this.clearDomNode, 'click'); Event.chain( Event.any(onKeyDown, onClear) ).event(this.onEventOrInput, this, this.enabledDisposables); this.filter.pattern = ''; this.tree.refilter(); this.render(); this._enabled = true; this.triggered = false; } private disable(): void { if (!this._enabled) { return; } this.domNode.remove(); this.enabledDisposables.clear(); this.tree.refilter(); this.render(); this._enabled = false; this.triggered = false; } private onEventOrInput(e: MouseEvent | StandardKeyboardEvent | string): void { if (typeof e === 'string') { this.onInput(e); } else if ( e instanceof MouseEvent || e.keyCode === KeyCode.Escape || (e.keyCode === KeyCode.Backspace && (isMacintosh ? e.altKey : e.ctrlKey)) ) { this.onInput(''); } else if (e.keyCode === KeyCode.Backspace) { this.onInput( this.pattern.length === 0 ? '' : this.pattern.substr(0, this.pattern.length - 1) ); } else { this.onInput(this.pattern + e.browserEvent.key); } } private onInput(pattern: string): void { const container = this.view.getHTMLElement(); if (pattern && !this.domNode.parentElement) { container.append(this.domNode); } else if (!pattern && this.domNode.parentElement) { this.domNode.remove(); this.tree.domFocus(); } this._pattern = pattern; this._onDidChangePattern.fire(pattern); this.filter.pattern = pattern; this.tree.refilter(); if (pattern) { this.tree.focusNext( 0, true, undefined, (node) => !FuzzyScore.isDefault(node.filterData as any as FuzzyScore) ); } const focus = this.tree.getFocus(); if (focus.length > 0) { const element = focus[0]; if (this.tree.getRelativeTop(element) === null) { this.tree.reveal(element, 0.5); } } this.render(); if (!pattern) { this.triggered = false; } } private onDragStart(): void { const container = this.view.getHTMLElement(); const { left } = getDomNodePagePosition(container); const containerWidth = container.clientWidth; const midContainerWidth = containerWidth / 2; const width = this.domNode.clientWidth; const disposables = new DisposableStore(); let positionClassName = this.positionClassName; const updatePosition = () => { switch (positionClassName) { case 'nw': this.domNode.style.top = `4px`; this.domNode.style.left = `4px`; break; case 'ne': this.domNode.style.top = `4px`; this.domNode.style.left = `${containerWidth - width - 6}px`; break; } }; const onDragOver = (event: DragEvent) => { event.preventDefault(); // needed so that the drop event fires (https://stackoverflow.com/questions/21339924/drop-event-not-firing-in-chrome) const x = event.clientX - left; if (event.dataTransfer) { event.dataTransfer.dropEffect = 'none'; } if (x < midContainerWidth) { positionClassName = 'nw'; } else { positionClassName = 'ne'; } updatePosition(); }; const onDragEnd = () => { this.positionClassName = positionClassName; this.domNode.className = `monaco-list-type-filter ${this.positionClassName}`; this.domNode.style.top = ''; this.domNode.style.left = ''; dispose(disposables); }; updatePosition(); this.domNode.classList.remove(positionClassName); this.domNode.classList.add('dragging'); disposables.add( toDisposable(() => this.domNode.classList.remove('dragging')) ); domEvent(document, 'dragover')(onDragOver, null, disposables); domEvent(this.domNode, 'dragend')(onDragEnd, null, disposables); StaticDND.CurrentDragAndDropData = new DragAndDropData('vscode-ui'); disposables.add( toDisposable(() => (StaticDND.CurrentDragAndDropData = undefined)) ); } private onDidSpliceModel(): void { if (!this._enabled || this.pattern.length === 0) { return; } this.tree.refilter(); this.render(); } private onDidChangeFilterOnType(): void { this.tree.updateOptions({ filterOnType: this.filterOnTypeDomNode.checked }); this.tree.refilter(); this.tree.domFocus(); this.render(); this.updateFilterOnTypeTitleAndIcon(); } private updateFilterOnTypeTitleAndIcon(): void { if (this.filterOnType) { this.filterOnTypeDomNode.classList.remove( ...treeFilterOnTypeOffIcon.classNamesArray ); this.filterOnTypeDomNode.classList.add( ...treeFilterOnTypeOnIcon.classNamesArray ); this.filterOnTypeDomNode.title = localize( 'disable filter on type', 'Disable Filter on Type' ); } else { this.filterOnTypeDomNode.classList.remove( ...treeFilterOnTypeOnIcon.classNamesArray ); this.filterOnTypeDomNode.classList.add( ...treeFilterOnTypeOffIcon.classNamesArray ); this.filterOnTypeDomNode.title = localize( 'enable filter on type', 'Enable Filter on Type' ); } } private render(): void { const noMatches = this.filter.totalCount > 0 && this.filter.matchCount === 0; if (this.pattern && this.tree.options.filterOnType && noMatches) { this.messageDomNode.textContent = localize('empty', 'No elements found'); this._empty = true; } else { this.messageDomNode.innerText = ''; this._empty = false; } this.domNode.classList.toggle('no-matches', noMatches); this.domNode.title = localize( 'found', 'Matched {0} out of {1} elements', this.filter.matchCount, this.filter.totalCount ); this.labelDomNode.textContent = this.pattern.length > 16 ? '…' + this.pattern.substr(this.pattern.length - 16) : this.pattern; this._onDidChangeEmptyState.fire(this._empty); } shouldAllowFocus(node: ITreeNode): boolean { if (!this.enabled || !this.pattern || this.filterOnType) { return true; } if (this.filter.totalCount > 0 && this.filter.matchCount <= 1) { return true; } return !FuzzyScore.isDefault(node.filterData as any as FuzzyScore); } dispose() { if (this._enabled) { this.domNode.remove(); this.enabledDisposables.dispose(); this._enabled = false; this.triggered = false; } this._onDidChangePattern.dispose(); dispose(this.disposables); } } function asTreeMouseEvent( event: IListMouseEvent> ): ITreeMouseEvent { let target: TreeMouseEventTarget = TreeMouseEventTarget.Unknown; if ( hasParentWithClass( event.browserEvent.target as HTMLElement, 'monaco-tl-twistie', 'monaco-tl-row' ) ) { target = TreeMouseEventTarget.Twistie; } else if ( hasParentWithClass( event.browserEvent.target as HTMLElement, 'monaco-tl-contents', 'monaco-tl-row' ) ) { target = TreeMouseEventTarget.Element; } return { browserEvent: event.browserEvent, element: event.element ? event.element.element : null, target, }; } export interface IKeyboardNavigationEventFilter { (e: StandardKeyboardEvent): boolean; } export interface IAbstractTreeOptionsUpdate extends ITreeRendererOptions { readonly automaticKeyboardNavigation?: boolean; readonly simpleKeyboardNavigation?: boolean; readonly filterOnType?: boolean; readonly smoothScrolling?: boolean; readonly horizontalScrolling?: boolean; readonly expandOnDoubleClick?: boolean; readonly expandOnlyOnTwistieClick?: boolean | ((e: any) => boolean); // e is T } export interface IAbstractTreeOptions extends IAbstractTreeOptionsUpdate, IListOptions { readonly collapseByDefault?: boolean; // defaults to false readonly filter?: ITreeFilter; readonly dnd?: ITreeDragAndDrop; readonly keyboardNavigationEventFilter?: IKeyboardNavigationEventFilter; readonly additionalScrollHeight?: number; } function dfs( node: ITreeNode, fn: (node: ITreeNode) => void ): void { fn(node); node.children.forEach((child) => dfs(child, fn)); } /** * The trait concept needs to exist at the tree level, because collapsed * tree nodes will not be known by the list. */ class Trait { private nodes: ITreeNode[] = []; private elements: T[] | undefined; private readonly _onDidChange = new Emitter>(); readonly onDidChange = this._onDidChange.event; private _nodeSet: Set> | undefined; private get nodeSet(): Set> { if (!this._nodeSet) { this._nodeSet = this.createNodeSet(); } return this._nodeSet; } constructor(private identityProvider?: IIdentityProvider) {} set(nodes: ITreeNode[], browserEvent?: UIEvent): void { if (!(browserEvent as any)?.__forceEvent && equals(this.nodes, nodes)) { return; } this._set(nodes, false, browserEvent); } private _set( nodes: ITreeNode[], silent: boolean, browserEvent?: UIEvent ): void { this.nodes = [...nodes]; this.elements = undefined; this._nodeSet = undefined; if (!silent) { const that = this; this._onDidChange.fire({ get elements() { return that.get(); }, browserEvent, }); } } get(): T[] { if (!this.elements) { this.elements = this.nodes.map((node) => node.element); } return [...this.elements]; } getNodes(): readonly ITreeNode[] { return this.nodes; } has(node: ITreeNode): boolean { return this.nodeSet.has(node); } onDidModelSplice({ insertedNodes, deletedNodes, }: ITreeModelSpliceEvent): void { if (!this.identityProvider) { const set = this.createNodeSet(); const visit = (node: ITreeNode) => set.delete(node); deletedNodes.forEach((node) => dfs(node, visit)); this.set([...set.values()]); return; } const deletedNodesIdSet = new Set(); const deletedNodesVisitor = (node: ITreeNode) => deletedNodesIdSet.add( this.identityProvider!.getId(node.element).toString() ); deletedNodes.forEach((node) => dfs(node, deletedNodesVisitor)); const insertedNodesMap = new Map>(); const insertedNodesVisitor = (node: ITreeNode) => insertedNodesMap.set( this.identityProvider!.getId(node.element).toString(), node ); insertedNodes.forEach((node) => dfs(node, insertedNodesVisitor)); const nodes: ITreeNode[] = []; for (const node of this.nodes) { const id = this.identityProvider.getId(node.element).toString(); const wasDeleted = deletedNodesIdSet.has(id); if (!wasDeleted) { nodes.push(node); } else { const insertedNode = insertedNodesMap.get(id); if (insertedNode) { nodes.push(insertedNode); } } } this._set(nodes, true); } private createNodeSet(): Set> { const set = new Set>(); for (const node of this.nodes) { set.add(node); } return set; } } class TreeNodeListMouseController extends MouseController< ITreeNode > { constructor( list: TreeNodeList, private tree: AbstractTree ) { super(list); } protected override onViewPointer( e: IListMouseEvent> ): void { if ( isInputElement(e.browserEvent.target as HTMLElement) || isMonacoEditor(e.browserEvent.target as HTMLElement) ) { return; } const node = e.element; if (!node) { return super.onViewPointer(e); } if ( this.isSelectionRangeChangeEvent(e) || this.isSelectionSingleChangeEvent(e) ) { return super.onViewPointer(e); } const target = e.browserEvent.target as HTMLElement; const onTwistie = target.classList.contains('monaco-tl-twistie') || (target.classList.contains('monaco-icon-label') && target.classList.contains('folder-icon') && e.browserEvent.offsetX < 16); let expandOnlyOnTwistieClick = false; if (typeof this.tree.expandOnlyOnTwistieClick === 'function') { expandOnlyOnTwistieClick = this.tree.expandOnlyOnTwistieClick( node.element ); } else { expandOnlyOnTwistieClick = !!this.tree.expandOnlyOnTwistieClick; } if (expandOnlyOnTwistieClick && !onTwistie && e.browserEvent.detail !== 2) { return super.onViewPointer(e); } if (!this.tree.expandOnDoubleClick && e.browserEvent.detail === 2) { return super.onViewPointer(e); } if (node.collapsible) { const model = (this.tree as any).model as ITreeModel< T, TFilterData, TRef >; // internal const location = model.getNodeLocation(node); const recursive = e.browserEvent.altKey; this.tree.setFocus([location]); model.setCollapsed(location, undefined, recursive); if (expandOnlyOnTwistieClick && onTwistie) { return; } } super.onViewPointer(e); } protected override onDoubleClick( e: IListMouseEvent> ): void { const onTwistie = (e.browserEvent.target as HTMLElement).classList.contains( 'monaco-tl-twistie' ); if (onTwistie || !this.tree.expandOnDoubleClick) { return; } super.onDoubleClick(e); } } interface ITreeNodeListOptions extends IListOptions> { readonly tree: AbstractTree; } /** * We use this List subclass to restore selection and focus as nodes * get rendered in the list, possibly due to a node expand() call. */ class TreeNodeList extends List< ITreeNode > { constructor( user: string, container: HTMLElement, virtualDelegate: IListVirtualDelegate>, renderers: IListRenderer[], private focusTrait: Trait, private selectionTrait: Trait, private anchorTrait: Trait, options: ITreeNodeListOptions ) { super(user, container, virtualDelegate, renderers, options); } protected override createMouseController( options: ITreeNodeListOptions ): MouseController> { return new TreeNodeListMouseController(this, options.tree); } override splice( start: number, deleteCount: number, elements: ITreeNode[] = [] ): void { super.splice(start, deleteCount, elements); if (elements.length === 0) { return; } const additionalFocus: number[] = []; const additionalSelection: number[] = []; let anchor: number | undefined; elements.forEach((node, index) => { if (this.focusTrait.has(node)) { additionalFocus.push(start + index); } if (this.selectionTrait.has(node)) { additionalSelection.push(start + index); } if (this.anchorTrait.has(node)) { anchor = start + index; } }); if (additionalFocus.length > 0) { super.setFocus(distinctES6([...super.getFocus(), ...additionalFocus])); } if (additionalSelection.length > 0) { super.setSelection( distinctES6([...super.getSelection(), ...additionalSelection]) ); } if (typeof anchor === 'number') { super.setAnchor(anchor); } } override setFocus( indexes: number[], browserEvent?: UIEvent, fromAPI = false ): void { super.setFocus(indexes, browserEvent); if (!fromAPI) { this.focusTrait.set( indexes.map((i) => this.element(i)), browserEvent ); } } override setSelection( indexes: number[], browserEvent?: UIEvent, fromAPI = false ): void { super.setSelection(indexes, browserEvent); if (!fromAPI) { this.selectionTrait.set( indexes.map((i) => this.element(i)), browserEvent ); } } override setAnchor(index: number | undefined, fromAPI = false): void { super.setAnchor(index); if (!fromAPI) { if (typeof index === 'undefined') { this.anchorTrait.set([]); } else { this.anchorTrait.set([this.element(index)]); } } } } export abstract class AbstractTree implements IDisposable { protected view: TreeNodeList; private renderers: TreeRenderer[]; protected model: ITreeModel; private focus: Trait; private selection: Trait; private anchor: Trait; private eventBufferer = new EventBufferer(); private typeFilterController?: TypeFilterController; private focusNavigationFilter: | ((node: ITreeNode) => boolean) | undefined; private styleElement: HTMLStyleElement; protected readonly disposables = new DisposableStore(); get onDidChangeFocus(): Event> { return this.eventBufferer.wrapEvent(this.focus.onDidChange); } get onDidChangeSelection(): Event> { return this.eventBufferer.wrapEvent(this.selection.onDidChange); } get onMouseDblClick(): Event> { return Event.map(this.view.onMouseDblClick, asTreeMouseEvent); } get onPointer(): Event> { return Event.map(this.view.onPointer, asTreeMouseEvent); } get onDidFocus(): Event { return this.view.onDidFocus; } get onDidChangeCollapseState(): Event< ICollapseStateChangeEvent > { return this.model.onDidChangeCollapseState; } private readonly _onWillRefilter = new Emitter(); readonly onWillRefilter: Event = this._onWillRefilter.event; get expandOnDoubleClick(): boolean { return typeof this._options.expandOnDoubleClick === 'undefined' ? true : this._options.expandOnDoubleClick; } get expandOnlyOnTwistieClick(): boolean | ((e: T) => boolean) { return typeof this._options.expandOnlyOnTwistieClick === 'undefined' ? true : this._options.expandOnlyOnTwistieClick; } private readonly _onDidUpdateOptions = new Emitter< IAbstractTreeOptions >(); get onDidDispose(): Event { return this.view.onDidDispose; } constructor( user: string, container: HTMLElement, delegate: IListVirtualDelegate, renderers: ITreeRenderer[], private _options: IAbstractTreeOptions = {} ) { const treeDelegate = new ComposedTreeDelegate>( delegate ); const onDidChangeCollapseStateRelay = new Relay< ICollapseStateChangeEvent >(); const onDidChangeActiveNodes = new Relay[]>(); const activeNodes = new EventCollection(onDidChangeActiveNodes.event); this.renderers = renderers.map( (r) => new TreeRenderer( r, () => this.model, onDidChangeCollapseStateRelay.event, activeNodes, _options ) ); for (let r of this.renderers) { this.disposables.add(r); } let filter: TypeFilter | undefined; if (_options.keyboardNavigationLabelProvider) { filter = new TypeFilter( this, _options.keyboardNavigationLabelProvider, _options.filter as any as ITreeFilter ); _options = { ..._options, filter: filter as ITreeFilter }; // TODO need typescript help here this.disposables.add(filter); } this.focus = new Trait(_options.identityProvider); this.selection = new Trait(_options.identityProvider); this.anchor = new Trait(_options.identityProvider); this.view = new TreeNodeList( user, container, treeDelegate, this.renderers, this.focus, this.selection, this.anchor, { ...asListOptions(() => this.model, _options), tree: this } ); this.model = this.createModel(user, this.view, _options); onDidChangeCollapseStateRelay.input = this.model.onDidChangeCollapseState; const onDidModelSplice = Event.forEach(this.model.onDidSplice, (e) => { this.eventBufferer.bufferEvents(() => { this.focus.onDidModelSplice(e); this.selection.onDidModelSplice(e); }); }); // Make sure the `forEach` always runs onDidModelSplice(() => null, null, this.disposables); // Active nodes can change when the model changes or when focus or selection change. // We debounce it with 0 delay since these events may fire in the same stack and we only // want to run this once. It also doesn't matter if it runs on the next tick since it's only // a nice to have UI feature. onDidChangeActiveNodes.input = Event.chain( Event.any( onDidModelSplice, this.focus.onDidChange, this.selection.onDidChange ) ) .debounce(() => null, 0) .map(() => { const set = new Set>(); for (const node of this.focus.getNodes()) { set.add(node); } for (const node of this.selection.getNodes()) { set.add(node); } return [...set.values()]; }).event; if (_options.keyboardSupport !== false) { const onKeyDown = Event.chain(this.view.onKeyDown) .filter((e) => !isInputElement(e.target as HTMLElement)) .map((e) => new StandardKeyboardEvent(e)); onKeyDown .filter((e) => e.keyCode === KeyCode.LeftArrow) .on(this.onLeftArrow, this, this.disposables); onKeyDown .filter((e) => e.keyCode === KeyCode.RightArrow) .on(this.onRightArrow, this, this.disposables); onKeyDown .filter((e) => e.keyCode === KeyCode.Space) .on(this.onSpace, this, this.disposables); } if (_options.keyboardNavigationLabelProvider) { const delegate = _options.keyboardNavigationDelegate || DefaultKeyboardNavigationDelegate; this.typeFilterController = new TypeFilterController( this, this.model, this.view, filter!, delegate ); this.focusNavigationFilter = (node) => this.typeFilterController!.shouldAllowFocus(node); this.disposables.add(this.typeFilterController!); } this.styleElement = createStyleSheet(this.view.getHTMLElement()); this.getHTMLElement().classList.toggle( 'always', this._options.renderIndentGuides === RenderIndentGuides.Always ); } updateOptions(optionsUpdate: IAbstractTreeOptionsUpdate = {}): void { this._options = { ...this._options, ...optionsUpdate }; for (const renderer of this.renderers) { renderer.updateOptions(optionsUpdate); } this.view.updateOptions({ enableKeyboardNavigation: this._options.simpleKeyboardNavigation, automaticKeyboardNavigation: this._options.automaticKeyboardNavigation, smoothScrolling: this._options.smoothScrolling, horizontalScrolling: this._options.horizontalScrolling, }); if (this.typeFilterController) { this.typeFilterController.updateOptions(this._options); } this._onDidUpdateOptions.fire(this._options); this.getHTMLElement().classList.toggle( 'always', this._options.renderIndentGuides === RenderIndentGuides.Always ); } get options(): IAbstractTreeOptions { return this._options; } // Widget getHTMLElement(): HTMLElement { return this.view.getHTMLElement(); } get scrollTop(): number { return this.view.scrollTop; } set scrollTop(scrollTop: number) { this.view.scrollTop = scrollTop; } domFocus(): void { this.view.domFocus(); } layout(height?: number, width?: number): void { this.view.layout(height, width); } style(styles: IListStyles): void { const suffix = `.${this.view.domId}`; const content: string[] = []; if (styles.treeIndentGuidesStroke) { content.push( `.monaco-list${suffix}:hover .monaco-tl-indent > .indent-guide, .monaco-list${suffix}.always .monaco-tl-indent > .indent-guide { border-color: ${styles.treeIndentGuidesStroke.transparent( 0.4 )}; }` ); content.push( `.monaco-list${suffix} .monaco-tl-indent > .indent-guide.active { border-color: ${styles.treeIndentGuidesStroke}; }` ); } this.styleElement.textContent = content.join('\n'); this.view.style(styles); } collapse(location: TRef, recursive: boolean = false): boolean { return this.model.setCollapsed(location, true, recursive); } expand(location: TRef, recursive: boolean = false): boolean { return this.model.setCollapsed(location, false, recursive); } isCollapsible(location: TRef): boolean { return this.model.isCollapsible(location); } setCollapsible(location: TRef, collapsible?: boolean): boolean { return this.model.setCollapsible(location, collapsible); } isCollapsed(location: TRef): boolean { return this.model.isCollapsed(location); } refilter(): void { this._onWillRefilter.fire(undefined); this.model.refilter(); } setSelection(elements: TRef[], browserEvent?: UIEvent): void { const nodes = elements.map((e) => this.model.getNode(e)); this.selection.set(nodes, browserEvent); const indexes = elements .map((e) => this.model.getListIndex(e)) .filter((i) => i > -1); this.view.setSelection(indexes, browserEvent, true); } getSelection(): T[] { return this.selection.get(); } setFocus(elements: TRef[], browserEvent?: UIEvent): void { const nodes = elements.map((e) => this.model.getNode(e)); this.focus.set(nodes, browserEvent); const indexes = elements .map((e) => this.model.getListIndex(e)) .filter((i) => i > -1); this.view.setFocus(indexes, browserEvent, true); } focusNext( n = 1, loop = false, browserEvent?: UIEvent, filter = this.focusNavigationFilter ): void { this.view.focusNext(n, loop, browserEvent, filter); } getFocus(): T[] { return this.focus.get(); } reveal(location: TRef, relativeTop?: number): void { this.model.expandTo(location); const index = this.model.getListIndex(location); if (index === -1) { return; } this.view.reveal(index, relativeTop); } /** * Returns the relative position of an element rendered in the list. * Returns `null` if the element isn't *entirely* in the visible viewport. */ getRelativeTop(location: TRef): number | null { const index = this.model.getListIndex(location); if (index === -1) { return null; } return this.view.getRelativeTop(index); } // List private onLeftArrow(e: StandardKeyboardEvent): void { e.preventDefault(); e.stopPropagation(); const nodes = this.view.getFocusedElements(); if (nodes.length === 0) { return; } const node = nodes[0]; const location = this.model.getNodeLocation(node); const didChange = this.model.setCollapsed(location, true); if (!didChange) { const parentLocation = this.model.getParentNodeLocation(location); if (!parentLocation) { return; } const parentListIndex = this.model.getListIndex(parentLocation); this.view.reveal(parentListIndex); this.view.setFocus([parentListIndex]); } } private onRightArrow(e: StandardKeyboardEvent): void { e.preventDefault(); e.stopPropagation(); const nodes = this.view.getFocusedElements(); if (nodes.length === 0) { return; } const node = nodes[0]; const location = this.model.getNodeLocation(node); const didChange = this.model.setCollapsed(location, false); if (!didChange) { if (!node.children.some((child) => child.visible)) { return; } const [focusedIndex] = this.view.getFocus(); const firstChildIndex = focusedIndex + 1; this.view.reveal(firstChildIndex); this.view.setFocus([firstChildIndex]); } } private onSpace(e: StandardKeyboardEvent): void { e.preventDefault(); e.stopPropagation(); const nodes = this.view.getFocusedElements(); if (nodes.length === 0) { return; } const node = nodes[0]; const location = this.model.getNodeLocation(node); const recursive = e.browserEvent.altKey; this.model.setCollapsed(location, undefined, recursive); } protected abstract createModel( user: string, view: ISpliceable>, options: IAbstractTreeOptions ): ITreeModel; dispose(): void { dispose(this.disposables); this.view.dispose(); } }