如何使用 libclang 找出成员函数是 const 还是 volatile？

Question

我有一个CXCursor 的实例CXCursor_CXXMethod。我想知道函数是const还是volatile，例如：

class Foo {
public:
    void bar() const;
    void baz() volatile;
    void qux() const volatile;
};

我在 libclang 的文档中找不到任何有用的东西。我尝试了 clang_isConstQualifiedType 和 clang_isVolatileQualifiedType，但这些似乎总是在 C++ 成员函数类型上返回 0。

Answer 1

我可以想到两种方法：

使用libclang 词法分析器

this SO answer 中出现的代码对我有用；它使用libclang 标记器将方法声明分开，然后记录方法括号之外的任何关键字。

它确实不访问代码的 AST，据我所知，它根本不涉及解析器。如果您确定您调查的代码是正确的 C++，我相信这种方法是安全的。

缺点：该解决方案似乎没有考虑预处理指令，因此必须首先处理代码（例如，通过cpp）。

示例代码（要解析的文件必须是程序的第一个参数，例如./a.out bla.cpp）：

#include "clang-c/Index.h"
#include <string>
#include <set>
#include <iostream>

std::string GetClangString(CXString str)
{
  const char* tmp = clang_getCString(str);
  if (tmp == NULL) {
    return "";
  } else {
    std::string translated = std::string(tmp);
    clang_disposeString(str);
    return translated;
  }
}

void GetMethodQualifiers(CXTranslationUnit translationUnit,
                         std::set<std::string>& qualifiers,
                         CXCursor cursor) {
  qualifiers.clear();

  CXSourceRange range = clang_getCursorExtent(cursor);
  CXToken* tokens;
  unsigned int numTokens;
  clang_tokenize(translationUnit, range, &tokens, &numTokens);

  bool insideBrackets = false;
  for (unsigned int i = 0; i < numTokens; i++) {
    std::string token = GetClangString(clang_getTokenSpelling(translationUnit, tokens[i]));
    if (token == "(") {
      insideBrackets = true;
    } else if (token == "{" || token == ";") {
      break;
    } else if (token == ")") {
      insideBrackets = false;
    } else if (clang_getTokenKind(tokens[i]) == CXToken_Keyword && 
             !insideBrackets) {
      qualifiers.insert(token);
    }
  }

  clang_disposeTokens(translationUnit, tokens, numTokens);
}

int main(int argc, char *argv[]) {
  CXIndex Index = clang_createIndex(0, 0);
  CXTranslationUnit TU = clang_parseTranslationUnit(Index, 0, 
          argv, argc, 0, 0, CXTranslationUnit_None);

  // Set the file you're interested in, and the code location:
  CXFile file = clang_getFile(TU, argv[1]);
  int line = 5;
  int column = 6;
  CXSourceLocation location = clang_getLocation(TU, file, line, column);
  CXCursor cursor = clang_getCursor(TU, location);

  std::set<std::string> qualifiers;
  GetMethodQualifiers(TU, qualifiers, cursor);

  for (std::set<std::string>::const_iterator i = qualifiers.begin(); i != qualifiers.end(); ++i) {
    std::cout << *i << std::endl;
  }

  clang_disposeTranslationUnit(TU);
  clang_disposeIndex(Index);
  return 0;
}

使用 libclang 的统一符号解析 (USR)

这种方法涉及使用解析器本身，并从 AST 中提取限定符信息。

优点：似乎适用于带有预处理器指令的代码，至少对于简单的情况。

缺点：我的解决方案解析了 USR，它是无证的，将来可能会改变。尽管如此，编写单元测试来防止这种情况仍然很容易。

看看$(CLANG_SRC)/tools/libclang/CIndexUSRs.cpp，它包含生成USR的代码，因此包含解析USR字符串所需的信息。具体来说，限定符部分的第 523-529 行（在从 www.llvm.org 下载的 LLVM 3.1 的源代码中）。

在某处添加以下函数：

void parseUsrString(const std::string& usrString, bool* isVolatile, bool* isConst, bool *isRestrict) {
  size_t bangLocation = usrString.find("#");
  if (bangLocation == std::string::npos || bangLocation == usrString.length() - 1) {
    *isVolatile = *isConst = *isRestrict = false;
    return;
  }
  bangLocation++;
  int x = usrString[bangLocation];

  *isConst = x & 0x1;
  *isVolatile = x & 0x4;
  *isRestrict = x & 0x2;
}

在main()，

CXString usr = clang_getCursorUSR(cursor);
const char *usr_string = clang_getCString(usr);
std::cout << usr_string << "\n";
bool isVolatile, isConst, isRestrict;
parseUsrString(usr_string, &isVolatile, &isConst, &isRestrict);
printf("restrict, volatile, const: %d %d %d\n", isRestrict, isVolatile, isConst);
clang_disposeString(usr);

在Foo::qux() 上运行来自

#define BLA const

class Foo {
public:
    void bar() const;
    void baz() volatile;
    void qux() BLA volatile;
};

产生预期的结果

c:@C@Foo@F@qux#5
restrict, volatile, const: 0 1 1

警告：您可能已经注意到 libclang 的源代码建议我的代码应该是 isVolatile = x & 0x2 而不是 0x4，因此您可能应该将 0x4 替换为 0x2。我的实现（OS X）可能已经替换了它们。