Add ILSPCodeExtractorsManager token

Author: krassowski

packages/jupyterlab-lsp/src/adapters/adapter.ts

@@ -124,6 +124,10 @@ export abstract class WidgetAdapter<T extends IDocumentWidget> {
     this.widget.disposed.connect(this.dispose, this);
   }
 
+  protected get foreign_code_extractors() {
+    return this.extension.foreign_code_extractors;
+  }
+
   on_connection_closed(
     manager: DocumentConnectionManager,
     { virtual_document }: IDocumentConnectionData

packages/jupyterlab-lsp/src/adapters/notebook/notebook.ts

@@ -2,7 +2,6 @@ import { WidgetAdapter } from '../adapter';
 import { Notebook, NotebookPanel } from '@jupyterlab/notebook';
 import { until_ready } from '../../utils';
 import { language_specific_overrides } from '../../magics/defaults';
-import { foreign_code_extractors } from '../../extractors/defaults';
 import { Cell } from '@jupyterlab/cells';
 import * as nbformat from '@jupyterlab/nbformat';
 import ILanguageInfoMetadata = nbformat.ILanguageInfoMetadata;
@@ -162,7 +161,7 @@ export class NotebookAdapter extends WidgetAdapter<NotebookPanel> {
       language: this.language,
       path: this.document_path,
       overrides_registry: language_specific_overrides,
-      foreign_code_extractors: foreign_code_extractors,
+      foreign_code_extractors: this.foreign_code_extractors,
       file_extension: this.language_file_extension,
       // notebooks are continuous, each cell is dependent on the previous one
       standalone: false,

packages/jupyterlab-lsp/src/editor_integration/testutils.ts

@@ -44,6 +44,8 @@ import { ServiceManager } from '@jupyterlab/services';
 import { FeatureManager, ILSPExtension } from '../index';
 import { JupyterFrontEnd } from '@jupyterlab/application';
 import { IFeatureSettings } from '../feature';
+import { IForeignCodeExtractorsRegistry } from "../extractors/types";
+import { foreign_code_extractors } from "../extractors/defaults";
 
 export interface ITestEnvironment {
   document_options: VirtualDocument.IOptions;
@@ -88,6 +90,7 @@ export class MockExtension implements ILSPExtension {
   language_server_manager: LanguageServerManager;
   feature_manager: ILSPFeatureManager;
   editor_type_manager: ILSPVirtualEditorManager;
+  foreign_code_extractors: IForeignCodeExtractorsRegistry;
 
   constructor() {
     this.app = null;
@@ -102,6 +105,7 @@ export class MockExtension implements ILSPExtension {
       name: 'CodeMirrorEditor',
       supports: CodeMirrorEditor
     });
+    this.foreign_code_extractors = foreign_code_extractors;
   }
 }
 

packages/jupyterlab-lsp/src/extractors/defaults.ts

@@ -5,6 +5,8 @@ import {
   rpy2_args_pattern,
   RPY2_MAX_ARGS
 } from '../magics/rpy2';
+import { JupyterFrontEndPlugin } from "@jupyterlab/application";
+import { ILSPCodeExtractorsManager, PLUGIN_ID } from "../tokens";
 
 function rpy2_code_extractor(match: string, ...args: string[]) {
   let r = extract_r_args(args, -3);
@@ -123,3 +125,16 @@ export let foreign_code_extractors: IForeignCodeExtractorsRegistry = {
     })
   ]
 };
+
+export const DEFAULT_CODE_EXTRACTORS: JupyterFrontEndPlugin<void> = {
+  id: PLUGIN_ID + ':default-extractors',
+  requires: [ILSPCodeExtractorsManager],
+  activate: (app, extractors_manager: ILSPCodeExtractorsManager) => {
+    for (let language of Object.keys(foreign_code_extractors)) {
+      for (let extractor of foreign_code_extractors[language]) {
+        extractors_manager.register(extractor, language);
+      }
+    }
+  },
+  autoStart: true
+};

packages/jupyterlab-lsp/src/extractors/manger.ts

@@ -0,0 +1,29 @@
+import { JupyterFrontEndPlugin } from "@jupyterlab/application";
+import { ILSPCodeExtractorsManager } from "../tokens";
+import { IForeignCodeExtractor, IForeignCodeExtractorsRegistry } from "./types";
+
+export class CodeExtractorsManager implements ILSPCodeExtractorsManager {
+  registry: IForeignCodeExtractorsRegistry;
+
+  constructor() {
+    this.registry = {};
+  }
+
+  register(extractor: IForeignCodeExtractor, host_language: string): void {
+    if (!this.registry.hasOwnProperty(host_language)) {
+      this.registry[host_language] = [];
+    }
+    this.registry[host_language].push(extractor)
+  }
+
+}
+
+export const CODE_EXTRACTORS_MANAGER: JupyterFrontEndPlugin<ILSPCodeExtractorsManager> = {
+  id: ILSPCodeExtractorsManager.name,
+  requires: [],
+  activate: (app) => {
+    return new CodeExtractorsManager();
+  },
+  provides: ILSPCodeExtractorsManager,
+  autoStart: true
+};

packages/jupyterlab-lsp/src/extractors/types.ts

@@ -40,7 +40,7 @@ export interface IExtractedCode {
  */
 export interface IForeignCodeExtractor {
   /**
-   * The foreign language.
+   * The foreign language. TODO what is language, what is host language, ILanguageInfo
    */
   language: string;
 

packages/jupyterlab-lsp/src/index.ts

@@ -13,7 +13,7 @@ import { IStatusBar } from '@jupyterlab/statusbar';
 import { LSPStatus } from './components/statusbar';
 import { DocumentConnectionManager } from './connection_manager';
 import {
-  ILSPAdapterManager,
+  ILSPAdapterManager, ILSPCodeExtractorsManager,
   ILSPFeatureManager,
   ILSPVirtualEditorManager,
   PLUGIN_ID,
@@ -35,6 +35,8 @@ import { LabIcon } from '@jupyterlab/ui-components';
 import codeCheckSvg from '../style/icons/code-check.svg';
 import { DIAGNOSTICS_PLUGIN } from './features/diagnostics';
 import { COMPLETION_PLUGIN } from './features/completion';
+import { CODE_EXTRACTORS_MANAGER } from "./extractors/manger";
+import { IForeignCodeExtractorsRegistry } from "./extractors/types";
 
 export const codeCheckIcon = new LabIcon({
   name: 'lsp:codeCheck',
@@ -98,6 +100,7 @@ export interface ILSPExtension {
   language_server_manager: LanguageServerManager;
   feature_manager: ILSPFeatureManager;
   editor_type_manager: ILSPVirtualEditorManager;
+  foreign_code_extractors: IForeignCodeExtractorsRegistry;
 }
 
 export class LSPExtension implements ILSPExtension {
@@ -113,7 +116,8 @@ export class LSPExtension implements ILSPExtension {
     paths: IPaths,
     status_bar: IStatusBar,
     adapterManager: ILSPAdapterManager,
-    public editor_type_manager: ILSPVirtualEditorManager
+    public editor_type_manager: ILSPVirtualEditorManager,
+    private code_extractors_manager: ILSPCodeExtractorsManager
   ) {
     this.language_server_manager = new LanguageServerManager({});
     this.connection_manager = new DocumentConnectionManager({
@@ -165,6 +169,10 @@ export class LSPExtension implements ILSPExtension {
     });
   }
 
+  get foreign_code_extractors () {
+    return this.code_extractors_manager.registry;
+  }
+
   private updateOptions(settings: ISettingRegistry.ISettings) {
     const options = settings.composite;
 
@@ -186,7 +194,8 @@ const plugin: JupyterFrontEndPlugin<ILSPFeatureManager> = {
     IPaths,
     IStatusBar,
     ILSPAdapterManager,
-    ILSPVirtualEditorManager
+    ILSPVirtualEditorManager,
+    ILSPCodeExtractorsManager
   ],
   activate: (app, ...args) => {
     let extension = new LSPExtension(
@@ -198,7 +207,8 @@ const plugin: JupyterFrontEndPlugin<ILSPFeatureManager> = {
         IPaths,
         IStatusBar,
         ILSPAdapterManager,
-        ILSPVirtualEditorManager
+        ILSPVirtualEditorManager,
+        ILSPCodeExtractorsManager
       ])
     );
     return extension.feature_manager;
@@ -218,6 +228,7 @@ const default_features: JupyterFrontEndPlugin<void>[] = [
 ];
 
 const plugins: JupyterFrontEndPlugin<any>[] = [
+  CODE_EXTRACTORS_MANAGER,
   WIDGET_ADAPTER_MANAGER,
   NOTEBOOK_ADAPTER,
   FILE_EDITOR_ADAPTER,

packages/jupyterlab-lsp/src/tokens.ts

@@ -17,6 +17,7 @@ import {
   IContextMenuOptions
 } from './command_manager';
 import IEditor = CodeEditor.IEditor;
+import { IForeignCodeExtractor, IForeignCodeExtractorsRegistry } from "./extractors/types";
 
 export type TLanguageServerId = string;
 export type TLanguageId = string;
@@ -157,6 +158,22 @@ export interface ILSPVirtualEditorManager {
   ): IVirtualEditorType<any>;
 }
 
+
+/**
+ * Manages code transclusion plugins.
+ */
+export interface ILSPCodeExtractorsManager {
+  /**
+   * Global registry of the foreign code extractors.
+   */
+  registry: IForeignCodeExtractorsRegistry;
+
+  /**
+   * Register the extraction rules to be applied in documents with language `host_language`.
+   */
+  register(extractor: IForeignCodeExtractor, host_language: string): void
+}
+
 export const PLUGIN_ID = '@krassowski/jupyterlab-lsp';
 
 export const ILSPFeatureManager = new Token<ILSPFeatureManager>(
@@ -170,3 +187,7 @@ export const ILSPAdapterManager = new Token<ILSPAdapterManager>(
 export const ILSPVirtualEditorManager = new Token<ILSPVirtualEditorManager>(
   PLUGIN_ID + ':ILSPVirtualEditorManager'
 );
+
+export const ILSPCodeExtractorsManager = new Token<ILSPCodeExtractorsManager>(
+  PLUGIN_ID + ':ILSPCodeExtractorsManager'
+);