cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug
-DCMAKE_INSTALL_PREFIX=../install -DLLVM_TARGETS_TO_BUILD="X86"
-DLLVM_ENABLE_PROJECTS="clang" -DLLVM_USE_SPLIT_DWARF=ON
-DBUILD_SHARED_LIBS=ON ../llvm

$`ninja install
\end{shell}

完成了clang的构建和安装，就可以继续编写项目的CMakeLists.txt文件。

\mySubsubsection{4.6.2.}{插件的CMake构建配置}

使用图3.20作为我们的插件构建配置的基础，更改项目名称为classchecker，而ClassComplexityChecker.cpp将作为主要源文件。文件的主要部分如图4.32所示。如图所示，将构建一个动态库（第18-20行），而不是之前的测试项目中的可执行文件。另一个修改是在第12行，设置了一个配置参数来定位LLVM构建文件夹。这个参数是必要的，以便找到LIT可执行文件，正如之前在第4.5.2节，LLVM测试框架中提到的，LIT可执行文件不包括在标准安装过程中。为了支持LIT测试的调用，还需要进行一些修改，但会稍后在图4.44中讨论这些。

\begin{cmake}
message(STATUS "$LLVM_HOME found: $ENV{LLVM_HOME}")
set(LLVM_HOME$ENVLLVM_HOME CACHE PATH "Root of LLVM installation") set(LLVM_LIB ${LLVM_HOME}/lib)
set(LLVM_DIR$LLVM_LIB/cmake/llvm) set(LLVM_BUILD $ENV{LLVM_BUILD} CACHE PATH "Root of LLVM build")
find_package(LLVM REQUIRED CONFIG)
include_directories($LLVM_INCLUDE_DIRS) link_directories(${LLVM_LIBRARY_DIRS})

Add the plugin's shared library target

add_library(classchecker MODULE
ClassChecker.cpp
)
set_target_properties(classchecker PROPERTIES COMPILE_FLAGS "-fno-rtti")
target_link_libraries(classchecker
LLVMSupport
clangAST
clangBasic
clangFrontend
clangTooling
)
\end{cmake}

\begin{center}
图4.32：class complexity插件的CMakeLists.txt文件
\end{center}

完成构建配置后，可以开始编写插件的主要代码。将创建的第一个组件是一个递归访问者类，名为ClassVisitor。

\mySubsubsection{4.6.3.}{递归访问者类}

访问者类位于ClassVisitor.hpp文件中（见图4.33），这是一个递归访问者，处理clang::CXXRecordDecl，这是C++类声明的AST节点。第13-16行计算方法的数量，并在超过阈值时在第19-25行发出诊断信息。

\begin{cpp}
#include "clang/AST/ASTContext.h"
#include "clang/AST/RecursiveASTVisitor.h"

namespace clangbook {
namespace classchecker {
class ClassVisitor : public clang::RecursiveASTVisitor {
public:
explicit ClassVisitor(clang::ASTContext *C, int T)
: Context(C), Threshold(T) {}

bool VisitCXXRecordDecl(clang::CXXRecordDecl *Declaration) {
if (Declaration->isThisDeclarationADefinition()) {
int MethodCount = 0;
for (const auto *M : Declaration->methods()) {
MethodCount++;
}
if (MethodCount > Threshold) {
clang::DiagnosticsEngine &D = Context->getDiagnostics();
unsigned DiagID =
D.getCustomDiagID(clang::DiagnosticsEngine::Warning,
"class %0 is too complex: method count = %1");
clang::DiagnosticBuilder DiagBuilder =
              D.Report(Declaration->getLocation(), DiagID);
DiagBuilder << Declaration->getName() << MethodCount;
}
}
return true;
}

private:
 clang::ASTContext *Context;
int Threshold;
};
} // namespace classchecker
} // namespace clangbook
\end{cpp}

\begin{center}
图4.33：ClassVisitor.hpp的源代码
\end{center}

诊断消息在行20-22中构建，诊断消息接受两个参数：类名和类的函数数量。这些参数在第22行以'%1'和'%2'占位符编码。这些参数的实际值在第25行传递，使用DiagBuild对象构建诊断消息。这个对象是clang::DiagnosticBuilder类的实例，实现了资源获取即初始化（RAII）模式。当对象超出作用域时，会自动调用其析构函数，并在此时发出实际的诊断信息。

\begin{myNotic}{重要提示}
C++中，RAII原则是一种常见的习惯用法，用于通过将资源与对象的生存期联系起来来管理资源生命周期。当对象超出作用域时，其析构函数会自动调用，这为释放对象持有的资源提供了机会。
\end{myNotic}

ClassVisitor是在AST消费者类中创建的，这是我们的下一个主题。

\mySubsubsection{4.6.4.}{插件AST消费者类}

AST消费者类在ClassConsumer.hpp中实现，并在我们的AST访问者测试项目中代表标准AST消费者（参见图3.9）。代码在图4.35中展示。

\begin{cpp}
namespace clangbook {
namespace classchecker {
class ClassConsumer : public clang::ASTConsumer {
public:
explicit ClassConsumer(clang::ASTContext *Context, int Threshold)
: Visitor(Context, Threshold) {}

virtual void HandleTranslationUnit(clang::ASTContext &Context) {
Visitor.TraverseDecl(Context.getTranslationUnitDecl());
}

private:
ClassVisitor Visitor;
};
} // namespace classchecker
} // namespace clangbook
\end{cpp}

\begin{center}
图4.34：ClassConsumer.hpp的源代码
\end{center}

代码在第10行初始化Visitor，并在第13行使用Visitor类遍历声明，从最顶层的声明（翻译单元声明）开始。消费者必须从特殊的AST动作类创建，这是我们接下来要讨论的。

\mySubsubsection{4.6.5.}{插件AST动作类}

插件AST动作的代码如图4.35所示：

\begin{itemize}
\item
第7行：从clang::PluginASTAction派生ClassAction。

\item
第10-13行：实例化ClassConsumer并利用MethodCountThreshold，这是从可选插件参数派生的。

\item
第15-25行：处理插件的可选阈值参数
\end{itemize}

\begin{cpp}
namespace clangbook {
namespace classchecker {
class ClassAction : public clang::PluginASTAction {
protected:
std::unique_ptrclang::ASTConsumer
CreateASTConsumer(clang::CompilerInstance &CI, llvm::StringRef) {
return std::make_unique(&CI.getASTContext(),
MethodCountThreshold);
}

bool ParseArgs(const clang::CompilerInstance &CI,
const std::vectorstd::string &args) {
for (const auto &arg : args) {
if (arg.substr(0, 9) == "threshold") {
auto valueStr = arg.substr(10); // Get the substring after "threshold="
MethodCountThreshold = std::stoi(valueStr);
return true;
}
}
return true;
}
ActionType getActionType() { return AddAfterMainAction; }

private:
int MethodCountThreshold = 5; // default value
};
} // namespace classchecker
} // namespace clangbook
\end{cpp}

\begin{center}
图4.35：ClassAction.hpp的源代码
\end{center}

我们几乎完成了，并准备初始化插件。

\mySubsubsection{4.6.6.}{插件代码}

插件注册在ClassChecker.cpp文件中，如图4.36所示。

\begin{cpp}
#include "clang/Frontend/FrontendPluginRegistry.h"

#include "ClassAction.hpp"

static clang::FrontendPluginRegistry::Addclangbook::classchecker::ClassAction
X("classchecker", "Checks the complexity of C++ classes");
\end{cpp}

\begin{center}
图4.36：ClassChecker.cpp的源代码
\end{center}

大多数初始化都隐藏在辅助类中，只需要将实现传递给lang::FrontendPluginRegistry::Add。

现在准备构建和测试我们的Clang插件。

\mySubsubsection{4.6.7.}{构建和运行插件代码}

需要指定LLVM项目的安装文件夹的路径。其余的步骤是之前使用过的标准步骤，见图3.11：

\begin{shell}
export LLVM_HOME=<...>/llvm-project/install
mkdir build
cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug ..
ninja classchecker
\end{shell}

\begin{center}
图4.37：为Clang插件配置和构建命令
\end{center}

构建工件将位于build文件夹中。然后，可以像以下这样在测试文件上运行插件，其中是要编译的文件路径：

\begin{shell}`$ <...>/llvm-project/install/bin/clang -fsyntax-only
 -fplugin=./build/libclasschecker.so  <filepath>

xport LLVM_BUILD=<...>/llvm-project/build export
LLVM_HOME=<...>/llvm-project/install rm -rf build; mkdir build; cd
build cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug .. ninja classchecker
ninja check-classchecker

... [2/2] Linking CXX shared module libclasschecker.so [0/1] Running
lit tests for classchecker clang plugin – Testing: 1 tests, 1 workers –
PASS: classchecker :: simple_test.cpp (1 of 1)

Testing Time: 0.12s Passed: 1