arkanalyzer 1.0.6 → 1.0.8

package/lib/core/model/ArkBaseModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArkBaseModel.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkBaseModel.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,MAAM,iBAAiB,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAgB,MAAM,oBAAoB,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAqB9E,oBAAY,YAAY;IACpB,OAAO,IAAI;IACX,SAAS,IAAS;IAClB,MAAM,IAAS;IACf,MAAM,IAAS;IACf,MAAM,KAAS;IACf,QAAQ,KAAS;IACjB,KAAK,KAAS;IACd,KAAK,MAAS;IACd,QAAQ,MAAS;IACjB,OAAO,MAAS;IAChB,EAAE,OAAU;IACZ,QAAQ,OAAU;IAClB,GAAG,OAAU;IACb,QAAQ,OAAU;IAClB,OAAO,QAAU;CACpB;AAED,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAsCzC,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,GAAG,YAAY,CAEnE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CASjE;AAED,8BAAsB,YAAY;IAC9B,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC;IAE1B,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,eAAe,GAAG,SAAS;IAI/D,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,GAAG,IAAI;IAOhE,YAAY,IAAI,MAAM;IAOtB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAMrC,WAAW,CAAC,QAAQ,EAAE,YAAY,GAAG,MAAM,GAAG,IAAI;IAIlD,cAAc,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAO5C,QAAQ,IAAI,OAAO;IAInB,WAAW,IAAI,OAAO;IAItB,SAAS,IAAI,OAAO;IAIpB,QAAQ,IAAI,OAAO;IAInB,UAAU,IAAI,OAAO;IAIrB,UAAU,IAAI,OAAO;IAIrB,QAAQ,IAAI,OAAO;IAI1B,gDAAgD;IACzC,UAAU,IAAI,OAAO;IAIrB,SAAS,IAAI,OAAO;IAIpB,gBAAgB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO;IAQrD,aAAa,IAAI,SAAS,EAAE;IAO5B,aAAa,CAAC,UAAU,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,IAAI;IAM/C,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAOxC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQnC,mBAAmB,IAAI,OAAO;IAI9B,kBAAkB,IAAI,SAAS,EAAE;IASjC,wBAAwB,IAAI,OAAO;IAInC,iBAAiB,IAAI,OAAO;IAI5B,qBAAqB,IAAI,OAAO;IAIhC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,OAAO;IAYxD,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ;aAepC,QAAQ,IAAI,QAAQ;CACvC"}

package/lib/core/model/ArkBaseModel.js

@@ -0,0 +1,271 @@
+"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.
+ */
+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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArkBaseModel = exports.modifiers2stringArray = exports.modifierKind2Enum = exports.MODIFIER_TYPE_MASK = exports.ModifierType = void 0;
+const ohos_typescript_1 = __importDefault(require("ohos-typescript"));
+const EtsConst_1 = require("../common/EtsConst");
+const ArkError_1 = require("../common/ArkError");
+const logger_1 = __importStar(require("../../utils/logger"));
+const ArkMetadata_1 = require("./ArkMetadata");
+const logger = logger_1.default.getLogger(logger_1.LOG_MODULE_TYPE.ARKANALYZER, 'ArkBaseModel');
+const COMPONENT_MEMBER_DECORATORS = new Set([
+    'State',
+    'Prop',
+    'Link',
+    'StorageProp',
+    'StorageLink',
+    'Provide',
+    'Consume',
+    'ObjectLink',
+    'LocalStorageLink',
+    'LocalStorageProp',
+    'Local',
+    'Param',
+    'Event',
+    'Provider',
+    'Consumer',
+]);
+var ModifierType;
+(function (ModifierType) {
+    ModifierType[ModifierType["PRIVATE"] = 1] = "PRIVATE";
+    ModifierType[ModifierType["PROTECTED"] = 2] = "PROTECTED";
+    ModifierType[ModifierType["PUBLIC"] = 4] = "PUBLIC";
+    ModifierType[ModifierType["EXPORT"] = 8] = "EXPORT";
+    ModifierType[ModifierType["STATIC"] = 16] = "STATIC";
+    ModifierType[ModifierType["ABSTRACT"] = 32] = "ABSTRACT";
+    ModifierType[ModifierType["ASYNC"] = 64] = "ASYNC";
+    ModifierType[ModifierType["CONST"] = 128] = "CONST";
+    ModifierType[ModifierType["ACCESSOR"] = 256] = "ACCESSOR";
+    ModifierType[ModifierType["DEFAULT"] = 512] = "DEFAULT";
+    ModifierType[ModifierType["IN"] = 1024] = "IN";
+    ModifierType[ModifierType["READONLY"] = 2048] = "READONLY";
+    ModifierType[ModifierType["OUT"] = 4096] = "OUT";
+    ModifierType[ModifierType["OVERRIDE"] = 8192] = "OVERRIDE";
+    ModifierType[ModifierType["DECLARE"] = 16384] = "DECLARE";
+})(ModifierType = exports.ModifierType || (exports.ModifierType = {}));
+exports.MODIFIER_TYPE_MASK = 0xffff;
+const MODIFIER_TYPE_STRINGS = [
+    'private',
+    'protected',
+    'public',
+    'export',
+    'static',
+    'abstract',
+    'async',
+    'const',
+    'accessor',
+    'default',
+    'in',
+    'readonly',
+    'out',
+    'override',
+    'declare',
+];
+const MODIFIER_KIND_2_ENUM = new Map([
+    [ohos_typescript_1.default.SyntaxKind.AbstractKeyword, ModifierType.ABSTRACT],
+    [ohos_typescript_1.default.SyntaxKind.AccessorKeyword, ModifierType.ACCESSOR],
+    [ohos_typescript_1.default.SyntaxKind.AsyncKeyword, ModifierType.ASYNC],
+    [ohos_typescript_1.default.SyntaxKind.ConstKeyword, ModifierType.CONST],
+    [ohos_typescript_1.default.SyntaxKind.DeclareKeyword, ModifierType.DECLARE],
+    [ohos_typescript_1.default.SyntaxKind.DefaultKeyword, ModifierType.DEFAULT],
+    [ohos_typescript_1.default.SyntaxKind.ExportKeyword, ModifierType.EXPORT],
+    [ohos_typescript_1.default.SyntaxKind.InKeyword, ModifierType.IN],
+    [ohos_typescript_1.default.SyntaxKind.PrivateKeyword, ModifierType.PRIVATE],
+    [ohos_typescript_1.default.SyntaxKind.ProtectedKeyword, ModifierType.PROTECTED],
+    [ohos_typescript_1.default.SyntaxKind.PublicKeyword, ModifierType.PUBLIC],
+    [ohos_typescript_1.default.SyntaxKind.ReadonlyKeyword, ModifierType.READONLY],
+    [ohos_typescript_1.default.SyntaxKind.OutKeyword, ModifierType.OUT],
+    [ohos_typescript_1.default.SyntaxKind.OverrideKeyword, ModifierType.OVERRIDE],
+    [ohos_typescript_1.default.SyntaxKind.StaticKeyword, ModifierType.STATIC],
+]);
+function modifierKind2Enum(kind) {
+    return MODIFIER_KIND_2_ENUM.get(kind);
+}
+exports.modifierKind2Enum = modifierKind2Enum;
+function modifiers2stringArray(modifiers) {
+    let strs = [];
+    for (let idx = 0; idx < MODIFIER_TYPE_STRINGS.length; idx++) {
+        if (modifiers & 0x01) {
+            strs.push(MODIFIER_TYPE_STRINGS[idx]);
+        }
+        modifiers = modifiers >>> 1;
+    }
+    return strs;
+}
+exports.modifiers2stringArray = modifiers2stringArray;
+class ArkBaseModel {
+    getMetadata(kind) {
+        var _a;
+        return (_a = this.metadata) === null || _a === void 0 ? void 0 : _a.getMetadata(kind);
+    }
+    setMetadata(kind, value) {
+        var _a;
+        if (!this.metadata) {
+            this.metadata = new ArkMetadata_1.ArkMetadata();
+        }
+        return (_a = this.metadata) === null || _a === void 0 ? void 0 : _a.setMetadata(kind, value);
+    }
+    getModifiers() {
+        if (!this.modifiers) {
+            return 0;
+        }
+        return this.modifiers;
+    }
+    setModifiers(modifiers) {
+        if (modifiers !== 0) {
+            this.modifiers = modifiers;
+        }
+    }
+    addModifier(modifier) {
+        this.modifiers = this.getModifiers() | modifier;
+    }
+    removeModifier(modifier) {
+        if (!this.modifiers) {
+            return;
+        }
+        this.modifiers &= exports.MODIFIER_TYPE_MASK ^ modifier;
+    }
+    isStatic() {
+        return this.containsModifier(ModifierType.STATIC);
+    }
+    isProtected() {
+        return this.containsModifier(ModifierType.PROTECTED);
+    }
+    isPrivate() {
+        return this.containsModifier(ModifierType.PRIVATE);
+    }
+    isPublic() {
+        return this.containsModifier(ModifierType.PUBLIC);
+    }
+    isReadonly() {
+        return this.containsModifier(ModifierType.READONLY);
+    }
+    isAbstract() {
+        return this.containsModifier(ModifierType.ABSTRACT);
+    }
+    isExport() {
+        return this.containsModifier(ModifierType.EXPORT);
+    }
+    /** @deprecated Use {@link isExport} instead. */
+    isExported() {
+        return this.isExport();
+    }
+    isDeclare() {
+        return this.containsModifier(ModifierType.DECLARE);
+    }
+    containsModifier(modifierType) {
+        if (!this.modifiers) {
+            return false;
+        }
+        return (this.modifiers & modifierType) === modifierType;
+    }
+    getDecorators() {
+        if (this.decorators) {
+            return Array.from(this.decorators);
+        }
+        return [];
+    }
+    setDecorators(decorators) {
+        if (decorators.size > 0) {
+            this.decorators = decorators;
+        }
+    }
+    addDecorator(decorator) {
+        if (!this.decorators) {
+            this.decorators = new Set();
+        }
+        this.decorators.add(decorator);
+    }
+    removeDecorator(kind) {
+        var _a;
+        (_a = this.decorators) === null || _a === void 0 ? void 0 : _a.forEach((value) => {
+            var _a;
+            if (value.getKind() === kind) {
+                (_a = this.decorators) === null || _a === void 0 ? void 0 : _a.delete(value);
+            }
+        });
+    }
+    hasBuilderDecorator() {
+        return this.hasDecorator(EtsConst_1.BUILDER_DECORATOR);
+    }
+    getStateDecorators() {
+        if (!this.decorators) {
+            return [];
+        }
+        return Array.from(this.decorators).filter((item) => {
+            return COMPONENT_MEMBER_DECORATORS.has(item.getKind());
+        });
+    }
+    hasBuilderParamDecorator() {
+        return this.hasDecorator(EtsConst_1.BUILDER_PARAM_DECORATOR);
+    }
+    hasEntryDecorator() {
+        return this.hasDecorator(EtsConst_1.ENTRY_DECORATOR);
+    }
+    hasComponentDecorator() {
+        return this.hasDecorator(EtsConst_1.COMPONENT_DECORATOR);
+    }
+    hasDecorator(kind) {
+        let decorators = this.getDecorators();
+        return (decorators.filter((value) => {
+            if (kind instanceof Set) {
+                return kind.has(value.getKind());
+            }
+            return value.getKind() === kind;
+        }).length !== 0);
+    }
+    validateFields(fields) {
+        let errs = [];
+        for (const field of fields) {
+            let value = Reflect.get(this, field);
+            if (!value) {
+                errs.push(field);
+            }
+        }
+        if (errs.length === 0) {
+            return { errCode: ArkError_1.ArkErrorCode.OK };
+        }
+        logger.error(`class fields: ${errs.join(',')} is undefined.`);
+        return { errCode: ArkError_1.ArkErrorCode.CLASS_INSTANCE_FIELD_UNDEFINDED, errMsg: `${errs.join(',')} is undefined.` };
+    }
+}
+exports.ArkBaseModel = ArkBaseModel;

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

@@ -1,22 +1,16 @@
 import { Local } from '../base/Local';
 import { Cfg } from '../graph/Cfg';
-import { Stmt } from '../base/Stmt';
 import { AliasType, AliasTypeDeclaration } from '../base/Type';
 export declare class ArkBody {
     private locals;
-    private originalCfg;
     private cfg;
-    private stmtToOriginalStmt;
-    private aliasTypeMap;
-    constructor(locals: Set<Local>, originalCfg: Cfg, cfg: Cfg, stmtToOriginalStmt: Map<Stmt, Stmt>, aliasTypeMap: Map<string, [AliasType, AliasTypeDeclaration]>);
+    private aliasTypeMap?;
+    constructor(locals: Set<Local>, cfg: Cfg, aliasTypeMap?: Map<string, [AliasType, AliasTypeDeclaration]>);
     getLocals(): Map<string, Local>;
     setLocals(locals: Set<Local>): void;
     getCfg(): Cfg;
     setCfg(cfg: Cfg): void;
-    getOriginalCfg(): Cfg;
-    setOriginalCfg(originalCfg: Cfg): void;
-    getStmtToOriginalStmt(): Map<Stmt, Stmt>;
-    getAliasTypeMap(): Map<string, [AliasType, AliasTypeDeclaration]>;
+    getAliasTypeMap(): Map<string, [AliasType, AliasTypeDeclaration]> | undefined;
     getAliasTypeByName(name: string): AliasType | null;
 }
 //# sourceMappingURL=ArkBody.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ArkBody.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkBody.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAE/D,qBAAa,OAAO;IAChB,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,WAAW,CAAM;IACzB,OAAO,CAAC,GAAG,CAAM;IACjB,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,YAAY,CAA6D;gBAErE,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,kBAAkB,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAStJ,SAAS,IAAI,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC;IAI/B,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI;IAOnC,MAAM,IAAI,GAAG;IAIb,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAItB,cAAc,IAAI,GAAG;IAIrB,cAAc,CAAC,WAAW,EAAE,GAAG,GAAG,IAAI;IAItC,qBAAqB,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC;IAIxC,eAAe,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAIjE,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAO5D"}
+{"version":3,"file":"ArkBody.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkBody.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAE/D,qBAAa,OAAO;IAChB,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,GAAG,CAAM;IACjB,OAAO,CAAC,YAAY,CAAC,CAAiD;gBAE1D,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAOhG,SAAS,IAAI,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC;IAI/B,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI;IAOnC,MAAM,IAAI,GAAG;IAIb,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAItB,eAAe,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC,GAAG,SAAS;IAI7E,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAO5D"}

package/lib/core/model/ArkBody.js

@@ -16,11 +16,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArkBody = void 0;
 class ArkBody {
-    constructor(locals, originalCfg, cfg, stmtToOriginalStmt, aliasTypeMap) {
-        this.aliasTypeMap = new Map();
-        this.originalCfg = originalCfg;
+    constructor(locals, cfg, aliasTypeMap) {
         this.cfg = cfg;
-        this.stmtToOriginalStmt = stmtToOriginalStmt;
         this.aliasTypeMap = aliasTypeMap;
         this.locals = new Map();
         locals.forEach(local => this.locals.set(local.getName(), local));
@@ -40,20 +37,12 @@ class ArkBody {
     setCfg(cfg) {
         this.cfg = cfg;
     }
-    getOriginalCfg() {
-        return this.originalCfg;
-    }
-    setOriginalCfg(originalCfg) {
-        this.originalCfg = originalCfg;
-    }
-    getStmtToOriginalStmt() {
-        return this.stmtToOriginalStmt;
-    }
     getAliasTypeMap() {
         return this.aliasTypeMap;
     }
     getAliasTypeByName(name) {
-        const aliasTypeInfo = this.aliasTypeMap.get(name);
+        var _a;
+        const aliasTypeInfo = (_a = this.aliasTypeMap) === null || _a === void 0 ? void 0 : _a.get(name);
         if (aliasTypeInfo) {
             return aliasTypeInfo[0];
         }

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

@@ -1,4 +1,4 @@
-import { GenericType } from '../base/Type';
+import { GenericType, Type } from '../base/Type';
 import { ViewTree } from '../graph/ViewTree';
 import { ArkField } from './ArkField';
 import { ArkFile } from './ArkFile';
@@ -6,8 +6,9 @@ import { ArkMethod } from './ArkMethod';
 import { ArkNamespace } from './ArkNamespace';
 import { ClassSignature, FieldSignature, FileSignature, MethodSignature, NamespaceSignature } from './ArkSignature';
 import { Local } from '../base/Local';
-import { Decorator } from '../base/Decorator';
 import { ArkExport, ExportType } from './ArkExport';
+import { ArkBaseModel } from './ArkBaseModel';
+import { ArkError } from '../common/ArkError';
 export declare enum ClassCategory {
     CLASS = 0,
     STRUCT = 1,
@@ -19,7 +20,7 @@ export declare enum ClassCategory {
 /**
  * @category core/model
  */
-export declare class ArkClass implements ArkExport {
+export declare class ArkClass extends ArkBaseModel implements ArkExport {
     private category;
     private code?;
     private lineCol;
@@ -29,8 +30,8 @@ export declare class ArkClass implements ArkExport {
     private superClassName;
     private superClass?;
     private implementedInterfaceNames;
-    private modifiers;
     private genericsTypes?;
+    private realTypes?;
     private defaultMethod;
     private methods;
     private fields;
@@ -43,26 +44,64 @@ export declare class ArkClass implements ArkExport {
     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;
-    isExported(): boolean;
     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;
     setSuperClassName(superClassName: string): void;
+    /**
+     * Returns the superclass of this class.
+     * @returns The superclass of this class.
+     */
     getSuperClass(): ArkClass | null;
     setSuperClass(superClass: ArkClass): void;
     getExtendedClasses(): Map<string, ArkClass>;
@@ -70,18 +109,41 @@ export declare class ArkClass implements ArkExport {
     getImplementedInterfaceNames(): string[];
     addImplementedInterfaceName(interfaceName: string): void;
     hasImplementedInterface(interfaceName: string): boolean;
+    /**
+     * 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;
-    getModifiers(): Set<string | Decorator>;
-    addModifier(name: string | Decorator): void;
+    getRealTypes(): Type[] | undefined;
     getGenericsTypes(): GenericType[] | undefined;
     addGenericType(gType: GenericType): void;
-    containsModifier(name: string): boolean;
-    isStatic(): boolean;
+    /**
+     * 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;
@@ -90,14 +152,43 @@ export declare class ArkClass implements ArkExport {
     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[];
-    getDecorators(): Decorator[];
-    hasEntryDecorator(): boolean;
-    hasComponentDecorator(): boolean;
-    private hasDecorator;
     getAnonymousMethodNumber(): number;
     getIndexSignatureNumber(): number;
     getExportType(): ExportType;
@@ -105,5 +196,8 @@ export declare class ArkClass implements ArkExport {
     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

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

@@ -1 +1 @@
-{"version":3,"file":"ArkClass.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkClass.ts"],"names":[],"mappings":"AAeA,OAAO,EAAa,WAAW,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpH,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKpD,oBAAY,aAAa;IACrB,KAAK,IAAI;IACT,MAAM,IAAI;IACV,SAAS,IAAI;IACb,IAAI,IAAI;IACR,YAAY,IAAI;IAChB,MAAM,IAAI;CACb;AAED;;GAEG;AACH,qBAAa,QAAS,YAAW,SAAS;IACtC,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,OAAO,CAAc;IAE7B,OAAO,CAAC,gBAAgB,CAAW;IACnC,OAAO,CAAC,qBAAqB,CAA2B;IACxD,OAAO,CAAC,cAAc,CAAkB;IAExC,OAAO,CAAC,cAAc,CAAc;IACpC,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,yBAAyB,CAAgB;IACjD,OAAO,CAAC,SAAS,CAA0D;IAC3E,OAAO,CAAC,aAAa,CAAC,CAAgB;IAEtC,OAAO,CAAC,aAAa,CAA0B;IAG/C,OAAO,CAAC,OAAO,CAAwD;IACvE,OAAO,CAAC,MAAM,CAAsD;IACpE,OAAO,CAAC,eAAe,CAAsD;IAC7E,OAAO,CAAC,aAAa,CAAwD;IAC7E,OAAO,CAAC,YAAY,CAAsD;IAE1E,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,gBAAgB,CAA8B;IAEtD,OAAO,CAAC,qBAAqB,CAAa;IAC1C,OAAO,CAAC,oBAAoB,CAAa;IAEzC,OAAO,CAAC,QAAQ,CAAC,CAAW;;IAKrB,OAAO;IAIP,OAAO;IAIP,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,OAAO;IAIP,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM;IAIxB,WAAW,IAAI,aAAa;IAI5B,WAAW,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAI1C,mBAAmB;IAInB,mBAAmB,CAAC,gBAAgB,EAAE,OAAO;IAI7C,wBAAwB,IAAI,YAAY,GAAG,SAAS;IAIpD,wBAAwB,CAAC,qBAAqB,EAAE,YAAY,GAAG,SAAS;IAIxE,UAAU,IAAI,OAAO;IAIrB,iBAAiB,IAAI,OAAO;IAI5B,gBAAgB,IAAI,OAAO;IAI3B,YAAY;IAIZ,YAAY,CAAC,QAAQ,EAAE,cAAc;IAIrC,iBAAiB;IAIjB,iBAAiB,CAAC,cAAc,EAAE,MAAM;IAIxC,aAAa,IAAI,QAAQ,GAAG,IAAI;IAgBhC,aAAa,CAAC,UAAU,EAAE,QAAQ;IAIlC,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC;IAI3C,gBAAgB,CAAC,aAAa,EAAE,QAAQ;IAIxC,4BAA4B;IAI5B,2BAA2B,CAAC,aAAa,EAAE,MAAM;IAIjD,uBAAuB,CAAC,aAAa,EAAE,MAAM;IAI7C,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,QAAQ,GAAG,IAAI;IASzD,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAIpD,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAI1D,SAAS,IAAI,QAAQ,EAAE;IAMvB,QAAQ,CAAC,KAAK,EAAE,QAAQ;IAQxB,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE;IAM5B,YAAY;IAIZ,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAIpC,gBAAgB;IAIhB,cAAc,CAAC,KAAK,EAAE,WAAW;IAOjC,gBAAgB,CAAC,IAAI,EAAE,MAAM;IAI7B,QAAQ,IAAI,OAAO;IAOnB,UAAU,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE;IAO5C,SAAS,CAAC,eAAe,EAAE,eAAe,GAAG,SAAS,GAAG,IAAI;IAS7D,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAIvD,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAK7D,SAAS,CAAC,MAAM,EAAE,SAAS;IAQ3B,mBAAmB,CAAC,aAAa,EAAE,SAAS;IAK5C,mBAAmB,IAAI,SAAS,GAAG,IAAI;IAIvC,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAI9B,WAAW,IAAI,QAAQ,GAAG,SAAS;IAInC,WAAW,IAAI,OAAO;IAItB,eAAe,CAAC,QAAQ,EAAE,GAAG,CAAC,aAAa,GAAG,kBAAkB,EAAE,QAAQ,EAAE,CAAC,GAAG,QAAQ,EAAE;IAkB1F,iBAAiB,CAAC,SAAS,EAAE,GAAG,CAAC,aAAa,GAAG,kBAAkB,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE;IAOvF,aAAa,IAAI,SAAS,EAAE;IAM5B,iBAAiB,IAAI,OAAO;IAI5B,qBAAqB,IAAI,OAAO;IAIvC,OAAO,CAAC,YAAY;IAUb,wBAAwB;IAIxB,uBAAuB;IAI9B,aAAa,IAAI,UAAU;IAIpB,qBAAqB,IAAI,SAAS;IAIlC,mBAAmB,IAAI,SAAS;IAIhC,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAIjD,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;CAGzD"}
+{"version":3,"file":"ArkClass.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkClass.ts"],"names":[],"mappings":"AAeA,OAAO,EAAa,WAAW,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpH,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,oBAAY,aAAa;IACrB,KAAK,IAAI;IACT,MAAM,IAAI;IACV,SAAS,IAAI;IACb,IAAI,IAAI;IACR,YAAY,IAAI;IAChB,MAAM,IAAI;CACb;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,YAAa,YAAW,SAAS;IAC3D,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,OAAO,CAAc;IAE7B,OAAO,CAAC,gBAAgB,CAAW;IACnC,OAAO,CAAC,qBAAqB,CAA2B;IACxD,OAAO,CAAC,cAAc,CAAkB;IAExC,OAAO,CAAC,cAAc,CAAc;IACpC,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,yBAAyB,CAAgB;IACjD,OAAO,CAAC,aAAa,CAAC,CAAgB;IACtC,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,aAAa,CAA0B;IAG/C,OAAO,CAAC,OAAO,CAAwD;IACvE,OAAO,CAAC,MAAM,CAAsD;IACpE,OAAO,CAAC,eAAe,CAAsD;IAC7E,OAAO,CAAC,aAAa,CAAwD;IAC7E,OAAO,CAAC,YAAY,CAAsD;IAE1E,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,gBAAgB,CAA8B;IAEtD,OAAO,CAAC,qBAAqB,CAAa;IAC1C,OAAO,CAAC,oBAAoB,CAAa;IAEzC,OAAO,CAAC,QAAQ,CAAC,CAAW;;IAM5B;;;OAGG;IACI,OAAO;IAId;;;OAGG;IACI,OAAO;IAIP,OAAO,CAAC,IAAI,EAAE,MAAM;IAI3B;;;OAGG;IACI,OAAO;IAIP,OAAO,CAAC,IAAI,EAAE,MAAM;IAI3B;;;OAGG;IACI,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM;IAIxB,WAAW,IAAI,aAAa;IAI5B,WAAW,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAIjD;;;;;;;;;OASG;IACI,mBAAmB;IAInB,mBAAmB,CAAC,gBAAgB,EAAE,OAAO;IAIpD;;;OAGG;IACI,wBAAwB,IAAI,YAAY,GAAG,SAAS;IAIpD,wBAAwB,CAAC,qBAAqB,EAAE,YAAY,GAAG,SAAS;IAIxE,iBAAiB,IAAI,OAAO;IAI5B,gBAAgB,IAAI,OAAO;IAIlC;;;;OAIG;IACI,YAAY;IAIZ,YAAY,CAAC,QAAQ,EAAE,cAAc;IAIrC,iBAAiB;IAIjB,iBAAiB,CAAC,cAAc,EAAE,MAAM;IAI/C;;;OAGG;IACI,aAAa,IAAI,QAAQ,GAAG,IAAI;IAmBhC,aAAa,CAAC,UAAU,EAAE,QAAQ;IAIlC,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC;IAI3C,gBAAgB,CAAC,aAAa,EAAE,QAAQ;IAIxC,4BAA4B;IAI5B,2BAA2B,CAAC,aAAa,EAAE,MAAM;IAIjD,uBAAuB,CAAC,aAAa,EAAE,MAAM;IAIpD;;;;;OAKG;IACI,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,QAAQ,GAAG,IAAI;IASzD,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAIpD,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAIjE;;;OAGG;IACI,SAAS,IAAI,QAAQ,EAAE;IAMvB,QAAQ,CAAC,KAAK,EAAE,QAAQ;IAQxB,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE;IAM5B,YAAY,IAAI,IAAI,EAAE,GAAG,SAAS;IAIlC,gBAAgB;IAIhB,cAAc,CAAC,KAAK,EAAE,WAAW;IAOxC;;;;;;;;;;;;;;;OAeG;IACI,UAAU,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE;IAO5C,SAAS,CAAC,eAAe,EAAE,eAAe,GAAG,SAAS,GAAG,IAAI;IAqB7D,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAIvD,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAI7D,SAAS,CAAC,MAAM,EAAE,SAAS;IAQ3B,mBAAmB,CAAC,aAAa,EAAE,SAAS;IAK5C,mBAAmB,IAAI,SAAS,GAAG,IAAI;IAIvC,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAIrC;;;;;;;;;;;;;;;OAeG;IACI,WAAW,IAAI,QAAQ,GAAG,SAAS;IAI1C;;;;;;;;;;;;;;;;OAgBG;IACI,WAAW,IAAI,OAAO;IAItB,eAAe,CAAC,QAAQ,EAAE,GAAG,CAAC,aAAa,GAAG,kBAAkB,EAAE,QAAQ,EAAE,CAAC,GAAG,QAAQ,EAAE;IAkB1F,iBAAiB,CAAC,SAAS,EAAE,GAAG,CAAC,aAAa,GAAG,kBAAkB,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE;IAOvF,wBAAwB;IAIxB,uBAAuB;IAI9B,aAAa,IAAI,UAAU;IAIpB,qBAAqB,IAAI,SAAS;IAIlC,mBAAmB,IAAI,SAAS;IAIhC,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAIjD,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAI/C,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAOrC,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAWxC,QAAQ,IAAI,QAAQ;CAG9B"}