Introduce Manim Shell abstraction to preview terminal-free

src/extension.ts

@@ -1,14 +1,19 @@
 import * as vscode from 'vscode';
+import { window } from 'vscode';
+import { ManimShell } from './manimShell';
 import { ManimCell } from './manimCell';
 import { ManimCellRanges } from './manimCellRanges';
 import { previewCode } from './previewCode';
-import { executeTerminalCommand } from './executeTerminalCommand';
+import { startScene, exitScene } from './startStopScene';
 
 export function activate(context: vscode.ExtensionContext) {
 
+	// Trigger the Manim shell to start listening to the terminal
+	ManimShell.instance;
+
 	const previewManimCellCommand = vscode.commands.registerCommand(
-		'manim-notebook.previewManimCell', (cellCode: string | undefined) => {
-			previewManimCell(cellCode);
+		'manim-notebook.previewManimCell', (cellCode?: string, startLine?: number) => {
+			previewManimCell(cellCode, startLine);
 		});
 
 	const previewSelectionCommand = vscode.commands.registerCommand(
@@ -52,12 +57,14 @@ export function deactivate() { }
  * (when accessed via the command pallette) or the code of the cell where
  * the codelens was clicked.
  */
-function previewManimCell(cellCode: string | undefined) {
+function previewManimCell(cellCode?: string, startLine?: number) {
+	let startLineFinal: number | undefined = startLine;
+
 	// User has executed the command via command pallette
 	if (cellCode === undefined) {
-		const editor = vscode.window.activeTextEditor;
+		const editor = window.activeTextEditor;
 		if (!editor) {
-			vscode.window.showErrorMessage(
+			window.showErrorMessage(
 				'No opened file found. Place your cursor in a Manim cell.');
 			return;
 		}
@@ -67,22 +74,28 @@ function previewManimCell(cellCode: string | undefined) {
 		const cursorLine = editor.selection.active.line;
 		const range = ManimCellRanges.getCellRangeAtLine(document, cursorLine);
 		if (!range) {
-			vscode.window.showErrorMessage('Place your cursor in a Manim cell.');
+			window.showErrorMessage('Place your cursor in a Manim cell.');
 			return;
 		}
 		cellCode = document.getText(range);
+		startLineFinal = range.start.line;
+	}
+
+	if (startLineFinal === undefined) {
+		window.showErrorMessage('Internal error: Line number not found in `previewManimCell()`.');
+		return;
 	}
 
-	previewCode(cellCode);
+	previewCode(cellCode, startLineFinal);
 }
 
 /**
  * Previews the Manim code of the selected text.
  */
 function previewSelection() {
-	const editor = vscode.window.activeTextEditor;
+	const editor = window.activeTextEditor;
 	if (!editor) {
-		vscode.window.showErrorMessage('Select some code to preview.');
+		window.showErrorMessage('Select some code to preview.');
 		return;
 	}
 
@@ -102,119 +115,22 @@ function previewSelection() {
 	}
 
 	if (!selectedText) {
-		vscode.window.showErrorMessage('Select some code to preview.');
+		window.showErrorMessage('Select some code to preview.');
 		return;
 	}
 
-	previewCode(selectedText);
-}
-
-/**
- * Runs the `manimgl` command in the terminal, with the current cursor's line number:
- * manimgl <file_name> <ClassName> [-se <lineNumber>]
- * 
- * - Saves the active file.
- * - Previews the scene at the cursor's line (end of line)
- * - If the cursor is on a class definition line, then `-se <lineNumber>`
- *   is NOT added, i.e. the whole scene is previewed.
- * - (3b1b's version also copies this command to the clipboard with additional
- *   args `--prerun --finder -w`. We don't do that here.)
- */
-async function startScene() {
-	const editor = vscode.window.activeTextEditor;
-	if (!editor) {
-		vscode.window.showErrorMessage(
-			'No opened file found. Please place your cursor at a line of code.'
-		);
-		return;
-	}
-
-	// Save active file
-	vscode.commands.executeCommand('workbench.action.files.save');
-
-	const languageId = editor.document.languageId;
-	if (languageId !== 'python') {
-		vscode.window.showErrorMessage("You don't have a Python file open.");
-		return;
-	}
-
-	const lines = editor.document.getText().split("\n");
-
-	// Find which lines define classes
-	// E.g. here, classLines = [{ line: "class FirstScene(Scene):", index: 3 }, ...]
-	const classLines = lines
-		.map((line, index) => ({ line, index }))
-		.filter(({ line }) => /^class (.+?)\((.+?)\):/.test(line));
-
-	const cursorLine = editor.selection.start.line;
-
-	// Find the first class defined before where the cursor is
-	// E.g. here, matchingClass = { line: "class SelectedScene(Scene):", index: 42 }
-	const matchingClass = classLines
-		.reverse()
-		.find(({ index }) => index <= cursorLine);
-	if (!matchingClass) {
-		vscode.window.showErrorMessage('Place your cursor in Manim code inside a class.');
-		return;
-	}
-	// E.g. here, sceneName = "SelectedScene"
-	const sceneName = matchingClass.line.slice("class ".length, matchingClass.line.indexOf("("));
-
-	// While line is empty - make it the previous line
-	// (because `manimgl -se <lineNumber>` doesn't work on empty lines)
-	let lineNumber = cursorLine;
-	while (lines[lineNumber].trim() === "") {
-		lineNumber--;
-	}
-
-	// Create the command
-	const filePath = editor.document.fileName;  // absolute path
-	const cmds = ["manimgl", filePath, sceneName];
-	let enter = false;
-	if (cursorLine !== matchingClass.index) {
-		cmds.push(`-se ${lineNumber + 1}`);
-		enter = true;
-	}
-	const command = cmds.join(" ");
-
-	// // Commented out - in case someone would like it.
-	// // For us - we want to NOT overwrite our clipboard.
-	// // If one wants to run it in a different terminal,
-	// // it's often to write to a file
-	// await vscode.env.clipboard.writeText(command + " --prerun --finder -w");
-
-	// Run the command
-	executeTerminalCommand(command);
-
-	// // Commented out - in case someone would like it.
-	// // For us - it would require MacOS. Also - the effect is not desired.
-	// // Focus some windows (ONLY for MacOS because it uses `osascript`!)
-	// const terminal = vscode.window.activeTerminal || vscode.window.createTerminal();
-	// if (enter) {
-	// 	// Keep cursor where it started (in VSCode)
-	// 	const cmd_focus_vscode = 'osascript -e "tell application \\"Visual Studio Code\\" to activate"';
-	// 	// Execute the command in the shell after a delay (to give the animation window enough time to open)
-	// 	await new Promise(resolve => setTimeout(resolve, 2500));
-	// 	require('child_process').exec(cmd_focus_vscode);
-	// } else {
-	// 	terminal.show();
-	// }
-}
-
-/**
- * Runs the `exit()` command in the terminal to close the animation window
- * and the IPython terminal.
- */
-function exitScene() {
-	executeTerminalCommand("exit()");
+	previewCode(selectedText, selection.start.line);
 }
 
 /**
  * Runs the `clear()` command in the terminal to remove all objects from
  * the scene.
  */
-function clearScene() {
-	executeTerminalCommand("clear()");
+async function clearScene() {
+	const success = await ManimShell.instance.executeCommandEnsureActiveSession("clear()");
+	if (!success) {
+		window.showErrorMessage('No active ManimGL scene found to remove objects from.');
+	}
 }
 
 /**
@@ -229,24 +145,24 @@ function registerManimCellProviders(context: vscode.ExtensionContext) {
 		{ language: 'python' }, manimCell);
 	context.subscriptions.push(codeLensProvider, foldingRangeProvider);
 
-	vscode.window.onDidChangeActiveTextEditor(editor => {
+	window.onDidChangeActiveTextEditor(editor => {
 		if (editor) {
 			manimCell.applyCellDecorations(editor);
 		}
 	}, null, context.subscriptions);
 
 	vscode.workspace.onDidChangeTextDocument(event => {
-		const editor = vscode.window.activeTextEditor;
+		const editor = window.activeTextEditor;
 		if (editor && event.document === editor.document) {
 			manimCell.applyCellDecorations(editor);
 		}
 	}, null, context.subscriptions);
 
-	vscode.window.onDidChangeTextEditorSelection(event => {
+	window.onDidChangeTextEditorSelection(event => {
 		manimCell.applyCellDecorations(event.textEditor);
 	}, null, context.subscriptions);
 
-	if (vscode.window.activeTextEditor) {
-		manimCell.applyCellDecorations(vscode.window.activeTextEditor);
+	if (window.activeTextEditor) {
+		manimCell.applyCellDecorations(window.activeTextEditor);
 	}
 }

src/manimCell.ts

@@ -50,7 +50,7 @@ export class ManimCell implements vscode.CodeLensProvider, vscode.FoldingRangePr
             title: "▶ Preview Manim Cell",
             command: "manim-notebook.previewManimCell",
             tooltip: "Preview this Manim Cell inside an interactive Manim environment",
-            arguments: [cellCode]
+            arguments: [cellCode, codeLens.range.start.line]
         };
 
         return codeLens;