Improve VirtualDocument

jupyterlab · Oct 12, 2023 · c01c013 · c01c013
1 parent b9168b5
commit c01c013
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 14 deletions.
diff --git a/packages/lsp/src/virtual/document.ts b/packages/lsp/src/virtual/document.ts
@@ -461,9 +461,6 @@ export class VirtualDocument implements IDisposable {
    * Clear the virtual document and all related stuffs
    */
   clear(): void {
-    this.unusedStandaloneDocuments.forEach(item =>
-      item.forEach(doc => doc.dispose())
-    );
     this.unusedStandaloneDocuments.clear();
 
     for (let document of this.foreignDocuments.values()) {
@@ -745,7 +742,7 @@ export class VirtualDocument implements IDisposable {
             );
             continue;
           }
-          let foreignDocument = this.chooseForeignDocument(extractor);
+          let foreignDocument = this._chooseForeignDocument(extractor);
           foreignDocumentsMap.set(result.range, {
             virtualLine: foreignDocument.lastVirtualLine,
             virtualDocument: foreignDocument,
@@ -800,8 +797,6 @@ export class VirtualDocument implements IDisposable {
    * Close all foreign documents.
    */
   closeAllForeignDocuments(): void {
-    console.log('closing');
-
     for (let document of this.foreignDocuments.values()) {
       this.closeForeign(document);
     }
@@ -896,6 +891,19 @@ export class VirtualDocument implements IDisposable {
     } as ISourcePosition;
   }
 
+  /**
+   * Compute the position in root document from the position of
+   * a virtual document.
+   */
+  transformVirtualToRoot(position: IVirtualPosition): IRootPosition | null {
+    const editor = this.virtualLines.get(position.line)?.editor;
+    const editorPosition = this.transformVirtualToEditor(position);
+    if (!editor || !editorPosition) {
+      return null;
+    }
+    return this.root.transformFromEditorToRoot(editor, editorPosition);
+  }
+
   /**
    * Get the corresponding editor of the virtual line.
    */
@@ -973,7 +981,7 @@ export class VirtualDocument implements IDisposable {
   /**
    * Get the foreign document that can be opened with the input extractor.
    */
-  private chooseForeignDocument(
+  private _chooseForeignDocument(
     extractor: IForeignCodeExtractor
   ): VirtualDocument {
     let foreignDocument: VirtualDocument;
@@ -1012,13 +1020,16 @@ export class VirtualDocument implements IDisposable {
     standalone: boolean,
     fileExtension: string
   ): VirtualDocument {
-    let document = new VirtualDocument({
+    let document = new (this.constructor as new (
+      ...args: ConstructorParameters<typeof VirtualDocument>
+    ) => VirtualDocument)({
       ...this.options,
       parent: this,
       standalone: standalone,
       fileExtension: fileExtension,
       language: language
     });
+
     const context: Document.IForeignContext = {
       foreignDocument: document,
       parentHost: this

diff --git a/packages/lsp/test/document.spec.ts b/packages/lsp/test/document.spec.ts
@@ -225,16 +225,16 @@ describe('@jupyterlab/lsp', () => {
         expect(foreignDocumentsMap.size).toEqual(1);
       });
     });
-    describe('#chooseForeignDocument', () => {
+    describe('#_chooseForeignDocument', () => {
       it('should select the foreign document for markdown cell', () => {
-        const md: VirtualDocument = document['chooseForeignDocument'](
+        const md: VirtualDocument = document['_chooseForeignDocument'](
           markdownCellExtractor
         );
         expect(md.uri).toBe('test.ipynb.python-markdown.md');
       });
       it('should select the foreign document for raw cell', () => {
         const md: VirtualDocument =
-          document['chooseForeignDocument'](rawCellExtractor);
+          document['_chooseForeignDocument'](rawCellExtractor);
         expect(md.uri).toBe('test.ipynb.python-text.txt');
       });
     });
@@ -282,14 +282,14 @@ describe('@jupyterlab/lsp', () => {
       it('should emit the `foreignDocumentClosed` signal', () => {
         const cb = jest.fn();
         document.foreignDocumentClosed.connect(cb);
-        const md: VirtualDocument = document['chooseForeignDocument'](
+        const md: VirtualDocument = document['_chooseForeignDocument'](
           markdownCellExtractor
         );
         document.closeForeign(md);
         expect(cb).toHaveBeenCalled();
       });
       it('should close correctly foreign documents', () => {
-        const md: VirtualDocument = document['chooseForeignDocument'](
+        const md: VirtualDocument = document['_chooseForeignDocument'](
           markdownCellExtractor
         );
         md.closeAllForeignDocuments = jest.fn();
@@ -312,7 +312,7 @@ describe('@jupyterlab/lsp', () => {
         );
       });
       it('should get the markdown content of the document', () => {
-        const md = document['chooseForeignDocument'](markdownCellExtractor);
+        const md = document['_chooseForeignDocument'](markdownCellExtractor);
 
         expect(md.value).toContain(
           'test line in markdown 1\ntest line in markdown 2'