webgal-parser 4.3.13 → 4.4.4

package/package.json

@@ -1,35 +1,40 @@
-{
-  "name": "webgal-parser",
-  "version": "4.3.13",
-  "description": "WebGAL script parser",
-  "scripts": {
-    "test": "vitest",
-    "build": "rimraf -rf ./build && rollup --config"
-  },
-  "module": "./build/es/index.js",
-  "main": "./build/cjs/index.js",
-  "author": "Mahiru <Mahiru_@outlook.com>",
-  "license": "MPL-2.0",
-  "dependencies": {
-    "cloudlogjs": "^1.0.11",
-    "lodash": "^4.17.21"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^23.0.2",
-    "@rollup/plugin-json": "^5.0.1",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-typescript": "^9.0.2",
-    "@types/lodash": "^4.14.189",
-    "@types/node": "^18.14.0",
-    "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",
-    "tslib": "^2.4.1",
-    "typescript": "^4.9.3",
-    "vitest": "^0.28.5"
-  },
-  "type": "module"
-}
+{
+  "name": "webgal-parser",
+  "version": "4.4.4",
+  "description": "WebGAL script parser",
+  "scripts": {
+    "test": "vitest",
+    "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",
+    "tsx": "^3.12.7"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-json": "^5.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@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-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.4.1",
+    "typescript": "^4.9.3",
+    "vitest": "^0.28.5"
+  },
+  "type": "module"
+}

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,60 @@
+import {argsParser} from "../scriptParser/argsParser";
+
+interface IOptionItem{
+  key:string;
+  value:string | number | boolean;
+}
+interface IConfigItem{
+  command:string;
+  args:string[]
+  options:IOptionItem[];
+}
+
+export type WebgalConfig = IConfigItem[]
+
+
+function configLineParser(inputLine:string):IConfigItem{
+  const options:Array<IOptionItem> = [];
+  let command: string;
+
+  let newSentenceRaw = inputLine.split(";")[0];
+  if (newSentenceRaw === "") {
+    // 注释提前返回
+    return {
+      command:'',
+      args:[],
+      options:[]
+    };
+  }
+  // 截取命令
+  const getCommandResult = /:/.exec(newSentenceRaw);
+
+  // 没有command
+  if (getCommandResult === null) {
+    command = '';
+  } else {
+    command = newSentenceRaw.substring(0, getCommandResult.index);
+    // 划分命令区域和content区域
+    newSentenceRaw = newSentenceRaw.substring(getCommandResult.index + 1, newSentenceRaw.length);
+  }
+  // 截取 Options 区域
+  const getOptionsResult = / -/.exec(newSentenceRaw);
+  // 获取到参数
+  if (getOptionsResult) {
+    const optionsRaw = newSentenceRaw.substring(getOptionsResult.index, newSentenceRaw.length);
+    newSentenceRaw = newSentenceRaw.substring(0, getOptionsResult.index);
+    for (const e of argsParser(optionsRaw, (name,_)=>{return name})) {
+      options.push(e);
+    }
+  }
+  return {
+    command,
+    args:newSentenceRaw.split('|').map(e=>e.trim()).filter(e=>e!==''),
+    options
+  };
+}
+
+export function configParser(configText:string):WebgalConfig{
+  const configLines = configText.replaceAll(`\r`,'').split('\n');
+  return configLines.map(e=>configLineParser(e)).filter(e=>e.command!=='');
+}

package/src/index.ts

@@ -1,25 +1,42 @@
-import { commandType, IAsset } from "./interface/sceneInterface";
-import { fileType } from "./interface/assets";
-import { sceneParser } from "./sceneParser";
-
-export default class SceneParser {
-
-  private readonly assetsPrefetcher;
-  private readonly assetSetter;
-  private readonly ADD_NEXT_ARG_LIST;
-  private readonly SCRIPT_CONFIG;
-
-  constructor(assetsPrefetcher: ((assetList: Array<IAsset>) => void),
-              assetSetter: (fileName: string, assetType: fileType) => string,
-              ADD_NEXT_ARG_LIST: Array<commandType>, SCRIPT_CONFIG: Array<any>) {
-    this.assetsPrefetcher = assetsPrefetcher;
-    this.assetSetter = assetSetter;
-    this.ADD_NEXT_ARG_LIST = ADD_NEXT_ARG_LIST;
-    this.SCRIPT_CONFIG = SCRIPT_CONFIG;
-  }
-
-  parse(rawScene: string, sceneName: string, sceneUrl: string
-  ) {
-    return sceneParser(rawScene, sceneName, sceneUrl, this.assetsPrefetcher, this.assetSetter, this.ADD_NEXT_ARG_LIST, this.SCRIPT_CONFIG);
-  }
-}
+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, WebgalConfig} from "./configParser/configParser";
+
+export default class SceneParser {
+
+  private readonly assetsPrefetcher;
+  private readonly assetSetter;
+  private readonly ADD_NEXT_ARG_LIST;
+  private readonly SCRIPT_CONFIG;
+
+  constructor(assetsPrefetcher: ((assetList: Array<IAsset>) => void),
+              assetSetter: (fileName: string, assetType: fileType) => string,
+              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;
+    this.SCRIPT_CONFIG = SCRIPT_CONFIG;
+  }
+
+  parse(rawScene: string, sceneName: string, sceneUrl: string
+  ) {
+    return sceneParser(rawScene, sceneName, sceneUrl, this.assetsPrefetcher, this.assetSetter, this.ADD_NEXT_ARG_LIST, this.SCRIPT_CONFIG);
+  }
+
+  parseConfig(configText: string) {
+    return configParser(configText)
+  }
+
+  stringifyConfig(config: WebgalConfig) {
+    return config
+      .reduce(
+        (previousValue, curr) =>
+          (previousValue + `${curr.command}:${curr.args.join('|')}${curr.options.length <= 0 ? '' : curr.options.reduce((p, c) => (p + ' -' + c.key + '=' + c.value), '')};\n`),
+        ''
+      )
+  }
+}
+
+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,101 +1,103 @@
-/**
- * 语句类型
- */
-import { sceneEntry } from "./runtimeInterface";
-import { fileType } from "./assets";
-
-export enum commandType {
-  say, // 对话
-  changeBg, // 更改背景
-  changeFigure, // 更改立绘
-  bgm, // 更改背景音乐
-  video, // 播放视频
-  pixi, // pixi演出
-  pixiInit, // pixi初始化
-  intro, // 黑屏文字演示
-  miniAvatar, // 小头像
-  changeScene, // 切换场景
-  choose, // 分支选择
-  end, // 结束游戏
-  setComplexAnimation, // 动画演出
-  setFilter, // 设置效果
-  label, // 标签
-  jumpLabel, // 跳转标签
-  chooseLabel, // 选择标签
-  setVar, // 设置变量
-  if, // 条件跳转
-  callScene, // 调用场景
-  showVars,
-  unlockCg,
-  unlockBgm,
-  filmMode,
-  setTextbox,
-  setAnimation,
-  playEffect,
-  setTempAnimation,
-  comment
-}
-
-/**
- * 单个参数接口
- * @interface arg
- */
-export interface arg {
-  key: string; // 参数键
-  value: string | boolean | number; // 参数值
-}
-
-/**
- * 资源接口
- * @interface IAsset
- */
-export interface IAsset {
-  name: string; // 资源名称
-  type: fileType; // 资源类型
-  url: string; // 资源url
-  lineNumber: number; // 触发资源语句的行号
-}
-
-/**
- * 单条语句接口
- * @interface ISentence
- */
-export interface ISentence {
-  command: commandType; // 语句类型
-  commandRaw: string; // 命令的原始内容，方便调试
-  content: string; // 语句内容
-  args: Array<arg>; // 参数列表
-  sentenceAssets: Array<IAsset>; // 语句携带的资源列表
-  subScene: Array<string>; // 语句包含子场景列表
-}
-
-/**
- * 场景接口
- * @interface IScene
- */
-export interface IScene {
-  sceneName: string; // 场景名称
-  sceneUrl: string; // 场景url
-  sentenceList: Array<ISentence>; // 语句列表
-  assetsList: Array<IAsset>; // 资源列表
-  subSceneList: Array<string>; // 子场景的url列表
-}
-
-/**
- * 当前的场景数据
- * @interface ISceneData
- */
-export interface ISceneData {
-  currentSentenceId: number; // 当前语句ID
-  sceneStack: Array<sceneEntry>; // 场景栈
-  currentScene: IScene; // 当前场景数据
-}
-
-/**
- * 处理后的命令接口
- * @interface parsedCommand
- */
-export interface parsedCommand {
-  type: commandType;
-  additionalArgs: Array<arg>;
-}
+/**
+ * 语句类型
+ */
+import {sceneEntry} from "./runtimeInterface";
+import {fileType} from "./assets";
+
+export enum commandType {
+  say, // 对话
+  changeBg, // 更改背景
+  changeFigure, // 更改立绘
+  bgm, // 更改背景音乐
+  video, // 播放视频
+  pixi, // pixi演出
+  pixiInit, // pixi初始化
+  intro, // 黑屏文字演示
+  miniAvatar, // 小头像
+  changeScene, // 切换场景
+  choose, // 分支选择
+  end, // 结束游戏
+  setComplexAnimation, // 动画演出
+  setFilter, // 设置效果
+  label, // 标签
+  jumpLabel, // 跳转标签
+  chooseLabel, // 选择标签
+  setVar, // 设置变量
+  if, // 条件跳转
+  callScene, // 调用场景
+  showVars,
+  unlockCg,
+  unlockBgm,
+  filmMode,
+  setTextbox,
+  setAnimation,
+  playEffect,
+  setTempAnimation,
+  comment,
+  setTransform,
+  setTransition,
+}
+
+/**
+ * 单个参数接口
+ * @interface arg
+ */
+export interface arg {
+  key: string; // 参数键
+  value: string | boolean | number; // 参数值
+}
+
+/**
+ * 资源接口
+ * @interface IAsset
+ */
+export interface IAsset {
+  name: string; // 资源名称
+  type: fileType; // 资源类型
+  url: string; // 资源url
+  lineNumber: number; // 触发资源语句的行号
+}
+
+/**
+ * 单条语句接口
+ * @interface ISentence
+ */
+export interface ISentence {
+  command: commandType; // 语句类型
+  commandRaw: string; // 命令的原始内容，方便调试
+  content: string; // 语句内容
+  args: Array<arg>; // 参数列表
+  sentenceAssets: Array<IAsset>; // 语句携带的资源列表
+  subScene: Array<string>; // 语句包含子场景列表
+}
+
+/**
+ * 场景接口
+ * @interface IScene
+ */
+export interface IScene {
+  sceneName: string; // 场景名称
+  sceneUrl: string; // 场景url
+  sentenceList: Array<ISentence>; // 语句列表
+  assetsList: Array<IAsset>; // 资源列表
+  subSceneList: Array<string>; // 子场景的url列表
+}
+
+/**
+ * 当前的场景数据
+ * @interface ISceneData
+ */
+export interface ISceneData {
+  currentSentenceId: number; // 当前语句ID
+  sceneStack: Array<sceneEntry>; // 场景栈
+  currentScene: IScene; // 当前场景数据
+}
+
+/**
+ * 处理后的命令接口
+ * @interface parsedCommand
+ */
+export interface parsedCommand {
+  type: commandType;
+  additionalArgs: Array<arg>;
+}