@theia/notebook 1.53.0-next.4 → 1.53.0-next.55

package/src/browser/service/notebook-options.ts

@@ -1,154 +1,155 @@
-
-// *****************************************************************************
-// Copyright (C) 2024 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
-import { PreferenceService } from '@theia/core/lib/browser';
-import { Emitter } from '@theia/core';
-import { NotebookPreferences, notebookPreferenceSchema } from '../contributions/notebook-preferences';
-import { EditorPreferences } from '@theia/editor/lib/browser';
-import { BareFontInfo } from '@theia/monaco-editor-core/esm/vs/editor/common/config/fontInfo';
-import { PixelRatio } from '@theia/monaco-editor-core/esm/vs/base/browser/browser';
-
-const notebookOutputOptionsRelevantPreferences = [
-    'editor.fontSize',
-    'editor.fontFamily',
-    NotebookPreferences.NOTEBOOK_LINE_NUMBERS,
-    NotebookPreferences.OUTPUT_LINE_HEIGHT,
-    NotebookPreferences.OUTPUT_FONT_SIZE,
-    NotebookPreferences.OUTPUT_FONT_FAMILY,
-    NotebookPreferences.OUTPUT_SCROLLING,
-    NotebookPreferences.OUTPUT_WORD_WRAP,
-    NotebookPreferences.OUTPUT_LINE_LIMIT
-];
-
-export interface NotebookOutputOptions {
-    // readonly outputNodePadding: number;
-    // readonly outputNodeLeftPadding: number;
-    // readonly previewNodePadding: number;
-    // readonly markdownLeftMargin: number;
-    // readonly leftMargin: number;
-    // readonly rightMargin: number;
-    // readonly runGutter: number;
-    // readonly dragAndDropEnabled: boolean;
-    readonly fontSize: number;
-    readonly outputFontSize?: number;
-    readonly fontFamily: string;
-    readonly outputFontFamily?: string;
-    // readonly markupFontSize: number;
-    // readonly markdownLineHeight: number;
-    readonly outputLineHeight: number;
-    readonly outputScrolling: boolean;
-    readonly outputWordWrap: boolean;
-    readonly outputLineLimit: number;
-    // readonly outputLinkifyFilePaths: boolean;
-    // readonly minimalError: boolean;
-
-}
-
-@injectable()
-export class NotebookOptionsService {
-
-    @inject(PreferenceService)
-    protected readonly preferenceService: PreferenceService;
-
-    @inject(EditorPreferences)
-    protected readonly editorPreferences: EditorPreferences;
-
-    protected outputOptionsChangedEmitter = new Emitter<NotebookOutputOptions>();
-    onDidChangeOutputOptions = this.outputOptionsChangedEmitter.event;
-
-    protected fontInfo?: BareFontInfo;
-    get editorFontInfo(): BareFontInfo {
-        return this.getOrCreateMonacoFontInfo();
-    }
-
-    @postConstruct()
-    protected init(): void {
-        this.preferenceService.onPreferencesChanged(async preferenceChanges => {
-            if (notebookOutputOptionsRelevantPreferences.some(p => p in preferenceChanges)) {
-                this.outputOptionsChangedEmitter.fire(this.computeOutputOptions());
-            }
-        });
-    }
-
-    computeOutputOptions(): NotebookOutputOptions {
-        const outputLineHeight = this.getNotebookPreferenceWithDefault<number>(NotebookPreferences.OUTPUT_LINE_HEIGHT);
-
-        const fontSize = this.preferenceService.get<number>('editor.fontSize')!;
-        const outputFontSize = this.getNotebookPreferenceWithDefault<number>(NotebookPreferences.OUTPUT_FONT_SIZE);
-
-        return {
-            fontSize,
-            outputFontSize: outputFontSize,
-            fontFamily: this.preferenceService.get<string>('editor.fontFamily')!,
-            outputFontFamily: this.getNotebookPreferenceWithDefault<string>(NotebookPreferences.OUTPUT_FONT_FAMILY),
-            outputLineHeight: this.computeOutputLineHeight(outputLineHeight, outputFontSize ?? fontSize),
-            outputScrolling: this.getNotebookPreferenceWithDefault<boolean>(NotebookPreferences.OUTPUT_SCROLLING)!,
-            outputWordWrap: this.getNotebookPreferenceWithDefault<boolean>(NotebookPreferences.OUTPUT_WORD_WRAP)!,
-            outputLineLimit: this.getNotebookPreferenceWithDefault<number>(NotebookPreferences.OUTPUT_LINE_LIMIT)!
-        };
-    }
-
-    protected getNotebookPreferenceWithDefault<T>(key: string): T {
-        return this.preferenceService.get<T>(key, notebookPreferenceSchema.properties?.[key]?.default as T);
-    }
-
-    protected computeOutputLineHeight(lineHeight: number, outputFontSize: number): number {
-        const minimumLineHeight = 9;
-
-        if (lineHeight === 0) {
-            // use editor line height
-            lineHeight = this.editorFontInfo.lineHeight;
-        } else if (lineHeight < minimumLineHeight) {
-            // Values too small to be line heights in pixels are in ems.
-            let fontSize = outputFontSize;
-            if (fontSize === 0) {
-                fontSize = this.preferenceService.get<number>('editor.fontSize')!;
-            }
-
-            lineHeight = lineHeight * fontSize;
-        }
-
-        // Enforce integer, minimum constraints
-        lineHeight = Math.round(lineHeight);
-        if (lineHeight < minimumLineHeight) {
-            lineHeight = minimumLineHeight;
-        }
-
-        return lineHeight;
-    }
-
-    protected getOrCreateMonacoFontInfo(): BareFontInfo {
-        if (!this.fontInfo) {
-            this.fontInfo = this.createFontInfo();
-            this.editorPreferences.onPreferenceChanged(e => this.fontInfo = this.createFontInfo());
-        }
-        return this.fontInfo;
-    }
-
-    protected createFontInfo(): BareFontInfo {
-        return BareFontInfo.createFromRawSettings({
-            fontFamily: this.editorPreferences['editor.fontFamily'],
-            fontWeight: String(this.editorPreferences['editor.fontWeight']),
-            fontSize: this.editorPreferences['editor.fontSize'],
-            fontLigatures: this.editorPreferences['editor.fontLigatures'],
-            lineHeight: this.editorPreferences['editor.lineHeight'],
-            letterSpacing: this.editorPreferences['editor.letterSpacing'],
-        }, PixelRatio.value);
-    }
-
-}
+
+// *****************************************************************************
+// Copyright (C) 2024 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
+import { PreferenceService } from '@theia/core/lib/browser';
+import { Emitter } from '@theia/core';
+import { NotebookPreferences, notebookPreferenceSchema } from '../contributions/notebook-preferences';
+import { EditorPreferences } from '@theia/editor/lib/browser';
+import { BareFontInfo } from '@theia/monaco-editor-core/esm/vs/editor/common/config/fontInfo';
+import { PixelRatio } from '@theia/monaco-editor-core/esm/vs/base/browser/browser';
+
+const notebookOutputOptionsRelevantPreferences = [
+    'editor.fontSize',
+    'editor.fontFamily',
+    NotebookPreferences.NOTEBOOK_LINE_NUMBERS,
+    NotebookPreferences.OUTPUT_LINE_HEIGHT,
+    NotebookPreferences.OUTPUT_FONT_SIZE,
+    NotebookPreferences.OUTPUT_FONT_FAMILY,
+    NotebookPreferences.OUTPUT_SCROLLING,
+    NotebookPreferences.OUTPUT_WORD_WRAP,
+    NotebookPreferences.OUTPUT_LINE_LIMIT
+];
+
+export interface NotebookOutputOptions {
+    // readonly outputNodePadding: number;
+    readonly outputNodeLeftPadding: number;
+    // readonly previewNodePadding: number;
+    // readonly markdownLeftMargin: number;
+    // readonly leftMargin: number;
+    // readonly rightMargin: number;
+    // readonly runGutter: number;
+    // readonly dragAndDropEnabled: boolean;
+    readonly fontSize: number;
+    readonly outputFontSize?: number;
+    readonly fontFamily: string;
+    readonly outputFontFamily?: string;
+    // readonly markupFontSize: number;
+    // readonly markdownLineHeight: number;
+    readonly outputLineHeight: number;
+    readonly outputScrolling: boolean;
+    readonly outputWordWrap: boolean;
+    readonly outputLineLimit: number;
+    // readonly outputLinkifyFilePaths: boolean;
+    // readonly minimalError: boolean;
+
+}
+
+@injectable()
+export class NotebookOptionsService {
+
+    @inject(PreferenceService)
+    protected readonly preferenceService: PreferenceService;
+
+    @inject(EditorPreferences)
+    protected readonly editorPreferences: EditorPreferences;
+
+    protected outputOptionsChangedEmitter = new Emitter<NotebookOutputOptions>();
+    onDidChangeOutputOptions = this.outputOptionsChangedEmitter.event;
+
+    protected fontInfo?: BareFontInfo;
+    get editorFontInfo(): BareFontInfo {
+        return this.getOrCreateMonacoFontInfo();
+    }
+
+    @postConstruct()
+    protected init(): void {
+        this.preferenceService.onPreferencesChanged(async preferenceChanges => {
+            if (notebookOutputOptionsRelevantPreferences.some(p => p in preferenceChanges)) {
+                this.outputOptionsChangedEmitter.fire(this.computeOutputOptions());
+            }
+        });
+    }
+
+    computeOutputOptions(): NotebookOutputOptions {
+        const outputLineHeight = this.getNotebookPreferenceWithDefault<number>(NotebookPreferences.OUTPUT_LINE_HEIGHT);
+
+        const fontSize = this.preferenceService.get<number>('editor.fontSize')!;
+        const outputFontSize = this.getNotebookPreferenceWithDefault<number>(NotebookPreferences.OUTPUT_FONT_SIZE);
+
+        return {
+            fontSize,
+            outputFontSize: outputFontSize,
+            fontFamily: this.preferenceService.get<string>('editor.fontFamily')!,
+            outputNodeLeftPadding: 8,
+            outputFontFamily: this.getNotebookPreferenceWithDefault<string>(NotebookPreferences.OUTPUT_FONT_FAMILY),
+            outputLineHeight: this.computeOutputLineHeight(outputLineHeight, outputFontSize ?? fontSize),
+            outputScrolling: this.getNotebookPreferenceWithDefault<boolean>(NotebookPreferences.OUTPUT_SCROLLING)!,
+            outputWordWrap: this.getNotebookPreferenceWithDefault<boolean>(NotebookPreferences.OUTPUT_WORD_WRAP)!,
+            outputLineLimit: this.getNotebookPreferenceWithDefault<number>(NotebookPreferences.OUTPUT_LINE_LIMIT)!
+        };
+    }
+
+    protected getNotebookPreferenceWithDefault<T>(key: string): T {
+        return this.preferenceService.get<T>(key, notebookPreferenceSchema.properties?.[key]?.default as T);
+    }
+
+    protected computeOutputLineHeight(lineHeight: number, outputFontSize: number): number {
+        const minimumLineHeight = 9;
+
+        if (lineHeight === 0) {
+            // use editor line height
+            lineHeight = this.editorFontInfo.lineHeight;
+        } else if (lineHeight < minimumLineHeight) {
+            // Values too small to be line heights in pixels are in ems.
+            let fontSize = outputFontSize;
+            if (fontSize === 0) {
+                fontSize = this.preferenceService.get<number>('editor.fontSize')!;
+            }
+
+            lineHeight = lineHeight * fontSize;
+        }
+
+        // Enforce integer, minimum constraints
+        lineHeight = Math.round(lineHeight);
+        if (lineHeight < minimumLineHeight) {
+            lineHeight = minimumLineHeight;
+        }
+
+        return lineHeight;
+    }
+
+    protected getOrCreateMonacoFontInfo(): BareFontInfo {
+        if (!this.fontInfo) {
+            this.fontInfo = this.createFontInfo();
+            this.editorPreferences.onPreferenceChanged(e => this.fontInfo = this.createFontInfo());
+        }
+        return this.fontInfo;
+    }
+
+    protected createFontInfo(): BareFontInfo {
+        return BareFontInfo.createFromRawSettings({
+            fontFamily: this.editorPreferences['editor.fontFamily'],
+            fontWeight: String(this.editorPreferences['editor.fontWeight']),
+            fontSize: this.editorPreferences['editor.fontSize'],
+            fontLigatures: this.editorPreferences['editor.fontLigatures'],
+            lineHeight: this.editorPreferences['editor.lineHeight'],
+            letterSpacing: this.editorPreferences['editor.letterSpacing'],
+        }, PixelRatio.value);
+    }
+
+}

package/src/browser/service/notebook-renderer-messaging-service.ts

@@ -1,121 +1,121 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-import { Emitter } from '@theia/core';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import { Disposable } from '@theia/core/shared/vscode-languageserver-protocol';
-import { NotebookEditorWidgetService } from './notebook-editor-widget-service';
-
-interface RendererMessage {
-    editorId: string;
-    rendererId: string;
-    message: unknown
-};
-
-export interface RendererMessaging extends Disposable {
-    /**
-     * Method called when a message is received. Should return a boolean
-     * indicating whether a renderer received it.
-     */
-    receiveMessage?: (rendererId: string, message: unknown) => Promise<boolean>;
-
-    /**
-     * Sends a message to an extension from a renderer.
-     */
-    postMessage(rendererId: string, message: unknown): void;
-}
-
-@injectable()
-export class NotebookRendererMessagingService implements Disposable {
-
-    protected readonly postMessageEmitter = new Emitter<RendererMessage>();
-    readonly onPostMessage = this.postMessageEmitter.event;
-
-    protected readonly willActivateRendererEmitter = new Emitter<string>();
-    readonly onWillActivateRenderer = this.willActivateRendererEmitter.event;
-
-    @inject(NotebookEditorWidgetService)
-    protected readonly editorWidgetService: NotebookEditorWidgetService;
-
-    protected readonly activations = new Map<string /* rendererId */, undefined | RendererMessage[]>();
-    protected readonly scopedMessaging = new Map<string /* editorId */, RendererMessaging>();
-
-    receiveMessage(editorId: string | undefined, rendererId: string, message: unknown): Promise<boolean> {
-        if (editorId === undefined) {
-            const sends = [...this.scopedMessaging.values()].map(e => e.receiveMessage?.(rendererId, message));
-            return Promise.all(sends).then(values => values.some(value => !!value));
-        }
-
-        return this.scopedMessaging.get(editorId)?.receiveMessage?.(rendererId, message) ?? Promise.resolve(false);
-    }
-
-    prepare(rendererId: string): void {
-        if (this.activations.has(rendererId)) {
-            return;
-        }
-
-        const queue: RendererMessage[] = [];
-        this.activations.set(rendererId, queue);
-
-        Promise.all(this.willActivateRendererEmitter.fire(rendererId)).then(() => {
-            for (const message of queue) {
-                this.postMessageEmitter.fire(message);
-            }
-            this.activations.set(rendererId, undefined);
-        });
-    }
-
-    public getScoped(editorId: string): RendererMessaging {
-        const existing = this.scopedMessaging.get(editorId);
-        if (existing) {
-            return existing;
-        }
-
-        const messaging: RendererMessaging = {
-            postMessage: (rendererId, message) => this.postMessage(editorId, rendererId, message),
-            receiveMessage: async (rendererId, message) => {
-                this.editorWidgetService.getNotebookEditor(editorId)?.postRendererMessage(rendererId, message);
-                return true;
-            },
-            dispose: () => this.scopedMessaging.delete(editorId),
-        };
-
-        this.scopedMessaging.set(editorId, messaging);
-        return messaging;
-    }
-
-    protected postMessage(editorId: string, rendererId: string, message: unknown): void {
-        if (!this.activations.has(rendererId)) {
-            this.prepare(rendererId);
-        }
-
-        const activation = this.activations.get(rendererId);
-        const toSend = { rendererId, editorId, message };
-        if (activation === undefined) {
-            this.postMessageEmitter.fire(toSend);
-        } else {
-            activation.push(toSend);
-        }
-    }
-
-    dispose(): void {
-        this.postMessageEmitter.dispose();
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { Emitter } from '@theia/core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { Disposable } from '@theia/core/shared/vscode-languageserver-protocol';
+import { NotebookEditorWidgetService } from './notebook-editor-widget-service';
+
+interface RendererMessage {
+    editorId: string;
+    rendererId: string;
+    message: unknown
+};
+
+export interface RendererMessaging extends Disposable {
+    /**
+     * Method called when a message is received. Should return a boolean
+     * indicating whether a renderer received it.
+     */
+    receiveMessage?: (rendererId: string, message: unknown) => Promise<boolean>;
+
+    /**
+     * Sends a message to an extension from a renderer.
+     */
+    postMessage(rendererId: string, message: unknown): void;
+}
+
+@injectable()
+export class NotebookRendererMessagingService implements Disposable {
+
+    protected readonly postMessageEmitter = new Emitter<RendererMessage>();
+    readonly onPostMessage = this.postMessageEmitter.event;
+
+    protected readonly willActivateRendererEmitter = new Emitter<string>();
+    readonly onWillActivateRenderer = this.willActivateRendererEmitter.event;
+
+    @inject(NotebookEditorWidgetService)
+    protected readonly editorWidgetService: NotebookEditorWidgetService;
+
+    protected readonly activations = new Map<string /* rendererId */, undefined | RendererMessage[]>();
+    protected readonly scopedMessaging = new Map<string /* editorId */, RendererMessaging>();
+
+    receiveMessage(editorId: string | undefined, rendererId: string, message: unknown): Promise<boolean> {
+        if (editorId === undefined) {
+            const sends = [...this.scopedMessaging.values()].map(e => e.receiveMessage?.(rendererId, message));
+            return Promise.all(sends).then(values => values.some(value => !!value));
+        }
+
+        return this.scopedMessaging.get(editorId)?.receiveMessage?.(rendererId, message) ?? Promise.resolve(false);
+    }
+
+    prepare(rendererId: string): void {
+        if (this.activations.has(rendererId)) {
+            return;
+        }
+
+        const queue: RendererMessage[] = [];
+        this.activations.set(rendererId, queue);
+
+        Promise.all(this.willActivateRendererEmitter.fire(rendererId)).then(() => {
+            for (const message of queue) {
+                this.postMessageEmitter.fire(message);
+            }
+            this.activations.set(rendererId, undefined);
+        });
+    }
+
+    public getScoped(editorId: string): RendererMessaging {
+        const existing = this.scopedMessaging.get(editorId);
+        if (existing) {
+            return existing;
+        }
+
+        const messaging: RendererMessaging = {
+            postMessage: (rendererId, message) => this.postMessage(editorId, rendererId, message),
+            receiveMessage: async (rendererId, message) => {
+                this.editorWidgetService.getNotebookEditor(editorId)?.postRendererMessage(rendererId, message);
+                return true;
+            },
+            dispose: () => this.scopedMessaging.delete(editorId),
+        };
+
+        this.scopedMessaging.set(editorId, messaging);
+        return messaging;
+    }
+
+    protected postMessage(editorId: string, rendererId: string, message: unknown): void {
+        if (!this.activations.has(rendererId)) {
+            this.prepare(rendererId);
+        }
+
+        const activation = this.activations.get(rendererId);
+        const toSend = { rendererId, editorId, message };
+        if (activation === undefined) {
+            this.postMessageEmitter.fire(toSend);
+        } else {
+            activation.push(toSend);
+        }
+    }
+
+    dispose(): void {
+        this.postMessageEmitter.dispose();
+    }
+}