updated xterm to v5 - fixes #5612

tabby-linkifier/package.json

@@ -17,6 +17,7 @@
   "author": "Eugene Pankov",
   "license": "MIT",
   "devDependencies": {
-    "untildify": "^4.0.0"
+    "untildify": "^4.0.0",
+    "xterm-addon-web-links": "^0.7.0"
   }
 }

tabby-linkifier/src/decorator.ts

@@ -1,7 +1,7 @@
 import { Inject, Injectable } from '@angular/core'
-import { ConfigService, PlatformService, TranslateService } from 'tabby-core'
-import { TerminalDecorator, BaseTerminalTabComponent } from 'tabby-terminal'
-
+import { ConfigService, PlatformService } from 'tabby-core'
+import { TerminalDecorator, BaseTerminalTabComponent, XTermFrontend } from 'tabby-terminal'
+import { WebLinksAddon } from 'xterm-addon-web-links'
 import { LinkHandler } from './api'
 
 @Injectable()
@@ -9,55 +9,47 @@ export class LinkHighlighterDecorator extends TerminalDecorator {
     constructor (
         private config: ConfigService,
         private platform: PlatformService,
-        private translate: TranslateService,
         @Inject(LinkHandler) private handlers: LinkHandler[],
     ) {
         super()
     }
 
     attach (tab: BaseTerminalTabComponent): void {
-        if (!(tab.frontend as any).xterm) {
-            // not hterm
+        if (!(tab.frontend instanceof XTermFrontend)) {
+            // not xterm
             return
         }
 
+        tab.frontend.xterm.options.linkHandler = {
+            activate: (event, uri) => {
+                if (!this.willHandleEvent(event)) {
+                    return
+                }
+                this.platform.openExternal(uri)
+            },
+        }
+
         for (const handler of this.handlers) {
             const getLink = async uri => handler.convert(uri, tab)
             const openLink = async uri => handler.handle(await getLink(uri), tab)
 
-            ;(tab.frontend as any).xterm.registerLinkMatcher(
-                handler.regex,
-                (event: MouseEvent, uri: string) => {
+            const addon = new WebLinksAddon(
+                this.onClick.bind(this),
+                async (event, uri) => {
                     if (!this.willHandleEvent(event)) {
                         return
                     }
+                    if (!await handler.verify(await handler.convert(uri, tab), tab)) {
+                        return
+                    }
                     openLink(uri)
                 },
                 {
-                    priority: handler.priority,
-                    validationCallback: async (uri: string, callback: (isValid: boolean) => void) => {
-                        callback(await handler.verify(await handler.convert(uri, tab), tab))
-                    },
-                    willLinkActivate: (event: MouseEvent, uri: string) => {
-                        if (event.button === 2) {
-                            this.platform.popupContextMenu([
-                                {
-                                    click: () => openLink(uri),
-                                    label: this.translate.instant('Open'),
-                                },
-                                {
-                                    click: async () => {
-                                        this.platform.setClipboard({ text: await getLink(uri) })
-                                    },
-                                    label: this.translate.instant('Copy'),
-                                },
-                            ])
-                            return false
-                        }
-                        return this.willHandleEvent(event)
-                    },
-                }
+                    urlRegex: handler.regex,
+                },
             )
+
+            tab.frontend.xterm.loadAddon(addon)
         }
     }
 

tabby-linkifier/yarn.lock

@@ -6,3 +6,8 @@ untildify@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/untildify/-/untildify-4.0.0.tgz#2bc947b953652487e4600949fb091e3ae8cd919b"
   integrity sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==
+
+xterm-addon-web-links@^0.7.0:
+  version "0.7.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-web-links/-/xterm-addon-web-links-0.7.0.tgz#dceac36170605f9db10a01d716bd83ee38f65c17"
+  integrity sha512-6PqoqzzPwaeSq22skzbvyboDvSnYk5teUYEoKBwMYvhbkwOQkemZccjWHT5FnNA8o1aInTc4PRYAl4jjPucCKA==

tabby-terminal/package.json

@@ -26,7 +26,8 @@
     "ngx-colors": "^3.0.4",
     "ps-node": "^0.1.6",
     "runes": "^0.4.2",
-    "xterm": "npm:@tabby-gang/xterm@^4.19.0-beta.4",
+    "xterm": "^5.0.0",
+    "xterm-addon-canvas": "^0.2.0",
     "xterm-addon-fit": "^0.6.0-beta.8",
     "xterm-addon-image": "^0.1.0",
     "xterm-addon-ligatures": "^0.6.0-beta.14",

tabby-terminal/src/frontends/xtermFrontend.ts

@@ -10,6 +10,7 @@ import { WebglAddon } from 'xterm-addon-webgl'
 import { Unicode11Addon } from 'xterm-addon-unicode11'
 import { SerializeAddon } from 'xterm-addon-serialize'
 import { ImageAddon } from 'xterm-addon-image'
+import { CanvasAddon } from 'xterm-addon-canvas'
 import './xterm.css'
 import deepEqual from 'deep-equal'
 import { Attributes } from 'xterm/src/common/buffer/Constants'
@@ -60,9 +61,9 @@ class FlowControl {
 /** @hidden */
 export class XTermFrontend extends Frontend {
     enableResizing = true
+    xterm: Terminal
     protected xtermCore: any
     protected enableWebGL = false
-    private xterm: Terminal
     private element?: HTMLElement
     private configuredFontSize = 0
     private configuredLinePadding = 0
@@ -76,6 +77,7 @@ export class XTermFrontend extends Frontend {
     private serializeAddon = new SerializeAddon()
     private ligaturesAddon?: LigaturesAddon
     private webGLAddon?: WebglAddon
+    private canvasAddon?: CanvasAddon
     private opened = false
     private resizeObserver?: any
     private flowControl: FlowControl
@@ -94,6 +96,7 @@ export class XTermFrontend extends Frontend {
 
         this.xterm = new Terminal({
             allowTransparency: true,
+            allowProposedApi: true,
             overviewRulerWidth: 8,
             windowsMode: process.platform === 'win32',
         })
@@ -236,6 +239,14 @@ export class XTermFrontend extends Frontend {
             ).subscribe(() => {
                 this.webGLAddon?.clearTextureAtlas()
             })
+        } else {
+            this.canvasAddon = new CanvasAddon()
+            this.xterm.loadAddon(this.canvasAddon)
+            this.platformService.displayMetricsChanged$.pipe(
+                takeUntil(this.destroyed$),
+            ).subscribe(() => {
+                this.canvasAddon?.clearTextureAtlas()
+            })
         }
 
         this.ready.next()
@@ -275,6 +286,7 @@ export class XTermFrontend extends Frontend {
     destroy (): void {
         super.destroy()
         this.webGLAddon?.dispose()
+        this.canvasAddon?.dispose()
         this.xterm.dispose()
     }
 
@@ -356,7 +368,6 @@ export class XTermFrontend extends Frontend {
         })
 
         this.xterm.options.fontFamily = getCSSFontFamily(config)
-        this.xterm.options.bellStyle = config.terminal.bell
         this.xterm.options.cursorStyle = {
             beam: 'bar',
         }[config.terminal.cursor] || config.terminal.cursor
@@ -375,7 +386,7 @@ export class XTermFrontend extends Frontend {
 
         const theme: ITheme = {
             foreground: config.terminal.colorScheme.foreground,
-            selection: config.terminal.colorScheme.selection || '#88888888',
+            selectionBackground: config.terminal.colorScheme.selection || '#88888888',
             selectionForeground: config.terminal.colorScheme.selectionForeground || undefined,
             background: config.terminal.background === 'colorScheme' ? config.terminal.colorScheme.background : '#00000000',
             cursor: config.terminal.colorScheme.cursor,
@@ -472,14 +483,14 @@ export class XTermFrontend extends Frontend {
         if (!selection) {
             return ''
         }
-        if (selection.startRow === selection.endRow) {
-            html += this.getLineAsHTML(selection.startRow, selection.startColumn, selection.endColumn)
+        if (selection.start.y === selection.end.y) {
+            html += this.getLineAsHTML(selection.start.y, selection.start.x, selection.end.x)
         } else {
-            html += this.getLineAsHTML(selection.startRow, selection.startColumn, this.xterm.cols)
-            for (let y = selection.startRow + 1; y < selection.endRow; y++) {
+            html += this.getLineAsHTML(selection.start.y, selection.start.x, this.xterm.cols)
+            for (let y = selection.start.y + 1; y < selection.end.y; y++) {
                 html += this.getLineAsHTML(y, 0, this.xterm.cols)
             }
-            html += this.getLineAsHTML(selection.endRow, 0, selection.endColumn)
+            html += this.getLineAsHTML(selection.end.y, 0, selection.end.x)
         }
         html += '</div>'
         return html

tabby-terminal/yarn.lock

@@ -104,7 +104,7 @@ ngx-colors@^3.0.4:
 opentype.js@^0.8.0:
   version "0.8.0"
   resolved "https://registry.yarnpkg.com/opentype.js/-/opentype.js-0.8.0.tgz#acabcfa1642fbe894a3e4d759e43ba694e02bd35"
-  integrity sha1-rKvPoWQvvolKPk11nkO6aU4CvTU=
+  integrity sha512-FQHR4oGP+a0m/f6yHoRpBOIbn/5ZWxKd4D/djHVJu8+KpBTYrJda0b7mLcgDEMWXE9xBCJm+qb0yv6FcvPjukg==
   dependencies:
     tiny-inflate "^1.0.2"
 
@@ -157,48 +157,53 @@ xtend@^4.0.0:
   resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54"
   integrity sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==
 
+xterm-addon-canvas@^0.2.0:
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-canvas/-/xterm-addon-canvas-0.2.0.tgz#ba0080d4071f172f94e8c0b5e6151dd7e386f1a1"
+  integrity sha512-b4tMT05US9Rlqv6R0XZTHsfq8MRKzwxITwpvckuod/l4lokcCokHPbgpYAytOgrzqkzWjYI+Ol8en6cMGf8ncg==
+
 xterm-addon-fit@^0.6.0-beta.8:
-  version "0.6.0-beta.9"
-  resolved "https://registry.yarnpkg.com/xterm-addon-fit/-/xterm-addon-fit-0.6.0-beta.9.tgz#55d550b7e8f3b90ee0781fdddf876b8502a31540"
-  integrity sha512-QrlwItVFiapkiJ2YL2rj2drtOvFmr8luDyV286MCrVSK4iGxSnsOdT+NcjeNig1lqYmy5FAo8iuP4FPY//NDog==
+  version "0.6.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-fit/-/xterm-addon-fit-0.6.0.tgz#142e1ce181da48763668332593fc440349c88c34"
+  integrity sha512-9/7A+1KEjkFam0yxTaHfuk9LEvvTSBi0PZmEkzJqgafXPEXL9pCMAVV7rB09sX6ATRDXAdBpQhZkhKj7CGvYeg==
 
 xterm-addon-image@^0.1.0:
-  version "0.1.0"
-  resolved "https://registry.yarnpkg.com/xterm-addon-image/-/xterm-addon-image-0.1.0.tgz#ead96aa224f5fcbfb45da2907f02368fe92985e6"
-  integrity sha512-xMvcEQ2rVUIXbbj5BRhznrZU24CRaMiSo8l2HH/E1FeE+G+KKduoF6mwja856/n4ekZ7K0ALZmmyDsbZODhDqQ==
+  version "0.1.3"
+  resolved "https://registry.yarnpkg.com/xterm-addon-image/-/xterm-addon-image-0.1.3.tgz#20593d93b51ab3408debb31f66f8700a2e60ed2d"
+  integrity sha512-9J+DnI/MlanAv+gaaTcTXcqXK8fU/FYiWbaL0C5+YY2lbflpGSk7XV4K95txbix4AdV85RfIDByUm7VJZRWs8g==
 
 xterm-addon-ligatures@^0.6.0-beta.14:
-  version "0.6.0-beta.14"
-  resolved "https://registry.yarnpkg.com/xterm-addon-ligatures/-/xterm-addon-ligatures-0.6.0-beta.14.tgz#392b8df0e32dcfc87f43b79901ec1c2abc997ae7"
-  integrity sha512-WeObuNFfGULKhfvbFyCccjxBk+BX6YMvG54lu40kgW5ubwpt0BcnKTQAxHvt9mSeT0lG0A5GxcbimBeRWc484Q==
+  version "0.6.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-ligatures/-/xterm-addon-ligatures-0.6.0.tgz#c51801b0150c62ac1165654757b55c796457d195"
+  integrity sha512-DxiYCXXYEpnwr8li4/QhG64exjrLX1nHBfNNfrQgx5e8Z9tK2SjWKpxI6PZEy++8+YdL1F7VjWI4aKOaDt2VVw==
   dependencies:
     font-finder "^1.1.0"
     font-ligatures "^1.4.1"
 
 xterm-addon-search@^0.9.0-beta.18:
-  version "0.9.0-beta.37"
-  resolved "https://registry.yarnpkg.com/xterm-addon-search/-/xterm-addon-search-0.9.0-beta.37.tgz#84a020f03b2cacc5afac78ca6ff2f1eb86fb6710"
-  integrity sha512-bfeFgKJkDYyIgqpWiV1oWYqDiTo+SHTeIPEbpOfxDr97pc3PtDF1Tyd79PrvJNfoxaV3VMUo//UEOy4D+KY9OQ==
+  version "0.9.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-search/-/xterm-addon-search-0.9.0.tgz#95278ebb818cfcf882209ae75be96e0bea5d52a5"
+  integrity sha512-aoolI8YuHvdGw+Qjg8g2M4kst0v86GtB7WeBm4F0jNXA005/6QbWWy9eCsvnIDLJOFI5JSSrZnD6CaOkvBQYPA==
 
 xterm-addon-serialize@^0.7.0-beta.12:
-  version "0.7.0-beta.12"
-  resolved "https://registry.yarnpkg.com/xterm-addon-serialize/-/xterm-addon-serialize-0.7.0-beta.12.tgz#4f845d8b1a9f9b7ae3f910455ce8c58b041babc7"
-  integrity sha512-b4Ug0B/RSJMux+KAcp+PXVqubVyXjN1yCQw1FOkgVYTpmd9AH/X+EcxKml5Lz8DsKmsXqfD9AlV3WpEeT+OtMw==
+  version "0.7.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-serialize/-/xterm-addon-serialize-0.7.0.tgz#cc7ef78972c8425b81dd6ae0a76824ce033d1e5f"
+  integrity sha512-ZfZ4Zj4uTEBFnUA0exipDGZ14jfiWLCov7gIt2OwIjQEz2ey8ic5kL/cxYz5antNz8/hTSA2qZcyA6VyyQASOQ==
 
 xterm-addon-unicode11@^0.4.0-beta.3:
-  version "0.4.0-beta.3"
-  resolved "https://registry.yarnpkg.com/xterm-addon-unicode11/-/xterm-addon-unicode11-0.4.0-beta.3.tgz#f350184155fafd5ad0d6fbf31d13e6ca7dea1efa"
-  integrity sha512-FryZAVwbUjKTmwXnm1trch/2XO60F5JsDvOkZhzobV1hm10sFLVuZpFyHXiUx7TFeeFsvNP+S77LAtWoeT5z+Q==
+  version "0.4.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-unicode11/-/xterm-addon-unicode11-0.4.0.tgz#59a4abbb591befb69ca0c5f7c3f9fa9c1c05353e"
+  integrity sha512-HkUwR4gc8MKVFy2Ux8zUnjqARYpfl7dJ9na3TwRbAUbF4JlCv707m4Z07WVaDMIRUZsfZ+5LgSi+Ss7PfZqNcw==
 
 xterm-addon-webgl@^0.12.0-beta.27:
-  version "0.12.0-beta.36"
-  resolved "https://registry.yarnpkg.com/xterm-addon-webgl/-/xterm-addon-webgl-0.12.0-beta.36.tgz#460f80829a78c979a448d5b764699af3f0366ff1"
-  integrity sha512-sgX7OHSGZQZE5b4xtPqd/5NEcll0Z+00tnTVxKZlXf5XEENcG0tnBF4I4f+k9K3cmjE1UIUVG2yYPrqWlYCdpA==
+  version "0.12.0"
+  resolved "https://registry.yarnpkg.com/xterm-addon-webgl/-/xterm-addon-webgl-0.12.0.tgz#2fba8d31890a122adafa1c2fb945482e2ae12973"
+  integrity sha512-3P5ihdjPnxH6Wrvqjki9UD+duoVrp1fvnO/pSpXP2F1L2GwY6TDNExgj8Yg141vMCNgQbcVqmsTLYEYZxjY92A==
 
-"xterm@npm:@tabby-gang/xterm@^4.19.0-beta.4":
-  version "4.19.0-beta.5"
-  resolved "https://registry.yarnpkg.com/@tabby-gang/xterm/-/xterm-4.19.0-beta.5.tgz#aa7a4509148a31ac4e4e55475c950f8572616899"
-  integrity sha512-8Vn92qMHDT2Q8TLPTFqalbwdS8ev3AmtLfPs2PRoMlJA/XzrcGUD5BNuAau5bn9lF5iEueX1gYqsJxzk5aYDbQ==
+xterm@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/xterm/-/xterm-5.0.0.tgz#0af50509b33d0dc62fde7a4ec17750b8e453cc5c"
+  integrity sha512-tmVsKzZovAYNDIaUinfz+VDclraQpPUnAME+JawosgWRMphInDded/PuY0xmU5dOhyeYZsI0nz5yd8dPYsdLTA==
 
 yallist@^4.0.0:
   version "4.0.0"