Index.h revision 256382
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 55extern "C" { 56#endif 57 58/** \defgroup CINDEX libclang: C Interface to Clang 59 * 60 * The C Interface to Clang provides a relatively small API that exposes 61 * facilities for parsing source code into an abstract syntax tree (AST), 62 * loading already-parsed ASTs, traversing the AST, associating 63 * physical source locations with elements within the AST, and other 64 * facilities that support Clang-based development tools. 65 * 66 * This C interface to Clang will never provide all of the information 67 * representation stored in Clang's C++ AST, nor should it: the intent is to 68 * maintain an API that is relatively stable from one release to the next, 69 * providing only the basic functionality needed to support development tools. 70 * 71 * To avoid namespace pollution, data types are prefixed with "CX" and 72 * functions are prefixed with "clang_". 73 * 74 * @{ 75 */ 76 77/** 78 * \brief An "index" that consists of a set of translation units that would 79 * typically be linked together into an executable or library. 80 */ 81typedef void *CXIndex; 82 83/** 84 * \brief A single translation unit, which resides in an index. 85 */ 86typedef struct CXTranslationUnitImpl *CXTranslationUnit; 87 88/** 89 * \brief Opaque pointer representing client data that will be passed through 90 * to various callbacks and visitors. 91 */ 92typedef void *CXClientData; 93 94/** 95 * \brief Provides the contents of a file that has not yet been saved to disk. 96 * 97 * Each CXUnsavedFile instance provides the name of a file on the 98 * system along with the current contents of that file that have not 99 * yet been saved to disk. 100 */ 101struct CXUnsavedFile { 102 /** 103 * \brief The file whose contents have not yet been saved. 104 * 105 * This file must already exist in the file system. 106 */ 107 const char *Filename; 108 109 /** 110 * \brief A buffer containing the unsaved contents of this file. 111 */ 112 const char *Contents; 113 114 /** 115 * \brief The length of the unsaved contents of this buffer. 116 */ 117 unsigned long Length; 118}; 119 120/** 121 * \brief Describes the availability of a particular entity, which indicates 122 * whether the use of this entity will result in a warning or error due to 123 * it being deprecated or unavailable. 124 */ 125enum CXAvailabilityKind { 126 /** 127 * \brief The entity is available. 128 */ 129 CXAvailability_Available, 130 /** 131 * \brief The entity is available, but has been deprecated (and its use is 132 * not recommended). 133 */ 134 CXAvailability_Deprecated, 135 /** 136 * \brief The entity is not available; any use of it will be an error. 137 */ 138 CXAvailability_NotAvailable, 139 /** 140 * \brief The entity is available, but not accessible; any use of it will be 141 * an error. 142 */ 143 CXAvailability_NotAccessible 144}; 145 146/** 147 * \brief Describes a version number of the form major.minor.subminor. 148 */ 149typedef struct CXVersion { 150 /** 151 * \brief The major version number, e.g., the '10' in '10.7.3'. A negative 152 * value indicates that there is no version number at all. 153 */ 154 int Major; 155 /** 156 * \brief The minor version number, e.g., the '7' in '10.7.3'. This value 157 * will be negative if no minor version number was provided, e.g., for 158 * version '10'. 159 */ 160 int Minor; 161 /** 162 * \brief The subminor version number, e.g., the '3' in '10.7.3'. This value 163 * will be negative if no minor or subminor version number was provided, 164 * e.g., in version '10' or '10.7'. 165 */ 166 int Subminor; 167} CXVersion; 168 169/** 170 * \brief Provides a shared context for creating translation units. 171 * 172 * It provides two options: 173 * 174 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local" 175 * declarations (when loading any new translation units). A "local" declaration 176 * is one that belongs in the translation unit itself and not in a precompiled 177 * header that was used by the translation unit. If zero, all declarations 178 * will be enumerated. 179 * 180 * Here is an example: 181 * 182 * \code 183 * // excludeDeclsFromPCH = 1, displayDiagnostics=1 184 * Idx = clang_createIndex(1, 1); 185 * 186 * // IndexTest.pch was produced with the following command: 187 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch" 188 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch"); 189 * 190 * // This will load all the symbols from 'IndexTest.pch' 191 * clang_visitChildren(clang_getTranslationUnitCursor(TU), 192 * TranslationUnitVisitor, 0); 193 * clang_disposeTranslationUnit(TU); 194 * 195 * // This will load all the symbols from 'IndexTest.c', excluding symbols 196 * // from 'IndexTest.pch'. 197 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" }; 198 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args, 199 * 0, 0); 200 * clang_visitChildren(clang_getTranslationUnitCursor(TU), 201 * TranslationUnitVisitor, 0); 202 * clang_disposeTranslationUnit(TU); 203 * \endcode 204 * 205 * This process of creating the 'pch', loading it separately, and using it (via 206 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks 207 * (which gives the indexer the same performance benefit as the compiler). 208 */ 209CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 210 int displayDiagnostics); 211 212/** 213 * \brief Destroy the given index. 214 * 215 * The index must not be destroyed until all of the translation units created 216 * within that index have been destroyed. 217 */ 218CINDEX_LINKAGE void clang_disposeIndex(CXIndex index); 219 220typedef enum { 221 /** 222 * \brief Used to indicate that no special CXIndex options are needed. 223 */ 224 CXGlobalOpt_None = 0x0, 225 226 /** 227 * \brief Used to indicate that threads that libclang creates for indexing 228 * purposes should use background priority. 229 * 230 * Affects #clang_indexSourceFile, #clang_indexTranslationUnit, 231 * #clang_parseTranslationUnit, #clang_saveTranslationUnit. 232 */ 233 CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1, 234 235 /** 236 * \brief Used to indicate that threads that libclang creates for editing 237 * purposes should use background priority. 238 * 239 * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt, 240 * #clang_annotateTokens 241 */ 242 CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2, 243 244 /** 245 * \brief Used to indicate that all threads that libclang creates should use 246 * background priority. 247 */ 248 CXGlobalOpt_ThreadBackgroundPriorityForAll = 249 CXGlobalOpt_ThreadBackgroundPriorityForIndexing | 250 CXGlobalOpt_ThreadBackgroundPriorityForEditing 251 252} CXGlobalOptFlags; 253 254/** 255 * \brief Sets general options associated with a CXIndex. 256 * 257 * For example: 258 * \code 259 * CXIndex idx = ...; 260 * clang_CXIndex_setGlobalOptions(idx, 261 * clang_CXIndex_getGlobalOptions(idx) | 262 * CXGlobalOpt_ThreadBackgroundPriorityForIndexing); 263 * \endcode 264 * 265 * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags. 266 */ 267CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options); 268 269/** 270 * \brief Gets the general options associated with a CXIndex. 271 * 272 * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that 273 * are associated with the given CXIndex object. 274 */ 275CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex); 276 277/** 278 * \defgroup CINDEX_FILES File manipulation routines 279 * 280 * @{ 281 */ 282 283/** 284 * \brief A particular source file that is part of a translation unit. 285 */ 286typedef void *CXFile; 287 288 289/** 290 * \brief Retrieve the complete file and path name of the given file. 291 */ 292CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile); 293 294/** 295 * \brief Retrieve the last modification time of the given file. 296 */ 297CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile); 298 299/** 300 * \brief Uniquely identifies a CXFile, that refers to the same underlying file, 301 * across an indexing session. 302 */ 303typedef struct { 304 unsigned long long data[3]; 305} CXFileUniqueID; 306 307/** 308 * \brief Retrieve the unique ID for the given \c file. 309 * 310 * \param file the file to get the ID for. 311 * \param outID stores the returned CXFileUniqueID. 312 * \returns If there was a failure getting the unique ID, returns non-zero, 313 * otherwise returns 0. 314*/ 315CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID); 316 317/** 318 * \brief Determine whether the given header is guarded against 319 * multiple inclusions, either with the conventional 320 * \#ifndef/\#define/\#endif macro guards or with \#pragma once. 321 */ 322CINDEX_LINKAGE unsigned 323clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file); 324 325/** 326 * \brief Retrieve a file handle within the given translation unit. 327 * 328 * \param tu the translation unit 329 * 330 * \param file_name the name of the file. 331 * 332 * \returns the file handle for the named file in the translation unit \p tu, 333 * or a NULL file handle if the file was not a part of this translation unit. 334 */ 335CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu, 336 const char *file_name); 337 338/** 339 * @} 340 */ 341 342/** 343 * \defgroup CINDEX_LOCATIONS Physical source locations 344 * 345 * Clang represents physical source locations in its abstract syntax tree in 346 * great detail, with file, line, and column information for the majority of 347 * the tokens parsed in the source code. These data types and functions are 348 * used to represent source location information, either for a particular 349 * point in the program or for a range of points in the program, and extract 350 * specific location information from those data types. 351 * 352 * @{ 353 */ 354 355/** 356 * \brief Identifies a specific source location within a translation 357 * unit. 358 * 359 * Use clang_getExpansionLocation() or clang_getSpellingLocation() 360 * to map a source location to a particular file, line, and column. 361 */ 362typedef struct { 363 const void *ptr_data[2]; 364 unsigned int_data; 365} CXSourceLocation; 366 367/** 368 * \brief Identifies a half-open character range in the source code. 369 * 370 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the 371 * starting and end locations from a source range, respectively. 372 */ 373typedef struct { 374 const void *ptr_data[2]; 375 unsigned begin_int_data; 376 unsigned end_int_data; 377} CXSourceRange; 378 379/** 380 * \brief Retrieve a NULL (invalid) source location. 381 */ 382CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(void); 383 384/** 385 * \brief Determine whether two source locations, which must refer into 386 * the same translation unit, refer to exactly the same point in the source 387 * code. 388 * 389 * \returns non-zero if the source locations refer to the same location, zero 390 * if they refer to different locations. 391 */ 392CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1, 393 CXSourceLocation loc2); 394 395/** 396 * \brief Retrieves the source location associated with a given file/line/column 397 * in a particular translation unit. 398 */ 399CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu, 400 CXFile file, 401 unsigned line, 402 unsigned column); 403/** 404 * \brief Retrieves the source location associated with a given character offset 405 * in a particular translation unit. 406 */ 407CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 408 CXFile file, 409 unsigned offset); 410 411/** 412 * \brief Returns non-zero if the given source location is in a system header. 413 */ 414CINDEX_LINKAGE int clang_Location_isInSystemHeader(CXSourceLocation location); 415 416/** 417 * \brief Retrieve a NULL (invalid) source range. 418 */ 419CINDEX_LINKAGE CXSourceRange clang_getNullRange(void); 420 421/** 422 * \brief Retrieve a source range given the beginning and ending source 423 * locations. 424 */ 425CINDEX_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 */ 433CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1, 434 CXSourceRange range2); 435 436/** 437 * \brief Returns non-zero if \p range is null. 438 */ 439CINDEX_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 */ 463CINDEX_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 */ 509CINDEX_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 */ 522CINDEX_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 */ 550CINDEX_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 */ 579CINDEX_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 */ 589CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range); 590 591/** 592 * \brief Retrieve a source location representing the last character within a 593 * source range. 594 */ 595CINDEX_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 */ 610enum 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 */ 646typedef void *CXDiagnostic; 647 648/** 649 * \brief A group of CXDiagnostics. 650 */ 651typedef void *CXDiagnosticSet; 652 653/** 654 * \brief Determine the number of diagnostics in a CXDiagnosticSet. 655 */ 656CINDEX_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 */ 667CINDEX_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 */ 675enum 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 */ 713CINDEX_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 */ 720CINDEX_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 */ 728CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D); 729 730/** 731 * \brief Determine the number of diagnostics produced for the given 732 * translation unit. 733 */ 734CINDEX_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 */ 745CINDEX_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 */ 754CINDEX_LINKAGE CXDiagnosticSet 755 clang_getDiagnosticSetFromTU(CXTranslationUnit Unit); 756 757/** 758 * \brief Destroy a diagnostic. 759 */ 760CINDEX_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 */ 768enum 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 */ 845CINDEX_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 */ 855CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void); 856 857/** 858 * \brief Determine the severity of the given diagnostic. 859 */ 860CINDEX_LINKAGE enum CXDiagnosticSeverity 861clang_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 */ 869CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic); 870 871/** 872 * \brief Retrieve the text of the given diagnostic. 873 */ 874CINDEX_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 */ 888CINDEX_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 */ 901CINDEX_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 */ 913CINDEX_DEPRECATED CINDEX_LINKAGE 914CXString 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 */ 921CINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic); 922 923/** 924 * \brief Determine the number of source ranges associated with the given 925 * diagnostic. 926 */ 927CINDEX_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 */ 942CINDEX_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 */ 949CINDEX_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 */ 976CINDEX_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 */ 997CINDEX_LINKAGE CXString 998clang_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 */ 1040CINDEX_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 */ 1051CINDEX_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 */ 1061enum 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 */ 1165CINDEX_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 */ 1209CINDEX_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 */ 1224enum 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 */ 1240CINDEX_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 */ 1246enum 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 */ 1300CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU, 1301 const char *FileName, 1302 unsigned options); 1303 1304/** 1305 * \brief Destroy the specified CXTranslationUnit object. 1306 */ 1307CINDEX_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 */ 1316enum 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 */ 1333CINDEX_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 */ 1373CINDEX_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 */ 1381enum 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 */ 1408CINDEX_LINKAGE 1409const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind); 1410 1411typedef 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 */ 1422typedef 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 */ 1439CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU); 1440 1441CINDEX_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 */ 1450enum 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 CXCursor_LastStmt = CXCursor_DeclStmt, 2066 2067 /** 2068 * \brief Cursor that represents the translation unit itself. 2069 * 2070 * The translation unit cursor exists primarily to act as the root 2071 * cursor for traversing the contents of a translation unit. 2072 */ 2073 CXCursor_TranslationUnit = 300, 2074 2075 /* Attributes */ 2076 CXCursor_FirstAttr = 400, 2077 /** 2078 * \brief An attribute whose specific kind is not exposed via this 2079 * interface. 2080 */ 2081 CXCursor_UnexposedAttr = 400, 2082 2083 CXCursor_IBActionAttr = 401, 2084 CXCursor_IBOutletAttr = 402, 2085 CXCursor_IBOutletCollectionAttr = 403, 2086 CXCursor_CXXFinalAttr = 404, 2087 CXCursor_CXXOverrideAttr = 405, 2088 CXCursor_AnnotateAttr = 406, 2089 CXCursor_AsmLabelAttr = 407, 2090 CXCursor_LastAttr = CXCursor_AsmLabelAttr, 2091 2092 /* Preprocessing */ 2093 CXCursor_PreprocessingDirective = 500, 2094 CXCursor_MacroDefinition = 501, 2095 CXCursor_MacroExpansion = 502, 2096 CXCursor_MacroInstantiation = CXCursor_MacroExpansion, 2097 CXCursor_InclusionDirective = 503, 2098 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective, 2099 CXCursor_LastPreprocessing = CXCursor_InclusionDirective, 2100 2101 /* Extra Declarations */ 2102 /** 2103 * \brief A module import declaration. 2104 */ 2105 CXCursor_ModuleImportDecl = 600, 2106 CXCursor_FirstExtraDecl = CXCursor_ModuleImportDecl, 2107 CXCursor_LastExtraDecl = CXCursor_ModuleImportDecl 2108}; 2109 2110/** 2111 * \brief A cursor representing some element in the abstract syntax tree for 2112 * a translation unit. 2113 * 2114 * The cursor abstraction unifies the different kinds of entities in a 2115 * program--declaration, statements, expressions, references to declarations, 2116 * etc.--under a single "cursor" abstraction with a common set of operations. 2117 * Common operation for a cursor include: getting the physical location in 2118 * a source file where the cursor points, getting the name associated with a 2119 * cursor, and retrieving cursors for any child nodes of a particular cursor. 2120 * 2121 * Cursors can be produced in two specific ways. 2122 * clang_getTranslationUnitCursor() produces a cursor for a translation unit, 2123 * from which one can use clang_visitChildren() to explore the rest of the 2124 * translation unit. clang_getCursor() maps from a physical source location 2125 * to the entity that resides at that location, allowing one to map from the 2126 * source code into the AST. 2127 */ 2128typedef struct { 2129 enum CXCursorKind kind; 2130 int xdata; 2131 const void *data[3]; 2132} CXCursor; 2133 2134/** 2135 * \brief A comment AST node. 2136 */ 2137typedef struct { 2138 const void *ASTNode; 2139 CXTranslationUnit TranslationUnit; 2140} CXComment; 2141 2142/** 2143 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations 2144 * 2145 * @{ 2146 */ 2147 2148/** 2149 * \brief Retrieve the NULL cursor, which represents no entity. 2150 */ 2151CINDEX_LINKAGE CXCursor clang_getNullCursor(void); 2152 2153/** 2154 * \brief Retrieve the cursor that represents the given translation unit. 2155 * 2156 * The translation unit cursor can be used to start traversing the 2157 * various declarations within the given translation unit. 2158 */ 2159CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit); 2160 2161/** 2162 * \brief Determine whether two cursors are equivalent. 2163 */ 2164CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); 2165 2166/** 2167 * \brief Returns non-zero if \p cursor is null. 2168 */ 2169CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor); 2170 2171/** 2172 * \brief Compute a hash value for the given cursor. 2173 */ 2174CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor); 2175 2176/** 2177 * \brief Retrieve the kind of the given cursor. 2178 */ 2179CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor); 2180 2181/** 2182 * \brief Determine whether the given cursor kind represents a declaration. 2183 */ 2184CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind); 2185 2186/** 2187 * \brief Determine whether the given cursor kind represents a simple 2188 * reference. 2189 * 2190 * Note that other kinds of cursors (such as expressions) can also refer to 2191 * other cursors. Use clang_getCursorReferenced() to determine whether a 2192 * particular cursor refers to another entity. 2193 */ 2194CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind); 2195 2196/** 2197 * \brief Determine whether the given cursor kind represents an expression. 2198 */ 2199CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind); 2200 2201/** 2202 * \brief Determine whether the given cursor kind represents a statement. 2203 */ 2204CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind); 2205 2206/** 2207 * \brief Determine whether the given cursor kind represents an attribute. 2208 */ 2209CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind); 2210 2211/** 2212 * \brief Determine whether the given cursor kind represents an invalid 2213 * cursor. 2214 */ 2215CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind); 2216 2217/** 2218 * \brief Determine whether the given cursor kind represents a translation 2219 * unit. 2220 */ 2221CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind); 2222 2223/*** 2224 * \brief Determine whether the given cursor represents a preprocessing 2225 * element, such as a preprocessor directive or macro instantiation. 2226 */ 2227CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind); 2228 2229/*** 2230 * \brief Determine whether the given cursor represents a currently 2231 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt). 2232 */ 2233CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind); 2234 2235/** 2236 * \brief Describe the linkage of the entity referred to by a cursor. 2237 */ 2238enum CXLinkageKind { 2239 /** \brief This value indicates that no linkage information is available 2240 * for a provided CXCursor. */ 2241 CXLinkage_Invalid, 2242 /** 2243 * \brief This is the linkage for variables, parameters, and so on that 2244 * have automatic storage. This covers normal (non-extern) local variables. 2245 */ 2246 CXLinkage_NoLinkage, 2247 /** \brief This is the linkage for static variables and static functions. */ 2248 CXLinkage_Internal, 2249 /** \brief This is the linkage for entities with external linkage that live 2250 * in C++ anonymous namespaces.*/ 2251 CXLinkage_UniqueExternal, 2252 /** \brief This is the linkage for entities with true, external linkage. */ 2253 CXLinkage_External 2254}; 2255 2256/** 2257 * \brief Determine the linkage of the entity referred to by a given cursor. 2258 */ 2259CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor); 2260 2261/** 2262 * \brief Determine the availability of the entity that this cursor refers to, 2263 * taking the current target platform into account. 2264 * 2265 * \param cursor The cursor to query. 2266 * 2267 * \returns The availability of the cursor. 2268 */ 2269CINDEX_LINKAGE enum CXAvailabilityKind 2270clang_getCursorAvailability(CXCursor cursor); 2271 2272/** 2273 * Describes the availability of a given entity on a particular platform, e.g., 2274 * a particular class might only be available on Mac OS 10.7 or newer. 2275 */ 2276typedef struct CXPlatformAvailability { 2277 /** 2278 * \brief A string that describes the platform for which this structure 2279 * provides availability information. 2280 * 2281 * Possible values are "ios" or "macosx". 2282 */ 2283 CXString Platform; 2284 /** 2285 * \brief The version number in which this entity was introduced. 2286 */ 2287 CXVersion Introduced; 2288 /** 2289 * \brief The version number in which this entity was deprecated (but is 2290 * still available). 2291 */ 2292 CXVersion Deprecated; 2293 /** 2294 * \brief The version number in which this entity was obsoleted, and therefore 2295 * is no longer available. 2296 */ 2297 CXVersion Obsoleted; 2298 /** 2299 * \brief Whether the entity is unconditionally unavailable on this platform. 2300 */ 2301 int Unavailable; 2302 /** 2303 * \brief An optional message to provide to a user of this API, e.g., to 2304 * suggest replacement APIs. 2305 */ 2306 CXString Message; 2307} CXPlatformAvailability; 2308 2309/** 2310 * \brief Determine the availability of the entity that this cursor refers to 2311 * on any platforms for which availability information is known. 2312 * 2313 * \param cursor The cursor to query. 2314 * 2315 * \param always_deprecated If non-NULL, will be set to indicate whether the 2316 * entity is deprecated on all platforms. 2317 * 2318 * \param deprecated_message If non-NULL, will be set to the message text 2319 * provided along with the unconditional deprecation of this entity. The client 2320 * is responsible for deallocating this string. 2321 * 2322 * \param always_unavailable If non-NULL, will be set to indicate whether the 2323 * entity is unavailable on all platforms. 2324 * 2325 * \param unavailable_message If non-NULL, will be set to the message text 2326 * provided along with the unconditional unavailability of this entity. The 2327 * client is responsible for deallocating this string. 2328 * 2329 * \param availability If non-NULL, an array of CXPlatformAvailability instances 2330 * that will be populated with platform availability information, up to either 2331 * the number of platforms for which availability information is available (as 2332 * returned by this function) or \c availability_size, whichever is smaller. 2333 * 2334 * \param availability_size The number of elements available in the 2335 * \c availability array. 2336 * 2337 * \returns The number of platforms (N) for which availability information is 2338 * available (which is unrelated to \c availability_size). 2339 * 2340 * Note that the client is responsible for calling 2341 * \c clang_disposeCXPlatformAvailability to free each of the 2342 * platform-availability structures returned. There are 2343 * \c min(N, availability_size) such structures. 2344 */ 2345CINDEX_LINKAGE int 2346clang_getCursorPlatformAvailability(CXCursor cursor, 2347 int *always_deprecated, 2348 CXString *deprecated_message, 2349 int *always_unavailable, 2350 CXString *unavailable_message, 2351 CXPlatformAvailability *availability, 2352 int availability_size); 2353 2354/** 2355 * \brief Free the memory associated with a \c CXPlatformAvailability structure. 2356 */ 2357CINDEX_LINKAGE void 2358clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability); 2359 2360/** 2361 * \brief Describe the "language" of the entity referred to by a cursor. 2362 */ 2363CINDEX_LINKAGE enum CXLanguageKind { 2364 CXLanguage_Invalid = 0, 2365 CXLanguage_C, 2366 CXLanguage_ObjC, 2367 CXLanguage_CPlusPlus 2368}; 2369 2370/** 2371 * \brief Determine the "language" of the entity referred to by a given cursor. 2372 */ 2373CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor); 2374 2375/** 2376 * \brief Returns the translation unit that a cursor originated from. 2377 */ 2378CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor); 2379 2380 2381/** 2382 * \brief A fast container representing a set of CXCursors. 2383 */ 2384typedef struct CXCursorSetImpl *CXCursorSet; 2385 2386/** 2387 * \brief Creates an empty CXCursorSet. 2388 */ 2389CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void); 2390 2391/** 2392 * \brief Disposes a CXCursorSet and releases its associated memory. 2393 */ 2394CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset); 2395 2396/** 2397 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor. 2398 * 2399 * \returns non-zero if the set contains the specified cursor. 2400*/ 2401CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset, 2402 CXCursor cursor); 2403 2404/** 2405 * \brief Inserts a CXCursor into a CXCursorSet. 2406 * 2407 * \returns zero if the CXCursor was already in the set, and non-zero otherwise. 2408*/ 2409CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset, 2410 CXCursor cursor); 2411 2412/** 2413 * \brief Determine the semantic parent of the given cursor. 2414 * 2415 * The semantic parent of a cursor is the cursor that semantically contains 2416 * the given \p cursor. For many declarations, the lexical and semantic parents 2417 * are equivalent (the lexical parent is returned by 2418 * \c clang_getCursorLexicalParent()). They diverge when declarations or 2419 * definitions are provided out-of-line. For example: 2420 * 2421 * \code 2422 * class C { 2423 * void f(); 2424 * }; 2425 * 2426 * void C::f() { } 2427 * \endcode 2428 * 2429 * In the out-of-line definition of \c C::f, the semantic parent is the 2430 * the class \c C, of which this function is a member. The lexical parent is 2431 * the place where the declaration actually occurs in the source code; in this 2432 * case, the definition occurs in the translation unit. In general, the 2433 * lexical parent for a given entity can change without affecting the semantics 2434 * of the program, and the lexical parent of different declarations of the 2435 * same entity may be different. Changing the semantic parent of a declaration, 2436 * on the other hand, can have a major impact on semantics, and redeclarations 2437 * of a particular entity should all have the same semantic context. 2438 * 2439 * In the example above, both declarations of \c C::f have \c C as their 2440 * semantic context, while the lexical context of the first \c C::f is \c C 2441 * and the lexical context of the second \c C::f is the translation unit. 2442 * 2443 * For global declarations, the semantic parent is the translation unit. 2444 */ 2445CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor); 2446 2447/** 2448 * \brief Determine the lexical parent of the given cursor. 2449 * 2450 * The lexical parent of a cursor is the cursor in which the given \p cursor 2451 * was actually written. For many declarations, the lexical and semantic parents 2452 * are equivalent (the semantic parent is returned by 2453 * \c clang_getCursorSemanticParent()). They diverge when declarations or 2454 * definitions are provided out-of-line. For example: 2455 * 2456 * \code 2457 * class C { 2458 * void f(); 2459 * }; 2460 * 2461 * void C::f() { } 2462 * \endcode 2463 * 2464 * In the out-of-line definition of \c C::f, the semantic parent is the 2465 * the class \c C, of which this function is a member. The lexical parent is 2466 * the place where the declaration actually occurs in the source code; in this 2467 * case, the definition occurs in the translation unit. In general, the 2468 * lexical parent for a given entity can change without affecting the semantics 2469 * of the program, and the lexical parent of different declarations of the 2470 * same entity may be different. Changing the semantic parent of a declaration, 2471 * on the other hand, can have a major impact on semantics, and redeclarations 2472 * of a particular entity should all have the same semantic context. 2473 * 2474 * In the example above, both declarations of \c C::f have \c C as their 2475 * semantic context, while the lexical context of the first \c C::f is \c C 2476 * and the lexical context of the second \c C::f is the translation unit. 2477 * 2478 * For declarations written in the global scope, the lexical parent is 2479 * the translation unit. 2480 */ 2481CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor); 2482 2483/** 2484 * \brief Determine the set of methods that are overridden by the given 2485 * method. 2486 * 2487 * In both Objective-C and C++, a method (aka virtual member function, 2488 * in C++) can override a virtual method in a base class. For 2489 * Objective-C, a method is said to override any method in the class's 2490 * base class, its protocols, or its categories' protocols, that has the same 2491 * selector and is of the same kind (class or instance). 2492 * If no such method exists, the search continues to the class's superclass, 2493 * its protocols, and its categories, and so on. A method from an Objective-C 2494 * implementation is considered to override the same methods as its 2495 * corresponding method in the interface. 2496 * 2497 * For C++, a virtual member function overrides any virtual member 2498 * function with the same signature that occurs in its base 2499 * classes. With multiple inheritance, a virtual member function can 2500 * override several virtual member functions coming from different 2501 * base classes. 2502 * 2503 * In all cases, this function determines the immediate overridden 2504 * method, rather than all of the overridden methods. For example, if 2505 * a method is originally declared in a class A, then overridden in B 2506 * (which in inherits from A) and also in C (which inherited from B), 2507 * then the only overridden method returned from this function when 2508 * invoked on C's method will be B's method. The client may then 2509 * invoke this function again, given the previously-found overridden 2510 * methods, to map out the complete method-override set. 2511 * 2512 * \param cursor A cursor representing an Objective-C or C++ 2513 * method. This routine will compute the set of methods that this 2514 * method overrides. 2515 * 2516 * \param overridden A pointer whose pointee will be replaced with a 2517 * pointer to an array of cursors, representing the set of overridden 2518 * methods. If there are no overridden methods, the pointee will be 2519 * set to NULL. The pointee must be freed via a call to 2520 * \c clang_disposeOverriddenCursors(). 2521 * 2522 * \param num_overridden A pointer to the number of overridden 2523 * functions, will be set to the number of overridden functions in the 2524 * array pointed to by \p overridden. 2525 */ 2526CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 2527 CXCursor **overridden, 2528 unsigned *num_overridden); 2529 2530/** 2531 * \brief Free the set of overridden cursors returned by \c 2532 * clang_getOverriddenCursors(). 2533 */ 2534CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden); 2535 2536/** 2537 * \brief Retrieve the file that is included by the given inclusion directive 2538 * cursor. 2539 */ 2540CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor); 2541 2542/** 2543 * @} 2544 */ 2545 2546/** 2547 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code 2548 * 2549 * Cursors represent a location within the Abstract Syntax Tree (AST). These 2550 * routines help map between cursors and the physical locations where the 2551 * described entities occur in the source code. The mapping is provided in 2552 * both directions, so one can map from source code to the AST and back. 2553 * 2554 * @{ 2555 */ 2556 2557/** 2558 * \brief Map a source location to the cursor that describes the entity at that 2559 * location in the source code. 2560 * 2561 * clang_getCursor() maps an arbitrary source location within a translation 2562 * unit down to the most specific cursor that describes the entity at that 2563 * location. For example, given an expression \c x + y, invoking 2564 * clang_getCursor() with a source location pointing to "x" will return the 2565 * cursor for "x"; similarly for "y". If the cursor points anywhere between 2566 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor() 2567 * will return a cursor referring to the "+" expression. 2568 * 2569 * \returns a cursor representing the entity at the given source location, or 2570 * a NULL cursor if no such entity can be found. 2571 */ 2572CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation); 2573 2574/** 2575 * \brief Retrieve the physical location of the source constructor referenced 2576 * by the given cursor. 2577 * 2578 * The location of a declaration is typically the location of the name of that 2579 * declaration, where the name of that declaration would occur if it is 2580 * unnamed, or some keyword that introduces that particular declaration. 2581 * The location of a reference is where that reference occurs within the 2582 * source code. 2583 */ 2584CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor); 2585 2586/** 2587 * \brief Retrieve the physical extent of the source construct referenced by 2588 * the given cursor. 2589 * 2590 * The extent of a cursor starts with the file/line/column pointing at the 2591 * first character within the source construct that the cursor refers to and 2592 * ends with the last character withinin that source construct. For a 2593 * declaration, the extent covers the declaration itself. For a reference, 2594 * the extent covers the location of the reference (e.g., where the referenced 2595 * entity was actually used). 2596 */ 2597CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor); 2598 2599/** 2600 * @} 2601 */ 2602 2603/** 2604 * \defgroup CINDEX_TYPES Type information for CXCursors 2605 * 2606 * @{ 2607 */ 2608 2609/** 2610 * \brief Describes the kind of type 2611 */ 2612enum CXTypeKind { 2613 /** 2614 * \brief Reprents an invalid type (e.g., where no type is available). 2615 */ 2616 CXType_Invalid = 0, 2617 2618 /** 2619 * \brief A type whose specific kind is not exposed via this 2620 * interface. 2621 */ 2622 CXType_Unexposed = 1, 2623 2624 /* Builtin types */ 2625 CXType_Void = 2, 2626 CXType_Bool = 3, 2627 CXType_Char_U = 4, 2628 CXType_UChar = 5, 2629 CXType_Char16 = 6, 2630 CXType_Char32 = 7, 2631 CXType_UShort = 8, 2632 CXType_UInt = 9, 2633 CXType_ULong = 10, 2634 CXType_ULongLong = 11, 2635 CXType_UInt128 = 12, 2636 CXType_Char_S = 13, 2637 CXType_SChar = 14, 2638 CXType_WChar = 15, 2639 CXType_Short = 16, 2640 CXType_Int = 17, 2641 CXType_Long = 18, 2642 CXType_LongLong = 19, 2643 CXType_Int128 = 20, 2644 CXType_Float = 21, 2645 CXType_Double = 22, 2646 CXType_LongDouble = 23, 2647 CXType_NullPtr = 24, 2648 CXType_Overload = 25, 2649 CXType_Dependent = 26, 2650 CXType_ObjCId = 27, 2651 CXType_ObjCClass = 28, 2652 CXType_ObjCSel = 29, 2653 CXType_FirstBuiltin = CXType_Void, 2654 CXType_LastBuiltin = CXType_ObjCSel, 2655 2656 CXType_Complex = 100, 2657 CXType_Pointer = 101, 2658 CXType_BlockPointer = 102, 2659 CXType_LValueReference = 103, 2660 CXType_RValueReference = 104, 2661 CXType_Record = 105, 2662 CXType_Enum = 106, 2663 CXType_Typedef = 107, 2664 CXType_ObjCInterface = 108, 2665 CXType_ObjCObjectPointer = 109, 2666 CXType_FunctionNoProto = 110, 2667 CXType_FunctionProto = 111, 2668 CXType_ConstantArray = 112, 2669 CXType_Vector = 113 2670}; 2671 2672/** 2673 * \brief Describes the calling convention of a function type 2674 */ 2675enum CXCallingConv { 2676 CXCallingConv_Default = 0, 2677 CXCallingConv_C = 1, 2678 CXCallingConv_X86StdCall = 2, 2679 CXCallingConv_X86FastCall = 3, 2680 CXCallingConv_X86ThisCall = 4, 2681 CXCallingConv_X86Pascal = 5, 2682 CXCallingConv_AAPCS = 6, 2683 CXCallingConv_AAPCS_VFP = 7, 2684 CXCallingConv_PnaclCall = 8, 2685 CXCallingConv_IntelOclBicc = 9, 2686 CXCallingConv_X86_64Win64 = 10, 2687 CXCallingConv_X86_64SysV = 11, 2688 2689 CXCallingConv_Invalid = 100, 2690 CXCallingConv_Unexposed = 200 2691}; 2692 2693 2694/** 2695 * \brief The type of an element in the abstract syntax tree. 2696 * 2697 */ 2698typedef struct { 2699 enum CXTypeKind kind; 2700 void *data[2]; 2701} CXType; 2702 2703/** 2704 * \brief Retrieve the type of a CXCursor (if any). 2705 */ 2706CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C); 2707 2708/** 2709 * \brief Pretty-print the underlying type using the rules of the 2710 * language of the translation unit from which it came. 2711 * 2712 * If the type is invalid, an empty string is returned. 2713 */ 2714CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT); 2715 2716/** 2717 * \brief Retrieve the underlying type of a typedef declaration. 2718 * 2719 * If the cursor does not reference a typedef declaration, an invalid type is 2720 * returned. 2721 */ 2722CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C); 2723 2724/** 2725 * \brief Retrieve the integer type of an enum declaration. 2726 * 2727 * If the cursor does not reference an enum declaration, an invalid type is 2728 * returned. 2729 */ 2730CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C); 2731 2732/** 2733 * \brief Retrieve the integer value of an enum constant declaration as a signed 2734 * long long. 2735 * 2736 * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned. 2737 * Since this is also potentially a valid constant value, the kind of the cursor 2738 * must be verified before calling this function. 2739 */ 2740CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C); 2741 2742/** 2743 * \brief Retrieve the integer value of an enum constant declaration as an unsigned 2744 * long long. 2745 * 2746 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned. 2747 * Since this is also potentially a valid constant value, the kind of the cursor 2748 * must be verified before calling this function. 2749 */ 2750CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C); 2751 2752/** 2753 * \brief Retrieve the bit width of a bit field declaration as an integer. 2754 * 2755 * If a cursor that is not a bit field declaration is passed in, -1 is returned. 2756 */ 2757CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C); 2758 2759/** 2760 * \brief Retrieve the number of non-variadic arguments associated with a given 2761 * cursor. 2762 * 2763 * The number of arguments can be determined for calls as well as for 2764 * declarations of functions or methods. For other cursors -1 is returned. 2765 */ 2766CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C); 2767 2768/** 2769 * \brief Retrieve the argument cursor of a function or method. 2770 * 2771 * The argument cursor can be determined for calls as well as for declarations 2772 * of functions or methods. For other cursors and for invalid indices, an 2773 * invalid cursor is returned. 2774 */ 2775CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i); 2776 2777/** 2778 * \brief Determine whether two CXTypes represent the same type. 2779 * 2780 * \returns non-zero if the CXTypes represent the same type and 2781 * zero otherwise. 2782 */ 2783CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B); 2784 2785/** 2786 * \brief Return the canonical type for a CXType. 2787 * 2788 * Clang's type system explicitly models typedefs and all the ways 2789 * a specific type can be represented. The canonical type is the underlying 2790 * type with all the "sugar" removed. For example, if 'T' is a typedef 2791 * for 'int', the canonical type for 'T' would be 'int'. 2792 */ 2793CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T); 2794 2795/** 2796 * \brief Determine whether a CXType has the "const" qualifier set, 2797 * without looking through typedefs that may have added "const" at a 2798 * different level. 2799 */ 2800CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T); 2801 2802/** 2803 * \brief Determine whether a CXType has the "volatile" qualifier set, 2804 * without looking through typedefs that may have added "volatile" at 2805 * a different level. 2806 */ 2807CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T); 2808 2809/** 2810 * \brief Determine whether a CXType has the "restrict" qualifier set, 2811 * without looking through typedefs that may have added "restrict" at a 2812 * different level. 2813 */ 2814CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T); 2815 2816/** 2817 * \brief For pointer types, returns the type of the pointee. 2818 */ 2819CINDEX_LINKAGE CXType clang_getPointeeType(CXType T); 2820 2821/** 2822 * \brief Return the cursor for the declaration of the given type. 2823 */ 2824CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T); 2825 2826/** 2827 * Returns the Objective-C type encoding for the specified declaration. 2828 */ 2829CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C); 2830 2831/** 2832 * \brief Retrieve the spelling of a given CXTypeKind. 2833 */ 2834CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K); 2835 2836/** 2837 * \brief Retrieve the calling convention associated with a function type. 2838 * 2839 * If a non-function type is passed in, CXCallingConv_Invalid is returned. 2840 */ 2841CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T); 2842 2843/** 2844 * \brief Retrieve the result type associated with a function type. 2845 * 2846 * If a non-function type is passed in, an invalid type is returned. 2847 */ 2848CINDEX_LINKAGE CXType clang_getResultType(CXType T); 2849 2850/** 2851 * \brief Retrieve the number of non-variadic arguments associated with a 2852 * function type. 2853 * 2854 * If a non-function type is passed in, -1 is returned. 2855 */ 2856CINDEX_LINKAGE int clang_getNumArgTypes(CXType T); 2857 2858/** 2859 * \brief Retrieve the type of an argument of a function type. 2860 * 2861 * If a non-function type is passed in or the function does not have enough 2862 * parameters, an invalid type is returned. 2863 */ 2864CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i); 2865 2866/** 2867 * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise. 2868 */ 2869CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T); 2870 2871/** 2872 * \brief Retrieve the result type associated with a given cursor. 2873 * 2874 * This only returns a valid type if the cursor refers to a function or method. 2875 */ 2876CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C); 2877 2878/** 2879 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0 2880 * otherwise. 2881 */ 2882CINDEX_LINKAGE unsigned clang_isPODType(CXType T); 2883 2884/** 2885 * \brief Return the element type of an array, complex, or vector type. 2886 * 2887 * If a type is passed in that is not an array, complex, or vector type, 2888 * an invalid type is returned. 2889 */ 2890CINDEX_LINKAGE CXType clang_getElementType(CXType T); 2891 2892/** 2893 * \brief Return the number of elements of an array or vector type. 2894 * 2895 * If a type is passed in that is not an array or vector type, 2896 * -1 is returned. 2897 */ 2898CINDEX_LINKAGE long long clang_getNumElements(CXType T); 2899 2900/** 2901 * \brief Return the element type of an array type. 2902 * 2903 * If a non-array type is passed in, an invalid type is returned. 2904 */ 2905CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T); 2906 2907/** 2908 * \brief Return the array size of a constant array. 2909 * 2910 * If a non-array type is passed in, -1 is returned. 2911 */ 2912CINDEX_LINKAGE long long clang_getArraySize(CXType T); 2913 2914/** 2915 * \brief List the possible error codes for \c clang_Type_getSizeOf, 2916 * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and 2917 * \c clang_Cursor_getOffsetOf. 2918 * 2919 * A value of this enumeration type can be returned if the target type is not 2920 * a valid argument to sizeof, alignof or offsetof. 2921 */ 2922enum CXTypeLayoutError { 2923 /** 2924 * \brief Type is of kind CXType_Invalid. 2925 */ 2926 CXTypeLayoutError_Invalid = -1, 2927 /** 2928 * \brief The type is an incomplete Type. 2929 */ 2930 CXTypeLayoutError_Incomplete = -2, 2931 /** 2932 * \brief The type is a dependent Type. 2933 */ 2934 CXTypeLayoutError_Dependent = -3, 2935 /** 2936 * \brief The type is not a constant size type. 2937 */ 2938 CXTypeLayoutError_NotConstantSize = -4, 2939 /** 2940 * \brief The Field name is not valid for this record. 2941 */ 2942 CXTypeLayoutError_InvalidFieldName = -5 2943}; 2944 2945/** 2946 * \brief Return the alignment of a type in bytes as per C++[expr.alignof] 2947 * standard. 2948 * 2949 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned. 2950 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete 2951 * is returned. 2952 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is 2953 * returned. 2954 * If the type declaration is not a constant size type, 2955 * CXTypeLayoutError_NotConstantSize is returned. 2956 */ 2957CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T); 2958 2959/** 2960 * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard. 2961 * 2962 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned. 2963 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete 2964 * is returned. 2965 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is 2966 * returned. 2967 */ 2968CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T); 2969 2970/** 2971 * \brief Return the offset of a field named S in a record of type T in bits 2972 * as it would be returned by __offsetof__ as per C++11[18.2p4] 2973 * 2974 * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid 2975 * is returned. 2976 * If the field's type declaration is an incomplete type, 2977 * CXTypeLayoutError_Incomplete is returned. 2978 * If the field's type declaration is a dependent type, 2979 * CXTypeLayoutError_Dependent is returned. 2980 * If the field's name S is not found, 2981 * CXTypeLayoutError_InvalidFieldName is returned. 2982 */ 2983CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S); 2984 2985/** 2986 * \brief Returns non-zero if the cursor specifies a Record member that is a 2987 * bitfield. 2988 */ 2989CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C); 2990 2991/** 2992 * \brief Returns 1 if the base class specified by the cursor with kind 2993 * CX_CXXBaseSpecifier is virtual. 2994 */ 2995CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor); 2996 2997/** 2998 * \brief Represents the C++ access control level to a base class for a 2999 * cursor with kind CX_CXXBaseSpecifier. 3000 */ 3001enum CX_CXXAccessSpecifier { 3002 CX_CXXInvalidAccessSpecifier, 3003 CX_CXXPublic, 3004 CX_CXXProtected, 3005 CX_CXXPrivate 3006}; 3007 3008/** 3009 * \brief Returns the access control level for the referenced object. 3010 * 3011 * If the cursor refers to a C++ declaration, its access control level within its 3012 * parent scope is returned. Otherwise, if the cursor refers to a base specifier or 3013 * access specifier, the specifier itself is returned. 3014 */ 3015CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor); 3016 3017/** 3018 * \brief Determine the number of overloaded declarations referenced by a 3019 * \c CXCursor_OverloadedDeclRef cursor. 3020 * 3021 * \param cursor The cursor whose overloaded declarations are being queried. 3022 * 3023 * \returns The number of overloaded declarations referenced by \c cursor. If it 3024 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0. 3025 */ 3026CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor); 3027 3028/** 3029 * \brief Retrieve a cursor for one of the overloaded declarations referenced 3030 * by a \c CXCursor_OverloadedDeclRef cursor. 3031 * 3032 * \param cursor The cursor whose overloaded declarations are being queried. 3033 * 3034 * \param index The zero-based index into the set of overloaded declarations in 3035 * the cursor. 3036 * 3037 * \returns A cursor representing the declaration referenced by the given 3038 * \c cursor at the specified \c index. If the cursor does not have an 3039 * associated set of overloaded declarations, or if the index is out of bounds, 3040 * returns \c clang_getNullCursor(); 3041 */ 3042CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 3043 unsigned index); 3044 3045/** 3046 * @} 3047 */ 3048 3049/** 3050 * \defgroup CINDEX_ATTRIBUTES Information for attributes 3051 * 3052 * @{ 3053 */ 3054 3055 3056/** 3057 * \brief For cursors representing an iboutletcollection attribute, 3058 * this function returns the collection element type. 3059 * 3060 */ 3061CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor); 3062 3063/** 3064 * @} 3065 */ 3066 3067/** 3068 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors 3069 * 3070 * These routines provide the ability to traverse the abstract syntax tree 3071 * using cursors. 3072 * 3073 * @{ 3074 */ 3075 3076/** 3077 * \brief Describes how the traversal of the children of a particular 3078 * cursor should proceed after visiting a particular child cursor. 3079 * 3080 * A value of this enumeration type should be returned by each 3081 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed. 3082 */ 3083enum CXChildVisitResult { 3084 /** 3085 * \brief Terminates the cursor traversal. 3086 */ 3087 CXChildVisit_Break, 3088 /** 3089 * \brief Continues the cursor traversal with the next sibling of 3090 * the cursor just visited, without visiting its children. 3091 */ 3092 CXChildVisit_Continue, 3093 /** 3094 * \brief Recursively traverse the children of this cursor, using 3095 * the same visitor and client data. 3096 */ 3097 CXChildVisit_Recurse 3098}; 3099 3100/** 3101 * \brief Visitor invoked for each cursor found by a traversal. 3102 * 3103 * This visitor function will be invoked for each cursor found by 3104 * clang_visitCursorChildren(). Its first argument is the cursor being 3105 * visited, its second argument is the parent visitor for that cursor, 3106 * and its third argument is the client data provided to 3107 * clang_visitCursorChildren(). 3108 * 3109 * The visitor should return one of the \c CXChildVisitResult values 3110 * to direct clang_visitCursorChildren(). 3111 */ 3112typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor, 3113 CXCursor parent, 3114 CXClientData client_data); 3115 3116/** 3117 * \brief Visit the children of a particular cursor. 3118 * 3119 * This function visits all the direct children of the given cursor, 3120 * invoking the given \p visitor function with the cursors of each 3121 * visited child. The traversal may be recursive, if the visitor returns 3122 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if 3123 * the visitor returns \c CXChildVisit_Break. 3124 * 3125 * \param parent the cursor whose child may be visited. All kinds of 3126 * cursors can be visited, including invalid cursors (which, by 3127 * definition, have no children). 3128 * 3129 * \param visitor the visitor function that will be invoked for each 3130 * child of \p parent. 3131 * 3132 * \param client_data pointer data supplied by the client, which will 3133 * be passed to the visitor each time it is invoked. 3134 * 3135 * \returns a non-zero value if the traversal was terminated 3136 * prematurely by the visitor returning \c CXChildVisit_Break. 3137 */ 3138CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent, 3139 CXCursorVisitor visitor, 3140 CXClientData client_data); 3141#ifdef __has_feature 3142# if __has_feature(blocks) 3143/** 3144 * \brief Visitor invoked for each cursor found by a traversal. 3145 * 3146 * This visitor block will be invoked for each cursor found by 3147 * clang_visitChildrenWithBlock(). Its first argument is the cursor being 3148 * visited, its second argument is the parent visitor for that cursor. 3149 * 3150 * The visitor should return one of the \c CXChildVisitResult values 3151 * to direct clang_visitChildrenWithBlock(). 3152 */ 3153typedef enum CXChildVisitResult 3154 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 3155 3156/** 3157 * Visits the children of a cursor using the specified block. Behaves 3158 * identically to clang_visitChildren() in all other respects. 3159 */ 3160unsigned clang_visitChildrenWithBlock(CXCursor parent, 3161 CXCursorVisitorBlock block); 3162# endif 3163#endif 3164 3165/** 3166 * @} 3167 */ 3168 3169/** 3170 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST 3171 * 3172 * These routines provide the ability to determine references within and 3173 * across translation units, by providing the names of the entities referenced 3174 * by cursors, follow reference cursors to the declarations they reference, 3175 * and associate declarations with their definitions. 3176 * 3177 * @{ 3178 */ 3179 3180/** 3181 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced 3182 * by the given cursor. 3183 * 3184 * A Unified Symbol Resolution (USR) is a string that identifies a particular 3185 * entity (function, class, variable, etc.) within a program. USRs can be 3186 * compared across translation units to determine, e.g., when references in 3187 * one translation refer to an entity defined in another translation unit. 3188 */ 3189CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor); 3190 3191/** 3192 * \brief Construct a USR for a specified Objective-C class. 3193 */ 3194CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name); 3195 3196/** 3197 * \brief Construct a USR for a specified Objective-C category. 3198 */ 3199CINDEX_LINKAGE CXString 3200 clang_constructUSR_ObjCCategory(const char *class_name, 3201 const char *category_name); 3202 3203/** 3204 * \brief Construct a USR for a specified Objective-C protocol. 3205 */ 3206CINDEX_LINKAGE CXString 3207 clang_constructUSR_ObjCProtocol(const char *protocol_name); 3208 3209 3210/** 3211 * \brief Construct a USR for a specified Objective-C instance variable and 3212 * the USR for its containing class. 3213 */ 3214CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name, 3215 CXString classUSR); 3216 3217/** 3218 * \brief Construct a USR for a specified Objective-C method and 3219 * the USR for its containing class. 3220 */ 3221CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name, 3222 unsigned isInstanceMethod, 3223 CXString classUSR); 3224 3225/** 3226 * \brief Construct a USR for a specified Objective-C property and the USR 3227 * for its containing class. 3228 */ 3229CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property, 3230 CXString classUSR); 3231 3232/** 3233 * \brief Retrieve a name for the entity referenced by this cursor. 3234 */ 3235CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor); 3236 3237/** 3238 * \brief Retrieve a range for a piece that forms the cursors spelling name. 3239 * Most of the times there is only one range for the complete spelling but for 3240 * objc methods and objc message expressions, there are multiple pieces for each 3241 * selector identifier. 3242 * 3243 * \param pieceIndex the index of the spelling name piece. If this is greater 3244 * than the actual number of pieces, it will return a NULL (invalid) range. 3245 * 3246 * \param options Reserved. 3247 */ 3248CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor, 3249 unsigned pieceIndex, 3250 unsigned options); 3251 3252/** 3253 * \brief Retrieve the display name for the entity referenced by this cursor. 3254 * 3255 * The display name contains extra information that helps identify the cursor, 3256 * such as the parameters of a function or template or the arguments of a 3257 * class template specialization. 3258 */ 3259CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor); 3260 3261/** \brief For a cursor that is a reference, retrieve a cursor representing the 3262 * entity that it references. 3263 * 3264 * Reference cursors refer to other entities in the AST. For example, an 3265 * Objective-C superclass reference cursor refers to an Objective-C class. 3266 * This function produces the cursor for the Objective-C class from the 3267 * cursor for the superclass reference. If the input cursor is a declaration or 3268 * definition, it returns that declaration or definition unchanged. 3269 * Otherwise, returns the NULL cursor. 3270 */ 3271CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor); 3272 3273/** 3274 * \brief For a cursor that is either a reference to or a declaration 3275 * of some entity, retrieve a cursor that describes the definition of 3276 * that entity. 3277 * 3278 * Some entities can be declared multiple times within a translation 3279 * unit, but only one of those declarations can also be a 3280 * definition. For example, given: 3281 * 3282 * \code 3283 * int f(int, int); 3284 * int g(int x, int y) { return f(x, y); } 3285 * int f(int a, int b) { return a + b; } 3286 * int f(int, int); 3287 * \endcode 3288 * 3289 * there are three declarations of the function "f", but only the 3290 * second one is a definition. The clang_getCursorDefinition() 3291 * function will take any cursor pointing to a declaration of "f" 3292 * (the first or fourth lines of the example) or a cursor referenced 3293 * that uses "f" (the call to "f' inside "g") and will return a 3294 * declaration cursor pointing to the definition (the second "f" 3295 * declaration). 3296 * 3297 * If given a cursor for which there is no corresponding definition, 3298 * e.g., because there is no definition of that entity within this 3299 * translation unit, returns a NULL cursor. 3300 */ 3301CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor); 3302 3303/** 3304 * \brief Determine whether the declaration pointed to by this cursor 3305 * is also a definition of that entity. 3306 */ 3307CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor); 3308 3309/** 3310 * \brief Retrieve the canonical cursor corresponding to the given cursor. 3311 * 3312 * In the C family of languages, many kinds of entities can be declared several 3313 * times within a single translation unit. For example, a structure type can 3314 * be forward-declared (possibly multiple times) and later defined: 3315 * 3316 * \code 3317 * struct X; 3318 * struct X; 3319 * struct X { 3320 * int member; 3321 * }; 3322 * \endcode 3323 * 3324 * The declarations and the definition of \c X are represented by three 3325 * different cursors, all of which are declarations of the same underlying 3326 * entity. One of these cursor is considered the "canonical" cursor, which 3327 * is effectively the representative for the underlying entity. One can 3328 * determine if two cursors are declarations of the same underlying entity by 3329 * comparing their canonical cursors. 3330 * 3331 * \returns The canonical cursor for the entity referred to by the given cursor. 3332 */ 3333CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor); 3334 3335 3336/** 3337 * \brief If the cursor points to a selector identifier in a objc method or 3338 * message expression, this returns the selector index. 3339 * 3340 * After getting a cursor with #clang_getCursor, this can be called to 3341 * determine if the location points to a selector identifier. 3342 * 3343 * \returns The selector index if the cursor is an objc method or message 3344 * expression and the cursor is pointing to a selector identifier, or -1 3345 * otherwise. 3346 */ 3347CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor); 3348 3349/** 3350 * \brief Given a cursor pointing to a C++ method call or an ObjC message, 3351 * returns non-zero if the method/message is "dynamic", meaning: 3352 * 3353 * For a C++ method: the call is virtual. 3354 * For an ObjC message: the receiver is an object instance, not 'super' or a 3355 * specific class. 3356 * 3357 * If the method/message is "static" or the cursor does not point to a 3358 * method/message, it will return zero. 3359 */ 3360CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C); 3361 3362/** 3363 * \brief Given a cursor pointing to an ObjC message, returns the CXType of the 3364 * receiver. 3365 */ 3366CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C); 3367 3368/** 3369 * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl. 3370 */ 3371typedef enum { 3372 CXObjCPropertyAttr_noattr = 0x00, 3373 CXObjCPropertyAttr_readonly = 0x01, 3374 CXObjCPropertyAttr_getter = 0x02, 3375 CXObjCPropertyAttr_assign = 0x04, 3376 CXObjCPropertyAttr_readwrite = 0x08, 3377 CXObjCPropertyAttr_retain = 0x10, 3378 CXObjCPropertyAttr_copy = 0x20, 3379 CXObjCPropertyAttr_nonatomic = 0x40, 3380 CXObjCPropertyAttr_setter = 0x80, 3381 CXObjCPropertyAttr_atomic = 0x100, 3382 CXObjCPropertyAttr_weak = 0x200, 3383 CXObjCPropertyAttr_strong = 0x400, 3384 CXObjCPropertyAttr_unsafe_unretained = 0x800 3385} CXObjCPropertyAttrKind; 3386 3387/** 3388 * \brief Given a cursor that represents a property declaration, return the 3389 * associated property attributes. The bits are formed from 3390 * \c CXObjCPropertyAttrKind. 3391 * 3392 * \param reserved Reserved for future use, pass 0. 3393 */ 3394CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C, 3395 unsigned reserved); 3396 3397/** 3398 * \brief 'Qualifiers' written next to the return and parameter types in 3399 * ObjC method declarations. 3400 */ 3401typedef enum { 3402 CXObjCDeclQualifier_None = 0x0, 3403 CXObjCDeclQualifier_In = 0x1, 3404 CXObjCDeclQualifier_Inout = 0x2, 3405 CXObjCDeclQualifier_Out = 0x4, 3406 CXObjCDeclQualifier_Bycopy = 0x8, 3407 CXObjCDeclQualifier_Byref = 0x10, 3408 CXObjCDeclQualifier_Oneway = 0x20 3409} CXObjCDeclQualifierKind; 3410 3411/** 3412 * \brief Given a cursor that represents an ObjC method or parameter 3413 * declaration, return the associated ObjC qualifiers for the return type or the 3414 * parameter respectively. The bits are formed from CXObjCDeclQualifierKind. 3415 */ 3416CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C); 3417 3418/** 3419 * \brief Returns non-zero if the given cursor is a variadic function or method. 3420 */ 3421CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C); 3422 3423/** 3424 * \brief Given a cursor that represents a declaration, return the associated 3425 * comment's source range. The range may include multiple consecutive comments 3426 * with whitespace in between. 3427 */ 3428CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C); 3429 3430/** 3431 * \brief Given a cursor that represents a declaration, return the associated 3432 * comment text, including comment markers. 3433 */ 3434CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C); 3435 3436/** 3437 * \brief Given a cursor that represents a documentable entity (e.g., 3438 * declaration), return the associated \\brief paragraph; otherwise return the 3439 * first paragraph. 3440 */ 3441CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C); 3442 3443/** 3444 * \brief Given a cursor that represents a documentable entity (e.g., 3445 * declaration), return the associated parsed comment as a 3446 * \c CXComment_FullComment AST node. 3447 */ 3448CINDEX_LINKAGE CXComment clang_Cursor_getParsedComment(CXCursor C); 3449 3450/** 3451 * @} 3452 */ 3453 3454/** 3455 * \defgroup CINDEX_MODULE Module introspection 3456 * 3457 * The functions in this group provide access to information about modules. 3458 * 3459 * @{ 3460 */ 3461 3462typedef void *CXModule; 3463 3464/** 3465 * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module. 3466 */ 3467CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C); 3468 3469/** 3470 * \param Module a module object. 3471 * 3472 * \returns the module file where the provided module object came from. 3473 */ 3474CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module); 3475 3476/** 3477 * \param Module a module object. 3478 * 3479 * \returns the parent of a sub-module or NULL if the given module is top-level, 3480 * e.g. for 'std.vector' it will return the 'std' module. 3481 */ 3482CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module); 3483 3484/** 3485 * \param Module a module object. 3486 * 3487 * \returns the name of the module, e.g. for the 'std.vector' sub-module it 3488 * will return "vector". 3489 */ 3490CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module); 3491 3492/** 3493 * \param Module a module object. 3494 * 3495 * \returns the full name of the module, e.g. "std.vector". 3496 */ 3497CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module); 3498 3499/** 3500 * \param Module a module object. 3501 * 3502 * \returns the number of top level headers associated with this module. 3503 */ 3504CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit, 3505 CXModule Module); 3506 3507/** 3508 * \param Module a module object. 3509 * 3510 * \param Index top level header index (zero-based). 3511 * 3512 * \returns the specified top level header associated with the module. 3513 */ 3514CINDEX_LINKAGE 3515CXFile clang_Module_getTopLevelHeader(CXTranslationUnit, 3516 CXModule Module, unsigned Index); 3517 3518/** 3519 * @} 3520 */ 3521 3522/** 3523 * \defgroup CINDEX_COMMENT Comment AST introspection 3524 * 3525 * The routines in this group provide access to information in the 3526 * documentation comment ASTs. 3527 * 3528 * @{ 3529 */ 3530 3531/** 3532 * \brief Describes the type of the comment AST node (\c CXComment). A comment 3533 * node can be considered block content (e. g., paragraph), inline content 3534 * (plain text) or neither (the root AST node). 3535 */ 3536enum CXCommentKind { 3537 /** 3538 * \brief Null comment. No AST node is constructed at the requested location 3539 * because there is no text or a syntax error. 3540 */ 3541 CXComment_Null = 0, 3542 3543 /** 3544 * \brief Plain text. Inline content. 3545 */ 3546 CXComment_Text = 1, 3547 3548 /** 3549 * \brief A command with word-like arguments that is considered inline content. 3550 * 3551 * For example: \\c command. 3552 */ 3553 CXComment_InlineCommand = 2, 3554 3555 /** 3556 * \brief HTML start tag with attributes (name-value pairs). Considered 3557 * inline content. 3558 * 3559 * For example: 3560 * \verbatim 3561 * <br> <br /> <a href="http://example.org/"> 3562 * \endverbatim 3563 */ 3564 CXComment_HTMLStartTag = 3, 3565 3566 /** 3567 * \brief HTML end tag. Considered inline content. 3568 * 3569 * For example: 3570 * \verbatim 3571 * </a> 3572 * \endverbatim 3573 */ 3574 CXComment_HTMLEndTag = 4, 3575 3576 /** 3577 * \brief A paragraph, contains inline comment. The paragraph itself is 3578 * block content. 3579 */ 3580 CXComment_Paragraph = 5, 3581 3582 /** 3583 * \brief A command that has zero or more word-like arguments (number of 3584 * word-like arguments depends on command name) and a paragraph as an 3585 * argument. Block command is block content. 3586 * 3587 * Paragraph argument is also a child of the block command. 3588 * 3589 * For example: \\brief has 0 word-like arguments and a paragraph argument. 3590 * 3591 * AST nodes of special kinds that parser knows about (e. g., \\param 3592 * command) have their own node kinds. 3593 */ 3594 CXComment_BlockCommand = 6, 3595 3596 /** 3597 * \brief A \\param or \\arg command that describes the function parameter 3598 * (name, passing direction, description). 3599 * 3600 * For example: \\param [in] ParamName description. 3601 */ 3602 CXComment_ParamCommand = 7, 3603 3604 /** 3605 * \brief A \\tparam command that describes a template parameter (name and 3606 * description). 3607 * 3608 * For example: \\tparam T description. 3609 */ 3610 CXComment_TParamCommand = 8, 3611 3612 /** 3613 * \brief A verbatim block command (e. g., preformatted code). Verbatim 3614 * block has an opening and a closing command and contains multiple lines of 3615 * text (\c CXComment_VerbatimBlockLine child nodes). 3616 * 3617 * For example: 3618 * \\verbatim 3619 * aaa 3620 * \\endverbatim 3621 */ 3622 CXComment_VerbatimBlockCommand = 9, 3623 3624 /** 3625 * \brief A line of text that is contained within a 3626 * CXComment_VerbatimBlockCommand node. 3627 */ 3628 CXComment_VerbatimBlockLine = 10, 3629 3630 /** 3631 * \brief A verbatim line command. Verbatim line has an opening command, 3632 * a single line of text (up to the newline after the opening command) and 3633 * has no closing command. 3634 */ 3635 CXComment_VerbatimLine = 11, 3636 3637 /** 3638 * \brief A full comment attached to a declaration, contains block content. 3639 */ 3640 CXComment_FullComment = 12 3641}; 3642 3643/** 3644 * \brief The most appropriate rendering mode for an inline command, chosen on 3645 * command semantics in Doxygen. 3646 */ 3647enum CXCommentInlineCommandRenderKind { 3648 /** 3649 * \brief Command argument should be rendered in a normal font. 3650 */ 3651 CXCommentInlineCommandRenderKind_Normal, 3652 3653 /** 3654 * \brief Command argument should be rendered in a bold font. 3655 */ 3656 CXCommentInlineCommandRenderKind_Bold, 3657 3658 /** 3659 * \brief Command argument should be rendered in a monospaced font. 3660 */ 3661 CXCommentInlineCommandRenderKind_Monospaced, 3662 3663 /** 3664 * \brief Command argument should be rendered emphasized (typically italic 3665 * font). 3666 */ 3667 CXCommentInlineCommandRenderKind_Emphasized 3668}; 3669 3670/** 3671 * \brief Describes parameter passing direction for \\param or \\arg command. 3672 */ 3673enum CXCommentParamPassDirection { 3674 /** 3675 * \brief The parameter is an input parameter. 3676 */ 3677 CXCommentParamPassDirection_In, 3678 3679 /** 3680 * \brief The parameter is an output parameter. 3681 */ 3682 CXCommentParamPassDirection_Out, 3683 3684 /** 3685 * \brief The parameter is an input and output parameter. 3686 */ 3687 CXCommentParamPassDirection_InOut 3688}; 3689 3690/** 3691 * \param Comment AST node of any kind. 3692 * 3693 * \returns the type of the AST node. 3694 */ 3695CINDEX_LINKAGE enum CXCommentKind clang_Comment_getKind(CXComment Comment); 3696 3697/** 3698 * \param Comment AST node of any kind. 3699 * 3700 * \returns number of children of the AST node. 3701 */ 3702CINDEX_LINKAGE unsigned clang_Comment_getNumChildren(CXComment Comment); 3703 3704/** 3705 * \param Comment AST node of any kind. 3706 * 3707 * \param ChildIdx child index (zero-based). 3708 * 3709 * \returns the specified child of the AST node. 3710 */ 3711CINDEX_LINKAGE 3712CXComment clang_Comment_getChild(CXComment Comment, unsigned ChildIdx); 3713 3714/** 3715 * \brief A \c CXComment_Paragraph node is considered whitespace if it contains 3716 * only \c CXComment_Text nodes that are empty or whitespace. 3717 * 3718 * Other AST nodes (except \c CXComment_Paragraph and \c CXComment_Text) are 3719 * never considered whitespace. 3720 * 3721 * \returns non-zero if \c Comment is whitespace. 3722 */ 3723CINDEX_LINKAGE unsigned clang_Comment_isWhitespace(CXComment Comment); 3724 3725/** 3726 * \returns non-zero if \c Comment is inline content and has a newline 3727 * immediately following it in the comment text. Newlines between paragraphs 3728 * do not count. 3729 */ 3730CINDEX_LINKAGE 3731unsigned clang_InlineContentComment_hasTrailingNewline(CXComment Comment); 3732 3733/** 3734 * \param Comment a \c CXComment_Text AST node. 3735 * 3736 * \returns text contained in the AST node. 3737 */ 3738CINDEX_LINKAGE CXString clang_TextComment_getText(CXComment Comment); 3739 3740/** 3741 * \param Comment a \c CXComment_InlineCommand AST node. 3742 * 3743 * \returns name of the inline command. 3744 */ 3745CINDEX_LINKAGE 3746CXString clang_InlineCommandComment_getCommandName(CXComment Comment); 3747 3748/** 3749 * \param Comment a \c CXComment_InlineCommand AST node. 3750 * 3751 * \returns the most appropriate rendering mode, chosen on command 3752 * semantics in Doxygen. 3753 */ 3754CINDEX_LINKAGE enum CXCommentInlineCommandRenderKind 3755clang_InlineCommandComment_getRenderKind(CXComment Comment); 3756 3757/** 3758 * \param Comment a \c CXComment_InlineCommand AST node. 3759 * 3760 * \returns number of command arguments. 3761 */ 3762CINDEX_LINKAGE 3763unsigned clang_InlineCommandComment_getNumArgs(CXComment Comment); 3764 3765/** 3766 * \param Comment a \c CXComment_InlineCommand AST node. 3767 * 3768 * \param ArgIdx argument index (zero-based). 3769 * 3770 * \returns text of the specified argument. 3771 */ 3772CINDEX_LINKAGE 3773CXString clang_InlineCommandComment_getArgText(CXComment Comment, 3774 unsigned ArgIdx); 3775 3776/** 3777 * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST 3778 * node. 3779 * 3780 * \returns HTML tag name. 3781 */ 3782CINDEX_LINKAGE CXString clang_HTMLTagComment_getTagName(CXComment Comment); 3783 3784/** 3785 * \param Comment a \c CXComment_HTMLStartTag AST node. 3786 * 3787 * \returns non-zero if tag is self-closing (for example, <br />). 3788 */ 3789CINDEX_LINKAGE 3790unsigned clang_HTMLStartTagComment_isSelfClosing(CXComment Comment); 3791 3792/** 3793 * \param Comment a \c CXComment_HTMLStartTag AST node. 3794 * 3795 * \returns number of attributes (name-value pairs) attached to the start tag. 3796 */ 3797CINDEX_LINKAGE unsigned clang_HTMLStartTag_getNumAttrs(CXComment Comment); 3798 3799/** 3800 * \param Comment a \c CXComment_HTMLStartTag AST node. 3801 * 3802 * \param AttrIdx attribute index (zero-based). 3803 * 3804 * \returns name of the specified attribute. 3805 */ 3806CINDEX_LINKAGE 3807CXString clang_HTMLStartTag_getAttrName(CXComment Comment, unsigned AttrIdx); 3808 3809/** 3810 * \param Comment a \c CXComment_HTMLStartTag AST node. 3811 * 3812 * \param AttrIdx attribute index (zero-based). 3813 * 3814 * \returns value of the specified attribute. 3815 */ 3816CINDEX_LINKAGE 3817CXString clang_HTMLStartTag_getAttrValue(CXComment Comment, unsigned AttrIdx); 3818 3819/** 3820 * \param Comment a \c CXComment_BlockCommand AST node. 3821 * 3822 * \returns name of the block command. 3823 */ 3824CINDEX_LINKAGE 3825CXString clang_BlockCommandComment_getCommandName(CXComment Comment); 3826 3827/** 3828 * \param Comment a \c CXComment_BlockCommand AST node. 3829 * 3830 * \returns number of word-like arguments. 3831 */ 3832CINDEX_LINKAGE 3833unsigned clang_BlockCommandComment_getNumArgs(CXComment Comment); 3834 3835/** 3836 * \param Comment a \c CXComment_BlockCommand AST node. 3837 * 3838 * \param ArgIdx argument index (zero-based). 3839 * 3840 * \returns text of the specified word-like argument. 3841 */ 3842CINDEX_LINKAGE 3843CXString clang_BlockCommandComment_getArgText(CXComment Comment, 3844 unsigned ArgIdx); 3845 3846/** 3847 * \param Comment a \c CXComment_BlockCommand or 3848 * \c CXComment_VerbatimBlockCommand AST node. 3849 * 3850 * \returns paragraph argument of the block command. 3851 */ 3852CINDEX_LINKAGE 3853CXComment clang_BlockCommandComment_getParagraph(CXComment Comment); 3854 3855/** 3856 * \param Comment a \c CXComment_ParamCommand AST node. 3857 * 3858 * \returns parameter name. 3859 */ 3860CINDEX_LINKAGE 3861CXString clang_ParamCommandComment_getParamName(CXComment Comment); 3862 3863/** 3864 * \param Comment a \c CXComment_ParamCommand AST node. 3865 * 3866 * \returns non-zero if the parameter that this AST node represents was found 3867 * in the function prototype and \c clang_ParamCommandComment_getParamIndex 3868 * function will return a meaningful value. 3869 */ 3870CINDEX_LINKAGE 3871unsigned clang_ParamCommandComment_isParamIndexValid(CXComment Comment); 3872 3873/** 3874 * \param Comment a \c CXComment_ParamCommand AST node. 3875 * 3876 * \returns zero-based parameter index in function prototype. 3877 */ 3878CINDEX_LINKAGE 3879unsigned clang_ParamCommandComment_getParamIndex(CXComment Comment); 3880 3881/** 3882 * \param Comment a \c CXComment_ParamCommand AST node. 3883 * 3884 * \returns non-zero if parameter passing direction was specified explicitly in 3885 * the comment. 3886 */ 3887CINDEX_LINKAGE 3888unsigned clang_ParamCommandComment_isDirectionExplicit(CXComment Comment); 3889 3890/** 3891 * \param Comment a \c CXComment_ParamCommand AST node. 3892 * 3893 * \returns parameter passing direction. 3894 */ 3895CINDEX_LINKAGE 3896enum CXCommentParamPassDirection clang_ParamCommandComment_getDirection( 3897 CXComment Comment); 3898 3899/** 3900 * \param Comment a \c CXComment_TParamCommand AST node. 3901 * 3902 * \returns template parameter name. 3903 */ 3904CINDEX_LINKAGE 3905CXString clang_TParamCommandComment_getParamName(CXComment Comment); 3906 3907/** 3908 * \param Comment a \c CXComment_TParamCommand AST node. 3909 * 3910 * \returns non-zero if the parameter that this AST node represents was found 3911 * in the template parameter list and 3912 * \c clang_TParamCommandComment_getDepth and 3913 * \c clang_TParamCommandComment_getIndex functions will return a meaningful 3914 * value. 3915 */ 3916CINDEX_LINKAGE 3917unsigned clang_TParamCommandComment_isParamPositionValid(CXComment Comment); 3918 3919/** 3920 * \param Comment a \c CXComment_TParamCommand AST node. 3921 * 3922 * \returns zero-based nesting depth of this parameter in the template parameter list. 3923 * 3924 * For example, 3925 * \verbatim 3926 * template<typename C, template<typename T> class TT> 3927 * void test(TT<int> aaa); 3928 * \endverbatim 3929 * for C and TT nesting depth is 0, 3930 * for T nesting depth is 1. 3931 */ 3932CINDEX_LINKAGE 3933unsigned clang_TParamCommandComment_getDepth(CXComment Comment); 3934 3935/** 3936 * \param Comment a \c CXComment_TParamCommand AST node. 3937 * 3938 * \returns zero-based parameter index in the template parameter list at a 3939 * given nesting depth. 3940 * 3941 * For example, 3942 * \verbatim 3943 * template<typename C, template<typename T> class TT> 3944 * void test(TT<int> aaa); 3945 * \endverbatim 3946 * for C and TT nesting depth is 0, so we can ask for index at depth 0: 3947 * at depth 0 C's index is 0, TT's index is 1. 3948 * 3949 * For T nesting depth is 1, so we can ask for index at depth 0 and 1: 3950 * at depth 0 T's index is 1 (same as TT's), 3951 * at depth 1 T's index is 0. 3952 */ 3953CINDEX_LINKAGE 3954unsigned clang_TParamCommandComment_getIndex(CXComment Comment, unsigned Depth); 3955 3956/** 3957 * \param Comment a \c CXComment_VerbatimBlockLine AST node. 3958 * 3959 * \returns text contained in the AST node. 3960 */ 3961CINDEX_LINKAGE 3962CXString clang_VerbatimBlockLineComment_getText(CXComment Comment); 3963 3964/** 3965 * \param Comment a \c CXComment_VerbatimLine AST node. 3966 * 3967 * \returns text contained in the AST node. 3968 */ 3969CINDEX_LINKAGE CXString clang_VerbatimLineComment_getText(CXComment Comment); 3970 3971/** 3972 * \brief Convert an HTML tag AST node to string. 3973 * 3974 * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST 3975 * node. 3976 * 3977 * \returns string containing an HTML tag. 3978 */ 3979CINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString(CXComment Comment); 3980 3981/** 3982 * \brief Convert a given full parsed comment to an HTML fragment. 3983 * 3984 * Specific details of HTML layout are subject to change. Don't try to parse 3985 * this HTML back into an AST, use other APIs instead. 3986 * 3987 * Currently the following CSS classes are used: 3988 * \li "para-brief" for \\brief paragraph and equivalent commands; 3989 * \li "para-returns" for \\returns paragraph and equivalent commands; 3990 * \li "word-returns" for the "Returns" word in \\returns paragraph. 3991 * 3992 * Function argument documentation is rendered as a \<dl\> list with arguments 3993 * sorted in function prototype order. CSS classes used: 3994 * \li "param-name-index-NUMBER" for parameter name (\<dt\>); 3995 * \li "param-descr-index-NUMBER" for parameter description (\<dd\>); 3996 * \li "param-name-index-invalid" and "param-descr-index-invalid" are used if 3997 * parameter index is invalid. 3998 * 3999 * Template parameter documentation is rendered as a \<dl\> list with 4000 * parameters sorted in template parameter list order. CSS classes used: 4001 * \li "tparam-name-index-NUMBER" for parameter name (\<dt\>); 4002 * \li "tparam-descr-index-NUMBER" for parameter description (\<dd\>); 4003 * \li "tparam-name-index-other" and "tparam-descr-index-other" are used for 4004 * names inside template template parameters; 4005 * \li "tparam-name-index-invalid" and "tparam-descr-index-invalid" are used if 4006 * parameter position is invalid. 4007 * 4008 * \param Comment a \c CXComment_FullComment AST node. 4009 * 4010 * \returns string containing an HTML fragment. 4011 */ 4012CINDEX_LINKAGE CXString clang_FullComment_getAsHTML(CXComment Comment); 4013 4014/** 4015 * \brief Convert a given full parsed comment to an XML document. 4016 * 4017 * A Relax NG schema for the XML can be found in comment-xml-schema.rng file 4018 * inside clang source tree. 4019 * 4020 * \param Comment a \c CXComment_FullComment AST node. 4021 * 4022 * \returns string containing an XML document. 4023 */ 4024CINDEX_LINKAGE CXString clang_FullComment_getAsXML(CXComment Comment); 4025 4026/** 4027 * @} 4028 */ 4029 4030/** 4031 * \defgroup CINDEX_CPP C++ AST introspection 4032 * 4033 * The routines in this group provide access information in the ASTs specific 4034 * to C++ language features. 4035 * 4036 * @{ 4037 */ 4038 4039/** 4040 * \brief Determine if a C++ member function or member function template is 4041 * declared 'static'. 4042 */ 4043CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C); 4044 4045/** 4046 * \brief Determine if a C++ member function or member function template is 4047 * explicitly declared 'virtual' or if it overrides a virtual method from 4048 * one of the base classes. 4049 */ 4050CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C); 4051 4052/** 4053 * \brief Given a cursor that represents a template, determine 4054 * the cursor kind of the specializations would be generated by instantiating 4055 * the template. 4056 * 4057 * This routine can be used to determine what flavor of function template, 4058 * class template, or class template partial specialization is stored in the 4059 * cursor. For example, it can describe whether a class template cursor is 4060 * declared with "struct", "class" or "union". 4061 * 4062 * \param C The cursor to query. This cursor should represent a template 4063 * declaration. 4064 * 4065 * \returns The cursor kind of the specializations that would be generated 4066 * by instantiating the template \p C. If \p C is not a template, returns 4067 * \c CXCursor_NoDeclFound. 4068 */ 4069CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C); 4070 4071/** 4072 * \brief Given a cursor that may represent a specialization or instantiation 4073 * of a template, retrieve the cursor that represents the template that it 4074 * specializes or from which it was instantiated. 4075 * 4076 * This routine determines the template involved both for explicit 4077 * specializations of templates and for implicit instantiations of the template, 4078 * both of which are referred to as "specializations". For a class template 4079 * specialization (e.g., \c std::vector<bool>), this routine will return 4080 * either the primary template (\c std::vector) or, if the specialization was 4081 * instantiated from a class template partial specialization, the class template 4082 * partial specialization. For a class template partial specialization and a 4083 * function template specialization (including instantiations), this 4084 * this routine will return the specialized template. 4085 * 4086 * For members of a class template (e.g., member functions, member classes, or 4087 * static data members), returns the specialized or instantiated member. 4088 * Although not strictly "templates" in the C++ language, members of class 4089 * templates have the same notions of specializations and instantiations that 4090 * templates do, so this routine treats them similarly. 4091 * 4092 * \param C A cursor that may be a specialization of a template or a member 4093 * of a template. 4094 * 4095 * \returns If the given cursor is a specialization or instantiation of a 4096 * template or a member thereof, the template or member that it specializes or 4097 * from which it was instantiated. Otherwise, returns a NULL cursor. 4098 */ 4099CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C); 4100 4101/** 4102 * \brief Given a cursor that references something else, return the source range 4103 * covering that reference. 4104 * 4105 * \param C A cursor pointing to a member reference, a declaration reference, or 4106 * an operator call. 4107 * \param NameFlags A bitset with three independent flags: 4108 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and 4109 * CXNameRange_WantSinglePiece. 4110 * \param PieceIndex For contiguous names or when passing the flag 4111 * CXNameRange_WantSinglePiece, only one piece with index 0 is 4112 * available. When the CXNameRange_WantSinglePiece flag is not passed for a 4113 * non-contiguous names, this index can be used to retrieve the individual 4114 * pieces of the name. See also CXNameRange_WantSinglePiece. 4115 * 4116 * \returns The piece of the name pointed to by the given cursor. If there is no 4117 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned. 4118 */ 4119CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, 4120 unsigned NameFlags, 4121 unsigned PieceIndex); 4122 4123enum CXNameRefFlags { 4124 /** 4125 * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the 4126 * range. 4127 */ 4128 CXNameRange_WantQualifier = 0x1, 4129 4130 /** 4131 * \brief Include the explicit template arguments, e.g. \<int> in x.f<int>, 4132 * in the range. 4133 */ 4134 CXNameRange_WantTemplateArgs = 0x2, 4135 4136 /** 4137 * \brief If the name is non-contiguous, return the full spanning range. 4138 * 4139 * Non-contiguous names occur in Objective-C when a selector with two or more 4140 * parameters is used, or in C++ when using an operator: 4141 * \code 4142 * [object doSomething:here withValue:there]; // ObjC 4143 * return some_vector[1]; // C++ 4144 * \endcode 4145 */ 4146 CXNameRange_WantSinglePiece = 0x4 4147}; 4148 4149/** 4150 * @} 4151 */ 4152 4153/** 4154 * \defgroup CINDEX_LEX Token extraction and manipulation 4155 * 4156 * The routines in this group provide access to the tokens within a 4157 * translation unit, along with a semantic mapping of those tokens to 4158 * their corresponding cursors. 4159 * 4160 * @{ 4161 */ 4162 4163/** 4164 * \brief Describes a kind of token. 4165 */ 4166typedef enum CXTokenKind { 4167 /** 4168 * \brief A token that contains some kind of punctuation. 4169 */ 4170 CXToken_Punctuation, 4171 4172 /** 4173 * \brief A language keyword. 4174 */ 4175 CXToken_Keyword, 4176 4177 /** 4178 * \brief An identifier (that is not a keyword). 4179 */ 4180 CXToken_Identifier, 4181 4182 /** 4183 * \brief A numeric, string, or character literal. 4184 */ 4185 CXToken_Literal, 4186 4187 /** 4188 * \brief A comment. 4189 */ 4190 CXToken_Comment 4191} CXTokenKind; 4192 4193/** 4194 * \brief Describes a single preprocessing token. 4195 */ 4196typedef struct { 4197 unsigned int_data[4]; 4198 void *ptr_data; 4199} CXToken; 4200 4201/** 4202 * \brief Determine the kind of the given token. 4203 */ 4204CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken); 4205 4206/** 4207 * \brief Determine the spelling of the given token. 4208 * 4209 * The spelling of a token is the textual representation of that token, e.g., 4210 * the text of an identifier or keyword. 4211 */ 4212CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken); 4213 4214/** 4215 * \brief Retrieve the source location of the given token. 4216 */ 4217CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit, 4218 CXToken); 4219 4220/** 4221 * \brief Retrieve a source range that covers the given token. 4222 */ 4223CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken); 4224 4225/** 4226 * \brief Tokenize the source code described by the given range into raw 4227 * lexical tokens. 4228 * 4229 * \param TU the translation unit whose text is being tokenized. 4230 * 4231 * \param Range the source range in which text should be tokenized. All of the 4232 * tokens produced by tokenization will fall within this source range, 4233 * 4234 * \param Tokens this pointer will be set to point to the array of tokens 4235 * that occur within the given source range. The returned pointer must be 4236 * freed with clang_disposeTokens() before the translation unit is destroyed. 4237 * 4238 * \param NumTokens will be set to the number of tokens in the \c *Tokens 4239 * array. 4240 * 4241 */ 4242CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 4243 CXToken **Tokens, unsigned *NumTokens); 4244 4245/** 4246 * \brief Annotate the given set of tokens by providing cursors for each token 4247 * that can be mapped to a specific entity within the abstract syntax tree. 4248 * 4249 * This token-annotation routine is equivalent to invoking 4250 * clang_getCursor() for the source locations of each of the 4251 * tokens. The cursors provided are filtered, so that only those 4252 * cursors that have a direct correspondence to the token are 4253 * accepted. For example, given a function call \c f(x), 4254 * clang_getCursor() would provide the following cursors: 4255 * 4256 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'. 4257 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'. 4258 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'. 4259 * 4260 * Only the first and last of these cursors will occur within the 4261 * annotate, since the tokens "f" and "x' directly refer to a function 4262 * and a variable, respectively, but the parentheses are just a small 4263 * part of the full syntax of the function call expression, which is 4264 * not provided as an annotation. 4265 * 4266 * \param TU the translation unit that owns the given tokens. 4267 * 4268 * \param Tokens the set of tokens to annotate. 4269 * 4270 * \param NumTokens the number of tokens in \p Tokens. 4271 * 4272 * \param Cursors an array of \p NumTokens cursors, whose contents will be 4273 * replaced with the cursors corresponding to each token. 4274 */ 4275CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU, 4276 CXToken *Tokens, unsigned NumTokens, 4277 CXCursor *Cursors); 4278 4279/** 4280 * \brief Free the given set of tokens. 4281 */ 4282CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU, 4283 CXToken *Tokens, unsigned NumTokens); 4284 4285/** 4286 * @} 4287 */ 4288 4289/** 4290 * \defgroup CINDEX_DEBUG Debugging facilities 4291 * 4292 * These routines are used for testing and debugging, only, and should not 4293 * be relied upon. 4294 * 4295 * @{ 4296 */ 4297 4298/* for debug/testing */ 4299CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind); 4300CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor, 4301 const char **startBuf, 4302 const char **endBuf, 4303 unsigned *startLine, 4304 unsigned *startColumn, 4305 unsigned *endLine, 4306 unsigned *endColumn); 4307CINDEX_LINKAGE void clang_enableStackTraces(void); 4308CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data, 4309 unsigned stack_size); 4310 4311/** 4312 * @} 4313 */ 4314 4315/** 4316 * \defgroup CINDEX_CODE_COMPLET Code completion 4317 * 4318 * Code completion involves taking an (incomplete) source file, along with 4319 * knowledge of where the user is actively editing that file, and suggesting 4320 * syntactically- and semantically-valid constructs that the user might want to 4321 * use at that particular point in the source code. These data structures and 4322 * routines provide support for code completion. 4323 * 4324 * @{ 4325 */ 4326 4327/** 4328 * \brief A semantic string that describes a code-completion result. 4329 * 4330 * A semantic string that describes the formatting of a code-completion 4331 * result as a single "template" of text that should be inserted into the 4332 * source buffer when a particular code-completion result is selected. 4333 * Each semantic string is made up of some number of "chunks", each of which 4334 * contains some text along with a description of what that text means, e.g., 4335 * the name of the entity being referenced, whether the text chunk is part of 4336 * the template, or whether it is a "placeholder" that the user should replace 4337 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a 4338 * description of the different kinds of chunks. 4339 */ 4340typedef void *CXCompletionString; 4341 4342/** 4343 * \brief A single result of code completion. 4344 */ 4345typedef struct { 4346 /** 4347 * \brief The kind of entity that this completion refers to. 4348 * 4349 * The cursor kind will be a macro, keyword, or a declaration (one of the 4350 * *Decl cursor kinds), describing the entity that the completion is 4351 * referring to. 4352 * 4353 * \todo In the future, we would like to provide a full cursor, to allow 4354 * the client to extract additional information from declaration. 4355 */ 4356 enum CXCursorKind CursorKind; 4357 4358 /** 4359 * \brief The code-completion string that describes how to insert this 4360 * code-completion result into the editing buffer. 4361 */ 4362 CXCompletionString CompletionString; 4363} CXCompletionResult; 4364 4365/** 4366 * \brief Describes a single piece of text within a code-completion string. 4367 * 4368 * Each "chunk" within a code-completion string (\c CXCompletionString) is 4369 * either a piece of text with a specific "kind" that describes how that text 4370 * should be interpreted by the client or is another completion string. 4371 */ 4372enum CXCompletionChunkKind { 4373 /** 4374 * \brief A code-completion string that describes "optional" text that 4375 * could be a part of the template (but is not required). 4376 * 4377 * The Optional chunk is the only kind of chunk that has a code-completion 4378 * string for its representation, which is accessible via 4379 * \c clang_getCompletionChunkCompletionString(). The code-completion string 4380 * describes an additional part of the template that is completely optional. 4381 * For example, optional chunks can be used to describe the placeholders for 4382 * arguments that match up with defaulted function parameters, e.g. given: 4383 * 4384 * \code 4385 * void f(int x, float y = 3.14, double z = 2.71828); 4386 * \endcode 4387 * 4388 * The code-completion string for this function would contain: 4389 * - a TypedText chunk for "f". 4390 * - a LeftParen chunk for "(". 4391 * - a Placeholder chunk for "int x" 4392 * - an Optional chunk containing the remaining defaulted arguments, e.g., 4393 * - a Comma chunk for "," 4394 * - a Placeholder chunk for "float y" 4395 * - an Optional chunk containing the last defaulted argument: 4396 * - a Comma chunk for "," 4397 * - a Placeholder chunk for "double z" 4398 * - a RightParen chunk for ")" 4399 * 4400 * There are many ways to handle Optional chunks. Two simple approaches are: 4401 * - Completely ignore optional chunks, in which case the template for the 4402 * function "f" would only include the first parameter ("int x"). 4403 * - Fully expand all optional chunks, in which case the template for the 4404 * function "f" would have all of the parameters. 4405 */ 4406 CXCompletionChunk_Optional, 4407 /** 4408 * \brief Text that a user would be expected to type to get this 4409 * code-completion result. 4410 * 4411 * There will be exactly one "typed text" chunk in a semantic string, which 4412 * will typically provide the spelling of a keyword or the name of a 4413 * declaration that could be used at the current code point. Clients are 4414 * expected to filter the code-completion results based on the text in this 4415 * chunk. 4416 */ 4417 CXCompletionChunk_TypedText, 4418 /** 4419 * \brief Text that should be inserted as part of a code-completion result. 4420 * 4421 * A "text" chunk represents text that is part of the template to be 4422 * inserted into user code should this particular code-completion result 4423 * be selected. 4424 */ 4425 CXCompletionChunk_Text, 4426 /** 4427 * \brief Placeholder text that should be replaced by the user. 4428 * 4429 * A "placeholder" chunk marks a place where the user should insert text 4430 * into the code-completion template. For example, placeholders might mark 4431 * the function parameters for a function declaration, to indicate that the 4432 * user should provide arguments for each of those parameters. The actual 4433 * text in a placeholder is a suggestion for the text to display before 4434 * the user replaces the placeholder with real code. 4435 */ 4436 CXCompletionChunk_Placeholder, 4437 /** 4438 * \brief Informative text that should be displayed but never inserted as 4439 * part of the template. 4440 * 4441 * An "informative" chunk contains annotations that can be displayed to 4442 * help the user decide whether a particular code-completion result is the 4443 * right option, but which is not part of the actual template to be inserted 4444 * by code completion. 4445 */ 4446 CXCompletionChunk_Informative, 4447 /** 4448 * \brief Text that describes the current parameter when code-completion is 4449 * referring to function call, message send, or template specialization. 4450 * 4451 * A "current parameter" chunk occurs when code-completion is providing 4452 * information about a parameter corresponding to the argument at the 4453 * code-completion point. For example, given a function 4454 * 4455 * \code 4456 * int add(int x, int y); 4457 * \endcode 4458 * 4459 * and the source code \c add(, where the code-completion point is after the 4460 * "(", the code-completion string will contain a "current parameter" chunk 4461 * for "int x", indicating that the current argument will initialize that 4462 * parameter. After typing further, to \c add(17, (where the code-completion 4463 * point is after the ","), the code-completion string will contain a 4464 * "current paremeter" chunk to "int y". 4465 */ 4466 CXCompletionChunk_CurrentParameter, 4467 /** 4468 * \brief A left parenthesis ('('), used to initiate a function call or 4469 * signal the beginning of a function parameter list. 4470 */ 4471 CXCompletionChunk_LeftParen, 4472 /** 4473 * \brief A right parenthesis (')'), used to finish a function call or 4474 * signal the end of a function parameter list. 4475 */ 4476 CXCompletionChunk_RightParen, 4477 /** 4478 * \brief A left bracket ('['). 4479 */ 4480 CXCompletionChunk_LeftBracket, 4481 /** 4482 * \brief A right bracket (']'). 4483 */ 4484 CXCompletionChunk_RightBracket, 4485 /** 4486 * \brief A left brace ('{'). 4487 */ 4488 CXCompletionChunk_LeftBrace, 4489 /** 4490 * \brief A right brace ('}'). 4491 */ 4492 CXCompletionChunk_RightBrace, 4493 /** 4494 * \brief A left angle bracket ('<'). 4495 */ 4496 CXCompletionChunk_LeftAngle, 4497 /** 4498 * \brief A right angle bracket ('>'). 4499 */ 4500 CXCompletionChunk_RightAngle, 4501 /** 4502 * \brief A comma separator (','). 4503 */ 4504 CXCompletionChunk_Comma, 4505 /** 4506 * \brief Text that specifies the result type of a given result. 4507 * 4508 * This special kind of informative chunk is not meant to be inserted into 4509 * the text buffer. Rather, it is meant to illustrate the type that an 4510 * expression using the given completion string would have. 4511 */ 4512 CXCompletionChunk_ResultType, 4513 /** 4514 * \brief A colon (':'). 4515 */ 4516 CXCompletionChunk_Colon, 4517 /** 4518 * \brief A semicolon (';'). 4519 */ 4520 CXCompletionChunk_SemiColon, 4521 /** 4522 * \brief An '=' sign. 4523 */ 4524 CXCompletionChunk_Equal, 4525 /** 4526 * Horizontal space (' '). 4527 */ 4528 CXCompletionChunk_HorizontalSpace, 4529 /** 4530 * Vertical space ('\n'), after which it is generally a good idea to 4531 * perform indentation. 4532 */ 4533 CXCompletionChunk_VerticalSpace 4534}; 4535 4536/** 4537 * \brief Determine the kind of a particular chunk within a completion string. 4538 * 4539 * \param completion_string the completion string to query. 4540 * 4541 * \param chunk_number the 0-based index of the chunk in the completion string. 4542 * 4543 * \returns the kind of the chunk at the index \c chunk_number. 4544 */ 4545CINDEX_LINKAGE enum CXCompletionChunkKind 4546clang_getCompletionChunkKind(CXCompletionString completion_string, 4547 unsigned chunk_number); 4548 4549/** 4550 * \brief Retrieve the text associated with a particular chunk within a 4551 * completion string. 4552 * 4553 * \param completion_string the completion string to query. 4554 * 4555 * \param chunk_number the 0-based index of the chunk in the completion string. 4556 * 4557 * \returns the text associated with the chunk at index \c chunk_number. 4558 */ 4559CINDEX_LINKAGE CXString 4560clang_getCompletionChunkText(CXCompletionString completion_string, 4561 unsigned chunk_number); 4562 4563/** 4564 * \brief Retrieve the completion string associated with a particular chunk 4565 * within a completion string. 4566 * 4567 * \param completion_string the completion string to query. 4568 * 4569 * \param chunk_number the 0-based index of the chunk in the completion string. 4570 * 4571 * \returns the completion string associated with the chunk at index 4572 * \c chunk_number. 4573 */ 4574CINDEX_LINKAGE CXCompletionString 4575clang_getCompletionChunkCompletionString(CXCompletionString completion_string, 4576 unsigned chunk_number); 4577 4578/** 4579 * \brief Retrieve the number of chunks in the given code-completion string. 4580 */ 4581CINDEX_LINKAGE unsigned 4582clang_getNumCompletionChunks(CXCompletionString completion_string); 4583 4584/** 4585 * \brief Determine the priority of this code completion. 4586 * 4587 * The priority of a code completion indicates how likely it is that this 4588 * particular completion is the completion that the user will select. The 4589 * priority is selected by various internal heuristics. 4590 * 4591 * \param completion_string The completion string to query. 4592 * 4593 * \returns The priority of this completion string. Smaller values indicate 4594 * higher-priority (more likely) completions. 4595 */ 4596CINDEX_LINKAGE unsigned 4597clang_getCompletionPriority(CXCompletionString completion_string); 4598 4599/** 4600 * \brief Determine the availability of the entity that this code-completion 4601 * string refers to. 4602 * 4603 * \param completion_string The completion string to query. 4604 * 4605 * \returns The availability of the completion string. 4606 */ 4607CINDEX_LINKAGE enum CXAvailabilityKind 4608clang_getCompletionAvailability(CXCompletionString completion_string); 4609 4610/** 4611 * \brief Retrieve the number of annotations associated with the given 4612 * completion string. 4613 * 4614 * \param completion_string the completion string to query. 4615 * 4616 * \returns the number of annotations associated with the given completion 4617 * string. 4618 */ 4619CINDEX_LINKAGE unsigned 4620clang_getCompletionNumAnnotations(CXCompletionString completion_string); 4621 4622/** 4623 * \brief Retrieve the annotation associated with the given completion string. 4624 * 4625 * \param completion_string the completion string to query. 4626 * 4627 * \param annotation_number the 0-based index of the annotation of the 4628 * completion string. 4629 * 4630 * \returns annotation string associated with the completion at index 4631 * \c annotation_number, or a NULL string if that annotation is not available. 4632 */ 4633CINDEX_LINKAGE CXString 4634clang_getCompletionAnnotation(CXCompletionString completion_string, 4635 unsigned annotation_number); 4636 4637/** 4638 * \brief Retrieve the parent context of the given completion string. 4639 * 4640 * The parent context of a completion string is the semantic parent of 4641 * the declaration (if any) that the code completion represents. For example, 4642 * a code completion for an Objective-C method would have the method's class 4643 * or protocol as its context. 4644 * 4645 * \param completion_string The code completion string whose parent is 4646 * being queried. 4647 * 4648 * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL. 4649 * 4650 * \returns The name of the completion parent, e.g., "NSObject" if 4651 * the completion string represents a method in the NSObject class. 4652 */ 4653CINDEX_LINKAGE CXString 4654clang_getCompletionParent(CXCompletionString completion_string, 4655 enum CXCursorKind *kind); 4656 4657/** 4658 * \brief Retrieve the brief documentation comment attached to the declaration 4659 * that corresponds to the given completion string. 4660 */ 4661CINDEX_LINKAGE CXString 4662clang_getCompletionBriefComment(CXCompletionString completion_string); 4663 4664/** 4665 * \brief Retrieve a completion string for an arbitrary declaration or macro 4666 * definition cursor. 4667 * 4668 * \param cursor The cursor to query. 4669 * 4670 * \returns A non-context-sensitive completion string for declaration and macro 4671 * definition cursors, or NULL for other kinds of cursors. 4672 */ 4673CINDEX_LINKAGE CXCompletionString 4674clang_getCursorCompletionString(CXCursor cursor); 4675 4676/** 4677 * \brief Contains the results of code-completion. 4678 * 4679 * This data structure contains the results of code completion, as 4680 * produced by \c clang_codeCompleteAt(). Its contents must be freed by 4681 * \c clang_disposeCodeCompleteResults. 4682 */ 4683typedef struct { 4684 /** 4685 * \brief The code-completion results. 4686 */ 4687 CXCompletionResult *Results; 4688 4689 /** 4690 * \brief The number of code-completion results stored in the 4691 * \c Results array. 4692 */ 4693 unsigned NumResults; 4694} CXCodeCompleteResults; 4695 4696/** 4697 * \brief Flags that can be passed to \c clang_codeCompleteAt() to 4698 * modify its behavior. 4699 * 4700 * The enumerators in this enumeration can be bitwise-OR'd together to 4701 * provide multiple options to \c clang_codeCompleteAt(). 4702 */ 4703enum CXCodeComplete_Flags { 4704 /** 4705 * \brief Whether to include macros within the set of code 4706 * completions returned. 4707 */ 4708 CXCodeComplete_IncludeMacros = 0x01, 4709 4710 /** 4711 * \brief Whether to include code patterns for language constructs 4712 * within the set of code completions, e.g., for loops. 4713 */ 4714 CXCodeComplete_IncludeCodePatterns = 0x02, 4715 4716 /** 4717 * \brief Whether to include brief documentation within the set of code 4718 * completions returned. 4719 */ 4720 CXCodeComplete_IncludeBriefComments = 0x04 4721}; 4722 4723/** 4724 * \brief Bits that represent the context under which completion is occurring. 4725 * 4726 * The enumerators in this enumeration may be bitwise-OR'd together if multiple 4727 * contexts are occurring simultaneously. 4728 */ 4729enum CXCompletionContext { 4730 /** 4731 * \brief The context for completions is unexposed, as only Clang results 4732 * should be included. (This is equivalent to having no context bits set.) 4733 */ 4734 CXCompletionContext_Unexposed = 0, 4735 4736 /** 4737 * \brief Completions for any possible type should be included in the results. 4738 */ 4739 CXCompletionContext_AnyType = 1 << 0, 4740 4741 /** 4742 * \brief Completions for any possible value (variables, function calls, etc.) 4743 * should be included in the results. 4744 */ 4745 CXCompletionContext_AnyValue = 1 << 1, 4746 /** 4747 * \brief Completions for values that resolve to an Objective-C object should 4748 * be included in the results. 4749 */ 4750 CXCompletionContext_ObjCObjectValue = 1 << 2, 4751 /** 4752 * \brief Completions for values that resolve to an Objective-C selector 4753 * should be included in the results. 4754 */ 4755 CXCompletionContext_ObjCSelectorValue = 1 << 3, 4756 /** 4757 * \brief Completions for values that resolve to a C++ class type should be 4758 * included in the results. 4759 */ 4760 CXCompletionContext_CXXClassTypeValue = 1 << 4, 4761 4762 /** 4763 * \brief Completions for fields of the member being accessed using the dot 4764 * operator should be included in the results. 4765 */ 4766 CXCompletionContext_DotMemberAccess = 1 << 5, 4767 /** 4768 * \brief Completions for fields of the member being accessed using the arrow 4769 * operator should be included in the results. 4770 */ 4771 CXCompletionContext_ArrowMemberAccess = 1 << 6, 4772 /** 4773 * \brief Completions for properties of the Objective-C object being accessed 4774 * using the dot operator should be included in the results. 4775 */ 4776 CXCompletionContext_ObjCPropertyAccess = 1 << 7, 4777 4778 /** 4779 * \brief Completions for enum tags should be included in the results. 4780 */ 4781 CXCompletionContext_EnumTag = 1 << 8, 4782 /** 4783 * \brief Completions for union tags should be included in the results. 4784 */ 4785 CXCompletionContext_UnionTag = 1 << 9, 4786 /** 4787 * \brief Completions for struct tags should be included in the results. 4788 */ 4789 CXCompletionContext_StructTag = 1 << 10, 4790 4791 /** 4792 * \brief Completions for C++ class names should be included in the results. 4793 */ 4794 CXCompletionContext_ClassTag = 1 << 11, 4795 /** 4796 * \brief Completions for C++ namespaces and namespace aliases should be 4797 * included in the results. 4798 */ 4799 CXCompletionContext_Namespace = 1 << 12, 4800 /** 4801 * \brief Completions for C++ nested name specifiers should be included in 4802 * the results. 4803 */ 4804 CXCompletionContext_NestedNameSpecifier = 1 << 13, 4805 4806 /** 4807 * \brief Completions for Objective-C interfaces (classes) should be included 4808 * in the results. 4809 */ 4810 CXCompletionContext_ObjCInterface = 1 << 14, 4811 /** 4812 * \brief Completions for Objective-C protocols should be included in 4813 * the results. 4814 */ 4815 CXCompletionContext_ObjCProtocol = 1 << 15, 4816 /** 4817 * \brief Completions for Objective-C categories should be included in 4818 * the results. 4819 */ 4820 CXCompletionContext_ObjCCategory = 1 << 16, 4821 /** 4822 * \brief Completions for Objective-C instance messages should be included 4823 * in the results. 4824 */ 4825 CXCompletionContext_ObjCInstanceMessage = 1 << 17, 4826 /** 4827 * \brief Completions for Objective-C class messages should be included in 4828 * the results. 4829 */ 4830 CXCompletionContext_ObjCClassMessage = 1 << 18, 4831 /** 4832 * \brief Completions for Objective-C selector names should be included in 4833 * the results. 4834 */ 4835 CXCompletionContext_ObjCSelectorName = 1 << 19, 4836 4837 /** 4838 * \brief Completions for preprocessor macro names should be included in 4839 * the results. 4840 */ 4841 CXCompletionContext_MacroName = 1 << 20, 4842 4843 /** 4844 * \brief Natural language completions should be included in the results. 4845 */ 4846 CXCompletionContext_NaturalLanguage = 1 << 21, 4847 4848 /** 4849 * \brief The current context is unknown, so set all contexts. 4850 */ 4851 CXCompletionContext_Unknown = ((1 << 22) - 1) 4852}; 4853 4854/** 4855 * \brief Returns a default set of code-completion options that can be 4856 * passed to\c clang_codeCompleteAt(). 4857 */ 4858CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void); 4859 4860/** 4861 * \brief Perform code completion at a given location in a translation unit. 4862 * 4863 * This function performs code completion at a particular file, line, and 4864 * column within source code, providing results that suggest potential 4865 * code snippets based on the context of the completion. The basic model 4866 * for code completion is that Clang will parse a complete source file, 4867 * performing syntax checking up to the location where code-completion has 4868 * been requested. At that point, a special code-completion token is passed 4869 * to the parser, which recognizes this token and determines, based on the 4870 * current location in the C/Objective-C/C++ grammar and the state of 4871 * semantic analysis, what completions to provide. These completions are 4872 * returned via a new \c CXCodeCompleteResults structure. 4873 * 4874 * Code completion itself is meant to be triggered by the client when the 4875 * user types punctuation characters or whitespace, at which point the 4876 * code-completion location will coincide with the cursor. For example, if \c p 4877 * is a pointer, code-completion might be triggered after the "-" and then 4878 * after the ">" in \c p->. When the code-completion location is afer the ">", 4879 * the completion results will provide, e.g., the members of the struct that 4880 * "p" points to. The client is responsible for placing the cursor at the 4881 * beginning of the token currently being typed, then filtering the results 4882 * based on the contents of the token. For example, when code-completing for 4883 * the expression \c p->get, the client should provide the location just after 4884 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the 4885 * client can filter the results based on the current token text ("get"), only 4886 * showing those results that start with "get". The intent of this interface 4887 * is to separate the relatively high-latency acquisition of code-completion 4888 * results from the filtering of results on a per-character basis, which must 4889 * have a lower latency. 4890 * 4891 * \param TU The translation unit in which code-completion should 4892 * occur. The source files for this translation unit need not be 4893 * completely up-to-date (and the contents of those source files may 4894 * be overridden via \p unsaved_files). Cursors referring into the 4895 * translation unit may be invalidated by this invocation. 4896 * 4897 * \param complete_filename The name of the source file where code 4898 * completion should be performed. This filename may be any file 4899 * included in the translation unit. 4900 * 4901 * \param complete_line The line at which code-completion should occur. 4902 * 4903 * \param complete_column The column at which code-completion should occur. 4904 * Note that the column should point just after the syntactic construct that 4905 * initiated code completion, and not in the middle of a lexical token. 4906 * 4907 * \param unsaved_files the Tiles that have not yet been saved to disk 4908 * but may be required for parsing or code completion, including the 4909 * contents of those files. The contents and name of these files (as 4910 * specified by CXUnsavedFile) are copied when necessary, so the 4911 * client only needs to guarantee their validity until the call to 4912 * this function returns. 4913 * 4914 * \param num_unsaved_files The number of unsaved file entries in \p 4915 * unsaved_files. 4916 * 4917 * \param options Extra options that control the behavior of code 4918 * completion, expressed as a bitwise OR of the enumerators of the 4919 * CXCodeComplete_Flags enumeration. The 4920 * \c clang_defaultCodeCompleteOptions() function returns a default set 4921 * of code-completion options. 4922 * 4923 * \returns If successful, a new \c CXCodeCompleteResults structure 4924 * containing code-completion results, which should eventually be 4925 * freed with \c clang_disposeCodeCompleteResults(). If code 4926 * completion fails, returns NULL. 4927 */ 4928CINDEX_LINKAGE 4929CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU, 4930 const char *complete_filename, 4931 unsigned complete_line, 4932 unsigned complete_column, 4933 struct CXUnsavedFile *unsaved_files, 4934 unsigned num_unsaved_files, 4935 unsigned options); 4936 4937/** 4938 * \brief Sort the code-completion results in case-insensitive alphabetical 4939 * order. 4940 * 4941 * \param Results The set of results to sort. 4942 * \param NumResults The number of results in \p Results. 4943 */ 4944CINDEX_LINKAGE 4945void clang_sortCodeCompletionResults(CXCompletionResult *Results, 4946 unsigned NumResults); 4947 4948/** 4949 * \brief Free the given set of code-completion results. 4950 */ 4951CINDEX_LINKAGE 4952void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results); 4953 4954/** 4955 * \brief Determine the number of diagnostics produced prior to the 4956 * location where code completion was performed. 4957 */ 4958CINDEX_LINKAGE 4959unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results); 4960 4961/** 4962 * \brief Retrieve a diagnostic associated with the given code completion. 4963 * 4964 * \param Results the code completion results to query. 4965 * \param Index the zero-based diagnostic number to retrieve. 4966 * 4967 * \returns the requested diagnostic. This diagnostic must be freed 4968 * via a call to \c clang_disposeDiagnostic(). 4969 */ 4970CINDEX_LINKAGE 4971CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results, 4972 unsigned Index); 4973 4974/** 4975 * \brief Determines what compeltions are appropriate for the context 4976 * the given code completion. 4977 * 4978 * \param Results the code completion results to query 4979 * 4980 * \returns the kinds of completions that are appropriate for use 4981 * along with the given code completion results. 4982 */ 4983CINDEX_LINKAGE 4984unsigned long long clang_codeCompleteGetContexts( 4985 CXCodeCompleteResults *Results); 4986 4987/** 4988 * \brief Returns the cursor kind for the container for the current code 4989 * completion context. The container is only guaranteed to be set for 4990 * contexts where a container exists (i.e. member accesses or Objective-C 4991 * message sends); if there is not a container, this function will return 4992 * CXCursor_InvalidCode. 4993 * 4994 * \param Results the code completion results to query 4995 * 4996 * \param IsIncomplete on return, this value will be false if Clang has complete 4997 * information about the container. If Clang does not have complete 4998 * information, this value will be true. 4999 * 5000 * \returns the container kind, or CXCursor_InvalidCode if there is not a 5001 * container 5002 */ 5003CINDEX_LINKAGE 5004enum CXCursorKind clang_codeCompleteGetContainerKind( 5005 CXCodeCompleteResults *Results, 5006 unsigned *IsIncomplete); 5007 5008/** 5009 * \brief Returns the USR for the container for the current code completion 5010 * context. If there is not a container for the current context, this 5011 * function will return the empty string. 5012 * 5013 * \param Results the code completion results to query 5014 * 5015 * \returns the USR for the container 5016 */ 5017CINDEX_LINKAGE 5018CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results); 5019 5020 5021/** 5022 * \brief Returns the currently-entered selector for an Objective-C message 5023 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a 5024 * non-empty string for CXCompletionContext_ObjCInstanceMessage and 5025 * CXCompletionContext_ObjCClassMessage. 5026 * 5027 * \param Results the code completion results to query 5028 * 5029 * \returns the selector (or partial selector) that has been entered thus far 5030 * for an Objective-C message send. 5031 */ 5032CINDEX_LINKAGE 5033CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results); 5034 5035/** 5036 * @} 5037 */ 5038 5039 5040/** 5041 * \defgroup CINDEX_MISC Miscellaneous utility functions 5042 * 5043 * @{ 5044 */ 5045 5046/** 5047 * \brief Return a version string, suitable for showing to a user, but not 5048 * intended to be parsed (the format is not guaranteed to be stable). 5049 */ 5050CINDEX_LINKAGE CXString clang_getClangVersion(void); 5051 5052 5053/** 5054 * \brief Enable/disable crash recovery. 5055 * 5056 * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero 5057 * value enables crash recovery, while 0 disables it. 5058 */ 5059CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled); 5060 5061 /** 5062 * \brief Visitor invoked for each file in a translation unit 5063 * (used with clang_getInclusions()). 5064 * 5065 * This visitor function will be invoked by clang_getInclusions() for each 5066 * file included (either at the top-level or by \#include directives) within 5067 * a translation unit. The first argument is the file being included, and 5068 * the second and third arguments provide the inclusion stack. The 5069 * array is sorted in order of immediate inclusion. For example, 5070 * the first element refers to the location that included 'included_file'. 5071 */ 5072typedef void (*CXInclusionVisitor)(CXFile included_file, 5073 CXSourceLocation* inclusion_stack, 5074 unsigned include_len, 5075 CXClientData client_data); 5076 5077/** 5078 * \brief Visit the set of preprocessor inclusions in a translation unit. 5079 * The visitor function is called with the provided data for every included 5080 * file. This does not include headers included by the PCH file (unless one 5081 * is inspecting the inclusions in the PCH file itself). 5082 */ 5083CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu, 5084 CXInclusionVisitor visitor, 5085 CXClientData client_data); 5086 5087/** 5088 * @} 5089 */ 5090 5091/** \defgroup CINDEX_REMAPPING Remapping functions 5092 * 5093 * @{ 5094 */ 5095 5096/** 5097 * \brief A remapping of original source files and their translated files. 5098 */ 5099typedef void *CXRemapping; 5100 5101/** 5102 * \brief Retrieve a remapping. 5103 * 5104 * \param path the path that contains metadata about remappings. 5105 * 5106 * \returns the requested remapping. This remapping must be freed 5107 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 5108 */ 5109CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path); 5110 5111/** 5112 * \brief Retrieve a remapping. 5113 * 5114 * \param filePaths pointer to an array of file paths containing remapping info. 5115 * 5116 * \param numFiles number of file paths. 5117 * 5118 * \returns the requested remapping. This remapping must be freed 5119 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred. 5120 */ 5121CINDEX_LINKAGE 5122CXRemapping clang_getRemappingsFromFileList(const char **filePaths, 5123 unsigned numFiles); 5124 5125/** 5126 * \brief Determine the number of remappings. 5127 */ 5128CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping); 5129 5130/** 5131 * \brief Get the original and the associated filename from the remapping. 5132 * 5133 * \param original If non-NULL, will be set to the original filename. 5134 * 5135 * \param transformed If non-NULL, will be set to the filename that the original 5136 * is associated with. 5137 */ 5138CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index, 5139 CXString *original, CXString *transformed); 5140 5141/** 5142 * \brief Dispose the remapping. 5143 */ 5144CINDEX_LINKAGE void clang_remap_dispose(CXRemapping); 5145 5146/** 5147 * @} 5148 */ 5149 5150/** \defgroup CINDEX_HIGH Higher level API functions 5151 * 5152 * @{ 5153 */ 5154 5155enum CXVisitorResult { 5156 CXVisit_Break, 5157 CXVisit_Continue 5158}; 5159 5160typedef struct { 5161 void *context; 5162 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange); 5163} CXCursorAndRangeVisitor; 5164 5165typedef enum { 5166 /** 5167 * \brief Function returned successfully. 5168 */ 5169 CXResult_Success = 0, 5170 /** 5171 * \brief One of the parameters was invalid for the function. 5172 */ 5173 CXResult_Invalid = 1, 5174 /** 5175 * \brief The function was terminated by a callback (e.g. it returned 5176 * CXVisit_Break) 5177 */ 5178 CXResult_VisitBreak = 2 5179 5180} CXResult; 5181 5182/** 5183 * \brief Find references of a declaration in a specific file. 5184 * 5185 * \param cursor pointing to a declaration or a reference of one. 5186 * 5187 * \param file to search for references. 5188 * 5189 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for 5190 * each reference found. 5191 * The CXSourceRange will point inside the file; if the reference is inside 5192 * a macro (and not a macro argument) the CXSourceRange will be invalid. 5193 * 5194 * \returns one of the CXResult enumerators. 5195 */ 5196CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file, 5197 CXCursorAndRangeVisitor visitor); 5198 5199/** 5200 * \brief Find #import/#include directives in a specific file. 5201 * 5202 * \param TU translation unit containing the file to query. 5203 * 5204 * \param file to search for #import/#include directives. 5205 * 5206 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for 5207 * each directive found. 5208 * 5209 * \returns one of the CXResult enumerators. 5210 */ 5211CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU, 5212 CXFile file, 5213 CXCursorAndRangeVisitor visitor); 5214 5215#ifdef __has_feature 5216# if __has_feature(blocks) 5217 5218typedef enum CXVisitorResult 5219 (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange); 5220 5221CINDEX_LINKAGE 5222CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile, 5223 CXCursorAndRangeVisitorBlock); 5224 5225CINDEX_LINKAGE 5226CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile, 5227 CXCursorAndRangeVisitorBlock); 5228 5229# endif 5230#endif 5231 5232/** 5233 * \brief The client's data object that is associated with a CXFile. 5234 */ 5235typedef void *CXIdxClientFile; 5236 5237/** 5238 * \brief The client's data object that is associated with a semantic entity. 5239 */ 5240typedef void *CXIdxClientEntity; 5241 5242/** 5243 * \brief The client's data object that is associated with a semantic container 5244 * of entities. 5245 */ 5246typedef void *CXIdxClientContainer; 5247 5248/** 5249 * \brief The client's data object that is associated with an AST file (PCH 5250 * or module). 5251 */ 5252typedef void *CXIdxClientASTFile; 5253 5254/** 5255 * \brief Source location passed to index callbacks. 5256 */ 5257typedef struct { 5258 void *ptr_data[2]; 5259 unsigned int_data; 5260} CXIdxLoc; 5261 5262/** 5263 * \brief Data for ppIncludedFile callback. 5264 */ 5265typedef struct { 5266 /** 5267 * \brief Location of '#' in the \#include/\#import directive. 5268 */ 5269 CXIdxLoc hashLoc; 5270 /** 5271 * \brief Filename as written in the \#include/\#import directive. 5272 */ 5273 const char *filename; 5274 /** 5275 * \brief The actual file that the \#include/\#import directive resolved to. 5276 */ 5277 CXFile file; 5278 int isImport; 5279 int isAngled; 5280 /** 5281 * \brief Non-zero if the directive was automatically turned into a module 5282 * import. 5283 */ 5284 int isModuleImport; 5285} CXIdxIncludedFileInfo; 5286 5287/** 5288 * \brief Data for IndexerCallbacks#importedASTFile. 5289 */ 5290typedef struct { 5291 /** 5292 * \brief Top level AST file containing the imported PCH, module or submodule. 5293 */ 5294 CXFile file; 5295 /** 5296 * \brief The imported module or NULL if the AST file is a PCH. 5297 */ 5298 CXModule module; 5299 /** 5300 * \brief Location where the file is imported. Applicable only for modules. 5301 */ 5302 CXIdxLoc loc; 5303 /** 5304 * \brief Non-zero if an inclusion directive was automatically turned into 5305 * a module import. Applicable only for modules. 5306 */ 5307 int isImplicit; 5308 5309} CXIdxImportedASTFileInfo; 5310 5311typedef enum { 5312 CXIdxEntity_Unexposed = 0, 5313 CXIdxEntity_Typedef = 1, 5314 CXIdxEntity_Function = 2, 5315 CXIdxEntity_Variable = 3, 5316 CXIdxEntity_Field = 4, 5317 CXIdxEntity_EnumConstant = 5, 5318 5319 CXIdxEntity_ObjCClass = 6, 5320 CXIdxEntity_ObjCProtocol = 7, 5321 CXIdxEntity_ObjCCategory = 8, 5322 5323 CXIdxEntity_ObjCInstanceMethod = 9, 5324 CXIdxEntity_ObjCClassMethod = 10, 5325 CXIdxEntity_ObjCProperty = 11, 5326 CXIdxEntity_ObjCIvar = 12, 5327 5328 CXIdxEntity_Enum = 13, 5329 CXIdxEntity_Struct = 14, 5330 CXIdxEntity_Union = 15, 5331 5332 CXIdxEntity_CXXClass = 16, 5333 CXIdxEntity_CXXNamespace = 17, 5334 CXIdxEntity_CXXNamespaceAlias = 18, 5335 CXIdxEntity_CXXStaticVariable = 19, 5336 CXIdxEntity_CXXStaticMethod = 20, 5337 CXIdxEntity_CXXInstanceMethod = 21, 5338 CXIdxEntity_CXXConstructor = 22, 5339 CXIdxEntity_CXXDestructor = 23, 5340 CXIdxEntity_CXXConversionFunction = 24, 5341 CXIdxEntity_CXXTypeAlias = 25, 5342 CXIdxEntity_CXXInterface = 26 5343 5344} CXIdxEntityKind; 5345 5346typedef enum { 5347 CXIdxEntityLang_None = 0, 5348 CXIdxEntityLang_C = 1, 5349 CXIdxEntityLang_ObjC = 2, 5350 CXIdxEntityLang_CXX = 3 5351} CXIdxEntityLanguage; 5352 5353/** 5354 * \brief Extra C++ template information for an entity. This can apply to: 5355 * CXIdxEntity_Function 5356 * CXIdxEntity_CXXClass 5357 * CXIdxEntity_CXXStaticMethod 5358 * CXIdxEntity_CXXInstanceMethod 5359 * CXIdxEntity_CXXConstructor 5360 * CXIdxEntity_CXXConversionFunction 5361 * CXIdxEntity_CXXTypeAlias 5362 */ 5363typedef enum { 5364 CXIdxEntity_NonTemplate = 0, 5365 CXIdxEntity_Template = 1, 5366 CXIdxEntity_TemplatePartialSpecialization = 2, 5367 CXIdxEntity_TemplateSpecialization = 3 5368} CXIdxEntityCXXTemplateKind; 5369 5370typedef enum { 5371 CXIdxAttr_Unexposed = 0, 5372 CXIdxAttr_IBAction = 1, 5373 CXIdxAttr_IBOutlet = 2, 5374 CXIdxAttr_IBOutletCollection = 3 5375} CXIdxAttrKind; 5376 5377typedef struct { 5378 CXIdxAttrKind kind; 5379 CXCursor cursor; 5380 CXIdxLoc loc; 5381} CXIdxAttrInfo; 5382 5383typedef struct { 5384 CXIdxEntityKind kind; 5385 CXIdxEntityCXXTemplateKind templateKind; 5386 CXIdxEntityLanguage lang; 5387 const char *name; 5388 const char *USR; 5389 CXCursor cursor; 5390 const CXIdxAttrInfo *const *attributes; 5391 unsigned numAttributes; 5392} CXIdxEntityInfo; 5393 5394typedef struct { 5395 CXCursor cursor; 5396} CXIdxContainerInfo; 5397 5398typedef struct { 5399 const CXIdxAttrInfo *attrInfo; 5400 const CXIdxEntityInfo *objcClass; 5401 CXCursor classCursor; 5402 CXIdxLoc classLoc; 5403} CXIdxIBOutletCollectionAttrInfo; 5404 5405typedef enum { 5406 CXIdxDeclFlag_Skipped = 0x1 5407} CXIdxDeclInfoFlags; 5408 5409typedef struct { 5410 const CXIdxEntityInfo *entityInfo; 5411 CXCursor cursor; 5412 CXIdxLoc loc; 5413 const CXIdxContainerInfo *semanticContainer; 5414 /** 5415 * \brief Generally same as #semanticContainer but can be different in 5416 * cases like out-of-line C++ member functions. 5417 */ 5418 const CXIdxContainerInfo *lexicalContainer; 5419 int isRedeclaration; 5420 int isDefinition; 5421 int isContainer; 5422 const CXIdxContainerInfo *declAsContainer; 5423 /** 5424 * \brief Whether the declaration exists in code or was created implicitly 5425 * by the compiler, e.g. implicit objc methods for properties. 5426 */ 5427 int isImplicit; 5428 const CXIdxAttrInfo *const *attributes; 5429 unsigned numAttributes; 5430 5431 unsigned flags; 5432 5433} CXIdxDeclInfo; 5434 5435typedef enum { 5436 CXIdxObjCContainer_ForwardRef = 0, 5437 CXIdxObjCContainer_Interface = 1, 5438 CXIdxObjCContainer_Implementation = 2 5439} CXIdxObjCContainerKind; 5440 5441typedef struct { 5442 const CXIdxDeclInfo *declInfo; 5443 CXIdxObjCContainerKind kind; 5444} CXIdxObjCContainerDeclInfo; 5445 5446typedef struct { 5447 const CXIdxEntityInfo *base; 5448 CXCursor cursor; 5449 CXIdxLoc loc; 5450} CXIdxBaseClassInfo; 5451 5452typedef struct { 5453 const CXIdxEntityInfo *protocol; 5454 CXCursor cursor; 5455 CXIdxLoc loc; 5456} CXIdxObjCProtocolRefInfo; 5457 5458typedef struct { 5459 const CXIdxObjCProtocolRefInfo *const *protocols; 5460 unsigned numProtocols; 5461} CXIdxObjCProtocolRefListInfo; 5462 5463typedef struct { 5464 const CXIdxObjCContainerDeclInfo *containerInfo; 5465 const CXIdxBaseClassInfo *superInfo; 5466 const CXIdxObjCProtocolRefListInfo *protocols; 5467} CXIdxObjCInterfaceDeclInfo; 5468 5469typedef struct { 5470 const CXIdxObjCContainerDeclInfo *containerInfo; 5471 const CXIdxEntityInfo *objcClass; 5472 CXCursor classCursor; 5473 CXIdxLoc classLoc; 5474 const CXIdxObjCProtocolRefListInfo *protocols; 5475} CXIdxObjCCategoryDeclInfo; 5476 5477typedef struct { 5478 const CXIdxDeclInfo *declInfo; 5479 const CXIdxEntityInfo *getter; 5480 const CXIdxEntityInfo *setter; 5481} CXIdxObjCPropertyDeclInfo; 5482 5483typedef struct { 5484 const CXIdxDeclInfo *declInfo; 5485 const CXIdxBaseClassInfo *const *bases; 5486 unsigned numBases; 5487} CXIdxCXXClassDeclInfo; 5488 5489/** 5490 * \brief Data for IndexerCallbacks#indexEntityReference. 5491 */ 5492typedef enum { 5493 /** 5494 * \brief The entity is referenced directly in user's code. 5495 */ 5496 CXIdxEntityRef_Direct = 1, 5497 /** 5498 * \brief An implicit reference, e.g. a reference of an ObjC method via the 5499 * dot syntax. 5500 */ 5501 CXIdxEntityRef_Implicit = 2 5502} CXIdxEntityRefKind; 5503 5504/** 5505 * \brief Data for IndexerCallbacks#indexEntityReference. 5506 */ 5507typedef struct { 5508 CXIdxEntityRefKind kind; 5509 /** 5510 * \brief Reference cursor. 5511 */ 5512 CXCursor cursor; 5513 CXIdxLoc loc; 5514 /** 5515 * \brief The entity that gets referenced. 5516 */ 5517 const CXIdxEntityInfo *referencedEntity; 5518 /** 5519 * \brief Immediate "parent" of the reference. For example: 5520 * 5521 * \code 5522 * Foo *var; 5523 * \endcode 5524 * 5525 * The parent of reference of type 'Foo' is the variable 'var'. 5526 * For references inside statement bodies of functions/methods, 5527 * the parentEntity will be the function/method. 5528 */ 5529 const CXIdxEntityInfo *parentEntity; 5530 /** 5531 * \brief Lexical container context of the reference. 5532 */ 5533 const CXIdxContainerInfo *container; 5534} CXIdxEntityRefInfo; 5535 5536/** 5537 * \brief A group of callbacks used by #clang_indexSourceFile and 5538 * #clang_indexTranslationUnit. 5539 */ 5540typedef struct { 5541 /** 5542 * \brief Called periodically to check whether indexing should be aborted. 5543 * Should return 0 to continue, and non-zero to abort. 5544 */ 5545 int (*abortQuery)(CXClientData client_data, void *reserved); 5546 5547 /** 5548 * \brief Called at the end of indexing; passes the complete diagnostic set. 5549 */ 5550 void (*diagnostic)(CXClientData client_data, 5551 CXDiagnosticSet, void *reserved); 5552 5553 CXIdxClientFile (*enteredMainFile)(CXClientData client_data, 5554 CXFile mainFile, void *reserved); 5555 5556 /** 5557 * \brief Called when a file gets \#included/\#imported. 5558 */ 5559 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data, 5560 const CXIdxIncludedFileInfo *); 5561 5562 /** 5563 * \brief Called when a AST file (PCH or module) gets imported. 5564 * 5565 * AST files will not get indexed (there will not be callbacks to index all 5566 * the entities in an AST file). The recommended action is that, if the AST 5567 * file is not already indexed, to initiate a new indexing job specific to 5568 * the AST file. 5569 */ 5570 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data, 5571 const CXIdxImportedASTFileInfo *); 5572 5573 /** 5574 * \brief Called at the beginning of indexing a translation unit. 5575 */ 5576 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data, 5577 void *reserved); 5578 5579 void (*indexDeclaration)(CXClientData client_data, 5580 const CXIdxDeclInfo *); 5581 5582 /** 5583 * \brief Called to index a reference of an entity. 5584 */ 5585 void (*indexEntityReference)(CXClientData client_data, 5586 const CXIdxEntityRefInfo *); 5587 5588} IndexerCallbacks; 5589 5590CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind); 5591CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo * 5592clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *); 5593 5594CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo * 5595clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *); 5596 5597CINDEX_LINKAGE 5598const CXIdxObjCCategoryDeclInfo * 5599clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *); 5600 5601CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo * 5602clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *); 5603 5604CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo * 5605clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *); 5606 5607CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo * 5608clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *); 5609 5610CINDEX_LINKAGE const CXIdxCXXClassDeclInfo * 5611clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *); 5612 5613/** 5614 * \brief For retrieving a custom CXIdxClientContainer attached to a 5615 * container. 5616 */ 5617CINDEX_LINKAGE CXIdxClientContainer 5618clang_index_getClientContainer(const CXIdxContainerInfo *); 5619 5620/** 5621 * \brief For setting a custom CXIdxClientContainer attached to a 5622 * container. 5623 */ 5624CINDEX_LINKAGE void 5625clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer); 5626 5627/** 5628 * \brief For retrieving a custom CXIdxClientEntity attached to an entity. 5629 */ 5630CINDEX_LINKAGE CXIdxClientEntity 5631clang_index_getClientEntity(const CXIdxEntityInfo *); 5632 5633/** 5634 * \brief For setting a custom CXIdxClientEntity attached to an entity. 5635 */ 5636CINDEX_LINKAGE void 5637clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity); 5638 5639/** 5640 * \brief An indexing action/session, to be applied to one or multiple 5641 * translation units. 5642 */ 5643typedef void *CXIndexAction; 5644 5645/** 5646 * \brief An indexing action/session, to be applied to one or multiple 5647 * translation units. 5648 * 5649 * \param CIdx The index object with which the index action will be associated. 5650 */ 5651CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx); 5652 5653/** 5654 * \brief Destroy the given index action. 5655 * 5656 * The index action must not be destroyed until all of the translation units 5657 * created within that index action have been destroyed. 5658 */ 5659CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction); 5660 5661typedef enum { 5662 /** 5663 * \brief Used to indicate that no special indexing options are needed. 5664 */ 5665 CXIndexOpt_None = 0x0, 5666 5667 /** 5668 * \brief Used to indicate that IndexerCallbacks#indexEntityReference should 5669 * be invoked for only one reference of an entity per source file that does 5670 * not also include a declaration/definition of the entity. 5671 */ 5672 CXIndexOpt_SuppressRedundantRefs = 0x1, 5673 5674 /** 5675 * \brief Function-local symbols should be indexed. If this is not set 5676 * function-local symbols will be ignored. 5677 */ 5678 CXIndexOpt_IndexFunctionLocalSymbols = 0x2, 5679 5680 /** 5681 * \brief Implicit function/class template instantiations should be indexed. 5682 * If this is not set, implicit instantiations will be ignored. 5683 */ 5684 CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4, 5685 5686 /** 5687 * \brief Suppress all compiler warnings when parsing for indexing. 5688 */ 5689 CXIndexOpt_SuppressWarnings = 0x8, 5690 5691 /** 5692 * \brief Skip a function/method body that was already parsed during an 5693 * indexing session assosiated with a \c CXIndexAction object. 5694 * Bodies in system headers are always skipped. 5695 */ 5696 CXIndexOpt_SkipParsedBodiesInSession = 0x10 5697 5698} CXIndexOptFlags; 5699 5700/** 5701 * \brief Index the given source file and the translation unit corresponding 5702 * to that file via callbacks implemented through #IndexerCallbacks. 5703 * 5704 * \param client_data pointer data supplied by the client, which will 5705 * be passed to the invoked callbacks. 5706 * 5707 * \param index_callbacks Pointer to indexing callbacks that the client 5708 * implements. 5709 * 5710 * \param index_callbacks_size Size of #IndexerCallbacks structure that gets 5711 * passed in index_callbacks. 5712 * 5713 * \param index_options A bitmask of options that affects how indexing is 5714 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags. 5715 * 5716 * \param out_TU [out] pointer to store a CXTranslationUnit that can be reused 5717 * after indexing is finished. Set to NULL if you do not require it. 5718 * 5719 * \returns If there is a failure from which the there is no recovery, returns 5720 * non-zero, otherwise returns 0. 5721 * 5722 * The rest of the parameters are the same as #clang_parseTranslationUnit. 5723 */ 5724CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction, 5725 CXClientData client_data, 5726 IndexerCallbacks *index_callbacks, 5727 unsigned index_callbacks_size, 5728 unsigned index_options, 5729 const char *source_filename, 5730 const char * const *command_line_args, 5731 int num_command_line_args, 5732 struct CXUnsavedFile *unsaved_files, 5733 unsigned num_unsaved_files, 5734 CXTranslationUnit *out_TU, 5735 unsigned TU_options); 5736 5737/** 5738 * \brief Index the given translation unit via callbacks implemented through 5739 * #IndexerCallbacks. 5740 * 5741 * The order of callback invocations is not guaranteed to be the same as 5742 * when indexing a source file. The high level order will be: 5743 * 5744 * -Preprocessor callbacks invocations 5745 * -Declaration/reference callbacks invocations 5746 * -Diagnostic callback invocations 5747 * 5748 * The parameters are the same as #clang_indexSourceFile. 5749 * 5750 * \returns If there is a failure from which the there is no recovery, returns 5751 * non-zero, otherwise returns 0. 5752 */ 5753CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction, 5754 CXClientData client_data, 5755 IndexerCallbacks *index_callbacks, 5756 unsigned index_callbacks_size, 5757 unsigned index_options, 5758 CXTranslationUnit); 5759 5760/** 5761 * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by 5762 * the given CXIdxLoc. 5763 * 5764 * If the location refers into a macro expansion, retrieves the 5765 * location of the macro expansion and if it refers into a macro argument 5766 * retrieves the location of the argument. 5767 */ 5768CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc, 5769 CXIdxClientFile *indexFile, 5770 CXFile *file, 5771 unsigned *line, 5772 unsigned *column, 5773 unsigned *offset); 5774 5775/** 5776 * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc. 5777 */ 5778CINDEX_LINKAGE 5779CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc); 5780 5781/** 5782 * @} 5783 */ 5784 5785/** 5786 * @} 5787 */ 5788 5789#ifdef __cplusplus 5790} 5791#endif 5792#endif 5793 5794