feat: REPLの機能強化 (#850)

* REPLをscriptsに追加 * ドキュメントに追記 * Interpreterを保存 * REPLを複数行入力に対応 * REPLの終了コマンドを変更 * 改行時に深さが変わらないように Co-authored-by: salano_ym <53254905+salano-ym@users.noreply.github.com> --------- Co-authored-by: salano_ym <53254905+salano-ym@users.noreply.github.com>
aiscript-dev · Nov 17, 2024 · ce845b1 · ce845b1
1 parent 6118f9e
commit ce845b1
Show file tree

Hide file tree

Showing 12 changed files with 108 additions and 30 deletions.
diff --git a/docs/execution.md b/docs/execution.md
@@ -36,3 +36,10 @@ $ npm run start
 ```
 $ npm run parse
 ```
+
+## 4. REPL上で実行
+コマンドライン上で対話的にコードを実行します。
+以下のコマンドを実行し、コードを入力します。
+```
+$npm run repl
+```
diff --git a/etc/aiscript.api.md b/etc/aiscript.api.md
@@ -80,6 +80,11 @@ class AiScriptTypeError extends AiScriptError {
     pos: Pos;
 }
 
+// @public
+class AiScriptUnexpectedEOFError extends AiScriptSyntaxError {
+    constructor(pos: Pos, info?: unknown);
+}
+
 // @public
 class AiScriptUserError extends AiScriptRuntimeError {
     constructor(message: string, info?: unknown);
@@ -280,6 +285,7 @@ declare namespace errors {
         AiScriptError,
         NonAiScriptError,
         AiScriptSyntaxError,
+        AiScriptUnexpectedEOFError,
         AiScriptTypeError,
         AiScriptNamespaceError,
         AiScriptRuntimeError,

diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
 	"scripts": {
 		"start": "node ./scripts/start.mjs",
 		"parse": "node ./scripts/parse.mjs",
+		"repl": "node ./scripts/repl.mjs",
 		"ts": "npm run ts-esm && npm run ts-dts",
 		"ts-esm": "tsc --outDir built/esm",
 		"ts-dts": "tsc --outDir built/dts --declaration true --emitDeclarationOnly true --declarationMap true",

diff --git a/console.js → scripts/repl.mjs b/console.js → scripts/repl.mjs
@@ -1,6 +1,6 @@
 import * as readline from 'readline/promises';
 import chalk from 'chalk';
-import { Parser, Interpreter, utils } from '@syuilo/aiscript';
+import { errors, Parser, Interpreter, utils } from '@syuilo/aiscript';
 const { valToString } = utils;
 
 const i = readline.createInterface({
@@ -12,9 +12,9 @@ console.log(
 `Welcome to AiScript!
 https://github.com/syuilo/aiscript
 
-Type 'exit' to end this session.`);
+Type '.exit' to end this session.`);
 
-const getInterpreter = () => new Interpreter({}, {
+const interpreter = new Interpreter({}, {
 	in(q) {
 		return i.question(q + ': ');
 	},
@@ -36,14 +36,34 @@ const getInterpreter = () => new Interpreter({}, {
 	}
 });
 
-let interpreter;
+async function getAst() {
+	let script = '';
+	let a = await i.question('>>> ');
+	while (true) {
+		try {
+			if (a === '.exit') return null;
+			script += a;
+			let ast = Parser.parse(script);
+			script = '';
+			return ast;
+		} catch(e) {
+			if (e instanceof errors.AiScriptUnexpectedEOFError) {
+				script += '\n';
+				a = await i.question('... ');
+			} else {
+				script = '';
+				throw e;
+			}
+		}
+	}
+}
+
 async function main(){
-	let a = await i.question('> ');
-	interpreter?.abort();
-	if (a === 'exit') return false;
 	try {
-		let ast = Parser.parse(a);
-		interpreter = getInterpreter();
+		let ast = await getAst();
+		if (ast == null) {
+			return false;
+		}
 		await interpreter.exec(ast);
 	} catch(e) {
 		console.log(chalk.red(`${e}`));

diff --git a/src/error.ts b/src/error.ts
@@ -1,3 +1,4 @@
+import { TokenKind } from './parser/token.js';
 import type { Pos } from './node.js';
 
 export abstract class AiScriptError extends Error {
@@ -40,6 +41,16 @@ export class AiScriptSyntaxError extends AiScriptError {
 		super(`${message} (Line ${pos.line}, Column ${pos.column})`, info);
 	}
 }
+
+/**
+ * Unexpected EOF errors.
+ */
+export class AiScriptUnexpectedEOFError extends AiScriptSyntaxError {
+	constructor(pos: Pos, info?: unknown) {
+		super('unexpected EOF', pos, info);
+	}
+}
+
 /**
  * Type validation(parser/plugins/validate-type) errors.
  */

diff --git a/src/parser/scanner.ts b/src/parser/scanner.ts
@@ -1,6 +1,7 @@
-import { AiScriptSyntaxError } from '../error.js';
+import { AiScriptSyntaxError, AiScriptUnexpectedEOFError } from '../error.js';
 import { CharStream } from './streams/char-stream.js';
 import { TOKEN, TokenKind } from './token.js';
+import { unexpectedTokenError } from './utils.js';
 
 import type { ITokenStream } from './streams/token-stream.js';
 import type { Token, TokenPosition } from './token.js';
@@ -96,7 +97,7 @@ export class Scanner implements ITokenStream {
 	*/
 	public expect(kind: TokenKind): void {
 		if (!this.is(kind)) {
-			throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[this.getTokenKind()]}`, this.getPos());
+			throw unexpectedTokenError(this.getTokenKind(), this.getPos());
 		}
 	}
 
@@ -456,7 +457,7 @@ export class Scanner implements ITokenStream {
 			switch (state) {
 				case 'string': {
 					if (this.stream.eof) {
-						throw new AiScriptSyntaxError('unexpected EOF', pos);
+						throw new AiScriptUnexpectedEOFError(pos);
 					}
 					if (this.stream.char === '\\') {
 						this.stream.next();
@@ -474,7 +475,7 @@ export class Scanner implements ITokenStream {
 				}
 				case 'escape': {
 					if (this.stream.eof) {
-						throw new AiScriptSyntaxError('unexpected EOF', pos);
+						throw new AiScriptUnexpectedEOFError(pos);
 					}
 					value += this.stream.char;
 					this.stream.next();
@@ -502,7 +503,7 @@ export class Scanner implements ITokenStream {
 				case 'string': {
 					// テンプレートの終了が無いままEOFに達した
 					if (this.stream.eof) {
-						throw new AiScriptSyntaxError('unexpected EOF', pos);
+						throw new AiScriptUnexpectedEOFError(pos);
 					}
 					// エスケープ
 					if (this.stream.char === '\\') {
@@ -538,7 +539,7 @@ export class Scanner implements ITokenStream {
 				case 'escape': {
 					// エスケープ対象の文字が無いままEOFに達した
 					if (this.stream.eof) {
-						throw new AiScriptSyntaxError('unexpected EOF', pos);
+						throw new AiScriptUnexpectedEOFError(pos);
 					}
 					// 普通の文字として取り込み
 					buf += this.stream.char;
@@ -550,7 +551,7 @@ export class Scanner implements ITokenStream {
 				case 'expr': {
 					// 埋め込み式の終端記号が無いままEOFに達した
 					if (this.stream.eof) {
-						throw new AiScriptSyntaxError('unexpected EOF', pos);
+						throw new AiScriptUnexpectedEOFError(pos);
 					}
 					// skip spasing
 					if (spaceChars.includes(this.stream.char)) {

diff --git a/src/parser/streams/token-stream.ts b/src/parser/streams/token-stream.ts
@@ -1,5 +1,5 @@
-import { AiScriptSyntaxError } from '../../error.js';
 import { TOKEN, TokenKind } from '../token.js';
+import { unexpectedTokenError } from '../utils.js';
 import type { Token, TokenPosition } from '../token.js';
 
 /**
@@ -131,7 +131,7 @@ export class TokenStream implements ITokenStream {
 	*/
 	public expect(kind: TokenKind): void {
 		if (!this.is(kind)) {
-			throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[this.getTokenKind()]}`, this.getPos());
+			throw unexpectedTokenError(this.getTokenKind(), this.getPos());
 		}
 	}
 

diff --git a/src/parser/syntaxes/common.ts b/src/parser/syntaxes/common.ts
@@ -1,5 +1,5 @@
 import { TokenKind } from '../token.js';
-import { AiScriptSyntaxError } from '../../error.js';
+import { AiScriptSyntaxError, AiScriptUnexpectedEOFError } from '../../error.js';
 import { NODE } from '../utils.js';
 import { parseStatement } from './statements.js';
 import { parseExpr } from './expressions.js';
@@ -75,6 +75,9 @@ export function parseParams(s: ITokenStream): Ast.Fn['params'] {
 			case TokenKind.CloseParen: {
 				break;
 			}
+			case TokenKind.EOF: {
+				throw new AiScriptUnexpectedEOFError(s.getPos());
+			}
 			default: {
 				throw new AiScriptSyntaxError('separator expected', s.getPos());
 			}
@@ -116,6 +119,9 @@ export function parseBlock(s: ITokenStream): (Ast.Statement | Ast.Expression)[]
 			case TokenKind.CloseBrace: {
 				break;
 			}
+			case TokenKind.EOF: {
+				throw new AiScriptUnexpectedEOFError(s.getPos());
+			}
 			default: {
 				throw new AiScriptSyntaxError('Multiple statements cannot be placed on a single line.', s.getPos());
 			}
@@ -184,6 +190,9 @@ function parseFnType(s: ITokenStream): Ast.TypeSource {
 					s.next();
 					break;
 				}
+				case TokenKind.EOF: {
+					throw new AiScriptUnexpectedEOFError(s.getPos());
+				}
 				default: {
 					throw new AiScriptSyntaxError('separator expected', s.getPos());
 				}

diff --git a/src/parser/syntaxes/expressions.ts b/src/parser/syntaxes/expressions.ts
@@ -1,5 +1,5 @@
-import { AiScriptSyntaxError } from '../../error.js';
-import { NODE } from '../utils.js';
+import { AiScriptSyntaxError, AiScriptUnexpectedEOFError } from '../../error.js';
+import { NODE, unexpectedTokenError } from '../utils.js';
 import { TokenStream } from '../streams/token-stream.js';
 import { TokenKind } from '../token.js';
 import { parseBlock, parseOptionalSeparator, parseParams, parseType } from './common.js';
@@ -84,7 +84,7 @@ function parsePrefix(s: ITokenStream, minBp: number): Ast.Expression {
 			return NODE('not', { expr }, startPos, endPos);
 		}
 		default: {
-			throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[op]}`, startPos);
+			throw unexpectedTokenError(op, startPos);
 		}
 	}
 }
@@ -158,7 +158,7 @@ function parseInfix(s: ITokenStream, left: Ast.Expression, minBp: number): Ast.E
 				return NODE('or', { left, right }, startPos, endPos);
 			}
 			default: {
-				throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[op]}`, startPos);
+				throw unexpectedTokenError(op, startPos);
 			}
 		}
 	}
@@ -184,7 +184,7 @@ function parsePostfix(s: ITokenStream, expr: Ast.Expression): Ast.Expression {
 			}, startPos, s.getPos());
 		}
 		default: {
-			throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[op]}`, startPos);
+			throw unexpectedTokenError(op, startPos);
 		}
 	}
 }
@@ -241,7 +241,7 @@ function parseAtom(s: ITokenStream, isStatic: boolean): Ast.Expression {
 						break;
 					}
 					default: {
-						throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[element.kind]}`, element.pos);
+						throw unexpectedTokenError(element.kind, element.pos);
 					}
 				}
 			}
@@ -288,7 +288,7 @@ function parseAtom(s: ITokenStream, isStatic: boolean): Ast.Expression {
 			return expr;
 		}
 	}
-	throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[s.getTokenKind()]}`, startPos);
+	throw unexpectedTokenError(s.getTokenKind(), startPos);
 }
 
 /**
@@ -324,6 +324,9 @@ function parseCall(s: ITokenStream, target: Ast.Expression): Ast.Call {
 			case TokenKind.CloseParen: {
 				break;
 			}
+			case TokenKind.EOF: {
+				throw new AiScriptUnexpectedEOFError(s.getPos());
+			}
 			default: {
 				throw new AiScriptSyntaxError('separator expected', s.getPos());
 			}
@@ -578,6 +581,9 @@ function parseObject(s: ITokenStream, isStatic: boolean): Ast.Obj {
 			case TokenKind.CloseBrace: {
 				break;
 			}
+			case TokenKind.EOF: {
+				throw new AiScriptUnexpectedEOFError(s.getPos());
+			}
 			default: {
 				throw new AiScriptSyntaxError('separator expected', s.getPos());
 			}
@@ -622,6 +628,9 @@ function parseArray(s: ITokenStream, isStatic: boolean): Ast.Arr {
 			case TokenKind.CloseBracket: {
 				break;
 			}
+			case TokenKind.EOF: {
+				throw new AiScriptUnexpectedEOFError(s.getPos());
+			}
 			default: {
 				throw new AiScriptSyntaxError('separator expected', s.getPos());
 			}

diff --git a/src/parser/syntaxes/statements.ts b/src/parser/syntaxes/statements.ts
@@ -1,5 +1,5 @@
 import { AiScriptSyntaxError } from '../../error.js';
-import { CALL_NODE, NODE } from '../utils.js';
+import { CALL_NODE, NODE, unexpectedTokenError } from '../utils.js';
 import { TokenKind } from '../token.js';
 import { parseBlock, parseDest, parseParams, parseType } from './common.js';
 import { parseExpr } from './expressions.js';
@@ -78,7 +78,7 @@ export function parseDefStatement(s: ITokenStream): Ast.Definition {
 			return parseFnDef(s);
 		}
 		default: {
-			throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[s.getTokenKind()]}`, s.getPos());
+			throw unexpectedTokenError(s.getTokenKind(), s.getPos());
 		}
 	}
 }
@@ -117,7 +117,7 @@ function parseVarDef(s: ITokenStream): Ast.Definition {
 			break;
 		}
 		default: {
-			throw new AiScriptSyntaxError(`unexpected token: ${TokenKind[s.getTokenKind()]}`, s.getPos());
+			throw unexpectedTokenError(s.getTokenKind(), s.getPos());
 		}
 	}
 	s.next();

diff --git a/src/parser/syntaxes/toplevel.ts b/src/parser/syntaxes/toplevel.ts
@@ -1,6 +1,6 @@
 import { NODE } from '../utils.js';
 import { TokenKind } from '../token.js';
-import { AiScriptSyntaxError } from '../../error.js';
+import { AiScriptSyntaxError, AiScriptUnexpectedEOFError } from '../../error.js';
 import { parseDefStatement, parseStatement } from './statements.js';
 import { parseExpr } from './expressions.js';
 
@@ -105,6 +105,9 @@ export function parseNamespace(s: ITokenStream): Ast.Namespace {
 			case TokenKind.CloseBrace: {
 				break;
 			}
+			case TokenKind.EOF: {
+				throw new AiScriptUnexpectedEOFError(s.getPos());
+			}
 			default: {
 				throw new AiScriptSyntaxError('Multiple statements cannot be placed on a single line.', s.getPos());
 			}

diff --git a/src/parser/utils.ts b/src/parser/utils.ts
@@ -1,3 +1,6 @@
+import { AiScriptSyntaxError, AiScriptUnexpectedEOFError } from '../error.js';
+import { TokenKind } from './token.js';
+import type { AiScriptError } from '../error.js';
 import type * as Ast from '../node.js';
 
 export function NODE<T extends Ast.Node['type']>(
@@ -29,3 +32,11 @@ export function CALL_NODE(
 		args,
 	}, start, end);
 }
+
+export function unexpectedTokenError(token: TokenKind, pos: Ast.Pos, info?: unknown): AiScriptError {
+	if (token === TokenKind.EOF) {
+		return new AiScriptUnexpectedEOFError(pos, info);
+	} else {
+		return new AiScriptSyntaxError(`unexpected token: ${TokenKind[token]}`, pos, info);
+	}
+}