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

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 (689) hide show
  1. package/README.md +7 -7
  2. package/i18n/nls.cs.json +582 -552
  3. package/i18n/nls.de.json +582 -552
  4. package/i18n/nls.es.json +582 -552
  5. package/i18n/nls.fr.json +582 -552
  6. package/i18n/nls.hu.json +582 -552
  7. package/i18n/nls.it.json +582 -552
  8. package/i18n/nls.ja.json +582 -552
  9. package/i18n/nls.json +582 -552
  10. package/i18n/nls.ko.json +582 -0
  11. package/i18n/nls.pl.json +582 -552
  12. package/i18n/nls.pt-br.json +582 -552
  13. package/i18n/nls.ru.json +582 -552
  14. package/i18n/nls.tr.json +582 -0
  15. package/i18n/nls.zh-cn.json +582 -552
  16. package/i18n/nls.zh-tw.json +582 -0
  17. package/lib/browser/authentication-service.d.ts +15 -14
  18. package/lib/browser/authentication-service.d.ts.map +1 -1
  19. package/lib/browser/authentication-service.js +5 -5
  20. package/lib/browser/authentication-service.js.map +1 -1
  21. package/lib/browser/catalog.json +6889 -0
  22. package/lib/browser/common-frontend-contribution.js +3 -3
  23. package/lib/browser/common-styling-participants.js +166 -166
  24. package/lib/browser/context-key-service.d.ts +3 -2
  25. package/lib/browser/context-key-service.d.ts.map +1 -1
  26. package/lib/browser/context-key-service.js.map +1 -1
  27. package/lib/browser/core-preferences.d.ts.map +1 -1
  28. package/lib/browser/core-preferences.js +9 -0
  29. package/lib/browser/core-preferences.js.map +1 -1
  30. package/lib/browser/frontend-application-module.d.ts.map +1 -1
  31. package/lib/browser/frontend-application-module.js.map +1 -1
  32. package/lib/browser/json-schema-store.d.ts +0 -3
  33. package/lib/browser/json-schema-store.d.ts.map +1 -1
  34. package/lib/browser/json-schema-store.js +2 -12
  35. package/lib/browser/json-schema-store.js.map +1 -1
  36. package/lib/browser/open-with-service.d.ts +13 -1
  37. package/lib/browser/open-with-service.d.ts.map +1 -1
  38. package/lib/browser/open-with-service.js +48 -9
  39. package/lib/browser/open-with-service.js.map +1 -1
  40. package/lib/browser/opener-service.d.ts +8 -0
  41. package/lib/browser/opener-service.d.ts.map +1 -1
  42. package/lib/browser/opener-service.js +18 -3
  43. package/lib/browser/opener-service.js.map +1 -1
  44. package/lib/browser/progress-location-service.spec.js +7 -7
  45. package/lib/browser/saveable-service.d.ts.map +1 -1
  46. package/lib/browser/saveable-service.js +6 -2
  47. package/lib/browser/saveable-service.js.map +1 -1
  48. package/lib/browser/saveable.d.ts +17 -1
  49. package/lib/browser/saveable.d.ts.map +1 -1
  50. package/lib/browser/saveable.js +62 -1
  51. package/lib/browser/saveable.js.map +1 -1
  52. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.d.ts +5 -4
  53. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.d.ts.map +1 -1
  54. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.js +2 -1
  55. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.js.map +1 -1
  56. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.d.ts +6 -16
  57. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.d.ts.map +1 -1
  58. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.js +12 -29
  59. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.js.map +1 -1
  60. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.d.ts +43 -78
  61. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.d.ts.map +1 -1
  62. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.js +8 -39
  63. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.js.map +1 -1
  64. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.d.ts +10 -10
  65. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.d.ts.map +1 -1
  66. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.js +43 -32
  67. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.js.map +1 -1
  68. package/lib/browser/storage-service.js +3 -3
  69. package/lib/browser/tree/tree.spec.js +75 -75
  70. package/lib/browser/view-container.d.ts +2 -2
  71. package/lib/browser/view-container.d.ts.map +1 -1
  72. package/lib/browser/view-container.js.map +1 -1
  73. package/lib/browser/widget-open-handler.d.ts +4 -1
  74. package/lib/browser/widget-open-handler.d.ts.map +1 -1
  75. package/lib/browser/widget-open-handler.js.map +1 -1
  76. package/lib/browser/widgets/extractable-widget.js +1 -1
  77. package/lib/browser/widgets/extractable-widget.js.map +1 -1
  78. package/lib/browser/widgets/index.d.ts +1 -0
  79. package/lib/browser/widgets/index.d.ts.map +1 -1
  80. package/lib/browser/widgets/index.js +1 -0
  81. package/lib/browser/widgets/index.js.map +1 -1
  82. package/lib/browser/widgets/split-widget.d.ts +45 -0
  83. package/lib/browser/widgets/split-widget.d.ts.map +1 -0
  84. package/lib/browser/widgets/split-widget.js +126 -0
  85. package/lib/browser/widgets/split-widget.js.map +1 -0
  86. package/lib/common/event.d.ts +2 -0
  87. package/lib/common/event.d.ts.map +1 -1
  88. package/lib/common/event.js +4 -0
  89. package/lib/common/event.js.map +1 -1
  90. package/lib/common/glob.d.ts +4 -4
  91. package/lib/common/json-schema.d.ts +2 -0
  92. package/lib/common/json-schema.d.ts.map +1 -1
  93. package/lib/common/menu/menu-types.d.ts.map +1 -1
  94. package/lib/common/menu/menu-types.js.map +1 -1
  95. package/lib/electron-browser/electron-uri-handler.d.ts +6 -0
  96. package/lib/electron-browser/electron-uri-handler.d.ts.map +1 -0
  97. package/lib/electron-browser/electron-uri-handler.js +49 -0
  98. package/lib/electron-browser/electron-uri-handler.js.map +1 -0
  99. package/lib/electron-browser/menu/electron-main-menu-factory.d.ts +1 -1
  100. package/lib/electron-browser/menu/electron-main-menu-factory.d.ts.map +1 -1
  101. package/lib/electron-browser/menu/electron-main-menu-factory.js +6 -6
  102. package/lib/electron-browser/menu/electron-main-menu-factory.js.map +1 -1
  103. package/lib/electron-browser/preload.d.ts.map +1 -1
  104. package/lib/electron-browser/preload.js +12 -0
  105. package/lib/electron-browser/preload.js.map +1 -1
  106. package/lib/electron-browser/window/electron-window-module.d.ts.map +1 -1
  107. package/lib/electron-browser/window/electron-window-module.js +3 -0
  108. package/lib/electron-browser/window/electron-window-module.js.map +1 -1
  109. package/lib/electron-browser/window/external-app-open-handler.js +1 -1
  110. package/lib/electron-browser/window/external-app-open-handler.js.map +1 -1
  111. package/lib/electron-common/electron-api.d.ts +2 -0
  112. package/lib/electron-common/electron-api.d.ts.map +1 -1
  113. package/lib/electron-common/electron-api.js +2 -1
  114. package/lib/electron-common/electron-api.js.map +1 -1
  115. package/lib/electron-main/electron-api-main.d.ts +2 -0
  116. package/lib/electron-main/electron-api-main.d.ts.map +1 -1
  117. package/lib/electron-main/electron-api-main.js +27 -3
  118. package/lib/electron-main/electron-api-main.js.map +1 -1
  119. package/lib/electron-main/electron-main-application.d.ts +5 -3
  120. package/lib/electron-main/electron-main-application.d.ts.map +1 -1
  121. package/lib/electron-main/electron-main-application.js +57 -14
  122. package/lib/electron-main/electron-main-application.js.map +1 -1
  123. package/lib/electron-main/theia-electron-window.d.ts +1 -0
  124. package/lib/electron-main/theia-electron-window.d.ts.map +1 -1
  125. package/lib/electron-main/theia-electron-window.js +3 -0
  126. package/lib/electron-main/theia-electron-window.js.map +1 -1
  127. package/lib/node/i18n/theia-localization-contribution.d.ts.map +1 -1
  128. package/lib/node/i18n/theia-localization-contribution.js +12 -8
  129. package/lib/node/i18n/theia-localization-contribution.js.map +1 -1
  130. package/lib/node/process-utils.spec.js +8 -8
  131. package/package.json +10 -8
  132. package/shared/ajv/index.d.ts +2 -2
  133. package/shared/markdown-it.d.ts +2 -2
  134. package/shared/markdown-it.js +1 -1
  135. package/shared/reflect-metadata/index.d.ts +1 -1
  136. package/shared/reflect-metadata/index.js +1 -1
  137. package/shared/vscode-languageserver-types/index.d.ts +1 -1
  138. package/src/browser/about-dialog.tsx +137 -137
  139. package/src/browser/authentication-service.ts +467 -468
  140. package/src/browser/breadcrumbs/breadcrumb-popup-container.ts +101 -101
  141. package/src/browser/breadcrumbs/breadcrumb-renderer.tsx +41 -41
  142. package/src/browser/breadcrumbs/breadcrumbs-constants.ts +79 -79
  143. package/src/browser/breadcrumbs/breadcrumbs-renderer.tsx +185 -185
  144. package/src/browser/breadcrumbs/breadcrumbs-service.ts +108 -108
  145. package/src/browser/breadcrumbs/index.ts +21 -21
  146. package/src/browser/browser-clipboard-service.ts +122 -122
  147. package/src/browser/browser.ts +239 -239
  148. package/src/browser/clipboard-service.ts +23 -23
  149. package/src/browser/color-application-contribution.ts +110 -110
  150. package/src/browser/color-registry.ts +60 -60
  151. package/src/browser/command-open-handler.ts +54 -54
  152. package/src/browser/common-frontend-contribution.ts +2680 -2680
  153. package/src/browser/common-styling-participants.ts +361 -361
  154. package/src/browser/connection-status-service.spec.ts +200 -200
  155. package/src/browser/connection-status-service.ts +216 -216
  156. package/src/browser/context-key-service.ts +142 -142
  157. package/src/browser/context-menu-renderer.ts +124 -124
  158. package/src/browser/core-preferences.ts +343 -334
  159. package/src/browser/credentials-service.ts +106 -106
  160. package/src/browser/decoration-style.ts +65 -65
  161. package/src/browser/decorations-service.ts +209 -209
  162. package/src/browser/dialogs/react-dialog.tsx +56 -56
  163. package/src/browser/dialogs.ts +534 -534
  164. package/src/browser/diff-uris.ts +117 -117
  165. package/src/browser/encoding-registry.ts +97 -97
  166. package/src/browser/endpoint.spec.ts +148 -148
  167. package/src/browser/endpoint.ts +136 -136
  168. package/src/browser/external-uri-service.ts +79 -79
  169. package/src/browser/file-icons-js.d.ts +20 -20
  170. package/src/browser/frontend-application-bindings.ts +62 -62
  171. package/src/browser/frontend-application-config-provider.spec.ts +45 -45
  172. package/src/browser/frontend-application-config-provider.ts +50 -50
  173. package/src/browser/frontend-application-contribution.ts +110 -110
  174. package/src/browser/frontend-application-module.ts +474 -475
  175. package/src/browser/frontend-application-state.ts +74 -74
  176. package/src/browser/frontend-application.ts +326 -326
  177. package/src/browser/hover-service.ts +218 -218
  178. package/src/browser/http-open-handler.ts +49 -49
  179. package/src/browser/i18n/i18n-frontend-module.ts +27 -27
  180. package/src/browser/i18n/language-quick-pick-service.ts +130 -130
  181. package/src/browser/icon-registry.ts +87 -87
  182. package/src/browser/icon-theme-contribution.ts +64 -64
  183. package/src/browser/icon-theme-service.ts +217 -217
  184. package/src/browser/icons/CollapseAll.svg +7 -7
  185. package/src/browser/icons/CollapseAll_inverse.svg +7 -7
  186. package/src/browser/icons/Refresh.svg +7 -7
  187. package/src/browser/icons/Refresh_inverse.svg +7 -7
  188. package/src/browser/icons/add-inverse.svg +4 -4
  189. package/src/browser/icons/add.svg +4 -4
  190. package/src/browser/icons/arrow-down-bright.svg +6 -6
  191. package/src/browser/icons/arrow-down-dark.svg +6 -6
  192. package/src/browser/icons/arrow-up-bright.svg +6 -6
  193. package/src/browser/icons/arrow-up-dark.svg +6 -6
  194. package/src/browser/icons/case-sensitive-dark.svg +16 -16
  195. package/src/browser/icons/case-sensitive.svg +16 -16
  196. package/src/browser/icons/chevron-right-dark.svg +5 -5
  197. package/src/browser/icons/chevron-right-light.svg +6 -6
  198. package/src/browser/icons/circle-bright.svg +7 -7
  199. package/src/browser/icons/circle-dark.svg +7 -7
  200. package/src/browser/icons/clear-search-results-dark.svg +7 -7
  201. package/src/browser/icons/clear-search-results.svg +7 -7
  202. package/src/browser/icons/close-all-bright.svg +7 -7
  203. package/src/browser/icons/close-all-dark.svg +7 -7
  204. package/src/browser/icons/close-bright.svg +7 -7
  205. package/src/browser/icons/close-dark.svg +7 -7
  206. package/src/browser/icons/collapse.svg +4 -4
  207. package/src/browser/icons/edit-json-dark.svg +6 -6
  208. package/src/browser/icons/edit-json.svg +6 -6
  209. package/src/browser/icons/expand.svg +4 -4
  210. package/src/browser/icons/loading-dark.svg +6 -6
  211. package/src/browser/icons/loading-light.svg +6 -6
  212. package/src/browser/icons/open-change-bright.svg +3 -3
  213. package/src/browser/icons/open-change-dark.svg +4 -4
  214. package/src/browser/icons/open-file-bright.svg +4 -4
  215. package/src/browser/icons/open-file-dark.svg +4 -4
  216. package/src/browser/icons/preview-bright.svg +3 -3
  217. package/src/browser/icons/preview-dark.svg +3 -3
  218. package/src/browser/icons/regex-dark.svg +10 -10
  219. package/src/browser/icons/regex.svg +10 -10
  220. package/src/browser/icons/remove-all-inverse.svg +4 -4
  221. package/src/browser/icons/remove-all.svg +4 -4
  222. package/src/browser/icons/replace-all-inverse.svg +13 -13
  223. package/src/browser/icons/replace-all.svg +13 -13
  224. package/src/browser/icons/replace-inverse.svg +15 -15
  225. package/src/browser/icons/replace.svg +15 -15
  226. package/src/browser/icons/whole-word-dark.svg +19 -19
  227. package/src/browser/icons/whole-word.svg +19 -19
  228. package/src/browser/index.ts +50 -50
  229. package/src/browser/json-schema-store.ts +118 -127
  230. package/src/browser/keybinding.spec.ts +554 -554
  231. package/src/browser/keybinding.ts +759 -759
  232. package/src/browser/keyboard/browser-keyboard-frontend-contribution.ts +108 -108
  233. package/src/browser/keyboard/browser-keyboard-layout-provider.spec.ts +171 -171
  234. package/src/browser/keyboard/browser-keyboard-layout-provider.ts +469 -469
  235. package/src/browser/keyboard/browser-keyboard-module.ts +30 -30
  236. package/src/browser/keyboard/index.ts +20 -20
  237. package/src/browser/keyboard/keyboard-layout-service.spec.ts +121 -121
  238. package/src/browser/keyboard/keyboard-layout-service.ts +455 -455
  239. package/src/browser/keyboard/keys.spec.ts +258 -258
  240. package/src/browser/keyboard/keys.ts +20 -20
  241. package/src/browser/keys.ts +21 -21
  242. package/src/browser/label-parser.spec.ts +165 -165
  243. package/src/browser/label-parser.ts +108 -108
  244. package/src/browser/label-provider.spec.ts +62 -62
  245. package/src/browser/label-provider.ts +385 -385
  246. package/src/browser/language-icon-provider.ts +55 -55
  247. package/src/browser/language-service.ts +77 -77
  248. package/src/browser/logger-frontend-module.ts +65 -65
  249. package/src/browser/markdown-rendering/markdown-renderer.ts +98 -98
  250. package/src/browser/menu/browser-context-menu-renderer.ts +48 -48
  251. package/src/browser/menu/browser-menu-module.ts +28 -28
  252. package/src/browser/menu/browser-menu-plugin.ts +491 -491
  253. package/src/browser/menu/context-menu-context.ts +41 -41
  254. package/src/browser/messaging/connection-source.ts +26 -26
  255. package/src/browser/messaging/frontend-id-provider.ts +37 -37
  256. package/src/browser/messaging/index.ts +18 -18
  257. package/src/browser/messaging/messaging-frontend-module.ts +41 -41
  258. package/src/browser/messaging/service-connection-provider.ts +140 -140
  259. package/src/browser/messaging/ws-connection-provider.ts +49 -49
  260. package/src/browser/messaging/ws-connection-source.ts +230 -230
  261. package/src/browser/mime-service.ts +30 -30
  262. package/src/browser/navigatable-types.ts +81 -81
  263. package/src/browser/navigatable.ts +39 -39
  264. package/src/browser/open-with-service.ts +140 -93
  265. package/src/browser/opener-service.spec.ts +49 -49
  266. package/src/browser/opener-service.ts +169 -146
  267. package/src/browser/performance/frontend-stopwatch.ts +65 -65
  268. package/src/browser/performance/index.ts +18 -18
  269. package/src/browser/performance/measurement-frontend-bindings.ts +31 -31
  270. package/src/browser/preferences/index.ts +23 -23
  271. package/src/browser/preferences/injectable-preference-proxy.ts +283 -283
  272. package/src/browser/preferences/preference-configurations.ts +82 -82
  273. package/src/browser/preferences/preference-contribution.ts +436 -436
  274. package/src/browser/preferences/preference-language-override-service.ts +111 -111
  275. package/src/browser/preferences/preference-provider.spec.ts +36 -36
  276. package/src/browser/preferences/preference-provider.ts +277 -277
  277. package/src/browser/preferences/preference-proxy.spec.ts +367 -367
  278. package/src/browser/preferences/preference-proxy.ts +367 -367
  279. package/src/browser/preferences/preference-schema-provider.spec.ts +130 -130
  280. package/src/browser/preferences/preference-scope.ts +18 -18
  281. package/src/browser/preferences/preference-service.spec.ts +613 -613
  282. package/src/browser/preferences/preference-service.ts +594 -594
  283. package/src/browser/preferences/preference-validation-service.spec.ts +334 -334
  284. package/src/browser/preferences/preference-validation-service.ts +358 -358
  285. package/src/browser/preferences/test/index.ts +19 -19
  286. package/src/browser/preferences/test/mock-preference-provider.ts +50 -50
  287. package/src/browser/preferences/test/mock-preference-proxy.ts +48 -48
  288. package/src/browser/preferences/test/mock-preference-service.ts +63 -63
  289. package/src/browser/preload/i18n-preload-contribution.ts +50 -50
  290. package/src/browser/preload/os-preload-contribution.ts +37 -37
  291. package/src/browser/preload/preload-module.ts +45 -45
  292. package/src/browser/preload/preloader.ts +37 -37
  293. package/src/browser/preload/theme-preload-contribution.ts +31 -31
  294. package/src/browser/progress-bar-factory.ts +29 -29
  295. package/src/browser/progress-bar.ts +76 -76
  296. package/src/browser/progress-client.ts +53 -53
  297. package/src/browser/progress-location-service.spec.ts +50 -50
  298. package/src/browser/progress-location-service.ts +96 -96
  299. package/src/browser/progress-status-bar-item.ts +83 -83
  300. package/src/browser/quick-input/index.ts +23 -23
  301. package/src/browser/quick-input/quick-access.ts +75 -75
  302. package/src/browser/quick-input/quick-command-frontend-contribution.ts +89 -89
  303. package/src/browser/quick-input/quick-command-service.ts +246 -246
  304. package/src/browser/quick-input/quick-help-service.ts +87 -87
  305. package/src/browser/quick-input/quick-input-frontend-contribution.ts +33 -33
  306. package/src/browser/quick-input/quick-input-service.spec.ts +176 -176
  307. package/src/browser/quick-input/quick-input-service.ts +17 -17
  308. package/src/browser/quick-input/quick-pick-service-impl.ts +69 -69
  309. package/src/browser/quick-input/quick-view-service.ts +83 -83
  310. package/src/browser/request/browser-request-module.ts +23 -23
  311. package/src/browser/request/browser-request-service.ts +172 -172
  312. package/src/browser/resource-context-key.ts +77 -77
  313. package/src/browser/saveable-service.ts +332 -328
  314. package/src/browser/saveable.ts +395 -327
  315. package/src/browser/secondary-window-handler.ts +211 -211
  316. package/src/browser/shell/additional-views-menu-widget.tsx +71 -71
  317. package/src/browser/shell/application-shell-mouse-tracker.ts +103 -103
  318. package/src/browser/shell/application-shell.ts +2271 -2271
  319. package/src/browser/shell/current-widget-command-adapter.ts +57 -57
  320. package/src/browser/shell/index.ts +23 -23
  321. package/src/browser/shell/shell-layout-restorer.ts +399 -399
  322. package/src/browser/shell/side-panel-handler.ts +794 -794
  323. package/src/browser/shell/side-panel-toolbar.ts +111 -111
  324. package/src/browser/shell/sidebar-bottom-menu-widget.tsx +39 -39
  325. package/src/browser/shell/sidebar-menu-widget.tsx +183 -183
  326. package/src/browser/shell/sidebar-top-menu-widget.tsx +26 -26
  327. package/src/browser/shell/split-panels.ts +191 -191
  328. package/src/browser/shell/tab-bar-decorator.ts +106 -106
  329. package/src/browser/shell/tab-bar-toolbar/index.ts +19 -19
  330. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.ts +31 -31
  331. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.ts +242 -256
  332. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.ts +149 -207
  333. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar.spec.ts +62 -62
  334. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar.tsx +443 -428
  335. package/src/browser/shell/tab-bars.spec.ts +63 -63
  336. package/src/browser/shell/tab-bars.ts +1468 -1468
  337. package/src/browser/shell/theia-dock-panel.ts +265 -265
  338. package/src/browser/shell/view-column-service.ts +125 -125
  339. package/src/browser/shell/view-contribution.ts +178 -178
  340. package/src/browser/source-tree/index.ts +19 -19
  341. package/src/browser/source-tree/source-tree-widget.tsx +107 -107
  342. package/src/browser/source-tree/source-tree.ts +146 -146
  343. package/src/browser/source-tree/tree-source.ts +73 -73
  344. package/src/browser/status-bar/index.ts +29 -29
  345. package/src/browser/status-bar/status-bar-types.ts +97 -97
  346. package/src/browser/status-bar/status-bar-view-model.ts +209 -209
  347. package/src/browser/status-bar/status-bar.tsx +189 -189
  348. package/src/browser/storage-service.spec.ts +76 -76
  349. package/src/browser/storage-service.ts +129 -129
  350. package/src/browser/style/about.css +36 -36
  351. package/src/browser/style/alert-messages.css +62 -62
  352. package/src/browser/style/ansi.css +88 -88
  353. package/src/browser/style/breadcrumbs.css +130 -130
  354. package/src/browser/style/dialog.css +126 -126
  355. package/src/browser/style/dockpanel.css +76 -76
  356. package/src/browser/style/hover-service.css +101 -101
  357. package/src/browser/style/icons.css +61 -61
  358. package/src/browser/style/index.css +353 -352
  359. package/src/browser/style/materialcolors.css +278 -278
  360. package/src/browser/style/menus.css +230 -230
  361. package/src/browser/style/notification.css +39 -39
  362. package/src/browser/style/os.css +87 -87
  363. package/src/browser/style/progress-bar.css +43 -43
  364. package/src/browser/style/quick-title-bar.css +45 -45
  365. package/src/browser/style/scrollbars.css +172 -172
  366. package/src/browser/style/search-box.css +123 -123
  367. package/src/browser/style/select-component.css +107 -107
  368. package/src/browser/style/sidepanel.css +367 -367
  369. package/src/browser/style/split-widget.css +38 -0
  370. package/src/browser/style/status-bar.css +127 -127
  371. package/src/browser/style/tabs.css +647 -658
  372. package/src/browser/style/tooltip.css +28 -28
  373. package/src/browser/style/tree-decorators.css +81 -81
  374. package/src/browser/style/tree.css +232 -232
  375. package/src/browser/style/view-container.css +187 -194
  376. package/src/browser/style/widget.css +19 -19
  377. package/src/browser/styling-service.ts +96 -96
  378. package/src/browser/supported-encodings.ts +262 -262
  379. package/src/browser/test/jsdom.ts +69 -69
  380. package/src/browser/test/mock-connection-status-service.ts +33 -33
  381. package/src/browser/test/mock-env-variables-server.ts +47 -47
  382. package/src/browser/test/mock-opener-service.ts +34 -34
  383. package/src/browser/test/mock-storage-service.ts +49 -49
  384. package/src/browser/theming.ts +206 -206
  385. package/src/browser/tooltip-service.tsx +96 -96
  386. package/src/browser/tree/fuzzy-search.spec.ts +99 -99
  387. package/src/browser/tree/fuzzy-search.ts +136 -136
  388. package/src/browser/tree/index.ts +29 -29
  389. package/src/browser/tree/search-box-debounce.ts +96 -96
  390. package/src/browser/tree/search-box.ts +355 -355
  391. package/src/browser/tree/test/mock-selectable-tree-model.ts +109 -109
  392. package/src/browser/tree/test/mock-tree-model.ts +136 -136
  393. package/src/browser/tree/test/tree-test-container.ts +50 -50
  394. package/src/browser/tree/tree-compression/compressed-tree-expansion-service.ts +46 -46
  395. package/src/browser/tree/tree-compression/compressed-tree-model.ts +88 -88
  396. package/src/browser/tree/tree-compression/compressed-tree-widget.tsx +203 -203
  397. package/src/browser/tree/tree-compression/index.ts +20 -20
  398. package/src/browser/tree/tree-compression/tree-compression-service.ts +125 -125
  399. package/src/browser/tree/tree-compression/tree-compression.css +28 -28
  400. package/src/browser/tree/tree-consistency.spec.ts +105 -105
  401. package/src/browser/tree/tree-container.spec.ts +45 -45
  402. package/src/browser/tree/tree-container.ts +155 -155
  403. package/src/browser/tree/tree-decorator.spec.ts +162 -162
  404. package/src/browser/tree/tree-decorator.ts +238 -238
  405. package/src/browser/tree/tree-expansion.spec.ts +173 -173
  406. package/src/browser/tree/tree-expansion.ts +165 -165
  407. package/src/browser/tree/tree-focus-service.ts +55 -55
  408. package/src/browser/tree/tree-iterator.spec.ts +170 -170
  409. package/src/browser/tree/tree-iterator.ts +256 -256
  410. package/src/browser/tree/tree-label-provider.ts +40 -40
  411. package/src/browser/tree/tree-model.ts +562 -562
  412. package/src/browser/tree/tree-navigation.ts +58 -58
  413. package/src/browser/tree/tree-preference.ts +50 -50
  414. package/src/browser/tree/tree-search.ts +128 -128
  415. package/src/browser/tree/tree-selectable.spec.ts +152 -152
  416. package/src/browser/tree/tree-selection-impl.ts +176 -176
  417. package/src/browser/tree/tree-selection-state.spec.ts +462 -462
  418. package/src/browser/tree/tree-selection-state.ts +245 -245
  419. package/src/browser/tree/tree-selection.ts +159 -159
  420. package/src/browser/tree/tree-view-welcome-widget.tsx +263 -263
  421. package/src/browser/tree/tree-widget-selection.ts +45 -45
  422. package/src/browser/tree/tree-widget.tsx +1591 -1591
  423. package/src/browser/tree/tree.spec.ts +241 -241
  424. package/src/browser/tree/tree.ts +425 -425
  425. package/src/browser/undo-redo-handler.ts +85 -85
  426. package/src/browser/user-working-directory-provider.ts +77 -77
  427. package/src/browser/view-container.ts +1640 -1640
  428. package/src/browser/widget-decoration.ts +358 -358
  429. package/src/browser/widget-manager.spec.ts +102 -102
  430. package/src/browser/widget-manager.ts +318 -318
  431. package/src/browser/widget-open-handler.ts +168 -165
  432. package/src/browser/widgets/alert-message.tsx +56 -56
  433. package/src/browser/widgets/enhanced-preview-widget.ts +27 -27
  434. package/src/browser/widgets/extractable-widget.ts +33 -33
  435. package/src/browser/widgets/index.ts +21 -20
  436. package/src/browser/widgets/previewable-widget.ts +31 -31
  437. package/src/browser/widgets/react-renderer.tsx +53 -53
  438. package/src/browser/widgets/react-widget.tsx +51 -51
  439. package/src/browser/widgets/select-component.tsx +367 -367
  440. package/src/browser/widgets/split-widget.ts +163 -0
  441. package/src/browser/widgets/widget.ts +406 -406
  442. package/src/browser/window/browser-window-module.ts +32 -32
  443. package/src/browser/window/default-secondary-window-service.ts +189 -189
  444. package/src/browser/window/default-window-service.spec.ts +78 -78
  445. package/src/browser/window/default-window-service.ts +171 -171
  446. package/src/browser/window/secondary-window-service.ts +39 -39
  447. package/src/browser/window/test/mock-window-service.ts +29 -29
  448. package/src/browser/window/window-service.ts +78 -78
  449. package/src/browser/window/window-title-service.ts +107 -107
  450. package/src/browser/window/window-title-updater.ts +95 -95
  451. package/src/browser/window-contribution.ts +64 -64
  452. package/src/browser-only/frontend-only-application-module.ts +116 -116
  453. package/src/browser-only/i18n/i18n-frontend-only-module.ts +37 -37
  454. package/src/browser-only/logger-frontend-only-module.ts +63 -63
  455. package/src/browser-only/messaging/frontend-only-service-connection-provider.ts +39 -39
  456. package/src/browser-only/messaging/messaging-frontend-only-module.ts +42 -42
  457. package/src/browser-only/preload/frontend-only-preload-module.ts +49 -49
  458. package/src/common/accessibility.ts +33 -33
  459. package/src/common/application-error.spec.ts +27 -27
  460. package/src/common/application-error.ts +76 -76
  461. package/src/common/application-protocol.ts +42 -42
  462. package/src/common/array-utils.ts +129 -129
  463. package/src/common/buffer.ts +228 -228
  464. package/src/common/cancellation.ts +163 -163
  465. package/src/common/char-code.ts +438 -438
  466. package/src/common/collections.ts +125 -125
  467. package/src/common/color.ts +103 -103
  468. package/src/common/command.spec.ts +208 -208
  469. package/src/common/command.ts +489 -489
  470. package/src/common/contribution-filter/contribution-filter-registry.ts +79 -79
  471. package/src/common/contribution-filter/contribution-filter.ts +64 -64
  472. package/src/common/contribution-filter/filter.ts +23 -23
  473. package/src/common/contribution-filter/index.ts +19 -19
  474. package/src/common/contribution-provider.ts +96 -96
  475. package/src/common/disposable.spec.ts +94 -94
  476. package/src/common/disposable.ts +188 -188
  477. package/src/common/encoding-service.ts +380 -380
  478. package/src/common/encodings.ts +24 -24
  479. package/src/common/env-variables/env-variables-protocol.ts +38 -38
  480. package/src/common/env-variables/index.ts +17 -17
  481. package/src/common/event.spec.ts +32 -32
  482. package/src/common/event.ts +493 -487
  483. package/src/common/file-uri.ts +61 -61
  484. package/src/common/frontend-application-state.ts +38 -38
  485. package/src/common/glob.ts +741 -741
  486. package/src/common/hash.ts +85 -85
  487. package/src/common/i18n/localization-server.ts +25 -25
  488. package/src/common/i18n/localization.ts +80 -80
  489. package/src/common/i18n/nls.metadata.json +34112 -34112
  490. package/src/common/index.ts +51 -51
  491. package/src/common/json-schema.ts +108 -106
  492. package/src/common/key-store.ts +26 -26
  493. package/src/common/keybinding.ts +152 -152
  494. package/src/common/keyboard/keyboard-layout-provider.ts +51 -51
  495. package/src/common/keys.ts +694 -694
  496. package/src/common/label-protocol.ts +35 -35
  497. package/src/common/logger-protocol.ts +119 -119
  498. package/src/common/logger-watcher.ts +48 -48
  499. package/src/common/logger.spec.ts +46 -46
  500. package/src/common/logger.ts +389 -389
  501. package/src/common/lsp-types.ts +34 -34
  502. package/src/common/markdown-rendering/icon-utilities.ts +30 -30
  503. package/src/common/markdown-rendering/index.ts +18 -18
  504. package/src/common/markdown-rendering/markdown-string.ts +152 -152
  505. package/src/common/menu/action-menu-node.ts +65 -65
  506. package/src/common/menu/composite-menu-node.spec.ts +67 -67
  507. package/src/common/menu/composite-menu-node.ts +114 -114
  508. package/src/common/menu/index.ts +21 -21
  509. package/src/common/menu/menu-adapter.ts +103 -103
  510. package/src/common/menu/menu-model-registry.ts +374 -374
  511. package/src/common/menu/menu-types.ts +220 -219
  512. package/src/common/menu/menu.spec.ts +101 -101
  513. package/src/common/message-rpc/channel.spec.ts +88 -88
  514. package/src/common/message-rpc/channel.ts +300 -300
  515. package/src/common/message-rpc/index.ts +22 -22
  516. package/src/common/message-rpc/message-buffer.ts +105 -105
  517. package/src/common/message-rpc/msg-pack-extension-manager.ts +70 -70
  518. package/src/common/message-rpc/rpc-message-encoder.spec.ts +65 -65
  519. package/src/common/message-rpc/rpc-message-encoder.ts +190 -190
  520. package/src/common/message-rpc/rpc-protocol.ts +255 -255
  521. package/src/common/message-rpc/uint8-array-message-buffer.spec.ts +41 -41
  522. package/src/common/message-rpc/uint8-array-message-buffer.ts +213 -213
  523. package/src/common/message-service-protocol.ts +148 -148
  524. package/src/common/message-service.ts +226 -226
  525. package/src/common/messaging/connection-error-handler.ts +73 -73
  526. package/src/common/messaging/connection-management.ts +43 -43
  527. package/src/common/messaging/handler.ts +26 -26
  528. package/src/common/messaging/index.ts +19 -19
  529. package/src/common/messaging/proxy-factory.spec.ts +108 -108
  530. package/src/common/messaging/proxy-factory.ts +336 -336
  531. package/src/common/messaging/socket-write-buffer.ts +52 -52
  532. package/src/common/messaging/web-socket-channel.ts +76 -76
  533. package/src/common/nls.ts +151 -151
  534. package/src/common/numbers.ts +21 -21
  535. package/src/common/objects.spec.ts +112 -112
  536. package/src/common/objects.ts +123 -123
  537. package/src/common/os.ts +82 -82
  538. package/src/common/path.spec.ts +415 -415
  539. package/src/common/path.ts +334 -334
  540. package/src/common/paths.ts +250 -250
  541. package/src/common/performance/index.ts +19 -19
  542. package/src/common/performance/measurement-protocol.ts +104 -104
  543. package/src/common/performance/measurement.ts +130 -130
  544. package/src/common/performance/stopwatch.ts +183 -183
  545. package/src/common/preferences/preference-schema.ts +101 -101
  546. package/src/common/preferences/preference-scope.spec.ts +48 -48
  547. package/src/common/preferences/preference-scope.ts +68 -68
  548. package/src/common/prioritizeable.ts +58 -58
  549. package/src/common/progress-service-protocol.ts +35 -35
  550. package/src/common/progress-service.ts +82 -82
  551. package/src/common/promise-util.spec.ts +102 -102
  552. package/src/common/promise-util.ts +143 -143
  553. package/src/common/quick-pick-service.ts +353 -353
  554. package/src/common/reference.spec.ts +145 -145
  555. package/src/common/reference.ts +230 -230
  556. package/src/common/resource.ts +430 -430
  557. package/src/common/selection-command-handler.ts +101 -101
  558. package/src/common/selection-service.spec.ts +43 -43
  559. package/src/common/selection-service.ts +49 -49
  560. package/src/common/selection.ts +50 -50
  561. package/src/common/severity.ts +111 -111
  562. package/src/common/stream.ts +718 -718
  563. package/src/common/strings.ts +231 -231
  564. package/src/common/telemetry.ts +45 -45
  565. package/src/common/ternary-search-tree.ts +417 -417
  566. package/src/common/test/expect.ts +34 -34
  567. package/src/common/test/mock-logger.ts +118 -118
  568. package/src/common/test/mock-menu.ts +35 -35
  569. package/src/common/test/mock-resource-provider.ts +33 -33
  570. package/src/common/theme.ts +68 -68
  571. package/src/common/types.spec.ts +86 -86
  572. package/src/common/types.ts +140 -140
  573. package/src/common/uri-command-handler.spec.ts +90 -90
  574. package/src/common/uri-command-handler.ts +148 -148
  575. package/src/common/uri.spec.ts +278 -278
  576. package/src/common/uri.ts +279 -279
  577. package/src/common/uuid.ts +45 -45
  578. package/src/common/version.ts +17 -17
  579. package/src/common/view-column.ts +33 -33
  580. package/src/common/window.ts +34 -34
  581. package/src/electron-browser/electron-clipboard-service.ts +32 -32
  582. package/src/electron-browser/electron-uri-handler.ts +42 -0
  583. package/src/electron-browser/keyboard/electron-keyboard-layout-change-notifier.ts +39 -39
  584. package/src/electron-browser/keyboard/electron-keyboard-module.ts +28 -28
  585. package/src/electron-browser/menu/electron-context-menu-renderer.ts +122 -122
  586. package/src/electron-browser/menu/electron-main-menu-factory.ts +339 -338
  587. package/src/electron-browser/menu/electron-menu-contribution.ts +506 -506
  588. package/src/electron-browser/menu/electron-menu-module.ts +40 -40
  589. package/src/electron-browser/menu/electron-menu-style.css +110 -110
  590. package/src/electron-browser/messaging/electron-frontend-id-provider.ts +25 -25
  591. package/src/electron-browser/messaging/electron-ipc-connection-source.ts +65 -65
  592. package/src/electron-browser/messaging/electron-local-ws-connection-source.ts +45 -45
  593. package/src/electron-browser/messaging/electron-messaging-frontend-module.ts +78 -78
  594. package/src/electron-browser/messaging/electron-ws-connection-source.ts +38 -38
  595. package/src/electron-browser/preload.ts +264 -249
  596. package/src/electron-browser/request/electron-browser-request-module.ts +26 -26
  597. package/src/electron-browser/token/electron-token-frontend-module.ts +22 -22
  598. package/src/electron-browser/window/electron-frontend-application-state.ts +26 -26
  599. package/src/electron-browser/window/electron-secondary-window-service.ts +35 -35
  600. package/src/electron-browser/window/electron-window-module.ts +48 -45
  601. package/src/electron-browser/window/electron-window-preferences.ts +76 -76
  602. package/src/electron-browser/window/electron-window-service.ts +109 -109
  603. package/src/electron-browser/window/external-app-open-handler.ts +42 -42
  604. package/src/electron-common/electron-api.ts +157 -154
  605. package/src/electron-common/electron-main-window-service.ts +24 -24
  606. package/src/electron-common/electron-token.ts +27 -27
  607. package/src/electron-main/electron-api-main.ts +373 -347
  608. package/src/electron-main/electron-main-application-module.ts +65 -65
  609. package/src/electron-main/electron-main-application.ts +860 -818
  610. package/src/electron-main/electron-main-constants.ts +23 -23
  611. package/src/electron-main/electron-main-window-service-impl.ts +44 -44
  612. package/src/electron-main/electron-security-token-service.ts +36 -36
  613. package/src/electron-main/event-utils.ts +36 -36
  614. package/src/electron-main/messaging/electron-connection-handler.ts +21 -21
  615. package/src/electron-main/messaging/electron-messaging-contribution.ts +143 -143
  616. package/src/electron-main/messaging/electron-messaging-service.ts +35 -35
  617. package/src/electron-main/theia-electron-window.ts +219 -214
  618. package/src/electron-node/cli/electron-backend-cli-module.ts +24 -24
  619. package/src/electron-node/cli/electron-cli-contribution.ts +35 -35
  620. package/src/electron-node/hosting/electron-backend-hosting-module.ts +24 -24
  621. package/src/electron-node/hosting/electron-ws-origin-validator.ts +37 -37
  622. package/src/electron-node/keyboard/electron-backend-keyboard-module.ts +30 -30
  623. package/src/electron-node/keyboard/electron-keyboard-layout-provider.ts +35 -35
  624. package/src/electron-node/request/electron-backend-request-module.ts +23 -23
  625. package/src/electron-node/request/electron-backend-request-service.ts +78 -78
  626. package/src/electron-node/token/electron-token-backend-contribution.ts +48 -48
  627. package/src/electron-node/token/electron-token-backend-module.ts +28 -28
  628. package/src/electron-node/token/electron-token-validator.ts +93 -93
  629. package/src/node/application-server.ts +59 -59
  630. package/src/node/backend-application-config-provider.spec.ts +29 -29
  631. package/src/node/backend-application-config-provider.ts +48 -48
  632. package/src/node/backend-application-module.ts +139 -139
  633. package/src/node/backend-application.ts +374 -374
  634. package/src/node/cli.spec.ts +94 -94
  635. package/src/node/cli.ts +63 -63
  636. package/src/node/console-logger-server.spec.ts +59 -59
  637. package/src/node/console-logger-server.ts +76 -76
  638. package/src/node/debug.ts +30 -30
  639. package/src/node/dynamic-require.ts +56 -56
  640. package/src/node/env-variables/env-variables-server.ts +123 -123
  641. package/src/node/env-variables/index.ts +17 -17
  642. package/src/node/environment-utils.spec.ts +92 -92
  643. package/src/node/environment-utils.ts +66 -66
  644. package/src/node/file-uri.spec.ts +76 -76
  645. package/src/node/filesystem-locking.ts +77 -77
  646. package/src/node/hosting/backend-application-hosts.ts +60 -60
  647. package/src/node/hosting/backend-hosting-module.ts +26 -26
  648. package/src/node/hosting/ws-origin-validator.ts +36 -36
  649. package/src/node/i18n/i18n-backend-module.ts +42 -42
  650. package/src/node/i18n/localization-contribution.ts +112 -112
  651. package/src/node/i18n/localization-provider.ts +125 -125
  652. package/src/node/i18n/localization-server.ts +52 -52
  653. package/src/node/i18n/theia-localization-contribution.ts +40 -36
  654. package/src/node/index.ts +22 -22
  655. package/src/node/key-store-server.ts +162 -162
  656. package/src/node/logger-backend-module.ts +88 -88
  657. package/src/node/logger-cli-contribution.spec.ts +245 -245
  658. package/src/node/logger-cli-contribution.ts +168 -168
  659. package/src/node/main.ts +33 -33
  660. package/src/node/messaging/binary-message-pipe.ts +168 -168
  661. package/src/node/messaging/connection-container-module.ts +96 -96
  662. package/src/node/messaging/default-messaging-service.ts +129 -129
  663. package/src/node/messaging/frontend-connection-service.ts +24 -24
  664. package/src/node/messaging/index.ts +19 -19
  665. package/src/node/messaging/ipc-bootstrap.ts +27 -27
  666. package/src/node/messaging/ipc-channel.ts +77 -77
  667. package/src/node/messaging/ipc-connection-provider.ts +107 -107
  668. package/src/node/messaging/ipc-protocol.ts +76 -76
  669. package/src/node/messaging/messaging-backend-module.ts +52 -52
  670. package/src/node/messaging/messaging-listeners.ts +52 -52
  671. package/src/node/messaging/messaging-service.ts +46 -46
  672. package/src/node/messaging/test/test-web-socket-channel.ts +61 -61
  673. package/src/node/messaging/websocket-endpoint.ts +79 -79
  674. package/src/node/messaging/websocket-frontend-connection-service.ts +186 -186
  675. package/src/node/os-backend-provider.ts +25 -25
  676. package/src/node/performance/index.ts +18 -18
  677. package/src/node/performance/measurement-backend-bindings.ts +35 -35
  678. package/src/node/performance/node-stopwatch.ts +40 -40
  679. package/src/node/process-utils.spec.ts +48 -48
  680. package/src/node/process-utils.ts +102 -102
  681. package/src/node/remote/backend-remote-service.ts +25 -25
  682. package/src/node/remote/remote-cli-contribution.ts +34 -34
  683. package/src/node/remote/remote-copy-contribution.ts +45 -45
  684. package/src/node/request/backend-request-facade.ts +39 -39
  685. package/src/node/request/backend-request-module.ts +25 -25
  686. package/src/node/request/proxy-cli-contribution.ts +65 -65
  687. package/src/node/ws-request-validators.ts +56 -56
  688. package/src/typings/native-keymap.d.ts +108 -108
  689. package/i18n/nls.pt-pt.json +0 -552
@@ -1,818 +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
- protected 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
- protected 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 restarting = false;
187
-
188
- /** Used to temporarily store the reference to an early created main window */
189
- protected initialWindow?: BrowserWindow;
190
-
191
- get config(): FrontendApplicationConfig {
192
- if (!this._config) {
193
- throw new Error('You have to start the application first.');
194
- }
195
- return this._config;
196
- }
197
-
198
- protected makePortable(): boolean {
199
- const dataFolderPath = path.join(app.getAppPath(), 'data');
200
- const appDataPath = path.join(dataFolderPath, 'app-data');
201
- if (existsSync(dataFolderPath)) {
202
- if (!existsSync(appDataPath)) {
203
- mkdirSync(appDataPath);
204
- }
205
- app.setPath('userData', appDataPath);
206
- return true;
207
- } else {
208
- return false;
209
- }
210
- }
211
-
212
- async start(config: FrontendApplicationConfig): Promise<void> {
213
- const argv = this.processArgv.getProcessArgvWithoutBin(process.argv);
214
- createYargs(argv, process.cwd())
215
- .help(false)
216
- .command('$0 [file]', false,
217
- cmd => cmd
218
- .option('electronUserData', {
219
- type: 'string',
220
- describe: 'The area where the electron main process puts its data'
221
- })
222
- .positional('file', { type: 'string' }),
223
- async args => {
224
- if (args.electronUserData) {
225
- console.info(`using electron user data area : '${args.electronUserData}'`);
226
- await fs.mkdir(args.electronUserData, { recursive: true });
227
- app.setPath('userData', args.electronUserData);
228
- }
229
- this.useNativeWindowFrame = this.getTitleBarStyle(config) === 'native';
230
- this._config = config;
231
- this.hookApplicationEvents();
232
- this.showInitialWindow();
233
- const port = await this.startBackend();
234
- this._backendPort.resolve(port);
235
- await app.whenReady();
236
- await this.attachElectronSecurityToken(port);
237
- await this.startContributions();
238
-
239
- this.handleMainCommand({
240
- file: args.file,
241
- cwd: process.cwd(),
242
- secondInstance: false
243
- });
244
- },
245
- ).parse();
246
- }
247
-
248
- protected getTitleBarStyle(config: FrontendApplicationConfig): 'native' | 'custom' {
249
- if ('THEIA_ELECTRON_DISABLE_NATIVE_ELEMENTS' in process.env && process.env.THEIA_ELECTRON_DISABLE_NATIVE_ELEMENTS === '1') {
250
- return 'custom';
251
- }
252
- if (isOSX) {
253
- return 'native';
254
- }
255
- const storedFrame = this.electronStore.get('windowstate')?.frame;
256
- if (storedFrame !== undefined) {
257
- return !!storedFrame ? 'native' : 'custom';
258
- }
259
- if (config.preferences && config.preferences['window.titleBarStyle']) {
260
- const titleBarStyle = config.preferences['window.titleBarStyle'];
261
- if (titleBarStyle === 'native' || titleBarStyle === 'custom') {
262
- return titleBarStyle;
263
- }
264
- }
265
- return isWindows ? 'custom' : 'native';
266
- }
267
-
268
- public setTitleBarStyle(webContents: WebContents, style: string): void {
269
- this.useNativeWindowFrame = isOSX || style === 'native';
270
- this.saveState(webContents);
271
- }
272
-
273
- setBackgroundColor(webContents: WebContents, backgroundColor: string): void {
274
- this.customBackgroundColor = backgroundColor;
275
- this.saveState(webContents);
276
- }
277
-
278
- protected saveState(webContents: Electron.WebContents): void {
279
- const browserWindow = BrowserWindow.fromWebContents(webContents);
280
- if (browserWindow) {
281
- this.saveWindowState(browserWindow);
282
- } else {
283
- console.warn(`no BrowserWindow with id: ${webContents.id}`);
284
- }
285
- }
286
-
287
- /**
288
- * @param id the id of the WebContents of the BrowserWindow in question
289
- * @returns 'native' or 'custom'
290
- */
291
- getTitleBarStyleAtStartup(webContents: WebContents): 'native' | 'custom' {
292
- return this.didUseNativeWindowFrameOnStart.get(webContents.id) ? 'native' : 'custom';
293
- }
294
-
295
- protected async determineSplashScreenBounds(initialWindowBounds: { x: number, y: number, width: number, height: number }):
296
- Promise<{ x: number, y: number, width: number, height: number }> {
297
- const splashScreenOptions = this.getSplashScreenOptions();
298
- const width = splashScreenOptions?.width ?? 640;
299
- const height = splashScreenOptions?.height ?? 480;
300
-
301
- // determine the screen on which to show the splash screen via the center of the window to show
302
- const windowCenterPoint = { x: initialWindowBounds.x + (initialWindowBounds.width / 2), y: initialWindowBounds.y + (initialWindowBounds.height / 2) };
303
- const { bounds } = screen.getDisplayNearestPoint(windowCenterPoint);
304
-
305
- // place splash screen center of screen
306
- const screenCenterPoint = { x: bounds.x + (bounds.width / 2), y: bounds.y + (bounds.height / 2) };
307
- const x = screenCenterPoint.x - (width / 2);
308
- const y = screenCenterPoint.y - (height / 2);
309
-
310
- return {
311
- x, y, width, height
312
- };
313
- }
314
-
315
- protected isShowWindowEarly(): boolean {
316
- return !!this.config.electron.showWindowEarly &&
317
- !('THEIA_ELECTRON_NO_EARLY_WINDOW' in process.env && process.env.THEIA_ELECTRON_NO_EARLY_WINDOW === '1');
318
- }
319
-
320
- protected showInitialWindow(): void {
321
- if (this.isShowWindowEarly() || this.isShowSplashScreen()) {
322
- app.whenReady().then(async () => {
323
- const options = await this.getLastWindowOptions();
324
- // If we want to show a splash screen, don't auto open the main window
325
- if (this.isShowSplashScreen()) {
326
- options.preventAutomaticShow = true;
327
- }
328
- this.initialWindow = await this.createWindow({ ...options });
329
-
330
- if (this.isShowSplashScreen()) {
331
- console.log('Showing splash screen');
332
- this.configureAndShowSplashScreen(this.initialWindow);
333
- }
334
-
335
- // Show main window early if windows shall be shown early and splash screen is not configured
336
- if (this.isShowWindowEarly() && !this.isShowSplashScreen()) {
337
- console.log('Showing main window early');
338
- this.initialWindow.show();
339
- }
340
- });
341
- }
342
- }
343
-
344
- protected async configureAndShowSplashScreen(mainWindow: BrowserWindow): Promise<BrowserWindow> {
345
- const splashScreenOptions = this.getSplashScreenOptions()!;
346
- console.debug('SplashScreen options', splashScreenOptions);
347
-
348
- const splashScreenBounds = await this.determineSplashScreenBounds(mainWindow.getBounds());
349
- const splashScreenWindow = new BrowserWindow({
350
- ...splashScreenBounds,
351
- frame: false,
352
- alwaysOnTop: true,
353
- show: false,
354
- transparent: true,
355
- webPreferences: {
356
- backgroundThrottling: false
357
- }
358
- });
359
-
360
- if (this.isShowWindowEarly()) {
361
- console.log('Showing splash screen early');
362
- splashScreenWindow.show();
363
- } else {
364
- splashScreenWindow.on('ready-to-show', () => {
365
- splashScreenWindow.show();
366
- });
367
- }
368
-
369
- splashScreenWindow.loadFile(path.resolve(this.globals.THEIA_APP_PROJECT_PATH, splashScreenOptions.content!).toString());
370
-
371
- // close splash screen and show main window once frontend is ready or a timeout is hit
372
- const cancelTokenSource = new CancellationTokenSource();
373
- const minTime = timeout(splashScreenOptions.minDuration ?? 0, cancelTokenSource.token);
374
- const maxTime = timeout(splashScreenOptions.maxDuration ?? 30000, cancelTokenSource.token);
375
-
376
- const showWindowAndCloseSplashScreen = () => {
377
- cancelTokenSource.cancel();
378
- if (!mainWindow.isVisible()) {
379
- mainWindow.show();
380
- }
381
- splashScreenWindow.close();
382
- };
383
- TheiaRendererAPI.onApplicationStateChanged(mainWindow.webContents, state => {
384
- if (state === 'ready') {
385
- minTime.then(() => showWindowAndCloseSplashScreen());
386
- }
387
- });
388
- maxTime.then(() => showWindowAndCloseSplashScreen());
389
- return splashScreenWindow;
390
- }
391
-
392
- protected isShowSplashScreen(): boolean {
393
- return typeof this.config.electron.splashScreenOptions === 'object' && !!this.config.electron.splashScreenOptions.content;
394
- }
395
-
396
- protected getSplashScreenOptions(): ElectronFrontendApplicationConfig.SplashScreenOptions | undefined {
397
- if (this.isShowSplashScreen()) {
398
- return this.config.electron.splashScreenOptions;
399
- }
400
- return undefined;
401
- }
402
-
403
- /**
404
- * Use this rather than creating `BrowserWindow` instances from scratch, since some security parameters need to be set, this method will do it.
405
- *
406
- * @param options
407
- */
408
- async createWindow(asyncOptions: MaybePromise<TheiaBrowserWindowOptions> = this.getDefaultTheiaWindowOptions()): Promise<BrowserWindow> {
409
- let options = await asyncOptions;
410
- options = this.avoidOverlap(options);
411
- const electronWindow = this.windowFactory(options, this.config);
412
- const id = electronWindow.window.webContents.id;
413
- this.windows.set(id, electronWindow);
414
- electronWindow.onDidClose(() => this.windows.delete(id));
415
- electronWindow.window.on('maximize', () => TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'maximize'));
416
- electronWindow.window.on('unmaximize', () => TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'unmaximize'));
417
- electronWindow.window.on('focus', () => TheiaRendererAPI.sendWindowEvent(electronWindow.window.webContents, 'focus'));
418
- this.attachSaveWindowState(electronWindow.window);
419
-
420
- return electronWindow.window;
421
- }
422
-
423
- async getLastWindowOptions(): Promise<TheiaBrowserWindowOptions> {
424
- const previousWindowState: TheiaBrowserWindowOptions | undefined = this.electronStore.get('windowstate');
425
- const windowState = previousWindowState?.screenLayout === this.getCurrentScreenLayout()
426
- ? previousWindowState
427
- : this.getDefaultTheiaWindowOptions();
428
- return {
429
- frame: this.useNativeWindowFrame,
430
- ...this.getDefaultOptions(),
431
- ...windowState
432
- };
433
- }
434
-
435
- protected avoidOverlap(options: TheiaBrowserWindowOptions): TheiaBrowserWindowOptions {
436
- const existingWindowsBounds = BrowserWindow.getAllWindows().map(window => window.getBounds());
437
- if (existingWindowsBounds.length > 0) {
438
- while (existingWindowsBounds.some(window => window.x === options.x || window.y === options.y)) {
439
- // if the window is maximized or in fullscreen, use the default window options.
440
- if (options.isMaximized || options.isFullScreen) {
441
- options = this.getDefaultTheiaWindowOptions();
442
- }
443
- options.x = options.x! + 30;
444
- options.y = options.y! + 30;
445
-
446
- }
447
- }
448
- return options;
449
- }
450
-
451
- protected getDefaultOptions(): TheiaBrowserWindowOptions {
452
- return {
453
- show: false,
454
- title: this.config.applicationName,
455
- backgroundColor: DefaultTheme.defaultBackgroundColor(this.config.electron.windowOptions?.darkTheme || nativeTheme.shouldUseDarkColors),
456
- minWidth: 200,
457
- minHeight: 120,
458
- webPreferences: {
459
- // `global` is undefined when `true`.
460
- contextIsolation: true,
461
- sandbox: false,
462
- nodeIntegration: false,
463
- // Setting the following option to `true` causes some features to break, somehow.
464
- // Issue: https://github.com/eclipse-theia/theia/issues/8577
465
- nodeIntegrationInWorker: false,
466
- backgroundThrottling: false,
467
- preload: path.resolve(this.globals.THEIA_APP_PROJECT_PATH, 'lib', 'frontend', 'preload.js').toString()
468
- },
469
- ...this.config.electron?.windowOptions || {},
470
- };
471
- }
472
-
473
- async openDefaultWindow(params?: WindowSearchParams): Promise<BrowserWindow> {
474
- const options = this.getDefaultTheiaWindowOptions();
475
- const [uri, electronWindow] = await Promise.all([this.createWindowUri(params), this.reuseOrCreateWindow(options)]);
476
- electronWindow.loadURL(uri.withFragment(DEFAULT_WINDOW_HASH).toString(true));
477
- return electronWindow;
478
- }
479
-
480
- protected async openWindowWithWorkspace(workspacePath: string): Promise<BrowserWindow> {
481
- const options = await this.getLastWindowOptions();
482
- const [uri, electronWindow] = await Promise.all([this.createWindowUri(), this.reuseOrCreateWindow(options)]);
483
- electronWindow.loadURL(uri.withFragment(encodeURI(workspacePath)).toString(true));
484
- return electronWindow;
485
- }
486
-
487
- protected async reuseOrCreateWindow(asyncOptions: MaybePromise<TheiaBrowserWindowOptions>): Promise<BrowserWindow> {
488
- if (!this.initialWindow) {
489
- return this.createWindow(asyncOptions);
490
- }
491
- // reset initial window after having it re-used once
492
- const window = this.initialWindow;
493
- this.initialWindow = undefined;
494
- return window;
495
- }
496
-
497
- /**
498
- * "Gently" close all windows, application will not stop if a `beforeunload` handler returns `false`.
499
- */
500
- requestStop(): void {
501
- app.quit();
502
- }
503
-
504
- protected async handleMainCommand(options: ElectronMainCommandOptions): Promise<void> {
505
- if (options.secondInstance === false) {
506
- await this.openWindowWithWorkspace(''); // restore previous workspace.
507
- } else if (options.file === undefined) {
508
- await this.openDefaultWindow();
509
- } else {
510
- let workspacePath: string | undefined;
511
- try {
512
- workspacePath = await fs.realpath(path.resolve(options.cwd, options.file));
513
- } catch {
514
- console.error(`Could not resolve the workspace path. "${options.file}" is not a valid 'file' option. Falling back to the default workspace location.`);
515
- }
516
- if (workspacePath === undefined) {
517
- await this.openDefaultWindow();
518
- } else {
519
- await this.openWindowWithWorkspace(workspacePath);
520
- }
521
- }
522
- }
523
-
524
- protected async createWindowUri(params: WindowSearchParams = {}): Promise<URI> {
525
- if (!('port' in params)) {
526
- params.port = (await this.backendPort).toString();
527
- }
528
- const query = Object.entries(params).map(([name, value]) => `${name}=${value}`).join('&');
529
- return FileUri.create(this.globals.THEIA_FRONTEND_HTML_PATH)
530
- .withQuery(query);
531
- }
532
-
533
- protected getDefaultTheiaWindowOptions(): TheiaBrowserWindowOptions {
534
- return {
535
- frame: this.useNativeWindowFrame,
536
- isFullScreen: false,
537
- isMaximized: false,
538
- ...this.getDefaultTheiaWindowBounds(),
539
- ...this.getDefaultOptions()
540
- };
541
- }
542
-
543
- protected getDefaultTheiaSecondaryWindowBounds(): TheiaBrowserWindowOptions {
544
- return {};
545
- }
546
-
547
- protected getDefaultTheiaWindowBounds(): TheiaBrowserWindowOptions {
548
- // The `screen` API must be required when the application is ready.
549
- // See: https://electronjs.org/docs/api/screen#screen
550
- // We must center by hand because `browserWindow.center()` fails on multi-screen setups
551
- // See: https://github.com/electron/electron/issues/3490
552
- const { bounds } = screen.getDisplayNearestPoint(screen.getCursorScreenPoint());
553
- const height = Math.round(bounds.height * (2 / 3));
554
- const width = Math.round(bounds.width * (2 / 3));
555
- const y = Math.round(bounds.y + (bounds.height - height) / 2);
556
- const x = Math.round(bounds.x + (bounds.width - width) / 2);
557
- return {
558
- width,
559
- height,
560
- x,
561
- y
562
- };
563
- }
564
-
565
- /**
566
- * Save the window geometry state on every change.
567
- */
568
- protected attachSaveWindowState(electronWindow: BrowserWindow): void {
569
- const windowStateListeners = new DisposableCollection();
570
- let delayedSaveTimeout: NodeJS.Timeout | undefined;
571
- const saveWindowStateDelayed = () => {
572
- if (delayedSaveTimeout) {
573
- clearTimeout(delayedSaveTimeout);
574
- }
575
- delayedSaveTimeout = setTimeout(() => this.saveWindowState(electronWindow), 1000);
576
- };
577
- createDisposableListener(electronWindow, 'close', () => {
578
- this.saveWindowState(electronWindow);
579
- }, windowStateListeners);
580
- createDisposableListener(electronWindow, 'resize', saveWindowStateDelayed, windowStateListeners);
581
- createDisposableListener(electronWindow, 'move', saveWindowStateDelayed, windowStateListeners);
582
- windowStateListeners.push(Disposable.create(() => { try { this.didUseNativeWindowFrameOnStart.delete(electronWindow.webContents.id); } catch { } }));
583
- this.didUseNativeWindowFrameOnStart.set(electronWindow.webContents.id, this.useNativeWindowFrame);
584
- electronWindow.once('closed', () => windowStateListeners.dispose());
585
- }
586
-
587
- protected saveWindowState(electronWindow: BrowserWindow): void {
588
- // In some circumstances the `electronWindow` can be `null`
589
- if (!electronWindow) {
590
- return;
591
- }
592
- try {
593
- const bounds = electronWindow.getBounds();
594
- const options: TheiaBrowserWindowOptions = {
595
- isFullScreen: electronWindow.isFullScreen(),
596
- isMaximized: electronWindow.isMaximized(),
597
- width: bounds.width,
598
- height: bounds.height,
599
- x: bounds.x,
600
- y: bounds.y,
601
- frame: this.useNativeWindowFrame,
602
- screenLayout: this.getCurrentScreenLayout(),
603
- backgroundColor: this.customBackgroundColor
604
- };
605
- this.electronStore.set('windowstate', options);
606
- } catch (e) {
607
- console.error('Error while saving window state:', e);
608
- }
609
- }
610
-
611
- /**
612
- * Return a string unique to the current display layout.
613
- */
614
- protected getCurrentScreenLayout(): string {
615
- return screen.getAllDisplays().map(
616
- display => `${display.bounds.x}:${display.bounds.y}:${display.bounds.width}:${display.bounds.height}`
617
- ).sort().join('-');
618
- }
619
-
620
- /**
621
- * Start the NodeJS backend server.
622
- *
623
- * @return Running server's port promise.
624
- */
625
- protected async startBackend(): Promise<number> {
626
- // Check if we should run everything as one process.
627
- const noBackendFork = process.argv.indexOf('--no-cluster') !== -1;
628
- // Set the electron version for both the dev and the production mode. (https://github.com/eclipse-theia/theia/issues/3254)
629
- // Otherwise, the forked backend processes will not know that they're serving the electron frontend.
630
- process.env.THEIA_ELECTRON_VERSION = process.versions.electron;
631
- if (noBackendFork) {
632
- process.env[ElectronSecurityToken] = JSON.stringify(this.electronSecurityToken);
633
- // The backend server main file is supposed to export a promise resolving with the port used by the http(s) server.
634
- dynamicRequire(this.globals.THEIA_BACKEND_MAIN_PATH);
635
- // @ts-expect-error
636
- const address: AddressInfo = await globalThis.serverAddress;
637
- return address.port;
638
- } else {
639
- const backendProcess = fork(
640
- this.globals.THEIA_BACKEND_MAIN_PATH,
641
- this.processArgv.getProcessArgvWithoutBin(),
642
- await this.getForkOptions(),
643
- );
644
- return new Promise((resolve, reject) => {
645
- // The backend server main file is also supposed to send the resolved http(s) server port via IPC.
646
- backendProcess.on('message', (address: AddressInfo) => {
647
- resolve(address.port);
648
- });
649
- backendProcess.on('error', error => {
650
- reject(error);
651
- });
652
- backendProcess.on('exit', code => {
653
- reject(code);
654
- });
655
- app.on('quit', () => {
656
- // Only issue a kill signal if the backend process is running.
657
- // eslint-disable-next-line no-null/no-null
658
- if (backendProcess.exitCode === null && backendProcess.signalCode === null) {
659
- try {
660
- // If we forked the process for the clusters, we need to manually terminate it.
661
- // See: https://github.com/eclipse-theia/theia/issues/835
662
- if (backendProcess.pid) {
663
- process.kill(backendProcess.pid);
664
- }
665
- } catch (error) {
666
- // See https://man7.org/linux/man-pages/man2/kill.2.html#ERRORS
667
- if (error.code === 'ESRCH') {
668
- return;
669
- }
670
- throw error;
671
- }
672
- }
673
- });
674
- });
675
- }
676
- }
677
-
678
- protected async getForkOptions(): Promise<ForkOptions> {
679
- return {
680
- // The backend must be a process group leader on UNIX in order to kill the tree later.
681
- // See https://nodejs.org/api/child_process.html#child_process_options_detached
682
- detached: process.platform !== 'win32',
683
- env: {
684
- ...process.env,
685
- [ElectronSecurityToken]: JSON.stringify(this.electronSecurityToken),
686
- },
687
- };
688
- }
689
-
690
- protected async attachElectronSecurityToken(port: number): Promise<void> {
691
- await this.electronSecurityTokenService.setElectronSecurityTokenCookie(`http://localhost:${port}`);
692
- }
693
-
694
- protected hookApplicationEvents(): void {
695
- app.on('will-quit', this.onWillQuit.bind(this));
696
- app.on('second-instance', this.onSecondInstance.bind(this));
697
- app.on('window-all-closed', this.onWindowAllClosed.bind(this));
698
- app.on('web-contents-created', this.onWebContentsCreated.bind(this));
699
- }
700
-
701
- protected onWillQuit(event: ElectronEvent): void {
702
- this.stopContributions();
703
- }
704
-
705
- protected async onSecondInstance(event: ElectronEvent, argv: string[], cwd: string): Promise<void> {
706
- createYargs(this.processArgv.getProcessArgvWithoutBin(argv), process.cwd())
707
- .help(false)
708
- .command('$0 [file]', false,
709
- cmd => cmd
710
- .positional('file', { type: 'string' }),
711
- async args => {
712
- this.handleMainCommand({
713
- file: args.file,
714
- cwd: process.cwd(),
715
- secondInstance: true
716
- });
717
- },
718
- ).parse();
719
- }
720
-
721
- protected onWebContentsCreated(event: ElectronEvent, webContents: WebContents): void {
722
- // Block any in-page navigation except loading the secondary window contents
723
- webContents.on('will-navigate', evt => {
724
- if (new URI(evt.url).path.fsPath() !== new Path(this.globals.THEIA_SECONDARY_WINDOW_HTML_PATH).fsPath()) {
725
- evt.preventDefault();
726
- }
727
- });
728
-
729
- webContents.setWindowOpenHandler(details => {
730
- // if it's a secondary window, allow it to open
731
- if (new URI(details.url).path.fsPath() === new Path(this.globals.THEIA_SECONDARY_WINDOW_HTML_PATH).fsPath()) {
732
- const { minWidth, minHeight } = this.getDefaultOptions();
733
- const options: BrowserWindowConstructorOptions = {
734
- ...this.getDefaultTheiaSecondaryWindowBounds(),
735
- // We always need the native window frame for now because the secondary window does not have Theia's title bar by default.
736
- // In 'custom' title bar mode this would leave the window without any window controls (close, min, max)
737
- // TODO set to this.useNativeWindowFrame when secondary windows support a custom title bar.
738
- frame: true,
739
- minWidth,
740
- minHeight
741
- };
742
- if (!this.useNativeWindowFrame) {
743
- // If the main window does not have a native window frame, do not show an icon in the secondary window's native title bar.
744
- // The data url is a 1x1 transparent png
745
- options.icon = nativeImage.createFromDataURL(
746
- 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAC0lEQVQI12P4DwQACfsD/WMmxY8AAAAASUVORK5CYII=');
747
- }
748
- return {
749
- action: 'allow',
750
- overrideBrowserWindowOptions: options,
751
- };
752
- } else {
753
- const uri: URI = new URI(details.url);
754
- let okToOpen = uri.scheme === 'https' || uri.scheme === 'http';
755
- if (!okToOpen) {
756
- const button = dialog.showMessageBoxSync(BrowserWindow.fromWebContents(webContents)!, {
757
- message: `Open link\n\n${details.url}\n\nin the system handler?`,
758
- type: 'question',
759
- title: 'Open Link',
760
- buttons: ['OK', 'Cancel'],
761
- defaultId: 1,
762
- cancelId: 1
763
- });
764
- okToOpen = button === 0;
765
- }
766
- if (okToOpen) {
767
- shell.openExternal(details.url, {});
768
- }
769
-
770
- return { action: 'deny' };
771
- }
772
- });
773
- }
774
-
775
- protected onWindowAllClosed(event: ElectronEvent): void {
776
- if (!this.restarting) {
777
- this.requestStop();
778
- }
779
- }
780
-
781
- public async restart(webContents: WebContents): Promise<void> {
782
- this.restarting = true;
783
- const wrapper = this.windows.get(webContents.id);
784
- if (wrapper) {
785
- const listener = wrapper.onDidClose(async () => {
786
- listener.dispose();
787
- await this.handleMainCommand({
788
- secondInstance: false,
789
- cwd: process.cwd()
790
- });
791
- this.restarting = false;
792
- });
793
- // If close failed or was cancelled on this occasion, don't keep listening for it.
794
- if (!await wrapper.close(StopReason.Restart)) {
795
- listener.dispose();
796
- }
797
- }
798
- }
799
-
800
- protected async startContributions(): Promise<void> {
801
- const promises = [];
802
- for (const contribution of this.contributions.getContributions()) {
803
- if (contribution.onStart) {
804
- promises.push(contribution.onStart(this));
805
- }
806
- }
807
- await Promise.all(promises);
808
- }
809
-
810
- protected stopContributions(): void {
811
- for (const contribution of this.contributions.getContributions()) {
812
- if (contribution.onStop) {
813
- contribution.onStop(this);
814
- }
815
- }
816
- }
817
-
818
- }
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
+ }