@theia/preferences 1.34.1 → 1.34.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. package/LICENSE +641 -641
  2. package/README.md +81 -81
  3. package/lib/browser/abstract-resource-preference-provider.d.ts +46 -46
  4. package/lib/browser/abstract-resource-preference-provider.js +237 -237
  5. package/lib/browser/abstract-resource-preference-provider.spec.d.ts +1 -1
  6. package/lib/browser/abstract-resource-preference-provider.spec.js +83 -83
  7. package/lib/browser/folder-preference-provider.d.ts +20 -20
  8. package/lib/browser/folder-preference-provider.js +59 -59
  9. package/lib/browser/folders-preferences-provider.d.ts +25 -25
  10. package/lib/browser/folders-preferences-provider.js +239 -239
  11. package/lib/browser/index.d.ts +7 -7
  12. package/lib/browser/index.js +34 -34
  13. package/lib/browser/monaco-jsonc-editor.d.ts +9 -9
  14. package/lib/browser/monaco-jsonc-editor.js +80 -80
  15. package/lib/browser/package.spec.js +25 -25
  16. package/lib/browser/preference-bindings.d.ts +4 -4
  17. package/lib/browser/preference-bindings.js +63 -63
  18. package/lib/browser/preference-frontend-module.d.ts +6 -6
  19. package/lib/browser/preference-frontend-module.js +52 -52
  20. package/lib/browser/preference-open-handler.d.ts +9 -9
  21. package/lib/browser/preference-open-handler.js +64 -64
  22. package/lib/browser/preference-transaction-manager.d.ts +98 -98
  23. package/lib/browser/preference-transaction-manager.js +295 -295
  24. package/lib/browser/preference-tree-model.d.ts +59 -59
  25. package/lib/browser/preference-tree-model.js +240 -240
  26. package/lib/browser/preferences-contribution.d.ts +37 -37
  27. package/lib/browser/preferences-contribution.js +279 -279
  28. package/lib/browser/preferences-json-schema-contribution.d.ts +17 -17
  29. package/lib/browser/preferences-json-schema-contribution.js +91 -91
  30. package/lib/browser/preferences-monaco-contribution.d.ts +1 -1
  31. package/lib/browser/preferences-monaco-contribution.js +30 -30
  32. package/lib/browser/section-preference-provider.d.ts +21 -21
  33. package/lib/browser/section-preference-provider.js +96 -96
  34. package/lib/browser/user-configs-preference-provider.d.ts +21 -21
  35. package/lib/browser/user-configs-preference-provider.js +134 -134
  36. package/lib/browser/user-preference-provider.d.ts +13 -13
  37. package/lib/browser/user-preference-provider.js +41 -41
  38. package/lib/browser/util/preference-scope-command-manager.d.ts +17 -17
  39. package/lib/browser/util/preference-scope-command-manager.js +87 -87
  40. package/lib/browser/util/preference-tree-generator.d.ts +30 -30
  41. package/lib/browser/util/preference-tree-generator.js +234 -234
  42. package/lib/browser/util/preference-tree-label-provider.d.ts +11 -11
  43. package/lib/browser/util/preference-tree-label-provider.js +77 -77
  44. package/lib/browser/util/preference-tree-label-provider.spec.d.ts +1 -1
  45. package/lib/browser/util/preference-tree-label-provider.spec.js +87 -87
  46. package/lib/browser/util/preference-types.d.ts +62 -62
  47. package/lib/browser/util/preference-types.js +128 -128
  48. package/lib/browser/views/components/preference-array-input.d.ts +28 -28
  49. package/lib/browser/views/components/preference-array-input.js +180 -180
  50. package/lib/browser/views/components/preference-boolean-input.d.ts +17 -17
  51. package/lib/browser/views/components/preference-boolean-input.js +79 -79
  52. package/lib/browser/views/components/preference-file-input.d.ts +29 -29
  53. package/lib/browser/views/components/preference-file-input.js +110 -110
  54. package/lib/browser/views/components/preference-json-input.d.ts +19 -19
  55. package/lib/browser/views/components/preference-json-input.js +93 -93
  56. package/lib/browser/views/components/preference-node-renderer-creator.d.ts +48 -48
  57. package/lib/browser/views/components/preference-node-renderer-creator.js +132 -132
  58. package/lib/browser/views/components/preference-node-renderer.d.ts +111 -111
  59. package/lib/browser/views/components/preference-node-renderer.js +460 -460
  60. package/lib/browser/views/components/preference-number-input.d.ts +34 -34
  61. package/lib/browser/views/components/preference-number-input.js +142 -142
  62. package/lib/browser/views/components/preference-select-input.d.ts +27 -27
  63. package/lib/browser/views/components/preference-select-input.js +135 -135
  64. package/lib/browser/views/components/preference-string-input.d.ts +17 -17
  65. package/lib/browser/views/components/preference-string-input.js +89 -89
  66. package/lib/browser/views/preference-editor-widget.d.ts +67 -67
  67. package/lib/browser/views/preference-editor-widget.js +376 -376
  68. package/lib/browser/views/preference-scope-tabbar-widget.d.ts +54 -54
  69. package/lib/browser/views/preference-scope-tabbar-widget.js +343 -343
  70. package/lib/browser/views/preference-searchbar-widget.d.ts +53 -53
  71. package/lib/browser/views/preference-searchbar-widget.js +173 -173
  72. package/lib/browser/views/preference-tree-widget.d.ts +17 -17
  73. package/lib/browser/views/preference-tree-widget.js +104 -104
  74. package/lib/browser/views/preference-widget-bindings.d.ts +3 -3
  75. package/lib/browser/views/preference-widget-bindings.js +85 -85
  76. package/lib/browser/views/preference-widget.d.ts +35 -35
  77. package/lib/browser/views/preference-widget.js +123 -123
  78. package/lib/browser/workspace-file-preference-provider.d.ts +23 -23
  79. package/lib/browser/workspace-file-preference-provider.js +110 -110
  80. package/lib/browser/workspace-preference-provider.d.ts +28 -28
  81. package/lib/browser/workspace-preference-provider.js +142 -142
  82. package/package.json +9 -9
  83. package/src/browser/abstract-resource-preference-provider.spec.ts +95 -95
  84. package/src/browser/abstract-resource-preference-provider.ts +228 -228
  85. package/src/browser/folder-preference-provider.ts +58 -58
  86. package/src/browser/folders-preferences-provider.ts +236 -236
  87. package/src/browser/index.ts +23 -23
  88. package/src/browser/monaco-jsonc-editor.ts +67 -67
  89. package/src/browser/package.spec.ts +28 -28
  90. package/src/browser/preference-bindings.ts +65 -65
  91. package/src/browser/preference-frontend-module.ts +57 -57
  92. package/src/browser/preference-open-handler.ts +53 -53
  93. package/src/browser/preference-transaction-manager.ts +283 -283
  94. package/src/browser/preference-tree-model.ts +246 -246
  95. package/src/browser/preferences-contribution.ts +263 -263
  96. package/src/browser/preferences-json-schema-contribution.ts +86 -86
  97. package/src/browser/preferences-monaco-contribution.ts +30 -30
  98. package/src/browser/section-preference-provider.ts +83 -83
  99. package/src/browser/style/index.css +456 -456
  100. package/src/browser/style/preference-array.css +90 -90
  101. package/src/browser/style/preference-context-menu.css +74 -74
  102. package/src/browser/style/preference-file.css +32 -32
  103. package/src/browser/style/preference-object.css +49 -49
  104. package/src/browser/style/search-input.css +66 -66
  105. package/src/browser/user-configs-preference-provider.ts +123 -123
  106. package/src/browser/user-preference-provider.ts +35 -35
  107. package/src/browser/util/preference-scope-command-manager.ts +75 -75
  108. package/src/browser/util/preference-tree-generator.ts +222 -222
  109. package/src/browser/util/preference-tree-label-provider.spec.ts +108 -108
  110. package/src/browser/util/preference-tree-label-provider.ts +64 -64
  111. package/src/browser/util/preference-types.ts +169 -169
  112. package/src/browser/views/components/preference-array-input.ts +174 -174
  113. package/src/browser/views/components/preference-boolean-input.ts +69 -69
  114. package/src/browser/views/components/preference-file-input.ts +104 -104
  115. package/src/browser/views/components/preference-json-input.ts +78 -78
  116. package/src/browser/views/components/preference-node-renderer-creator.ts +141 -141
  117. package/src/browser/views/components/preference-node-renderer.ts +499 -499
  118. package/src/browser/views/components/preference-number-input.ts +147 -147
  119. package/src/browser/views/components/preference-select-input.ts +127 -127
  120. package/src/browser/views/components/preference-string-input.ts +76 -76
  121. package/src/browser/views/preference-editor-widget.ts +361 -361
  122. package/src/browser/views/preference-scope-tabbar-widget.tsx +344 -344
  123. package/src/browser/views/preference-searchbar-widget.tsx +183 -183
  124. package/src/browser/views/preference-tree-widget.tsx +93 -93
  125. package/src/browser/views/preference-widget-bindings.ts +99 -99
  126. package/src/browser/views/preference-widget.tsx +113 -113
  127. package/src/browser/workspace-file-preference-provider.ts +100 -100
  128. package/src/browser/workspace-preference-provider.ts +134 -134
@@ -1,344 +1,344 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2020 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
18
- import { TabBar, Widget, Title } from '@theia/core/shared/@phosphor/widgets';
19
- import { PreferenceScope, Message, ContextMenuRenderer, LabelProvider, StatefulWidget, codicon } from '@theia/core/lib/browser';
20
- import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
21
- import URI from '@theia/core/lib/common/uri';
22
- import { FileStat } from '@theia/filesystem/lib/common/files';
23
- import { PreferenceScopeCommandManager } from '../util/preference-scope-command-manager';
24
- import { Preference, PreferenceMenus } from '../util/preference-types';
25
- import { CommandRegistry, DisposableCollection, Emitter, MenuModelRegistry } from '@theia/core/lib/common';
26
- import { nls } from '@theia/core/lib/common/nls';
27
-
28
- const USER_TAB_LABEL = nls.localizeByDefault('User');
29
- const USER_TAB_INDEX = PreferenceScope['User'];
30
- const WORKSPACE_TAB_LABEL = nls.localizeByDefault('Workspace');
31
- const WORKSPACE_TAB_INDEX = PreferenceScope['Workspace'];
32
- const FOLDER_TAB_LABEL = nls.localizeByDefault('Folder');
33
- const FOLDER_TAB_INDEX = PreferenceScope['Folder'];
34
-
35
- const PREFERENCE_TAB_CLASSNAME = 'preferences-scope-tab';
36
- const GENERAL_FOLDER_TAB_CLASSNAME = 'preference-folder';
37
- const LABELED_FOLDER_TAB_CLASSNAME = 'preferences-folder-tab';
38
- const FOLDER_DROPDOWN_CLASSNAME = 'preferences-folder-dropdown';
39
- const FOLDER_DROPDOWN_ICON_CLASSNAME = 'preferences-folder-dropdown-icon ' + codicon('chevron-down');
40
- const TABBAR_UNDERLINE_CLASSNAME = 'tabbar-underline';
41
- const SINGLE_FOLDER_TAB_CLASSNAME = `${PREFERENCE_TAB_CLASSNAME} ${GENERAL_FOLDER_TAB_CLASSNAME} ${LABELED_FOLDER_TAB_CLASSNAME}`;
42
- const UNSELECTED_FOLDER_DROPDOWN_CLASSNAME = `${PREFERENCE_TAB_CLASSNAME} ${GENERAL_FOLDER_TAB_CLASSNAME} ${FOLDER_DROPDOWN_CLASSNAME}`;
43
- const SELECTED_FOLDER_DROPDOWN_CLASSNAME = `${PREFERENCE_TAB_CLASSNAME} ${GENERAL_FOLDER_TAB_CLASSNAME} ${LABELED_FOLDER_TAB_CLASSNAME} ${FOLDER_DROPDOWN_CLASSNAME}`;
44
- const SHADOW_CLASSNAME = 'with-shadow';
45
-
46
- export interface PreferencesScopeTabBarState {
47
- scopeDetails: Preference.SelectedScopeDetails;
48
- }
49
-
50
- @injectable()
51
- export class PreferencesScopeTabBar extends TabBar<Widget> implements StatefulWidget {
52
-
53
- static ID = 'preferences-scope-tab-bar';
54
- @inject(WorkspaceService) protected readonly workspaceService: WorkspaceService;
55
- @inject(PreferenceScopeCommandManager) protected readonly preferencesMenuFactory: PreferenceScopeCommandManager;
56
- @inject(ContextMenuRenderer) protected readonly contextMenuRenderer: ContextMenuRenderer;
57
- @inject(LabelProvider) protected readonly labelProvider: LabelProvider;
58
- @inject(CommandRegistry) protected readonly commandRegistry: CommandRegistry;
59
- @inject(MenuModelRegistry) protected readonly menuModelRegistry: MenuModelRegistry;
60
-
61
- protected readonly onScopeChangedEmitter = new Emitter<Preference.SelectedScopeDetails>();
62
- readonly onScopeChanged = this.onScopeChangedEmitter.event;
63
-
64
- protected toDispose = new DisposableCollection();
65
- protected folderTitle: Title<Widget>;
66
- protected currentWorkspaceRoots: FileStat[] = [];
67
- protected currentSelection: Preference.SelectedScopeDetails = Preference.DEFAULT_SCOPE;
68
- protected editorScrollAtTop = true;
69
-
70
- get currentScope(): Preference.SelectedScopeDetails {
71
- return this.currentSelection;
72
- }
73
-
74
- protected setNewScopeSelection(newSelection: Preference.SelectedScopeDetails): void {
75
- const stringifiedSelectionScope = newSelection.scope.toString();
76
- const newIndex = this.titles.findIndex(title => title.dataset.scope === stringifiedSelectionScope);
77
- if (newIndex !== -1) {
78
- this.currentSelection = newSelection;
79
- this.currentIndex = newIndex;
80
- if (newSelection.scope === PreferenceScope.Folder) {
81
- this.addOrUpdateFolderTab();
82
- }
83
- this.emitNewScope();
84
- }
85
- }
86
-
87
- @postConstruct()
88
- protected init(): void {
89
- this.id = PreferencesScopeTabBar.ID;
90
- this.setupInitialDisplay();
91
-
92
- this.tabActivateRequested.connect((sender, args) => {
93
- const scopeDetails = this.toScopeDetails(args.title);
94
- if (scopeDetails) {
95
- this.setNewScopeSelection(scopeDetails);
96
- }
97
- });
98
- this.toDispose.pushAll([
99
- this.workspaceService.onWorkspaceChanged(newRoots => this.doUpdateDisplay(newRoots)),
100
- this.workspaceService.onWorkspaceLocationChanged(() => this.doUpdateDisplay(this.workspaceService.tryGetRoots())),
101
- ]);
102
- const tabUnderline = document.createElement('div');
103
- tabUnderline.className = TABBAR_UNDERLINE_CLASSNAME;
104
- this.node.append(tabUnderline);
105
- }
106
-
107
- protected toScopeDetails(title?: Title<Widget> | Preference.SelectedScopeDetails): Preference.SelectedScopeDetails | undefined {
108
- if (title) {
109
- const source = 'dataset' in title ? title.dataset : title;
110
- const { scope, uri, activeScopeIsFolder } = source;
111
- return {
112
- scope: Number(scope),
113
- uri: uri || undefined,
114
- activeScopeIsFolder: activeScopeIsFolder === 'true' || activeScopeIsFolder === true,
115
- };
116
- }
117
- }
118
-
119
- protected toDataSet(scopeDetails: Preference.SelectedScopeDetails): Title.Dataset {
120
- const { scope, uri, activeScopeIsFolder } = scopeDetails;
121
- return {
122
- scope: scope.toString(),
123
- uri: uri ?? '',
124
- activeScopeIsFolder: activeScopeIsFolder.toString()
125
- };
126
- }
127
-
128
- protected setupInitialDisplay(): void {
129
- this.addUserTab();
130
- if (this.workspaceService.workspace) {
131
- this.addWorkspaceTab(this.workspaceService.workspace);
132
- }
133
- this.addOrUpdateFolderTab();
134
- }
135
-
136
- protected override onUpdateRequest(msg: Message): void {
137
- super.onUpdateRequest(msg);
138
- this.addTabIndexToTabs();
139
- }
140
-
141
- protected addTabIndexToTabs(): void {
142
- this.node.querySelectorAll('li').forEach((tab, index) => {
143
- tab.tabIndex = 0;
144
- const handler = () => {
145
- if (tab.className.includes(GENERAL_FOLDER_TAB_CLASSNAME) && this.currentWorkspaceRoots.length > 1) {
146
- const tabRect = tab.getBoundingClientRect();
147
- this.openContextMenu(tabRect, tab, 'keypress');
148
- } else {
149
- const details = this.toScopeDetails(this.titles[index]);
150
- if (details) {
151
- this.setNewScopeSelection(details);
152
- }
153
- }
154
- };
155
- tab.onkeydown = handler;
156
- tab.onclick = handler;
157
- });
158
- }
159
-
160
- protected addUserTab(): void {
161
- this.addTab(new Title({
162
- dataset: { uri: '', scope: USER_TAB_INDEX.toString() },
163
- label: USER_TAB_LABEL,
164
- owner: this,
165
- className: PREFERENCE_TAB_CLASSNAME
166
- }));
167
- }
168
-
169
- protected addWorkspaceTab(currentWorkspace: FileStat): Title<Widget> {
170
- const scopeDetails = this.getWorkspaceDataset(currentWorkspace);
171
- const workspaceTabTitle = new Title({
172
- dataset: this.toDataSet(scopeDetails),
173
- label: WORKSPACE_TAB_LABEL,
174
- owner: this,
175
- className: PREFERENCE_TAB_CLASSNAME,
176
- });
177
- this.addTab(workspaceTabTitle);
178
- return workspaceTabTitle;
179
- }
180
-
181
- protected getWorkspaceDataset(currentWorkspace: FileStat): Preference.SelectedScopeDetails {
182
- const { resource, isDirectory } = currentWorkspace;
183
- const scope = WORKSPACE_TAB_INDEX;
184
- return { uri: resource.toString(), activeScopeIsFolder: isDirectory, scope };
185
- }
186
-
187
- protected addOrUpdateFolderTab(): void {
188
- if (!!this.workspaceService.workspace) {
189
- this.currentWorkspaceRoots = this.workspaceService.tryGetRoots();
190
- const multipleFolderRootsAreAvailable = this.currentWorkspaceRoots && this.currentWorkspaceRoots.length > 1;
191
- const noFolderRootsAreAvailable = this.currentWorkspaceRoots.length === 0;
192
- const shouldShowFoldersSeparately = this.workspaceService.saved;
193
-
194
- if (!noFolderRootsAreAvailable) {
195
- if (!this.folderTitle) {
196
- this.folderTitle = new Title({
197
- label: '',
198
- caption: FOLDER_TAB_LABEL,
199
- owner: this,
200
- });
201
- }
202
-
203
- this.setFolderTitleProperties(multipleFolderRootsAreAvailable);
204
- if (multipleFolderRootsAreAvailable || shouldShowFoldersSeparately) {
205
- this.addTab(this.folderTitle);
206
- }
207
- } else {
208
- const folderTabIndex = this.titles.findIndex(title => title.caption === FOLDER_TAB_LABEL);
209
-
210
- if (folderTabIndex > -1) {
211
- this.removeTabAt(folderTabIndex);
212
- }
213
- }
214
- }
215
- }
216
-
217
- protected setFolderTitleProperties(multipleFolderRootsAreAvailable: boolean): void {
218
- this.folderTitle.iconClass = multipleFolderRootsAreAvailable ? FOLDER_DROPDOWN_ICON_CLASSNAME : '';
219
- if (this.currentSelection.scope === FOLDER_TAB_INDEX) {
220
- this.folderTitle.label = this.labelProvider.getName(new URI(this.currentSelection.uri));
221
- this.folderTitle.dataset = this.toDataSet(this.currentSelection);
222
- this.folderTitle.className = multipleFolderRootsAreAvailable ? SELECTED_FOLDER_DROPDOWN_CLASSNAME : SINGLE_FOLDER_TAB_CLASSNAME;
223
- } else {
224
- const singleFolderRoot = this.currentWorkspaceRoots[0].resource;
225
- const singleFolderLabel = this.labelProvider.getName(singleFolderRoot);
226
- const defaultURI = multipleFolderRootsAreAvailable ? '' : singleFolderRoot.toString();
227
- this.folderTitle.label = multipleFolderRootsAreAvailable ? FOLDER_TAB_LABEL : singleFolderLabel;
228
- this.folderTitle.className = multipleFolderRootsAreAvailable ? UNSELECTED_FOLDER_DROPDOWN_CLASSNAME : SINGLE_FOLDER_TAB_CLASSNAME;
229
- this.folderTitle.dataset = { folderTitle: 'true', scope: FOLDER_TAB_INDEX.toString(), uri: defaultURI };
230
- }
231
- }
232
-
233
- protected folderSelectionCallback = (newScope: Preference.SelectedScopeDetails): void => { this.setNewScopeSelection(newScope); };
234
-
235
- protected getFolderContextMenu(workspaceRoots = this.workspaceService.tryGetRoots()): void {
236
- this.preferencesMenuFactory.createFolderWorkspacesMenu(workspaceRoots, this.currentSelection.uri);
237
- }
238
-
239
- override handleEvent(): void {
240
- // Don't - the handlers are defined in PreferenceScopeTabbarWidget.addTabIndexToTabs()
241
- }
242
-
243
- protected openContextMenu(tabRect: DOMRect | ClientRect, folderTabNode: HTMLElement, source: 'click' | 'keypress'): void {
244
- const toDisposeOnHide = new DisposableCollection();
245
- for (const root of this.workspaceService.tryGetRoots()) {
246
- const id = `set-scope-to-${root.resource.toString()}`;
247
- toDisposeOnHide.pushAll([
248
- this.commandRegistry.registerCommand(
249
- { id },
250
- { execute: () => this.setScope(root.resource) }
251
- ),
252
- this.menuModelRegistry.registerMenuAction(PreferenceMenus.FOLDER_SCOPE_MENU_PATH,
253
- {
254
- commandId: id,
255
- label: this.labelProvider.getName(root),
256
- }
257
- )
258
- ]);
259
- }
260
- this.contextMenuRenderer.render({
261
- menuPath: PreferenceMenus.FOLDER_SCOPE_MENU_PATH,
262
- anchor: { x: tabRect.left, y: tabRect.bottom },
263
- onHide: () => {
264
- setTimeout(() => toDisposeOnHide.dispose());
265
- if (source === 'click') { folderTabNode.blur(); }
266
- }
267
- });
268
- }
269
-
270
- protected doUpdateDisplay(newRoots: FileStat[]): void {
271
- const folderWasRemoved = newRoots.length < this.currentWorkspaceRoots.length;
272
- this.currentWorkspaceRoots = newRoots;
273
- if (folderWasRemoved) {
274
- const removedFolderWasSelectedScope = !this.currentWorkspaceRoots.some(root => root.resource.toString() === this.currentSelection.uri);
275
- if (removedFolderWasSelectedScope) {
276
- this.setNewScopeSelection(Preference.DEFAULT_SCOPE);
277
- }
278
- }
279
- this.updateWorkspaceTab();
280
- this.addOrUpdateFolderTab();
281
- }
282
-
283
- protected updateWorkspaceTab(): void {
284
- const currentWorkspace = this.workspaceService.workspace;
285
- if (currentWorkspace) {
286
- const workspaceTitle = this.titles.find(title => title.label === WORKSPACE_TAB_LABEL) ?? this.addWorkspaceTab(currentWorkspace);
287
- const scopeDetails = this.getWorkspaceDataset(currentWorkspace);
288
- workspaceTitle.dataset = this.toDataSet(scopeDetails);
289
- if (this.currentSelection.scope === PreferenceScope.Workspace) {
290
- this.setNewScopeSelection(scopeDetails);
291
- }
292
- }
293
- }
294
-
295
- protected emitNewScope(): void {
296
- this.onScopeChangedEmitter.fire(this.currentSelection);
297
- }
298
-
299
- setScope(scope: PreferenceScope.User | PreferenceScope.Workspace | URI): void {
300
- const details = scope instanceof URI ? this.getDetailsForResource(scope) : this.getDetailsForScope(scope);
301
- if (details) {
302
- this.setNewScopeSelection(details);
303
- }
304
- }
305
-
306
- protected getDetailsForScope(scope: PreferenceScope.User | PreferenceScope.Workspace): Preference.SelectedScopeDetails | undefined {
307
- const stringifiedSelectionScope = scope.toString();
308
- const correspondingTitle = this.titles.find(title => title.dataset.scope === stringifiedSelectionScope);
309
- return this.toScopeDetails(correspondingTitle);
310
- }
311
-
312
- protected getDetailsForResource(resource: URI): Preference.SelectedScopeDetails | undefined {
313
- const parent = this.workspaceService.getWorkspaceRootUri(resource);
314
- if (!parent) {
315
- return undefined;
316
- }
317
- if (!this.workspaceService.isMultiRootWorkspaceOpened) {
318
- return this.getDetailsForScope(PreferenceScope.Workspace);
319
- }
320
- return ({ scope: PreferenceScope.Folder, uri: parent.toString(), activeScopeIsFolder: true });
321
- }
322
-
323
- storeState(): PreferencesScopeTabBarState {
324
- return {
325
- scopeDetails: this.currentScope
326
- };
327
- }
328
-
329
- restoreState(oldState: PreferencesScopeTabBarState): void {
330
- const scopeDetails = this.toScopeDetails(oldState.scopeDetails);
331
- if (scopeDetails) {
332
- this.setNewScopeSelection(scopeDetails);
333
- }
334
- }
335
-
336
- toggleShadow(showShadow: boolean): void {
337
- this.toggleClass(SHADOW_CLASSNAME, showShadow);
338
- }
339
-
340
- override dispose(): void {
341
- super.dispose();
342
- this.toDispose.dispose();
343
- }
344
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2020 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
18
+ import { TabBar, Widget, Title } from '@theia/core/shared/@phosphor/widgets';
19
+ import { PreferenceScope, Message, ContextMenuRenderer, LabelProvider, StatefulWidget, codicon } from '@theia/core/lib/browser';
20
+ import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
21
+ import URI from '@theia/core/lib/common/uri';
22
+ import { FileStat } from '@theia/filesystem/lib/common/files';
23
+ import { PreferenceScopeCommandManager } from '../util/preference-scope-command-manager';
24
+ import { Preference, PreferenceMenus } from '../util/preference-types';
25
+ import { CommandRegistry, DisposableCollection, Emitter, MenuModelRegistry } from '@theia/core/lib/common';
26
+ import { nls } from '@theia/core/lib/common/nls';
27
+
28
+ const USER_TAB_LABEL = nls.localizeByDefault('User');
29
+ const USER_TAB_INDEX = PreferenceScope['User'];
30
+ const WORKSPACE_TAB_LABEL = nls.localizeByDefault('Workspace');
31
+ const WORKSPACE_TAB_INDEX = PreferenceScope['Workspace'];
32
+ const FOLDER_TAB_LABEL = nls.localizeByDefault('Folder');
33
+ const FOLDER_TAB_INDEX = PreferenceScope['Folder'];
34
+
35
+ const PREFERENCE_TAB_CLASSNAME = 'preferences-scope-tab';
36
+ const GENERAL_FOLDER_TAB_CLASSNAME = 'preference-folder';
37
+ const LABELED_FOLDER_TAB_CLASSNAME = 'preferences-folder-tab';
38
+ const FOLDER_DROPDOWN_CLASSNAME = 'preferences-folder-dropdown';
39
+ const FOLDER_DROPDOWN_ICON_CLASSNAME = 'preferences-folder-dropdown-icon ' + codicon('chevron-down');
40
+ const TABBAR_UNDERLINE_CLASSNAME = 'tabbar-underline';
41
+ const SINGLE_FOLDER_TAB_CLASSNAME = `${PREFERENCE_TAB_CLASSNAME} ${GENERAL_FOLDER_TAB_CLASSNAME} ${LABELED_FOLDER_TAB_CLASSNAME}`;
42
+ const UNSELECTED_FOLDER_DROPDOWN_CLASSNAME = `${PREFERENCE_TAB_CLASSNAME} ${GENERAL_FOLDER_TAB_CLASSNAME} ${FOLDER_DROPDOWN_CLASSNAME}`;
43
+ const SELECTED_FOLDER_DROPDOWN_CLASSNAME = `${PREFERENCE_TAB_CLASSNAME} ${GENERAL_FOLDER_TAB_CLASSNAME} ${LABELED_FOLDER_TAB_CLASSNAME} ${FOLDER_DROPDOWN_CLASSNAME}`;
44
+ const SHADOW_CLASSNAME = 'with-shadow';
45
+
46
+ export interface PreferencesScopeTabBarState {
47
+ scopeDetails: Preference.SelectedScopeDetails;
48
+ }
49
+
50
+ @injectable()
51
+ export class PreferencesScopeTabBar extends TabBar<Widget> implements StatefulWidget {
52
+
53
+ static ID = 'preferences-scope-tab-bar';
54
+ @inject(WorkspaceService) protected readonly workspaceService: WorkspaceService;
55
+ @inject(PreferenceScopeCommandManager) protected readonly preferencesMenuFactory: PreferenceScopeCommandManager;
56
+ @inject(ContextMenuRenderer) protected readonly contextMenuRenderer: ContextMenuRenderer;
57
+ @inject(LabelProvider) protected readonly labelProvider: LabelProvider;
58
+ @inject(CommandRegistry) protected readonly commandRegistry: CommandRegistry;
59
+ @inject(MenuModelRegistry) protected readonly menuModelRegistry: MenuModelRegistry;
60
+
61
+ protected readonly onScopeChangedEmitter = new Emitter<Preference.SelectedScopeDetails>();
62
+ readonly onScopeChanged = this.onScopeChangedEmitter.event;
63
+
64
+ protected toDispose = new DisposableCollection();
65
+ protected folderTitle: Title<Widget>;
66
+ protected currentWorkspaceRoots: FileStat[] = [];
67
+ protected currentSelection: Preference.SelectedScopeDetails = Preference.DEFAULT_SCOPE;
68
+ protected editorScrollAtTop = true;
69
+
70
+ get currentScope(): Preference.SelectedScopeDetails {
71
+ return this.currentSelection;
72
+ }
73
+
74
+ protected setNewScopeSelection(newSelection: Preference.SelectedScopeDetails): void {
75
+ const stringifiedSelectionScope = newSelection.scope.toString();
76
+ const newIndex = this.titles.findIndex(title => title.dataset.scope === stringifiedSelectionScope);
77
+ if (newIndex !== -1) {
78
+ this.currentSelection = newSelection;
79
+ this.currentIndex = newIndex;
80
+ if (newSelection.scope === PreferenceScope.Folder) {
81
+ this.addOrUpdateFolderTab();
82
+ }
83
+ this.emitNewScope();
84
+ }
85
+ }
86
+
87
+ @postConstruct()
88
+ protected init(): void {
89
+ this.id = PreferencesScopeTabBar.ID;
90
+ this.setupInitialDisplay();
91
+
92
+ this.tabActivateRequested.connect((sender, args) => {
93
+ const scopeDetails = this.toScopeDetails(args.title);
94
+ if (scopeDetails) {
95
+ this.setNewScopeSelection(scopeDetails);
96
+ }
97
+ });
98
+ this.toDispose.pushAll([
99
+ this.workspaceService.onWorkspaceChanged(newRoots => this.doUpdateDisplay(newRoots)),
100
+ this.workspaceService.onWorkspaceLocationChanged(() => this.doUpdateDisplay(this.workspaceService.tryGetRoots())),
101
+ ]);
102
+ const tabUnderline = document.createElement('div');
103
+ tabUnderline.className = TABBAR_UNDERLINE_CLASSNAME;
104
+ this.node.append(tabUnderline);
105
+ }
106
+
107
+ protected toScopeDetails(title?: Title<Widget> | Preference.SelectedScopeDetails): Preference.SelectedScopeDetails | undefined {
108
+ if (title) {
109
+ const source = 'dataset' in title ? title.dataset : title;
110
+ const { scope, uri, activeScopeIsFolder } = source;
111
+ return {
112
+ scope: Number(scope),
113
+ uri: uri || undefined,
114
+ activeScopeIsFolder: activeScopeIsFolder === 'true' || activeScopeIsFolder === true,
115
+ };
116
+ }
117
+ }
118
+
119
+ protected toDataSet(scopeDetails: Preference.SelectedScopeDetails): Title.Dataset {
120
+ const { scope, uri, activeScopeIsFolder } = scopeDetails;
121
+ return {
122
+ scope: scope.toString(),
123
+ uri: uri ?? '',
124
+ activeScopeIsFolder: activeScopeIsFolder.toString()
125
+ };
126
+ }
127
+
128
+ protected setupInitialDisplay(): void {
129
+ this.addUserTab();
130
+ if (this.workspaceService.workspace) {
131
+ this.addWorkspaceTab(this.workspaceService.workspace);
132
+ }
133
+ this.addOrUpdateFolderTab();
134
+ }
135
+
136
+ protected override onUpdateRequest(msg: Message): void {
137
+ super.onUpdateRequest(msg);
138
+ this.addTabIndexToTabs();
139
+ }
140
+
141
+ protected addTabIndexToTabs(): void {
142
+ this.node.querySelectorAll('li').forEach((tab, index) => {
143
+ tab.tabIndex = 0;
144
+ const handler = () => {
145
+ if (tab.className.includes(GENERAL_FOLDER_TAB_CLASSNAME) && this.currentWorkspaceRoots.length > 1) {
146
+ const tabRect = tab.getBoundingClientRect();
147
+ this.openContextMenu(tabRect, tab, 'keypress');
148
+ } else {
149
+ const details = this.toScopeDetails(this.titles[index]);
150
+ if (details) {
151
+ this.setNewScopeSelection(details);
152
+ }
153
+ }
154
+ };
155
+ tab.onkeydown = handler;
156
+ tab.onclick = handler;
157
+ });
158
+ }
159
+
160
+ protected addUserTab(): void {
161
+ this.addTab(new Title({
162
+ dataset: { uri: '', scope: USER_TAB_INDEX.toString() },
163
+ label: USER_TAB_LABEL,
164
+ owner: this,
165
+ className: PREFERENCE_TAB_CLASSNAME
166
+ }));
167
+ }
168
+
169
+ protected addWorkspaceTab(currentWorkspace: FileStat): Title<Widget> {
170
+ const scopeDetails = this.getWorkspaceDataset(currentWorkspace);
171
+ const workspaceTabTitle = new Title({
172
+ dataset: this.toDataSet(scopeDetails),
173
+ label: WORKSPACE_TAB_LABEL,
174
+ owner: this,
175
+ className: PREFERENCE_TAB_CLASSNAME,
176
+ });
177
+ this.addTab(workspaceTabTitle);
178
+ return workspaceTabTitle;
179
+ }
180
+
181
+ protected getWorkspaceDataset(currentWorkspace: FileStat): Preference.SelectedScopeDetails {
182
+ const { resource, isDirectory } = currentWorkspace;
183
+ const scope = WORKSPACE_TAB_INDEX;
184
+ return { uri: resource.toString(), activeScopeIsFolder: isDirectory, scope };
185
+ }
186
+
187
+ protected addOrUpdateFolderTab(): void {
188
+ if (!!this.workspaceService.workspace) {
189
+ this.currentWorkspaceRoots = this.workspaceService.tryGetRoots();
190
+ const multipleFolderRootsAreAvailable = this.currentWorkspaceRoots && this.currentWorkspaceRoots.length > 1;
191
+ const noFolderRootsAreAvailable = this.currentWorkspaceRoots.length === 0;
192
+ const shouldShowFoldersSeparately = this.workspaceService.saved;
193
+
194
+ if (!noFolderRootsAreAvailable) {
195
+ if (!this.folderTitle) {
196
+ this.folderTitle = new Title({
197
+ label: '',
198
+ caption: FOLDER_TAB_LABEL,
199
+ owner: this,
200
+ });
201
+ }
202
+
203
+ this.setFolderTitleProperties(multipleFolderRootsAreAvailable);
204
+ if (multipleFolderRootsAreAvailable || shouldShowFoldersSeparately) {
205
+ this.addTab(this.folderTitle);
206
+ }
207
+ } else {
208
+ const folderTabIndex = this.titles.findIndex(title => title.caption === FOLDER_TAB_LABEL);
209
+
210
+ if (folderTabIndex > -1) {
211
+ this.removeTabAt(folderTabIndex);
212
+ }
213
+ }
214
+ }
215
+ }
216
+
217
+ protected setFolderTitleProperties(multipleFolderRootsAreAvailable: boolean): void {
218
+ this.folderTitle.iconClass = multipleFolderRootsAreAvailable ? FOLDER_DROPDOWN_ICON_CLASSNAME : '';
219
+ if (this.currentSelection.scope === FOLDER_TAB_INDEX) {
220
+ this.folderTitle.label = this.labelProvider.getName(new URI(this.currentSelection.uri));
221
+ this.folderTitle.dataset = this.toDataSet(this.currentSelection);
222
+ this.folderTitle.className = multipleFolderRootsAreAvailable ? SELECTED_FOLDER_DROPDOWN_CLASSNAME : SINGLE_FOLDER_TAB_CLASSNAME;
223
+ } else {
224
+ const singleFolderRoot = this.currentWorkspaceRoots[0].resource;
225
+ const singleFolderLabel = this.labelProvider.getName(singleFolderRoot);
226
+ const defaultURI = multipleFolderRootsAreAvailable ? '' : singleFolderRoot.toString();
227
+ this.folderTitle.label = multipleFolderRootsAreAvailable ? FOLDER_TAB_LABEL : singleFolderLabel;
228
+ this.folderTitle.className = multipleFolderRootsAreAvailable ? UNSELECTED_FOLDER_DROPDOWN_CLASSNAME : SINGLE_FOLDER_TAB_CLASSNAME;
229
+ this.folderTitle.dataset = { folderTitle: 'true', scope: FOLDER_TAB_INDEX.toString(), uri: defaultURI };
230
+ }
231
+ }
232
+
233
+ protected folderSelectionCallback = (newScope: Preference.SelectedScopeDetails): void => { this.setNewScopeSelection(newScope); };
234
+
235
+ protected getFolderContextMenu(workspaceRoots = this.workspaceService.tryGetRoots()): void {
236
+ this.preferencesMenuFactory.createFolderWorkspacesMenu(workspaceRoots, this.currentSelection.uri);
237
+ }
238
+
239
+ override handleEvent(): void {
240
+ // Don't - the handlers are defined in PreferenceScopeTabbarWidget.addTabIndexToTabs()
241
+ }
242
+
243
+ protected openContextMenu(tabRect: DOMRect | ClientRect, folderTabNode: HTMLElement, source: 'click' | 'keypress'): void {
244
+ const toDisposeOnHide = new DisposableCollection();
245
+ for (const root of this.workspaceService.tryGetRoots()) {
246
+ const id = `set-scope-to-${root.resource.toString()}`;
247
+ toDisposeOnHide.pushAll([
248
+ this.commandRegistry.registerCommand(
249
+ { id },
250
+ { execute: () => this.setScope(root.resource) }
251
+ ),
252
+ this.menuModelRegistry.registerMenuAction(PreferenceMenus.FOLDER_SCOPE_MENU_PATH,
253
+ {
254
+ commandId: id,
255
+ label: this.labelProvider.getName(root),
256
+ }
257
+ )
258
+ ]);
259
+ }
260
+ this.contextMenuRenderer.render({
261
+ menuPath: PreferenceMenus.FOLDER_SCOPE_MENU_PATH,
262
+ anchor: { x: tabRect.left, y: tabRect.bottom },
263
+ onHide: () => {
264
+ setTimeout(() => toDisposeOnHide.dispose());
265
+ if (source === 'click') { folderTabNode.blur(); }
266
+ }
267
+ });
268
+ }
269
+
270
+ protected doUpdateDisplay(newRoots: FileStat[]): void {
271
+ const folderWasRemoved = newRoots.length < this.currentWorkspaceRoots.length;
272
+ this.currentWorkspaceRoots = newRoots;
273
+ if (folderWasRemoved) {
274
+ const removedFolderWasSelectedScope = !this.currentWorkspaceRoots.some(root => root.resource.toString() === this.currentSelection.uri);
275
+ if (removedFolderWasSelectedScope) {
276
+ this.setNewScopeSelection(Preference.DEFAULT_SCOPE);
277
+ }
278
+ }
279
+ this.updateWorkspaceTab();
280
+ this.addOrUpdateFolderTab();
281
+ }
282
+
283
+ protected updateWorkspaceTab(): void {
284
+ const currentWorkspace = this.workspaceService.workspace;
285
+ if (currentWorkspace) {
286
+ const workspaceTitle = this.titles.find(title => title.label === WORKSPACE_TAB_LABEL) ?? this.addWorkspaceTab(currentWorkspace);
287
+ const scopeDetails = this.getWorkspaceDataset(currentWorkspace);
288
+ workspaceTitle.dataset = this.toDataSet(scopeDetails);
289
+ if (this.currentSelection.scope === PreferenceScope.Workspace) {
290
+ this.setNewScopeSelection(scopeDetails);
291
+ }
292
+ }
293
+ }
294
+
295
+ protected emitNewScope(): void {
296
+ this.onScopeChangedEmitter.fire(this.currentSelection);
297
+ }
298
+
299
+ setScope(scope: PreferenceScope.User | PreferenceScope.Workspace | URI): void {
300
+ const details = scope instanceof URI ? this.getDetailsForResource(scope) : this.getDetailsForScope(scope);
301
+ if (details) {
302
+ this.setNewScopeSelection(details);
303
+ }
304
+ }
305
+
306
+ protected getDetailsForScope(scope: PreferenceScope.User | PreferenceScope.Workspace): Preference.SelectedScopeDetails | undefined {
307
+ const stringifiedSelectionScope = scope.toString();
308
+ const correspondingTitle = this.titles.find(title => title.dataset.scope === stringifiedSelectionScope);
309
+ return this.toScopeDetails(correspondingTitle);
310
+ }
311
+
312
+ protected getDetailsForResource(resource: URI): Preference.SelectedScopeDetails | undefined {
313
+ const parent = this.workspaceService.getWorkspaceRootUri(resource);
314
+ if (!parent) {
315
+ return undefined;
316
+ }
317
+ if (!this.workspaceService.isMultiRootWorkspaceOpened) {
318
+ return this.getDetailsForScope(PreferenceScope.Workspace);
319
+ }
320
+ return ({ scope: PreferenceScope.Folder, uri: parent.toString(), activeScopeIsFolder: true });
321
+ }
322
+
323
+ storeState(): PreferencesScopeTabBarState {
324
+ return {
325
+ scopeDetails: this.currentScope
326
+ };
327
+ }
328
+
329
+ restoreState(oldState: PreferencesScopeTabBarState): void {
330
+ const scopeDetails = this.toScopeDetails(oldState.scopeDetails);
331
+ if (scopeDetails) {
332
+ this.setNewScopeSelection(scopeDetails);
333
+ }
334
+ }
335
+
336
+ toggleShadow(showShadow: boolean): void {
337
+ this.toggleClass(SHADOW_CLASSNAME, showShadow);
338
+ }
339
+
340
+ override dispose(): void {
341
+ super.dispose();
342
+ this.toDispose.dispose();
343
+ }
344
+ }