webgal-parser 4.5.2 → 4.5.16

package/build/umd/index.global.js

@@ -36,52 +36,62 @@ var webgalParser = (function (exports) {
       commandType[commandType["setTransition"] = 30] = "setTransition";
       commandType[commandType["getUserInput"] = 31] = "getUserInput";
       commandType[commandType["applyStyle"] = 32] = "applyStyle";
+      commandType[commandType["wait"] = 33] = "wait";
   })(commandType || (commandType = {}));
 
   const SCRIPT_CONFIG = [
-      { scriptString: 'intro', scriptType: commandType.intro },
+      { scriptString: 'say', scriptType: commandType.say },
       { scriptString: 'changeBg', scriptType: commandType.changeBg },
       { scriptString: 'changeFigure', scriptType: commandType.changeFigure },
+      { scriptString: 'bgm', scriptType: commandType.bgm },
+      { scriptString: 'playVideo', scriptType: commandType.video },
+      { scriptString: 'pixiPerform', scriptType: commandType.pixi },
+      { scriptString: 'pixiInit', scriptType: commandType.pixiInit },
+      { scriptString: 'intro', scriptType: commandType.intro },
       { 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: 'chooseLabel', scriptType: commandType.chooseLabel },
       { scriptString: 'setVar', scriptType: commandType.setVar },
+      { scriptString: 'if', scriptType: commandType.if },
       { 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 },
+      { scriptString: 'setTempAnimation', scriptType: commandType.setTempAnimation },
+      // comment?
+      { scriptString: 'setTransform', scriptType: commandType.setTransform },
+      { scriptString: 'setTransition', scriptType: commandType.setTransition },
+      { scriptString: 'getUserInput', scriptType: commandType.getUserInput },
       { scriptString: 'applyStyle', scriptType: commandType.applyStyle },
+      { scriptString: 'wait', scriptType: commandType.wait },
   ];
   const ADD_NEXT_ARG_LIST = [
       commandType.bgm,
       commandType.pixi,
       commandType.pixiInit,
+      commandType.miniAvatar,
       commandType.label,
       commandType.if,
-      commandType.miniAvatar,
       commandType.setVar,
-      commandType.unlockBgm,
       commandType.unlockCg,
+      commandType.unlockBgm,
       commandType.filmMode,
       commandType.playEffect,
+      commandType.setTransition,
+      commandType.applyStyle,
   ];
 
   /**
@@ -117,10 +127,10 @@ var webgalParser = (function (exports) {
       });
       rawArgsList.forEach((e) => {
           const equalSignIndex = e.indexOf('=');
-          let argName = e.slice(0, equalSignIndex);
-          let argValue = e.slice(equalSignIndex + 1);
+          let argName = e.slice(0, equalSignIndex).trim();
+          let argValue = e.slice(equalSignIndex + 1).trim();
           if (equalSignIndex < 0) {
-              argName = e;
+              argName = e.trim();
               argValue = undefined;
           }
           // 判断是不是语音参数
@@ -181,7 +191,7 @@ var webgalParser = (function (exports) {
           };
       }
       // 截取命令
-      const getCommandResult = /:/.exec(newSentenceRaw);
+      const getCommandResult = /\s*:\s*/.exec(newSentenceRaw);
       // 没有command
       if (getCommandResult === null) {
           command = '';
@@ -303,12 +313,12 @@ var webgalParser = (function (exports) {
       }
   };
   function getChooseContent(contentRaw, assetSetter) {
-      const chooseList = contentRaw.split('|');
+      const chooseList = contentRaw.split(/(?<!\\)\|/);
       const chooseKeyList = [];
       const chooseValueList = [];
       for (const e of chooseList) {
-          chooseKeyList.push(e.split(':')[0] ?? '');
-          chooseValueList.push(e.split(':')[1] ?? '');
+          chooseKeyList.push(e.split(/(?<!\\):/)[0] ?? '');
+          chooseValueList.push(e.split(/(?<!\\):/)[1] ?? '');
       }
       const parsedChooseList = chooseValueList.map((e) => {
           if (e.match(/\./)) {
@@ -436,14 +446,16 @@ var webgalParser = (function (exports) {
       let commandRaw;
       // 正式开始解析
       // 去分号
-      let newSentenceRaw = sentenceRaw.split(/(?<!\\);/)[0];
+      const commentSplit = sentenceRaw.split(/(?<!\\);/);
+      let newSentenceRaw = commentSplit[0].trim();
       newSentenceRaw = newSentenceRaw.replaceAll('\\;', ';');
+      const sentenceComment = commentSplit[1] ?? '';
       if (newSentenceRaw === '') {
           // 注释提前返回
           return {
               command: commandType.comment,
               commandRaw: 'comment',
-              content: sentenceRaw.split(';')[1] ?? '',
+              content: sentenceComment.trim(),
               args: [{ key: 'next', value: true }],
               sentenceAssets: [],
               subScene: [], // 语句携带的子场景
@@ -1760,7 +1772,7 @@ var webgalParser = (function (exports) {
    * @return {IScene} 解析后的场景
    */
   const sceneParser = (rawScene, sceneName, sceneUrl, assetsPrefetcher, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG_MAP) => {
-      const rawSentenceList = rawScene.split('\n'); // 原始句子列表
+      const rawSentenceList = rawScene.replaceAll('\r', '').split('\n'); // 原始句子列表
       // 去分号留到后面去做了，现在注释要单独处理
       const rawSentenceListWithoutEmpty = rawSentenceList;
       // .map((sentence) => sentence.split(";")[0])
@@ -1816,6 +1828,198 @@ var webgalParser = (function (exports) {
       return [result, specialRules.trim()];
   }
 
+  /**
+   * Preprocessor for scene text.
+   *
+   * Use two-pass to generate a new scene text that concats multiline sequences
+   * into a single line and add placeholder lines to preserve the original number
+   * of lines.
+   *
+   * @param sceneText The original scene text
+   * @returns The processed scene text
+   */
+  function sceneTextPreProcess(sceneText) {
+      let lines = sceneText.replaceAll('\r', '').split('\n');
+      lines = sceneTextPreProcessPassOne(lines);
+      lines = sceneTextPreProcessPassTwo(lines);
+      return lines.join('\n');
+  }
+  /**
+   * Pass one.
+   *
+   * Add escape character to all lines that should be multiline.
+   *
+   * @param lines The original lines
+   * @returns The processed lines
+   */
+  function sceneTextPreProcessPassOne(lines) {
+      const processedLines = [];
+      let lastLineIsMultiline = false;
+      let thisLineIsMultiline = false;
+      for (const line of lines) {
+          thisLineIsMultiline = false;
+          if (canBeMultiline(line)) {
+              thisLineIsMultiline = true;
+          }
+          if (shouldNotBeMultiline(line, lastLineIsMultiline)) {
+              thisLineIsMultiline = false;
+          }
+          if (thisLineIsMultiline) {
+              processedLines[processedLines.length - 1] += '\\';
+          }
+          processedLines.push(line);
+          lastLineIsMultiline = thisLineIsMultiline;
+      }
+      return processedLines;
+  }
+  function canBeMultiline(line) {
+      if (!line.startsWith(' ')) {
+          return false;
+      }
+      const trimmedLine = line.trimStart();
+      return trimmedLine.startsWith('|') || trimmedLine.startsWith('-');
+  }
+  /**
+   * Logic to check if a line should not be multiline.
+   *
+   * @param line The line to check
+   * @returns If the line should not be multiline
+   */
+  function shouldNotBeMultiline(line, lastLineIsMultiline) {
+      if (!lastLineIsMultiline && isEmptyLine(line)) {
+          return true;
+      }
+      // Custom logic: if the line contains -concat, it should not be multiline
+      if (line.indexOf('-concat') !== -1) {
+          return true;
+      }
+      return false;
+  }
+  function isEmptyLine(line) {
+      return line.trim() === '';
+  }
+  /**
+   * Pass two.
+   *
+   * Traverse the lines to
+   * - remove escape characters
+   * - add placeholder lines to preserve the original number of lines.
+   *
+   * @param lines The lines in pass one
+   * @returns The processed lines
+   */
+  function sceneTextPreProcessPassTwo(lines) {
+      const processedLines = [];
+      let currentMultilineContent = "";
+      let placeHolderLines = [];
+      function concat(line) {
+          let trimmed = line.trim();
+          if (trimmed.startsWith('-')) {
+              trimmed = " " + trimmed;
+          }
+          currentMultilineContent = currentMultilineContent + trimmed;
+          placeHolderLines.push(placeholderLine(line));
+      }
+      for (const line of lines) {
+          console.log(line);
+          if (line.endsWith('\\')) {
+              const trueLine = line.slice(0, -1);
+              if (currentMultilineContent === "") {
+                  // first line
+                  currentMultilineContent = trueLine;
+              }
+              else {
+                  // middle line
+                  concat(trueLine);
+              }
+              continue;
+          }
+          if (currentMultilineContent !== "") {
+              // end line
+              concat(line);
+              processedLines.push(currentMultilineContent);
+              processedLines.push(...placeHolderLines);
+              placeHolderLines = [];
+              currentMultilineContent = "";
+              continue;
+          }
+          processedLines.push(line);
+      }
+      return processedLines;
+  }
+  /**
+   * Placeholder Line. Adding this line preserves the original number of lines
+   * in the scene text, so that it can be compatible with the graphical editor.
+   *
+   * @param content The original content on this line
+   * @returns The placeholder line
+   */
+  function placeholderLine(content = "") {
+      return ";_WEBGAL_LINE_BREAK_" + content;
+  }
+  // export function sceneTextPreProcess(sceneText: string): string {
+  //   const lines = sceneText.replaceAll('\r', '').split('\n');
+  //   const processedLines: string[] = [];
+  //   let lastNonMultilineIndex = -1;
+  //   let isInMultilineSequence = false;
+  //   function isMultiline(line: string): boolean {
+  //     if (!line.startsWith(' ')) return false;
+  //     const trimmedLine = line.trimStart();
+  //     return trimmedLine.startsWith('|') || trimmedLine.startsWith('-');
+  //   }
+  //   for (let i = 0; i < lines.length; i++) {
+  //     const line = lines[i];
+  //     if (line.trim() === '') {
+  //       // Empty line handling
+  //       if (isInMultilineSequence) {
+  //         // Check if the next line is a multiline line
+  //         let isStillInMulti = false;
+  //         for (let j = i + 1; j < lines.length; j++) {
+  //           const lookForwardLine = lines[j] || '';
+  //           // 遇到正常语句了，直接中断
+  //           if (lookForwardLine.trim() !== '' && !isMultiline(lookForwardLine)) {
+  //             isStillInMulti = false;
+  //             break;
+  //           }
+  //           // 必须找到后面接的是参数，并且中间没有遇到任何正常语句才行
+  //           if (lookForwardLine.trim() !== '' && isMultiline(lookForwardLine)) {
+  //             isStillInMulti = true;
+  //             break;
+  //           }
+  //         }
+  //         if (isStillInMulti) {
+  //           // Still within a multiline sequence
+  //           processedLines.push(';_WEBGAL_LINE_BREAK_');
+  //         } else {
+  //           // End of multiline sequence
+  //           isInMultilineSequence = false;
+  //           processedLines.push(line);
+  //         }
+  //       } else {
+  //         // Preserve empty lines outside of multiline sequences
+  //         processedLines.push(line);
+  //       }
+  //     } else if (isMultiline(line)) {
+  //       // Multiline statement handling
+  //       if (lastNonMultilineIndex >= 0) {
+  //         // Concatenate to the previous non-multiline statement
+  //         const trimedLine = line.trimStart();
+  //         const addBlank = trimedLine.startsWith('-') ? ' ' : '';
+  //         processedLines[lastNonMultilineIndex] += addBlank + trimedLine;
+  //       }
+  //       // Add the special comment line
+  //       processedLines.push(';_WEBGAL_LINE_BREAK_' + line);
+  //       isInMultilineSequence = true;
+  //     } else {
+  //       // Non-multiline statement handling
+  //       processedLines.push(line);
+  //       lastNonMultilineIndex = processedLines.length - 1;
+  //       isInMultilineSequence = false;
+  //     }
+  //   }
+  //   return processedLines.join('\n');
+  // }
+
   class SceneParser {
       assetsPrefetcher;
       assetSetter;
@@ -1862,6 +2066,7 @@ var webgalParser = (function (exports) {
   exports.ADD_NEXT_ARG_LIST = ADD_NEXT_ARG_LIST;
   exports.SCRIPT_CONFIG = SCRIPT_CONFIG;
   exports.default = SceneParser;
+  exports.sceneTextPreProcess = sceneTextPreProcess;
 
   Object.defineProperty(exports, '__esModule', { value: true });
 

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "webgal-parser",
-  "version": "4.5.2",
+  "version": "4.5.16",
   "description": "WebGAL script parser",
   "scripts": {
     "test": "vitest",
     "coverage": "vitest run --coverage",
     "build": "rimraf -rf ./build && rollup --config",
+    "prepublishOnly": "npm run build",
     "build-ci": "rollup --config",
     "debug": "tsx test/debug.ts",
-    "debug-scss-parser": "tsx test/debugCssParser.ts"
+    "debug-scss-parser": "tsx test/debugCssParser.ts",
+    "debug-linebreak-parser": "tsx test/debug-linebreak.ts"
   },
   "types": "./build/types/index.d.ts",
   "module": "./build/es/index.js",
@@ -29,7 +31,7 @@
     "@types/lodash": "^4.14.189",
     "@types/node": "^18.14.0",
     "@vitest/coverage-c8": "^0.28.5",
-    "rollup": "^3.3.0",
+    "rollup": "^3.29.5",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.34.1",

package/src/config/scriptConfig.ts

@@ -1,49 +1,58 @@
 import {commandType} from '../interface/sceneInterface';
 
 export const SCRIPT_CONFIG = [
-  { scriptString: 'intro', scriptType: commandType.intro },
+  { scriptString: 'say', scriptType: commandType.say },
   { scriptString: 'changeBg', scriptType: commandType.changeBg },
   { scriptString: 'changeFigure', scriptType: commandType.changeFigure },
+  { scriptString: 'bgm', scriptType: commandType.bgm },
+  { scriptString: 'playVideo', scriptType: commandType.video },
+  { scriptString: 'pixiPerform', scriptType: commandType.pixi },
+  { scriptString: 'pixiInit', scriptType: commandType.pixiInit },
+  { scriptString: 'intro', scriptType: commandType.intro },
   { 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: 'chooseLabel', scriptType: commandType.chooseLabel },
   { scriptString: 'setVar', scriptType: commandType.setVar },
+  { scriptString: 'if', scriptType: commandType.if },
   { 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 },
+  { scriptString: 'setTempAnimation', scriptType: commandType.setTempAnimation },
+  // comment?
+  { scriptString: 'setTransform', scriptType: commandType.setTransform },
+  { scriptString: 'setTransition', scriptType: commandType.setTransition },
+  { scriptString: 'getUserInput', scriptType: commandType.getUserInput },
   { scriptString: 'applyStyle', scriptType: commandType.applyStyle },
+  { scriptString: 'wait', scriptType: commandType.wait },
 ];
 export const ADD_NEXT_ARG_LIST = [
   commandType.bgm,
   commandType.pixi,
   commandType.pixiInit,
+  commandType.miniAvatar,
   commandType.label,
   commandType.if,
-  commandType.miniAvatar,
   commandType.setVar,
-  commandType.unlockBgm,
   commandType.unlockCg,
+  commandType.unlockBgm,
   commandType.filmMode,
   commandType.playEffect,
+  commandType.setTransition,
+  commandType.applyStyle,
 ];
 
 export type ConfigMap = Map<string, ConfigItem>;

package/src/configParser/configParser.ts

@@ -26,7 +26,7 @@ function configLineParser(inputLine: string): IConfigItem {
     };
   }
   // 截取命令
-  const getCommandResult = /:/.exec(newSentenceRaw);
+  const getCommandResult = /\s*:\s*/.exec(newSentenceRaw);
 
   // 没有command
   if (getCommandResult === null) {

package/src/index.ts

@@ -8,7 +8,8 @@ import { configParser, WebgalConfig } from './configParser/configParser';
 import { fileType } from './interface/assets';
 import { IAsset } from './interface/sceneInterface';
 import { sceneParser } from './sceneParser';
-import {IWebGALStyleObj, scss2cssinjsParser} from "./styleParser";
+import { IWebGALStyleObj, scss2cssinjsParser } from "./styleParser";
+import { sceneTextPreProcess } from "./sceneTextPreProcessor";
 
 export default class SceneParser {
   private readonly SCRIPT_CONFIG_MAP: ConfigMap;
@@ -76,3 +77,4 @@ export default class SceneParser {
 }
 
 export { ADD_NEXT_ARG_LIST, SCRIPT_CONFIG };
+export { sceneTextPreProcess };

package/src/interface/runtimeInterface.ts

@@ -7,3 +7,9 @@ export interface sceneEntry {
   sceneUrl: string; // 场景url
   continueLine: number; // 继续原场景的行号
 }
+
+/**
+ * 场景栈条目接口 (兼容性别名)
+ * @interface ISceneEntry
+ */
+export interface ISceneEntry extends sceneEntry {}

package/src/interface/sceneInterface.ts

@@ -1,7 +1,7 @@
 /**
  * 语句类型
  */
-import { sceneEntry } from './runtimeInterface';
+import { sceneEntry, ISceneEntry } from './runtimeInterface';
 import { fileType } from './assets';
 
 export enum commandType {
@@ -37,7 +37,8 @@ export enum commandType {
   setTransform,
   setTransition,
   getUserInput,
-  applyStyle
+  applyStyle,
+  wait,
 }
 
 /**
@@ -91,7 +92,7 @@ export interface IScene {
  */
 export interface ISceneData {
   currentSentenceId: number; // 当前语句ID
-  sceneStack: Array<sceneEntry>; // 场景栈
+  sceneStack: Array<ISceneEntry>; // 场景栈
   currentScene: IScene; // 当前场景数据
 }
 

package/src/sceneParser.ts

@@ -29,7 +29,7 @@ export const sceneParser = (
   ADD_NEXT_ARG_LIST: commandType[],
   SCRIPT_CONFIG_MAP: ConfigMap,
 ): IScene => {
-  const rawSentenceList = rawScene.split('\n'); // 原始句子列表
+  const rawSentenceList = rawScene.replaceAll('\r', '').split('\n'); // 原始句子列表
 
   // 去分号留到后面去做了，现在注释要单独处理
   const rawSentenceListWithoutEmpty = rawSentenceList;