Remove link matchers

Fixes #2703
xtermjs · Jul 27, 2022 · 7a17a26 · 7a17a26
1 parent fafa7ef
commit 7a17a26
Show file tree

Hide file tree

Showing 15 changed files with 23 additions and 961 deletions.
diff --git a/addons/xterm-addon-attach/typings/xterm-addon-attach.d.ts b/addons/xterm-addon-attach/typings/xterm-addon-attach.d.ts
@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Terminal, ILinkMatcherOptions, ITerminalAddon } from 'xterm';
+import { Terminal, ITerminalAddon } from 'xterm';
 
 declare module 'xterm-addon-attach' {
   export interface IAttachOptions {

diff --git a/addons/xterm-addon-web-links/src/WebLinksAddon.ts b/addons/xterm-addon-web-links/src/WebLinksAddon.ts
@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Terminal, ILinkMatcherOptions, ITerminalAddon, IDisposable } from 'xterm';
+import { Terminal, ITerminalAddon, IDisposable } from 'xterm';
 import { ILinkProviderOptions, WebLinkProvider } from './WebLinkProvider';
 
 const protocolClause = '(https?:\\/\\/)';
@@ -41,37 +41,23 @@ function handleLink(event: MouseEvent, uri: string): void {
 }
 
 export class WebLinksAddon implements ITerminalAddon {
-  private _linkMatcherId: number | undefined;
   private _terminal: Terminal | undefined;
   private _linkProvider: IDisposable | undefined;
 
   constructor(
     private _handler: (event: MouseEvent, uri: string) => void = handleLink,
-    private _options: ILinkMatcherOptions | ILinkProviderOptions = {},
-    private _useLinkProvider: boolean = false
+    private _options: ILinkProviderOptions = {}
   ) {
   }
 
   public activate(terminal: Terminal): void {
     this._terminal = terminal;
-
-    if (this._useLinkProvider && 'registerLinkProvider' in this._terminal) {
-      const options = this._options as ILinkProviderOptions;
-      const regex = options.urlRegex || strictUrlRegex;
-      this._linkProvider = this._terminal.registerLinkProvider(new WebLinkProvider(this._terminal, regex, this._handler, options));
-    } else {
-      // TODO: This should be removed eventually
-      const options = this._options as ILinkMatcherOptions;
-      options.matchIndex = 1;
-      this._linkMatcherId = (this._terminal as Terminal).registerLinkMatcher(strictUrlRegex, this._handler, options);
-    }
+    const options = this._options as ILinkProviderOptions;
+    const regex = options.urlRegex || strictUrlRegex;
+    this._linkProvider = this._terminal.registerLinkProvider(new WebLinkProvider(this._terminal, regex, this._handler, options));
   }
 
   public dispose(): void {
-    if (this._linkMatcherId !== undefined && this._terminal !== undefined) {
-      this._terminal.deregisterLinkMatcher(this._linkMatcherId);
-    }
-
     this._linkProvider?.dispose();
   }
 }
diff --git a/addons/xterm-addon-web-links/typings/xterm-addon-web-links.d.ts b/addons/xterm-addon-web-links/typings/xterm-addon-web-links.d.ts
@@ -4,7 +4,7 @@
  */
 
 
-import { Terminal, ILinkMatcherOptions, ITerminalAddon, IViewportRange } from 'xterm';
+import { Terminal, ITerminalAddon, IViewportRange } from 'xterm';
 
 declare module 'xterm-addon-web-links' {
   /**
@@ -14,13 +14,9 @@ declare module 'xterm-addon-web-links' {
     /**
      * Creates a new web links addon.
      * @param handler The callback when the link is called.
-     * @param options Options for the link matcher.
-     * @param useLinkProvider Whether to use the new link provider API to create
-     * the links. This is an option because use of both link matcher (old) and
-     * link provider (new) may cause issues. Link provider will eventually be
-     * the default and only option.
+     * @param options Options for the link provider.
      */
-    constructor(handler?: (event: MouseEvent, uri: string) => void, options?: ILinkMatcherOptions | ILinkProviderOptions, useLinkProvider?: boolean);
+    constructor(handler?: (event: MouseEvent, uri: string) => void, options?: ILinkProviderOptions);
 
     /**
      * Activates the addon
@@ -50,7 +46,7 @@ declare module 'xterm-addon-web-links' {
      */
     leave?(event: MouseEvent, text: string): void;
 
-    /** 
+    /**
      * A callback to use instead of the default one.
     */
     urlRegex?: RegExp;

diff --git a/addons/xterm-addon-webgl/src/renderLayer/LinkRenderLayer.ts b/addons/xterm-addon-webgl/src/renderLayer/LinkRenderLayer.ts
@@ -15,8 +15,6 @@ export class LinkRenderLayer extends BaseRenderLayer {
 
   constructor(container: HTMLElement, zIndex: number, colors: IColorSet, terminal: ITerminal) {
     super(container, 'link', zIndex, true, colors);
-    terminal.linkifier.onShowLinkUnderline(e => this._onShowLinkUnderline(e));
-    terminal.linkifier.onHideLinkUnderline(e => this._onHideLinkUnderline(e));
 
     terminal.linkifier2.onShowLinkUnderline(e => this._onShowLinkUnderline(e));
     terminal.linkifier2.onHideLinkUnderline(e => this._onHideLinkUnderline(e));

diff --git a/src/browser/Linkifier.test.ts b/src/browser/Linkifier.test.ts