arkanalyzer 1.0.20 → 1.0.21

package/lib/core/model/ArkBody.d.ts

@@ -1,25 +1,25 @@
-import { Local } from '../base/Local';
-import { Cfg } from '../graph/Cfg';
-import { AliasType } from '../base/Type';
-import { Trap } from '../base/Trap';
-import { Value } from '../base/Value';
-import { ArkAliasTypeDefineStmt } from '../base/Stmt';
-export declare class ArkBody {
-    private locals;
-    private usedGlobals?;
-    private cfg;
-    private aliasTypeMap?;
-    private traps?;
-    constructor(locals: Set<Local>, cfg: Cfg, aliasTypeMap?: Map<string, [AliasType, ArkAliasTypeDefineStmt]>, traps?: Trap[]);
-    getLocals(): Map<string, Local>;
-    setLocals(locals: Set<Local>): void;
-    addLocal(name: string, local: Local): void;
-    getUsedGlobals(): Map<string, Value> | undefined;
-    setUsedGlobals(globals: Map<string, Value>): void;
-    getCfg(): Cfg;
-    setCfg(cfg: Cfg): void;
-    getAliasTypeMap(): Map<string, [AliasType, ArkAliasTypeDefineStmt]> | undefined;
-    getAliasTypeByName(name: string): AliasType | null;
-    getTraps(): Trap[] | undefined;
-}
+import { Local } from '../base/Local';
+import { Cfg } from '../graph/Cfg';
+import { AliasType } from '../base/Type';
+import { Trap } from '../base/Trap';
+import { Value } from '../base/Value';
+import { ArkAliasTypeDefineStmt } from '../base/Stmt';
+export declare class ArkBody {
+    private locals;
+    private usedGlobals?;
+    private cfg;
+    private aliasTypeMap?;
+    private traps?;
+    constructor(locals: Set<Local>, cfg: Cfg, aliasTypeMap?: Map<string, [AliasType, ArkAliasTypeDefineStmt]>, traps?: Trap[]);
+    getLocals(): Map<string, Local>;
+    setLocals(locals: Set<Local>): void;
+    addLocal(name: string, local: Local): void;
+    getUsedGlobals(): Map<string, Value> | undefined;
+    setUsedGlobals(globals: Map<string, Value>): void;
+    getCfg(): Cfg;
+    setCfg(cfg: Cfg): void;
+    getAliasTypeMap(): Map<string, [AliasType, ArkAliasTypeDefineStmt]> | undefined;
+    getAliasTypeByName(name: string): AliasType | null;
+    getTraps(): Trap[] | undefined;
+}
 //# sourceMappingURL=ArkBody.d.ts.map

package/lib/core/model/ArkBody.js

@@ -1,65 +1,65 @@
-"use strict";
-/*
- * Copyright (c) 2024 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArkBody = void 0;
-class ArkBody {
-    constructor(locals, cfg, aliasTypeMap, traps) {
-        this.cfg = cfg;
-        this.aliasTypeMap = aliasTypeMap;
-        this.locals = new Map();
-        locals.forEach(local => this.locals.set(local.getName(), local));
-        this.traps = traps;
-    }
-    getLocals() {
-        return this.locals;
-    }
-    setLocals(locals) {
-        if (!this.locals) {
-            this.locals = new Map();
-        }
-        locals.forEach(local => this.locals.set(local.getName(), local));
-    }
-    addLocal(name, local) {
-        this.locals.set(name, local);
-    }
-    getUsedGlobals() {
-        return this.usedGlobals;
-    }
-    setUsedGlobals(globals) {
-        this.usedGlobals = globals;
-    }
-    getCfg() {
-        return this.cfg;
-    }
-    setCfg(cfg) {
-        this.cfg = cfg;
-    }
-    getAliasTypeMap() {
-        return this.aliasTypeMap;
-    }
-    getAliasTypeByName(name) {
-        var _a;
-        const aliasTypeInfo = (_a = this.aliasTypeMap) === null || _a === void 0 ? void 0 : _a.get(name);
-        if (aliasTypeInfo) {
-            return aliasTypeInfo[0];
-        }
-        return null;
-    }
-    getTraps() {
-        return this.traps;
-    }
-}
-exports.ArkBody = ArkBody;
+"use strict";
+/*
+ * Copyright (c) 2024 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArkBody = void 0;
+class ArkBody {
+    constructor(locals, cfg, aliasTypeMap, traps) {
+        this.cfg = cfg;
+        this.aliasTypeMap = aliasTypeMap;
+        this.locals = new Map();
+        locals.forEach(local => this.locals.set(local.getName(), local));
+        this.traps = traps;
+    }
+    getLocals() {
+        return this.locals;
+    }
+    setLocals(locals) {
+        if (!this.locals) {
+            this.locals = new Map();
+        }
+        locals.forEach(local => this.locals.set(local.getName(), local));
+    }
+    addLocal(name, local) {
+        this.locals.set(name, local);
+    }
+    getUsedGlobals() {
+        return this.usedGlobals;
+    }
+    setUsedGlobals(globals) {
+        this.usedGlobals = globals;
+    }
+    getCfg() {
+        return this.cfg;
+    }
+    setCfg(cfg) {
+        this.cfg = cfg;
+    }
+    getAliasTypeMap() {
+        return this.aliasTypeMap;
+    }
+    getAliasTypeByName(name) {
+        var _a;
+        const aliasTypeInfo = (_a = this.aliasTypeMap) === null || _a === void 0 ? void 0 : _a.get(name);
+        if (aliasTypeInfo) {
+            return aliasTypeInfo[0];
+        }
+        return null;
+    }
+    getTraps() {
+        return this.traps;
+    }
+}
+exports.ArkBody = ArkBody;

package/lib/core/model/ArkClass.d.ts

@@ -1,207 +1,207 @@
-import { GenericType, Type } from '../base/Type';
-import { ViewTree } from '../graph/ViewTree';
-import { ArkField } from './ArkField';
-import { ArkFile } from './ArkFile';
-import { ArkMethod } from './ArkMethod';
-import { ArkNamespace } from './ArkNamespace';
-import { ClassSignature, FieldSignature, FileSignature, MethodSignature, NamespaceSignature } from './ArkSignature';
-import { Local } from '../base/Local';
-import { ArkExport, ExportType } from './ArkExport';
-import { ArkBaseModel } from './ArkBaseModel';
-import { ArkError } from '../common/ArkError';
-export declare enum ClassCategory {
-    CLASS = 0,
-    STRUCT = 1,
-    INTERFACE = 2,
-    ENUM = 3,
-    TYPE_LITERAL = 4,
-    OBJECT = 5
-}
-/**
- * @category core/model
- */
-export declare class ArkClass extends ArkBaseModel implements ArkExport {
-    private category;
-    private code?;
-    private lineCol;
-    private declaringArkFile;
-    private declaringArkNamespace;
-    private classSignature;
-    /**
-     * The keys of the `heritageClasses` map represent the names of superclass and interfaces.
-     * The superclass name is placed first; if it does not exist, an empty string `''` will occupy this position.
-     * The values of the `heritageClasses` map will be replaced with `ArkClass` or `null` during type inference.
-     */
-    private heritageClasses;
-    private genericsTypes?;
-    private realTypes?;
-    private defaultMethod;
-    private methods;
-    private fields;
-    private extendedClasses;
-    private staticMethods;
-    private staticFields;
-    private instanceInitMethod;
-    private staticInitMethod;
-    private anonymousMethodNumber;
-    private indexSignatureNumber;
-    private viewTree?;
-    constructor();
-    /**
-     * Returns the **string**name of this class.
-     * @returns The name of this class.
-     */
-    getName(): string;
-    /**
-     * Returns the codes of class as a **string.**
-     * @returns the codes of class.
-     */
-    getCode(): string | undefined;
-    setCode(code: string): void;
-    /**
-     * Returns the line position of this class.
-     * @returns The line position of this class.
-     */
-    getLine(): number;
-    setLine(line: number): void;
-    /**
-     * Returns the column position of this class.
-     * @returns The column position of this class.
-     */
-    getColumn(): number;
-    setColumn(column: number): void;
-    getCategory(): ClassCategory;
-    setCategory(category: ClassCategory): void;
-    /**
-     * Returns the declaring file.
-     * @returns A file defined by ArkAnalyzer.
-     * @example
-     * 1. Get the {@link ArkFile} which the ArkClass is in.
-
-     ```typescript
-     const arkFile = arkClass.getDeclaringArkFile();
-     ```
-     */
-    getDeclaringArkFile(): ArkFile;
-    setDeclaringArkFile(declaringArkFile: ArkFile): void;
-    /**
-     * Returns the declaring namespace of this class, which may also be an **undefined**.
-     * @returns The declaring namespace (may be **undefined**) of this class.
-     */
-    getDeclaringArkNamespace(): ArkNamespace | undefined;
-    setDeclaringArkNamespace(declaringArkNamespace: ArkNamespace | undefined): void;
-    isDefaultArkClass(): boolean;
-    isAnonymousClass(): boolean;
-    /**
-     * Returns the signature of current class (i.e., {@link ClassSignature}).
-     * The {@link ClassSignature} can uniquely identify a class, according to which we can find the class from the scene.
-     * @returns The class signature.
-     */
-    getSignature(): ClassSignature;
-    setSignature(classSig: ClassSignature): void;
-    getSuperClassName(): string;
-    addHeritageClassName(className: string): void;
-    /**
-     * Returns the superclass of this class.
-     * @returns The superclass of this class.
-     */
-    getSuperClass(): ArkClass | null;
-    private getHeritageClass;
-    getAllHeritageClasses(): ArkClass[];
-    getExtendedClasses(): Map<string, ArkClass>;
-    addExtendedClass(extendedClass: ArkClass): void;
-    getImplementedInterfaceNames(): string[];
-    hasImplementedInterface(interfaceName: string): boolean;
-    getImplementedInterface(interfaceName: string): ArkClass | null;
-    /**
-     * Get the field according to its field signature.
-     * If no field cound be found, **null**will be returned.
-     * @param fieldSignature - the field's signature.
-     * @returns A field. If there is no field in this class, the return will be a **null**.
-     */
-    getField(fieldSignature: FieldSignature): ArkField | null;
-    getFieldWithName(fieldName: string): ArkField | null;
-    getStaticFieldWithName(fieldName: string): ArkField | null;
-    /**
-     * Returns an **array** of fields in the class.
-     * @returns an **array** of fields in the class.
-     */
-    getFields(): ArkField[];
-    addField(field: ArkField): void;
-    addFields(fields: ArkField[]): void;
-    getRealTypes(): Type[] | undefined;
-    getGenericsTypes(): GenericType[] | undefined;
-    addGenericType(gType: GenericType): void;
-    /**
-     * Returns all methods defined in the specific class in the form of an array.
-     * @param generated - indicating whether this API returns the methods that are dynamically
-     * generated at runtime. If it is not specified as true or false, the return will not include the generated method.
-     * @returns An array of all methods in this class.
-     * @example
-     * 1. Get methods defined in class `BookService`.
-
-     ```typescript
-     let classes: ArkClass[] = scene.getClasses();
-     let serviceClass : ArkClass = classes[1];
-     let methods: ArkMethod[] = serviceClass.getMethods();
-     let methodNames: string[] = methods.map(mthd => mthd.name);
-     console.log(methodNames);
-     ```
-     */
-    getMethods(generated?: boolean): ArkMethod[];
-    getMethod(methodSignature: MethodSignature): ArkMethod | null;
-    getMethodWithName(methodName: string): ArkMethod | null;
-    getStaticMethodWithName(methodName: string): ArkMethod | null;
-    addMethod(method: ArkMethod): void;
-    setDefaultArkMethod(defaultMethod: ArkMethod): void;
-    getDefaultArkMethod(): ArkMethod | null;
-    setViewTree(viewTree: ViewTree): void;
-    /**
-     * Returns the view tree of the ArkClass.
-     * @returns The view tree of the ArkClass.
-     * @example
-     * 1. get viewTree of ArkClass.
-
-     ```typescript
-     for (let arkFiles of scene.getFiles()) {
-     for (let arkClasss of arkFiles.getClasses()) {
-     if (arkClasss.hasViewTree()) {
-     arkClasss.getViewTree();
-     }
-     }
-     }
-     ```
-     */
-    getViewTree(): ViewTree | undefined;
-    /**
-     * Check whether the view tree is defined.
-     * If it is defined, the return value is true, otherwise it is false.
-     * @returns True if the view tree is defined; false otherwise.
-     * @example
-     * 1. Judge viewTree of ArkClass.
-
-     ```typescript
-     for (let arkFiles of scene.getFiles()) {
-     for (let arkClasss of arkFiles.getClasses()) {
-     if (arkClasss.hasViewTree()) {
-     arkClasss.getViewTree();
-     }
-     }
-     }
-     ```
-     */
-    hasViewTree(): boolean;
-    getStaticFields(classMap: Map<FileSignature | NamespaceSignature, ArkClass[]>): ArkField[];
-    getGlobalVariable(globalMap: Map<FileSignature | NamespaceSignature, Local[]>): Local[];
-    getAnonymousMethodNumber(): number;
-    getIndexSignatureNumber(): number;
-    getExportType(): ExportType;
-    getInstanceInitMethod(): ArkMethod;
-    getStaticInitMethod(): ArkMethod;
-    setInstanceInitMethod(arkMethod: ArkMethod): void;
-    setStaticInitMethod(arkMethod: ArkMethod): void;
-    removeField(field: ArkField): boolean;
-    removeMethod(method: ArkMethod): boolean;
-    validate(): ArkError;
-}
+import { GenericType, Type } from '../base/Type';
+import { ViewTree } from '../graph/ViewTree';
+import { ArkField } from './ArkField';
+import { ArkFile } from './ArkFile';
+import { ArkMethod } from './ArkMethod';
+import { ArkNamespace } from './ArkNamespace';
+import { ClassSignature, FieldSignature, FileSignature, MethodSignature, NamespaceSignature } from './ArkSignature';
+import { Local } from '../base/Local';
+import { ArkExport, ExportType } from './ArkExport';
+import { ArkBaseModel } from './ArkBaseModel';
+import { ArkError } from '../common/ArkError';
+export declare enum ClassCategory {
+    CLASS = 0,
+    STRUCT = 1,
+    INTERFACE = 2,
+    ENUM = 3,
+    TYPE_LITERAL = 4,
+    OBJECT = 5
+}
+/**
+ * @category core/model
+ */
+export declare class ArkClass extends ArkBaseModel implements ArkExport {
+    private category;
+    private code?;
+    private lineCol;
+    private declaringArkFile;
+    private declaringArkNamespace;
+    private classSignature;
+    /**
+     * The keys of the `heritageClasses` map represent the names of superclass and interfaces.
+     * The superclass name is placed first; if it does not exist, an empty string `''` will occupy this position.
+     * The values of the `heritageClasses` map will be replaced with `ArkClass` or `null` during type inference.
+     */
+    private heritageClasses;
+    private genericsTypes?;
+    private realTypes?;
+    private defaultMethod;
+    private methods;
+    private fields;
+    private extendedClasses;
+    private staticMethods;
+    private staticFields;
+    private instanceInitMethod;
+    private staticInitMethod;
+    private anonymousMethodNumber;
+    private indexSignatureNumber;
+    private viewTree?;
+    constructor();
+    /**
+     * Returns the **string**name of this class.
+     * @returns The name of this class.
+     */
+    getName(): string;
+    /**
+     * Returns the codes of class as a **string.**
+     * @returns the codes of class.
+     */
+    getCode(): string | undefined;
+    setCode(code: string): void;
+    /**
+     * Returns the line position of this class.
+     * @returns The line position of this class.
+     */
+    getLine(): number;
+    setLine(line: number): void;
+    /**
+     * Returns the column position of this class.
+     * @returns The column position of this class.
+     */
+    getColumn(): number;
+    setColumn(column: number): void;
+    getCategory(): ClassCategory;
+    setCategory(category: ClassCategory): void;
+    /**
+     * Returns the declaring file.
+     * @returns A file defined by ArkAnalyzer.
+     * @example
+     * 1. Get the {@link ArkFile} which the ArkClass is in.
+
+     ```typescript
+     const arkFile = arkClass.getDeclaringArkFile();
+     ```
+     */
+    getDeclaringArkFile(): ArkFile;
+    setDeclaringArkFile(declaringArkFile: ArkFile): void;
+    /**
+     * Returns the declaring namespace of this class, which may also be an **undefined**.
+     * @returns The declaring namespace (may be **undefined**) of this class.
+     */
+    getDeclaringArkNamespace(): ArkNamespace | undefined;
+    setDeclaringArkNamespace(declaringArkNamespace: ArkNamespace | undefined): void;
+    isDefaultArkClass(): boolean;
+    isAnonymousClass(): boolean;
+    /**
+     * Returns the signature of current class (i.e., {@link ClassSignature}).
+     * The {@link ClassSignature} can uniquely identify a class, according to which we can find the class from the scene.
+     * @returns The class signature.
+     */
+    getSignature(): ClassSignature;
+    setSignature(classSig: ClassSignature): void;
+    getSuperClassName(): string;
+    addHeritageClassName(className: string): void;
+    /**
+     * Returns the superclass of this class.
+     * @returns The superclass of this class.
+     */
+    getSuperClass(): ArkClass | null;
+    private getHeritageClass;
+    getAllHeritageClasses(): ArkClass[];
+    getExtendedClasses(): Map<string, ArkClass>;
+    addExtendedClass(extendedClass: ArkClass): void;
+    getImplementedInterfaceNames(): string[];
+    hasImplementedInterface(interfaceName: string): boolean;
+    getImplementedInterface(interfaceName: string): ArkClass | null;
+    /**
+     * Get the field according to its field signature.
+     * If no field cound be found, **null**will be returned.
+     * @param fieldSignature - the field's signature.
+     * @returns A field. If there is no field in this class, the return will be a **null**.
+     */
+    getField(fieldSignature: FieldSignature): ArkField | null;
+    getFieldWithName(fieldName: string): ArkField | null;
+    getStaticFieldWithName(fieldName: string): ArkField | null;
+    /**
+     * Returns an **array** of fields in the class.
+     * @returns an **array** of fields in the class.
+     */
+    getFields(): ArkField[];
+    addField(field: ArkField): void;
+    addFields(fields: ArkField[]): void;
+    getRealTypes(): Type[] | undefined;
+    getGenericsTypes(): GenericType[] | undefined;
+    addGenericType(gType: GenericType): void;
+    /**
+     * Returns all methods defined in the specific class in the form of an array.
+     * @param generated - indicating whether this API returns the methods that are dynamically
+     * generated at runtime. If it is not specified as true or false, the return will not include the generated method.
+     * @returns An array of all methods in this class.
+     * @example
+     * 1. Get methods defined in class `BookService`.
+
+     ```typescript
+     let classes: ArkClass[] = scene.getClasses();
+     let serviceClass : ArkClass = classes[1];
+     let methods: ArkMethod[] = serviceClass.getMethods();
+     let methodNames: string[] = methods.map(mthd => mthd.name);
+     console.log(methodNames);
+     ```
+     */
+    getMethods(generated?: boolean): ArkMethod[];
+    getMethod(methodSignature: MethodSignature): ArkMethod | null;
+    getMethodWithName(methodName: string): ArkMethod | null;
+    getStaticMethodWithName(methodName: string): ArkMethod | null;
+    addMethod(method: ArkMethod): void;
+    setDefaultArkMethod(defaultMethod: ArkMethod): void;
+    getDefaultArkMethod(): ArkMethod | null;
+    setViewTree(viewTree: ViewTree): void;
+    /**
+     * Returns the view tree of the ArkClass.
+     * @returns The view tree of the ArkClass.
+     * @example
+     * 1. get viewTree of ArkClass.
+
+     ```typescript
+     for (let arkFiles of scene.getFiles()) {
+     for (let arkClasss of arkFiles.getClasses()) {
+     if (arkClasss.hasViewTree()) {
+     arkClasss.getViewTree();
+     }
+     }
+     }
+     ```
+     */
+    getViewTree(): ViewTree | undefined;
+    /**
+     * Check whether the view tree is defined.
+     * If it is defined, the return value is true, otherwise it is false.
+     * @returns True if the view tree is defined; false otherwise.
+     * @example
+     * 1. Judge viewTree of ArkClass.
+
+     ```typescript
+     for (let arkFiles of scene.getFiles()) {
+     for (let arkClasss of arkFiles.getClasses()) {
+     if (arkClasss.hasViewTree()) {
+     arkClasss.getViewTree();
+     }
+     }
+     }
+     ```
+     */
+    hasViewTree(): boolean;
+    getStaticFields(classMap: Map<FileSignature | NamespaceSignature, ArkClass[]>): ArkField[];
+    getGlobalVariable(globalMap: Map<FileSignature | NamespaceSignature, Local[]>): Local[];
+    getAnonymousMethodNumber(): number;
+    getIndexSignatureNumber(): number;
+    getExportType(): ExportType;
+    getInstanceInitMethod(): ArkMethod;
+    getStaticInitMethod(): ArkMethod;
+    setInstanceInitMethod(arkMethod: ArkMethod): void;
+    setStaticInitMethod(arkMethod: ArkMethod): void;
+    removeField(field: ArkField): boolean;
+    removeMethod(method: ArkMethod): boolean;
+    validate(): ArkError;
+}
 //# sourceMappingURL=ArkClass.d.ts.map