@theia/core 1.53.0-next.55 → 1.53.0-next.64

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 (581) hide show
  1. package/README.md +6 -6
  2. package/i18n/nls.cs.json +582 -582
  3. package/i18n/nls.de.json +582 -582
  4. package/i18n/nls.es.json +582 -582
  5. package/i18n/nls.fr.json +582 -582
  6. package/i18n/nls.hu.json +582 -582
  7. package/i18n/nls.it.json +582 -582
  8. package/i18n/nls.ja.json +582 -582
  9. package/i18n/nls.json +582 -582
  10. package/i18n/nls.ko.json +582 -582
  11. package/i18n/nls.pl.json +582 -582
  12. package/i18n/nls.pt-br.json +582 -582
  13. package/i18n/nls.ru.json +582 -582
  14. package/i18n/nls.tr.json +582 -582
  15. package/i18n/nls.zh-cn.json +582 -582
  16. package/i18n/nls.zh-tw.json +582 -582
  17. package/lib/browser/catalog.json +54 -6
  18. package/lib/browser/common-frontend-contribution.js +3 -3
  19. package/lib/browser/common-styling-participants.js +166 -166
  20. package/lib/browser/progress-location-service.spec.js +7 -7
  21. package/lib/browser/storage-service.js +3 -3
  22. package/lib/browser/tree/tree.spec.js +75 -75
  23. package/lib/node/process-utils.spec.js +8 -8
  24. package/package.json +4 -4
  25. package/shared/ajv/index.d.ts +2 -2
  26. package/shared/markdown-it.d.ts +2 -2
  27. package/shared/markdown-it.js +1 -1
  28. package/shared/reflect-metadata/index.d.ts +1 -1
  29. package/shared/reflect-metadata/index.js +1 -1
  30. package/shared/vscode-languageserver-types/index.d.ts +1 -1
  31. package/src/browser/about-dialog.tsx +137 -137
  32. package/src/browser/authentication-service.ts +467 -467
  33. package/src/browser/breadcrumbs/breadcrumb-popup-container.ts +101 -101
  34. package/src/browser/breadcrumbs/breadcrumb-renderer.tsx +41 -41
  35. package/src/browser/breadcrumbs/breadcrumbs-constants.ts +79 -79
  36. package/src/browser/breadcrumbs/breadcrumbs-renderer.tsx +185 -185
  37. package/src/browser/breadcrumbs/breadcrumbs-service.ts +108 -108
  38. package/src/browser/breadcrumbs/index.ts +21 -21
  39. package/src/browser/browser-clipboard-service.ts +122 -122
  40. package/src/browser/browser.ts +239 -239
  41. package/src/browser/clipboard-service.ts +23 -23
  42. package/src/browser/color-application-contribution.ts +110 -110
  43. package/src/browser/color-registry.ts +60 -60
  44. package/src/browser/command-open-handler.ts +54 -54
  45. package/src/browser/common-frontend-contribution.ts +2680 -2680
  46. package/src/browser/common-styling-participants.ts +361 -361
  47. package/src/browser/connection-status-service.spec.ts +200 -200
  48. package/src/browser/connection-status-service.ts +216 -216
  49. package/src/browser/context-key-service.ts +142 -142
  50. package/src/browser/context-menu-renderer.ts +124 -124
  51. package/src/browser/core-preferences.ts +343 -343
  52. package/src/browser/credentials-service.ts +106 -106
  53. package/src/browser/decoration-style.ts +65 -65
  54. package/src/browser/decorations-service.ts +209 -209
  55. package/src/browser/dialogs/react-dialog.tsx +56 -56
  56. package/src/browser/dialogs.ts +534 -534
  57. package/src/browser/diff-uris.ts +117 -117
  58. package/src/browser/encoding-registry.ts +97 -97
  59. package/src/browser/endpoint.spec.ts +148 -148
  60. package/src/browser/endpoint.ts +136 -136
  61. package/src/browser/external-uri-service.ts +79 -79
  62. package/src/browser/file-icons-js.d.ts +20 -20
  63. package/src/browser/frontend-application-bindings.ts +62 -62
  64. package/src/browser/frontend-application-config-provider.spec.ts +45 -45
  65. package/src/browser/frontend-application-config-provider.ts +50 -50
  66. package/src/browser/frontend-application-contribution.ts +110 -110
  67. package/src/browser/frontend-application-module.ts +474 -474
  68. package/src/browser/frontend-application-state.ts +74 -74
  69. package/src/browser/frontend-application.ts +326 -326
  70. package/src/browser/hover-service.ts +218 -218
  71. package/src/browser/http-open-handler.ts +49 -49
  72. package/src/browser/i18n/i18n-frontend-module.ts +27 -27
  73. package/src/browser/i18n/language-quick-pick-service.ts +130 -130
  74. package/src/browser/icon-registry.ts +87 -87
  75. package/src/browser/icon-theme-contribution.ts +64 -64
  76. package/src/browser/icon-theme-service.ts +217 -217
  77. package/src/browser/icons/CollapseAll.svg +7 -7
  78. package/src/browser/icons/CollapseAll_inverse.svg +7 -7
  79. package/src/browser/icons/Refresh.svg +7 -7
  80. package/src/browser/icons/Refresh_inverse.svg +7 -7
  81. package/src/browser/icons/add-inverse.svg +4 -4
  82. package/src/browser/icons/add.svg +4 -4
  83. package/src/browser/icons/arrow-down-bright.svg +6 -6
  84. package/src/browser/icons/arrow-down-dark.svg +6 -6
  85. package/src/browser/icons/arrow-up-bright.svg +6 -6
  86. package/src/browser/icons/arrow-up-dark.svg +6 -6
  87. package/src/browser/icons/case-sensitive-dark.svg +16 -16
  88. package/src/browser/icons/case-sensitive.svg +16 -16
  89. package/src/browser/icons/chevron-right-dark.svg +5 -5
  90. package/src/browser/icons/chevron-right-light.svg +6 -6
  91. package/src/browser/icons/circle-bright.svg +7 -7
  92. package/src/browser/icons/circle-dark.svg +7 -7
  93. package/src/browser/icons/clear-search-results-dark.svg +7 -7
  94. package/src/browser/icons/clear-search-results.svg +7 -7
  95. package/src/browser/icons/close-all-bright.svg +7 -7
  96. package/src/browser/icons/close-all-dark.svg +7 -7
  97. package/src/browser/icons/close-bright.svg +7 -7
  98. package/src/browser/icons/close-dark.svg +7 -7
  99. package/src/browser/icons/collapse.svg +4 -4
  100. package/src/browser/icons/edit-json-dark.svg +6 -6
  101. package/src/browser/icons/edit-json.svg +6 -6
  102. package/src/browser/icons/expand.svg +4 -4
  103. package/src/browser/icons/loading-dark.svg +6 -6
  104. package/src/browser/icons/loading-light.svg +6 -6
  105. package/src/browser/icons/open-change-bright.svg +3 -3
  106. package/src/browser/icons/open-change-dark.svg +4 -4
  107. package/src/browser/icons/open-file-bright.svg +4 -4
  108. package/src/browser/icons/open-file-dark.svg +4 -4
  109. package/src/browser/icons/preview-bright.svg +3 -3
  110. package/src/browser/icons/preview-dark.svg +3 -3
  111. package/src/browser/icons/regex-dark.svg +10 -10
  112. package/src/browser/icons/regex.svg +10 -10
  113. package/src/browser/icons/remove-all-inverse.svg +4 -4
  114. package/src/browser/icons/remove-all.svg +4 -4
  115. package/src/browser/icons/replace-all-inverse.svg +13 -13
  116. package/src/browser/icons/replace-all.svg +13 -13
  117. package/src/browser/icons/replace-inverse.svg +15 -15
  118. package/src/browser/icons/replace.svg +15 -15
  119. package/src/browser/icons/whole-word-dark.svg +19 -19
  120. package/src/browser/icons/whole-word.svg +19 -19
  121. package/src/browser/index.ts +50 -50
  122. package/src/browser/json-schema-store.ts +118 -118
  123. package/src/browser/keybinding.spec.ts +554 -554
  124. package/src/browser/keybinding.ts +759 -759
  125. package/src/browser/keyboard/browser-keyboard-frontend-contribution.ts +108 -108
  126. package/src/browser/keyboard/browser-keyboard-layout-provider.spec.ts +171 -171
  127. package/src/browser/keyboard/browser-keyboard-layout-provider.ts +469 -469
  128. package/src/browser/keyboard/browser-keyboard-module.ts +30 -30
  129. package/src/browser/keyboard/index.ts +20 -20
  130. package/src/browser/keyboard/keyboard-layout-service.spec.ts +121 -121
  131. package/src/browser/keyboard/keyboard-layout-service.ts +455 -455
  132. package/src/browser/keyboard/keys.spec.ts +258 -258
  133. package/src/browser/keyboard/keys.ts +20 -20
  134. package/src/browser/keys.ts +21 -21
  135. package/src/browser/label-parser.spec.ts +165 -165
  136. package/src/browser/label-parser.ts +108 -108
  137. package/src/browser/label-provider.spec.ts +62 -62
  138. package/src/browser/label-provider.ts +385 -385
  139. package/src/browser/language-icon-provider.ts +55 -55
  140. package/src/browser/language-service.ts +77 -77
  141. package/src/browser/logger-frontend-module.ts +65 -65
  142. package/src/browser/markdown-rendering/markdown-renderer.ts +98 -98
  143. package/src/browser/menu/browser-context-menu-renderer.ts +48 -48
  144. package/src/browser/menu/browser-menu-module.ts +28 -28
  145. package/src/browser/menu/browser-menu-plugin.ts +491 -491
  146. package/src/browser/menu/context-menu-context.ts +41 -41
  147. package/src/browser/messaging/connection-source.ts +26 -26
  148. package/src/browser/messaging/frontend-id-provider.ts +37 -37
  149. package/src/browser/messaging/index.ts +18 -18
  150. package/src/browser/messaging/messaging-frontend-module.ts +41 -41
  151. package/src/browser/messaging/service-connection-provider.ts +140 -140
  152. package/src/browser/messaging/ws-connection-provider.ts +49 -49
  153. package/src/browser/messaging/ws-connection-source.ts +230 -230
  154. package/src/browser/mime-service.ts +30 -30
  155. package/src/browser/navigatable-types.ts +81 -81
  156. package/src/browser/navigatable.ts +39 -39
  157. package/src/browser/open-with-service.ts +140 -140
  158. package/src/browser/opener-service.spec.ts +49 -49
  159. package/src/browser/opener-service.ts +169 -169
  160. package/src/browser/performance/frontend-stopwatch.ts +65 -65
  161. package/src/browser/performance/index.ts +18 -18
  162. package/src/browser/performance/measurement-frontend-bindings.ts +31 -31
  163. package/src/browser/preferences/index.ts +23 -23
  164. package/src/browser/preferences/injectable-preference-proxy.ts +283 -283
  165. package/src/browser/preferences/preference-configurations.ts +82 -82
  166. package/src/browser/preferences/preference-contribution.ts +436 -436
  167. package/src/browser/preferences/preference-language-override-service.ts +111 -111
  168. package/src/browser/preferences/preference-provider.spec.ts +36 -36
  169. package/src/browser/preferences/preference-provider.ts +277 -277
  170. package/src/browser/preferences/preference-proxy.spec.ts +367 -367
  171. package/src/browser/preferences/preference-proxy.ts +367 -367
  172. package/src/browser/preferences/preference-schema-provider.spec.ts +130 -130
  173. package/src/browser/preferences/preference-scope.ts +18 -18
  174. package/src/browser/preferences/preference-service.spec.ts +613 -613
  175. package/src/browser/preferences/preference-service.ts +594 -594
  176. package/src/browser/preferences/preference-validation-service.spec.ts +334 -334
  177. package/src/browser/preferences/preference-validation-service.ts +358 -358
  178. package/src/browser/preferences/test/index.ts +19 -19
  179. package/src/browser/preferences/test/mock-preference-provider.ts +50 -50
  180. package/src/browser/preferences/test/mock-preference-proxy.ts +48 -48
  181. package/src/browser/preferences/test/mock-preference-service.ts +63 -63
  182. package/src/browser/preload/i18n-preload-contribution.ts +50 -50
  183. package/src/browser/preload/os-preload-contribution.ts +37 -37
  184. package/src/browser/preload/preload-module.ts +45 -45
  185. package/src/browser/preload/preloader.ts +37 -37
  186. package/src/browser/preload/theme-preload-contribution.ts +31 -31
  187. package/src/browser/progress-bar-factory.ts +29 -29
  188. package/src/browser/progress-bar.ts +76 -76
  189. package/src/browser/progress-client.ts +53 -53
  190. package/src/browser/progress-location-service.spec.ts +50 -50
  191. package/src/browser/progress-location-service.ts +96 -96
  192. package/src/browser/progress-status-bar-item.ts +83 -83
  193. package/src/browser/quick-input/index.ts +23 -23
  194. package/src/browser/quick-input/quick-access.ts +75 -75
  195. package/src/browser/quick-input/quick-command-frontend-contribution.ts +89 -89
  196. package/src/browser/quick-input/quick-command-service.ts +246 -246
  197. package/src/browser/quick-input/quick-help-service.ts +87 -87
  198. package/src/browser/quick-input/quick-input-frontend-contribution.ts +33 -33
  199. package/src/browser/quick-input/quick-input-service.spec.ts +176 -176
  200. package/src/browser/quick-input/quick-input-service.ts +17 -17
  201. package/src/browser/quick-input/quick-pick-service-impl.ts +69 -69
  202. package/src/browser/quick-input/quick-view-service.ts +83 -83
  203. package/src/browser/request/browser-request-module.ts +23 -23
  204. package/src/browser/request/browser-request-service.ts +172 -172
  205. package/src/browser/resource-context-key.ts +77 -77
  206. package/src/browser/saveable-service.ts +332 -332
  207. package/src/browser/saveable.ts +395 -395
  208. package/src/browser/secondary-window-handler.ts +211 -211
  209. package/src/browser/shell/additional-views-menu-widget.tsx +71 -71
  210. package/src/browser/shell/application-shell-mouse-tracker.ts +103 -103
  211. package/src/browser/shell/application-shell.ts +2271 -2271
  212. package/src/browser/shell/current-widget-command-adapter.ts +57 -57
  213. package/src/browser/shell/index.ts +23 -23
  214. package/src/browser/shell/shell-layout-restorer.ts +399 -399
  215. package/src/browser/shell/side-panel-handler.ts +794 -794
  216. package/src/browser/shell/side-panel-toolbar.ts +111 -111
  217. package/src/browser/shell/sidebar-bottom-menu-widget.tsx +39 -39
  218. package/src/browser/shell/sidebar-menu-widget.tsx +183 -183
  219. package/src/browser/shell/sidebar-top-menu-widget.tsx +26 -26
  220. package/src/browser/shell/split-panels.ts +191 -191
  221. package/src/browser/shell/tab-bar-decorator.ts +106 -106
  222. package/src/browser/shell/tab-bar-toolbar/index.ts +19 -19
  223. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.ts +31 -31
  224. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.ts +242 -242
  225. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.ts +149 -149
  226. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar.spec.ts +62 -62
  227. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar.tsx +443 -443
  228. package/src/browser/shell/tab-bars.spec.ts +63 -63
  229. package/src/browser/shell/tab-bars.ts +1468 -1468
  230. package/src/browser/shell/theia-dock-panel.ts +265 -265
  231. package/src/browser/shell/view-column-service.ts +125 -125
  232. package/src/browser/shell/view-contribution.ts +178 -178
  233. package/src/browser/source-tree/index.ts +19 -19
  234. package/src/browser/source-tree/source-tree-widget.tsx +107 -107
  235. package/src/browser/source-tree/source-tree.ts +146 -146
  236. package/src/browser/source-tree/tree-source.ts +73 -73
  237. package/src/browser/status-bar/index.ts +29 -29
  238. package/src/browser/status-bar/status-bar-types.ts +97 -97
  239. package/src/browser/status-bar/status-bar-view-model.ts +209 -209
  240. package/src/browser/status-bar/status-bar.tsx +189 -189
  241. package/src/browser/storage-service.spec.ts +76 -76
  242. package/src/browser/storage-service.ts +129 -129
  243. package/src/browser/style/about.css +36 -36
  244. package/src/browser/style/alert-messages.css +62 -62
  245. package/src/browser/style/ansi.css +88 -88
  246. package/src/browser/style/breadcrumbs.css +130 -130
  247. package/src/browser/style/dialog.css +126 -126
  248. package/src/browser/style/dockpanel.css +76 -76
  249. package/src/browser/style/hover-service.css +101 -101
  250. package/src/browser/style/icons.css +61 -61
  251. package/src/browser/style/index.css +353 -353
  252. package/src/browser/style/materialcolors.css +278 -278
  253. package/src/browser/style/menus.css +230 -230
  254. package/src/browser/style/notification.css +39 -39
  255. package/src/browser/style/os.css +87 -87
  256. package/src/browser/style/progress-bar.css +43 -43
  257. package/src/browser/style/quick-title-bar.css +45 -45
  258. package/src/browser/style/scrollbars.css +172 -172
  259. package/src/browser/style/search-box.css +123 -123
  260. package/src/browser/style/select-component.css +107 -107
  261. package/src/browser/style/sidepanel.css +367 -367
  262. package/src/browser/style/split-widget.css +38 -38
  263. package/src/browser/style/status-bar.css +127 -127
  264. package/src/browser/style/tabs.css +647 -647
  265. package/src/browser/style/tooltip.css +28 -28
  266. package/src/browser/style/tree-decorators.css +81 -81
  267. package/src/browser/style/tree.css +232 -232
  268. package/src/browser/style/view-container.css +187 -187
  269. package/src/browser/style/widget.css +19 -19
  270. package/src/browser/styling-service.ts +96 -96
  271. package/src/browser/supported-encodings.ts +262 -262
  272. package/src/browser/test/jsdom.ts +69 -69
  273. package/src/browser/test/mock-connection-status-service.ts +33 -33
  274. package/src/browser/test/mock-env-variables-server.ts +47 -47
  275. package/src/browser/test/mock-opener-service.ts +34 -34
  276. package/src/browser/test/mock-storage-service.ts +49 -49
  277. package/src/browser/theming.ts +206 -206
  278. package/src/browser/tooltip-service.tsx +96 -96
  279. package/src/browser/tree/fuzzy-search.spec.ts +99 -99
  280. package/src/browser/tree/fuzzy-search.ts +136 -136
  281. package/src/browser/tree/index.ts +29 -29
  282. package/src/browser/tree/search-box-debounce.ts +96 -96
  283. package/src/browser/tree/search-box.ts +355 -355
  284. package/src/browser/tree/test/mock-selectable-tree-model.ts +109 -109
  285. package/src/browser/tree/test/mock-tree-model.ts +136 -136
  286. package/src/browser/tree/test/tree-test-container.ts +50 -50
  287. package/src/browser/tree/tree-compression/compressed-tree-expansion-service.ts +46 -46
  288. package/src/browser/tree/tree-compression/compressed-tree-model.ts +88 -88
  289. package/src/browser/tree/tree-compression/compressed-tree-widget.tsx +203 -203
  290. package/src/browser/tree/tree-compression/index.ts +20 -20
  291. package/src/browser/tree/tree-compression/tree-compression-service.ts +125 -125
  292. package/src/browser/tree/tree-compression/tree-compression.css +28 -28
  293. package/src/browser/tree/tree-consistency.spec.ts +105 -105
  294. package/src/browser/tree/tree-container.spec.ts +45 -45
  295. package/src/browser/tree/tree-container.ts +155 -155
  296. package/src/browser/tree/tree-decorator.spec.ts +162 -162
  297. package/src/browser/tree/tree-decorator.ts +238 -238
  298. package/src/browser/tree/tree-expansion.spec.ts +173 -173
  299. package/src/browser/tree/tree-expansion.ts +165 -165
  300. package/src/browser/tree/tree-focus-service.ts +55 -55
  301. package/src/browser/tree/tree-iterator.spec.ts +170 -170
  302. package/src/browser/tree/tree-iterator.ts +256 -256
  303. package/src/browser/tree/tree-label-provider.ts +40 -40
  304. package/src/browser/tree/tree-model.ts +562 -562
  305. package/src/browser/tree/tree-navigation.ts +58 -58
  306. package/src/browser/tree/tree-preference.ts +50 -50
  307. package/src/browser/tree/tree-search.ts +128 -128
  308. package/src/browser/tree/tree-selectable.spec.ts +152 -152
  309. package/src/browser/tree/tree-selection-impl.ts +176 -176
  310. package/src/browser/tree/tree-selection-state.spec.ts +462 -462
  311. package/src/browser/tree/tree-selection-state.ts +245 -245
  312. package/src/browser/tree/tree-selection.ts +159 -159
  313. package/src/browser/tree/tree-view-welcome-widget.tsx +263 -263
  314. package/src/browser/tree/tree-widget-selection.ts +45 -45
  315. package/src/browser/tree/tree-widget.tsx +1591 -1591
  316. package/src/browser/tree/tree.spec.ts +241 -241
  317. package/src/browser/tree/tree.ts +425 -425
  318. package/src/browser/undo-redo-handler.ts +85 -85
  319. package/src/browser/user-working-directory-provider.ts +77 -77
  320. package/src/browser/view-container.ts +1640 -1640
  321. package/src/browser/widget-decoration.ts +358 -358
  322. package/src/browser/widget-manager.spec.ts +102 -102
  323. package/src/browser/widget-manager.ts +318 -318
  324. package/src/browser/widget-open-handler.ts +168 -168
  325. package/src/browser/widgets/alert-message.tsx +56 -56
  326. package/src/browser/widgets/enhanced-preview-widget.ts +27 -27
  327. package/src/browser/widgets/extractable-widget.ts +33 -33
  328. package/src/browser/widgets/index.ts +21 -21
  329. package/src/browser/widgets/previewable-widget.ts +31 -31
  330. package/src/browser/widgets/react-renderer.tsx +53 -53
  331. package/src/browser/widgets/react-widget.tsx +51 -51
  332. package/src/browser/widgets/select-component.tsx +367 -367
  333. package/src/browser/widgets/split-widget.ts +163 -163
  334. package/src/browser/widgets/widget.ts +406 -406
  335. package/src/browser/window/browser-window-module.ts +32 -32
  336. package/src/browser/window/default-secondary-window-service.ts +189 -189
  337. package/src/browser/window/default-window-service.spec.ts +78 -78
  338. package/src/browser/window/default-window-service.ts +171 -171
  339. package/src/browser/window/secondary-window-service.ts +39 -39
  340. package/src/browser/window/test/mock-window-service.ts +29 -29
  341. package/src/browser/window/window-service.ts +78 -78
  342. package/src/browser/window/window-title-service.ts +107 -107
  343. package/src/browser/window/window-title-updater.ts +95 -95
  344. package/src/browser/window-contribution.ts +64 -64
  345. package/src/browser-only/frontend-only-application-module.ts +116 -116
  346. package/src/browser-only/i18n/i18n-frontend-only-module.ts +37 -37
  347. package/src/browser-only/logger-frontend-only-module.ts +63 -63
  348. package/src/browser-only/messaging/frontend-only-service-connection-provider.ts +39 -39
  349. package/src/browser-only/messaging/messaging-frontend-only-module.ts +42 -42
  350. package/src/browser-only/preload/frontend-only-preload-module.ts +49 -49
  351. package/src/common/accessibility.ts +33 -33
  352. package/src/common/application-error.spec.ts +27 -27
  353. package/src/common/application-error.ts +76 -76
  354. package/src/common/application-protocol.ts +42 -42
  355. package/src/common/array-utils.ts +129 -129
  356. package/src/common/buffer.ts +228 -228
  357. package/src/common/cancellation.ts +163 -163
  358. package/src/common/char-code.ts +438 -438
  359. package/src/common/collections.ts +125 -125
  360. package/src/common/color.ts +103 -103
  361. package/src/common/command.spec.ts +208 -208
  362. package/src/common/command.ts +489 -489
  363. package/src/common/contribution-filter/contribution-filter-registry.ts +79 -79
  364. package/src/common/contribution-filter/contribution-filter.ts +64 -64
  365. package/src/common/contribution-filter/filter.ts +23 -23
  366. package/src/common/contribution-filter/index.ts +19 -19
  367. package/src/common/contribution-provider.ts +96 -96
  368. package/src/common/disposable.spec.ts +94 -94
  369. package/src/common/disposable.ts +188 -188
  370. package/src/common/encoding-service.ts +380 -380
  371. package/src/common/encodings.ts +24 -24
  372. package/src/common/env-variables/env-variables-protocol.ts +38 -38
  373. package/src/common/env-variables/index.ts +17 -17
  374. package/src/common/event.spec.ts +32 -32
  375. package/src/common/event.ts +493 -493
  376. package/src/common/file-uri.ts +61 -61
  377. package/src/common/frontend-application-state.ts +38 -38
  378. package/src/common/glob.ts +741 -741
  379. package/src/common/hash.ts +85 -85
  380. package/src/common/i18n/localization-server.ts +25 -25
  381. package/src/common/i18n/localization.ts +80 -80
  382. package/src/common/i18n/nls.metadata.json +34112 -34112
  383. package/src/common/index.ts +51 -51
  384. package/src/common/json-schema.ts +108 -108
  385. package/src/common/key-store.ts +26 -26
  386. package/src/common/keybinding.ts +152 -152
  387. package/src/common/keyboard/keyboard-layout-provider.ts +51 -51
  388. package/src/common/keys.ts +694 -694
  389. package/src/common/label-protocol.ts +35 -35
  390. package/src/common/logger-protocol.ts +119 -119
  391. package/src/common/logger-watcher.ts +48 -48
  392. package/src/common/logger.spec.ts +46 -46
  393. package/src/common/logger.ts +389 -389
  394. package/src/common/lsp-types.ts +34 -34
  395. package/src/common/markdown-rendering/icon-utilities.ts +30 -30
  396. package/src/common/markdown-rendering/index.ts +18 -18
  397. package/src/common/markdown-rendering/markdown-string.ts +152 -152
  398. package/src/common/menu/action-menu-node.ts +65 -65
  399. package/src/common/menu/composite-menu-node.spec.ts +67 -67
  400. package/src/common/menu/composite-menu-node.ts +114 -114
  401. package/src/common/menu/index.ts +21 -21
  402. package/src/common/menu/menu-adapter.ts +103 -103
  403. package/src/common/menu/menu-model-registry.ts +374 -374
  404. package/src/common/menu/menu-types.ts +220 -220
  405. package/src/common/menu/menu.spec.ts +101 -101
  406. package/src/common/message-rpc/channel.spec.ts +88 -88
  407. package/src/common/message-rpc/channel.ts +300 -300
  408. package/src/common/message-rpc/index.ts +22 -22
  409. package/src/common/message-rpc/message-buffer.ts +105 -105
  410. package/src/common/message-rpc/msg-pack-extension-manager.ts +70 -70
  411. package/src/common/message-rpc/rpc-message-encoder.spec.ts +65 -65
  412. package/src/common/message-rpc/rpc-message-encoder.ts +190 -190
  413. package/src/common/message-rpc/rpc-protocol.ts +255 -255
  414. package/src/common/message-rpc/uint8-array-message-buffer.spec.ts +41 -41
  415. package/src/common/message-rpc/uint8-array-message-buffer.ts +213 -213
  416. package/src/common/message-service-protocol.ts +148 -148
  417. package/src/common/message-service.ts +226 -226
  418. package/src/common/messaging/connection-error-handler.ts +73 -73
  419. package/src/common/messaging/connection-management.ts +43 -43
  420. package/src/common/messaging/handler.ts +26 -26
  421. package/src/common/messaging/index.ts +19 -19
  422. package/src/common/messaging/proxy-factory.spec.ts +108 -108
  423. package/src/common/messaging/proxy-factory.ts +336 -336
  424. package/src/common/messaging/socket-write-buffer.ts +52 -52
  425. package/src/common/messaging/web-socket-channel.ts +76 -76
  426. package/src/common/nls.ts +151 -151
  427. package/src/common/numbers.ts +21 -21
  428. package/src/common/objects.spec.ts +112 -112
  429. package/src/common/objects.ts +123 -123
  430. package/src/common/os.ts +82 -82
  431. package/src/common/path.spec.ts +415 -415
  432. package/src/common/path.ts +334 -334
  433. package/src/common/paths.ts +250 -250
  434. package/src/common/performance/index.ts +19 -19
  435. package/src/common/performance/measurement-protocol.ts +104 -104
  436. package/src/common/performance/measurement.ts +130 -130
  437. package/src/common/performance/stopwatch.ts +183 -183
  438. package/src/common/preferences/preference-schema.ts +101 -101
  439. package/src/common/preferences/preference-scope.spec.ts +48 -48
  440. package/src/common/preferences/preference-scope.ts +68 -68
  441. package/src/common/prioritizeable.ts +58 -58
  442. package/src/common/progress-service-protocol.ts +35 -35
  443. package/src/common/progress-service.ts +82 -82
  444. package/src/common/promise-util.spec.ts +102 -102
  445. package/src/common/promise-util.ts +143 -143
  446. package/src/common/quick-pick-service.ts +353 -353
  447. package/src/common/reference.spec.ts +145 -145
  448. package/src/common/reference.ts +230 -230
  449. package/src/common/resource.ts +430 -430
  450. package/src/common/selection-command-handler.ts +101 -101
  451. package/src/common/selection-service.spec.ts +43 -43
  452. package/src/common/selection-service.ts +49 -49
  453. package/src/common/selection.ts +50 -50
  454. package/src/common/severity.ts +111 -111
  455. package/src/common/stream.ts +718 -718
  456. package/src/common/strings.ts +231 -231
  457. package/src/common/telemetry.ts +45 -45
  458. package/src/common/ternary-search-tree.ts +417 -417
  459. package/src/common/test/expect.ts +34 -34
  460. package/src/common/test/mock-logger.ts +118 -118
  461. package/src/common/test/mock-menu.ts +35 -35
  462. package/src/common/test/mock-resource-provider.ts +33 -33
  463. package/src/common/theme.ts +68 -68
  464. package/src/common/types.spec.ts +86 -86
  465. package/src/common/types.ts +140 -140
  466. package/src/common/uri-command-handler.spec.ts +90 -90
  467. package/src/common/uri-command-handler.ts +148 -148
  468. package/src/common/uri.spec.ts +278 -278
  469. package/src/common/uri.ts +279 -279
  470. package/src/common/uuid.ts +45 -45
  471. package/src/common/version.ts +17 -17
  472. package/src/common/view-column.ts +33 -33
  473. package/src/common/window.ts +34 -34
  474. package/src/electron-browser/electron-clipboard-service.ts +32 -32
  475. package/src/electron-browser/electron-uri-handler.ts +42 -42
  476. package/src/electron-browser/keyboard/electron-keyboard-layout-change-notifier.ts +39 -39
  477. package/src/electron-browser/keyboard/electron-keyboard-module.ts +28 -28
  478. package/src/electron-browser/menu/electron-context-menu-renderer.ts +122 -122
  479. package/src/electron-browser/menu/electron-main-menu-factory.ts +339 -339
  480. package/src/electron-browser/menu/electron-menu-contribution.ts +506 -506
  481. package/src/electron-browser/menu/electron-menu-module.ts +40 -40
  482. package/src/electron-browser/menu/electron-menu-style.css +110 -110
  483. package/src/electron-browser/messaging/electron-frontend-id-provider.ts +25 -25
  484. package/src/electron-browser/messaging/electron-ipc-connection-source.ts +65 -65
  485. package/src/electron-browser/messaging/electron-local-ws-connection-source.ts +45 -45
  486. package/src/electron-browser/messaging/electron-messaging-frontend-module.ts +78 -78
  487. package/src/electron-browser/messaging/electron-ws-connection-source.ts +38 -38
  488. package/src/electron-browser/preload.ts +264 -264
  489. package/src/electron-browser/request/electron-browser-request-module.ts +26 -26
  490. package/src/electron-browser/token/electron-token-frontend-module.ts +22 -22
  491. package/src/electron-browser/window/electron-frontend-application-state.ts +26 -26
  492. package/src/electron-browser/window/electron-secondary-window-service.ts +35 -35
  493. package/src/electron-browser/window/electron-window-module.ts +48 -48
  494. package/src/electron-browser/window/electron-window-preferences.ts +76 -76
  495. package/src/electron-browser/window/electron-window-service.ts +109 -109
  496. package/src/electron-browser/window/external-app-open-handler.ts +42 -42
  497. package/src/electron-common/electron-api.ts +157 -157
  498. package/src/electron-common/electron-main-window-service.ts +24 -24
  499. package/src/electron-common/electron-token.ts +27 -27
  500. package/src/electron-main/electron-api-main.ts +373 -373
  501. package/src/electron-main/electron-main-application-module.ts +65 -65
  502. package/src/electron-main/electron-main-application.ts +860 -860
  503. package/src/electron-main/electron-main-constants.ts +23 -23
  504. package/src/electron-main/electron-main-window-service-impl.ts +44 -44
  505. package/src/electron-main/electron-security-token-service.ts +36 -36
  506. package/src/electron-main/event-utils.ts +36 -36
  507. package/src/electron-main/messaging/electron-connection-handler.ts +21 -21
  508. package/src/electron-main/messaging/electron-messaging-contribution.ts +143 -143
  509. package/src/electron-main/messaging/electron-messaging-service.ts +35 -35
  510. package/src/electron-main/theia-electron-window.ts +219 -219
  511. package/src/electron-node/cli/electron-backend-cli-module.ts +24 -24
  512. package/src/electron-node/cli/electron-cli-contribution.ts +35 -35
  513. package/src/electron-node/hosting/electron-backend-hosting-module.ts +24 -24
  514. package/src/electron-node/hosting/electron-ws-origin-validator.ts +37 -37
  515. package/src/electron-node/keyboard/electron-backend-keyboard-module.ts +30 -30
  516. package/src/electron-node/keyboard/electron-keyboard-layout-provider.ts +35 -35
  517. package/src/electron-node/request/electron-backend-request-module.ts +23 -23
  518. package/src/electron-node/request/electron-backend-request-service.ts +78 -78
  519. package/src/electron-node/token/electron-token-backend-contribution.ts +48 -48
  520. package/src/electron-node/token/electron-token-backend-module.ts +28 -28
  521. package/src/electron-node/token/electron-token-validator.ts +93 -93
  522. package/src/node/application-server.ts +59 -59
  523. package/src/node/backend-application-config-provider.spec.ts +29 -29
  524. package/src/node/backend-application-config-provider.ts +48 -48
  525. package/src/node/backend-application-module.ts +139 -139
  526. package/src/node/backend-application.ts +374 -374
  527. package/src/node/cli.spec.ts +94 -94
  528. package/src/node/cli.ts +63 -63
  529. package/src/node/console-logger-server.spec.ts +59 -59
  530. package/src/node/console-logger-server.ts +76 -76
  531. package/src/node/debug.ts +30 -30
  532. package/src/node/dynamic-require.ts +56 -56
  533. package/src/node/env-variables/env-variables-server.ts +123 -123
  534. package/src/node/env-variables/index.ts +17 -17
  535. package/src/node/environment-utils.spec.ts +92 -92
  536. package/src/node/environment-utils.ts +66 -66
  537. package/src/node/file-uri.spec.ts +76 -76
  538. package/src/node/filesystem-locking.ts +77 -77
  539. package/src/node/hosting/backend-application-hosts.ts +60 -60
  540. package/src/node/hosting/backend-hosting-module.ts +26 -26
  541. package/src/node/hosting/ws-origin-validator.ts +36 -36
  542. package/src/node/i18n/i18n-backend-module.ts +42 -42
  543. package/src/node/i18n/localization-contribution.ts +112 -112
  544. package/src/node/i18n/localization-provider.ts +125 -125
  545. package/src/node/i18n/localization-server.ts +52 -52
  546. package/src/node/i18n/theia-localization-contribution.ts +40 -40
  547. package/src/node/index.ts +22 -22
  548. package/src/node/key-store-server.ts +162 -162
  549. package/src/node/logger-backend-module.ts +88 -88
  550. package/src/node/logger-cli-contribution.spec.ts +245 -245
  551. package/src/node/logger-cli-contribution.ts +168 -168
  552. package/src/node/main.ts +33 -33
  553. package/src/node/messaging/binary-message-pipe.ts +168 -168
  554. package/src/node/messaging/connection-container-module.ts +96 -96
  555. package/src/node/messaging/default-messaging-service.ts +129 -129
  556. package/src/node/messaging/frontend-connection-service.ts +24 -24
  557. package/src/node/messaging/index.ts +19 -19
  558. package/src/node/messaging/ipc-bootstrap.ts +27 -27
  559. package/src/node/messaging/ipc-channel.ts +77 -77
  560. package/src/node/messaging/ipc-connection-provider.ts +107 -107
  561. package/src/node/messaging/ipc-protocol.ts +76 -76
  562. package/src/node/messaging/messaging-backend-module.ts +52 -52
  563. package/src/node/messaging/messaging-listeners.ts +52 -52
  564. package/src/node/messaging/messaging-service.ts +46 -46
  565. package/src/node/messaging/test/test-web-socket-channel.ts +61 -61
  566. package/src/node/messaging/websocket-endpoint.ts +79 -79
  567. package/src/node/messaging/websocket-frontend-connection-service.ts +186 -186
  568. package/src/node/os-backend-provider.ts +25 -25
  569. package/src/node/performance/index.ts +18 -18
  570. package/src/node/performance/measurement-backend-bindings.ts +35 -35
  571. package/src/node/performance/node-stopwatch.ts +40 -40
  572. package/src/node/process-utils.spec.ts +48 -48
  573. package/src/node/process-utils.ts +102 -102
  574. package/src/node/remote/backend-remote-service.ts +25 -25
  575. package/src/node/remote/remote-cli-contribution.ts +34 -34
  576. package/src/node/remote/remote-copy-contribution.ts +45 -45
  577. package/src/node/request/backend-request-facade.ts +39 -39
  578. package/src/node/request/backend-request-module.ts +25 -25
  579. package/src/node/request/proxy-cli-contribution.ts +65 -65
  580. package/src/node/ws-request-validators.ts +56 -56
  581. package/src/typings/native-keymap.d.ts +108 -108
@@ -1,594 +1,594 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2018 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-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- /* eslint-disable @typescript-eslint/no-explicit-any */
18
-
19
- import { injectable, inject, postConstruct } from 'inversify';
20
- import { Event, Emitter, DisposableCollection, Disposable, deepFreeze, unreachable } from '../../common';
21
- import { Deferred } from '../../common/promise-util';
22
- import { PreferenceProvider, PreferenceProviderDataChange, PreferenceProviderDataChanges, PreferenceResolveResult } from './preference-provider';
23
- import { PreferenceSchemaProvider } from './preference-contribution';
24
- import URI from '../../common/uri';
25
- import { PreferenceScope } from './preference-scope';
26
- import { PreferenceConfigurations } from './preference-configurations';
27
- import { JSONExt, JSONValue } from '@phosphor/coreutils/lib/json';
28
- import { OverridePreferenceName, PreferenceLanguageOverrideService } from './preference-language-override-service';
29
-
30
- export { PreferenceScope };
31
-
32
- /**
33
- * Representation of a preference change. A preference value can be set to `undefined` for a specific scope.
34
- * This means that the value from a more general scope will be used.
35
- */
36
- export interface PreferenceChange extends PreferenceProviderDataChange {
37
- /**
38
- * Tests wether the given resource is affected by the preference change.
39
- * @param resourceUri the uri of the resource to test.
40
- */
41
- affects(resourceUri?: string): boolean;
42
- }
43
-
44
- export class PreferenceChangeImpl implements PreferenceChange {
45
- protected readonly change: PreferenceProviderDataChange;
46
- constructor(change: PreferenceProviderDataChange) {
47
- this.change = deepFreeze(change);
48
- }
49
-
50
- get preferenceName(): string {
51
- return this.change.preferenceName;
52
- }
53
- get newValue(): string {
54
- return this.change.newValue;
55
- }
56
- get oldValue(): string {
57
- return this.change.oldValue;
58
- }
59
- get scope(): PreferenceScope {
60
- return this.change.scope;
61
- }
62
- get domain(): string[] | undefined {
63
- return this.change.domain;
64
- }
65
-
66
- // TODO add tests
67
- affects(resourceUri?: string): boolean {
68
- const resourcePath = resourceUri && new URI(resourceUri).path;
69
- const domain = this.change.domain;
70
- return !resourcePath || !domain || domain.some(uri => new URI(uri).path.relativity(resourcePath) >= 0);
71
- }
72
- }
73
- /**
74
- * A key-value storage for {@link PreferenceChange}s. Used to aggregate multiple simultaneous preference changes.
75
- */
76
- export interface PreferenceChanges {
77
- [preferenceName: string]: PreferenceChange
78
- }
79
-
80
- export const PreferenceService = Symbol('PreferenceService');
81
- /**
82
- * Service to manage preferences including, among others, getting and setting preference values as well
83
- * as listening to preference changes.
84
- *
85
- * Depending on your use case you might also want to look at {@link createPreferenceProxy} with which
86
- * you can easily create a typesafe schema-based interface for your preferences. Internally the proxy
87
- * uses the PreferenceService so both approaches are compatible.
88
- */
89
- export interface PreferenceService extends Disposable {
90
- /**
91
- * Promise indicating whether the service successfully initialized.
92
- */
93
- readonly ready: Promise<void>;
94
- /**
95
- * Indicates whether the service has successfully initialized. Will be `true` when {@link PreferenceService.ready the `ready` Promise} resolves.
96
- */
97
- readonly isReady: boolean;
98
- /**
99
- * Retrieve the stored value for the given preference.
100
- *
101
- * @param preferenceName the preference identifier.
102
- *
103
- * @returns the value stored for the given preference when it exists, `undefined` otherwise.
104
- */
105
- get<T>(preferenceName: string): T | undefined;
106
- /**
107
- * Retrieve the stored value for the given preference.
108
- *
109
- * @param preferenceName the preference identifier.
110
- * @param defaultValue the value to return when no value for the given preference is stored.
111
- *
112
- * @returns the value stored for the given preference when it exists, otherwise the given default value.
113
- */
114
- get<T>(preferenceName: string, defaultValue: T): T;
115
- /**
116
- * Retrieve the stored value for the given preference and resourceUri.
117
- *
118
- * @param preferenceName the preference identifier.
119
- * @param defaultValue the value to return when no value for the given preference is stored.
120
- * @param resourceUri the uri of the resource for which the preference is stored. This used to retrieve
121
- * a potentially different value for the same preference for different resources, for example `files.encoding`.
122
- *
123
- * @returns the value stored for the given preference and resourceUri when it exists, otherwise the given
124
- * default value.
125
- */
126
- get<T>(preferenceName: string, defaultValue: T, resourceUri?: string): T;
127
- /**
128
- * Retrieve the stored value for the given preference and resourceUri.
129
- *
130
- * @param preferenceName the preference identifier.
131
- * @param defaultValue the value to return when no value for the given preference is stored.
132
- * @param resourceUri the uri of the resource for which the preference is stored. This used to retrieve
133
- * a potentially different value for the same preference for different resources, for example `files.encoding`.
134
- *
135
- * @returns the value stored for the given preference and resourceUri when it exists, otherwise the given
136
- * default value.
137
- */
138
- get<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined;
139
- /**
140
- * Sets the given preference to the given value.
141
- *
142
- * @param preferenceName the preference identifier.
143
- * @param value the new value of the preference.
144
- * @param scope the scope for which the value shall be set, i.e. user, workspace etc.
145
- * When the folder scope is specified a resourceUri must be provided.
146
- * @param resourceUri the uri of the resource for which the preference is stored. This used to store
147
- * a potentially different value for the same preference for different resources, for example `files.encoding`.
148
- *
149
- * @returns a promise which resolves to `undefined` when setting the preference was successful. Otherwise it rejects
150
- * with an error.
151
- */
152
- set(preferenceName: string, value: any, scope?: PreferenceScope, resourceUri?: string): Promise<void>;
153
-
154
- /**
155
- * Determines and applies the changes necessary to apply `value` to either the `resourceUri` supplied or the active session.
156
- * If there is no setting for the `preferenceName`, the change will be applied in user scope.
157
- * If there is a setting conflicting with the specified `value`, the change will be applied in the most specific scope with a conflicting value.
158
- *
159
- * @param preferenceName the identifier of the preference to modify.
160
- * @param value the value to which to set the preference. `undefined` will reset the preference to its default value.
161
- * @param resourceUri the uri of the resource to which the change is to apply. If none is provided, folder scope will be ignored.
162
- */
163
- updateValue(preferenceName: string, value: any, resourceUri?: string): Promise<void>
164
-
165
- /**
166
- * Registers a callback which will be called whenever a preference is changed.
167
- */
168
- onPreferenceChanged: Event<PreferenceChange>;
169
- /**
170
- * Registers a callback which will be called whenever one or more preferences are changed.
171
- */
172
- onPreferencesChanged: Event<PreferenceChanges>;
173
- /**
174
- * Retrieve the stored value for the given preference and resourceUri in all available scopes.
175
- *
176
- * @param preferenceName the preference identifier.
177
- * @param resourceUri the uri of the resource for which the preference is stored.
178
- * @param forceLanguageOverride if `true` and `preferenceName` is a language override, only values for the specified override will be returned.
179
- * Otherwise, values for the override will be returned where defined, and values from the base preference will be returned otherwise.
180
- *
181
- * @return an object containing the value of the given preference for all scopes.
182
- */
183
- inspect<T extends JSONValue>(preferenceName: string, resourceUri?: string, forceLanguageOverride?: boolean): PreferenceInspection<T> | undefined;
184
- /**
185
- * For behavior, see {@link PreferenceService.inspect}.
186
- *
187
- * @returns the value in the scope specified.
188
- */
189
- inspectInScope<T extends JSONValue>(preferenceName: string, scope: PreferenceScope, resourceUri?: string, forceLanguageOverride?: boolean): T | undefined
190
- /**
191
- * Returns a new preference identifier based on the given OverridePreferenceName.
192
- *
193
- * @param options the override specification.
194
- *
195
- * @returns the calculated string based on the given OverridePreferenceName.
196
- */
197
- overridePreferenceName(options: OverridePreferenceName): string;
198
- /**
199
- * Tries to split the given preference identifier into the original OverridePreferenceName attributes
200
- * with which this identifier was created. Returns `undefined` if this is not possible, for example
201
- * when the given preference identifier was not generated by `overridePreferenceName`.
202
- *
203
- * This method is checked when resolving preferences. Therefore together with "overridePreferenceName"
204
- * this can be used to handle specialized preferences, e.g. "[markdown].editor.autoIndent" and "editor.autoIndent".
205
- *
206
- * @param preferenceName the preferenceName which might have been created via {@link PreferenceService.overridePreferenceName}.
207
- *
208
- * @returns the OverridePreferenceName which was used to create the given `preferenceName` if this was the case,
209
- * `undefined` otherwise.
210
- */
211
- overriddenPreferenceName(preferenceName: string): OverridePreferenceName | undefined;
212
- /**
213
- * Retrieve the stored value for the given preference and resourceUri.
214
- *
215
- * @param preferenceName the preference identifier.
216
- * @param defaultValue the value to return when no value for the given preference is stored.
217
- * @param resourceUri the uri of the resource for which the preference is stored. This used to retrieve
218
- * a potentially different value for the same preference for different resources, for example `files.encoding`.
219
- *
220
- * @returns an object containing the value stored for the given preference and resourceUri when it exists,
221
- * otherwise the given default value. If determinable the object will also contain the uri of the configuration
222
- * resource in which the preference was stored.
223
- */
224
- resolve<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): PreferenceResolveResult<T>;
225
- /**
226
- * Returns the uri of the configuration resource for the given scope and optional resource uri.
227
- *
228
- * @param scope the PreferenceScope to query for.
229
- * @param resourceUri the optional uri of the resource-specific preference handling
230
- * @param sectionName the optional preference section to query for.
231
- *
232
- * @returns the uri of the configuration resource for the given scope and optional resource uri it it exists,
233
- * `undefined` otherwise.
234
- */
235
- getConfigUri(scope: PreferenceScope, resourceUri?: string, sectionName?: string): URI | undefined;
236
- }
237
-
238
- /**
239
- * Return type of the {@link PreferenceService.inspect} call.
240
- */
241
- export interface PreferenceInspection<T = JSONValue> {
242
- /**
243
- * The preference identifier.
244
- */
245
- preferenceName: string,
246
- /**
247
- * Value in default scope.
248
- */
249
- defaultValue: T | undefined,
250
- /**
251
- * Value in user scope.
252
- */
253
- globalValue: T | undefined,
254
- /**
255
- * Value in workspace scope.
256
- */
257
- workspaceValue: T | undefined,
258
- /**
259
- * Value in folder scope.
260
- */
261
- workspaceFolderValue: T | undefined,
262
- /**
263
- * The value that is active, i.e. the value set in the lowest scope available.
264
- */
265
- value: T | undefined;
266
- }
267
-
268
- export type PreferenceInspectionScope = keyof Omit<PreferenceInspection<unknown>, 'preferenceName'>;
269
-
270
- /**
271
- * We cannot load providers directly in the case if they depend on `PreferenceService` somehow.
272
- * It allows to load them lazily after DI is configured.
273
- */
274
- export const PreferenceProviderProvider = Symbol('PreferenceProviderProvider');
275
- export type PreferenceProviderProvider = (scope: PreferenceScope, uri?: URI) => PreferenceProvider;
276
-
277
- @injectable()
278
- export class PreferenceServiceImpl implements PreferenceService {
279
-
280
- protected readonly onPreferenceChangedEmitter = new Emitter<PreferenceChange>();
281
- readonly onPreferenceChanged = this.onPreferenceChangedEmitter.event;
282
-
283
- protected readonly onPreferencesChangedEmitter = new Emitter<PreferenceChanges>();
284
- readonly onPreferencesChanged = this.onPreferencesChangedEmitter.event;
285
-
286
- protected readonly toDispose = new DisposableCollection(this.onPreferenceChangedEmitter, this.onPreferencesChangedEmitter);
287
-
288
- @inject(PreferenceSchemaProvider)
289
- protected readonly schema: PreferenceSchemaProvider;
290
-
291
- @inject(PreferenceProviderProvider)
292
- protected readonly providerProvider: PreferenceProviderProvider;
293
-
294
- @inject(PreferenceConfigurations)
295
- protected readonly configurations: PreferenceConfigurations;
296
-
297
- @inject(PreferenceLanguageOverrideService)
298
- protected readonly preferenceOverrideService: PreferenceLanguageOverrideService;
299
-
300
- protected readonly preferenceProviders = new Map<PreferenceScope, PreferenceProvider>();
301
-
302
- protected async initializeProviders(): Promise<void> {
303
- try {
304
- for (const scope of PreferenceScope.getScopes()) {
305
- const provider = this.providerProvider(scope);
306
- this.preferenceProviders.set(scope, provider);
307
- this.toDispose.push(provider.onDidPreferencesChanged(changes =>
308
- this.reconcilePreferences(changes)
309
- ));
310
- await provider.ready;
311
- }
312
- this._ready.resolve();
313
- this._isReady = true;
314
- } catch (e) {
315
- this._ready.reject(e);
316
- }
317
- }
318
-
319
- @postConstruct()
320
- protected init(): void {
321
- this.toDispose.push(Disposable.create(() => this._ready.reject(new Error('preference service is disposed'))));
322
- this.initializeProviders();
323
- }
324
-
325
- dispose(): void {
326
- this.toDispose.dispose();
327
- }
328
-
329
- protected readonly _ready = new Deferred<void>();
330
- get ready(): Promise<void> {
331
- return this._ready.promise;
332
- }
333
-
334
- protected _isReady = false;
335
- get isReady(): boolean {
336
- return this._isReady;
337
- }
338
-
339
- protected reconcilePreferences(changes: PreferenceProviderDataChanges): void {
340
- const changesToEmit: PreferenceChanges = {};
341
- const acceptChange = (change: PreferenceProviderDataChange) =>
342
- this.getAffectedPreferenceNames(change, preferenceName =>
343
- changesToEmit[preferenceName] = new PreferenceChangeImpl({ ...change, preferenceName })
344
- );
345
-
346
- for (const preferenceName of Object.keys(changes)) {
347
- let change = changes[preferenceName];
348
- if (change.newValue === undefined) {
349
- const overridden = this.overriddenPreferenceName(change.preferenceName);
350
- if (overridden) {
351
- change = {
352
- ...change, newValue: this.doGet(overridden.preferenceName)
353
- };
354
- }
355
- }
356
- if (this.schema.isValidInScope(preferenceName, PreferenceScope.Folder)) {
357
- acceptChange(change);
358
- continue;
359
- }
360
- for (const scope of PreferenceScope.getReversedScopes()) {
361
- if (this.schema.isValidInScope(preferenceName, scope)) {
362
- const provider = this.getProvider(scope);
363
- if (provider) {
364
- const value = provider.get(preferenceName);
365
- if (scope > change.scope && value !== undefined) {
366
- // preference defined in a more specific scope
367
- break;
368
- } else if (scope === change.scope && change.newValue !== undefined) {
369
- // preference is changed into something other than `undefined`
370
- acceptChange(change);
371
- } else if (scope < change.scope && change.newValue === undefined && value !== undefined) {
372
- // preference is changed to `undefined`, use the value from a more general scope
373
- change = {
374
- ...change,
375
- newValue: value,
376
- scope
377
- };
378
- acceptChange(change);
379
- }
380
- }
381
- } else if (change.newValue === undefined && change.scope === PreferenceScope.Default) {
382
- // preference is removed
383
- acceptChange(change);
384
- break;
385
- }
386
- }
387
- }
388
-
389
- // emit the changes
390
- const changedPreferenceNames = Object.keys(changesToEmit);
391
- if (changedPreferenceNames.length > 0) {
392
- this.onPreferencesChangedEmitter.fire(changesToEmit);
393
- }
394
- changedPreferenceNames.forEach(preferenceName => this.onPreferenceChangedEmitter.fire(changesToEmit[preferenceName]));
395
- }
396
- protected getAffectedPreferenceNames(change: PreferenceProviderDataChange, accept: (affectedPreferenceName: string) => void): void {
397
- accept(change.preferenceName);
398
- for (const overridePreferenceName of this.schema.getOverridePreferenceNames(change.preferenceName)) {
399
- if (!this.doHas(overridePreferenceName)) {
400
- accept(overridePreferenceName);
401
- }
402
- }
403
- }
404
-
405
- protected getProvider(scope: PreferenceScope): PreferenceProvider | undefined {
406
- return this.preferenceProviders.get(scope);
407
- }
408
-
409
- has(preferenceName: string, resourceUri?: string): boolean {
410
- return this.get(preferenceName, undefined, resourceUri) !== undefined;
411
- }
412
-
413
- get<T>(preferenceName: string): T | undefined;
414
- get<T>(preferenceName: string, defaultValue: T): T;
415
- get<T>(preferenceName: string, defaultValue: T, resourceUri: string): T;
416
- get<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined;
417
- get<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined {
418
- return this.resolve<T>(preferenceName, defaultValue, resourceUri).value;
419
- }
420
-
421
- resolve<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): PreferenceResolveResult<T> {
422
- const { value, configUri } = this.doResolve(preferenceName, defaultValue, resourceUri);
423
- if (value === undefined) {
424
- const overridden = this.overriddenPreferenceName(preferenceName);
425
- if (overridden) {
426
- return this.doResolve(overridden.preferenceName, defaultValue, resourceUri);
427
- }
428
- }
429
- return { value, configUri };
430
- }
431
-
432
- async set(preferenceName: string, value: any, scope: PreferenceScope | undefined, resourceUri?: string): Promise<void> {
433
- const resolvedScope = scope ?? (!resourceUri ? PreferenceScope.Workspace : PreferenceScope.Folder);
434
- if (resolvedScope === PreferenceScope.Folder && !resourceUri) {
435
- throw new Error('Unable to write to Folder Settings because no resource is provided.');
436
- }
437
- const provider = this.getProvider(resolvedScope);
438
- if (provider && await provider.setPreference(preferenceName, value, resourceUri)) {
439
- return;
440
- }
441
- throw new Error(`Unable to write to ${PreferenceScope[resolvedScope]} Settings.`);
442
- }
443
-
444
- getBoolean(preferenceName: string): boolean | undefined;
445
- getBoolean(preferenceName: string, defaultValue: boolean): boolean;
446
- getBoolean(preferenceName: string, defaultValue: boolean, resourceUri: string): boolean;
447
- getBoolean(preferenceName: string, defaultValue?: boolean, resourceUri?: string): boolean | undefined {
448
- const value = resourceUri ? this.get(preferenceName, defaultValue, resourceUri) : this.get(preferenceName, defaultValue);
449
- // eslint-disable-next-line no-null/no-null
450
- return value !== null && value !== undefined ? !!value : defaultValue;
451
- }
452
-
453
- getString(preferenceName: string): string | undefined;
454
- getString(preferenceName: string, defaultValue: string): string;
455
- getString(preferenceName: string, defaultValue: string, resourceUri: string): string;
456
- getString(preferenceName: string, defaultValue?: string, resourceUri?: string): string | undefined {
457
- const value = resourceUri ? this.get(preferenceName, defaultValue, resourceUri) : this.get(preferenceName, defaultValue);
458
- // eslint-disable-next-line no-null/no-null
459
- if (value === null || value === undefined) {
460
- return defaultValue;
461
- }
462
- return value.toString();
463
- }
464
-
465
- getNumber(preferenceName: string): number | undefined;
466
- getNumber(preferenceName: string, defaultValue: number): number;
467
- getNumber(preferenceName: string, defaultValue: number, resourceUri: string): number;
468
- getNumber(preferenceName: string, defaultValue?: number, resourceUri?: string): number | undefined {
469
- const value = resourceUri ? this.get(preferenceName, defaultValue, resourceUri) : this.get(preferenceName, defaultValue);
470
- // eslint-disable-next-line no-null/no-null
471
- if (value === null || value === undefined) {
472
- return defaultValue;
473
- }
474
- if (typeof value === 'number') {
475
- return value;
476
- }
477
- return Number(value);
478
- }
479
-
480
- inspect<T extends JSONValue>(preferenceName: string, resourceUri?: string, forceLanguageOverride?: boolean): PreferenceInspection<T> | undefined {
481
- const defaultValue = this.inspectInScope<T>(preferenceName, PreferenceScope.Default, resourceUri, forceLanguageOverride);
482
- const globalValue = this.inspectInScope<T>(preferenceName, PreferenceScope.User, resourceUri, forceLanguageOverride);
483
- const workspaceValue = this.inspectInScope<T>(preferenceName, PreferenceScope.Workspace, resourceUri, forceLanguageOverride);
484
- const workspaceFolderValue = this.inspectInScope<T>(preferenceName, PreferenceScope.Folder, resourceUri, forceLanguageOverride);
485
-
486
- const valueApplied = workspaceFolderValue ?? workspaceValue ?? globalValue ?? defaultValue;
487
-
488
- return { preferenceName, defaultValue, globalValue, workspaceValue, workspaceFolderValue, value: valueApplied };
489
- }
490
-
491
- inspectInScope<T extends JSONValue>(preferenceName: string, scope: PreferenceScope, resourceUri?: string, forceLanguageOverride?: boolean): T | undefined {
492
- const value = this.doInspectInScope<T>(preferenceName, scope, resourceUri);
493
- if (value === undefined && !forceLanguageOverride) {
494
- const overridden = this.overriddenPreferenceName(preferenceName);
495
- if (overridden) {
496
- return this.doInspectInScope(overridden.preferenceName, scope, resourceUri);
497
- }
498
- }
499
- return value;
500
- }
501
-
502
- protected getScopedValueFromInspection<T>(inspection: PreferenceInspection<T>, scope: PreferenceScope): T | undefined {
503
- switch (scope) {
504
- case PreferenceScope.Default:
505
- return inspection.defaultValue;
506
- case PreferenceScope.User:
507
- return inspection.globalValue;
508
- case PreferenceScope.Workspace:
509
- return inspection.workspaceValue;
510
- case PreferenceScope.Folder:
511
- return inspection.workspaceFolderValue;
512
- }
513
- unreachable(scope, 'Not all PreferenceScope enum variants handled.');
514
- }
515
-
516
- async updateValue(preferenceName: string, value: any, resourceUri?: string): Promise<void> {
517
- const inspection = this.inspect<any>(preferenceName, resourceUri);
518
- if (inspection) {
519
- const scopesToChange = this.getScopesToChange(inspection, value);
520
- const isDeletion = value === undefined
521
- || (scopesToChange.length === 1 && scopesToChange[0] === PreferenceScope.User && JSONExt.deepEqual(value, inspection.defaultValue));
522
- const effectiveValue = isDeletion ? undefined : value;
523
- await Promise.all(scopesToChange.map(scope => this.set(preferenceName, effectiveValue, scope, resourceUri)));
524
- }
525
- }
526
-
527
- protected getScopesToChange(inspection: PreferenceInspection<any>, intendedValue: any): PreferenceScope[] {
528
- if (JSONExt.deepEqual(inspection.value, intendedValue)) {
529
- return [];
530
- }
531
-
532
- // Scopes in ascending order of scope breadth.
533
- const allScopes = PreferenceScope.getReversedScopes();
534
- // Get rid of Default scope. We can't set anything there.
535
- allScopes.pop();
536
-
537
- const isScopeDefined = (scope: PreferenceScope) => this.getScopedValueFromInspection(inspection, scope) !== undefined;
538
-
539
- if (intendedValue === undefined) {
540
- return allScopes.filter(isScopeDefined);
541
- }
542
-
543
- return [allScopes.find(isScopeDefined) ?? PreferenceScope.User];
544
- }
545
-
546
- overridePreferenceName(options: OverridePreferenceName): string {
547
- return this.preferenceOverrideService.overridePreferenceName(options);
548
- }
549
- overriddenPreferenceName(preferenceName: string): OverridePreferenceName | undefined {
550
- return this.preferenceOverrideService.overriddenPreferenceName(preferenceName);
551
- }
552
-
553
- protected doHas(preferenceName: string, resourceUri?: string): boolean {
554
- return this.doGet(preferenceName, undefined, resourceUri) !== undefined;
555
- }
556
- protected doInspectInScope<T>(preferenceName: string, scope: PreferenceScope, resourceUri?: string): T | undefined {
557
- const provider = this.getProvider(scope);
558
- return provider && provider.get<T>(preferenceName, resourceUri);
559
- }
560
- protected doGet<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined {
561
- return this.doResolve(preferenceName, defaultValue, resourceUri).value;
562
- }
563
- protected doResolve<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): PreferenceResolveResult<T> {
564
- const result: PreferenceResolveResult<T> = {};
565
- for (const scope of PreferenceScope.getScopes()) {
566
- if (this.schema.isValidInScope(preferenceName, scope)) {
567
- const provider = this.getProvider(scope);
568
- if (provider?.canHandleScope(scope)) {
569
- const { configUri, value } = provider.resolve<T>(preferenceName, resourceUri);
570
- if (value !== undefined) {
571
- result.configUri = configUri;
572
- result.value = PreferenceProvider.merge(result.value as any, value as any) as any;
573
- }
574
- }
575
- }
576
- }
577
- return {
578
- configUri: result.configUri,
579
- value: result.value !== undefined ? deepFreeze(result.value) : defaultValue
580
- };
581
- }
582
-
583
- getConfigUri(scope: PreferenceScope, resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
584
- const provider = this.getProvider(scope);
585
- if (!provider || !this.configurations.isAnyConfig(sectionName)) {
586
- return undefined;
587
- }
588
- const configUri = provider.getConfigUri(resourceUri, sectionName);
589
- if (configUri) {
590
- return configUri;
591
- }
592
- return provider.getContainingConfigUri && provider.getContainingConfigUri(resourceUri, sectionName);
593
- }
594
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2018 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-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ /* eslint-disable @typescript-eslint/no-explicit-any */
18
+
19
+ import { injectable, inject, postConstruct } from 'inversify';
20
+ import { Event, Emitter, DisposableCollection, Disposable, deepFreeze, unreachable } from '../../common';
21
+ import { Deferred } from '../../common/promise-util';
22
+ import { PreferenceProvider, PreferenceProviderDataChange, PreferenceProviderDataChanges, PreferenceResolveResult } from './preference-provider';
23
+ import { PreferenceSchemaProvider } from './preference-contribution';
24
+ import URI from '../../common/uri';
25
+ import { PreferenceScope } from './preference-scope';
26
+ import { PreferenceConfigurations } from './preference-configurations';
27
+ import { JSONExt, JSONValue } from '@phosphor/coreutils/lib/json';
28
+ import { OverridePreferenceName, PreferenceLanguageOverrideService } from './preference-language-override-service';
29
+
30
+ export { PreferenceScope };
31
+
32
+ /**
33
+ * Representation of a preference change. A preference value can be set to `undefined` for a specific scope.
34
+ * This means that the value from a more general scope will be used.
35
+ */
36
+ export interface PreferenceChange extends PreferenceProviderDataChange {
37
+ /**
38
+ * Tests wether the given resource is affected by the preference change.
39
+ * @param resourceUri the uri of the resource to test.
40
+ */
41
+ affects(resourceUri?: string): boolean;
42
+ }
43
+
44
+ export class PreferenceChangeImpl implements PreferenceChange {
45
+ protected readonly change: PreferenceProviderDataChange;
46
+ constructor(change: PreferenceProviderDataChange) {
47
+ this.change = deepFreeze(change);
48
+ }
49
+
50
+ get preferenceName(): string {
51
+ return this.change.preferenceName;
52
+ }
53
+ get newValue(): string {
54
+ return this.change.newValue;
55
+ }
56
+ get oldValue(): string {
57
+ return this.change.oldValue;
58
+ }
59
+ get scope(): PreferenceScope {
60
+ return this.change.scope;
61
+ }
62
+ get domain(): string[] | undefined {
63
+ return this.change.domain;
64
+ }
65
+
66
+ // TODO add tests
67
+ affects(resourceUri?: string): boolean {
68
+ const resourcePath = resourceUri && new URI(resourceUri).path;
69
+ const domain = this.change.domain;
70
+ return !resourcePath || !domain || domain.some(uri => new URI(uri).path.relativity(resourcePath) >= 0);
71
+ }
72
+ }
73
+ /**
74
+ * A key-value storage for {@link PreferenceChange}s. Used to aggregate multiple simultaneous preference changes.
75
+ */
76
+ export interface PreferenceChanges {
77
+ [preferenceName: string]: PreferenceChange
78
+ }
79
+
80
+ export const PreferenceService = Symbol('PreferenceService');
81
+ /**
82
+ * Service to manage preferences including, among others, getting and setting preference values as well
83
+ * as listening to preference changes.
84
+ *
85
+ * Depending on your use case you might also want to look at {@link createPreferenceProxy} with which
86
+ * you can easily create a typesafe schema-based interface for your preferences. Internally the proxy
87
+ * uses the PreferenceService so both approaches are compatible.
88
+ */
89
+ export interface PreferenceService extends Disposable {
90
+ /**
91
+ * Promise indicating whether the service successfully initialized.
92
+ */
93
+ readonly ready: Promise<void>;
94
+ /**
95
+ * Indicates whether the service has successfully initialized. Will be `true` when {@link PreferenceService.ready the `ready` Promise} resolves.
96
+ */
97
+ readonly isReady: boolean;
98
+ /**
99
+ * Retrieve the stored value for the given preference.
100
+ *
101
+ * @param preferenceName the preference identifier.
102
+ *
103
+ * @returns the value stored for the given preference when it exists, `undefined` otherwise.
104
+ */
105
+ get<T>(preferenceName: string): T | undefined;
106
+ /**
107
+ * Retrieve the stored value for the given preference.
108
+ *
109
+ * @param preferenceName the preference identifier.
110
+ * @param defaultValue the value to return when no value for the given preference is stored.
111
+ *
112
+ * @returns the value stored for the given preference when it exists, otherwise the given default value.
113
+ */
114
+ get<T>(preferenceName: string, defaultValue: T): T;
115
+ /**
116
+ * Retrieve the stored value for the given preference and resourceUri.
117
+ *
118
+ * @param preferenceName the preference identifier.
119
+ * @param defaultValue the value to return when no value for the given preference is stored.
120
+ * @param resourceUri the uri of the resource for which the preference is stored. This used to retrieve
121
+ * a potentially different value for the same preference for different resources, for example `files.encoding`.
122
+ *
123
+ * @returns the value stored for the given preference and resourceUri when it exists, otherwise the given
124
+ * default value.
125
+ */
126
+ get<T>(preferenceName: string, defaultValue: T, resourceUri?: string): T;
127
+ /**
128
+ * Retrieve the stored value for the given preference and resourceUri.
129
+ *
130
+ * @param preferenceName the preference identifier.
131
+ * @param defaultValue the value to return when no value for the given preference is stored.
132
+ * @param resourceUri the uri of the resource for which the preference is stored. This used to retrieve
133
+ * a potentially different value for the same preference for different resources, for example `files.encoding`.
134
+ *
135
+ * @returns the value stored for the given preference and resourceUri when it exists, otherwise the given
136
+ * default value.
137
+ */
138
+ get<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined;
139
+ /**
140
+ * Sets the given preference to the given value.
141
+ *
142
+ * @param preferenceName the preference identifier.
143
+ * @param value the new value of the preference.
144
+ * @param scope the scope for which the value shall be set, i.e. user, workspace etc.
145
+ * When the folder scope is specified a resourceUri must be provided.
146
+ * @param resourceUri the uri of the resource for which the preference is stored. This used to store
147
+ * a potentially different value for the same preference for different resources, for example `files.encoding`.
148
+ *
149
+ * @returns a promise which resolves to `undefined` when setting the preference was successful. Otherwise it rejects
150
+ * with an error.
151
+ */
152
+ set(preferenceName: string, value: any, scope?: PreferenceScope, resourceUri?: string): Promise<void>;
153
+
154
+ /**
155
+ * Determines and applies the changes necessary to apply `value` to either the `resourceUri` supplied or the active session.
156
+ * If there is no setting for the `preferenceName`, the change will be applied in user scope.
157
+ * If there is a setting conflicting with the specified `value`, the change will be applied in the most specific scope with a conflicting value.
158
+ *
159
+ * @param preferenceName the identifier of the preference to modify.
160
+ * @param value the value to which to set the preference. `undefined` will reset the preference to its default value.
161
+ * @param resourceUri the uri of the resource to which the change is to apply. If none is provided, folder scope will be ignored.
162
+ */
163
+ updateValue(preferenceName: string, value: any, resourceUri?: string): Promise<void>
164
+
165
+ /**
166
+ * Registers a callback which will be called whenever a preference is changed.
167
+ */
168
+ onPreferenceChanged: Event<PreferenceChange>;
169
+ /**
170
+ * Registers a callback which will be called whenever one or more preferences are changed.
171
+ */
172
+ onPreferencesChanged: Event<PreferenceChanges>;
173
+ /**
174
+ * Retrieve the stored value for the given preference and resourceUri in all available scopes.
175
+ *
176
+ * @param preferenceName the preference identifier.
177
+ * @param resourceUri the uri of the resource for which the preference is stored.
178
+ * @param forceLanguageOverride if `true` and `preferenceName` is a language override, only values for the specified override will be returned.
179
+ * Otherwise, values for the override will be returned where defined, and values from the base preference will be returned otherwise.
180
+ *
181
+ * @return an object containing the value of the given preference for all scopes.
182
+ */
183
+ inspect<T extends JSONValue>(preferenceName: string, resourceUri?: string, forceLanguageOverride?: boolean): PreferenceInspection<T> | undefined;
184
+ /**
185
+ * For behavior, see {@link PreferenceService.inspect}.
186
+ *
187
+ * @returns the value in the scope specified.
188
+ */
189
+ inspectInScope<T extends JSONValue>(preferenceName: string, scope: PreferenceScope, resourceUri?: string, forceLanguageOverride?: boolean): T | undefined
190
+ /**
191
+ * Returns a new preference identifier based on the given OverridePreferenceName.
192
+ *
193
+ * @param options the override specification.
194
+ *
195
+ * @returns the calculated string based on the given OverridePreferenceName.
196
+ */
197
+ overridePreferenceName(options: OverridePreferenceName): string;
198
+ /**
199
+ * Tries to split the given preference identifier into the original OverridePreferenceName attributes
200
+ * with which this identifier was created. Returns `undefined` if this is not possible, for example
201
+ * when the given preference identifier was not generated by `overridePreferenceName`.
202
+ *
203
+ * This method is checked when resolving preferences. Therefore together with "overridePreferenceName"
204
+ * this can be used to handle specialized preferences, e.g. "[markdown].editor.autoIndent" and "editor.autoIndent".
205
+ *
206
+ * @param preferenceName the preferenceName which might have been created via {@link PreferenceService.overridePreferenceName}.
207
+ *
208
+ * @returns the OverridePreferenceName which was used to create the given `preferenceName` if this was the case,
209
+ * `undefined` otherwise.
210
+ */
211
+ overriddenPreferenceName(preferenceName: string): OverridePreferenceName | undefined;
212
+ /**
213
+ * Retrieve the stored value for the given preference and resourceUri.
214
+ *
215
+ * @param preferenceName the preference identifier.
216
+ * @param defaultValue the value to return when no value for the given preference is stored.
217
+ * @param resourceUri the uri of the resource for which the preference is stored. This used to retrieve
218
+ * a potentially different value for the same preference for different resources, for example `files.encoding`.
219
+ *
220
+ * @returns an object containing the value stored for the given preference and resourceUri when it exists,
221
+ * otherwise the given default value. If determinable the object will also contain the uri of the configuration
222
+ * resource in which the preference was stored.
223
+ */
224
+ resolve<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): PreferenceResolveResult<T>;
225
+ /**
226
+ * Returns the uri of the configuration resource for the given scope and optional resource uri.
227
+ *
228
+ * @param scope the PreferenceScope to query for.
229
+ * @param resourceUri the optional uri of the resource-specific preference handling
230
+ * @param sectionName the optional preference section to query for.
231
+ *
232
+ * @returns the uri of the configuration resource for the given scope and optional resource uri it it exists,
233
+ * `undefined` otherwise.
234
+ */
235
+ getConfigUri(scope: PreferenceScope, resourceUri?: string, sectionName?: string): URI | undefined;
236
+ }
237
+
238
+ /**
239
+ * Return type of the {@link PreferenceService.inspect} call.
240
+ */
241
+ export interface PreferenceInspection<T = JSONValue> {
242
+ /**
243
+ * The preference identifier.
244
+ */
245
+ preferenceName: string,
246
+ /**
247
+ * Value in default scope.
248
+ */
249
+ defaultValue: T | undefined,
250
+ /**
251
+ * Value in user scope.
252
+ */
253
+ globalValue: T | undefined,
254
+ /**
255
+ * Value in workspace scope.
256
+ */
257
+ workspaceValue: T | undefined,
258
+ /**
259
+ * Value in folder scope.
260
+ */
261
+ workspaceFolderValue: T | undefined,
262
+ /**
263
+ * The value that is active, i.e. the value set in the lowest scope available.
264
+ */
265
+ value: T | undefined;
266
+ }
267
+
268
+ export type PreferenceInspectionScope = keyof Omit<PreferenceInspection<unknown>, 'preferenceName'>;
269
+
270
+ /**
271
+ * We cannot load providers directly in the case if they depend on `PreferenceService` somehow.
272
+ * It allows to load them lazily after DI is configured.
273
+ */
274
+ export const PreferenceProviderProvider = Symbol('PreferenceProviderProvider');
275
+ export type PreferenceProviderProvider = (scope: PreferenceScope, uri?: URI) => PreferenceProvider;
276
+
277
+ @injectable()
278
+ export class PreferenceServiceImpl implements PreferenceService {
279
+
280
+ protected readonly onPreferenceChangedEmitter = new Emitter<PreferenceChange>();
281
+ readonly onPreferenceChanged = this.onPreferenceChangedEmitter.event;
282
+
283
+ protected readonly onPreferencesChangedEmitter = new Emitter<PreferenceChanges>();
284
+ readonly onPreferencesChanged = this.onPreferencesChangedEmitter.event;
285
+
286
+ protected readonly toDispose = new DisposableCollection(this.onPreferenceChangedEmitter, this.onPreferencesChangedEmitter);
287
+
288
+ @inject(PreferenceSchemaProvider)
289
+ protected readonly schema: PreferenceSchemaProvider;
290
+
291
+ @inject(PreferenceProviderProvider)
292
+ protected readonly providerProvider: PreferenceProviderProvider;
293
+
294
+ @inject(PreferenceConfigurations)
295
+ protected readonly configurations: PreferenceConfigurations;
296
+
297
+ @inject(PreferenceLanguageOverrideService)
298
+ protected readonly preferenceOverrideService: PreferenceLanguageOverrideService;
299
+
300
+ protected readonly preferenceProviders = new Map<PreferenceScope, PreferenceProvider>();
301
+
302
+ protected async initializeProviders(): Promise<void> {
303
+ try {
304
+ for (const scope of PreferenceScope.getScopes()) {
305
+ const provider = this.providerProvider(scope);
306
+ this.preferenceProviders.set(scope, provider);
307
+ this.toDispose.push(provider.onDidPreferencesChanged(changes =>
308
+ this.reconcilePreferences(changes)
309
+ ));
310
+ await provider.ready;
311
+ }
312
+ this._ready.resolve();
313
+ this._isReady = true;
314
+ } catch (e) {
315
+ this._ready.reject(e);
316
+ }
317
+ }
318
+
319
+ @postConstruct()
320
+ protected init(): void {
321
+ this.toDispose.push(Disposable.create(() => this._ready.reject(new Error('preference service is disposed'))));
322
+ this.initializeProviders();
323
+ }
324
+
325
+ dispose(): void {
326
+ this.toDispose.dispose();
327
+ }
328
+
329
+ protected readonly _ready = new Deferred<void>();
330
+ get ready(): Promise<void> {
331
+ return this._ready.promise;
332
+ }
333
+
334
+ protected _isReady = false;
335
+ get isReady(): boolean {
336
+ return this._isReady;
337
+ }
338
+
339
+ protected reconcilePreferences(changes: PreferenceProviderDataChanges): void {
340
+ const changesToEmit: PreferenceChanges = {};
341
+ const acceptChange = (change: PreferenceProviderDataChange) =>
342
+ this.getAffectedPreferenceNames(change, preferenceName =>
343
+ changesToEmit[preferenceName] = new PreferenceChangeImpl({ ...change, preferenceName })
344
+ );
345
+
346
+ for (const preferenceName of Object.keys(changes)) {
347
+ let change = changes[preferenceName];
348
+ if (change.newValue === undefined) {
349
+ const overridden = this.overriddenPreferenceName(change.preferenceName);
350
+ if (overridden) {
351
+ change = {
352
+ ...change, newValue: this.doGet(overridden.preferenceName)
353
+ };
354
+ }
355
+ }
356
+ if (this.schema.isValidInScope(preferenceName, PreferenceScope.Folder)) {
357
+ acceptChange(change);
358
+ continue;
359
+ }
360
+ for (const scope of PreferenceScope.getReversedScopes()) {
361
+ if (this.schema.isValidInScope(preferenceName, scope)) {
362
+ const provider = this.getProvider(scope);
363
+ if (provider) {
364
+ const value = provider.get(preferenceName);
365
+ if (scope > change.scope && value !== undefined) {
366
+ // preference defined in a more specific scope
367
+ break;
368
+ } else if (scope === change.scope && change.newValue !== undefined) {
369
+ // preference is changed into something other than `undefined`
370
+ acceptChange(change);
371
+ } else if (scope < change.scope && change.newValue === undefined && value !== undefined) {
372
+ // preference is changed to `undefined`, use the value from a more general scope
373
+ change = {
374
+ ...change,
375
+ newValue: value,
376
+ scope
377
+ };
378
+ acceptChange(change);
379
+ }
380
+ }
381
+ } else if (change.newValue === undefined && change.scope === PreferenceScope.Default) {
382
+ // preference is removed
383
+ acceptChange(change);
384
+ break;
385
+ }
386
+ }
387
+ }
388
+
389
+ // emit the changes
390
+ const changedPreferenceNames = Object.keys(changesToEmit);
391
+ if (changedPreferenceNames.length > 0) {
392
+ this.onPreferencesChangedEmitter.fire(changesToEmit);
393
+ }
394
+ changedPreferenceNames.forEach(preferenceName => this.onPreferenceChangedEmitter.fire(changesToEmit[preferenceName]));
395
+ }
396
+ protected getAffectedPreferenceNames(change: PreferenceProviderDataChange, accept: (affectedPreferenceName: string) => void): void {
397
+ accept(change.preferenceName);
398
+ for (const overridePreferenceName of this.schema.getOverridePreferenceNames(change.preferenceName)) {
399
+ if (!this.doHas(overridePreferenceName)) {
400
+ accept(overridePreferenceName);
401
+ }
402
+ }
403
+ }
404
+
405
+ protected getProvider(scope: PreferenceScope): PreferenceProvider | undefined {
406
+ return this.preferenceProviders.get(scope);
407
+ }
408
+
409
+ has(preferenceName: string, resourceUri?: string): boolean {
410
+ return this.get(preferenceName, undefined, resourceUri) !== undefined;
411
+ }
412
+
413
+ get<T>(preferenceName: string): T | undefined;
414
+ get<T>(preferenceName: string, defaultValue: T): T;
415
+ get<T>(preferenceName: string, defaultValue: T, resourceUri: string): T;
416
+ get<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined;
417
+ get<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined {
418
+ return this.resolve<T>(preferenceName, defaultValue, resourceUri).value;
419
+ }
420
+
421
+ resolve<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): PreferenceResolveResult<T> {
422
+ const { value, configUri } = this.doResolve(preferenceName, defaultValue, resourceUri);
423
+ if (value === undefined) {
424
+ const overridden = this.overriddenPreferenceName(preferenceName);
425
+ if (overridden) {
426
+ return this.doResolve(overridden.preferenceName, defaultValue, resourceUri);
427
+ }
428
+ }
429
+ return { value, configUri };
430
+ }
431
+
432
+ async set(preferenceName: string, value: any, scope: PreferenceScope | undefined, resourceUri?: string): Promise<void> {
433
+ const resolvedScope = scope ?? (!resourceUri ? PreferenceScope.Workspace : PreferenceScope.Folder);
434
+ if (resolvedScope === PreferenceScope.Folder && !resourceUri) {
435
+ throw new Error('Unable to write to Folder Settings because no resource is provided.');
436
+ }
437
+ const provider = this.getProvider(resolvedScope);
438
+ if (provider && await provider.setPreference(preferenceName, value, resourceUri)) {
439
+ return;
440
+ }
441
+ throw new Error(`Unable to write to ${PreferenceScope[resolvedScope]} Settings.`);
442
+ }
443
+
444
+ getBoolean(preferenceName: string): boolean | undefined;
445
+ getBoolean(preferenceName: string, defaultValue: boolean): boolean;
446
+ getBoolean(preferenceName: string, defaultValue: boolean, resourceUri: string): boolean;
447
+ getBoolean(preferenceName: string, defaultValue?: boolean, resourceUri?: string): boolean | undefined {
448
+ const value = resourceUri ? this.get(preferenceName, defaultValue, resourceUri) : this.get(preferenceName, defaultValue);
449
+ // eslint-disable-next-line no-null/no-null
450
+ return value !== null && value !== undefined ? !!value : defaultValue;
451
+ }
452
+
453
+ getString(preferenceName: string): string | undefined;
454
+ getString(preferenceName: string, defaultValue: string): string;
455
+ getString(preferenceName: string, defaultValue: string, resourceUri: string): string;
456
+ getString(preferenceName: string, defaultValue?: string, resourceUri?: string): string | undefined {
457
+ const value = resourceUri ? this.get(preferenceName, defaultValue, resourceUri) : this.get(preferenceName, defaultValue);
458
+ // eslint-disable-next-line no-null/no-null
459
+ if (value === null || value === undefined) {
460
+ return defaultValue;
461
+ }
462
+ return value.toString();
463
+ }
464
+
465
+ getNumber(preferenceName: string): number | undefined;
466
+ getNumber(preferenceName: string, defaultValue: number): number;
467
+ getNumber(preferenceName: string, defaultValue: number, resourceUri: string): number;
468
+ getNumber(preferenceName: string, defaultValue?: number, resourceUri?: string): number | undefined {
469
+ const value = resourceUri ? this.get(preferenceName, defaultValue, resourceUri) : this.get(preferenceName, defaultValue);
470
+ // eslint-disable-next-line no-null/no-null
471
+ if (value === null || value === undefined) {
472
+ return defaultValue;
473
+ }
474
+ if (typeof value === 'number') {
475
+ return value;
476
+ }
477
+ return Number(value);
478
+ }
479
+
480
+ inspect<T extends JSONValue>(preferenceName: string, resourceUri?: string, forceLanguageOverride?: boolean): PreferenceInspection<T> | undefined {
481
+ const defaultValue = this.inspectInScope<T>(preferenceName, PreferenceScope.Default, resourceUri, forceLanguageOverride);
482
+ const globalValue = this.inspectInScope<T>(preferenceName, PreferenceScope.User, resourceUri, forceLanguageOverride);
483
+ const workspaceValue = this.inspectInScope<T>(preferenceName, PreferenceScope.Workspace, resourceUri, forceLanguageOverride);
484
+ const workspaceFolderValue = this.inspectInScope<T>(preferenceName, PreferenceScope.Folder, resourceUri, forceLanguageOverride);
485
+
486
+ const valueApplied = workspaceFolderValue ?? workspaceValue ?? globalValue ?? defaultValue;
487
+
488
+ return { preferenceName, defaultValue, globalValue, workspaceValue, workspaceFolderValue, value: valueApplied };
489
+ }
490
+
491
+ inspectInScope<T extends JSONValue>(preferenceName: string, scope: PreferenceScope, resourceUri?: string, forceLanguageOverride?: boolean): T | undefined {
492
+ const value = this.doInspectInScope<T>(preferenceName, scope, resourceUri);
493
+ if (value === undefined && !forceLanguageOverride) {
494
+ const overridden = this.overriddenPreferenceName(preferenceName);
495
+ if (overridden) {
496
+ return this.doInspectInScope(overridden.preferenceName, scope, resourceUri);
497
+ }
498
+ }
499
+ return value;
500
+ }
501
+
502
+ protected getScopedValueFromInspection<T>(inspection: PreferenceInspection<T>, scope: PreferenceScope): T | undefined {
503
+ switch (scope) {
504
+ case PreferenceScope.Default:
505
+ return inspection.defaultValue;
506
+ case PreferenceScope.User:
507
+ return inspection.globalValue;
508
+ case PreferenceScope.Workspace:
509
+ return inspection.workspaceValue;
510
+ case PreferenceScope.Folder:
511
+ return inspection.workspaceFolderValue;
512
+ }
513
+ unreachable(scope, 'Not all PreferenceScope enum variants handled.');
514
+ }
515
+
516
+ async updateValue(preferenceName: string, value: any, resourceUri?: string): Promise<void> {
517
+ const inspection = this.inspect<any>(preferenceName, resourceUri);
518
+ if (inspection) {
519
+ const scopesToChange = this.getScopesToChange(inspection, value);
520
+ const isDeletion = value === undefined
521
+ || (scopesToChange.length === 1 && scopesToChange[0] === PreferenceScope.User && JSONExt.deepEqual(value, inspection.defaultValue));
522
+ const effectiveValue = isDeletion ? undefined : value;
523
+ await Promise.all(scopesToChange.map(scope => this.set(preferenceName, effectiveValue, scope, resourceUri)));
524
+ }
525
+ }
526
+
527
+ protected getScopesToChange(inspection: PreferenceInspection<any>, intendedValue: any): PreferenceScope[] {
528
+ if (JSONExt.deepEqual(inspection.value, intendedValue)) {
529
+ return [];
530
+ }
531
+
532
+ // Scopes in ascending order of scope breadth.
533
+ const allScopes = PreferenceScope.getReversedScopes();
534
+ // Get rid of Default scope. We can't set anything there.
535
+ allScopes.pop();
536
+
537
+ const isScopeDefined = (scope: PreferenceScope) => this.getScopedValueFromInspection(inspection, scope) !== undefined;
538
+
539
+ if (intendedValue === undefined) {
540
+ return allScopes.filter(isScopeDefined);
541
+ }
542
+
543
+ return [allScopes.find(isScopeDefined) ?? PreferenceScope.User];
544
+ }
545
+
546
+ overridePreferenceName(options: OverridePreferenceName): string {
547
+ return this.preferenceOverrideService.overridePreferenceName(options);
548
+ }
549
+ overriddenPreferenceName(preferenceName: string): OverridePreferenceName | undefined {
550
+ return this.preferenceOverrideService.overriddenPreferenceName(preferenceName);
551
+ }
552
+
553
+ protected doHas(preferenceName: string, resourceUri?: string): boolean {
554
+ return this.doGet(preferenceName, undefined, resourceUri) !== undefined;
555
+ }
556
+ protected doInspectInScope<T>(preferenceName: string, scope: PreferenceScope, resourceUri?: string): T | undefined {
557
+ const provider = this.getProvider(scope);
558
+ return provider && provider.get<T>(preferenceName, resourceUri);
559
+ }
560
+ protected doGet<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): T | undefined {
561
+ return this.doResolve(preferenceName, defaultValue, resourceUri).value;
562
+ }
563
+ protected doResolve<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): PreferenceResolveResult<T> {
564
+ const result: PreferenceResolveResult<T> = {};
565
+ for (const scope of PreferenceScope.getScopes()) {
566
+ if (this.schema.isValidInScope(preferenceName, scope)) {
567
+ const provider = this.getProvider(scope);
568
+ if (provider?.canHandleScope(scope)) {
569
+ const { configUri, value } = provider.resolve<T>(preferenceName, resourceUri);
570
+ if (value !== undefined) {
571
+ result.configUri = configUri;
572
+ result.value = PreferenceProvider.merge(result.value as any, value as any) as any;
573
+ }
574
+ }
575
+ }
576
+ }
577
+ return {
578
+ configUri: result.configUri,
579
+ value: result.value !== undefined ? deepFreeze(result.value) : defaultValue
580
+ };
581
+ }
582
+
583
+ getConfigUri(scope: PreferenceScope, resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
584
+ const provider = this.getProvider(scope);
585
+ if (!provider || !this.configurations.isAnyConfig(sectionName)) {
586
+ return undefined;
587
+ }
588
+ const configUri = provider.getConfigUri(resourceUri, sectionName);
589
+ if (configUri) {
590
+ return configUri;
591
+ }
592
+ return provider.getContainingConfigUri && provider.getContainingConfigUri(resourceUri, sectionName);
593
+ }
594
+ }