arkanalyzer 1.0.85 → 1.0.87

package/docs/cppFrontend/cpp_frontend_build_guide.md

@@ -0,0 +1,126 @@
+# CPP 前端构建指南
+
+本文说明在 **Linux / macOS / Windows** 上构建 `astJsonDumper` 之前需要安装的工具、推荐版本及环境变量。构建由仓库根目录脚本 `script/buildCpp.js` 驱动（`npm run build:cpp`）。
+
+## 1. 构建什么、命令是什么
+
+在仓库根目录执行 **`npm run build:cpp`**，于**当前操作系统**本机构建 `astJsonDumper`（Linux/macOS 下无扩展名，Windows 下为 `astJsonDumper.exe`）。不在此脚本中支持从 Linux/macOS 交叉编译 Windows PE。
+
+源码与 CMake 工程根目录：`src/frontend/cppFrontend/ast`。  
+脚本会在配置阶段向 CMake 传入 `LLVM_DIR` / `Clang_DIR`（若已探测或已设置）。
+
+## 2. 通用依赖
+
+- **CMake**：3.16+（工程 `cmake_minimum_required`），且 `cmake` 在 `PATH` 中。
+- **LLVM / Clang**：需能通过 CMake `find_package(LLVM)`、`find_package(Clang)` 解析。仓库开发与 CI 以 **LLVM 19** 为主线；若使用其他主版本，需自行验证链接与头文件是否一致。
+- **C++ 编译器**：支持 **C++17**（由 LLVM/Clang 或 MSVC 提供，取决于平台与生成器）。
+
+脚本会按顺序尝试：环境变量 **`LLVM_DIR`**（若目录存在）、**`llvm-config` / `llvm-config-19`**（`--cmakedir`）、常见安装路径（见各节）。  
+若同时设置 **`LLVM_DIR`** 与 **`Clang_DIR`**，将优先直接使用二者（路径需分别指向 `lib/cmake/llvm` 与 `lib/cmake/clang`）。
+
+## 3. Linux（本机）
+
+### 3.1 推荐软件包（Debian / Ubuntu 示例）
+
+```bash
+sudo apt-get update
+sudo apt-get install -y cmake ninja-build llvm-19-dev libclang-19-dev
+```
+
+确保 `llvm-config-19` 在 `PATH` 中，或显式导出：
+
+```bash
+export LLVM_DIR=$(llvm-config-19 --cmakedir)
+# 可选：Clang_DIR 通常可由脚本根据 LLVM_DIR 推导；若 CMake 报错再设：
+# export Clang_DIR=$(dirname "$(llvm-config-19 --cmakedir)")/clang
+```
+
+### 3.2 注意
+
+- 避免混用不同主版本的 LLVM 动态库（例如系统 `libLLVM.so` 与 `LLVM_DIR` 指向 19 不一致），否则易出现链接错误或 “DSO missing” 类问题。
+- 其他发行版请使用对应包名安装 **LLVM/Clang 开发包** 与 **CMake**，原则同上。
+
+## 4. macOS（本机）
+
+### 4.1 Homebrew 示例
+
+```bash
+brew install cmake llvm@19 ninja
+```
+
+`llvm@19` 通常不在默认 shell PATH 中，可将 `$(brew --prefix llvm@19)/bin` 加入 `PATH`，或设置：
+
+```bash
+export LLVM_DIR="$(brew --prefix llvm@19)/lib/cmake/llvm"
+export Clang_DIR="$(brew --prefix llvm@19)/lib/cmake/clang"
+```
+
+脚本在未设置 `LLVM_DIR` 时，也会尝试通过 `brew --prefix llvm` 或常见路径探测（以本机实际安装为准）。
+
+### 4.2 注意
+
+- Apple 自带 `clang` 不等于 **LLVM CMake 包**；若未安装 Homebrew LLVM，需自行提供可用的 `LLVM_DIR` / `Clang_DIR`。
+
+## 5. Windows（本机，非 MSYS2）
+
+适用于：官方安装包 **LLVM** + **Visual Studio**（含 “使用 C++ 的桌面开发”），在 **cmd / PowerShell** 或已配置好 PATH 的终端中执行 `npm run build:cpp`。
+
+### 5.1 安装建议
+
+- **CMake**：`winget install Kitware.CMake` 或从官网安装并加入 `PATH`。
+- **LLVM**：`winget install LLVM.LLVM` 等，默认常见路径为 `C:\Program Files\LLVM\lib\cmake\llvm`；可将 `C:\Program Files\LLVM\bin` 加入 `PATH` 以便找到 `llvm-config.exe`。
+- **Visual Studio 2022**：提供 MSVC 工具链与 Windows SDK；CMake 默认可能选用 Visual Studio 生成器。
+- **Ninja（可选）**：若已安装并在 `PATH` 中，脚本会优先使用 **Ninja + Release** 单配置生成，产物路径更固定；否则使用 Visual Studio 多配置生成，构建时追加 `--config Release`，并在 `build\Release\` 等目录下查找 `astJsonDumper.exe`。
+
+### 5.2 环境变量（可选）
+
+```text
+LLVM_DIR=C:\Program Files\LLVM\lib\cmake\llvm
+Clang_DIR=C:\Program Files\LLVM\lib\cmake\clang
+```
+
+路径含空格时，在图形界面或脚本中设置即可，无需手动转义引号给 Node 脚本。
+
+## 6. Windows（MSYS2 本机构建）
+
+在 **MSYS2** 的 **MinGW x64**、**UCRT64** 或 **CLANG64** 环境中，使用 `pacman` 安装 LLVM/Clang 与构建工具，然后在**同一环境**中执行 `npm run build:cpp`（需能访问到该环境中的 `cmake`、`node`）。
+
+### 6.1 MinGW64 环境示例
+
+```bash
+pacman -S mingw-w64-x86_64-llvm mingw-w64-x86_64-clang mingw-w64-x86_64-clang-tools-extra mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-nodejs
+```
+
+### 6.2 UCRT64 环境
+
+将包名前缀改为 `mingw-w64-ucrt-x86_64-*`（如 `mingw-w64-ucrt-x86_64-llvm` 等），与当前环境一致即可。
+
+### 6.3 路径探测说明
+
+脚本会结合 **`MSYS2_ROOT`**、**`MINGW_PREFIX`**（如 `/mingw64`）以及常见根目录（如 `C:\msys64` 下 `mingw64`、`ucrt64`、`clang64`）自动查找 `lib\cmake\llvm`。若 MSYS2 未安装在默认盘符路径，请设置 **`MSYS2_ROOT`** 或 **`LLVM_DIR`**。
+
+## 7. 环境变量一览
+
+| 变量 | 用途 |
+| ---- | ---- |
+| `LLVM_DIR` | 指向 `lib/cmake/llvm`（LLVM CMake 包目录） |
+| `Clang_DIR` | 指向 `lib/cmake/clang`（可选；未设时脚本常从 `LLVM_DIR` 推导） |
+| `MSYS2_ROOT` | 仅 Windows：MSYS2 安装根目录，辅助解析 `mingw64` 等前缀 |
+
+## 8. 构建产物位置
+
+成功执行后，脚本会将可执行文件复制到：
+
+- 目录：`src/frontend/cppFrontend/ast/dumper/`
+- 名称：`astJsonDumper`（Unix）或 `astJsonDumper.exe`（Windows）
+
+中间构建目录：`src/frontend/cppFrontend/ast/build/`（若切换生成器或路径，可删除该目录后重试）。
+
+## 9. 常见问题
+
+- **CMake 找不到 LLVM**：先确认 `LLVM_DIR` 目录存在且包含 `LLVMConfig.cmake`；Linux 上优先使用 `llvm-config-19 --cmakedir` 输出。
+- **Windows 上找不到产物**：确认是否使用 **Release** 配置；脚本会尝试 `build\`、`build\Release\`、`build\x64\Release\` 等路径。
+- **版本混链**：同一构建中 `LLVM_DIR`、系统 `libLLVM`、PATH 中的 `clang` 应来自同一 LLVM 大版本，避免 18/19 混用。
+
+更偏设计与链接策略的说明见：`docs/developer/cpp-ast-dumper-build-stability-design.md`。  
+使用说明（含历史截图与工具链名）见：`docs/cppFrontend/ArkAnalyzer-cpp_usage_guide.md`。

package/docs/cppFrontend/cpp_frontend_user_guide.md

@@ -0,0 +1,175 @@
+# ArkAnalyzer-CPP前端
+
+### ArkAnalyzer-CPP前端是由 ICT BG 公共开发部的品牌-精卫 团队主导设计与开发, 基于llvm的解析能力对cpp/c的语义场景完成其到ArkAnalyzer IR的转译及分析。
+
+## 一、ArkAnalyzer-CPP工具使用介绍
+
+### 1、外部接口调用
+
+在本分支下，对ArkAnalyzer使用者提供统一接口调用，可以参考tests/unit/core_cpp/graph/Cfg.test.ts测试文件中的构建
+
+```
+    let config: SceneConfig = new SceneConfig();
+    config.buildFromProjectDir(path.join(BASE_DIR, folderName));
+    let scene = new Scene();
+    scene.buildSceneFromProjectDir(config);
+    return scene;
+```
+
+只需要调用SceneConfig和scene构建即可，其中config.buildFromProjectDir()传入的参数是需要解析的项目路径。该函数位置在src/Scene.ts中
+以一个if代码的解析做介绍，解析过程如下图所示:
+![img.png](img.png)
+在解析过程中，genArkFiles函数会区分文件类型，对于cpp文件会调用buildArkCxxFileFromFile生成对应语法树。
+在genArkFiles下的buildAllMethodBody中调用method.freeCxxBodyBuilder()进行函数内语句的解析。
+
+### 2、解析结果，scene展示
+
+如下图所示
+![img_1.png](img_1.png)
+![img_2.png](img_2.png)
+
+如果一个cpp接口是在ts语言中被调用的接口，会在Scene结构中添加ts2cxxFuncMap进行暴露，通过setTs2CxxFuncMapOfClass函数进行填充。
+这里以懒加载任务提供的代码示例
+![img_3.png](img_3.png)
+
+## 二、cpp_frontend模块介绍
+
+#### 路径：ArkAnalyzer/src/cpp_frontend
+
+### 1、common模块
+
+ArkCxxIRTransformer：继承ArkAnalyzer/src/core/common下的ArkIRTransformer，复用了ArkIRTransformer下的方法，根据c++语法重写和新增了ArkCxxIRTransformer下的方法
+
+ArkCxxValueTransformer：继承ArkAnalyzer/src/core/common下的ArkValueTransformer，复用了ArkValueTransformer下的方法，根据c++语法重写和新增了ArkCxxValueTransformer下的方法
+
+ModelUtils：根据c++语法编写了关于获取头文件的include信息的方法
+
+TypeInference：根据c++语法编写了关于类型推断的方法，该文件下许多方法的函数体与ArkAnalyzer/src/core/common/TypeInference相同，因为c++和typescript使用的AST结构不同，所以不能复用
+
+ValueUtilsCpp：继承ArkAnalyzer/src/core/common下的ValueUtils,复用了ValueUtils下的方法，根据c++语法新增了normalizeString和createStringConst两个方法
+
+### 2、graph模块
+
+CfgBuilder：根据c++语法编写了关于构建cfg的方法，复用了ArkAnalyzer/src/core/graph/builder/CfgBuilder下的BlockBuilder, Case, Catch, TextError, Variable, Scope对象
+
+### 3、model模块
+
+ArkClassBuilder：根据c++语法编写了关于构建cfg结构下ArkClass的方法，复用了ArkAnalyzer/src/core/model/builder/ArkClassBuilder下的方法和对象
+
+ArkFieldBuilder：根据c++语法编写了关于构建cfg结构下ArkField的方法
+
+ArkFileBuilder：根据c++语法编写了关于构建cfg结构下ArkFile的方法，复用了ArkAnalyzer/src/core/model/builder下ArkExportBuilder和ArkClassBuilder的方法
+
+ArkImportBuilder：根据c++语法编写了关于构建cfg结构下ArkInclude的方法
+
+ArkMethodBuilder：根据c++语法编写了关于构建cfg结构下ArkMethod的方法，复用了ArkAnalyzer/src/core/model/builder下ViewTreeBuilder和ArkMethodBuilder的方法和对象
+
+ArkNamespaceBuilder：根据c++语法编写了关于构建cfg结构下ArkNamespace的方法，复用了ArkAnalyzer/src/core/model/builder/ArkNamespaceBuilder下的方法
+
+CxxBodyBuilder：根据c++语法编写了关于构建整个cfg结构的方法，从CxxBodyBuilder开始调用cpp_frontend模块下的方法，复用了ArkAnalyzer/src/core/model/builder/ArkMethodBuilder的方法
+
+builderUtils：根据c++语法编写了关于构建cfg的常规方法，复用了ArkAnalyzer/src/core/model/builder下ArkMethodBuilder和builderUtils的方法
+
+## 三、ArkAnalyzer-CPP前端暴露接口，ArkAnalyzer/src/Scene下调用
+
+1、ArkAnalyzer/src/cpp_frontend/model/builder/ArkFileBuilder下的buildArkFileFromFile方法，该方法获取c++的抽象语法树
+
+2、ArkAnalyzer/src/cpp_frontend/model/builder/ArkMethodBuilder下的addInitInConstructor方法，该方法添加默认的构造函数
+
+3、ArkAnalyzer/src/cpp_frontend/model/ArkMethod下的buildCxxBody和freeCxxBodyBuilder方法，作用分别是构建cfg和释放资源
+
+## 四、ArkAnalyzer-CPP工具开发介绍
+
+### 本部分介绍ArkAnalzyer解析Cpp源码生成IR的接口逻辑，主要是关键函数相关的调用逻辑，以及函数功能的介绍
+
+#### 1、对scene数据结构的介绍，ArkAnalyzer项目的核心就是在将代码解析成scene数据结构
+
+Scene 类为 ArkAnalyzer 的核心类，用户可以通过该类访问所分析代码（项目）的所有信息，包括文件列表、类列表、方法列表、属性列表等。Scene 类具体数据结构如下所示。
+
+![img_4.png](img_4.png)
+
+### 2.下面介绍Cpp代码解析的过程
+
+<核心函数调用图>
+
+```mermaid
+graph TD
+    buildSceneFromProjectDir --> buildBasicInfo
+    buildSceneFromProjectDir --> genArkFiles
+    genArkFiles --> buildArkCxxFileFromFile
+    genArkFiles --> buildAllMethodBody
+    genArkFiles --> addDefaultConstructors
+    buildArkCxxFileFromFile --> AstUtils.parse
+    AstUtils.parse --> getPlatformClang
+    AstUtils.parse --> JSON.parse
+    buildArkCxxFileFromFile --> genDefaultArkClass
+    buildArkCxxFileFromFile --> buildArkFile
+    genDefaultArkClass --> buildDefaultArkClassFromArkFile
+    genDefaultArkClass --> arkFile.setDefaultClass
+    genDefaultArkClass --> arkFile.addArkClass
+    buildArkFile --> buildNormalArkClassFromArkFile
+    buildArkFile --> buildArkMethodFromArkClass
+    buildArkFile --> buildArkNamespace
+    buildArkFile --> buildImportInfo
+    genArkFiles --> buildAllMethodBody
+    genArkFiles --> addDefaultConstructors
+    buildAllMethodBody --> method.buildCxxBody
+    method.buildCxxBody --> CxxBodyBuilder.build
+    CxxBodyBuilder.build --> cfgBuilder.buildCfgBuilder
+    CxxBodyBuilder.build --> cfgBuilder.buildCfg
+    cfgBuilder.buildCfgBuilder --> walkAST
+    cfgBuilder.buildCfg --> buildNormalCfg
+    cfgBuilder.buildCfg --> buildCfgForSimpleArrowFunction
+    buildNormalCfg --> processBlocks
+    processBlocks --> switchStatementToValueAndStmts
+    processBlocks --> tsNodeToStmts
+    tsNodeToStmts --> xxxToStmts
+    xxxToStmts --> cxxNodeToValueAndStmts
+
+```
+
+#### 项目入口
+
+首先配置config结构，如
+config.buildFromProjectDir(path);
+将需要解析的项目源码位置存储到config结构中。
+随后使用scene的buildSceneFromProjectDir进行scene构建。
+scene.buildSceneFromProjectDir(config);
+
+#### 下面是构建过程的详细介绍，整个过程分为两个阶段，第一阶段是生成Arkfile，ArkClass，和ArkMethod：①调用libClang工具生成ast语法树，②ArkAnalzyer对生成的语法树解析，构造scene结构。
+
+第二阶段，对method的语句进行解析。
+
+##### 第一阶段：
+
+```
+    private genArkFiles(): void {
+        this.projectFiles.forEach(file => {
+            logger.trace('=== parse file:', file);
+            try {
+                const arkFile: ArkFile = new ArkFile(FileUtils.getFileLanguage(file, this.fileLanguages));
+                arkFile.setScene(this);
+                if (arkFile.getLanguage() === Language.CXX) {
+                    buildArkCxxFileFromFile(file, this.realProjectDir, arkFile, this.projectName, this.includeDirs);
+                } else {
+                    buildArkFileFromFile(file, this.realProjectDir, arkFile, this.projectName);
+                }
+                this.filesMap.set(arkFile.getFileSignature().toMapKey(), arkFile);
+            } catch (error) {
+                logger.error('Error parsing file:', file, error);
+                this.unhandledFilePaths.push(file);
+                return;
+            }
+        });
+        this.buildAllMethodBody();
+        this.addDefaultConstructors();
+    }
+```
+
+##### 第二阶段：
+
+这一部分主要介绍两个处理过程：
+1、buildAllMethodBody()，在此函数中使用buildCxxBody()接口,在开发中walkAST依据语法树的结构划分出block，并构建出block的前后继关系
+2、tsNodeToStmts：在这个函数中根据不同的模块类型，进行不同的处理，比如传入节点是IfStmt时，选择对应的cxxIfStatementToStmts，构建出相应的IR表示，这里的IR就是三地址码的形式了，例如其中条件表达部分调用conditionToValueAndStmts，构造ArkConditionExpr
+
+当前ArkAnalzyer在解析源码生成中间IR集

package/docs/sig_programanalysis.en.md

@@ -0,0 +1,66 @@
+# sig_programanalysis
+
+English | [简体中文](./sig_programanalysis.md)
+
+The content of this SIG follows the conventions described in the OpenHarmony PMC charter [README](../../zh/pmc.md).
+
+## SIG Group Work Objectives and Scope
+
+### Work Objectives
+
+* 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.
+
+* 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.
+
+### Work Scope
+
+* 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.
+
+* Responsible for the architecture design, open source development, and project maintenance of projects related to program analysis.
+
+
+### Projects
+
+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).
+
+
+* ArkAnalyzer:
+The Static Analysis Framework for ArkTS-based OpenHarmony Apps.
+
+* ArkCheck:
+Checking OpenHarmony Apps for Potential Code-level Defects
+
+
+## SIG Members
+
+
+### Leader
+
+- [lilicoding](https://gitcode.com/lilicoding)
+
+
+### 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)
+
+
+### 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)
+
+### Contact
+
+- Mailing list: [dev@openharmony.io](https://lists.openatom.io/postorius/lists/dev@openharmony.io/)

package/docs/sig_programanalysis.md

@@ -0,0 +1,73 @@
+# sig_programanalysis
+
+简体中文 | [English](./sig_programanalysis.en.md)
+
+说明：本SIG的内容遵循OpenHarmony的PMC管理章程 [README](../../zh/pmc.md)中描述的约定。
+
+
+## SIG组工作目标和范围
+
+  
+
+### 工作目标
+
+* 程序分析-SIG（Sig_programanalysis） 旨在面向OpenHarmony系统和原生应用开展程序分析技术洞察、关键技术识别和竞争力构建，同时成为OpenHarmony系统和应用程序分析能力的聚集地和相关工程工具的孵化地。
+
+* 程序分析-SIG（Sig_programanalysis）将面向OpenHarmony应用构建基础程序分析框架并基于此为应用开发者提供开箱即用的缺陷扫描分析工具，面向IDE、流水线门禁、应用市场上架审核等场景，打造自动化工具看护能力。
+
+### 工作范围
+
+* 负责程序分析子领域关键根技术地图梳理，以及领域内功能模块分解、接口定义与维护管理等工作。
+
+* 负责程序分析子领域相关项目的架构设计、开源开发和项目维护等工作。
+
+
+### 项目孵化
+
+程序分析-SIG（Sig_programanalysis）正积极孵化如下项目，欢迎大家参与共享共建（可申请参与已有项目的共建，也可申请创建新的程序分析项目并联合社区启动开源共建）。
+
+
+* 方舟分析器（ArkAnalyzer）:
+	面向ArkTS的OpenHarmony应用程序分析框架。
+
+* 方舟检测器（ArkCheck）:
+	面向OpenHarmony应用开发提供代码级缺陷自动检测（I期聚焦高性能编码规则的自动化检测）
+
+
+
+## SIG组成员
+
+
+### Leader
+
+- [lilicoding](https://gitcode.com/lilicoding)
+
+
+### 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)
+
+
+### 会议
+ - 会议时间：双周例会，周四晚上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)
+
+
+### Contact (optional)
+
+- 邮件列表：[dev@openharmony.io](https://lists.openatom.io/postorius/lists/dev@openharmony.io/)
+
+***

package/lib/Config.d.ts

@@ -13,6 +13,19 @@ export interface TsConfig {
         };
     };
 }
+/**
+ * Build a SceneConfig from a project directory and optional OHOS SDK home.
+ *
+ * SDK resolution order:
+ * 1) explicit `ohosSdkHome` (must contain at least one valid SDK directory:
+ *    `<ohosSdkHome>/openharmony/ets` or `<ohosSdkHome>/hms/ets`)
+ * 2) environment variable `OHOS_SDK_HOME`
+ *
+ * @param project Project root directory path.
+ * @param ohosSdkHome Optional OHOS SDK home path.
+ * @returns SceneConfig initialized with project files and discovered SDKs.
+ */
+export declare function buildSceneConfigFromProject(project: string, ohosSdkHome?: string): SceneConfig;
 export type SceneOptionsValue = string | number | boolean | (string | number)[] | string[] | null | undefined;
 export interface SceneOptions {
     supportFileExts?: string[];
@@ -33,7 +46,10 @@ export declare class SceneConfig {
     private sdkFiles;
     private sdkFilesMap;
     private projectFiles;
+    private includeDirs;
     private fileLanguages;
+    private ccjsonPath;
+    private cppAstPath;
     private options;
     constructor(options?: SceneOptions);
     getOptions(): SceneOptions;
@@ -51,6 +67,7 @@ export declare class SceneConfig {
      * targetProjectDirectory property of the sceneConfig object.
      * @param targetProjectDirectory - the target project directory, such as xxx/xxx/xxx, started from project
      *     directory.
+     * @param includeDirs - Header file directories that the CXX project depends on.
      * @example
      * 1. build a sceneConfig object.
     ```typescript
@@ -59,7 +76,7 @@ export declare class SceneConfig {
     sceneConfig.buildFromProjectDir(projectDir);
     ```
      */
-    buildFromProjectDir(targetProjectDirectory: string): void;
+    buildFromProjectDir(targetProjectDirectory: string, includeDirs?: string[]): void;
     buildFromProjectFiles(projectName: string, projectDir: string, filesAndDirectorys: string[], sdks?: Sdk[], languageTags?: Map<string, Language>): void;
     private processFilePaths;
     private setLanguageTagForFiles;
@@ -67,6 +84,20 @@ export declare class SceneConfig {
     getTargetProjectName(): string;
     getTargetProjectDirectory(): string;
     getProjectFiles(): string[];
+    /** Obtain the header file directories of the input C++ project dependencies. */
+    getIncludeDirs(): string[];
+    setCcjsonPath(ccjsonPath: string): void;
+    /**
+     * Returns compile_commands.json path configured by the project.
+     *
+     * If ccjson is not configured, this value is empty initially. Before AST generation,
+     * astUtils may auto-discover a compile database near source files (for DevEco projects
+     * that load compilation databases). The discovered path is used directly by Scene and is
+     * not backfilled into this config field.
+     */
+    getCcjsonPath(): string;
+    setCppAstPath(cppAstPath: string): void;
+    getCppAstPath(): string;
     getFileLanguages(): Map<string, Language>;
     getSdkFiles(): string[];
     getSdkFilesMap(): Map<string[], string>;

package/lib/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../src/Config.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAKhD,MAAM,WAAW,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE;YACJ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;SAC3B,CAAC;KACL,CAAC;CACL;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;AAC9G,MAAM,WAAW,YAAY;IACzB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACvC;AAID,qBAAa,WAAW;IACpB,OAAO,CAAC,iBAAiB,CAAc;IACvC,OAAO,CAAC,sBAAsB,CAAc;IAE5C,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,OAAO,CAAa;IAE5B,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAsD;IAEzE,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,aAAa,CAAoC;IAEzD,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,CAAC,EAAE,YAAY;IAK3B,UAAU,IAAI,YAAY;IAIjC;;;;;;;OAOG;IACI,WAAW,CAAC,iBAAiB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAUzH;;;;;;;;;;;;OAYG;IACI,mBAAmB,CAAC,sBAAsB,EAAE,MAAM,GAAG,IAAI;IAMzD,qBAAqB,CACxB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,MAAM,EAAE,EAC5B,IAAI,CAAC,EAAE,GAAG,EAAE,EACZ,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,GACrC,IAAI;IAgBP,OAAO,CAAC,gBAAgB;IAkBxB,OAAO,CAAC,sBAAsB;IAgBvB,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAiC3C,oBAAoB,IAAI,MAAM;IAI9B,yBAAyB,IAAI,MAAM;IAInC,eAAe,IAAI,MAAM,EAAE;IAI3B,gBAAgB,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC;IAIzC,WAAW,IAAI,MAAM,EAAE;IAIvB,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC;IAIvC,aAAa,IAAI,MAAM;IAIvB,UAAU,IAAI,GAAG,EAAE;IAI1B,OAAO,CAAC,oBAAoB;IAkB5B,OAAO,CAAC,iBAAiB;CAY5B"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../src/Config.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAKhD,MAAM,WAAW,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE;YACJ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;SAC3B,CAAC;KACL,CAAC;CACL;AAoBD;;;;;;;;;;;GAWG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAK9F;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;AAC9G,MAAM,WAAW,YAAY;IACzB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACvC;AAID,qBAAa,WAAW;IACpB,OAAO,CAAC,iBAAiB,CAAc;IACvC,OAAO,CAAC,sBAAsB,CAAc;IAE5C,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,OAAO,CAAa;IAE5B,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAsD;IAEzE,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,aAAa,CAAoC;IACzD,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,UAAU,CAAc;IAEhC,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,CAAC,EAAE,YAAY;IAM3B,UAAU,IAAI,YAAY;IAIjC;;;;;;;OAOG;IACI,WAAW,CAAC,iBAAiB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAUzH;;;;;;;;;;;;;OAaG;IACI,mBAAmB,CAAC,sBAAsB,EAAE,MAAM,EAAE,WAAW,GAAE,MAAM,EAAO,GAAG,IAAI;IAerF,qBAAqB,CACxB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,MAAM,EAAE,EAC5B,IAAI,CAAC,EAAE,GAAG,EAAE,EACZ,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,GACrC,IAAI;IAgBP,OAAO,CAAC,gBAAgB;IAkBxB,OAAO,CAAC,sBAAsB;IAgBvB,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAiC3C,oBAAoB,IAAI,MAAM;IAI9B,yBAAyB,IAAI,MAAM;IAInC,eAAe,IAAI,MAAM,EAAE;IAIlC,gFAAgF;IACzE,cAAc,IAAI,MAAM,EAAE;IAI1B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAI9C;;;;;;;OAOG;IACI,aAAa,IAAI,MAAM;IAIvB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,aAAa,IAAI,MAAM;IAIvB,gBAAgB,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC;IAIzC,WAAW,IAAI,MAAM,EAAE;IAIvB,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC;IAIvC,aAAa,IAAI,MAAM;IAIvB,UAAU,IAAI,GAAG,EAAE;IAI1B,OAAO,CAAC,oBAAoB;IAkB5B,OAAO,CAAC,iBAAiB;CAY5B"}