arkanalyzer 1.0.40 → 1.0.42

package/lib/pass/SceneValidator.d.ts

@@ -0,0 +1,215 @@
+import { Scene } from '../Scene';
+import { Dispatch, Dispatcher, StmtInit, StmtTy, ValueInit, ValueTy } from './Dispatcher';
+import { ClassCtx, ClassPass, FallAction, FileCtx, FilePass, MethodCtx, MethodPass } from './Pass';
+import { ArkFile } from '../core/model/ArkFile';
+import { ArkClass } from '../core/model/ArkClass';
+import { ArkMethod } from '../core/model/ArkMethod';
+import { Value } from '../core/base/Value';
+import { Stmt } from '../core/base/Stmt';
+export declare const enum SummaryLevel {
+    info = 0,
+    warn = 1,
+    error = 2
+}
+/**
+ * Abstract class representing a statement validator.
+ * Provides a mechanism to validate statements of a specific type within a given context.
+ * Implementations must define the `validate` method to perform custom validation logic.
+ */
+export declare abstract class StmtValidator<S extends StmtTy> {
+    /**
+     * Validates the given input using the provided context and reports the results.
+     *
+     * @param s The input value to be validated.
+     * @param ctx The context used for validation, which includes reporting mechanisms.
+     * @return The result of the validation process.
+     */
+    abstract validate(s: S, ctx: SummaryReporter): void;
+    run(s: S, ctx: MethodCtx, mtd: ArkMethod): void;
+    static register(init: StmtInit): void;
+}
+/**
+ * Abstract class representing a validator for values of a specific type.
+ * Provides a mechanism to validate values and report the results through a summary reporter.
+ * The validation logic is defined by implementing the `validate` method in derived classes.
+ */
+export declare abstract class ValueValidator<S extends ValueTy> {
+    /**
+     * Validates the given input against specific criteria and reports the validation status.
+     *
+     * @param s The input value to be validated. This can be of any type depending on the implementation.
+     * @param ctx The context object used for reporting validation results or summaries.
+     * @return The result of the validation process.
+     */
+    abstract validate(s: S, ctx: SummaryReporter): void;
+    run(s: S, ctx: MethodCtx, mtd: ArkMethod): void;
+    static register(init: ValueInit): void;
+}
+/**
+ * The ArkValidatorRegistry class is responsible for managing and registering statement and value initializers
+ * used in validation processes. It extends the Dispatcher class and provides mechanisms to dynamically
+ * register and invalidate dispatch configurations.
+ */
+export declare class ArkValidatorRegistry extends Dispatcher {
+    private static readonly stmtsHolder;
+    private static readonly valuesHolder;
+    private static dispatchHolder?;
+    constructor(ctx: MethodCtx);
+    static getDispatch(): Dispatch;
+    static stmt(init: StmtInit): void;
+    static value(init: ValueInit): void;
+}
+/**
+ * Interface representing a summary reporter for logging messages with different severity levels.
+ * Provides methods to log informational, warning, and error messages.
+ * The `info` method is used to log general informational messages.
+ * The `warn` method is used to log warning messages that indicate potential issues.
+ * The `error` method is used to log error messages that represent critical problems.
+ */
+export interface SummaryReporter {
+    info(msg: string): void;
+    warn(msg: string): void;
+    error(msg: string): void;
+}
+/**
+ * An abstract class that extends FilePass and provides a framework for validating files.
+ * The FileValidator class is designed to be subclassed with specific validation logic
+ * implemented in the `validate` method. It provides a default implementation of the `run`
+ * method, which processes a file and submits validation results (info, warning, or error)
+ * to a summary object associated with the file context.
+ */
+export declare abstract class FileValidator extends FilePass {
+    /**
+     * Validates the given file and reports the results through the provided context.
+     *
+     * @param file The file to be validated, represented as an ArkFile object.
+     * @param ctx The context used for reporting validation results, implemented as a SummaryReporter.
+     * @return The result of the validation process.
+     */
+    abstract validate(file: ArkFile, ctx: SummaryReporter): void;
+    run(file: ArkFile, ctx: FileCtx): void;
+}
+export declare abstract class ClassValidator extends ClassPass {
+    /**
+     * Validates the given class and reports any issues found during validation.
+     *
+     * @param cls The class to be validated. This should be an instance of ArkClass.
+     * @param ctx The context used for reporting validation results or issues. This should be an instance of SummaryReporter.
+     * @return This method does not return any value.
+     */
+    abstract validate(cls: ArkClass, ctx: SummaryReporter): void;
+    run(cls: ArkClass, ctx: ClassCtx): FallAction | void;
+}
+export declare abstract class MethodValidator extends MethodPass {
+    /**
+     * Validates the given method and reports any issues found.
+     *
+     * @param mtd The method to be validated. This is an instance of ArkMethod.
+     * @param ctx The context for reporting validation results or issues. This is an instance of SummaryReporter.
+     * @return This method does not return a value.
+     */
+    abstract validate(mtd: ArkMethod, ctx: SummaryReporter): void;
+    run(mtd: ArkMethod, ctx: MethodCtx): FallAction | void;
+}
+/**
+ * Represents a summary of a scene, containing metadata and associated file summaries.
+ * The name property provides a default identifier for the scene summary.
+ * The files property maintains a mapping of ArkFile instances to their corresponding FileSummary objects.
+ * This class is used to encapsulate and manage information about a scene and its related files.
+ */
+export declare class SceneSummary {
+    name: string;
+    files: Map<ArkFile, FileSummary>;
+}
+/**
+ * Represents a summary of a file containing information about classes and messages.
+ * Provides methods to manage and retrieve file summaries within a given context.
+ * The class maintains a collection of messages and a mapping of classes to their summaries.
+ * It supports operations to submit new messages and retrieve or create summaries for files.
+ */
+export declare class FileSummary {
+    name: string;
+    classes: Map<ArkClass, ClassSummary>;
+    msgList: SummaryMsg[];
+    constructor();
+    submit(msg: SummaryMsg): void;
+    /**
+     * Retrieves an existing FileSummary instance from the given context or creates a new one if it does not exist.
+     *
+     * @param ctx The context object that holds the FileSummary instance. It is used to check if a FileSummary already exists.
+     * @param file The ArkFile object for which the FileSummary is being retrieved or created.
+     * @return The existing or newly created FileSummary instance associated with the provided file.
+     */
+    static getOrNew(ctx: FileCtx, file: ArkFile): FileSummary;
+}
+/**
+ * Represents a summary of a class, containing its name, associated methods, and messages.
+ * Provides functionality to submit messages and retrieve or create a ClassSummary instance.
+ * The class maintains a collection of method summaries and tracks messages related to the class.
+ * It is designed to be used in the context of a larger system that processes class information.
+ */
+export declare class ClassSummary {
+    name: string;
+    methods: Map<ArkMethod, MethodSummary>;
+    msgList: SummaryMsg[];
+    constructor();
+    submit(msg: SummaryMsg): void;
+    /**
+     * Retrieves an existing ClassSummary instance from the given context or creates a new one if it does not exist.
+     * If the ClassSummary is not found in the context, it attempts to retrieve or create a FileSummary for the declaring file of the class.
+     * Ensures that the ClassSummary is associated with the provided class and context before returning it.
+     *
+     * @param ctx The context in which to search for or store the ClassSummary instance.
+     * @param cls The class for which the ClassSummary is being retrieved or created.
+     * @return The existing or newly created ClassSummary instance associated with the provided class and context.
+     */
+    static getOrNew(ctx: ClassCtx, cls: ArkClass): ClassSummary;
+}
+/**
+ * Represents a summary message with an associated level and content.
+ * The SummaryMsg class is used to encapsulate messages that have a specific severity or importance level.
+ * It provides a way to associate a textual message with a defined level, making it suitable for logging, notifications, or summaries.
+ * The constructor initializes the message and its level, ensuring both are explicitly defined at creation.
+ */
+export declare class SummaryMsg {
+    level: SummaryLevel;
+    msg: string;
+    constructor(level: SummaryLevel, msg: string);
+}
+/**
+ * Represents a summary of a method, capturing various messages and associations with values and statements.
+ * This class provides methods to submit messages and associate them with specific values or statements.
+ * It also supports retrieving or creating a method summary within a given context.
+ */
+export declare class MethodSummary {
+    name: string;
+    values: Map<Value, SummaryMsg[]>;
+    stmts: Map<Stmt, SummaryMsg[]>;
+    msgList: SummaryMsg[];
+    constructor();
+    submit(msg: SummaryMsg): void;
+    submitValue(value: Value, msg: SummaryMsg): void;
+    submitStmt(stmt: Stmt, msg: SummaryMsg): void;
+    /**
+     * Retrieves an existing MethodSummary from the context or creates a new one if it does not exist.
+     *
+     * @param ctx The method context in which the MethodSummary is stored or will be created.
+     * @param mtd The ArkMethod for which the MethodSummary is being retrieved or created.
+     * @return The existing or newly created MethodSummary associated with the provided context and method.
+     */
+    static getOrNew(ctx: MethodCtx, mtd: ArkMethod): MethodSummary;
+}
+/**
+ * The SceneValidator class is responsible for validating a given scene by leveraging the ScenePassMgr.
+ * It sets up a context for validation, executes the validation process, and retrieves the summary of the validation.
+ *
+ * The validate method initializes a new SceneSummary instance, associates it with the current scene context,
+ * runs the validation process using the configured manager, and finally returns the generated summary.
+ *
+ * This class ensures that the validation logic is encapsulated and provides a clean interface for processing scenes.
+ */
+export declare class SceneValidator {
+    private mgr;
+    validate(scene: Scene): SceneSummary;
+}
+//# sourceMappingURL=SceneValidator.d.ts.map

package/lib/pass/SceneValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SceneValidator.d.ts","sourceRoot":"","sources":["../../src/pass/SceneValidator.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACnG,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAKzC,0BAAkB,YAAY;IAC1B,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,KAAK,IAAA;CACR;AAED;;;;GAIG;AACH,8BAAsB,aAAa,CAAC,CAAC,SAAS,MAAM;IAChD;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,eAAe,GAAG,IAAI;IAEnD,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI;IAY/C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;CAGxC;AAED;;;;GAIG;AACH,8BAAsB,cAAc,CAAC,CAAC,SAAS,OAAO;IAClD;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,eAAe,GAAG,IAAI;IAEnD,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI;IAY/C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;CAGzC;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,UAAU;IAChD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAkB;IACrD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAmB;IACvD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAW;gBAE7B,GAAG,EAAE,SAAS;IAK1B,MAAM,CAAC,WAAW,IAAI,QAAQ;IAQ9B,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAMjC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;CAKtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC5B,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,8BAAsB,aAAc,SAAQ,QAAQ;IAChD;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,GAAG,IAAI;IAE5D,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI;CAWzC;AAED,8BAAsB,cAAe,SAAQ,SAAS;IAClD;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,IAAI;IAE5D,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,GAAG,UAAU,GAAG,IAAI;CAWvD;AAED,8BAAsB,eAAgB,SAAQ,UAAU;IACpD;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,eAAe,GAAG,IAAI;IAE7D,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,GAAG,UAAU,GAAG,IAAI;CAWzD;AAED;;;;;GAKG;AACH,qBAAa,YAAY;IACrB,IAAI,EAAE,MAAM,CAAsB;IAClC,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAa;CAChD;AAED;;;;;GAKG;AACH,qBAAa,WAAW;IACpB,IAAI,EAAE,MAAM,CAAkB;IAC9B,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAa;IACjD,OAAO,EAAE,UAAU,EAAE,CAAM;;IAK3B,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI;IAI7B;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,WAAW;CAY5D;AAED;;;;;GAKG;AACH,qBAAa,YAAY;IACrB,IAAI,EAAE,MAAM,CAAmB;IAC/B,OAAO,EAAE,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAa;IACnD,OAAO,EAAE,UAAU,EAAE,CAAM;;IAK3B,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI;IAI7B;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,GAAG,YAAY;CAY9D;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACnB,KAAK,EAAE,YAAY,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;gBAEA,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM;CAI/C;AAED;;;;GAIG;AACH,qBAAa,aAAa;IACtB,IAAI,EAAE,MAAM,CAAoB;IAChC,MAAM,EAAE,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC,CAAa;IAC7C,KAAK,EAAE,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAa;IAC3C,OAAO,EAAE,UAAU,EAAE,CAAM;;IAK3B,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI;IAI7B,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAOhD,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAQ7C;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,GAAG,aAAa;CAYjE;AAED;;;;;;;;GAQG;AACH,qBAAa,cAAc;IACvB,OAAO,CAAC,GAAG,CAAwE;IAEnF,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,YAAY;CAMvC"}

package/lib/pass/SceneValidator.js

@@ -0,0 +1,339 @@
+"use strict";
+/*
+ * Copyright (c) 2024-2025 Huawei Device Co., Ltd.
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneValidator = exports.MethodSummary = exports.SummaryMsg = exports.ClassSummary = exports.FileSummary = exports.SceneSummary = exports.MethodValidator = exports.ClassValidator = exports.FileValidator = exports.ArkValidatorRegistry = exports.ValueValidator = exports.StmtValidator = void 0;
+const ScenePassMgr_1 = require("./ScenePassMgr");
+const Dispatcher_1 = require("./Dispatcher");
+const Pass_1 = require("./Pass");
+const logger_1 = __importStar(require("../utils/logger"));
+const logger = logger_1.default.getLogger(logger_1.LOG_MODULE_TYPE.ARKANALYZER, 'Validator');
+/**
+ * Abstract class representing a statement validator.
+ * Provides a mechanism to validate statements of a specific type within a given context.
+ * Implementations must define the `validate` method to perform custom validation logic.
+ */
+class StmtValidator {
+    run(s, ctx, mtd) {
+        let submit = (msg) => {
+            let summary = MethodSummary.getOrNew(ctx, mtd);
+            summary.submitStmt(s, msg);
+        };
+        this.validate(s, {
+            info: (msg) => submit(new SummaryMsg(0 /* SummaryLevel.info */, msg)),
+            warn: (msg) => submit(new SummaryMsg(1 /* SummaryLevel.warn */, msg)),
+            error: (msg) => submit(new SummaryMsg(2 /* SummaryLevel.error */, msg)),
+        });
+    }
+    static register(init) {
+        ArkValidatorRegistry.stmt(init);
+    }
+}
+exports.StmtValidator = StmtValidator;
+/**
+ * Abstract class representing a validator for values of a specific type.
+ * Provides a mechanism to validate values and report the results through a summary reporter.
+ * The validation logic is defined by implementing the `validate` method in derived classes.
+ */
+class ValueValidator {
+    run(s, ctx, mtd) {
+        let submit = (msg) => {
+            let summary = MethodSummary.getOrNew(ctx, mtd);
+            summary.submitValue(s, msg);
+        };
+        this.validate(s, {
+            info: (msg) => submit(new SummaryMsg(0 /* SummaryLevel.info */, msg)),
+            warn: (msg) => submit(new SummaryMsg(1 /* SummaryLevel.warn */, msg)),
+            error: (msg) => submit(new SummaryMsg(2 /* SummaryLevel.error */, msg)),
+        });
+    }
+    static register(init) {
+        ArkValidatorRegistry.value(init);
+    }
+}
+exports.ValueValidator = ValueValidator;
+/**
+ * The ArkValidatorRegistry class is responsible for managing and registering statement and value initializers
+ * used in validation processes. It extends the Dispatcher class and provides mechanisms to dynamically
+ * register and invalidate dispatch configurations.
+ */
+class ArkValidatorRegistry extends Dispatcher_1.Dispatcher {
+    constructor(ctx) {
+        super(ctx, ArkValidatorRegistry.getDispatch());
+        this.fallAction = 0 /* FallAction.Continue */;
+    }
+    static getDispatch() {
+        if (ArkValidatorRegistry.dispatchHolder) {
+            return ArkValidatorRegistry.dispatchHolder;
+        }
+        ArkValidatorRegistry.dispatchHolder = new Dispatcher_1.Dispatch(this.stmtsHolder, this.valuesHolder);
+        return ArkValidatorRegistry.dispatchHolder;
+    }
+    static stmt(init) {
+        this.stmtsHolder.push(init);
+        // invalidate holder
+        ArkValidatorRegistry.dispatchHolder = undefined;
+    }
+    static value(init) {
+        this.valuesHolder.push(init);
+        // invalidate holder
+        ArkValidatorRegistry.dispatchHolder = undefined;
+    }
+}
+exports.ArkValidatorRegistry = ArkValidatorRegistry;
+ArkValidatorRegistry.stmtsHolder = [];
+ArkValidatorRegistry.valuesHolder = [];
+/**
+ * An abstract class that extends FilePass and provides a framework for validating files.
+ * The FileValidator class is designed to be subclassed with specific validation logic
+ * implemented in the `validate` method. It provides a default implementation of the `run`
+ * method, which processes a file and submits validation results (info, warning, or error)
+ * to a summary object associated with the file context.
+ */
+class FileValidator extends Pass_1.FilePass {
+    run(file, ctx) {
+        let submit = (msg) => {
+            let summary = FileSummary.getOrNew(ctx, file);
+            summary.submit(msg);
+        };
+        this.validate(file, {
+            info: (msg) => submit(new SummaryMsg(0 /* SummaryLevel.info */, msg)),
+            warn: (msg) => submit(new SummaryMsg(1 /* SummaryLevel.warn */, msg)),
+            error: (msg) => submit(new SummaryMsg(2 /* SummaryLevel.error */, msg)),
+        });
+    }
+}
+exports.FileValidator = FileValidator;
+class ClassValidator extends Pass_1.ClassPass {
+    run(cls, ctx) {
+        let submit = (msg) => {
+            let summary = ClassSummary.getOrNew(ctx, cls);
+            summary.submit(msg);
+        };
+        this.validate(cls, {
+            info: (msg) => submit(new SummaryMsg(0 /* SummaryLevel.info */, msg)),
+            warn: (msg) => submit(new SummaryMsg(1 /* SummaryLevel.warn */, msg)),
+            error: (msg) => submit(new SummaryMsg(2 /* SummaryLevel.error */, msg)),
+        });
+    }
+}
+exports.ClassValidator = ClassValidator;
+class MethodValidator extends Pass_1.MethodPass {
+    run(mtd, ctx) {
+        let submit = (msg) => {
+            let summary = MethodSummary.getOrNew(ctx, mtd);
+            summary.submit(msg);
+        };
+        this.validate(mtd, {
+            info: (msg) => submit(new SummaryMsg(0 /* SummaryLevel.info */, msg)),
+            warn: (msg) => submit(new SummaryMsg(1 /* SummaryLevel.warn */, msg)),
+            error: (msg) => submit(new SummaryMsg(2 /* SummaryLevel.error */, msg)),
+        });
+    }
+}
+exports.MethodValidator = MethodValidator;
+/**
+ * Represents a summary of a scene, containing metadata and associated file summaries.
+ * The name property provides a default identifier for the scene summary.
+ * The files property maintains a mapping of ArkFile instances to their corresponding FileSummary objects.
+ * This class is used to encapsulate and manage information about a scene and its related files.
+ */
+class SceneSummary {
+    constructor() {
+        this.name = 'validate summary';
+        this.files = new Map();
+    }
+}
+exports.SceneSummary = SceneSummary;
+/**
+ * Represents a summary of a file containing information about classes and messages.
+ * Provides methods to manage and retrieve file summaries within a given context.
+ * The class maintains a collection of messages and a mapping of classes to their summaries.
+ * It supports operations to submit new messages and retrieve or create summaries for files.
+ */
+class FileSummary {
+    constructor() {
+        this.name = 'file summary';
+        this.classes = new Map();
+        this.msgList = [];
+    }
+    submit(msg) {
+        this.msgList.push(msg);
+    }
+    /**
+     * Retrieves an existing FileSummary instance from the given context or creates a new one if it does not exist.
+     *
+     * @param ctx The context object that holds the FileSummary instance. It is used to check if a FileSummary already exists.
+     * @param file The ArkFile object for which the FileSummary is being retrieved or created.
+     * @return The existing or newly created FileSummary instance associated with the provided file.
+     */
+    static getOrNew(ctx, file) {
+        if (ctx.get(FileSummary)) {
+            return ctx.get(FileSummary);
+        }
+        let validate = ctx.upper.get(SceneSummary);
+        if (!validate.files.get(file)) {
+            validate.files.set(file, new FileSummary());
+        }
+        let summary = validate.files.get(file);
+        ctx.set(FileSummary, summary);
+        return summary;
+    }
+}
+exports.FileSummary = FileSummary;
+/**
+ * Represents a summary of a class, containing its name, associated methods, and messages.
+ * Provides functionality to submit messages and retrieve or create a ClassSummary instance.
+ * The class maintains a collection of method summaries and tracks messages related to the class.
+ * It is designed to be used in the context of a larger system that processes class information.
+ */
+class ClassSummary {
+    constructor() {
+        this.name = 'class summary';
+        this.methods = new Map();
+        this.msgList = [];
+    }
+    submit(msg) {
+        this.msgList.push(msg);
+    }
+    /**
+     * Retrieves an existing ClassSummary instance from the given context or creates a new one if it does not exist.
+     * If the ClassSummary is not found in the context, it attempts to retrieve or create a FileSummary for the declaring file of the class.
+     * Ensures that the ClassSummary is associated with the provided class and context before returning it.
+     *
+     * @param ctx The context in which to search for or store the ClassSummary instance.
+     * @param cls The class for which the ClassSummary is being retrieved or created.
+     * @return The existing or newly created ClassSummary instance associated with the provided class and context.
+     */
+    static getOrNew(ctx, cls) {
+        if (ctx.get(ClassSummary)) {
+            return ctx.get(ClassSummary);
+        }
+        let file = FileSummary.getOrNew(ctx.upper, cls.getDeclaringArkFile());
+        if (!file.classes.get(cls)) {
+            file.classes.set(cls, new ClassSummary());
+        }
+        let summary = file.classes.get(cls);
+        ctx.set(ClassSummary, summary);
+        return summary;
+    }
+}
+exports.ClassSummary = ClassSummary;
+/**
+ * Represents a summary message with an associated level and content.
+ * The SummaryMsg class is used to encapsulate messages that have a specific severity or importance level.
+ * It provides a way to associate a textual message with a defined level, making it suitable for logging, notifications, or summaries.
+ * The constructor initializes the message and its level, ensuring both are explicitly defined at creation.
+ */
+class SummaryMsg {
+    constructor(level, msg) {
+        this.level = level;
+        this.msg = msg;
+    }
+}
+exports.SummaryMsg = SummaryMsg;
+/**
+ * Represents a summary of a method, capturing various messages and associations with values and statements.
+ * This class provides methods to submit messages and associate them with specific values or statements.
+ * It also supports retrieving or creating a method summary within a given context.
+ */
+class MethodSummary {
+    constructor() {
+        this.name = 'method summary';
+        this.values = new Map();
+        this.stmts = new Map();
+        this.msgList = [];
+    }
+    submit(msg) {
+        this.msgList.push(msg);
+    }
+    submitValue(value, msg) {
+        if (!this.values.get(value)) {
+            this.values.set(value, []);
+        }
+        this.values.get(value).push(msg);
+    }
+    submitStmt(stmt, msg) {
+        if (this.stmts.get(stmt) === undefined) {
+            this.stmts.set(stmt, []);
+        }
+        logger.info(`submit ${JSON.stringify(msg)}`);
+        this.stmts.get(stmt).push(msg);
+    }
+    /**
+     * Retrieves an existing MethodSummary from the context or creates a new one if it does not exist.
+     *
+     * @param ctx The method context in which the MethodSummary is stored or will be created.
+     * @param mtd The ArkMethod for which the MethodSummary is being retrieved or created.
+     * @return The existing or newly created MethodSummary associated with the provided context and method.
+     */
+    static getOrNew(ctx, mtd) {
+        if (ctx.get(MethodSummary)) {
+            return ctx.get(MethodSummary);
+        }
+        let cls = ClassSummary.getOrNew(ctx.upper, mtd.getDeclaringArkClass());
+        if (!cls.methods.get(mtd)) {
+            cls.methods.set(mtd, new MethodSummary());
+        }
+        let summary = cls.methods.get(mtd);
+        ctx.set(MethodSummary, summary);
+        return summary;
+    }
+}
+exports.MethodSummary = MethodSummary;
+/**
+ * The SceneValidator class is responsible for validating a given scene by leveraging the ScenePassMgr.
+ * It sets up a context for validation, executes the validation process, and retrieves the summary of the validation.
+ *
+ * The validate method initializes a new SceneSummary instance, associates it with the current scene context,
+ * runs the validation process using the configured manager, and finally returns the generated summary.
+ *
+ * This class ensures that the validation logic is encapsulated and provides a clean interface for processing scenes.
+ */
+class SceneValidator {
+    constructor() {
+        this.mgr = new ScenePassMgr_1.ScenePassMgr({ dispatcher: ArkValidatorRegistry });
+    }
+    validate(scene) {
+        let summary = new SceneSummary();
+        this.mgr.sceneContext().set(SceneSummary, summary);
+        this.mgr.run(scene);
+        return this.mgr.sceneContext().remove(SceneSummary);
+    }
+}
+exports.SceneValidator = SceneValidator;

package/lib/save/JsonPrinter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"JsonPrinter.d.ts","sourceRoot":"","sources":["../../src/save/JsonPrinter.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAuEhD,qBAAa,WAAY,SAAQ,OAAO;IACxB,OAAO,CAAC,OAAO;gBAAP,OAAO,EAAE,OAAO;IAI7B,IAAI,IAAI,MAAM;IAKrB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,wBAAwB;IAShC,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,wBAAwB;IAOhC,OAAO,CAAC,aAAa;IAoIrB,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,2BAA2B;IASnC,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,wBAAwB;IAYhC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,cAAc;IAsKtB,OAAO,CAAC,aAAa;CAuCxB"}
+{"version":3,"file":"JsonPrinter.d.ts","sourceRoot":"","sources":["../../src/save/JsonPrinter.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAuEhD,qBAAa,WAAY,SAAQ,OAAO;IACxB,OAAO,CAAC,OAAO;gBAAP,OAAO,EAAE,OAAO;IAI7B,IAAI,IAAI,MAAM;IAKrB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,wBAAwB;IAShC,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,wBAAwB;IAOhC,OAAO,CAAC,aAAa;IAgHrB,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,2BAA2B;IASnC,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,wBAAwB;IAYhC,OAAO,CAAC,2BAA2B;IAOnC,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,cAAc;IAwGtB,OAAO,CAAC,aAAa;CAuCxB"}