webgal-parser 4.3.13 → 4.4.3

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "webgal-parser",
-  "version": "4.3.13",
+  "version": "4.4.3",
   "description": "WebGAL script parser",
   "scripts": {
     "test": "vitest",
-    "build": "rimraf -rf ./build && rollup --config"
+    "coverage": "vitest run --coverage",
+    "build": "rimraf -rf ./build && rollup --config",
+    "debug": "tsx test/debug.ts"
   },
+  "types": "./build/types/index.d.ts",
   "module": "./build/es/index.js",
   "main": "./build/cjs/index.js",
   "author": "Mahiru <Mahiru_@outlook.com>",
   "license": "MPL-2.0",
   "dependencies": {
+    "chevrotain": "^10.5.0",
     "cloudlogjs": "^1.0.11",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "tsx": "^3.12.7"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^23.0.2",
@@ -21,9 +26,9 @@
     "@rollup/plugin-typescript": "^9.0.2",
     "@types/lodash": "^4.14.189",
     "@types/node": "^18.14.0",
+    "@vitest/coverage-c8": "^0.28.5",
     "rollup": "^3.3.0",
     "rollup-plugin-babel": "^4.4.0",
-    "rollup-plugin-dts": "^5.0.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.34.1",
     "ts-node": "^10.9.1",

package/src/config/scriptConfig.ts

@@ -1,44 +1,46 @@
-import { commandType } from '../interface/sceneInterface';
-
-export const SCRIPT_CONFIG = [
-  { scriptString: 'intro', scriptType: commandType.intro },
-  { scriptString: 'changeBg', scriptType: commandType.changeBg },
-  { scriptString: 'changeFigure', scriptType: commandType.changeFigure },
-  { scriptString: 'miniAvatar', scriptType: commandType.miniAvatar },
-  { scriptString: 'changeScene', scriptType: commandType.changeScene },
-  { scriptString: 'choose', scriptType: commandType.choose},
-  { scriptString: 'end', scriptType: commandType.end },
-  { scriptString: 'bgm', scriptType: commandType.bgm },
-  { scriptString: 'playVideo', scriptType: commandType.video },
-  {
-    scriptString: 'setComplexAnimation',
-    scriptType: commandType.setComplexAnimation,
-  },
-  { scriptString: 'setFilter', scriptType: commandType.setFilter },
-  { scriptString: 'pixiInit', scriptType: commandType.pixiInit },
-  { scriptString: 'pixiPerform', scriptType: commandType.pixi },
-  { scriptString: 'label', scriptType: commandType.label},
-  { scriptString: 'jumpLabel', scriptType: commandType.jumpLabel},
-  { scriptString: 'setVar', scriptType: commandType.setVar },
-  { scriptString: 'callScene', scriptType: commandType.callScene },
-  { scriptString: 'showVars', scriptType: commandType.showVars },
-  { scriptString: 'unlockCg', scriptType: commandType.unlockCg },
-  { scriptString: 'unlockBgm', scriptType: commandType.unlockBgm },
-  { scriptString: 'say', scriptType: commandType.say },
-  { scriptString: 'filmMode', scriptType: commandType.filmMode },
-  { scriptString: 'callScene', scriptType: commandType.callScene },
-  { scriptString: 'setTextbox', scriptType: commandType.setTextbox},
-  { scriptString: 'setAnimation', scriptType: commandType.setAnimation },
-];
-export const ADD_NEXT_ARG_LIST = [
-  commandType.bgm,
-  commandType.pixi,
-  commandType.pixiInit,
-  commandType.label,
-  commandType.if,
-  commandType.miniAvatar,
-  commandType.setVar,
-  commandType.unlockBgm,
-  commandType.unlockCg,
-  commandType.filmMode,
-];
+import { commandType } from "../interface/sceneInterface";
+
+export const SCRIPT_CONFIG = [
+  { scriptString: 'intro', scriptType: commandType.intro },
+  { scriptString: 'changeBg', scriptType: commandType.changeBg },
+  { scriptString: 'changeFigure', scriptType: commandType.changeFigure },
+  { scriptString: 'miniAvatar', scriptType: commandType.miniAvatar },
+  { scriptString: 'changeScene', scriptType: commandType.changeScene },
+  { scriptString: 'choose', scriptType: commandType.choose},
+  { scriptString: 'end', scriptType: commandType.end },
+  { scriptString: 'bgm', scriptType: commandType.bgm },
+  { scriptString: 'playVideo', scriptType: commandType.video },
+  {
+    scriptString: 'setComplexAnimation',
+    scriptType: commandType.setComplexAnimation,
+  },
+  { scriptString: 'setFilter', scriptType: commandType.setFilter },
+  { scriptString: 'pixiInit', scriptType: commandType.pixiInit },
+  { scriptString: 'pixiPerform', scriptType: commandType.pixi },
+  { scriptString: 'label', scriptType: commandType.label},
+  { scriptString: 'jumpLabel', scriptType: commandType.jumpLabel},
+  { scriptString: 'setVar', scriptType: commandType.setVar },
+  { scriptString: 'callScene', scriptType: commandType.callScene },
+  { scriptString: 'showVars', scriptType: commandType.showVars },
+  { scriptString: 'unlockCg', scriptType: commandType.unlockCg },
+  { scriptString: 'unlockBgm', scriptType: commandType.unlockBgm },
+  { scriptString: 'say', scriptType: commandType.say },
+  { scriptString: 'filmMode', scriptType: commandType.filmMode },
+  { scriptString: 'callScene', scriptType: commandType.callScene },
+  { scriptString: 'setTextbox', scriptType: commandType.setTextbox},
+  { scriptString: 'setAnimation', scriptType: commandType.setAnimation },
+  { scriptString: 'playEffect', scriptType: commandType.playEffect },
+];
+export const ADD_NEXT_ARG_LIST = [
+  commandType.bgm,
+  commandType.pixi,
+  commandType.pixiInit,
+  commandType.label,
+  commandType.if,
+  commandType.miniAvatar,
+  commandType.setVar,
+  commandType.unlockBgm,
+  commandType.unlockCg,
+  commandType.filmMode,
+  commandType.playEffect,
+];

package/src/configParser/configParser.ts

@@ -0,0 +1,4 @@
+export function configParser(configText:string){
+  // TODO
+  return configText
+}

package/src/index.ts

@@ -1,6 +1,8 @@
-import { commandType, IAsset } from "./interface/sceneInterface";
-import { fileType } from "./interface/assets";
-import { sceneParser } from "./sceneParser";
+import {commandType, IAsset} from "./interface/sceneInterface";
+import {fileType} from "./interface/assets";
+import {sceneParser} from "./sceneParser";
+import {ADD_NEXT_ARG_LIST, SCRIPT_CONFIG} from "./config/scriptConfig";
+import {configParser} from "@/configParser/configParser";
 
 export default class SceneParser {
 
@@ -11,7 +13,7 @@ export default class SceneParser {
 
   constructor(assetsPrefetcher: ((assetList: Array<IAsset>) => void),
               assetSetter: (fileName: string, assetType: fileType) => string,
-              ADD_NEXT_ARG_LIST: Array<commandType>, SCRIPT_CONFIG: Array<any>) {
+              ADD_NEXT_ARG_LIST: Array<number>, SCRIPT_CONFIG: Array<any>) {
     this.assetsPrefetcher = assetsPrefetcher;
     this.assetSetter = assetSetter;
     this.ADD_NEXT_ARG_LIST = ADD_NEXT_ARG_LIST;
@@ -22,4 +24,10 @@ export default class SceneParser {
   ) {
     return sceneParser(rawScene, sceneName, sceneUrl, this.assetsPrefetcher, this.assetSetter, this.ADD_NEXT_ARG_LIST, this.SCRIPT_CONFIG);
   }
+
+  parseConfig(configText: string) {
+    return configParser(configText)
+  }
 }
+
+export {ADD_NEXT_ARG_LIST, SCRIPT_CONFIG};

package/src/interface/assets.ts

@@ -1,12 +1,12 @@
-/**
- * 内置资源类型的枚举
- */
-export enum fileType {
-  background,
-  bgm,
-  figure,
-  scene,
-  tex,
-  vocal,
-  video,
-}
+/**
+ * 内置资源类型的枚举
+ */
+export enum fileType {
+  background,
+  bgm,
+  figure,
+  scene,
+  tex,
+  vocal,
+  video,
+}

package/src/interface/runtimeInterface.ts

@@ -1,9 +1,9 @@
-/**
- * 子场景结束后回到父场景的入口
- * @interface sceneEntry
- */
-export interface sceneEntry {
-  sceneName: string; // 场景名称
-  sceneUrl: string; // 场景url
-  continueLine: number; // 继续原场景的行号
-}
+/**
+ * 子场景结束后回到父场景的入口
+ * @interface sceneEntry
+ */
+export interface sceneEntry {
+  sceneName: string; // 场景名称
+  sceneUrl: string; // 场景url
+  continueLine: number; // 继续原场景的行号
+}

package/src/interface/sceneInterface.ts

@@ -1,8 +1,8 @@
 /**
  * 语句类型
  */
-import { sceneEntry } from "./runtimeInterface";
-import { fileType } from "./assets";
+import {sceneEntry} from "./runtimeInterface";
+import {fileType} from "./assets";
 
 export enum commandType {
   say, // 对话
@@ -33,7 +33,9 @@ export enum commandType {
   setAnimation,
   playEffect,
   setTempAnimation,
-  comment
+  comment,
+  setTransform,
+  setTransition,
 }
 
 /**

package/src/parser4/index.ts

@@ -0,0 +1,158 @@
+// (function jsonGrammarOnlyExample() {
+//   // ----------------- Lexer -----------------
+//   const createToken = chevrotain.createToken;
+//   const Lexer = chevrotain.Lexer;
+//
+//   const True = createToken({ name: "True", pattern: /true/ });
+//   const False = createToken({ name: "False", pattern: /false/ });
+//   const LCurly = createToken({ name: "LCurly", pattern: /{/ });
+//   const RCurly = createToken({ name: "RCurly", pattern: /}/ });
+//   const LSquare = createToken({ name: "LSquare", pattern: /\[/ });
+//   const RSquare = createToken({ name: "RSquare", pattern: /]/ });
+//   const Comma = createToken({ name: "Comma", pattern: /,/ });
+//   const Colon = createToken({ name: "Colon", pattern: /:/ });
+//   const Lf = createToken({ name: "LF", pattern: /\n/ });
+//   const Semi = createToken({ name: ";", pattern: /;/ });
+//   const Command = createToken({ name: "Command", pattern: /Command/ });
+//   const ArgS = createToken({ name: " -", pattern: / -/ });
+//   const StringLiteral = createToken({
+//     name: "StringLiteral", pattern: /(?!(?:true|false|Command)\b)\w+/
+//   });
+//   const NumberLiteral = createToken({
+//     name: "NumberLiteral", pattern: /-?(0|[1-9]\d*)(\.\d+)?([eE][+-]?\d+)?/
+//   });
+//
+//   const Equal = createToken({
+//     name: "=",
+//     pattern: /=/
+//   });
+//
+//   const webgalTokens = [NumberLiteral, StringLiteral, RCurly, LCurly,
+//     LSquare, RSquare, Comma, Colon, True, False, Equal, Command, ArgS, Lf, Semi];
+//
+//   const WebGalLexer = new Lexer(webgalTokens, {
+//     // Less position info tracked, reduces verbosity of the playground output.
+//     positionTracking: "onlyStart"
+//   });
+//
+//   // Labels only affect error messages and Diagrams.
+//   LCurly.LABEL = "'{'";
+//   RCurly.LABEL = "'}'";
+//   LSquare.LABEL = "'['";
+//   RSquare.LABEL = "']'";
+//   Comma.LABEL = "','";
+//   Colon.LABEL = "':'";
+//
+//
+//   // ----------------- parser -----------------
+//   const CstParser = chevrotain.CstParser;
+//
+//   class webgalScriptParser extends CstParser {
+//     constructor() {
+//       super(webgalTokens, {
+//         recoveryEnabled: true
+//       });
+//
+//       const $ = this;
+//
+//       $.RULE("scene", () => {
+//         $.MANY_SEP({
+//           SEP: Lf, DEF: () => {
+//             $.SUBRULE($.sentence);
+//           }
+//         });
+//       });
+//
+//       $.RULE("sentence", () => {
+//         $.OR([
+//           { ALT: () => $.SUBRULE($.commonSentence) },
+//           { ALT: () => $.SUBRULE($.comment) }
+//         ]);
+//       });
+//
+//       $.RULE("commonSentence", () => {
+//         $.OR([
+//           { ALT: () => $.SUBRULE($.commandSentence) },
+//           { ALT: () => $.SUBRULE($.dialog) }
+//         ]);
+//         $.OPTION(() => {
+//           $.CONSUME(Semi);
+//         });
+//       });
+//
+//       $.RULE("comment", () => {
+//         $.CONSUME(Semi);
+//         $.CONSUME(StringLiteral);
+//       });
+//
+//       $.RULE("dialog", () => {
+//         $.CONSUME(StringLiteral);
+//
+//       });
+//
+//
+//       $.RULE("commandSentence", () => {
+//         $.CONSUME(Command);
+//         $.CONSUME(Colon);
+//         $.CONSUME(StringLiteral);
+//         $.OPTION(() => {
+//           $.SUBRULE($.args);
+//         });
+//       });
+//
+//       $.RULE("args", () => {
+//         $.CONSUME(ArgS);
+//         $.MANY_SEP({
+//           SEP: ArgS, DEF: () => {
+//             $.SUBRULE($.arg);
+//           }
+//         });
+//       });
+//
+//       $.RULE("arg", () => {
+//         $.CONSUME(StringLiteral);
+//         $.CONSUME(Equal);
+//         $.SUBRULE($.argv);
+//       });
+//
+//       $.RULE("argv", () => {
+//         $.OR([
+//           {
+//             ALT: () => {
+//               this.CONSUME(StringLiteral);
+//             }
+//           },
+//           {
+//             ALT: () => {
+//               this.CONSUME(NumberLiteral);
+//             }
+//           },
+//           {
+//             ALT: () => {
+//               this.CONSUME(True);
+//             }
+//           },
+//           {
+//             ALT: () => {
+//               this.CONSUME(False);
+//             }
+//           }]);
+//       });
+//
+//       // very important to call this after all the rules have been setup.
+//       // otherwise the parser may not work correctly as it will lack information
+//       // derived from the self analysis.
+//       this.performSelfAnalysis();
+//     }
+//
+//   }
+//
+//
+//   // for the playground to work the returned object must contain these fields
+//   return {
+//     lexer: WebGalLexer,
+//     parser: webgalScriptParser,
+//     defaultRule: "scene"
+//   };
+// }());
+export const parser4 = 'unreleased'

package/src/sceneParser.ts

@@ -1,47 +1,47 @@
-import { IAsset, IScene, ISentence } from "./interface/sceneInterface";
-import { scriptParser } from "./scriptParser/scriptParser";
-import * as __ from "lodash";
-import { fileType } from "./interface/assets";
-
-/**
- * 场景解析器
- * @param rawScene 原始场景
- * @param sceneName 场景名称
- * @param sceneUrl 场景url
- * @param assetsPrefetcher
- * @param assetSetter
- * @param ADD_NEXT_ARG_LIST
- * @param SCRIPT_CONFIG
- * @return {IScene} 解析后的场景
- */
-export const sceneParser = (rawScene: string, sceneName: string, sceneUrl: string
-  , assetsPrefetcher: ((assetList: Array<IAsset>) => void), assetSetter: (fileName: string, assetType: fileType) => string
-  , ADD_NEXT_ARG_LIST:any, SCRIPT_CONFIG:any): IScene => {
-  const rawSentenceList = rawScene.split("\n"); // 原始句子列表
-
-  // 去分号留到后面去做了，现在注释要单独处理
-  const rawSentenceListWithoutEmpty = rawSentenceList;
-    // .map((sentence) => sentence.split(";")[0])
-    // .filter((sentence) => sentence.trim() !== "");
-  let assetsList: Array<IAsset> = []; // 场景资源列表
-  let subSceneList: Array<string> = []; // 子场景列表
-  const sentenceList: Array<ISentence> = rawSentenceListWithoutEmpty.map((sentence) => {
-    const returnSentence: ISentence = scriptParser(sentence, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
-    // 在这里解析出语句可能携带的资源和场景，合并到 assetsList 和 subSceneList
-    assetsList = [...assetsList, ...returnSentence.sentenceAssets];
-    subSceneList = [...subSceneList, ...returnSentence.subScene];
-    return returnSentence;
-  });
-
-  // 开始资源的预加载
-  assetsList = __.uniqWith(assetsList); // 去重
-  assetsPrefetcher(assetsList);
-
-  return {
-    sceneName: sceneName, // 场景名称
-    sceneUrl: sceneUrl,
-    sentenceList: sentenceList, // 语句列表
-    assetsList: assetsList, // 资源列表
-    subSceneList: subSceneList // 子场景列表
-  };
-};
+import { IAsset, IScene, ISentence } from "./interface/sceneInterface";
+import { scriptParser } from "./scriptParser/scriptParser";
+import uniqWith from "lodash/uniqWith";
+import { fileType } from "./interface/assets";
+
+/**
+ * 场景解析器
+ * @param rawScene 原始场景
+ * @param sceneName 场景名称
+ * @param sceneUrl 场景url
+ * @param assetsPrefetcher
+ * @param assetSetter
+ * @param ADD_NEXT_ARG_LIST
+ * @param SCRIPT_CONFIG
+ * @return {IScene} 解析后的场景
+ */
+export const sceneParser = (rawScene: string, sceneName: string, sceneUrl: string
+  , assetsPrefetcher: ((assetList: Array<IAsset>) => void), assetSetter: (fileName: string, assetType: fileType) => string
+  , ADD_NEXT_ARG_LIST: any, SCRIPT_CONFIG: any): IScene => {
+  const rawSentenceList = rawScene.split("\n"); // 原始句子列表
+
+  // 去分号留到后面去做了，现在注释要单独处理
+  const rawSentenceListWithoutEmpty = rawSentenceList;
+  // .map((sentence) => sentence.split(";")[0])
+  // .filter((sentence) => sentence.trim() !== "");
+  let assetsList: Array<IAsset> = []; // 场景资源列表
+  let subSceneList: Array<string> = []; // 子场景列表
+  const sentenceList: Array<ISentence> = rawSentenceListWithoutEmpty.map((sentence) => {
+    const returnSentence: ISentence = scriptParser(sentence, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+    // 在这里解析出语句可能携带的资源和场景，合并到 assetsList 和 subSceneList
+    assetsList = [...assetsList, ...returnSentence.sentenceAssets];
+    subSceneList = [...subSceneList, ...returnSentence.subScene];
+    return returnSentence;
+  });
+
+  // 开始资源的预加载
+  assetsList = uniqWith(assetsList); // 去重
+  assetsPrefetcher(assetsList);
+
+  return {
+    sceneName: sceneName, // 场景名称
+    sceneUrl: sceneUrl,
+    sentenceList: sentenceList, // 语句列表
+    assetsList: assetsList, // 资源列表
+    subSceneList: subSceneList // 子场景列表
+  };
+};

package/src/scriptParser/argsParser.ts

@@ -1,62 +1,68 @@
-import { arg } from "../interface/sceneInterface";
-import { fileType } from "../interface/assets";
-/**
- * 参数解析器
- * @param argsRaw 原始参数字符串
- * @param assetSetter
- * @return {Array<arg>} 解析后的参数列表
- */
-export function argsParser(argsRaw: string, assetSetter: (fileName: string, assetType: fileType) => string): Array<arg> {
-  const returnArrayList: Array<arg> = [];
-  // 处理参数
-  // 不要去空格
-  let newArgsRaw = argsRaw.replace(/ /g, " ");
-  // 分割参数列表
-  let rawArgsList: Array<string> = newArgsRaw.split(" -");
-  // 去除空字符串
-  rawArgsList = rawArgsList.filter((e) => {
-    return e !== "";
-  });
-  rawArgsList.forEach((e) => {
-    const argName = e.split("=")[0];
-    const argValue = e.split("=")[1];
-    // 判断是不是语音参数
-    if (e.match(/.ogg|.mp3|.wav/)) {
-      returnArrayList.push({
-        key: "vocal",
-        value: assetSetter(e, fileType.vocal)
-      });
-    } else {
-      // 判断是不是省略参数
-      if (argValue === undefined) {
-        returnArrayList.push({
-          key: argName,
-          value: true
-        });
-      } else {
-        // 是字符串描述的布尔值
-        if (argValue === "true" || argValue === "false") {
-          returnArrayList.push({
-            key: argName,
-            value: argValue === "true"
-          });
-        } else {
-          // 是数字
-          if (!isNaN(Number(argValue))) {
-            returnArrayList.push({
-              key: argName,
-              value: Number(argValue)
-            });
-          } else {
-            // 是普通参数
-            returnArrayList.push({
-              key: argName,
-              value: argValue
-            });
-          }
-        }
-      }
-    }
-  });
-  return returnArrayList;
-};
+import {arg} from "../interface/sceneInterface";
+import {fileType} from "../interface/assets";
+
+/**
+ * 参数解析器
+ * @param argsRaw 原始参数字符串
+ * @param assetSetter
+ * @return {Array<arg>} 解析后的参数列表
+ */
+export function argsParser(argsRaw: string, assetSetter: (fileName: string, assetType: fileType) => string): Array<arg> {
+  const returnArrayList: Array<arg> = [];
+  // 处理参数
+  // 不要去空格
+  let newArgsRaw = argsRaw.replace(/ /g, " ");
+  // 分割参数列表
+  let rawArgsList: Array<string> = newArgsRaw.split(" -");
+  // 去除空字符串
+  rawArgsList = rawArgsList.filter((e) => {
+    return e !== "";
+  });
+  rawArgsList.forEach((e) => {
+    const equalSignIndex = e.indexOf('=');
+    let argName = e.slice(0, equalSignIndex);
+    let argValue: string | undefined = e.slice(equalSignIndex + 1);
+    if (equalSignIndex < 0) {
+      argName = e;
+      argValue = undefined;
+    }
+    // 判断是不是语音参数
+    if (e.match(/.ogg|.mp3|.wav/)) {
+      returnArrayList.push({
+        key: "vocal",
+        value: assetSetter(e, fileType.vocal)
+      });
+    } else {
+      // 判断是不是省略参数
+      if (argValue === undefined) {
+        returnArrayList.push({
+          key: argName,
+          value: true
+        });
+      } else {
+        // 是字符串描述的布尔值
+        if (argValue === "true" || argValue === "false") {
+          returnArrayList.push({
+            key: argName,
+            value: argValue === "true"
+          });
+        } else {
+          // 是数字
+          if (!isNaN(Number(argValue))) {
+            returnArrayList.push({
+              key: argName,
+              value: Number(argValue)
+            });
+          } else {
+            // 是普通参数
+            returnArrayList.push({
+              key: argName,
+              value: argValue
+            });
+          }
+        }
+      }
+    }
+  });
+  return returnArrayList;
+};