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