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