arkanalyzer 1.0.6 → 1.0.8

package/lib/core/dataflow/UndefinedVariable.js

@@ -23,11 +23,13 @@ const Constant_1 = require("../base/Constant");
 const Ref_1 = require("../base/Ref");
 const DataflowSolver_1 = require("./DataflowSolver");
 const Expr_1 = require("../base/Expr");
-const DataflowSolver_2 = require("../dataflow/DataflowSolver");
+const Util_1 = require("./Util");
+const Const_1 = require("../common/Const");
 class UndefinedVariableChecker extends DataflowProblem_1.DataflowProblem {
     constructor(stmt, method) {
         super();
         this.zeroValue = new Constant_1.Constant('undefined', Type_1.UndefinedType.getInstance());
+        this.outcomes = [];
         this.entryPoint = stmt;
         this.entryMethod = method;
         this.scene = method.getDeclaringArkFile().getScene();
@@ -54,7 +56,7 @@ class UndefinedVariableChecker extends DataflowProblem_1.DataflowProblem {
         return new class {
             getDataFacts(dataFact) {
                 let ret = new Set();
-                if (checkerInstance.getEntryPoint() == srcStmt && checkerInstance.getZeroValue() == dataFact) {
+                if (checkerInstance.getEntryPoint() === srcStmt && checkerInstance.getZeroValue() === dataFact) {
                     let entryMethod = checkerInstance.getEntryMethod();
                     const parameters = [...entryMethod.getCfg().getBlocks()][0].getStmts().slice(0, entryMethod.getParameters().length);
                     for (let i = 0; i < parameters.length; i++) {
@@ -67,7 +69,7 @@ class UndefinedVariableChecker extends DataflowProblem_1.DataflowProblem {
                     const staticFields = entryMethod.getDeclaringArkClass().getStaticFields(checkerInstance.classMap);
                     for (const field of staticFields) {
                         const initializer = field.getInitializer();
-                        if (initializer.length == 1 && initializer[0] instanceof Stmt_1.ArkAssignStmt && initializer[0].getRightOp() == undefined) {
+                        if (initializer.length === 1 && initializer[0] instanceof Stmt_1.ArkAssignStmt && initializer[0].getRightOp() === undefined) {
                             ret.add(new Ref_1.ArkStaticFieldRef(field.getSignature()));
                         }
                     }
@@ -76,105 +78,128 @@ class UndefinedVariableChecker extends DataflowProblem_1.DataflowProblem {
                     }
                     return ret;
                 }
-                if (!(0, DataflowSolver_2.factEqual)(srcStmt.getDef(), dataFact)) {
-                    if (!(dataFact instanceof Local_1.Local && dataFact.getName() == srcStmt.getDef().toString()))
-                        ret.add(dataFact);
-                }
                 if (srcStmt instanceof Stmt_1.ArkAssignStmt) {
-                    let ass = srcStmt;
-                    let assigned = ass.getLeftOp();
-                    let rightOp = ass.getRightOp();
-                    if (checkerInstance.getZeroValue() == dataFact) {
-                        if (checkerInstance.isUndefined(rightOp)) {
-                            ret.add(assigned);
-                        }
-                    }
-                    else if ((0, DataflowSolver_2.factEqual)(rightOp, dataFact) || rightOp.getType() instanceof Type_1.UndefinedType) {
-                        ret.add(assigned);
-                    }
-                    else if (rightOp instanceof Ref_1.ArkInstanceFieldRef) {
-                        const base = rightOp.getBase();
-                        if (base == dataFact || !base.getDeclaringStmt() && base.getName() == dataFact.toString()) {
-                            console.log("undefined base");
-                            console.log(srcStmt.toString());
-                            console.log(srcStmt.getOriginPositionInfo().toString());
-                        }
-                    }
-                    else if (dataFact instanceof Ref_1.ArkInstanceFieldRef && rightOp == dataFact.getBase()) {
-                        const field = new Ref_1.ArkInstanceFieldRef(srcStmt.getLeftOp(), dataFact.getFieldSignature());
-                        ret.add(field);
-                    }
+                    checkerInstance.insideNormalFlowFunction(ret, srcStmt, dataFact);
                 }
                 return ret;
             }
         };
     }
+    insideNormalFlowFunction(ret, srcStmt, dataFact) {
+        if (!this.factEqual(srcStmt.getDef(), dataFact)) {
+            if (!(dataFact instanceof Local_1.Local && dataFact.getName() === srcStmt.getDef().toString())) {
+                ret.add(dataFact);
+            }
+        }
+        let ass = srcStmt;
+        let assigned = ass.getLeftOp();
+        let rightOp = ass.getRightOp();
+        if (this.getZeroValue() === dataFact) {
+            if (this.isUndefined(rightOp)) {
+                ret.add(assigned);
+            }
+        }
+        else if (this.factEqual(rightOp, dataFact) || rightOp.getType() instanceof Type_1.UndefinedType) {
+            ret.add(assigned);
+        }
+        else if (rightOp instanceof Ref_1.ArkInstanceFieldRef) {
+            const base = rightOp.getBase();
+            if (base === dataFact || !base.getDeclaringStmt() && base.getName() === dataFact.toString()) {
+                this.outcomes.push(new Outcome(rightOp, ass));
+                console.log('undefined base');
+                console.log(srcStmt.toString());
+                console.log(srcStmt.getOriginPositionInfo().toString());
+            }
+        }
+        else if (dataFact instanceof Ref_1.ArkInstanceFieldRef && rightOp === dataFact.getBase()) {
+            const field = new Ref_1.ArkInstanceFieldRef(srcStmt.getLeftOp(), dataFact.getFieldSignature());
+            ret.add(field);
+        }
+    }
     getCallFlowFunction(srcStmt, method) {
         let checkerInstance = this;
         return new class {
             getDataFacts(dataFact) {
                 const ret = new Set();
-                if (checkerInstance.getZeroValue() == dataFact) {
-                    ret.add(checkerInstance.getZeroValue());
-                    // 加上调用函数能访问到的所有静态变量，如果不考虑多线程，加上所有变量，考虑则要统计之前已经处理过的变量并排除
-                    for (const field of method.getDeclaringArkClass().getStaticFields(checkerInstance.classMap)) {
-                        if (field.getInitializer() == undefined) {
-                            ret.add(new Ref_1.ArkStaticFieldRef(field.getSignature()));
-                        }
-                    }
-                    for (const local of method.getDeclaringArkClass().getGlobalVariable(checkerInstance.globalVariableMap)) {
-                        ret.add(local);
-                    }
+                if (checkerInstance.getZeroValue() === dataFact) {
+                    checkerInstance.insideCallFlowFunction(ret, method);
                 }
                 else {
                     const callExpr = srcStmt.getExprs()[0];
-                    if (callExpr instanceof Expr_1.ArkInstanceInvokeExpr && dataFact instanceof Ref_1.ArkInstanceFieldRef && callExpr.getBase().getName() == dataFact.getBase().getName()) {
+                    if (callExpr instanceof Expr_1.ArkInstanceInvokeExpr && dataFact instanceof Ref_1.ArkInstanceFieldRef && callExpr.getBase().getName() === dataFact.getBase().getName()) {
                         // todo:base转this
-                        const baseType = callExpr.getBase().getType();
-                        const arkClass = checkerInstance.scene.getClass(baseType.getClassSignature());
-                        const constructor = arkClass === null || arkClass === void 0 ? void 0 : arkClass.getMethodWithName("constructor");
-                        const block = [...constructor.getCfg().getBlocks()][0];
-                        for (const stmt of block.getStmts()) {
-                            const def = stmt.getDef();
-                            if (def && def instanceof Ref_1.ArkInstanceFieldRef && def.getBase().getName() == "this" && def.getFieldName() == dataFact.getFieldName()) {
-                                ret.add(def);
-                                break;
-                            }
-                        }
+                        const thisRef = new Ref_1.ArkInstanceFieldRef(new Local_1.Local('this', new Type_1.ClassType(method.getDeclaringArkClass().getSignature())), dataFact.getFieldSignature());
+                        ret.add(thisRef);
                     }
-                    else if (callExpr instanceof Expr_1.ArkStaticInvokeExpr && dataFact instanceof Ref_1.ArkStaticFieldRef && callExpr.getMethodSignature().getDeclaringClassSignature() == dataFact.getFieldSignature().getDeclaringSignature()) {
+                    else if (callExpr instanceof Expr_1.ArkStaticInvokeExpr && dataFact instanceof Ref_1.ArkStaticFieldRef && callExpr.getMethodSignature().getDeclaringClassSignature() === dataFact.getFieldSignature().getDeclaringSignature()) {
                         ret.add(dataFact);
                     }
                 }
-                const callStmt = srcStmt;
-                const args = callStmt.getInvokeExpr().getArgs();
-                for (let i = 0; i < args.length; i++) {
-                    if (args[i] == dataFact || checkerInstance.isUndefined(args[i]) && checkerInstance.getZeroValue() == dataFact) {
-                        const realParameter = [...method.getCfg().getBlocks()][0].getStmts()[i].getDef();
-                        if (realParameter)
-                            ret.add(realParameter);
-                    }
-                    else if (dataFact instanceof Ref_1.ArkInstanceFieldRef && dataFact.getBase().getName() == args[i].toString()) {
-                        const realParameter = [...method.getCfg().getBlocks()][0].getStmts()[i].getDef();
-                        if (realParameter) {
-                            const retRef = new Ref_1.ArkInstanceFieldRef(realParameter, dataFact.getFieldSignature());
-                            ret.add(retRef);
-                        }
-                    }
-                }
+                checkerInstance.addParameters(srcStmt, dataFact, method, ret);
                 return ret;
             }
         };
     }
+    insideCallFlowFunction(ret, method) {
+        ret.add(this.getZeroValue());
+        // 加上调用函数能访问到的所有静态变量，如果不考虑多线程，加上所有变量，考虑则要统计之前已经处理过的变量并排除
+        for (const field of method.getDeclaringArkClass().getStaticFields(this.classMap)) {
+            if (field.getInitializer() === undefined) {
+                ret.add(new Ref_1.ArkStaticFieldRef(field.getSignature()));
+            }
+        }
+        for (const local of method.getDeclaringArkClass().getGlobalVariable(this.globalVariableMap)) {
+            ret.add(local);
+        }
+        // 加上所有未定义初始值的属性
+        if (method.getName() === Const_1.INSTANCE_INIT_METHOD_NAME || method.getName() === Const_1.STATIC_INIT_METHOD_NAME) {
+            for (const field of method.getDeclaringArkClass().getFields()) {
+                this.addUndefinedField(field, method, ret);
+            }
+        }
+    }
+    addUndefinedField(field, method, ret) {
+        let defined = false;
+        for (const stmt of method.getCfg().getStmts()) {
+            const def = stmt.getDef();
+            if (def instanceof Ref_1.ArkInstanceFieldRef && def.getFieldSignature() === field.getSignature()) {
+                defined = true;
+                break;
+            }
+        }
+        if (!defined) {
+            const fieldRef = new Ref_1.ArkInstanceFieldRef(new Local_1.Local('this', new Type_1.ClassType(method.getDeclaringArkClass().getSignature())), field.getSignature());
+            ret.add(fieldRef);
+        }
+    }
+    addParameters(srcStmt, dataFact, method, ret) {
+        const callStmt = srcStmt;
+        const args = callStmt.getInvokeExpr().getArgs();
+        for (let i = 0; i < args.length; i++) {
+            if (args[i] === dataFact || this.isUndefined(args[i]) && this.getZeroValue() === dataFact) {
+                const realParameter = [...method.getCfg().getBlocks()][0].getStmts()[i].getDef();
+                if (realParameter) {
+                    ret.add(realParameter);
+                }
+            }
+            else if (dataFact instanceof Ref_1.ArkInstanceFieldRef && dataFact.getBase().getName() === args[i].toString()) {
+                const realParameter = [...method.getCfg().getBlocks()][0].getStmts()[i].getDef();
+                if (realParameter) {
+                    const retRef = new Ref_1.ArkInstanceFieldRef(realParameter, dataFact.getFieldSignature());
+                    ret.add(retRef);
+                }
+            }
+        }
+    }
     getExitToReturnFlowFunction(srcStmt, tgtStmt, callStmt) {
         let checkerInstance = this;
         return new class {
             getDataFacts(dataFact) {
                 let ret = new Set();
-                if (dataFact == checkerInstance.getZeroValue()) {
+                if (dataFact === checkerInstance.getZeroValue()) {
                     ret.add(checkerInstance.getZeroValue());
                 }
-                if (dataFact instanceof Ref_1.ArkInstanceFieldRef && dataFact.getBase().getName() == "this") {
+                if (dataFact instanceof Ref_1.ArkInstanceFieldRef && dataFact.getBase().getName() === "this") {
                     // todo:this转base。
                     const expr = callStmt.getExprs()[0];
                     if (expr instanceof Expr_1.ArkInstanceInvokeExpr) {
@@ -189,13 +214,13 @@ class UndefinedVariableChecker extends DataflowProblem_1.DataflowProblem {
                     let ass = callStmt;
                     let leftOp = ass.getLeftOp();
                     let retVal = srcStmt.getOp();
-                    if (dataFact == checkerInstance.getZeroValue()) {
+                    if (dataFact === checkerInstance.getZeroValue()) {
                         ret.add(checkerInstance.getZeroValue());
                         if (checkerInstance.isUndefined(retVal)) {
                             ret.add(leftOp);
                         }
                     }
-                    else if (retVal == dataFact) {
+                    else if (retVal === dataFact) {
                         ret.add(leftOp);
                     }
                 }
@@ -208,11 +233,11 @@ class UndefinedVariableChecker extends DataflowProblem_1.DataflowProblem {
         return new class {
             getDataFacts(dataFact) {
                 const ret = new Set();
-                if (checkerInstance.getZeroValue() == dataFact) {
+                if (checkerInstance.getZeroValue() === dataFact) {
                     ret.add(checkerInstance.getZeroValue());
                 }
                 const defValue = srcStmt.getDef();
-                if (!(defValue && defValue == dataFact)) {
+                if (!(defValue && defValue === dataFact)) {
                     ret.add(dataFact);
                 }
                 return ret;
@@ -225,6 +250,21 @@ class UndefinedVariableChecker extends DataflowProblem_1.DataflowProblem {
     getZeroValue() {
         return this.zeroValue;
     }
+    factEqual(d1, d2) {
+        if (d1 instanceof Constant_1.Constant && d2 instanceof Constant_1.Constant) {
+            return d1 === d2;
+        }
+        else if (d1 instanceof Local_1.Local && d2 instanceof Local_1.Local) {
+            return (0, Util_1.LocalEqual)(d1, d2);
+        }
+        else if (d1 instanceof Ref_1.AbstractRef && d2 instanceof Ref_1.AbstractRef) {
+            return (0, Util_1.RefEqual)(d1, d2);
+        }
+        return false;
+    }
+    getOutcomes() {
+        return this.outcomes;
+    }
 }
 exports.UndefinedVariableChecker = UndefinedVariableChecker;
 class UndefinedVariableSolver extends DataflowSolver_1.DataflowSolver {
@@ -233,3 +273,9 @@ class UndefinedVariableSolver extends DataflowSolver_1.DataflowSolver {
     }
 }
 exports.UndefinedVariableSolver = UndefinedVariableSolver;
+class Outcome {
+    constructor(v, s) {
+        this.value = v;
+        this.stmt = s;
+    }
+}

package/lib/core/dataflow/Util.d.ts

@@ -1,8 +1,12 @@
 import { ArkInvokeStmt } from "../base/Stmt";
 import { ArkMethod } from "../model/ArkMethod";
 import { Scene } from "../../Scene";
+import { Local } from "../base/Local";
+import { AbstractRef } from "../base/Ref";
 export declare const INTERNAL_PARAMETER_SOURCE: string[];
 export declare const INTERNAL_SINK_METHOD: string[];
-export declare function Json2ArkMethod(str: string, scene: Scene): ArkMethod | null;
+export declare function Json2ArkMethod(sdkName: string, str: string, scene: Scene): ArkMethod | null;
 export declare function getRecallMethodInParam(stmt: ArkInvokeStmt): ArkMethod | null;
+export declare function LocalEqual(local1: Local, local2: Local): boolean;
+export declare function RefEqual(ref1: AbstractRef, ref2: AbstractRef): boolean;
 //# sourceMappingURL=Util.d.ts.map

package/lib/core/dataflow/Util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Util.d.ts","sourceRoot":"","sources":["../../../src/core/dataflow/Util.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGpC,eAAO,MAAM,yBAAyB,EAAE,MAAM,EAE7C,CAAA;AAED,eAAO,MAAM,oBAAoB,EAAE,MAAM,EAMxC,CAAA;AAID,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,IAAI,CAsF1E;AAGD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,aAAa,GAAG,SAAS,GAAG,IAAI,CAW5E"}
+{"version":3,"file":"Util.d.ts","sourceRoot":"","sources":["../../../src/core/dataflow/Util.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,WAAW,EAA0C,MAAM,aAAa,CAAC;AAGlF,eAAO,MAAM,yBAAyB,EAAE,MAAM,EAE7C,CAAA;AAED,eAAO,MAAM,oBAAoB,EAAE,MAAM,EAMxC,CAAA;AAID,wBAAgB,cAAc,CAAC,OAAO,EAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,IAAI,CAoF1F;AAGD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,aAAa,GAAG,SAAS,GAAG,IAAI,CAW5E;AAGD,wBAAgB,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,OAAO,CAQhE;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAOtE"}

package/lib/core/dataflow/Util.js

@@ -14,27 +14,31 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRecallMethodInParam = exports.Json2ArkMethod = exports.INTERNAL_SINK_METHOD = exports.INTERNAL_PARAMETER_SOURCE = void 0;
+exports.RefEqual = exports.LocalEqual = exports.getRecallMethodInParam = exports.Json2ArkMethod = exports.INTERNAL_SINK_METHOD = exports.INTERNAL_PARAMETER_SOURCE = void 0;
 const Type_1 = require("../base/Type");
+const ArkSignature_1 = require("../model/ArkSignature");
+const Ref_1 = require("../base/Ref");
 exports.INTERNAL_PARAMETER_SOURCE = [
     '@ohos.app.ability.Want.d.ts: Want'
 ];
 exports.INTERNAL_SINK_METHOD = [
-    'console.<@_UnknownProjectName/_UnknownFileName: .log()>',
-    'console.<@_UnknownProjectName/_UnknownFileName: .error()>',
-    'console.<@_UnknownProjectName/_UnknownFileName: .info()>',
-    'console.<@_UnknownProjectName/_UnknownFileName: .warn()>',
-    'console.<@_UnknownProjectName/_UnknownFileName: .assert()>'
+    'console.<@%unk/%unk: .log()>',
+    'console.<@%unk/%unk: .error()>',
+    'console.<@%unk/%unk: .info()>',
+    'console.<@%unk/%unk: .warn()>',
+    'console.<@%unk/%unk: .assert()>'
 ];
 const filenamePrefix = '@etsSdk/api/';
-function Json2ArkMethod(str, scene) {
+function Json2ArkMethod(sdkName, str, scene) {
     const mes = str.split(': ');
     const fileName = filenamePrefix + mes[0] + ': ';
     const otherMes = mes.slice(1).join(': ').split('.');
     if (otherMes.length < 3) {
         return null;
     }
-    const namespaceName = otherMes[0], className = otherMes[1], methodName = otherMes[2].split('(')[0];
+    const namespaceName = otherMes[0];
+    const className = otherMes[1];
+    const methodName = otherMes[2].split('(')[0];
     let paramNames = [];
     if (otherMes[2]) {
         if (!otherMes[2].match(/\((.*?)\)/)) {
@@ -42,19 +46,18 @@ function Json2ArkMethod(str, scene) {
         }
         paramNames = otherMes[2].match(/\((.*?)\)/)[1].split(',').map((item) => item.replace(/\s/g, '')).filter((item) => item !== '');
     }
-    const file = scene.getSdkArkFilesMap().get(fileName);
+    const file = scene.getFile(new ArkSignature_1.FileSignature(sdkName, fileName));
     if (!file) {
-        // console.log("no file: " + fileName);
         return null;
     }
     let arkClass = null;
-    if (namespaceName == "_") {
-        if (className == '_') {
+    if (namespaceName === "_") {
+        if (className === '_') {
             arkClass = file.getDefaultClass();
         }
         else {
             for (const clas of file.getClasses()) {
-                if (clas.getName() == className) {
+                if (clas.getName() === className) {
                     arkClass = clas;
                     break;
                 }
@@ -64,18 +67,18 @@ function Json2ArkMethod(str, scene) {
     else {
         let arkNamespace = null;
         for (const ns of file.getNamespaces()) {
-            if (ns.getName() == namespaceName) {
+            if (ns.getName() === namespaceName) {
                 arkNamespace = ns;
                 break;
             }
         }
         if (arkNamespace) {
-            if (className == '_') {
+            if (className === '_') {
                 arkClass = arkNamespace.getDefaultClass();
             }
             else {
                 for (const clas of arkNamespace.getClasses()) {
-                    if (clas.getName() == className) {
+                    if (clas.getName() === className) {
                         arkClass = clas;
                         break;
                     }
@@ -83,27 +86,25 @@ function Json2ArkMethod(str, scene) {
             }
         }
         else {
-            // console.log("no namespace: " + namespaceName);
             return null;
         }
     }
     if (!arkClass) {
-        // console.log("no class: " + className);
         return null;
     }
     else {
         let arkMethod = null;
         for (const method of arkClass.getMethods()) {
-            if (method.getName() == methodName) {
+            if (method.getName() === methodName) {
                 arkMethod = method;
                 break;
             }
         }
-        if (arkMethod && arkMethod.getParameters().length == paramNames.length) {
+        if (arkMethod && arkMethod.getParameters().length === paramNames.length) {
             let paramEqual = true;
             for (let i = 0; i < arkMethod.getParameters().length; i++) {
                 const param = arkMethod.getParameters()[i];
-                if (param.getName() + ':' + param.getType().toString() != paramNames[i]) {
+                if (param.getName() + ':' + param.getType().toString() !== paramNames[i]) {
                     paramEqual = false;
                     break;
                 }
@@ -113,7 +114,6 @@ function Json2ArkMethod(str, scene) {
             }
         }
         else {
-            // console.log("no method: " + methodName);
             return null;
         }
     }
@@ -135,3 +135,24 @@ function getRecallMethodInParam(stmt) {
     return null;
 }
 exports.getRecallMethodInParam = getRecallMethodInParam;
+function LocalEqual(local1, local2) {
+    var _a, _b, _c, _d;
+    if (local1.getName() === 'this' && local2.getName() === 'this') {
+        return true;
+    }
+    const method1 = (_b = (_a = local1.getDeclaringStmt()) === null || _a === void 0 ? void 0 : _a.getCfg()) === null || _b === void 0 ? void 0 : _b.getDeclaringMethod();
+    const method2 = (_d = (_c = local2.getDeclaringStmt()) === null || _c === void 0 ? void 0 : _c.getCfg()) === null || _d === void 0 ? void 0 : _d.getDeclaringMethod();
+    const nameEqual = local1.getName() === local2.getName();
+    return method1 === method2 && nameEqual;
+}
+exports.LocalEqual = LocalEqual;
+function RefEqual(ref1, ref2) {
+    if (ref1 instanceof Ref_1.ArkStaticFieldRef && ref2 instanceof Ref_1.ArkStaticFieldRef) {
+        return ref1.getFieldSignature().toString() === ref2.getFieldSignature().toString();
+    }
+    else if (ref1 instanceof Ref_1.ArkInstanceFieldRef && ref2 instanceof Ref_1.ArkInstanceFieldRef) {
+        return LocalEqual(ref1.getBase(), ref2.getBase()) && ref1.getFieldSignature().toString() === ref2.getFieldSignature().toString();
+    }
+    return false;
+}
+exports.RefEqual = RefEqual;

package/lib/core/graph/BasicBlock.d.ts

@@ -1,6 +1,12 @@
 import { Stmt } from '../base/Stmt';
+import { ArkError } from '../common/ArkError';
 /**
  * @category core/graph
+ * A `BasicBlock` is composed of:
+ * - ID: a **number** that uniquely identify the basic block, initialized as -1.
+ * - Statements: an **array** of statements in the basic block.
+ * - Predecessors:  an **array** of basic blocks in front of the current basic block. More accurately, these basic blocks can reach the current block through edges.
+ * - Successors: an **array** of basic blocks after the current basic block. More accurately, the current block can reach these basic blocks through edges.
  */
 export declare class BasicBlock {
     private id;
@@ -10,11 +16,75 @@ export declare class BasicBlock {
     constructor();
     getId(): number;
     setId(id: number): void;
+    /**
+     * Returns an array of the statements in a basic block.
+     * @returns An array of statements in a basic block.
+     */
     getStmts(): Stmt[];
     addStmt(stmt: Stmt): void;
+    /**
+     * Adds the given stmt at the beginning of the basic block.
+     * @param stmt
+     */
+    addHead(stmt: Stmt | Stmt[]): void;
+    /**
+     * Adds the given stmt at the end of the basic block.
+     * @param stmt
+     */
+    addTail(stmt: Stmt | Stmt[]): void;
+    /**
+     * Inserts toInsert in the basic block after point.
+     * @param toInsert
+     * @param point
+     * @returns The number of successfully inserted statements
+     */
+    insertAfter(toInsert: Stmt | Stmt[], point: Stmt): number;
+    /**
+     * Inserts toInsert in the basic block befor point.
+     * @param toInsert
+     * @param point
+     * @returns The number of successfully inserted statements
+     */
+    insertBefore(toInsert: Stmt | Stmt[], point: Stmt): number;
+    /**
+     * Removes the given stmt from this basic block.
+     * @param stmt
+     * @returns
+     */
+    remove(stmt: Stmt): void;
+    /**
+     * Removes the first stmt from this basic block.
+     */
+    removeHead(): void;
+    /**
+     * Removes the last stmt from this basic block.
+     */
+    removeTail(): void;
     getHead(): Stmt | null;
     getTail(): Stmt | null;
+    /**
+     * Returns successors of the current basic block, whose types are also basic blocks (i.e.{@link BasicBlock}).
+     * @returns Successors of the current basic block.
+     * @example
+     * 1. get block successors.
+
+    ```typescript
+    const body = arkMethod.getBody();
+    const blocks = [...body.getCfg().getBlocks()]
+    for (let i = 0; i < blocks.length; i++) {
+    const block = blocks[i]
+        ...
+        for (const next of block.getSuccessors()) {
+        ...
+        }
+    }
+    ```
+     */
     getSuccessors(): BasicBlock[];
+    /**
+     * Returns predecessors of the current basic block, whose types are also basic blocks.
+     * @returns An array of basic blocks.
+     */
     getPredecessors(): BasicBlock[];
     addPredecessorBlock(block: BasicBlock): void;
     setPredecessorBlock(idx: number, block: BasicBlock): boolean;
@@ -22,5 +92,7 @@ export declare class BasicBlock {
     addStmtToFirst(stmt: Stmt): void;
     addSuccessorBlock(block: BasicBlock): void;
     toString(): string;
+    validate(): ArkError;
+    private insertPos;
 }
 //# sourceMappingURL=BasicBlock.d.ts.map

package/lib/core/graph/BasicBlock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BasicBlock.d.ts","sourceRoot":"","sources":["../../../src/core/graph/BasicBlock.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC;;GAEG;AACH,qBAAa,UAAU;IACnB,OAAO,CAAC,EAAE,CAAc;IACxB,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,eAAe,CAAoB;;IAKpC,KAAK,IAAI,MAAM;IAIf,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAIvB,QAAQ,IAAI,IAAI,EAAE;IAIlB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAIzB,OAAO,IAAI,IAAI,GAAG,IAAI;IAOtB,OAAO,IAAI,IAAI,GAAG,IAAI;IAQtB,aAAa,IAAI,UAAU,EAAE;IAI7B,eAAe,IAAI,UAAU,EAAE;IAI/B,mBAAmB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAI5C,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO;IAQ5D,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO;IAS1D,cAAc,CAAC,IAAI,EAAE,IAAI;IAKzB,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAI1C,QAAQ,IAAI,MAAM;CAO5B"}
+{"version":3,"file":"BasicBlock.d.ts","sourceRoot":"","sources":["../../../src/core/graph/BasicBlock.ts"],"names":[],"mappings":"AAeA,OAAO,EAA8D,IAAI,EAAE,MAAM,cAAc,CAAC;AAChG,OAAO,EAAE,QAAQ,EAAgB,MAAM,oBAAoB,CAAC;AAI5D;;;;;;;GAOG;AACH,qBAAa,UAAU;IACnB,OAAO,CAAC,EAAE,CAAc;IACxB,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,eAAe,CAAoB;;IAIpC,KAAK,IAAI,MAAM;IAIf,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAI9B;;;OAGG;IACI,QAAQ,IAAI,IAAI,EAAE;IAIlB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAIhC;;;OAGG;IACI,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,IAAI;IAQzC;;;OAGG;IACI,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,IAAI;IAQzC;;;;;OAKG;IACI,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM;IAQhE;;;;;OAKG;IACI,YAAY,CAAC,QAAQ,EAAE,IAAI,GAAG,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM;IAQjE;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAQ/B;;OAEG;IACI,UAAU,IAAI,IAAI;IAIzB;;OAEG;IACI,UAAU,IAAI,IAAI;IAIlB,OAAO,IAAI,IAAI,GAAG,IAAI;IAOtB,OAAO,IAAI,IAAI,GAAG,IAAI;IAQ7B;;;;;;;;;;;;;;;;;OAiBG;IACI,aAAa,IAAI,UAAU,EAAE;IAIpC;;;OAGG;IACI,eAAe,IAAI,UAAU,EAAE;IAI/B,mBAAmB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAI5C,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO;IAQ5D,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO;IAS1D,cAAc,CAAC,IAAI,EAAE,IAAI;IAKzB,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAI1C,QAAQ,IAAI,MAAM;IAQlB,QAAQ,IAAI,QAAQ;IA4B3B,OAAO,CAAC,SAAS;CAQpB"}