1import ctypes
2import gc
3import unittest
4
5from clang.cindex import AvailabilityKind
6from clang.cindex import CursorKind
7from clang.cindex import TemplateArgumentKind
8from clang.cindex import TranslationUnit
9from clang.cindex import TypeKind
10from .util import get_cursor
11from .util import get_cursors
12from .util import get_tu
13
14
15kInput = """\
16struct s0 {
17  int a;
18  int b;
19};
20
21struct s1;
22
23void f0(int a0, int a1) {
24  int l0, l1;
25
26  if (a0)
27    return;
28
29  for (;;) {
30    break;
31  }
32}
33"""
34
35kParentTest = """\
36        class C {
37            void f();
38        }
39
40        void C::f() { }
41    """
42
43kTemplateArgTest = """\
44        template <int kInt, typename T, bool kBool>
45        void foo();
46
47        template<>
48        void foo<-7, float, true>();
49    """
50
51class TestCursor(unittest.TestCase):
52    def test_get_children(self):
53        tu = get_tu(kInput)
54
55        it = tu.cursor.get_children()
56        tu_nodes = list(it)
57
58        self.assertEqual(len(tu_nodes), 3)
59        for cursor in tu_nodes:
60            self.assertIsNotNone(cursor.translation_unit)
61
62        self.assertNotEqual(tu_nodes[0], tu_nodes[1])
63        self.assertEqual(tu_nodes[0].kind, CursorKind.STRUCT_DECL)
64        self.assertEqual(tu_nodes[0].spelling, 's0')
65        self.assertEqual(tu_nodes[0].is_definition(), True)
66        self.assertEqual(tu_nodes[0].location.file.name, 't.c')
67        self.assertEqual(tu_nodes[0].location.line, 1)
68        self.assertEqual(tu_nodes[0].location.column, 8)
69        self.assertGreater(tu_nodes[0].hash, 0)
70        self.assertIsNotNone(tu_nodes[0].translation_unit)
71
72        s0_nodes = list(tu_nodes[0].get_children())
73        self.assertEqual(len(s0_nodes), 2)
74        self.assertEqual(s0_nodes[0].kind, CursorKind.FIELD_DECL)
75        self.assertEqual(s0_nodes[0].spelling, 'a')
76        self.assertEqual(s0_nodes[0].type.kind, TypeKind.INT)
77        self.assertEqual(s0_nodes[1].kind, CursorKind.FIELD_DECL)
78        self.assertEqual(s0_nodes[1].spelling, 'b')
79        self.assertEqual(s0_nodes[1].type.kind, TypeKind.INT)
80
81        self.assertEqual(tu_nodes[1].kind, CursorKind.STRUCT_DECL)
82        self.assertEqual(tu_nodes[1].spelling, 's1')
83        self.assertEqual(tu_nodes[1].displayname, 's1')
84        self.assertEqual(tu_nodes[1].is_definition(), False)
85
86        self.assertEqual(tu_nodes[2].kind, CursorKind.FUNCTION_DECL)
87        self.assertEqual(tu_nodes[2].spelling, 'f0')
88        self.assertEqual(tu_nodes[2].displayname, 'f0(int, int)')
89        self.assertEqual(tu_nodes[2].is_definition(), True)
90
91    def test_references(self):
92        """Ensure that references to TranslationUnit are kept."""
93        tu = get_tu('int x;')
94        cursors = list(tu.cursor.get_children())
95        self.assertGreater(len(cursors), 0)
96
97        cursor = cursors[0]
98        self.assertIsInstance(cursor.translation_unit, TranslationUnit)
99
100        # Delete reference to TU and perform a full GC.
101        del tu
102        gc.collect()
103        self.assertIsInstance(cursor.translation_unit, TranslationUnit)
104
105        # If the TU was destroyed, this should cause a segfault.
106        parent = cursor.semantic_parent
107
108    def test_canonical(self):
109        source = 'struct X; struct X; struct X { int member; };'
110        tu = get_tu(source)
111
112        cursors = []
113        for cursor in tu.cursor.get_children():
114            if cursor.spelling == 'X':
115                cursors.append(cursor)
116
117        self.assertEqual(len(cursors), 3)
118        self.assertEqual(cursors[1].canonical, cursors[2].canonical)
119
120    def test_is_const_method(self):
121        """Ensure Cursor.is_const_method works."""
122        source = 'class X { void foo() const; void bar(); };'
123        tu = get_tu(source, lang='cpp')
124
125        cls = get_cursor(tu, 'X')
126        foo = get_cursor(tu, 'foo')
127        bar = get_cursor(tu, 'bar')
128        self.assertIsNotNone(cls)
129        self.assertIsNotNone(foo)
130        self.assertIsNotNone(bar)
131
132        self.assertTrue(foo.is_const_method())
133        self.assertFalse(bar.is_const_method())
134
135    def test_is_converting_constructor(self):
136        """Ensure Cursor.is_converting_constructor works."""
137        source = 'class X { explicit X(int); X(double); X(); };'
138        tu = get_tu(source, lang='cpp')
139
140        xs = get_cursors(tu, 'X')
141
142        self.assertEqual(len(xs), 4)
143        self.assertEqual(xs[0].kind, CursorKind.CLASS_DECL)
144        cs = xs[1:]
145        self.assertEqual(cs[0].kind, CursorKind.CONSTRUCTOR)
146        self.assertEqual(cs[1].kind, CursorKind.CONSTRUCTOR)
147        self.assertEqual(cs[2].kind, CursorKind.CONSTRUCTOR)
148
149        self.assertFalse(cs[0].is_converting_constructor())
150        self.assertTrue(cs[1].is_converting_constructor())
151        self.assertFalse(cs[2].is_converting_constructor())
152
153
154    def test_is_copy_constructor(self):
155        """Ensure Cursor.is_copy_constructor works."""
156        source = 'class X { X(); X(const X&); X(X&&); };'
157        tu = get_tu(source, lang='cpp')
158
159        xs = get_cursors(tu, 'X')
160        self.assertEqual(xs[0].kind, CursorKind.CLASS_DECL)
161        cs = xs[1:]
162        self.assertEqual(cs[0].kind, CursorKind.CONSTRUCTOR)
163        self.assertEqual(cs[1].kind, CursorKind.CONSTRUCTOR)
164        self.assertEqual(cs[2].kind, CursorKind.CONSTRUCTOR)
165
166        self.assertFalse(cs[0].is_copy_constructor())
167        self.assertTrue(cs[1].is_copy_constructor())
168        self.assertFalse(cs[2].is_copy_constructor())
169
170    def test_is_default_constructor(self):
171        """Ensure Cursor.is_default_constructor works."""
172        source = 'class X { X(); X(int); };'
173        tu = get_tu(source, lang='cpp')
174
175        xs = get_cursors(tu, 'X')
176        self.assertEqual(xs[0].kind, CursorKind.CLASS_DECL)
177        cs = xs[1:]
178        self.assertEqual(cs[0].kind, CursorKind.CONSTRUCTOR)
179        self.assertEqual(cs[1].kind, CursorKind.CONSTRUCTOR)
180
181        self.assertTrue(cs[0].is_default_constructor())
182        self.assertFalse(cs[1].is_default_constructor())
183
184    def test_is_move_constructor(self):
185        """Ensure Cursor.is_move_constructor works."""
186        source = 'class X { X(); X(const X&); X(X&&); };'
187        tu = get_tu(source, lang='cpp')
188
189        xs = get_cursors(tu, 'X')
190        self.assertEqual(xs[0].kind, CursorKind.CLASS_DECL)
191        cs = xs[1:]
192        self.assertEqual(cs[0].kind, CursorKind.CONSTRUCTOR)
193        self.assertEqual(cs[1].kind, CursorKind.CONSTRUCTOR)
194        self.assertEqual(cs[2].kind, CursorKind.CONSTRUCTOR)
195
196        self.assertFalse(cs[0].is_move_constructor())
197        self.assertFalse(cs[1].is_move_constructor())
198        self.assertTrue(cs[2].is_move_constructor())
199
200    def test_is_default_method(self):
201        """Ensure Cursor.is_default_method works."""
202        source = 'class X { X() = default; }; class Y { Y(); };'
203        tu = get_tu(source, lang='cpp')
204
205        xs = get_cursors(tu, 'X')
206        ys = get_cursors(tu, 'Y')
207
208        self.assertEqual(len(xs), 2)
209        self.assertEqual(len(ys), 2)
210
211        xc = xs[1]
212        yc = ys[1]
213
214        self.assertTrue(xc.is_default_method())
215        self.assertFalse(yc.is_default_method())
216
217    def test_is_mutable_field(self):
218        """Ensure Cursor.is_mutable_field works."""
219        source = 'class X { int x_; mutable int y_; };'
220        tu = get_tu(source, lang='cpp')
221
222        cls = get_cursor(tu, 'X')
223        x_ = get_cursor(tu, 'x_')
224        y_ = get_cursor(tu, 'y_')
225        self.assertIsNotNone(cls)
226        self.assertIsNotNone(x_)
227        self.assertIsNotNone(y_)
228
229        self.assertFalse(x_.is_mutable_field())
230        self.assertTrue(y_.is_mutable_field())
231
232    def test_is_static_method(self):
233        """Ensure Cursor.is_static_method works."""
234
235        source = 'class X { static void foo(); void bar(); };'
236        tu = get_tu(source, lang='cpp')
237
238        cls = get_cursor(tu, 'X')
239        foo = get_cursor(tu, 'foo')
240        bar = get_cursor(tu, 'bar')
241        self.assertIsNotNone(cls)
242        self.assertIsNotNone(foo)
243        self.assertIsNotNone(bar)
244
245        self.assertTrue(foo.is_static_method())
246        self.assertFalse(bar.is_static_method())
247
248    def test_is_pure_virtual_method(self):
249        """Ensure Cursor.is_pure_virtual_method works."""
250        source = 'class X { virtual void foo() = 0; virtual void bar(); };'
251        tu = get_tu(source, lang='cpp')
252
253        cls = get_cursor(tu, 'X')
254        foo = get_cursor(tu, 'foo')
255        bar = get_cursor(tu, 'bar')
256        self.assertIsNotNone(cls)
257        self.assertIsNotNone(foo)
258        self.assertIsNotNone(bar)
259
260        self.assertTrue(foo.is_pure_virtual_method())
261        self.assertFalse(bar.is_pure_virtual_method())
262
263    def test_is_virtual_method(self):
264        """Ensure Cursor.is_virtual_method works."""
265        source = 'class X { virtual void foo(); void bar(); };'
266        tu = get_tu(source, lang='cpp')
267
268        cls = get_cursor(tu, 'X')
269        foo = get_cursor(tu, 'foo')
270        bar = get_cursor(tu, 'bar')
271        self.assertIsNotNone(cls)
272        self.assertIsNotNone(foo)
273        self.assertIsNotNone(bar)
274
275        self.assertTrue(foo.is_virtual_method())
276        self.assertFalse(bar.is_virtual_method())
277
278    def test_is_scoped_enum(self):
279        """Ensure Cursor.is_scoped_enum works."""
280        source = 'class X {}; enum RegularEnum {}; enum class ScopedEnum {};'
281        tu = get_tu(source, lang='cpp')
282
283        cls = get_cursor(tu, 'X')
284        regular_enum = get_cursor(tu, 'RegularEnum')
285        scoped_enum = get_cursor(tu, 'ScopedEnum')
286        self.assertIsNotNone(cls)
287        self.assertIsNotNone(regular_enum)
288        self.assertIsNotNone(scoped_enum)
289
290        self.assertFalse(cls.is_scoped_enum())
291        self.assertFalse(regular_enum.is_scoped_enum())
292        self.assertTrue(scoped_enum.is_scoped_enum())
293
294    def test_underlying_type(self):
295        tu = get_tu('typedef int foo;')
296        typedef = get_cursor(tu, 'foo')
297        self.assertIsNotNone(typedef)
298
299        self.assertTrue(typedef.kind.is_declaration())
300        underlying = typedef.underlying_typedef_type
301        self.assertEqual(underlying.kind, TypeKind.INT)
302
303    def test_semantic_parent(self):
304        tu = get_tu(kParentTest, 'cpp')
305        curs = get_cursors(tu, 'f')
306        decl = get_cursor(tu, 'C')
307        self.assertEqual(len(curs), 2)
308        self.assertEqual(curs[0].semantic_parent, curs[1].semantic_parent)
309        self.assertEqual(curs[0].semantic_parent, decl)
310
311    def test_lexical_parent(self):
312        tu = get_tu(kParentTest, 'cpp')
313        curs = get_cursors(tu, 'f')
314        decl = get_cursor(tu, 'C')
315        self.assertEqual(len(curs), 2)
316        self.assertNotEqual(curs[0].lexical_parent, curs[1].lexical_parent)
317        self.assertEqual(curs[0].lexical_parent, decl)
318        self.assertEqual(curs[1].lexical_parent, tu.cursor)
319
320    def test_enum_type(self):
321        tu = get_tu('enum TEST { FOO=1, BAR=2 };')
322        enum = get_cursor(tu, 'TEST')
323        self.assertIsNotNone(enum)
324
325        self.assertEqual(enum.kind, CursorKind.ENUM_DECL)
326        enum_type = enum.enum_type
327        self.assertEqual(enum_type.kind, TypeKind.UINT)
328
329    def test_enum_type_cpp(self):
330        tu = get_tu('enum TEST : long long { FOO=1, BAR=2 };', lang="cpp")
331        enum = get_cursor(tu, 'TEST')
332        self.assertIsNotNone(enum)
333
334        self.assertEqual(enum.kind, CursorKind.ENUM_DECL)
335        self.assertEqual(enum.enum_type.kind, TypeKind.LONGLONG)
336
337    def test_objc_type_encoding(self):
338        tu = get_tu('int i;', lang='objc')
339        i = get_cursor(tu, 'i')
340
341        self.assertIsNotNone(i)
342        self.assertEqual(i.objc_type_encoding, 'i')
343
344    def test_enum_values(self):
345        tu = get_tu('enum TEST { SPAM=1, EGG, HAM = EGG * 20};')
346        enum = get_cursor(tu, 'TEST')
347        self.assertIsNotNone(enum)
348
349        self.assertEqual(enum.kind, CursorKind.ENUM_DECL)
350
351        enum_constants = list(enum.get_children())
352        self.assertEqual(len(enum_constants), 3)
353
354        spam, egg, ham = enum_constants
355
356        self.assertEqual(spam.kind, CursorKind.ENUM_CONSTANT_DECL)
357        self.assertEqual(spam.enum_value, 1)
358        self.assertEqual(egg.kind, CursorKind.ENUM_CONSTANT_DECL)
359        self.assertEqual(egg.enum_value, 2)
360        self.assertEqual(ham.kind, CursorKind.ENUM_CONSTANT_DECL)
361        self.assertEqual(ham.enum_value, 40)
362
363    def test_enum_values_cpp(self):
364        tu = get_tu('enum TEST : long long { SPAM = -1, HAM = 0x10000000000};', lang="cpp")
365        enum = get_cursor(tu, 'TEST')
366        self.assertIsNotNone(enum)
367
368        self.assertEqual(enum.kind, CursorKind.ENUM_DECL)
369
370        enum_constants = list(enum.get_children())
371        self.assertEqual(len(enum_constants), 2)
372
373        spam, ham = enum_constants
374
375        self.assertEqual(spam.kind, CursorKind.ENUM_CONSTANT_DECL)
376        self.assertEqual(spam.enum_value, -1)
377        self.assertEqual(ham.kind, CursorKind.ENUM_CONSTANT_DECL)
378        self.assertEqual(ham.enum_value, 0x10000000000)
379
380    def test_annotation_attribute(self):
381        tu = get_tu('int foo (void) __attribute__ ((annotate("here be annotation attribute")));')
382
383        foo = get_cursor(tu, 'foo')
384        self.assertIsNotNone(foo)
385
386        for c in foo.get_children():
387            if c.kind == CursorKind.ANNOTATE_ATTR:
388                self.assertEqual(c.displayname, "here be annotation attribute")
389                break
390        else:
391            self.fail("Couldn't find annotation")
392
393    def test_annotation_template(self):
394        annotation = '__attribute__ ((annotate("annotation")))'
395        for source, kind in [
396                ('int foo (T value) %s;', CursorKind.FUNCTION_TEMPLATE),
397                ('class %s foo {};', CursorKind.CLASS_TEMPLATE),
398        ]:
399            source = 'template<typename T> ' + (source % annotation)
400            tu = get_tu(source, lang="cpp")
401
402            foo = get_cursor(tu, 'foo')
403            self.assertIsNotNone(foo)
404            self.assertEqual(foo.kind, kind)
405
406            for c in foo.get_children():
407                if c.kind == CursorKind.ANNOTATE_ATTR:
408                    self.assertEqual(c.displayname, "annotation")
409                    break
410            else:
411                self.fail("Couldn't find annotation for {}".format(kind))
412
413    def test_result_type(self):
414        tu = get_tu('int foo();')
415        foo = get_cursor(tu, 'foo')
416
417        self.assertIsNotNone(foo)
418        t = foo.result_type
419        self.assertEqual(t.kind, TypeKind.INT)
420
421    def test_availability(self):
422        tu = get_tu('class A { A(A const&) = delete; };', lang='cpp')
423
424        # AvailabilityKind.AVAILABLE
425        cursor = get_cursor(tu, 'A')
426        self.assertEqual(cursor.kind, CursorKind.CLASS_DECL)
427        self.assertEqual(cursor.availability, AvailabilityKind.AVAILABLE)
428
429        # AvailabilityKind.NOT_AVAILABLE
430        cursors = get_cursors(tu, 'A')
431        for c in cursors:
432            if c.kind == CursorKind.CONSTRUCTOR:
433                self.assertEqual(c.availability, AvailabilityKind.NOT_AVAILABLE)
434                break
435        else:
436            self.fail("Could not find cursor for deleted constructor")
437
438        # AvailabilityKind.DEPRECATED
439        tu = get_tu('void test() __attribute__((deprecated));', lang='cpp')
440        cursor = get_cursor(tu, 'test')
441        self.assertEqual(cursor.availability, AvailabilityKind.DEPRECATED)
442
443        # AvailabilityKind.NOT_ACCESSIBLE is only used in the code completion results
444
445    def test_get_tokens(self):
446        """Ensure we can map cursors back to tokens."""
447        tu = get_tu('int foo(int i);')
448        foo = get_cursor(tu, 'foo')
449
450        tokens = list(foo.get_tokens())
451        self.assertEqual(len(tokens), 6)
452        self.assertEqual(tokens[0].spelling, 'int')
453        self.assertEqual(tokens[1].spelling, 'foo')
454
455    def test_get_token_cursor(self):
456        """Ensure we can map tokens to cursors."""
457        tu = get_tu('class A {}; int foo(A var = A());', lang='cpp')
458        foo = get_cursor(tu, 'foo')
459
460        for cursor in foo.walk_preorder():
461            if cursor.kind.is_expression() and not cursor.kind.is_statement():
462                break
463        else:
464            self.fail("Could not find default value expression")
465
466        tokens = list(cursor.get_tokens())
467        self.assertEqual(len(tokens), 4, [t.spelling for t in tokens])
468        self.assertEqual(tokens[0].spelling, '=')
469        self.assertEqual(tokens[1].spelling, 'A')
470        self.assertEqual(tokens[2].spelling, '(')
471        self.assertEqual(tokens[3].spelling, ')')
472        t_cursor = tokens[1].cursor
473        self.assertEqual(t_cursor.kind, CursorKind.TYPE_REF)
474        r_cursor = t_cursor.referenced # should not raise an exception
475        self.assertEqual(r_cursor.kind, CursorKind.CLASS_DECL)
476
477    def test_get_arguments(self):
478        tu = get_tu('void foo(int i, int j);')
479        foo = get_cursor(tu, 'foo')
480        arguments = list(foo.get_arguments())
481
482        self.assertEqual(len(arguments), 2)
483        self.assertEqual(arguments[0].spelling, "i")
484        self.assertEqual(arguments[1].spelling, "j")
485
486    def test_get_num_template_arguments(self):
487        tu = get_tu(kTemplateArgTest, lang='cpp')
488        foos = get_cursors(tu, 'foo')
489
490        self.assertEqual(foos[1].get_num_template_arguments(), 3)
491
492    def test_get_template_argument_kind(self):
493        tu = get_tu(kTemplateArgTest, lang='cpp')
494        foos = get_cursors(tu, 'foo')
495
496        self.assertEqual(foos[1].get_template_argument_kind(0), TemplateArgumentKind.INTEGRAL)
497        self.assertEqual(foos[1].get_template_argument_kind(1), TemplateArgumentKind.TYPE)
498        self.assertEqual(foos[1].get_template_argument_kind(2), TemplateArgumentKind.INTEGRAL)
499
500    def test_get_template_argument_type(self):
501        tu = get_tu(kTemplateArgTest, lang='cpp')
502        foos = get_cursors(tu, 'foo')
503
504        self.assertEqual(foos[1].get_template_argument_type(1).kind, TypeKind.FLOAT)
505
506    def test_get_template_argument_value(self):
507        tu = get_tu(kTemplateArgTest, lang='cpp')
508        foos = get_cursors(tu, 'foo')
509
510        self.assertEqual(foos[1].get_template_argument_value(0), -7)
511        self.assertEqual(foos[1].get_template_argument_value(2), True)
512
513    def test_get_template_argument_unsigned_value(self):
514        tu = get_tu(kTemplateArgTest, lang='cpp')
515        foos = get_cursors(tu, 'foo')
516
517        self.assertEqual(foos[1].get_template_argument_unsigned_value(0), 2 ** 32 - 7)
518        self.assertEqual(foos[1].get_template_argument_unsigned_value(2), True)
519
520    def test_referenced(self):
521        tu = get_tu('void foo(); void bar() { foo(); }')
522        foo = get_cursor(tu, 'foo')
523        bar = get_cursor(tu, 'bar')
524        for c in bar.get_children():
525            if c.kind == CursorKind.CALL_EXPR:
526                self.assertEqual(c.referenced.spelling, foo.spelling)
527                break
528
529    def test_mangled_name(self):
530        kInputForMangling = """\
531        int foo(int, int);
532        """
533        tu = get_tu(kInputForMangling, lang='cpp')
534        foo = get_cursor(tu, 'foo')
535
536        # Since libclang does not link in targets, we cannot pass a triple to it
537        # and force the target. To enable this test to pass on all platforms, accept
538        # all valid manglings.
539        # [c-index-test handles this by running the source through clang, emitting
540        #  an AST file and running libclang on that AST file]
541        self.assertIn(foo.mangled_name, ('_Z3fooii', '__Z3fooii', '?foo@@YAHHH'))
542