contrib/llvm/tools/clang/include/clang-c/Index.h

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