@jupyterlab/lsp 4.0.6 → 4.1.0-alpha.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.
  */

package/src/virtual/document.ts

@@ -241,7 +241,6 @@ export class VirtualDocument implements IDisposable {
     );
     this._remainingLifetime = 6;
 
-    this.unusedDocuments = new Set();
     this.documentInfo = new VirtualDocumentInfo(this);
     this.updateManager = new UpdateManager(this);
     this.updateManager.updateBegan.connect(this._updateBeganSlot, this);
@@ -446,7 +445,6 @@ export class VirtualDocument implements IDisposable {
 
     this.foreignDocuments.clear();
     this.sourceLines.clear();
-    this.unusedDocuments.clear();
     this.unusedStandaloneDocuments.clear();
     this.virtualLines.clear();
 
@@ -470,7 +468,6 @@ export class VirtualDocument implements IDisposable {
     // TODO - deep clear (assure that there is no memory leak)
     this.unusedStandaloneDocuments.clear();
 
-    this.unusedDocuments = new Set();
     this.virtualLines.clear();
     this.sourceLines.clear();
     this.lastVirtualLine = 0;
@@ -806,10 +803,34 @@ export class VirtualDocument implements IDisposable {
    * Close all expired documents.
    */
   closeExpiredDocuments(): void {
-    for (let document of this.unusedDocuments.values()) {
+    const usedDocuments = new Set<VirtualDocument>();
+    for (const line of this.sourceLines.values()) {
+      for (const block of line.foreignDocumentsMap.values()) {
+        usedDocuments.add(block.virtualDocument);
+      }
+    }
+
+    const documentIDs = new Map<VirtualDocument, string[]>();
+    for (const [id, document] of this.foreignDocuments.entries()) {
+      const ids = documentIDs.get(document);
+      if (typeof ids !== 'undefined') {
+        documentIDs.set(document, [...ids, id]);
+      }
+      documentIDs.set(document, [id]);
+    }
+    const allDocuments = new Set<VirtualDocument>(documentIDs.keys());
+    const unusedVirtualDocuments = new Set(
+      [...allDocuments].filter(x => !usedDocuments.has(x))
+    );
+
+    for (let document of unusedVirtualDocuments.values()) {
       document.remainingLifetime -= 1;
       if (document.remainingLifetime <= 0) {
         document.dispose();
+        const ids = documentIDs.get(document)!;
+        for (const id of ids) {
+          this.foreignDocuments.delete(id);
+        }
       }
     }
   }
@@ -901,7 +922,7 @@ export class VirtualDocument implements IDisposable {
 
   /**
    * When this counter goes down to 0, the document will be destroyed and the associated connection will be closed;
-   * This is meant to reduce the number of open connections when a a foreign code snippet was removed from the document.
+   * This is meant to reduce the number of open connections when a foreign code snippet was removed from the document.
    *
    * Note: top level virtual documents are currently immortal (unless killed by other means); it might be worth
    * implementing culling of unused documents, but if and only if JupyterLab will also implement culling of
@@ -927,7 +948,6 @@ export class VirtualDocument implements IDisposable {
   protected sourceLines: Map<number, ISourceLine>;
   protected lineBlocks: Array<string>;
 
-  protected unusedDocuments: Set<VirtualDocument>;
   protected unusedStandaloneDocuments: DefaultMap<
     language,
     Array<VirtualDocument>

package/style/index.css

@@ -4,6 +4,8 @@
 |----------------------------------------------------------------------------*/
 
 /* This file was auto-generated by ensurePackage() in @jupyterlab/buildutils */
+@import url('~@lumino/widgets/style/index.css');
 @import url('~@jupyterlab/apputils/style/index.css');
 @import url('~@jupyterlab/codeeditor/style/index.css');
+@import url('~@jupyterlab/codemirror/style/index.css');
 @import url('~@jupyterlab/docregistry/style/index.css');

package/style/index.js

@@ -4,6 +4,8 @@
 |----------------------------------------------------------------------------*/
 
 /* This file was auto-generated by ensurePackage() in @jupyterlab/buildutils */
+import '@lumino/widgets/style/index.js';
 import '@jupyterlab/apputils/style/index.js';
 import '@jupyterlab/codeeditor/style/index.js';
+import '@jupyterlab/codemirror/style/index.js';
 import '@jupyterlab/docregistry/style/index.js';