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