hzengine-core 0.1.2-dev

package/src/script/strtools.ts

@@ -0,0 +1,159 @@
+/**
+ * 将一行字符串切割为(str,quoted)[]的形式
+ * @param str
+ * @returns
+ */
+export function splitStr2Objs(str: string) {
+  // console.log(`splitStr2Objs: ${str}`);
+  
+  let res: { str: string; isQuoted?: boolean; isSquared?: boolean, isRounded?: boolean }[] = [];
+  let len = str.length;
+  let p = 0;
+  while (p < len) {
+    while (p < len && str[p] === " ") ++p; // find first not space
+    if (p === len) return res;
+    if (str[p] === '"') {
+      // find next `"`
+      let q = p + 1;
+      while (q < len && str[q] !== '"') {
+        if (str[q] === "\\") q += 2;
+        else ++q;
+      }
+      if (q >= len) throw "Quote not completed";
+      let resstr = str.slice(p + 1, q);
+      //   console.log(`Transformed[${res.length}]:\n${transformStr(resstr)}`);
+      let transformedStr: string = "error";
+      try {
+        transformedStr = transformStr(resstr);
+      } catch (e) {
+        throw "该字符串中的转义字符有错误：" + resstr;
+      }
+      res.push({ str: transformedStr!, isQuoted: true });
+      p = q + 1;
+    } else if (str[p] === "[") {
+      // find next `]`
+      let q = p + 1;
+      while (q < len && str[q] !== "]") {
+        // if (str[q] === "\\") q += 2;
+        // else ++q;
+        ++q;
+      }
+      if (q >= len) throw "square brackets not completed";
+      let resstr = str.slice(p + 1, q);
+      res.push({ str: resstr, isSquared: true });
+      p = q + 1;
+    } else if (str[p] === "(") {
+      // find next `)`
+      let q = p + 1;
+      while (q < len && str[q] !== ")") {
+        // if (str[q] === "\\") q += 2;
+        // else ++q;
+        ++q;
+      }
+      if (q >= len) throw "round brackets not completed";
+      let resstr = str.slice(p + 1, q);
+      res.push({ str: resstr, isRounded: true });
+      p = q + 1;
+    }
+     else {
+      let q = p + 1;
+      while (q < len && str[q] !== " " && str[q] !== '"' && str[q] !== "(" && str[q] !== "[") ++q; // find first space/quote after this
+      let resstr = str.slice(p, q);
+      //   console.log(transformStr(resstr));
+      res.push({ str: resstr, isQuoted: false });
+      p = q;
+    }
+  }
+  return res;
+}
+
+export function mergeObjs2Str(
+  objs: { str: string; isQuoted?: boolean; isSquared?: boolean, isRounded?: boolean }[]
+) {
+  return objs
+    .map((obj) =>
+      obj.isQuoted ? `"${obj.str}"` : obj.isSquared ? `[${obj.str}]` : obj.isRounded ? `(${obj.str})` : obj.str
+    )
+    .join(" ");
+}
+
+export function splitStr2Strs(str: string) {
+  return splitStr2Objs(str).map((obj) =>
+    obj.isQuoted ? `"${obj.str}"` : obj.str
+  );
+}
+
+/**
+ * 转义一遍字符串，使其中\n等变成对应字符（可能报错）
+ * @param str
+ * @returns
+ */
+export function transformStr(str: string) {
+  return JSON.parse(`"${str}"`);
+}
+
+// 翻译hzengine script插值字符串
+// 语法："...[expression]..."
+// 如果希望在字符串中显示`[`，请使用两个`[`，如`"[[正常显示而不被当作表达式的文字]]"`
+export function parseInterpolatedStr(str: string): ParsedInterpolationItem[] {
+  let len = str.length;
+  let p = 0;
+  let expr_record: [l: number, r: number][] = [];
+  while (p < len) {
+    // 寻找第一个`[`
+    while (p < len && str[p] !== "[") ++p;
+    if (p >= len) break;
+    // 判断是否是两个`[`
+    if (str[p] === "[" && str[p + 1] === "[") {
+      p += 2;
+      continue;
+    }
+    // 寻找第一个`]`
+    let q = p + 1;
+    while (q < len && str[q] !== "]") {
+      ++q;
+      // 判断是否是两个`]`
+      while (q < len && str[q] === "]" && str[q + 1] === "]") {
+        q += 2;
+      }
+    }
+    if (q >= len) {
+      // 没有找到`]`，报错
+      throw `Interpolated string lose closing bracket: ${str}`;
+    }
+    expr_record.push([p, q]);
+    p = q + 1;
+  }
+  let left = 0,
+    right = len;
+  let res: ParsedInterpolationItem[] = [];
+  for (let i = 0; i < expr_record.length; ++i) {
+    let [l, r] = expr_record[i];
+    if (l > left) res.push({ str: str.slice(left, l), isExpression: false });
+    res.push({ str: str.slice(l + 1, r), isExpression: true });
+    left = r + 1;
+  }
+  if (left < right)
+    res.push({ str: str.slice(left, right), isExpression: false });
+  return res;
+}
+
+export function removeComment(str: string) {
+  let quoteNotClosed = false;
+  let len = str.length;
+  for (let i = 0; i < len; ++i) {
+    if (quoteNotClosed && str[i] === `\\`) {
+      ++i;
+    } else if (str[i] === `"`) {
+      quoteNotClosed = !quoteNotClosed;
+    } else if (str[i] === "#" && !quoteNotClosed) {
+      return str.slice(0, i);
+    }
+  }
+  return str;
+}
+
+type ParsedInterpolationItem = {
+  str: string;
+  isExpression: boolean;
+};

package/src/storage/decorator.ts

@@ -0,0 +1,473 @@
+import { HZEngineCore, Platform, Storage } from "../index.js";
+import { Async } from "../async/index.js";
+
+/**
+ * 存档属性装饰器
+ * @param store_key 保存数据到存档数据对象的key
+ * @returns
+ */
+export function Save<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore },
+  Value extends Storage.Saveable<Value>
+>(store_key: string) {
+  return function (
+    target: ClassAccessorDecoratorTarget<This, Value>,
+    context: ClassAccessorDecoratorContext<This, Value>
+  ) {
+    context.addInitializer(function () {
+      Async.nextTick(() => {
+        const core = this._core;
+        core.on("initArchiveData", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            true,
+            target.get.call(this),
+            ...store_key.split(".")
+          );
+        });
+        core.on("beforeSaveArchive", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            false,
+            target.get.call(this),
+            ...store_key.split(".")
+          );
+        });
+
+        core.on("afterLoadArchive", () => {
+          let dataInArchive = core.storage.getSaveableData(
+            core.storage.archiveData,
+            false,
+            ...store_key.split(".")
+          ) as Value;
+          this._core.debug.log(
+            `Load Data from Archive, store_key: ${store_key}, dataInArchive: ${JSON.stringify(
+              dataInArchive
+            )}`
+          );
+          target.set.call(this, dataInArchive);
+        });
+      });
+    });
+    if (context.kind !== "accessor") {
+      throw new Error("ArchiveStateAccessor只能用于accessor属性");
+    }
+    return {
+      get() {
+        target = target as ClassAccessorDecoratorTarget<This, Value>;
+        return archiveStateGetter<PlatformType, This, Value>(this, store_key, target.get);
+      },
+      set(value) {
+        target = target as ClassAccessorDecoratorTarget<This, Value>;
+        archiveStateSetter<PlatformType, This, Value>(this, store_key, target.set, value);
+      },
+    } as ClassAccessorDecoratorResult<This, Value>;
+  };
+}
+
+/**
+ * 存档属性装饰器
+ * @param store_key 保存数据到存档数据对象的key
+ * @returns
+ */
+export function CustomSave<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore },
+  Value,
+  SerializedValue extends Storage.Saveable<SerializedValue>
+>(
+  store_key: string,
+  serializer: (this: This, value: Value) => SerializedValue,
+  deserializer: (this: This, value: SerializedValue) => Value
+) {
+  return (
+    target: ClassAccessorDecoratorTarget<This, Value>,
+    context: ClassAccessorDecoratorContext<This, Value>
+  ) => {
+    if (context.kind !== "accessor") {
+      throw new Error("ArchiveStateAccessor只能用于accessor属性");
+    }
+    context.addInitializer(function () {
+      Async.nextTick(() => {
+        const core = this._core;
+        core.on("initArchiveData", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            true,
+            serializer.call(this, target.get.call(this)),
+            ...store_key.split(".")
+          );
+        });
+        core.on("beforeSaveArchive", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            false,
+            serializer.call(this, target.get.call(this)),
+            ...store_key.split(".")
+          );
+        });
+
+        core.on("afterLoadArchive", () => {
+          let dataInArchive = core.storage.getSaveableData(
+            core.storage.archiveData,
+            false,
+            ...store_key.split(".")
+          ) as SerializedValue;
+          this._core.debug.log(
+            `Load Data from Archive, store_key: ${store_key}, dataInArchive: ${JSON.stringify(
+              dataInArchive
+            )}`
+          );
+          target.set.call(this, deserializer.call(this, dataInArchive));
+        });
+      });
+    });
+    return {
+      get() {
+        target = target as ClassAccessorDecoratorTarget<This, Value>;
+        return archiveStateGetterWithSerializer<PlatformType, This, Value, SerializedValue>(
+          this,
+          store_key,
+          target.get,
+          serializer
+        );
+      },
+      set(value) {
+        target = target as ClassAccessorDecoratorTarget<This, Value>;
+        archiveStateSetterWithDeserializer<PlatformType, This, Value, SerializedValue>(
+          this,
+          store_key,
+          target.set,
+          value,
+          deserializer
+        );
+      },
+    } as ClassAccessorDecoratorResult<This, Value>;
+  };
+}
+
+export function SaveGetter<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value extends Storage.Saveable<Value>
+>(store_key: string) {
+  return (
+    target: ClassGetterDecoratorTarget<PlatformType, This, Value>,
+    context: ClassGetterDecoratorContext<This, Value>
+  ) => {
+    context.addInitializer(function () {
+      Async.nextTick(() => {
+        const core = this._core;
+        core.on("initArchiveData", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            true,
+            target.call(this),
+            ...store_key.split(".")
+          );
+        });
+        core.on("beforeSaveArchive", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            false,
+            target.call(this),
+            ...store_key.split(".")
+          );
+        });
+      });
+    });
+    if (context.kind !== "getter") {
+      throw new Error("ArchiveStateGetter只能用于getter属性");
+    }
+    return function (this: This) {
+      let val = archiveStateGetter<PlatformType, This, Value>(
+        this,
+        store_key,
+        target as ClassGetterDecoratorTarget<PlatformType, This, Value>
+      );
+      return val;
+    };
+  };
+}
+
+export function CustomSaveGetter<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value,
+  SerializedValue extends Storage.Saveable<SerializedValue>
+>(
+  store_key: string,
+  serializer: (this: This, value: Value) => SerializedValue
+) {
+  return (
+    target: ClassGetterDecoratorTarget<PlatformType, This, Value>,
+    context: ClassGetterDecoratorContext<This, Value>
+  ) => {
+    if (context.kind !== "getter") {
+      throw new Error("ArchiveStateGetter只能用于getter属性");
+    }
+    context.addInitializer(function () {
+      Async.nextTick(() => {
+        const core = this._core;
+        core.on("initArchiveData", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            true,
+            serializer.call(this, target.call(this)),
+            ...store_key.split(".")
+          );
+        });
+        core.on("beforeSaveArchive", () => {
+          core.storage.setSaveableData(
+            core.storage.archiveData,
+            false,
+            serializer.call(this, target.call(this)),
+            ...store_key.split(".")
+          );
+        });
+      });
+    });
+    return function (this: This) {
+      let val = archiveStateGetterWithSerializer<PlatformType, This, Value, SerializedValue>(
+        this,
+        store_key,
+        target as ClassGetterDecoratorTarget<PlatformType, This, Value>,
+        serializer
+      );
+      return val;
+    };
+  };
+}
+
+/**
+ * 存档属性装饰器
+ * @param store_key 保存数据到存档数据对象的key
+ * @returns
+ */
+export function SaveSetter<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value extends Storage.Saveable<Value>
+>(store_key: string) {
+  return (
+    target: ClassSetterDecoratorTarget<PlatformType, This, Value>,
+    context: ClassSetterDecoratorContext<This, Value>
+  ) => {
+    if (context.kind !== "setter") {
+      throw new Error("ArchiveStateSetter只能用于setter属性");
+    }
+    context.addInitializer(function () {
+      Async.nextTick(() => {
+        let core = this._core;
+        core.on("afterLoadArchive", () => {
+          let dataInArchive = core.storage.getSaveableData(
+            core.storage.archiveData,
+            false,
+            ...store_key.split(".")
+          ) as Value;
+          this._core.debug.log(
+            `Load Data from Archive, store_key: ${store_key}, dataInArchive: ${JSON.stringify(
+              dataInArchive
+            )}`
+          );
+          target.call(this, dataInArchive);
+        });
+      });
+    });
+    return function (this: This, value: Value) {
+      archiveStateSetter<PlatformType, This, Value>(
+        this,
+        store_key,
+        target as ClassSetterDecoratorTarget< PlatformType, This, Value>,
+        value
+      );
+    };
+  };
+}
+
+export function CustomSaveSetter<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value,
+  SerializedValue extends Storage.Saveable<SerializedValue>
+>(
+  store_key: string,
+  deserializer: (this: This, value: SerializedValue) => Value
+) {
+  return (
+    target: ClassSetterDecoratorTarget<PlatformType, This, Value>,
+    context: ClassSetterDecoratorContext<This, Value>
+  ) => {
+    if (context.kind !== "setter") {
+      throw new Error("ArchiveStateSetter只能用于setter属性");
+    }
+    context.addInitializer(function () {
+      Async.nextTick(() => {
+        let core = this._core;
+        core.on("afterLoadArchive", () => {
+          let dataInArchive = core.storage.getSaveableData(
+            core.storage.archiveData,
+            false,
+            ...store_key.split(".")
+          ) as SerializedValue;
+          this._core.debug.log(
+            `Load Data from Archive, store_key: ${store_key}, dataInArchive: ${JSON.stringify(
+              dataInArchive
+            )}`
+          );
+          target.call(this, deserializer.call(this, dataInArchive));
+        });
+      });
+    });
+    return function (this: This, value: Value) {
+      archiveStateSetterWithDeserializer<PlatformType, This, Value, SerializedValue>(
+        this,
+        store_key,
+        target as ClassSetterDecoratorTarget<PlatformType, This, Value>,
+        value,
+        deserializer
+      );
+    };
+  };
+}
+
+/**
+ * 存档属性装饰器
+ * @param store_key 保存数据到存档数据对象的key
+ * @returns
+ */
+function archiveStateGetter<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value extends Storage.Saveable<Value>
+>(_this: This, store_key: string, old_getter: (this: This) => Value) {
+  const core = _this._core;
+  // if (!core.storage._archiveStateGetterRegisteredList.has(store_key)) {
+  //   core.storage._archiveStateGetterRegisteredList.add(store_key);
+  //   core.on("initArchiveData", () => {
+  //     core.storage.setSaveableData(
+  //       core.storage.archiveData,
+  //       true,
+  //       old_getter.call(_this),
+  //       ...store_key.split(".")
+  //     );
+  //   });
+  //   core.on("beforeSaveArchive", () => {
+  //     core.storage.setSaveableData(
+  //       core.storage.archiveData,
+  //       false,
+  //       old_getter.call(_this),
+  //       ...store_key.split(".")
+  //     );
+  //   });
+  // }
+  let val = old_getter.call(_this);
+  // console.log(`getval: ${val}`);
+  return val;
+}
+
+/**
+ * 存档属性装饰器
+ * @param store_key 保存数据到存档数据对象的key
+ * @returns
+ */
+function archiveStateGetterWithSerializer<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value,
+  SerializedValue extends Storage.Saveable<SerializedValue>
+>(
+  _this: This,
+  store_key: string,
+  old_getter: (this: This) => Value,
+  serializer: (this: This, value: Value) => SerializedValue
+) {
+  const core = _this._core;
+  // if (!core.storage._archiveStateGetterRegisteredList.has(store_key)) {
+  //   core.storage._archiveStateGetterRegisteredList.add(store_key);
+  //   core.on("initArchiveData", () => {
+  //     core.storage.setSaveableData(
+  //       core.storage.archiveData,
+  //       true,
+  //       serializer.call(_this, old_getter.call(_this)),
+  //       ...store_key.split(".")
+  //     );
+  //   });
+  //   core.on("beforeSaveArchive", () => {
+  //     core.storage.setSaveableData(
+  //       core.storage.archiveData,
+  //       false,
+  //       serializer.call(_this, old_getter.call(_this)),
+  //       ...store_key.split(".")
+  //     );
+  //   });
+  // }
+  let val = old_getter.call(_this);
+  // console.log(`getval: ${val}`);
+  return val;
+}
+
+function archiveStateSetter<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value extends Storage.Saveable<Value>
+>(
+  _this: This,
+  store_key: string,
+  old_setter: (this: This, value: Value) => void,
+  val: Value
+) {
+  // const core = _this._core;
+  // if (!core.storage._archiveStateSetterRegisteredList.has(store_key)) {
+  //   core.storage._archiveStateSetterRegisteredList.add(store_key);
+  //   core.on("afterLoadArchive", () => {
+  //     let dataInArchive = core.storage.getSaveableData(
+  //       core.storage.archiveData,
+  //       false,
+  //       ...store_key.split(".")
+  //     ) as Value;
+  //     console.log(`Load Data from Archive, store_key: ${store_key}`);
+  //     old_setter.call(_this, dataInArchive);
+  //   });
+  // }
+  old_setter.call(_this, val);
+  // console.log(`setval: ${val}`);
+}
+
+function archiveStateSetterWithDeserializer<
+  PlatformType extends Platform,
+  This extends { _core: HZEngineCore<PlatformType> },
+  Value,
+  SerializedValue extends Storage.Saveable<SerializedValue>
+>(
+  _this: This,
+  store_key: string,
+  old_setter: (this: This, value: Value) => void,
+  val: Value,
+  deserializer: (this: This, value: SerializedValue) => Value
+) {
+  // const core = _this._core;
+  // if (!core.storage._archiveStateSetterRegisteredList.has(store_key)) {
+  //   core.storage._archiveStateSetterRegisteredList.add(store_key);
+  //   core.on("afterLoadArchive", () => {
+  //     let dataInArchive = core.storage.getSaveableData(
+  //       core.storage.archiveData,
+  //       false,
+  //       ...store_key.split(".")
+  //     ) as SerializedValue;
+  //     console.log(`Load Data from Archive, store_key: ${store_key}`);
+  //     old_setter.call(_this, deserializer.call(_this, dataInArchive));
+  //   });
+  // }
+  old_setter.call(_this, val);
+  // console.log(`setval: ${val}`);
+}
+
+type ClassGetterDecoratorTarget<PlatformType extends Platform, This extends { _core: HZEngineCore<PlatformType> }, Value> = (
+  this: This
+) => Value;
+type ClassSetterDecoratorTarget<PlatformType extends Platform, This extends { _core: HZEngineCore<PlatformType> }, Value> = (
+  this: This,
+  value: Value
+) => void;