arkanalyzer 1.0.85 → 1.0.87

package/README.en.md

@@ -1,96 +1,100 @@
-# sig_programanalysis
+# ArkAnalyzer: Static Program Analysis Framework for the ArkTS Language
 
-English | [简体中文](./README.md)
+[简体中文](./README.md) 
 
-## SIG Group Work Objectives and Scope
+## Development environment setup
 
-### Work Objectives
+1. Install [Visual Studio Code](https://code.visualstudio.com/download) or another IDE.
+2. Install [Node.js](https://nodejs.org/en/download/current) (includes npm).
+3. Install dependencies:
+```shell
+npm install
+```
+4. [Optional] Generate the latest API documentation under `docs/api_docs`:
+```shell
+npm run gendoc
+```
 
-* Sig_programanalysis aims to carry out program analysis technology exploration, key technology identification, and competitiveness building for OpenHarmony systems and apps, striving to become the gathering place for OpenHarmony system and app analysis capabilities and an incubation place for related engineering tools.
+## Command-line interface (CLI)
 
-* Sig_programanalysis will build a basic program analysis framework for OpenHarmony apps, and subsequently based on it to provide application developers with out-of-the-box defect scanning and analysis tools, making it possible to automatically vet code for scenarios such as IDE, CI/CD pipelines, etc.
+The executable is `arkanalyzer` (see the `bin` field in `package.json`). **Build before using the CLI locally** so that `lib/` is generated:
 
-### Work Scope
+```shell
+npm run build
+```
 
-* Responsible for building and maintaining the key technology map of program analysis, as well as the decomposition of functional modules in the field, interface definition, and maintenance management.
+Show help:
 
-* Responsible for the architecture design, open source development, and project maintenance of projects related to program analysis.
+```shell
+npx arkanalyzer --help
+npx arkanalyzer cg --help
+npx arkanalyzer ir --help
+```
 
+`<input>` is the **project root** of an ArkTS/TypeScript project.
 
-### Projects
+### `cg`: call graph and reachability
 
-Sig_programanalysis currently incubates the following projects. Everyone is welcome to participate (you can apply to participate in the co-construction of existing projects, or you can apply to create a new program analysis project).
+Usage: `arkanalyzer cg <input> [options]`
 
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-a, --algorithm <name>` | Graph algorithm: `cha` \| `rta` | `rta` |
+| `-o, --output <file>` | Output file path | `stdout` |
+| `-f, --format <type>` | Output format: `json` \| `text` \| `dot` \| `csv` | `json` |
+| `-e, --entry <method>` | Entry method (repeatable); `@dummyMain` means default entries | auto |
+| `-r, --reachable-from <method>` | Reachability roots (repeatable) | — |
+| `--direction <dir>` | `forward` (callees) \| `backward` (callers toward roots) | `forward` |
+| `--edges <type>` | Edge filter: `call` \| `virtual` \| `interface` \| `all` | `all` |
+| `--ohos-sdk-home <path>` | OpenHarmony SDK root; falls back to `OHOS_SDK_HOME` | — |
 
-* ArkAnalyzer:
-The Static Analysis Framework for ArkTS-based OpenHarmony Apps.
+Examples:
 
-* ArkCheck:
-Checking OpenHarmony Apps for Potential Code-level Defects
+```shell
+npx arkanalyzer cg ./myapp -a rta -f json
+npx arkanalyzer cg ./myapp -e "@dummyMain" -r MyClass.myMethod --direction backward -f text
+```
 
+### `ir`: export IR artifacts
 
-## SIG Members
+Usage: `arkanalyzer ir <input> [options]`
 
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-o, --output <dir>` | Output directory for artifacts | `out` |
+| `-f, --format <type>` | `json` \| `text` \| `dot` | `text` |
+| `--ohos-sdk-home <path>` | Same as `cg` | — |
+| `--no-infer-types` | Skip `Scene.inferTypes()` for speed | inference on by default |
 
-### Leader
+The command prints one line of JSON summary to **stdout** (fields such as `input`, `format`, `outputDir`, `fileCount`).
 
-- [lilicoding](https://gitee.com/lilicoding)
+Examples:
 
+```shell
+npx arkanalyzer ir ./myapp -f text -o ./out
+npx arkanalyzer ir ./myapp -f json -o ./out
+```
 
-### Committers
-- [kubigao](https://gitee.com/kubigao)
-- [yifei-xue](https://gitee.com/yifei_xue)
-- [kubrick-hjh](https://gitee.com/kubrick-hjh)
-- [speed9](https://gitee.com/speeds)
-- [bbsun](https://gitee.com/bbsun)
-- [chn](https://gitee.com/chn)
-- [Elouan](https://gitee.com/Elouan)
-- [Rnine](https://gitee.com/Rnine)
-- [workspace_cb](https://gitee.com/workspace_cb)
-- [longyuC](https://gitee.com/longyuC)
-- [xyji95](https://gitee.com/xyji95)
-- [xulingyun-red](https://gitee.com/xulingyun-red)
+For detailed option semantics and examples, see [skills/arkanalyzer/skills/cg.md](skills/arkanalyzer/skills/cg.md) and [skills/arkanalyzer/skills/ir.md](skills/arkanalyzer/skills/ir.md).
 
+## Documentation
 
-### Meetings
- - Meeting Time: Bi-weekly meeting, Thursday 19:30 Beijing time
- - Meeting Application：[Link](https://shimo.im/forms/B1Awd60W7bU51g3m/fill)
- - Meeting Link: Welink or Others
- - Meeting Notification: [Subscribe to](https://lists.openatom.io/postorius/lists/dev.openharmony.io) mailing list dev@openharmony.io for the meeting link
- - Meeting Summary: [Archive link address](https://gitee.com/openharmony-sig/sig-content)
+1. Quick start: [QuickStart.md](docs/QuickStart.md).
+2. API reference: [globals.md](docs/api_docs/globals.md).
+3. Program Analysis SIG: [English](docs/sig_programanalysis.en.md).
 
-### Contact
+## Contributing
 
-- Mailing list: [dev@openharmony.io](https://lists.openatom.io/postorius/lists/dev@openharmony.io/)
+Follow the OpenHarmony-SIG contribution workflow: [HowToCreatePR.md (English)](docs/HowToCreatePR.md#english).
 
-*** 
-# ArkAnalyzer: Static Program Analysis Framework for the ArkTS Language
-## Develope environment setup
-1. [Download Visual Studio Code](https://code.visualstudio.com/download) or other IDEA;
-2. [Download Node.js](https://nodejs.org/en/download/current) and install it. Node.js is a runtime environment for JavaScript, which comes with its own package manager, npm. 
-3. Install Typescript via npm: 
-```shell
-npm install -g typescript
-```
-4. Install dependency libraries
-```shell
-cd arkanalyzer
-npm install
-```
-5. [Optional] Generate the latest API documentation, which will be created at docs/api_docs.
-```shell
-npm run gendoc
-```
+## Debugging
 
-## Docmentations
+Set the `args` array in `.vscode/launch.json` to the file path you want to debug, then start debugging.
 
-1. ArkAnalyzer API docmentations，refer to the [link](docs/api_docs/globals.md).
+## Adding test cases
 
-## Commit codes
-Follow the code repository standards of Openharmony-Sig, refer to the [link](docs/HowToCreatePR.md#english)
+Place new tests under `tests/`. Sample code and other resources go under `tests/resources/`, organized in folders per scenario.
 
-## Debug
-Modify the `args` parameter array in the debug configuration file `.vscode/launch.json` to the path of the test file you want to debug, and then start the debugging process.
+## Issues
 
-## Add test cases
-Place all new test codes in the `tests` directory. Corresponding sample code and other resource files should be placed in the ``tests\resources` directory, and create different folders for each testing scenario.
+See [HowToHandleIssues.md](docs/HowToHandleIssues.md) to file issues.

package/README.md

@@ -1,98 +1,84 @@
-# sig_programanalysis
-
-简体中文 | [English](./README.en.md)
-
-说明：本SIG的内容遵循OpenHarmony的PMC管理章程 [README](../../zh/pmc.md)中描述的约定。
-
-
-## SIG组工作目标和范围
-
-  
-
-### 工作目标
-
-* 程序分析-SIG（Sig_programanalysis） 旨在面向OpenHarmony系统和原生应用开展程序分析技术洞察、关键技术识别和竞争力构建，同时成为OpenHarmony系统和应用程序分析能力的聚集地和相关工程工具的孵化地。
-
-* 程序分析-SIG（Sig_programanalysis）将面向OpenHarmony应用构建基础程序分析框架并基于此为应用开发者提供开箱即用的缺陷扫描分析工具，面向IDE、流水线门禁、应用市场上架审核等场景，打造自动化工具看护能力。
-
-### 工作范围
-
-* 负责程序分析子领域关键根技术地图梳理，以及领域内功能模块分解、接口定义与维护管理等工作。
-
-* 负责程序分析子领域相关项目的架构设计、开源开发和项目维护等工作。
-
-
-### 项目孵化
-
-程序分析-SIG（Sig_programanalysis）正积极孵化如下项目，欢迎大家参与共享共建（可申请参与已有项目的共建，也可申请创建新的程序分析项目并联合社区启动开源共建）。
+# 方舟分析器：面向ArkTS语言的静态程序分析框架
 
+## ArkAnalyzer 环境配置
+1. 从 [Download Visual Studio Code](https://code.visualstudio.com/download) 下载 VS Code 并安装，或安装其他 IDE。
+2. 从 [Download Node.js](https://nodejs.org/en/download/current) 下载 Node.js 并安装（自带 npm）。
+3. 安装依赖库：
+```shell
+npm install
+```
+4. 【可选】生成最新 API 文档，输出目录为 `docs/api_docs`：
+```shell
+npm run gendoc
+```
 
-* 方舟分析器（ArkAnalyzer）:
-	面向ArkTS的OpenHarmony应用程序分析框架。
+## ArkAnalyzer 命令行（CLI）
 
-* 方舟检测器（ArkCheck）:
-	面向OpenHarmony应用开发提供代码级缺陷自动检测（I期聚焦高性能编码规则的自动化检测）
+可执行入口为 `arkanalyzer`（见 `package.json` 的 `bin` 字段）。**本地使用 CLI 前请先编译**，生成 `lib/`：
 
+```shell
+npm run build
+```
 
+查看帮助：
 
-## SIG组成员
+```shell
+npx arkanalyzer --help
+npx arkanalyzer cg --help
+npx arkanalyzer ir --help
+```
 
+`<input>` 均指 ArkTS/TypeScript **工程根目录**。
 
-### Leader
+### `cg`：调用图构建与可达性分析
 
-- [lilicoding](https://gitcode.com/lilicoding)
+用法：`arkanalyzer cg <input> [options]`
 
+| 选项 | 说明 | 默认值 |
+|------|------|--------|
+| `-a, --algorithm <name>` | 构图算法：`cha` \| `rta` | `rta` |
+| `-o, --output <file>` | 结果输出文件路径 | `stdout` |
+| `-f, --format <type>` | 输出格式：`json` \| `text` \| `dot` \| `csv` | `json` |
+| `-e, --entry <method>` | 入口方法，可多次指定；`@dummyMain` 表示与默认入口一致 | 自动推断 |
+| `-r, --reachable-from <method>` | 可达性分析根方法，可多次指定 | — |
+| `--direction <dir>` | 可达方向：`forward`（顺调）\| `backward`（谁调到根） | `forward` |
+| `--edges <type>` | 边类型过滤：`call` \| `virtual` \| `interface` \| `all` | `all` |
+| `--ohos-sdk-home <path>` | OpenHarmony SDK 根路径；未设置时读取环境变量 `OHOS_SDK_HOME` | — |
 
-### Committers列表
-- [kubigao](https://gitcode.com/kubigao)
-- [yifei-xue](https://gitcode.com/yifei-xue)
-- [kubrick-hjh](https://gitcode.com/kubrick-hjh)
-- [speed9](https://gitee.com/speeds)
-- [bbsun](https://gitcode.com/bbsun)
-- [chn](https://gitcode.com/chn)
-- [Elouan](https://gitcode.com/Elouan)
-- [Rnine](https://gitcode.com/Rnine1)
-- [workspace_cb](https://gitee.com/workspace_cb)
-- [longyuC](https://gitee.com/longyuC)
-- [xyji95](https://gitcode.com/xyji95)
-- [xulingyun](https://gitcode.com/muya318)
+示例：
 
+```shell
+npx arkanalyzer cg ./myapp -a rta -f json
+npx arkanalyzer cg ./myapp -e "@dummyMain" -r MyClass.myMethod --direction backward -f text
+```
 
-### 会议
- - 会议时间：双周例会，周四晚上19:00, UTC+8
- - 会议申报：[申报链接](https://shimo.im/forms/B1Awd60W7bU51g3m/fill)
- - 会议链接：Welink或其他会议
- - 会议通知：请[订阅](https://lists.openatom.io/postorius/lists/dev.openharmony.io)邮件列表 dev@openharmony.io 获取会议链接
- - 会议纪要：[归档链接地址](https://gitee.com/openharmony-sig/sig-content)
+### `ir`：导出工程 IR 产物
 
+用法：`arkanalyzer ir <input> [options]`
 
-### Contact (optional)
+| 选项 | 说明 | 默认值 |
+|------|------|--------|
+| `-o, --output <dir>` | 产物输出目录 | `out` |
+| `-f, --format <type>` | `json` \| `text` \| `dot` | `text` |
+| `--ohos-sdk-home <path>` | 同 `cg` | — |
+| `--no-infer-types` | 跳过 `Scene.inferTypes()` 以加快执行 | 默认会做类型推断 |
 
-- 邮件列表：[dev@openharmony.io](https://lists.openatom.io/postorius/lists/dev@openharmony.io/)
+命令会在**标准输出**打印一行 JSON 摘要（含 `input`、`format`、`outputDir`、`fileCount` 等）。
 
-***
+示例：
 
-# 方舟分析器：面向ArkTS语言的静态程序分析框架
-## ArkAnalyzer 环境配置
-1. 从[Download Visual Studio Code](https://code.visualstudio.com/download)下载vscode并安装，或安装其他IDE。
-2. 从[Download Node.js](https://nodejs.org/en/download/current)下载Node.js并安装，Node.js为JavaScript的运行时环境，自带包管理器npm。
-3. 通过npm安装TypeScript编译器，命令行输入
 ```shell
-npm install -g typescript
-```
-4. 安装依赖库
-```shell
-npm install
-```
-5. 【可选】生成最新API文档，文档生成在 docs/api_docs。
-```shell
-npm run gendoc
+npx arkanalyzer ir ./myapp -f text -o ./out
+npx arkanalyzer ir ./myapp -f json -o ./out
 ```
 
+更细的参数语义与典型用法可参考仓库内 [skills/arkanalyzer/skills/cg.md](skills/arkanalyzer/skills/cg.md)、[skills/arkanalyzer/skills/ir.md](skills/arkanalyzer/skills/ir.md)。
+
 ## ArkAnalyzer 文档
 
 1. ArkAnalyzer 快速入门文档，请参考：[链接](docs/QuickStart.md)。
 2. ArkAnalyzer API文档，请参考：[链接](docs/api_docs/globals.md)。
+3. 程序分析 SIG 说明：[简体中文](docs/sig_programanalysis.md) · [English](docs/sig_programanalysis.en.md)。
 
 ## ArkAnalyzer 代码上库
 遵守openharmony-sig代码上库规范, 操作方法请参考：[链接](docs/HowToCreatePR.md#中文)

package/config/arkanalyzer.json

@@ -8,13 +8,18 @@
   ],
   "enableLeadingComments": false,
   "enableBuiltIn": true,
+  "enableOhModulesBody": false,
   "ignoreFileNames": [
-    "oh_modules",
     "node_modules",
     "build-tools",
     "hvigorfile.ts",
     "hvigorfile.js",
-    "hvigor-wrapper.js"
+    "hvigor-wrapper.js",
+    "build-tools",
+    "build",
+    ".cxx",
+    ".test",
+    ".preview"
   ],
   "sdkGlobalFolders": [
     "component",

package/docs/cppFrontend/ArkAnalyzer-cpp_usage_guide.md

@@ -0,0 +1,245 @@
+# ArkAnalyzer-cpp使用指导
+
+## 一、arkCppAstDumper工具生成与使用
+* 简介：解析C/C++源码文件生成抽象语法树
+
+### 1、构建环境（根据构建要求选择）
+* **LLVM**：使用19.1.7版本，llvm中clang-c目录下的13个头文件为arkCppAstDumper工具提供解析处理抽象语法节点的方法，libclang动态链接库为arkCppAstDumper工具提供编译器接口，下载地址：https://github.com/llvm/llvm-project/releases
+
+* **Visual Studio 2022**：使用2022版本，通过Visual Studio下载windows平台的MSVC标准库头文件，也作为构建系统在windows平台构建arkCppAstDumper工具，下载地址：https://visualstudio.microsoft.com/zh-hans/downloads
+
+* **llvm-mingw**：用于在linux上交叉编译构建windows版本的arkCppAstDumper工具，下载地址：https://github.com/mstorsjo/llvm-mingw/releases
+
+* **osxcross**：用于在linux上交叉编译构建mac版本的arkCppAstDumper工具,下载地址：https://github.com/tpoechtrager/osxcross
+
+* **macosx-sdks**：用于在linux上交叉编译构建mac版本的arkCppAstDumper工具,下载地址：https://github.com/joseluisq/macosX-sdks
+
+* **cmake**：使用3.22.5及以上版本，构建命令构建arkCppAstDumper工具，下载地址：https://cmake.org/download
+
+* **json.hpp**：用于将抽象语法树以json的格式输出，下载地址：https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp
+
+### 2、构建arkCppAstDumper工具
+#### 2.1、构建windows版本的arkCppAstDumper
+
+##### 2.1.1、在windows平台构建arkCppAstDumper
+
+根据windows平台下载对应的llvm预编译版本并解压
+
+![img_7.png](img_7.png)
+
+配置llvm的bin目录到环境变量
+
+![img_22.png](img_22.png)
+
+下载Visual Studio 2022安装包进行安装，打开Visual Studio install选择C++的桌面开发进行安装环境
+
+![img_20.png](img_20.png)
+
+下载arkAnalyzer-cpp代码，将json.hpp文件放在arkanalyzer\src\cpp_frontend\ast\utils的目录下，在arkanalyzer\src\cpp_frontend\ast\cmake\toolchains\windows.cmake文件中配置llvm的clang-c和libclang的路径
+
+![img_23.png](img_23.png)
+
+在arkanalyzer\src\cpp_frontend\ast的目录下执行以下命令，在arkanalyzer\src\cpp_frontend\ast\build\Release目录下生成工具
+
+    mkdir build && cd build
+    cmake -DCMAKE_TOOLCHAIN_FILE=..\cmake\toolchains\windows.cmake ..
+    cmake --build . --config Release
+
+执行依赖的文件：
+* libclang.dll（可从llvm预编译版本的bin目录下获取）
+
+##### 2.1.2、在linux平台交叉编译构建windows版本的arkCppAstDumper
+
+下载windows版本的llvm预编译版本并解压
+
+![img_7.png](img_7.png)
+
+根据LLVM版本下载对应的llvm-mingw包并解压
+
+![img_9.png](img_9.png)
+
+下载arkAnalyzer-cpp代码，将json.hpp文件放在arkanalyzer\src\cpp_frontend\ast\utils的目录下，在arkanalyzer\src\cpp_frontend\ast\cmake\toolchains\mingw.cmake文件中配置llvm的clang-c和libclang.dll的路径,配置llvm-mingw的clang编译器和链接库
+
+![img_6.png](img_6.png)
+
+在arkanalyzer\src\cpp_frontend\ast的目录下执行以下命令，在arkanalyzer\src\cpp_frontend\ast\build目录下生成工具
+
+    mkdir build && cd build
+    cmake -DCMAKE_TOOLCHAIN_FILE=..\cmake\toolchains\mingw.cmake ..
+    make
+
+执行依赖的文件：
+* libclang.dll（可从llvm预编译版本的bin目录下获取）
+* libc++.dll（可从llvm-mingw的x86_64-w64-mingw32/bin目录下获取）
+* libunwind.dll（可从llvm-mingw的x86_64-w64-mingw32/bin目录下获取）
+
+#### 2.2、构建linux版本的arkCppAstDumper（x86和arm同理）
+下载linux版本的llvm预编译版本并解压
+
+![img_21.png](img_21.png)
+
+下载arkAnalyzer-cpp代码，将json.hpp文件放在arkanalyzer\src\cpp_frontend\ast\utils的目录下，在arkanalyzer\src\cpp_frontend\ast\cmake\toolchains\linux.cmake文件中配置llvm的clang-c和libclang.so的路径
+
+![img_5.png](img_5.png)
+
+在arkanalyzer\src\cpp_frontend\ast的目录下执行以下命令，在arkanalyzer\src\cpp_frontend\ast\build目录下生成工具
+
+    mkdir build && cd build
+    cmake -DCMAKE_TOOLCHAIN_FILE=..\cmake\toolchains\linux.cmake ..
+    make
+
+执行依赖的文件：
+libclang.so（可从llvm预编译版本的LLVM-19.1.7-Linux-X64/lib目录下获取）
+
+#### 2.3、构建mac版本的arkCppAstDumper（x86和arm同理）
+##### 2.3.1、在linux平台交叉编译构建mac版本的arkCppAstDumper
+下载mac版本的llvm预编译版本并解压
+
+![img_10.png](img_10.png)
+
+下载osxcross源码，执行下列命令安装基础依赖环境
+
+    apt install cmake clang git patch libssl-dev libxml2-dev xz-utils bzip2 cpio zliblg-dev
+
+下载mac的SDK包放在osxcross/tarball目录下
+
+![img_11.png](img_11.png)
+
+执行下列命令配置osxcross环境变量
+
+    export OSXCROSS_INSTALL_DIR=osxcross根目录
+
+在osxcross根目录执行构建脚本
+
+    TARGET_DIR=${OSXCROSS_INSTALL_DIR} SDK_VERSION=sdk版本号 OSX_VERSION_MIN=14.0 ./build.sh
+
+执行下列命令配置环境变量
+
+    export OSXCROSS_TARGET_DIR=osxcross/target
+    export LLVM_MACOS_ARM64_PATH=llvm的目录
+    export PATH=${OSXCROSS_TARGET_DIR}/bin:$PATH
+    export OSXCROSS_TARGET=darwin24.5
+    export OSXCROSS_SDK=MacOSX15.5.sdk
+    export OSXCROSS_HOST=arm64-apple-darwin24.5
+
+下载arkAnalyzer-cpp代码，将json.hpp文件放在arkanalyzer\src\cpp_frontend\ast\utils的目录下，在arkanalyzer\src\cpp_frontend\ast的目录下执行以下命令，在arkanalyzer\src\cpp_frontend\ast\build目录下生成工具
+
+    mkdir build && cd build
+    cmake -DCMAKE_TOOLCHAIN_FILE=${OSXCROSS_INSTALL_DIR}/toolchain.cmake -DCLANG_INCLUDE_DIRS=${LLVM_MACOS_ARM64_PATH}/include -DCLANG_LIBRARIES=${LLVM_MACOS_ARM64_PATH}/lib/libclang.dylib ..
+    make
+
+执行依赖的文件：
+* libclang.dylib（可从llvm预编译版本的LLVM-19.1.7-macOS-ARM64/lib目录下获取）
+
+### 3、使用arkCppAstDumper工具
+
+#### 3.1、arkCppAstDumper工具使用示例
+
+##### 对单个文件生成抽象语法树并输出到文件.cpp同级路径下（默认路径）
+
+    ./arkCppAstDumper.exe <文件.cpp>
+
+##### 对单个文件生成抽象语法树并输出到指定路径
+
+    ./arkCppAstDumper.exe <文件.cpp> -o <json文件指定路径>
+
+##### 对单个文件生成抽象语法树并提供编译数据库文件
+
+    ./arkCppAstDumper.exe <文件.cpp> -o <json文件指定路径> -c <编译数据库文件路径>
+
+##### 对单个文件生成抽象语法树并提供多个-I编译参数
+
+    ./arkCppAstDumper.exe <文件.cpp> -o <json文件指定路径> -i <头文件路径> -i <头文件路径> ...
+
+##### 对单个文件生成抽象语法树并指定 TU Flags
+
+    ./arkCppAstDumper.exe <文件.cpp> -o <json文件指定路径> -f <flags>
+
+    其中 -f 参数用于控制 libClang 的 TranslationUnit 解析标志：
+    默认总是包含 KeepGoing（保证 AST 构建在遇到错误时尽量继续）。
+    允许与 DetailedPreprocessingRecord 组合，开启详细预处理记录（可以获取 #include 和 #define 等信息）。
+    允许与 SingleFileParse 组合，仅解析单个源文件而不递归解析包含的头文件。
+    多个标志可以用 , 或 | 分隔，例如：
+    ./arkCppAstDumper.exe test.cpp -f "DPP|SingleFileParse"
+    等价于 KeepGoing | DetailedPreprocessingRecord | SingleFileParse。
+
+#### 3.2、arkCppAstDumper工具解析策略
+- arkCppAstDumper会优先从-c获取编译数据库引入头文件的编译参数，如果编译数据库不存在再从-i获取引入头文件的编译参数，-c参数和-i参数不能同时存在，只能选其一。
+
+## 二、使用ArkAnalyzer源码分析C++项目
+
+1、将arkCppAstDumper工具及其依赖的文件放在arkanalyzer\src\cpp_frontend\ast\dumper目录下
+
+![img_12.png](img_12.png)
+
+2、对需要分析的项目生成编译数据库，推荐的三种方式：
+
+* 用DevEco Studio打开项目，点击file下的Sync and Refresh Project对项目自动生成编译数据库
+
+![img_13.png](img_13.png)
+
+* 使用cmake原生支持生成编译数据库，在CMakeLists.txt文件添加下列设置
+
+    set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+* 安装bear拦截编译生成编译数据库
+    
+    sudo apt install bear
+    bear -- cmake ..
+
+3、设置SceneConfig，路径：arkanalyzer\src\Config.ts
+
+![img_14.png](img_14.png)
+
+4、设置c++头文件到环境变量，当没有编译数据库时作为头文件搜索路径
+
+* windows平台设置DevEco studio目录下的c++头文件
+  ![img_8.png](img_8.png)
+
+* linux平台设置commomd-line-tools目录下的c++头文件
+![img_16.png](img_16.png)
+
+* mac平台设置DevEco studio和MacOSX.sdk目录下的c++头文件
+![img_19.png](img_19.png)
+
+5、执行接口，SceneConfig作为参数传给buildSceneFromFiles方法生成Scene结构的ArkIR，路径：arkanalyzer\src\Scene.ts
+
+![img_18.png](img_18.png)
+
+6、执行流程：
+
+* 根据SceneConfig中项目目录编译所有的文件，通过配置中的文件后缀过滤掉其它不需要分析的文件。
+
+* 遍历需要分析的文件分别执行arkCppAstDumper工具对单个文件生成抽象语法树。
+
+* arkAnalyzer-cpp遍历抽象语法树对每个节点进行解析处理生成Scene结构的ArkIR。
+
+## 三、基于ArkAnalyzer npm包分析C++项目
+
+1、修改package.json文件中dumper工具的目录，删除postinstall配置，将dumper工具打包到包中
+
+![img_17.png](img_17.png)
+
+2、在arkanalyzer根目录下执行下列命令进行打包生成arkanalyzer-1.0.8.tgz包
+   
+    npm pack
+
+3、将arkanalyzer-1.0.8.tgz包放在homecheck根目录下执行下列命令进行安装
+ 
+    npm install arkanalyzer-1.0.8.tgz
+
+4、在homecheck中引入arkanalyzer的SceneConfig和Scene，在SceneConfig配置项目信息，将SceneConfig配置传给Scene的buildSceneFromFiles方法生成Scene结构的ArkIR
+
+![img_15.png](img_15.png)
+
+## 四、单元测试运行
+
+配置：将arkCppAstDumper工具及其依赖的文件放在arkanalyzer\src\cpp_frontend\ast\dumper目录下
+
+1、运行单个单元测试，执行以下终端命令
+
+    npm test 单元测试用例路径
+
+2、运行所有单元测试，在项目的跟目录下执行以下终端命令
+
+    npm test