webgal-parser 4.6.1 → 4.6.3-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webgal-parser",
-  "version": "4.6.1",
+  "version": "4.6.3-beta.1",
   "description": "WebGAL script parser",
   "scripts": {
     "test": "vitest",
@@ -17,26 +17,16 @@
   "main": "./build/cjs/index.cjs",
   "author": "Mahiru <Mahiru_@outlook.com>",
   "license": "MPL-2.0",
-  "dependencies": {
-    "chevrotain": "^10.5.0",
-    "cloudlogjs": "^1.0.11",
-    "lodash": "^4.17.23",
-    "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",
+    "rimraf": "^3.0.2",
     "rollup": "^3.29.5",
-    "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",
+    "tsx": "^3.12.7",
     "typescript": "^4.9.3",
     "vitest": "^0.28.5"
   },

package/src/config/scriptConfig.ts

@@ -39,6 +39,7 @@ export const SCRIPT_CONFIG = [
   { scriptString: 'applyStyle', scriptType: commandType.applyStyle },
   { scriptString: 'wait', scriptType: commandType.wait },
   { scriptString: 'callSteam', scriptType: commandType.callSteam },
+  { scriptString: 'return', scriptType: commandType.return },
 ];
 export const ADD_NEXT_ARG_LIST = [
   commandType.bgm,

package/src/index.ts

@@ -9,7 +9,11 @@ import { fileType } from './interface/assets';
 import { IAsset } from './interface/sceneInterface';
 import { sceneParser } from './sceneParser';
 import { IWebGALStyleObj, scss2cssinjsParser } from "./styleParser";
-import { sceneTextPreProcess } from "./sceneTextPreProcessor";
+import {
+  isLineBreakPlaceholder,
+  sceneTextPreProcess,
+  WEBGAL_LINE_BREAK_MARK,
+} from "./sceneTextPreProcessor";
 
 export default class SceneParser {
   private readonly SCRIPT_CONFIG_MAP: ConfigMap;
@@ -77,4 +81,4 @@ export default class SceneParser {
 }
 
 export { ADD_NEXT_ARG_LIST, SCRIPT_CONFIG };
-export { sceneTextPreProcess };
+export { sceneTextPreProcess, isLineBreakPlaceholder, WEBGAL_LINE_BREAK_MARK };

package/src/interface/runtimeInterface.ts

@@ -6,6 +6,8 @@ export interface sceneEntry {
   sceneName: string; // 场景名称
   sceneUrl: string; // 场景url
   continueLine: number; // 继续原场景的行号
+  locals?: Record<string, any>; // 该帧的局部变量
+  writeReturnTo?: string; // 返回值写回该帧的哪个变量
 }
 
 /**

package/src/interface/sceneInterface.ts

@@ -40,6 +40,7 @@ export enum commandType {
   applyStyle,
   wait,
   callSteam, // 调用Steam功能
+  return, // 从被调用的场景返回
 }
 
 /**
@@ -74,6 +75,15 @@ export interface ISentence {
   sentenceAssets: Array<IAsset>; // 语句携带的资源列表
   subScene: Array<string>; // 语句包含子场景列表
   inlineComment: string; // 行内注释
+  /**
+   * 本语句在原始场景文件中占据的行范围（0-based，含首尾）。
+   * 单行语句 startLine === endLine；多行语句 endLine 指向最后一条续行。
+   * 图形编辑器据此做「只替换被编辑语句所占的行」。
+   */
+  startLine: number;
+  endLine: number;
+  /** 本条是多行语句被折叠掉的续行占位，仅用于补齐行数，不应展示给用户 */
+  isLineBreakHolder: boolean;
 }
 
 /**

package/src/sceneParser.ts

@@ -5,9 +5,12 @@ import {
   ISentence,
 } from './interface/sceneInterface';
 import { scriptParser } from './scriptParser/scriptParser';
-import uniqWith from 'lodash/uniqWith';
 import { fileType } from './interface/assets';
 import { ConfigMap } from './config/scriptConfig';
+import {
+  isLineBreakPlaceholder,
+  sceneTextPreProcess,
+} from './sceneTextPreProcessor';
 
 /**
  * 场景解析器
@@ -29,7 +32,9 @@ export const sceneParser = (
   ADD_NEXT_ARG_LIST: commandType[],
   SCRIPT_CONFIG_MAP: ConfigMap,
 ): IScene => {
-  const rawSentenceList = rawScene.replaceAll('\r', '').split('\n'); // 原始句子列表
+  // 预处理把多行语句折叠进它的首行，并用占位行补齐被折叠掉的行，
+  // 因此这里的行数与原始场景严格一致，「语句 index == 文件行号」始终成立。
+  const rawSentenceList = sceneTextPreProcess(rawScene).split('\n'); // 原始句子列表
 
   // 去分号留到后面去做了，现在注释要单独处理
   const rawSentenceListWithoutEmpty = rawSentenceList;
@@ -53,8 +58,10 @@ export const sceneParser = (
     },
   );
 
+  markMultilineRanges(sentenceList, rawSentenceList);
+
   // 开始资源的预加载
-  assetsList = uniqWith(assetsList); // 去重
+  assetsList = deduplicateAssets(assetsList);
   assetsPrefetcher(assetsList);
 
   return {
@@ -65,3 +72,45 @@ export const sceneParser = (
     subSceneList: subSceneList, // 子场景列表
   };
 };
+
+/**
+ * 回填多行语句的行范围。
+ *
+ * 预处理后，一条多行语句的完整内容都落在它的首行，紧跟其后的若干占位行
+ * 就是被折叠掉的续行。这里把占位行标记出来，并把首行语句的 endLine
+ * 推到最后一条续行，图形编辑器据此按整个行范围替换语句。
+ *
+ * @param sentenceList 解析后的语句列表
+ * @param processedLines 预处理后的行，与 sentenceList 一一对应
+ */
+const markMultilineRanges = (
+  sentenceList: ISentence[],
+  processedLines: string[],
+) => {
+  let headIndex = -1; // 最近一条非占位语句的下标，即当前多行语句的首行
+  for (let index = 0; index < sentenceList.length; index++) {
+    if (!isLineBreakPlaceholder(processedLines[index])) {
+      headIndex = index;
+      continue;
+    }
+    sentenceList[index].isLineBreakHolder = true;
+    if (headIndex >= 0) {
+      sentenceList[headIndex].endLine = index;
+    }
+  }
+};
+
+const deduplicateAssets = (assetsList: IAsset[]): IAsset[] => {
+  const seenAssets = new Set<string>();
+  return assetsList.filter((asset) => {
+    if (!asset || typeof asset.url !== 'string' || asset.url === '') {
+      return false;
+    }
+    const assetKey = `${asset.type}:${asset.url}`;
+    if (seenAssets.has(assetKey)) {
+      return false;
+    }
+    seenAssets.add(assetKey);
+    return true;
+  });
+};

package/src/sceneTextPreProcessor.ts

@@ -31,15 +31,11 @@ function sceneTextPreProcessPassOne(lines: string[]): string[] {
   let thisLineIsMultiline = false;
 
   for (const line of lines) {
-    thisLineIsMultiline = false;
-
-    if (canBeMultiline(line)) {
-      thisLineIsMultiline = true;
-    }
-
-    if (shouldNotBeMultiline(line, lastLineIsMultiline)) {
-      thisLineIsMultiline = false;
-    }
+    // 续行需要接到上一行，所以场景的第一行永远不会是续行。
+    thisLineIsMultiline =
+      processedLines.length > 0 &&
+      canBeMultiline(line) &&
+      !shouldNotBeMultiline(line, lastLineIsMultiline);
 
     if (thisLineIsMultiline) {
       processedLines[processedLines.length - 1] += '\\';
@@ -111,7 +107,6 @@ function sceneTextPreProcessPassTwo(lines: string[]): string[] {
   }
 
   for (const line of lines) {
-    console.log(line);
     if (line.endsWith('\\')) {
       const trueLine = line.slice(0, -1);
 
@@ -139,9 +134,28 @@ function sceneTextPreProcessPassTwo(lines: string[]): string[] {
     processedLines.push(line);
   }
 
+  // 场景末行仍以 \ 结尾时循环里没有机会收尾，在这里把累积的内容补出去。
+  if (currentMultilineContent !== "") {
+    processedLines.push(currentMultilineContent, ...placeHolderLines);
+  }
+
   return processedLines;
 }
 
+/**
+ * 占位行的前缀。占位行本身是一条注释，引擎会空跑掉；
+ * 它的作用是让预处理后的行数与原始场景一致，从而保持
+ * 「解析后语句 index == 文件行号」这一不变量。
+ */
+export const WEBGAL_LINE_BREAK_MARK = ';_WEBGAL_LINE_BREAK_';
+
+/**
+ * 判断预处理后的某一行是否是占位行，即它是上一条多行语句折叠掉的续行。
+ */
+export function isLineBreakPlaceholder(processedLine: string): boolean {
+  return processedLine.startsWith(WEBGAL_LINE_BREAK_MARK);
+}
+
 /**
  * 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.
@@ -150,74 +164,5 @@ function sceneTextPreProcessPassTwo(lines: string[]): string[] {
  * @returns The placeholder line
  */
 function placeholderLine(content = "") {
-  return ";_WEBGAL_LINE_BREAK_" + content;
+  return WEBGAL_LINE_BREAK_MARK + 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');
-// }

package/src/scriptParser/argsParser.ts

@@ -30,7 +30,7 @@ export function argsParser(
       argValue = undefined;
     }
     // 判断是不是语音参数
-    if (argName.toLowerCase().match(/.ogg|.mp3|.wav/)) {
+    if (argName.toLowerCase().match(/.ogg|.mp3|.wav|.opus/)) {
       returnArrayList.push({
         key: 'vocal',
         value: assetSetter(e, fileType.vocal),

package/src/scriptParser/scriptParser.ts

@@ -40,7 +40,7 @@ export const scriptParser = (
   const commentSplit = sentenceRaw.split(/(?<!\\);/);
   let newSentenceRaw = commentSplit[0];
   newSentenceRaw = newSentenceRaw.replaceAll('\\;',';');
-  const sentenceComment = commentSplit[1] ?? '';
+  const sentenceComment = commentSplit.slice(1).join(';');
   if (newSentenceRaw.trim() === '') {
     // 注释提前返回
     return {
@@ -51,6 +51,9 @@ export const scriptParser = (
       sentenceAssets: [], // 语句携带的资源列表
       subScene: [], // 语句携带的子场景
       inlineComment: '', // 行内注释
+      startLine: lineNumber,
+      endLine: lineNumber,
+      isLineBreakHolder: false,
     };
   }
   // 截取命令
@@ -116,5 +119,9 @@ export const scriptParser = (
     sentenceAssets: sentenceAssets, // 语句携带的资源列表
     subScene: subScene, // 语句携带的子场景
     inlineComment: sentenceComment.trim(), // 行内注释
+    // 单行语句的行范围就是自己，多行语句的 endLine 由 sceneParser 回填
+    startLine: lineNumber,
+    endLine: lineNumber,
+    isLineBreakHolder: false,
   };
 };