cindex.py revision eb9ff2ea9ed829809cb177e74238301cfc2750ca
1#===- cindex.py - Python Indexing Library Bindings -----------*- python -*--===# 2# 3# The LLVM Compiler Infrastructure 4# 5# This file is distributed under the University of Illinois Open Source 6# License. See LICENSE.TXT for details. 7# 8#===------------------------------------------------------------------------===# 9 10r""" 11Clang Indexing Library Bindings 12=============================== 13 14This module provides an interface to the Clang indexing library. It is a 15low-level interface to the indexing library which attempts to match the Clang 16API directly while also being "pythonic". Notable differences from the C API 17are: 18 19 * string results are returned as Python strings, not CXString objects. 20 21 * null cursors are translated to None. 22 23 * access to child cursors is done via iteration, not visitation. 24 25The major indexing objects are: 26 27 Index 28 29 The top-level object which manages some global library state. 30 31 TranslationUnit 32 33 High-level object encapsulating the AST for a single translation unit. These 34 can be loaded from .ast files or parsed on the fly. 35 36 Cursor 37 38 Generic object for representing a node in the AST. 39 40 SourceRange, SourceLocation, and File 41 42 Objects representing information about the input source. 43 44Most object information is exposed using properties, when the underlying API 45call is efficient. 46""" 47 48# TODO 49# ==== 50# 51# o API support for invalid translation units. Currently we can't even get the 52# diagnostics on failure because they refer to locations in an object that 53# will have been invalidated. 54# 55# o fix memory management issues (currently client must hold on to index and 56# translation unit, or risk crashes). 57# 58# o expose code completion APIs. 59# 60# o cleanup ctypes wrapping, would be nice to separate the ctypes details more 61# clearly, and hide from the external interface (i.e., help(cindex)). 62# 63# o implement additional SourceLocation, SourceRange, and File methods. 64 65from ctypes import * 66 67def get_cindex_library(): 68 # FIXME: It's probably not the case that the library is actually found in 69 # this location. We need a better system of identifying and loading the 70 # CIndex library. It could be on path or elsewhere, or versioned, etc. 71 import platform 72 name = platform.system() 73 if name == 'Darwin': 74 return cdll.LoadLibrary('libclang.dylib') 75 elif name == 'Windows': 76 return cdll.LoadLibrary('libclang.dll') 77 else: 78 return cdll.LoadLibrary('libclang.so') 79 80# ctypes doesn't implicitly convert c_void_p to the appropriate wrapper 81# object. This is a problem, because it means that from_parameter will see an 82# integer and pass the wrong value on platforms where int != void*. Work around 83# this by marshalling object arguments as void**. 84c_object_p = POINTER(c_void_p) 85 86lib = get_cindex_library() 87 88### Structures and Utility Classes ### 89 90class _CXString(Structure): 91 """Helper for transforming CXString results.""" 92 93 _fields_ = [("spelling", c_char_p), ("free", c_int)] 94 95 def __del__(self): 96 _CXString_dispose(self) 97 98 @staticmethod 99 def from_result(res, fn, args): 100 assert isinstance(res, _CXString) 101 return _CXString_getCString(res) 102 103class SourceLocation(Structure): 104 """ 105 A SourceLocation represents a particular location within a source file. 106 """ 107 _fields_ = [("ptr_data", c_void_p * 2), ("int_data", c_uint)] 108 _data = None 109 110 def _get_instantiation(self): 111 if self._data is None: 112 f, l, c, o = c_object_p(), c_uint(), c_uint(), c_uint() 113 SourceLocation_loc(self, byref(f), byref(l), byref(c), byref(o)) 114 if f: 115 f = File(f) 116 else: 117 f = None 118 self._data = (f, int(l.value), int(c.value), int(o.value)) 119 return self._data 120 121 @staticmethod 122 def from_position(tu, file, line, column): 123 """ 124 Retrieve the source location associated with a given file/line/column in 125 a particular translation unit. 126 """ 127 return SourceLocation_getLocation(tu, file, line, column) 128 129 @property 130 def file(self): 131 """Get the file represented by this source location.""" 132 return self._get_instantiation()[0] 133 134 @property 135 def line(self): 136 """Get the line represented by this source location.""" 137 return self._get_instantiation()[1] 138 139 @property 140 def column(self): 141 """Get the column represented by this source location.""" 142 return self._get_instantiation()[2] 143 144 @property 145 def offset(self): 146 """Get the file offset represented by this source location.""" 147 return self._get_instantiation()[3] 148 149 def __eq__(self, other): 150 return SourceLocation_equalLocations(self, other) 151 152 def __ne__(self, other): 153 return not self.__eq__(other) 154 155 def __repr__(self): 156 if self.file: 157 filename = self.file.name 158 else: 159 filename = None 160 return "<SourceLocation file %r, line %r, column %r>" % ( 161 filename, self.line, self.column) 162 163class SourceRange(Structure): 164 """ 165 A SourceRange describes a range of source locations within the source 166 code. 167 """ 168 _fields_ = [ 169 ("ptr_data", c_void_p * 2), 170 ("begin_int_data", c_uint), 171 ("end_int_data", c_uint)] 172 173 # FIXME: Eliminate this and make normal constructor? Requires hiding ctypes 174 # object. 175 @staticmethod 176 def from_locations(start, end): 177 return SourceRange_getRange(start, end) 178 179 @property 180 def start(self): 181 """ 182 Return a SourceLocation representing the first character within a 183 source range. 184 """ 185 return SourceRange_start(self) 186 187 @property 188 def end(self): 189 """ 190 Return a SourceLocation representing the last character within a 191 source range. 192 """ 193 return SourceRange_end(self) 194 195 def __eq__(self, other): 196 return SourceRange_equalRanges(self, other) 197 198 def __ne__(self, other): 199 return not self.__eq__(other) 200 201 def __repr__(self): 202 return "<SourceRange start %r, end %r>" % (self.start, self.end) 203 204class Diagnostic(object): 205 """ 206 A Diagnostic is a single instance of a Clang diagnostic. It includes the 207 diagnostic severity, the message, the location the diagnostic occurred, as 208 well as additional source ranges and associated fix-it hints. 209 """ 210 211 Ignored = 0 212 Note = 1 213 Warning = 2 214 Error = 3 215 Fatal = 4 216 217 def __init__(self, ptr): 218 self.ptr = ptr 219 220 def __del__(self): 221 _clang_disposeDiagnostic(self) 222 223 @property 224 def severity(self): 225 return _clang_getDiagnosticSeverity(self) 226 227 @property 228 def location(self): 229 return _clang_getDiagnosticLocation(self) 230 231 @property 232 def spelling(self): 233 return _clang_getDiagnosticSpelling(self) 234 235 @property 236 def ranges(self): 237 class RangeIterator: 238 def __init__(self, diag): 239 self.diag = diag 240 241 def __len__(self): 242 return int(_clang_getDiagnosticNumRanges(self.diag)) 243 244 def __getitem__(self, key): 245 if (key >= len(self)): 246 raise IndexError 247 return _clang_getDiagnosticRange(self.diag, key) 248 249 return RangeIterator(self) 250 251 @property 252 def fixits(self): 253 class FixItIterator: 254 def __init__(self, diag): 255 self.diag = diag 256 257 def __len__(self): 258 return int(_clang_getDiagnosticNumFixIts(self.diag)) 259 260 def __getitem__(self, key): 261 range = SourceRange() 262 value = _clang_getDiagnosticFixIt(self.diag, key, byref(range)) 263 if len(value) == 0: 264 raise IndexError 265 266 return FixIt(range, value) 267 268 return FixItIterator(self) 269 270 @property 271 def category_number(self): 272 """The category number for this diagnostic.""" 273 return _clang_getDiagnosticCategory(self) 274 275 @property 276 def category_name(self): 277 """The string name of the category for this diagnostic.""" 278 return _clang_getDiagnosticCategoryName(self.category_number) 279 280 @property 281 def option(self): 282 """The command-line option that enables this diagnostic.""" 283 return _clang_getDiagnosticOption(self, None) 284 285 @property 286 def disable_option(self): 287 """The command-line option that disables this diagnostic.""" 288 disable = _CXString() 289 _clang_getDiagnosticOption(self, byref(disable)) 290 291 return _CXString_getCString(disable) 292 293 def __repr__(self): 294 return "<Diagnostic severity %r, location %r, spelling %r>" % ( 295 self.severity, self.location, self.spelling) 296 297 def from_param(self): 298 return self.ptr 299 300class FixIt(object): 301 """ 302 A FixIt represents a transformation to be applied to the source to 303 "fix-it". The fix-it shouldbe applied by replacing the given source range 304 with the given value. 305 """ 306 307 def __init__(self, range, value): 308 self.range = range 309 self.value = value 310 311 def __repr__(self): 312 return "<FixIt range %r, value %r>" % (self.range, self.value) 313 314### Cursor Kinds ### 315 316class CursorKind(object): 317 """ 318 A CursorKind describes the kind of entity that a cursor points to. 319 """ 320 321 # The unique kind objects, indexed by id. 322 _kinds = [] 323 _name_map = None 324 325 def __init__(self, value): 326 if value >= len(CursorKind._kinds): 327 CursorKind._kinds += [None] * (value - len(CursorKind._kinds) + 1) 328 if CursorKind._kinds[value] is not None: 329 raise ValueError,'CursorKind already loaded' 330 self.value = value 331 CursorKind._kinds[value] = self 332 CursorKind._name_map = None 333 334 def from_param(self): 335 return self.value 336 337 @property 338 def name(self): 339 """Get the enumeration name of this cursor kind.""" 340 if self._name_map is None: 341 self._name_map = {} 342 for key,value in CursorKind.__dict__.items(): 343 if isinstance(value,CursorKind): 344 self._name_map[value] = key 345 return self._name_map[self] 346 347 @staticmethod 348 def from_id(id): 349 if id >= len(CursorKind._kinds) or CursorKind._kinds[id] is None: 350 raise ValueError,'Unknown cursor kind' 351 return CursorKind._kinds[id] 352 353 @staticmethod 354 def get_all_kinds(): 355 """Return all CursorKind enumeration instances.""" 356 return filter(None, CursorKind._kinds) 357 358 def is_declaration(self): 359 """Test if this is a declaration kind.""" 360 return CursorKind_is_decl(self) 361 362 def is_reference(self): 363 """Test if this is a reference kind.""" 364 return CursorKind_is_ref(self) 365 366 def is_expression(self): 367 """Test if this is an expression kind.""" 368 return CursorKind_is_expr(self) 369 370 def is_statement(self): 371 """Test if this is a statement kind.""" 372 return CursorKind_is_stmt(self) 373 374 def is_attribute(self): 375 """Test if this is an attribute kind.""" 376 return CursorKind_is_attribute(self) 377 378 def is_invalid(self): 379 """Test if this is an invalid kind.""" 380 return CursorKind_is_inv(self) 381 382 def is_translation_unit(self): 383 """Test if this is a translation unit kind.""" 384 return CursorKind_is_translation_unit(self) 385 386 def is_preprocessing(self): 387 """Test if this is a preprocessing kind.""" 388 return CursorKind_is_preprocessing(self) 389 390 def is_unexposed(self): 391 """Test if this is an unexposed kind.""" 392 return CursorKind_is_unexposed(self) 393 394 def __repr__(self): 395 return 'CursorKind.%s' % (self.name,) 396 397# FIXME: Is there a nicer way to expose this enumeration? We could potentially 398# represent the nested structure, or even build a class hierarchy. The main 399# things we want for sure are (a) simple external access to kinds, (b) a place 400# to hang a description and name, (c) easy to keep in sync with Index.h. 401 402### 403# Declaration Kinds 404 405# A declaration whose specific kind is not exposed via this interface. 406# 407# Unexposed declarations have the same operations as any other kind of 408# declaration; one can extract their location information, spelling, find their 409# definitions, etc. However, the specific kind of the declaration is not 410# reported. 411CursorKind.UNEXPOSED_DECL = CursorKind(1) 412 413# A C or C++ struct. 414CursorKind.STRUCT_DECL = CursorKind(2) 415 416# A C or C++ union. 417CursorKind.UNION_DECL = CursorKind(3) 418 419# A C++ class. 420CursorKind.CLASS_DECL = CursorKind(4) 421 422# An enumeration. 423CursorKind.ENUM_DECL = CursorKind(5) 424 425# A field (in C) or non-static data member (in C++) in a struct, union, or C++ 426# class. 427CursorKind.FIELD_DECL = CursorKind(6) 428 429# An enumerator constant. 430CursorKind.ENUM_CONSTANT_DECL = CursorKind(7) 431 432# A function. 433CursorKind.FUNCTION_DECL = CursorKind(8) 434 435# A variable. 436CursorKind.VAR_DECL = CursorKind(9) 437 438# A function or method parameter. 439CursorKind.PARM_DECL = CursorKind(10) 440 441# An Objective-C @interface. 442CursorKind.OBJC_INTERFACE_DECL = CursorKind(11) 443 444# An Objective-C @interface for a category. 445CursorKind.OBJC_CATEGORY_DECL = CursorKind(12) 446 447# An Objective-C @protocol declaration. 448CursorKind.OBJC_PROTOCOL_DECL = CursorKind(13) 449 450# An Objective-C @property declaration. 451CursorKind.OBJC_PROPERTY_DECL = CursorKind(14) 452 453# An Objective-C instance variable. 454CursorKind.OBJC_IVAR_DECL = CursorKind(15) 455 456# An Objective-C instance method. 457CursorKind.OBJC_INSTANCE_METHOD_DECL = CursorKind(16) 458 459# An Objective-C class method. 460CursorKind.OBJC_CLASS_METHOD_DECL = CursorKind(17) 461 462# An Objective-C @implementation. 463CursorKind.OBJC_IMPLEMENTATION_DECL = CursorKind(18) 464 465# An Objective-C @implementation for a category. 466CursorKind.OBJC_CATEGORY_IMPL_DECL = CursorKind(19) 467 468# A typedef. 469CursorKind.TYPEDEF_DECL = CursorKind(20) 470 471# A C++ class method. 472CursorKind.CXX_METHOD = CursorKind(21) 473 474# A C++ namespace. 475CursorKind.NAMESPACE = CursorKind(22) 476 477# A linkage specification, e.g. 'extern "C"'. 478CursorKind.LINKAGE_SPEC = CursorKind(23) 479 480# A C++ constructor. 481CursorKind.CONSTRUCTOR = CursorKind(24) 482 483# A C++ destructor. 484CursorKind.DESTRUCTOR = CursorKind(25) 485 486# A C++ conversion function. 487CursorKind.CONVERSION_FUNCTION = CursorKind(26) 488 489# A C++ template type parameter 490CursorKind.TEMPLATE_TYPE_PARAMETER = CursorKind(27) 491 492# A C++ non-type template paramater. 493CursorKind.TEMPLATE_NON_TYPE_PARAMETER = CursorKind(28) 494 495# A C++ template template parameter. 496CursorKind.TEMPLATE_TEMPLATE_PARAMTER = CursorKind(29) 497 498# A C++ function template. 499CursorKind.FUNCTION_TEMPLATE = CursorKind(30) 500 501# A C++ class template. 502CursorKind.CLASS_TEMPLATE = CursorKind(31) 503 504# A C++ class template partial specialization. 505CursorKind.CLASS_TEMPLATE_PARTIAL_SPECIALIZATION = CursorKind(32) 506 507# A C++ namespace alias declaration. 508CursorKind.NAMESPACE_ALIAS = CursorKind(33) 509 510# A C++ using directive 511CursorKind.USING_DIRECTIVE = CursorKind(34) 512 513# A C++ using declaration 514CursorKind.USING_DECLARATION = CursorKind(35) 515 516# A Type alias decl. 517CursorKind.TYPE_ALIAS_DECL = CursorKind(36) 518 519# A Objective-C synthesize decl 520CursorKind.OBJC_SYNTHESIZE_DECL = CursorKind(37) 521 522# A Objective-C dynamic decl 523CursorKind.OBJC_DYNAMIC_DECL = CursorKind(38) 524 525# A C++ access specifier decl. 526CursorKind.CXX_ACCESS_SPEC_DECL = CursorKind(39) 527 528 529### 530# Reference Kinds 531 532CursorKind.OBJC_SUPER_CLASS_REF = CursorKind(40) 533CursorKind.OBJC_PROTOCOL_REF = CursorKind(41) 534CursorKind.OBJC_CLASS_REF = CursorKind(42) 535 536# A reference to a type declaration. 537# 538# A type reference occurs anywhere where a type is named but not 539# declared. For example, given: 540# typedef unsigned size_type; 541# size_type size; 542# 543# The typedef is a declaration of size_type (CXCursor_TypedefDecl), 544# while the type of the variable "size" is referenced. The cursor 545# referenced by the type of size is the typedef for size_type. 546CursorKind.TYPE_REF = CursorKind(43) 547CursorKind.CXX_BASE_SPECIFIER = CursorKind(44) 548 549# A reference to a class template, function template, template 550# template parameter, or class template partial specialization. 551CursorKind.TEMPLATE_REF = CursorKind(45) 552 553# A reference to a namespace or namepsace alias. 554CursorKind.NAMESPACE_REF = CursorKind(46) 555 556# A reference to a member of a struct, union, or class that occurs in 557# some non-expression context, e.g., a designated initializer. 558CursorKind.MEMBER_REF = CursorKind(47) 559 560# A reference to a labeled statement. 561CursorKind.LABEL_REF = CursorKind(48) 562 563# A reference toa a set of overloaded functions or function templates 564# that has not yet been resolved to a specific function or function template. 565CursorKind.OVERLOADED_DECL_REF = CursorKind(49) 566 567### 568# Invalid/Error Kinds 569 570CursorKind.INVALID_FILE = CursorKind(70) 571CursorKind.NO_DECL_FOUND = CursorKind(71) 572CursorKind.NOT_IMPLEMENTED = CursorKind(72) 573CursorKind.INVALID_CODE = CursorKind(73) 574 575### 576# Expression Kinds 577 578# An expression whose specific kind is not exposed via this interface. 579# 580# Unexposed expressions have the same operations as any other kind of 581# expression; one can extract their location information, spelling, children, 582# etc. However, the specific kind of the expression is not reported. 583CursorKind.UNEXPOSED_EXPR = CursorKind(100) 584 585# An expression that refers to some value declaration, such as a function, 586# varible, or enumerator. 587CursorKind.DECL_REF_EXPR = CursorKind(101) 588 589# An expression that refers to a member of a struct, union, class, Objective-C 590# class, etc. 591CursorKind.MEMBER_REF_EXPR = CursorKind(102) 592 593# An expression that calls a function. 594CursorKind.CALL_EXPR = CursorKind(103) 595 596# An expression that sends a message to an Objective-C object or class. 597CursorKind.OBJC_MESSAGE_EXPR = CursorKind(104) 598 599# An expression that represents a block literal. 600CursorKind.BLOCK_EXPR = CursorKind(105) 601 602# An integer literal. 603CursorKind.INTEGER_LITERAL = CursorKind(106) 604 605# A floating point number literal. 606CursorKind.FLOATING_LITERAL = CursorKind(107) 607 608# An imaginary number literal. 609CursorKind.IMAGINARY_LITERAL = CursorKind(108) 610 611# A string literal. 612CursorKind.STRING_LITERAL = CursorKind(109) 613 614# A character literal. 615CursorKind.CHARACTER_LITERAL = CursorKind(110) 616 617# A parenthesized expression, e.g. "(1)". 618# 619# This AST node is only formed if full location information is requested. 620CursorKind.PAREN_EXPR = CursorKind(111) 621 622# This represents the unary-expression's (except sizeof and 623# alignof). 624CursorKind.UNARY_OPERATOR = CursorKind(112) 625 626# [C99 6.5.2.1] Array Subscripting. 627CursorKind.ARRAY_SUBSCRIPT_EXPR = CursorKind(113) 628 629# A builtin binary operation expression such as "x + y" or 630# "x <= y". 631CursorKind.BINARY_OPERATOR = CursorKind(114) 632 633# Compound assignment such as "+=". 634CursorKind.COMPOUND_ASSIGNMENT_OPERATOR = CursorKind(115) 635 636# The ?: ternary operator. 637CursorKind.CONDITONAL_OPERATOR = CursorKind(116) 638 639# An explicit cast in C (C99 6.5.4) or a C-style cast in C++ 640# (C++ [expr.cast]), which uses the syntax (Type)expr. 641# 642# For example: (int)f. 643CursorKind.CSTYLE_CAST_EXPR = CursorKind(117) 644 645# [C99 6.5.2.5] 646CursorKind.COMPOUND_LITERAL_EXPR = CursorKind(118) 647 648# Describes an C or C++ initializer list. 649CursorKind.INIT_LIST_EXPR = CursorKind(119) 650 651# The GNU address of label extension, representing &&label. 652CursorKind.ADDR_LABEL_EXPR = CursorKind(120) 653 654# This is the GNU Statement Expression extension: ({int X=4; X;}) 655CursorKind.StmtExpr = CursorKind(121) 656 657# Represents a C11 generic selection. 658CursorKind.GENERIC_SELECTION_EXPR = CursorKind(122) 659 660# Implements the GNU __null extension, which is a name for a null 661# pointer constant that has integral type (e.g., int or long) and is the same 662# size and alignment as a pointer. 663# 664# The __null extension is typically only used by system headers, which define 665# NULL as __null in C++ rather than using 0 (which is an integer that may not 666# match the size of a pointer). 667CursorKind.GNU_NULL_EXPR = CursorKind(123) 668 669# C++'s static_cast<> expression. 670CursorKind.CXX_STATIC_CAST_EXPR = CursorKind(124) 671 672# C++'s dynamic_cast<> expression. 673CursorKind.CXX_DYNAMIC_CAST_EXPR = CursorKind(125) 674 675# C++'s reinterpret_cast<> expression. 676CursorKind.CXX_REINTERPRET_CAST_EXPR = CursorKind(126) 677 678# C++'s const_cast<> expression. 679CursorKind.CXX_CONST_CAST_EXPR = CursorKind(127) 680 681# Represents an explicit C++ type conversion that uses "functional" 682# notion (C++ [expr.type.conv]). 683# 684# Example: 685# \code 686# x = int(0.5); 687# \endcode 688CursorKind.CXX_FUNCTIONAL_CAST_EXPR = CursorKind(128) 689 690# A C++ typeid expression (C++ [expr.typeid]). 691CursorKind.CXX_TYPEID_EXPR = CursorKind(129) 692 693# [C++ 2.13.5] C++ Boolean Literal. 694CursorKind.CXX_BOOL_LITERAL_EXPR = CursorKind(130) 695 696# [C++0x 2.14.7] C++ Pointer Literal. 697CursorKind.CXX_NULL_PTR_LITERAL_EXPR = CursorKind(131) 698 699# Represents the "this" expression in C++ 700CursorKind.CXX_THIS_EXPR = CursorKind(132) 701 702# [C++ 15] C++ Throw Expression. 703# 704# This handles 'throw' and 'throw' assignment-expression. When 705# assignment-expression isn't present, Op will be null. 706CursorKind.CXX_THROW_EXPR = CursorKind(133) 707 708# A new expression for memory allocation and constructor calls, e.g: 709# "new CXXNewExpr(foo)". 710CursorKind.CXX_NEW_EXPR = CursorKind(134) 711 712# A delete expression for memory deallocation and destructor calls, 713# e.g. "delete[] pArray". 714CursorKind.CXX_DELETE_EXPR = CursorKind(135) 715 716# Represents a unary expression. 717CursorKind.CXX_UNARY_EXPR = CursorKind(136) 718 719# ObjCStringLiteral, used for Objective-C string literals i.e. "foo". 720CursorKind.OBJC_STRING_LITERAL = CursorKind(137) 721 722# ObjCEncodeExpr, used for in Objective-C. 723CursorKind.OBJC_ENCODE_EXPR = CursorKind(138) 724 725# ObjCSelectorExpr used for in Objective-C. 726CursorKind.OBJC_SELECTOR_EXPR = CursorKind(139) 727 728# Objective-C's protocol expression. 729CursorKind.OBJC_PROTOCOL_EXPR = CursorKind(140) 730 731# An Objective-C "bridged" cast expression, which casts between 732# Objective-C pointers and C pointers, transferring ownership in the process. 733# 734# \code 735# NSString *str = (__bridge_transfer NSString *)CFCreateString(); 736# \endcode 737CursorKind.OBJC_BRIDGE_CAST_EXPR = CursorKind(141) 738 739# Represents a C++0x pack expansion that produces a sequence of 740# expressions. 741# 742# A pack expansion expression contains a pattern (which itself is an 743# expression) followed by an ellipsis. For example: 744CursorKind.PACK_EXPANSION_EXPR = CursorKind(142) 745 746# Represents an expression that computes the length of a parameter 747# pack. 748CursorKind.SIZE_OF_PACK_EXPR = CursorKind(143) 749 750# A statement whose specific kind is not exposed via this interface. 751# 752# Unexposed statements have the same operations as any other kind of statement; 753# one can extract their location information, spelling, children, etc. However, 754# the specific kind of the statement is not reported. 755CursorKind.UNEXPOSED_STMT = CursorKind(200) 756 757# A labelled statement in a function. 758CursorKind.LABEL_STMT = CursorKind(201) 759 760# A compound statement 761CursorKind.COMPOUND_STMT = CursorKind(202) 762 763# A case statement. 764CursorKind.CASE_STMT = CursorKind(203) 765 766# A default statement. 767CursorKind.DEFAULT_STMT = CursorKind(204) 768 769# An if statement. 770CursorKind.IF_STMT = CursorKind(205) 771 772# A switch statement. 773CursorKind.SWITCH_STMT = CursorKind(206) 774 775# A while statement. 776CursorKind.WHILE_STMT = CursorKind(207) 777 778# A do statement. 779CursorKind.DO_STMT = CursorKind(208) 780 781# A for statement. 782CursorKind.FOR_STMT = CursorKind(209) 783 784# A goto statement. 785CursorKind.GOTO_STMT = CursorKind(210) 786 787# An indirect goto statement. 788CursorKind.INDIRECT_GOTO_STMT = CursorKind(211) 789 790# A continue statement. 791CursorKind.CONTINUE_STMT = CursorKind(212) 792 793# A break statement. 794CursorKind.BREAK_STMT = CursorKind(213) 795 796# A return statement. 797CursorKind.RETURN_STMT = CursorKind(214) 798 799# A GNU-style inline assembler statement. 800CursorKind.ASM_STMT = CursorKind(215) 801 802# Objective-C's overall @try-@catch-@finally statement. 803CursorKind.OBJC_AT_TRY_STMT = CursorKind(216) 804 805# Objective-C's @catch statement. 806CursorKind.OBJC_AT_CATCH_STMT = CursorKind(217) 807 808# Objective-C's @finally statement. 809CursorKind.OBJC_AT_FINALLY_STMT = CursorKind(218) 810 811# Objective-C's @throw statement. 812CursorKind.OBJC_AT_THROW_STMT = CursorKind(219) 813 814# Objective-C's @synchronized statement. 815CursorKind.OBJC_AT_SYNCHRONIZED_STMT = CursorKind(220) 816 817# Objective-C's autorealease pool statement. 818CursorKind.OBJC_AUTORELEASE_POOL_STMT = CursorKind(221) 819 820# Objective-C's for collection statement. 821CursorKind.OBJC_FOR_COLLECTION_STMT = CursorKind(222) 822 823# C++'s catch statement. 824CursorKind.CXX_CATCH_STMT = CursorKind(223) 825 826# C++'s try statement. 827CursorKind.CXX_TRY_STMT = CursorKind(224) 828 829# C++'s for (* : *) statement. 830CursorKind.CXX_FOR_RANGE_STMT = CursorKind(225) 831 832# Windows Structured Exception Handling's try statement. 833CursorKind.SEH_TRY_STMT = CursorKind(226) 834 835# Windows Structured Exception Handling's except statement. 836CursorKind.SEH_EXCEPT_STMT = CursorKind(227) 837 838# Windows Structured Exception Handling's finally statement. 839CursorKind.SEH_FINALLY_STMT = CursorKind(228) 840 841# The null statement. 842CursorKind.NULL_STMT = CursorKind(230) 843 844# Adaptor class for mixing declarations with statements and expressions. 845CursorKind.DECL_STMT = CursorKind(231) 846 847### 848# Other Kinds 849 850# Cursor that represents the translation unit itself. 851# 852# The translation unit cursor exists primarily to act as the root cursor for 853# traversing the contents of a translation unit. 854CursorKind.TRANSLATION_UNIT = CursorKind(300) 855 856### 857# Attributes 858 859# An attribute whoe specific kind is note exposed via this interface 860CursorKind.UNEXPOSED_ATTR = CursorKind(400) 861 862CursorKind.IB_ACTION_ATTR = CursorKind(401) 863CursorKind.IB_OUTLET_ATTR = CursorKind(402) 864CursorKind.IB_OUTLET_COLLECTION_ATTR = CursorKind(403) 865 866CursorKind.CXX_FINAL_ATTR = CursorKind(404) 867CursorKind.CXX_OVERRIDE_ATTR = CursorKind(405) 868CursorKind.ANNOTATE_ATTR = CursorKind(406) 869CursorKind.ASM_LABEL_ATTR = CursorKind(407) 870 871### 872# Preprocessing 873CursorKind.PREPROCESSING_DIRECTIVE = CursorKind(500) 874CursorKind.MACRO_DEFINITION = CursorKind(501) 875CursorKind.MACRO_INSTANTIATION = CursorKind(502) 876CursorKind.INCLUSION_DIRECTIVE = CursorKind(503) 877 878### Cursors ### 879 880class Cursor(Structure): 881 """ 882 The Cursor class represents a reference to an element within the AST. It 883 acts as a kind of iterator. 884 """ 885 _fields_ = [("_kind_id", c_int), ("xdata", c_int), ("data", c_void_p * 3)] 886 887 @staticmethod 888 def from_location(tu, location): 889 return Cursor_get(tu, location) 890 891 def __eq__(self, other): 892 return Cursor_eq(self, other) 893 894 def __ne__(self, other): 895 return not Cursor_eq(self, other) 896 897 def is_definition(self): 898 """ 899 Returns true if the declaration pointed at by the cursor is also a 900 definition of that entity. 901 """ 902 return Cursor_is_def(self) 903 904 def get_definition(self): 905 """ 906 If the cursor is a reference to a declaration or a declaration of 907 some entity, return a cursor that points to the definition of that 908 entity. 909 """ 910 # TODO: Should probably check that this is either a reference or 911 # declaration prior to issuing the lookup. 912 return Cursor_def(self) 913 914 def get_usr(self): 915 """Return the Unified Symbol Resultion (USR) for the entity referenced 916 by the given cursor (or None). 917 918 A Unified Symbol Resolution (USR) is a string that identifies a 919 particular entity (function, class, variable, etc.) within a 920 program. USRs can be compared across translation units to determine, 921 e.g., when references in one translation refer to an entity defined in 922 another translation unit.""" 923 return Cursor_usr(self) 924 925 @property 926 def kind(self): 927 """Return the kind of this cursor.""" 928 return CursorKind.from_id(self._kind_id) 929 930 @property 931 def spelling(self): 932 """Return the spelling of the entity pointed at by the cursor.""" 933 if not self.kind.is_declaration(): 934 # FIXME: clang_getCursorSpelling should be fixed to not assert on 935 # this, for consistency with clang_getCursorUSR. 936 return None 937 if not hasattr(self, '_spelling'): 938 self._spelling = Cursor_spelling(self) 939 return self._spelling 940 941 @property 942 def displayname(self): 943 """ 944 Return the display name for the entity referenced by this cursor. 945 946 The display name contains extra information that helps identify the cursor, 947 such as the parameters of a function or template or the arguments of a 948 class template specialization. 949 """ 950 if not hasattr(self, '_displayname'): 951 self._displayname = Cursor_displayname(self) 952 return self._displayname 953 954 @property 955 def location(self): 956 """ 957 Return the source location (the starting character) of the entity 958 pointed at by the cursor. 959 """ 960 if not hasattr(self, '_loc'): 961 self._loc = Cursor_loc(self) 962 return self._loc 963 964 @property 965 def extent(self): 966 """ 967 Return the source range (the range of text) occupied by the entity 968 pointed at by the cursor. 969 """ 970 if not hasattr(self, '_extent'): 971 self._extent = Cursor_extent(self) 972 return self._extent 973 974 @property 975 def type(self): 976 """ 977 Retrieve the type (if any) of of the entity pointed at by the 978 cursor. 979 """ 980 if not hasattr(self, '_type'): 981 self._type = Cursor_type(self) 982 return self._type 983 984 @property 985 def underlying_typedef_type(self): 986 """Return the underlying type of a typedef declaration. 987 988 Returns a type for the typedef this cursor is a declaration for. If 989 the current cursor is not a typedef, this raises. 990 """ 991 if not hasattr(self, '_underlying_type'): 992 assert self.kind.is_declaration() 993 self._underlying_type = Cursor_underlying_type(self) 994 995 return self._underlying_type 996 997 @property 998 def enum_type(self): 999 """Return the integer type of an enum declaration. 1000 1001 Returns a type corresponding to an integer. If the cursor is not for an 1002 enum, this raises. 1003 """ 1004 if not hasattr(self, '_enum_type'): 1005 assert self.kind == CursorKind.ENUM_DECL 1006 self._enum_type = Cursor_enum_type(self) 1007 1008 return self._enum_type 1009 1010 @property 1011 def hash(self): 1012 """Returns a hash of the cursor as an int.""" 1013 if not hasattr(self, '_hash'): 1014 self._hash = Cursor_hash(self) 1015 1016 return self._hash 1017 1018 def get_children(self): 1019 """Return an iterator for accessing the children of this cursor.""" 1020 1021 # FIXME: Expose iteration from CIndex, PR6125. 1022 def visitor(child, parent, children): 1023 # FIXME: Document this assertion in API. 1024 # FIXME: There should just be an isNull method. 1025 assert child != Cursor_null() 1026 children.append(child) 1027 return 1 # continue 1028 children = [] 1029 Cursor_visit(self, Cursor_visit_callback(visitor), children) 1030 return iter(children) 1031 1032 @staticmethod 1033 def from_result(res, fn, args): 1034 assert isinstance(res, Cursor) 1035 # FIXME: There should just be an isNull method. 1036 if res == Cursor_null(): 1037 return None 1038 return res 1039 1040 1041### Type Kinds ### 1042 1043class TypeKind(object): 1044 """ 1045 Describes the kind of type. 1046 """ 1047 1048 # The unique kind objects, indexed by id. 1049 _kinds = [] 1050 _name_map = None 1051 1052 def __init__(self, value): 1053 if value >= len(TypeKind._kinds): 1054 TypeKind._kinds += [None] * (value - len(TypeKind._kinds) + 1) 1055 if TypeKind._kinds[value] is not None: 1056 raise ValueError,'TypeKind already loaded' 1057 self.value = value 1058 TypeKind._kinds[value] = self 1059 TypeKind._name_map = None 1060 1061 def from_param(self): 1062 return self.value 1063 1064 @property 1065 def name(self): 1066 """Get the enumeration name of this cursor kind.""" 1067 if self._name_map is None: 1068 self._name_map = {} 1069 for key,value in TypeKind.__dict__.items(): 1070 if isinstance(value,TypeKind): 1071 self._name_map[value] = key 1072 return self._name_map[self] 1073 1074 @staticmethod 1075 def from_id(id): 1076 if id >= len(TypeKind._kinds) or TypeKind._kinds[id] is None: 1077 raise ValueError,'Unknown type kind %d' % id 1078 return TypeKind._kinds[id] 1079 1080 def __repr__(self): 1081 return 'TypeKind.%s' % (self.name,) 1082 1083 1084 1085TypeKind.INVALID = TypeKind(0) 1086TypeKind.UNEXPOSED = TypeKind(1) 1087TypeKind.VOID = TypeKind(2) 1088TypeKind.BOOL = TypeKind(3) 1089TypeKind.CHAR_U = TypeKind(4) 1090TypeKind.UCHAR = TypeKind(5) 1091TypeKind.CHAR16 = TypeKind(6) 1092TypeKind.CHAR32 = TypeKind(7) 1093TypeKind.USHORT = TypeKind(8) 1094TypeKind.UINT = TypeKind(9) 1095TypeKind.ULONG = TypeKind(10) 1096TypeKind.ULONGLONG = TypeKind(11) 1097TypeKind.UINT128 = TypeKind(12) 1098TypeKind.CHAR_S = TypeKind(13) 1099TypeKind.SCHAR = TypeKind(14) 1100TypeKind.WCHAR = TypeKind(15) 1101TypeKind.SHORT = TypeKind(16) 1102TypeKind.INT = TypeKind(17) 1103TypeKind.LONG = TypeKind(18) 1104TypeKind.LONGLONG = TypeKind(19) 1105TypeKind.INT128 = TypeKind(20) 1106TypeKind.FLOAT = TypeKind(21) 1107TypeKind.DOUBLE = TypeKind(22) 1108TypeKind.LONGDOUBLE = TypeKind(23) 1109TypeKind.NULLPTR = TypeKind(24) 1110TypeKind.OVERLOAD = TypeKind(25) 1111TypeKind.DEPENDENT = TypeKind(26) 1112TypeKind.OBJCID = TypeKind(27) 1113TypeKind.OBJCCLASS = TypeKind(28) 1114TypeKind.OBJCSEL = TypeKind(29) 1115TypeKind.COMPLEX = TypeKind(100) 1116TypeKind.POINTER = TypeKind(101) 1117TypeKind.BLOCKPOINTER = TypeKind(102) 1118TypeKind.LVALUEREFERENCE = TypeKind(103) 1119TypeKind.RVALUEREFERENCE = TypeKind(104) 1120TypeKind.RECORD = TypeKind(105) 1121TypeKind.ENUM = TypeKind(106) 1122TypeKind.TYPEDEF = TypeKind(107) 1123TypeKind.OBJCINTERFACE = TypeKind(108) 1124TypeKind.OBJCOBJECTPOINTER = TypeKind(109) 1125TypeKind.FUNCTIONNOPROTO = TypeKind(110) 1126TypeKind.FUNCTIONPROTO = TypeKind(111) 1127TypeKind.CONSTANTARRAY = TypeKind(112) 1128TypeKind.VECTOR = TypeKind(113) 1129 1130class Type(Structure): 1131 """ 1132 The type of an element in the abstract syntax tree. 1133 """ 1134 _fields_ = [("_kind_id", c_int), ("data", c_void_p * 2)] 1135 1136 @property 1137 def kind(self): 1138 """Return the kind of this type.""" 1139 return TypeKind.from_id(self._kind_id) 1140 1141 @staticmethod 1142 def from_result(res, fn, args): 1143 assert isinstance(res, Type) 1144 return res 1145 1146 def get_canonical(self): 1147 """ 1148 Return the canonical type for a Type. 1149 1150 Clang's type system explicitly models typedefs and all the 1151 ways a specific type can be represented. The canonical type 1152 is the underlying type with all the "sugar" removed. For 1153 example, if 'T' is a typedef for 'int', the canonical type for 1154 'T' would be 'int'. 1155 """ 1156 return Type_get_canonical(self) 1157 1158 def is_const_qualified(self): 1159 """ 1160 Determine whether a Type has the "const" qualifier set, 1161 without looking through typedefs that may have added "const" 1162 at a different level. 1163 """ 1164 return Type_is_const_qualified(self) 1165 1166 def is_volatile_qualified(self): 1167 """ 1168 Determine whether a Type has the "volatile" qualifier set, 1169 without looking through typedefs that may have added 1170 "volatile" at a different level. 1171 """ 1172 return Type_is_volatile_qualified(self) 1173 1174 def is_restrict_qualified(self): 1175 """ 1176 Determine whether a Type has the "restrict" qualifier set, 1177 without looking through typedefs that may have added 1178 "restrict" at a different level. 1179 """ 1180 return Type_is_restrict_qualified(self) 1181 1182 def get_pointee(self): 1183 """ 1184 For pointer types, returns the type of the pointee. 1185 """ 1186 return Type_get_pointee(self) 1187 1188 def get_declaration(self): 1189 """ 1190 Return the cursor for the declaration of the given type. 1191 """ 1192 return Type_get_declaration(self) 1193 1194 def get_result(self): 1195 """ 1196 Retrieve the result type associated with a function type. 1197 """ 1198 return Type_get_result(self) 1199 1200 def get_array_element_type(self): 1201 """ 1202 Retrieve the type of the elements of the array type. 1203 """ 1204 return Type_get_array_element(self) 1205 1206 def get_array_size(self): 1207 """ 1208 Retrieve the size of the constant array. 1209 """ 1210 return Type_get_array_size(self) 1211 1212## CIndex Objects ## 1213 1214# CIndex objects (derived from ClangObject) are essentially lightweight 1215# wrappers attached to some underlying object, which is exposed via CIndex as 1216# a void*. 1217 1218class ClangObject(object): 1219 """ 1220 A helper for Clang objects. This class helps act as an intermediary for 1221 the ctypes library and the Clang CIndex library. 1222 """ 1223 def __init__(self, obj): 1224 assert isinstance(obj, c_object_p) and obj 1225 self.obj = self._as_parameter_ = obj 1226 1227 def from_param(self): 1228 return self._as_parameter_ 1229 1230 1231class _CXUnsavedFile(Structure): 1232 """Helper for passing unsaved file arguments.""" 1233 _fields_ = [("name", c_char_p), ("contents", c_char_p), ('length', c_ulong)] 1234 1235## Diagnostic Conversion ## 1236 1237_clang_getNumDiagnostics = lib.clang_getNumDiagnostics 1238_clang_getNumDiagnostics.argtypes = [c_object_p] 1239_clang_getNumDiagnostics.restype = c_uint 1240 1241_clang_getDiagnostic = lib.clang_getDiagnostic 1242_clang_getDiagnostic.argtypes = [c_object_p, c_uint] 1243_clang_getDiagnostic.restype = c_object_p 1244 1245_clang_disposeDiagnostic = lib.clang_disposeDiagnostic 1246_clang_disposeDiagnostic.argtypes = [Diagnostic] 1247 1248_clang_getDiagnosticSeverity = lib.clang_getDiagnosticSeverity 1249_clang_getDiagnosticSeverity.argtypes = [Diagnostic] 1250_clang_getDiagnosticSeverity.restype = c_int 1251 1252_clang_getDiagnosticLocation = lib.clang_getDiagnosticLocation 1253_clang_getDiagnosticLocation.argtypes = [Diagnostic] 1254_clang_getDiagnosticLocation.restype = SourceLocation 1255 1256_clang_getDiagnosticSpelling = lib.clang_getDiagnosticSpelling 1257_clang_getDiagnosticSpelling.argtypes = [Diagnostic] 1258_clang_getDiagnosticSpelling.restype = _CXString 1259_clang_getDiagnosticSpelling.errcheck = _CXString.from_result 1260 1261_clang_getDiagnosticNumRanges = lib.clang_getDiagnosticNumRanges 1262_clang_getDiagnosticNumRanges.argtypes = [Diagnostic] 1263_clang_getDiagnosticNumRanges.restype = c_uint 1264 1265_clang_getDiagnosticRange = lib.clang_getDiagnosticRange 1266_clang_getDiagnosticRange.argtypes = [Diagnostic, c_uint] 1267_clang_getDiagnosticRange.restype = SourceRange 1268 1269_clang_getDiagnosticNumFixIts = lib.clang_getDiagnosticNumFixIts 1270_clang_getDiagnosticNumFixIts.argtypes = [Diagnostic] 1271_clang_getDiagnosticNumFixIts.restype = c_uint 1272 1273_clang_getDiagnosticFixIt = lib.clang_getDiagnosticFixIt 1274_clang_getDiagnosticFixIt.argtypes = [Diagnostic, c_uint, POINTER(SourceRange)] 1275_clang_getDiagnosticFixIt.restype = _CXString 1276_clang_getDiagnosticFixIt.errcheck = _CXString.from_result 1277 1278_clang_getDiagnosticCategory = lib.clang_getDiagnosticCategory 1279_clang_getDiagnosticCategory.argtypes = [Diagnostic] 1280_clang_getDiagnosticCategory.restype = c_uint 1281 1282_clang_getDiagnosticCategoryName = lib.clang_getDiagnosticCategoryName 1283_clang_getDiagnosticCategoryName.argtypes = [c_uint] 1284_clang_getDiagnosticCategoryName.restype = _CXString 1285_clang_getDiagnosticCategoryName.errcheck = _CXString.from_result 1286 1287_clang_getDiagnosticOption = lib.clang_getDiagnosticOption 1288_clang_getDiagnosticOption.argtypes = [Diagnostic, POINTER(_CXString)] 1289_clang_getDiagnosticOption.restype = _CXString 1290_clang_getDiagnosticOption.errcheck = _CXString.from_result 1291 1292### 1293 1294class CompletionChunk: 1295 class Kind: 1296 def __init__(self, name): 1297 self.name = name 1298 1299 def __str__(self): 1300 return self.name 1301 1302 def __repr__(self): 1303 return "<ChunkKind: %s>" % self 1304 1305 def __init__(self, completionString, key): 1306 self.cs = completionString 1307 self.key = key 1308 1309 def __repr__(self): 1310 return "{'" + self.spelling + "', " + str(self.kind) + "}" 1311 1312 @property 1313 def spelling(self): 1314 return _clang_getCompletionChunkText(self.cs, self.key).spelling 1315 1316 @property 1317 def kind(self): 1318 res = _clang_getCompletionChunkKind(self.cs, self.key) 1319 return completionChunkKindMap[res] 1320 1321 @property 1322 def string(self): 1323 res = _clang_getCompletionChunkCompletionString(self.cs, self.key) 1324 1325 if (res): 1326 return CompletionString(res) 1327 else: 1328 None 1329 1330 def isKindOptional(self): 1331 return self.kind == completionChunkKindMap[0] 1332 1333 def isKindTypedText(self): 1334 return self.kind == completionChunkKindMap[1] 1335 1336 def isKindPlaceHolder(self): 1337 return self.kind == completionChunkKindMap[3] 1338 1339 def isKindInformative(self): 1340 return self.kind == completionChunkKindMap[4] 1341 1342 def isKindResultType(self): 1343 return self.kind == completionChunkKindMap[15] 1344 1345completionChunkKindMap = { 1346 0: CompletionChunk.Kind("Optional"), 1347 1: CompletionChunk.Kind("TypedText"), 1348 2: CompletionChunk.Kind("Text"), 1349 3: CompletionChunk.Kind("Placeholder"), 1350 4: CompletionChunk.Kind("Informative"), 1351 5: CompletionChunk.Kind("CurrentParameter"), 1352 6: CompletionChunk.Kind("LeftParen"), 1353 7: CompletionChunk.Kind("RightParen"), 1354 8: CompletionChunk.Kind("LeftBracket"), 1355 9: CompletionChunk.Kind("RightBracket"), 1356 10: CompletionChunk.Kind("LeftBrace"), 1357 11: CompletionChunk.Kind("RightBrace"), 1358 12: CompletionChunk.Kind("LeftAngle"), 1359 13: CompletionChunk.Kind("RightAngle"), 1360 14: CompletionChunk.Kind("Comma"), 1361 15: CompletionChunk.Kind("ResultType"), 1362 16: CompletionChunk.Kind("Colon"), 1363 17: CompletionChunk.Kind("SemiColon"), 1364 18: CompletionChunk.Kind("Equal"), 1365 19: CompletionChunk.Kind("HorizontalSpace"), 1366 20: CompletionChunk.Kind("VerticalSpace")} 1367 1368class CompletionString(ClangObject): 1369 class Availability: 1370 def __init__(self, name): 1371 self.name = name 1372 1373 def __str__(self): 1374 return self.name 1375 1376 def __repr__(self): 1377 return "<Availability: %s>" % self 1378 1379 def __len__(self): 1380 return _clang_getNumCompletionChunks(self.obj) 1381 1382 def __getitem__(self, key): 1383 if len(self) <= key: 1384 raise IndexError 1385 return CompletionChunk(self.obj, key) 1386 1387 @property 1388 def priority(self): 1389 return _clang_getCompletionPriority(self.obj) 1390 1391 @property 1392 def availability(self): 1393 res = _clang_getCompletionAvailability(self.obj) 1394 return availabilityKinds[res] 1395 1396 def __repr__(self): 1397 return " | ".join([str(a) for a in self]) \ 1398 + " || Priority: " + str(self.priority) \ 1399 + " || Availability: " + str(self.availability) 1400 1401availabilityKinds = { 1402 0: CompletionChunk.Kind("Available"), 1403 1: CompletionChunk.Kind("Deprecated"), 1404 2: CompletionChunk.Kind("NotAvailable")} 1405 1406class CodeCompletionResult(Structure): 1407 _fields_ = [('cursorKind', c_int), ('completionString', c_object_p)] 1408 1409 def __repr__(self): 1410 return str(CompletionString(self.completionString)) 1411 1412 @property 1413 def kind(self): 1414 return CursorKind.from_id(self.cursorKind) 1415 1416 @property 1417 def string(self): 1418 return CompletionString(self.completionString) 1419 1420class CCRStructure(Structure): 1421 _fields_ = [('results', POINTER(CodeCompletionResult)), 1422 ('numResults', c_int)] 1423 1424 def __len__(self): 1425 return self.numResults 1426 1427 def __getitem__(self, key): 1428 if len(self) <= key: 1429 raise IndexError 1430 1431 return self.results[key] 1432 1433class CodeCompletionResults(ClangObject): 1434 def __init__(self, ptr): 1435 assert isinstance(ptr, POINTER(CCRStructure)) and ptr 1436 self.ptr = self._as_parameter_ = ptr 1437 1438 def from_param(self): 1439 return self._as_parameter_ 1440 1441 def __del__(self): 1442 CodeCompletionResults_dispose(self) 1443 1444 @property 1445 def results(self): 1446 return self.ptr.contents 1447 1448 @property 1449 def diagnostics(self): 1450 class DiagnosticsItr: 1451 def __init__(self, ccr): 1452 self.ccr= ccr 1453 1454 def __len__(self): 1455 return int(_clang_codeCompleteGetNumDiagnostics(self.ccr)) 1456 1457 def __getitem__(self, key): 1458 return _clang_codeCompleteGetDiagnostic(self.ccr, key) 1459 1460 return DiagnosticsItr(self) 1461 1462 1463class Index(ClangObject): 1464 """ 1465 The Index type provides the primary interface to the Clang CIndex library, 1466 primarily by providing an interface for reading and parsing translation 1467 units. 1468 """ 1469 1470 @staticmethod 1471 def create(excludeDecls=False): 1472 """ 1473 Create a new Index. 1474 Parameters: 1475 excludeDecls -- Exclude local declarations from translation units. 1476 """ 1477 return Index(Index_create(excludeDecls, 0)) 1478 1479 def __del__(self): 1480 Index_dispose(self) 1481 1482 def read(self, path): 1483 """Load the translation unit from the given AST file.""" 1484 ptr = TranslationUnit_read(self, path) 1485 if ptr: 1486 return TranslationUnit(ptr) 1487 return None 1488 1489 def parse(self, path, args = [], unsaved_files = [], options = 0): 1490 """ 1491 Load the translation unit from the given source code file by running 1492 clang and generating the AST before loading. Additional command line 1493 parameters can be passed to clang via the args parameter. 1494 1495 In-memory contents for files can be provided by passing a list of pairs 1496 to as unsaved_files, the first item should be the filenames to be mapped 1497 and the second should be the contents to be substituted for the 1498 file. The contents may be passed as strings or file objects. 1499 """ 1500 arg_array = 0 1501 if len(args): 1502 arg_array = (c_char_p * len(args))(* args) 1503 unsaved_files_array = 0 1504 if len(unsaved_files): 1505 unsaved_files_array = (_CXUnsavedFile * len(unsaved_files))() 1506 for i,(name,value) in enumerate(unsaved_files): 1507 if not isinstance(value, str): 1508 # FIXME: It would be great to support an efficient version 1509 # of this, one day. 1510 value = value.read() 1511 print value 1512 if not isinstance(value, str): 1513 raise TypeError,'Unexpected unsaved file contents.' 1514 unsaved_files_array[i].name = name 1515 unsaved_files_array[i].contents = value 1516 unsaved_files_array[i].length = len(value) 1517 ptr = TranslationUnit_parse(self, path, arg_array, len(args), 1518 unsaved_files_array, len(unsaved_files), 1519 options) 1520 if ptr: 1521 return TranslationUnit(ptr) 1522 return None 1523 1524 1525class TranslationUnit(ClangObject): 1526 """ 1527 The TranslationUnit class represents a source code translation unit and 1528 provides read-only access to its top-level declarations. 1529 """ 1530 1531 def __init__(self, ptr): 1532 ClangObject.__init__(self, ptr) 1533 1534 def __del__(self): 1535 TranslationUnit_dispose(self) 1536 1537 @property 1538 def cursor(self): 1539 """Retrieve the cursor that represents the given translation unit.""" 1540 return TranslationUnit_cursor(self) 1541 1542 @property 1543 def spelling(self): 1544 """Get the original translation unit source file name.""" 1545 return TranslationUnit_spelling(self) 1546 1547 def get_includes(self): 1548 """ 1549 Return an iterable sequence of FileInclusion objects that describe the 1550 sequence of inclusions in a translation unit. The first object in 1551 this sequence is always the input file. Note that this method will not 1552 recursively iterate over header files included through precompiled 1553 headers. 1554 """ 1555 def visitor(fobj, lptr, depth, includes): 1556 if depth > 0: 1557 loc = lptr.contents 1558 includes.append(FileInclusion(loc.file, File(fobj), loc, depth)) 1559 1560 # Automatically adapt CIndex/ctype pointers to python objects 1561 includes = [] 1562 TranslationUnit_includes(self, 1563 TranslationUnit_includes_callback(visitor), 1564 includes) 1565 return iter(includes) 1566 1567 @property 1568 def diagnostics(self): 1569 """ 1570 Return an iterable (and indexable) object containing the diagnostics. 1571 """ 1572 class DiagIterator: 1573 def __init__(self, tu): 1574 self.tu = tu 1575 1576 def __len__(self): 1577 return int(_clang_getNumDiagnostics(self.tu)) 1578 1579 def __getitem__(self, key): 1580 diag = _clang_getDiagnostic(self.tu, key) 1581 if not diag: 1582 raise IndexError 1583 return Diagnostic(diag) 1584 1585 return DiagIterator(self) 1586 1587 def reparse(self, unsaved_files = [], options = 0): 1588 """ 1589 Reparse an already parsed translation unit. 1590 1591 In-memory contents for files can be provided by passing a list of pairs 1592 as unsaved_files, the first items should be the filenames to be mapped 1593 and the second should be the contents to be substituted for the 1594 file. The contents may be passed as strings or file objects. 1595 """ 1596 unsaved_files_array = 0 1597 if len(unsaved_files): 1598 unsaved_files_array = (_CXUnsavedFile * len(unsaved_files))() 1599 for i,(name,value) in enumerate(unsaved_files): 1600 if not isinstance(value, str): 1601 # FIXME: It would be great to support an efficient version 1602 # of this, one day. 1603 value = value.read() 1604 print value 1605 if not isinstance(value, str): 1606 raise TypeError,'Unexpected unsaved file contents.' 1607 unsaved_files_array[i].name = name 1608 unsaved_files_array[i].contents = value 1609 unsaved_files_array[i].length = len(value) 1610 ptr = TranslationUnit_reparse(self, len(unsaved_files), 1611 unsaved_files_array, 1612 options) 1613 def codeComplete(self, path, line, column, unsaved_files = [], options = 0): 1614 """ 1615 Code complete in this translation unit. 1616 1617 In-memory contents for files can be provided by passing a list of pairs 1618 as unsaved_files, the first items should be the filenames to be mapped 1619 and the second should be the contents to be substituted for the 1620 file. The contents may be passed as strings or file objects. 1621 """ 1622 unsaved_files_array = 0 1623 if len(unsaved_files): 1624 unsaved_files_array = (_CXUnsavedFile * len(unsaved_files))() 1625 for i,(name,value) in enumerate(unsaved_files): 1626 if not isinstance(value, str): 1627 # FIXME: It would be great to support an efficient version 1628 # of this, one day. 1629 value = value.read() 1630 print value 1631 if not isinstance(value, str): 1632 raise TypeError,'Unexpected unsaved file contents.' 1633 unsaved_files_array[i].name = name 1634 unsaved_files_array[i].contents = value 1635 unsaved_files_array[i].length = len(value) 1636 ptr = TranslationUnit_codeComplete(self, path, 1637 line, column, 1638 unsaved_files_array, 1639 len(unsaved_files), 1640 options) 1641 if ptr: 1642 return CodeCompletionResults(ptr) 1643 return None 1644 1645class File(ClangObject): 1646 """ 1647 The File class represents a particular source file that is part of a 1648 translation unit. 1649 """ 1650 1651 @staticmethod 1652 def from_name(translation_unit, file_name): 1653 """Retrieve a file handle within the given translation unit.""" 1654 return File(File_getFile(translation_unit, file_name)) 1655 1656 @property 1657 def name(self): 1658 """Return the complete file and path name of the file.""" 1659 return _CXString_getCString(File_name(self)) 1660 1661 @property 1662 def time(self): 1663 """Return the last modification time of the file.""" 1664 return File_time(self) 1665 1666 def __str__(self): 1667 return self.name 1668 1669 def __repr__(self): 1670 return "<File: %s>" % (self.name) 1671 1672class FileInclusion(object): 1673 """ 1674 The FileInclusion class represents the inclusion of one source file by 1675 another via a '#include' directive or as the input file for the translation 1676 unit. This class provides information about the included file, the including 1677 file, the location of the '#include' directive and the depth of the included 1678 file in the stack. Note that the input file has depth 0. 1679 """ 1680 1681 def __init__(self, src, tgt, loc, depth): 1682 self.source = src 1683 self.include = tgt 1684 self.location = loc 1685 self.depth = depth 1686 1687 @property 1688 def is_input_file(self): 1689 """True if the included file is the input file.""" 1690 return self.depth == 0 1691 1692# Additional Functions and Types 1693 1694# String Functions 1695_CXString_dispose = lib.clang_disposeString 1696_CXString_dispose.argtypes = [_CXString] 1697 1698_CXString_getCString = lib.clang_getCString 1699_CXString_getCString.argtypes = [_CXString] 1700_CXString_getCString.restype = c_char_p 1701 1702# Source Location Functions 1703SourceLocation_loc = lib.clang_getInstantiationLocation 1704SourceLocation_loc.argtypes = [SourceLocation, POINTER(c_object_p), 1705 POINTER(c_uint), POINTER(c_uint), 1706 POINTER(c_uint)] 1707 1708SourceLocation_getLocation = lib.clang_getLocation 1709SourceLocation_getLocation.argtypes = [TranslationUnit, File, c_uint, c_uint] 1710SourceLocation_getLocation.restype = SourceLocation 1711 1712SourceLocation_equalLocations = lib.clang_equalLocations 1713SourceLocation_equalLocations.argtypes = [SourceLocation, SourceLocation] 1714SourceLocation_equalLocations.restype = bool 1715 1716# Source Range Functions 1717SourceRange_getRange = lib.clang_getRange 1718SourceRange_getRange.argtypes = [SourceLocation, SourceLocation] 1719SourceRange_getRange.restype = SourceRange 1720 1721SourceRange_start = lib.clang_getRangeStart 1722SourceRange_start.argtypes = [SourceRange] 1723SourceRange_start.restype = SourceLocation 1724 1725SourceRange_end = lib.clang_getRangeEnd 1726SourceRange_end.argtypes = [SourceRange] 1727SourceRange_end.restype = SourceLocation 1728 1729SourceRange_equalRanges = lib.clang_equalRanges 1730SourceRange_equalRanges.argtypes = [SourceRange, SourceRange] 1731SourceRange_equalRanges.restype = bool 1732 1733# CursorKind Functions 1734CursorKind_is_decl = lib.clang_isDeclaration 1735CursorKind_is_decl.argtypes = [CursorKind] 1736CursorKind_is_decl.restype = bool 1737 1738CursorKind_is_ref = lib.clang_isReference 1739CursorKind_is_ref.argtypes = [CursorKind] 1740CursorKind_is_ref.restype = bool 1741 1742CursorKind_is_expr = lib.clang_isExpression 1743CursorKind_is_expr.argtypes = [CursorKind] 1744CursorKind_is_expr.restype = bool 1745 1746CursorKind_is_stmt = lib.clang_isStatement 1747CursorKind_is_stmt.argtypes = [CursorKind] 1748CursorKind_is_stmt.restype = bool 1749 1750CursorKind_is_attribute = lib.clang_isAttribute 1751CursorKind_is_attribute.argtypes = [CursorKind] 1752CursorKind_is_attribute.restype = bool 1753 1754CursorKind_is_inv = lib.clang_isInvalid 1755CursorKind_is_inv.argtypes = [CursorKind] 1756CursorKind_is_inv.restype = bool 1757 1758CursorKind_is_translation_unit = lib.clang_isTranslationUnit 1759CursorKind_is_translation_unit.argtypes = [CursorKind] 1760CursorKind_is_translation_unit.restype = bool 1761 1762CursorKind_is_preprocessing = lib.clang_isPreprocessing 1763CursorKind_is_preprocessing.argtypes = [CursorKind] 1764CursorKind_is_preprocessing.restype = bool 1765 1766CursorKind_is_unexposed = lib.clang_isUnexposed 1767CursorKind_is_unexposed.argtypes = [CursorKind] 1768CursorKind_is_unexposed.restype = bool 1769 1770# Cursor Functions 1771# TODO: Implement this function 1772Cursor_get = lib.clang_getCursor 1773Cursor_get.argtypes = [TranslationUnit, SourceLocation] 1774Cursor_get.restype = Cursor 1775 1776Cursor_null = lib.clang_getNullCursor 1777Cursor_null.restype = Cursor 1778 1779Cursor_usr = lib.clang_getCursorUSR 1780Cursor_usr.argtypes = [Cursor] 1781Cursor_usr.restype = _CXString 1782Cursor_usr.errcheck = _CXString.from_result 1783 1784Cursor_is_def = lib.clang_isCursorDefinition 1785Cursor_is_def.argtypes = [Cursor] 1786Cursor_is_def.restype = bool 1787 1788Cursor_def = lib.clang_getCursorDefinition 1789Cursor_def.argtypes = [Cursor] 1790Cursor_def.restype = Cursor 1791Cursor_def.errcheck = Cursor.from_result 1792 1793Cursor_eq = lib.clang_equalCursors 1794Cursor_eq.argtypes = [Cursor, Cursor] 1795Cursor_eq.restype = c_uint 1796 1797Cursor_hash = lib.clang_hashCursor 1798Cursor_hash.argtypes = [Cursor] 1799Cursor_hash.restype = c_uint 1800 1801Cursor_spelling = lib.clang_getCursorSpelling 1802Cursor_spelling.argtypes = [Cursor] 1803Cursor_spelling.restype = _CXString 1804Cursor_spelling.errcheck = _CXString.from_result 1805 1806Cursor_displayname = lib.clang_getCursorDisplayName 1807Cursor_displayname.argtypes = [Cursor] 1808Cursor_displayname.restype = _CXString 1809Cursor_displayname.errcheck = _CXString.from_result 1810 1811Cursor_loc = lib.clang_getCursorLocation 1812Cursor_loc.argtypes = [Cursor] 1813Cursor_loc.restype = SourceLocation 1814 1815Cursor_extent = lib.clang_getCursorExtent 1816Cursor_extent.argtypes = [Cursor] 1817Cursor_extent.restype = SourceRange 1818 1819Cursor_ref = lib.clang_getCursorReferenced 1820Cursor_ref.argtypes = [Cursor] 1821Cursor_ref.restype = Cursor 1822Cursor_ref.errcheck = Cursor.from_result 1823 1824Cursor_type = lib.clang_getCursorType 1825Cursor_type.argtypes = [Cursor] 1826Cursor_type.restype = Type 1827Cursor_type.errcheck = Type.from_result 1828 1829Cursor_underlying_type = lib.clang_getTypedefDeclUnderlyingType 1830Cursor_underlying_type.argtypes = [Cursor] 1831Cursor_underlying_type.restype = Type 1832Cursor_underlying_type.errcheck = Type.from_result 1833 1834Cursor_enum_type = lib.clang_getEnumDeclIntegerType 1835Cursor_enum_type.argtypes = [Cursor] 1836Cursor_enum_type.restype = Type 1837Cursor_enum_type.errcheck = Type.from_result 1838 1839Cursor_visit_callback = CFUNCTYPE(c_int, Cursor, Cursor, py_object) 1840Cursor_visit = lib.clang_visitChildren 1841Cursor_visit.argtypes = [Cursor, Cursor_visit_callback, py_object] 1842Cursor_visit.restype = c_uint 1843 1844# Type Functions 1845Type_get_canonical = lib.clang_getCanonicalType 1846Type_get_canonical.argtypes = [Type] 1847Type_get_canonical.restype = Type 1848Type_get_canonical.errcheck = Type.from_result 1849 1850Type_is_const_qualified = lib.clang_isConstQualifiedType 1851Type_is_const_qualified.argtypes = [Type] 1852Type_is_const_qualified.restype = bool 1853 1854Type_is_volatile_qualified = lib.clang_isVolatileQualifiedType 1855Type_is_volatile_qualified.argtypes = [Type] 1856Type_is_volatile_qualified.restype = bool 1857 1858Type_is_restrict_qualified = lib.clang_isRestrictQualifiedType 1859Type_is_restrict_qualified.argtypes = [Type] 1860Type_is_restrict_qualified.restype = bool 1861 1862Type_get_pointee = lib.clang_getPointeeType 1863Type_get_pointee.argtypes = [Type] 1864Type_get_pointee.restype = Type 1865Type_get_pointee.errcheck = Type.from_result 1866 1867Type_get_declaration = lib.clang_getTypeDeclaration 1868Type_get_declaration.argtypes = [Type] 1869Type_get_declaration.restype = Cursor 1870Type_get_declaration.errcheck = Cursor.from_result 1871 1872Type_get_result = lib.clang_getResultType 1873Type_get_result.argtypes = [Type] 1874Type_get_result.restype = Type 1875Type_get_result.errcheck = Type.from_result 1876 1877Type_get_array_element = lib.clang_getArrayElementType 1878Type_get_array_element.argtypes = [Type] 1879Type_get_array_element.restype = Type 1880Type_get_array_element.errcheck = Type.from_result 1881 1882Type_get_array_size = lib.clang_getArraySize 1883Type_get_array_size.argtype = [Type] 1884Type_get_array_size.restype = c_longlong 1885 1886# Index Functions 1887Index_create = lib.clang_createIndex 1888Index_create.argtypes = [c_int, c_int] 1889Index_create.restype = c_object_p 1890 1891Index_dispose = lib.clang_disposeIndex 1892Index_dispose.argtypes = [Index] 1893 1894# Translation Unit Functions 1895TranslationUnit_read = lib.clang_createTranslationUnit 1896TranslationUnit_read.argtypes = [Index, c_char_p] 1897TranslationUnit_read.restype = c_object_p 1898 1899TranslationUnit_parse = lib.clang_parseTranslationUnit 1900TranslationUnit_parse.argtypes = [Index, c_char_p, c_void_p, 1901 c_int, c_void_p, c_int, c_int] 1902TranslationUnit_parse.restype = c_object_p 1903 1904TranslationUnit_reparse = lib.clang_reparseTranslationUnit 1905TranslationUnit_reparse.argtypes = [TranslationUnit, c_int, c_void_p, c_int] 1906TranslationUnit_reparse.restype = c_int 1907 1908TranslationUnit_codeComplete = lib.clang_codeCompleteAt 1909TranslationUnit_codeComplete.argtypes = [TranslationUnit, c_char_p, c_int, 1910 c_int, c_void_p, c_int, c_int] 1911TranslationUnit_codeComplete.restype = POINTER(CCRStructure) 1912 1913TranslationUnit_cursor = lib.clang_getTranslationUnitCursor 1914TranslationUnit_cursor.argtypes = [TranslationUnit] 1915TranslationUnit_cursor.restype = Cursor 1916TranslationUnit_cursor.errcheck = Cursor.from_result 1917 1918TranslationUnit_spelling = lib.clang_getTranslationUnitSpelling 1919TranslationUnit_spelling.argtypes = [TranslationUnit] 1920TranslationUnit_spelling.restype = _CXString 1921TranslationUnit_spelling.errcheck = _CXString.from_result 1922 1923TranslationUnit_dispose = lib.clang_disposeTranslationUnit 1924TranslationUnit_dispose.argtypes = [TranslationUnit] 1925 1926TranslationUnit_includes_callback = CFUNCTYPE(None, 1927 c_object_p, 1928 POINTER(SourceLocation), 1929 c_uint, py_object) 1930TranslationUnit_includes = lib.clang_getInclusions 1931TranslationUnit_includes.argtypes = [TranslationUnit, 1932 TranslationUnit_includes_callback, 1933 py_object] 1934 1935# File Functions 1936File_getFile = lib.clang_getFile 1937File_getFile.argtypes = [TranslationUnit, c_char_p] 1938File_getFile.restype = c_object_p 1939 1940File_name = lib.clang_getFileName 1941File_name.argtypes = [File] 1942File_name.restype = _CXString 1943 1944File_time = lib.clang_getFileTime 1945File_time.argtypes = [File] 1946File_time.restype = c_uint 1947 1948# Code completion 1949 1950CodeCompletionResults_dispose = lib.clang_disposeCodeCompleteResults 1951CodeCompletionResults_dispose.argtypes = [CodeCompletionResults] 1952 1953_clang_codeCompleteGetNumDiagnostics = lib.clang_codeCompleteGetNumDiagnostics 1954_clang_codeCompleteGetNumDiagnostics.argtypes = [CodeCompletionResults] 1955_clang_codeCompleteGetNumDiagnostics.restype = c_int 1956 1957_clang_codeCompleteGetDiagnostic = lib.clang_codeCompleteGetDiagnostic 1958_clang_codeCompleteGetDiagnostic.argtypes = [CodeCompletionResults, c_int] 1959_clang_codeCompleteGetDiagnostic.restype = Diagnostic 1960 1961_clang_getCompletionChunkText = lib.clang_getCompletionChunkText 1962_clang_getCompletionChunkText.argtypes = [c_void_p, c_int] 1963_clang_getCompletionChunkText.restype = _CXString 1964 1965_clang_getCompletionChunkKind = lib.clang_getCompletionChunkKind 1966_clang_getCompletionChunkKind.argtypes = [c_void_p, c_int] 1967_clang_getCompletionChunkKind.restype = c_int 1968 1969_clang_getCompletionChunkCompletionString = lib.clang_getCompletionChunkCompletionString 1970_clang_getCompletionChunkCompletionString.argtypes = [c_void_p, c_int] 1971_clang_getCompletionChunkCompletionString.restype = c_object_p 1972 1973_clang_getNumCompletionChunks = lib.clang_getNumCompletionChunks 1974_clang_getNumCompletionChunks.argtypes = [c_void_p] 1975_clang_getNumCompletionChunks.restype = c_int 1976 1977_clang_getCompletionAvailability = lib.clang_getCompletionAvailability 1978_clang_getCompletionAvailability.argtypes = [c_void_p] 1979_clang_getCompletionAvailability.restype = c_int 1980 1981_clang_getCompletionPriority = lib.clang_getCompletionPriority 1982_clang_getCompletionPriority.argtypes = [c_void_p] 1983_clang_getCompletionPriority.restype = c_int 1984 1985 1986### 1987 1988__all__ = ['Index', 'TranslationUnit', 'Cursor', 'CursorKind', 'Type', 'TypeKind', 1989 'Diagnostic', 'FixIt', 'CodeCompletionResults', 'SourceRange', 1990 'SourceLocation', 'File'] 1991