基于clang libTooling的C函数式宏扩展集成问题

核心思路 #

直接绕开Clang原生预处理器的宏处理流程，用Boost.Wave完成全量宏扩展后，将处理后的源码直接喂给Clang的AST分析阶段，彻底解决嵌套宏、函数式宏参数未展开等复杂场景下的实现难题。同时适配你现有MacroExpander类的非宏预处理逻辑，最终对接RecursiveASTVisitor完成插桩。

分步实现方案 #

1. 拆分Clang编译流程，替换预处理阶段

自定义FrontendAction，跳过Clang原生预处理，用Boost.Wave的结果直接构建AST：

#include "clang/AST/ASTConsumer.h"
#include "clang/AST/ASTFrontendAction.h"
#include "clang/Frontend/CompilerInstance.h"
#include "boost/wave.hpp"
#include "boost/wave/cpplexer/cpp_lex_token.hpp"
#include "boost/wave/cpplexer/cpp_lex_iterator.hpp"

class CustomASTAction : public clang::ASTFrontendAction {
public:
    std::unique_ptr<clang::ASTConsumer> CreateASTConsumer(clang::CompilerInstance& CI, llvm::StringRef InFile) override {
        return std::make_unique<MyASTConsumer>(CI.getRewriter());
    }

    bool BeginSourceFileAction(clang::CompilerInstance& CI) override {
        const auto& mainFile = CI.getSourceManager().getFileEntryForID(CI.getSourceManager().getMainFileID());
        std::vector<std::string> includeDirs;
        // 同步Clang的包含目录配置
        for (const auto& entry : CI.getHeaderSearchOpts().UserEntries) {
            includeDirs.push_back(entry.Path);
        }

        // 用Boost.Wave完成宏扩展
        std::string expandedCode = expandMacros(mainFile->getName().str(), includeDirs);
        
        // 替换Clang的原始文件内容为扩展后代码
        llvm::MemoryBufferRef buffer(llvm::StringRef(expandedCode), mainFile->getName());
        CI.getSourceManager().overrideFileContents(CI.getSourceManager().getMainFileID(), buffer);
        
        // 初始化Rewriter
        CI.getRewriter().setSourceMgr(CI.getSourceManager(), CI.getLangOpts());
        return true;
    }

private:
    std::string expandMacros(const std::string& filePath, const std::vector<std::string>& includeDirs) {
        using namespace boost::wave;
        typedef cpplexer::lex_token<> token_type;
        typedef cpplexer::lex_iterator<token_type> lex_iter_type;
        typedef context<std::string::iterator, lex_iter_type> context_type;

        std::ifstream file(filePath);
        std::string source((std::istreambuf_iterator<char>(file)), std::istreambuf_iterator<char>());

        context_type ctx(source.begin(), source.end(), filePath.c_str());
        // 配置与Clang兼容的宏扩展规则（比如C99标准、保留注释）
        ctx.set_language(language_support::c99 | language_support::keep_comments);
        for (const auto& dir : includeDirs) {
            ctx.add_include_path(dir);
        }

        std::string result;
        auto iter = ctx.begin();
        auto end = ctx.end();
        while (iter != end) {
            result += (*iter).get_value();
            ++iter;
        }
        return result;
    }
};

2. 适配现有MacroExpander类逻辑

如果你的MacroExpander中除了宏扩展，还有其他预处理逻辑（如#include路径校验、自定义pragma处理）：

• 将宏扩展相关代码全部移除，保留非宏逻辑
• 把自定义预处理逻辑迁移到Boost.Wave的钩子中：比如继承boost::wave::context，重写on_include_directive等方法，替代原MacroExpander中对应的PPCallbacks回调

3. 对接RecursiveASTVisitor完成插桩

实现标准的ASTConsumer和Visitor，基于扩展后的源码进行插桩改写：

class MyASTVisitor : public clang::RecursiveASTVisitor<MyASTVisitor> {
private:
    clang::Rewriter& Rewriter;
public:
    explicit MyASTVisitor(clang::Rewriter& R) : Rewriter(R) {}

    bool VisitFunctionDecl(clang::FunctionDecl* FD) {
        // 示例：在函数定义开头插入日志代码
        if (FD->isThisDeclarationADefinition()) {
            clang::SourceLocation insertLoc = FD->getBody()->getBeginLoc();
            std::string logCode = "printf(\"Entered function: %s\\n\", \"" + std::string(FD->getName()) + "\");\n";
            Rewriter.InsertText(insertLoc, logCode);
        }
        return true;
    }
};

class MyASTConsumer : public clang::ASTConsumer {
private:
    MyASTVisitor Visitor;
public:
    explicit MyASTConsumer(clang::Rewriter& R) : Visitor(R) {}

    void HandleTranslationUnit(clang::ASTContext& Context) override {
        Visitor.TraverseDecl(Context.getTranslationUnitDecl());
        // 输出改写后的代码
        Visitor.Rewriter.getEditBuffer(Visitor.RewritergetSourceMgr().getMainFileID()).write(llvm::outs());
    }
};

4. 关键注意事项

• 兼容Clang的宏行为：Boost.Wave的语言配置必须与Clang编译参数严格一致（如C标准、GNU扩展开关），避免宏扩展结果差异导致AST分析错误
• 位置信息映射：如果需要保留原始代码的行号用于错误提示，可通过Boost.Wave的token_position接口记录原始位置，在Rewriter中做映射
• 预处理指令处理：对于#pragma等非宏预处理指令，需配置Boost.Wave保留对应token，确保Clang后续阶段能正确识别

内容的提问来源于stack exchange，提问作者johnco3