Clang工具

为了第一个测试项目，创建一个简单的Clang工具，该工具运行编译器，并检查提供的源文件的语法。先创建一个所谓的树外LLVM项目，即一个将使用LLVM但位于主LLVM源树外的项目。

创建项目需要执行以下几项操作：

• 必须构建和安装所需的LLVM库和头文件

• 需要为测试项目创建一个构建配置文件

• 使用LLVM的源代码必须创建

从第一步开始，安装Clang支持库和头文件。使用以下CMake配置命令：

这里只启用了一个项目：clang。所有其他选项都是我们调试构建的标准配置。该命令必须从LLVM源树中创建的构建文件夹中运行。

使用动态库的配置，除了减少大小外，还有简化依赖项指定的优点。只需要指定项目直接依赖的动态库，动态链接器将处理其余部分。

所需的库和头文件可以通过以下命令安装：

库和头文件将安装到通过CMAKE_INSTALL_PREFIX选项指定的文件夹中。

再为项目创建两个文件：

• CMakeLists.txt: 项目配置文件

• TestProject.cpp: 项目源代码

项目配置文件，CMakeLists.txt，将通过LLVM_HOME环境变量接受LLVM安装文件夹的路径。该文件如下所示：

• 第2行：指定了项目名称（syntax-check）。这也是可执行文件的名称。

• 第4-7行：测试LLVM_HOME环境变量。

• 第10行：设置了LLVM CMake帮助器的路径。

• 第11行：从第10行指定的路径加载LLVM CMake包。

• 第14行：指定了编译的源文件。

• 第16行：设置了相应的编译标志：-fno-rtti。当LLVM没有构建RTTI时，为了减少代码和可执行文件大小
  ¹，这个标志是必需的。

• 第18-22行：指定要链接到我们程序的必需库

工具源码如下：

• 第7-9行：大多数编译器工具都有一套相同的命令行参数。LLVM命令行库 ²
  提供了一些API来处理编译器命令选项。第7行设置了该库，在第8-10行设置了相应的帮助信息。

• 第13-18行：解析命令行参数。

• 第19-24行：创建并运行Clang工具。

• 第22-23行：使用clang::SyntaxOnlyAction前端动作，将在输入文件上运行语法和语义检查。

必须指定LLVM安装文件夹的路径来构建工具。如之前所述，路径必须通过LLVM_HOME环境变量指定。配置命令（见图1.12）将路径指定为LLVM项目源树中的安装文件夹，所以可以按照以下方式构建工具：

可以按照以下方式运行工具：

如果在一个C++源文件上运行程序，它将直接退出；但在一个有语法错误的C++文件上运行，会产生错误消息：

以syntax-check为主程序，将main.cpp源文件作为工具的参数（图1.18）。还可以向syntax-check可执行文件传递编译标志(-std=c++17)。

可以设置断点，并按照以下方式运行程序：

在clang::ParseAST函数中设置了一个断点（图1.19，第1行）。该函数是源代码解析的主要入口点。第3行运行程序，并在第16行继续执行断点后的程序。

本书的后续章节中，将使用相同的调试技术来研究Clang的源码。