hzengine-core 0.1.2-dev

package/dist/utils/path.js

@@ -0,0 +1,289 @@
+// path utils for ZeppOS
+// @CuberQAQ
+// Generated by GPT-4o mini
+"use strict";
+var util = {
+    isString: (x) => typeof x === "string", // 检查是否为字符串
+    isObject: (x) => typeof x === "object", // 检查是否为对象
+};
+/**
+ * 检查路径是否包含协议
+ * @param {string} path - 路径字符串
+ * @returns {boolean} - 如果路径包含协议，则返回 true
+ */
+function isProtocolPath(path) {
+    return /^[a-zA-Z][a-zA-Z\d+\-.]*:\/\//.test(path);
+}
+/**
+ * 提取协议和路径部分
+ * @param {string} path - 路径字符串
+ * @returns {{protocol: string, filepath: string}} - 包含协议和文件路径的对象
+ */
+function extractProtocol(path) {
+    const match = path.match(/^([a-zA-Z][a-zA-Z\d+\-.]*):\/\/(.*)$/);
+    if (match) {
+        return {
+            protocol: match[1], // 获取协议
+            filepath: match[2], // 获取文件路径
+        };
+    }
+    return { protocol: null, filepath: path }; // 如果没有协议，返回原路径
+}
+/**
+ * 解析路径数组并规范化
+ * @param {string[]} parts - 路径组成部分
+ * @param {boolean} allowAboveRoot - 是否允许上级目录
+ * @returns {string[]} - 规范化后的路径部分
+ */
+function normalizeArray(parts, allowAboveRoot) {
+    var res = [];
+    for (var i = 0; i < parts.length; i++) {
+        var p = parts[i];
+        // 忽略空部分和当前目录（.）
+        if (!p || p === ".")
+            continue;
+        // 处理上级目录（..）
+        if (p === "..") {
+            if (res.length && res[res.length - 1] !== "..") {
+                res.pop(); // 移除最后一个部分
+            }
+            else if (allowAboveRoot) {
+                res.push(".."); // 允许上级目录
+            }
+        }
+        else {
+            res.push(p); // 添加有效部分
+        }
+    }
+    return res;
+}
+/**
+ * 移除数组两端的空元素
+ * @param {string[]} arr - 输入数组
+ * @returns {string[]} - 去除空元素后的数组
+ */
+function trimArray(arr) {
+    var lastIndex = arr.length - 1;
+    var start = 0;
+    for (; start <= lastIndex; start++) {
+        if (arr[start])
+            break;
+    }
+    var end = lastIndex;
+    for (; end >= 0; end--) {
+        if (arr[end])
+            break;
+    }
+    if (start === 0 && end === lastIndex)
+        return arr;
+    if (start > end)
+        return [];
+    return arr.slice(start, end + 1);
+}
+// 使用正则表达式分割路径
+var splitPathRe = /^(\/?|)([\s\S]*?)((?:\.{1,2}|[^\/]+?|)(\.[^.\/]*|))(?:[\/]*)$/;
+var posix = {};
+/**
+ * 分割路径
+ * @param {string} filename - 输入的路径字符串
+ * @returns {string[]} - 分割后的路径组成部分
+ */
+function posixSplitPath(filename) {
+    return splitPathRe.exec(filename).slice(1);
+}
+/**
+ * 解析路径，将相对路径转换为绝对路径
+ * @param {...string} paths - 要解析的路径
+ * @returns {string} - 解析后的绝对路径
+ */
+posix.resolve = function () {
+    var resolvedPath = "", resolvedAbsolute = false;
+    for (var i = arguments.length - 1; i >= -1 && !resolvedAbsolute; i--) {
+        var path = i >= 0 ? arguments[i] : process.cwd();
+        // 跳过空和无效的条目
+        if (!util.isString(path)) {
+            throw new TypeError("Arguments to path.resolve must be strings");
+        }
+        else if (!path) {
+            continue;
+        }
+        // 检查路径是否包含协议
+        if (isProtocolPath(path)) {
+            const { protocol, filepath } = extractProtocol(path);
+            resolvedPath = filepath + "/" + resolvedPath;
+            resolvedAbsolute = true; // 将协议路径视为绝对路径
+        }
+        else {
+            resolvedPath = path + "/" + resolvedPath;
+            resolvedAbsolute = path[0] === "/";
+        }
+    }
+    // 规范化路径
+    resolvedPath = normalizeArray(resolvedPath.split("/"), !resolvedAbsolute).join("/");
+    return (resolvedAbsolute ? "/" : "") + resolvedPath || ".";
+};
+/**
+ * 规范化路径，去除多余的斜杠和当前目录
+ * @param {string} path - 输入的路径字符串
+ * @returns {string} - 规范化后的路径
+ */
+posix.normalize = function (path) {
+    // 检查路径是否包含协议
+    if (isProtocolPath(path)) {
+        const { protocol, filepath } = extractProtocol(path);
+        return protocol + "://" + normalizeArray(filepath.split("/")).join("/");
+    }
+    var isAbsolute = posix.isAbsolute(path), trailingSlash = path && path[path.length - 1] === "/";
+    // 规范化路径
+    path = normalizeArray(path.split("/"), !isAbsolute).join("/");
+    if (!path && !isAbsolute) {
+        path = ".";
+    }
+    if (path && trailingSlash) {
+        path += "/";
+    }
+    return (isAbsolute ? "/" : "") + path;
+};
+/**
+ * 检查路径是否为绝对路径
+ * @param {string} path - 输入的路径字符串
+ * @returns {boolean} - 如果路径为绝对路径，则返回 true
+ */
+posix.isAbsolute = function (path) {
+    return path.charAt(0) === "/";
+};
+/**
+ * 连接多个路径段为一个路径
+ * @param {...string} segments - 要连接的路径段
+ * @returns {string} - 连接后的路径
+ */
+posix.join = function () {
+    var path = "";
+    for (var i = 0; i < arguments.length; i++) {
+        var segment = arguments[i];
+        if (!util.isString(segment)) {
+            throw new TypeError("Arguments to path.join must be strings");
+        }
+        if (segment) {
+            if (!path) {
+                path += segment;
+            }
+            else {
+                path += "/" + segment;
+            }
+        }
+    }
+    return posix.normalize(path);
+};
+/**
+ * 计算相对路径
+ * @param {string} from - 起始路径
+ * @param {string} to - 目标路径
+ * @returns {string} - 相对路径
+ */
+posix.relative = function (from, to) {
+    from = posix.resolve(from).substr(1);
+    to = posix.resolve(to).substr(1);
+    var fromParts = trimArray(from.split("/"));
+    var toParts = trimArray(to.split("/"));
+    var length = Math.min(fromParts.length, toParts.length);
+    var samePartsLength = length;
+    for (var i = 0; i < length; i++) {
+        if (fromParts[i] !== toParts[i]) {
+            samePartsLength = i;
+            break;
+        }
+    }
+    var outputParts = [];
+    for (var i = samePartsLength; i < fromParts.length; i++) {
+        outputParts.push("..");
+    }
+    outputParts = outputParts.concat(toParts.slice(samePartsLength));
+    return outputParts.join("/");
+};
+/**
+ * 获取路径的目录名
+ * @param {string} path - 输入的路径字符串
+ * @returns {string} - 目录名
+ */
+posix.dirname = function (path) {
+    var result = posixSplitPath(path), root = result[0], dir = result[1];
+    if (!root && !dir) {
+        return ".";
+    }
+    if (dir) {
+        dir = dir.substr(0, dir.length - 1); // 去掉尾部斜杠
+    }
+    return root + dir;
+};
+/**
+ * 获取路径的基本名
+ * @param {string} path - 输入的路径字符串
+ * @param {string} [ext] - 可选的扩展名，如果提供则将其从基本名中去除
+ * @returns {string} - 基本名
+ */
+posix.basename = function (path, ext) {
+    var f = posixSplitPath(path)[2];
+    if (ext && f.substr(-1 * ext.length) === ext) {
+        f = f.substr(0, f.length - ext.length);
+    }
+    return f;
+};
+/**
+ * 获取路径的扩展名
+ * @param {string} path - 输入的路径字符串
+ * @returns {string} - 扩展名
+ */
+posix.extname = function (path) {
+    return posixSplitPath(path)[3];
+};
+/**
+ * 格式化路径对象为路径字符串
+ * @param {Object} pathObject - 路径对象
+ * @param {string} pathObject.root - 根路径
+ * @param {string} pathObject.dir - 目录路径
+ * @param {string} pathObject.base - 基本文件名
+ * @param {string} pathObject.ext - 扩展名
+ * @param {string} pathObject.name - 文件名（不包含扩展名）
+ * @returns {string} - 格式化后的路径字符串
+ */
+posix.format = function (pathObject) {
+    if (!util.isObject(pathObject)) {
+        throw new TypeError("Parameter 'pathObject' must be an object, not " + typeof pathObject);
+    }
+    var root = pathObject.root || "";
+    if (!util.isString(root)) {
+        throw new TypeError("'pathObject.root' must be a string or undefined, not " +
+            typeof pathObject.root);
+    }
+    var dir = pathObject.dir ? pathObject.dir + posix.sep : "";
+    var base = pathObject.base || "";
+    return dir + base;
+};
+/**
+ * 解析路径字符串为路径对象
+ * @param {string} pathString - 输入的路径字符串
+ * @returns {{root: string, dir: string, base: string, ext: string, name: string}} - 路径对象
+ */
+posix.parse = function (pathString) {
+    if (!util.isString(pathString)) {
+        throw new TypeError("Parameter 'pathString' must be a string, not " + typeof pathString);
+    }
+    var allParts = posixSplitPath(pathString);
+    if (!allParts || allParts.length !== 4) {
+        throw new TypeError("Invalid path '" + pathString + "'");
+    }
+    allParts[1] = allParts[1] || "";
+    allParts[2] = allParts[2] || "";
+    allParts[3] = allParts[3] || "";
+    return {
+        root: allParts[0],
+        dir: allParts[0] + allParts[1].slice(0, -1),
+        base: allParts[2],
+        ext: allParts[3],
+        name: allParts[2].slice(0, allParts[2].length - allParts[3].length),
+    };
+};
+posix.sep = "/"; // POSIX 路径分隔符
+posix.delimiter = ":"; // POSIX 路径分隔符（用于环境变量）
+export default posix; // 导出 posix 模块

package/license.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 CuberQAQ <a224503353@163.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "hzengine-core",
+  "version": "0.1.2-dev",
+  "description": "An Visual Novel Engine for Zepp OS",
+  "main": "./dist/index.js",
+  "types": "./src/index.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch"
+  },
+  "keywords": [
+    "Galgame",
+    "HZEngine",
+    "NVL",
+    "ZeppOS"
+  ],
+  "author": "CuberQAQ",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@zeppos/device-types": "^3.0.0"
+  },
+  "dependencies": {
+    "@cuberqaq/path-polyfill": "^1.0.2"
+  }
+}

package/src/async/index.ts

@@ -0,0 +1,124 @@
+import { HZEngineCore, Storage } from "../index.js";
+import { Save } from "../storage/decorator.js";
+import { ZeppTimer } from "./zeppos_timer.js";
+// import { Time } from "@zos/sensor";
+
+export class Async {
+  static _nextTickCallbacks: (() => void)[] = [];
+  static _nextTickTimerId: number | null = null;
+  static nextTick(callback: () => void) {
+    this._nextTickCallbacks.push(callback);
+    if (this._nextTickTimerId == null) {
+      this._nextTickTimerId = setTimeout(() => {
+        this._nextTickTimerCallback();
+      }, 30) as unknown as number;
+    }
+  }
+
+  static _nextTickTimerCallback() {
+    this._nextTickTimerId = null;
+    const callbacks = this._nextTickCallbacks;
+    this._nextTickCallbacks = [];
+    callbacks.forEach((cb) => {
+      cb();
+    });
+  }
+
+  // private _fps = 45;
+  // private _hmTime = new Time();
+  private _lastTime: number;
+  constructor(public _core: HZEngineCore) {
+    // console.log("async init");
+    // let timer = new ZeppTimer(() => {
+    // //   console.log(`async timer cb`);
+    //   this._scheduleTask();
+    // }, ~~(1000 / this._fps));
+    // timer.start();
+    this._lastTime = this._core.platform.getTime();
+    // setInterval(() => {
+    //   this._scheduleTask();
+    // }, ~~(1000 / this._fps));
+    _core.platform.setFrameInterval(() => {
+      this._scheduleTask();
+    });
+  }
+
+  _scheduleTask() {
+    // TODO 沒有充分考慮存檔時產生的問題（this._delayTasks引用變化），及其它問題
+    let now = this._core.platform.getTime();
+    let deltaTime = now - this._lastTime;
+    this._lastTime = now;
+
+    // console.log(`async timer cb d=${deltaTime}`);
+
+    for (let id in this._delayTasks) {
+      let task = this._delayTasks[id];
+      task.next -= deltaTime;
+      if (task.next <= 0) {
+        this._core.emit(task.event, ...task.args);
+        if (task.repeat >= 0) {
+          // interval
+          task.next += task.repeat;
+        } else {
+          delete this._delayTasks[id];
+        }
+      }
+    }
+  }
+
+  @Save("async.nextTimerId")
+  private accessor _nextTimerId: number = 50;
+
+  // tasks
+  @Save("async.delayTasks")
+  private accessor _delayTasks: Record<number, Async.Task> = {};
+
+  // 注意在task執行中立即創建一個新的task，會在同一個js task中執行
+  // 注意周期實際為1個frame的時間的整數倍
+  addDelayTask(
+    event: string,
+    args: Storage.Saveable<unknown>[],
+    delayMs: number
+  ): number {
+    let task: Async.Task = {
+      event,
+      args,
+      next: delayMs,
+      repeat: -1,
+    };
+    let id = this._nextTimerId++;
+    this._delayTasks[id] = task;
+    return id;
+  }
+
+  addRepeatTask(
+    event: string,
+    args: Storage.Saveable<unknown>[],
+    intervalMs: number,
+    delayMs?: number
+  ): number {
+    intervalMs = intervalMs >= 0 ? intervalMs : 0;
+    let task: Async.Task = {
+      event,
+      args,
+      next: delayMs ?? intervalMs,
+      repeat: intervalMs,
+    };
+    let id = this._nextTimerId++;
+    this._delayTasks[id] = task;
+    return id;
+  }
+
+  removeTask(id: number) {
+    delete this._delayTasks[id];
+  }
+}
+
+export namespace Async {
+  export interface Task {
+    event: string;
+    args: Storage.Saveable<unknown>[];
+    next: number; // remaining time in ms
+    repeat: number; // -1 for once ; >=0 for repeat circle
+  }
+}