@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,860 +1,860 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2020 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { inject, injectable, named } from 'inversify';
18
- import {
19
- screen, app, BrowserWindow, WebContents, Event as ElectronEvent, BrowserWindowConstructorOptions, nativeImage,
20
- nativeTheme, shell, dialog
21
- } from '../../electron-shared/electron';
22
- import * as path from 'path';
23
- import { Argv } from 'yargs';
24
- import { AddressInfo } from 'net';
25
- import { promises as fs } from 'fs';
26
- import { existsSync, mkdirSync } from 'fs-extra';
27
- import { fork, ForkOptions } from 'child_process';
28
- import { DefaultTheme, ElectronFrontendApplicationConfig, FrontendApplicationConfig } from '@theia/application-package/lib/application-props';
29
- import URI from '../common/uri';
30
- import { FileUri } from '../common/file-uri';
31
- import { Deferred, timeout } from '../common/promise-util';
32
- import { MaybePromise } from '../common/types';
33
- import { ContributionProvider } from '../common/contribution-provider';
34
- import { ElectronSecurityTokenService } from './electron-security-token-service';
35
- import { ElectronSecurityToken } from '../electron-common/electron-token';
36
- import Storage = require('electron-store');
37
- import { CancellationTokenSource, Disposable, DisposableCollection, Path, isOSX, isWindows } from '../common';
38
- import { DEFAULT_WINDOW_HASH, WindowSearchParams } from '../common/window';
39
- import { TheiaBrowserWindowOptions, TheiaElectronWindow, TheiaElectronWindowFactory } from './theia-electron-window';
40
- import { ElectronMainApplicationGlobals } from './electron-main-constants';
41
- import { createDisposableListener } from './event-utils';
42
- import { TheiaRendererAPI } from './electron-api-main';
43
- import { StopReason } from '../common/frontend-application-state';
44
- import { dynamicRequire } from '../node/dynamic-require';
45
-
46
- export { ElectronMainApplicationGlobals };
47
-
48
- const createYargs: (argv?: string[], cwd?: string) => Argv = require('yargs/yargs');
49
-
50
- /**
51
- * Options passed to the main/default command handler.
52
- */
53
- export interface ElectronMainCommandOptions {
54
-
55
- /**
56
- * By default, the first positional argument. Should be either a relative or absolute file-system path pointing to a file or a folder.
57
- */
58
- readonly file?: string;
59
-
60
- readonly cwd: string;
61
-
62
- /**
63
- * If the app is launched for the first time, `secondInstance` is false.
64
- * If the app is already running but user relaunches it, `secondInstance` is true.
65
- */
66
- readonly secondInstance: boolean;
67
- }
68
-
69
- /**
70
- * The default entrypoint will handle a very rudimentary CLI to open workspaces by doing `app path/to/workspace`. To override this behavior, you can extend and rebind the
71
- * `ElectronMainApplication` class and overriding the `launch` method.
72
- * A JSON-RPC communication between the Electron Main Process and the Renderer Processes is available: You can bind services using the `ElectronConnectionHandler` and
73
- * `ElectronIpcConnectionProvider` APIs, example:
74
- *
75
- * From an `electron-main` module:
76
- *
77
- * bind(ElectronConnectionHandler).toDynamicValue(context =>
78
- * new RpcConnectionHandler(electronMainWindowServicePath,
79
- * () => context.container.get(ElectronMainWindowService))
80
- * ).inSingletonScope();
81
- *
82
- * And from the `electron-browser` module:
83
- *
84
- * bind(ElectronMainWindowService).toDynamicValue(context =>
85
- * ElectronIpcConnectionProvider.createProxy(context.container, electronMainWindowServicePath)
86
- * ).inSingletonScope();
87
- */
88
- export const ElectronMainApplicationContribution = Symbol('ElectronMainApplicationContribution');
89
- export interface ElectronMainApplicationContribution {
90
- /**
91
- * The application is ready and is starting. This is the time to initialize
92
- * services global to this process.
93
- *
94
- * Invoked when the electron-main process starts for the first time.
95
- */
96
- onStart?(application: ElectronMainApplication): MaybePromise<void>;
97
- /**
98
- * The application is stopping. Contributions must perform only synchronous operations.
99
- */
100
- onStop?(application: ElectronMainApplication): void;
101
- }
102
-
103
- // Extracted and modified the functionality from `yargs@15.4.0-beta.0`.
104
- // Based on https://github.com/yargs/yargs/blob/522b019c9a50924605986a1e6e0cb716d47bcbca/lib/process-argv.ts
105
- @injectable()
106
- export class ElectronMainProcessArgv {
107
-
108
- protected get processArgvBinIndex(): number {
109
- // The binary name is the first command line argument for:
110
- // - bundled Electron apps: bin argv1 argv2 ... argvn
111
- if (this.isBundledElectronApp) {
112
- return 0;
113
- }
114
- // or the second one (default) for:
115
- // - standard node apps: node bin.js argv1 argv2 ... argvn
116
- // - unbundled Electron apps: electron bin.js argv1 arg2 ... argvn
117
- return 1;
118
- }
119
-
120
- get isBundledElectronApp(): boolean {
121
- // process.defaultApp is either set by electron in an electron unbundled app, or undefined
122
- // see https://github.com/electron/electron/blob/master/docs/api/process.md#processdefaultapp-readonly
123
- return this.isElectronApp && !(process as ElectronMainProcessArgv.ElectronMainProcess).defaultApp;
124
- }
125
-
126
- get isElectronApp(): boolean {
127
- // process.versions.electron is either set by electron, or undefined
128
- // see https://github.com/electron/electron/blob/master/docs/api/process.md#processversionselectron-readonly
129
- return !!(process as ElectronMainProcessArgv.ElectronMainProcess).versions.electron;
130
- }
131
-
132
- getProcessArgvWithoutBin(argv = process.argv): Array<string> {
133
- return argv.slice(this.processArgvBinIndex + 1);
134
- }
135
-
136
- getProcessArgvBin(argv = process.argv): string {
137
- return argv[this.processArgvBinIndex];
138
- }
139
-
140
- }
141
-
142
- export namespace ElectronMainProcessArgv {
143
- export interface ElectronMainProcess extends NodeJS.Process {
144
- readonly defaultApp: boolean;
145
- readonly versions: NodeJS.ProcessVersions & {
146
- readonly electron: string;
147
- };
148
- }
149
- }
150
-
151
- @injectable()
152
- export class ElectronMainApplication {
153
- @inject(ContributionProvider)
154
- @named(ElectronMainApplicationContribution)
155
- protected readonly contributions: ContributionProvider<ElectronMainApplicationContribution>;
156
-
157
- @inject(ElectronMainApplicationGlobals)
158
- protected readonly globals: ElectronMainApplicationGlobals;
159
-
160
- @inject(ElectronMainProcessArgv)
161
- protected processArgv: ElectronMainProcessArgv;
162
-
163
- @inject(ElectronSecurityTokenService)
164
- protected electronSecurityTokenService: ElectronSecurityTokenService;
165
-
166
- @inject(ElectronSecurityToken)
167
- protected readonly electronSecurityToken: ElectronSecurityToken;
168
-
169
- @inject(TheiaElectronWindowFactory)
170
- protected readonly windowFactory: TheiaElectronWindowFactory;
171
-
172
- protected isPortable = this.makePortable();
173
-
174
- protected readonly electronStore = new Storage<{
175
- windowstate?: TheiaBrowserWindowOptions
176
- }>();
177
-
178
- protected readonly _backendPort = new Deferred<number>();
179
- readonly backendPort = this._backendPort.promise;
180
-
181
- protected _config: FrontendApplicationConfig | undefined;
182
- protected useNativeWindowFrame: boolean = true;
183
- protected customBackgroundColor?: string;
184
- protected didUseNativeWindowFrameOnStart = new Map<number, boolean>();
185
- protected windows = new Map<number, TheiaElectronWindow>();
186
- protected activeWindowStack: number[] = [];
187
- protected restarting = false;
188
-
189
- /** Used to temporarily store the reference to an early created main window */
190
- protected initialWindow?: BrowserWindow;
191
-
192
- get config(): FrontendApplicationConfig {
193
- if (!this._config) {
194
- throw new Error('You have to start the application first.');
195
- }
196
- return this._config;
197
- }
198
-
199
- protected makePortable(): boolean {
200
- const dataFolderPath = path.join(app.getAppPath(), 'data');
201
- const appDataPath = path.join(dataFolderPath, 'app-data');
202
- if (existsSync(dataFolderPath)) {
203
- if (!existsSync(appDataPath)) {
204
- mkdirSync(appDataPath);
205
- }
206
- app.setPath('userData', appDataPath);
207
- return true;
208
- } else {
209
- return false;
210
- }
211
- }
212
-
213
- async start(config: FrontendApplicationConfig): Promise<void> {
214
- const argv = this.processArgv.getProcessArgvWithoutBin(process.argv);
215
- createYargs(argv, process.cwd())
216
- .help(false)
217
- .command('$0 [file]', false,
218
- cmd => cmd
219
- .option('electronUserData', {
220
- type: 'string',
221
- describe: 'The area where the electron main process puts its data'
222
- })
223
- .positional('file', { type: 'string' }),
224
- async args => {
225
- if (args.electronUserData) {
226
- console.info(`using electron user data area : '${args.electronUserData}'`);
227
- await fs.mkdir(args.electronUserData, { recursive: true });
228
- app.setPath('userData', args.electronUserData);
229
- }
230
- this.useNativeWindowFrame = this.getTitleBarStyle(config) === 'native';
231
- this._config = config;
232
- this.hookApplicationEvents();
233
- this.showInitialWindow(argv.includes('--open-url') ? argv[argv.length - 1] : undefined);
234
- const port = await this.startBackend();
235
- this._backendPort.resolve(port);
236
- await app.whenReady();
237
- await this.attachElectronSecurityToken(port);
238
- await this.startContributions();
239
-
240
- this.handleMainCommand({
241
- file: args.file,
242
- cwd: process.cwd(),
243
- secondInstance: false
244
- });
245
- },
246
- ).parse();
247
- }
248
-
249
- protected getTitleBarStyle(config: FrontendApplicationConfig): 'native' | 'custom' {
250
- if ('THEIA_ELECTRON_DISABLE_NATIVE_ELEMENTS' in process.env && process.env.THEIA_ELECTRON_DISABLE_NATIVE_ELEMENTS === '1') {
251
- return 'custom';
252
- }
253
- if (isOSX) {
254
- return 'native';
255
- }
256
- const storedFrame = this.electronStore.get('windowstate')?.frame;
257
- if (storedFrame !== undefined) {
258
- return !!storedFrame ? 'native' : 'custom';
259
- }
260
- if (config.preferences && config.preferences['window.titleBarStyle']) {
261
- const titleBarStyle = config.preferences['window.titleBarStyle'];
262
- if (titleBarStyle === 'native' || titleBarStyle === 'custom') {
263
- return titleBarStyle;
264
- }
265
- }
266
- return isWindows ? 'custom' : 'native';
267
- }
268
-
269
- public setTitleBarStyle(webContents: WebContents, style: string): void {
270
- this.useNativeWindowFrame = isOSX || style === 'native';
271
- this.saveState(webContents);
272
- }
273
-
274
- setBackgroundColor(webContents: WebContents, backgroundColor: string): void {
275
- this.customBackgroundColor = backgroundColor;
276
- this.saveState(webContents);
277
- }
278
-
279
- protected saveState(webContents: Electron.WebContents): void {
280
- const browserWindow = BrowserWindow.fromWebContents(webContents);
281
- if (browserWindow) {
282
- this.saveWindowState(browserWindow);
283
- } else {
284
- console.warn(`no BrowserWindow with id: ${webContents.id}`);
285
- }
286
- }
287
-
288
- /**
289
- * @param id the id of the WebContents of the BrowserWindow in question
290
- * @returns 'native' or 'custom'
291
- */
292
- getTitleBarStyleAtStartup(webContents: WebContents): 'native' | 'custom' {
293
- return this.didUseNativeWindowFrameOnStart.get(webContents.id) ? 'native' : 'custom';
294
- }
295
-
296
- protected async determineSplashScreenBounds(initialWindowBounds: { x: number, y: number, width: number, height: number }):
297
- Promise<{ x: number, y: number, width: number, height: number }> {
298
- const splashScreenOptions = this.getSplashScreenOptions();
299
- const width = splashScreenOptions?.width ?? 640;
300
- const height = splashScreenOptions?.height ?? 480;
301
-
302
- // determine the screen on which to show the splash screen via the center of the window to show
303
- const windowCenterPoint = { x: initialWindowBounds.x + (initialWindowBounds.width / 2), y: initialWindowBounds.y + (initialWindowBounds.height / 2) };
304
- const { bounds } = screen.getDisplayNearestPoint(windowCenterPoint);
305
-
306
- // place splash screen center of screen
307
- const screenCenterPoint = { x: bounds.x + (bounds.width / 2), y: bounds.y + (bounds.height / 2) };
308
- const x = screenCenterPoint.x - (width / 2);
309
- const y = screenCenterPoint.y - (height / 2);
310
-
311
- return {
312
- x, y, width, height
313
- };
314
- }
315
-
316
- protected isShowWindowEarly(): boolean {
317
- return !!this.config.electron.showWindowEarly &&
318
- !('THEIA_ELECTRON_NO_EARLY_WINDOW' in process.env && process.env.THEIA_ELECTRON_NO_EARLY_WINDOW === '1');
319
- }
320
-
321
- protected showInitialWindow(urlToOpen: string | undefined): void {
322
- if (this.isShowWindowEarly() || this.isShowSplashScreen()) {
323
- app.whenReady().then(async () => {
324
- const options = await this.getLastWindowOptions();
325
- // If we want to show a splash screen, don't auto open the main window
326
- if (this.isShowSplashScreen()) {
327
- options.preventAutomaticShow = true;
328
- }
329
- this.initialWindow = await this.createWindow({ ...options });
330
- TheiaRendererAPI.onApplicationStateChanged(this.initialWindow.webContents, state => {
331
- if (state === 'ready' && urlToOpen) {
332
- this.openUrl(urlToOpen);
333
- }
334
- });
335
- if (this.isShowSplashScreen()) {
336
- console.log('Showing splash screen');
337
- this.configureAndShowSplashScreen(this.initialWindow);
338
- }
339
-
340
- // Show main window early if windows shall be shown early and splash screen is not configured
341
- if (this.isShowWindowEarly() && !this.isShowSplashScreen()) {
342
- console.log('Showing main window early');
343
- this.initialWindow.show();
344
- }
345
- });
346
- }
347
- }
348
-
349
- protected async configureAndShowSplashScreen(mainWindow: BrowserWindow): Promise<BrowserWindow> {
350
- const splashScreenOptions = this.getSplashScreenOptions()!;
351
- console.debug('SplashScreen options', splashScreenOptions);
352
-
353
- const splashScreenBounds = await this.determineSplashScreenBounds(mainWindow.getBounds());
354
- const splashScreenWindow = new BrowserWindow({
355
- ...splashScreenBounds,
356
- frame: false,
357
- alwaysOnTop: true,
358
- show: false,
359
- transparent: true,
360
- webPreferences: {
361
- backgroundThrottling: false
362
- }
363
- });
364
-
365
- if (this.isShowWindowEarly()) {
366
- console.log('Showing splash screen early');
367
- splashScreenWindow.show();
368
- } else {
369
- splashScreenWindow.on('ready-to-show', () => {
370
- splashScreenWindow.show();
371
- });
372
- }
373
-
374
- splashScreenWindow.loadFile(path.resolve(this.globals.THEIA_APP_PROJECT_PATH, splashScreenOptions.content!).toString());
375
-
376
- // close splash screen and show main window once frontend is ready or a timeout is hit
377
- const cancelTokenSource = new CancellationTokenSource();
378
- const minTime = timeout(splashScreenOptions.minDuration ?? 0, cancelTokenSource.token);
379
- const maxTime = timeout(splashScreenOptions.maxDuration ?? 30000, cancelTokenSource.token);
380
-
381
- const showWindowAndCloseSplashScreen = () => {
382
- cancelTokenSource.cancel();
383
- if (!mainWindow.isVisible()) {
384
- mainWindow.show();
385
- }
386
- splashScreenWindow.close();
387
- };
388
- TheiaRendererAPI.onApplicationStateChanged(mainWindow.webContents, state => {
389
- if (state === 'ready') {
390
- minTime.then(() => showWindowAndCloseSplashScreen());
391
- }
392
- });
393
- maxTime.then(() => showWindowAndCloseSplashScreen());
394
- return splashScreenWindow;
395
- }
396
-
397
- protected isShowSplashScreen(): boolean {
398
- return typeof this.config.electron.splashScreenOptions === 'object' && !!this.config.electron.splashScreenOptions.content;
399
- }
400
-
401
- protected getSplashScreenOptions(): ElectronFrontendApplicationConfig.SplashScreenOptions | undefined {
402
- if (this.isShowSplashScreen()) {
403
- return this.config.electron.splashScreenOptions;
404
- }
405
- return undefined;
406
- }
407
-
408
- /**
409
- * Use this rather than creating `BrowserWindow` instances from scratch, since some security parameters need to be set, this method will do it.
410
- *
411
- * @param options
412
- */
413
- async createWindow(asyncOptions: MaybePromise<TheiaBrowserWindowOptions> = this.getDefaultTheiaWindowOptions()): Promise<BrowserWindow> {
414
- let options = await asyncOptions;
415
- options = this.avoidOverlap(options);
416
- const electronWindow = this.windowFactory(options, this.config);
417
- const id = electronWindow.window.webContents.id;
418
- this.activeWindowStack.push(id);
419
- this.windows.set(id, electronWindow);
420
- electronWindow.onDidClose(() => {
421
- const stackIndex = this.activeWindowStack.indexOf(id);
422
- if (stackIndex >= 0) {
423
- this.activeWindowStack.splice(stackIndex, 1);
424
- }
425
- this.windows.delete(id);
426
- });
427
- electronWindow.window.on('maximize', () => TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'maximize'));
428
- electronWindow.window.on('unmaximize', () => TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'unmaximize'));
429
- electronWindow.window.on('focus', () => {
430
- const stackIndex = this.activeWindowStack.indexOf(id);
431
- if (stackIndex >= 0) {
432
- this.activeWindowStack.splice(stackIndex, 1);
433
- }
434
- this.activeWindowStack.unshift(id);
435
- TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'focus');
436
- });
437
- this.attachSaveWindowState(electronWindow.window);
438
-
439
- return electronWindow.window;
440
- }
441
-
442
- async getLastWindowOptions(): Promise<TheiaBrowserWindowOptions> {
443
- const previousWindowState: TheiaBrowserWindowOptions | undefined = this.electronStore.get('windowstate');
444
- const windowState = previousWindowState?.screenLayout === this.getCurrentScreenLayout()
445
- ? previousWindowState
446
- : this.getDefaultTheiaWindowOptions();
447
- return {
448
- frame: this.useNativeWindowFrame,
449
- ...this.getDefaultOptions(),
450
- ...windowState
451
- };
452
- }
453
-
454
- protected avoidOverlap(options: TheiaBrowserWindowOptions): TheiaBrowserWindowOptions {
455
- const existingWindowsBounds = BrowserWindow.getAllWindows().map(window => window.getBounds());
456
- if (existingWindowsBounds.length > 0) {
457
- while (existingWindowsBounds.some(window => window.x === options.x || window.y === options.y)) {
458
- // if the window is maximized or in fullscreen, use the default window options.
459
- if (options.isMaximized || options.isFullScreen) {
460
- options = this.getDefaultTheiaWindowOptions();
461
- }
462
- options.x = options.x! + 30;
463
- options.y = options.y! + 30;
464
-
465
- }
466
- }
467
- return options;
468
- }
469
-
470
- protected getDefaultOptions(): TheiaBrowserWindowOptions {
471
- return {
472
- show: false,
473
- title: this.config.applicationName,
474
- backgroundColor: DefaultTheme.defaultBackgroundColor(this.config.electron.windowOptions?.darkTheme || nativeTheme.shouldUseDarkColors),
475
- minWidth: 200,
476
- minHeight: 120,
477
- webPreferences: {
478
- // `global` is undefined when `true`.
479
- contextIsolation: true,
480
- sandbox: false,
481
- nodeIntegration: false,
482
- // Setting the following option to `true` causes some features to break, somehow.
483
- // Issue: https://github.com/eclipse-theia/theia/issues/8577
484
- nodeIntegrationInWorker: false,
485
- backgroundThrottling: false,
486
- preload: path.resolve(this.globals.THEIA_APP_PROJECT_PATH, 'lib', 'frontend', 'preload.js').toString()
487
- },
488
- ...this.config.electron?.windowOptions || {},
489
- };
490
- }
491
-
492
- async openDefaultWindow(params?: WindowSearchParams): Promise<BrowserWindow> {
493
- const options = this.getDefaultTheiaWindowOptions();
494
- const [uri, electronWindow] = await Promise.all([this.createWindowUri(params), this.reuseOrCreateWindow(options)]);
495
- electronWindow.loadURL(uri.withFragment(DEFAULT_WINDOW_HASH).toString(true));
496
- return electronWindow;
497
- }
498
-
499
- protected async openWindowWithWorkspace(workspacePath: string): Promise<BrowserWindow> {
500
- const options = await this.getLastWindowOptions();
501
- const [uri, electronWindow] = await Promise.all([this.createWindowUri(), this.reuseOrCreateWindow(options)]);
502
- electronWindow.loadURL(uri.withFragment(encodeURI(workspacePath)).toString(true));
503
- return electronWindow;
504
- }
505
-
506
- protected async reuseOrCreateWindow(asyncOptions: MaybePromise<TheiaBrowserWindowOptions>): Promise<BrowserWindow> {
507
- if (!this.initialWindow) {
508
- return this.createWindow(asyncOptions);
509
- }
510
- // reset initial window after having it re-used once
511
- const window = this.initialWindow;
512
- this.initialWindow = undefined;
513
- return window;
514
- }
515
-
516
- /**
517
- * "Gently" close all windows, application will not stop if a `beforeunload` handler returns `false`.
518
- */
519
- requestStop(): void {
520
- app.quit();
521
- }
522
-
523
- protected async handleMainCommand(options: ElectronMainCommandOptions): Promise<void> {
524
- if (options.secondInstance === false) {
525
- await this.openWindowWithWorkspace(''); // restore previous workspace.
526
- } else if (options.file === undefined) {
527
- await this.openDefaultWindow();
528
- } else {
529
- let workspacePath: string | undefined;
530
- try {
531
- workspacePath = await fs.realpath(path.resolve(options.cwd, options.file));
532
- } catch {
533
- console.error(`Could not resolve the workspace path. "${options.file}" is not a valid 'file' option. Falling back to the default workspace location.`);
534
- }
535
- if (workspacePath === undefined) {
536
- await this.openDefaultWindow();
537
- } else {
538
- await this.openWindowWithWorkspace(workspacePath);
539
- }
540
- }
541
- }
542
-
543
- async openUrl(url: string): Promise<void> {
544
- for (const id of this.activeWindowStack) {
545
- const window = this.windows.get(id);
546
- if (window && await window.openUrl(url)) {
547
- break;
548
- }
549
- }
550
- }
551
-
552
- protected async createWindowUri(params: WindowSearchParams = {}): Promise<URI> {
553
- if (!('port' in params)) {
554
- params.port = (await this.backendPort).toString();
555
- }
556
- const query = Object.entries(params).map(([name, value]) => `${name}=${value}`).join('&');
557
- return FileUri.create(this.globals.THEIA_FRONTEND_HTML_PATH)
558
- .withQuery(query);
559
- }
560
-
561
- protected getDefaultTheiaWindowOptions(): TheiaBrowserWindowOptions {
562
- return {
563
- frame: this.useNativeWindowFrame,
564
- isFullScreen: false,
565
- isMaximized: false,
566
- ...this.getDefaultTheiaWindowBounds(),
567
- ...this.getDefaultOptions()
568
- };
569
- }
570
-
571
- protected getDefaultTheiaSecondaryWindowBounds(): TheiaBrowserWindowOptions {
572
- return {};
573
- }
574
-
575
- protected getDefaultTheiaWindowBounds(): TheiaBrowserWindowOptions {
576
- // The `screen` API must be required when the application is ready.
577
- // See: https://electronjs.org/docs/api/screen#screen
578
- // We must center by hand because `browserWindow.center()` fails on multi-screen setups
579
- // See: https://github.com/electron/electron/issues/3490
580
- const { bounds } = screen.getDisplayNearestPoint(screen.getCursorScreenPoint());
581
- const height = Math.round(bounds.height * (2 / 3));
582
- const width = Math.round(bounds.width * (2 / 3));
583
- const y = Math.round(bounds.y + (bounds.height - height) / 2);
584
- const x = Math.round(bounds.x + (bounds.width - width) / 2);
585
- return {
586
- width,
587
- height,
588
- x,
589
- y
590
- };
591
- }
592
-
593
- /**
594
- * Save the window geometry state on every change.
595
- */
596
- protected attachSaveWindowState(electronWindow: BrowserWindow): void {
597
- const windowStateListeners = new DisposableCollection();
598
- let delayedSaveTimeout: NodeJS.Timeout | undefined;
599
- const saveWindowStateDelayed = () => {
600
- if (delayedSaveTimeout) {
601
- clearTimeout(delayedSaveTimeout);
602
- }
603
- delayedSaveTimeout = setTimeout(() => this.saveWindowState(electronWindow), 1000);
604
- };
605
- createDisposableListener(electronWindow, 'close', () => {
606
- this.saveWindowState(electronWindow);
607
- }, windowStateListeners);
608
- createDisposableListener(electronWindow, 'resize', saveWindowStateDelayed, windowStateListeners);
609
- createDisposableListener(electronWindow, 'move', saveWindowStateDelayed, windowStateListeners);
610
- windowStateListeners.push(Disposable.create(() => { try { this.didUseNativeWindowFrameOnStart.delete(electronWindow.webContents.id); } catch { } }));
611
- this.didUseNativeWindowFrameOnStart.set(electronWindow.webContents.id, this.useNativeWindowFrame);
612
- electronWindow.once('closed', () => windowStateListeners.dispose());
613
- }
614
-
615
- protected saveWindowState(electronWindow: BrowserWindow): void {
616
- // In some circumstances the `electronWindow` can be `null`
617
- if (!electronWindow) {
618
- return;
619
- }
620
- try {
621
- const bounds = electronWindow.getBounds();
622
- const options: TheiaBrowserWindowOptions = {
623
- isFullScreen: electronWindow.isFullScreen(),
624
- isMaximized: electronWindow.isMaximized(),
625
- width: bounds.width,
626
- height: bounds.height,
627
- x: bounds.x,
628
- y: bounds.y,
629
- frame: this.useNativeWindowFrame,
630
- screenLayout: this.getCurrentScreenLayout(),
631
- backgroundColor: this.customBackgroundColor
632
- };
633
- this.electronStore.set('windowstate', options);
634
- } catch (e) {
635
- console.error('Error while saving window state:', e);
636
- }
637
- }
638
-
639
- /**
640
- * Return a string unique to the current display layout.
641
- */
642
- protected getCurrentScreenLayout(): string {
643
- return screen.getAllDisplays().map(
644
- display => `${display.bounds.x}:${display.bounds.y}:${display.bounds.width}:${display.bounds.height}`
645
- ).sort().join('-');
646
- }
647
-
648
- /**
649
- * Start the NodeJS backend server.
650
- *
651
- * @return Running server's port promise.
652
- */
653
- protected async startBackend(): Promise<number> {
654
- // Check if we should run everything as one process.
655
- const noBackendFork = process.argv.indexOf('--no-cluster') !== -1;
656
- // Set the electron version for both the dev and the production mode. (https://github.com/eclipse-theia/theia/issues/3254)
657
- // Otherwise, the forked backend processes will not know that they're serving the electron frontend.
658
- process.env.THEIA_ELECTRON_VERSION = process.versions.electron;
659
- if (noBackendFork) {
660
- process.env[ElectronSecurityToken] = JSON.stringify(this.electronSecurityToken);
661
- // The backend server main file is supposed to export a promise resolving with the port used by the http(s) server.
662
- dynamicRequire(this.globals.THEIA_BACKEND_MAIN_PATH);
663
- // @ts-expect-error
664
- const address: AddressInfo = await globalThis.serverAddress;
665
- return address.port;
666
- } else {
667
- const backendProcess = fork(
668
- this.globals.THEIA_BACKEND_MAIN_PATH,
669
- this.processArgv.getProcessArgvWithoutBin(),
670
- await this.getForkOptions(),
671
- );
672
- return new Promise((resolve, reject) => {
673
- // The backend server main file is also supposed to send the resolved http(s) server port via IPC.
674
- backendProcess.on('message', (address: AddressInfo) => {
675
- resolve(address.port);
676
- });
677
- backendProcess.on('error', error => {
678
- reject(error);
679
- });
680
- backendProcess.on('exit', code => {
681
- reject(code);
682
- });
683
- app.on('quit', () => {
684
- // Only issue a kill signal if the backend process is running.
685
- // eslint-disable-next-line no-null/no-null
686
- if (backendProcess.exitCode === null && backendProcess.signalCode === null) {
687
- try {
688
- // If we forked the process for the clusters, we need to manually terminate it.
689
- // See: https://github.com/eclipse-theia/theia/issues/835
690
- if (backendProcess.pid) {
691
- process.kill(backendProcess.pid);
692
- }
693
- } catch (error) {
694
- // See https://man7.org/linux/man-pages/man2/kill.2.html#ERRORS
695
- if (error.code === 'ESRCH') {
696
- return;
697
- }
698
- throw error;
699
- }
700
- }
701
- });
702
- });
703
- }
704
- }
705
-
706
- protected async getForkOptions(): Promise<ForkOptions> {
707
- return {
708
- // The backend must be a process group leader on UNIX in order to kill the tree later.
709
- // See https://nodejs.org/api/child_process.html#child_process_options_detached
710
- detached: process.platform !== 'win32',
711
- env: {
712
- ...process.env,
713
- [ElectronSecurityToken]: JSON.stringify(this.electronSecurityToken),
714
- },
715
- };
716
- }
717
-
718
- protected async attachElectronSecurityToken(port: number): Promise<void> {
719
- await this.electronSecurityTokenService.setElectronSecurityTokenCookie(`http://localhost:${port}`);
720
- }
721
-
722
- protected hookApplicationEvents(): void {
723
- app.on('will-quit', this.onWillQuit.bind(this));
724
- app.on('second-instance', this.onSecondInstance.bind(this));
725
- app.on('window-all-closed', this.onWindowAllClosed.bind(this));
726
- app.on('web-contents-created', this.onWebContentsCreated.bind(this));
727
-
728
- if (isWindows) {
729
- const args = this.processArgv.isBundledElectronApp ? [] : [app.getAppPath()];
730
- args.push('--open-url');
731
- app.setAsDefaultProtocolClient(this.config.electron.uriScheme, process.execPath, args);
732
- } else {
733
- app.on('open-url', (evt, url) => {
734
- this.openUrl(url);
735
- });
736
- }
737
- }
738
-
739
- protected onWillQuit(event: ElectronEvent): void {
740
- this.stopContributions();
741
- }
742
-
743
- protected async onSecondInstance(event: ElectronEvent, argv: string[], cwd: string): Promise<void> {
744
- if (argv.includes('--open-url')) {
745
- this.openUrl(argv[argv.length - 1]);
746
- } else {
747
- createYargs(this.processArgv.getProcessArgvWithoutBin(argv), process.cwd())
748
- .help(false)
749
- .command('$0 [file]', false,
750
- cmd => cmd
751
- .positional('file', { type: 'string' }),
752
- async args => {
753
- await this.handleMainCommand({
754
- file: args.file,
755
- cwd: process.cwd(),
756
- secondInstance: true
757
- });
758
- },
759
- ).parse();
760
- }
761
- }
762
-
763
- protected onWebContentsCreated(event: ElectronEvent, webContents: WebContents): void {
764
- // Block any in-page navigation except loading the secondary window contents
765
- webContents.on('will-navigate', evt => {
766
- if (new URI(evt.url).path.fsPath() !== new Path(this.globals.THEIA_SECONDARY_WINDOW_HTML_PATH).fsPath()) {
767
- evt.preventDefault();
768
- }
769
- });
770
-
771
- webContents.setWindowOpenHandler(details => {
772
- // if it's a secondary window, allow it to open
773
- if (new URI(details.url).path.fsPath() === new Path(this.globals.THEIA_SECONDARY_WINDOW_HTML_PATH).fsPath()) {
774
- const { minWidth, minHeight } = this.getDefaultOptions();
775
- const options: BrowserWindowConstructorOptions = {
776
- ...this.getDefaultTheiaSecondaryWindowBounds(),
777
- // We always need the native window frame for now because the secondary window does not have Theia's title bar by default.
778
- // In 'custom' title bar mode this would leave the window without any window controls (close, min, max)
779
- // TODO set to this.useNativeWindowFrame when secondary windows support a custom title bar.
780
- frame: true,
781
- minWidth,
782
- minHeight
783
- };
784
- if (!this.useNativeWindowFrame) {
785
- // If the main window does not have a native window frame, do not show an icon in the secondary window's native title bar.
786
- // The data url is a 1x1 transparent png
787
- options.icon = nativeImage.createFromDataURL(
788
- 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAC0lEQVQI12P4DwQACfsD/WMmxY8AAAAASUVORK5CYII=');
789
- }
790
- return {
791
- action: 'allow',
792
- overrideBrowserWindowOptions: options,
793
- };
794
- } else {
795
- const uri: URI = new URI(details.url);
796
- let okToOpen = uri.scheme === 'https' || uri.scheme === 'http';
797
- if (!okToOpen) {
798
- const button = dialog.showMessageBoxSync(BrowserWindow.fromWebContents(webContents)!, {
799
- message: `Open link\n\n${details.url}\n\nin the system handler?`,
800
- type: 'question',
801
- title: 'Open Link',
802
- buttons: ['OK', 'Cancel'],
803
- defaultId: 1,
804
- cancelId: 1
805
- });
806
- okToOpen = button === 0;
807
- }
808
- if (okToOpen) {
809
- shell.openExternal(details.url, {});
810
- }
811
-
812
- return { action: 'deny' };
813
- }
814
- });
815
- }
816
-
817
- protected onWindowAllClosed(event: ElectronEvent): void {
818
- if (!this.restarting) {
819
- this.requestStop();
820
- }
821
- }
822
-
823
- public async restart(webContents: WebContents): Promise<void> {
824
- this.restarting = true;
825
- const wrapper = this.windows.get(webContents.id);
826
- if (wrapper) {
827
- const listener = wrapper.onDidClose(async () => {
828
- listener.dispose();
829
- await this.handleMainCommand({
830
- secondInstance: false,
831
- cwd: process.cwd()
832
- });
833
- this.restarting = false;
834
- });
835
- // If close failed or was cancelled on this occasion, don't keep listening for it.
836
- if (!await wrapper.close(StopReason.Restart)) {
837
- listener.dispose();
838
- }
839
- }
840
- }
841
-
842
- protected async startContributions(): Promise<void> {
843
- const promises = [];
844
- for (const contribution of this.contributions.getContributions()) {
845
- if (contribution.onStart) {
846
- promises.push(contribution.onStart(this));
847
- }
848
- }
849
- await Promise.all(promises);
850
- }
851
-
852
- protected stopContributions(): void {
853
- for (const contribution of this.contributions.getContributions()) {
854
- if (contribution.onStop) {
855
- contribution.onStop(this);
856
- }
857
- }
858
- }
859
-
860
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2020 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { inject, injectable, named } from 'inversify';
18
+ import {
19
+ screen, app, BrowserWindow, WebContents, Event as ElectronEvent, BrowserWindowConstructorOptions, nativeImage,
20
+ nativeTheme, shell, dialog
21
+ } from '../../electron-shared/electron';
22
+ import * as path from 'path';
23
+ import { Argv } from 'yargs';
24
+ import { AddressInfo } from 'net';
25
+ import { promises as fs } from 'fs';
26
+ import { existsSync, mkdirSync } from 'fs-extra';
27
+ import { fork, ForkOptions } from 'child_process';
28
+ import { DefaultTheme, ElectronFrontendApplicationConfig, FrontendApplicationConfig } from '@theia/application-package/lib/application-props';
29
+ import URI from '../common/uri';
30
+ import { FileUri } from '../common/file-uri';
31
+ import { Deferred, timeout } from '../common/promise-util';
32
+ import { MaybePromise } from '../common/types';
33
+ import { ContributionProvider } from '../common/contribution-provider';
34
+ import { ElectronSecurityTokenService } from './electron-security-token-service';
35
+ import { ElectronSecurityToken } from '../electron-common/electron-token';
36
+ import Storage = require('electron-store');
37
+ import { CancellationTokenSource, Disposable, DisposableCollection, Path, isOSX, isWindows } from '../common';
38
+ import { DEFAULT_WINDOW_HASH, WindowSearchParams } from '../common/window';
39
+ import { TheiaBrowserWindowOptions, TheiaElectronWindow, TheiaElectronWindowFactory } from './theia-electron-window';
40
+ import { ElectronMainApplicationGlobals } from './electron-main-constants';
41
+ import { createDisposableListener } from './event-utils';
42
+ import { TheiaRendererAPI } from './electron-api-main';
43
+ import { StopReason } from '../common/frontend-application-state';
44
+ import { dynamicRequire } from '../node/dynamic-require';
45
+
46
+ export { ElectronMainApplicationGlobals };
47
+
48
+ const createYargs: (argv?: string[], cwd?: string) => Argv = require('yargs/yargs');
49
+
50
+ /**
51
+ * Options passed to the main/default command handler.
52
+ */
53
+ export interface ElectronMainCommandOptions {
54
+
55
+ /**
56
+ * By default, the first positional argument. Should be either a relative or absolute file-system path pointing to a file or a folder.
57
+ */
58
+ readonly file?: string;
59
+
60
+ readonly cwd: string;
61
+
62
+ /**
63
+ * If the app is launched for the first time, `secondInstance` is false.
64
+ * If the app is already running but user relaunches it, `secondInstance` is true.
65
+ */
66
+ readonly secondInstance: boolean;
67
+ }
68
+
69
+ /**
70
+ * The default entrypoint will handle a very rudimentary CLI to open workspaces by doing `app path/to/workspace`. To override this behavior, you can extend and rebind the
71
+ * `ElectronMainApplication` class and overriding the `launch` method.
72
+ * A JSON-RPC communication between the Electron Main Process and the Renderer Processes is available: You can bind services using the `ElectronConnectionHandler` and
73
+ * `ElectronIpcConnectionProvider` APIs, example:
74
+ *
75
+ * From an `electron-main` module:
76
+ *
77
+ * bind(ElectronConnectionHandler).toDynamicValue(context =>
78
+ * new RpcConnectionHandler(electronMainWindowServicePath,
79
+ * () => context.container.get(ElectronMainWindowService))
80
+ * ).inSingletonScope();
81
+ *
82
+ * And from the `electron-browser` module:
83
+ *
84
+ * bind(ElectronMainWindowService).toDynamicValue(context =>
85
+ * ElectronIpcConnectionProvider.createProxy(context.container, electronMainWindowServicePath)
86
+ * ).inSingletonScope();
87
+ */
88
+ export const ElectronMainApplicationContribution = Symbol('ElectronMainApplicationContribution');
89
+ export interface ElectronMainApplicationContribution {
90
+ /**
91
+ * The application is ready and is starting. This is the time to initialize
92
+ * services global to this process.
93
+ *
94
+ * Invoked when the electron-main process starts for the first time.
95
+ */
96
+ onStart?(application: ElectronMainApplication): MaybePromise<void>;
97
+ /**
98
+ * The application is stopping. Contributions must perform only synchronous operations.
99
+ */
100
+ onStop?(application: ElectronMainApplication): void;
101
+ }
102
+
103
+ // Extracted and modified the functionality from `yargs@15.4.0-beta.0`.
104
+ // Based on https://github.com/yargs/yargs/blob/522b019c9a50924605986a1e6e0cb716d47bcbca/lib/process-argv.ts
105
+ @injectable()
106
+ export class ElectronMainProcessArgv {
107
+
108
+ protected get processArgvBinIndex(): number {
109
+ // The binary name is the first command line argument for:
110
+ // - bundled Electron apps: bin argv1 argv2 ... argvn
111
+ if (this.isBundledElectronApp) {
112
+ return 0;
113
+ }
114
+ // or the second one (default) for:
115
+ // - standard node apps: node bin.js argv1 argv2 ... argvn
116
+ // - unbundled Electron apps: electron bin.js argv1 arg2 ... argvn
117
+ return 1;
118
+ }
119
+
120
+ get isBundledElectronApp(): boolean {
121
+ // process.defaultApp is either set by electron in an electron unbundled app, or undefined
122
+ // see https://github.com/electron/electron/blob/master/docs/api/process.md#processdefaultapp-readonly
123
+ return this.isElectronApp && !(process as ElectronMainProcessArgv.ElectronMainProcess).defaultApp;
124
+ }
125
+
126
+ get isElectronApp(): boolean {
127
+ // process.versions.electron is either set by electron, or undefined
128
+ // see https://github.com/electron/electron/blob/master/docs/api/process.md#processversionselectron-readonly
129
+ return !!(process as ElectronMainProcessArgv.ElectronMainProcess).versions.electron;
130
+ }
131
+
132
+ getProcessArgvWithoutBin(argv = process.argv): Array<string> {
133
+ return argv.slice(this.processArgvBinIndex + 1);
134
+ }
135
+
136
+ getProcessArgvBin(argv = process.argv): string {
137
+ return argv[this.processArgvBinIndex];
138
+ }
139
+
140
+ }
141
+
142
+ export namespace ElectronMainProcessArgv {
143
+ export interface ElectronMainProcess extends NodeJS.Process {
144
+ readonly defaultApp: boolean;
145
+ readonly versions: NodeJS.ProcessVersions & {
146
+ readonly electron: string;
147
+ };
148
+ }
149
+ }
150
+
151
+ @injectable()
152
+ export class ElectronMainApplication {
153
+ @inject(ContributionProvider)
154
+ @named(ElectronMainApplicationContribution)
155
+ protected readonly contributions: ContributionProvider<ElectronMainApplicationContribution>;
156
+
157
+ @inject(ElectronMainApplicationGlobals)
158
+ protected readonly globals: ElectronMainApplicationGlobals;
159
+
160
+ @inject(ElectronMainProcessArgv)
161
+ protected processArgv: ElectronMainProcessArgv;
162
+
163
+ @inject(ElectronSecurityTokenService)
164
+ protected electronSecurityTokenService: ElectronSecurityTokenService;
165
+
166
+ @inject(ElectronSecurityToken)
167
+ protected readonly electronSecurityToken: ElectronSecurityToken;
168
+
169
+ @inject(TheiaElectronWindowFactory)
170
+ protected readonly windowFactory: TheiaElectronWindowFactory;
171
+
172
+ protected isPortable = this.makePortable();
173
+
174
+ protected readonly electronStore = new Storage<{
175
+ windowstate?: TheiaBrowserWindowOptions
176
+ }>();
177
+
178
+ protected readonly _backendPort = new Deferred<number>();
179
+ readonly backendPort = this._backendPort.promise;
180
+
181
+ protected _config: FrontendApplicationConfig | undefined;
182
+ protected useNativeWindowFrame: boolean = true;
183
+ protected customBackgroundColor?: string;
184
+ protected didUseNativeWindowFrameOnStart = new Map<number, boolean>();
185
+ protected windows = new Map<number, TheiaElectronWindow>();
186
+ protected activeWindowStack: number[] = [];
187
+ protected restarting = false;
188
+
189
+ /** Used to temporarily store the reference to an early created main window */
190
+ protected initialWindow?: BrowserWindow;
191
+
192
+ get config(): FrontendApplicationConfig {
193
+ if (!this._config) {
194
+ throw new Error('You have to start the application first.');
195
+ }
196
+ return this._config;
197
+ }
198
+
199
+ protected makePortable(): boolean {
200
+ const dataFolderPath = path.join(app.getAppPath(), 'data');
201
+ const appDataPath = path.join(dataFolderPath, 'app-data');
202
+ if (existsSync(dataFolderPath)) {
203
+ if (!existsSync(appDataPath)) {
204
+ mkdirSync(appDataPath);
205
+ }
206
+ app.setPath('userData', appDataPath);
207
+ return true;
208
+ } else {
209
+ return false;
210
+ }
211
+ }
212
+
213
+ async start(config: FrontendApplicationConfig): Promise<void> {
214
+ const argv = this.processArgv.getProcessArgvWithoutBin(process.argv);
215
+ createYargs(argv, process.cwd())
216
+ .help(false)
217
+ .command('$0 [file]', false,
218
+ cmd => cmd
219
+ .option('electronUserData', {
220
+ type: 'string',
221
+ describe: 'The area where the electron main process puts its data'
222
+ })
223
+ .positional('file', { type: 'string' }),
224
+ async args => {
225
+ if (args.electronUserData) {
226
+ console.info(`using electron user data area : '${args.electronUserData}'`);
227
+ await fs.mkdir(args.electronUserData, { recursive: true });
228
+ app.setPath('userData', args.electronUserData);
229
+ }
230
+ this.useNativeWindowFrame = this.getTitleBarStyle(config) === 'native';
231
+ this._config = config;
232
+ this.hookApplicationEvents();
233
+ this.showInitialWindow(argv.includes('--open-url') ? argv[argv.length - 1] : undefined);
234
+ const port = await this.startBackend();
235
+ this._backendPort.resolve(port);
236
+ await app.whenReady();
237
+ await this.attachElectronSecurityToken(port);
238
+ await this.startContributions();
239
+
240
+ this.handleMainCommand({
241
+ file: args.file,
242
+ cwd: process.cwd(),
243
+ secondInstance: false
244
+ });
245
+ },
246
+ ).parse();
247
+ }
248
+
249
+ protected getTitleBarStyle(config: FrontendApplicationConfig): 'native' | 'custom' {
250
+ if ('THEIA_ELECTRON_DISABLE_NATIVE_ELEMENTS' in process.env && process.env.THEIA_ELECTRON_DISABLE_NATIVE_ELEMENTS === '1') {
251
+ return 'custom';
252
+ }
253
+ if (isOSX) {
254
+ return 'native';
255
+ }
256
+ const storedFrame = this.electronStore.get('windowstate')?.frame;
257
+ if (storedFrame !== undefined) {
258
+ return !!storedFrame ? 'native' : 'custom';
259
+ }
260
+ if (config.preferences && config.preferences['window.titleBarStyle']) {
261
+ const titleBarStyle = config.preferences['window.titleBarStyle'];
262
+ if (titleBarStyle === 'native' || titleBarStyle === 'custom') {
263
+ return titleBarStyle;
264
+ }
265
+ }
266
+ return isWindows ? 'custom' : 'native';
267
+ }
268
+
269
+ public setTitleBarStyle(webContents: WebContents, style: string): void {
270
+ this.useNativeWindowFrame = isOSX || style === 'native';
271
+ this.saveState(webContents);
272
+ }
273
+
274
+ setBackgroundColor(webContents: WebContents, backgroundColor: string): void {
275
+ this.customBackgroundColor = backgroundColor;
276
+ this.saveState(webContents);
277
+ }
278
+
279
+ protected saveState(webContents: Electron.WebContents): void {
280
+ const browserWindow = BrowserWindow.fromWebContents(webContents);
281
+ if (browserWindow) {
282
+ this.saveWindowState(browserWindow);
283
+ } else {
284
+ console.warn(`no BrowserWindow with id: ${webContents.id}`);
285
+ }
286
+ }
287
+
288
+ /**
289
+ * @param id the id of the WebContents of the BrowserWindow in question
290
+ * @returns 'native' or 'custom'
291
+ */
292
+ getTitleBarStyleAtStartup(webContents: WebContents): 'native' | 'custom' {
293
+ return this.didUseNativeWindowFrameOnStart.get(webContents.id) ? 'native' : 'custom';
294
+ }
295
+
296
+ protected async determineSplashScreenBounds(initialWindowBounds: { x: number, y: number, width: number, height: number }):
297
+ Promise<{ x: number, y: number, width: number, height: number }> {
298
+ const splashScreenOptions = this.getSplashScreenOptions();
299
+ const width = splashScreenOptions?.width ?? 640;
300
+ const height = splashScreenOptions?.height ?? 480;
301
+
302
+ // determine the screen on which to show the splash screen via the center of the window to show
303
+ const windowCenterPoint = { x: initialWindowBounds.x + (initialWindowBounds.width / 2), y: initialWindowBounds.y + (initialWindowBounds.height / 2) };
304
+ const { bounds } = screen.getDisplayNearestPoint(windowCenterPoint);
305
+
306
+ // place splash screen center of screen
307
+ const screenCenterPoint = { x: bounds.x + (bounds.width / 2), y: bounds.y + (bounds.height / 2) };
308
+ const x = screenCenterPoint.x - (width / 2);
309
+ const y = screenCenterPoint.y - (height / 2);
310
+
311
+ return {
312
+ x, y, width, height
313
+ };
314
+ }
315
+
316
+ protected isShowWindowEarly(): boolean {
317
+ return !!this.config.electron.showWindowEarly &&
318
+ !('THEIA_ELECTRON_NO_EARLY_WINDOW' in process.env && process.env.THEIA_ELECTRON_NO_EARLY_WINDOW === '1');
319
+ }
320
+
321
+ protected showInitialWindow(urlToOpen: string | undefined): void {
322
+ if (this.isShowWindowEarly() || this.isShowSplashScreen()) {
323
+ app.whenReady().then(async () => {
324
+ const options = await this.getLastWindowOptions();
325
+ // If we want to show a splash screen, don't auto open the main window
326
+ if (this.isShowSplashScreen()) {
327
+ options.preventAutomaticShow = true;
328
+ }
329
+ this.initialWindow = await this.createWindow({ ...options });
330
+ TheiaRendererAPI.onApplicationStateChanged(this.initialWindow.webContents, state => {
331
+ if (state === 'ready' && urlToOpen) {
332
+ this.openUrl(urlToOpen);
333
+ }
334
+ });
335
+ if (this.isShowSplashScreen()) {
336
+ console.log('Showing splash screen');
337
+ this.configureAndShowSplashScreen(this.initialWindow);
338
+ }
339
+
340
+ // Show main window early if windows shall be shown early and splash screen is not configured
341
+ if (this.isShowWindowEarly() && !this.isShowSplashScreen()) {
342
+ console.log('Showing main window early');
343
+ this.initialWindow.show();
344
+ }
345
+ });
346
+ }
347
+ }
348
+
349
+ protected async configureAndShowSplashScreen(mainWindow: BrowserWindow): Promise<BrowserWindow> {
350
+ const splashScreenOptions = this.getSplashScreenOptions()!;
351
+ console.debug('SplashScreen options', splashScreenOptions);
352
+
353
+ const splashScreenBounds = await this.determineSplashScreenBounds(mainWindow.getBounds());
354
+ const splashScreenWindow = new BrowserWindow({
355
+ ...splashScreenBounds,
356
+ frame: false,
357
+ alwaysOnTop: true,
358
+ show: false,
359
+ transparent: true,
360
+ webPreferences: {
361
+ backgroundThrottling: false
362
+ }
363
+ });
364
+
365
+ if (this.isShowWindowEarly()) {
366
+ console.log('Showing splash screen early');
367
+ splashScreenWindow.show();
368
+ } else {
369
+ splashScreenWindow.on('ready-to-show', () => {
370
+ splashScreenWindow.show();
371
+ });
372
+ }
373
+
374
+ splashScreenWindow.loadFile(path.resolve(this.globals.THEIA_APP_PROJECT_PATH, splashScreenOptions.content!).toString());
375
+
376
+ // close splash screen and show main window once frontend is ready or a timeout is hit
377
+ const cancelTokenSource = new CancellationTokenSource();
378
+ const minTime = timeout(splashScreenOptions.minDuration ?? 0, cancelTokenSource.token);
379
+ const maxTime = timeout(splashScreenOptions.maxDuration ?? 30000, cancelTokenSource.token);
380
+
381
+ const showWindowAndCloseSplashScreen = () => {
382
+ cancelTokenSource.cancel();
383
+ if (!mainWindow.isVisible()) {
384
+ mainWindow.show();
385
+ }
386
+ splashScreenWindow.close();
387
+ };
388
+ TheiaRendererAPI.onApplicationStateChanged(mainWindow.webContents, state => {
389
+ if (state === 'ready') {
390
+ minTime.then(() => showWindowAndCloseSplashScreen());
391
+ }
392
+ });
393
+ maxTime.then(() => showWindowAndCloseSplashScreen());
394
+ return splashScreenWindow;
395
+ }
396
+
397
+ protected isShowSplashScreen(): boolean {
398
+ return typeof this.config.electron.splashScreenOptions === 'object' && !!this.config.electron.splashScreenOptions.content;
399
+ }
400
+
401
+ protected getSplashScreenOptions(): ElectronFrontendApplicationConfig.SplashScreenOptions | undefined {
402
+ if (this.isShowSplashScreen()) {
403
+ return this.config.electron.splashScreenOptions;
404
+ }
405
+ return undefined;
406
+ }
407
+
408
+ /**
409
+ * Use this rather than creating `BrowserWindow` instances from scratch, since some security parameters need to be set, this method will do it.
410
+ *
411
+ * @param options
412
+ */
413
+ async createWindow(asyncOptions: MaybePromise<TheiaBrowserWindowOptions> = this.getDefaultTheiaWindowOptions()): Promise<BrowserWindow> {
414
+ let options = await asyncOptions;
415
+ options = this.avoidOverlap(options);
416
+ const electronWindow = this.windowFactory(options, this.config);
417
+ const id = electronWindow.window.webContents.id;
418
+ this.activeWindowStack.push(id);
419
+ this.windows.set(id, electronWindow);
420
+ electronWindow.onDidClose(() => {
421
+ const stackIndex = this.activeWindowStack.indexOf(id);
422
+ if (stackIndex >= 0) {
423
+ this.activeWindowStack.splice(stackIndex, 1);
424
+ }
425
+ this.windows.delete(id);
426
+ });
427
+ electronWindow.window.on('maximize', () => TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'maximize'));
428
+ electronWindow.window.on('unmaximize', () => TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'unmaximize'));
429
+ electronWindow.window.on('focus', () => {
430
+ const stackIndex = this.activeWindowStack.indexOf(id);
431
+ if (stackIndex >= 0) {
432
+ this.activeWindowStack.splice(stackIndex, 1);
433
+ }
434
+ this.activeWindowStack.unshift(id);
435
+ TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'focus');
436
+ });
437
+ this.attachSaveWindowState(electronWindow.window);
438
+
439
+ return electronWindow.window;
440
+ }
441
+
442
+ async getLastWindowOptions(): Promise<TheiaBrowserWindowOptions> {
443
+ const previousWindowState: TheiaBrowserWindowOptions | undefined = this.electronStore.get('windowstate');
444
+ const windowState = previousWindowState?.screenLayout === this.getCurrentScreenLayout()
445
+ ? previousWindowState
446
+ : this.getDefaultTheiaWindowOptions();
447
+ return {
448
+ frame: this.useNativeWindowFrame,
449
+ ...this.getDefaultOptions(),
450
+ ...windowState
451
+ };
452
+ }
453
+
454
+ protected avoidOverlap(options: TheiaBrowserWindowOptions): TheiaBrowserWindowOptions {
455
+ const existingWindowsBounds = BrowserWindow.getAllWindows().map(window => window.getBounds());
456
+ if (existingWindowsBounds.length > 0) {
457
+ while (existingWindowsBounds.some(window => window.x === options.x || window.y === options.y)) {
458
+ // if the window is maximized or in fullscreen, use the default window options.
459
+ if (options.isMaximized || options.isFullScreen) {
460
+ options = this.getDefaultTheiaWindowOptions();
461
+ }
462
+ options.x = options.x! + 30;
463
+ options.y = options.y! + 30;
464
+
465
+ }
466
+ }
467
+ return options;
468
+ }
469
+
470
+ protected getDefaultOptions(): TheiaBrowserWindowOptions {
471
+ return {
472
+ show: false,
473
+ title: this.config.applicationName,
474
+ backgroundColor: DefaultTheme.defaultBackgroundColor(this.config.electron.windowOptions?.darkTheme || nativeTheme.shouldUseDarkColors),
475
+ minWidth: 200,
476
+ minHeight: 120,
477
+ webPreferences: {
478
+ // `global` is undefined when `true`.
479
+ contextIsolation: true,
480
+ sandbox: false,
481
+ nodeIntegration: false,
482
+ // Setting the following option to `true` causes some features to break, somehow.
483
+ // Issue: https://github.com/eclipse-theia/theia/issues/8577
484
+ nodeIntegrationInWorker: false,
485
+ backgroundThrottling: false,
486
+ preload: path.resolve(this.globals.THEIA_APP_PROJECT_PATH, 'lib', 'frontend', 'preload.js').toString()
487
+ },
488
+ ...this.config.electron?.windowOptions || {},
489
+ };
490
+ }
491
+
492
+ async openDefaultWindow(params?: WindowSearchParams): Promise<BrowserWindow> {
493
+ const options = this.getDefaultTheiaWindowOptions();
494
+ const [uri, electronWindow] = await Promise.all([this.createWindowUri(params), this.reuseOrCreateWindow(options)]);
495
+ electronWindow.loadURL(uri.withFragment(DEFAULT_WINDOW_HASH).toString(true));
496
+ return electronWindow;
497
+ }
498
+
499
+ protected async openWindowWithWorkspace(workspacePath: string): Promise<BrowserWindow> {
500
+ const options = await this.getLastWindowOptions();
501
+ const [uri, electronWindow] = await Promise.all([this.createWindowUri(), this.reuseOrCreateWindow(options)]);
502
+ electronWindow.loadURL(uri.withFragment(encodeURI(workspacePath)).toString(true));
503
+ return electronWindow;
504
+ }
505
+
506
+ protected async reuseOrCreateWindow(asyncOptions: MaybePromise<TheiaBrowserWindowOptions>): Promise<BrowserWindow> {
507
+ if (!this.initialWindow) {
508
+ return this.createWindow(asyncOptions);
509
+ }
510
+ // reset initial window after having it re-used once
511
+ const window = this.initialWindow;
512
+ this.initialWindow = undefined;
513
+ return window;
514
+ }
515
+
516
+ /**
517
+ * "Gently" close all windows, application will not stop if a `beforeunload` handler returns `false`.
518
+ */
519
+ requestStop(): void {
520
+ app.quit();
521
+ }
522
+
523
+ protected async handleMainCommand(options: ElectronMainCommandOptions): Promise<void> {
524
+ if (options.secondInstance === false) {
525
+ await this.openWindowWithWorkspace(''); // restore previous workspace.
526
+ } else if (options.file === undefined) {
527
+ await this.openDefaultWindow();
528
+ } else {
529
+ let workspacePath: string | undefined;
530
+ try {
531
+ workspacePath = await fs.realpath(path.resolve(options.cwd, options.file));
532
+ } catch {
533
+ console.error(`Could not resolve the workspace path. "${options.file}" is not a valid 'file' option. Falling back to the default workspace location.`);
534
+ }
535
+ if (workspacePath === undefined) {
536
+ await this.openDefaultWindow();
537
+ } else {
538
+ await this.openWindowWithWorkspace(workspacePath);
539
+ }
540
+ }
541
+ }
542
+
543
+ async openUrl(url: string): Promise<void> {
544
+ for (const id of this.activeWindowStack) {
545
+ const window = this.windows.get(id);
546
+ if (window && await window.openUrl(url)) {
547
+ break;
548
+ }
549
+ }
550
+ }
551
+
552
+ protected async createWindowUri(params: WindowSearchParams = {}): Promise<URI> {
553
+ if (!('port' in params)) {
554
+ params.port = (await this.backendPort).toString();
555
+ }
556
+ const query = Object.entries(params).map(([name, value]) => `${name}=${value}`).join('&');
557
+ return FileUri.create(this.globals.THEIA_FRONTEND_HTML_PATH)
558
+ .withQuery(query);
559
+ }
560
+
561
+ protected getDefaultTheiaWindowOptions(): TheiaBrowserWindowOptions {
562
+ return {
563
+ frame: this.useNativeWindowFrame,
564
+ isFullScreen: false,
565
+ isMaximized: false,
566
+ ...this.getDefaultTheiaWindowBounds(),
567
+ ...this.getDefaultOptions()
568
+ };
569
+ }
570
+
571
+ protected getDefaultTheiaSecondaryWindowBounds(): TheiaBrowserWindowOptions {
572
+ return {};
573
+ }
574
+
575
+ protected getDefaultTheiaWindowBounds(): TheiaBrowserWindowOptions {
576
+ // The `screen` API must be required when the application is ready.
577
+ // See: https://electronjs.org/docs/api/screen#screen
578
+ // We must center by hand because `browserWindow.center()` fails on multi-screen setups
579
+ // See: https://github.com/electron/electron/issues/3490
580
+ const { bounds } = screen.getDisplayNearestPoint(screen.getCursorScreenPoint());
581
+ const height = Math.round(bounds.height * (2 / 3));
582
+ const width = Math.round(bounds.width * (2 / 3));
583
+ const y = Math.round(bounds.y + (bounds.height - height) / 2);
584
+ const x = Math.round(bounds.x + (bounds.width - width) / 2);
585
+ return {
586
+ width,
587
+ height,
588
+ x,
589
+ y
590
+ };
591
+ }
592
+
593
+ /**
594
+ * Save the window geometry state on every change.
595
+ */
596
+ protected attachSaveWindowState(electronWindow: BrowserWindow): void {
597
+ const windowStateListeners = new DisposableCollection();
598
+ let delayedSaveTimeout: NodeJS.Timeout | undefined;
599
+ const saveWindowStateDelayed = () => {
600
+ if (delayedSaveTimeout) {
601
+ clearTimeout(delayedSaveTimeout);
602
+ }
603
+ delayedSaveTimeout = setTimeout(() => this.saveWindowState(electronWindow), 1000);
604
+ };
605
+ createDisposableListener(electronWindow, 'close', () => {
606
+ this.saveWindowState(electronWindow);
607
+ }, windowStateListeners);
608
+ createDisposableListener(electronWindow, 'resize', saveWindowStateDelayed, windowStateListeners);
609
+ createDisposableListener(electronWindow, 'move', saveWindowStateDelayed, windowStateListeners);
610
+ windowStateListeners.push(Disposable.create(() => { try { this.didUseNativeWindowFrameOnStart.delete(electronWindow.webContents.id); } catch { } }));
611
+ this.didUseNativeWindowFrameOnStart.set(electronWindow.webContents.id, this.useNativeWindowFrame);
612
+ electronWindow.once('closed', () => windowStateListeners.dispose());
613
+ }
614
+
615
+ protected saveWindowState(electronWindow: BrowserWindow): void {
616
+ // In some circumstances the `electronWindow` can be `null`
617
+ if (!electronWindow) {
618
+ return;
619
+ }
620
+ try {
621
+ const bounds = electronWindow.getBounds();
622
+ const options: TheiaBrowserWindowOptions = {
623
+ isFullScreen: electronWindow.isFullScreen(),
624
+ isMaximized: electronWindow.isMaximized(),
625
+ width: bounds.width,
626
+ height: bounds.height,
627
+ x: bounds.x,
628
+ y: bounds.y,
629
+ frame: this.useNativeWindowFrame,
630
+ screenLayout: this.getCurrentScreenLayout(),
631
+ backgroundColor: this.customBackgroundColor
632
+ };
633
+ this.electronStore.set('windowstate', options);
634
+ } catch (e) {
635
+ console.error('Error while saving window state:', e);
636
+ }
637
+ }
638
+
639
+ /**
640
+ * Return a string unique to the current display layout.
641
+ */
642
+ protected getCurrentScreenLayout(): string {
643
+ return screen.getAllDisplays().map(
644
+ display => `${display.bounds.x}:${display.bounds.y}:${display.bounds.width}:${display.bounds.height}`
645
+ ).sort().join('-');
646
+ }
647
+
648
+ /**
649
+ * Start the NodeJS backend server.
650
+ *
651
+ * @return Running server's port promise.
652
+ */
653
+ protected async startBackend(): Promise<number> {
654
+ // Check if we should run everything as one process.
655
+ const noBackendFork = process.argv.indexOf('--no-cluster') !== -1;
656
+ // Set the electron version for both the dev and the production mode. (https://github.com/eclipse-theia/theia/issues/3254)
657
+ // Otherwise, the forked backend processes will not know that they're serving the electron frontend.
658
+ process.env.THEIA_ELECTRON_VERSION = process.versions.electron;
659
+ if (noBackendFork) {
660
+ process.env[ElectronSecurityToken] = JSON.stringify(this.electronSecurityToken);
661
+ // The backend server main file is supposed to export a promise resolving with the port used by the http(s) server.
662
+ dynamicRequire(this.globals.THEIA_BACKEND_MAIN_PATH);
663
+ // @ts-expect-error
664
+ const address: AddressInfo = await globalThis.serverAddress;
665
+ return address.port;
666
+ } else {
667
+ const backendProcess = fork(
668
+ this.globals.THEIA_BACKEND_MAIN_PATH,
669
+ this.processArgv.getProcessArgvWithoutBin(),
670
+ await this.getForkOptions(),
671
+ );
672
+ return new Promise((resolve, reject) => {
673
+ // The backend server main file is also supposed to send the resolved http(s) server port via IPC.
674
+ backendProcess.on('message', (address: AddressInfo) => {
675
+ resolve(address.port);
676
+ });
677
+ backendProcess.on('error', error => {
678
+ reject(error);
679
+ });
680
+ backendProcess.on('exit', code => {
681
+ reject(code);
682
+ });
683
+ app.on('quit', () => {
684
+ // Only issue a kill signal if the backend process is running.
685
+ // eslint-disable-next-line no-null/no-null
686
+ if (backendProcess.exitCode === null && backendProcess.signalCode === null) {
687
+ try {
688
+ // If we forked the process for the clusters, we need to manually terminate it.
689
+ // See: https://github.com/eclipse-theia/theia/issues/835
690
+ if (backendProcess.pid) {
691
+ process.kill(backendProcess.pid);
692
+ }
693
+ } catch (error) {
694
+ // See https://man7.org/linux/man-pages/man2/kill.2.html#ERRORS
695
+ if (error.code === 'ESRCH') {
696
+ return;
697
+ }
698
+ throw error;
699
+ }
700
+ }
701
+ });
702
+ });
703
+ }
704
+ }
705
+
706
+ protected async getForkOptions(): Promise<ForkOptions> {
707
+ return {
708
+ // The backend must be a process group leader on UNIX in order to kill the tree later.
709
+ // See https://nodejs.org/api/child_process.html#child_process_options_detached
710
+ detached: process.platform !== 'win32',
711
+ env: {
712
+ ...process.env,
713
+ [ElectronSecurityToken]: JSON.stringify(this.electronSecurityToken),
714
+ },
715
+ };
716
+ }
717
+
718
+ protected async attachElectronSecurityToken(port: number): Promise<void> {
719
+ await this.electronSecurityTokenService.setElectronSecurityTokenCookie(`http://localhost:${port}`);
720
+ }
721
+
722
+ protected hookApplicationEvents(): void {
723
+ app.on('will-quit', this.onWillQuit.bind(this));
724
+ app.on('second-instance', this.onSecondInstance.bind(this));
725
+ app.on('window-all-closed', this.onWindowAllClosed.bind(this));
726
+ app.on('web-contents-created', this.onWebContentsCreated.bind(this));
727
+
728
+ if (isWindows) {
729
+ const args = this.processArgv.isBundledElectronApp ? [] : [app.getAppPath()];
730
+ args.push('--open-url');
731
+ app.setAsDefaultProtocolClient(this.config.electron.uriScheme, process.execPath, args);
732
+ } else {
733
+ app.on('open-url', (evt, url) => {
734
+ this.openUrl(url);
735
+ });
736
+ }
737
+ }
738
+
739
+ protected onWillQuit(event: ElectronEvent): void {
740
+ this.stopContributions();
741
+ }
742
+
743
+ protected async onSecondInstance(event: ElectronEvent, argv: string[], cwd: string): Promise<void> {
744
+ if (argv.includes('--open-url')) {
745
+ this.openUrl(argv[argv.length - 1]);
746
+ } else {
747
+ createYargs(this.processArgv.getProcessArgvWithoutBin(argv), process.cwd())
748
+ .help(false)
749
+ .command('$0 [file]', false,
750
+ cmd => cmd
751
+ .positional('file', { type: 'string' }),
752
+ async args => {
753
+ await this.handleMainCommand({
754
+ file: args.file,
755
+ cwd: process.cwd(),
756
+ secondInstance: true
757
+ });
758
+ },
759
+ ).parse();
760
+ }
761
+ }
762
+
763
+ protected onWebContentsCreated(event: ElectronEvent, webContents: WebContents): void {
764
+ // Block any in-page navigation except loading the secondary window contents
765
+ webContents.on('will-navigate', evt => {
766
+ if (new URI(evt.url).path.fsPath() !== new Path(this.globals.THEIA_SECONDARY_WINDOW_HTML_PATH).fsPath()) {
767
+ evt.preventDefault();
768
+ }
769
+ });
770
+
771
+ webContents.setWindowOpenHandler(details => {
772
+ // if it's a secondary window, allow it to open
773
+ if (new URI(details.url).path.fsPath() === new Path(this.globals.THEIA_SECONDARY_WINDOW_HTML_PATH).fsPath()) {
774
+ const { minWidth, minHeight } = this.getDefaultOptions();
775
+ const options: BrowserWindowConstructorOptions = {
776
+ ...this.getDefaultTheiaSecondaryWindowBounds(),
777
+ // We always need the native window frame for now because the secondary window does not have Theia's title bar by default.
778
+ // In 'custom' title bar mode this would leave the window without any window controls (close, min, max)
779
+ // TODO set to this.useNativeWindowFrame when secondary windows support a custom title bar.
780
+ frame: true,
781
+ minWidth,
782
+ minHeight
783
+ };
784
+ if (!this.useNativeWindowFrame) {
785
+ // If the main window does not have a native window frame, do not show an icon in the secondary window's native title bar.
786
+ // The data url is a 1x1 transparent png
787
+ options.icon = nativeImage.createFromDataURL(
788
+ 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAC0lEQVQI12P4DwQACfsD/WMmxY8AAAAASUVORK5CYII=');
789
+ }
790
+ return {
791
+ action: 'allow',
792
+ overrideBrowserWindowOptions: options,
793
+ };
794
+ } else {
795
+ const uri: URI = new URI(details.url);
796
+ let okToOpen = uri.scheme === 'https' || uri.scheme === 'http';
797
+ if (!okToOpen) {
798
+ const button = dialog.showMessageBoxSync(BrowserWindow.fromWebContents(webContents)!, {
799
+ message: `Open link\n\n${details.url}\n\nin the system handler?`,
800
+ type: 'question',
801
+ title: 'Open Link',
802
+ buttons: ['OK', 'Cancel'],
803
+ defaultId: 1,
804
+ cancelId: 1
805
+ });
806
+ okToOpen = button === 0;
807
+ }
808
+ if (okToOpen) {
809
+ shell.openExternal(details.url, {});
810
+ }
811
+
812
+ return { action: 'deny' };
813
+ }
814
+ });
815
+ }
816
+
817
+ protected onWindowAllClosed(event: ElectronEvent): void {
818
+ if (!this.restarting) {
819
+ this.requestStop();
820
+ }
821
+ }
822
+
823
+ public async restart(webContents: WebContents): Promise<void> {
824
+ this.restarting = true;
825
+ const wrapper = this.windows.get(webContents.id);
826
+ if (wrapper) {
827
+ const listener = wrapper.onDidClose(async () => {
828
+ listener.dispose();
829
+ await this.handleMainCommand({
830
+ secondInstance: false,
831
+ cwd: process.cwd()
832
+ });
833
+ this.restarting = false;
834
+ });
835
+ // If close failed or was cancelled on this occasion, don't keep listening for it.
836
+ if (!await wrapper.close(StopReason.Restart)) {
837
+ listener.dispose();
838
+ }
839
+ }
840
+ }
841
+
842
+ protected async startContributions(): Promise<void> {
843
+ const promises = [];
844
+ for (const contribution of this.contributions.getContributions()) {
845
+ if (contribution.onStart) {
846
+ promises.push(contribution.onStart(this));
847
+ }
848
+ }
849
+ await Promise.all(promises);
850
+ }
851
+
852
+ protected stopContributions(): void {
853
+ for (const contribution of this.contributions.getContributions()) {
854
+ if (contribution.onStop) {
855
+ contribution.onStop(this);
856
+ }
857
+ }
858
+ }
859
+
860
+ }