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