在 libclang (Python) 中查找特定函数声明的所有引用

Question

在 Python 中通过 libclang 解析 C++ 源文件时，我试图查找（行和列位置）特定函数声明的所有引用。

例如：

#include <iostream>
using namespace std;

int addition (int a, int b)
{
  int r;
  r=a+b;
  return r;
}

int main ()
{
  int z, q;
  z = addition (5,3);
  q = addition (5,5);
  cout << "The first result is " << z;
  cout << "The second result is " << q;
}

因此，对于上面的源文件，我希望在第 5 行中为 addition 的函数声明，我希望 find_all_function_decl_references（见下文）在第 15 行和第 16 行返回 addition 的引用.

我试过这个（改编自here）

import clang.cindex
import ccsyspath

index = clang.cindex.Index.create()
translation_unit = index.parse(filename, args=args)

for node in translation_unit.cursor.walk_preorder():
    node_definition = node.get_definition()

    if node.location.file is None:
        continue
    if node.location.file.name != sourcefile:
        continue
    if node_def is None:
        pass
    if node.kind.name == 'FUNCTION_DECL':
        if node.kind.is_reference():
          find_all_function_decl_references(node_definition.displayname)  # TODO

另一种方法是存储在列表中找到的所有函数声明，并在每个函数上运行find_all_function_decl_references 方法。

有没有人知道如何解决这个问题？这个find_all_function_decl_references 方法会怎么样？ （我是 libclang 和 Python 的新手。）

我已经看到this def find_typerefs 在其中找到对某种类型的所有引用，但我不确定如何根据我的需要实现它。

理想情况下，我希望能够获取任何声明的所有引用；不仅是函数，还有变量声明、参数声明（例如上面第 7 行示例中的 a 和 b）、类声明等。

编辑 在Andrew's 评论之后，这里有一些关于我的设置规范的详细信息：

• LLVM 3.8.0-win64
• libclang-py3 3.8.1
• Python3.5.1（在 Windows 中，我假设是 CPython）
• 对于args，我尝试了答案here 中建议的方法和another 答案中建议的方法。

*请注意，鉴于我的编程经验很少，我希望能得到一个简单解释其工作原理的答案。

Answer 1

真正使这个问题具有挑战性的是 C++ 的复杂性。

考虑 C++ 中可调用的内容：函数、lambda、函数调用运算符、成员函数、模板函数和成员模板函数。因此，在仅匹配调用表达式的情况下，您需要能够消除这些情况的歧义。

此外，libclang 不提供 clang AST 的完美视图（一些节点没有完全暴露，尤其是一些与模板相关的节点）。因此，任意代码片段有可能（甚至很可能）包含一些构造，其中 AST 的 libclangs 视图不足以将调用表达式与声明相关联。

但是，如果您准备将自己限制在语言的一个子集上，则可能会取得一些进展 - 例如，以下示例尝试将调用站点与函数声明相关联。它通过使用调用表达式对 AST 匹配函数声明中的所有节点进行单次传递来实现这一点。

from clang.cindex import *

def is_function_call(funcdecl, c):
    """ Determine where a call-expression cursor refers to a particular function declaration
    """
    defn = c.get_definition()
    return (defn is not None) and (defn == funcdecl)

def fully_qualified(c):
    """ Retrieve a fully qualified function name (with namespaces)
    """
    res = c.spelling
    c = c.semantic_parent
    while c.kind != CursorKind.TRANSLATION_UNIT:
        res = c.spelling + '::' + res
        c = c.semantic_parent
    return res

def find_funcs_and_calls(tu):
    """ Retrieve lists of function declarations and call expressions in a translation unit
    """
    filename = tu.cursor.spelling
    calls = []
    funcs = []
    for c in tu.cursor.walk_preorder():
        if c.location.file is None:
            pass
        elif c.location.file.name != filename:
            pass
        elif c.kind == CursorKind.CALL_EXPR:
            calls.append(c)
        elif c.kind == CursorKind.FUNCTION_DECL:
            funcs.append(c)
    return funcs, calls

idx = Index.create()
args =  '-x c++ --std=c++11'.split()
tu = idx.parse('tmp.cpp', args=args)
funcs, calls = find_funcs_and_calls(tu)
for f in funcs:
    print(fully_qualified(f), f.location)
    for c in calls:
        if is_function_call(f, c):
            print('-', c)
    print()

为了展示它的效果如何，您需要一个更具挑战性的示例来解析：

// tmp.cpp
#include <iostream>
using namespace std;

namespace impl {
    int addition(int x, int y) {
        return x + y;
    }

    void f() {
        addition(2, 3);
    }
}

int addition (int a, int b) {
  int r;
  r=a+b;
  return r;
}

int main () {
  int z, q;
  z = addition (5,3);
  q = addition (5,5);
  cout << "The first result is " << z;
  cout << "The second result is " << q;
}

我得到了输出：

impl::addition
- <SourceLocation file 'tmp.cpp', line 10, column 9>

impl::f

addition
- <SourceLocation file 'tmp.cpp', line 22, column 7>
- <SourceLocation file 'tmp.cpp', line 23, column 7>

main

扩大规模以考虑更多类型的声明（IMO）将是不平凡的，并且本身就是一个有趣的项目。

寻址 cmets

鉴于有一些关于此答案中的代码是否产生我提供的结果的问题，我添加了一个gist of the code（重现了这个问题的内容）和一个非常小的vagrant@987654323 @ 你可以用来试验。机器启动后，您可以克隆 gist，并使用以下命令重现答案：

git clone https://gist.github.com/AndrewWalker/daa2af23f34fe9a6acc2de579ec45535 find-func-decl-refs
cd find-func-decl-refs
export LD_LIBRARY_PATH=/usr/lib/llvm-3.8/lib/ && python3 main.py