clang API Documentation

Index.h
Go to the documentation of this file.
00001 /*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\
00002 |*                                                                            *|
00003 |*                     The LLVM Compiler Infrastructure                       *|
00004 |*                                                                            *|
00005 |* This file is distributed under the University of Illinois Open Source      *|
00006 |* License. See LICENSE.TXT for details.                                      *|
00007 |*                                                                            *|
00008 |*===----------------------------------------------------------------------===*|
00009 |*                                                                            *|
00010 |* This header provides a public inferface to a Clang library for extracting  *|
00011 |* high-level symbol information from source files without exposing the full  *|
00012 |* Clang C++ API.                                                             *|
00013 |*                                                                            *|
00014 \*===----------------------------------------------------------------------===*/
00015 
00016 #ifndef LLVM_CLANG_C_INDEX_H
00017 #define LLVM_CLANG_C_INDEX_H
00018 
00019 #include <time.h>
00020 
00021 #include "clang-c/Platform.h"
00022 #include "clang-c/CXErrorCode.h"
00023 #include "clang-c/CXString.h"
00024 #include "clang-c/BuildSystem.h"
00025 
00026 /**
00027  * \brief The version constants for the libclang API.
00028  * CINDEX_VERSION_MINOR should increase when there are API additions.
00029  * CINDEX_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
00030  *
00031  * The policy about the libclang API was always to keep it source and ABI
00032  * compatible, thus CINDEX_VERSION_MAJOR is expected to remain stable.
00033  */
00034 #define CINDEX_VERSION_MAJOR 0
00035 #define CINDEX_VERSION_MINOR 28
00036 
00037 #define CINDEX_VERSION_ENCODE(major, minor) ( \
00038       ((major) * 10000)                       \
00039     + ((minor) *     1))
00040 
00041 #define CINDEX_VERSION CINDEX_VERSION_ENCODE( \
00042     CINDEX_VERSION_MAJOR,                     \
00043     CINDEX_VERSION_MINOR )
00044 
00045 #define CINDEX_VERSION_STRINGIZE_(major, minor)   \
00046     #major"."#minor
00047 #define CINDEX_VERSION_STRINGIZE(major, minor)    \
00048     CINDEX_VERSION_STRINGIZE_(major, minor)
00049 
00050 #define CINDEX_VERSION_STRING CINDEX_VERSION_STRINGIZE( \
00051     CINDEX_VERSION_MAJOR,                               \
00052     CINDEX_VERSION_MINOR)
00053 
00054 #ifdef __cplusplus
00055 extern "C" {
00056 #endif
00057 
00058 /** \defgroup CINDEX libclang: C Interface to Clang
00059  *
00060  * The C Interface to Clang provides a relatively small API that exposes
00061  * facilities for parsing source code into an abstract syntax tree (AST),
00062  * loading already-parsed ASTs, traversing the AST, associating
00063  * physical source locations with elements within the AST, and other
00064  * facilities that support Clang-based development tools.
00065  *
00066  * This C interface to Clang will never provide all of the information
00067  * representation stored in Clang's C++ AST, nor should it: the intent is to
00068  * maintain an API that is relatively stable from one release to the next,
00069  * providing only the basic functionality needed to support development tools.
00070  *
00071  * To avoid namespace pollution, data types are prefixed with "CX" and
00072  * functions are prefixed with "clang_".
00073  *
00074  * @{
00075  */
00076 
00077 /**
00078  * \brief An "index" that consists of a set of translation units that would
00079  * typically be linked together into an executable or library.
00080  */
00081 typedef void *CXIndex;
00082 
00083 /**
00084  * \brief A single translation unit, which resides in an index.
00085  */
00086 typedef struct CXTranslationUnitImpl *CXTranslationUnit;
00087 
00088 /**
00089  * \brief Opaque pointer representing client data that will be passed through
00090  * to various callbacks and visitors.
00091  */
00092 typedef void *CXClientData;
00093 
00094 /**
00095  * \brief Provides the contents of a file that has not yet been saved to disk.
00096  *
00097  * Each CXUnsavedFile instance provides the name of a file on the
00098  * system along with the current contents of that file that have not
00099  * yet been saved to disk.
00100  */
00101 struct CXUnsavedFile {
00102   /**
00103    * \brief The file whose contents have not yet been saved.
00104    *
00105    * This file must already exist in the file system.
00106    */
00107   const char *Filename;
00108 
00109   /**
00110    * \brief A buffer containing the unsaved contents of this file.
00111    */
00112   const char *Contents;
00113 
00114   /**
00115    * \brief The length of the unsaved contents of this buffer.
00116    */
00117   unsigned long Length;
00118 };
00119 
00120 /**
00121  * \brief Describes the availability of a particular entity, which indicates
00122  * whether the use of this entity will result in a warning or error due to
00123  * it being deprecated or unavailable.
00124  */
00125 enum CXAvailabilityKind {
00126   /**
00127    * \brief The entity is available.
00128    */
00129   CXAvailability_Available,
00130   /**
00131    * \brief The entity is available, but has been deprecated (and its use is
00132    * not recommended).
00133    */
00134   CXAvailability_Deprecated,
00135   /**
00136    * \brief The entity is not available; any use of it will be an error.
00137    */
00138   CXAvailability_NotAvailable,
00139   /**
00140    * \brief The entity is available, but not accessible; any use of it will be
00141    * an error.
00142    */
00143   CXAvailability_NotAccessible
00144 };
00145 
00146 /**
00147  * \brief Describes a version number of the form major.minor.subminor.
00148  */
00149 typedef struct CXVersion {
00150   /**
00151    * \brief The major version number, e.g., the '10' in '10.7.3'. A negative
00152    * value indicates that there is no version number at all.
00153    */
00154   int Major;
00155   /**
00156    * \brief The minor version number, e.g., the '7' in '10.7.3'. This value
00157    * will be negative if no minor version number was provided, e.g., for 
00158    * version '10'.
00159    */
00160   int Minor;
00161   /**
00162    * \brief The subminor version number, e.g., the '3' in '10.7.3'. This value
00163    * will be negative if no minor or subminor version number was provided,
00164    * e.g., in version '10' or '10.7'.
00165    */
00166   int Subminor;
00167 } CXVersion;
00168   
00169 /**
00170  * \brief Provides a shared context for creating translation units.
00171  *
00172  * It provides two options:
00173  *
00174  * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
00175  * declarations (when loading any new translation units). A "local" declaration
00176  * is one that belongs in the translation unit itself and not in a precompiled
00177  * header that was used by the translation unit. If zero, all declarations
00178  * will be enumerated.
00179  *
00180  * Here is an example:
00181  *
00182  * \code
00183  *   // excludeDeclsFromPCH = 1, displayDiagnostics=1
00184  *   Idx = clang_createIndex(1, 1);
00185  *
00186  *   // IndexTest.pch was produced with the following command:
00187  *   // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
00188  *   TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
00189  *
00190  *   // This will load all the symbols from 'IndexTest.pch'
00191  *   clang_visitChildren(clang_getTranslationUnitCursor(TU),
00192  *                       TranslationUnitVisitor, 0);
00193  *   clang_disposeTranslationUnit(TU);
00194  *
00195  *   // This will load all the symbols from 'IndexTest.c', excluding symbols
00196  *   // from 'IndexTest.pch'.
00197  *   char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
00198  *   TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
00199  *                                                  0, 0);
00200  *   clang_visitChildren(clang_getTranslationUnitCursor(TU),
00201  *                       TranslationUnitVisitor, 0);
00202  *   clang_disposeTranslationUnit(TU);
00203  * \endcode
00204  *
00205  * This process of creating the 'pch', loading it separately, and using it (via
00206  * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
00207  * (which gives the indexer the same performance benefit as the compiler).
00208  */
00209 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
00210                                          int displayDiagnostics);
00211 
00212 /**
00213  * \brief Destroy the given index.
00214  *
00215  * The index must not be destroyed until all of the translation units created
00216  * within that index have been destroyed.
00217  */
00218 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
00219 
00220 typedef enum {
00221   /**
00222    * \brief Used to indicate that no special CXIndex options are needed.
00223    */
00224   CXGlobalOpt_None = 0x0,
00225 
00226   /**
00227    * \brief Used to indicate that threads that libclang creates for indexing
00228    * purposes should use background priority.
00229    *
00230    * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
00231    * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
00232    */
00233   CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1,
00234 
00235   /**
00236    * \brief Used to indicate that threads that libclang creates for editing
00237    * purposes should use background priority.
00238    *
00239    * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
00240    * #clang_annotateTokens
00241    */
00242   CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2,
00243 
00244   /**
00245    * \brief Used to indicate that all threads that libclang creates should use
00246    * background priority.
00247    */
00248   CXGlobalOpt_ThreadBackgroundPriorityForAll =
00249       CXGlobalOpt_ThreadBackgroundPriorityForIndexing |
00250       CXGlobalOpt_ThreadBackgroundPriorityForEditing
00251 
00252 } CXGlobalOptFlags;
00253 
00254 /**
00255  * \brief Sets general options associated with a CXIndex.
00256  *
00257  * For example:
00258  * \code
00259  * CXIndex idx = ...;
00260  * clang_CXIndex_setGlobalOptions(idx,
00261  *     clang_CXIndex_getGlobalOptions(idx) |
00262  *     CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
00263  * \endcode
00264  *
00265  * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
00266  */
00267 CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
00268 
00269 /**
00270  * \brief Gets the general options associated with a CXIndex.
00271  *
00272  * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
00273  * are associated with the given CXIndex object.
00274  */
00275 CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex);
00276 
00277 /**
00278  * \defgroup CINDEX_FILES File manipulation routines
00279  *
00280  * @{
00281  */
00282 
00283 /**
00284  * \brief A particular source file that is part of a translation unit.
00285  */
00286 typedef void *CXFile;
00287 
00288 
00289 /**
00290  * \brief Retrieve the complete file and path name of the given file.
00291  */
00292 CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
00293 
00294 /**
00295  * \brief Retrieve the last modification time of the given file.
00296  */
00297 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
00298 
00299 /**
00300  * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
00301  * across an indexing session.
00302  */
00303 typedef struct {
00304   unsigned long long data[3];
00305 } CXFileUniqueID;
00306 
00307 /**
00308  * \brief Retrieve the unique ID for the given \c file.
00309  *
00310  * \param file the file to get the ID for.
00311  * \param outID stores the returned CXFileUniqueID.
00312  * \returns If there was a failure getting the unique ID, returns non-zero,
00313  * otherwise returns 0.
00314 */
00315 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
00316 
00317 /**
00318  * \brief Determine whether the given header is guarded against
00319  * multiple inclusions, either with the conventional
00320  * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
00321  */
00322 CINDEX_LINKAGE unsigned 
00323 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
00324 
00325 /**
00326  * \brief Retrieve a file handle within the given translation unit.
00327  *
00328  * \param tu the translation unit
00329  *
00330  * \param file_name the name of the file.
00331  *
00332  * \returns the file handle for the named file in the translation unit \p tu,
00333  * or a NULL file handle if the file was not a part of this translation unit.
00334  */
00335 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
00336                                     const char *file_name);
00337 
00338 /**
00339  * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
00340  * or they are both NULL.
00341  */
00342 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
00343 
00344 /**
00345  * @}
00346  */
00347 
00348 /**
00349  * \defgroup CINDEX_LOCATIONS Physical source locations
00350  *
00351  * Clang represents physical source locations in its abstract syntax tree in
00352  * great detail, with file, line, and column information for the majority of
00353  * the tokens parsed in the source code. These data types and functions are
00354  * used to represent source location information, either for a particular
00355  * point in the program or for a range of points in the program, and extract
00356  * specific location information from those data types.
00357  *
00358  * @{
00359  */
00360 
00361 /**
00362  * \brief Identifies a specific source location within a translation
00363  * unit.
00364  *
00365  * Use clang_getExpansionLocation() or clang_getSpellingLocation()
00366  * to map a source location to a particular file, line, and column.
00367  */
00368 typedef struct {
00369   const void *ptr_data[2];
00370   unsigned int_data;
00371 } CXSourceLocation;
00372 
00373 /**
00374  * \brief Identifies a half-open character range in the source code.
00375  *
00376  * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
00377  * starting and end locations from a source range, respectively.
00378  */
00379 typedef struct {
00380   const void *ptr_data[2];
00381   unsigned begin_int_data;
00382   unsigned end_int_data;
00383 } CXSourceRange;
00384 
00385 /**
00386  * \brief Retrieve a NULL (invalid) source location.
00387  */
00388 CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(void);
00389 
00390 /**
00391  * \brief Determine whether two source locations, which must refer into
00392  * the same translation unit, refer to exactly the same point in the source
00393  * code.
00394  *
00395  * \returns non-zero if the source locations refer to the same location, zero
00396  * if they refer to different locations.
00397  */
00398 CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
00399                                              CXSourceLocation loc2);
00400 
00401 /**
00402  * \brief Retrieves the source location associated with a given file/line/column
00403  * in a particular translation unit.
00404  */
00405 CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
00406                                                   CXFile file,
00407                                                   unsigned line,
00408                                                   unsigned column);
00409 /**
00410  * \brief Retrieves the source location associated with a given character offset
00411  * in a particular translation unit.
00412  */
00413 CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
00414                                                            CXFile file,
00415                                                            unsigned offset);
00416 
00417 /**
00418  * \brief Returns non-zero if the given source location is in a system header.
00419  */
00420 CINDEX_LINKAGE int clang_Location_isInSystemHeader(CXSourceLocation location);
00421 
00422 /**
00423  * \brief Returns non-zero if the given source location is in the main file of
00424  * the corresponding translation unit.
00425  */
00426 CINDEX_LINKAGE int clang_Location_isFromMainFile(CXSourceLocation location);
00427 
00428 /**
00429  * \brief Retrieve a NULL (invalid) source range.
00430  */
00431 CINDEX_LINKAGE CXSourceRange clang_getNullRange(void);
00432 
00433 /**
00434  * \brief Retrieve a source range given the beginning and ending source
00435  * locations.
00436  */
00437 CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
00438                                             CXSourceLocation end);
00439 
00440 /**
00441  * \brief Determine whether two ranges are equivalent.
00442  *
00443  * \returns non-zero if the ranges are the same, zero if they differ.
00444  */
00445 CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
00446                                           CXSourceRange range2);
00447 
00448 /**
00449  * \brief Returns non-zero if \p range is null.
00450  */
00451 CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
00452 
00453 /**
00454  * \brief Retrieve the file, line, column, and offset represented by
00455  * the given source location.
00456  *
00457  * If the location refers into a macro expansion, retrieves the
00458  * location of the macro expansion.
00459  *
00460  * \param location the location within a source file that will be decomposed
00461  * into its parts.
00462  *
00463  * \param file [out] if non-NULL, will be set to the file to which the given
00464  * source location points.
00465  *
00466  * \param line [out] if non-NULL, will be set to the line to which the given
00467  * source location points.
00468  *
00469  * \param column [out] if non-NULL, will be set to the column to which the given
00470  * source location points.
00471  *
00472  * \param offset [out] if non-NULL, will be set to the offset into the
00473  * buffer to which the given source location points.
00474  */
00475 CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location,
00476                                                CXFile *file,
00477                                                unsigned *line,
00478                                                unsigned *column,
00479                                                unsigned *offset);
00480 
00481 /**
00482  * \brief Retrieve the file, line, column, and offset represented by
00483  * the given source location, as specified in a # line directive.
00484  *
00485  * Example: given the following source code in a file somefile.c
00486  *
00487  * \code
00488  * #123 "dummy.c" 1
00489  *
00490  * static int func(void)
00491  * {
00492  *     return 0;
00493  * }
00494  * \endcode
00495  *
00496  * the location information returned by this function would be
00497  *
00498  * File: dummy.c Line: 124 Column: 12
00499  *
00500  * whereas clang_getExpansionLocation would have returned
00501  *
00502  * File: somefile.c Line: 3 Column: 12
00503  *
00504  * \param location the location within a source file that will be decomposed
00505  * into its parts.
00506  *
00507  * \param filename [out] if non-NULL, will be set to the filename of the
00508  * source location. Note that filenames returned will be for "virtual" files,
00509  * which don't necessarily exist on the machine running clang - e.g. when
00510  * parsing preprocessed output obtained from a different environment. If
00511  * a non-NULL value is passed in, remember to dispose of the returned value
00512  * using \c clang_disposeString() once you've finished with it. For an invalid
00513  * source location, an empty string is returned.
00514  *
00515  * \param line [out] if non-NULL, will be set to the line number of the
00516  * source location. For an invalid source location, zero is returned.
00517  *
00518  * \param column [out] if non-NULL, will be set to the column number of the
00519  * source location. For an invalid source location, zero is returned.
00520  */
00521 CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location,
00522                                               CXString *filename,
00523                                               unsigned *line,
00524                                               unsigned *column);
00525 
00526 /**
00527  * \brief Legacy API to retrieve the file, line, column, and offset represented
00528  * by the given source location.
00529  *
00530  * This interface has been replaced by the newer interface
00531  * #clang_getExpansionLocation(). See that interface's documentation for
00532  * details.
00533  */
00534 CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
00535                                                    CXFile *file,
00536                                                    unsigned *line,
00537                                                    unsigned *column,
00538                                                    unsigned *offset);
00539 
00540 /**
00541  * \brief Retrieve the file, line, column, and offset represented by
00542  * the given source location.
00543  *
00544  * If the location refers into a macro instantiation, return where the
00545  * location was originally spelled in the source file.
00546  *
00547  * \param location the location within a source file that will be decomposed
00548  * into its parts.
00549  *
00550  * \param file [out] if non-NULL, will be set to the file to which the given
00551  * source location points.
00552  *
00553  * \param line [out] if non-NULL, will be set to the line to which the given
00554  * source location points.
00555  *
00556  * \param column [out] if non-NULL, will be set to the column to which the given
00557  * source location points.
00558  *
00559  * \param offset [out] if non-NULL, will be set to the offset into the
00560  * buffer to which the given source location points.
00561  */
00562 CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
00563                                               CXFile *file,
00564                                               unsigned *line,
00565                                               unsigned *column,
00566                                               unsigned *offset);
00567 
00568 /**
00569  * \brief Retrieve the file, line, column, and offset represented by
00570  * the given source location.
00571  *
00572  * If the location refers into a macro expansion, return where the macro was
00573  * expanded or where the macro argument was written, if the location points at
00574  * a macro argument.
00575  *
00576  * \param location the location within a source file that will be decomposed
00577  * into its parts.
00578  *
00579  * \param file [out] if non-NULL, will be set to the file to which the given
00580  * source location points.
00581  *
00582  * \param line [out] if non-NULL, will be set to the line to which the given
00583  * source location points.
00584  *
00585  * \param column [out] if non-NULL, will be set to the column to which the given
00586  * source location points.
00587  *
00588  * \param offset [out] if non-NULL, will be set to the offset into the
00589  * buffer to which the given source location points.
00590  */
00591 CINDEX_LINKAGE void clang_getFileLocation(CXSourceLocation location,
00592                                           CXFile *file,
00593                                           unsigned *line,
00594                                           unsigned *column,
00595                                           unsigned *offset);
00596 
00597 /**
00598  * \brief Retrieve a source location representing the first character within a
00599  * source range.
00600  */
00601 CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
00602 
00603 /**
00604  * \brief Retrieve a source location representing the last character within a
00605  * source range.
00606  */
00607 CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
00608 
00609 /**
00610  * \brief Identifies an array of ranges.
00611  */
00612 typedef struct {
00613   /** \brief The number of ranges in the \c ranges array. */
00614   unsigned count;
00615   /**
00616    * \brief An array of \c CXSourceRanges.
00617    */
00618   CXSourceRange *ranges;
00619 } CXSourceRangeList;
00620 
00621 /**
00622  * \brief Retrieve all ranges that were skipped by the preprocessor.
00623  *
00624  * The preprocessor will skip lines when they are surrounded by an
00625  * if/ifdef/ifndef directive whose condition does not evaluate to true.
00626  */
00627 CINDEX_LINKAGE CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit tu,
00628                                                          CXFile file);
00629 
00630 /**
00631  * \brief Destroy the given \c CXSourceRangeList.
00632  */
00633 CINDEX_LINKAGE void clang_disposeSourceRangeList(CXSourceRangeList *ranges);
00634 
00635 /**
00636  * @}
00637  */
00638 
00639 /**
00640  * \defgroup CINDEX_DIAG Diagnostic reporting
00641  *
00642  * @{
00643  */
00644 
00645 /**
00646  * \brief Describes the severity of a particular diagnostic.
00647  */
00648 enum CXDiagnosticSeverity {
00649   /**
00650    * \brief A diagnostic that has been suppressed, e.g., by a command-line
00651    * option.
00652    */
00653   CXDiagnostic_Ignored = 0,
00654 
00655   /**
00656    * \brief This diagnostic is a note that should be attached to the
00657    * previous (non-note) diagnostic.
00658    */
00659   CXDiagnostic_Note    = 1,
00660 
00661   /**
00662    * \brief This diagnostic indicates suspicious code that may not be
00663    * wrong.
00664    */
00665   CXDiagnostic_Warning = 2,
00666 
00667   /**
00668    * \brief This diagnostic indicates that the code is ill-formed.
00669    */
00670   CXDiagnostic_Error   = 3,
00671 
00672   /**
00673    * \brief This diagnostic indicates that the code is ill-formed such
00674    * that future parser recovery is unlikely to produce useful
00675    * results.
00676    */
00677   CXDiagnostic_Fatal   = 4
00678 };
00679 
00680 /**
00681  * \brief A single diagnostic, containing the diagnostic's severity,
00682  * location, text, source ranges, and fix-it hints.
00683  */
00684 typedef void *CXDiagnostic;
00685 
00686 /**
00687  * \brief A group of CXDiagnostics.
00688  */
00689 typedef void *CXDiagnosticSet;
00690   
00691 /**
00692  * \brief Determine the number of diagnostics in a CXDiagnosticSet.
00693  */
00694 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
00695 
00696 /**
00697  * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
00698  *
00699  * \param Diags the CXDiagnosticSet to query.
00700  * \param Index the zero-based diagnostic number to retrieve.
00701  *
00702  * \returns the requested diagnostic. This diagnostic must be freed
00703  * via a call to \c clang_disposeDiagnostic().
00704  */
00705 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
00706                                                      unsigned Index);  
00707 
00708 
00709 /**
00710  * \brief Describes the kind of error that occurred (if any) in a call to
00711  * \c clang_loadDiagnostics.
00712  */
00713 enum CXLoadDiag_Error {
00714   /**
00715    * \brief Indicates that no error occurred.
00716    */
00717   CXLoadDiag_None = 0,
00718   
00719   /**
00720    * \brief Indicates that an unknown error occurred while attempting to
00721    * deserialize diagnostics.
00722    */
00723   CXLoadDiag_Unknown = 1,
00724   
00725   /**
00726    * \brief Indicates that the file containing the serialized diagnostics
00727    * could not be opened.
00728    */
00729   CXLoadDiag_CannotLoad = 2,
00730   
00731   /**
00732    * \brief Indicates that the serialized diagnostics file is invalid or
00733    * corrupt.
00734    */
00735   CXLoadDiag_InvalidFile = 3
00736 };
00737   
00738 /**
00739  * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
00740  * file.
00741  *
00742  * \param file The name of the file to deserialize.
00743  * \param error A pointer to a enum value recording if there was a problem
00744  *        deserializing the diagnostics.
00745  * \param errorString A pointer to a CXString for recording the error string
00746  *        if the file was not successfully loaded.
00747  *
00748  * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise.  These
00749  * diagnostics should be released using clang_disposeDiagnosticSet().
00750  */
00751 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
00752                                                   enum CXLoadDiag_Error *error,
00753                                                   CXString *errorString);
00754 
00755 /**
00756  * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
00757  */
00758 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
00759 
00760 /**
00761  * \brief Retrieve the child diagnostics of a CXDiagnostic. 
00762  *
00763  * This CXDiagnosticSet does not need to be released by
00764  * clang_disposeDiagnosticSet.
00765  */
00766 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
00767 
00768 /**
00769  * \brief Determine the number of diagnostics produced for the given
00770  * translation unit.
00771  */
00772 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
00773 
00774 /**
00775  * \brief Retrieve a diagnostic associated with the given translation unit.
00776  *
00777  * \param Unit the translation unit to query.
00778  * \param Index the zero-based diagnostic number to retrieve.
00779  *
00780  * \returns the requested diagnostic. This diagnostic must be freed
00781  * via a call to \c clang_disposeDiagnostic().
00782  */
00783 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
00784                                                 unsigned Index);
00785 
00786 /**
00787  * \brief Retrieve the complete set of diagnostics associated with a
00788  *        translation unit.
00789  *
00790  * \param Unit the translation unit to query.
00791  */
00792 CINDEX_LINKAGE CXDiagnosticSet
00793   clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);  
00794 
00795 /**
00796  * \brief Destroy a diagnostic.
00797  */
00798 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
00799 
00800 /**
00801  * \brief Options to control the display of diagnostics.
00802  *
00803  * The values in this enum are meant to be combined to customize the
00804  * behavior of \c clang_formatDiagnostic().
00805  */
00806 enum CXDiagnosticDisplayOptions {
00807   /**
00808    * \brief Display the source-location information where the
00809    * diagnostic was located.
00810    *
00811    * When set, diagnostics will be prefixed by the file, line, and
00812    * (optionally) column to which the diagnostic refers. For example,
00813    *
00814    * \code
00815    * test.c:28: warning: extra tokens at end of #endif directive
00816    * \endcode
00817    *
00818    * This option corresponds to the clang flag \c -fshow-source-location.
00819    */
00820   CXDiagnostic_DisplaySourceLocation = 0x01,
00821 
00822   /**
00823    * \brief If displaying the source-location information of the
00824    * diagnostic, also include the column number.
00825    *
00826    * This option corresponds to the clang flag \c -fshow-column.
00827    */
00828   CXDiagnostic_DisplayColumn = 0x02,
00829 
00830   /**
00831    * \brief If displaying the source-location information of the
00832    * diagnostic, also include information about source ranges in a
00833    * machine-parsable format.
00834    *
00835    * This option corresponds to the clang flag
00836    * \c -fdiagnostics-print-source-range-info.
00837    */
00838   CXDiagnostic_DisplaySourceRanges = 0x04,
00839   
00840   /**
00841    * \brief Display the option name associated with this diagnostic, if any.
00842    *
00843    * The option name displayed (e.g., -Wconversion) will be placed in brackets
00844    * after the diagnostic text. This option corresponds to the clang flag
00845    * \c -fdiagnostics-show-option.
00846    */
00847   CXDiagnostic_DisplayOption = 0x08,
00848   
00849   /**
00850    * \brief Display the category number associated with this diagnostic, if any.
00851    *
00852    * The category number is displayed within brackets after the diagnostic text.
00853    * This option corresponds to the clang flag 
00854    * \c -fdiagnostics-show-category=id.
00855    */
00856   CXDiagnostic_DisplayCategoryId = 0x10,
00857 
00858   /**
00859    * \brief Display the category name associated with this diagnostic, if any.
00860    *
00861    * The category name is displayed within brackets after the diagnostic text.
00862    * This option corresponds to the clang flag 
00863    * \c -fdiagnostics-show-category=name.
00864    */
00865   CXDiagnostic_DisplayCategoryName = 0x20
00866 };
00867 
00868 /**
00869  * \brief Format the given diagnostic in a manner that is suitable for display.
00870  *
00871  * This routine will format the given diagnostic to a string, rendering
00872  * the diagnostic according to the various options given. The
00873  * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
00874  * options that most closely mimics the behavior of the clang compiler.
00875  *
00876  * \param Diagnostic The diagnostic to print.
00877  *
00878  * \param Options A set of options that control the diagnostic display,
00879  * created by combining \c CXDiagnosticDisplayOptions values.
00880  *
00881  * \returns A new string containing for formatted diagnostic.
00882  */
00883 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
00884                                                unsigned Options);
00885 
00886 /**
00887  * \brief Retrieve the set of display options most similar to the
00888  * default behavior of the clang compiler.
00889  *
00890  * \returns A set of display options suitable for use with \c
00891  * clang_formatDiagnostic().
00892  */
00893 CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
00894 
00895 /**
00896  * \brief Determine the severity of the given diagnostic.
00897  */
00898 CINDEX_LINKAGE enum CXDiagnosticSeverity
00899 clang_getDiagnosticSeverity(CXDiagnostic);
00900 
00901 /**
00902  * \brief Retrieve the source location of the given diagnostic.
00903  *
00904  * This location is where Clang would print the caret ('^') when
00905  * displaying the diagnostic on the command line.
00906  */
00907 CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
00908 
00909 /**
00910  * \brief Retrieve the text of the given diagnostic.
00911  */
00912 CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
00913 
00914 /**
00915  * \brief Retrieve the name of the command-line option that enabled this
00916  * diagnostic.
00917  *
00918  * \param Diag The diagnostic to be queried.
00919  *
00920  * \param Disable If non-NULL, will be set to the option that disables this
00921  * diagnostic (if any).
00922  *
00923  * \returns A string that contains the command-line option used to enable this
00924  * warning, such as "-Wconversion" or "-pedantic". 
00925  */
00926 CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
00927                                                   CXString *Disable);
00928 
00929 /**
00930  * \brief Retrieve the category number for this diagnostic.
00931  *
00932  * Diagnostics can be categorized into groups along with other, related
00933  * diagnostics (e.g., diagnostics under the same warning flag). This routine 
00934  * retrieves the category number for the given diagnostic.
00935  *
00936  * \returns The number of the category that contains this diagnostic, or zero
00937  * if this diagnostic is uncategorized.
00938  */
00939 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
00940 
00941 /**
00942  * \brief Retrieve the name of a particular diagnostic category.  This
00943  *  is now deprecated.  Use clang_getDiagnosticCategoryText()
00944  *  instead.
00945  *
00946  * \param Category A diagnostic category number, as returned by 
00947  * \c clang_getDiagnosticCategory().
00948  *
00949  * \returns The name of the given diagnostic category.
00950  */
00951 CINDEX_DEPRECATED CINDEX_LINKAGE
00952 CXString clang_getDiagnosticCategoryName(unsigned Category);
00953 
00954 /**
00955  * \brief Retrieve the diagnostic category text for a given diagnostic.
00956  *
00957  * \returns The text of the given diagnostic category.
00958  */
00959 CINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic);
00960   
00961 /**
00962  * \brief Determine the number of source ranges associated with the given
00963  * diagnostic.
00964  */
00965 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
00966 
00967 /**
00968  * \brief Retrieve a source range associated with the diagnostic.
00969  *
00970  * A diagnostic's source ranges highlight important elements in the source
00971  * code. On the command line, Clang displays source ranges by
00972  * underlining them with '~' characters.
00973  *
00974  * \param Diagnostic the diagnostic whose range is being extracted.
00975  *
00976  * \param Range the zero-based index specifying which range to
00977  *
00978  * \returns the requested source range.
00979  */
00980 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
00981                                                       unsigned Range);
00982 
00983 /**
00984  * \brief Determine the number of fix-it hints associated with the
00985  * given diagnostic.
00986  */
00987 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
00988 
00989 /**
00990  * \brief Retrieve the replacement information for a given fix-it.
00991  *
00992  * Fix-its are described in terms of a source range whose contents
00993  * should be replaced by a string. This approach generalizes over
00994  * three kinds of operations: removal of source code (the range covers
00995  * the code to be removed and the replacement string is empty),
00996  * replacement of source code (the range covers the code to be
00997  * replaced and the replacement string provides the new code), and
00998  * insertion (both the start and end of the range point at the
00999  * insertion location, and the replacement string provides the text to
01000  * insert).
01001  *
01002  * \param Diagnostic The diagnostic whose fix-its are being queried.
01003  *
01004  * \param FixIt The zero-based index of the fix-it.
01005  *
01006  * \param ReplacementRange The source range whose contents will be
01007  * replaced with the returned replacement string. Note that source
01008  * ranges are half-open ranges [a, b), so the source code should be
01009  * replaced from a and up to (but not including) b.
01010  *
01011  * \returns A string containing text that should be replace the source
01012  * code indicated by the \c ReplacementRange.
01013  */
01014 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
01015                                                  unsigned FixIt,
01016                                                CXSourceRange *ReplacementRange);
01017 
01018 /**
01019  * @}
01020  */
01021 
01022 /**
01023  * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
01024  *
01025  * The routines in this group provide the ability to create and destroy
01026  * translation units from files, either by parsing the contents of the files or
01027  * by reading in a serialized representation of a translation unit.
01028  *
01029  * @{
01030  */
01031 
01032 /**
01033  * \brief Get the original translation unit source file name.
01034  */
01035 CINDEX_LINKAGE CXString
01036 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
01037 
01038 /**
01039  * \brief Return the CXTranslationUnit for a given source file and the provided
01040  * command line arguments one would pass to the compiler.
01041  *
01042  * Note: The 'source_filename' argument is optional.  If the caller provides a
01043  * NULL pointer, the name of the source file is expected to reside in the
01044  * specified command line arguments.
01045  *
01046  * Note: When encountered in 'clang_command_line_args', the following options
01047  * are ignored:
01048  *
01049  *   '-c'
01050  *   '-emit-ast'
01051  *   '-fsyntax-only'
01052  *   '-o <output file>'  (both '-o' and '<output file>' are ignored)
01053  *
01054  * \param CIdx The index object with which the translation unit will be
01055  * associated.
01056  *
01057  * \param source_filename The name of the source file to load, or NULL if the
01058  * source file is included in \p clang_command_line_args.
01059  *
01060  * \param num_clang_command_line_args The number of command-line arguments in
01061  * \p clang_command_line_args.
01062  *
01063  * \param clang_command_line_args The command-line arguments that would be
01064  * passed to the \c clang executable if it were being invoked out-of-process.
01065  * These command-line options will be parsed and will affect how the translation
01066  * unit is parsed. Note that the following options are ignored: '-c',
01067  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
01068  *
01069  * \param num_unsaved_files the number of unsaved file entries in \p
01070  * unsaved_files.
01071  *
01072  * \param unsaved_files the files that have not yet been saved to disk
01073  * but may be required for code completion, including the contents of
01074  * those files.  The contents and name of these files (as specified by
01075  * CXUnsavedFile) are copied when necessary, so the client only needs to
01076  * guarantee their validity until the call to this function returns.
01077  */
01078 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
01079                                          CXIndex CIdx,
01080                                          const char *source_filename,
01081                                          int num_clang_command_line_args,
01082                                    const char * const *clang_command_line_args,
01083                                          unsigned num_unsaved_files,
01084                                          struct CXUnsavedFile *unsaved_files);
01085 
01086 /**
01087  * \brief Same as \c clang_createTranslationUnit2, but returns
01088  * the \c CXTranslationUnit instead of an error code.  In case of an error this
01089  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
01090  * error codes.
01091  */
01092 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(
01093     CXIndex CIdx,
01094     const char *ast_filename);
01095 
01096 /**
01097  * \brief Create a translation unit from an AST file (\c -emit-ast).
01098  *
01099  * \param[out] out_TU A non-NULL pointer to store the created
01100  * \c CXTranslationUnit.
01101  *
01102  * \returns Zero on success, otherwise returns an error code.
01103  */
01104 CINDEX_LINKAGE enum CXErrorCode clang_createTranslationUnit2(
01105     CXIndex CIdx,
01106     const char *ast_filename,
01107     CXTranslationUnit *out_TU);
01108 
01109 /**
01110  * \brief Flags that control the creation of translation units.
01111  *
01112  * The enumerators in this enumeration type are meant to be bitwise
01113  * ORed together to specify which options should be used when
01114  * constructing the translation unit.
01115  */
01116 enum CXTranslationUnit_Flags {
01117   /**
01118    * \brief Used to indicate that no special translation-unit options are
01119    * needed.
01120    */
01121   CXTranslationUnit_None = 0x0,
01122 
01123   /**
01124    * \brief Used to indicate that the parser should construct a "detailed"
01125    * preprocessing record, including all macro definitions and instantiations.
01126    *
01127    * Constructing a detailed preprocessing record requires more memory
01128    * and time to parse, since the information contained in the record
01129    * is usually not retained. However, it can be useful for
01130    * applications that require more detailed information about the
01131    * behavior of the preprocessor.
01132    */
01133   CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
01134 
01135   /**
01136    * \brief Used to indicate that the translation unit is incomplete.
01137    *
01138    * When a translation unit is considered "incomplete", semantic
01139    * analysis that is typically performed at the end of the
01140    * translation unit will be suppressed. For example, this suppresses
01141    * the completion of tentative declarations in C and of
01142    * instantiation of implicitly-instantiation function templates in
01143    * C++. This option is typically used when parsing a header with the
01144    * intent of producing a precompiled header.
01145    */
01146   CXTranslationUnit_Incomplete = 0x02,
01147   
01148   /**
01149    * \brief Used to indicate that the translation unit should be built with an 
01150    * implicit precompiled header for the preamble.
01151    *
01152    * An implicit precompiled header is used as an optimization when a
01153    * particular translation unit is likely to be reparsed many times
01154    * when the sources aren't changing that often. In this case, an
01155    * implicit precompiled header will be built containing all of the
01156    * initial includes at the top of the main file (what we refer to as
01157    * the "preamble" of the file). In subsequent parses, if the
01158    * preamble or the files in it have not changed, \c
01159    * clang_reparseTranslationUnit() will re-use the implicit
01160    * precompiled header to improve parsing performance.
01161    */
01162   CXTranslationUnit_PrecompiledPreamble = 0x04,
01163   
01164   /**
01165    * \brief Used to indicate that the translation unit should cache some
01166    * code-completion results with each reparse of the source file.
01167    *
01168    * Caching of code-completion results is a performance optimization that
01169    * introduces some overhead to reparsing but improves the performance of
01170    * code-completion operations.
01171    */
01172   CXTranslationUnit_CacheCompletionResults = 0x08,
01173 
01174   /**
01175    * \brief Used to indicate that the translation unit will be serialized with
01176    * \c clang_saveTranslationUnit.
01177    *
01178    * This option is typically used when parsing a header with the intent of
01179    * producing a precompiled header.
01180    */
01181   CXTranslationUnit_ForSerialization = 0x10,
01182 
01183   /**
01184    * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
01185    *
01186    * Note: this is a *temporary* option that is available only while
01187    * we are testing C++ precompiled preamble support. It is deprecated.
01188    */
01189   CXTranslationUnit_CXXChainedPCH = 0x20,
01190 
01191   /**
01192    * \brief Used to indicate that function/method bodies should be skipped while
01193    * parsing.
01194    *
01195    * This option can be used to search for declarations/definitions while
01196    * ignoring the usages.
01197    */
01198   CXTranslationUnit_SkipFunctionBodies = 0x40,
01199 
01200   /**
01201    * \brief Used to indicate that brief documentation comments should be
01202    * included into the set of code completions returned from this translation
01203    * unit.
01204    */
01205   CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80
01206 };
01207 
01208 /**
01209  * \brief Returns the set of flags that is suitable for parsing a translation
01210  * unit that is being edited.
01211  *
01212  * The set of flags returned provide options for \c clang_parseTranslationUnit()
01213  * to indicate that the translation unit is likely to be reparsed many times,
01214  * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
01215  * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
01216  * set contains an unspecified set of optimizations (e.g., the precompiled 
01217  * preamble) geared toward improving the performance of these routines. The
01218  * set of optimizations enabled may change from one version to the next.
01219  */
01220 CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
01221 
01222 /**
01223  * \brief Same as \c clang_parseTranslationUnit2, but returns
01224  * the \c CXTranslationUnit instead of an error code.  In case of an error this
01225  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
01226  * error codes.
01227  */
01228 CINDEX_LINKAGE CXTranslationUnit
01229 clang_parseTranslationUnit(CXIndex CIdx,
01230                            const char *source_filename,
01231                            const char *const *command_line_args,
01232                            int num_command_line_args,
01233                            struct CXUnsavedFile *unsaved_files,
01234                            unsigned num_unsaved_files,
01235                            unsigned options);
01236 
01237 /**
01238  * \brief Parse the given source file and the translation unit corresponding
01239  * to that file.
01240  *
01241  * This routine is the main entry point for the Clang C API, providing the
01242  * ability to parse a source file into a translation unit that can then be
01243  * queried by other functions in the API. This routine accepts a set of
01244  * command-line arguments so that the compilation can be configured in the same
01245  * way that the compiler is configured on the command line.
01246  *
01247  * \param CIdx The index object with which the translation unit will be 
01248  * associated.
01249  *
01250  * \param source_filename The name of the source file to load, or NULL if the
01251  * source file is included in \c command_line_args.
01252  *
01253  * \param command_line_args The command-line arguments that would be
01254  * passed to the \c clang executable if it were being invoked out-of-process.
01255  * These command-line options will be parsed and will affect how the translation
01256  * unit is parsed. Note that the following options are ignored: '-c', 
01257  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
01258  *
01259  * \param num_command_line_args The number of command-line arguments in
01260  * \c command_line_args.
01261  *
01262  * \param unsaved_files the files that have not yet been saved to disk
01263  * but may be required for parsing, including the contents of
01264  * those files.  The contents and name of these files (as specified by
01265  * CXUnsavedFile) are copied when necessary, so the client only needs to
01266  * guarantee their validity until the call to this function returns.
01267  *
01268  * \param num_unsaved_files the number of unsaved file entries in \p
01269  * unsaved_files.
01270  *
01271  * \param options A bitmask of options that affects how the translation unit
01272  * is managed but not its compilation. This should be a bitwise OR of the
01273  * CXTranslationUnit_XXX flags.
01274  *
01275  * \param[out] out_TU A non-NULL pointer to store the created
01276  * \c CXTranslationUnit, describing the parsed code and containing any
01277  * diagnostics produced by the compiler.
01278  *
01279  * \returns Zero on success, otherwise returns an error code.
01280  */
01281 CINDEX_LINKAGE enum CXErrorCode
01282 clang_parseTranslationUnit2(CXIndex CIdx,
01283                             const char *source_filename,
01284                             const char *const *command_line_args,
01285                             int num_command_line_args,
01286                             struct CXUnsavedFile *unsaved_files,
01287                             unsigned num_unsaved_files,
01288                             unsigned options,
01289                             CXTranslationUnit *out_TU);
01290 
01291 /**
01292  * \brief Flags that control how translation units are saved.
01293  *
01294  * The enumerators in this enumeration type are meant to be bitwise
01295  * ORed together to specify which options should be used when
01296  * saving the translation unit.
01297  */
01298 enum CXSaveTranslationUnit_Flags {
01299   /**
01300    * \brief Used to indicate that no special saving options are needed.
01301    */
01302   CXSaveTranslationUnit_None = 0x0
01303 };
01304 
01305 /**
01306  * \brief Returns the set of flags that is suitable for saving a translation
01307  * unit.
01308  *
01309  * The set of flags returned provide options for
01310  * \c clang_saveTranslationUnit() by default. The returned flag
01311  * set contains an unspecified set of options that save translation units with
01312  * the most commonly-requested data.
01313  */
01314 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
01315 
01316 /**
01317  * \brief Describes the kind of error that occurred (if any) in a call to
01318  * \c clang_saveTranslationUnit().
01319  */
01320 enum CXSaveError {
01321   /**
01322    * \brief Indicates that no error occurred while saving a translation unit.
01323    */
01324   CXSaveError_None = 0,
01325   
01326   /**
01327    * \brief Indicates that an unknown error occurred while attempting to save
01328    * the file.
01329    *
01330    * This error typically indicates that file I/O failed when attempting to 
01331    * write the file.
01332    */
01333   CXSaveError_Unknown = 1,
01334   
01335   /**
01336    * \brief Indicates that errors during translation prevented this attempt
01337    * to save the translation unit.
01338    * 
01339    * Errors that prevent the translation unit from being saved can be
01340    * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
01341    */
01342   CXSaveError_TranslationErrors = 2,
01343   
01344   /**
01345    * \brief Indicates that the translation unit to be saved was somehow
01346    * invalid (e.g., NULL).
01347    */
01348   CXSaveError_InvalidTU = 3
01349 };
01350   
01351 /**
01352  * \brief Saves a translation unit into a serialized representation of
01353  * that translation unit on disk.
01354  *
01355  * Any translation unit that was parsed without error can be saved
01356  * into a file. The translation unit can then be deserialized into a
01357  * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
01358  * if it is an incomplete translation unit that corresponds to a
01359  * header, used as a precompiled header when parsing other translation
01360  * units.
01361  *
01362  * \param TU The translation unit to save.
01363  *
01364  * \param FileName The file to which the translation unit will be saved.
01365  *
01366  * \param options A bitmask of options that affects how the translation unit
01367  * is saved. This should be a bitwise OR of the
01368  * CXSaveTranslationUnit_XXX flags.
01369  *
01370  * \returns A value that will match one of the enumerators of the CXSaveError
01371  * enumeration. Zero (CXSaveError_None) indicates that the translation unit was 
01372  * saved successfully, while a non-zero value indicates that a problem occurred.
01373  */
01374 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
01375                                              const char *FileName,
01376                                              unsigned options);
01377 
01378 /**
01379  * \brief Destroy the specified CXTranslationUnit object.
01380  */
01381 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
01382 
01383 /**
01384  * \brief Flags that control the reparsing of translation units.
01385  *
01386  * The enumerators in this enumeration type are meant to be bitwise
01387  * ORed together to specify which options should be used when
01388  * reparsing the translation unit.
01389  */
01390 enum CXReparse_Flags {
01391   /**
01392    * \brief Used to indicate that no special reparsing options are needed.
01393    */
01394   CXReparse_None = 0x0
01395 };
01396  
01397 /**
01398  * \brief Returns the set of flags that is suitable for reparsing a translation
01399  * unit.
01400  *
01401  * The set of flags returned provide options for
01402  * \c clang_reparseTranslationUnit() by default. The returned flag
01403  * set contains an unspecified set of optimizations geared toward common uses
01404  * of reparsing. The set of optimizations enabled may change from one version 
01405  * to the next.
01406  */
01407 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
01408 
01409 /**
01410  * \brief Reparse the source files that produced this translation unit.
01411  *
01412  * This routine can be used to re-parse the source files that originally
01413  * created the given translation unit, for example because those source files
01414  * have changed (either on disk or as passed via \p unsaved_files). The
01415  * source code will be reparsed with the same command-line options as it
01416  * was originally parsed. 
01417  *
01418  * Reparsing a translation unit invalidates all cursors and source locations
01419  * that refer into that translation unit. This makes reparsing a translation
01420  * unit semantically equivalent to destroying the translation unit and then
01421  * creating a new translation unit with the same command-line arguments.
01422  * However, it may be more efficient to reparse a translation 
01423  * unit using this routine.
01424  *
01425  * \param TU The translation unit whose contents will be re-parsed. The
01426  * translation unit must originally have been built with 
01427  * \c clang_createTranslationUnitFromSourceFile().
01428  *
01429  * \param num_unsaved_files The number of unsaved file entries in \p
01430  * unsaved_files.
01431  *
01432  * \param unsaved_files The files that have not yet been saved to disk
01433  * but may be required for parsing, including the contents of
01434  * those files.  The contents and name of these files (as specified by
01435  * CXUnsavedFile) are copied when necessary, so the client only needs to
01436  * guarantee their validity until the call to this function returns.
01437  * 
01438  * \param options A bitset of options composed of the flags in CXReparse_Flags.
01439  * The function \c clang_defaultReparseOptions() produces a default set of
01440  * options recommended for most uses, based on the translation unit.
01441  *
01442  * \returns 0 if the sources could be reparsed.  A non-zero error code will be
01443  * returned if reparsing was impossible, such that the translation unit is
01444  * invalid. In such cases, the only valid call for \c TU is
01445  * \c clang_disposeTranslationUnit(TU).  The error codes returned by this
01446  * routine are described by the \c CXErrorCode enum.
01447  */
01448 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
01449                                                 unsigned num_unsaved_files,
01450                                           struct CXUnsavedFile *unsaved_files,
01451                                                 unsigned options);
01452 
01453 /**
01454   * \brief Categorizes how memory is being used by a translation unit.
01455   */
01456 enum CXTUResourceUsageKind {
01457   CXTUResourceUsage_AST = 1,
01458   CXTUResourceUsage_Identifiers = 2,
01459   CXTUResourceUsage_Selectors = 3,
01460   CXTUResourceUsage_GlobalCompletionResults = 4,
01461   CXTUResourceUsage_SourceManagerContentCache = 5,
01462   CXTUResourceUsage_AST_SideTables = 6,
01463   CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
01464   CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
01465   CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9, 
01466   CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10, 
01467   CXTUResourceUsage_Preprocessor = 11,
01468   CXTUResourceUsage_PreprocessingRecord = 12,
01469   CXTUResourceUsage_SourceManager_DataStructures = 13,
01470   CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
01471   CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
01472   CXTUResourceUsage_MEMORY_IN_BYTES_END =
01473     CXTUResourceUsage_Preprocessor_HeaderSearch,
01474 
01475   CXTUResourceUsage_First = CXTUResourceUsage_AST,
01476   CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
01477 };
01478 
01479 /**
01480   * \brief Returns the human-readable null-terminated C string that represents
01481   *  the name of the memory category.  This string should never be freed.
01482   */
01483 CINDEX_LINKAGE
01484 const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
01485 
01486 typedef struct CXTUResourceUsageEntry {
01487   /* \brief The memory usage category. */
01488   enum CXTUResourceUsageKind kind;  
01489   /* \brief Amount of resources used. 
01490       The units will depend on the resource kind. */
01491   unsigned long amount;
01492 } CXTUResourceUsageEntry;
01493 
01494 /**
01495   * \brief The memory usage of a CXTranslationUnit, broken into categories.
01496   */
01497 typedef struct CXTUResourceUsage {
01498   /* \brief Private data member, used for queries. */
01499   void *data;
01500 
01501   /* \brief The number of entries in the 'entries' array. */
01502   unsigned numEntries;
01503 
01504   /* \brief An array of key-value pairs, representing the breakdown of memory
01505             usage. */
01506   CXTUResourceUsageEntry *entries;
01507 
01508 } CXTUResourceUsage;
01509 
01510 /**
01511   * \brief Return the memory usage of a translation unit.  This object
01512   *  should be released with clang_disposeCXTUResourceUsage().
01513   */
01514 CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
01515 
01516 CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
01517 
01518 /**
01519  * @}
01520  */
01521 
01522 /**
01523  * \brief Describes the kind of entity that a cursor refers to.
01524  */
01525 enum CXCursorKind {
01526   /* Declarations */
01527   /**
01528    * \brief A declaration whose specific kind is not exposed via this
01529    * interface.
01530    *
01531    * Unexposed declarations have the same operations as any other kind
01532    * of declaration; one can extract their location information,
01533    * spelling, find their definitions, etc. However, the specific kind
01534    * of the declaration is not reported.
01535    */
01536   CXCursor_UnexposedDecl                 = 1,
01537   /** \brief A C or C++ struct. */
01538   CXCursor_StructDecl                    = 2,
01539   /** \brief A C or C++ union. */
01540   CXCursor_UnionDecl                     = 3,
01541   /** \brief A C++ class. */
01542   CXCursor_ClassDecl                     = 4,
01543   /** \brief An enumeration. */
01544   CXCursor_EnumDecl                      = 5,
01545   /**
01546    * \brief A field (in C) or non-static data member (in C++) in a
01547    * struct, union, or C++ class.
01548    */
01549   CXCursor_FieldDecl                     = 6,
01550   /** \brief An enumerator constant. */
01551   CXCursor_EnumConstantDecl              = 7,
01552   /** \brief A function. */
01553   CXCursor_FunctionDecl                  = 8,
01554   /** \brief A variable. */
01555   CXCursor_VarDecl                       = 9,
01556   /** \brief A function or method parameter. */
01557   CXCursor_ParmDecl                      = 10,
01558   /** \brief An Objective-C \@interface. */
01559   CXCursor_ObjCInterfaceDecl             = 11,
01560   /** \brief An Objective-C \@interface for a category. */
01561   CXCursor_ObjCCategoryDecl              = 12,
01562   /** \brief An Objective-C \@protocol declaration. */
01563   CXCursor_ObjCProtocolDecl              = 13,
01564   /** \brief An Objective-C \@property declaration. */
01565   CXCursor_ObjCPropertyDecl              = 14,
01566   /** \brief An Objective-C instance variable. */
01567   CXCursor_ObjCIvarDecl                  = 15,
01568   /** \brief An Objective-C instance method. */
01569   CXCursor_ObjCInstanceMethodDecl        = 16,
01570   /** \brief An Objective-C class method. */
01571   CXCursor_ObjCClassMethodDecl           = 17,
01572   /** \brief An Objective-C \@implementation. */
01573   CXCursor_ObjCImplementationDecl        = 18,
01574   /** \brief An Objective-C \@implementation for a category. */
01575   CXCursor_ObjCCategoryImplDecl          = 19,
01576   /** \brief A typedef */
01577   CXCursor_TypedefDecl                   = 20,
01578   /** \brief A C++ class method. */
01579   CXCursor_CXXMethod                     = 21,
01580   /** \brief A C++ namespace. */
01581   CXCursor_Namespace                     = 22,
01582   /** \brief A linkage specification, e.g. 'extern "C"'. */
01583   CXCursor_LinkageSpec                   = 23,
01584   /** \brief A C++ constructor. */
01585   CXCursor_Constructor                   = 24,
01586   /** \brief A C++ destructor. */
01587   CXCursor_Destructor                    = 25,
01588   /** \brief A C++ conversion function. */
01589   CXCursor_ConversionFunction            = 26,
01590   /** \brief A C++ template type parameter. */
01591   CXCursor_TemplateTypeParameter         = 27,
01592   /** \brief A C++ non-type template parameter. */
01593   CXCursor_NonTypeTemplateParameter      = 28,
01594   /** \brief A C++ template template parameter. */
01595   CXCursor_TemplateTemplateParameter     = 29,
01596   /** \brief A C++ function template. */
01597   CXCursor_FunctionTemplate              = 30,
01598   /** \brief A C++ class template. */
01599   CXCursor_ClassTemplate                 = 31,
01600   /** \brief A C++ class template partial specialization. */
01601   CXCursor_ClassTemplatePartialSpecialization = 32,
01602   /** \brief A C++ namespace alias declaration. */
01603   CXCursor_NamespaceAlias                = 33,
01604   /** \brief A C++ using directive. */
01605   CXCursor_UsingDirective                = 34,
01606   /** \brief A C++ using declaration. */
01607   CXCursor_UsingDeclaration              = 35,
01608   /** \brief A C++ alias declaration */
01609   CXCursor_TypeAliasDecl                 = 36,
01610   /** \brief An Objective-C \@synthesize definition. */
01611   CXCursor_ObjCSynthesizeDecl            = 37,
01612   /** \brief An Objective-C \@dynamic definition. */
01613   CXCursor_ObjCDynamicDecl               = 38,
01614   /** \brief An access specifier. */
01615   CXCursor_CXXAccessSpecifier            = 39,
01616 
01617   CXCursor_FirstDecl                     = CXCursor_UnexposedDecl,
01618   CXCursor_LastDecl                      = CXCursor_CXXAccessSpecifier,
01619 
01620   /* References */
01621   CXCursor_FirstRef                      = 40, /* Decl references */
01622   CXCursor_ObjCSuperClassRef             = 40,
01623   CXCursor_ObjCProtocolRef               = 41,
01624   CXCursor_ObjCClassRef                  = 42,
01625   /**
01626    * \brief A reference to a type declaration.
01627    *
01628    * A type reference occurs anywhere where a type is named but not
01629    * declared. For example, given:
01630    *
01631    * \code
01632    * typedef unsigned size_type;
01633    * size_type size;
01634    * \endcode
01635    *
01636    * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
01637    * while the type of the variable "size" is referenced. The cursor
01638    * referenced by the type of size is the typedef for size_type.
01639    */
01640   CXCursor_TypeRef                       = 43,
01641   CXCursor_CXXBaseSpecifier              = 44,
01642   /** 
01643    * \brief A reference to a class template, function template, template
01644    * template parameter, or class template partial specialization.
01645    */
01646   CXCursor_TemplateRef                   = 45,
01647   /**
01648    * \brief A reference to a namespace or namespace alias.
01649    */
01650   CXCursor_NamespaceRef                  = 46,
01651   /**
01652    * \brief A reference to a member of a struct, union, or class that occurs in 
01653    * some non-expression context, e.g., a designated initializer.
01654    */
01655   CXCursor_MemberRef                     = 47,
01656   /**
01657    * \brief A reference to a labeled statement.
01658    *
01659    * This cursor kind is used to describe the jump to "start_over" in the 
01660    * goto statement in the following example:
01661    *
01662    * \code
01663    *   start_over:
01664    *     ++counter;
01665    *
01666    *     goto start_over;
01667    * \endcode
01668    *
01669    * A label reference cursor refers to a label statement.
01670    */
01671   CXCursor_LabelRef                      = 48,
01672   
01673   /**
01674    * \brief A reference to a set of overloaded functions or function templates
01675    * that has not yet been resolved to a specific function or function template.
01676    *
01677    * An overloaded declaration reference cursor occurs in C++ templates where
01678    * a dependent name refers to a function. For example:
01679    *
01680    * \code
01681    * template<typename T> void swap(T&, T&);
01682    *
01683    * struct X { ... };
01684    * void swap(X&, X&);
01685    *
01686    * template<typename T>
01687    * void reverse(T* first, T* last) {
01688    *   while (first < last - 1) {
01689    *     swap(*first, *--last);
01690    *     ++first;
01691    *   }
01692    * }
01693    *
01694    * struct Y { };
01695    * void swap(Y&, Y&);
01696    * \endcode
01697    *
01698    * Here, the identifier "swap" is associated with an overloaded declaration
01699    * reference. In the template definition, "swap" refers to either of the two
01700    * "swap" functions declared above, so both results will be available. At
01701    * instantiation time, "swap" may also refer to other functions found via
01702    * argument-dependent lookup (e.g., the "swap" function at the end of the
01703    * example).
01704    *
01705    * The functions \c clang_getNumOverloadedDecls() and 
01706    * \c clang_getOverloadedDecl() can be used to retrieve the definitions
01707    * referenced by this cursor.
01708    */
01709   CXCursor_OverloadedDeclRef             = 49,
01710   
01711   /**
01712    * \brief A reference to a variable that occurs in some non-expression 
01713    * context, e.g., a C++ lambda capture list.
01714    */
01715   CXCursor_VariableRef                   = 50,
01716   
01717   CXCursor_LastRef                       = CXCursor_VariableRef,
01718 
01719   /* Error conditions */
01720   CXCursor_FirstInvalid                  = 70,
01721   CXCursor_InvalidFile                   = 70,
01722   CXCursor_NoDeclFound                   = 71,
01723   CXCursor_NotImplemented                = 72,
01724   CXCursor_InvalidCode                   = 73,
01725   CXCursor_LastInvalid                   = CXCursor_InvalidCode,
01726 
01727   /* Expressions */
01728   CXCursor_FirstExpr                     = 100,
01729 
01730   /**
01731    * \brief An expression whose specific kind is not exposed via this
01732    * interface.
01733    *
01734    * Unexposed expressions have the same operations as any other kind
01735    * of expression; one can extract their location information,
01736    * spelling, children, etc. However, the specific kind of the
01737    * expression is not reported.
01738    */
01739   CXCursor_UnexposedExpr                 = 100,
01740 
01741   /**
01742    * \brief An expression that refers to some value declaration, such
01743    * as a function, variable, or enumerator.
01744    */
01745   CXCursor_DeclRefExpr                   = 101,
01746 
01747   /**
01748    * \brief An expression that refers to a member of a struct, union,
01749    * class, Objective-C class, etc.
01750    */
01751   CXCursor_MemberRefExpr                 = 102,
01752 
01753   /** \brief An expression that calls a function. */
01754   CXCursor_CallExpr                      = 103,
01755 
01756   /** \brief An expression that sends a message to an Objective-C
01757    object or class. */
01758   CXCursor_ObjCMessageExpr               = 104,
01759 
01760   /** \brief An expression that represents a block literal. */
01761   CXCursor_BlockExpr                     = 105,
01762 
01763   /** \brief An integer literal.
01764    */
01765   CXCursor_IntegerLiteral                = 106,
01766 
01767   /** \brief A floating point number literal.
01768    */
01769   CXCursor_FloatingLiteral               = 107,
01770 
01771   /** \brief An imaginary number literal.
01772    */
01773   CXCursor_ImaginaryLiteral              = 108,
01774 
01775   /** \brief A string literal.
01776    */
01777   CXCursor_StringLiteral                 = 109,
01778 
01779   /** \brief A character literal.
01780    */
01781   CXCursor_CharacterLiteral              = 110,
01782 
01783   /** \brief A parenthesized expression, e.g. "(1)".
01784    *
01785    * This AST node is only formed if full location information is requested.
01786    */
01787   CXCursor_ParenExpr                     = 111,
01788 
01789   /** \brief This represents the unary-expression's (except sizeof and
01790    * alignof).
01791    */
01792   CXCursor_UnaryOperator                 = 112,
01793 
01794   /** \brief [C99 6.5.2.1] Array Subscripting.
01795    */
01796   CXCursor_ArraySubscriptExpr            = 113,
01797 
01798   /** \brief A builtin binary operation expression such as "x + y" or
01799    * "x <= y".
01800    */
01801   CXCursor_BinaryOperator                = 114,
01802 
01803   /** \brief Compound assignment such as "+=".
01804    */
01805   CXCursor_CompoundAssignOperator        = 115,
01806 
01807   /** \brief The ?: ternary operator.
01808    */
01809   CXCursor_ConditionalOperator           = 116,
01810 
01811   /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
01812    * (C++ [expr.cast]), which uses the syntax (Type)expr.
01813    *
01814    * For example: (int)f.
01815    */
01816   CXCursor_CStyleCastExpr                = 117,
01817 
01818   /** \brief [C99 6.5.2.5]
01819    */
01820   CXCursor_CompoundLiteralExpr           = 118,
01821 
01822   /** \brief Describes an C or C++ initializer list.
01823    */
01824   CXCursor_InitListExpr                  = 119,
01825 
01826   /** \brief The GNU address of label extension, representing &&label.
01827    */
01828   CXCursor_AddrLabelExpr                 = 120,
01829 
01830   /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
01831    */
01832   CXCursor_StmtExpr                      = 121,
01833 
01834   /** \brief Represents a C11 generic selection.
01835    */
01836   CXCursor_GenericSelectionExpr          = 122,
01837 
01838   /** \brief Implements the GNU __null extension, which is a name for a null
01839    * pointer constant that has integral type (e.g., int or long) and is the same
01840    * size and alignment as a pointer.
01841    *
01842    * The __null extension is typically only used by system headers, which define
01843    * NULL as __null in C++ rather than using 0 (which is an integer that may not
01844    * match the size of a pointer).
01845    */
01846   CXCursor_GNUNullExpr                   = 123,
01847 
01848   /** \brief C++'s static_cast<> expression.
01849    */
01850   CXCursor_CXXStaticCastExpr             = 124,
01851 
01852   /** \brief C++'s dynamic_cast<> expression.
01853    */
01854   CXCursor_CXXDynamicCastExpr            = 125,
01855 
01856   /** \brief C++'s reinterpret_cast<> expression.
01857    */
01858   CXCursor_CXXReinterpretCastExpr        = 126,
01859 
01860   /** \brief C++'s const_cast<> expression.
01861    */
01862   CXCursor_CXXConstCastExpr              = 127,
01863 
01864   /** \brief Represents an explicit C++ type conversion that uses "functional"
01865    * notion (C++ [expr.type.conv]).
01866    *
01867    * Example:
01868    * \code
01869    *   x = int(0.5);
01870    * \endcode
01871    */
01872   CXCursor_CXXFunctionalCastExpr         = 128,
01873 
01874   /** \brief A C++ typeid expression (C++ [expr.typeid]).
01875    */
01876   CXCursor_CXXTypeidExpr                 = 129,
01877 
01878   /** \brief [C++ 2.13.5] C++ Boolean Literal.
01879    */
01880   CXCursor_CXXBoolLiteralExpr            = 130,
01881 
01882   /** \brief [C++0x 2.14.7] C++ Pointer Literal.
01883    */
01884   CXCursor_CXXNullPtrLiteralExpr         = 131,
01885 
01886   /** \brief Represents the "this" expression in C++
01887    */
01888   CXCursor_CXXThisExpr                   = 132,
01889 
01890   /** \brief [C++ 15] C++ Throw Expression.
01891    *
01892    * This handles 'throw' and 'throw' assignment-expression. When
01893    * assignment-expression isn't present, Op will be null.
01894    */
01895   CXCursor_CXXThrowExpr                  = 133,
01896 
01897   /** \brief A new expression for memory allocation and constructor calls, e.g:
01898    * "new CXXNewExpr(foo)".
01899    */
01900   CXCursor_CXXNewExpr                    = 134,
01901 
01902   /** \brief A delete expression for memory deallocation and destructor calls,
01903    * e.g. "delete[] pArray".
01904    */
01905   CXCursor_CXXDeleteExpr                 = 135,
01906 
01907   /** \brief A unary expression.
01908    */
01909   CXCursor_UnaryExpr                     = 136,
01910 
01911   /** \brief An Objective-C string literal i.e. @"foo".
01912    */
01913   CXCursor_ObjCStringLiteral             = 137,
01914 
01915   /** \brief An Objective-C \@encode expression.
01916    */
01917   CXCursor_ObjCEncodeExpr                = 138,
01918 
01919   /** \brief An Objective-C \@selector expression.
01920    */
01921   CXCursor_ObjCSelectorExpr              = 139,
01922 
01923   /** \brief An Objective-C \@protocol expression.
01924    */
01925   CXCursor_ObjCProtocolExpr              = 140,
01926 
01927   /** \brief An Objective-C "bridged" cast expression, which casts between
01928    * Objective-C pointers and C pointers, transferring ownership in the process.
01929    *
01930    * \code
01931    *   NSString *str = (__bridge_transfer NSString *)CFCreateString();
01932    * \endcode
01933    */
01934   CXCursor_ObjCBridgedCastExpr           = 141,
01935 
01936   /** \brief Represents a C++0x pack expansion that produces a sequence of
01937    * expressions.
01938    *
01939    * A pack expansion expression contains a pattern (which itself is an
01940    * expression) followed by an ellipsis. For example:
01941    *
01942    * \code
01943    * template<typename F, typename ...Types>
01944    * void forward(F f, Types &&...args) {
01945    *  f(static_cast<Types&&>(args)...);
01946    * }
01947    * \endcode
01948    */
01949   CXCursor_PackExpansionExpr             = 142,
01950 
01951   /** \brief Represents an expression that computes the length of a parameter
01952    * pack.
01953    *
01954    * \code
01955    * template<typename ...Types>
01956    * struct count {
01957    *   static const unsigned value = sizeof...(Types);
01958    * };
01959    * \endcode
01960    */
01961   CXCursor_SizeOfPackExpr                = 143,
01962 
01963   /* \brief Represents a C++ lambda expression that produces a local function
01964    * object.
01965    *
01966    * \code
01967    * void abssort(float *x, unsigned N) {
01968    *   std::sort(x, x + N,
01969    *             [](float a, float b) {
01970    *               return std::abs(a) < std::abs(b);
01971    *             });
01972    * }
01973    * \endcode
01974    */
01975   CXCursor_LambdaExpr                    = 144,
01976   
01977   /** \brief Objective-c Boolean Literal.
01978    */
01979   CXCursor_ObjCBoolLiteralExpr           = 145,
01980 
01981   /** \brief Represents the "self" expression in an Objective-C method.
01982    */
01983   CXCursor_ObjCSelfExpr                  = 146,
01984 
01985   CXCursor_LastExpr                      = CXCursor_ObjCSelfExpr,
01986 
01987   /* Statements */
01988   CXCursor_FirstStmt                     = 200,
01989   /**
01990    * \brief A statement whose specific kind is not exposed via this
01991    * interface.
01992    *
01993    * Unexposed statements have the same operations as any other kind of
01994    * statement; one can extract their location information, spelling,
01995    * children, etc. However, the specific kind of the statement is not
01996    * reported.
01997    */
01998   CXCursor_UnexposedStmt                 = 200,
01999   
02000   /** \brief A labelled statement in a function. 
02001    *
02002    * This cursor kind is used to describe the "start_over:" label statement in 
02003    * the following example:
02004    *
02005    * \code
02006    *   start_over:
02007    *     ++counter;
02008    * \endcode
02009    *
02010    */
02011   CXCursor_LabelStmt                     = 201,
02012 
02013   /** \brief A group of statements like { stmt stmt }.
02014    *
02015    * This cursor kind is used to describe compound statements, e.g. function
02016    * bodies.
02017    */
02018   CXCursor_CompoundStmt                  = 202,
02019 
02020   /** \brief A case statement.
02021    */
02022   CXCursor_CaseStmt                      = 203,
02023 
02024   /** \brief A default statement.
02025    */
02026   CXCursor_DefaultStmt                   = 204,
02027 
02028   /** \brief An if statement
02029    */
02030   CXCursor_IfStmt                        = 205,
02031 
02032   /** \brief A switch statement.
02033    */
02034   CXCursor_SwitchStmt                    = 206,
02035 
02036   /** \brief A while statement.
02037    */
02038   CXCursor_WhileStmt                     = 207,
02039 
02040   /** \brief A do statement.
02041    */
02042   CXCursor_DoStmt                        = 208,
02043 
02044   /** \brief A for statement.
02045    */
02046   CXCursor_ForStmt                       = 209,
02047 
02048   /** \brief A goto statement.
02049    */
02050   CXCursor_GotoStmt                      = 210,
02051 
02052   /** \brief An indirect goto statement.
02053    */
02054   CXCursor_IndirectGotoStmt              = 211,
02055 
02056   /** \brief A continue statement.
02057    */
02058   CXCursor_ContinueStmt                  = 212,
02059 
02060   /** \brief A break statement.
02061    */
02062   CXCursor_BreakStmt                     = 213,
02063 
02064   /** \brief A return statement.
02065    */
02066   CXCursor_ReturnStmt                    = 214,
02067 
02068   /** \brief A GCC inline assembly statement extension.
02069    */
02070   CXCursor_GCCAsmStmt                    = 215,
02071   CXCursor_AsmStmt                       = CXCursor_GCCAsmStmt,
02072 
02073   /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
02074    */
02075   CXCursor_ObjCAtTryStmt                 = 216,
02076 
02077   /** \brief Objective-C's \@catch statement.
02078    */
02079   CXCursor_ObjCAtCatchStmt               = 217,
02080 
02081   /** \brief Objective-C's \@finally statement.
02082    */
02083   CXCursor_ObjCAtFinallyStmt             = 218,
02084 
02085   /** \brief Objective-C's \@throw statement.
02086    */
02087   CXCursor_ObjCAtThrowStmt               = 219,
02088 
02089   /** \brief Objective-C's \@synchronized statement.
02090    */
02091   CXCursor_ObjCAtSynchronizedStmt        = 220,
02092 
02093   /** \brief Objective-C's autorelease pool statement.
02094    */
02095   CXCursor_ObjCAutoreleasePoolStmt       = 221,
02096 
02097   /** \brief Objective-C's collection statement.
02098    */
02099   CXCursor_ObjCForCollectionStmt         = 222,
02100 
02101   /** \brief C++'s catch statement.
02102    */
02103   CXCursor_CXXCatchStmt                  = 223,
02104 
02105   /** \brief C++'s try statement.
02106    */
02107   CXCursor_CXXTryStmt                    = 224,
02108 
02109   /** \brief C++'s for (* : *) statement.
02110    */
02111   CXCursor_CXXForRangeStmt               = 225,
02112 
02113   /** \brief Windows Structured Exception Handling's try statement.
02114    */
02115   CXCursor_SEHTryStmt                    = 226,
02116 
02117   /** \brief Windows Structured Exception Handling's except statement.
02118    */
02119   CXCursor_SEHExceptStmt                 = 227,
02120 
02121   /** \brief Windows Structured Exception Handling's finally statement.
02122    */
02123   CXCursor_SEHFinallyStmt                = 228,
02124 
02125   /** \brief A MS inline assembly statement extension.
02126    */
02127   CXCursor_MSAsmStmt                     = 229,
02128 
02129   /** \brief The null satement ";": C99 6.8.3p3.
02130    *
02131    * This cursor kind is used to describe the null statement.
02132    */
02133   CXCursor_NullStmt                      = 230,
02134 
02135   /** \brief Adaptor class for mixing declarations with statements and
02136    * expressions.
02137    */
02138   CXCursor_DeclStmt                      = 231,
02139 
02140   /** \brief OpenMP parallel directive.
02141    */
02142   CXCursor_OMPParallelDirective          = 232,
02143 
02144   /** \brief OpenMP simd directive.
02145    */
02146   CXCursor_OMPSimdDirective              = 233,
02147 
02148   /** \brief OpenMP for directive.
02149    */
02150   CXCursor_OMPForDirective               = 234,
02151 
02152   /** \brief OpenMP sections directive.
02153    */
02154   CXCursor_OMPSectionsDirective          = 235,
02155 
02156   /** \brief OpenMP section directive.
02157    */
02158   CXCursor_OMPSectionDirective           = 236,
02159 
02160   /** \brief OpenMP single directive.
02161    */
02162   CXCursor_OMPSingleDirective            = 237,
02163 
02164   /** \brief OpenMP parallel for directive.
02165    */
02166   CXCursor_OMPParallelForDirective       = 238,
02167 
02168   /** \brief OpenMP parallel sections directive.
02169    */
02170   CXCursor_OMPParallelSectionsDirective  = 239,
02171 
02172   /** \brief OpenMP task directive.
02173    */
02174   CXCursor_OMPTaskDirective              = 240,
02175 
02176   /** \brief OpenMP master directive.
02177    */
02178   CXCursor_OMPMasterDirective            = 241,
02179 
02180   /** \brief OpenMP critical directive.
02181    */
02182   CXCursor_OMPCriticalDirective          = 242,
02183 
02184   /** \brief OpenMP taskyield directive.
02185    */
02186   CXCursor_OMPTaskyieldDirective         = 243,
02187 
02188   /** \brief OpenMP barrier directive.
02189    */
02190   CXCursor_OMPBarrierDirective           = 244,
02191 
02192   /** \brief OpenMP taskwait directive.
02193    */
02194   CXCursor_OMPTaskwaitDirective          = 245,
02195 
02196   /** \brief OpenMP flush directive.
02197    */
02198   CXCursor_OMPFlushDirective             = 246,
02199 
02200   /** \brief Windows Structured Exception Handling's leave statement.
02201    */
02202   CXCursor_SEHLeaveStmt                  = 247,
02203 
02204   /** \brief OpenMP ordered directive.
02205    */
02206   CXCursor_OMPOrderedDirective           = 248,
02207 
02208   /** \brief OpenMP atomic directive.
02209    */
02210   CXCursor_OMPAtomicDirective            = 249,
02211 
02212   /** \brief OpenMP for simd directive.
02213    */
02214   CXCursor_OMPForSimdDirective           = 250,
02215 
02216   /** \brief OpenMP parallel for simd directive.
02217    */
02218   CXCursor_OMPParallelForSimdDirective   = 251,
02219 
02220   /** \brief OpenMP target directive.
02221    */
02222   CXCursor_OMPTargetDirective            = 252,
02223 
02224   CXCursor_LastStmt                      = CXCursor_OMPTargetDirective,
02225 
02226   /**
02227    * \brief Cursor that represents the translation unit itself.
02228    *
02229    * The translation unit cursor exists primarily to act as the root
02230    * cursor for traversing the contents of a translation unit.
02231    */
02232   CXCursor_TranslationUnit               = 300,
02233 
02234   /* Attributes */
02235   CXCursor_FirstAttr                     = 400,
02236   /**
02237    * \brief An attribute whose specific kind is not exposed via this
02238    * interface.
02239    */
02240   CXCursor_UnexposedAttr                 = 400,
02241 
02242   CXCursor_IBActionAttr                  = 401,
02243   CXCursor_IBOutletAttr                  = 402,
02244   CXCursor_IBOutletCollectionAttr        = 403,
02245   CXCursor_CXXFinalAttr                  = 404,
02246   CXCursor_CXXOverrideAttr               = 405,
02247   CXCursor_AnnotateAttr                  = 406,
02248   CXCursor_AsmLabelAttr                  = 407,
02249   CXCursor_PackedAttr                    = 408,
02250   CXCursor_PureAttr                      = 409,
02251   CXCursor_ConstAttr                     = 410,
02252   CXCursor_NoDuplicateAttr               = 411,
02253   CXCursor_CUDAConstantAttr              = 412,
02254   CXCursor_CUDADeviceAttr                = 413,
02255   CXCursor_CUDAGlobalAttr                = 414,
02256   CXCursor_CUDAHostAttr                  = 415,
02257   CXCursor_CUDASharedAttr                = 416,
02258   CXCursor_LastAttr                      = CXCursor_CUDASharedAttr,
02259 
02260   /* Preprocessing */
02261   CXCursor_PreprocessingDirective        = 500,
02262   CXCursor_MacroDefinition               = 501,
02263   CXCursor_MacroExpansion                = 502,
02264   CXCursor_MacroInstantiation            = CXCursor_MacroExpansion,
02265   CXCursor_InclusionDirective            = 503,
02266   CXCursor_FirstPreprocessing            = CXCursor_PreprocessingDirective,
02267   CXCursor_LastPreprocessing             = CXCursor_InclusionDirective,
02268 
02269   /* Extra Declarations */
02270   /**
02271    * \brief A module import declaration.
02272    */
02273   CXCursor_ModuleImportDecl              = 600,
02274   CXCursor_FirstExtraDecl                = CXCursor_ModuleImportDecl,
02275   CXCursor_LastExtraDecl                 = CXCursor_ModuleImportDecl
02276 };
02277 
02278 /**
02279  * \brief A cursor representing some element in the abstract syntax tree for
02280  * a translation unit.
02281  *
02282  * The cursor abstraction unifies the different kinds of entities in a
02283  * program--declaration, statements, expressions, references to declarations,
02284  * etc.--under a single "cursor" abstraction with a common set of operations.
02285  * Common operation for a cursor include: getting the physical location in
02286  * a source file where the cursor points, getting the name associated with a
02287  * cursor, and retrieving cursors for any child nodes of a particular cursor.
02288  *
02289  * Cursors can be produced in two specific ways.
02290  * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
02291  * from which one can use clang_visitChildren() to explore the rest of the
02292  * translation unit. clang_getCursor() maps from a physical source location
02293  * to the entity that resides at that location, allowing one to map from the
02294  * source code into the AST.
02295  */
02296 typedef struct {
02297   enum CXCursorKind kind;
02298   int xdata;
02299   const void *data[3];
02300 } CXCursor;
02301 
02302 /**
02303  * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
02304  *
02305  * @{
02306  */
02307 
02308 /**
02309  * \brief Retrieve the NULL cursor, which represents no entity.
02310  */
02311 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
02312 
02313 /**
02314  * \brief Retrieve the cursor that represents the given translation unit.
02315  *
02316  * The translation unit cursor can be used to start traversing the
02317  * various declarations within the given translation unit.
02318  */
02319 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
02320 
02321 /**
02322  * \brief Determine whether two cursors are equivalent.
02323  */
02324 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
02325 
02326 /**
02327  * \brief Returns non-zero if \p cursor is null.
02328  */
02329 CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
02330 
02331 /**
02332  * \brief Compute a hash value for the given cursor.
02333  */
02334 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
02335   
02336 /**
02337  * \brief Retrieve the kind of the given cursor.
02338  */
02339 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
02340 
02341 /**
02342  * \brief Determine whether the given cursor kind represents a declaration.
02343  */
02344 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
02345 
02346 /**
02347  * \brief Determine whether the given cursor kind represents a simple
02348  * reference.
02349  *
02350  * Note that other kinds of cursors (such as expressions) can also refer to
02351  * other cursors. Use clang_getCursorReferenced() to determine whether a
02352  * particular cursor refers to another entity.
02353  */
02354 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
02355 
02356 /**
02357  * \brief Determine whether the given cursor kind represents an expression.
02358  */
02359 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
02360 
02361 /**
02362  * \brief Determine whether the given cursor kind represents a statement.
02363  */
02364 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
02365 
02366 /**
02367  * \brief Determine whether the given cursor kind represents an attribute.
02368  */
02369 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
02370 
02371 /**
02372  * \brief Determine whether the given cursor kind represents an invalid
02373  * cursor.
02374  */
02375 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
02376 
02377 /**
02378  * \brief Determine whether the given cursor kind represents a translation
02379  * unit.
02380  */
02381 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
02382 
02383 /***
02384  * \brief Determine whether the given cursor represents a preprocessing
02385  * element, such as a preprocessor directive or macro instantiation.
02386  */
02387 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
02388   
02389 /***
02390  * \brief Determine whether the given cursor represents a currently
02391  *  unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
02392  */
02393 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
02394 
02395 /**
02396  * \brief Describe the linkage of the entity referred to by a cursor.
02397  */
02398 enum CXLinkageKind {
02399   /** \brief This value indicates that no linkage information is available
02400    * for a provided CXCursor. */
02401   CXLinkage_Invalid,
02402   /**
02403    * \brief This is the linkage for variables, parameters, and so on that
02404    *  have automatic storage.  This covers normal (non-extern) local variables.
02405    */
02406   CXLinkage_NoLinkage,
02407   /** \brief This is the linkage for static variables and static functions. */
02408   CXLinkage_Internal,
02409   /** \brief This is the linkage for entities with external linkage that live
02410    * in C++ anonymous namespaces.*/
02411   CXLinkage_UniqueExternal,
02412   /** \brief This is the linkage for entities with true, external linkage. */
02413   CXLinkage_External
02414 };
02415 
02416 /**
02417  * \brief Determine the linkage of the entity referred to by a given cursor.
02418  */
02419 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
02420 
02421 /**
02422  * \brief Determine the availability of the entity that this cursor refers to,
02423  * taking the current target platform into account.
02424  *
02425  * \param cursor The cursor to query.
02426  *
02427  * \returns The availability of the cursor.
02428  */
02429 CINDEX_LINKAGE enum CXAvailabilityKind 
02430 clang_getCursorAvailability(CXCursor cursor);
02431 
02432 /**
02433  * Describes the availability of a given entity on a particular platform, e.g.,
02434  * a particular class might only be available on Mac OS 10.7 or newer.
02435  */
02436 typedef struct CXPlatformAvailability {
02437   /**
02438    * \brief A string that describes the platform for which this structure
02439    * provides availability information.
02440    *
02441    * Possible values are "ios" or "macosx".
02442    */
02443   CXString Platform;
02444   /**
02445    * \brief The version number in which this entity was introduced.
02446    */
02447   CXVersion Introduced;
02448   /**
02449    * \brief The version number in which this entity was deprecated (but is
02450    * still available).
02451    */
02452   CXVersion Deprecated;
02453   /**
02454    * \brief The version number in which this entity was obsoleted, and therefore
02455    * is no longer available.
02456    */
02457   CXVersion Obsoleted;
02458   /**
02459    * \brief Whether the entity is unconditionally unavailable on this platform.
02460    */
02461   int Unavailable;
02462   /**
02463    * \brief An optional message to provide to a user of this API, e.g., to
02464    * suggest replacement APIs.
02465    */
02466   CXString Message;
02467 } CXPlatformAvailability;
02468 
02469 /**
02470  * \brief Determine the availability of the entity that this cursor refers to
02471  * on any platforms for which availability information is known.
02472  *
02473  * \param cursor The cursor to query.
02474  *
02475  * \param always_deprecated If non-NULL, will be set to indicate whether the 
02476  * entity is deprecated on all platforms.
02477  *
02478  * \param deprecated_message If non-NULL, will be set to the message text 
02479  * provided along with the unconditional deprecation of this entity. The client
02480  * is responsible for deallocating this string.
02481  *
02482  * \param always_unavailable If non-NULL, will be set to indicate whether the
02483  * entity is unavailable on all platforms.
02484  *
02485  * \param unavailable_message If non-NULL, will be set to the message text
02486  * provided along with the unconditional unavailability of this entity. The 
02487  * client is responsible for deallocating this string.
02488  *
02489  * \param availability If non-NULL, an array of CXPlatformAvailability instances
02490  * that will be populated with platform availability information, up to either
02491  * the number of platforms for which availability information is available (as
02492  * returned by this function) or \c availability_size, whichever is smaller.
02493  *
02494  * \param availability_size The number of elements available in the 
02495  * \c availability array.
02496  *
02497  * \returns The number of platforms (N) for which availability information is
02498  * available (which is unrelated to \c availability_size).
02499  *
02500  * Note that the client is responsible for calling 
02501  * \c clang_disposeCXPlatformAvailability to free each of the 
02502  * platform-availability structures returned. There are 
02503  * \c min(N, availability_size) such structures.
02504  */
02505 CINDEX_LINKAGE int
02506 clang_getCursorPlatformAvailability(CXCursor cursor,
02507                                     int *always_deprecated,
02508                                     CXString *deprecated_message,
02509                                     int *always_unavailable,
02510                                     CXString *unavailable_message,
02511                                     CXPlatformAvailability *availability,
02512                                     int availability_size);
02513 
02514 /**
02515  * \brief Free the memory associated with a \c CXPlatformAvailability structure.
02516  */
02517 CINDEX_LINKAGE void
02518 clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
02519   
02520 /**
02521  * \brief Describe the "language" of the entity referred to by a cursor.
02522  */
02523 enum CXLanguageKind {
02524   CXLanguage_Invalid = 0,
02525   CXLanguage_C,
02526   CXLanguage_ObjC,
02527   CXLanguage_CPlusPlus
02528 };
02529 
02530 /**
02531  * \brief Determine the "language" of the entity referred to by a given cursor.
02532  */
02533 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
02534 
02535 /**
02536  * \brief Returns the translation unit that a cursor originated from.
02537  */
02538 CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
02539 
02540 
02541 /**
02542  * \brief A fast container representing a set of CXCursors.
02543  */
02544 typedef struct CXCursorSetImpl *CXCursorSet;
02545 
02546 /**
02547  * \brief Creates an empty CXCursorSet.
02548  */
02549 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
02550 
02551 /**
02552  * \brief Disposes a CXCursorSet and releases its associated memory.
02553  */
02554 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
02555 
02556 /**
02557  * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
02558  *
02559  * \returns non-zero if the set contains the specified cursor.
02560 */
02561 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
02562                                                    CXCursor cursor);
02563 
02564 /**
02565  * \brief Inserts a CXCursor into a CXCursorSet.
02566  *
02567  * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
02568 */
02569 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
02570                                                  CXCursor cursor);
02571 
02572 /**
02573  * \brief Determine the semantic parent of the given cursor.
02574  *
02575  * The semantic parent of a cursor is the cursor that semantically contains
02576  * the given \p cursor. For many declarations, the lexical and semantic parents
02577  * are equivalent (the lexical parent is returned by 
02578  * \c clang_getCursorLexicalParent()). They diverge when declarations or
02579  * definitions are provided out-of-line. For example:
02580  *
02581  * \code
02582  * class C {
02583  *  void f();
02584  * };
02585  *
02586  * void C::f() { }
02587  * \endcode
02588  *
02589  * In the out-of-line definition of \c C::f, the semantic parent is
02590  * the class \c C, of which this function is a member. The lexical parent is
02591  * the place where the declaration actually occurs in the source code; in this
02592  * case, the definition occurs in the translation unit. In general, the
02593  * lexical parent for a given entity can change without affecting the semantics
02594  * of the program, and the lexical parent of different declarations of the
02595  * same entity may be different. Changing the semantic parent of a declaration,
02596  * on the other hand, can have a major impact on semantics, and redeclarations
02597  * of a particular entity should all have the same semantic context.
02598  *
02599  * In the example above, both declarations of \c C::f have \c C as their
02600  * semantic context, while the lexical context of the first \c C::f is \c C
02601  * and the lexical context of the second \c C::f is the translation unit.
02602  *
02603  * For global declarations, the semantic parent is the translation unit.
02604  */
02605 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
02606 
02607 /**
02608  * \brief Determine the lexical parent of the given cursor.
02609  *
02610  * The lexical parent of a cursor is the cursor in which the given \p cursor
02611  * was actually written. For many declarations, the lexical and semantic parents
02612  * are equivalent (the semantic parent is returned by 
02613  * \c clang_getCursorSemanticParent()). They diverge when declarations or
02614  * definitions are provided out-of-line. For example:
02615  *
02616  * \code
02617  * class C {
02618  *  void f();
02619  * };
02620  *
02621  * void C::f() { }
02622  * \endcode
02623  *
02624  * In the out-of-line definition of \c C::f, the semantic parent is
02625  * the class \c C, of which this function is a member. The lexical parent is
02626  * the place where the declaration actually occurs in the source code; in this
02627  * case, the definition occurs in the translation unit. In general, the
02628  * lexical parent for a given entity can change without affecting the semantics
02629  * of the program, and the lexical parent of different declarations of the
02630  * same entity may be different. Changing the semantic parent of a declaration,
02631  * on the other hand, can have a major impact on semantics, and redeclarations
02632  * of a particular entity should all have the same semantic context.
02633  *
02634  * In the example above, both declarations of \c C::f have \c C as their
02635  * semantic context, while the lexical context of the first \c C::f is \c C
02636  * and the lexical context of the second \c C::f is the translation unit.
02637  *
02638  * For declarations written in the global scope, the lexical parent is
02639  * the translation unit.
02640  */
02641 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
02642 
02643 /**
02644  * \brief Determine the set of methods that are overridden by the given
02645  * method.
02646  *
02647  * In both Objective-C and C++, a method (aka virtual member function,
02648  * in C++) can override a virtual method in a base class. For
02649  * Objective-C, a method is said to override any method in the class's
02650  * base class, its protocols, or its categories' protocols, that has the same
02651  * selector and is of the same kind (class or instance).
02652  * If no such method exists, the search continues to the class's superclass,
02653  * its protocols, and its categories, and so on. A method from an Objective-C
02654  * implementation is considered to override the same methods as its
02655  * corresponding method in the interface.
02656  *
02657  * For C++, a virtual member function overrides any virtual member
02658  * function with the same signature that occurs in its base
02659  * classes. With multiple inheritance, a virtual member function can
02660  * override several virtual member functions coming from different
02661  * base classes.
02662  *
02663  * In all cases, this function determines the immediate overridden
02664  * method, rather than all of the overridden methods. For example, if
02665  * a method is originally declared in a class A, then overridden in B
02666  * (which in inherits from A) and also in C (which inherited from B),
02667  * then the only overridden method returned from this function when
02668  * invoked on C's method will be B's method. The client may then
02669  * invoke this function again, given the previously-found overridden
02670  * methods, to map out the complete method-override set.
02671  *
02672  * \param cursor A cursor representing an Objective-C or C++
02673  * method. This routine will compute the set of methods that this
02674  * method overrides.
02675  * 
02676  * \param overridden A pointer whose pointee will be replaced with a
02677  * pointer to an array of cursors, representing the set of overridden
02678  * methods. If there are no overridden methods, the pointee will be
02679  * set to NULL. The pointee must be freed via a call to 
02680  * \c clang_disposeOverriddenCursors().
02681  *
02682  * \param num_overridden A pointer to the number of overridden
02683  * functions, will be set to the number of overridden functions in the
02684  * array pointed to by \p overridden.
02685  */
02686 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 
02687                                                CXCursor **overridden,
02688                                                unsigned *num_overridden);
02689 
02690 /**
02691  * \brief Free the set of overridden cursors returned by \c
02692  * clang_getOverriddenCursors().
02693  */
02694 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
02695 
02696 /**
02697  * \brief Retrieve the file that is included by the given inclusion directive
02698  * cursor.
02699  */
02700 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
02701   
02702 /**
02703  * @}
02704  */
02705 
02706 /**
02707  * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
02708  *
02709  * Cursors represent a location within the Abstract Syntax Tree (AST). These
02710  * routines help map between cursors and the physical locations where the
02711  * described entities occur in the source code. The mapping is provided in
02712  * both directions, so one can map from source code to the AST and back.
02713  *
02714  * @{
02715  */
02716 
02717 /**
02718  * \brief Map a source location to the cursor that describes the entity at that
02719  * location in the source code.
02720  *
02721  * clang_getCursor() maps an arbitrary source location within a translation
02722  * unit down to the most specific cursor that describes the entity at that
02723  * location. For example, given an expression \c x + y, invoking
02724  * clang_getCursor() with a source location pointing to "x" will return the
02725  * cursor for "x"; similarly for "y". If the cursor points anywhere between
02726  * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
02727  * will return a cursor referring to the "+" expression.
02728  *
02729  * \returns a cursor representing the entity at the given source location, or
02730  * a NULL cursor if no such entity can be found.
02731  */
02732 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
02733 
02734 /**
02735  * \brief Retrieve the physical location of the source constructor referenced
02736  * by the given cursor.
02737  *
02738  * The location of a declaration is typically the location of the name of that
02739  * declaration, where the name of that declaration would occur if it is
02740  * unnamed, or some keyword that introduces that particular declaration.
02741  * The location of a reference is where that reference occurs within the
02742  * source code.
02743  */
02744 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
02745 
02746 /**
02747  * \brief Retrieve the physical extent of the source construct referenced by
02748  * the given cursor.
02749  *
02750  * The extent of a cursor starts with the file/line/column pointing at the
02751  * first character within the source construct that the cursor refers to and
02752  * ends with the last character within that source construct. For a
02753  * declaration, the extent covers the declaration itself. For a reference,
02754  * the extent covers the location of the reference (e.g., where the referenced
02755  * entity was actually used).
02756  */
02757 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
02758 
02759 /**
02760  * @}
02761  */
02762     
02763 /**
02764  * \defgroup CINDEX_TYPES Type information for CXCursors
02765  *
02766  * @{
02767  */
02768 
02769 /**
02770  * \brief Describes the kind of type
02771  */
02772 enum CXTypeKind {
02773   /**
02774    * \brief Represents an invalid type (e.g., where no type is available).
02775    */
02776   CXType_Invalid = 0,
02777 
02778   /**
02779    * \brief A type whose specific kind is not exposed via this
02780    * interface.
02781    */
02782   CXType_Unexposed = 1,
02783 
02784   /* Builtin types */
02785   CXType_Void = 2,
02786   CXType_Bool = 3,
02787   CXType_Char_U = 4,
02788   CXType_UChar = 5,
02789   CXType_Char16 = 6,
02790   CXType_Char32 = 7,
02791   CXType_UShort = 8,
02792   CXType_UInt = 9,
02793   CXType_ULong = 10,
02794   CXType_ULongLong = 11,
02795   CXType_UInt128 = 12,
02796   CXType_Char_S = 13,
02797   CXType_SChar = 14,
02798   CXType_WChar = 15,
02799   CXType_Short = 16,
02800   CXType_Int = 17,
02801   CXType_Long = 18,
02802   CXType_LongLong = 19,
02803   CXType_Int128 = 20,
02804   CXType_Float = 21,
02805   CXType_Double = 22,
02806   CXType_LongDouble = 23,
02807   CXType_NullPtr = 24,
02808   CXType_Overload = 25,
02809   CXType_Dependent = 26,
02810   CXType_ObjCId = 27,
02811   CXType_ObjCClass = 28,
02812   CXType_ObjCSel = 29,
02813   CXType_FirstBuiltin = CXType_Void,
02814   CXType_LastBuiltin  = CXType_ObjCSel,
02815 
02816   CXType_Complex = 100,
02817   CXType_Pointer = 101,
02818   CXType_BlockPointer = 102,
02819   CXType_LValueReference = 103,
02820   CXType_RValueReference = 104,
02821   CXType_Record = 105,
02822   CXType_Enum = 106,
02823   CXType_Typedef = 107,
02824   CXType_ObjCInterface = 108,
02825   CXType_ObjCObjectPointer = 109,
02826   CXType_FunctionNoProto = 110,
02827   CXType_FunctionProto = 111,
02828   CXType_ConstantArray = 112,
02829   CXType_Vector = 113,
02830   CXType_IncompleteArray = 114,
02831   CXType_VariableArray = 115,
02832   CXType_DependentSizedArray = 116,
02833   CXType_MemberPointer = 117
02834 };
02835 
02836 /**
02837  * \brief Describes the calling convention of a function type
02838  */
02839 enum CXCallingConv {
02840   CXCallingConv_Default = 0,
02841   CXCallingConv_C = 1,
02842   CXCallingConv_X86StdCall = 2,
02843   CXCallingConv_X86FastCall = 3,
02844   CXCallingConv_X86ThisCall = 4,
02845   CXCallingConv_X86Pascal = 5,
02846   CXCallingConv_AAPCS = 6,
02847   CXCallingConv_AAPCS_VFP = 7,
02848   CXCallingConv_PnaclCall = 8,
02849   CXCallingConv_IntelOclBicc = 9,
02850   CXCallingConv_X86_64Win64 = 10,
02851   CXCallingConv_X86_64SysV = 11,
02852 
02853   CXCallingConv_Invalid = 100,
02854   CXCallingConv_Unexposed = 200
02855 };
02856 
02857 
02858 /**
02859  * \brief The type of an element in the abstract syntax tree.
02860  *
02861  */
02862 typedef struct {
02863   enum CXTypeKind kind;
02864   void *data[2];
02865 } CXType;
02866 
02867 /**
02868  * \brief Retrieve the type of a CXCursor (if any).
02869  */
02870 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
02871 
02872 /**
02873  * \brief Pretty-print the underlying type using the rules of the
02874  * language of the translation unit from which it came.
02875  *
02876  * If the type is invalid, an empty string is returned.
02877  */
02878 CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
02879 
02880 /**
02881  * \brief Retrieve the underlying type of a typedef declaration.
02882  *
02883  * If the cursor does not reference a typedef declaration, an invalid type is
02884  * returned.
02885  */
02886 CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
02887 
02888 /**
02889  * \brief Retrieve the integer type of an enum declaration.
02890  *
02891  * If the cursor does not reference an enum declaration, an invalid type is
02892  * returned.
02893  */
02894 CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
02895 
02896 /**
02897  * \brief Retrieve the integer value of an enum constant declaration as a signed
02898  *  long long.
02899  *
02900  * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
02901  * Since this is also potentially a valid constant value, the kind of the cursor
02902  * must be verified before calling this function.
02903  */
02904 CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C);
02905 
02906 /**
02907  * \brief Retrieve the integer value of an enum constant declaration as an unsigned
02908  *  long long.
02909  *
02910  * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
02911  * Since this is also potentially a valid constant value, the kind of the cursor
02912  * must be verified before calling this function.
02913  */
02914 CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C);
02915 
02916 /**
02917  * \brief Retrieve the bit width of a bit field declaration as an integer.
02918  *
02919  * If a cursor that is not a bit field declaration is passed in, -1 is returned.
02920  */
02921 CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
02922 
02923 /**
02924  * \brief Retrieve the number of non-variadic arguments associated with a given
02925  * cursor.
02926  *
02927  * The number of arguments can be determined for calls as well as for
02928  * declarations of functions or methods. For other cursors -1 is returned.
02929  */
02930 CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
02931 
02932 /**
02933  * \brief Retrieve the argument cursor of a function or method.
02934  *
02935  * The argument cursor can be determined for calls as well as for declarations
02936  * of functions or methods. For other cursors and for invalid indices, an
02937  * invalid cursor is returned.
02938  */
02939 CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
02940 
02941 /**
02942  * \brief Determine whether two CXTypes represent the same type.
02943  *
02944  * \returns non-zero if the CXTypes represent the same type and
02945  *          zero otherwise.
02946  */
02947 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
02948 
02949 /**
02950  * \brief Return the canonical type for a CXType.
02951  *
02952  * Clang's type system explicitly models typedefs and all the ways
02953  * a specific type can be represented.  The canonical type is the underlying
02954  * type with all the "sugar" removed.  For example, if 'T' is a typedef
02955  * for 'int', the canonical type for 'T' would be 'int'.
02956  */
02957 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
02958 
02959 /**
02960  * \brief Determine whether a CXType has the "const" qualifier set,
02961  * without looking through typedefs that may have added "const" at a
02962  * different level.
02963  */
02964 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
02965 
02966 /**
02967  * \brief Determine whether a CXType has the "volatile" qualifier set,
02968  * without looking through typedefs that may have added "volatile" at
02969  * a different level.
02970  */
02971 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
02972 
02973 /**
02974  * \brief Determine whether a CXType has the "restrict" qualifier set,
02975  * without looking through typedefs that may have added "restrict" at a
02976  * different level.
02977  */
02978 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
02979 
02980 /**
02981  * \brief For pointer types, returns the type of the pointee.
02982  */
02983 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
02984 
02985 /**
02986  * \brief Return the cursor for the declaration of the given type.
02987  */
02988 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
02989 
02990 /**
02991  * Returns the Objective-C type encoding for the specified declaration.
02992  */
02993 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
02994 
02995 /**
02996  * \brief Retrieve the spelling of a given CXTypeKind.
02997  */
02998 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
02999 
03000 /**
03001  * \brief Retrieve the calling convention associated with a function type.
03002  *
03003  * If a non-function type is passed in, CXCallingConv_Invalid is returned.
03004  */
03005 CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
03006 
03007 /**
03008  * \brief Retrieve the return type associated with a function type.
03009  *
03010  * If a non-function type is passed in, an invalid type is returned.
03011  */
03012 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
03013 
03014 /**
03015  * \brief Retrieve the number of non-variadic parameters associated with a
03016  * function type.
03017  *
03018  * If a non-function type is passed in, -1 is returned.
03019  */
03020 CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
03021 
03022 /**
03023  * \brief Retrieve the type of a parameter of a function type.
03024  *
03025  * If a non-function type is passed in or the function does not have enough
03026  * parameters, an invalid type is returned.
03027  */
03028 CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
03029 
03030 /**
03031  * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
03032  */
03033 CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
03034 
03035 /**
03036  * \brief Retrieve the return type associated with a given cursor.
03037  *
03038  * This only returns a valid type if the cursor refers to a function or method.
03039  */
03040 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
03041 
03042 /**
03043  * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
03044  *  otherwise.
03045  */
03046 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
03047 
03048 /**
03049  * \brief Return the element type of an array, complex, or vector type.
03050  *
03051  * If a type is passed in that is not an array, complex, or vector type,
03052  * an invalid type is returned.
03053  */
03054 CINDEX_LINKAGE CXType clang_getElementType(CXType T);
03055 
03056 /**
03057  * \brief Return the number of elements of an array or vector type.
03058  *
03059  * If a type is passed in that is not an array or vector type,
03060  * -1 is returned.
03061  */
03062 CINDEX_LINKAGE long long clang_getNumElements(CXType T);
03063 
03064 /**
03065  * \brief Return the element type of an array type.
03066  *
03067  * If a non-array type is passed in, an invalid type is returned.
03068  */
03069 CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
03070 
03071 /**
03072  * \brief Return the array size of a constant array.
03073  *
03074  * If a non-array type is passed in, -1 is returned.
03075  */
03076 CINDEX_LINKAGE long long clang_getArraySize(CXType T);
03077 
03078 /**
03079  * \brief List the possible error codes for \c clang_Type_getSizeOf,
03080  *   \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
03081  *   \c clang_Cursor_getOffsetOf.
03082  *
03083  * A value of this enumeration type can be returned if the target type is not
03084  * a valid argument to sizeof, alignof or offsetof.
03085  */
03086 enum CXTypeLayoutError {
03087   /**
03088    * \brief Type is of kind CXType_Invalid.
03089    */
03090   CXTypeLayoutError_Invalid = -1,
03091   /**
03092    * \brief The type is an incomplete Type.
03093    */
03094   CXTypeLayoutError_Incomplete = -2,
03095   /**
03096    * \brief The type is a dependent Type.
03097    */
03098   CXTypeLayoutError_Dependent = -3,
03099   /**
03100    * \brief The type is not a constant size type.
03101    */
03102   CXTypeLayoutError_NotConstantSize = -4,
03103   /**
03104    * \brief The Field name is not valid for this record.
03105    */
03106   CXTypeLayoutError_InvalidFieldName = -5
03107 };
03108 
03109 /**
03110  * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
03111  *   standard.
03112  *
03113  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
03114  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
03115  *   is returned.
03116  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
03117  *   returned.
03118  * If the type declaration is not a constant size type,
03119  *   CXTypeLayoutError_NotConstantSize is returned.
03120  */
03121 CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
03122 
03123 /**
03124  * \brief Return the class type of an member pointer type.
03125  *
03126  * If a non-member-pointer type is passed in, an invalid type is returned.
03127  */
03128 CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
03129 
03130 /**
03131  * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
03132  *
03133  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
03134  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
03135  *   is returned.
03136  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
03137  *   returned.
03138  */
03139 CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
03140 
03141 /**
03142  * \brief Return the offset of a field named S in a record of type T in bits
03143  *   as it would be returned by __offsetof__ as per C++11[18.2p4]
03144  *
03145  * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
03146  *   is returned.
03147  * If the field's type declaration is an incomplete type,
03148  *   CXTypeLayoutError_Incomplete is returned.
03149  * If the field's type declaration is a dependent type,
03150  *   CXTypeLayoutError_Dependent is returned.
03151  * If the field's name S is not found,
03152  *   CXTypeLayoutError_InvalidFieldName is returned.
03153  */
03154 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
03155 
03156 enum CXRefQualifierKind {
03157   /** \brief No ref-qualifier was provided. */
03158   CXRefQualifier_None = 0,
03159   /** \brief An lvalue ref-qualifier was provided (\c &). */
03160   CXRefQualifier_LValue,
03161   /** \brief An rvalue ref-qualifier was provided (\c &&). */
03162   CXRefQualifier_RValue
03163 };
03164 
03165 /**
03166  * \brief Returns the number of template arguments for given class template
03167  * specialization, or -1 if type \c T is not a class template specialization.
03168  *
03169  * Variadic argument packs count as only one argument, and can not be inspected
03170  * further.
03171  */
03172 CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
03173 
03174 /**
03175  * \brief Returns the type template argument of a template class specialization
03176  * at given index.
03177  *
03178  * This function only returns template type arguments and does not handle
03179  * template template arguments or variadic packs.
03180  */
03181 CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
03182 
03183 /**
03184  * \brief Retrieve the ref-qualifier kind of a function or method.
03185  *
03186  * The ref-qualifier is returned for C++ functions or methods. For other types
03187  * or non-C++ declarations, CXRefQualifier_None is returned.
03188  */
03189 CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
03190 
03191 /**
03192  * \brief Returns non-zero if the cursor specifies a Record member that is a
03193  *   bitfield.
03194  */
03195 CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
03196 
03197 /**
03198  * \brief Returns 1 if the base class specified by the cursor with kind
03199  *   CX_CXXBaseSpecifier is virtual.
03200  */
03201 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
03202     
03203 /**
03204  * \brief Represents the C++ access control level to a base class for a
03205  * cursor with kind CX_CXXBaseSpecifier.
03206  */
03207 enum CX_CXXAccessSpecifier {
03208   CX_CXXInvalidAccessSpecifier,
03209   CX_CXXPublic,
03210   CX_CXXProtected,
03211   CX_CXXPrivate
03212 };
03213 
03214 /**
03215  * \brief Returns the access control level for the referenced object.
03216  *
03217  * If the cursor refers to a C++ declaration, its access control level within its
03218  * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
03219  * access specifier, the specifier itself is returned.
03220  */
03221 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
03222 
03223 /**
03224  * \brief Determine the number of overloaded declarations referenced by a 
03225  * \c CXCursor_OverloadedDeclRef cursor.
03226  *
03227  * \param cursor The cursor whose overloaded declarations are being queried.
03228  *
03229  * \returns The number of overloaded declarations referenced by \c cursor. If it
03230  * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
03231  */
03232 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
03233 
03234 /**
03235  * \brief Retrieve a cursor for one of the overloaded declarations referenced
03236  * by a \c CXCursor_OverloadedDeclRef cursor.
03237  *
03238  * \param cursor The cursor whose overloaded declarations are being queried.
03239  *
03240  * \param index The zero-based index into the set of overloaded declarations in
03241  * the cursor.
03242  *
03243  * \returns A cursor representing the declaration referenced by the given 
03244  * \c cursor at the specified \c index. If the cursor does not have an 
03245  * associated set of overloaded declarations, or if the index is out of bounds,
03246  * returns \c clang_getNullCursor();
03247  */
03248 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 
03249                                                 unsigned index);
03250   
03251 /**
03252  * @}
03253  */
03254   
03255 /**
03256  * \defgroup CINDEX_ATTRIBUTES Information for attributes
03257  *
03258  * @{
03259  */
03260 
03261 
03262 /**
03263  * \brief For cursors representing an iboutletcollection attribute,
03264  *  this function returns the collection element type.
03265  *
03266  */
03267 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
03268 
03269 /**
03270  * @}
03271  */
03272 
03273 /**
03274  * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
03275  *
03276  * These routines provide the ability to traverse the abstract syntax tree
03277  * using cursors.
03278  *
03279  * @{
03280  */
03281 
03282 /**
03283  * \brief Describes how the traversal of the children of a particular
03284  * cursor should proceed after visiting a particular child cursor.
03285  *
03286  * A value of this enumeration type should be returned by each
03287  * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
03288  */
03289 enum CXChildVisitResult {
03290   /**
03291    * \brief Terminates the cursor traversal.
03292    */
03293   CXChildVisit_Break,
03294   /**
03295    * \brief Continues the cursor traversal with the next sibling of
03296    * the cursor just visited, without visiting its children.
03297    */
03298   CXChildVisit_Continue,
03299   /**
03300    * \brief Recursively traverse the children of this cursor, using
03301    * the same visitor and client data.
03302    */
03303   CXChildVisit_Recurse
03304 };
03305 
03306 /**
03307  * \brief Visitor invoked for each cursor found by a traversal.
03308  *
03309  * This visitor function will be invoked for each cursor found by
03310  * clang_visitCursorChildren(). Its first argument is the cursor being
03311  * visited, its second argument is the parent visitor for that cursor,
03312  * and its third argument is the client data provided to
03313  * clang_visitCursorChildren().
03314  *
03315  * The visitor should return one of the \c CXChildVisitResult values
03316  * to direct clang_visitCursorChildren().
03317  */
03318 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
03319                                                    CXCursor parent,
03320                                                    CXClientData client_data);
03321 
03322 /**
03323  * \brief Visit the children of a particular cursor.
03324  *
03325  * This function visits all the direct children of the given cursor,
03326  * invoking the given \p visitor function with the cursors of each
03327  * visited child. The traversal may be recursive, if the visitor returns
03328  * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
03329  * the visitor returns \c CXChildVisit_Break.
03330  *
03331  * \param parent the cursor whose child may be visited. All kinds of
03332  * cursors can be visited, including invalid cursors (which, by
03333  * definition, have no children).
03334  *
03335  * \param visitor the visitor function that will be invoked for each
03336  * child of \p parent.
03337  *
03338  * \param client_data pointer data supplied by the client, which will
03339  * be passed to the visitor each time it is invoked.
03340  *
03341  * \returns a non-zero value if the traversal was terminated
03342  * prematurely by the visitor returning \c CXChildVisit_Break.
03343  */
03344 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
03345                                             CXCursorVisitor visitor,
03346                                             CXClientData client_data);
03347 #ifdef __has_feature
03348 #  if __has_feature(blocks)
03349 /**
03350  * \brief Visitor invoked for each cursor found by a traversal.
03351  *
03352  * This visitor block will be invoked for each cursor found by
03353  * clang_visitChildrenWithBlock(). Its first argument is the cursor being
03354  * visited, its second argument is the parent visitor for that cursor.
03355  *
03356  * The visitor should return one of the \c CXChildVisitResult values
03357  * to direct clang_visitChildrenWithBlock().
03358  */
03359 typedef enum CXChildVisitResult 
03360      (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
03361 
03362 /**
03363  * Visits the children of a cursor using the specified block.  Behaves
03364  * identically to clang_visitChildren() in all other respects.
03365  */
03366 unsigned clang_visitChildrenWithBlock(CXCursor parent,
03367                                       CXCursorVisitorBlock block);
03368 #  endif
03369 #endif
03370 
03371 /**
03372  * @}
03373  */
03374 
03375 /**
03376  * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
03377  *
03378  * These routines provide the ability to determine references within and
03379  * across translation units, by providing the names of the entities referenced
03380  * by cursors, follow reference cursors to the declarations they reference,
03381  * and associate declarations with their definitions.
03382  *
03383  * @{
03384  */
03385 
03386 /**
03387  * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
03388  * by the given cursor.
03389  *
03390  * A Unified Symbol Resolution (USR) is a string that identifies a particular
03391  * entity (function, class, variable, etc.) within a program. USRs can be
03392  * compared across translation units to determine, e.g., when references in
03393  * one translation refer to an entity defined in another translation unit.
03394  */
03395 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
03396 
03397 /**
03398  * \brief Construct a USR for a specified Objective-C class.
03399  */
03400 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
03401 
03402 /**
03403  * \brief Construct a USR for a specified Objective-C category.
03404  */
03405 CINDEX_LINKAGE CXString
03406   clang_constructUSR_ObjCCategory(const char *class_name,
03407                                  const char *category_name);
03408 
03409 /**
03410  * \brief Construct a USR for a specified Objective-C protocol.
03411  */
03412 CINDEX_LINKAGE CXString
03413   clang_constructUSR_ObjCProtocol(const char *protocol_name);
03414 
03415 
03416 /**
03417  * \brief Construct a USR for a specified Objective-C instance variable and
03418  *   the USR for its containing class.
03419  */
03420 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
03421                                                     CXString classUSR);
03422 
03423 /**
03424  * \brief Construct a USR for a specified Objective-C method and
03425  *   the USR for its containing class.
03426  */
03427 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
03428                                                       unsigned isInstanceMethod,
03429                                                       CXString classUSR);
03430 
03431 /**
03432  * \brief Construct a USR for a specified Objective-C property and the USR
03433  *  for its containing class.
03434  */
03435 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
03436                                                         CXString classUSR);
03437 
03438 /**
03439  * \brief Retrieve a name for the entity referenced by this cursor.
03440  */
03441 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
03442 
03443 /**
03444  * \brief Retrieve a range for a piece that forms the cursors spelling name.
03445  * Most of the times there is only one range for the complete spelling but for
03446  * Objective-C methods and Objective-C message expressions, there are multiple
03447  * pieces for each selector identifier.
03448  * 
03449  * \param pieceIndex the index of the spelling name piece. If this is greater
03450  * than the actual number of pieces, it will return a NULL (invalid) range.
03451  *  
03452  * \param options Reserved.
03453  */
03454 CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor,
03455                                                           unsigned pieceIndex,
03456                                                           unsigned options);
03457 
03458 /**
03459  * \brief Retrieve the display name for the entity referenced by this cursor.
03460  *
03461  * The display name contains extra information that helps identify the cursor,
03462  * such as the parameters of a function or template or the arguments of a 
03463  * class template specialization.
03464  */
03465 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
03466   
03467 /** \brief For a cursor that is a reference, retrieve a cursor representing the
03468  * entity that it references.
03469  *
03470  * Reference cursors refer to other entities in the AST. For example, an
03471  * Objective-C superclass reference cursor refers to an Objective-C class.
03472  * This function produces the cursor for the Objective-C class from the
03473  * cursor for the superclass reference. If the input cursor is a declaration or
03474  * definition, it returns that declaration or definition unchanged.
03475  * Otherwise, returns the NULL cursor.
03476  */
03477 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
03478 
03479 /**
03480  *  \brief For a cursor that is either a reference to or a declaration
03481  *  of some entity, retrieve a cursor that describes the definition of
03482  *  that entity.
03483  *
03484  *  Some entities can be declared multiple times within a translation
03485  *  unit, but only one of those declarations can also be a
03486  *  definition. For example, given:
03487  *
03488  *  \code
03489  *  int f(int, int);
03490  *  int g(int x, int y) { return f(x, y); }
03491  *  int f(int a, int b) { return a + b; }
03492  *  int f(int, int);
03493  *  \endcode
03494  *
03495  *  there are three declarations of the function "f", but only the
03496  *  second one is a definition. The clang_getCursorDefinition()
03497  *  function will take any cursor pointing to a declaration of "f"
03498  *  (the first or fourth lines of the example) or a cursor referenced
03499  *  that uses "f" (the call to "f' inside "g") and will return a
03500  *  declaration cursor pointing to the definition (the second "f"
03501  *  declaration).
03502  *
03503  *  If given a cursor for which there is no corresponding definition,
03504  *  e.g., because there is no definition of that entity within this
03505  *  translation unit, returns a NULL cursor.
03506  */
03507 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
03508 
03509 /**
03510  * \brief Determine whether the declaration pointed to by this cursor
03511  * is also a definition of that entity.
03512  */
03513 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
03514 
03515 /**
03516  * \brief Retrieve the canonical cursor corresponding to the given cursor.
03517  *
03518  * In the C family of languages, many kinds of entities can be declared several
03519  * times within a single translation unit. For example, a structure type can
03520  * be forward-declared (possibly multiple times) and later defined:
03521  *
03522  * \code
03523  * struct X;
03524  * struct X;
03525  * struct X {
03526  *   int member;
03527  * };
03528  * \endcode
03529  *
03530  * The declarations and the definition of \c X are represented by three 
03531  * different cursors, all of which are declarations of the same underlying 
03532  * entity. One of these cursor is considered the "canonical" cursor, which
03533  * is effectively the representative for the underlying entity. One can 
03534  * determine if two cursors are declarations of the same underlying entity by
03535  * comparing their canonical cursors.
03536  *
03537  * \returns The canonical cursor for the entity referred to by the given cursor.
03538  */
03539 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
03540 
03541 
03542 /**
03543  * \brief If the cursor points to a selector identifier in an Objective-C
03544  * method or message expression, this returns the selector index.
03545  *
03546  * After getting a cursor with #clang_getCursor, this can be called to
03547  * determine if the location points to a selector identifier.
03548  *
03549  * \returns The selector index if the cursor is an Objective-C method or message
03550  * expression and the cursor is pointing to a selector identifier, or -1
03551  * otherwise.
03552  */
03553 CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
03554 
03555 /**
03556  * \brief Given a cursor pointing to a C++ method call or an Objective-C
03557  * message, returns non-zero if the method/message is "dynamic", meaning:
03558  * 
03559  * For a C++ method: the call is virtual.
03560  * For an Objective-C message: the receiver is an object instance, not 'super'
03561  * or a specific class.
03562  * 
03563  * If the method/message is "static" or the cursor does not point to a
03564  * method/message, it will return zero.
03565  */
03566 CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
03567 
03568 /**
03569  * \brief Given a cursor pointing to an Objective-C message, returns the CXType
03570  * of the receiver.
03571  */
03572 CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
03573 
03574 /**
03575  * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
03576  */
03577 typedef enum {
03578   CXObjCPropertyAttr_noattr    = 0x00,
03579   CXObjCPropertyAttr_readonly  = 0x01,
03580   CXObjCPropertyAttr_getter    = 0x02,
03581   CXObjCPropertyAttr_assign    = 0x04,
03582   CXObjCPropertyAttr_readwrite = 0x08,
03583   CXObjCPropertyAttr_retain    = 0x10,
03584   CXObjCPropertyAttr_copy      = 0x20,
03585   CXObjCPropertyAttr_nonatomic = 0x40,
03586   CXObjCPropertyAttr_setter    = 0x80,
03587   CXObjCPropertyAttr_atomic    = 0x100,
03588   CXObjCPropertyAttr_weak      = 0x200,
03589   CXObjCPropertyAttr_strong    = 0x400,
03590   CXObjCPropertyAttr_unsafe_unretained = 0x800
03591 } CXObjCPropertyAttrKind;
03592 
03593 /**
03594  * \brief Given a cursor that represents a property declaration, return the
03595  * associated property attributes. The bits are formed from
03596  * \c CXObjCPropertyAttrKind.
03597  *
03598  * \param reserved Reserved for future use, pass 0.
03599  */
03600 CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C,
03601                                                              unsigned reserved);
03602 
03603 /**
03604  * \brief 'Qualifiers' written next to the return and parameter types in
03605  * Objective-C method declarations.
03606  */
03607 typedef enum {
03608   CXObjCDeclQualifier_None = 0x0,
03609   CXObjCDeclQualifier_In = 0x1,
03610   CXObjCDeclQualifier_Inout = 0x2,
03611   CXObjCDeclQualifier_Out = 0x4,
03612   CXObjCDeclQualifier_Bycopy = 0x8,
03613   CXObjCDeclQualifier_Byref = 0x10,
03614   CXObjCDeclQualifier_Oneway = 0x20
03615 } CXObjCDeclQualifierKind;
03616 
03617 /**
03618  * \brief Given a cursor that represents an Objective-C method or parameter
03619  * declaration, return the associated Objective-C qualifiers for the return
03620  * type or the parameter respectively. The bits are formed from
03621  * CXObjCDeclQualifierKind.
03622  */
03623 CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
03624 
03625 /**
03626  * \brief Given a cursor that represents an Objective-C method or property
03627  * declaration, return non-zero if the declaration was affected by "@optional".
03628  * Returns zero if the cursor is not such a declaration or it is "@required".
03629  */
03630 CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
03631 
03632 /**
03633  * \brief Returns non-zero if the given cursor is a variadic function or method.
03634  */
03635 CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
03636 
03637 /**
03638  * \brief Given a cursor that represents a declaration, return the associated
03639  * comment's source range.  The range may include multiple consecutive comments
03640  * with whitespace in between.
03641  */
03642 CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
03643 
03644 /**
03645  * \brief Given a cursor that represents a declaration, return the associated
03646  * comment text, including comment markers.
03647  */
03648 CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
03649 
03650 /**
03651  * \brief Given a cursor that represents a documentable entity (e.g.,
03652  * declaration), return the associated \\brief paragraph; otherwise return the
03653  * first paragraph.
03654  */
03655 CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
03656 
03657 /**
03658  * @}
03659  */
03660 
03661 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
03662  *
03663  * @{
03664  */
03665 
03666 /**
03667  * \brief Retrieve the CXString representing the mangled name of the cursor.
03668  */
03669 CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
03670 
03671 /**
03672  * @}
03673  */
03674 
03675 /**
03676  * \defgroup CINDEX_MODULE Module introspection
03677  *
03678  * The functions in this group provide access to information about modules.
03679  *
03680  * @{
03681  */
03682 
03683 typedef void *CXModule;
03684 
03685 /**
03686  * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
03687  */
03688 CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
03689 
03690 /**
03691  * \brief Given a CXFile header file, return the module that contains it, if one
03692  * exists.
03693  */
03694 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
03695 
03696 /**
03697  * \param Module a module object.
03698  *
03699  * \returns the module file where the provided module object came from.
03700  */
03701 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
03702 
03703 /**
03704  * \param Module a module object.
03705  *
03706  * \returns the parent of a sub-module or NULL if the given module is top-level,
03707  * e.g. for 'std.vector' it will return the 'std' module.
03708  */
03709 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
03710 
03711 /**
03712  * \param Module a module object.
03713  *
03714  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
03715  * will return "vector".
03716  */
03717 CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
03718 
03719 /**
03720  * \param Module a module object.
03721  *
03722  * \returns the full name of the module, e.g. "std.vector".
03723  */
03724 CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
03725 
03726 /**
03727  * \param Module a module object.
03728  *
03729  * \returns non-zero if the module is a system one.
03730  */
03731 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
03732 
03733 /**
03734  * \param Module a module object.
03735  *
03736  * \returns the number of top level headers associated with this module.
03737  */
03738 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
03739                                                            CXModule Module);
03740 
03741 /**
03742  * \param Module a module object.
03743  *
03744  * \param Index top level header index (zero-based).
03745  *
03746  * \returns the specified top level header associated with the module.
03747  */
03748 CINDEX_LINKAGE
03749 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
03750                                       CXModule Module, unsigned Index);
03751 
03752 /**
03753  * @}
03754  */
03755 
03756 /**
03757  * \defgroup CINDEX_CPP C++ AST introspection
03758  *
03759  * The routines in this group provide access information in the ASTs specific
03760  * to C++ language features.
03761  *
03762  * @{
03763  */
03764 
03765 /**
03766  * \brief Determine if a C++ member function or member function template is
03767  * pure virtual.
03768  */
03769 CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
03770 
03771 /**
03772  * \brief Determine if a C++ member function or member function template is 
03773  * declared 'static'.
03774  */
03775 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
03776 
03777 /**
03778  * \brief Determine if a C++ member function or member function template is
03779  * explicitly declared 'virtual' or if it overrides a virtual method from
03780  * one of the base classes.
03781  */
03782 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
03783 
03784 /**
03785  * \brief Determine if a C++ member function or member function template is
03786  * declared 'const'.
03787  */
03788 CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
03789 
03790 /**
03791  * \brief Given a cursor that represents a template, determine
03792  * the cursor kind of the specializations would be generated by instantiating
03793  * the template.
03794  *
03795  * This routine can be used to determine what flavor of function template,
03796  * class template, or class template partial specialization is stored in the
03797  * cursor. For example, it can describe whether a class template cursor is
03798  * declared with "struct", "class" or "union".
03799  *
03800  * \param C The cursor to query. This cursor should represent a template
03801  * declaration.
03802  *
03803  * \returns The cursor kind of the specializations that would be generated
03804  * by instantiating the template \p C. If \p C is not a template, returns
03805  * \c CXCursor_NoDeclFound.
03806  */
03807 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
03808   
03809 /**
03810  * \brief Given a cursor that may represent a specialization or instantiation
03811  * of a template, retrieve the cursor that represents the template that it
03812  * specializes or from which it was instantiated.
03813  *
03814  * This routine determines the template involved both for explicit 
03815  * specializations of templates and for implicit instantiations of the template,
03816  * both of which are referred to as "specializations". For a class template
03817  * specialization (e.g., \c std::vector<bool>), this routine will return 
03818  * either the primary template (\c std::vector) or, if the specialization was
03819  * instantiated from a class template partial specialization, the class template
03820  * partial specialization. For a class template partial specialization and a
03821  * function template specialization (including instantiations), this
03822  * this routine will return the specialized template.
03823  *
03824  * For members of a class template (e.g., member functions, member classes, or
03825  * static data members), returns the specialized or instantiated member. 
03826  * Although not strictly "templates" in the C++ language, members of class
03827  * templates have the same notions of specializations and instantiations that
03828  * templates do, so this routine treats them similarly.
03829  *
03830  * \param C A cursor that may be a specialization of a template or a member
03831  * of a template.
03832  *
03833  * \returns If the given cursor is a specialization or instantiation of a 
03834  * template or a member thereof, the template or member that it specializes or
03835  * from which it was instantiated. Otherwise, returns a NULL cursor.
03836  */
03837 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
03838 
03839 /**
03840  * \brief Given a cursor that references something else, return the source range
03841  * covering that reference.
03842  *
03843  * \param C A cursor pointing to a member reference, a declaration reference, or
03844  * an operator call.
03845  * \param NameFlags A bitset with three independent flags: 
03846  * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
03847  * CXNameRange_WantSinglePiece.
03848  * \param PieceIndex For contiguous names or when passing the flag 
03849  * CXNameRange_WantSinglePiece, only one piece with index 0 is 
03850  * available. When the CXNameRange_WantSinglePiece flag is not passed for a
03851  * non-contiguous names, this index can be used to retrieve the individual
03852  * pieces of the name. See also CXNameRange_WantSinglePiece.
03853  *
03854  * \returns The piece of the name pointed to by the given cursor. If there is no
03855  * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
03856  */
03857 CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
03858                                                 unsigned NameFlags, 
03859                                                 unsigned PieceIndex);
03860 
03861 enum CXNameRefFlags {
03862   /**
03863    * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
03864    * range.
03865    */
03866   CXNameRange_WantQualifier = 0x1,
03867   
03868   /**
03869    * \brief Include the explicit template arguments, e.g. <int> in x.f<int>,
03870    * in the range.
03871    */
03872   CXNameRange_WantTemplateArgs = 0x2,
03873 
03874   /**
03875    * \brief If the name is non-contiguous, return the full spanning range.
03876    *
03877    * Non-contiguous names occur in Objective-C when a selector with two or more
03878    * parameters is used, or in C++ when using an operator:
03879    * \code
03880    * [object doSomething:here withValue:there]; // Objective-C
03881    * return some_vector[1]; // C++
03882    * \endcode
03883    */
03884   CXNameRange_WantSinglePiece = 0x4
03885 };
03886   
03887 /**
03888  * @}
03889  */
03890 
03891 /**
03892  * \defgroup CINDEX_LEX Token extraction and manipulation
03893  *
03894  * The routines in this group provide access to the tokens within a
03895  * translation unit, along with a semantic mapping of those tokens to
03896  * their corresponding cursors.
03897  *
03898  * @{
03899  */
03900 
03901 /**
03902  * \brief Describes a kind of token.
03903  */
03904 typedef enum CXTokenKind {
03905   /**
03906    * \brief A token that contains some kind of punctuation.
03907    */
03908   CXToken_Punctuation,
03909 
03910   /**
03911    * \brief A language keyword.
03912    */
03913   CXToken_Keyword,
03914 
03915   /**
03916    * \brief An identifier (that is not a keyword).
03917    */
03918   CXToken_Identifier,
03919 
03920   /**
03921    * \brief A numeric, string, or character literal.
03922    */
03923   CXToken_Literal,
03924 
03925   /**
03926    * \brief A comment.
03927    */
03928   CXToken_Comment
03929 } CXTokenKind;
03930 
03931 /**
03932  * \brief Describes a single preprocessing token.
03933  */
03934 typedef struct {
03935   unsigned int_data[4];
03936   void *ptr_data;
03937 } CXToken;
03938 
03939 /**
03940  * \brief Determine the kind of the given token.
03941  */
03942 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
03943 
03944 /**
03945  * \brief Determine the spelling of the given token.
03946  *
03947  * The spelling of a token is the textual representation of that token, e.g.,
03948  * the text of an identifier or keyword.
03949  */
03950 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
03951 
03952 /**
03953  * \brief Retrieve the source location of the given token.
03954  */
03955 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
03956                                                        CXToken);
03957 
03958 /**
03959  * \brief Retrieve a source range that covers the given token.
03960  */
03961 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
03962 
03963 /**
03964  * \brief Tokenize the source code described by the given range into raw
03965  * lexical tokens.
03966  *
03967  * \param TU the translation unit whose text is being tokenized.
03968  *
03969  * \param Range the source range in which text should be tokenized. All of the
03970  * tokens produced by tokenization will fall within this source range,
03971  *
03972  * \param Tokens this pointer will be set to point to the array of tokens
03973  * that occur within the given source range. The returned pointer must be
03974  * freed with clang_disposeTokens() before the translation unit is destroyed.
03975  *
03976  * \param NumTokens will be set to the number of tokens in the \c *Tokens
03977  * array.
03978  *
03979  */
03980 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
03981                                    CXToken **Tokens, unsigned *NumTokens);
03982 
03983 /**
03984  * \brief Annotate the given set of tokens by providing cursors for each token
03985  * that can be mapped to a specific entity within the abstract syntax tree.
03986  *
03987  * This token-annotation routine is equivalent to invoking
03988  * clang_getCursor() for the source locations of each of the
03989  * tokens. The cursors provided are filtered, so that only those
03990  * cursors that have a direct correspondence to the token are
03991  * accepted. For example, given a function call \c f(x),
03992  * clang_getCursor() would provide the following cursors:
03993  *
03994  *   * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
03995  *   * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
03996  *   * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
03997  *
03998  * Only the first and last of these cursors will occur within the
03999  * annotate, since the tokens "f" and "x' directly refer to a function
04000  * and a variable, respectively, but the parentheses are just a small
04001  * part of the full syntax of the function call expression, which is
04002  * not provided as an annotation.
04003  *
04004  * \param TU the translation unit that owns the given tokens.
04005  *
04006  * \param Tokens the set of tokens to annotate.
04007  *
04008  * \param NumTokens the number of tokens in \p Tokens.
04009  *
04010  * \param Cursors an array of \p NumTokens cursors, whose contents will be
04011  * replaced with the cursors corresponding to each token.
04012  */
04013 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
04014                                          CXToken *Tokens, unsigned NumTokens,
04015                                          CXCursor *Cursors);
04016 
04017 /**
04018  * \brief Free the given set of tokens.
04019  */
04020 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
04021                                         CXToken *Tokens, unsigned NumTokens);
04022 
04023 /**
04024  * @}
04025  */
04026 
04027 /**
04028  * \defgroup CINDEX_DEBUG Debugging facilities
04029  *
04030  * These routines are used for testing and debugging, only, and should not
04031  * be relied upon.
04032  *
04033  * @{
04034  */
04035 
04036 /* for debug/testing */
04037 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
04038 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
04039                                           const char **startBuf,
04040                                           const char **endBuf,
04041                                           unsigned *startLine,
04042                                           unsigned *startColumn,
04043                                           unsigned *endLine,
04044                                           unsigned *endColumn);
04045 CINDEX_LINKAGE void clang_enableStackTraces(void);
04046 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
04047                                           unsigned stack_size);
04048 
04049 /**
04050  * @}
04051  */
04052 
04053 /**
04054  * \defgroup CINDEX_CODE_COMPLET Code completion
04055  *
04056  * Code completion involves taking an (incomplete) source file, along with
04057  * knowledge of where the user is actively editing that file, and suggesting
04058  * syntactically- and semantically-valid constructs that the user might want to
04059  * use at that particular point in the source code. These data structures and
04060  * routines provide support for code completion.
04061  *
04062  * @{
04063  */
04064 
04065 /**
04066  * \brief A semantic string that describes a code-completion result.
04067  *
04068  * A semantic string that describes the formatting of a code-completion
04069  * result as a single "template" of text that should be inserted into the
04070  * source buffer when a particular code-completion result is selected.
04071  * Each semantic string is made up of some number of "chunks", each of which
04072  * contains some text along with a description of what that text means, e.g.,
04073  * the name of the entity being referenced, whether the text chunk is part of
04074  * the template, or whether it is a "placeholder" that the user should replace
04075  * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
04076  * description of the different kinds of chunks.
04077  */
04078 typedef void *CXCompletionString;
04079 
04080 /**
04081  * \brief A single result of code completion.
04082  */
04083 typedef struct {
04084   /**
04085    * \brief The kind of entity that this completion refers to.
04086    *
04087    * The cursor kind will be a macro, keyword, or a declaration (one of the
04088    * *Decl cursor kinds), describing the entity that the completion is
04089    * referring to.
04090    *
04091    * \todo In the future, we would like to provide a full cursor, to allow
04092    * the client to extract additional information from declaration.
04093    */
04094   enum CXCursorKind CursorKind;
04095 
04096   /**
04097    * \brief The code-completion string that describes how to insert this
04098    * code-completion result into the editing buffer.
04099    */
04100   CXCompletionString CompletionString;
04101 } CXCompletionResult;
04102 
04103 /**
04104  * \brief Describes a single piece of text within a code-completion string.
04105  *
04106  * Each "chunk" within a code-completion string (\c CXCompletionString) is
04107  * either a piece of text with a specific "kind" that describes how that text
04108  * should be interpreted by the client or is another completion string.
04109  */
04110 enum CXCompletionChunkKind {
04111   /**
04112    * \brief A code-completion string that describes "optional" text that
04113    * could be a part of the template (but is not required).
04114    *
04115    * The Optional chunk is the only kind of chunk that has a code-completion
04116    * string for its representation, which is accessible via
04117    * \c clang_getCompletionChunkCompletionString(). The code-completion string
04118    * describes an additional part of the template that is completely optional.
04119    * For example, optional chunks can be used to describe the placeholders for
04120    * arguments that match up with defaulted function parameters, e.g. given:
04121    *
04122    * \code
04123    * void f(int x, float y = 3.14, double z = 2.71828);
04124    * \endcode
04125    *
04126    * The code-completion string for this function would contain:
04127    *   - a TypedText chunk for "f".
04128    *   - a LeftParen chunk for "(".
04129    *   - a Placeholder chunk for "int x"
04130    *   - an Optional chunk containing the remaining defaulted arguments, e.g.,
04131    *       - a Comma chunk for ","
04132    *       - a Placeholder chunk for "float y"
04133    *       - an Optional chunk containing the last defaulted argument:
04134    *           - a Comma chunk for ","
04135    *           - a Placeholder chunk for "double z"
04136    *   - a RightParen chunk for ")"
04137    *
04138    * There are many ways to handle Optional chunks. Two simple approaches are:
04139    *   - Completely ignore optional chunks, in which case the template for the
04140    *     function "f" would only include the first parameter ("int x").
04141    *   - Fully expand all optional chunks, in which case the template for the
04142    *     function "f" would have all of the parameters.
04143    */
04144   CXCompletionChunk_Optional,
04145   /**
04146    * \brief Text that a user would be expected to type to get this
04147    * code-completion result.
04148    *
04149    * There will be exactly one "typed text" chunk in a semantic string, which
04150    * will typically provide the spelling of a keyword or the name of a
04151    * declaration that could be used at the current code point. Clients are
04152    * expected to filter the code-completion results based on the text in this
04153    * chunk.
04154    */
04155   CXCompletionChunk_TypedText,
04156   /**
04157    * \brief Text that should be inserted as part of a code-completion result.
04158    *
04159    * A "text" chunk represents text that is part of the template to be
04160    * inserted into user code should this particular code-completion result
04161    * be selected.
04162    */
04163   CXCompletionChunk_Text,
04164   /**
04165    * \brief Placeholder text that should be replaced by the user.
04166    *
04167    * A "placeholder" chunk marks a place where the user should insert text
04168    * into the code-completion template. For example, placeholders might mark
04169    * the function parameters for a function declaration, to indicate that the
04170    * user should provide arguments for each of those parameters. The actual
04171    * text in a placeholder is a suggestion for the text to display before
04172    * the user replaces the placeholder with real code.
04173    */
04174   CXCompletionChunk_Placeholder,
04175   /**
04176    * \brief Informative text that should be displayed but never inserted as
04177    * part of the template.
04178    *
04179    * An "informative" chunk contains annotations that can be displayed to
04180    * help the user decide whether a particular code-completion result is the
04181    * right option, but which is not part of the actual template to be inserted
04182    * by code completion.
04183    */
04184   CXCompletionChunk_Informative,
04185   /**
04186    * \brief Text that describes the current parameter when code-completion is
04187    * referring to function call, message send, or template specialization.
04188    *
04189    * A "current parameter" chunk occurs when code-completion is providing
04190    * information about a parameter corresponding to the argument at the
04191    * code-completion point. For example, given a function
04192    *
04193    * \code
04194    * int add(int x, int y);
04195    * \endcode
04196    *
04197    * and the source code \c add(, where the code-completion point is after the
04198    * "(", the code-completion string will contain a "current parameter" chunk
04199    * for "int x", indicating that the current argument will initialize that
04200    * parameter. After typing further, to \c add(17, (where the code-completion
04201    * point is after the ","), the code-completion string will contain a
04202    * "current paremeter" chunk to "int y".
04203    */
04204   CXCompletionChunk_CurrentParameter,
04205   /**
04206    * \brief A left parenthesis ('('), used to initiate a function call or
04207    * signal the beginning of a function parameter list.
04208    */
04209   CXCompletionChunk_LeftParen,
04210   /**
04211    * \brief A right parenthesis (')'), used to finish a function call or
04212    * signal the end of a function parameter list.
04213    */
04214   CXCompletionChunk_RightParen,
04215   /**
04216    * \brief A left bracket ('[').
04217    */
04218   CXCompletionChunk_LeftBracket,
04219   /**
04220    * \brief A right bracket (']').
04221    */
04222   CXCompletionChunk_RightBracket,
04223   /**
04224    * \brief A left brace ('{').
04225    */
04226   CXCompletionChunk_LeftBrace,
04227   /**
04228    * \brief A right brace ('}').
04229    */
04230   CXCompletionChunk_RightBrace,
04231   /**
04232    * \brief A left angle bracket ('<').
04233    */
04234   CXCompletionChunk_LeftAngle,
04235   /**
04236    * \brief A right angle bracket ('>').
04237    */
04238   CXCompletionChunk_RightAngle,
04239   /**
04240    * \brief A comma separator (',').
04241    */
04242   CXCompletionChunk_Comma,
04243   /**
04244    * \brief Text that specifies the result type of a given result.
04245    *
04246    * This special kind of informative chunk is not meant to be inserted into
04247    * the text buffer. Rather, it is meant to illustrate the type that an
04248    * expression using the given completion string would have.
04249    */
04250   CXCompletionChunk_ResultType,
04251   /**
04252    * \brief A colon (':').
04253    */
04254   CXCompletionChunk_Colon,
04255   /**
04256    * \brief A semicolon (';').
04257    */
04258   CXCompletionChunk_SemiColon,
04259   /**
04260    * \brief An '=' sign.
04261    */
04262   CXCompletionChunk_Equal,
04263   /**
04264    * Horizontal space (' ').
04265    */
04266   CXCompletionChunk_HorizontalSpace,
04267   /**
04268    * Vertical space ('\n'), after which it is generally a good idea to
04269    * perform indentation.
04270    */
04271   CXCompletionChunk_VerticalSpace
04272 };
04273 
04274 /**
04275  * \brief Determine the kind of a particular chunk within a completion string.
04276  *
04277  * \param completion_string the completion string to query.
04278  *
04279  * \param chunk_number the 0-based index of the chunk in the completion string.
04280  *
04281  * \returns the kind of the chunk at the index \c chunk_number.
04282  */
04283 CINDEX_LINKAGE enum CXCompletionChunkKind
04284 clang_getCompletionChunkKind(CXCompletionString completion_string,
04285                              unsigned chunk_number);
04286 
04287 /**
04288  * \brief Retrieve the text associated with a particular chunk within a
04289  * completion string.
04290  *
04291  * \param completion_string the completion string to query.
04292  *
04293  * \param chunk_number the 0-based index of the chunk in the completion string.
04294  *
04295  * \returns the text associated with the chunk at index \c chunk_number.
04296  */
04297 CINDEX_LINKAGE CXString
04298 clang_getCompletionChunkText(CXCompletionString completion_string,
04299                              unsigned chunk_number);
04300 
04301 /**
04302  * \brief Retrieve the completion string associated with a particular chunk
04303  * within a completion string.
04304  *
04305  * \param completion_string the completion string to query.
04306  *
04307  * \param chunk_number the 0-based index of the chunk in the completion string.
04308  *
04309  * \returns the completion string associated with the chunk at index
04310  * \c chunk_number.
04311  */
04312 CINDEX_LINKAGE CXCompletionString
04313 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
04314                                          unsigned chunk_number);
04315 
04316 /**
04317  * \brief Retrieve the number of chunks in the given code-completion string.
04318  */
04319 CINDEX_LINKAGE unsigned
04320 clang_getNumCompletionChunks(CXCompletionString completion_string);
04321 
04322 /**
04323  * \brief Determine the priority of this code completion.
04324  *
04325  * The priority of a code completion indicates how likely it is that this 
04326  * particular completion is the completion that the user will select. The
04327  * priority is selected by various internal heuristics.
04328  *
04329  * \param completion_string The completion string to query.
04330  *
04331  * \returns The priority of this completion string. Smaller values indicate
04332  * higher-priority (more likely) completions.
04333  */
04334 CINDEX_LINKAGE unsigned
04335 clang_getCompletionPriority(CXCompletionString completion_string);
04336   
04337 /**
04338  * \brief Determine the availability of the entity that this code-completion
04339  * string refers to.
04340  *
04341  * \param completion_string The completion string to query.
04342  *
04343  * \returns The availability of the completion string.
04344  */
04345 CINDEX_LINKAGE enum CXAvailabilityKind 
04346 clang_getCompletionAvailability(CXCompletionString completion_string);
04347 
04348 /**
04349  * \brief Retrieve the number of annotations associated with the given
04350  * completion string.
04351  *
04352  * \param completion_string the completion string to query.
04353  *
04354  * \returns the number of annotations associated with the given completion
04355  * string.
04356  */
04357 CINDEX_LINKAGE unsigned
04358 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
04359 
04360 /**
04361  * \brief Retrieve the annotation associated with the given completion string.
04362  *
04363  * \param completion_string the completion string to query.
04364  *
04365  * \param annotation_number the 0-based index of the annotation of the
04366  * completion string.
04367  *
04368  * \returns annotation string associated with the completion at index
04369  * \c annotation_number, or a NULL string if that annotation is not available.
04370  */
04371 CINDEX_LINKAGE CXString
04372 clang_getCompletionAnnotation(CXCompletionString completion_string,
04373                               unsigned annotation_number);
04374 
04375 /**
04376  * \brief Retrieve the parent context of the given completion string.
04377  *
04378  * The parent context of a completion string is the semantic parent of 
04379  * the declaration (if any) that the code completion represents. For example,
04380  * a code completion for an Objective-C method would have the method's class
04381  * or protocol as its context.
04382  *
04383  * \param completion_string The code completion string whose parent is
04384  * being queried.
04385  *
04386  * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
04387  *
04388  * \returns The name of the completion parent, e.g., "NSObject" if
04389  * the completion string represents a method in the NSObject class.
04390  */
04391 CINDEX_LINKAGE CXString
04392 clang_getCompletionParent(CXCompletionString completion_string,
04393                           enum CXCursorKind *kind);
04394 
04395 /**
04396  * \brief Retrieve the brief documentation comment attached to the declaration
04397  * that corresponds to the given completion string.
04398  */
04399 CINDEX_LINKAGE CXString
04400 clang_getCompletionBriefComment(CXCompletionString completion_string);
04401 
04402 /**
04403  * \brief Retrieve a completion string for an arbitrary declaration or macro
04404  * definition cursor.
04405  *
04406  * \param cursor The cursor to query.
04407  *
04408  * \returns A non-context-sensitive completion string for declaration and macro
04409  * definition cursors, or NULL for other kinds of cursors.
04410  */
04411 CINDEX_LINKAGE CXCompletionString
04412 clang_getCursorCompletionString(CXCursor cursor);
04413   
04414 /**
04415  * \brief Contains the results of code-completion.
04416  *
04417  * This data structure contains the results of code completion, as
04418  * produced by \c clang_codeCompleteAt(). Its contents must be freed by
04419  * \c clang_disposeCodeCompleteResults.
04420  */
04421 typedef struct {
04422   /**
04423    * \brief The code-completion results.
04424    */
04425   CXCompletionResult *Results;
04426 
04427   /**
04428    * \brief The number of code-completion results stored in the
04429    * \c Results array.
04430    */
04431   unsigned NumResults;
04432 } CXCodeCompleteResults;
04433 
04434 /**
04435  * \brief Flags that can be passed to \c clang_codeCompleteAt() to
04436  * modify its behavior.
04437  *
04438  * The enumerators in this enumeration can be bitwise-OR'd together to
04439  * provide multiple options to \c clang_codeCompleteAt().
04440  */
04441 enum CXCodeComplete_Flags {
04442   /**
04443    * \brief Whether to include macros within the set of code
04444    * completions returned.
04445    */
04446   CXCodeComplete_IncludeMacros = 0x01,
04447 
04448   /**
04449    * \brief Whether to include code patterns for language constructs
04450    * within the set of code completions, e.g., for loops.
04451    */
04452   CXCodeComplete_IncludeCodePatterns = 0x02,
04453 
04454   /**
04455    * \brief Whether to include brief documentation within the set of code
04456    * completions returned.
04457    */
04458   CXCodeComplete_IncludeBriefComments = 0x04
04459 };
04460 
04461 /**
04462  * \brief Bits that represent the context under which completion is occurring.
04463  *
04464  * The enumerators in this enumeration may be bitwise-OR'd together if multiple
04465  * contexts are occurring simultaneously.
04466  */
04467 enum CXCompletionContext {
04468   /**
04469    * \brief The context for completions is unexposed, as only Clang results
04470    * should be included. (This is equivalent to having no context bits set.)
04471    */
04472   CXCompletionContext_Unexposed = 0,
04473   
04474   /**
04475    * \brief Completions for any possible type should be included in the results.
04476    */
04477   CXCompletionContext_AnyType = 1 << 0,
04478   
04479   /**
04480    * \brief Completions for any possible value (variables, function calls, etc.)
04481    * should be included in the results.
04482    */
04483   CXCompletionContext_AnyValue = 1 << 1,
04484   /**
04485    * \brief Completions for values that resolve to an Objective-C object should
04486    * be included in the results.
04487    */
04488   CXCompletionContext_ObjCObjectValue = 1 << 2,
04489   /**
04490    * \brief Completions for values that resolve to an Objective-C selector
04491    * should be included in the results.
04492    */
04493   CXCompletionContext_ObjCSelectorValue = 1 << 3,
04494   /**
04495    * \brief Completions for values that resolve to a C++ class type should be
04496    * included in the results.
04497    */
04498   CXCompletionContext_CXXClassTypeValue = 1 << 4,
04499   
04500   /**
04501    * \brief Completions for fields of the member being accessed using the dot
04502    * operator should be included in the results.
04503    */
04504   CXCompletionContext_DotMemberAccess = 1 << 5,
04505   /**
04506    * \brief Completions for fields of the member being accessed using the arrow
04507    * operator should be included in the results.
04508    */
04509   CXCompletionContext_ArrowMemberAccess = 1 << 6,
04510   /**
04511    * \brief Completions for properties of the Objective-C object being accessed
04512    * using the dot operator should be included in the results.
04513    */
04514   CXCompletionContext_ObjCPropertyAccess = 1 << 7,
04515   
04516   /**
04517    * \brief Completions for enum tags should be included in the results.
04518    */
04519   CXCompletionContext_EnumTag = 1 << 8,
04520   /**
04521    * \brief Completions for union tags should be included in the results.
04522    */
04523   CXCompletionContext_UnionTag = 1 << 9,
04524   /**
04525    * \brief Completions for struct tags should be included in the results.
04526    */
04527   CXCompletionContext_StructTag = 1 << 10,
04528   
04529   /**
04530    * \brief Completions for C++ class names should be included in the results.
04531    */
04532   CXCompletionContext_ClassTag = 1 << 11,
04533   /**
04534    * \brief Completions for C++ namespaces and namespace aliases should be
04535    * included in the results.
04536    */
04537   CXCompletionContext_Namespace = 1 << 12,
04538   /**
04539    * \brief Completions for C++ nested name specifiers should be included in
04540    * the results.
04541    */
04542   CXCompletionContext_NestedNameSpecifier = 1 << 13,
04543   
04544   /**
04545    * \brief Completions for Objective-C interfaces (classes) should be included
04546    * in the results.
04547    */
04548   CXCompletionContext_ObjCInterface = 1 << 14,
04549   /**
04550    * \brief Completions for Objective-C protocols should be included in
04551    * the results.
04552    */
04553   CXCompletionContext_ObjCProtocol = 1 << 15,
04554   /**
04555    * \brief Completions for Objective-C categories should be included in
04556    * the results.
04557    */
04558   CXCompletionContext_ObjCCategory = 1 << 16,
04559   /**
04560    * \brief Completions for Objective-C instance messages should be included
04561    * in the results.
04562    */
04563   CXCompletionContext_ObjCInstanceMessage = 1 << 17,
04564   /**
04565    * \brief Completions for Objective-C class messages should be included in
04566    * the results.
04567    */
04568   CXCompletionContext_ObjCClassMessage = 1 << 18,
04569   /**
04570    * \brief Completions for Objective-C selector names should be included in
04571    * the results.
04572    */
04573   CXCompletionContext_ObjCSelectorName = 1 << 19,
04574   
04575   /**
04576    * \brief Completions for preprocessor macro names should be included in
04577    * the results.
04578    */
04579   CXCompletionContext_MacroName = 1 << 20,
04580   
04581   /**
04582    * \brief Natural language completions should be included in the results.
04583    */
04584   CXCompletionContext_NaturalLanguage = 1 << 21,
04585   
04586   /**
04587    * \brief The current context is unknown, so set all contexts.
04588    */
04589   CXCompletionContext_Unknown = ((1 << 22) - 1)
04590 };
04591   
04592 /**
04593  * \brief Returns a default set of code-completion options that can be
04594  * passed to\c clang_codeCompleteAt(). 
04595  */
04596 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
04597 
04598 /**
04599  * \brief Perform code completion at a given location in a translation unit.
04600  *
04601  * This function performs code completion at a particular file, line, and
04602  * column within source code, providing results that suggest potential
04603  * code snippets based on the context of the completion. The basic model
04604  * for code completion is that Clang will parse a complete source file,
04605  * performing syntax checking up to the location where code-completion has
04606  * been requested. At that point, a special code-completion token is passed
04607  * to the parser, which recognizes this token and determines, based on the
04608  * current location in the C/Objective-C/C++ grammar and the state of
04609  * semantic analysis, what completions to provide. These completions are
04610  * returned via a new \c CXCodeCompleteResults structure.
04611  *
04612  * Code completion itself is meant to be triggered by the client when the
04613  * user types punctuation characters or whitespace, at which point the
04614  * code-completion location will coincide with the cursor. For example, if \c p
04615  * is a pointer, code-completion might be triggered after the "-" and then
04616  * after the ">" in \c p->. When the code-completion location is afer the ">",
04617  * the completion results will provide, e.g., the members of the struct that
04618  * "p" points to. The client is responsible for placing the cursor at the
04619  * beginning of the token currently being typed, then filtering the results
04620  * based on the contents of the token. For example, when code-completing for
04621  * the expression \c p->get, the client should provide the location just after
04622  * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
04623  * client can filter the results based on the current token text ("get"), only
04624  * showing those results that start with "get". The intent of this interface
04625  * is to separate the relatively high-latency acquisition of code-completion
04626  * results from the filtering of results on a per-character basis, which must
04627  * have a lower latency.
04628  *
04629  * \param TU The translation unit in which code-completion should
04630  * occur. The source files for this translation unit need not be
04631  * completely up-to-date (and the contents of those source files may
04632  * be overridden via \p unsaved_files). Cursors referring into the
04633  * translation unit may be invalidated by this invocation.
04634  *
04635  * \param complete_filename The name of the source file where code
04636  * completion should be performed. This filename may be any file
04637  * included in the translation unit.
04638  *
04639  * \param complete_line The line at which code-completion should occur.
04640  *
04641  * \param complete_column The column at which code-completion should occur.
04642  * Note that the column should point just after the syntactic construct that
04643  * initiated code completion, and not in the middle of a lexical token.
04644  *
04645  * \param unsaved_files the Tiles that have not yet been saved to disk
04646  * but may be required for parsing or code completion, including the
04647  * contents of those files.  The contents and name of these files (as
04648  * specified by CXUnsavedFile) are copied when necessary, so the
04649  * client only needs to guarantee their validity until the call to
04650  * this function returns.
04651  *
04652  * \param num_unsaved_files The number of unsaved file entries in \p
04653  * unsaved_files.
04654  *
04655  * \param options Extra options that control the behavior of code
04656  * completion, expressed as a bitwise OR of the enumerators of the
04657  * CXCodeComplete_Flags enumeration. The 
04658  * \c clang_defaultCodeCompleteOptions() function returns a default set
04659  * of code-completion options.
04660  *
04661  * \returns If successful, a new \c CXCodeCompleteResults structure
04662  * containing code-completion results, which should eventually be
04663  * freed with \c clang_disposeCodeCompleteResults(). If code
04664  * completion fails, returns NULL.
04665  */
04666 CINDEX_LINKAGE
04667 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
04668                                             const char *complete_filename,
04669                                             unsigned complete_line,
04670                                             unsigned complete_column,
04671                                             struct CXUnsavedFile *unsaved_files,
04672                                             unsigned num_unsaved_files,
04673                                             unsigned options);
04674 
04675 /**
04676  * \brief Sort the code-completion results in case-insensitive alphabetical 
04677  * order.
04678  *
04679  * \param Results The set of results to sort.
04680  * \param NumResults The number of results in \p Results.
04681  */
04682 CINDEX_LINKAGE
04683 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
04684                                      unsigned NumResults);
04685   
04686 /**
04687  * \brief Free the given set of code-completion results.
04688  */
04689 CINDEX_LINKAGE
04690 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
04691   
04692 /**
04693  * \brief Determine the number of diagnostics produced prior to the
04694  * location where code completion was performed.
04695  */
04696 CINDEX_LINKAGE
04697 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
04698 
04699 /**
04700  * \brief Retrieve a diagnostic associated with the given code completion.
04701  *
04702  * \param Results the code completion results to query.
04703  * \param Index the zero-based diagnostic number to retrieve.
04704  *
04705  * \returns the requested diagnostic. This diagnostic must be freed
04706  * via a call to \c clang_disposeDiagnostic().
04707  */
04708 CINDEX_LINKAGE
04709 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
04710                                              unsigned Index);
04711 
04712 /**
04713  * \brief Determines what completions are appropriate for the context
04714  * the given code completion.
04715  * 
04716  * \param Results the code completion results to query
04717  *
04718  * \returns the kinds of completions that are appropriate for use
04719  * along with the given code completion results.
04720  */
04721 CINDEX_LINKAGE
04722 unsigned long long clang_codeCompleteGetContexts(
04723                                                 CXCodeCompleteResults *Results);
04724 
04725 /**
04726  * \brief Returns the cursor kind for the container for the current code
04727  * completion context. The container is only guaranteed to be set for
04728  * contexts where a container exists (i.e. member accesses or Objective-C
04729  * message sends); if there is not a container, this function will return
04730  * CXCursor_InvalidCode.
04731  *
04732  * \param Results the code completion results to query
04733  *
04734  * \param IsIncomplete on return, this value will be false if Clang has complete
04735  * information about the container. If Clang does not have complete
04736  * information, this value will be true.
04737  *
04738  * \returns the container kind, or CXCursor_InvalidCode if there is not a
04739  * container
04740  */
04741 CINDEX_LINKAGE
04742 enum CXCursorKind clang_codeCompleteGetContainerKind(
04743                                                  CXCodeCompleteResults *Results,
04744                                                      unsigned *IsIncomplete);
04745 
04746 /**
04747  * \brief Returns the USR for the container for the current code completion
04748  * context. If there is not a container for the current context, this
04749  * function will return the empty string.
04750  *
04751  * \param Results the code completion results to query
04752  *
04753  * \returns the USR for the container
04754  */
04755 CINDEX_LINKAGE
04756 CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
04757   
04758   
04759 /**
04760  * \brief Returns the currently-entered selector for an Objective-C message
04761  * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
04762  * non-empty string for CXCompletionContext_ObjCInstanceMessage and
04763  * CXCompletionContext_ObjCClassMessage.
04764  *
04765  * \param Results the code completion results to query
04766  *
04767  * \returns the selector (or partial selector) that has been entered thus far
04768  * for an Objective-C message send.
04769  */
04770 CINDEX_LINKAGE
04771 CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
04772   
04773 /**
04774  * @}
04775  */
04776 
04777 
04778 /**
04779  * \defgroup CINDEX_MISC Miscellaneous utility functions
04780  *
04781  * @{
04782  */
04783 
04784 /**
04785  * \brief Return a version string, suitable for showing to a user, but not
04786  *        intended to be parsed (the format is not guaranteed to be stable).
04787  */
04788 CINDEX_LINKAGE CXString clang_getClangVersion(void);
04789 
04790   
04791 /**
04792  * \brief Enable/disable crash recovery.
04793  *
04794  * \param isEnabled Flag to indicate if crash recovery is enabled.  A non-zero
04795  *        value enables crash recovery, while 0 disables it.
04796  */
04797 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
04798   
04799  /**
04800   * \brief Visitor invoked for each file in a translation unit
04801   *        (used with clang_getInclusions()).
04802   *
04803   * This visitor function will be invoked by clang_getInclusions() for each
04804   * file included (either at the top-level or by \#include directives) within
04805   * a translation unit.  The first argument is the file being included, and
04806   * the second and third arguments provide the inclusion stack.  The
04807   * array is sorted in order of immediate inclusion.  For example,
04808   * the first element refers to the location that included 'included_file'.
04809   */
04810 typedef void (*CXInclusionVisitor)(CXFile included_file,
04811                                    CXSourceLocation* inclusion_stack,
04812                                    unsigned include_len,
04813                                    CXClientData client_data);
04814 
04815 /**
04816  * \brief Visit the set of preprocessor inclusions in a translation unit.
04817  *   The visitor function is called with the provided data for every included
04818  *   file.  This does not include headers included by the PCH file (unless one
04819  *   is inspecting the inclusions in the PCH file itself).
04820  */
04821 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
04822                                         CXInclusionVisitor visitor,
04823                                         CXClientData client_data);
04824 
04825 /**
04826  * @}
04827  */
04828 
04829 /** \defgroup CINDEX_REMAPPING Remapping functions
04830  *
04831  * @{
04832  */
04833 
04834 /**
04835  * \brief A remapping of original source files and their translated files.
04836  */
04837 typedef void *CXRemapping;
04838 
04839 /**
04840  * \brief Retrieve a remapping.
04841  *
04842  * \param path the path that contains metadata about remappings.
04843  *
04844  * \returns the requested remapping. This remapping must be freed
04845  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
04846  */
04847 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
04848 
04849 /**
04850  * \brief Retrieve a remapping.
04851  *
04852  * \param filePaths pointer to an array of file paths containing remapping info.
04853  *
04854  * \param numFiles number of file paths.
04855  *
04856  * \returns the requested remapping. This remapping must be freed
04857  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
04858  */
04859 CINDEX_LINKAGE
04860 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
04861                                             unsigned numFiles);
04862 
04863 /**
04864  * \brief Determine the number of remappings.
04865  */
04866 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
04867 
04868 /**
04869  * \brief Get the original and the associated filename from the remapping.
04870  * 
04871  * \param original If non-NULL, will be set to the original filename.
04872  *
04873  * \param transformed If non-NULL, will be set to the filename that the original
04874  * is associated with.
04875  */
04876 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
04877                                      CXString *original, CXString *transformed);
04878 
04879 /**
04880  * \brief Dispose the remapping.
04881  */
04882 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
04883 
04884 /**
04885  * @}
04886  */
04887 
04888 /** \defgroup CINDEX_HIGH Higher level API functions
04889  *
04890  * @{
04891  */
04892 
04893 enum CXVisitorResult {
04894   CXVisit_Break,
04895   CXVisit_Continue
04896 };
04897 
04898 typedef struct {
04899   void *context;
04900   enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
04901 } CXCursorAndRangeVisitor;
04902 
04903 typedef enum {
04904   /**
04905    * \brief Function returned successfully.
04906    */
04907   CXResult_Success = 0,
04908   /**
04909    * \brief One of the parameters was invalid for the function.
04910    */
04911   CXResult_Invalid = 1,
04912   /**
04913    * \brief The function was terminated by a callback (e.g. it returned
04914    * CXVisit_Break)
04915    */
04916   CXResult_VisitBreak = 2
04917 
04918 } CXResult;
04919 
04920 /**
04921  * \brief Find references of a declaration in a specific file.
04922  * 
04923  * \param cursor pointing to a declaration or a reference of one.
04924  *
04925  * \param file to search for references.
04926  *
04927  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
04928  * each reference found.
04929  * The CXSourceRange will point inside the file; if the reference is inside
04930  * a macro (and not a macro argument) the CXSourceRange will be invalid.
04931  *
04932  * \returns one of the CXResult enumerators.
04933  */
04934 CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file,
04935                                                CXCursorAndRangeVisitor visitor);
04936 
04937 /**
04938  * \brief Find #import/#include directives in a specific file.
04939  *
04940  * \param TU translation unit containing the file to query.
04941  *
04942  * \param file to search for #import/#include directives.
04943  *
04944  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
04945  * each directive found.
04946  *
04947  * \returns one of the CXResult enumerators.
04948  */
04949 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
04950                                                  CXFile file,
04951                                               CXCursorAndRangeVisitor visitor);
04952 
04953 #ifdef __has_feature
04954 #  if __has_feature(blocks)
04955 
04956 typedef enum CXVisitorResult
04957     (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
04958 
04959 CINDEX_LINKAGE
04960 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
04961                                              CXCursorAndRangeVisitorBlock);
04962 
04963 CINDEX_LINKAGE
04964 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
04965                                            CXCursorAndRangeVisitorBlock);
04966 
04967 #  endif
04968 #endif
04969 
04970 /**
04971  * \brief The client's data object that is associated with a CXFile.
04972  */
04973 typedef void *CXIdxClientFile;
04974 
04975 /**
04976  * \brief The client's data object that is associated with a semantic entity.
04977  */
04978 typedef void *CXIdxClientEntity;
04979 
04980 /**
04981  * \brief The client's data object that is associated with a semantic container
04982  * of entities.
04983  */
04984 typedef void *CXIdxClientContainer;
04985 
04986 /**
04987  * \brief The client's data object that is associated with an AST file (PCH
04988  * or module).
04989  */
04990 typedef void *CXIdxClientASTFile;
04991 
04992 /**
04993  * \brief Source location passed to index callbacks.
04994  */
04995 typedef struct {
04996   void *ptr_data[2];
04997   unsigned int_data;
04998 } CXIdxLoc;
04999 
05000 /**
05001  * \brief Data for ppIncludedFile callback.
05002  */
05003 typedef struct {
05004   /**
05005    * \brief Location of '#' in the \#include/\#import directive.
05006    */
05007   CXIdxLoc hashLoc;
05008   /**
05009    * \brief Filename as written in the \#include/\#import directive.
05010    */
05011   const char *filename;
05012   /**
05013    * \brief The actual file that the \#include/\#import directive resolved to.
05014    */
05015   CXFile file;
05016   int isImport;
05017   int isAngled;
05018   /**
05019    * \brief Non-zero if the directive was automatically turned into a module
05020    * import.
05021    */
05022   int isModuleImport;
05023 } CXIdxIncludedFileInfo;
05024 
05025 /**
05026  * \brief Data for IndexerCallbacks#importedASTFile.
05027  */
05028 typedef struct {
05029   /**
05030    * \brief Top level AST file containing the imported PCH, module or submodule.
05031    */
05032   CXFile file;
05033   /**
05034    * \brief The imported module or NULL if the AST file is a PCH.
05035    */
05036   CXModule module;
05037   /**
05038    * \brief Location where the file is imported. Applicable only for modules.
05039    */
05040   CXIdxLoc loc;
05041   /**
05042    * \brief Non-zero if an inclusion directive was automatically turned into
05043    * a module import. Applicable only for modules.
05044    */
05045   int isImplicit;
05046 
05047 } CXIdxImportedASTFileInfo;
05048 
05049 typedef enum {
05050   CXIdxEntity_Unexposed     = 0,
05051   CXIdxEntity_Typedef       = 1,
05052   CXIdxEntity_Function      = 2,
05053   CXIdxEntity_Variable      = 3,
05054   CXIdxEntity_Field         = 4,
05055   CXIdxEntity_EnumConstant  = 5,
05056 
05057   CXIdxEntity_ObjCClass     = 6,
05058   CXIdxEntity_ObjCProtocol  = 7,
05059   CXIdxEntity_ObjCCategory  = 8,
05060 
05061   CXIdxEntity_ObjCInstanceMethod = 9,
05062   CXIdxEntity_ObjCClassMethod    = 10,
05063   CXIdxEntity_ObjCProperty  = 11,
05064   CXIdxEntity_ObjCIvar      = 12,
05065 
05066   CXIdxEntity_Enum          = 13,
05067   CXIdxEntity_Struct        = 14,
05068   CXIdxEntity_Union         = 15,
05069 
05070   CXIdxEntity_CXXClass              = 16,
05071   CXIdxEntity_CXXNamespace          = 17,
05072   CXIdxEntity_CXXNamespaceAlias     = 18,
05073   CXIdxEntity_CXXStaticVariable     = 19,
05074   CXIdxEntity_CXXStaticMethod       = 20,
05075   CXIdxEntity_CXXInstanceMethod     = 21,
05076   CXIdxEntity_CXXConstructor        = 22,
05077   CXIdxEntity_CXXDestructor         = 23,
05078   CXIdxEntity_CXXConversionFunction = 24,
05079   CXIdxEntity_CXXTypeAlias          = 25,
05080   CXIdxEntity_CXXInterface          = 26
05081 
05082 } CXIdxEntityKind;
05083 
05084 typedef enum {
05085   CXIdxEntityLang_None = 0,
05086   CXIdxEntityLang_C    = 1,
05087   CXIdxEntityLang_ObjC = 2,
05088   CXIdxEntityLang_CXX  = 3
05089 } CXIdxEntityLanguage;
05090 
05091 /**
05092  * \brief Extra C++ template information for an entity. This can apply to:
05093  * CXIdxEntity_Function
05094  * CXIdxEntity_CXXClass
05095  * CXIdxEntity_CXXStaticMethod
05096  * CXIdxEntity_CXXInstanceMethod
05097  * CXIdxEntity_CXXConstructor
05098  * CXIdxEntity_CXXConversionFunction
05099  * CXIdxEntity_CXXTypeAlias
05100  */
05101 typedef enum {
05102   CXIdxEntity_NonTemplate   = 0,
05103   CXIdxEntity_Template      = 1,
05104   CXIdxEntity_TemplatePartialSpecialization = 2,
05105   CXIdxEntity_TemplateSpecialization = 3
05106 } CXIdxEntityCXXTemplateKind;
05107 
05108 typedef enum {
05109   CXIdxAttr_Unexposed     = 0,
05110   CXIdxAttr_IBAction      = 1,
05111   CXIdxAttr_IBOutlet      = 2,
05112   CXIdxAttr_IBOutletCollection = 3
05113 } CXIdxAttrKind;
05114 
05115 typedef struct {
05116   CXIdxAttrKind kind;
05117   CXCursor cursor;
05118   CXIdxLoc loc;
05119 } CXIdxAttrInfo;
05120 
05121 typedef struct {
05122   CXIdxEntityKind kind;
05123   CXIdxEntityCXXTemplateKind templateKind;
05124   CXIdxEntityLanguage lang;
05125   const char *name;
05126   const char *USR;
05127   CXCursor cursor;
05128   const CXIdxAttrInfo *const *attributes;
05129   unsigned numAttributes;
05130 } CXIdxEntityInfo;
05131 
05132 typedef struct {
05133   CXCursor cursor;
05134 } CXIdxContainerInfo;
05135 
05136 typedef struct {
05137   const CXIdxAttrInfo *attrInfo;
05138   const CXIdxEntityInfo *objcClass;
05139   CXCursor classCursor;
05140   CXIdxLoc classLoc;
05141 } CXIdxIBOutletCollectionAttrInfo;
05142 
05143 typedef enum {
05144   CXIdxDeclFlag_Skipped = 0x1
05145 } CXIdxDeclInfoFlags;
05146 
05147 typedef struct {
05148   const CXIdxEntityInfo *entityInfo;
05149   CXCursor cursor;
05150   CXIdxLoc loc;
05151   const CXIdxContainerInfo *semanticContainer;
05152   /**
05153    * \brief Generally same as #semanticContainer but can be different in
05154    * cases like out-of-line C++ member functions.
05155    */
05156   const CXIdxContainerInfo *lexicalContainer;
05157   int isRedeclaration;
05158   int isDefinition;
05159   int isContainer;
05160   const CXIdxContainerInfo *declAsContainer;
05161   /**
05162    * \brief Whether the declaration exists in code or was created implicitly
05163    * by the compiler, e.g. implicit Objective-C methods for properties.
05164    */
05165   int isImplicit;
05166   const CXIdxAttrInfo *const *attributes;
05167   unsigned numAttributes;
05168 
05169   unsigned flags;
05170 
05171 } CXIdxDeclInfo;
05172 
05173 typedef enum {
05174   CXIdxObjCContainer_ForwardRef = 0,
05175   CXIdxObjCContainer_Interface = 1,
05176   CXIdxObjCContainer_Implementation = 2
05177 } CXIdxObjCContainerKind;
05178 
05179 typedef struct {
05180   const CXIdxDeclInfo *declInfo;
05181   CXIdxObjCContainerKind kind;
05182 } CXIdxObjCContainerDeclInfo;
05183 
05184 typedef struct {
05185   const CXIdxEntityInfo *base;
05186   CXCursor cursor;
05187   CXIdxLoc loc;
05188 } CXIdxBaseClassInfo;
05189 
05190 typedef struct {
05191   const CXIdxEntityInfo *protocol;
05192   CXCursor cursor;
05193   CXIdxLoc loc;
05194 } CXIdxObjCProtocolRefInfo;
05195 
05196 typedef struct {
05197   const CXIdxObjCProtocolRefInfo *const *protocols;
05198   unsigned numProtocols;
05199 } CXIdxObjCProtocolRefListInfo;
05200 
05201 typedef struct {
05202   const CXIdxObjCContainerDeclInfo *containerInfo;
05203   const CXIdxBaseClassInfo *superInfo;
05204   const CXIdxObjCProtocolRefListInfo *protocols;
05205 } CXIdxObjCInterfaceDeclInfo;
05206 
05207 typedef struct {
05208   const CXIdxObjCContainerDeclInfo *containerInfo;
05209   const CXIdxEntityInfo *objcClass;
05210   CXCursor classCursor;
05211   CXIdxLoc classLoc;
05212   const CXIdxObjCProtocolRefListInfo *protocols;
05213 } CXIdxObjCCategoryDeclInfo;
05214 
05215 typedef struct {
05216   const CXIdxDeclInfo *declInfo;
05217   const CXIdxEntityInfo *getter;
05218   const CXIdxEntityInfo *setter;
05219 } CXIdxObjCPropertyDeclInfo;
05220 
05221 typedef struct {
05222   const CXIdxDeclInfo *declInfo;
05223   const CXIdxBaseClassInfo *const *bases;
05224   unsigned numBases;
05225 } CXIdxCXXClassDeclInfo;
05226 
05227 /**
05228  * \brief Data for IndexerCallbacks#indexEntityReference.
05229  */
05230 typedef enum {
05231   /**
05232    * \brief The entity is referenced directly in user's code.
05233    */
05234   CXIdxEntityRef_Direct = 1,
05235   /**
05236    * \brief An implicit reference, e.g. a reference of an Objective-C method
05237    * via the dot syntax.
05238    */
05239   CXIdxEntityRef_Implicit = 2
05240 } CXIdxEntityRefKind;
05241 
05242 /**
05243  * \brief Data for IndexerCallbacks#indexEntityReference.
05244  */
05245 typedef struct {
05246   CXIdxEntityRefKind kind;
05247   /**
05248    * \brief Reference cursor.
05249    */
05250   CXCursor cursor;
05251   CXIdxLoc loc;
05252   /**
05253    * \brief The entity that gets referenced.
05254    */
05255   const CXIdxEntityInfo *referencedEntity;
05256   /**
05257    * \brief Immediate "parent" of the reference. For example:
05258    * 
05259    * \code
05260    * Foo *var;
05261    * \endcode
05262    * 
05263    * The parent of reference of type 'Foo' is the variable 'var'.
05264    * For references inside statement bodies of functions/methods,
05265    * the parentEntity will be the function/method.
05266    */
05267   const CXIdxEntityInfo *parentEntity;
05268   /**
05269    * \brief Lexical container context of the reference.
05270    */
05271   const CXIdxContainerInfo *container;
05272 } CXIdxEntityRefInfo;
05273 
05274 /**
05275  * \brief A group of callbacks used by #clang_indexSourceFile and
05276  * #clang_indexTranslationUnit.
05277  */
05278 typedef struct {
05279   /**
05280    * \brief Called periodically to check whether indexing should be aborted.
05281    * Should return 0 to continue, and non-zero to abort.
05282    */
05283   int (*abortQuery)(CXClientData client_data, void *reserved);
05284 
05285   /**
05286    * \brief Called at the end of indexing; passes the complete diagnostic set.
05287    */
05288   void (*diagnostic)(CXClientData client_data,
05289                      CXDiagnosticSet, void *reserved);
05290 
05291   CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
05292                                      CXFile mainFile, void *reserved);
05293   
05294   /**
05295    * \brief Called when a file gets \#included/\#imported.
05296    */
05297   CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
05298                                     const CXIdxIncludedFileInfo *);
05299   
05300   /**
05301    * \brief Called when a AST file (PCH or module) gets imported.
05302    * 
05303    * AST files will not get indexed (there will not be callbacks to index all
05304    * the entities in an AST file). The recommended action is that, if the AST
05305    * file is not already indexed, to initiate a new indexing job specific to
05306    * the AST file.
05307    */
05308   CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
05309                                         const CXIdxImportedASTFileInfo *);
05310 
05311   /**
05312    * \brief Called at the beginning of indexing a translation unit.
05313    */
05314   CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
05315                                                  void *reserved);
05316 
05317   void (*indexDeclaration)(CXClientData client_data,
05318                            const CXIdxDeclInfo *);
05319 
05320   /**
05321    * \brief Called to index a reference of an entity.
05322    */
05323   void (*indexEntityReference)(CXClientData client_data,
05324                                const CXIdxEntityRefInfo *);
05325 
05326 } IndexerCallbacks;
05327 
05328 CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
05329 CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
05330 clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
05331 
05332 CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
05333 clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
05334 
05335 CINDEX_LINKAGE
05336 const CXIdxObjCCategoryDeclInfo *
05337 clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
05338 
05339 CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
05340 clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
05341 
05342 CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
05343 clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
05344 
05345 CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
05346 clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
05347 
05348 CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
05349 clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
05350 
05351 /**
05352  * \brief For retrieving a custom CXIdxClientContainer attached to a
05353  * container.
05354  */
05355 CINDEX_LINKAGE CXIdxClientContainer
05356 clang_index_getClientContainer(const CXIdxContainerInfo *);
05357 
05358 /**
05359  * \brief For setting a custom CXIdxClientContainer attached to a
05360  * container.
05361  */
05362 CINDEX_LINKAGE void
05363 clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
05364 
05365 /**
05366  * \brief For retrieving a custom CXIdxClientEntity attached to an entity.
05367  */
05368 CINDEX_LINKAGE CXIdxClientEntity
05369 clang_index_getClientEntity(const CXIdxEntityInfo *);
05370 
05371 /**
05372  * \brief For setting a custom CXIdxClientEntity attached to an entity.
05373  */
05374 CINDEX_LINKAGE void
05375 clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
05376 
05377 /**
05378  * \brief An indexing action/session, to be applied to one or multiple
05379  * translation units.
05380  */
05381 typedef void *CXIndexAction;
05382 
05383 /**
05384  * \brief An indexing action/session, to be applied to one or multiple
05385  * translation units.
05386  *
05387  * \param CIdx The index object with which the index action will be associated.
05388  */
05389 CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
05390 
05391 /**
05392  * \brief Destroy the given index action.
05393  *
05394  * The index action must not be destroyed until all of the translation units
05395  * created within that index action have been destroyed.
05396  */
05397 CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
05398 
05399 typedef enum {
05400   /**
05401    * \brief Used to indicate that no special indexing options are needed.
05402    */
05403   CXIndexOpt_None = 0x0,
05404   
05405   /**
05406    * \brief Used to indicate that IndexerCallbacks#indexEntityReference should
05407    * be invoked for only one reference of an entity per source file that does
05408    * not also include a declaration/definition of the entity.
05409    */
05410   CXIndexOpt_SuppressRedundantRefs = 0x1,
05411 
05412   /**
05413    * \brief Function-local symbols should be indexed. If this is not set
05414    * function-local symbols will be ignored.
05415    */
05416   CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
05417 
05418   /**
05419    * \brief Implicit function/class template instantiations should be indexed.
05420    * If this is not set, implicit instantiations will be ignored.
05421    */
05422   CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
05423 
05424   /**
05425    * \brief Suppress all compiler warnings when parsing for indexing.
05426    */
05427   CXIndexOpt_SuppressWarnings = 0x8,
05428 
05429   /**
05430    * \brief Skip a function/method body that was already parsed during an
05431    * indexing session associated with a \c CXIndexAction object.
05432    * Bodies in system headers are always skipped.
05433    */
05434   CXIndexOpt_SkipParsedBodiesInSession = 0x10
05435 
05436 } CXIndexOptFlags;
05437 
05438 /**
05439  * \brief Index the given source file and the translation unit corresponding
05440  * to that file via callbacks implemented through #IndexerCallbacks.
05441  *
05442  * \param client_data pointer data supplied by the client, which will
05443  * be passed to the invoked callbacks.
05444  *
05445  * \param index_callbacks Pointer to indexing callbacks that the client
05446  * implements.
05447  *
05448  * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
05449  * passed in index_callbacks.
05450  *
05451  * \param index_options A bitmask of options that affects how indexing is
05452  * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
05453  *
05454  * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
05455  * reused after indexing is finished. Set to \c NULL if you do not require it.
05456  *
05457  * \returns 0 on success or if there were errors from which the compiler could
05458  * recover.  If there is a failure from which the there is no recovery, returns
05459  * a non-zero \c CXErrorCode.
05460  *
05461  * The rest of the parameters are the same as #clang_parseTranslationUnit.
05462  */
05463 CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
05464                                          CXClientData client_data,
05465                                          IndexerCallbacks *index_callbacks,
05466                                          unsigned index_callbacks_size,
05467                                          unsigned index_options,
05468                                          const char *source_filename,
05469                                          const char * const *command_line_args,
05470                                          int num_command_line_args,
05471                                          struct CXUnsavedFile *unsaved_files,
05472                                          unsigned num_unsaved_files,
05473                                          CXTranslationUnit *out_TU,
05474                                          unsigned TU_options);
05475 
05476 /**
05477  * \brief Index the given translation unit via callbacks implemented through
05478  * #IndexerCallbacks.
05479  * 
05480  * The order of callback invocations is not guaranteed to be the same as
05481  * when indexing a source file. The high level order will be:
05482  * 
05483  *   -Preprocessor callbacks invocations
05484  *   -Declaration/reference callbacks invocations
05485  *   -Diagnostic callback invocations
05486  *
05487  * The parameters are the same as #clang_indexSourceFile.
05488  * 
05489  * \returns If there is a failure from which the there is no recovery, returns
05490  * non-zero, otherwise returns 0.
05491  */
05492 CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
05493                                               CXClientData client_data,
05494                                               IndexerCallbacks *index_callbacks,
05495                                               unsigned index_callbacks_size,
05496                                               unsigned index_options,
05497                                               CXTranslationUnit);
05498 
05499 /**
05500  * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by
05501  * the given CXIdxLoc.
05502  *
05503  * If the location refers into a macro expansion, retrieves the
05504  * location of the macro expansion and if it refers into a macro argument
05505  * retrieves the location of the argument.
05506  */
05507 CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
05508                                                    CXIdxClientFile *indexFile,
05509                                                    CXFile *file,
05510                                                    unsigned *line,
05511                                                    unsigned *column,
05512                                                    unsigned *offset);
05513 
05514 /**
05515  * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
05516  */
05517 CINDEX_LINKAGE
05518 CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
05519 
05520 /**
05521  * @}
05522  */
05523 
05524 /**
05525  * @}
05526  */
05527 
05528 /* Include the comment API for compatibility. This will eventually go away. */
05529 #include "clang-c/Documentation.h"
05530 
05531 #ifdef __cplusplus
05532 }
05533 #endif
05534 #endif
05535