如何使用clang python绑定获取类方法定义?

时间:2016-05-20 02:09:33

标签: python c++ parsing clang abstract-syntax-tree

给出以下C ++文件:

class Foo
{
public:
  Foo();

  void bar(int input);

  void another(int input, double & output);
};

void
Foo::bar(int input)
{
  input += 1;
}

void
Foo::another(int input, double & output)
{
  input += 1;
  output = input * 1.2345;
}

如何利用clang python绑定来提取两种方法的定义。我可以使用下面的python脚本获取类声明,但我似乎无法弄清楚如何提取完整的方法。例如,我想要这些信息:

void
Foo::another(int input, double & output)
{
  input += 1;
  output = input * 1.2345;
}

Python脚本:

#!/usr/bin/env python
import clang.cindex
clang.cindex.Config.set_library_path('/opt/moose/llvm-3.7.0/lib')

def getCursors(cursor, output, kind):
    """
    Recursively extract all the cursors of the given kind.
    """
    for c in cursor.get_children():
        if c.kind == kind:
            output.append(c)
        getCursors(c, output, kind)

if __name__ == '__main__':

    # Parse the test file
    index = clang.cindex.Index.create()
    tu = index.parse('method.C', ['-x', 'c++'])

    # Extract the parsers
    output = []
    getCursors(tu.cursor, output, clang.cindex.CursorKind.CXX_METHOD)

    # Print the method declarations (How to I get the definitions?)
    for c in output:
        defn = c.get_definition() # Gives nothing
        print defn 
        print c.extent.start.file, c.extent.start.line, c.extent.end.line # Gives decleration

关注:

以下功能被建议作为解决方案,但它对于clang 3.7并不起作用。在发布之前我无法更新到3.9,我需要支持最新的两个版本的clang(3.7和3.8)。如果添加print语句,则结果表明未找到定义。

def method_definitions(cursor):
    for i in cursor.walk_preorder():
        print i.kind, i.is_definition() # Added this
        if i.kind != CursorKind.CXX_METHOD:
            continue
        if not i.is_definition():
            continue
        yield i

运行该方法产生以下结果,任何人都知道clang 3.7和3.9之间发生了什么变化?

CursorKind.TRANSLATION_UNIT False
CursorKind.CLASS_DECL True
CursorKind.CXX_ACCESS_SPEC_DECL True
CursorKind.CONSTRUCTOR False
CursorKind.CXX_METHOD False
CursorKind.PARM_DECL True
CursorKind.CXX_METHOD False
CursorKind.PARM_DECL True
CursorKind.PARM_DECL True

1 个答案:

答案 0 :(得分:1)

你非常接近 - 诀窍是使用光标偏移而不是行/列,而AFAIK,libclang不公开源的字节,所以你需要自己阅读文本。

以下测试:

  • Clang由Xcode 7.3(7D175)提供 - OSX Apple LLVM版本7.3.0(clang-703.0.29)和pip安装的绑定来自pypi(pip install 'clang==3.7'
  • Ubuntu clang version 3.7.1-svn253742-1~exp1(branches / release_37)(基于LLVM 3.7.1)
  • Ubuntu clang version 3.6.2-svn240577-1~exp1(branches / release_36)(基于LLVM 3.6.2)
  • clang version 3.9.0-svn267343-1~exp1(trunk)

唯一需要注意的是,对于带有宏/标题YMMV的更复杂的情况。

import clang.cindex
from clang.cindex import *

def method_definitions(cursor):
    for i in cursor.walk_preorder():
        if i.kind != CursorKind.CXX_METHOD:
            continue
        if not i.is_definition():
            continue
        yield i

def extract_definition(cursor):
    filename = cursor.location.file.name
    with open(filename, 'r') as fh:
        contents = fh.read()
    return contents[cursor.extent.start.offset: cursor.extent.end.offset]

idx = Index.create()
tu = idx.parse('method.C', ['-x', 'c++'])
defns = method_definitions(tu.cursor)
for defn in defns:
    print extract_definition(defn)

给出了:

void
Foo::bar(int input)
{
      input += 1;
}
void
Foo::another(int input, double & output)
{
      input += 1;
        output = input * 1.2345;
}