arkanalyzer 1.0.7 → 1.0.9

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

@@ -1,5 +1,5 @@
 import { Stmt } from '../base/Stmt';
-import { GenericType } from '../base/Type';
+import { GenericType, Type } from '../base/Type';
 import { Value } from '../base/Value';
 import { Cfg } from '../graph/Cfg';
 import { ViewTree } from '../graph/ViewTree';
@@ -8,17 +8,21 @@ import { ArkClass } from './ArkClass';
 import { MethodSignature } from './ArkSignature';
 import { BodyBuilder } from '../common/BodyBuilder';
 import { ArkExport, ExportType } from './ArkExport';
+import { LineCol } from '../base/Position';
 import { ArkBaseModel } from './ArkBaseModel';
+import { ArkError } from '../common/ArkError';
 export declare const arkMethodNodeKind: string[];
 /**
  * @category core/model
  */
 export declare class ArkMethod extends ArkBaseModel implements ArkExport {
     private code?;
-    private lineCol;
     private declaringArkClass;
     private genericTypes?;
-    private methodSignature;
+    private methodDeclareSignatures?;
+    private methodDeclareLineCols?;
+    private methodSignature?;
+    private lineCol?;
     private body?;
     private viewTree?;
     private bodyBuilder?;
@@ -33,10 +37,70 @@ export declare class ArkMethod extends ArkBaseModel implements ArkExport {
      */
     getCode(): string | undefined;
     setCode(code: string): void;
-    getLine(): number;
+    /**
+     * Get all lines of the method's declarations or null if the method has no seperated declaration.
+     * @returns null or the lines of the method's declarations with number type.
+     */
+    getDeclareLines(): number[] | null;
+    /**
+     * Get all columns of the method's declarations or null if the method has no seperated declaration.
+     * @returns null or the columns of the method's declarations with number type.
+     */
+    getDeclareColumns(): number[] | null;
+    /**
+     * Set lines and columns of the declarations with number type inputs and then encoded them to LineCol type.
+     * The length of lines and columns should be the same otherwise they cannot be encoded together.
+     * @param lines - the number of lines.
+     * @param columns - the number of columns.
+     * @returns
+     */
+    setDeclareLinesAndCols(lines: number[], columns: number[]): void;
+    /**
+     * Set lineCols of the declarations directly with LineCol type input.
+     * @param lineCols - the encoded lines and columns with LineCol type.
+     * @returns
+     */
+    setDeclareLineCols(lineCols: LineCol[]): void;
+    /**
+     * Get encoded lines and columns of the method's declarations or null if the method has no seperated declaration.
+     * @returns null or the encoded lines and columns of the method's declarations with LineCol type.
+     */
+    getDeclareLineCols(): LineCol[] | null;
+    /**
+     * Get line of the method's implementation or null if the method has no implementation.
+     * @returns null or the number of the line.
+     */
+    getLine(): number | null;
+    /**
+     * Set line of the implementation with line number input.
+     * The line number will be encoded together with the original column number.
+     * @param line - the line number of the method implementation.
+     * @returns
+     */
     setLine(line: number): void;
-    getColumn(): number;
+    /**
+     * Get column of the method's implementation or null if the method has no implementation.
+     * @returns null or the number of the column.
+     */
+    getColumn(): number | null;
+    /**
+     * Set column of the implementation with column number input.
+     * The column number will be encoded together with the original line number.
+     * @param column - the column number of the method implementation.
+     * @returns
+     */
     setColumn(column: number): void;
+    /**
+     * Get encoded line and column of the method's implementation or null if the method has no implementation.
+     * @returns null or the encoded line and column of the method's implementation with LineCol type.
+     */
+    getLineCol(): LineCol | null;
+    /**
+     * Set lineCol of the implementation directly with LineCol type input.
+     * @param lineCol - the encoded line and column with LineCol type.
+     * @returns
+     */
+    setLineCol(lineCol: LineCol): void;
     /**
      * Returns the declaring class of the method.
      * @returns The declaring class of the method.
@@ -47,27 +111,64 @@ export declare class ArkMethod extends ArkBaseModel implements ArkExport {
     isDefaultArkMethod(): boolean;
     isAnonymousMethod(): boolean;
     getParameters(): import("./builder/ArkMethodBuilder").MethodParameter[];
-    getReturnType(): import("../base/Type").Type;
+    getReturnType(): Type;
+    /**
+     * Get all declare signatures.
+     * The results could be null if there is no seperated declaration of the method.
+     * @returns null or the method declare signatures.
+     */
+    getDeclareSignatures(): MethodSignature[] | null;
+    /**
+     * Get the index of the matched method declare signature among all declare signatures.
+     * The index will be -1 if there is no matched signature found.
+     * @param targetSignature - the target declare signature want to search.
+     * @returns -1 or the index of the matched signature.
+     */
+    getDeclareSignatureIndex(targetSignature: MethodSignature): number;
     /**
-     * <font color="red">?建议明确返回类型？</font>
-     * Get the method signature. It includes two fields. one is ClassSignature,
-     * the other is MethodSubSignature. The former indicates what class this method belong to,
-     * the latter indicates the detail info of this method,
-     * such as method name, parameters, returnType, etc.
+     * Get the method signature of the implementation.
+     * The signature could be null if the method is only a declaration which body is undefined.
+     * @returns null or the method implementation signature.
+     */
+    getImplementationSignature(): MethodSignature | null;
+    /**
+     * Get the method signature of the implementation or the first declaration if there is no implementation.
+     * For a method, the implementation and declaration signatures must not be undefined at the same time.
+     * A {@link MethodSignature} includes:
+     * - Class Signature: indicates which class this method belong to.
+     * - Method SubSignature: indicates the detail info of this method such as method name, parameters, returnType, etc.
      * @returns The method signature.
      * @example
-     * 1. New a body.
+     * 1. Get the signature of method mtd.
 
-    ```typescript
-    let mtd = new ArkMethod();
-    // ... ...
-    let mtd = mtd.getSignature();
-    // ... ...
-    ```
+     ```typescript
+     let signature = mtd.getSignature();
+     // ... ...
+     ```
      */
     getSignature(): MethodSignature;
-    getAllSignature(): MethodSignature[];
-    setSignature(methodSignature: MethodSignature | MethodSignature[]): void;
+    /**
+     * Set signatures of all declarations.
+     * It will reset the declaration signatures if they are already defined before.
+     * @param signatures - one signature or a list of signatures.
+     * @returns
+     */
+    setDeclareSignatures(signatures: MethodSignature | MethodSignature[]): void;
+    /**
+     * Reset signature of one declaration with the specified index.
+     * Will do nothing if the index doesn't exist.
+     * @param signature - new signature want to set.
+     * @param index - index of signature want to set.
+     * @returns
+     */
+    setDeclareSignatureWithIndex(signature: MethodSignature, index: number): void;
+    /**
+     * Set signature of implementation.
+     * It will reset the implementation signature if it is already defined before.
+     * @param signature - signature of implementation.
+     * @returns
+     */
+    setImplementationSignature(signature: MethodSignature): void;
     getSubSignature(): import("./ArkSignature").MethodSubSignature;
     getGenericTypes(): GenericType[] | undefined;
     isGenericsMethod(): boolean;
@@ -82,17 +183,17 @@ export declare class ArkMethod extends ArkBaseModel implements ArkExport {
      * @example
      * 1. Get cfg or stmt through ArkBody.
 
-    ```typescript
-    let cfg = this.scene.getMethod()?.getBody().getCfg();
-    const body = arkMethod.getBody()
-    ```
+     ```typescript
+     let cfg = this.scene.getMethod()?.getBody().getCfg();
+     const body = arkMethod.getBody()
+     ```
 
-    2. Get local variable through ArkBody.
+     2. Get local variable through ArkBody.
 
-    ```typescript
-    arkClass.getDefaultArkMethod()?.getBody().getLocals.forEach(local=>{...})
-    let locals = arkFile().getDefaultClass().getDefaultArkMethod()?.getBody()?.getLocals();
-    ```
+     ```typescript
+     arkClass.getDefaultArkMethod()?.getBody().getLocals.forEach(local=>{...})
+     let locals = arkFile().getDefaultClass().getDefaultArkMethod()?.getBody()?.getLocals();
+     ```
      */
     getBody(): ArkBody | undefined;
     setBody(body: ArkBody): void;
@@ -104,32 +205,32 @@ export declare class ArkMethod extends ArkBaseModel implements ArkExport {
      * @example
      * 1. get stmt through ArkBody cfg.
 
-    ```typescript
-    body = arkMethod.getBody();
-    const cfg = body.getCfg();
-    for (const threeAddressStmt of cfg.getStmts()) {
-    ... ...
-    }
-    ```
+     ```typescript
+     body = arkMethod.getBody();
+     const cfg = body.getCfg();
+     for (const threeAddressStmt of cfg.getStmts()) {
+     ... ...
+     }
+     ```
 
-    2. get blocks through ArkBody cfg.
+     2. get blocks through ArkBody cfg.
 
-    ```typescript
-    const body = arkMethod.getBody();
-    const blocks = [...body.getCfg().getBlocks()];
-    for (let i=0; i<blocks.length; i++) {
-    const block = blocks[i];
-    ... ...
-    for (const stmt of block.getStmts()) {
-        ... ...
-    }
-    let text = "next;"
-    for (const next of block.getSuccessors()) {
-        text += blocks.indexOf(next) + ' ';
-    }
-    // ... ...
-    }
-    ```
+     ```typescript
+     const body = arkMethod.getBody();
+     const blocks = [...body.getCfg().getBlocks()];
+     for (let i=0; i<blocks.length; i++) {
+     const block = blocks[i];
+     ... ...
+     for (const stmt of block.getStmts()) {
+     ... ...
+     }
+     let text = "next;"
+     for (const next of block.getSuccessors()) {
+     text += blocks.indexOf(next) + ' ';
+     }
+     // ... ...
+     }
+     ```
      */
     getCfg(): Cfg | undefined;
     getOriginalCfg(): Cfg | undefined;
@@ -146,5 +247,7 @@ export declare class ArkMethod extends ArkBaseModel implements ArkExport {
     setIsGeneratedFlag(isGeneratedFlag: boolean): void;
     getAsteriskToken(): boolean;
     setAsteriskToken(asteriskToken: boolean): void;
+    validate(): ArkError;
+    matchMethodSignature(args: Type[]): MethodSignature;
 }
 //# sourceMappingURL=ArkMethod.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ArkMethod.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkMethod.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAgC,IAAI,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,eAAO,MAAM,iBAAiB,UACqF,CAAC;AAEpH;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAa,YAAW,SAAS;IAC5D,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,OAAO,CAAc;IAE7B,OAAO,CAAC,iBAAiB,CAAY;IAErC,OAAO,CAAC,YAAY,CAAC,CAAgB;IAErC,OAAO,CAAC,eAAe,CAAqB;IAE5C,OAAO,CAAC,IAAI,CAAC,CAAU;IACvB,OAAO,CAAC,QAAQ,CAAC,CAAW;IAE5B,OAAO,CAAC,WAAW,CAAC,CAAc;IAElC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,aAAa,CAAkB;;IAMvC,aAAa,IAAI,UAAU;IAIpB,OAAO;IAId;;;OAGG;IACI,OAAO;IAIP,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,OAAO;IAIP,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM;IAI/B;;;OAGG;IACI,oBAAoB;IAIpB,oBAAoB,CAAC,iBAAiB,EAAE,QAAQ;IAIhD,mBAAmB;IAInB,kBAAkB,IAAI,OAAO;IAI7B,iBAAiB,IAAI,OAAO;IAI5B,aAAa;IAIb,aAAa;IAIpB;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,IAAI,eAAe;IAI/B,eAAe,IAAI,eAAe,EAAE;IAIpC,YAAY,CAAC,eAAe,EAAE,eAAe,GAAG,eAAe,EAAE;IAQjE,eAAe;IAIf,eAAe,IAAI,WAAW,EAAE,GAAG,SAAS;IAI5C,gBAAgB,IAAI,OAAO;IAI3B,eAAe,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,IAAI;IAIlD,cAAc,IAAI,WAAW,GAAG,SAAS;IAIhD;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,OAAO,IAAI,OAAO,GAAG,SAAS;IAI9B,OAAO,CAAC,IAAI,EAAE,OAAO;IAI5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,MAAM,IAAI,GAAG,GAAG,SAAS;IAIzB,cAAc,IAAI,GAAG,GAAG,SAAS;IAIjC,qBAAqB,IAAI,KAAK,EAAE;IAqBhC,eAAe,IAAI,KAAK,GAAG,IAAI;IAiB/B,eAAe,IAAI,KAAK,EAAE;IAgB1B,aAAa,IAAI,IAAI,EAAE;IAIvB,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAI9B,WAAW,IAAI,QAAQ,GAAG,SAAS;IAInC,WAAW,IAAI,OAAO;IAItB,cAAc,CAAC,WAAW,EAAE,WAAW;IAOvC,SAAS;IAYT,WAAW,IAAI,OAAO;IAItB,kBAAkB,CAAC,eAAe,EAAE,OAAO;IAI3C,gBAAgB,IAAI,OAAO;IAI3B,gBAAgB,CAAC,aAAa,EAAE,OAAO;CAGjD"}
+{"version":3,"file":"ArkMethod.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkMethod.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAgC,IAAI,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAA2B,WAAW,EAAc,IAAI,EAAa,MAAM,cAAc,CAAC;AACjG,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAuB,OAAO,EAAmB,MAAM,kBAAkB,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAgB,MAAM,oBAAoB,CAAC;AAI5D,eAAO,MAAM,iBAAiB,UACqF,CAAC;AAEpH;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAa,YAAW,SAAS;IAC5D,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,iBAAiB,CAAY;IAErC,OAAO,CAAC,YAAY,CAAC,CAAgB;IAErC,OAAO,CAAC,uBAAuB,CAAC,CAAoB;IACpD,OAAO,CAAC,qBAAqB,CAAC,CAAY;IAE1C,OAAO,CAAC,eAAe,CAAC,CAAkB;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAU;IAE1B,OAAO,CAAC,IAAI,CAAC,CAAU;IACvB,OAAO,CAAC,QAAQ,CAAC,CAAW;IAE5B,OAAO,CAAC,WAAW,CAAC,CAAc;IAElC,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,aAAa,CAAkB;;IAMvC,aAAa,IAAI,UAAU;IAIpB,OAAO;IAId;;;OAGG;IACI,OAAO;IAIP,OAAO,CAAC,IAAI,EAAE,MAAM;IAI3B;;;OAGG;IACI,eAAe,IAAI,MAAM,EAAE,GAAG,IAAI;IAWzC;;;OAGG;IACI,iBAAiB,IAAI,MAAM,EAAE,GAAG,IAAI;IAW3C;;;;;;OAMG;IACI,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAavE;;;;OAIG;IACI,kBAAkB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI;IAIpD;;;OAGG;IACI,kBAAkB,IAAI,OAAO,EAAE,GAAG,IAAI;IAI7C;;;OAGG;IACI,OAAO,IAAI,MAAM,GAAG,IAAI;IAO/B;;;;;OAKG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOlC;;;OAGG;IACI,SAAS,IAAI,MAAM,GAAG,IAAI;IAOjC;;;;;OAKG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAOtC;;;OAGG;IACI,UAAU,IAAI,OAAO,GAAG,IAAI;IAInC;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAIzC;;;OAGG;IACI,oBAAoB;IAIpB,oBAAoB,CAAC,iBAAiB,EAAE,QAAQ;IAIhD,mBAAmB;IAInB,kBAAkB,IAAI,OAAO;IAI7B,iBAAiB,IAAI,OAAO;IAI5B,aAAa;IAIb,aAAa;IAIpB;;;;OAIG;IACI,oBAAoB,IAAI,eAAe,EAAE,GAAG,IAAI;IAIvD;;;;;OAKG;IACI,wBAAwB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM;IAazE;;;;OAIG;IACI,0BAA0B,IAAI,eAAe,GAAG,IAAI;IAI3D;;;;;;;;;;;;;;OAcG;IACI,YAAY,IAAI,eAAe;IAItC;;;;;OAKG;IACI,oBAAoB,CAAC,UAAU,EAAE,eAAe,GAAG,eAAe,EAAE,GAAG,IAAI;IAQlF;;;;;;OAMG;IACI,4BAA4B,CAAC,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAOpF;;;;;OAKG;IACI,0BAA0B,CAAC,SAAS,EAAE,eAAe,GAAG,IAAI;IAI5D,eAAe;IAIf,eAAe,IAAI,WAAW,EAAE,GAAG,SAAS;IAI5C,gBAAgB,IAAI,OAAO;IAI3B,eAAe,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,IAAI;IAIlD,cAAc,IAAI,WAAW,GAAG,SAAS;IAIhD;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,OAAO,IAAI,OAAO,GAAG,SAAS;IAI9B,OAAO,CAAC,IAAI,EAAE,OAAO;IAI5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,MAAM,IAAI,GAAG,GAAG,SAAS;IAIzB,cAAc,IAAI,GAAG,GAAG,SAAS;IAIjC,qBAAqB,IAAI,KAAK,EAAE;IAqBhC,eAAe,IAAI,KAAK,GAAG,IAAI;IAiB/B,eAAe,IAAI,KAAK,EAAE;IAgB1B,aAAa,IAAI,IAAI,EAAE;IAIvB,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAI9B,WAAW,IAAI,QAAQ,GAAG,SAAS;IAInC,WAAW,IAAI,OAAO;IAItB,cAAc,CAAC,WAAW,EAAE,WAAW;IAOvC,SAAS;IAYT,WAAW,IAAI,OAAO;IAItB,kBAAkB,CAAC,eAAe,EAAE,OAAO;IAI3C,gBAAgB,IAAI,OAAO;IAI3B,gBAAgB,CAAC,aAAa,EAAE,OAAO;IAIvC,QAAQ,IAAI,QAAQ;IAiCpB,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,eAAe;CAiD7D"}