使用clang获取类中的方法列表

时间:2014-02-19 10:49:56

标签: c++ parsing clang code-inspection outliner

在常见的IDE(选择一个)中,您经常会有一个大纲视图,显示特定类的方法列表。

假设我在IFoo.h中有一个C ++接口类,如下所示:

#ifndef IFOO_H_
#define IFOO_H_
class IFoo { 
    public:
        virtual ~IFoo() {}
        virtual void bar() = 0;
};
#endif

如何(以编程方式)我可以使用clang库获取上面IFoo.h文件的IDE大纲列表?首先,如果我能得到函数名称列表,将会有所帮助。

我特意打算使用clang,所以任何有关如何用clang分析我的头文件的帮助都会非常感激。

与此同时,我将在此处查看铿锵教程:https://github.com/loarabia/Clang-tutorial

提前感谢您的帮助。

1 个答案:

答案 0 :(得分:14)

我浏览了这个教程http://clang.llvm.org/docs/LibASTMatchersTutorial.html并在那里找到了一些非常有用的东西,这就是我提出的:

我必须将我的文件从IFoo.h重命名为IFoo.hpp才能被检测为Cxx,而不是C代码。

我必须用-x c++调用我的程序才能将IFoo.h文件识别为C ++代码而不是C代码(clang默认将*.h文件解释为C:

~/Development/llvm-build/bin/mytool ~/IFoo.h -- -x c++

这是我从提供的类中转储所有虚函数的代码:

// Declares clang::SyntaxOnlyAction.
#include "clang/Frontend/FrontendActions.h"
#include "clang/Tooling/CommonOptionsParser.h"
#include "clang/Tooling/Tooling.h"
#include "clang/ASTMatchers/ASTMatchers.h"
// Declares llvm::cl::extrahelp.
#include "llvm/Support/CommandLine.h"

#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"

#include <cstdio>

using namespace clang;
using namespace clang::ast_matchers;
using namespace clang::tooling;
using namespace llvm;

DeclarationMatcher methodMatcher = methodDecl(isVirtual()).bind("methods");

class MethodPrinter : public MatchFinder::MatchCallback {
public :
  virtual void run(const MatchFinder::MatchResult &Result) {
    if (const CXXMethodDecl *md = Result.Nodes.getNodeAs<clang::CXXMethodDecl>("methods")) {    
      md->dump();
    }
  }
};

// CommonOptionsParser declares HelpMessage with a description of the common
// command-line options related to the compilation database and input files.
// It's nice to have this help message in all tools.
static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage);

// A help message for this specific tool can be added afterwards.
static cl::extrahelp MoreHelp("\nMore help text...");

int main(int argc, const char **argv) {    
  cl::OptionCategory cat("myname", "mydescription");
  CommonOptionsParser optionsParser(argc, argv, cat, 0);    

  ClangTool tool(optionsParser.getCompilations(), optionsParser.getSourcePathList());

  MethodPrinter printer;
  MatchFinder finder;
  finder.addMatcher(methodMatcher, &printer);
  return tool.run(newFrontendActionFactory(&finder));
}

传递IFoo.h文件时输出如下:

CXXDestructorDecl 0x1709c30 <~/IFoo.h:5:3, col:20> ~IFoo 'void (void)' virtual
`-CompoundStmt 0x1758128 <col:19, col:20>
CXXMethodDecl 0x1757e60 <~/IFoo.h:6:3, col:24> bar 'void (void)' virtual pure