@jupyterlab/lsp 4.1.0-alpha.1 → 4.1.0-alpha.3

package/src/adapters/tracker.ts

@@ -0,0 +1,222 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import { DocumentWidget } from '@jupyterlab/docregistry';
+
+import { ISignal, Signal } from '@lumino/signaling';
+
+import { WidgetLSPAdapter } from './adapter';
+import { IShell, IWidgetLSPAdapterTracker } from '../tokens';
+
+/**
+ * A class that keeps track of widget adapter instances.
+ *
+ * @typeparam T - The type of widget being tracked. Defaults to `WidgetLSPAdapter`.
+ */
+export class WidgetLSPAdapterTracker<
+  T extends WidgetLSPAdapter = WidgetLSPAdapter
+> implements IWidgetLSPAdapterTracker<T>
+{
+  /**
+   * Create a new widget tracker.
+   *
+   * @param options - The instantiation options for a widget tracker.
+   */
+  constructor(options: WidgetLSPAdapterTracker.IOptions) {
+    const shell = (this._shell = options.shell);
+
+    shell.currentChanged.connect((_, args) => {
+      let newValue = args.newValue;
+
+      if (!newValue || !(newValue instanceof DocumentWidget)) {
+        console.log('No current widget');
+        return;
+      }
+
+      const adapter = this.find(value => value.widget === newValue);
+
+      if (!adapter) {
+        return;
+      }
+
+      this._current = adapter;
+      this._currentChanged.emit(adapter);
+    });
+  }
+
+  /**
+   * A signal emitted when the current adapter changes.
+   */
+  get currentChanged(): ISignal<this, T | null> {
+    return this._currentChanged;
+  }
+
+  /**
+   * The current adapter is the most recently focused or added adapter.
+   *
+   * #### Notes
+   * It is the most recently focused adapter, or the most recently added
+   * adapter if no adapter has taken focus.
+   */
+  get currentAdapter(): T | null {
+    return this._current;
+  }
+
+  /**
+   * The number of adapter held by the tracker.
+   */
+  get size(): number {
+    return this._adapters.size;
+  }
+
+  /**
+   * A signal emitted when an adapter is added.
+   */
+  get adapterAdded(): ISignal<this, T> {
+    return this._adapterAdded;
+  }
+
+  /**
+   * A signal emitted when an adapter is updated.
+   */
+  get adapterUpdated(): ISignal<this, T> {
+    return this._adapterUpdated;
+  }
+
+  /**
+   * Add a new adapter to the tracker.
+   *
+   * @param adapter - The adapter being added.
+   *
+   * #### Notes.
+   * The newly added adapter becomes the current adapter unless the shell
+   * already had a DocumentWidget as the activeWidget.
+   */
+  add(adapter: T): void {
+    if (adapter.isDisposed) {
+      const warning = 'A disposed object cannot be added.';
+      console.warn(warning, adapter);
+      throw new Error(warning);
+    }
+
+    if (this._adapters.has(adapter)) {
+      const warning = 'This object already exists in the pool.';
+      console.warn(warning, adapter);
+      throw new Error(warning);
+    }
+
+    this._adapters.add(adapter);
+    this._adapterAdded.emit(adapter);
+
+    adapter.disposed.connect(() => {
+      this._adapters.delete(adapter);
+
+      if (adapter === this._current) {
+        this._current = null;
+        this._currentChanged.emit(this._current);
+      }
+    }, this);
+
+    // Only update the current adapter, when there is no shell.activeWidget
+    // or the active widget is not a DocumentWidget
+    // We will be able to use other panels while keeping the current adapter.
+    const active = this._shell.activeWidget;
+    if (!active || !(active instanceof DocumentWidget)) {
+      this._current = adapter;
+      this._currentChanged.emit(adapter);
+    }
+  }
+
+  /**
+   * Test whether the tracker is disposed.
+   */
+  get isDisposed(): boolean {
+    return this._isDisposed;
+  }
+
+  /**
+   * Dispose of the resources held by the tracker.
+   */
+  dispose(): void {
+    if (this.isDisposed) {
+      return;
+    }
+    this._isDisposed = true;
+    this._adapters.clear();
+    Signal.clearData(this);
+  }
+
+  /**
+   * Find the first adapter in the tracker that satisfies a filter function.
+   *
+   * @param - fn The filter function to call on each adapter.
+   *
+   * #### Notes
+   * If no adapter is found, the value returned is `undefined`.
+   */
+  find(fn: (adapter: T) => boolean): T | undefined {
+    const values = this._adapters.values();
+    for (const value of values) {
+      if (fn(value)) {
+        return value;
+      }
+    }
+    return undefined;
+  }
+
+  /**
+   * Iterate through each adapter in the tracker.
+   *
+   * @param fn - The function to call on each adapter.
+   */
+  forEach(fn: (adapter: T) => void): void {
+    this._adapters.forEach(fn);
+  }
+
+  /**
+   * Filter the adapter in the tracker based on a predicate.
+   *
+   * @param fn - The function by which to filter.
+   */
+  filter(fn: (adapter: T) => boolean): T[] {
+    const filtered: T[] = [];
+    this.forEach(value => {
+      if (fn(value)) {
+        filtered.push(value);
+      }
+    });
+    return filtered;
+  }
+
+  /**
+   * Check if this tracker has the specified adapter.
+   *
+   * @param adapter - The adapter whose existence is being checked.
+   */
+  has(adapter: T): boolean {
+    return this._adapters.has(adapter);
+  }
+
+  private _isDisposed = false;
+  private _shell: IShell;
+  private _current: T | null = null;
+  private _adapters = new Set<T>();
+  private _adapterAdded = new Signal<this, T>(this);
+  private _adapterUpdated = new Signal<this, T>(this);
+  private _currentChanged = new Signal<this, T | null>(this);
+}
+
+/**
+ * A namespace for `WidgetLSPAdapterTracker` statics.
+ */
+export namespace WidgetLSPAdapterTracker {
+  /**
+   * The instantiation options for the WidgetLSPAdapterTracker.
+   */
+  export interface IOptions {
+    /**
+     * The JupyterLab shell for tracking all widgets.
+     */
+    shell: IShell;
+  }
+}

package/src/connection_manager.ts

@@ -2,10 +2,9 @@
 // Distributed under the terms of the Modified BSD License.
 
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
-import { IDocumentWidget } from '@jupyterlab/docregistry';
 import { ISignal, Signal } from '@lumino/signaling';
 
-import { WidgetLSPAdapter } from './adapters/adapter';
+import { WidgetLSPAdapter } from './adapters';
 import { LSPConnection } from './connection';
 import { ClientCapabilities } from './lsp';
 import { AskServersToSendTraceNotifications } from './plugin';
@@ -16,6 +15,7 @@ import {
   ILSPConnection,
   ILSPDocumentConnectionManager,
   ISocketConnectionOptions,
+  IWidgetLSPAdapterTracker,
   TLanguageServerConfigurations,
   TLanguageServerId,
   TServerKeys
@@ -40,6 +40,11 @@ export class DocumentConnectionManager
     this._ignoredLanguages = new Set();
     this.languageServerManager = options.languageServerManager;
     Private.setLanguageServerManager(options.languageServerManager);
+
+    options.adapterTracker.adapterAdded.connect((_, adapter) => {
+      const path = adapter.widget.context.path;
+      this.registerAdapter(path, adapter);
+    });
   }
 
   /**
@@ -49,9 +54,10 @@ export class DocumentConnectionManager
   readonly connections: Map<VirtualDocument.uri, LSPConnection>;
 
   /**
+   * @deprecated
    * Map between the path of the document and its adapter
    */
-  readonly adapters: Map<string, WidgetLSPAdapter<IDocumentWidget>>;
+  readonly adapters: Map<string, WidgetLSPAdapter>;
 
   /**
    * Map between the URI of the virtual document and the document itself.
@@ -199,16 +205,21 @@ export class DocumentConnectionManager
   }
 
   /**
+   * @deprecated
+   *
    * Register a widget adapter with this manager
    *
    * @param  path - path to the inner document of the adapter
    * @param  adapter - the adapter to be registered
    */
-  registerAdapter(
-    path: string,
-    adapter: WidgetLSPAdapter<IDocumentWidget>
-  ): void {
+  registerAdapter(path: string, adapter: WidgetLSPAdapter): void {
     this.adapters.set(path, adapter);
+
+    adapter.widget.context.pathChanged.connect((context, newPath) => {
+      this.adapters.delete(path);
+      this.adapters.set(newPath, adapter);
+    });
+
     adapter.disposed.connect(() => {
       if (adapter.virtualDocument) {
         this.documents.delete(adapter.virtualDocument.uri);
@@ -535,6 +546,11 @@ export namespace DocumentConnectionManager {
      * The language server manager instance.
      */
     languageServerManager: ILanguageServerManager;
+
+    /**
+     * The WidgetLSPAdapter's tracker.
+     */
+    adapterTracker: IWidgetLSPAdapterTracker;
   }
 
   /**

package/src/feature.ts

@@ -6,13 +6,14 @@ import mergeWith from 'lodash.mergewith';
 
 import { ClientCapabilities } from './lsp';
 import { IFeature, ILSPFeatureManager } from './tokens';
+import { EditorAdapter } from './adapters/editorAdapter';
 
 /**
  * Class to manager the registered features of the language servers.
  */
 export class FeatureManager implements ILSPFeatureManager {
   constructor() {
-    this._featuresRegistered = new Signal(this);
+    this._featureRegistered = new Signal(this);
   }
   /**
    * List of registered features
@@ -22,8 +23,8 @@ export class FeatureManager implements ILSPFeatureManager {
   /**
    * Signal emitted when a new feature is registered.
    */
-  get featuresRegistered(): ISignal<ILSPFeatureManager, IFeature> {
-    return this._featuresRegistered;
+  get featureRegistered(): ISignal<ILSPFeatureManager, IFeature> {
+    return this._featureRegistered;
   }
 
   /**
@@ -36,7 +37,7 @@ export class FeatureManager implements ILSPFeatureManager {
       );
     } else {
       this.features.push(feature);
-      this._featuresRegistered.emit(feature);
+      this._featureRegistered.emit(feature);
     }
   }
 
@@ -54,5 +55,19 @@ export class FeatureManager implements ILSPFeatureManager {
     return capabilities;
   }
 
-  private _featuresRegistered: Signal<ILSPFeatureManager, IFeature>;
+  /**
+   * Get the extension factories of all clients.
+   */
+  extensionFactories(): EditorAdapter.ILSPEditorExtensionFactory[] {
+    const factories: EditorAdapter.ILSPEditorExtensionFactory[] = [];
+    for (const feature of this.features) {
+      if (!feature.extensionFactory) {
+        continue;
+      }
+      factories.push(feature.extensionFactory);
+    }
+    return factories;
+  }
+
+  private _featureRegistered: Signal<ILSPFeatureManager, IFeature>;
 }

package/src/index.ts

@@ -5,7 +5,7 @@
  * @module lsp
  */
 
-export * from './adapters/adapter';
+export * from './adapters';
 export * from './connection_manager';
 export * from './extractors';
 export * from './feature';

package/src/lsp.ts

@@ -5,6 +5,8 @@ import type * as lsp from 'vscode-languageserver-protocol';
 
 export type ClientCapabilities = lsp.ClientCapabilities;
 
+export type ServerCapabilities = lsp.ServerCapabilities;
+
 export enum DiagnosticSeverity {
   Error = 1,
   Warning = 2,

package/src/tokens.ts

@@ -1,13 +1,15 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { IDocumentWidget } from '@jupyterlab/docregistry';
 import { ServerConnection } from '@jupyterlab/services';
+import { CodeEditor } from '@jupyterlab/codeeditor';
+
+import { FocusTracker, Widget } from '@lumino/widgets';
 import { Token } from '@lumino/coreutils';
 import { IDisposable, IObservableDisposable } from '@lumino/disposable';
 import { ISignal, Signal } from '@lumino/signaling';
 
-import { WidgetLSPAdapter } from './adapters/adapter';
+import { EditorAdapter, WidgetLSPAdapter } from './adapters';
 import { IForeignCodeExtractor } from './extractors/types';
 import {
   AnyCompletion,
@@ -26,7 +28,7 @@ import {
 
 import type * as rpc from 'vscode-jsonrpc';
 import type * as lsp from 'vscode-languageserver-protocol';
-import { CodeEditor } from '@jupyterlab/codeeditor';
+
 export { IDocumentInfo };
 
 /**
@@ -367,9 +369,10 @@ export interface ILSPDocumentConnectionManager {
   documents: Map<VirtualDocument.uri, VirtualDocument>;
 
   /**
+   * @deprecated
    * The mapping of document uri to the widget adapter.
    */
-  adapters: Map<string, WidgetLSPAdapter<IDocumentWidget>>;
+  adapters: Map<string, WidgetLSPAdapter>;
 
   /**
    * Signal emitted when a connection is connected.
@@ -472,15 +475,14 @@ export interface ILSPDocumentConnectionManager {
   unregisterDocument(uri: string): void;
 
   /**
+   * @deprecated
+   *
    * Register a widget adapter.
    *
    * @param  path - path to current document widget of input adapter
    * @param  adapter - the adapter need to be registered
    */
-  registerAdapter(
-    path: string,
-    adapter: WidgetLSPAdapter<IDocumentWidget>
-  ): void;
+  registerAdapter(path: string, adapter: WidgetLSPAdapter): void;
 }
 
 /**
@@ -498,6 +500,11 @@ export interface IFeature {
    * LSP capabilities implemented by the feature.
    */
   capabilities?: ClientCapabilities;
+
+  /**
+   * Editor extension factory linked to the LSP feature.
+   */
+  extensionFactory?: EditorAdapter.ILSPEditorExtensionFactory;
 }
 
 /**
@@ -511,6 +518,11 @@ export interface ILSPFeatureManager {
    */
   readonly features: IFeature[];
 
+  /**
+   * Signal emitted when a feature is registered
+   */
+  featureRegistered: ISignal<ILSPFeatureManager, IFeature>;
+
   /**
    * Register the new feature (frontend capability)
    * for one or more code editor implementations.
@@ -518,14 +530,14 @@ export interface ILSPFeatureManager {
   register(feature: IFeature): void;
 
   /**
-   * Signal emitted when a feature is registered
+   * Get capabilities of all registered features
    */
-  featuresRegistered: ISignal<ILSPFeatureManager, IFeature>;
+  clientCapabilities(): ClientCapabilities;
 
   /**
-   * Get capabilities of all registered features
+   * Get the extension factories of all clients.
    */
-  clientCapabilities(): ClientCapabilities;
+  extensionFactories(): EditorAdapter.ILSPEditorExtensionFactory[];
 }
 
 /**
@@ -551,6 +563,96 @@ export interface ILSPCodeExtractorsManager {
   ): void;
 }
 
+/**
+ * An interface with the necessary properties from `JupyterFrontEnd.IShell`
+ * for the `WidgetLSPAdapterTracker`. Used to track the active DocumentWidget.
+ *
+ * For more info see https://github.com/jupyterlab/jupyterlab/pull/14920#discussion_r1316507818
+ * and https://github.com/jupyterlab/jupyterlab/pull/14920#discussion_r1305019718 .
+ */
+export interface IShell {
+  /**
+   * The active widget in the shell's main area.
+   */
+  readonly activeWidget: Widget | null;
+  /**
+   * A signal emitted when main area's current focus changes.
+   */
+  readonly currentChanged: ISignal<this, FocusTracker.IChangedArgs<Widget>>;
+}
+
+/**
+ * A tracker that tracks WidgetLSPAdapters.
+ *
+ * @typeparam T - The type of widget being tracked. Defaults to `WidgetLSPAdapter`.
+ */
+export interface IWidgetLSPAdapterTracker<
+  T extends WidgetLSPAdapter = WidgetLSPAdapter
+> extends IDisposable {
+  /**
+   * A signal emitted when an adapter is added.
+   */
+  readonly adapterAdded: ISignal<this, T>;
+
+  /**
+   * The current adapter is the most recently focused or added adapter.
+   *
+   * #### Notes
+   * It is the most recently focused adapter, or the most recently added
+   * adapter if no adapter has taken focus.
+   */
+  readonly currentAdapter: T | null;
+
+  /**
+   * A signal emitted when the current instance changes.
+   *
+   * #### Notes
+   * If the last instance being tracked is disposed, `null` will be emitted.
+   */
+  readonly currentChanged: ISignal<this, T | null>;
+
+  /**
+   * The number of instances held by the tracker.
+   */
+  readonly size: number;
+
+  /**
+   * A signal emitted when a adapter is updated.
+   */
+  readonly adapterUpdated: ISignal<this, T>;
+
+  /**
+   * Find the first instance in the tracker that satisfies a filter function.
+   *
+   * @param - fn The filter function to call on each instance.
+   *
+   * #### Notes
+   * If nothing is found, the value returned is `undefined`.
+   */
+  find(fn: (obj: T) => boolean): T | undefined;
+
+  /**
+   * Iterate through each instance in the tracker.
+   *
+   * @param fn - The function to call on each instance.
+   */
+  forEach(fn: (obj: T) => void): void;
+
+  /**
+   * Filter the instances in the tracker based on a predicate.
+   *
+   * @param fn - The function by which to filter.
+   */
+  filter(fn: (obj: T) => boolean): T[];
+
+  /**
+   * Check if this tracker has the specified instance.
+   *
+   * @param obj - The object whose existence is being checked.
+   */
+  has(obj: T): boolean;
+}
+
 /**
  * @alpha
  *
@@ -590,6 +692,18 @@ export const ILSPCodeExtractorsManager = new Token<ILSPCodeExtractorsManager>(
   'Provides the code extractor manager. This token is required in your extension to register code extractor allowing the creation of multiple virtual document from an opened document.'
 );
 
+/**
+ * @alpha
+ *
+ * The WidgetLSPAdapter tracker. Require this token in your extension to
+ * track WidgetLSPAdapters.
+ *
+ */
+export const IWidgetLSPAdapterTracker = new Token<IWidgetLSPAdapterTracker>(
+  '@jupyterlab/lsp:IWidgetLSPAdapterTracker',
+  'Provides the WidgetLSPAdapter tracker. This token is required in your extension to track WidgetLSPAdapters.'
+);
+
 /**
  * Argument for creating a connection to the LSP proxy server.
  */
@@ -638,9 +752,11 @@ export namespace Method {
 
   /** Client requests */
   export enum ClientRequest {
+    CODE_ACTION = 'textDocument/codeAction',
     COMPLETION = 'textDocument/completion',
     COMPLETION_ITEM_RESOLVE = 'completionItem/resolve',
     DEFINITION = 'textDocument/definition',
+    DOCUMENT_COLOR = 'textDocument/documentColor',
     DOCUMENT_HIGHLIGHT = 'textDocument/documentHighlight',
     DOCUMENT_SYMBOL = 'textDocument/documentSymbol',
     HOVER = 'textDocument/hover',
@@ -649,7 +765,14 @@ export namespace Method {
     REFERENCES = 'textDocument/references',
     RENAME = 'textDocument/rename',
     SIGNATURE_HELP = 'textDocument/signatureHelp',
-    TYPE_DEFINITION = 'textDocument/typeDefinition'
+    TYPE_DEFINITION = 'textDocument/typeDefinition',
+    LINKED_EDITING_RANGE = 'textDocument/linkedEditingRange',
+    INLINE_VALUE = 'textDocument/inlineValue',
+    INLAY_HINT = 'textDocument/inlayHint',
+    WORKSPACE_SYMBOL = 'workspace/symbol',
+    WORKSPACE_SYMBOL_RESOLVE = 'workspaceSymbol/resolve',
+    FORMATTING = 'textDocument/formatting',
+    RANGE_FORMATTING = 'textDocument/rangeFormatting'
   }
 }
 
@@ -700,9 +823,11 @@ export interface IServerResult {
  * Interface describing the request sent to the client.
  */
 export interface IClientRequestParams {
+  [Method.ClientRequest.CODE_ACTION]: lsp.CodeActionParams;
   [Method.ClientRequest.COMPLETION_ITEM_RESOLVE]: lsp.CompletionItem;
   [Method.ClientRequest.COMPLETION]: lsp.CompletionParams;
   [Method.ClientRequest.DEFINITION]: lsp.TextDocumentPositionParams;
+  [Method.ClientRequest.DOCUMENT_COLOR]: lsp.DocumentColorParams;
   [Method.ClientRequest.DOCUMENT_HIGHLIGHT]: lsp.TextDocumentPositionParams;
   [Method.ClientRequest.DOCUMENT_SYMBOL]: lsp.DocumentSymbolParams;
   [Method.ClientRequest.HOVER]: lsp.TextDocumentPositionParams;
@@ -712,15 +837,23 @@ export interface IClientRequestParams {
   [Method.ClientRequest.RENAME]: lsp.RenameParams;
   [Method.ClientRequest.SIGNATURE_HELP]: lsp.TextDocumentPositionParams;
   [Method.ClientRequest.TYPE_DEFINITION]: lsp.TextDocumentPositionParams;
+  [Method.ClientRequest.INLINE_VALUE]: lsp.InlineValueParams;
+  [Method.ClientRequest.INLAY_HINT]: lsp.InlayHintParams;
+  [Method.ClientRequest.WORKSPACE_SYMBOL]: lsp.WorkspaceSymbolParams;
+  [Method.ClientRequest.WORKSPACE_SYMBOL_RESOLVE]: lsp.WorkspaceSymbol;
+  [Method.ClientRequest.FORMATTING]: lsp.DocumentFormattingParams;
+  [Method.ClientRequest.RANGE_FORMATTING]: lsp.DocumentRangeFormattingParams;
 }
 
 /**
  * Interface describing the responses received from the client.
  */
 export interface IClientResult {
+  [Method.ClientRequest.CODE_ACTION]: (lsp.Command | lsp.CodeAction)[] | null;
   [Method.ClientRequest.COMPLETION_ITEM_RESOLVE]: lsp.CompletionItem;
   [Method.ClientRequest.COMPLETION]: AnyCompletion;
   [Method.ClientRequest.DEFINITION]: AnyLocation;
+  [Method.ClientRequest.DOCUMENT_COLOR]: lsp.ColorInformation[];
   [Method.ClientRequest.DOCUMENT_HIGHLIGHT]: lsp.DocumentHighlight[];
   [Method.ClientRequest.DOCUMENT_SYMBOL]: lsp.DocumentSymbol[];
   [Method.ClientRequest.HOVER]: lsp.Hover | null;
@@ -730,6 +863,15 @@ export interface IClientResult {
   [Method.ClientRequest.RENAME]: lsp.WorkspaceEdit;
   [Method.ClientRequest.SIGNATURE_HELP]: lsp.SignatureHelp;
   [Method.ClientRequest.TYPE_DEFINITION]: AnyLocation;
+  [Method.ClientRequest.INLINE_VALUE]: lsp.InlineValue[] | null;
+  [Method.ClientRequest.INLAY_HINT]: lsp.InlayHint[] | null;
+  [Method.ClientRequest.WORKSPACE_SYMBOL]:
+    | lsp.SymbolInformation[]
+    | lsp.WorkspaceSymbol[]
+    | null;
+  [Method.ClientRequest.WORKSPACE_SYMBOL_RESOLVE]: lsp.WorkspaceSymbol[];
+  [Method.ClientRequest.FORMATTING]: lsp.TextEdit[] | null;
+  [Method.ClientRequest.RANGE_FORMATTING]: lsp.TextEdit[] | null;
 }
 
 /**