1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { CancellationTokenSource } from 'vs/base/common/cancellation';
import { onUnexpectedError } from 'vs/base/common/errors';
import { Emitter, Event } from 'vs/base/common/event';
import { DisposableStore, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
import { isEqual, dirname } from 'vs/base/common/resources';
import { URI } from 'vs/base/common/uri';
import { IWorkspaceContextService, IWorkspaceFolder, WorkbenchState } from 'vs/platform/workspace/common/workspace';
import { Schemas } from 'vs/base/common/network';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { BreadcrumbsConfig } from 'vs/workbench/browser/parts/editor/breadcrumbs';
import { FileKind } from 'vs/platform/files/common/files';
import { withNullAsUndefined } from 'vs/base/common/types';
import { IOutline, IOutlineService, OutlineTarget } from 'vs/workbench/services/outline/browser/outline';
import { IEditorPane } from 'vs/workbench/common/editor';
export class FileElement {
constructor(
readonly uri: URI,
readonly kind: FileKind
) { }
}
type FileInfo = { path: FileElement[]; folder?: IWorkspaceFolder };
export class OutlineElement2 {
constructor(
readonly element: IOutline<any> | any,
readonly outline: IOutline<any>
) { }
}
export class BreadcrumbsModel {
private readonly _disposables = new DisposableStore();
private _fileInfo: FileInfo;
private readonly _cfgFilePath: BreadcrumbsConfig<'on' | 'off' | 'last'>;
private readonly _cfgSymbolPath: BreadcrumbsConfig<'on' | 'off' | 'last'>;
private readonly _currentOutline = new MutableDisposable<IOutline<any>>();
private readonly _outlineDisposables = new DisposableStore();
private readonly _onDidUpdate = new Emitter<this>();
readonly onDidUpdate: Event<this> = this._onDidUpdate.event;
constructor(
readonly resource: URI,
editor: IEditorPane | undefined,
@IConfigurationService configurationService: IConfigurationService,
@IWorkspaceContextService private readonly _workspaceService: IWorkspaceContextService,
@IOutlineService private readonly _outlineService: IOutlineService,
) {
this._cfgFilePath = BreadcrumbsConfig.FilePath.bindTo(configurationService);
this._cfgSymbolPath = BreadcrumbsConfig.SymbolPath.bindTo(configurationService);
this._disposables.add(this._cfgFilePath.onDidChange(_ => this._onDidUpdate.fire(this)));
this._disposables.add(this._cfgSymbolPath.onDidChange(_ => this._onDidUpdate.fire(this)));
this._workspaceService.onDidChangeWorkspaceFolders(this._onDidChangeWorkspaceFolders, this, this._disposables);
this._fileInfo = this._initFilePathInfo(resource);
if (editor) {
this._bindToEditor(editor);
this._disposables.add(_outlineService.onDidChange(() => this._bindToEditor(editor)));
this._disposables.add(editor.onDidChangeControl(() => this._bindToEditor(editor)));
}
this._onDidUpdate.fire(this);
}
dispose(): void {
this._disposables.dispose();
this._cfgFilePath.dispose();
this._cfgSymbolPath.dispose();
this._currentOutline.dispose();
this._outlineDisposables.dispose();
this._onDidUpdate.dispose();
}
isRelative(): boolean {
return Boolean(this._fileInfo.folder);
}
getElements(): ReadonlyArray<FileElement | OutlineElement2> {
let result: (FileElement | OutlineElement2)[] = [];
// file path elements
if (this._cfgFilePath.getValue() === 'on') {
result = result.concat(this._fileInfo.path);
} else if (this._cfgFilePath.getValue() === 'last' && this._fileInfo.path.length > 0) {
result = result.concat(this._fileInfo.path.slice(-1));
}
if (this._cfgSymbolPath.getValue() === 'off') {
return result;
}
if (!this._currentOutline.value) {
return result;
}
const breadcrumbsElements = this._currentOutline.value.config.breadcrumbsDataSource.getBreadcrumbElements();
for (let i = this._cfgSymbolPath.getValue() === 'last' && breadcrumbsElements.length > 0 ? breadcrumbsElements.length - 1 : 0; i < breadcrumbsElements.length; i++) {
result.push(new OutlineElement2(breadcrumbsElements[i], this._currentOutline.value));
}
if (breadcrumbsElements.length === 0 && !this._currentOutline.value.isEmpty) {
result.push(new OutlineElement2(this._currentOutline.value, this._currentOutline.value));
}
return result;
}
private _initFilePathInfo(uri: URI): FileInfo {
if (uri.scheme === Schemas.untitled) {
return {
folder: undefined,
path: []
};
}
const info: FileInfo = {
folder: withNullAsUndefined(this._workspaceService.getWorkspaceFolder(uri)),
path: []
};
let uriPrefix: URI | null = uri;
while (uriPrefix && uriPrefix.path !== '/') {
if (info.folder && isEqual(info.folder.uri, uriPrefix)) {
break;
}
info.path.unshift(new FileElement(uriPrefix, info.path.length === 0 ? FileKind.FILE : FileKind.FOLDER));
const prevPathLength = uriPrefix.path.length;
uriPrefix = dirname(uriPrefix);
if (uriPrefix.path.length === prevPathLength) {
break;
}
}
if (info.folder && this._workspaceService.getWorkbenchState() === WorkbenchState.WORKSPACE) {
info.path.unshift(new FileElement(info.folder.uri, FileKind.ROOT_FOLDER));
}
return info;
}
private _onDidChangeWorkspaceFolders() {
this._fileInfo = this._initFilePathInfo(this.resource);
this._onDidUpdate.fire(this);
}
private _bindToEditor(editor: IEditorPane): void {
const newCts = new CancellationTokenSource();
this._currentOutline.clear();
this._outlineDisposables.clear();
this._outlineDisposables.add(toDisposable(() => newCts.dispose(true)));
this._outlineService.createOutline(editor, OutlineTarget.Breadcrumbs, newCts.token).then(outline => {
if (newCts.token.isCancellationRequested) {
// cancelled: dispose new outline and reset
outline?.dispose();
outline = undefined;
}
this._currentOutline.value = outline;
this._onDidUpdate.fire(this);
if (outline) {
this._outlineDisposables.add(outline.onDidChange(() => this._onDidUpdate.fire(this)));
}
}).catch(err => {
this._onDidUpdate.fire(this);
onUnexpectedError(err);
});
}
}
|