arkanalyzer 1.0.20 → 1.0.21

package/lib/core/base/Position.js

@@ -1,147 +1,147 @@
-"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.FullPosition = exports.LineColPosition = exports.getColNo = exports.getLineNo = exports.setLineCol = exports.setCol = exports.setLine = void 0;
-const ohos_typescript_1 = __importDefault(require("ohos-typescript"));
-const logger_1 = __importStar(require("../../utils/logger"));
-const logger = logger_1.default.getLogger(logger_1.LOG_MODULE_TYPE.ARKANALYZER, 'Position');
-const LOW_BITS_SIZE = 16;
-const LOW_BITS_MASK = 0xffff;
-const HIGH_BITS_MASK = 0xffff0000;
-const MIN_NUMBER = 0;
-const MAX_NUMBER = 0xffff;
-const INVALID_LINE = -1;
-function setLine(lineCol, lineNo) {
-    if (lineNo < MIN_NUMBER) {
-        lineNo = MIN_NUMBER;
-    }
-    if (lineNo > MAX_NUMBER) {
-        logger.warn(`setLine overflow ${lineNo}`);
-        lineNo = MAX_NUMBER;
-    }
-    return (lineNo << LOW_BITS_SIZE) | (lineCol & LOW_BITS_MASK);
-}
-exports.setLine = setLine;
-function setCol(lineCol, colNo) {
-    if (colNo < MIN_NUMBER) {
-        colNo = MIN_NUMBER;
-    }
-    if (colNo > MAX_NUMBER) {
-        logger.warn(`setCol overflow ${colNo}`);
-        colNo = MAX_NUMBER;
-    }
-    return (lineCol & HIGH_BITS_MASK) | colNo;
-}
-exports.setCol = setCol;
-function setLineCol(lineNo, colNo) {
-    let lineCol = 0;
-    lineCol = setLine(lineCol, lineNo);
-    lineCol = setCol(lineCol, colNo);
-    return lineCol;
-}
-exports.setLineCol = setLineCol;
-function getLineNo(lineCol) {
-    let line = lineCol >>> LOW_BITS_SIZE;
-    if (line === MIN_NUMBER) {
-        return INVALID_LINE;
-    }
-    return line;
-}
-exports.getLineNo = getLineNo;
-function getColNo(lineCol) {
-    let col = lineCol & LOW_BITS_MASK;
-    if (col === MIN_NUMBER) {
-        return INVALID_LINE;
-    }
-    return col;
-}
-exports.getColNo = getColNo;
-/**
- * @category core/base
- */
-class LineColPosition {
-    constructor(lineNo, colNo) {
-        this.lineCol = setLineCol(lineNo, colNo);
-    }
-    getLineNo() {
-        return getLineNo(this.lineCol);
-    }
-    getColNo() {
-        return getColNo(this.lineCol);
-    }
-    static buildFromNode(node, sourceFile) {
-        let { line, character } = ohos_typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.getStart(sourceFile));
-        // line start from 1.
-        return new LineColPosition(line + 1, character + 1);
-    }
-}
-exports.LineColPosition = LineColPosition;
-LineColPosition.DEFAULT = new LineColPosition(INVALID_LINE, INVALID_LINE);
-class FullPosition {
-    constructor(firstLine, firstCol, lastLine, lastCol) {
-        this.first = setLineCol(firstLine, firstCol);
-        this.last = setLineCol(lastLine, lastCol);
-    }
-    getFirstLine() {
-        return getLineNo(this.first);
-    }
-    getLastLine() {
-        return getLineNo(this.last);
-    }
-    getFirstCol() {
-        return getColNo(this.first);
-    }
-    getLastCol() {
-        return getColNo(this.last);
-    }
-    static buildFromNode(node, sourceFile) {
-        const { line: startLine, character: startCharacter } = ohos_typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.getStart(sourceFile));
-        const { line: endLine, character: endCharacter } = ohos_typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.getEnd());
-        // line start from 1
-        return new FullPosition(startLine + 1, startCharacter + 1, endLine + 1, endCharacter + 1);
-    }
-    static merge(leftMostPosition, rightMostPosition) {
-        return new FullPosition(leftMostPosition.getFirstLine(), leftMostPosition.getFirstCol(), rightMostPosition.getLastLine(), rightMostPosition.getLastCol());
-    }
-}
-exports.FullPosition = FullPosition;
-FullPosition.DEFAULT = new FullPosition(INVALID_LINE, INVALID_LINE, INVALID_LINE, INVALID_LINE);
+"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.FullPosition = exports.LineColPosition = exports.getColNo = exports.getLineNo = exports.setLineCol = exports.setCol = exports.setLine = void 0;
+const ohos_typescript_1 = __importDefault(require("ohos-typescript"));
+const logger_1 = __importStar(require("../../utils/logger"));
+const logger = logger_1.default.getLogger(logger_1.LOG_MODULE_TYPE.ARKANALYZER, 'Position');
+const LOW_BITS_SIZE = 16;
+const LOW_BITS_MASK = 0xffff;
+const HIGH_BITS_MASK = 0xffff0000;
+const MIN_NUMBER = 0;
+const MAX_NUMBER = 0xffff;
+const INVALID_LINE = -1;
+function setLine(lineCol, lineNo) {
+    if (lineNo < MIN_NUMBER) {
+        lineNo = MIN_NUMBER;
+    }
+    if (lineNo > MAX_NUMBER) {
+        logger.warn(`setLine overflow ${lineNo}`);
+        lineNo = MAX_NUMBER;
+    }
+    return (lineNo << LOW_BITS_SIZE) | (lineCol & LOW_BITS_MASK);
+}
+exports.setLine = setLine;
+function setCol(lineCol, colNo) {
+    if (colNo < MIN_NUMBER) {
+        colNo = MIN_NUMBER;
+    }
+    if (colNo > MAX_NUMBER) {
+        logger.warn(`setCol overflow ${colNo}`);
+        colNo = MAX_NUMBER;
+    }
+    return (lineCol & HIGH_BITS_MASK) | colNo;
+}
+exports.setCol = setCol;
+function setLineCol(lineNo, colNo) {
+    let lineCol = 0;
+    lineCol = setLine(lineCol, lineNo);
+    lineCol = setCol(lineCol, colNo);
+    return lineCol;
+}
+exports.setLineCol = setLineCol;
+function getLineNo(lineCol) {
+    let line = lineCol >>> LOW_BITS_SIZE;
+    if (line === MIN_NUMBER) {
+        return INVALID_LINE;
+    }
+    return line;
+}
+exports.getLineNo = getLineNo;
+function getColNo(lineCol) {
+    let col = lineCol & LOW_BITS_MASK;
+    if (col === MIN_NUMBER) {
+        return INVALID_LINE;
+    }
+    return col;
+}
+exports.getColNo = getColNo;
+/**
+ * @category core/base
+ */
+class LineColPosition {
+    constructor(lineNo, colNo) {
+        this.lineCol = setLineCol(lineNo, colNo);
+    }
+    getLineNo() {
+        return getLineNo(this.lineCol);
+    }
+    getColNo() {
+        return getColNo(this.lineCol);
+    }
+    static buildFromNode(node, sourceFile) {
+        let { line, character } = ohos_typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.getStart(sourceFile));
+        // line start from 1.
+        return new LineColPosition(line + 1, character + 1);
+    }
+}
+exports.LineColPosition = LineColPosition;
+LineColPosition.DEFAULT = new LineColPosition(INVALID_LINE, INVALID_LINE);
+class FullPosition {
+    constructor(firstLine, firstCol, lastLine, lastCol) {
+        this.first = setLineCol(firstLine, firstCol);
+        this.last = setLineCol(lastLine, lastCol);
+    }
+    getFirstLine() {
+        return getLineNo(this.first);
+    }
+    getLastLine() {
+        return getLineNo(this.last);
+    }
+    getFirstCol() {
+        return getColNo(this.first);
+    }
+    getLastCol() {
+        return getColNo(this.last);
+    }
+    static buildFromNode(node, sourceFile) {
+        const { line: startLine, character: startCharacter } = ohos_typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.getStart(sourceFile));
+        const { line: endLine, character: endCharacter } = ohos_typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.getEnd());
+        // line start from 1
+        return new FullPosition(startLine + 1, startCharacter + 1, endLine + 1, endCharacter + 1);
+    }
+    static merge(leftMostPosition, rightMostPosition) {
+        return new FullPosition(leftMostPosition.getFirstLine(), leftMostPosition.getFirstCol(), rightMostPosition.getLastLine(), rightMostPosition.getLastCol());
+    }
+}
+exports.FullPosition = FullPosition;
+FullPosition.DEFAULT = new FullPosition(INVALID_LINE, INVALID_LINE, INVALID_LINE, INVALID_LINE);

package/lib/core/base/Ref.d.ts

@@ -1,174 +1,174 @@
-import { FieldSignature } from '../model/ArkSignature';
-import { Local } from './Local';
-import { ClassType, Type } from './Type';
-import { Value } from './Value';
-import { ArkMethod } from '../model/ArkMethod';
-import { Stmt } from './Stmt';
-/**
- * @category core/base/ref
- */
-export declare abstract class AbstractRef implements Value {
-    abstract getUses(): Value[];
-    abstract getType(): Type;
-    inferType(arkMethod: ArkMethod): AbstractRef;
-}
-export declare class ArkArrayRef extends AbstractRef {
-    private base;
-    private index;
-    constructor(base: Local, index: Value);
-    /**
-     * Returns the base of this array reference. Array reference refers to access to array elements.
-     * Array references usually consist of an local variable and an index.
-     * For example, `a[i]` is a typical array reference, where `a` is the base (i.e., local variable)
-     * pointing to the actual memory location where the array is stored
-     * and `i` is the index indicating access to the `i-th` element from array `a`.
-     * @returns the base of this array reference.
-     * @example
-     * 1. Get the base and the specific elements.
-
-     ```typescript
-     // Create an array
-     let myArray: number[] = [10, 20, 30, 40];
-     // Create an ArrayRef object representing a reference to myArray[2]
-     let arrayRef = new ArkArrayRef(myArray, 2);
-     // Use the getBase() method to get the base of the array
-     let baseArray = arrayRef.getBase();
-
-     console.log("Base array:", baseArray);  // Output: Base array: [10, 20, 30, 40]
-
-     // Use baseArray and obeject index of ArrayRef to access to specific array elements
-     let element = baseArray[arrayRef.index];
-     console.log("Element at index", arrayRef.index, ":", element);  // Output: Element at index 2 : 30
-     ```
-     */
-    getBase(): Local;
-    setBase(newBase: Local): void;
-    /**
-     * Returns the index of this array reference.
-     * In TypeScript, an array reference means that the variable stores
-     * the memory address of the array rather than the actual data of the array.
-     * @returns The index of this array reference.
-     */
-    getIndex(): Value;
-    setIndex(newIndex: Value): void;
-    getType(): Type;
-    getUses(): Value[];
-    toString(): string;
-}
-export declare abstract class AbstractFieldRef extends AbstractRef {
-    private fieldSignature;
-    constructor(fieldSignature: FieldSignature);
-    /**
-     * Returns the the field name as a **string**.
-     * @returns The the field name.
-     */
-    getFieldName(): string;
-    /**
-     * Returns a field signature, which consists of a class signature,
-     * a **string** field name, and a **boolean** label indicating whether it is static or not.
-     * @returns The field signature.
-     * @example
-     * 1. Compare two Fields
-
-     ```typescript
-     const fieldSignature = new FieldSignature();
-     fieldSignature.setFieldName(...);
-     const fieldRef = new ArkInstanceFieldRef(baseValue as Local, fieldSignature);
-     ...
-     if (fieldRef.getFieldSignature().getFieldName() ===
-     targetField.getFieldSignature().getFieldName()) {
-     ...
-     }
-     ```
-     */
-    getFieldSignature(): FieldSignature;
-    setFieldSignature(newFieldSignature: FieldSignature): void;
-    getType(): Type;
-}
-export declare class ArkInstanceFieldRef extends AbstractFieldRef {
-    private base;
-    constructor(base: Local, fieldSignature: FieldSignature);
-    /**
-     * Returns the local of field, showing which object this field belongs to.
-     * A {@link Local} consists of :
-     * - Name: the **string** name of local value, e.g., "$temp0".
-     * - Type: the type of value.
-     * @returns The object that the field belongs to.
-     * @example
-     * 1. Get a base.
-
-     ```typescript
-     if (expr instanceof ArkInstanceFieldRef) {
-     ...
-     let base = expr.getBase();
-     if (base.getName() == 'this') {
-     ...
-     }
-     ...
-     }
-     ```
-     */
-    getBase(): Local;
-    setBase(newBase: Local): void;
-    getUses(): Value[];
-    toString(): string;
-    inferType(arkMethod: ArkMethod): AbstractRef;
-}
-export declare class ArkStaticFieldRef extends AbstractFieldRef {
-    constructor(fieldSignature: FieldSignature);
-    getUses(): Value[];
-    toString(): string;
-}
-export declare class ArkParameterRef extends AbstractRef {
-    private index;
-    private paramType;
-    constructor(index: number, paramType: Type);
-    getIndex(): number;
-    setIndex(index: number): void;
-    getType(): Type;
-    setType(newType: Type): void;
-    inferType(arkMethod: ArkMethod): AbstractRef;
-    getUses(): Value[];
-    toString(): string;
-}
-export declare class ArkThisRef extends AbstractRef {
-    private type;
-    constructor(type: ClassType);
-    inferType(arkMethod: ArkMethod): AbstractRef;
-    getType(): ClassType;
-    getUses(): Value[];
-    toString(): string;
-}
-export declare class ArkCaughtExceptionRef extends AbstractRef {
-    private type;
-    constructor(type: Type);
-    getType(): Type;
-    getUses(): Value[];
-    toString(): string;
-}
-export declare class GlobalRef extends AbstractRef {
-    private name;
-    private ref;
-    private usedStmts;
-    constructor(name: string, ref?: Value);
-    getName(): string;
-    getUses(): Value[];
-    getType(): Type;
-    getRef(): Value | null;
-    setRef(value: Value): void;
-    getUsedStmts(): Stmt[];
-    addUsedStmts(usedStmts: Stmt | Stmt[]): void;
-    toString(): string;
-}
-export declare class ClosureFieldRef extends AbstractRef {
-    private base;
-    private fieldName;
-    private type;
-    constructor(base: Local, fieldName: string, type: Type);
-    getUses(): Value[];
-    getBase(): Local;
-    getType(): Type;
-    getFieldName(): string;
-    toString(): string;
-}
+import { FieldSignature } from '../model/ArkSignature';
+import { Local } from './Local';
+import { ClassType, Type } from './Type';
+import { Value } from './Value';
+import { ArkMethod } from '../model/ArkMethod';
+import { Stmt } from './Stmt';
+/**
+ * @category core/base/ref
+ */
+export declare abstract class AbstractRef implements Value {
+    abstract getUses(): Value[];
+    abstract getType(): Type;
+    inferType(arkMethod: ArkMethod): AbstractRef;
+}
+export declare class ArkArrayRef extends AbstractRef {
+    private base;
+    private index;
+    constructor(base: Local, index: Value);
+    /**
+     * Returns the base of this array reference. Array reference refers to access to array elements.
+     * Array references usually consist of an local variable and an index.
+     * For example, `a[i]` is a typical array reference, where `a` is the base (i.e., local variable)
+     * pointing to the actual memory location where the array is stored
+     * and `i` is the index indicating access to the `i-th` element from array `a`.
+     * @returns the base of this array reference.
+     * @example
+     * 1. Get the base and the specific elements.
+
+     ```typescript
+     // Create an array
+     let myArray: number[] = [10, 20, 30, 40];
+     // Create an ArrayRef object representing a reference to myArray[2]
+     let arrayRef = new ArkArrayRef(myArray, 2);
+     // Use the getBase() method to get the base of the array
+     let baseArray = arrayRef.getBase();
+
+     console.log("Base array:", baseArray);  // Output: Base array: [10, 20, 30, 40]
+
+     // Use baseArray and obeject index of ArrayRef to access to specific array elements
+     let element = baseArray[arrayRef.index];
+     console.log("Element at index", arrayRef.index, ":", element);  // Output: Element at index 2 : 30
+     ```
+     */
+    getBase(): Local;
+    setBase(newBase: Local): void;
+    /**
+     * Returns the index of this array reference.
+     * In TypeScript, an array reference means that the variable stores
+     * the memory address of the array rather than the actual data of the array.
+     * @returns The index of this array reference.
+     */
+    getIndex(): Value;
+    setIndex(newIndex: Value): void;
+    getType(): Type;
+    getUses(): Value[];
+    toString(): string;
+}
+export declare abstract class AbstractFieldRef extends AbstractRef {
+    private fieldSignature;
+    constructor(fieldSignature: FieldSignature);
+    /**
+     * Returns the the field name as a **string**.
+     * @returns The the field name.
+     */
+    getFieldName(): string;
+    /**
+     * Returns a field signature, which consists of a class signature,
+     * a **string** field name, and a **boolean** label indicating whether it is static or not.
+     * @returns The field signature.
+     * @example
+     * 1. Compare two Fields
+
+     ```typescript
+     const fieldSignature = new FieldSignature();
+     fieldSignature.setFieldName(...);
+     const fieldRef = new ArkInstanceFieldRef(baseValue as Local, fieldSignature);
+     ...
+     if (fieldRef.getFieldSignature().getFieldName() ===
+     targetField.getFieldSignature().getFieldName()) {
+     ...
+     }
+     ```
+     */
+    getFieldSignature(): FieldSignature;
+    setFieldSignature(newFieldSignature: FieldSignature): void;
+    getType(): Type;
+}
+export declare class ArkInstanceFieldRef extends AbstractFieldRef {
+    private base;
+    constructor(base: Local, fieldSignature: FieldSignature);
+    /**
+     * Returns the local of field, showing which object this field belongs to.
+     * A {@link Local} consists of :
+     * - Name: the **string** name of local value, e.g., "$temp0".
+     * - Type: the type of value.
+     * @returns The object that the field belongs to.
+     * @example
+     * 1. Get a base.
+
+     ```typescript
+     if (expr instanceof ArkInstanceFieldRef) {
+     ...
+     let base = expr.getBase();
+     if (base.getName() == 'this') {
+     ...
+     }
+     ...
+     }
+     ```
+     */
+    getBase(): Local;
+    setBase(newBase: Local): void;
+    getUses(): Value[];
+    toString(): string;
+    inferType(arkMethod: ArkMethod): AbstractRef;
+}
+export declare class ArkStaticFieldRef extends AbstractFieldRef {
+    constructor(fieldSignature: FieldSignature);
+    getUses(): Value[];
+    toString(): string;
+}
+export declare class ArkParameterRef extends AbstractRef {
+    private index;
+    private paramType;
+    constructor(index: number, paramType: Type);
+    getIndex(): number;
+    setIndex(index: number): void;
+    getType(): Type;
+    setType(newType: Type): void;
+    inferType(arkMethod: ArkMethod): AbstractRef;
+    getUses(): Value[];
+    toString(): string;
+}
+export declare class ArkThisRef extends AbstractRef {
+    private type;
+    constructor(type: ClassType);
+    inferType(arkMethod: ArkMethod): AbstractRef;
+    getType(): ClassType;
+    getUses(): Value[];
+    toString(): string;
+}
+export declare class ArkCaughtExceptionRef extends AbstractRef {
+    private type;
+    constructor(type: Type);
+    getType(): Type;
+    getUses(): Value[];
+    toString(): string;
+}
+export declare class GlobalRef extends AbstractRef {
+    private name;
+    private ref;
+    private usedStmts;
+    constructor(name: string, ref?: Value);
+    getName(): string;
+    getUses(): Value[];
+    getType(): Type;
+    getRef(): Value | null;
+    setRef(value: Value): void;
+    getUsedStmts(): Stmt[];
+    addUsedStmts(usedStmts: Stmt | Stmt[]): void;
+    toString(): string;
+}
+export declare class ClosureFieldRef extends AbstractRef {
+    private base;
+    private fieldName;
+    private type;
+    constructor(base: Local, fieldName: string, type: Type);
+    getUses(): Value[];
+    getBase(): Local;
+    getType(): Type;
+    getFieldName(): string;
+    toString(): string;
+}
 //# sourceMappingURL=Ref.d.ts.map