Index.h revision 34ebe1e1b0779bcea2f277bc6b4e9dd98bf70b7b
1/*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\ 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|* *| 10|* This header provides a public inferface to a Clang library for extracting *| 11|* high-level symbol information from source files without exposing the full *| 12|* Clang C++ API. *| 13|* *| 14\*===----------------------------------------------------------------------===*/ 15 16#ifndef CLANG_C_INDEX_H 17#define CLANG_C_INDEX_H 18 19#include <sys/stat.h> 20#include <time.h> 21#include <stdio.h> 22 23#ifdef __cplusplus 24extern "C" { 25#endif 26 27/* MSVC DLL import/export. */ 28#ifdef _MSC_VER 29 #ifdef _CINDEX_LIB_ 30 #define CINDEX_LINKAGE __declspec(dllexport) 31 #else 32 #define CINDEX_LINKAGE __declspec(dllimport) 33 #endif 34#else 35 #define CINDEX_LINKAGE 36#endif 37 38/** \defgroup CINDEX libclang: C Interface to Clang 39 * 40 * The C Interface to Clang provides a relatively small API that exposes 41 * facilities for parsing source code into an abstract syntax tree (AST), 42 * loading already-parsed ASTs, traversing the AST, associating 43 * physical source locations with elements within the AST, and other 44 * facilities that support Clang-based development tools. 45 * 46 * This C interface to Clang will never provide all of the information 47 * representation stored in Clang's C++ AST, nor should it: the intent is to 48 * maintain an API that is relatively stable from one release to the next, 49 * providing only the basic functionality needed to support development tools. 50 * 51 * To avoid namespace pollution, data types are prefixed with "CX" and 52 * functions are prefixed with "clang_". 53 * 54 * @{ 55 */ 56 57/** 58 * \brief An "index" that consists of a set of translation units that would 59 * typically be linked together into an executable or library. 60 */ 61typedef void *CXIndex; 62 63/** 64 * \brief A single translation unit, which resides in an index. 65 */ 66typedef struct CXTranslationUnitImpl *CXTranslationUnit; 67 68/** 69 * \brief Opaque pointer representing client data that will be passed through 70 * to various callbacks and visitors. 71 */ 72typedef void *CXClientData; 73 74/** 75 * \brief Provides the contents of a file that has not yet been saved to disk. 76 * 77 * Each CXUnsavedFile instance provides the name of a file on the 78 * system along with the current contents of that file that have not 79 * yet been saved to disk. 80 */ 81struct CXUnsavedFile { 82 /** 83 * \brief The file whose contents have not yet been saved. 84 * 85 * This file must already exist in the file system. 86 */ 87 const char *Filename; 88 89 /** 90 * \brief A buffer containing the unsaved contents of this file. 91 */ 92 const char *Contents; 93 94 /** 95 * \brief The length of the unsaved contents of this buffer. 96 */ 97 unsigned long Length; 98}; 99 100/** 101 * \brief Describes the availability of a particular entity, which indicates 102 * whether the use of this entity will result in a warning or error due to 103 * it being deprecated or unavailable. 104 */ 105enum CXAvailabilityKind { 106 /** 107 * \brief The entity is available. 108 */ 109 CXAvailability_Available, 110 /** 111 * \brief The entity is available, but has been deprecated (and its use is 112 * not recommended). 113 */ 114 CXAvailability_Deprecated, 115 /** 116 * \brief The entity is not available; any use of it will be an error. 117 */ 118 CXAvailability_NotAvailable, 119 /** 120 * \brief The entity is available, but not accessible; any use of it will be 121 * an error. 122 */ 123 CXAvailability_NotAccessible 124}; 125 126/** 127 * \defgroup CINDEX_STRING String manipulation routines 128 * 129 * @{ 130 */ 131 132/** 133 * \brief A character string. 134 * 135 * The \c CXString type is used to return strings from the interface when 136 * the ownership of that string might different from one call to the next. 137 * Use \c clang_getCString() to retrieve the string data and, once finished 138 * with the string data, call \c clang_disposeString() to free the string. 139 */ 140typedef struct { 141 void *data; 142 unsigned private_flags; 143} CXString; 144 145/** 146 * \brief Retrieve the character data associated with the given string. 147 */ 148CINDEX_LINKAGE const char *clang_getCString(CXString string); 149 150/** 151 * \brief Free the given string, 152 */ 153CINDEX_LINKAGE void clang_disposeString(CXString string); 154 155/** 156 * @} 157 */ 158 159/** 160 * \brief clang_createIndex() provides a shared context for creating 161 * translation units. It provides two options: 162 * 163 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local" 164 * declarations (when loading any new translation units). A "local" declaration 165 * is one that belongs in the translation unit itself and not in a precompiled 166 * header that was used by the translation unit. If zero, all declarations 167 * will be enumerated. 168 * 169 * Here is an example: 170 * 171 * // excludeDeclsFromPCH = 1, displayDiagnostics=1 172 * Idx = clang_createIndex(1, 1); 173 * 174 * // IndexTest.pch was produced with the following command: 175 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch" 176 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch"); 177 * 178 * // This will load all the symbols from 'IndexTest.pch' 179 * clang_visitChildren(clang_getTranslationUnitCursor(TU), 180 * TranslationUnitVisitor, 0); 181 * clang_disposeTranslationUnit(TU); 182 * 183 * // This will load all the symbols from 'IndexTest.c', excluding symbols 184 * // from 'IndexTest.pch'. 185 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" }; 186 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args, 187 * 0, 0); 188 * clang_visitChildren(clang_getTranslationUnitCursor(TU), 189 * TranslationUnitVisitor, 0); 190 * clang_disposeTranslationUnit(TU); 191 * 192 * This process of creating the 'pch', loading it separately, and using it (via 193 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks 194 * (which gives the indexer the same performance benefit as the compiler). 195 */ 196CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 197 int displayDiagnostics); 198 199/** 200 * \brief Destroy the given index. 201 * 202 * The index must not be destroyed until all of the translation units created 203 * within that index have been destroyed. 204 */ 205CINDEX_LINKAGE void clang_disposeIndex(CXIndex index); 206 207typedef enum { 208 /** 209 * \brief Used to indicate that no special CXIndex options are needed. 210 */ 211 CXGlobalOpt_None = 0x0, 212 213 /** 214 * \brief Used to indicate that threads that libclang creates for indexing 215 * purposes should use background priority. 216 * Affects \see clang_indexSourceFile, \see clang_indexTranslationUnit, 217 * \see clang_parseTranslationUnit, \see clang_saveTranslationUnit. 218 */ 219 CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1, 220 221 /** 222 * \brief Used to indicate that threads that libclang creates for editing 223 * purposes should use background priority. 224 * Affects \see clang_reparseTranslationUnit, \see clang_codeCompleteAt, 225 * \see clang_annotateTokens 226 */ 227 CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2, 228 229 /** 230 * \brief Used to indicate that all threads that libclang creates should use 231 * background priority. 232 */ 233 CXGlobalOpt_ThreadBackgroundPriorityForAll = 234 CXGlobalOpt_ThreadBackgroundPriorityForIndexing | 235 CXGlobalOpt_ThreadBackgroundPriorityForEditing 236 237} CXGlobalOptFlags; 238 239/** 240 * \brief Sets general options associated with a CXIndex. 241 * 242 * For example: 243 * \code 244 * CXIndex idx = ...; 245 * clang_CXIndex_setGlobalOptions(idx, 246 * clang_CXIndex_getGlobalOptions(idx) | 247 * CXGlobalOpt_ThreadBackgroundPriorityForIndexing); 248 * \endcode 249 * 250 * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags. 251 */ 252CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options); 253 254/** 255 * \brief Gets the general options associated with a CXIndex. 256 * 257 * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that 258 * are associated with the given CXIndex object. 259 */ 260CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex); 261 262/** 263 * \defgroup CINDEX_FILES File manipulation routines 264 * 265 * @{ 266 */ 267 268/** 269 * \brief A particular source file that is part of a translation unit. 270 */ 271typedef void *CXFile; 272 273 274/** 275 * \brief Retrieve the complete file and path name of the given file. 276 */ 277CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile); 278 279/** 280 * \brief Retrieve the last modification time of the given file. 281 */ 282CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile); 283 284/** 285 * \brief Determine whether the given header is guarded against 286 * multiple inclusions, either with the conventional 287 * #ifndef/#define/#endif macro guards or with #pragma once. 288 */ 289CINDEX_LINKAGE unsigned 290clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file); 291 292/** 293 * \brief Retrieve a file handle within the given translation unit. 294 * 295 * \param tu the translation unit 296 * 297 * \param file_name the name of the file. 298 * 299 * \returns the file handle for the named file in the translation unit \p tu, 300 * or a NULL file handle if the file was not a part of this translation unit. 301 */ 302CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 303 const char *file_name); 304 305/** 306 * @} 307 */ 308 309/** 310 * \defgroup CINDEX_LOCATIONS Physical source locations 311 * 312 * Clang represents physical source locations in its abstract syntax tree in 313 * great detail, with file, line, and column information for the majority of 314 * the tokens parsed in the source code. These data types and functions are 315 * used to represent source location information, either for a particular 316 * point in the program or for a range of points in the program, and extract 317 * specific location information from those data types. 318 * 319 * @{ 320 */ 321 322/** 323 * \brief Identifies a specific source location within a translation 324 * unit. 325 * 326 * Use clang_getExpansionLocation() or clang_getSpellingLocation() 327 * to map a source location to a particular file, line, and column. 328 */ 329typedef struct { 330 void *ptr_data[2]; 331 unsigned int_data; 332} CXSourceLocation; 333 334/** 335 * \brief Identifies a half-open character range in the source code. 336 * 337 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 338 * starting and end locations from a source range, respectively. 339 */ 340typedef struct { 341 void *ptr_data[2]; 342 unsigned begin_int_data; 343 unsigned end_int_data; 344} CXSourceRange; 345 346/** 347 * \brief Retrieve a NULL (invalid) source location. 348 */ 349CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(); 350 351/** 352 * \determine Determine whether two source locations, which must refer into 353 * the same translation unit, refer to exactly the same point in the source 354 * code. 355 * 356 * \returns non-zero if the source locations refer to the same location, zero 357 * if they refer to different locations. 358 */ 359CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 360 CXSourceLocation loc2); 361 362/** 363 * \brief Retrieves the source location associated with a given file/line/column 364 * in a particular translation unit. 365 */ 366CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 367 CXFile file, 368 unsigned line, 369 unsigned column); 370/** 371 * \brief Retrieves the source location associated with a given character offset 372 * in a particular translation unit. 373 */ 374CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 375 CXFile file, 376 unsigned offset); 377 378/** 379 * \brief Retrieve a NULL (invalid) source range. 380 */ 381CINDEX_LINKAGE CXSourceRange clang_getNullRange(); 382 383/** 384 * \brief Retrieve a source range given the beginning and ending source 385 * locations. 386 */ 387CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin, 388 CXSourceLocation end); 389 390/** 391 * \brief Determine whether two ranges are equivalent. 392 * 393 * \returns non-zero if the ranges are the same, zero if they differ. 394 */ 395CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1, 396 CXSourceRange range2); 397 398/** 399 * \brief Returns non-zero if \arg range is null. 400 */ 401CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range); 402 403/** 404 * \brief Retrieve the file, line, column, and offset represented by 405 * the given source location. 406 * 407 * If the location refers into a macro expansion, retrieves the 408 * location of the macro expansion. 409 * 410 * \param location the location within a source file that will be decomposed 411 * into its parts. 412 * 413 * \param file [out] if non-NULL, will be set to the file to which the given 414 * source location points. 415 * 416 * \param line [out] if non-NULL, will be set to the line to which the given 417 * source location points. 418 * 419 * \param column [out] if non-NULL, will be set to the column to which the given 420 * source location points. 421 * 422 * \param offset [out] if non-NULL, will be set to the offset into the 423 * buffer to which the given source location points. 424 */ 425CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location, 426 CXFile *file, 427 unsigned *line, 428 unsigned *column, 429 unsigned *offset); 430 431/** 432 * \brief Retrieve the file, line, column, and offset represented by 433 * the given source location, as specified in a # line directive. 434 * 435 * Example: given the following source code in a file somefile.c 436 * 437 * #123 "dummy.c" 1 438 * 439 * static int func(void) 440 * { 441 * return 0; 442 * } 443 * 444 * the location information returned by this function would be 445 * 446 * File: dummy.c Line: 124 Column: 12 447 * 448 * whereas clang_getExpansionLocation would have returned 449 * 450 * File: somefile.c Line: 3 Column: 12 451 * 452 * \param location the location within a source file that will be decomposed 453 * into its parts. 454 * 455 * \param filename [out] if non-NULL, will be set to the filename of the 456 * source location. Note that filenames returned will be for "virtual" files, 457 * which don't necessarily exist on the machine running clang - e.g. when 458 * parsing preprocessed output obtained from a different environment. If 459 * a non-NULL value is passed in, remember to dispose of the returned value 460 * using \c clang_disposeString() once you've finished with it. For an invalid 461 * source location, an empty string is returned. 462 * 463 * \param line [out] if non-NULL, will be set to the line number of the 464 * source location. For an invalid source location, zero is returned. 465 * 466 * \param column [out] if non-NULL, will be set to the column number of the 467 * source location. For an invalid source location, zero is returned. 468 */ 469CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location, 470 CXString *filename, 471 unsigned *line, 472 unsigned *column); 473 474/** 475 * \brief Legacy API to retrieve the file, line, column, and offset represented 476 * by the given source location. 477 * 478 * This interface has been replaced by the newer interface 479 * \see clang_getExpansionLocation(). See that interface's documentation for 480 * details. 481 */ 482CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location, 483 CXFile *file, 484 unsigned *line, 485 unsigned *column, 486 unsigned *offset); 487 488/** 489 * \brief Retrieve the file, line, column, and offset represented by 490 * the given source location. 491 * 492 * If the location refers into a macro instantiation, return where the 493 * location was originally spelled in the source file. 494 * 495 * \param location the location within a source file that will be decomposed 496 * into its parts. 497 * 498 * \param file [out] if non-NULL, will be set to the file to which the given 499 * source location points. 500 * 501 * \param line [out] if non-NULL, will be set to the line to which the given 502 * source location points. 503 * 504 * \param column [out] if non-NULL, will be set to the column to which the given 505 * source location points. 506 * 507 * \param offset [out] if non-NULL, will be set to the offset into the 508 * buffer to which the given source location points. 509 */ 510CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location, 511 CXFile *file, 512 unsigned *line, 513 unsigned *column, 514 unsigned *offset); 515 516/** 517 * \brief Retrieve a source location representing the first character within a 518 * source range. 519 */ 520CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 521 522/** 523 * \brief Retrieve a source location representing the last character within a 524 * source range. 525 */ 526CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range); 527 528/** 529 * @} 530 */ 531 532/** 533 * \defgroup CINDEX_DIAG Diagnostic reporting 534 * 535 * @{ 536 */ 537 538/** 539 * \brief Describes the severity of a particular diagnostic. 540 */ 541enum CXDiagnosticSeverity { 542 /** 543 * \brief A diagnostic that has been suppressed, e.g., by a command-line 544 * option. 545 */ 546 CXDiagnostic_Ignored = 0, 547 548 /** 549 * \brief This diagnostic is a note that should be attached to the 550 * previous (non-note) diagnostic. 551 */ 552 CXDiagnostic_Note = 1, 553 554 /** 555 * \brief This diagnostic indicates suspicious code that may not be 556 * wrong. 557 */ 558 CXDiagnostic_Warning = 2, 559 560 /** 561 * \brief This diagnostic indicates that the code is ill-formed. 562 */ 563 CXDiagnostic_Error = 3, 564 565 /** 566 * \brief This diagnostic indicates that the code is ill-formed such 567 * that future parser recovery is unlikely to produce useful 568 * results. 569 */ 570 CXDiagnostic_Fatal = 4 571}; 572 573/** 574 * \brief A single diagnostic, containing the diagnostic's severity, 575 * location, text, source ranges, and fix-it hints. 576 */ 577typedef void *CXDiagnostic; 578 579/** 580 * \brief A group of CXDiagnostics. 581 */ 582typedef void *CXDiagnosticSet; 583 584/** 585 * \brief Determine the number of diagnostics in a CXDiagnosticSet. 586 */ 587CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags); 588 589/** 590 * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet. 591 * 592 * \param Unit the CXDiagnosticSet to query. 593 * \param Index the zero-based diagnostic number to retrieve. 594 * 595 * \returns the requested diagnostic. This diagnostic must be freed 596 * via a call to \c clang_disposeDiagnostic(). 597 */ 598CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags, 599 unsigned Index); 600 601 602/** 603 * \brief Describes the kind of error that occurred (if any) in a call to 604 * \c clang_loadDiagnostics. 605 */ 606enum CXLoadDiag_Error { 607 /** 608 * \brief Indicates that no error occurred. 609 */ 610 CXLoadDiag_None = 0, 611 612 /** 613 * \brief Indicates that an unknown error occurred while attempting to 614 * deserialize diagnostics. 615 */ 616 CXLoadDiag_Unknown = 1, 617 618 /** 619 * \brief Indicates that the file containing the serialized diagnostics 620 * could not be opened. 621 */ 622 CXLoadDiag_CannotLoad = 2, 623 624 /** 625 * \brief Indicates that the serialized diagnostics file is invalid or 626 * corrupt. 627 */ 628 CXLoadDiag_InvalidFile = 3 629}; 630 631/** 632 * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode 633 * file. 634 * 635 * \param The name of the file to deserialize. 636 * \param A pointer to a enum value recording if there was a problem 637 * deserializing the diagnostics. 638 * \param A pointer to a CXString for recording the error string 639 * if the file was not successfully loaded. 640 * 641 * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These 642 * diagnostics should be released using clang_disposeDiagnosticSet(). 643 */ 644CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file, 645 enum CXLoadDiag_Error *error, 646 CXString *errorString); 647 648/** 649 * \brief Release a CXDiagnosticSet and all of its contained diagnostics. 650 */ 651CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags); 652 653/** 654 * \brief Retrieve the child diagnostics of a CXDiagnostic. This 655 * CXDiagnosticSet does not need to be released by clang_diposeDiagnosticSet. 656 */ 657CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D); 658 659/** 660 * \brief Determine the number of diagnostics produced for the given 661 * translation unit. 662 */ 663CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit); 664 665/** 666 * \brief Retrieve a diagnostic associated with the given translation unit. 667 * 668 * \param Unit the translation unit to query. 669 * \param Index the zero-based diagnostic number to retrieve. 670 * 671 * \returns the requested diagnostic. This diagnostic must be freed 672 * via a call to \c clang_disposeDiagnostic(). 673 */ 674CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit, 675 unsigned Index); 676 677/** 678 * \brief Retrieve the complete set of diagnostics associated with a 679 * translation unit. 680 * 681 * \param Unit the translation unit to query. 682 */ 683CINDEX_LINKAGE CXDiagnosticSet 684 clang_getDiagnosticSetFromTU(CXTranslationUnit Unit); 685 686/** 687 * \brief Destroy a diagnostic. 688 */ 689CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic); 690 691/** 692 * \brief Options to control the display of diagnostics. 693 * 694 * The values in this enum are meant to be combined to customize the 695 * behavior of \c clang_displayDiagnostic(). 696 */ 697enum CXDiagnosticDisplayOptions { 698 /** 699 * \brief Display the source-location information where the 700 * diagnostic was located. 701 * 702 * When set, diagnostics will be prefixed by the file, line, and 703 * (optionally) column to which the diagnostic refers. For example, 704 * 705 * \code 706 * test.c:28: warning: extra tokens at end of #endif directive 707 * \endcode 708 * 709 * This option corresponds to the clang flag \c -fshow-source-location. 710 */ 711 CXDiagnostic_DisplaySourceLocation = 0x01, 712 713 /** 714 * \brief If displaying the source-location information of the 715 * diagnostic, also include the column number. 716 * 717 * This option corresponds to the clang flag \c -fshow-column. 718 */ 719 CXDiagnostic_DisplayColumn = 0x02, 720 721 /** 722 * \brief If displaying the source-location information of the 723 * diagnostic, also include information about source ranges in a 724 * machine-parsable format. 725 * 726 * This option corresponds to the clang flag 727 * \c -fdiagnostics-print-source-range-info. 728 */ 729 CXDiagnostic_DisplaySourceRanges = 0x04, 730 731 /** 732 * \brief Display the option name associated with this diagnostic, if any. 733 * 734 * The option name displayed (e.g., -Wconversion) will be placed in brackets 735 * after the diagnostic text. This option corresponds to the clang flag 736 * \c -fdiagnostics-show-option. 737 */ 738 CXDiagnostic_DisplayOption = 0x08, 739 740 /** 741 * \brief Display the category number associated with this diagnostic, if any. 742 * 743 * The category number is displayed within brackets after the diagnostic text. 744 * This option corresponds to the clang flag 745 * \c -fdiagnostics-show-category=id. 746 */ 747 CXDiagnostic_DisplayCategoryId = 0x10, 748 749 /** 750 * \brief Display the category name associated with this diagnostic, if any. 751 * 752 * The category name is displayed within brackets after the diagnostic text. 753 * This option corresponds to the clang flag 754 * \c -fdiagnostics-show-category=name. 755 */ 756 CXDiagnostic_DisplayCategoryName = 0x20 757}; 758 759/** 760 * \brief Format the given diagnostic in a manner that is suitable for display. 761 * 762 * This routine will format the given diagnostic to a string, rendering 763 * the diagnostic according to the various options given. The 764 * \c clang_defaultDiagnosticDisplayOptions() function returns the set of 765 * options that most closely mimics the behavior of the clang compiler. 766 * 767 * \param Diagnostic The diagnostic to print. 768 * 769 * \param Options A set of options that control the diagnostic display, 770 * created by combining \c CXDiagnosticDisplayOptions values. 771 * 772 * \returns A new string containing for formatted diagnostic. 773 */ 774CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic, 775 unsigned Options); 776 777/** 778 * \brief Retrieve the set of display options most similar to the 779 * default behavior of the clang compiler. 780 * 781 * \returns A set of display options suitable for use with \c 782 * clang_displayDiagnostic(). 783 */ 784CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 785 786/** 787 * \brief Determine the severity of the given diagnostic. 788 */ 789CINDEX_LINKAGE enum CXDiagnosticSeverity 790clang_getDiagnosticSeverity(CXDiagnostic); 791 792/** 793 * \brief Retrieve the source location of the given diagnostic. 794 * 795 * This location is where Clang would print the caret ('^') when 796 * displaying the diagnostic on the command line. 797 */ 798CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 799 800/** 801 * \brief Retrieve the text of the given diagnostic. 802 */ 803CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic); 804 805/** 806 * \brief Retrieve the name of the command-line option that enabled this 807 * diagnostic. 808 * 809 * \param Diag The diagnostic to be queried. 810 * 811 * \param Disable If non-NULL, will be set to the option that disables this 812 * diagnostic (if any). 813 * 814 * \returns A string that contains the command-line option used to enable this 815 * warning, such as "-Wconversion" or "-pedantic". 816 */ 817CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag, 818 CXString *Disable); 819 820/** 821 * \brief Retrieve the category number for this diagnostic. 822 * 823 * Diagnostics can be categorized into groups along with other, related 824 * diagnostics (e.g., diagnostics under the same warning flag). This routine 825 * retrieves the category number for the given diagnostic. 826 * 827 * \returns The number of the category that contains this diagnostic, or zero 828 * if this diagnostic is uncategorized. 829 */ 830CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic); 831 832/** 833 * \brief Retrieve the name of a particular diagnostic category. 834 * 835 * \param Category A diagnostic category number, as returned by 836 * \c clang_getDiagnosticCategory(). 837 * 838 * \returns The name of the given diagnostic category. 839 */ 840CINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category); 841 842/** 843 * \brief Determine the number of source ranges associated with the given 844 * diagnostic. 845 */ 846CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic); 847 848/** 849 * \brief Retrieve a source range associated with the diagnostic. 850 * 851 * A diagnostic's source ranges highlight important elements in the source 852 * code. On the command line, Clang displays source ranges by 853 * underlining them with '~' characters. 854 * 855 * \param Diagnostic the diagnostic whose range is being extracted. 856 * 857 * \param Range the zero-based index specifying which range to 858 * 859 * \returns the requested source range. 860 */ 861CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic, 862 unsigned Range); 863 864/** 865 * \brief Determine the number of fix-it hints associated with the 866 * given diagnostic. 867 */ 868CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic); 869 870/** 871 * \brief Retrieve the replacement information for a given fix-it. 872 * 873 * Fix-its are described in terms of a source range whose contents 874 * should be replaced by a string. This approach generalizes over 875 * three kinds of operations: removal of source code (the range covers 876 * the code to be removed and the replacement string is empty), 877 * replacement of source code (the range covers the code to be 878 * replaced and the replacement string provides the new code), and 879 * insertion (both the start and end of the range point at the 880 * insertion location, and the replacement string provides the text to 881 * insert). 882 * 883 * \param Diagnostic The diagnostic whose fix-its are being queried. 884 * 885 * \param FixIt The zero-based index of the fix-it. 886 * 887 * \param ReplacementRange The source range whose contents will be 888 * replaced with the returned replacement string. Note that source 889 * ranges are half-open ranges [a, b), so the source code should be 890 * replaced from a and up to (but not including) b. 891 * 892 * \returns A string containing text that should be replace the source 893 * code indicated by the \c ReplacementRange. 894 */ 895CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic, 896 unsigned FixIt, 897 CXSourceRange *ReplacementRange); 898 899/** 900 * @} 901 */ 902 903/** 904 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation 905 * 906 * The routines in this group provide the ability to create and destroy 907 * translation units from files, either by parsing the contents of the files or 908 * by reading in a serialized representation of a translation unit. 909 * 910 * @{ 911 */ 912 913/** 914 * \brief Get the original translation unit source file name. 915 */ 916CINDEX_LINKAGE CXString 917clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit); 918 919/** 920 * \brief Return the CXTranslationUnit for a given source file and the provided 921 * command line arguments one would pass to the compiler. 922 * 923 * Note: The 'source_filename' argument is optional. If the caller provides a 924 * NULL pointer, the name of the source file is expected to reside in the 925 * specified command line arguments. 926 * 927 * Note: When encountered in 'clang_command_line_args', the following options 928 * are ignored: 929 * 930 * '-c' 931 * '-emit-ast' 932 * '-fsyntax-only' 933 * '-o <output file>' (both '-o' and '<output file>' are ignored) 934 * 935 * \param CIdx The index object with which the translation unit will be 936 * associated. 937 * 938 * \param source_filename - The name of the source file to load, or NULL if the 939 * source file is included in \p clang_command_line_args. 940 * 941 * \param num_clang_command_line_args The number of command-line arguments in 942 * \p clang_command_line_args. 943 * 944 * \param clang_command_line_args The command-line arguments that would be 945 * passed to the \c clang executable if it were being invoked out-of-process. 946 * These command-line options will be parsed and will affect how the translation 947 * unit is parsed. Note that the following options are ignored: '-c', 948 * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 949 * 950 * \param num_unsaved_files the number of unsaved file entries in \p 951 * unsaved_files. 952 * 953 * \param unsaved_files the files that have not yet been saved to disk 954 * but may be required for code completion, including the contents of 955 * those files. The contents and name of these files (as specified by 956 * CXUnsavedFile) are copied when necessary, so the client only needs to 957 * guarantee their validity until the call to this function returns. 958 */ 959CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile( 960 CXIndex CIdx, 961 const char *source_filename, 962 int num_clang_command_line_args, 963 const char * const *clang_command_line_args, 964 unsigned num_unsaved_files, 965 struct CXUnsavedFile *unsaved_files); 966 967/** 968 * \brief Create a translation unit from an AST file (-emit-ast). 969 */ 970CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex, 971 const char *ast_filename); 972 973/** 974 * \brief Flags that control the creation of translation units. 975 * 976 * The enumerators in this enumeration type are meant to be bitwise 977 * ORed together to specify which options should be used when 978 * constructing the translation unit. 979 */ 980enum CXTranslationUnit_Flags { 981 /** 982 * \brief Used to indicate that no special translation-unit options are 983 * needed. 984 */ 985 CXTranslationUnit_None = 0x0, 986 987 /** 988 * \brief Used to indicate that the parser should construct a "detailed" 989 * preprocessing record, including all macro definitions and instantiations. 990 * 991 * Constructing a detailed preprocessing record requires more memory 992 * and time to parse, since the information contained in the record 993 * is usually not retained. However, it can be useful for 994 * applications that require more detailed information about the 995 * behavior of the preprocessor. 996 */ 997 CXTranslationUnit_DetailedPreprocessingRecord = 0x01, 998 999 /** 1000 * \brief Used to indicate that the translation unit is incomplete. 1001 * 1002 * When a translation unit is considered "incomplete", semantic 1003 * analysis that is typically performed at the end of the 1004 * translation unit will be suppressed. For example, this suppresses 1005 * the completion of tentative declarations in C and of 1006 * instantiation of implicitly-instantiation function templates in 1007 * C++. This option is typically used when parsing a header with the 1008 * intent of producing a precompiled header. 1009 */ 1010 CXTranslationUnit_Incomplete = 0x02, 1011 1012 /** 1013 * \brief Used to indicate that the translation unit should be built with an 1014 * implicit precompiled header for the preamble. 1015 * 1016 * An implicit precompiled header is used as an optimization when a 1017 * particular translation unit is likely to be reparsed many times 1018 * when the sources aren't changing that often. In this case, an 1019 * implicit precompiled header will be built containing all of the 1020 * initial includes at the top of the main file (what we refer to as 1021 * the "preamble" of the file). In subsequent parses, if the 1022 * preamble or the files in it have not changed, \c 1023 * clang_reparseTranslationUnit() will re-use the implicit 1024 * precompiled header to improve parsing performance. 1025 */ 1026 CXTranslationUnit_PrecompiledPreamble = 0x04, 1027 1028 /** 1029 * \brief Used to indicate that the translation unit should cache some 1030 * code-completion results with each reparse of the source file. 1031 * 1032 * Caching of code-completion results is a performance optimization that 1033 * introduces some overhead to reparsing but improves the performance of 1034 * code-completion operations. 1035 */ 1036 CXTranslationUnit_CacheCompletionResults = 0x08, 1037 /** 1038 * \brief DEPRECATED: Enable precompiled preambles in C++. 1039 * 1040 * Note: this is a *temporary* option that is available only while 1041 * we are testing C++ precompiled preamble support. It is deprecated. 1042 */ 1043 CXTranslationUnit_CXXPrecompiledPreamble = 0x10, 1044 1045 /** 1046 * \brief DEPRECATED: Enabled chained precompiled preambles in C++. 1047 * 1048 * Note: this is a *temporary* option that is available only while 1049 * we are testing C++ precompiled preamble support. It is deprecated. 1050 */ 1051 CXTranslationUnit_CXXChainedPCH = 0x20 1052}; 1053 1054/** 1055 * \brief Returns the set of flags that is suitable for parsing a translation 1056 * unit that is being edited. 1057 * 1058 * The set of flags returned provide options for \c clang_parseTranslationUnit() 1059 * to indicate that the translation unit is likely to be reparsed many times, 1060 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly 1061 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag 1062 * set contains an unspecified set of optimizations (e.g., the precompiled 1063 * preamble) geared toward improving the performance of these routines. The 1064 * set of optimizations enabled may change from one version to the next. 1065 */ 1066CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void); 1067 1068/** 1069 * \brief Parse the given source file and the translation unit corresponding 1070 * to that file. 1071 * 1072 * This routine is the main entry point for the Clang C API, providing the 1073 * ability to parse a source file into a translation unit that can then be 1074 * queried by other functions in the API. This routine accepts a set of 1075 * command-line arguments so that the compilation can be configured in the same 1076 * way that the compiler is configured on the command line. 1077 * 1078 * \param CIdx The index object with which the translation unit will be 1079 * associated. 1080 * 1081 * \param source_filename The name of the source file to load, or NULL if the 1082 * source file is included in \p command_line_args. 1083 * 1084 * \param command_line_args The command-line arguments that would be 1085 * passed to the \c clang executable if it were being invoked out-of-process. 1086 * These command-line options will be parsed and will affect how the translation 1087 * unit is parsed. Note that the following options are ignored: '-c', 1088 * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'. 1089 * 1090 * \param num_command_line_args The number of command-line arguments in 1091 * \p command_line_args. 1092 * 1093 * \param unsaved_files the files that have not yet been saved to disk 1094 * but may be required for parsing, including the contents of 1095 * those files. The contents and name of these files (as specified by 1096 * CXUnsavedFile) are copied when necessary, so the client only needs to 1097 * guarantee their validity until the call to this function returns. 1098 * 1099 * \param num_unsaved_files the number of unsaved file entries in \p 1100 * unsaved_files. 1101 * 1102 * \param options A bitmask of options that affects how the translation unit 1103 * is managed but not its compilation. This should be a bitwise OR of the 1104 * CXTranslationUnit_XXX flags. 1105 * 1106 * \returns A new translation unit describing the parsed code and containing 1107 * any diagnostics produced by the compiler. If there is a failure from which 1108 * the compiler cannot recover, returns NULL. 1109 */ 1110CINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 1111 const char *source_filename, 1112 const char * const *command_line_args, 1113 int num_command_line_args, 1114 struct CXUnsavedFile *unsaved_files, 1115 unsigned num_unsaved_files, 1116 unsigned options); 1117 1118/** 1119 * \brief Flags that control how translation units are saved. 1120 * 1121 * The enumerators in this enumeration type are meant to be bitwise 1122 * ORed together to specify which options should be used when 1123 * saving the translation unit. 1124 */ 1125enum CXSaveTranslationUnit_Flags { 1126 /** 1127 * \brief Used to indicate that no special saving options are needed. 1128 */ 1129 CXSaveTranslationUnit_None = 0x0 1130}; 1131 1132/** 1133 * \brief Returns the set of flags that is suitable for saving a translation 1134 * unit. 1135 * 1136 * The set of flags returned provide options for 1137 * \c clang_saveTranslationUnit() by default. The returned flag 1138 * set contains an unspecified set of options that save translation units with 1139 * the most commonly-requested data. 1140 */ 1141CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU); 1142 1143/** 1144 * \brief Describes the kind of error that occurred (if any) in a call to 1145 * \c clang_saveTranslationUnit(). 1146 */ 1147enum CXSaveError { 1148 /** 1149 * \brief Indicates that no error occurred while saving a translation unit. 1150 */ 1151 CXSaveError_None = 0, 1152 1153 /** 1154 * \brief Indicates that an unknown error occurred while attempting to save 1155 * the file. 1156 * 1157 * This error typically indicates that file I/O failed when attempting to 1158 * write the file. 1159 */ 1160 CXSaveError_Unknown = 1, 1161 1162 /** 1163 * \brief Indicates that errors during translation prevented this attempt 1164 * to save the translation unit. 1165 * 1166 * Errors that prevent the translation unit from being saved can be 1167 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic(). 1168 */ 1169 CXSaveError_TranslationErrors = 2, 1170 1171 /** 1172 * \brief Indicates that the translation unit to be saved was somehow 1173 * invalid (e.g., NULL). 1174 */ 1175 CXSaveError_InvalidTU = 3 1176}; 1177 1178/** 1179 * \brief Saves a translation unit into a serialized representation of 1180 * that translation unit on disk. 1181 * 1182 * Any translation unit that was parsed without error can be saved 1183 * into a file. The translation unit can then be deserialized into a 1184 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or, 1185 * if it is an incomplete translation unit that corresponds to a 1186 * header, used as a precompiled header when parsing other translation 1187 * units. 1188 * 1189 * \param TU The translation unit to save. 1190 * 1191 * \param FileName The file to which the translation unit will be saved. 1192 * 1193 * \param options A bitmask of options that affects how the translation unit 1194 * is saved. This should be a bitwise OR of the 1195 * CXSaveTranslationUnit_XXX flags. 1196 * 1197 * \returns A value that will match one of the enumerators of the CXSaveError 1198 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was 1199 * saved successfully, while a non-zero value indicates that a problem occurred. 1200 */ 1201CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 1202 const char *FileName, 1203 unsigned options); 1204 1205/** 1206 * \brief Destroy the specified CXTranslationUnit object. 1207 */ 1208CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit); 1209 1210/** 1211 * \brief Flags that control the reparsing of translation units. 1212 * 1213 * The enumerators in this enumeration type are meant to be bitwise 1214 * ORed together to specify which options should be used when 1215 * reparsing the translation unit. 1216 */ 1217enum CXReparse_Flags { 1218 /** 1219 * \brief Used to indicate that no special reparsing options are needed. 1220 */ 1221 CXReparse_None = 0x0 1222}; 1223 1224/** 1225 * \brief Returns the set of flags that is suitable for reparsing a translation 1226 * unit. 1227 * 1228 * The set of flags returned provide options for 1229 * \c clang_reparseTranslationUnit() by default. The returned flag 1230 * set contains an unspecified set of optimizations geared toward common uses 1231 * of reparsing. The set of optimizations enabled may change from one version 1232 * to the next. 1233 */ 1234CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU); 1235 1236/** 1237 * \brief Reparse the source files that produced this translation unit. 1238 * 1239 * This routine can be used to re-parse the source files that originally 1240 * created the given translation unit, for example because those source files 1241 * have changed (either on disk or as passed via \p unsaved_files). The 1242 * source code will be reparsed with the same command-line options as it 1243 * was originally parsed. 1244 * 1245 * Reparsing a translation unit invalidates all cursors and source locations 1246 * that refer into that translation unit. This makes reparsing a translation 1247 * unit semantically equivalent to destroying the translation unit and then 1248 * creating a new translation unit with the same command-line arguments. 1249 * However, it may be more efficient to reparse a translation 1250 * unit using this routine. 1251 * 1252 * \param TU The translation unit whose contents will be re-parsed. The 1253 * translation unit must originally have been built with 1254 * \c clang_createTranslationUnitFromSourceFile(). 1255 * 1256 * \param num_unsaved_files The number of unsaved file entries in \p 1257 * unsaved_files. 1258 * 1259 * \param unsaved_files The files that have not yet been saved to disk 1260 * but may be required for parsing, including the contents of 1261 * those files. The contents and name of these files (as specified by 1262 * CXUnsavedFile) are copied when necessary, so the client only needs to 1263 * guarantee their validity until the call to this function returns. 1264 * 1265 * \param options A bitset of options composed of the flags in CXReparse_Flags. 1266 * The function \c clang_defaultReparseOptions() produces a default set of 1267 * options recommended for most uses, based on the translation unit. 1268 * 1269 * \returns 0 if the sources could be reparsed. A non-zero value will be 1270 * returned if reparsing was impossible, such that the translation unit is 1271 * invalid. In such cases, the only valid call for \p TU is 1272 * \c clang_disposeTranslationUnit(TU). 1273 */ 1274CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU, 1275 unsigned num_unsaved_files, 1276 struct CXUnsavedFile *unsaved_files, 1277 unsigned options); 1278 1279/** 1280 * \brief Categorizes how memory is being used by a translation unit. 1281 */ 1282enum CXTUResourceUsageKind { 1283 CXTUResourceUsage_AST = 1, 1284 CXTUResourceUsage_Identifiers = 2, 1285 CXTUResourceUsage_Selectors = 3, 1286 CXTUResourceUsage_GlobalCompletionResults = 4, 1287 CXTUResourceUsage_SourceManagerContentCache = 5, 1288 CXTUResourceUsage_AST_SideTables = 6, 1289 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7, 1290 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8, 1291 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9, 1292 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10, 1293 CXTUResourceUsage_Preprocessor = 11, 1294 CXTUResourceUsage_PreprocessingRecord = 12, 1295 CXTUResourceUsage_SourceManager_DataStructures = 13, 1296 CXTUResourceUsage_Preprocessor_HeaderSearch = 14, 1297 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST, 1298 CXTUResourceUsage_MEMORY_IN_BYTES_END = 1299 CXTUResourceUsage_Preprocessor_HeaderSearch, 1300 1301 CXTUResourceUsage_First = CXTUResourceUsage_AST, 1302 CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch 1303}; 1304 1305/** 1306 * \brief Returns the human-readable null-terminated C string that represents 1307 * the name of the memory category. This string should never be freed. 1308 */ 1309CINDEX_LINKAGE 1310const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind); 1311 1312typedef struct CXTUResourceUsageEntry { 1313 /* \brief The memory usage category. */ 1314 enum CXTUResourceUsageKind kind; 1315 /* \brief Amount of resources used. 1316 The units will depend on the resource kind. */ 1317 unsigned long amount; 1318} CXTUResourceUsageEntry; 1319 1320/** 1321 * \brief The memory usage of a CXTranslationUnit, broken into categories. 1322 */ 1323typedef struct CXTUResourceUsage { 1324 /* \brief Private data member, used for queries. */ 1325 void *data; 1326 1327 /* \brief The number of entries in the 'entries' array. */ 1328 unsigned numEntries; 1329 1330 /* \brief An array of key-value pairs, representing the breakdown of memory 1331 usage. */ 1332 CXTUResourceUsageEntry *entries; 1333 1334} CXTUResourceUsage; 1335 1336/** 1337 * \brief Return the memory usage of a translation unit. This object 1338 * should be released with clang_disposeCXTUResourceUsage(). 1339 */ 1340CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU); 1341 1342CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage); 1343 1344/** 1345 * @} 1346 */ 1347 1348/** 1349 * \brief Describes the kind of entity that a cursor refers to. 1350 */ 1351enum CXCursorKind { 1352 /* Declarations */ 1353 /** 1354 * \brief A declaration whose specific kind is not exposed via this 1355 * interface. 1356 * 1357 * Unexposed declarations have the same operations as any other kind 1358 * of declaration; one can extract their location information, 1359 * spelling, find their definitions, etc. However, the specific kind 1360 * of the declaration is not reported. 1361 */ 1362 CXCursor_UnexposedDecl = 1, 1363 /** \brief A C or C++ struct. */ 1364 CXCursor_StructDecl = 2, 1365 /** \brief A C or C++ union. */ 1366 CXCursor_UnionDecl = 3, 1367 /** \brief A C++ class. */ 1368 CXCursor_ClassDecl = 4, 1369 /** \brief An enumeration. */ 1370 CXCursor_EnumDecl = 5, 1371 /** 1372 * \brief A field (in C) or non-static data member (in C++) in a 1373 * struct, union, or C++ class. 1374 */ 1375 CXCursor_FieldDecl = 6, 1376 /** \brief An enumerator constant. */ 1377 CXCursor_EnumConstantDecl = 7, 1378 /** \brief A function. */ 1379 CXCursor_FunctionDecl = 8, 1380 /** \brief A variable. */ 1381 CXCursor_VarDecl = 9, 1382 /** \brief A function or method parameter. */ 1383 CXCursor_ParmDecl = 10, 1384 /** \brief An Objective-C @interface. */ 1385 CXCursor_ObjCInterfaceDecl = 11, 1386 /** \brief An Objective-C @interface for a category. */ 1387 CXCursor_ObjCCategoryDecl = 12, 1388 /** \brief An Objective-C @protocol declaration. */ 1389 CXCursor_ObjCProtocolDecl = 13, 1390 /** \brief An Objective-C @property declaration. */ 1391 CXCursor_ObjCPropertyDecl = 14, 1392 /** \brief An Objective-C instance variable. */ 1393 CXCursor_ObjCIvarDecl = 15, 1394 /** \brief An Objective-C instance method. */ 1395 CXCursor_ObjCInstanceMethodDecl = 16, 1396 /** \brief An Objective-C class method. */ 1397 CXCursor_ObjCClassMethodDecl = 17, 1398 /** \brief An Objective-C @implementation. */ 1399 CXCursor_ObjCImplementationDecl = 18, 1400 /** \brief An Objective-C @implementation for a category. */ 1401 CXCursor_ObjCCategoryImplDecl = 19, 1402 /** \brief A typedef */ 1403 CXCursor_TypedefDecl = 20, 1404 /** \brief A C++ class method. */ 1405 CXCursor_CXXMethod = 21, 1406 /** \brief A C++ namespace. */ 1407 CXCursor_Namespace = 22, 1408 /** \brief A linkage specification, e.g. 'extern "C"'. */ 1409 CXCursor_LinkageSpec = 23, 1410 /** \brief A C++ constructor. */ 1411 CXCursor_Constructor = 24, 1412 /** \brief A C++ destructor. */ 1413 CXCursor_Destructor = 25, 1414 /** \brief A C++ conversion function. */ 1415 CXCursor_ConversionFunction = 26, 1416 /** \brief A C++ template type parameter. */ 1417 CXCursor_TemplateTypeParameter = 27, 1418 /** \brief A C++ non-type template parameter. */ 1419 CXCursor_NonTypeTemplateParameter = 28, 1420 /** \brief A C++ template template parameter. */ 1421 CXCursor_TemplateTemplateParameter = 29, 1422 /** \brief A C++ function template. */ 1423 CXCursor_FunctionTemplate = 30, 1424 /** \brief A C++ class template. */ 1425 CXCursor_ClassTemplate = 31, 1426 /** \brief A C++ class template partial specialization. */ 1427 CXCursor_ClassTemplatePartialSpecialization = 32, 1428 /** \brief A C++ namespace alias declaration. */ 1429 CXCursor_NamespaceAlias = 33, 1430 /** \brief A C++ using directive. */ 1431 CXCursor_UsingDirective = 34, 1432 /** \brief A C++ using declaration. */ 1433 CXCursor_UsingDeclaration = 35, 1434 /** \brief A C++ alias declaration */ 1435 CXCursor_TypeAliasDecl = 36, 1436 /** \brief An Objective-C @synthesize definition. */ 1437 CXCursor_ObjCSynthesizeDecl = 37, 1438 /** \brief An Objective-C @dynamic definition. */ 1439 CXCursor_ObjCDynamicDecl = 38, 1440 /** \brief An access specifier. */ 1441 CXCursor_CXXAccessSpecifier = 39, 1442 1443 CXCursor_FirstDecl = CXCursor_UnexposedDecl, 1444 CXCursor_LastDecl = CXCursor_CXXAccessSpecifier, 1445 1446 /* References */ 1447 CXCursor_FirstRef = 40, /* Decl references */ 1448 CXCursor_ObjCSuperClassRef = 40, 1449 CXCursor_ObjCProtocolRef = 41, 1450 CXCursor_ObjCClassRef = 42, 1451 /** 1452 * \brief A reference to a type declaration. 1453 * 1454 * A type reference occurs anywhere where a type is named but not 1455 * declared. For example, given: 1456 * 1457 * \code 1458 * typedef unsigned size_type; 1459 * size_type size; 1460 * \endcode 1461 * 1462 * The typedef is a declaration of size_type (CXCursor_TypedefDecl), 1463 * while the type of the variable "size" is referenced. The cursor 1464 * referenced by the type of size is the typedef for size_type. 1465 */ 1466 CXCursor_TypeRef = 43, 1467 CXCursor_CXXBaseSpecifier = 44, 1468 /** 1469 * \brief A reference to a class template, function template, template 1470 * template parameter, or class template partial specialization. 1471 */ 1472 CXCursor_TemplateRef = 45, 1473 /** 1474 * \brief A reference to a namespace or namespace alias. 1475 */ 1476 CXCursor_NamespaceRef = 46, 1477 /** 1478 * \brief A reference to a member of a struct, union, or class that occurs in 1479 * some non-expression context, e.g., a designated initializer. 1480 */ 1481 CXCursor_MemberRef = 47, 1482 /** 1483 * \brief A reference to a labeled statement. 1484 * 1485 * This cursor kind is used to describe the jump to "start_over" in the 1486 * goto statement in the following example: 1487 * 1488 * \code 1489 * start_over: 1490 * ++counter; 1491 * 1492 * goto start_over; 1493 * \endcode 1494 * 1495 * A label reference cursor refers to a label statement. 1496 */ 1497 CXCursor_LabelRef = 48, 1498 1499 /** 1500 * \brief A reference to a set of overloaded functions or function templates 1501 * that has not yet been resolved to a specific function or function template. 1502 * 1503 * An overloaded declaration reference cursor occurs in C++ templates where 1504 * a dependent name refers to a function. For example: 1505 * 1506 * \code 1507 * template<typename T> void swap(T&, T&); 1508 * 1509 * struct X { ... }; 1510 * void swap(X&, X&); 1511 * 1512 * template<typename T> 1513 * void reverse(T* first, T* last) { 1514 * while (first < last - 1) { 1515 * swap(*first, *--last); 1516 * ++first; 1517 * } 1518 * } 1519 * 1520 * struct Y { }; 1521 * void swap(Y&, Y&); 1522 * \endcode 1523 * 1524 * Here, the identifier "swap" is associated with an overloaded declaration 1525 * reference. In the template definition, "swap" refers to either of the two 1526 * "swap" functions declared above, so both results will be available. At 1527 * instantiation time, "swap" may also refer to other functions found via 1528 * argument-dependent lookup (e.g., the "swap" function at the end of the 1529 * example). 1530 * 1531 * The functions \c clang_getNumOverloadedDecls() and 1532 * \c clang_getOverloadedDecl() can be used to retrieve the definitions 1533 * referenced by this cursor. 1534 */ 1535 CXCursor_OverloadedDeclRef = 49, 1536 1537 /** 1538 * \brief A reference to a variable that occurs in some non-expression 1539 * context, e.g., a C++ lambda capture list. 1540 */ 1541 CXCursor_VariableRef = 50, 1542 1543 CXCursor_LastRef = CXCursor_VariableRef, 1544 1545 /* Error conditions */ 1546 CXCursor_FirstInvalid = 70, 1547 CXCursor_InvalidFile = 70, 1548 CXCursor_NoDeclFound = 71, 1549 CXCursor_NotImplemented = 72, 1550 CXCursor_InvalidCode = 73, 1551 CXCursor_LastInvalid = CXCursor_InvalidCode, 1552 1553 /* Expressions */ 1554 CXCursor_FirstExpr = 100, 1555 1556 /** 1557 * \brief An expression whose specific kind is not exposed via this 1558 * interface. 1559 * 1560 * Unexposed expressions have the same operations as any other kind 1561 * of expression; one can extract their location information, 1562 * spelling, children, etc. However, the specific kind of the 1563 * expression is not reported. 1564 */ 1565 CXCursor_UnexposedExpr = 100, 1566 1567 /** 1568 * \brief An expression that refers to some value declaration, such 1569 * as a function, varible, or enumerator. 1570 */ 1571 CXCursor_DeclRefExpr = 101, 1572 1573 /** 1574 * \brief An expression that refers to a member of a struct, union, 1575 * class, Objective-C class, etc. 1576 */ 1577 CXCursor_MemberRefExpr = 102, 1578 1579 /** \brief An expression that calls a function. */ 1580 CXCursor_CallExpr = 103, 1581 1582 /** \brief An expression that sends a message to an Objective-C 1583 object or class. */ 1584 CXCursor_ObjCMessageExpr = 104, 1585 1586 /** \brief An expression that represents a block literal. */ 1587 CXCursor_BlockExpr = 105, 1588 1589 /** \brief An integer literal. 1590 */ 1591 CXCursor_IntegerLiteral = 106, 1592 1593 /** \brief A floating point number literal. 1594 */ 1595 CXCursor_FloatingLiteral = 107, 1596 1597 /** \brief An imaginary number literal. 1598 */ 1599 CXCursor_ImaginaryLiteral = 108, 1600 1601 /** \brief A string literal. 1602 */ 1603 CXCursor_StringLiteral = 109, 1604 1605 /** \brief A character literal. 1606 */ 1607 CXCursor_CharacterLiteral = 110, 1608 1609 /** \brief A parenthesized expression, e.g. "(1)". 1610 * 1611 * This AST node is only formed if full location information is requested. 1612 */ 1613 CXCursor_ParenExpr = 111, 1614 1615 /** \brief This represents the unary-expression's (except sizeof and 1616 * alignof). 1617 */ 1618 CXCursor_UnaryOperator = 112, 1619 1620 /** \brief [C99 6.5.2.1] Array Subscripting. 1621 */ 1622 CXCursor_ArraySubscriptExpr = 113, 1623 1624 /** \brief A builtin binary operation expression such as "x + y" or 1625 * "x <= y". 1626 */ 1627 CXCursor_BinaryOperator = 114, 1628 1629 /** \brief Compound assignment such as "+=". 1630 */ 1631 CXCursor_CompoundAssignOperator = 115, 1632 1633 /** \brief The ?: ternary operator. 1634 */ 1635 CXCursor_ConditionalOperator = 116, 1636 1637 /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++ 1638 * (C++ [expr.cast]), which uses the syntax (Type)expr. 1639 * 1640 * For example: (int)f. 1641 */ 1642 CXCursor_CStyleCastExpr = 117, 1643 1644 /** \brief [C99 6.5.2.5] 1645 */ 1646 CXCursor_CompoundLiteralExpr = 118, 1647 1648 /** \brief Describes an C or C++ initializer list. 1649 */ 1650 CXCursor_InitListExpr = 119, 1651 1652 /** \brief The GNU address of label extension, representing &&label. 1653 */ 1654 CXCursor_AddrLabelExpr = 120, 1655 1656 /** \brief This is the GNU Statement Expression extension: ({int X=4; X;}) 1657 */ 1658 CXCursor_StmtExpr = 121, 1659 1660 /** \brief Represents a C11 generic selection. 1661 */ 1662 CXCursor_GenericSelectionExpr = 122, 1663 1664 /** \brief Implements the GNU __null extension, which is a name for a null 1665 * pointer constant that has integral type (e.g., int or long) and is the same 1666 * size and alignment as a pointer. 1667 * 1668 * The __null extension is typically only used by system headers, which define 1669 * NULL as __null in C++ rather than using 0 (which is an integer that may not 1670 * match the size of a pointer). 1671 */ 1672 CXCursor_GNUNullExpr = 123, 1673 1674 /** \brief C++'s static_cast<> expression. 1675 */ 1676 CXCursor_CXXStaticCastExpr = 124, 1677 1678 /** \brief C++'s dynamic_cast<> expression. 1679 */ 1680 CXCursor_CXXDynamicCastExpr = 125, 1681 1682 /** \brief C++'s reinterpret_cast<> expression. 1683 */ 1684 CXCursor_CXXReinterpretCastExpr = 126, 1685 1686 /** \brief C++'s const_cast<> expression. 1687 */ 1688 CXCursor_CXXConstCastExpr = 127, 1689 1690 /** \brief Represents an explicit C++ type conversion that uses "functional" 1691 * notion (C++ [expr.type.conv]). 1692 * 1693 * Example: 1694 * \code 1695 * x = int(0.5); 1696 * \endcode 1697 */ 1698 CXCursor_CXXFunctionalCastExpr = 128, 1699 1700 /** \brief A C++ typeid expression (C++ [expr.typeid]). 1701 */ 1702 CXCursor_CXXTypeidExpr = 129, 1703 1704 /** \brief [C++ 2.13.5] C++ Boolean Literal. 1705 */ 1706 CXCursor_CXXBoolLiteralExpr = 130, 1707 1708 /** \brief [C++0x 2.14.7] C++ Pointer Literal. 1709 */ 1710 CXCursor_CXXNullPtrLiteralExpr = 131, 1711 1712 /** \brief Represents the "this" expression in C++ 1713 */ 1714 CXCursor_CXXThisExpr = 132, 1715 1716 /** \brief [C++ 15] C++ Throw Expression. 1717 * 1718 * This handles 'throw' and 'throw' assignment-expression. When 1719 * assignment-expression isn't present, Op will be null. 1720 */ 1721 CXCursor_CXXThrowExpr = 133, 1722 1723 /** \brief A new expression for memory allocation and constructor calls, e.g: 1724 * "new CXXNewExpr(foo)". 1725 */ 1726 CXCursor_CXXNewExpr = 134, 1727 1728 /** \brief A delete expression for memory deallocation and destructor calls, 1729 * e.g. "delete[] pArray". 1730 */ 1731 CXCursor_CXXDeleteExpr = 135, 1732 1733 /** \brief A unary expression. 1734 */ 1735 CXCursor_UnaryExpr = 136, 1736 1737 /** \brief An Objective-C string literal i.e. @"foo". 1738 */ 1739 CXCursor_ObjCStringLiteral = 137, 1740 1741 /** \brief An Objective-C @encode expression. 1742 */ 1743 CXCursor_ObjCEncodeExpr = 138, 1744 1745 /** \brief An Objective-C @selector expression. 1746 */ 1747 CXCursor_ObjCSelectorExpr = 139, 1748 1749 /** \brief An Objective-C @protocol expression. 1750 */ 1751 CXCursor_ObjCProtocolExpr = 140, 1752 1753 /** \brief An Objective-C "bridged" cast expression, which casts between 1754 * Objective-C pointers and C pointers, transferring ownership in the process. 1755 * 1756 * \code 1757 * NSString *str = (__bridge_transfer NSString *)CFCreateString(); 1758 * \endcode 1759 */ 1760 CXCursor_ObjCBridgedCastExpr = 141, 1761 1762 /** \brief Represents a C++0x pack expansion that produces a sequence of 1763 * expressions. 1764 * 1765 * A pack expansion expression contains a pattern (which itself is an 1766 * expression) followed by an ellipsis. For example: 1767 * 1768 * \code 1769 * template<typename F, typename ...Types> 1770 * void forward(F f, Types &&...args) { 1771 * f(static_cast<Types&&>(args)...); 1772 * } 1773 * \endcode 1774 */ 1775 CXCursor_PackExpansionExpr = 142, 1776 1777 /** \brief Represents an expression that computes the length of a parameter 1778 * pack. 1779 * 1780 * \code 1781 * template<typename ...Types> 1782 * struct count { 1783 * static const unsigned value = sizeof...(Types); 1784 * }; 1785 * \endcode 1786 */ 1787 CXCursor_SizeOfPackExpr = 143, 1788 1789 /* \brief Represents a C++ lambda expression that produces a local function 1790 * object. 1791 * 1792 * \code 1793 * void abssort(float *x, unsigned N) { 1794 * std::sort(x, x + N, 1795 * [](float a, float b) { 1796 * return std::abs(a) < std::abs(b); 1797 * }); 1798 * } 1799 * \endcode 1800 */ 1801 CXCursor_LambdaExpr = 144, 1802 1803 /** \brief Objective-c Boolean Literal. 1804 */ 1805 CXCursor_ObjCBoolLiteralExpr = 145, 1806 1807 CXCursor_LastExpr = CXCursor_ObjCBoolLiteralExpr, 1808 1809 /* Statements */ 1810 CXCursor_FirstStmt = 200, 1811 /** 1812 * \brief A statement whose specific kind is not exposed via this 1813 * interface. 1814 * 1815 * Unexposed statements have the same operations as any other kind of 1816 * statement; one can extract their location information, spelling, 1817 * children, etc. However, the specific kind of the statement is not 1818 * reported. 1819 */ 1820 CXCursor_UnexposedStmt = 200, 1821 1822 /** \brief A labelled statement in a function. 1823 * 1824 * This cursor kind is used to describe the "start_over:" label statement in 1825 * the following example: 1826 * 1827 * \code 1828 * start_over: 1829 * ++counter; 1830 * \endcode 1831 * 1832 */ 1833 CXCursor_LabelStmt = 201, 1834 1835 /** \brief A group of statements like { stmt stmt }. 1836 * 1837 * This cursor kind is used to describe compound statements, e.g. function 1838 * bodies. 1839 */ 1840 CXCursor_CompoundStmt = 202, 1841 1842 /** \brief A case statment. 1843 */ 1844 CXCursor_CaseStmt = 203, 1845 1846 /** \brief A default statement. 1847 */ 1848 CXCursor_DefaultStmt = 204, 1849 1850 /** \brief An if statement 1851 */ 1852 CXCursor_IfStmt = 205, 1853 1854 /** \brief A switch statement. 1855 */ 1856 CXCursor_SwitchStmt = 206, 1857 1858 /** \brief A while statement. 1859 */ 1860 CXCursor_WhileStmt = 207, 1861 1862 /** \brief A do statement. 1863 */ 1864 CXCursor_DoStmt = 208, 1865 1866 /** \brief A for statement. 1867 */ 1868 CXCursor_ForStmt = 209, 1869 1870 /** \brief A goto statement. 1871 */ 1872 CXCursor_GotoStmt = 210, 1873 1874 /** \brief An indirect goto statement. 1875 */ 1876 CXCursor_IndirectGotoStmt = 211, 1877 1878 /** \brief A continue statement. 1879 */ 1880 CXCursor_ContinueStmt = 212, 1881 1882 /** \brief A break statement. 1883 */ 1884 CXCursor_BreakStmt = 213, 1885 1886 /** \brief A return statement. 1887 */ 1888 CXCursor_ReturnStmt = 214, 1889 1890 /** \brief A GNU inline assembly statement extension. 1891 */ 1892 CXCursor_AsmStmt = 215, 1893 1894 /** \brief Objective-C's overall @try-@catch-@finally statement. 1895 */ 1896 CXCursor_ObjCAtTryStmt = 216, 1897 1898 /** \brief Objective-C's @catch statement. 1899 */ 1900 CXCursor_ObjCAtCatchStmt = 217, 1901 1902 /** \brief Objective-C's @finally statement. 1903 */ 1904 CXCursor_ObjCAtFinallyStmt = 218, 1905 1906 /** \brief Objective-C's @throw statement. 1907 */ 1908 CXCursor_ObjCAtThrowStmt = 219, 1909 1910 /** \brief Objective-C's @synchronized statement. 1911 */ 1912 CXCursor_ObjCAtSynchronizedStmt = 220, 1913 1914 /** \brief Objective-C's autorelease pool statement. 1915 */ 1916 CXCursor_ObjCAutoreleasePoolStmt = 221, 1917 1918 /** \brief Objective-C's collection statement. 1919 */ 1920 CXCursor_ObjCForCollectionStmt = 222, 1921 1922 /** \brief C++'s catch statement. 1923 */ 1924 CXCursor_CXXCatchStmt = 223, 1925 1926 /** \brief C++'s try statement. 1927 */ 1928 CXCursor_CXXTryStmt = 224, 1929 1930 /** \brief C++'s for (* : *) statement. 1931 */ 1932 CXCursor_CXXForRangeStmt = 225, 1933 1934 /** \brief Windows Structured Exception Handling's try statement. 1935 */ 1936 CXCursor_SEHTryStmt = 226, 1937 1938 /** \brief Windows Structured Exception Handling's except statement. 1939 */ 1940 CXCursor_SEHExceptStmt = 227, 1941 1942 /** \brief Windows Structured Exception Handling's finally statement. 1943 */ 1944 CXCursor_SEHFinallyStmt = 228, 1945 1946 /** \brief The null satement ";": C99 6.8.3p3. 1947 * 1948 * This cursor kind is used to describe the null statement. 1949 */ 1950 CXCursor_NullStmt = 230, 1951 1952 /** \brief Adaptor class for mixing declarations with statements and 1953 * expressions. 1954 */ 1955 CXCursor_DeclStmt = 231, 1956 1957 CXCursor_LastStmt = CXCursor_DeclStmt, 1958 1959 /** 1960 * \brief Cursor that represents the translation unit itself. 1961 * 1962 * The translation unit cursor exists primarily to act as the root 1963 * cursor for traversing the contents of a translation unit. 1964 */ 1965 CXCursor_TranslationUnit = 300, 1966 1967 /* Attributes */ 1968 CXCursor_FirstAttr = 400, 1969 /** 1970 * \brief An attribute whose specific kind is not exposed via this 1971 * interface. 1972 */ 1973 CXCursor_UnexposedAttr = 400, 1974 1975 CXCursor_IBActionAttr = 401, 1976 CXCursor_IBOutletAttr = 402, 1977 CXCursor_IBOutletCollectionAttr = 403, 1978 CXCursor_CXXFinalAttr = 404, 1979 CXCursor_CXXOverrideAttr = 405, 1980 CXCursor_AnnotateAttr = 406, 1981 CXCursor_AsmLabelAttr = 407, 1982 CXCursor_LastAttr = CXCursor_AsmLabelAttr, 1983 1984 /* Preprocessing */ 1985 CXCursor_PreprocessingDirective = 500, 1986 CXCursor_MacroDefinition = 501, 1987 CXCursor_MacroExpansion = 502, 1988 CXCursor_MacroInstantiation = CXCursor_MacroExpansion, 1989 CXCursor_InclusionDirective = 503, 1990 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 1991 CXCursor_LastPreprocessing = CXCursor_InclusionDirective 1992}; 1993 1994/** 1995 * \brief A cursor representing some element in the abstract syntax tree for 1996 * a translation unit. 1997 * 1998 * The cursor abstraction unifies the different kinds of entities in a 1999 * program--declaration, statements, expressions, references to declarations, 2000 * etc.--under a single "cursor" abstraction with a common set of operations. 2001 * Common operation for a cursor include: getting the physical location in 2002 * a source file where the cursor points, getting the name associated with a 2003 * cursor, and retrieving cursors for any child nodes of a particular cursor. 2004 * 2005 * Cursors can be produced in two specific ways. 2006 * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 2007 * from which one can use clang_visitChildren() to explore the rest of the 2008 * translation unit. clang_getCursor() maps from a physical source location 2009 * to the entity that resides at that location, allowing one to map from the 2010 * source code into the AST. 2011 */ 2012typedef struct { 2013 enum CXCursorKind kind; 2014 int xdata; 2015 void *data[3]; 2016} CXCursor; 2017 2018/** 2019 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 2020 * 2021 * @{ 2022 */ 2023 2024/** 2025 * \brief Retrieve the NULL cursor, which represents no entity. 2026 */ 2027CINDEX_LINKAGE CXCursor clang_getNullCursor(void); 2028 2029/** 2030 * \brief Retrieve the cursor that represents the given translation unit. 2031 * 2032 * The translation unit cursor can be used to start traversing the 2033 * various declarations within the given translation unit. 2034 */ 2035CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 2036 2037/** 2038 * \brief Determine whether two cursors are equivalent. 2039 */ 2040CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 2041 2042/** 2043 * \brief Returns non-zero if \arg cursor is null. 2044 */ 2045CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor); 2046 2047/** 2048 * \brief Compute a hash value for the given cursor. 2049 */ 2050CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 2051 2052/** 2053 * \brief Retrieve the kind of the given cursor. 2054 */ 2055CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 2056 2057/** 2058 * \brief Determine whether the given cursor kind represents a declaration. 2059 */ 2060CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 2061 2062/** 2063 * \brief Determine whether the given cursor kind represents a simple 2064 * reference. 2065 * 2066 * Note that other kinds of cursors (such as expressions) can also refer to 2067 * other cursors. Use clang_getCursorReferenced() to determine whether a 2068 * particular cursor refers to another entity. 2069 */ 2070CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 2071 2072/** 2073 * \brief Determine whether the given cursor kind represents an expression. 2074 */ 2075CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 2076 2077/** 2078 * \brief Determine whether the given cursor kind represents a statement. 2079 */ 2080CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 2081 2082/** 2083 * \brief Determine whether the given cursor kind represents an attribute. 2084 */ 2085CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind); 2086 2087/** 2088 * \brief Determine whether the given cursor kind represents an invalid 2089 * cursor. 2090 */ 2091CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 2092 2093/** 2094 * \brief Determine whether the given cursor kind represents a translation 2095 * unit. 2096 */ 2097CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 2098 2099/*** 2100 * \brief Determine whether the given cursor represents a preprocessing 2101 * element, such as a preprocessor directive or macro instantiation. 2102 */ 2103CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 2104 2105/*** 2106 * \brief Determine whether the given cursor represents a currently 2107 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 2108 */ 2109CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 2110 2111/** 2112 * \brief Describe the linkage of the entity referred to by a cursor. 2113 */ 2114enum CXLinkageKind { 2115 /** \brief This value indicates that no linkage information is available 2116 * for a provided CXCursor. */ 2117 CXLinkage_Invalid, 2118 /** 2119 * \brief This is the linkage for variables, parameters, and so on that 2120 * have automatic storage. This covers normal (non-extern) local variables. 2121 */ 2122 CXLinkage_NoLinkage, 2123 /** \brief This is the linkage for static variables and static functions. */ 2124 CXLinkage_Internal, 2125 /** \brief This is the linkage for entities with external linkage that live 2126 * in C++ anonymous namespaces.*/ 2127 CXLinkage_UniqueExternal, 2128 /** \brief This is the linkage for entities with true, external linkage. */ 2129 CXLinkage_External 2130}; 2131 2132/** 2133 * \brief Determine the linkage of the entity referred to by a given cursor. 2134 */ 2135CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 2136 2137/** 2138 * \brief Determine the availability of the entity that this cursor refers to. 2139 * 2140 * \param cursor The cursor to query. 2141 * 2142 * \returns The availability of the cursor. 2143 */ 2144CINDEX_LINKAGE enum CXAvailabilityKind 2145clang_getCursorAvailability(CXCursor cursor); 2146 2147/** 2148 * \brief Describe the "language" of the entity referred to by a cursor. 2149 */ 2150CINDEX_LINKAGE enum CXLanguageKind { 2151 CXLanguage_Invalid = 0, 2152 CXLanguage_C, 2153 CXLanguage_ObjC, 2154 CXLanguage_CPlusPlus 2155}; 2156 2157/** 2158 * \brief Determine the "language" of the entity referred to by a given cursor. 2159 */ 2160CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 2161 2162/** 2163 * \brief Returns the translation unit that a cursor originated from. 2164 */ 2165CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor); 2166 2167 2168/** 2169 * \brief A fast container representing a set of CXCursors. 2170 */ 2171typedef struct CXCursorSetImpl *CXCursorSet; 2172 2173/** 2174 * \brief Creates an empty CXCursorSet. 2175 */ 2176CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(); 2177 2178/** 2179 * \brief Disposes a CXCursorSet and releases its associated memory. 2180 */ 2181CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset); 2182 2183/** 2184 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. 2185 * 2186 * \returns non-zero if the set contains the specified cursor. 2187*/ 2188CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset, 2189 CXCursor cursor); 2190 2191/** 2192 * \brief Inserts a CXCursor into a CXCursorSet. 2193 * 2194 * \returns zero if the CXCursor was already in the set, and non-zero otherwise. 2195*/ 2196CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset, 2197 CXCursor cursor); 2198 2199/** 2200 * \brief Determine the semantic parent of the given cursor. 2201 * 2202 * The semantic parent of a cursor is the cursor that semantically contains 2203 * the given \p cursor. For many declarations, the lexical and semantic parents 2204 * are equivalent (the lexical parent is returned by 2205 * \c clang_getCursorLexicalParent()). They diverge when declarations or 2206 * definitions are provided out-of-line. For example: 2207 * 2208 * \code 2209 * class C { 2210 * void f(); 2211 * }; 2212 * 2213 * void C::f() { } 2214 * \endcode 2215 * 2216 * In the out-of-line definition of \c C::f, the semantic parent is the 2217 * the class \c C, of which this function is a member. The lexical parent is 2218 * the place where the declaration actually occurs in the source code; in this 2219 * case, the definition occurs in the translation unit. In general, the 2220 * lexical parent for a given entity can change without affecting the semantics 2221 * of the program, and the lexical parent of different declarations of the 2222 * same entity may be different. Changing the semantic parent of a declaration, 2223 * on the other hand, can have a major impact on semantics, and redeclarations 2224 * of a particular entity should all have the same semantic context. 2225 * 2226 * In the example above, both declarations of \c C::f have \c C as their 2227 * semantic context, while the lexical context of the first \c C::f is \c C 2228 * and the lexical context of the second \c C::f is the translation unit. 2229 * 2230 * For global declarations, the semantic parent is the translation unit. 2231 */ 2232CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 2233 2234/** 2235 * \brief Determine the lexical parent of the given cursor. 2236 * 2237 * The lexical parent of a cursor is the cursor in which the given \p cursor 2238 * was actually written. For many declarations, the lexical and semantic parents 2239 * are equivalent (the semantic parent is returned by 2240 * \c clang_getCursorSemanticParent()). They diverge when declarations or 2241 * definitions are provided out-of-line. For example: 2242 * 2243 * \code 2244 * class C { 2245 * void f(); 2246 * }; 2247 * 2248 * void C::f() { } 2249 * \endcode 2250 * 2251 * In the out-of-line definition of \c C::f, the semantic parent is the 2252 * the class \c C, of which this function is a member. The lexical parent is 2253 * the place where the declaration actually occurs in the source code; in this 2254 * case, the definition occurs in the translation unit. In general, the 2255 * lexical parent for a given entity can change without affecting the semantics 2256 * of the program, and the lexical parent of different declarations of the 2257 * same entity may be different. Changing the semantic parent of a declaration, 2258 * on the other hand, can have a major impact on semantics, and redeclarations 2259 * of a particular entity should all have the same semantic context. 2260 * 2261 * In the example above, both declarations of \c C::f have \c C as their 2262 * semantic context, while the lexical context of the first \c C::f is \c C 2263 * and the lexical context of the second \c C::f is the translation unit. 2264 * 2265 * For declarations written in the global scope, the lexical parent is 2266 * the translation unit. 2267 */ 2268CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 2269 2270/** 2271 * \brief Determine the set of methods that are overridden by the given 2272 * method. 2273 * 2274 * In both Objective-C and C++, a method (aka virtual member function, 2275 * in C++) can override a virtual method in a base class. For 2276 * Objective-C, a method is said to override any method in the class's 2277 * base class, its protocols, or its categories' protocols, that has the same 2278 * selector and is of the same kind (class or instance). 2279 * If no such method exists, the search continues to the class's superclass, 2280 * its protocols, and its categories, and so on. A method from an Objective-C 2281 * implementation is considered to override the same methods as its 2282 * corresponding method in the interface. 2283 * 2284 * For C++, a virtual member function overrides any virtual member 2285 * function with the same signature that occurs in its base 2286 * classes. With multiple inheritance, a virtual member function can 2287 * override several virtual member functions coming from different 2288 * base classes. 2289 * 2290 * In all cases, this function determines the immediate overridden 2291 * method, rather than all of the overridden methods. For example, if 2292 * a method is originally declared in a class A, then overridden in B 2293 * (which in inherits from A) and also in C (which inherited from B), 2294 * then the only overridden method returned from this function when 2295 * invoked on C's method will be B's method. The client may then 2296 * invoke this function again, given the previously-found overridden 2297 * methods, to map out the complete method-override set. 2298 * 2299 * \param cursor A cursor representing an Objective-C or C++ 2300 * method. This routine will compute the set of methods that this 2301 * method overrides. 2302 * 2303 * \param overridden A pointer whose pointee will be replaced with a 2304 * pointer to an array of cursors, representing the set of overridden 2305 * methods. If there are no overridden methods, the pointee will be 2306 * set to NULL. The pointee must be freed via a call to 2307 * \c clang_disposeOverriddenCursors(). 2308 * 2309 * \param num_overridden A pointer to the number of overridden 2310 * functions, will be set to the number of overridden functions in the 2311 * array pointed to by \p overridden. 2312 */ 2313CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 2314 CXCursor **overridden, 2315 unsigned *num_overridden); 2316 2317/** 2318 * \brief Free the set of overridden cursors returned by \c 2319 * clang_getOverriddenCursors(). 2320 */ 2321CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 2322 2323/** 2324 * \brief Retrieve the file that is included by the given inclusion directive 2325 * cursor. 2326 */ 2327CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 2328 2329/** 2330 * @} 2331 */ 2332 2333/** 2334 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 2335 * 2336 * Cursors represent a location within the Abstract Syntax Tree (AST). These 2337 * routines help map between cursors and the physical locations where the 2338 * described entities occur in the source code. The mapping is provided in 2339 * both directions, so one can map from source code to the AST and back. 2340 * 2341 * @{ 2342 */ 2343 2344/** 2345 * \brief Map a source location to the cursor that describes the entity at that 2346 * location in the source code. 2347 * 2348 * clang_getCursor() maps an arbitrary source location within a translation 2349 * unit down to the most specific cursor that describes the entity at that 2350 * location. For example, given an expression \c x + y, invoking 2351 * clang_getCursor() with a source location pointing to "x" will return the 2352 * cursor for "x"; similarly for "y". If the cursor points anywhere between 2353 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 2354 * will return a cursor referring to the "+" expression. 2355 * 2356 * \returns a cursor representing the entity at the given source location, or 2357 * a NULL cursor if no such entity can be found. 2358 */ 2359CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 2360 2361/** 2362 * \brief Retrieve the physical location of the source constructor referenced 2363 * by the given cursor. 2364 * 2365 * The location of a declaration is typically the location of the name of that 2366 * declaration, where the name of that declaration would occur if it is 2367 * unnamed, or some keyword that introduces that particular declaration. 2368 * The location of a reference is where that reference occurs within the 2369 * source code. 2370 */ 2371CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 2372 2373/** 2374 * \brief Retrieve the physical extent of the source construct referenced by 2375 * the given cursor. 2376 * 2377 * The extent of a cursor starts with the file/line/column pointing at the 2378 * first character within the source construct that the cursor refers to and 2379 * ends with the last character withinin that source construct. For a 2380 * declaration, the extent covers the declaration itself. For a reference, 2381 * the extent covers the location of the reference (e.g., where the referenced 2382 * entity was actually used). 2383 */ 2384CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 2385 2386/** 2387 * @} 2388 */ 2389 2390/** 2391 * \defgroup CINDEX_TYPES Type information for CXCursors 2392 * 2393 * @{ 2394 */ 2395 2396/** 2397 * \brief Describes the kind of type 2398 */ 2399enum CXTypeKind { 2400 /** 2401 * \brief Reprents an invalid type (e.g., where no type is available). 2402 */ 2403 CXType_Invalid = 0, 2404 2405 /** 2406 * \brief A type whose specific kind is not exposed via this 2407 * interface. 2408 */ 2409 CXType_Unexposed = 1, 2410 2411 /* Builtin types */ 2412 CXType_Void = 2, 2413 CXType_Bool = 3, 2414 CXType_Char_U = 4, 2415 CXType_UChar = 5, 2416 CXType_Char16 = 6, 2417 CXType_Char32 = 7, 2418 CXType_UShort = 8, 2419 CXType_UInt = 9, 2420 CXType_ULong = 10, 2421 CXType_ULongLong = 11, 2422 CXType_UInt128 = 12, 2423 CXType_Char_S = 13, 2424 CXType_SChar = 14, 2425 CXType_WChar = 15, 2426 CXType_Short = 16, 2427 CXType_Int = 17, 2428 CXType_Long = 18, 2429 CXType_LongLong = 19, 2430 CXType_Int128 = 20, 2431 CXType_Float = 21, 2432 CXType_Double = 22, 2433 CXType_LongDouble = 23, 2434 CXType_NullPtr = 24, 2435 CXType_Overload = 25, 2436 CXType_Dependent = 26, 2437 CXType_ObjCId = 27, 2438 CXType_ObjCClass = 28, 2439 CXType_ObjCSel = 29, 2440 CXType_FirstBuiltin = CXType_Void, 2441 CXType_LastBuiltin = CXType_ObjCSel, 2442 2443 CXType_Complex = 100, 2444 CXType_Pointer = 101, 2445 CXType_BlockPointer = 102, 2446 CXType_LValueReference = 103, 2447 CXType_RValueReference = 104, 2448 CXType_Record = 105, 2449 CXType_Enum = 106, 2450 CXType_Typedef = 107, 2451 CXType_ObjCInterface = 108, 2452 CXType_ObjCObjectPointer = 109, 2453 CXType_FunctionNoProto = 110, 2454 CXType_FunctionProto = 111, 2455 CXType_ConstantArray = 112, 2456 CXType_Vector = 113 2457}; 2458 2459/** 2460 * \brief Describes the calling convention of a function type 2461 */ 2462enum CXCallingConv { 2463 CXCallingConv_Default = 0, 2464 CXCallingConv_C = 1, 2465 CXCallingConv_X86StdCall = 2, 2466 CXCallingConv_X86FastCall = 3, 2467 CXCallingConv_X86ThisCall = 4, 2468 CXCallingConv_X86Pascal = 5, 2469 CXCallingConv_AAPCS = 6, 2470 CXCallingConv_AAPCS_VFP = 7, 2471 2472 CXCallingConv_Invalid = 100, 2473 CXCallingConv_Unexposed = 200 2474}; 2475 2476 2477/** 2478 * \brief The type of an element in the abstract syntax tree. 2479 * 2480 */ 2481typedef struct { 2482 enum CXTypeKind kind; 2483 void *data[2]; 2484} CXType; 2485 2486/** 2487 * \brief Retrieve the type of a CXCursor (if any). 2488 */ 2489CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 2490 2491/** 2492 * \brief Retrieve the underlying type of a typedef declaration. 2493 * 2494 * If the cursor does not reference a typedef declaration, an invalid type is 2495 * returned. 2496 */ 2497CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C); 2498 2499/** 2500 * \brief Retrieve the integer type of an enum declaration. 2501 * 2502 * If the cursor does not reference an enum declaration, an invalid type is 2503 * returned. 2504 */ 2505CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C); 2506 2507/** 2508 * \brief Retrieve the integer value of an enum constant declaration as a signed 2509 * long long. 2510 * 2511 * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned. 2512 * Since this is also potentially a valid constant value, the kind of the cursor 2513 * must be verified before calling this function. 2514 */ 2515CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C); 2516 2517/** 2518 * \brief Retrieve the integer value of an enum constant declaration as an unsigned 2519 * long long. 2520 * 2521 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned. 2522 * Since this is also potentially a valid constant value, the kind of the cursor 2523 * must be verified before calling this function. 2524 */ 2525CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C); 2526 2527/** 2528 * \determine Determine whether two CXTypes represent the same type. 2529 * 2530 * \returns non-zero if the CXTypes represent the same type and 2531 zero otherwise. 2532 */ 2533CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 2534 2535/** 2536 * \brief Return the canonical type for a CXType. 2537 * 2538 * Clang's type system explicitly models typedefs and all the ways 2539 * a specific type can be represented. The canonical type is the underlying 2540 * type with all the "sugar" removed. For example, if 'T' is a typedef 2541 * for 'int', the canonical type for 'T' would be 'int'. 2542 */ 2543CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 2544 2545/** 2546 * \determine Determine whether a CXType has the "const" qualifier set, 2547 * without looking through typedefs that may have added "const" at a different level. 2548 */ 2549CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T); 2550 2551/** 2552 * \determine Determine whether a CXType has the "volatile" qualifier set, 2553 * without looking through typedefs that may have added "volatile" at a different level. 2554 */ 2555CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T); 2556 2557/** 2558 * \determine Determine whether a CXType has the "restrict" qualifier set, 2559 * without looking through typedefs that may have added "restrict" at a different level. 2560 */ 2561CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T); 2562 2563/** 2564 * \brief For pointer types, returns the type of the pointee. 2565 * 2566 */ 2567CINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 2568 2569/** 2570 * \brief Return the cursor for the declaration of the given type. 2571 */ 2572CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 2573 2574/** 2575 * Returns the Objective-C type encoding for the specified declaration. 2576 */ 2577CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C); 2578 2579/** 2580 * \brief Retrieve the spelling of a given CXTypeKind. 2581 */ 2582CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 2583 2584/** 2585 * \brief Retrieve the calling convention associated with a function type. 2586 * 2587 * If a non-function type is passed in, CXCallingConv_Invalid is returned. 2588 */ 2589CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T); 2590 2591/** 2592 * \brief Retrieve the result type associated with a function type. 2593 * 2594 * If a non-function type is passed in, an invalid type is returned. 2595 */ 2596CINDEX_LINKAGE CXType clang_getResultType(CXType T); 2597 2598/** 2599 * \brief Retrieve the number of non-variadic arguments associated with a function type. 2600 * 2601 * If a non-function type is passed in, UINT_MAX is returned. 2602 */ 2603CINDEX_LINKAGE unsigned clang_getNumArgTypes(CXType T); 2604 2605/** 2606 * \brief Retrieve the type of an argument of a function type. 2607 * 2608 * If a non-function type is passed in or the function does not have enough parameters, 2609 * an invalid type is returned. 2610 */ 2611CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i); 2612 2613/** 2614 * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise. 2615 * 2616 */ 2617CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T); 2618 2619/** 2620 * \brief Retrieve the result type associated with a given cursor. 2621 * 2622 * This only returns a valid type if the cursor refers to a function or method. 2623 */ 2624CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 2625 2626/** 2627 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 2628 * otherwise. 2629 */ 2630CINDEX_LINKAGE unsigned clang_isPODType(CXType T); 2631 2632/** 2633 * \brief Return the element type of an array, complex, or vector type. 2634 * 2635 * If a type is passed in that is not an array, complex, or vector type, 2636 * an invalid type is returned. 2637 */ 2638CINDEX_LINKAGE CXType clang_getElementType(CXType T); 2639 2640/** 2641 * \brief Return the number of elements of an array or vector type. 2642 * 2643 * If a type is passed in that is not an array or vector type, 2644 * -1 is returned. 2645 */ 2646CINDEX_LINKAGE long long clang_getNumElements(CXType T); 2647 2648/** 2649 * \brief Return the element type of an array type. 2650 * 2651 * If a non-array type is passed in, an invalid type is returned. 2652 */ 2653CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T); 2654 2655/** 2656 * \brief Return the the array size of a constant array. 2657 * 2658 * If a non-array type is passed in, -1 is returned. 2659 */ 2660CINDEX_LINKAGE long long clang_getArraySize(CXType T); 2661 2662/** 2663 * \brief Returns 1 if the base class specified by the cursor with kind 2664 * CX_CXXBaseSpecifier is virtual. 2665 */ 2666CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 2667 2668/** 2669 * \brief Represents the C++ access control level to a base class for a 2670 * cursor with kind CX_CXXBaseSpecifier. 2671 */ 2672enum CX_CXXAccessSpecifier { 2673 CX_CXXInvalidAccessSpecifier, 2674 CX_CXXPublic, 2675 CX_CXXProtected, 2676 CX_CXXPrivate 2677}; 2678 2679/** 2680 * \brief Returns the access control level for the C++ base specifier 2681 * represented by a cursor with kind CXCursor_CXXBaseSpecifier or 2682 * CXCursor_AccessSpecifier. 2683 */ 2684CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 2685 2686/** 2687 * \brief Determine the number of overloaded declarations referenced by a 2688 * \c CXCursor_OverloadedDeclRef cursor. 2689 * 2690 * \param cursor The cursor whose overloaded declarations are being queried. 2691 * 2692 * \returns The number of overloaded declarations referenced by \c cursor. If it 2693 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 2694 */ 2695CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 2696 2697/** 2698 * \brief Retrieve a cursor for one of the overloaded declarations referenced 2699 * by a \c CXCursor_OverloadedDeclRef cursor. 2700 * 2701 * \param cursor The cursor whose overloaded declarations are being queried. 2702 * 2703 * \param index The zero-based index into the set of overloaded declarations in 2704 * the cursor. 2705 * 2706 * \returns A cursor representing the declaration referenced by the given 2707 * \c cursor at the specified \c index. If the cursor does not have an 2708 * associated set of overloaded declarations, or if the index is out of bounds, 2709 * returns \c clang_getNullCursor(); 2710 */ 2711CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 2712 unsigned index); 2713 2714/** 2715 * @} 2716 */ 2717 2718/** 2719 * \defgroup CINDEX_ATTRIBUTES Information for attributes 2720 * 2721 * @{ 2722 */ 2723 2724 2725/** 2726 * \brief For cursors representing an iboutletcollection attribute, 2727 * this function returns the collection element type. 2728 * 2729 */ 2730CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 2731 2732/** 2733 * @} 2734 */ 2735 2736/** 2737 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 2738 * 2739 * These routines provide the ability to traverse the abstract syntax tree 2740 * using cursors. 2741 * 2742 * @{ 2743 */ 2744 2745/** 2746 * \brief Describes how the traversal of the children of a particular 2747 * cursor should proceed after visiting a particular child cursor. 2748 * 2749 * A value of this enumeration type should be returned by each 2750 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 2751 */ 2752enum CXChildVisitResult { 2753 /** 2754 * \brief Terminates the cursor traversal. 2755 */ 2756 CXChildVisit_Break, 2757 /** 2758 * \brief Continues the cursor traversal with the next sibling of 2759 * the cursor just visited, without visiting its children. 2760 */ 2761 CXChildVisit_Continue, 2762 /** 2763 * \brief Recursively traverse the children of this cursor, using 2764 * the same visitor and client data. 2765 */ 2766 CXChildVisit_Recurse 2767}; 2768 2769/** 2770 * \brief Visitor invoked for each cursor found by a traversal. 2771 * 2772 * This visitor function will be invoked for each cursor found by 2773 * clang_visitCursorChildren(). Its first argument is the cursor being 2774 * visited, its second argument is the parent visitor for that cursor, 2775 * and its third argument is the client data provided to 2776 * clang_visitCursorChildren(). 2777 * 2778 * The visitor should return one of the \c CXChildVisitResult values 2779 * to direct clang_visitCursorChildren(). 2780 */ 2781typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 2782 CXCursor parent, 2783 CXClientData client_data); 2784 2785/** 2786 * \brief Visit the children of a particular cursor. 2787 * 2788 * This function visits all the direct children of the given cursor, 2789 * invoking the given \p visitor function with the cursors of each 2790 * visited child. The traversal may be recursive, if the visitor returns 2791 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 2792 * the visitor returns \c CXChildVisit_Break. 2793 * 2794 * \param parent the cursor whose child may be visited. All kinds of 2795 * cursors can be visited, including invalid cursors (which, by 2796 * definition, have no children). 2797 * 2798 * \param visitor the visitor function that will be invoked for each 2799 * child of \p parent. 2800 * 2801 * \param client_data pointer data supplied by the client, which will 2802 * be passed to the visitor each time it is invoked. 2803 * 2804 * \returns a non-zero value if the traversal was terminated 2805 * prematurely by the visitor returning \c CXChildVisit_Break. 2806 */ 2807CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 2808 CXCursorVisitor visitor, 2809 CXClientData client_data); 2810#ifdef __has_feature 2811# if __has_feature(blocks) 2812/** 2813 * \brief Visitor invoked for each cursor found by a traversal. 2814 * 2815 * This visitor block will be invoked for each cursor found by 2816 * clang_visitChildrenWithBlock(). Its first argument is the cursor being 2817 * visited, its second argument is the parent visitor for that cursor. 2818 * 2819 * The visitor should return one of the \c CXChildVisitResult values 2820 * to direct clang_visitChildrenWithBlock(). 2821 */ 2822typedef enum CXChildVisitResult 2823 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 2824 2825/** 2826 * Visits the children of a cursor using the specified block. Behaves 2827 * identically to clang_visitChildren() in all other respects. 2828 */ 2829unsigned clang_visitChildrenWithBlock(CXCursor parent, 2830 CXCursorVisitorBlock block); 2831# endif 2832#endif 2833 2834/** 2835 * @} 2836 */ 2837 2838/** 2839 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 2840 * 2841 * These routines provide the ability to determine references within and 2842 * across translation units, by providing the names of the entities referenced 2843 * by cursors, follow reference cursors to the declarations they reference, 2844 * and associate declarations with their definitions. 2845 * 2846 * @{ 2847 */ 2848 2849/** 2850 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 2851 * by the given cursor. 2852 * 2853 * A Unified Symbol Resolution (USR) is a string that identifies a particular 2854 * entity (function, class, variable, etc.) within a program. USRs can be 2855 * compared across translation units to determine, e.g., when references in 2856 * one translation refer to an entity defined in another translation unit. 2857 */ 2858CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 2859 2860/** 2861 * \brief Construct a USR for a specified Objective-C class. 2862 */ 2863CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 2864 2865/** 2866 * \brief Construct a USR for a specified Objective-C category. 2867 */ 2868CINDEX_LINKAGE CXString 2869 clang_constructUSR_ObjCCategory(const char *class_name, 2870 const char *category_name); 2871 2872/** 2873 * \brief Construct a USR for a specified Objective-C protocol. 2874 */ 2875CINDEX_LINKAGE CXString 2876 clang_constructUSR_ObjCProtocol(const char *protocol_name); 2877 2878 2879/** 2880 * \brief Construct a USR for a specified Objective-C instance variable and 2881 * the USR for its containing class. 2882 */ 2883CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 2884 CXString classUSR); 2885 2886/** 2887 * \brief Construct a USR for a specified Objective-C method and 2888 * the USR for its containing class. 2889 */ 2890CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 2891 unsigned isInstanceMethod, 2892 CXString classUSR); 2893 2894/** 2895 * \brief Construct a USR for a specified Objective-C property and the USR 2896 * for its containing class. 2897 */ 2898CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 2899 CXString classUSR); 2900 2901/** 2902 * \brief Retrieve a name for the entity referenced by this cursor. 2903 */ 2904CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 2905 2906/** 2907 * \brief Retrieve a range for a piece that forms the cursors spelling name. 2908 * Most of the times there is only one range for the complete spelling but for 2909 * objc methods and objc message expressions, there are multiple pieces for each 2910 * selector identifier. 2911 * 2912 * \param pieceIndex the index of the spelling name piece. If this is greater 2913 * than the actual number of pieces, it will return a NULL (invalid) range. 2914 * 2915 * \param options Reserved. 2916 */ 2917CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor, 2918 unsigned pieceIndex, 2919 unsigned options); 2920 2921/** 2922 * \brief Retrieve the display name for the entity referenced by this cursor. 2923 * 2924 * The display name contains extra information that helps identify the cursor, 2925 * such as the parameters of a function or template or the arguments of a 2926 * class template specialization. 2927 */ 2928CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 2929 2930/** \brief For a cursor that is a reference, retrieve a cursor representing the 2931 * entity that it references. 2932 * 2933 * Reference cursors refer to other entities in the AST. For example, an 2934 * Objective-C superclass reference cursor refers to an Objective-C class. 2935 * This function produces the cursor for the Objective-C class from the 2936 * cursor for the superclass reference. If the input cursor is a declaration or 2937 * definition, it returns that declaration or definition unchanged. 2938 * Otherwise, returns the NULL cursor. 2939 */ 2940CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 2941 2942/** 2943 * \brief For a cursor that is either a reference to or a declaration 2944 * of some entity, retrieve a cursor that describes the definition of 2945 * that entity. 2946 * 2947 * Some entities can be declared multiple times within a translation 2948 * unit, but only one of those declarations can also be a 2949 * definition. For example, given: 2950 * 2951 * \code 2952 * int f(int, int); 2953 * int g(int x, int y) { return f(x, y); } 2954 * int f(int a, int b) { return a + b; } 2955 * int f(int, int); 2956 * \endcode 2957 * 2958 * there are three declarations of the function "f", but only the 2959 * second one is a definition. The clang_getCursorDefinition() 2960 * function will take any cursor pointing to a declaration of "f" 2961 * (the first or fourth lines of the example) or a cursor referenced 2962 * that uses "f" (the call to "f' inside "g") and will return a 2963 * declaration cursor pointing to the definition (the second "f" 2964 * declaration). 2965 * 2966 * If given a cursor for which there is no corresponding definition, 2967 * e.g., because there is no definition of that entity within this 2968 * translation unit, returns a NULL cursor. 2969 */ 2970CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 2971 2972/** 2973 * \brief Determine whether the declaration pointed to by this cursor 2974 * is also a definition of that entity. 2975 */ 2976CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 2977 2978/** 2979 * \brief Retrieve the canonical cursor corresponding to the given cursor. 2980 * 2981 * In the C family of languages, many kinds of entities can be declared several 2982 * times within a single translation unit. For example, a structure type can 2983 * be forward-declared (possibly multiple times) and later defined: 2984 * 2985 * \code 2986 * struct X; 2987 * struct X; 2988 * struct X { 2989 * int member; 2990 * }; 2991 * \endcode 2992 * 2993 * The declarations and the definition of \c X are represented by three 2994 * different cursors, all of which are declarations of the same underlying 2995 * entity. One of these cursor is considered the "canonical" cursor, which 2996 * is effectively the representative for the underlying entity. One can 2997 * determine if two cursors are declarations of the same underlying entity by 2998 * comparing their canonical cursors. 2999 * 3000 * \returns The canonical cursor for the entity referred to by the given cursor. 3001 */ 3002CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 3003 3004 3005/** 3006 * \brief If the cursor points to a selector identifier in a objc method or 3007 * message expression, this returns the selector index. 3008 * 3009 * After getting a cursor with \see clang_getCursor, this can be called to 3010 * determine if the location points to a selector identifier. 3011 * 3012 * \returns The selector index if the cursor is an objc method or message 3013 * expression and the cursor is pointing to a selector identifier, or -1 3014 * otherwise. 3015 */ 3016CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor); 3017 3018/** 3019 * @} 3020 */ 3021 3022/** 3023 * \defgroup CINDEX_CPP C++ AST introspection 3024 * 3025 * The routines in this group provide access information in the ASTs specific 3026 * to C++ language features. 3027 * 3028 * @{ 3029 */ 3030 3031/** 3032 * \brief Determine if a C++ member function or member function template is 3033 * declared 'static'. 3034 */ 3035CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 3036 3037/** 3038 * \brief Determine if a C++ member function or member function template is 3039 * explicitly declared 'virtual' or if it overrides a virtual method from 3040 * one of the base classes. 3041 */ 3042CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C); 3043 3044/** 3045 * \brief Given a cursor that represents a template, determine 3046 * the cursor kind of the specializations would be generated by instantiating 3047 * the template. 3048 * 3049 * This routine can be used to determine what flavor of function template, 3050 * class template, or class template partial specialization is stored in the 3051 * cursor. For example, it can describe whether a class template cursor is 3052 * declared with "struct", "class" or "union". 3053 * 3054 * \param C The cursor to query. This cursor should represent a template 3055 * declaration. 3056 * 3057 * \returns The cursor kind of the specializations that would be generated 3058 * by instantiating the template \p C. If \p C is not a template, returns 3059 * \c CXCursor_NoDeclFound. 3060 */ 3061CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 3062 3063/** 3064 * \brief Given a cursor that may represent a specialization or instantiation 3065 * of a template, retrieve the cursor that represents the template that it 3066 * specializes or from which it was instantiated. 3067 * 3068 * This routine determines the template involved both for explicit 3069 * specializations of templates and for implicit instantiations of the template, 3070 * both of which are referred to as "specializations". For a class template 3071 * specialization (e.g., \c std::vector<bool>), this routine will return 3072 * either the primary template (\c std::vector) or, if the specialization was 3073 * instantiated from a class template partial specialization, the class template 3074 * partial specialization. For a class template partial specialization and a 3075 * function template specialization (including instantiations), this 3076 * this routine will return the specialized template. 3077 * 3078 * For members of a class template (e.g., member functions, member classes, or 3079 * static data members), returns the specialized or instantiated member. 3080 * Although not strictly "templates" in the C++ language, members of class 3081 * templates have the same notions of specializations and instantiations that 3082 * templates do, so this routine treats them similarly. 3083 * 3084 * \param C A cursor that may be a specialization of a template or a member 3085 * of a template. 3086 * 3087 * \returns If the given cursor is a specialization or instantiation of a 3088 * template or a member thereof, the template or member that it specializes or 3089 * from which it was instantiated. Otherwise, returns a NULL cursor. 3090 */ 3091CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 3092 3093/** 3094 * \brief Given a cursor that references something else, return the source range 3095 * covering that reference. 3096 * 3097 * \param C A cursor pointing to a member reference, a declaration reference, or 3098 * an operator call. 3099 * \param NameFlags A bitset with three independent flags: 3100 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and 3101 * CXNameRange_WantSinglePiece. 3102 * \param PieceIndex For contiguous names or when passing the flag 3103 * CXNameRange_WantSinglePiece, only one piece with index 0 is 3104 * available. When the CXNameRange_WantSinglePiece flag is not passed for a 3105 * non-contiguous names, this index can be used to retreive the individual 3106 * pieces of the name. See also CXNameRange_WantSinglePiece. 3107 * 3108 * \returns The piece of the name pointed to by the given cursor. If there is no 3109 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned. 3110 */ 3111CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, 3112 unsigned NameFlags, 3113 unsigned PieceIndex); 3114 3115enum CXNameRefFlags { 3116 /** 3117 * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the 3118 * range. 3119 */ 3120 CXNameRange_WantQualifier = 0x1, 3121 3122 /** 3123 * \brief Include the explicit template arguments, e.g. <int> in x.f<int>, in 3124 * the range. 3125 */ 3126 CXNameRange_WantTemplateArgs = 0x2, 3127 3128 /** 3129 * \brief If the name is non-contiguous, return the full spanning range. 3130 * 3131 * Non-contiguous names occur in Objective-C when a selector with two or more 3132 * parameters is used, or in C++ when using an operator: 3133 * \code 3134 * [object doSomething:here withValue:there]; // ObjC 3135 * return some_vector[1]; // C++ 3136 * \endcode 3137 */ 3138 CXNameRange_WantSinglePiece = 0x4 3139}; 3140 3141/** 3142 * @} 3143 */ 3144 3145/** 3146 * \defgroup CINDEX_LEX Token extraction and manipulation 3147 * 3148 * The routines in this group provide access to the tokens within a 3149 * translation unit, along with a semantic mapping of those tokens to 3150 * their corresponding cursors. 3151 * 3152 * @{ 3153 */ 3154 3155/** 3156 * \brief Describes a kind of token. 3157 */ 3158typedef enum CXTokenKind { 3159 /** 3160 * \brief A token that contains some kind of punctuation. 3161 */ 3162 CXToken_Punctuation, 3163 3164 /** 3165 * \brief A language keyword. 3166 */ 3167 CXToken_Keyword, 3168 3169 /** 3170 * \brief An identifier (that is not a keyword). 3171 */ 3172 CXToken_Identifier, 3173 3174 /** 3175 * \brief A numeric, string, or character literal. 3176 */ 3177 CXToken_Literal, 3178 3179 /** 3180 * \brief A comment. 3181 */ 3182 CXToken_Comment 3183} CXTokenKind; 3184 3185/** 3186 * \brief Describes a single preprocessing token. 3187 */ 3188typedef struct { 3189 unsigned int_data[4]; 3190 void *ptr_data; 3191} CXToken; 3192 3193/** 3194 * \brief Determine the kind of the given token. 3195 */ 3196CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 3197 3198/** 3199 * \brief Determine the spelling of the given token. 3200 * 3201 * The spelling of a token is the textual representation of that token, e.g., 3202 * the text of an identifier or keyword. 3203 */ 3204CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 3205 3206/** 3207 * \brief Retrieve the source location of the given token. 3208 */ 3209CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 3210 CXToken); 3211 3212/** 3213 * \brief Retrieve a source range that covers the given token. 3214 */ 3215CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 3216 3217/** 3218 * \brief Tokenize the source code described by the given range into raw 3219 * lexical tokens. 3220 * 3221 * \param TU the translation unit whose text is being tokenized. 3222 * 3223 * \param Range the source range in which text should be tokenized. All of the 3224 * tokens produced by tokenization will fall within this source range, 3225 * 3226 * \param Tokens this pointer will be set to point to the array of tokens 3227 * that occur within the given source range. The returned pointer must be 3228 * freed with clang_disposeTokens() before the translation unit is destroyed. 3229 * 3230 * \param NumTokens will be set to the number of tokens in the \c *Tokens 3231 * array. 3232 * 3233 */ 3234CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 3235 CXToken **Tokens, unsigned *NumTokens); 3236 3237/** 3238 * \brief Annotate the given set of tokens by providing cursors for each token 3239 * that can be mapped to a specific entity within the abstract syntax tree. 3240 * 3241 * This token-annotation routine is equivalent to invoking 3242 * clang_getCursor() for the source locations of each of the 3243 * tokens. The cursors provided are filtered, so that only those 3244 * cursors that have a direct correspondence to the token are 3245 * accepted. For example, given a function call \c f(x), 3246 * clang_getCursor() would provide the following cursors: 3247 * 3248 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 3249 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 3250 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 3251 * 3252 * Only the first and last of these cursors will occur within the 3253 * annotate, since the tokens "f" and "x' directly refer to a function 3254 * and a variable, respectively, but the parentheses are just a small 3255 * part of the full syntax of the function call expression, which is 3256 * not provided as an annotation. 3257 * 3258 * \param TU the translation unit that owns the given tokens. 3259 * 3260 * \param Tokens the set of tokens to annotate. 3261 * 3262 * \param NumTokens the number of tokens in \p Tokens. 3263 * 3264 * \param Cursors an array of \p NumTokens cursors, whose contents will be 3265 * replaced with the cursors corresponding to each token. 3266 */ 3267CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 3268 CXToken *Tokens, unsigned NumTokens, 3269 CXCursor *Cursors); 3270 3271/** 3272 * \brief Free the given set of tokens. 3273 */ 3274CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 3275 CXToken *Tokens, unsigned NumTokens); 3276 3277/** 3278 * @} 3279 */ 3280 3281/** 3282 * \defgroup CINDEX_DEBUG Debugging facilities 3283 * 3284 * These routines are used for testing and debugging, only, and should not 3285 * be relied upon. 3286 * 3287 * @{ 3288 */ 3289 3290/* for debug/testing */ 3291CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 3292CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 3293 const char **startBuf, 3294 const char **endBuf, 3295 unsigned *startLine, 3296 unsigned *startColumn, 3297 unsigned *endLine, 3298 unsigned *endColumn); 3299CINDEX_LINKAGE void clang_enableStackTraces(void); 3300CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 3301 unsigned stack_size); 3302 3303/** 3304 * @} 3305 */ 3306 3307/** 3308 * \defgroup CINDEX_CODE_COMPLET Code completion 3309 * 3310 * Code completion involves taking an (incomplete) source file, along with 3311 * knowledge of where the user is actively editing that file, and suggesting 3312 * syntactically- and semantically-valid constructs that the user might want to 3313 * use at that particular point in the source code. These data structures and 3314 * routines provide support for code completion. 3315 * 3316 * @{ 3317 */ 3318 3319/** 3320 * \brief A semantic string that describes a code-completion result. 3321 * 3322 * A semantic string that describes the formatting of a code-completion 3323 * result as a single "template" of text that should be inserted into the 3324 * source buffer when a particular code-completion result is selected. 3325 * Each semantic string is made up of some number of "chunks", each of which 3326 * contains some text along with a description of what that text means, e.g., 3327 * the name of the entity being referenced, whether the text chunk is part of 3328 * the template, or whether it is a "placeholder" that the user should replace 3329 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 3330 * description of the different kinds of chunks. 3331 */ 3332typedef void *CXCompletionString; 3333 3334/** 3335 * \brief A single result of code completion. 3336 */ 3337typedef struct { 3338 /** 3339 * \brief The kind of entity that this completion refers to. 3340 * 3341 * The cursor kind will be a macro, keyword, or a declaration (one of the 3342 * *Decl cursor kinds), describing the entity that the completion is 3343 * referring to. 3344 * 3345 * \todo In the future, we would like to provide a full cursor, to allow 3346 * the client to extract additional information from declaration. 3347 */ 3348 enum CXCursorKind CursorKind; 3349 3350 /** 3351 * \brief The code-completion string that describes how to insert this 3352 * code-completion result into the editing buffer. 3353 */ 3354 CXCompletionString CompletionString; 3355} CXCompletionResult; 3356 3357/** 3358 * \brief Describes a single piece of text within a code-completion string. 3359 * 3360 * Each "chunk" within a code-completion string (\c CXCompletionString) is 3361 * either a piece of text with a specific "kind" that describes how that text 3362 * should be interpreted by the client or is another completion string. 3363 */ 3364enum CXCompletionChunkKind { 3365 /** 3366 * \brief A code-completion string that describes "optional" text that 3367 * could be a part of the template (but is not required). 3368 * 3369 * The Optional chunk is the only kind of chunk that has a code-completion 3370 * string for its representation, which is accessible via 3371 * \c clang_getCompletionChunkCompletionString(). The code-completion string 3372 * describes an additional part of the template that is completely optional. 3373 * For example, optional chunks can be used to describe the placeholders for 3374 * arguments that match up with defaulted function parameters, e.g. given: 3375 * 3376 * \code 3377 * void f(int x, float y = 3.14, double z = 2.71828); 3378 * \endcode 3379 * 3380 * The code-completion string for this function would contain: 3381 * - a TypedText chunk for "f". 3382 * - a LeftParen chunk for "(". 3383 * - a Placeholder chunk for "int x" 3384 * - an Optional chunk containing the remaining defaulted arguments, e.g., 3385 * - a Comma chunk for "," 3386 * - a Placeholder chunk for "float y" 3387 * - an Optional chunk containing the last defaulted argument: 3388 * - a Comma chunk for "," 3389 * - a Placeholder chunk for "double z" 3390 * - a RightParen chunk for ")" 3391 * 3392 * There are many ways to handle Optional chunks. Two simple approaches are: 3393 * - Completely ignore optional chunks, in which case the template for the 3394 * function "f" would only include the first parameter ("int x"). 3395 * - Fully expand all optional chunks, in which case the template for the 3396 * function "f" would have all of the parameters. 3397 */ 3398 CXCompletionChunk_Optional, 3399 /** 3400 * \brief Text that a user would be expected to type to get this 3401 * code-completion result. 3402 * 3403 * There will be exactly one "typed text" chunk in a semantic string, which 3404 * will typically provide the spelling of a keyword or the name of a 3405 * declaration that could be used at the current code point. Clients are 3406 * expected to filter the code-completion results based on the text in this 3407 * chunk. 3408 */ 3409 CXCompletionChunk_TypedText, 3410 /** 3411 * \brief Text that should be inserted as part of a code-completion result. 3412 * 3413 * A "text" chunk represents text that is part of the template to be 3414 * inserted into user code should this particular code-completion result 3415 * be selected. 3416 */ 3417 CXCompletionChunk_Text, 3418 /** 3419 * \brief Placeholder text that should be replaced by the user. 3420 * 3421 * A "placeholder" chunk marks a place where the user should insert text 3422 * into the code-completion template. For example, placeholders might mark 3423 * the function parameters for a function declaration, to indicate that the 3424 * user should provide arguments for each of those parameters. The actual 3425 * text in a placeholder is a suggestion for the text to display before 3426 * the user replaces the placeholder with real code. 3427 */ 3428 CXCompletionChunk_Placeholder, 3429 /** 3430 * \brief Informative text that should be displayed but never inserted as 3431 * part of the template. 3432 * 3433 * An "informative" chunk contains annotations that can be displayed to 3434 * help the user decide whether a particular code-completion result is the 3435 * right option, but which is not part of the actual template to be inserted 3436 * by code completion. 3437 */ 3438 CXCompletionChunk_Informative, 3439 /** 3440 * \brief Text that describes the current parameter when code-completion is 3441 * referring to function call, message send, or template specialization. 3442 * 3443 * A "current parameter" chunk occurs when code-completion is providing 3444 * information about a parameter corresponding to the argument at the 3445 * code-completion point. For example, given a function 3446 * 3447 * \code 3448 * int add(int x, int y); 3449 * \endcode 3450 * 3451 * and the source code \c add(, where the code-completion point is after the 3452 * "(", the code-completion string will contain a "current parameter" chunk 3453 * for "int x", indicating that the current argument will initialize that 3454 * parameter. After typing further, to \c add(17, (where the code-completion 3455 * point is after the ","), the code-completion string will contain a 3456 * "current paremeter" chunk to "int y". 3457 */ 3458 CXCompletionChunk_CurrentParameter, 3459 /** 3460 * \brief A left parenthesis ('('), used to initiate a function call or 3461 * signal the beginning of a function parameter list. 3462 */ 3463 CXCompletionChunk_LeftParen, 3464 /** 3465 * \brief A right parenthesis (')'), used to finish a function call or 3466 * signal the end of a function parameter list. 3467 */ 3468 CXCompletionChunk_RightParen, 3469 /** 3470 * \brief A left bracket ('['). 3471 */ 3472 CXCompletionChunk_LeftBracket, 3473 /** 3474 * \brief A right bracket (']'). 3475 */ 3476 CXCompletionChunk_RightBracket, 3477 /** 3478 * \brief A left brace ('{'). 3479 */ 3480 CXCompletionChunk_LeftBrace, 3481 /** 3482 * \brief A right brace ('}'). 3483 */ 3484 CXCompletionChunk_RightBrace, 3485 /** 3486 * \brief A left angle bracket ('<'). 3487 */ 3488 CXCompletionChunk_LeftAngle, 3489 /** 3490 * \brief A right angle bracket ('>'). 3491 */ 3492 CXCompletionChunk_RightAngle, 3493 /** 3494 * \brief A comma separator (','). 3495 */ 3496 CXCompletionChunk_Comma, 3497 /** 3498 * \brief Text that specifies the result type of a given result. 3499 * 3500 * This special kind of informative chunk is not meant to be inserted into 3501 * the text buffer. Rather, it is meant to illustrate the type that an 3502 * expression using the given completion string would have. 3503 */ 3504 CXCompletionChunk_ResultType, 3505 /** 3506 * \brief A colon (':'). 3507 */ 3508 CXCompletionChunk_Colon, 3509 /** 3510 * \brief A semicolon (';'). 3511 */ 3512 CXCompletionChunk_SemiColon, 3513 /** 3514 * \brief An '=' sign. 3515 */ 3516 CXCompletionChunk_Equal, 3517 /** 3518 * Horizontal space (' '). 3519 */ 3520 CXCompletionChunk_HorizontalSpace, 3521 /** 3522 * Vertical space ('\n'), after which it is generally a good idea to 3523 * perform indentation. 3524 */ 3525 CXCompletionChunk_VerticalSpace 3526}; 3527 3528/** 3529 * \brief Determine the kind of a particular chunk within a completion string. 3530 * 3531 * \param completion_string the completion string to query. 3532 * 3533 * \param chunk_number the 0-based index of the chunk in the completion string. 3534 * 3535 * \returns the kind of the chunk at the index \c chunk_number. 3536 */ 3537CINDEX_LINKAGE enum CXCompletionChunkKind 3538clang_getCompletionChunkKind(CXCompletionString completion_string, 3539 unsigned chunk_number); 3540 3541/** 3542 * \brief Retrieve the text associated with a particular chunk within a 3543 * completion string. 3544 * 3545 * \param completion_string the completion string to query. 3546 * 3547 * \param chunk_number the 0-based index of the chunk in the completion string. 3548 * 3549 * \returns the text associated with the chunk at index \c chunk_number. 3550 */ 3551CINDEX_LINKAGE CXString 3552clang_getCompletionChunkText(CXCompletionString completion_string, 3553 unsigned chunk_number); 3554 3555/** 3556 * \brief Retrieve the completion string associated with a particular chunk 3557 * within a completion string. 3558 * 3559 * \param completion_string the completion string to query. 3560 * 3561 * \param chunk_number the 0-based index of the chunk in the completion string. 3562 * 3563 * \returns the completion string associated with the chunk at index 3564 * \c chunk_number. 3565 */ 3566CINDEX_LINKAGE CXCompletionString 3567clang_getCompletionChunkCompletionString(CXCompletionString completion_string, 3568 unsigned chunk_number); 3569 3570/** 3571 * \brief Retrieve the number of chunks in the given code-completion string. 3572 */ 3573CINDEX_LINKAGE unsigned 3574clang_getNumCompletionChunks(CXCompletionString completion_string); 3575 3576/** 3577 * \brief Determine the priority of this code completion. 3578 * 3579 * The priority of a code completion indicates how likely it is that this 3580 * particular completion is the completion that the user will select. The 3581 * priority is selected by various internal heuristics. 3582 * 3583 * \param completion_string The completion string to query. 3584 * 3585 * \returns The priority of this completion string. Smaller values indicate 3586 * higher-priority (more likely) completions. 3587 */ 3588CINDEX_LINKAGE unsigned 3589clang_getCompletionPriority(CXCompletionString completion_string); 3590 3591/** 3592 * \brief Determine the availability of the entity that this code-completion 3593 * string refers to. 3594 * 3595 * \param completion_string The completion string to query. 3596 * 3597 * \returns The availability of the completion string. 3598 */ 3599CINDEX_LINKAGE enum CXAvailabilityKind 3600clang_getCompletionAvailability(CXCompletionString completion_string); 3601 3602/** 3603 * \brief Retrieve the number of annotations associated with the given 3604 * completion string. 3605 * 3606 * \param completion_string the completion string to query. 3607 * 3608 * \returns the number of annotations associated with the given completion 3609 * string. 3610 */ 3611CINDEX_LINKAGE unsigned 3612clang_getCompletionNumAnnotations(CXCompletionString completion_string); 3613 3614/** 3615 * \brief Retrieve the annotation associated with the given completion string. 3616 * 3617 * \param completion_string the completion string to query. 3618 * 3619 * \param annotation_number the 0-based index of the annotation of the 3620 * completion string. 3621 * 3622 * \returns annotation string associated with the completion at index 3623 * \c annotation_number, or a NULL string if that annotation is not available. 3624 */ 3625CINDEX_LINKAGE CXString 3626clang_getCompletionAnnotation(CXCompletionString completion_string, 3627 unsigned annotation_number); 3628 3629/** 3630 * \brief Retrieve the parent context of the given completion string. 3631 * 3632 * The parent context of a completion string is the semantic parent of 3633 * the declaration (if any) that the code completion represents. For example, 3634 * a code completion for an Objective-C method would have the method's class 3635 * or protocol as its context. 3636 * 3637 * \param completion_string The code completion string whose parent is 3638 * being queried. 3639 * 3640 * \param kind If non-NULL, will be set to the kind of the parent context, 3641 * or CXCursor_NotImplemented if there is no context. 3642 * 3643 * \param Returns the name of the completion parent, e.g., "NSObject" if 3644 * the completion string represents a method in the NSObject class. 3645 */ 3646CINDEX_LINKAGE CXString 3647clang_getCompletionParent(CXCompletionString completion_string, 3648 enum CXCursorKind *kind); 3649/** 3650 * \brief Retrieve a completion string for an arbitrary declaration or macro 3651 * definition cursor. 3652 * 3653 * \param cursor The cursor to query. 3654 * 3655 * \returns A non-context-sensitive completion string for declaration and macro 3656 * definition cursors, or NULL for other kinds of cursors. 3657 */ 3658CINDEX_LINKAGE CXCompletionString 3659clang_getCursorCompletionString(CXCursor cursor); 3660 3661/** 3662 * \brief Contains the results of code-completion. 3663 * 3664 * This data structure contains the results of code completion, as 3665 * produced by \c clang_codeCompleteAt(). Its contents must be freed by 3666 * \c clang_disposeCodeCompleteResults. 3667 */ 3668typedef struct { 3669 /** 3670 * \brief The code-completion results. 3671 */ 3672 CXCompletionResult *Results; 3673 3674 /** 3675 * \brief The number of code-completion results stored in the 3676 * \c Results array. 3677 */ 3678 unsigned NumResults; 3679} CXCodeCompleteResults; 3680 3681/** 3682 * \brief Flags that can be passed to \c clang_codeCompleteAt() to 3683 * modify its behavior. 3684 * 3685 * The enumerators in this enumeration can be bitwise-OR'd together to 3686 * provide multiple options to \c clang_codeCompleteAt(). 3687 */ 3688enum CXCodeComplete_Flags { 3689 /** 3690 * \brief Whether to include macros within the set of code 3691 * completions returned. 3692 */ 3693 CXCodeComplete_IncludeMacros = 0x01, 3694 3695 /** 3696 * \brief Whether to include code patterns for language constructs 3697 * within the set of code completions, e.g., for loops. 3698 */ 3699 CXCodeComplete_IncludeCodePatterns = 0x02 3700}; 3701 3702/** 3703 * \brief Bits that represent the context under which completion is occurring. 3704 * 3705 * The enumerators in this enumeration may be bitwise-OR'd together if multiple 3706 * contexts are occurring simultaneously. 3707 */ 3708enum CXCompletionContext { 3709 /** 3710 * \brief The context for completions is unexposed, as only Clang results 3711 * should be included. (This is equivalent to having no context bits set.) 3712 */ 3713 CXCompletionContext_Unexposed = 0, 3714 3715 /** 3716 * \brief Completions for any possible type should be included in the results. 3717 */ 3718 CXCompletionContext_AnyType = 1 << 0, 3719 3720 /** 3721 * \brief Completions for any possible value (variables, function calls, etc.) 3722 * should be included in the results. 3723 */ 3724 CXCompletionContext_AnyValue = 1 << 1, 3725 /** 3726 * \brief Completions for values that resolve to an Objective-C object should 3727 * be included in the results. 3728 */ 3729 CXCompletionContext_ObjCObjectValue = 1 << 2, 3730 /** 3731 * \brief Completions for values that resolve to an Objective-C selector 3732 * should be included in the results. 3733 */ 3734 CXCompletionContext_ObjCSelectorValue = 1 << 3, 3735 /** 3736 * \brief Completions for values that resolve to a C++ class type should be 3737 * included in the results. 3738 */ 3739 CXCompletionContext_CXXClassTypeValue = 1 << 4, 3740 3741 /** 3742 * \brief Completions for fields of the member being accessed using the dot 3743 * operator should be included in the results. 3744 */ 3745 CXCompletionContext_DotMemberAccess = 1 << 5, 3746 /** 3747 * \brief Completions for fields of the member being accessed using the arrow 3748 * operator should be included in the results. 3749 */ 3750 CXCompletionContext_ArrowMemberAccess = 1 << 6, 3751 /** 3752 * \brief Completions for properties of the Objective-C object being accessed 3753 * using the dot operator should be included in the results. 3754 */ 3755 CXCompletionContext_ObjCPropertyAccess = 1 << 7, 3756 3757 /** 3758 * \brief Completions for enum tags should be included in the results. 3759 */ 3760 CXCompletionContext_EnumTag = 1 << 8, 3761 /** 3762 * \brief Completions for union tags should be included in the results. 3763 */ 3764 CXCompletionContext_UnionTag = 1 << 9, 3765 /** 3766 * \brief Completions for struct tags should be included in the results. 3767 */ 3768 CXCompletionContext_StructTag = 1 << 10, 3769 3770 /** 3771 * \brief Completions for C++ class names should be included in the results. 3772 */ 3773 CXCompletionContext_ClassTag = 1 << 11, 3774 /** 3775 * \brief Completions for C++ namespaces and namespace aliases should be 3776 * included in the results. 3777 */ 3778 CXCompletionContext_Namespace = 1 << 12, 3779 /** 3780 * \brief Completions for C++ nested name specifiers should be included in 3781 * the results. 3782 */ 3783 CXCompletionContext_NestedNameSpecifier = 1 << 13, 3784 3785 /** 3786 * \brief Completions for Objective-C interfaces (classes) should be included 3787 * in the results. 3788 */ 3789 CXCompletionContext_ObjCInterface = 1 << 14, 3790 /** 3791 * \brief Completions for Objective-C protocols should be included in 3792 * the results. 3793 */ 3794 CXCompletionContext_ObjCProtocol = 1 << 15, 3795 /** 3796 * \brief Completions for Objective-C categories should be included in 3797 * the results. 3798 */ 3799 CXCompletionContext_ObjCCategory = 1 << 16, 3800 /** 3801 * \brief Completions for Objective-C instance messages should be included 3802 * in the results. 3803 */ 3804 CXCompletionContext_ObjCInstanceMessage = 1 << 17, 3805 /** 3806 * \brief Completions for Objective-C class messages should be included in 3807 * the results. 3808 */ 3809 CXCompletionContext_ObjCClassMessage = 1 << 18, 3810 /** 3811 * \brief Completions for Objective-C selector names should be included in 3812 * the results. 3813 */ 3814 CXCompletionContext_ObjCSelectorName = 1 << 19, 3815 3816 /** 3817 * \brief Completions for preprocessor macro names should be included in 3818 * the results. 3819 */ 3820 CXCompletionContext_MacroName = 1 << 20, 3821 3822 /** 3823 * \brief Natural language completions should be included in the results. 3824 */ 3825 CXCompletionContext_NaturalLanguage = 1 << 21, 3826 3827 /** 3828 * \brief The current context is unknown, so set all contexts. 3829 */ 3830 CXCompletionContext_Unknown = ((1 << 22) - 1) 3831}; 3832 3833/** 3834 * \brief Returns a default set of code-completion options that can be 3835 * passed to\c clang_codeCompleteAt(). 3836 */ 3837CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 3838 3839/** 3840 * \brief Perform code completion at a given location in a translation unit. 3841 * 3842 * This function performs code completion at a particular file, line, and 3843 * column within source code, providing results that suggest potential 3844 * code snippets based on the context of the completion. The basic model 3845 * for code completion is that Clang will parse a complete source file, 3846 * performing syntax checking up to the location where code-completion has 3847 * been requested. At that point, a special code-completion token is passed 3848 * to the parser, which recognizes this token and determines, based on the 3849 * current location in the C/Objective-C/C++ grammar and the state of 3850 * semantic analysis, what completions to provide. These completions are 3851 * returned via a new \c CXCodeCompleteResults structure. 3852 * 3853 * Code completion itself is meant to be triggered by the client when the 3854 * user types punctuation characters or whitespace, at which point the 3855 * code-completion location will coincide with the cursor. For example, if \c p 3856 * is a pointer, code-completion might be triggered after the "-" and then 3857 * after the ">" in \c p->. When the code-completion location is afer the ">", 3858 * the completion results will provide, e.g., the members of the struct that 3859 * "p" points to. The client is responsible for placing the cursor at the 3860 * beginning of the token currently being typed, then filtering the results 3861 * based on the contents of the token. For example, when code-completing for 3862 * the expression \c p->get, the client should provide the location just after 3863 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 3864 * client can filter the results based on the current token text ("get"), only 3865 * showing those results that start with "get". The intent of this interface 3866 * is to separate the relatively high-latency acquisition of code-completion 3867 * results from the filtering of results on a per-character basis, which must 3868 * have a lower latency. 3869 * 3870 * \param TU The translation unit in which code-completion should 3871 * occur. The source files for this translation unit need not be 3872 * completely up-to-date (and the contents of those source files may 3873 * be overridden via \p unsaved_files). Cursors referring into the 3874 * translation unit may be invalidated by this invocation. 3875 * 3876 * \param complete_filename The name of the source file where code 3877 * completion should be performed. This filename may be any file 3878 * included in the translation unit. 3879 * 3880 * \param complete_line The line at which code-completion should occur. 3881 * 3882 * \param complete_column The column at which code-completion should occur. 3883 * Note that the column should point just after the syntactic construct that 3884 * initiated code completion, and not in the middle of a lexical token. 3885 * 3886 * \param unsaved_files the Tiles that have not yet been saved to disk 3887 * but may be required for parsing or code completion, including the 3888 * contents of those files. The contents and name of these files (as 3889 * specified by CXUnsavedFile) are copied when necessary, so the 3890 * client only needs to guarantee their validity until the call to 3891 * this function returns. 3892 * 3893 * \param num_unsaved_files The number of unsaved file entries in \p 3894 * unsaved_files. 3895 * 3896 * \param options Extra options that control the behavior of code 3897 * completion, expressed as a bitwise OR of the enumerators of the 3898 * CXCodeComplete_Flags enumeration. The 3899 * \c clang_defaultCodeCompleteOptions() function returns a default set 3900 * of code-completion options. 3901 * 3902 * \returns If successful, a new \c CXCodeCompleteResults structure 3903 * containing code-completion results, which should eventually be 3904 * freed with \c clang_disposeCodeCompleteResults(). If code 3905 * completion fails, returns NULL. 3906 */ 3907CINDEX_LINKAGE 3908CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 3909 const char *complete_filename, 3910 unsigned complete_line, 3911 unsigned complete_column, 3912 struct CXUnsavedFile *unsaved_files, 3913 unsigned num_unsaved_files, 3914 unsigned options); 3915 3916/** 3917 * \brief Sort the code-completion results in case-insensitive alphabetical 3918 * order. 3919 * 3920 * \param Results The set of results to sort. 3921 * \param NumResults The number of results in \p Results. 3922 */ 3923CINDEX_LINKAGE 3924void clang_sortCodeCompletionResults(CXCompletionResult *Results, 3925 unsigned NumResults); 3926 3927/** 3928 * \brief Free the given set of code-completion results. 3929 */ 3930CINDEX_LINKAGE 3931void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 3932 3933/** 3934 * \brief Determine the number of diagnostics produced prior to the 3935 * location where code completion was performed. 3936 */ 3937CINDEX_LINKAGE 3938unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 3939 3940/** 3941 * \brief Retrieve a diagnostic associated with the given code completion. 3942 * 3943 * \param Result the code completion results to query. 3944 * \param Index the zero-based diagnostic number to retrieve. 3945 * 3946 * \returns the requested diagnostic. This diagnostic must be freed 3947 * via a call to \c clang_disposeDiagnostic(). 3948 */ 3949CINDEX_LINKAGE 3950CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 3951 unsigned Index); 3952 3953/** 3954 * \brief Determines what compeltions are appropriate for the context 3955 * the given code completion. 3956 * 3957 * \param Results the code completion results to query 3958 * 3959 * \returns the kinds of completions that are appropriate for use 3960 * along with the given code completion results. 3961 */ 3962CINDEX_LINKAGE 3963unsigned long long clang_codeCompleteGetContexts( 3964 CXCodeCompleteResults *Results); 3965 3966/** 3967 * \brief Returns the cursor kind for the container for the current code 3968 * completion context. The container is only guaranteed to be set for 3969 * contexts where a container exists (i.e. member accesses or Objective-C 3970 * message sends); if there is not a container, this function will return 3971 * CXCursor_InvalidCode. 3972 * 3973 * \param Results the code completion results to query 3974 * 3975 * \param IsIncomplete on return, this value will be false if Clang has complete 3976 * information about the container. If Clang does not have complete 3977 * information, this value will be true. 3978 * 3979 * \returns the container kind, or CXCursor_InvalidCode if there is not a 3980 * container 3981 */ 3982CINDEX_LINKAGE 3983enum CXCursorKind clang_codeCompleteGetContainerKind( 3984 CXCodeCompleteResults *Results, 3985 unsigned *IsIncomplete); 3986 3987/** 3988 * \brief Returns the USR for the container for the current code completion 3989 * context. If there is not a container for the current context, this 3990 * function will return the empty string. 3991 * 3992 * \param Results the code completion results to query 3993 * 3994 * \returns the USR for the container 3995 */ 3996CINDEX_LINKAGE 3997CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results); 3998 3999 4000/** 4001 * \brief Returns the currently-entered selector for an Objective-C message 4002 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a 4003 * non-empty string for CXCompletionContext_ObjCInstanceMessage and 4004 * CXCompletionContext_ObjCClassMessage. 4005 * 4006 * \param Results the code completion results to query 4007 * 4008 * \returns the selector (or partial selector) that has been entered thus far 4009 * for an Objective-C message send. 4010 */ 4011CINDEX_LINKAGE 4012CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results); 4013 4014/** 4015 * @} 4016 */ 4017 4018 4019/** 4020 * \defgroup CINDEX_MISC Miscellaneous utility functions 4021 * 4022 * @{ 4023 */ 4024 4025/** 4026 * \brief Return a version string, suitable for showing to a user, but not 4027 * intended to be parsed (the format is not guaranteed to be stable). 4028 */ 4029CINDEX_LINKAGE CXString clang_getClangVersion(); 4030 4031 4032/** 4033 * \brief Enable/disable crash recovery. 4034 * 4035 * \param Flag to indicate if crash recovery is enabled. A non-zero value 4036 * enables crash recovery, while 0 disables it. 4037 */ 4038CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled); 4039 4040 /** 4041 * \brief Visitor invoked for each file in a translation unit 4042 * (used with clang_getInclusions()). 4043 * 4044 * This visitor function will be invoked by clang_getInclusions() for each 4045 * file included (either at the top-level or by #include directives) within 4046 * a translation unit. The first argument is the file being included, and 4047 * the second and third arguments provide the inclusion stack. The 4048 * array is sorted in order of immediate inclusion. For example, 4049 * the first element refers to the location that included 'included_file'. 4050 */ 4051typedef void (*CXInclusionVisitor)(CXFile included_file, 4052 CXSourceLocation* inclusion_stack, 4053 unsigned include_len, 4054 CXClientData client_data); 4055 4056/** 4057 * \brief Visit the set of preprocessor inclusions in a translation unit. 4058 * The visitor function is called with the provided data for every included 4059 * file. This does not include headers included by the PCH file (unless one 4060 * is inspecting the inclusions in the PCH file itself). 4061 */ 4062CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 4063 CXInclusionVisitor visitor, 4064 CXClientData client_data); 4065 4066/** 4067 * @} 4068 */ 4069 4070/** \defgroup CINDEX_REMAPPING Remapping functions 4071 * 4072 * @{ 4073 */ 4074 4075/** 4076 * \brief A remapping of original source files and their translated files. 4077 */ 4078typedef void *CXRemapping; 4079 4080/** 4081 * \brief Retrieve a remapping. 4082 * 4083 * \param path the path that contains metadata about remappings. 4084 * 4085 * \returns the requested remapping. This remapping must be freed 4086 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 4087 */ 4088CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path); 4089 4090/** 4091 * \brief Retrieve a remapping. 4092 * 4093 * \param filePaths pointer to an array of file paths containing remapping info. 4094 * 4095 * \param numFiles number of file paths. 4096 * 4097 * \returns the requested remapping. This remapping must be freed 4098 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 4099 */ 4100CINDEX_LINKAGE 4101CXRemapping clang_getRemappingsFromFileList(const char **filePaths, 4102 unsigned numFiles); 4103 4104/** 4105 * \brief Determine the number of remappings. 4106 */ 4107CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping); 4108 4109/** 4110 * \brief Get the original and the associated filename from the remapping. 4111 * 4112 * \param original If non-NULL, will be set to the original filename. 4113 * 4114 * \param transformed If non-NULL, will be set to the filename that the original 4115 * is associated with. 4116 */ 4117CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index, 4118 CXString *original, CXString *transformed); 4119 4120/** 4121 * \brief Dispose the remapping. 4122 */ 4123CINDEX_LINKAGE void clang_remap_dispose(CXRemapping); 4124 4125/** 4126 * @} 4127 */ 4128 4129/** \defgroup CINDEX_HIGH Higher level API functions 4130 * 4131 * @{ 4132 */ 4133 4134enum CXVisitorResult { 4135 CXVisit_Break, 4136 CXVisit_Continue 4137}; 4138 4139typedef struct { 4140 void *context; 4141 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange); 4142} CXCursorAndRangeVisitor; 4143 4144/** 4145 * \brief Find references of a declaration in a specific file. 4146 * 4147 * \param cursor pointing to a declaration or a reference of one. 4148 * 4149 * \param file to search for references. 4150 * 4151 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for 4152 * each reference found. 4153 * The CXSourceRange will point inside the file; if the reference is inside 4154 * a macro (and not a macro argument) the CXSourceRange will be invalid. 4155 */ 4156CINDEX_LINKAGE void clang_findReferencesInFile(CXCursor cursor, CXFile file, 4157 CXCursorAndRangeVisitor visitor); 4158 4159#ifdef __has_feature 4160# if __has_feature(blocks) 4161 4162typedef enum CXVisitorResult 4163 (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange); 4164 4165CINDEX_LINKAGE 4166void clang_findReferencesInFileWithBlock(CXCursor, CXFile, 4167 CXCursorAndRangeVisitorBlock); 4168 4169# endif 4170#endif 4171 4172/** 4173 * \brief The client's data object that is associated with a CXFile. 4174 */ 4175typedef void *CXIdxClientFile; 4176 4177/** 4178 * \brief The client's data object that is associated with a semantic entity. 4179 */ 4180typedef void *CXIdxClientEntity; 4181 4182/** 4183 * \brief The client's data object that is associated with a semantic container 4184 * of entities. 4185 */ 4186typedef void *CXIdxClientContainer; 4187 4188/** 4189 * \brief The client's data object that is associated with an AST file (PCH 4190 * or module). 4191 */ 4192typedef void *CXIdxClientASTFile; 4193 4194/** 4195 * \brief Source location passed to index callbacks. 4196 */ 4197typedef struct { 4198 void *ptr_data[2]; 4199 unsigned int_data; 4200} CXIdxLoc; 4201 4202/** 4203 * \brief Data for \see ppIncludedFile callback. 4204 */ 4205typedef struct { 4206 /** 4207 * \brief Location of '#' in the #include/#import directive. 4208 */ 4209 CXIdxLoc hashLoc; 4210 /** 4211 * \brief Filename as written in the #include/#import directive. 4212 */ 4213 const char *filename; 4214 /** 4215 * \brief The actual file that the #include/#import directive resolved to. 4216 */ 4217 CXFile file; 4218 int isImport; 4219 int isAngled; 4220} CXIdxIncludedFileInfo; 4221 4222/** 4223 * \brief Data for \see importedASTFile callback. 4224 */ 4225typedef struct { 4226 CXFile file; 4227 /** 4228 * \brief Location where the file is imported. It is useful mostly for 4229 * modules. 4230 */ 4231 CXIdxLoc loc; 4232 /** 4233 * \brief Non-zero if the AST file is a module otherwise it's a PCH. 4234 */ 4235 int isModule; 4236} CXIdxImportedASTFileInfo; 4237 4238typedef enum { 4239 CXIdxEntity_Unexposed = 0, 4240 CXIdxEntity_Typedef = 1, 4241 CXIdxEntity_Function = 2, 4242 CXIdxEntity_Variable = 3, 4243 CXIdxEntity_Field = 4, 4244 CXIdxEntity_EnumConstant = 5, 4245 4246 CXIdxEntity_ObjCClass = 6, 4247 CXIdxEntity_ObjCProtocol = 7, 4248 CXIdxEntity_ObjCCategory = 8, 4249 4250 CXIdxEntity_ObjCInstanceMethod = 9, 4251 CXIdxEntity_ObjCClassMethod = 10, 4252 CXIdxEntity_ObjCProperty = 11, 4253 CXIdxEntity_ObjCIvar = 12, 4254 4255 CXIdxEntity_Enum = 13, 4256 CXIdxEntity_Struct = 14, 4257 CXIdxEntity_Union = 15, 4258 4259 CXIdxEntity_CXXClass = 16, 4260 CXIdxEntity_CXXNamespace = 17, 4261 CXIdxEntity_CXXNamespaceAlias = 18, 4262 CXIdxEntity_CXXStaticVariable = 19, 4263 CXIdxEntity_CXXStaticMethod = 20, 4264 CXIdxEntity_CXXInstanceMethod = 21, 4265 CXIdxEntity_CXXConstructor = 22, 4266 CXIdxEntity_CXXDestructor = 23, 4267 CXIdxEntity_CXXConversionFunction = 24, 4268 CXIdxEntity_CXXTypeAlias = 25 4269 4270} CXIdxEntityKind; 4271 4272typedef enum { 4273 CXIdxEntityLang_None = 0, 4274 CXIdxEntityLang_C = 1, 4275 CXIdxEntityLang_ObjC = 2, 4276 CXIdxEntityLang_CXX = 3 4277} CXIdxEntityLanguage; 4278 4279/** 4280 * \brief Extra C++ template information for an entity. This can apply to: 4281 * CXIdxEntity_Function 4282 * CXIdxEntity_CXXClass 4283 * CXIdxEntity_CXXStaticMethod 4284 * CXIdxEntity_CXXInstanceMethod 4285 * CXIdxEntity_CXXConstructor 4286 * CXIdxEntity_CXXConversionFunction 4287 * CXIdxEntity_CXXTypeAlias 4288 */ 4289typedef enum { 4290 CXIdxEntity_NonTemplate = 0, 4291 CXIdxEntity_Template = 1, 4292 CXIdxEntity_TemplatePartialSpecialization = 2, 4293 CXIdxEntity_TemplateSpecialization = 3 4294} CXIdxEntityCXXTemplateKind; 4295 4296typedef enum { 4297 CXIdxAttr_Unexposed = 0, 4298 CXIdxAttr_IBAction = 1, 4299 CXIdxAttr_IBOutlet = 2, 4300 CXIdxAttr_IBOutletCollection = 3 4301} CXIdxAttrKind; 4302 4303typedef struct { 4304 CXIdxAttrKind kind; 4305 CXCursor cursor; 4306 CXIdxLoc loc; 4307} CXIdxAttrInfo; 4308 4309typedef struct { 4310 CXIdxEntityKind kind; 4311 CXIdxEntityCXXTemplateKind templateKind; 4312 CXIdxEntityLanguage lang; 4313 const char *name; 4314 const char *USR; 4315 CXCursor cursor; 4316 const CXIdxAttrInfo *const *attributes; 4317 unsigned numAttributes; 4318} CXIdxEntityInfo; 4319 4320typedef struct { 4321 CXCursor cursor; 4322} CXIdxContainerInfo; 4323 4324typedef struct { 4325 const CXIdxAttrInfo *attrInfo; 4326 const CXIdxEntityInfo *objcClass; 4327 CXCursor classCursor; 4328 CXIdxLoc classLoc; 4329} CXIdxIBOutletCollectionAttrInfo; 4330 4331typedef struct { 4332 const CXIdxEntityInfo *entityInfo; 4333 CXCursor cursor; 4334 CXIdxLoc loc; 4335 const CXIdxContainerInfo *semanticContainer; 4336 /** 4337 * \brief Generally same as \see semanticContainer but can be different in 4338 * cases like out-of-line C++ member functions. 4339 */ 4340 const CXIdxContainerInfo *lexicalContainer; 4341 int isRedeclaration; 4342 int isDefinition; 4343 int isContainer; 4344 const CXIdxContainerInfo *declAsContainer; 4345 /** 4346 * \brief Whether the declaration exists in code or was created implicitly 4347 * by the compiler, e.g. implicit objc methods for properties. 4348 */ 4349 int isImplicit; 4350 const CXIdxAttrInfo *const *attributes; 4351 unsigned numAttributes; 4352} CXIdxDeclInfo; 4353 4354typedef enum { 4355 CXIdxObjCContainer_ForwardRef = 0, 4356 CXIdxObjCContainer_Interface = 1, 4357 CXIdxObjCContainer_Implementation = 2 4358} CXIdxObjCContainerKind; 4359 4360typedef struct { 4361 const CXIdxDeclInfo *declInfo; 4362 CXIdxObjCContainerKind kind; 4363} CXIdxObjCContainerDeclInfo; 4364 4365typedef struct { 4366 const CXIdxEntityInfo *base; 4367 CXCursor cursor; 4368 CXIdxLoc loc; 4369} CXIdxBaseClassInfo; 4370 4371typedef struct { 4372 const CXIdxEntityInfo *protocol; 4373 CXCursor cursor; 4374 CXIdxLoc loc; 4375} CXIdxObjCProtocolRefInfo; 4376 4377typedef struct { 4378 const CXIdxObjCProtocolRefInfo *const *protocols; 4379 unsigned numProtocols; 4380} CXIdxObjCProtocolRefListInfo; 4381 4382typedef struct { 4383 const CXIdxObjCContainerDeclInfo *containerInfo; 4384 const CXIdxBaseClassInfo *superInfo; 4385 const CXIdxObjCProtocolRefListInfo *protocols; 4386} CXIdxObjCInterfaceDeclInfo; 4387 4388typedef struct { 4389 const CXIdxObjCContainerDeclInfo *containerInfo; 4390 const CXIdxEntityInfo *objcClass; 4391 CXCursor classCursor; 4392 CXIdxLoc classLoc; 4393 const CXIdxObjCProtocolRefListInfo *protocols; 4394} CXIdxObjCCategoryDeclInfo; 4395 4396typedef struct { 4397 const CXIdxDeclInfo *declInfo; 4398 const CXIdxEntityInfo *getter; 4399 const CXIdxEntityInfo *setter; 4400} CXIdxObjCPropertyDeclInfo; 4401 4402typedef struct { 4403 const CXIdxDeclInfo *declInfo; 4404 const CXIdxBaseClassInfo *const *bases; 4405 unsigned numBases; 4406} CXIdxCXXClassDeclInfo; 4407 4408/** 4409 * \brief Data for \see indexEntityReference callback. 4410 */ 4411typedef enum { 4412 /** 4413 * \brief The entity is referenced directly in user's code. 4414 */ 4415 CXIdxEntityRef_Direct = 1, 4416 /** 4417 * \brief An implicit reference, e.g. a reference of an ObjC method via the 4418 * dot syntax. 4419 */ 4420 CXIdxEntityRef_Implicit = 2 4421} CXIdxEntityRefKind; 4422 4423/** 4424 * \brief Data for \see indexEntityReference callback. 4425 */ 4426typedef struct { 4427 CXIdxEntityRefKind kind; 4428 /** 4429 * \brief Reference cursor. 4430 */ 4431 CXCursor cursor; 4432 CXIdxLoc loc; 4433 /** 4434 * \brief The entity that gets referenced. 4435 */ 4436 const CXIdxEntityInfo *referencedEntity; 4437 /** 4438 * \brief Immediate "parent" of the reference. For example: 4439 * 4440 * \code 4441 * Foo *var; 4442 * \endcode 4443 * 4444 * The parent of reference of type 'Foo' is the variable 'var'. 4445 * For references inside statement bodies of functions/methods, 4446 * the parentEntity will be the function/method. 4447 */ 4448 const CXIdxEntityInfo *parentEntity; 4449 /** 4450 * \brief Lexical container context of the reference. 4451 */ 4452 const CXIdxContainerInfo *container; 4453} CXIdxEntityRefInfo; 4454 4455typedef struct { 4456 /** 4457 * \brief Called periodically to check whether indexing should be aborted. 4458 * Should return 0 to continue, and non-zero to abort. 4459 */ 4460 int (*abortQuery)(CXClientData client_data, void *reserved); 4461 4462 /** 4463 * \brief Called at the end of indexing; passes the complete diagnostic set. 4464 */ 4465 void (*diagnostic)(CXClientData client_data, 4466 CXDiagnosticSet, void *reserved); 4467 4468 CXIdxClientFile (*enteredMainFile)(CXClientData client_data, 4469 CXFile mainFile, void *reserved); 4470 4471 /** 4472 * \brief Called when a file gets #included/#imported. 4473 */ 4474 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data, 4475 const CXIdxIncludedFileInfo *); 4476 4477 /** 4478 * \brief Called when a AST file (PCH or module) gets imported. 4479 * 4480 * AST files will not get indexed (there will not be callbacks to index all 4481 * the entities in an AST file). The recommended action is that, if the AST 4482 * file is not already indexed, to block further indexing and initiate a new 4483 * indexing job specific to the AST file. 4484 */ 4485 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data, 4486 const CXIdxImportedASTFileInfo *); 4487 4488 /** 4489 * \brief Called at the beginning of indexing a translation unit. 4490 */ 4491 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data, 4492 void *reserved); 4493 4494 void (*indexDeclaration)(CXClientData client_data, 4495 const CXIdxDeclInfo *); 4496 4497 /** 4498 * \brief Called to index a reference of an entity. 4499 */ 4500 void (*indexEntityReference)(CXClientData client_data, 4501 const CXIdxEntityRefInfo *); 4502 4503} IndexerCallbacks; 4504 4505CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind); 4506CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo * 4507clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *); 4508 4509CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo * 4510clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *); 4511 4512CINDEX_LINKAGE 4513const CXIdxObjCCategoryDeclInfo * 4514clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *); 4515 4516CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo * 4517clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *); 4518 4519CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo * 4520clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *); 4521 4522CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo * 4523clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *); 4524 4525CINDEX_LINKAGE const CXIdxCXXClassDeclInfo * 4526clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *); 4527 4528/** 4529 * \brief For retrieving a custom CXIdxClientContainer attached to a 4530 * container. 4531 */ 4532CINDEX_LINKAGE CXIdxClientContainer 4533clang_index_getClientContainer(const CXIdxContainerInfo *); 4534 4535/** 4536 * \brief For setting a custom CXIdxClientContainer attached to a 4537 * container. 4538 */ 4539CINDEX_LINKAGE void 4540clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer); 4541 4542/** 4543 * \brief For retrieving a custom CXIdxClientEntity attached to an entity. 4544 */ 4545CINDEX_LINKAGE CXIdxClientEntity 4546clang_index_getClientEntity(const CXIdxEntityInfo *); 4547 4548/** 4549 * \brief For setting a custom CXIdxClientEntity attached to an entity. 4550 */ 4551CINDEX_LINKAGE void 4552clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity); 4553 4554/** 4555 * \brief An indexing action, to be applied to one or multiple translation units 4556 * but not on concurrent threads. If there are threads doing indexing 4557 * concurrently, they should use different CXIndexAction objects. 4558 */ 4559typedef void *CXIndexAction; 4560 4561/** 4562 * \brief An indexing action, to be applied to one or multiple translation units 4563 * but not on concurrent threads. If there are threads doing indexing 4564 * concurrently, they should use different CXIndexAction objects. 4565 * 4566 * \param CIdx The index object with which the index action will be associated. 4567 */ 4568CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx); 4569 4570/** 4571 * \brief Destroy the given index action. 4572 * 4573 * The index action must not be destroyed until all of the translation units 4574 * created within that index action have been destroyed. 4575 */ 4576CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction); 4577 4578typedef enum { 4579 /** 4580 * \brief Used to indicate that no special indexing options are needed. 4581 */ 4582 CXIndexOpt_None = 0x0, 4583 4584 /** 4585 * \brief Used to indicate that \see indexEntityReference should be invoked 4586 * for only one reference of an entity per source file that does not also 4587 * include a declaration/definition of the entity. 4588 */ 4589 CXIndexOpt_SuppressRedundantRefs = 0x1, 4590 4591 /** 4592 * \brief Function-local symbols should be indexed. If this is not set 4593 * function-local symbols will be ignored. 4594 */ 4595 CXIndexOpt_IndexFunctionLocalSymbols = 0x2, 4596 4597 /** 4598 * \brief Implicit function/class template instantiations should be indexed. 4599 * If this is not set, implicit instantiations will be ignored. 4600 */ 4601 CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4, 4602 4603 /** 4604 * \brief Suppress all compiler warnings when parsing for indexing. 4605 */ 4606 CXIndexOpt_SuppressWarnings = 0x8 4607} CXIndexOptFlags; 4608 4609/** 4610 * \brief Index the given source file and the translation unit corresponding 4611 * to that file via callbacks implemented through \see IndexerCallbacks. 4612 * 4613 * \param client_data pointer data supplied by the client, which will 4614 * be passed to the invoked callbacks. 4615 * 4616 * \param index_callbacks Pointer to indexing callbacks that the client 4617 * implements. 4618 * 4619 * \param index_callbacks_size Size of \see IndexerCallbacks structure that gets 4620 * passed in index_callbacks. 4621 * 4622 * \param index_options A bitmask of options that affects how indexing is 4623 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags. 4624 * 4625 * \param out_TU [out] pointer to store a CXTranslationUnit that can be reused 4626 * after indexing is finished. Set to NULL if you do not require it. 4627 * 4628 * \returns If there is a failure from which the there is no recovery, returns 4629 * non-zero, otherwise returns 0. 4630 * 4631 * The rest of the parameters are the same as \see clang_parseTranslationUnit. 4632 */ 4633CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction, 4634 CXClientData client_data, 4635 IndexerCallbacks *index_callbacks, 4636 unsigned index_callbacks_size, 4637 unsigned index_options, 4638 const char *source_filename, 4639 const char * const *command_line_args, 4640 int num_command_line_args, 4641 struct CXUnsavedFile *unsaved_files, 4642 unsigned num_unsaved_files, 4643 CXTranslationUnit *out_TU, 4644 unsigned TU_options); 4645 4646/** 4647 * \brief Index the given translation unit via callbacks implemented through 4648 * \see IndexerCallbacks. 4649 * 4650 * The order of callback invocations is not guaranteed to be the same as 4651 * when indexing a source file. The high level order will be: 4652 * 4653 * -Preprocessor callbacks invocations 4654 * -Declaration/reference callbacks invocations 4655 * -Diagnostic callback invocations 4656 * 4657 * The parameters are the same as \see clang_indexSourceFile. 4658 * 4659 * \returns If there is a failure from which the there is no recovery, returns 4660 * non-zero, otherwise returns 0. 4661 */ 4662CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction, 4663 CXClientData client_data, 4664 IndexerCallbacks *index_callbacks, 4665 unsigned index_callbacks_size, 4666 unsigned index_options, 4667 CXTranslationUnit); 4668 4669/** 4670 * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by 4671 * the given CXIdxLoc. 4672 * 4673 * If the location refers into a macro expansion, retrieves the 4674 * location of the macro expansion and if it refers into a macro argument 4675 * retrieves the location of the argument. 4676 */ 4677CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc, 4678 CXIdxClientFile *indexFile, 4679 CXFile *file, 4680 unsigned *line, 4681 unsigned *column, 4682 unsigned *offset); 4683 4684/** 4685 * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc. 4686 */ 4687CINDEX_LINKAGE 4688CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc); 4689 4690/** 4691 * @} 4692 */ 4693 4694/** 4695 * @} 4696 */ 4697 4698#ifdef __cplusplus 4699} 4700#endif 4701#endif 4702 4703