[libclang/python] Add bindings for children of diagnostics

[hansonw]

Summary

This exposes the Clang API bindings clang_getChildDiagnostics (which returns a CXDiagnosticSet) and clang_getNumDiagnosticsInSet / clang_getDiagnosticInSet (to traverse the CXDiagnosticSet), and adds a helper children property in the Python Diagnostic wrapper.

Also, this adds the missing OVERLOAD_CANDIDATE (700) cursor type.

[hansonw]

Rebase

[hansonw]

Adding you guys since you reviewed some recent changes :)

[compnerd]

bindings/python/clang/cindex.py

369

Why does this need the explicit int construction?

[hansonw]

Thanks! I don't have commit permissions; could you check this in for me?

bindings/python/clang/cindex.py

369

This returns a long on 64-bit systems - however __len__ must return a plain int.

[compnerd]

Committed as SVN r268167. Thanks for the patch!

bindings/python/clang/cindex.py

def fixits(self):
                 if len(value) == 0:
                     raise IndexError
 
                 return FixIt(range, value)
 
         return FixItIterator(self)
 
     @property
+    def children(self):
+        class ChildDiagnosticsIterator:
+            def __init__(self, diag):
+                self.diag_set = conf.lib.clang_getChildDiagnostics(diag)
+
+            def __len__(self):
+                return int(conf.lib.clang_getNumDiagnosticsInSet(self.diag_set))
+
+            def __getitem__(self, key):
+                diag = conf.lib.clang_getDiagnosticInSet(self.diag_set, key)
+                if not diag:
+                    raise IndexError
+                return Diagnostic(diag)
+
+        return ChildDiagnosticsIterator(self)
+
+    @property
     def category_number(self):
         """The category number for this diagnostic or 0 if unavailable."""
         return conf.lib.clang_getDiagnosticCategory(self)
 
     @property
     def category_name(self):
         """The string name of the category for this diagnostic."""
         return conf.lib.clang_getDiagnosticCategoryText(self)

 ###
 # Extra declaration
 
 # A module import declaration.
 CursorKind.MODULE_IMPORT_DECL = CursorKind(600)
 # A type alias template declaration
 CursorKind.TYPE_ALIAS_TEMPLATE_DECL = CursorKind(601)
 
+# A code completion overload candidate.
+CursorKind.OVERLOAD_CANDIDATE = CursorKind(700)
+
 ### Template Argument Kinds ###
 class TemplateArgumentKind(BaseEnumeration):
     """
     A TemplateArgumentKind describes the kind of entity that a template argument
     represents.
     """
 
     # The required BaseEnumeration declarations.
#  [CXTUResourceUsage]),
    Cursor,
    Cursor.from_cursor_result),
 
   ("clang_getCanonicalType",
    [Type],
    Type,
    Type.from_result),
 
+  ("clang_getChildDiagnostics",
+   [Diagnostic],
+   c_object_p),
+
   ("clang_getCompletionAvailability",
    [c_void_p],
    c_int),
 
   ("clang_getCompletionBriefComment",
    [c_void_p],
    _CXString),
 
#  CXTUResourceUsage),
    _CXString,
    _CXString.from_result),
 
   ("clang_getDiagnosticFixIt",
    [Diagnostic, c_uint, POINTER(SourceRange)],
    _CXString,
    _CXString.from_result),
 
+  ("clang_getDiagnosticInSet",
+   [c_object_p, c_uint],
+   c_object_p),
+
   ("clang_getDiagnosticLocation",
    [Diagnostic],
    SourceLocation),
 
   ("clang_getDiagnosticNumFixIts",
    [Diagnostic],
    c_uint),
 
#  CXTUResourceUsage),
   ("clang_getNumCompletionChunks",
    [c_void_p],
    c_int),
 
   ("clang_getNumDiagnostics",
    [c_object_p],
    c_uint),
 
+  ("clang_getNumDiagnosticsInSet",
+   [c_object_p],
+   c_uint),
+
   ("clang_getNumElements",
    [Type],
    c_longlong),
 
   ("clang_getNumOverloadedDecls",
    [Cursor],
    c_uint),
 

bindings/python/tests/cindex/test_diagnostics.py

 def test_diagnostic_option():
     """Ensure that category option properties work."""
     tu = get_tu('int f(int i) { return 7; }', all_warnings=True)
     assert len(tu.diagnostics) == 1
     d = tu.diagnostics[0]
 
     assert d.option == '-Wunused-parameter'
     assert d.disable_option == '-Wno-unused-parameter'
+
+def test_diagnostic_children():
+    tu = get_tu('void f(int x) {} void g() { f(); }')
+    assert len(tu.diagnostics) == 1
+    d = tu.diagnostics[0]
+
+    children = d.children
+    assert len(children) == 1
+    assert children[0].severity == Diagnostic.Note
+    assert children[0].spelling.endswith('declared here')
+    assert children[0].location.line == 1
+    assert children[0].location.column == 1