@jupyterlab/fileeditor 4.0.0-alpha.1 → 4.0.0-alpha.12

package/lib/fileeditorlspadapter.d.ts

@@ -0,0 +1,90 @@
+import { CodeEditor } from '@jupyterlab/codeeditor';
+import { CodeMirrorEditor } from '@jupyterlab/codemirror';
+import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
+import { IAdapterOptions, IVirtualPosition, VirtualDocument, WidgetLSPAdapter } from '@jupyterlab/lsp';
+import { FileEditor } from './widget';
+export interface IFileEditorAdapterOptions extends IAdapterOptions {
+    /**
+     * The document registry instance.
+     */
+    docRegistry: DocumentRegistry;
+}
+export declare class FileEditorAdapter extends WidgetLSPAdapter<IDocumentWidget<FileEditor>> {
+    constructor(editorWidget: IDocumentWidget<FileEditor>, options: IFileEditorAdapterOptions);
+    /**
+     * The wrapped `FileEditor` widget.
+     */
+    readonly editor: FileEditor;
+    /**
+     * Get current path of the document.
+     */
+    get documentPath(): string;
+    /**
+     * Get the mime type of the document.
+     */
+    get mimeType(): string;
+    /**
+     * Get the file extension of the document.
+     */
+    get languageFileExtension(): string;
+    /**
+     * Get the CM editor
+     */
+    get ceEditor(): CodeMirrorEditor;
+    /**
+     * Get the activated CM editor.
+     */
+    get activeEditor(): CodeEditor.IEditor;
+    /**
+     * Get the inner HTMLElement of the document widget.
+     */
+    get wrapperElement(): HTMLElement;
+    /**
+     * Get current path of the document.
+     */
+    get path(): string;
+    /**
+     *  Get the list of CM editors in the document, there is only one editor
+     * in the case of file editor.
+     */
+    get editors(): {
+        ceEditor: CodeEditor.IEditor;
+        type: string;
+    }[];
+    /**
+     * Generate the virtual document associated with the document.
+     */
+    createVirtualDocument(): VirtualDocument;
+    /**
+     * Get the index of editor from the cursor position in the virtual
+     * document. Since there is only one editor, this method always return
+     * 0
+     *
+     * @param position - the position of cursor in the virtual document.
+     * @return  {number} - index of the virtual editor
+     */
+    getEditorIndexAt(position: IVirtualPosition): number;
+    /**
+     * Get the index of input editor
+     *
+     * @param ceEditor - instance of the code editor
+     */
+    getEditorIndex(ceEditor: CodeEditor.IEditor): number;
+    /**
+     * Get the wrapper of input editor.
+     *
+     * @param ceEditor
+     * @return  {HTMLElement}
+     */
+    getEditorWrapper(ceEditor: CodeEditor.IEditor): HTMLElement;
+    /**
+     * Initialization function called once the editor and the LSP connection
+     * manager is ready. This function will create the virtual document and
+     * connect various signals.
+     */
+    protected initOnceReady(): Promise<void>;
+    /**
+     * The document registry instance.
+     */
+    private readonly _docRegistry;
+}

package/lib/fileeditorlspadapter.js

@@ -0,0 +1,154 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { VirtualDocument, WidgetLSPAdapter } from '@jupyterlab/lsp';
+export class FileEditorAdapter extends WidgetLSPAdapter {
+    constructor(editorWidget, options) {
+        const { docRegistry } = options, others = __rest(options, ["docRegistry"]);
+        super(editorWidget, others);
+        this.editor = editorWidget.content;
+        this._docRegistry = docRegistry;
+        this.ready = new Promise((resolve, reject) => {
+            this.initOnceReady().then(resolve).catch(reject);
+        });
+        // Dispose the adapter when the editor is disposed.
+        editorWidget.disposed.connect(() => this.dispose());
+    }
+    /**
+     * Get current path of the document.
+     */
+    get documentPath() {
+        return this.widget.context.path;
+    }
+    /**
+     * Get the mime type of the document.
+     */
+    get mimeType() {
+        const codeMirrorMimeType = this.editor.model.mimeType;
+        const contentsModel = this.editor.context.contentsModel;
+        // when MIME type is not known it defaults to 'text/plain',
+        // so if it is different we can accept it as it is
+        if (codeMirrorMimeType != 'text/plain') {
+            return codeMirrorMimeType;
+        }
+        else if (contentsModel) {
+            // a script that does not have a MIME type known by the editor
+            // (no syntax highlight mode), can still be known by the document
+            // registry (and this is arguably easier to extend).
+            let fileType = this._docRegistry.getFileTypeForModel(contentsModel);
+            return fileType.mimeTypes[0];
+        }
+        else {
+            // "text/plain" this is
+            return codeMirrorMimeType;
+        }
+    }
+    /**
+     * Get the file extension of the document.
+     */
+    get languageFileExtension() {
+        let parts = this.documentPath.split('.');
+        return parts[parts.length - 1];
+    }
+    /**
+     * Get the CM editor
+     */
+    get ceEditor() {
+        return this.editor.editor;
+    }
+    /**
+     * Get the activated CM editor.
+     */
+    get activeEditor() {
+        return this.editor.editor;
+    }
+    /**
+     * Get the inner HTMLElement of the document widget.
+     */
+    get wrapperElement() {
+        return this.widget.node;
+    }
+    /**
+     * Get current path of the document.
+     */
+    get path() {
+        return this.widget.context.path;
+    }
+    /**
+     *  Get the list of CM editors in the document, there is only one editor
+     * in the case of file editor.
+     */
+    get editors() {
+        return [{ ceEditor: this.editor.editor, type: 'code' }];
+    }
+    /**
+     * Generate the virtual document associated with the document.
+     */
+    createVirtualDocument() {
+        return new VirtualDocument({
+            language: this.language,
+            foreignCodeExtractors: this.options.foreignCodeExtractorsManager,
+            path: this.documentPath,
+            fileExtension: this.languageFileExtension,
+            // notebooks are continuous, each cell is dependent on the previous one
+            standalone: true,
+            // notebooks are not supported by LSP servers
+            hasLspSupportedFile: true
+        });
+    }
+    /**
+     * Get the index of editor from the cursor position in the virtual
+     * document. Since there is only one editor, this method always return
+     * 0
+     *
+     * @param position - the position of cursor in the virtual document.
+     * @return  {number} - index of the virtual editor
+     */
+    getEditorIndexAt(position) {
+        return 0;
+    }
+    /**
+     * Get the index of input editor
+     *
+     * @param ceEditor - instance of the code editor
+     */
+    getEditorIndex(ceEditor) {
+        return 0;
+    }
+    /**
+     * Get the wrapper of input editor.
+     *
+     * @param ceEditor
+     * @return  {HTMLElement}
+     */
+    getEditorWrapper(ceEditor) {
+        return this.wrapperElement;
+    }
+    /**
+     * Initialization function called once the editor and the LSP connection
+     * manager is ready. This function will create the virtual document and
+     * connect various signals.
+     */
+    async initOnceReady() {
+        if (!this.editor.context.isReady) {
+            await this.editor.context.ready;
+        }
+        await this.connectionManager.ready;
+        this.initVirtual();
+        // connect the document, but do not open it as the adapter will handle this
+        // after registering all features
+        this.connectDocument(this.virtualDocument, false).catch(console.warn);
+        this.editor.model.mimeTypeChanged.connect(this.reloadConnection, this);
+    }
+}
+//# sourceMappingURL=fileeditorlspadapter.js.map

package/lib/fileeditorlspadapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileeditorlspadapter.js","sourceRoot":"","sources":["../src/fileeditorlspadapter.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;;;;;;;;;;;;AAK3D,OAAO,EAGL,eAAe,EACf,gBAAgB,EACjB,MAAM,iBAAiB,CAAC;AAWzB,MAAM,OAAO,iBAAkB,SAAQ,gBAEtC;IACC,YACE,YAAyC,EACzC,OAAkC;QAElC,MAAM,EAAE,WAAW,KAAgB,OAAO,EAAlB,MAAM,UAAK,OAAO,EAApC,eAA0B,CAAU,CAAC;QAC3C,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACjD,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,mDAAmD;QACnD,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IAOD;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;QACtD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC;QAExD,2DAA2D;QAC3D,kDAAkD;QAClD,IAAI,kBAAkB,IAAI,YAAY,EAAE;YACtC,OAAO,kBAAkB,CAAC;SAC3B;aAAM,IAAI,aAAa,EAAE;YACxB,8DAA8D;YAC9D,iEAAiE;YACjE,oDAAoD;YACpD,IAAI,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;YACpE,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC9B;aAAM;YACL,uBAAuB;YACvB,OAAO,kBAAkB,CAAC;SAC3B;IACH,CAAC;IAED;;OAEG;IACH,IAAI,qBAAqB;QACvB,IAAI,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,MAA0B,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,eAAe,CAAC;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,qBAAqB,EAAE,IAAI,CAAC,OAAO,CAAC,4BAA4B;YAChE,IAAI,EAAE,IAAI,CAAC,YAAY;YACvB,aAAa,EAAE,IAAI,CAAC,qBAAqB;YACzC,uEAAuE;YACvE,UAAU,EAAE,IAAI;YAChB,6CAA6C;YAC7C,mBAAmB,EAAE,IAAI;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,QAA0B;QACzC,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,QAA4B;QACzC,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,QAA4B;QAC3C,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,aAAa;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SACjC;QACD,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;QACnC,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,2EAA2E;QAC3E,iCAAiC;QACjC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACzE,CAAC;CAMF"}

package/lib/index.d.ts

@@ -2,6 +2,9 @@
  * @packageDocumentation
  * @module fileeditor
  */
+export * from './fileeditorlspadapter';
+export * from './searchprovider';
 export * from './tabspacestatus';
+export * from './toc';
 export * from './tokens';
 export * from './widget';

package/lib/index.js

@@ -4,7 +4,10 @@
  * @packageDocumentation
  * @module fileeditor
  */
+export * from './fileeditorlspadapter';
+export * from './searchprovider';
 export * from './tabspacestatus';
+export * from './toc';
 export * from './tokens';
 export * from './widget';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

package/lib/searchprovider.d.ts

@@ -0,0 +1,44 @@
+import { MainAreaWidget } from '@jupyterlab/apputils';
+import { CodeMirrorSearchProvider } from '@jupyterlab/codemirror';
+import { ISearchProvider } from '@jupyterlab/documentsearch';
+import { ITranslator } from '@jupyterlab/translation';
+import { Widget } from '@lumino/widgets';
+import { FileEditor } from './widget';
+/**
+ * Helper type
+ */
+export declare type FileEditorPanel = MainAreaWidget<FileEditor>;
+/**
+ * File editor search provider
+ */
+export declare class FileEditorSearchProvider extends CodeMirrorSearchProvider implements ISearchProvider {
+    /**
+     * Constructor
+     * @param widget File editor panel
+     */
+    constructor(widget: FileEditorPanel);
+    /**
+     * Instantiate a search provider for the widget.
+     *
+     * #### Notes
+     * The widget provided is always checked using `isApplicable` before calling
+     * this factory.
+     *
+     * @param widget The widget to search on
+     * @param translator [optional] The translator object
+     *
+     * @returns The search provider on the widget
+     */
+    static createNew(widget: FileEditorPanel, translator?: ITranslator): ISearchProvider;
+    /**
+     * Report whether or not this provider has the ability to search on the given object
+     */
+    static isApplicable(domain: Widget): domain is FileEditorPanel;
+    /**
+     * Get an initial query value if applicable so that it can be entered
+     * into the search box as an initial query
+     *
+     * @returns Initial value used to populate the search box.
+     */
+    getInitialQuery(): string;
+}

package/lib/searchprovider.js

@@ -0,0 +1,53 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { MainAreaWidget } from '@jupyterlab/apputils';
+import { CodeMirrorEditor, CodeMirrorSearchProvider } from '@jupyterlab/codemirror';
+import { FileEditor } from './widget';
+/**
+ * File editor search provider
+ */
+export class FileEditorSearchProvider extends CodeMirrorSearchProvider {
+    /**
+     * Constructor
+     * @param widget File editor panel
+     */
+    constructor(widget) {
+        super(widget.content.editor);
+    }
+    /**
+     * Instantiate a search provider for the widget.
+     *
+     * #### Notes
+     * The widget provided is always checked using `isApplicable` before calling
+     * this factory.
+     *
+     * @param widget The widget to search on
+     * @param translator [optional] The translator object
+     *
+     * @returns The search provider on the widget
+     */
+    static createNew(widget, translator) {
+        return new FileEditorSearchProvider(widget);
+    }
+    /**
+     * Report whether or not this provider has the ability to search on the given object
+     */
+    static isApplicable(domain) {
+        return (domain instanceof MainAreaWidget &&
+            domain.content instanceof FileEditor &&
+            domain.content.editor instanceof CodeMirrorEditor);
+    }
+    /**
+     * Get an initial query value if applicable so that it can be entered
+     * into the search box as an initial query
+     *
+     * @returns Initial value used to populate the search box.
+     */
+    getInitialQuery() {
+        const cm = this.editor;
+        const selection = cm.state.sliceDoc(cm.state.selection.main.from, cm.state.selection.main.to);
+        // if there are newlines, just return empty string
+        return selection.search(/\r?\n|\r/g) === -1 ? selection : '';
+    }
+}
+//# sourceMappingURL=searchprovider.js.map

package/lib/searchprovider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchprovider.js","sourceRoot":"","sources":["../src/searchprovider.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EACL,gBAAgB,EAChB,wBAAwB,EACzB,MAAM,wBAAwB,CAAC;AAIhC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAOtC;;GAEG;AACH,MAAM,OAAO,wBACX,SAAQ,wBAAwB;IAGhC;;;OAGG;IACH,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,MAA0B,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,CACd,MAAuB,EACvB,UAAwB;QAExB,OAAO,IAAI,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,MAAc;QAChC,OAAO,CACL,MAAM,YAAY,cAAc;YAChC,MAAM,CAAC,OAAO,YAAY,UAAU;YACpC,MAAM,CAAC,OAAO,CAAC,MAAM,YAAY,gBAAgB,CAClD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,eAAe;QACb,MAAM,EAAE,GAAG,IAAI,CAAC,MAA0B,CAAC;QAC3C,MAAM,SAAS,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,CACjC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAC5B,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAC3B,CAAC;QACF,kDAAkD;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,CAAC;CACF"}

package/lib/toc/factory.d.ts

@@ -0,0 +1,25 @@
+import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
+import { TableOfContents, TableOfContentsFactory, TableOfContentsModel } from '@jupyterlab/toc';
+import { FileEditor } from '../widget';
+/**
+ * Interface describing a file editor heading.
+ */
+export interface IEditorHeading extends TableOfContents.IHeading {
+    /**
+     * Heading line number.
+     */
+    line: number;
+}
+/**
+ * Base table of contents model factory for file editor
+ */
+export declare abstract class EditorTableOfContentsFactory extends TableOfContentsFactory<IDocumentWidget<FileEditor>> {
+    /**
+     * Create a new table of contents model for the widget
+     *
+     * @param widget - widget
+     * @param configuration - Table of contents configuration
+     * @returns The table of contents model
+     */
+    createNew(widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>, configuration?: TableOfContents.IConfig): TableOfContentsModel<IEditorHeading, IDocumentWidget<FileEditor, DocumentRegistry.IModel>>;
+}

package/lib/toc/factory.js

@@ -0,0 +1,32 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { TableOfContentsFactory } from '@jupyterlab/toc';
+/**
+ * Base table of contents model factory for file editor
+ */
+export class EditorTableOfContentsFactory extends TableOfContentsFactory {
+    /**
+     * Create a new table of contents model for the widget
+     *
+     * @param widget - widget
+     * @param configuration - Table of contents configuration
+     * @returns The table of contents model
+     */
+    createNew(widget, configuration) {
+        const model = super.createNew(widget, configuration);
+        const onActiveHeadingChanged = (model, heading) => {
+            if (heading) {
+                widget.content.editor.setCursorPosition({
+                    line: heading.line,
+                    column: 0
+                });
+            }
+        };
+        model.activeHeadingChanged.connect(onActiveHeadingChanged);
+        widget.disposed.connect(() => {
+            model.activeHeadingChanged.disconnect(onActiveHeadingChanged);
+        });
+        return model;
+    }
+}
+//# sourceMappingURL=factory.js.map

package/lib/toc/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/toc/factory.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAG3D,OAAO,EAEL,sBAAsB,EAEvB,MAAM,iBAAiB,CAAC;AAazB;;GAEG;AACH,MAAM,OAAgB,4BAA6B,SAAQ,sBAE1D;IACC;;;;;;OAMG;IACH,SAAS,CACP,MAA4D,EAC5D,aAAuC;QAKvC,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAC3B,MAAM,EACN,aAAa,CAId,CAAC;QAEF,MAAM,sBAAsB,GAAG,CAC7B,KAGC,EACD,OAA8B,EAC9B,EAAE;YACF,IAAI,OAAO,EAAE;gBACX,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;oBACtC,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,MAAM,EAAE,CAAC;iBACV,CAAC,CAAC;aACJ;QACH,CAAC,CAAC;QAEF,KAAK,CAAC,oBAAoB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC3D,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE;YAC3B,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/lib/toc/index.d.ts

@@ -0,0 +1,4 @@
+export * from './factory';
+export * from './latex';
+export * from './markdown';
+export * from './python';

package/lib/toc/index.js

@@ -0,0 +1,7 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export * from './factory';
+export * from './latex';
+export * from './markdown';
+export * from './python';
+//# sourceMappingURL=index.js.map

package/lib/toc/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/toc/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}

package/lib/toc/latex.d.ts

@@ -0,0 +1,48 @@
+import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
+import { TableOfContents, TableOfContentsModel } from '@jupyterlab/toc';
+import { Widget } from '@lumino/widgets';
+import { FileEditor } from '../widget';
+import { EditorTableOfContentsFactory, IEditorHeading } from './factory';
+/**
+ * Table of content model for LaTeX files.
+ */
+export declare class LaTeXTableOfContentsModel extends TableOfContentsModel<IEditorHeading, IDocumentWidget<FileEditor, DocumentRegistry.IModel>> {
+    /**
+     * Type of document supported by the model.
+     *
+     * #### Notes
+     * A `data-document-type` attribute with this value will be set
+     * on the tree view `.jp-TableOfContents-content[data-document-type="..."]`
+     */
+    get documentType(): string;
+    /**
+     * List of configuration options supported by the model.
+     */
+    get supportedOptions(): (keyof TableOfContents.IConfig)[];
+    /**
+     * Produce the headings for a document.
+     *
+     * @returns The list of new headings or `null` if nothing needs to be updated.
+     */
+    protected getHeadings(): Promise<IEditorHeading[] | null>;
+}
+/**
+ * Table of content model factory for LaTeX files.
+ */
+export declare class LaTeXTableOfContentsFactory extends EditorTableOfContentsFactory {
+    /**
+     * Whether the factory can handle the widget or not.
+     *
+     * @param widget - widget
+     * @returns boolean indicating a ToC can be generated
+     */
+    isApplicable(widget: Widget): boolean;
+    /**
+     * Create a new table of contents model for the widget
+     *
+     * @param widget - widget
+     * @param configuration - Table of contents configuration
+     * @returns The table of contents model
+     */
+    protected _createNew(widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>, configuration?: TableOfContents.IConfig): LaTeXTableOfContentsModel;
+}

package/lib/toc/latex.js

@@ -0,0 +1,112 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { TableOfContentsModel, TableOfContentsUtils } from '@jupyterlab/toc';
+import { EditorTableOfContentsFactory } from './factory';
+/**
+ * Maps LaTeX section headings to HTML header levels.
+ *
+ * ## Notes
+ *
+ * -   As `part` and `chapter` section headings appear to be less common, assign them to heading level 1.
+ *
+ * @private
+ */
+const LATEX_LEVELS = {
+    part: 1,
+    chapter: 1,
+    section: 1,
+    subsection: 2,
+    subsubsection: 3,
+    paragraph: 4,
+    subparagraph: 5
+};
+/**
+ * Regular expression to create the outline
+ */
+const SECTIONS = /^\s*\\(section|subsection|subsubsection){(.+)}/;
+/**
+ * Table of content model for LaTeX files.
+ */
+export class LaTeXTableOfContentsModel extends TableOfContentsModel {
+    /**
+     * Type of document supported by the model.
+     *
+     * #### Notes
+     * A `data-document-type` attribute with this value will be set
+     * on the tree view `.jp-TableOfContents-content[data-document-type="..."]`
+     */
+    get documentType() {
+        return 'latex';
+    }
+    /**
+     * List of configuration options supported by the model.
+     */
+    get supportedOptions() {
+        return ['maximalDepth', 'numberHeaders'];
+    }
+    /**
+     * Produce the headings for a document.
+     *
+     * @returns The list of new headings or `null` if nothing needs to be updated.
+     */
+    getHeadings() {
+        if (!this.isActive) {
+            return Promise.resolve(null);
+        }
+        // Split the text into lines:
+        const lines = this.widget.content.model.value.text.split('\n');
+        const levels = new Array();
+        let previousLevel = levels.length;
+        const headings = new Array();
+        for (let i = 0; i < lines.length; i++) {
+            const match = lines[i].match(SECTIONS);
+            if (match) {
+                const level = LATEX_LEVELS[match[1]];
+                if (level <= this.configuration.maximalDepth) {
+                    const prefix = TableOfContentsUtils.getPrefix(level, previousLevel, levels, Object.assign(Object.assign({}, this.configuration), { 
+                        // Force base numbering and numbering first level
+                        baseNumbering: 1, numberingH1: true }));
+                    previousLevel = level;
+                    headings.push({
+                        text: match[2],
+                        prefix: prefix,
+                        level,
+                        line: i
+                    });
+                }
+            }
+        }
+        return Promise.resolve(headings);
+    }
+}
+/**
+ * Table of content model factory for LaTeX files.
+ */
+export class LaTeXTableOfContentsFactory extends EditorTableOfContentsFactory {
+    /**
+     * Whether the factory can handle the widget or not.
+     *
+     * @param widget - widget
+     * @returns boolean indicating a ToC can be generated
+     */
+    isApplicable(widget) {
+        var _a, _b;
+        const isApplicable = super.isApplicable(widget);
+        if (isApplicable) {
+            let mime = (_b = (_a = widget.content) === null || _a === void 0 ? void 0 : _a.model) === null || _b === void 0 ? void 0 : _b.mimeType;
+            return mime && (mime === 'text/x-latex' || mime === 'text/x-stex');
+        }
+        return false;
+    }
+    /**
+     * Create a new table of contents model for the widget
+     *
+     * @param widget - widget
+     * @param configuration - Table of contents configuration
+     * @returns The table of contents model
+     */
+    _createNew(widget, configuration) {
+        return new LaTeXTableOfContentsModel(widget, configuration);
+    }
+}
+//# sourceMappingURL=latex.js.map

package/lib/toc/latex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"latex.js","sourceRoot":"","sources":["../../src/toc/latex.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAG3D,OAAO,EAEL,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,4BAA4B,EAAkB,MAAM,WAAW,CAAC;AAEzE;;;;;;;;GAQG;AACH,MAAM,YAAY,GAAgC;IAChD,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;IAChB,SAAS,EAAE,CAAC;IACZ,YAAY,EAAE,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,QAAQ,GAAG,gDAAgD,CAAC;AAElE;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,oBAG9C;IACC;;;;;;OAMG;IACH,IAAI,YAAY;QACd,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAClB,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACO,WAAW;QACnB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC9B;QAED,6BAA6B;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CACtD,IAAI,CACY,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAU,CAAC;QACnC,IAAI,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAkB,CAAC;QAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACvC,IAAI,KAAK,EAAE;gBACT,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACrC,IAAI,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;oBAC5C,MAAM,MAAM,GAAG,oBAAoB,CAAC,SAAS,CAC3C,KAAK,EACL,aAAa,EACb,MAAM,kCAED,IAAI,CAAC,aAAa;wBACrB,iDAAiD;wBACjD,aAAa,EAAE,CAAC,EAChB,WAAW,EAAE,IAAI,IAEpB,CAAC;oBACF,aAAa,GAAG,KAAK,CAAC;oBAEtB,QAAQ,CAAC,IAAI,CAAC;wBACZ,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;wBACd,MAAM,EAAE,MAAM;wBACd,KAAK;wBACL,IAAI,EAAE,CAAC;qBACR,CAAC,CAAC;iBACJ;aACF;SACF;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,4BAA4B;IAC3E;;;;;OAKG;IACH,YAAY,CAAC,MAAc;;QACzB,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAEhD,IAAI,YAAY,EAAE;YAChB,IAAI,IAAI,GAAG,MAAA,MAAC,MAAc,CAAC,OAAO,0CAAE,KAAK,0CAAE,QAAQ,CAAC;YACpD,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,IAAI,IAAI,KAAK,aAAa,CAAC,CAAC;SACpE;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACO,UAAU,CAClB,MAA4D,EAC5D,aAAuC;QAEvC,OAAO,IAAI,yBAAyB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC9D,CAAC;CACF"}