clang  mainline
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 30
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 statement ";": 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   /** \brief OpenMP teams directive.
02225    */
02226   CXCursor_OMPTeamsDirective             = 253,
02227 
02228   CXCursor_LastStmt                      = CXCursor_OMPTeamsDirective,
02229 
02230   /**
02231    * \brief Cursor that represents the translation unit itself.
02232    *
02233    * The translation unit cursor exists primarily to act as the root
02234    * cursor for traversing the contents of a translation unit.
02235    */
02236   CXCursor_TranslationUnit               = 300,
02237 
02238   /* Attributes */
02239   CXCursor_FirstAttr                     = 400,
02240   /**
02241    * \brief An attribute whose specific kind is not exposed via this
02242    * interface.
02243    */
02244   CXCursor_UnexposedAttr                 = 400,
02245 
02246   CXCursor_IBActionAttr                  = 401,
02247   CXCursor_IBOutletAttr                  = 402,
02248   CXCursor_IBOutletCollectionAttr        = 403,
02249   CXCursor_CXXFinalAttr                  = 404,
02250   CXCursor_CXXOverrideAttr               = 405,
02251   CXCursor_AnnotateAttr                  = 406,
02252   CXCursor_AsmLabelAttr                  = 407,
02253   CXCursor_PackedAttr                    = 408,
02254   CXCursor_PureAttr                      = 409,
02255   CXCursor_ConstAttr                     = 410,
02256   CXCursor_NoDuplicateAttr               = 411,
02257   CXCursor_CUDAConstantAttr              = 412,
02258   CXCursor_CUDADeviceAttr                = 413,
02259   CXCursor_CUDAGlobalAttr                = 414,
02260   CXCursor_CUDAHostAttr                  = 415,
02261   CXCursor_CUDASharedAttr                = 416,
02262   CXCursor_LastAttr                      = CXCursor_CUDASharedAttr,
02263 
02264   /* Preprocessing */
02265   CXCursor_PreprocessingDirective        = 500,
02266   CXCursor_MacroDefinition               = 501,
02267   CXCursor_MacroExpansion                = 502,
02268   CXCursor_MacroInstantiation            = CXCursor_MacroExpansion,
02269   CXCursor_InclusionDirective            = 503,
02270   CXCursor_FirstPreprocessing            = CXCursor_PreprocessingDirective,
02271   CXCursor_LastPreprocessing             = CXCursor_InclusionDirective,
02272 
02273   /* Extra Declarations */
02274   /**
02275    * \brief A module import declaration.
02276    */
02277   CXCursor_ModuleImportDecl              = 600,
02278   CXCursor_FirstExtraDecl                = CXCursor_ModuleImportDecl,
02279   CXCursor_LastExtraDecl                 = CXCursor_ModuleImportDecl,
02280 
02281   /**
02282    * \brief A code completion overload candidate.
02283    */
02284   CXCursor_OverloadCandidate             = 700
02285 };
02286 
02287 /**
02288  * \brief A cursor representing some element in the abstract syntax tree for
02289  * a translation unit.
02290  *
02291  * The cursor abstraction unifies the different kinds of entities in a
02292  * program--declaration, statements, expressions, references to declarations,
02293  * etc.--under a single "cursor" abstraction with a common set of operations.
02294  * Common operation for a cursor include: getting the physical location in
02295  * a source file where the cursor points, getting the name associated with a
02296  * cursor, and retrieving cursors for any child nodes of a particular cursor.
02297  *
02298  * Cursors can be produced in two specific ways.
02299  * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
02300  * from which one can use clang_visitChildren() to explore the rest of the
02301  * translation unit. clang_getCursor() maps from a physical source location
02302  * to the entity that resides at that location, allowing one to map from the
02303  * source code into the AST.
02304  */
02305 typedef struct {
02306   enum CXCursorKind kind;
02307   int xdata;
02308   const void *data[3];
02309 } CXCursor;
02310 
02311 /**
02312  * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
02313  *
02314  * @{
02315  */
02316 
02317 /**
02318  * \brief Retrieve the NULL cursor, which represents no entity.
02319  */
02320 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
02321 
02322 /**
02323  * \brief Retrieve the cursor that represents the given translation unit.
02324  *
02325  * The translation unit cursor can be used to start traversing the
02326  * various declarations within the given translation unit.
02327  */
02328 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
02329 
02330 /**
02331  * \brief Determine whether two cursors are equivalent.
02332  */
02333 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
02334 
02335 /**
02336  * \brief Returns non-zero if \p cursor is null.
02337  */
02338 CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
02339 
02340 /**
02341  * \brief Compute a hash value for the given cursor.
02342  */
02343 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
02344   
02345 /**
02346  * \brief Retrieve the kind of the given cursor.
02347  */
02348 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
02349 
02350 /**
02351  * \brief Determine whether the given cursor kind represents a declaration.
02352  */
02353 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
02354 
02355 /**
02356  * \brief Determine whether the given cursor kind represents a simple
02357  * reference.
02358  *
02359  * Note that other kinds of cursors (such as expressions) can also refer to
02360  * other cursors. Use clang_getCursorReferenced() to determine whether a
02361  * particular cursor refers to another entity.
02362  */
02363 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
02364 
02365 /**
02366  * \brief Determine whether the given cursor kind represents an expression.
02367  */
02368 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
02369 
02370 /**
02371  * \brief Determine whether the given cursor kind represents a statement.
02372  */
02373 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
02374 
02375 /**
02376  * \brief Determine whether the given cursor kind represents an attribute.
02377  */
02378 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
02379 
02380 /**
02381  * \brief Determine whether the given cursor kind represents an invalid
02382  * cursor.
02383  */
02384 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
02385 
02386 /**
02387  * \brief Determine whether the given cursor kind represents a translation
02388  * unit.
02389  */
02390 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
02391 
02392 /***
02393  * \brief Determine whether the given cursor represents a preprocessing
02394  * element, such as a preprocessor directive or macro instantiation.
02395  */
02396 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
02397   
02398 /***
02399  * \brief Determine whether the given cursor represents a currently
02400  *  unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
02401  */
02402 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
02403 
02404 /**
02405  * \brief Describe the linkage of the entity referred to by a cursor.
02406  */
02407 enum CXLinkageKind {
02408   /** \brief This value indicates that no linkage information is available
02409    * for a provided CXCursor. */
02410   CXLinkage_Invalid,
02411   /**
02412    * \brief This is the linkage for variables, parameters, and so on that
02413    *  have automatic storage.  This covers normal (non-extern) local variables.
02414    */
02415   CXLinkage_NoLinkage,
02416   /** \brief This is the linkage for static variables and static functions. */
02417   CXLinkage_Internal,
02418   /** \brief This is the linkage for entities with external linkage that live
02419    * in C++ anonymous namespaces.*/
02420   CXLinkage_UniqueExternal,
02421   /** \brief This is the linkage for entities with true, external linkage. */
02422   CXLinkage_External
02423 };
02424 
02425 /**
02426  * \brief Determine the linkage of the entity referred to by a given cursor.
02427  */
02428 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
02429 
02430 /**
02431  * \brief Determine the availability of the entity that this cursor refers to,
02432  * taking the current target platform into account.
02433  *
02434  * \param cursor The cursor to query.
02435  *
02436  * \returns The availability of the cursor.
02437  */
02438 CINDEX_LINKAGE enum CXAvailabilityKind 
02439 clang_getCursorAvailability(CXCursor cursor);
02440 
02441 /**
02442  * Describes the availability of a given entity on a particular platform, e.g.,
02443  * a particular class might only be available on Mac OS 10.7 or newer.
02444  */
02445 typedef struct CXPlatformAvailability {
02446   /**
02447    * \brief A string that describes the platform for which this structure
02448    * provides availability information.
02449    *
02450    * Possible values are "ios" or "macosx".
02451    */
02452   CXString Platform;
02453   /**
02454    * \brief The version number in which this entity was introduced.
02455    */
02456   CXVersion Introduced;
02457   /**
02458    * \brief The version number in which this entity was deprecated (but is
02459    * still available).
02460    */
02461   CXVersion Deprecated;
02462   /**
02463    * \brief The version number in which this entity was obsoleted, and therefore
02464    * is no longer available.
02465    */
02466   CXVersion Obsoleted;
02467   /**
02468    * \brief Whether the entity is unconditionally unavailable on this platform.
02469    */
02470   int Unavailable;
02471   /**
02472    * \brief An optional message to provide to a user of this API, e.g., to
02473    * suggest replacement APIs.
02474    */
02475   CXString Message;
02476 } CXPlatformAvailability;
02477 
02478 /**
02479  * \brief Determine the availability of the entity that this cursor refers to
02480  * on any platforms for which availability information is known.
02481  *
02482  * \param cursor The cursor to query.
02483  *
02484  * \param always_deprecated If non-NULL, will be set to indicate whether the 
02485  * entity is deprecated on all platforms.
02486  *
02487  * \param deprecated_message If non-NULL, will be set to the message text 
02488  * provided along with the unconditional deprecation of this entity. The client
02489  * is responsible for deallocating this string.
02490  *
02491  * \param always_unavailable If non-NULL, will be set to indicate whether the
02492  * entity is unavailable on all platforms.
02493  *
02494  * \param unavailable_message If non-NULL, will be set to the message text
02495  * provided along with the unconditional unavailability of this entity. The 
02496  * client is responsible for deallocating this string.
02497  *
02498  * \param availability If non-NULL, an array of CXPlatformAvailability instances
02499  * that will be populated with platform availability information, up to either
02500  * the number of platforms for which availability information is available (as
02501  * returned by this function) or \c availability_size, whichever is smaller.
02502  *
02503  * \param availability_size The number of elements available in the 
02504  * \c availability array.
02505  *
02506  * \returns The number of platforms (N) for which availability information is
02507  * available (which is unrelated to \c availability_size).
02508  *
02509  * Note that the client is responsible for calling 
02510  * \c clang_disposeCXPlatformAvailability to free each of the 
02511  * platform-availability structures returned. There are 
02512  * \c min(N, availability_size) such structures.
02513  */
02514 CINDEX_LINKAGE int
02515 clang_getCursorPlatformAvailability(CXCursor cursor,
02516                                     int *always_deprecated,
02517                                     CXString *deprecated_message,
02518                                     int *always_unavailable,
02519                                     CXString *unavailable_message,
02520                                     CXPlatformAvailability *availability,
02521                                     int availability_size);
02522 
02523 /**
02524  * \brief Free the memory associated with a \c CXPlatformAvailability structure.
02525  */
02526 CINDEX_LINKAGE void
02527 clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
02528   
02529 /**
02530  * \brief Describe the "language" of the entity referred to by a cursor.
02531  */
02532 enum CXLanguageKind {
02533   CXLanguage_Invalid = 0,
02534   CXLanguage_C,
02535   CXLanguage_ObjC,
02536   CXLanguage_CPlusPlus
02537 };
02538 
02539 /**
02540  * \brief Determine the "language" of the entity referred to by a given cursor.
02541  */
02542 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
02543 
02544 /**
02545  * \brief Returns the translation unit that a cursor originated from.
02546  */
02547 CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
02548 
02549 
02550 /**
02551  * \brief A fast container representing a set of CXCursors.
02552  */
02553 typedef struct CXCursorSetImpl *CXCursorSet;
02554 
02555 /**
02556  * \brief Creates an empty CXCursorSet.
02557  */
02558 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
02559 
02560 /**
02561  * \brief Disposes a CXCursorSet and releases its associated memory.
02562  */
02563 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
02564 
02565 /**
02566  * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
02567  *
02568  * \returns non-zero if the set contains the specified cursor.
02569 */
02570 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
02571                                                    CXCursor cursor);
02572 
02573 /**
02574  * \brief Inserts a CXCursor into a CXCursorSet.
02575  *
02576  * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
02577 */
02578 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
02579                                                  CXCursor cursor);
02580 
02581 /**
02582  * \brief Determine the semantic parent of the given cursor.
02583  *
02584  * The semantic parent of a cursor is the cursor that semantically contains
02585  * the given \p cursor. For many declarations, the lexical and semantic parents
02586  * are equivalent (the lexical parent is returned by 
02587  * \c clang_getCursorLexicalParent()). They diverge when declarations or
02588  * definitions are provided out-of-line. For example:
02589  *
02590  * \code
02591  * class C {
02592  *  void f();
02593  * };
02594  *
02595  * void C::f() { }
02596  * \endcode
02597  *
02598  * In the out-of-line definition of \c C::f, the semantic parent is
02599  * the class \c C, of which this function is a member. The lexical parent is
02600  * the place where the declaration actually occurs in the source code; in this
02601  * case, the definition occurs in the translation unit. In general, the
02602  * lexical parent for a given entity can change without affecting the semantics
02603  * of the program, and the lexical parent of different declarations of the
02604  * same entity may be different. Changing the semantic parent of a declaration,
02605  * on the other hand, can have a major impact on semantics, and redeclarations
02606  * of a particular entity should all have the same semantic context.
02607  *
02608  * In the example above, both declarations of \c C::f have \c C as their
02609  * semantic context, while the lexical context of the first \c C::f is \c C
02610  * and the lexical context of the second \c C::f is the translation unit.
02611  *
02612  * For global declarations, the semantic parent is the translation unit.
02613  */
02614 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
02615 
02616 /**
02617  * \brief Determine the lexical parent of the given cursor.
02618  *
02619  * The lexical parent of a cursor is the cursor in which the given \p cursor
02620  * was actually written. For many declarations, the lexical and semantic parents
02621  * are equivalent (the semantic parent is returned by 
02622  * \c clang_getCursorSemanticParent()). They diverge when declarations or
02623  * definitions are provided out-of-line. For example:
02624  *
02625  * \code
02626  * class C {
02627  *  void f();
02628  * };
02629  *
02630  * void C::f() { }
02631  * \endcode
02632  *
02633  * In the out-of-line definition of \c C::f, the semantic parent is
02634  * the class \c C, of which this function is a member. The lexical parent is
02635  * the place where the declaration actually occurs in the source code; in this
02636  * case, the definition occurs in the translation unit. In general, the
02637  * lexical parent for a given entity can change without affecting the semantics
02638  * of the program, and the lexical parent of different declarations of the
02639  * same entity may be different. Changing the semantic parent of a declaration,
02640  * on the other hand, can have a major impact on semantics, and redeclarations
02641  * of a particular entity should all have the same semantic context.
02642  *
02643  * In the example above, both declarations of \c C::f have \c C as their
02644  * semantic context, while the lexical context of the first \c C::f is \c C
02645  * and the lexical context of the second \c C::f is the translation unit.
02646  *
02647  * For declarations written in the global scope, the lexical parent is
02648  * the translation unit.
02649  */
02650 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
02651 
02652 /**
02653  * \brief Determine the set of methods that are overridden by the given
02654  * method.
02655  *
02656  * In both Objective-C and C++, a method (aka virtual member function,
02657  * in C++) can override a virtual method in a base class. For
02658  * Objective-C, a method is said to override any method in the class's
02659  * base class, its protocols, or its categories' protocols, that has the same
02660  * selector and is of the same kind (class or instance).
02661  * If no such method exists, the search continues to the class's superclass,
02662  * its protocols, and its categories, and so on. A method from an Objective-C
02663  * implementation is considered to override the same methods as its
02664  * corresponding method in the interface.
02665  *
02666  * For C++, a virtual member function overrides any virtual member
02667  * function with the same signature that occurs in its base
02668  * classes. With multiple inheritance, a virtual member function can
02669  * override several virtual member functions coming from different
02670  * base classes.
02671  *
02672  * In all cases, this function determines the immediate overridden
02673  * method, rather than all of the overridden methods. For example, if
02674  * a method is originally declared in a class A, then overridden in B
02675  * (which in inherits from A) and also in C (which inherited from B),
02676  * then the only overridden method returned from this function when
02677  * invoked on C's method will be B's method. The client may then
02678  * invoke this function again, given the previously-found overridden
02679  * methods, to map out the complete method-override set.
02680  *
02681  * \param cursor A cursor representing an Objective-C or C++
02682  * method. This routine will compute the set of methods that this
02683  * method overrides.
02684  * 
02685  * \param overridden A pointer whose pointee will be replaced with a
02686  * pointer to an array of cursors, representing the set of overridden
02687  * methods. If there are no overridden methods, the pointee will be
02688  * set to NULL. The pointee must be freed via a call to 
02689  * \c clang_disposeOverriddenCursors().
02690  *
02691  * \param num_overridden A pointer to the number of overridden
02692  * functions, will be set to the number of overridden functions in the
02693  * array pointed to by \p overridden.
02694  */
02695 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor, 
02696                                                CXCursor **overridden,
02697                                                unsigned *num_overridden);
02698 
02699 /**
02700  * \brief Free the set of overridden cursors returned by \c
02701  * clang_getOverriddenCursors().
02702  */
02703 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
02704 
02705 /**
02706  * \brief Retrieve the file that is included by the given inclusion directive
02707  * cursor.
02708  */
02709 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
02710   
02711 /**
02712  * @}
02713  */
02714 
02715 /**
02716  * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
02717  *
02718  * Cursors represent a location within the Abstract Syntax Tree (AST). These
02719  * routines help map between cursors and the physical locations where the
02720  * described entities occur in the source code. The mapping is provided in
02721  * both directions, so one can map from source code to the AST and back.
02722  *
02723  * @{
02724  */
02725 
02726 /**
02727  * \brief Map a source location to the cursor that describes the entity at that
02728  * location in the source code.
02729  *
02730  * clang_getCursor() maps an arbitrary source location within a translation
02731  * unit down to the most specific cursor that describes the entity at that
02732  * location. For example, given an expression \c x + y, invoking
02733  * clang_getCursor() with a source location pointing to "x" will return the
02734  * cursor for "x"; similarly for "y". If the cursor points anywhere between
02735  * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
02736  * will return a cursor referring to the "+" expression.
02737  *
02738  * \returns a cursor representing the entity at the given source location, or
02739  * a NULL cursor if no such entity can be found.
02740  */
02741 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
02742 
02743 /**
02744  * \brief Retrieve the physical location of the source constructor referenced
02745  * by the given cursor.
02746  *
02747  * The location of a declaration is typically the location of the name of that
02748  * declaration, where the name of that declaration would occur if it is
02749  * unnamed, or some keyword that introduces that particular declaration.
02750  * The location of a reference is where that reference occurs within the
02751  * source code.
02752  */
02753 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
02754 
02755 /**
02756  * \brief Retrieve the physical extent of the source construct referenced by
02757  * the given cursor.
02758  *
02759  * The extent of a cursor starts with the file/line/column pointing at the
02760  * first character within the source construct that the cursor refers to and
02761  * ends with the last character within that source construct. For a
02762  * declaration, the extent covers the declaration itself. For a reference,
02763  * the extent covers the location of the reference (e.g., where the referenced
02764  * entity was actually used).
02765  */
02766 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
02767 
02768 /**
02769  * @}
02770  */
02771     
02772 /**
02773  * \defgroup CINDEX_TYPES Type information for CXCursors
02774  *
02775  * @{
02776  */
02777 
02778 /**
02779  * \brief Describes the kind of type
02780  */
02781 enum CXTypeKind {
02782   /**
02783    * \brief Represents an invalid type (e.g., where no type is available).
02784    */
02785   CXType_Invalid = 0,
02786 
02787   /**
02788    * \brief A type whose specific kind is not exposed via this
02789    * interface.
02790    */
02791   CXType_Unexposed = 1,
02792 
02793   /* Builtin types */
02794   CXType_Void = 2,
02795   CXType_Bool = 3,
02796   CXType_Char_U = 4,
02797   CXType_UChar = 5,
02798   CXType_Char16 = 6,
02799   CXType_Char32 = 7,
02800   CXType_UShort = 8,
02801   CXType_UInt = 9,
02802   CXType_ULong = 10,
02803   CXType_ULongLong = 11,
02804   CXType_UInt128 = 12,
02805   CXType_Char_S = 13,
02806   CXType_SChar = 14,
02807   CXType_WChar = 15,
02808   CXType_Short = 16,
02809   CXType_Int = 17,
02810   CXType_Long = 18,
02811   CXType_LongLong = 19,
02812   CXType_Int128 = 20,
02813   CXType_Float = 21,
02814   CXType_Double = 22,
02815   CXType_LongDouble = 23,
02816   CXType_NullPtr = 24,
02817   CXType_Overload = 25,
02818   CXType_Dependent = 26,
02819   CXType_ObjCId = 27,
02820   CXType_ObjCClass = 28,
02821   CXType_ObjCSel = 29,
02822   CXType_FirstBuiltin = CXType_Void,
02823   CXType_LastBuiltin  = CXType_ObjCSel,
02824 
02825   CXType_Complex = 100,
02826   CXType_Pointer = 101,
02827   CXType_BlockPointer = 102,
02828   CXType_LValueReference = 103,
02829   CXType_RValueReference = 104,
02830   CXType_Record = 105,
02831   CXType_Enum = 106,
02832   CXType_Typedef = 107,
02833   CXType_ObjCInterface = 108,
02834   CXType_ObjCObjectPointer = 109,
02835   CXType_FunctionNoProto = 110,
02836   CXType_FunctionProto = 111,
02837   CXType_ConstantArray = 112,
02838   CXType_Vector = 113,
02839   CXType_IncompleteArray = 114,
02840   CXType_VariableArray = 115,
02841   CXType_DependentSizedArray = 116,
02842   CXType_MemberPointer = 117
02843 };
02844 
02845 /**
02846  * \brief Describes the calling convention of a function type
02847  */
02848 enum CXCallingConv {
02849   CXCallingConv_Default = 0,
02850   CXCallingConv_C = 1,
02851   CXCallingConv_X86StdCall = 2,
02852   CXCallingConv_X86FastCall = 3,
02853   CXCallingConv_X86ThisCall = 4,
02854   CXCallingConv_X86Pascal = 5,
02855   CXCallingConv_AAPCS = 6,
02856   CXCallingConv_AAPCS_VFP = 7,
02857   /* Value 8 was PnaclCall, but it was never used, so it could safely be re-used. */
02858   CXCallingConv_IntelOclBicc = 9,
02859   CXCallingConv_X86_64Win64 = 10,
02860   CXCallingConv_X86_64SysV = 11,
02861   CXCallingConv_X86VectorCall = 12,
02862 
02863   CXCallingConv_Invalid = 100,
02864   CXCallingConv_Unexposed = 200
02865 };
02866 
02867 
02868 /**
02869  * \brief The type of an element in the abstract syntax tree.
02870  *
02871  */
02872 typedef struct {
02873   enum CXTypeKind kind;
02874   void *data[2];
02875 } CXType;
02876 
02877 /**
02878  * \brief Retrieve the type of a CXCursor (if any).
02879  */
02880 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
02881 
02882 /**
02883  * \brief Pretty-print the underlying type using the rules of the
02884  * language of the translation unit from which it came.
02885  *
02886  * If the type is invalid, an empty string is returned.
02887  */
02888 CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
02889 
02890 /**
02891  * \brief Retrieve the underlying type of a typedef declaration.
02892  *
02893  * If the cursor does not reference a typedef declaration, an invalid type is
02894  * returned.
02895  */
02896 CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
02897 
02898 /**
02899  * \brief Retrieve the integer type of an enum declaration.
02900  *
02901  * If the cursor does not reference an enum declaration, an invalid type is
02902  * returned.
02903  */
02904 CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
02905 
02906 /**
02907  * \brief Retrieve the integer value of an enum constant declaration as a signed
02908  *  long long.
02909  *
02910  * If the cursor does not reference an enum constant declaration, LLONG_MIN 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 long long clang_getEnumConstantDeclValue(CXCursor C);
02915 
02916 /**
02917  * \brief Retrieve the integer value of an enum constant declaration as an unsigned
02918  *  long long.
02919  *
02920  * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
02921  * Since this is also potentially a valid constant value, the kind of the cursor
02922  * must be verified before calling this function.
02923  */
02924 CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C);
02925 
02926 /**
02927  * \brief Retrieve the bit width of a bit field declaration as an integer.
02928  *
02929  * If a cursor that is not a bit field declaration is passed in, -1 is returned.
02930  */
02931 CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
02932 
02933 /**
02934  * \brief Retrieve the number of non-variadic arguments associated with a given
02935  * cursor.
02936  *
02937  * The number of arguments can be determined for calls as well as for
02938  * declarations of functions or methods. For other cursors -1 is returned.
02939  */
02940 CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
02941 
02942 /**
02943  * \brief Retrieve the argument cursor of a function or method.
02944  *
02945  * The argument cursor can be determined for calls as well as for declarations
02946  * of functions or methods. For other cursors and for invalid indices, an
02947  * invalid cursor is returned.
02948  */
02949 CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
02950 
02951 /**
02952  * \brief Describes the kind of a template argument.
02953  *
02954  * See the definition of llvm::clang::TemplateArgument::ArgKind for full
02955  * element descriptions.
02956  */
02957 enum CXTemplateArgumentKind {
02958   CXTemplateArgumentKind_Null,
02959   CXTemplateArgumentKind_Type,
02960   CXTemplateArgumentKind_Declaration,
02961   CXTemplateArgumentKind_NullPtr,
02962   CXTemplateArgumentKind_Integral,
02963   CXTemplateArgumentKind_Template,
02964   CXTemplateArgumentKind_TemplateExpansion,
02965   CXTemplateArgumentKind_Expression,
02966   CXTemplateArgumentKind_Pack,
02967   /* Indicates an error case, preventing the kind from being deduced. */
02968   CXTemplateArgumentKind_Invalid
02969 };
02970 
02971 /**
02972  *\brief Returns the number of template args of a function decl representing a
02973  * template specialization.
02974  *
02975  * If the argument cursor cannot be converted into a template function
02976  * declaration, -1 is returned.
02977  *
02978  * For example, for the following declaration and specialization:
02979  *   template <typename T, int kInt, bool kBool>
02980  *   void foo() { ... }
02981  *
02982  *   template <>
02983  *   void foo<float, -7, true>();
02984  *
02985  * The value 3 would be returned from this call.
02986  */
02987 CINDEX_LINKAGE int clang_Cursor_getNumTemplateArguments(CXCursor C);
02988 
02989 /**
02990  * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
02991  *
02992  * If the argument CXCursor does not represent a FunctionDecl, an invalid
02993  * template argument kind is returned.
02994  *
02995  * For example, for the following declaration and specialization:
02996  *   template <typename T, int kInt, bool kBool>
02997  *   void foo() { ... }
02998  *
02999  *   template <>
03000  *   void foo<float, -7, true>();
03001  *
03002  * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
03003  * respectively.
03004  */
03005 CINDEX_LINKAGE enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(
03006     CXCursor C, unsigned I);
03007 
03008 /**
03009  * \brief Retrieve a CXType representing the type of a TemplateArgument of a
03010  *  function decl representing a template specialization.
03011  *
03012  * If the argument CXCursor does not represent a FunctionDecl whose I'th
03013  * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
03014  * is returned.
03015  *
03016  * For example, for the following declaration and specialization:
03017  *   template <typename T, int kInt, bool kBool>
03018  *   void foo() { ... }
03019  *
03020  *   template <>
03021  *   void foo<float, -7, true>();
03022  *
03023  * If called with I = 0, "float", will be returned.
03024  * Invalid types will be returned for I == 1 or 2.
03025  */
03026 CINDEX_LINKAGE CXType clang_Cursor_getTemplateArgumentType(CXCursor C,
03027                                                            unsigned I);
03028 
03029 /**
03030  * \brief Retrieve the value of an Integral TemplateArgument (of a function
03031  *  decl representing a template specialization) as a signed long long.
03032  *
03033  * It is undefined to call this function on a CXCursor that does not represent a
03034  * FunctionDecl or whose I'th template argument is not an integral value.
03035  *
03036  * For example, for the following declaration and specialization:
03037  *   template <typename T, int kInt, bool kBool>
03038  *   void foo() { ... }
03039  *
03040  *   template <>
03041  *   void foo<float, -7, true>();
03042  *
03043  * If called with I = 1 or 2, -7 or true will be returned, respectively.
03044  * For I == 0, this function's behavior is undefined.
03045  */
03046 CINDEX_LINKAGE long long clang_Cursor_getTemplateArgumentValue(CXCursor C,
03047                                                                unsigned I);
03048 
03049 /**
03050  * \brief Retrieve the value of an Integral TemplateArgument (of a function
03051  *  decl representing a template specialization) as an unsigned long long.
03052  *
03053  * It is undefined to call this function on a CXCursor that does not represent a
03054  * FunctionDecl or whose I'th template argument is not an integral value.
03055  *
03056  * For example, for the following declaration and specialization:
03057  *   template <typename T, int kInt, bool kBool>
03058  *   void foo() { ... }
03059  *
03060  *   template <>
03061  *   void foo<float, 2147483649, true>();
03062  *
03063  * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
03064  * For I == 0, this function's behavior is undefined.
03065  */
03066 CINDEX_LINKAGE unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(
03067     CXCursor C, unsigned I);
03068 
03069 /**
03070  * \brief Determine whether two CXTypes represent the same type.
03071  *
03072  * \returns non-zero if the CXTypes represent the same type and
03073  *          zero otherwise.
03074  */
03075 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
03076 
03077 /**
03078  * \brief Return the canonical type for a CXType.
03079  *
03080  * Clang's type system explicitly models typedefs and all the ways
03081  * a specific type can be represented.  The canonical type is the underlying
03082  * type with all the "sugar" removed.  For example, if 'T' is a typedef
03083  * for 'int', the canonical type for 'T' would be 'int'.
03084  */
03085 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
03086 
03087 /**
03088  * \brief Determine whether a CXType has the "const" qualifier set,
03089  * without looking through typedefs that may have added "const" at a
03090  * different level.
03091  */
03092 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
03093 
03094 /**
03095  * \brief Determine whether a CXType has the "volatile" qualifier set,
03096  * without looking through typedefs that may have added "volatile" at
03097  * a different level.
03098  */
03099 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
03100 
03101 /**
03102  * \brief Determine whether a CXType has the "restrict" qualifier set,
03103  * without looking through typedefs that may have added "restrict" at a
03104  * different level.
03105  */
03106 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
03107 
03108 /**
03109  * \brief For pointer types, returns the type of the pointee.
03110  */
03111 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
03112 
03113 /**
03114  * \brief Return the cursor for the declaration of the given type.
03115  */
03116 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
03117 
03118 /**
03119  * Returns the Objective-C type encoding for the specified declaration.
03120  */
03121 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
03122 
03123 /**
03124  * \brief Retrieve the spelling of a given CXTypeKind.
03125  */
03126 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
03127 
03128 /**
03129  * \brief Retrieve the calling convention associated with a function type.
03130  *
03131  * If a non-function type is passed in, CXCallingConv_Invalid is returned.
03132  */
03133 CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
03134 
03135 /**
03136  * \brief Retrieve the return type associated with a function type.
03137  *
03138  * If a non-function type is passed in, an invalid type is returned.
03139  */
03140 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
03141 
03142 /**
03143  * \brief Retrieve the number of non-variadic parameters associated with a
03144  * function type.
03145  *
03146  * If a non-function type is passed in, -1 is returned.
03147  */
03148 CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
03149 
03150 /**
03151  * \brief Retrieve the type of a parameter of a function type.
03152  *
03153  * If a non-function type is passed in or the function does not have enough
03154  * parameters, an invalid type is returned.
03155  */
03156 CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
03157 
03158 /**
03159  * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
03160  */
03161 CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
03162 
03163 /**
03164  * \brief Retrieve the return type associated with a given cursor.
03165  *
03166  * This only returns a valid type if the cursor refers to a function or method.
03167  */
03168 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
03169 
03170 /**
03171  * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
03172  *  otherwise.
03173  */
03174 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
03175 
03176 /**
03177  * \brief Return the element type of an array, complex, or vector type.
03178  *
03179  * If a type is passed in that is not an array, complex, or vector type,
03180  * an invalid type is returned.
03181  */
03182 CINDEX_LINKAGE CXType clang_getElementType(CXType T);
03183 
03184 /**
03185  * \brief Return the number of elements of an array or vector type.
03186  *
03187  * If a type is passed in that is not an array or vector type,
03188  * -1 is returned.
03189  */
03190 CINDEX_LINKAGE long long clang_getNumElements(CXType T);
03191 
03192 /**
03193  * \brief Return the element type of an array type.
03194  *
03195  * If a non-array type is passed in, an invalid type is returned.
03196  */
03197 CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
03198 
03199 /**
03200  * \brief Return the array size of a constant array.
03201  *
03202  * If a non-array type is passed in, -1 is returned.
03203  */
03204 CINDEX_LINKAGE long long clang_getArraySize(CXType T);
03205 
03206 /**
03207  * \brief List the possible error codes for \c clang_Type_getSizeOf,
03208  *   \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
03209  *   \c clang_Cursor_getOffsetOf.
03210  *
03211  * A value of this enumeration type can be returned if the target type is not
03212  * a valid argument to sizeof, alignof or offsetof.
03213  */
03214 enum CXTypeLayoutError {
03215   /**
03216    * \brief Type is of kind CXType_Invalid.
03217    */
03218   CXTypeLayoutError_Invalid = -1,
03219   /**
03220    * \brief The type is an incomplete Type.
03221    */
03222   CXTypeLayoutError_Incomplete = -2,
03223   /**
03224    * \brief The type is a dependent Type.
03225    */
03226   CXTypeLayoutError_Dependent = -3,
03227   /**
03228    * \brief The type is not a constant size type.
03229    */
03230   CXTypeLayoutError_NotConstantSize = -4,
03231   /**
03232    * \brief The Field name is not valid for this record.
03233    */
03234   CXTypeLayoutError_InvalidFieldName = -5
03235 };
03236 
03237 /**
03238  * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
03239  *   standard.
03240  *
03241  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
03242  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
03243  *   is returned.
03244  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
03245  *   returned.
03246  * If the type declaration is not a constant size type,
03247  *   CXTypeLayoutError_NotConstantSize is returned.
03248  */
03249 CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
03250 
03251 /**
03252  * \brief Return the class type of an member pointer type.
03253  *
03254  * If a non-member-pointer type is passed in, an invalid type is returned.
03255  */
03256 CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
03257 
03258 /**
03259  * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
03260  *
03261  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
03262  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
03263  *   is returned.
03264  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
03265  *   returned.
03266  */
03267 CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
03268 
03269 /**
03270  * \brief Return the offset of a field named S in a record of type T in bits
03271  *   as it would be returned by __offsetof__ as per C++11[18.2p4]
03272  *
03273  * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
03274  *   is returned.
03275  * If the field's type declaration is an incomplete type,
03276  *   CXTypeLayoutError_Incomplete is returned.
03277  * If the field's type declaration is a dependent type,
03278  *   CXTypeLayoutError_Dependent is returned.
03279  * If the field's name S is not found,
03280  *   CXTypeLayoutError_InvalidFieldName is returned.
03281  */
03282 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
03283 
03284 /**
03285  * \brief Return the offset of the field represented by the Cursor.
03286  *
03287  * If the cursor is not a field declaration, -1 is returned.
03288  * If the cursor semantic parent is not a record field declaration,
03289  *   CXTypeLayoutError_Invalid is returned.
03290  * If the field's type declaration is an incomplete type,
03291  *   CXTypeLayoutError_Incomplete is returned.
03292  * If the field's type declaration is a dependent type,
03293  *   CXTypeLayoutError_Dependent is returned.
03294  * If the field's name S is not found,
03295  *   CXTypeLayoutError_InvalidFieldName is returned.
03296  */
03297 CINDEX_LINKAGE long long clang_Cursor_getOffsetOfField(CXCursor C);
03298 
03299 /**
03300  * \brief Determine whether the given cursor represents an anonymous record
03301  * declaration.
03302  */
03303 CINDEX_LINKAGE unsigned clang_Cursor_isAnonymous(CXCursor C);
03304 
03305 
03306 enum CXRefQualifierKind {
03307   /** \brief No ref-qualifier was provided. */
03308   CXRefQualifier_None = 0,
03309   /** \brief An lvalue ref-qualifier was provided (\c &). */
03310   CXRefQualifier_LValue,
03311   /** \brief An rvalue ref-qualifier was provided (\c &&). */
03312   CXRefQualifier_RValue
03313 };
03314 
03315 /**
03316  * \brief Returns the number of template arguments for given class template
03317  * specialization, or -1 if type \c T is not a class template specialization.
03318  *
03319  * Variadic argument packs count as only one argument, and can not be inspected
03320  * further.
03321  */
03322 CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
03323 
03324 /**
03325  * \brief Returns the type template argument of a template class specialization
03326  * at given index.
03327  *
03328  * This function only returns template type arguments and does not handle
03329  * template template arguments or variadic packs.
03330  */
03331 CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
03332 
03333 /**
03334  * \brief Retrieve the ref-qualifier kind of a function or method.
03335  *
03336  * The ref-qualifier is returned for C++ functions or methods. For other types
03337  * or non-C++ declarations, CXRefQualifier_None is returned.
03338  */
03339 CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
03340 
03341 /**
03342  * \brief Returns non-zero if the cursor specifies a Record member that is a
03343  *   bitfield.
03344  */
03345 CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
03346 
03347 /**
03348  * \brief Returns 1 if the base class specified by the cursor with kind
03349  *   CX_CXXBaseSpecifier is virtual.
03350  */
03351 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
03352     
03353 /**
03354  * \brief Represents the C++ access control level to a base class for a
03355  * cursor with kind CX_CXXBaseSpecifier.
03356  */
03357 enum CX_CXXAccessSpecifier {
03358   CX_CXXInvalidAccessSpecifier,
03359   CX_CXXPublic,
03360   CX_CXXProtected,
03361   CX_CXXPrivate
03362 };
03363 
03364 /**
03365  * \brief Returns the access control level for the referenced object.
03366  *
03367  * If the cursor refers to a C++ declaration, its access control level within its
03368  * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
03369  * access specifier, the specifier itself is returned.
03370  */
03371 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
03372 
03373 /**
03374  * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
03375  * was added for the case that the passed cursor in not a declaration.
03376  */
03377 enum CX_StorageClass {
03378   CX_SC_Invalid,
03379   CX_SC_None,
03380   CX_SC_Extern,
03381   CX_SC_Static,
03382   CX_SC_PrivateExtern,
03383   CX_SC_OpenCLWorkGroupLocal,
03384   CX_SC_Auto,
03385   CX_SC_Register
03386 };
03387 
03388 /**
03389  * \brief Returns the storage class for a function or variable declaration.
03390  *
03391  * If the passed in Cursor is not a function or variable declaration,
03392  * CX_SC_Invalid is returned else the storage class.
03393  */
03394 CINDEX_LINKAGE enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor);
03395 
03396 /**
03397  * \brief Determine the number of overloaded declarations referenced by a 
03398  * \c CXCursor_OverloadedDeclRef cursor.
03399  *
03400  * \param cursor The cursor whose overloaded declarations are being queried.
03401  *
03402  * \returns The number of overloaded declarations referenced by \c cursor. If it
03403  * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
03404  */
03405 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
03406 
03407 /**
03408  * \brief Retrieve a cursor for one of the overloaded declarations referenced
03409  * by a \c CXCursor_OverloadedDeclRef cursor.
03410  *
03411  * \param cursor The cursor whose overloaded declarations are being queried.
03412  *
03413  * \param index The zero-based index into the set of overloaded declarations in
03414  * the cursor.
03415  *
03416  * \returns A cursor representing the declaration referenced by the given 
03417  * \c cursor at the specified \c index. If the cursor does not have an 
03418  * associated set of overloaded declarations, or if the index is out of bounds,
03419  * returns \c clang_getNullCursor();
03420  */
03421 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor, 
03422                                                 unsigned index);
03423   
03424 /**
03425  * @}
03426  */
03427   
03428 /**
03429  * \defgroup CINDEX_ATTRIBUTES Information for attributes
03430  *
03431  * @{
03432  */
03433 
03434 
03435 /**
03436  * \brief For cursors representing an iboutletcollection attribute,
03437  *  this function returns the collection element type.
03438  *
03439  */
03440 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
03441 
03442 /**
03443  * @}
03444  */
03445 
03446 /**
03447  * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
03448  *
03449  * These routines provide the ability to traverse the abstract syntax tree
03450  * using cursors.
03451  *
03452  * @{
03453  */
03454 
03455 /**
03456  * \brief Describes how the traversal of the children of a particular
03457  * cursor should proceed after visiting a particular child cursor.
03458  *
03459  * A value of this enumeration type should be returned by each
03460  * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
03461  */
03462 enum CXChildVisitResult {
03463   /**
03464    * \brief Terminates the cursor traversal.
03465    */
03466   CXChildVisit_Break,
03467   /**
03468    * \brief Continues the cursor traversal with the next sibling of
03469    * the cursor just visited, without visiting its children.
03470    */
03471   CXChildVisit_Continue,
03472   /**
03473    * \brief Recursively traverse the children of this cursor, using
03474    * the same visitor and client data.
03475    */
03476   CXChildVisit_Recurse
03477 };
03478 
03479 /**
03480  * \brief Visitor invoked for each cursor found by a traversal.
03481  *
03482  * This visitor function will be invoked for each cursor found by
03483  * clang_visitCursorChildren(). Its first argument is the cursor being
03484  * visited, its second argument is the parent visitor for that cursor,
03485  * and its third argument is the client data provided to
03486  * clang_visitCursorChildren().
03487  *
03488  * The visitor should return one of the \c CXChildVisitResult values
03489  * to direct clang_visitCursorChildren().
03490  */
03491 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
03492                                                    CXCursor parent,
03493                                                    CXClientData client_data);
03494 
03495 /**
03496  * \brief Visit the children of a particular cursor.
03497  *
03498  * This function visits all the direct children of the given cursor,
03499  * invoking the given \p visitor function with the cursors of each
03500  * visited child. The traversal may be recursive, if the visitor returns
03501  * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
03502  * the visitor returns \c CXChildVisit_Break.
03503  *
03504  * \param parent the cursor whose child may be visited. All kinds of
03505  * cursors can be visited, including invalid cursors (which, by
03506  * definition, have no children).
03507  *
03508  * \param visitor the visitor function that will be invoked for each
03509  * child of \p parent.
03510  *
03511  * \param client_data pointer data supplied by the client, which will
03512  * be passed to the visitor each time it is invoked.
03513  *
03514  * \returns a non-zero value if the traversal was terminated
03515  * prematurely by the visitor returning \c CXChildVisit_Break.
03516  */
03517 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
03518                                             CXCursorVisitor visitor,
03519                                             CXClientData client_data);
03520 #ifdef __has_feature
03521 #  if __has_feature(blocks)
03522 /**
03523  * \brief Visitor invoked for each cursor found by a traversal.
03524  *
03525  * This visitor block will be invoked for each cursor found by
03526  * clang_visitChildrenWithBlock(). Its first argument is the cursor being
03527  * visited, its second argument is the parent visitor for that cursor.
03528  *
03529  * The visitor should return one of the \c CXChildVisitResult values
03530  * to direct clang_visitChildrenWithBlock().
03531  */
03532 typedef enum CXChildVisitResult 
03533      (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
03534 
03535 /**
03536  * Visits the children of a cursor using the specified block.  Behaves
03537  * identically to clang_visitChildren() in all other respects.
03538  */
03539 unsigned clang_visitChildrenWithBlock(CXCursor parent,
03540                                       CXCursorVisitorBlock block);
03541 #  endif
03542 #endif
03543 
03544 /**
03545  * @}
03546  */
03547 
03548 /**
03549  * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
03550  *
03551  * These routines provide the ability to determine references within and
03552  * across translation units, by providing the names of the entities referenced
03553  * by cursors, follow reference cursors to the declarations they reference,
03554  * and associate declarations with their definitions.
03555  *
03556  * @{
03557  */
03558 
03559 /**
03560  * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
03561  * by the given cursor.
03562  *
03563  * A Unified Symbol Resolution (USR) is a string that identifies a particular
03564  * entity (function, class, variable, etc.) within a program. USRs can be
03565  * compared across translation units to determine, e.g., when references in
03566  * one translation refer to an entity defined in another translation unit.
03567  */
03568 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
03569 
03570 /**
03571  * \brief Construct a USR for a specified Objective-C class.
03572  */
03573 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
03574 
03575 /**
03576  * \brief Construct a USR for a specified Objective-C category.
03577  */
03578 CINDEX_LINKAGE CXString
03579   clang_constructUSR_ObjCCategory(const char *class_name,
03580                                  const char *category_name);
03581 
03582 /**
03583  * \brief Construct a USR for a specified Objective-C protocol.
03584  */
03585 CINDEX_LINKAGE CXString
03586   clang_constructUSR_ObjCProtocol(const char *protocol_name);
03587 
03588 
03589 /**
03590  * \brief Construct a USR for a specified Objective-C instance variable and
03591  *   the USR for its containing class.
03592  */
03593 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
03594                                                     CXString classUSR);
03595 
03596 /**
03597  * \brief Construct a USR for a specified Objective-C method and
03598  *   the USR for its containing class.
03599  */
03600 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
03601                                                       unsigned isInstanceMethod,
03602                                                       CXString classUSR);
03603 
03604 /**
03605  * \brief Construct a USR for a specified Objective-C property and the USR
03606  *  for its containing class.
03607  */
03608 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
03609                                                         CXString classUSR);
03610 
03611 /**
03612  * \brief Retrieve a name for the entity referenced by this cursor.
03613  */
03614 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
03615 
03616 /**
03617  * \brief Retrieve a range for a piece that forms the cursors spelling name.
03618  * Most of the times there is only one range for the complete spelling but for
03619  * Objective-C methods and Objective-C message expressions, there are multiple
03620  * pieces for each selector identifier.
03621  * 
03622  * \param pieceIndex the index of the spelling name piece. If this is greater
03623  * than the actual number of pieces, it will return a NULL (invalid) range.
03624  *  
03625  * \param options Reserved.
03626  */
03627 CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor,
03628                                                           unsigned pieceIndex,
03629                                                           unsigned options);
03630 
03631 /**
03632  * \brief Retrieve the display name for the entity referenced by this cursor.
03633  *
03634  * The display name contains extra information that helps identify the cursor,
03635  * such as the parameters of a function or template or the arguments of a 
03636  * class template specialization.
03637  */
03638 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
03639   
03640 /** \brief For a cursor that is a reference, retrieve a cursor representing the
03641  * entity that it references.
03642  *
03643  * Reference cursors refer to other entities in the AST. For example, an
03644  * Objective-C superclass reference cursor refers to an Objective-C class.
03645  * This function produces the cursor for the Objective-C class from the
03646  * cursor for the superclass reference. If the input cursor is a declaration or
03647  * definition, it returns that declaration or definition unchanged.
03648  * Otherwise, returns the NULL cursor.
03649  */
03650 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
03651 
03652 /**
03653  *  \brief For a cursor that is either a reference to or a declaration
03654  *  of some entity, retrieve a cursor that describes the definition of
03655  *  that entity.
03656  *
03657  *  Some entities can be declared multiple times within a translation
03658  *  unit, but only one of those declarations can also be a
03659  *  definition. For example, given:
03660  *
03661  *  \code
03662  *  int f(int, int);
03663  *  int g(int x, int y) { return f(x, y); }
03664  *  int f(int a, int b) { return a + b; }
03665  *  int f(int, int);
03666  *  \endcode
03667  *
03668  *  there are three declarations of the function "f", but only the
03669  *  second one is a definition. The clang_getCursorDefinition()
03670  *  function will take any cursor pointing to a declaration of "f"
03671  *  (the first or fourth lines of the example) or a cursor referenced
03672  *  that uses "f" (the call to "f' inside "g") and will return a
03673  *  declaration cursor pointing to the definition (the second "f"
03674  *  declaration).
03675  *
03676  *  If given a cursor for which there is no corresponding definition,
03677  *  e.g., because there is no definition of that entity within this
03678  *  translation unit, returns a NULL cursor.
03679  */
03680 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
03681 
03682 /**
03683  * \brief Determine whether the declaration pointed to by this cursor
03684  * is also a definition of that entity.
03685  */
03686 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
03687 
03688 /**
03689  * \brief Retrieve the canonical cursor corresponding to the given cursor.
03690  *
03691  * In the C family of languages, many kinds of entities can be declared several
03692  * times within a single translation unit. For example, a structure type can
03693  * be forward-declared (possibly multiple times) and later defined:
03694  *
03695  * \code
03696  * struct X;
03697  * struct X;
03698  * struct X {
03699  *   int member;
03700  * };
03701  * \endcode
03702  *
03703  * The declarations and the definition of \c X are represented by three 
03704  * different cursors, all of which are declarations of the same underlying 
03705  * entity. One of these cursor is considered the "canonical" cursor, which
03706  * is effectively the representative for the underlying entity. One can 
03707  * determine if two cursors are declarations of the same underlying entity by
03708  * comparing their canonical cursors.
03709  *
03710  * \returns The canonical cursor for the entity referred to by the given cursor.
03711  */
03712 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
03713 
03714 
03715 /**
03716  * \brief If the cursor points to a selector identifier in an Objective-C
03717  * method or message expression, this returns the selector index.
03718  *
03719  * After getting a cursor with #clang_getCursor, this can be called to
03720  * determine if the location points to a selector identifier.
03721  *
03722  * \returns The selector index if the cursor is an Objective-C method or message
03723  * expression and the cursor is pointing to a selector identifier, or -1
03724  * otherwise.
03725  */
03726 CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
03727 
03728 /**
03729  * \brief Given a cursor pointing to a C++ method call or an Objective-C
03730  * message, returns non-zero if the method/message is "dynamic", meaning:
03731  * 
03732  * For a C++ method: the call is virtual.
03733  * For an Objective-C message: the receiver is an object instance, not 'super'
03734  * or a specific class.
03735  * 
03736  * If the method/message is "static" or the cursor does not point to a
03737  * method/message, it will return zero.
03738  */
03739 CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
03740 
03741 /**
03742  * \brief Given a cursor pointing to an Objective-C message, returns the CXType
03743  * of the receiver.
03744  */
03745 CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
03746 
03747 /**
03748  * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
03749  */
03750 typedef enum {
03751   CXObjCPropertyAttr_noattr    = 0x00,
03752   CXObjCPropertyAttr_readonly  = 0x01,
03753   CXObjCPropertyAttr_getter    = 0x02,
03754   CXObjCPropertyAttr_assign    = 0x04,
03755   CXObjCPropertyAttr_readwrite = 0x08,
03756   CXObjCPropertyAttr_retain    = 0x10,
03757   CXObjCPropertyAttr_copy      = 0x20,
03758   CXObjCPropertyAttr_nonatomic = 0x40,
03759   CXObjCPropertyAttr_setter    = 0x80,
03760   CXObjCPropertyAttr_atomic    = 0x100,
03761   CXObjCPropertyAttr_weak      = 0x200,
03762   CXObjCPropertyAttr_strong    = 0x400,
03763   CXObjCPropertyAttr_unsafe_unretained = 0x800
03764 } CXObjCPropertyAttrKind;
03765 
03766 /**
03767  * \brief Given a cursor that represents a property declaration, return the
03768  * associated property attributes. The bits are formed from
03769  * \c CXObjCPropertyAttrKind.
03770  *
03771  * \param reserved Reserved for future use, pass 0.
03772  */
03773 CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C,
03774                                                              unsigned reserved);
03775 
03776 /**
03777  * \brief 'Qualifiers' written next to the return and parameter types in
03778  * Objective-C method declarations.
03779  */
03780 typedef enum {
03781   CXObjCDeclQualifier_None = 0x0,
03782   CXObjCDeclQualifier_In = 0x1,
03783   CXObjCDeclQualifier_Inout = 0x2,
03784   CXObjCDeclQualifier_Out = 0x4,
03785   CXObjCDeclQualifier_Bycopy = 0x8,
03786   CXObjCDeclQualifier_Byref = 0x10,
03787   CXObjCDeclQualifier_Oneway = 0x20
03788 } CXObjCDeclQualifierKind;
03789 
03790 /**
03791  * \brief Given a cursor that represents an Objective-C method or parameter
03792  * declaration, return the associated Objective-C qualifiers for the return
03793  * type or the parameter respectively. The bits are formed from
03794  * CXObjCDeclQualifierKind.
03795  */
03796 CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
03797 
03798 /**
03799  * \brief Given a cursor that represents an Objective-C method or property
03800  * declaration, return non-zero if the declaration was affected by "@optional".
03801  * Returns zero if the cursor is not such a declaration or it is "@required".
03802  */
03803 CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
03804 
03805 /**
03806  * \brief Returns non-zero if the given cursor is a variadic function or method.
03807  */
03808 CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
03809 
03810 /**
03811  * \brief Given a cursor that represents a declaration, return the associated
03812  * comment's source range.  The range may include multiple consecutive comments
03813  * with whitespace in between.
03814  */
03815 CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
03816 
03817 /**
03818  * \brief Given a cursor that represents a declaration, return the associated
03819  * comment text, including comment markers.
03820  */
03821 CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
03822 
03823 /**
03824  * \brief Given a cursor that represents a documentable entity (e.g.,
03825  * declaration), return the associated \\brief paragraph; otherwise return the
03826  * first paragraph.
03827  */
03828 CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
03829 
03830 /**
03831  * @}
03832  */
03833 
03834 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
03835  *
03836  * @{
03837  */
03838 
03839 /**
03840  * \brief Retrieve the CXString representing the mangled name of the cursor.
03841  */
03842 CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
03843 
03844 /**
03845  * @}
03846  */
03847 
03848 /**
03849  * \defgroup CINDEX_MODULE Module introspection
03850  *
03851  * The functions in this group provide access to information about modules.
03852  *
03853  * @{
03854  */
03855 
03856 typedef void *CXModule;
03857 
03858 /**
03859  * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
03860  */
03861 CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
03862 
03863 /**
03864  * \brief Given a CXFile header file, return the module that contains it, if one
03865  * exists.
03866  */
03867 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
03868 
03869 /**
03870  * \param Module a module object.
03871  *
03872  * \returns the module file where the provided module object came from.
03873  */
03874 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
03875 
03876 /**
03877  * \param Module a module object.
03878  *
03879  * \returns the parent of a sub-module or NULL if the given module is top-level,
03880  * e.g. for 'std.vector' it will return the 'std' module.
03881  */
03882 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
03883 
03884 /**
03885  * \param Module a module object.
03886  *
03887  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
03888  * will return "vector".
03889  */
03890 CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
03891 
03892 /**
03893  * \param Module a module object.
03894  *
03895  * \returns the full name of the module, e.g. "std.vector".
03896  */
03897 CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
03898 
03899 /**
03900  * \param Module a module object.
03901  *
03902  * \returns non-zero if the module is a system one.
03903  */
03904 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
03905 
03906 /**
03907  * \param Module a module object.
03908  *
03909  * \returns the number of top level headers associated with this module.
03910  */
03911 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
03912                                                            CXModule Module);
03913 
03914 /**
03915  * \param Module a module object.
03916  *
03917  * \param Index top level header index (zero-based).
03918  *
03919  * \returns the specified top level header associated with the module.
03920  */
03921 CINDEX_LINKAGE
03922 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
03923                                       CXModule Module, unsigned Index);
03924 
03925 /**
03926  * @}
03927  */
03928 
03929 /**
03930  * \defgroup CINDEX_CPP C++ AST introspection
03931  *
03932  * The routines in this group provide access information in the ASTs specific
03933  * to C++ language features.
03934  *
03935  * @{
03936  */
03937 
03938 /**
03939  * \brief Determine if a C++ member function or member function template is
03940  * pure virtual.
03941  */
03942 CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
03943 
03944 /**
03945  * \brief Determine if a C++ member function or member function template is 
03946  * declared 'static'.
03947  */
03948 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
03949 
03950 /**
03951  * \brief Determine if a C++ member function or member function template is
03952  * explicitly declared 'virtual' or if it overrides a virtual method from
03953  * one of the base classes.
03954  */
03955 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
03956 
03957 /**
03958  * \brief Determine if a C++ member function or member function template is
03959  * declared 'const'.
03960  */
03961 CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
03962 
03963 /**
03964  * \brief Given a cursor that represents a template, determine
03965  * the cursor kind of the specializations would be generated by instantiating
03966  * the template.
03967  *
03968  * This routine can be used to determine what flavor of function template,
03969  * class template, or class template partial specialization is stored in the
03970  * cursor. For example, it can describe whether a class template cursor is
03971  * declared with "struct", "class" or "union".
03972  *
03973  * \param C The cursor to query. This cursor should represent a template
03974  * declaration.
03975  *
03976  * \returns The cursor kind of the specializations that would be generated
03977  * by instantiating the template \p C. If \p C is not a template, returns
03978  * \c CXCursor_NoDeclFound.
03979  */
03980 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
03981   
03982 /**
03983  * \brief Given a cursor that may represent a specialization or instantiation
03984  * of a template, retrieve the cursor that represents the template that it
03985  * specializes or from which it was instantiated.
03986  *
03987  * This routine determines the template involved both for explicit 
03988  * specializations of templates and for implicit instantiations of the template,
03989  * both of which are referred to as "specializations". For a class template
03990  * specialization (e.g., \c std::vector<bool>), this routine will return 
03991  * either the primary template (\c std::vector) or, if the specialization was
03992  * instantiated from a class template partial specialization, the class template
03993  * partial specialization. For a class template partial specialization and a
03994  * function template specialization (including instantiations), this
03995  * this routine will return the specialized template.
03996  *
03997  * For members of a class template (e.g., member functions, member classes, or
03998  * static data members), returns the specialized or instantiated member. 
03999  * Although not strictly "templates" in the C++ language, members of class
04000  * templates have the same notions of specializations and instantiations that
04001  * templates do, so this routine treats them similarly.
04002  *
04003  * \param C A cursor that may be a specialization of a template or a member
04004  * of a template.
04005  *
04006  * \returns If the given cursor is a specialization or instantiation of a 
04007  * template or a member thereof, the template or member that it specializes or
04008  * from which it was instantiated. Otherwise, returns a NULL cursor.
04009  */
04010 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
04011 
04012 /**
04013  * \brief Given a cursor that references something else, return the source range
04014  * covering that reference.
04015  *
04016  * \param C A cursor pointing to a member reference, a declaration reference, or
04017  * an operator call.
04018  * \param NameFlags A bitset with three independent flags: 
04019  * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
04020  * CXNameRange_WantSinglePiece.
04021  * \param PieceIndex For contiguous names or when passing the flag 
04022  * CXNameRange_WantSinglePiece, only one piece with index 0 is 
04023  * available. When the CXNameRange_WantSinglePiece flag is not passed for a
04024  * non-contiguous names, this index can be used to retrieve the individual
04025  * pieces of the name. See also CXNameRange_WantSinglePiece.
04026  *
04027  * \returns The piece of the name pointed to by the given cursor. If there is no
04028  * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
04029  */
04030 CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
04031                                                 unsigned NameFlags, 
04032                                                 unsigned PieceIndex);
04033 
04034 enum CXNameRefFlags {
04035   /**
04036    * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
04037    * range.
04038    */
04039   CXNameRange_WantQualifier = 0x1,
04040   
04041   /**
04042    * \brief Include the explicit template arguments, e.g. <int> in x.f<int>,
04043    * in the range.
04044    */
04045   CXNameRange_WantTemplateArgs = 0x2,
04046 
04047   /**
04048    * \brief If the name is non-contiguous, return the full spanning range.
04049    *
04050    * Non-contiguous names occur in Objective-C when a selector with two or more
04051    * parameters is used, or in C++ when using an operator:
04052    * \code
04053    * [object doSomething:here withValue:there]; // Objective-C
04054    * return some_vector[1]; // C++
04055    * \endcode
04056    */
04057   CXNameRange_WantSinglePiece = 0x4
04058 };
04059   
04060 /**
04061  * @}
04062  */
04063 
04064 /**
04065  * \defgroup CINDEX_LEX Token extraction and manipulation
04066  *
04067  * The routines in this group provide access to the tokens within a
04068  * translation unit, along with a semantic mapping of those tokens to
04069  * their corresponding cursors.
04070  *
04071  * @{
04072  */
04073 
04074 /**
04075  * \brief Describes a kind of token.
04076  */
04077 typedef enum CXTokenKind {
04078   /**
04079    * \brief A token that contains some kind of punctuation.
04080    */
04081   CXToken_Punctuation,
04082 
04083   /**
04084    * \brief A language keyword.
04085    */
04086   CXToken_Keyword,
04087 
04088   /**
04089    * \brief An identifier (that is not a keyword).
04090    */
04091   CXToken_Identifier,
04092 
04093   /**
04094    * \brief A numeric, string, or character literal.
04095    */
04096   CXToken_Literal,
04097 
04098   /**
04099    * \brief A comment.
04100    */
04101   CXToken_Comment
04102 } CXTokenKind;
04103 
04104 /**
04105  * \brief Describes a single preprocessing token.
04106  */
04107 typedef struct {
04108   unsigned int_data[4];
04109   void *ptr_data;
04110 } CXToken;
04111 
04112 /**
04113  * \brief Determine the kind of the given token.
04114  */
04115 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
04116 
04117 /**
04118  * \brief Determine the spelling of the given token.
04119  *
04120  * The spelling of a token is the textual representation of that token, e.g.,
04121  * the text of an identifier or keyword.
04122  */
04123 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
04124 
04125 /**
04126  * \brief Retrieve the source location of the given token.
04127  */
04128 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
04129                                                        CXToken);
04130 
04131 /**
04132  * \brief Retrieve a source range that covers the given token.
04133  */
04134 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
04135 
04136 /**
04137  * \brief Tokenize the source code described by the given range into raw
04138  * lexical tokens.
04139  *
04140  * \param TU the translation unit whose text is being tokenized.
04141  *
04142  * \param Range the source range in which text should be tokenized. All of the
04143  * tokens produced by tokenization will fall within this source range,
04144  *
04145  * \param Tokens this pointer will be set to point to the array of tokens
04146  * that occur within the given source range. The returned pointer must be
04147  * freed with clang_disposeTokens() before the translation unit is destroyed.
04148  *
04149  * \param NumTokens will be set to the number of tokens in the \c *Tokens
04150  * array.
04151  *
04152  */
04153 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
04154                                    CXToken **Tokens, unsigned *NumTokens);
04155 
04156 /**
04157  * \brief Annotate the given set of tokens by providing cursors for each token
04158  * that can be mapped to a specific entity within the abstract syntax tree.
04159  *
04160  * This token-annotation routine is equivalent to invoking
04161  * clang_getCursor() for the source locations of each of the
04162  * tokens. The cursors provided are filtered, so that only those
04163  * cursors that have a direct correspondence to the token are
04164  * accepted. For example, given a function call \c f(x),
04165  * clang_getCursor() would provide the following cursors:
04166  *
04167  *   * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
04168  *   * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
04169  *   * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
04170  *
04171  * Only the first and last of these cursors will occur within the
04172  * annotate, since the tokens "f" and "x' directly refer to a function
04173  * and a variable, respectively, but the parentheses are just a small
04174  * part of the full syntax of the function call expression, which is
04175  * not provided as an annotation.
04176  *
04177  * \param TU the translation unit that owns the given tokens.
04178  *
04179  * \param Tokens the set of tokens to annotate.
04180  *
04181  * \param NumTokens the number of tokens in \p Tokens.
04182  *
04183  * \param Cursors an array of \p NumTokens cursors, whose contents will be
04184  * replaced with the cursors corresponding to each token.
04185  */
04186 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
04187                                          CXToken *Tokens, unsigned NumTokens,
04188                                          CXCursor *Cursors);
04189 
04190 /**
04191  * \brief Free the given set of tokens.
04192  */
04193 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
04194                                         CXToken *Tokens, unsigned NumTokens);
04195 
04196 /**
04197  * @}
04198  */
04199 
04200 /**
04201  * \defgroup CINDEX_DEBUG Debugging facilities
04202  *
04203  * These routines are used for testing and debugging, only, and should not
04204  * be relied upon.
04205  *
04206  * @{
04207  */
04208 
04209 /* for debug/testing */
04210 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
04211 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
04212                                           const char **startBuf,
04213                                           const char **endBuf,
04214                                           unsigned *startLine,
04215                                           unsigned *startColumn,
04216                                           unsigned *endLine,
04217                                           unsigned *endColumn);
04218 CINDEX_LINKAGE void clang_enableStackTraces(void);
04219 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
04220                                           unsigned stack_size);
04221 
04222 /**
04223  * @}
04224  */
04225 
04226 /**
04227  * \defgroup CINDEX_CODE_COMPLET Code completion
04228  *
04229  * Code completion involves taking an (incomplete) source file, along with
04230  * knowledge of where the user is actively editing that file, and suggesting
04231  * syntactically- and semantically-valid constructs that the user might want to
04232  * use at that particular point in the source code. These data structures and
04233  * routines provide support for code completion.
04234  *
04235  * @{
04236  */
04237 
04238 /**
04239  * \brief A semantic string that describes a code-completion result.
04240  *
04241  * A semantic string that describes the formatting of a code-completion
04242  * result as a single "template" of text that should be inserted into the
04243  * source buffer when a particular code-completion result is selected.
04244  * Each semantic string is made up of some number of "chunks", each of which
04245  * contains some text along with a description of what that text means, e.g.,
04246  * the name of the entity being referenced, whether the text chunk is part of
04247  * the template, or whether it is a "placeholder" that the user should replace
04248  * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
04249  * description of the different kinds of chunks.
04250  */
04251 typedef void *CXCompletionString;
04252 
04253 /**
04254  * \brief A single result of code completion.
04255  */
04256 typedef struct {
04257   /**
04258    * \brief The kind of entity that this completion refers to.
04259    *
04260    * The cursor kind will be a macro, keyword, or a declaration (one of the
04261    * *Decl cursor kinds), describing the entity that the completion is
04262    * referring to.
04263    *
04264    * \todo In the future, we would like to provide a full cursor, to allow
04265    * the client to extract additional information from declaration.
04266    */
04267   enum CXCursorKind CursorKind;
04268 
04269   /**
04270    * \brief The code-completion string that describes how to insert this
04271    * code-completion result into the editing buffer.
04272    */
04273   CXCompletionString CompletionString;
04274 } CXCompletionResult;
04275 
04276 /**
04277  * \brief Describes a single piece of text within a code-completion string.
04278  *
04279  * Each "chunk" within a code-completion string (\c CXCompletionString) is
04280  * either a piece of text with a specific "kind" that describes how that text
04281  * should be interpreted by the client or is another completion string.
04282  */
04283 enum CXCompletionChunkKind {
04284   /**
04285    * \brief A code-completion string that describes "optional" text that
04286    * could be a part of the template (but is not required).
04287    *
04288    * The Optional chunk is the only kind of chunk that has a code-completion
04289    * string for its representation, which is accessible via
04290    * \c clang_getCompletionChunkCompletionString(). The code-completion string
04291    * describes an additional part of the template that is completely optional.
04292    * For example, optional chunks can be used to describe the placeholders for
04293    * arguments that match up with defaulted function parameters, e.g. given:
04294    *
04295    * \code
04296    * void f(int x, float y = 3.14, double z = 2.71828);
04297    * \endcode
04298    *
04299    * The code-completion string for this function would contain:
04300    *   - a TypedText chunk for "f".
04301    *   - a LeftParen chunk for "(".
04302    *   - a Placeholder chunk for "int x"
04303    *   - an Optional chunk containing the remaining defaulted arguments, e.g.,
04304    *       - a Comma chunk for ","
04305    *       - a Placeholder chunk for "float y"
04306    *       - an Optional chunk containing the last defaulted argument:
04307    *           - a Comma chunk for ","
04308    *           - a Placeholder chunk for "double z"
04309    *   - a RightParen chunk for ")"
04310    *
04311    * There are many ways to handle Optional chunks. Two simple approaches are:
04312    *   - Completely ignore optional chunks, in which case the template for the
04313    *     function "f" would only include the first parameter ("int x").
04314    *   - Fully expand all optional chunks, in which case the template for the
04315    *     function "f" would have all of the parameters.
04316    */
04317   CXCompletionChunk_Optional,
04318   /**
04319    * \brief Text that a user would be expected to type to get this
04320    * code-completion result.
04321    *
04322    * There will be exactly one "typed text" chunk in a semantic string, which
04323    * will typically provide the spelling of a keyword or the name of a
04324    * declaration that could be used at the current code point. Clients are
04325    * expected to filter the code-completion results based on the text in this
04326    * chunk.
04327    */
04328   CXCompletionChunk_TypedText,
04329   /**
04330    * \brief Text that should be inserted as part of a code-completion result.
04331    *
04332    * A "text" chunk represents text that is part of the template to be
04333    * inserted into user code should this particular code-completion result
04334    * be selected.
04335    */
04336   CXCompletionChunk_Text,
04337   /**
04338    * \brief Placeholder text that should be replaced by the user.
04339    *
04340    * A "placeholder" chunk marks a place where the user should insert text
04341    * into the code-completion template. For example, placeholders might mark
04342    * the function parameters for a function declaration, to indicate that the
04343    * user should provide arguments for each of those parameters. The actual
04344    * text in a placeholder is a suggestion for the text to display before
04345    * the user replaces the placeholder with real code.
04346    */
04347   CXCompletionChunk_Placeholder,
04348   /**
04349    * \brief Informative text that should be displayed but never inserted as
04350    * part of the template.
04351    *
04352    * An "informative" chunk contains annotations that can be displayed to
04353    * help the user decide whether a particular code-completion result is the
04354    * right option, but which is not part of the actual template to be inserted
04355    * by code completion.
04356    */
04357   CXCompletionChunk_Informative,
04358   /**
04359    * \brief Text that describes the current parameter when code-completion is
04360    * referring to function call, message send, or template specialization.
04361    *
04362    * A "current parameter" chunk occurs when code-completion is providing
04363    * information about a parameter corresponding to the argument at the
04364    * code-completion point. For example, given a function
04365    *
04366    * \code
04367    * int add(int x, int y);
04368    * \endcode
04369    *
04370    * and the source code \c add(, where the code-completion point is after the
04371    * "(", the code-completion string will contain a "current parameter" chunk
04372    * for "int x", indicating that the current argument will initialize that
04373    * parameter. After typing further, to \c add(17, (where the code-completion
04374    * point is after the ","), the code-completion string will contain a
04375    * "current paremeter" chunk to "int y".
04376    */
04377   CXCompletionChunk_CurrentParameter,
04378   /**
04379    * \brief A left parenthesis ('('), used to initiate a function call or
04380    * signal the beginning of a function parameter list.
04381    */
04382   CXCompletionChunk_LeftParen,
04383   /**
04384    * \brief A right parenthesis (')'), used to finish a function call or
04385    * signal the end of a function parameter list.
04386    */
04387   CXCompletionChunk_RightParen,
04388   /**
04389    * \brief A left bracket ('[').
04390    */
04391   CXCompletionChunk_LeftBracket,
04392   /**
04393    * \brief A right bracket (']').
04394    */
04395   CXCompletionChunk_RightBracket,
04396   /**
04397    * \brief A left brace ('{').
04398    */
04399   CXCompletionChunk_LeftBrace,
04400   /**
04401    * \brief A right brace ('}').
04402    */
04403   CXCompletionChunk_RightBrace,
04404   /**
04405    * \brief A left angle bracket ('<').
04406    */
04407   CXCompletionChunk_LeftAngle,
04408   /**
04409    * \brief A right angle bracket ('>').
04410    */
04411   CXCompletionChunk_RightAngle,
04412   /**
04413    * \brief A comma separator (',').
04414    */
04415   CXCompletionChunk_Comma,
04416   /**
04417    * \brief Text that specifies the result type of a given result.
04418    *
04419    * This special kind of informative chunk is not meant to be inserted into
04420    * the text buffer. Rather, it is meant to illustrate the type that an
04421    * expression using the given completion string would have.
04422    */
04423   CXCompletionChunk_ResultType,
04424   /**
04425    * \brief A colon (':').
04426    */
04427   CXCompletionChunk_Colon,
04428   /**
04429    * \brief A semicolon (';').
04430    */
04431   CXCompletionChunk_SemiColon,
04432   /**
04433    * \brief An '=' sign.
04434    */
04435   CXCompletionChunk_Equal,
04436   /**
04437    * Horizontal space (' ').
04438    */
04439   CXCompletionChunk_HorizontalSpace,
04440   /**
04441    * Vertical space ('\n'), after which it is generally a good idea to
04442    * perform indentation.
04443    */
04444   CXCompletionChunk_VerticalSpace
04445 };
04446 
04447 /**
04448  * \brief Determine the kind of a particular chunk within a completion string.
04449  *
04450  * \param completion_string the completion string to query.
04451  *
04452  * \param chunk_number the 0-based index of the chunk in the completion string.
04453  *
04454  * \returns the kind of the chunk at the index \c chunk_number.
04455  */
04456 CINDEX_LINKAGE enum CXCompletionChunkKind
04457 clang_getCompletionChunkKind(CXCompletionString completion_string,
04458                              unsigned chunk_number);
04459 
04460 /**
04461  * \brief Retrieve the text associated with a particular chunk within a
04462  * completion string.
04463  *
04464  * \param completion_string the completion string to query.
04465  *
04466  * \param chunk_number the 0-based index of the chunk in the completion string.
04467  *
04468  * \returns the text associated with the chunk at index \c chunk_number.
04469  */
04470 CINDEX_LINKAGE CXString
04471 clang_getCompletionChunkText(CXCompletionString completion_string,
04472                              unsigned chunk_number);
04473 
04474 /**
04475  * \brief Retrieve the completion string associated with a particular chunk
04476  * within a completion string.
04477  *
04478  * \param completion_string the completion string to query.
04479  *
04480  * \param chunk_number the 0-based index of the chunk in the completion string.
04481  *
04482  * \returns the completion string associated with the chunk at index
04483  * \c chunk_number.
04484  */
04485 CINDEX_LINKAGE CXCompletionString
04486 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
04487                                          unsigned chunk_number);
04488 
04489 /**
04490  * \brief Retrieve the number of chunks in the given code-completion string.
04491  */
04492 CINDEX_LINKAGE unsigned
04493 clang_getNumCompletionChunks(CXCompletionString completion_string);
04494 
04495 /**
04496  * \brief Determine the priority of this code completion.
04497  *
04498  * The priority of a code completion indicates how likely it is that this 
04499  * particular completion is the completion that the user will select. The
04500  * priority is selected by various internal heuristics.
04501  *
04502  * \param completion_string The completion string to query.
04503  *
04504  * \returns The priority of this completion string. Smaller values indicate
04505  * higher-priority (more likely) completions.
04506  */
04507 CINDEX_LINKAGE unsigned
04508 clang_getCompletionPriority(CXCompletionString completion_string);
04509   
04510 /**
04511  * \brief Determine the availability of the entity that this code-completion
04512  * string refers to.
04513  *
04514  * \param completion_string The completion string to query.
04515  *
04516  * \returns The availability of the completion string.
04517  */
04518 CINDEX_LINKAGE enum CXAvailabilityKind 
04519 clang_getCompletionAvailability(CXCompletionString completion_string);
04520 
04521 /**
04522  * \brief Retrieve the number of annotations associated with the given
04523  * completion string.
04524  *
04525  * \param completion_string the completion string to query.
04526  *
04527  * \returns the number of annotations associated with the given completion
04528  * string.
04529  */
04530 CINDEX_LINKAGE unsigned
04531 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
04532 
04533 /**
04534  * \brief Retrieve the annotation associated with the given completion string.
04535  *
04536  * \param completion_string the completion string to query.
04537  *
04538  * \param annotation_number the 0-based index of the annotation of the
04539  * completion string.
04540  *
04541  * \returns annotation string associated with the completion at index
04542  * \c annotation_number, or a NULL string if that annotation is not available.
04543  */
04544 CINDEX_LINKAGE CXString
04545 clang_getCompletionAnnotation(CXCompletionString completion_string,
04546                               unsigned annotation_number);
04547 
04548 /**
04549  * \brief Retrieve the parent context of the given completion string.
04550  *
04551  * The parent context of a completion string is the semantic parent of 
04552  * the declaration (if any) that the code completion represents. For example,
04553  * a code completion for an Objective-C method would have the method's class
04554  * or protocol as its context.
04555  *
04556  * \param completion_string The code completion string whose parent is
04557  * being queried.
04558  *
04559  * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
04560  *
04561  * \returns The name of the completion parent, e.g., "NSObject" if
04562  * the completion string represents a method in the NSObject class.
04563  */
04564 CINDEX_LINKAGE CXString
04565 clang_getCompletionParent(CXCompletionString completion_string,
04566                           enum CXCursorKind *kind);
04567 
04568 /**
04569  * \brief Retrieve the brief documentation comment attached to the declaration
04570  * that corresponds to the given completion string.
04571  */
04572 CINDEX_LINKAGE CXString
04573 clang_getCompletionBriefComment(CXCompletionString completion_string);
04574 
04575 /**
04576  * \brief Retrieve a completion string for an arbitrary declaration or macro
04577  * definition cursor.
04578  *
04579  * \param cursor The cursor to query.
04580  *
04581  * \returns A non-context-sensitive completion string for declaration and macro
04582  * definition cursors, or NULL for other kinds of cursors.
04583  */
04584 CINDEX_LINKAGE CXCompletionString
04585 clang_getCursorCompletionString(CXCursor cursor);
04586   
04587 /**
04588  * \brief Contains the results of code-completion.
04589  *
04590  * This data structure contains the results of code completion, as
04591  * produced by \c clang_codeCompleteAt(). Its contents must be freed by
04592  * \c clang_disposeCodeCompleteResults.
04593  */
04594 typedef struct {
04595   /**
04596    * \brief The code-completion results.
04597    */
04598   CXCompletionResult *Results;
04599 
04600   /**
04601    * \brief The number of code-completion results stored in the
04602    * \c Results array.
04603    */
04604   unsigned NumResults;
04605 } CXCodeCompleteResults;
04606 
04607 /**
04608  * \brief Flags that can be passed to \c clang_codeCompleteAt() to
04609  * modify its behavior.
04610  *
04611  * The enumerators in this enumeration can be bitwise-OR'd together to
04612  * provide multiple options to \c clang_codeCompleteAt().
04613  */
04614 enum CXCodeComplete_Flags {
04615   /**
04616    * \brief Whether to include macros within the set of code
04617    * completions returned.
04618    */
04619   CXCodeComplete_IncludeMacros = 0x01,
04620 
04621   /**
04622    * \brief Whether to include code patterns for language constructs
04623    * within the set of code completions, e.g., for loops.
04624    */
04625   CXCodeComplete_IncludeCodePatterns = 0x02,
04626 
04627   /**
04628    * \brief Whether to include brief documentation within the set of code
04629    * completions returned.
04630    */
04631   CXCodeComplete_IncludeBriefComments = 0x04
04632 };
04633 
04634 /**
04635  * \brief Bits that represent the context under which completion is occurring.
04636  *
04637  * The enumerators in this enumeration may be bitwise-OR'd together if multiple
04638  * contexts are occurring simultaneously.
04639  */
04640 enum CXCompletionContext {
04641   /**
04642    * \brief The context for completions is unexposed, as only Clang results
04643    * should be included. (This is equivalent to having no context bits set.)
04644    */
04645   CXCompletionContext_Unexposed = 0,
04646   
04647   /**
04648    * \brief Completions for any possible type should be included in the results.
04649    */
04650   CXCompletionContext_AnyType = 1 << 0,
04651   
04652   /**
04653    * \brief Completions for any possible value (variables, function calls, etc.)
04654    * should be included in the results.
04655    */
04656   CXCompletionContext_AnyValue = 1 << 1,
04657   /**
04658    * \brief Completions for values that resolve to an Objective-C object should
04659    * be included in the results.
04660    */
04661   CXCompletionContext_ObjCObjectValue = 1 << 2,
04662   /**
04663    * \brief Completions for values that resolve to an Objective-C selector
04664    * should be included in the results.
04665    */
04666   CXCompletionContext_ObjCSelectorValue = 1 << 3,
04667   /**
04668    * \brief Completions for values that resolve to a C++ class type should be
04669    * included in the results.
04670    */
04671   CXCompletionContext_CXXClassTypeValue = 1 << 4,
04672   
04673   /**
04674    * \brief Completions for fields of the member being accessed using the dot
04675    * operator should be included in the results.
04676    */
04677   CXCompletionContext_DotMemberAccess = 1 << 5,
04678   /**
04679    * \brief Completions for fields of the member being accessed using the arrow
04680    * operator should be included in the results.
04681    */
04682   CXCompletionContext_ArrowMemberAccess = 1 << 6,
04683   /**
04684    * \brief Completions for properties of the Objective-C object being accessed
04685    * using the dot operator should be included in the results.
04686    */
04687   CXCompletionContext_ObjCPropertyAccess = 1 << 7,
04688   
04689   /**
04690    * \brief Completions for enum tags should be included in the results.
04691    */
04692   CXCompletionContext_EnumTag = 1 << 8,
04693   /**
04694    * \brief Completions for union tags should be included in the results.
04695    */
04696   CXCompletionContext_UnionTag = 1 << 9,
04697   /**
04698    * \brief Completions for struct tags should be included in the results.
04699    */
04700   CXCompletionContext_StructTag = 1 << 10,
04701   
04702   /**
04703    * \brief Completions for C++ class names should be included in the results.
04704    */
04705   CXCompletionContext_ClassTag = 1 << 11,
04706   /**
04707    * \brief Completions for C++ namespaces and namespace aliases should be
04708    * included in the results.
04709    */
04710   CXCompletionContext_Namespace = 1 << 12,
04711   /**
04712    * \brief Completions for C++ nested name specifiers should be included in
04713    * the results.
04714    */
04715   CXCompletionContext_NestedNameSpecifier = 1 << 13,
04716   
04717   /**
04718    * \brief Completions for Objective-C interfaces (classes) should be included
04719    * in the results.
04720    */
04721   CXCompletionContext_ObjCInterface = 1 << 14,
04722   /**
04723    * \brief Completions for Objective-C protocols should be included in
04724    * the results.
04725    */
04726   CXCompletionContext_ObjCProtocol = 1 << 15,
04727   /**
04728    * \brief Completions for Objective-C categories should be included in
04729    * the results.
04730    */
04731   CXCompletionContext_ObjCCategory = 1 << 16,
04732   /**
04733    * \brief Completions for Objective-C instance messages should be included
04734    * in the results.
04735    */
04736   CXCompletionContext_ObjCInstanceMessage = 1 << 17,
04737   /**
04738    * \brief Completions for Objective-C class messages should be included in
04739    * the results.
04740    */
04741   CXCompletionContext_ObjCClassMessage = 1 << 18,
04742   /**
04743    * \brief Completions for Objective-C selector names should be included in
04744    * the results.
04745    */
04746   CXCompletionContext_ObjCSelectorName = 1 << 19,
04747   
04748   /**
04749    * \brief Completions for preprocessor macro names should be included in
04750    * the results.
04751    */
04752   CXCompletionContext_MacroName = 1 << 20,
04753   
04754   /**
04755    * \brief Natural language completions should be included in the results.
04756    */
04757   CXCompletionContext_NaturalLanguage = 1 << 21,
04758   
04759   /**
04760    * \brief The current context is unknown, so set all contexts.
04761    */
04762   CXCompletionContext_Unknown = ((1 << 22) - 1)
04763 };
04764   
04765 /**
04766  * \brief Returns a default set of code-completion options that can be
04767  * passed to\c clang_codeCompleteAt(). 
04768  */
04769 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
04770 
04771 /**
04772  * \brief Perform code completion at a given location in a translation unit.
04773  *
04774  * This function performs code completion at a particular file, line, and
04775  * column within source code, providing results that suggest potential
04776  * code snippets based on the context of the completion. The basic model
04777  * for code completion is that Clang will parse a complete source file,
04778  * performing syntax checking up to the location where code-completion has
04779  * been requested. At that point, a special code-completion token is passed
04780  * to the parser, which recognizes this token and determines, based on the
04781  * current location in the C/Objective-C/C++ grammar and the state of
04782  * semantic analysis, what completions to provide. These completions are
04783  * returned via a new \c CXCodeCompleteResults structure.
04784  *
04785  * Code completion itself is meant to be triggered by the client when the
04786  * user types punctuation characters or whitespace, at which point the
04787  * code-completion location will coincide with the cursor. For example, if \c p
04788  * is a pointer, code-completion might be triggered after the "-" and then
04789  * after the ">" in \c p->. When the code-completion location is afer the ">",
04790  * the completion results will provide, e.g., the members of the struct that
04791  * "p" points to. The client is responsible for placing the cursor at the
04792  * beginning of the token currently being typed, then filtering the results
04793  * based on the contents of the token. For example, when code-completing for
04794  * the expression \c p->get, the client should provide the location just after
04795  * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
04796  * client can filter the results based on the current token text ("get"), only
04797  * showing those results that start with "get". The intent of this interface
04798  * is to separate the relatively high-latency acquisition of code-completion
04799  * results from the filtering of results on a per-character basis, which must
04800  * have a lower latency.
04801  *
04802  * \param TU The translation unit in which code-completion should
04803  * occur. The source files for this translation unit need not be
04804  * completely up-to-date (and the contents of those source files may
04805  * be overridden via \p unsaved_files). Cursors referring into the
04806  * translation unit may be invalidated by this invocation.
04807  *
04808  * \param complete_filename The name of the source file where code
04809  * completion should be performed. This filename may be any file
04810  * included in the translation unit.
04811  *
04812  * \param complete_line The line at which code-completion should occur.
04813  *
04814  * \param complete_column The column at which code-completion should occur.
04815  * Note that the column should point just after the syntactic construct that
04816  * initiated code completion, and not in the middle of a lexical token.
04817  *
04818  * \param unsaved_files the Tiles that have not yet been saved to disk
04819  * but may be required for parsing or code completion, including the
04820  * contents of those files.  The contents and name of these files (as
04821  * specified by CXUnsavedFile) are copied when necessary, so the
04822  * client only needs to guarantee their validity until the call to
04823  * this function returns.
04824  *
04825  * \param num_unsaved_files The number of unsaved file entries in \p
04826  * unsaved_files.
04827  *
04828  * \param options Extra options that control the behavior of code
04829  * completion, expressed as a bitwise OR of the enumerators of the
04830  * CXCodeComplete_Flags enumeration. The 
04831  * \c clang_defaultCodeCompleteOptions() function returns a default set
04832  * of code-completion options.
04833  *
04834  * \returns If successful, a new \c CXCodeCompleteResults structure
04835  * containing code-completion results, which should eventually be
04836  * freed with \c clang_disposeCodeCompleteResults(). If code
04837  * completion fails, returns NULL.
04838  */
04839 CINDEX_LINKAGE
04840 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
04841                                             const char *complete_filename,
04842                                             unsigned complete_line,
04843                                             unsigned complete_column,
04844                                             struct CXUnsavedFile *unsaved_files,
04845                                             unsigned num_unsaved_files,
04846                                             unsigned options);
04847 
04848 /**
04849  * \brief Sort the code-completion results in case-insensitive alphabetical 
04850  * order.
04851  *
04852  * \param Results The set of results to sort.
04853  * \param NumResults The number of results in \p Results.
04854  */
04855 CINDEX_LINKAGE
04856 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
04857                                      unsigned NumResults);
04858   
04859 /**
04860  * \brief Free the given set of code-completion results.
04861  */
04862 CINDEX_LINKAGE
04863 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
04864   
04865 /**
04866  * \brief Determine the number of diagnostics produced prior to the
04867  * location where code completion was performed.
04868  */
04869 CINDEX_LINKAGE
04870 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
04871 
04872 /**
04873  * \brief Retrieve a diagnostic associated with the given code completion.
04874  *
04875  * \param Results the code completion results to query.
04876  * \param Index the zero-based diagnostic number to retrieve.
04877  *
04878  * \returns the requested diagnostic. This diagnostic must be freed
04879  * via a call to \c clang_disposeDiagnostic().
04880  */
04881 CINDEX_LINKAGE
04882 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
04883                                              unsigned Index);
04884 
04885 /**
04886  * \brief Determines what completions are appropriate for the context
04887  * the given code completion.
04888  * 
04889  * \param Results the code completion results to query
04890  *
04891  * \returns the kinds of completions that are appropriate for use
04892  * along with the given code completion results.
04893  */
04894 CINDEX_LINKAGE
04895 unsigned long long clang_codeCompleteGetContexts(
04896                                                 CXCodeCompleteResults *Results);
04897 
04898 /**
04899  * \brief Returns the cursor kind for the container for the current code
04900  * completion context. The container is only guaranteed to be set for
04901  * contexts where a container exists (i.e. member accesses or Objective-C
04902  * message sends); if there is not a container, this function will return
04903  * CXCursor_InvalidCode.
04904  *
04905  * \param Results the code completion results to query
04906  *
04907  * \param IsIncomplete on return, this value will be false if Clang has complete
04908  * information about the container. If Clang does not have complete
04909  * information, this value will be true.
04910  *
04911  * \returns the container kind, or CXCursor_InvalidCode if there is not a
04912  * container
04913  */
04914 CINDEX_LINKAGE
04915 enum CXCursorKind clang_codeCompleteGetContainerKind(
04916                                                  CXCodeCompleteResults *Results,
04917                                                      unsigned *IsIncomplete);
04918 
04919 /**
04920  * \brief Returns the USR for the container for the current code completion
04921  * context. If there is not a container for the current context, this
04922  * function will return the empty string.
04923  *
04924  * \param Results the code completion results to query
04925  *
04926  * \returns the USR for the container
04927  */
04928 CINDEX_LINKAGE
04929 CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
04930   
04931   
04932 /**
04933  * \brief Returns the currently-entered selector for an Objective-C message
04934  * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
04935  * non-empty string for CXCompletionContext_ObjCInstanceMessage and
04936  * CXCompletionContext_ObjCClassMessage.
04937  *
04938  * \param Results the code completion results to query
04939  *
04940  * \returns the selector (or partial selector) that has been entered thus far
04941  * for an Objective-C message send.
04942  */
04943 CINDEX_LINKAGE
04944 CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
04945   
04946 /**
04947  * @}
04948  */
04949 
04950 
04951 /**
04952  * \defgroup CINDEX_MISC Miscellaneous utility functions
04953  *
04954  * @{
04955  */
04956 
04957 /**
04958  * \brief Return a version string, suitable for showing to a user, but not
04959  *        intended to be parsed (the format is not guaranteed to be stable).
04960  */
04961 CINDEX_LINKAGE CXString clang_getClangVersion(void);
04962 
04963   
04964 /**
04965  * \brief Enable/disable crash recovery.
04966  *
04967  * \param isEnabled Flag to indicate if crash recovery is enabled.  A non-zero
04968  *        value enables crash recovery, while 0 disables it.
04969  */
04970 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
04971   
04972  /**
04973   * \brief Visitor invoked for each file in a translation unit
04974   *        (used with clang_getInclusions()).
04975   *
04976   * This visitor function will be invoked by clang_getInclusions() for each
04977   * file included (either at the top-level or by \#include directives) within
04978   * a translation unit.  The first argument is the file being included, and
04979   * the second and third arguments provide the inclusion stack.  The
04980   * array is sorted in order of immediate inclusion.  For example,
04981   * the first element refers to the location that included 'included_file'.
04982   */
04983 typedef void (*CXInclusionVisitor)(CXFile included_file,
04984                                    CXSourceLocation* inclusion_stack,
04985                                    unsigned include_len,
04986                                    CXClientData client_data);
04987 
04988 /**
04989  * \brief Visit the set of preprocessor inclusions in a translation unit.
04990  *   The visitor function is called with the provided data for every included
04991  *   file.  This does not include headers included by the PCH file (unless one
04992  *   is inspecting the inclusions in the PCH file itself).
04993  */
04994 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
04995                                         CXInclusionVisitor visitor,
04996                                         CXClientData client_data);
04997 
04998 /**
04999  * @}
05000  */
05001 
05002 /** \defgroup CINDEX_REMAPPING Remapping functions
05003  *
05004  * @{
05005  */
05006 
05007 /**
05008  * \brief A remapping of original source files and their translated files.
05009  */
05010 typedef void *CXRemapping;
05011 
05012 /**
05013  * \brief Retrieve a remapping.
05014  *
05015  * \param path the path that contains metadata about remappings.
05016  *
05017  * \returns the requested remapping. This remapping must be freed
05018  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
05019  */
05020 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
05021 
05022 /**
05023  * \brief Retrieve a remapping.
05024  *
05025  * \param filePaths pointer to an array of file paths containing remapping info.
05026  *
05027  * \param numFiles number of file paths.
05028  *
05029  * \returns the requested remapping. This remapping must be freed
05030  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
05031  */
05032 CINDEX_LINKAGE
05033 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
05034                                             unsigned numFiles);
05035 
05036 /**
05037  * \brief Determine the number of remappings.
05038  */
05039 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
05040 
05041 /**
05042  * \brief Get the original and the associated filename from the remapping.
05043  * 
05044  * \param original If non-NULL, will be set to the original filename.
05045  *
05046  * \param transformed If non-NULL, will be set to the filename that the original
05047  * is associated with.
05048  */
05049 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
05050                                      CXString *original, CXString *transformed);
05051 
05052 /**
05053  * \brief Dispose the remapping.
05054  */
05055 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
05056 
05057 /**
05058  * @}
05059  */
05060 
05061 /** \defgroup CINDEX_HIGH Higher level API functions
05062  *
05063  * @{
05064  */
05065 
05066 enum CXVisitorResult {
05067   CXVisit_Break,
05068   CXVisit_Continue
05069 };
05070 
05071 typedef struct {
05072   void *context;
05073   enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
05074 } CXCursorAndRangeVisitor;
05075 
05076 typedef enum {
05077   /**
05078    * \brief Function returned successfully.
05079    */
05080   CXResult_Success = 0,
05081   /**
05082    * \brief One of the parameters was invalid for the function.
05083    */
05084   CXResult_Invalid = 1,
05085   /**
05086    * \brief The function was terminated by a callback (e.g. it returned
05087    * CXVisit_Break)
05088    */
05089   CXResult_VisitBreak = 2
05090 
05091 } CXResult;
05092 
05093 /**
05094  * \brief Find references of a declaration in a specific file.
05095  * 
05096  * \param cursor pointing to a declaration or a reference of one.
05097  *
05098  * \param file to search for references.
05099  *
05100  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
05101  * each reference found.
05102  * The CXSourceRange will point inside the file; if the reference is inside
05103  * a macro (and not a macro argument) the CXSourceRange will be invalid.
05104  *
05105  * \returns one of the CXResult enumerators.
05106  */
05107 CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file,
05108                                                CXCursorAndRangeVisitor visitor);
05109 
05110 /**
05111  * \brief Find #import/#include directives in a specific file.
05112  *
05113  * \param TU translation unit containing the file to query.
05114  *
05115  * \param file to search for #import/#include directives.
05116  *
05117  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
05118  * each directive found.
05119  *
05120  * \returns one of the CXResult enumerators.
05121  */
05122 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
05123                                                  CXFile file,
05124                                               CXCursorAndRangeVisitor visitor);
05125 
05126 #ifdef __has_feature
05127 #  if __has_feature(blocks)
05128 
05129 typedef enum CXVisitorResult
05130     (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
05131 
05132 CINDEX_LINKAGE
05133 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
05134                                              CXCursorAndRangeVisitorBlock);
05135 
05136 CINDEX_LINKAGE
05137 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
05138                                            CXCursorAndRangeVisitorBlock);
05139 
05140 #  endif
05141 #endif
05142 
05143 /**
05144  * \brief The client's data object that is associated with a CXFile.
05145  */
05146 typedef void *CXIdxClientFile;
05147 
05148 /**
05149  * \brief The client's data object that is associated with a semantic entity.
05150  */
05151 typedef void *CXIdxClientEntity;
05152 
05153 /**
05154  * \brief The client's data object that is associated with a semantic container
05155  * of entities.
05156  */
05157 typedef void *CXIdxClientContainer;
05158 
05159 /**
05160  * \brief The client's data object that is associated with an AST file (PCH
05161  * or module).
05162  */
05163 typedef void *CXIdxClientASTFile;
05164 
05165 /**
05166  * \brief Source location passed to index callbacks.
05167  */
05168 typedef struct {
05169   void *ptr_data[2];
05170   unsigned int_data;
05171 } CXIdxLoc;
05172 
05173 /**
05174  * \brief Data for ppIncludedFile callback.
05175  */
05176 typedef struct {
05177   /**
05178    * \brief Location of '#' in the \#include/\#import directive.
05179    */
05180   CXIdxLoc hashLoc;
05181   /**
05182    * \brief Filename as written in the \#include/\#import directive.
05183    */
05184   const char *filename;
05185   /**
05186    * \brief The actual file that the \#include/\#import directive resolved to.
05187    */
05188   CXFile file;
05189   int isImport;
05190   int isAngled;
05191   /**
05192    * \brief Non-zero if the directive was automatically turned into a module
05193    * import.
05194    */
05195   int isModuleImport;
05196 } CXIdxIncludedFileInfo;
05197 
05198 /**
05199  * \brief Data for IndexerCallbacks#importedASTFile.
05200  */
05201 typedef struct {
05202   /**
05203    * \brief Top level AST file containing the imported PCH, module or submodule.
05204    */
05205   CXFile file;
05206   /**
05207    * \brief The imported module or NULL if the AST file is a PCH.
05208    */
05209   CXModule module;
05210   /**
05211    * \brief Location where the file is imported. Applicable only for modules.
05212    */
05213   CXIdxLoc loc;
05214   /**
05215    * \brief Non-zero if an inclusion directive was automatically turned into
05216    * a module import. Applicable only for modules.
05217    */
05218   int isImplicit;
05219 
05220 } CXIdxImportedASTFileInfo;
05221 
05222 typedef enum {
05223   CXIdxEntity_Unexposed     = 0,
05224   CXIdxEntity_Typedef       = 1,
05225   CXIdxEntity_Function      = 2,
05226   CXIdxEntity_Variable      = 3,
05227   CXIdxEntity_Field         = 4,
05228   CXIdxEntity_EnumConstant  = 5,
05229 
05230   CXIdxEntity_ObjCClass     = 6,
05231   CXIdxEntity_ObjCProtocol  = 7,
05232   CXIdxEntity_ObjCCategory  = 8,
05233 
05234   CXIdxEntity_ObjCInstanceMethod = 9,
05235   CXIdxEntity_ObjCClassMethod    = 10,
05236   CXIdxEntity_ObjCProperty  = 11,
05237   CXIdxEntity_ObjCIvar      = 12,
05238 
05239   CXIdxEntity_Enum          = 13,
05240   CXIdxEntity_Struct        = 14,
05241   CXIdxEntity_Union         = 15,
05242 
05243   CXIdxEntity_CXXClass              = 16,
05244   CXIdxEntity_CXXNamespace          = 17,
05245   CXIdxEntity_CXXNamespaceAlias     = 18,
05246   CXIdxEntity_CXXStaticVariable     = 19,
05247   CXIdxEntity_CXXStaticMethod       = 20,
05248   CXIdxEntity_CXXInstanceMethod     = 21,
05249   CXIdxEntity_CXXConstructor        = 22,
05250   CXIdxEntity_CXXDestructor         = 23,
05251   CXIdxEntity_CXXConversionFunction = 24,
05252   CXIdxEntity_CXXTypeAlias          = 25,
05253   CXIdxEntity_CXXInterface          = 26
05254 
05255 } CXIdxEntityKind;
05256 
05257 typedef enum {
05258   CXIdxEntityLang_None = 0,
05259   CXIdxEntityLang_C    = 1,
05260   CXIdxEntityLang_ObjC = 2,
05261   CXIdxEntityLang_CXX  = 3
05262 } CXIdxEntityLanguage;
05263 
05264 /**
05265  * \brief Extra C++ template information for an entity. This can apply to:
05266  * CXIdxEntity_Function
05267  * CXIdxEntity_CXXClass
05268  * CXIdxEntity_CXXStaticMethod
05269  * CXIdxEntity_CXXInstanceMethod
05270  * CXIdxEntity_CXXConstructor
05271  * CXIdxEntity_CXXConversionFunction
05272  * CXIdxEntity_CXXTypeAlias
05273  */
05274 typedef enum {
05275   CXIdxEntity_NonTemplate   = 0,
05276   CXIdxEntity_Template      = 1,
05277   CXIdxEntity_TemplatePartialSpecialization = 2,
05278   CXIdxEntity_TemplateSpecialization = 3
05279 } CXIdxEntityCXXTemplateKind;
05280 
05281 typedef enum {
05282   CXIdxAttr_Unexposed     = 0,
05283   CXIdxAttr_IBAction      = 1,
05284   CXIdxAttr_IBOutlet      = 2,
05285   CXIdxAttr_IBOutletCollection = 3
05286 } CXIdxAttrKind;
05287 
05288 typedef struct {
05289   CXIdxAttrKind kind;
05290   CXCursor cursor;
05291   CXIdxLoc loc;
05292 } CXIdxAttrInfo;
05293 
05294 typedef struct {
05295   CXIdxEntityKind kind;
05296   CXIdxEntityCXXTemplateKind templateKind;
05297   CXIdxEntityLanguage lang;
05298   const char *name;
05299   const char *USR;
05300   CXCursor cursor;
05301   const CXIdxAttrInfo *const *attributes;
05302   unsigned numAttributes;
05303 } CXIdxEntityInfo;
05304 
05305 typedef struct {
05306   CXCursor cursor;
05307 } CXIdxContainerInfo;
05308 
05309 typedef struct {
05310   const CXIdxAttrInfo *attrInfo;
05311   const CXIdxEntityInfo *objcClass;
05312   CXCursor classCursor;
05313   CXIdxLoc classLoc;
05314 } CXIdxIBOutletCollectionAttrInfo;
05315 
05316 typedef enum {
05317   CXIdxDeclFlag_Skipped = 0x1
05318 } CXIdxDeclInfoFlags;
05319 
05320 typedef struct {
05321   const CXIdxEntityInfo *entityInfo;
05322   CXCursor cursor;
05323   CXIdxLoc loc;
05324   const CXIdxContainerInfo *semanticContainer;
05325   /**
05326    * \brief Generally same as #semanticContainer but can be different in
05327    * cases like out-of-line C++ member functions.
05328    */
05329   const CXIdxContainerInfo *lexicalContainer;
05330   int isRedeclaration;
05331   int isDefinition;
05332   int isContainer;
05333   const CXIdxContainerInfo *declAsContainer;
05334   /**
05335    * \brief Whether the declaration exists in code or was created implicitly
05336    * by the compiler, e.g. implicit Objective-C methods for properties.
05337    */
05338   int isImplicit;
05339   const CXIdxAttrInfo *const *attributes;
05340   unsigned numAttributes;
05341 
05342   unsigned flags;
05343 
05344 } CXIdxDeclInfo;
05345 
05346 typedef enum {
05347   CXIdxObjCContainer_ForwardRef = 0,
05348   CXIdxObjCContainer_Interface = 1,
05349   CXIdxObjCContainer_Implementation = 2
05350 } CXIdxObjCContainerKind;
05351 
05352 typedef struct {
05353   const CXIdxDeclInfo *declInfo;
05354   CXIdxObjCContainerKind kind;
05355 } CXIdxObjCContainerDeclInfo;
05356 
05357 typedef struct {
05358   const CXIdxEntityInfo *base;
05359   CXCursor cursor;
05360   CXIdxLoc loc;
05361 } CXIdxBaseClassInfo;
05362 
05363 typedef struct {
05364   const CXIdxEntityInfo *protocol;
05365   CXCursor cursor;
05366   CXIdxLoc loc;
05367 } CXIdxObjCProtocolRefInfo;
05368 
05369 typedef struct {
05370   const CXIdxObjCProtocolRefInfo *const *protocols;
05371   unsigned numProtocols;
05372 } CXIdxObjCProtocolRefListInfo;
05373 
05374 typedef struct {
05375   const CXIdxObjCContainerDeclInfo *containerInfo;
05376   const CXIdxBaseClassInfo *superInfo;
05377   const CXIdxObjCProtocolRefListInfo *protocols;
05378 } CXIdxObjCInterfaceDeclInfo;
05379 
05380 typedef struct {
05381   const CXIdxObjCContainerDeclInfo *containerInfo;
05382   const CXIdxEntityInfo *objcClass;
05383   CXCursor classCursor;
05384   CXIdxLoc classLoc;
05385   const CXIdxObjCProtocolRefListInfo *protocols;
05386 } CXIdxObjCCategoryDeclInfo;
05387 
05388 typedef struct {
05389   const CXIdxDeclInfo *declInfo;
05390   const CXIdxEntityInfo *getter;
05391   const CXIdxEntityInfo *setter;
05392 } CXIdxObjCPropertyDeclInfo;
05393 
05394 typedef struct {
05395   const CXIdxDeclInfo *declInfo;
05396   const CXIdxBaseClassInfo *const *bases;
05397   unsigned numBases;
05398 } CXIdxCXXClassDeclInfo;
05399 
05400 /**
05401  * \brief Data for IndexerCallbacks#indexEntityReference.
05402  */
05403 typedef enum {
05404   /**
05405    * \brief The entity is referenced directly in user's code.
05406    */
05407   CXIdxEntityRef_Direct = 1,
05408   /**
05409    * \brief An implicit reference, e.g. a reference of an Objective-C method
05410    * via the dot syntax.
05411    */
05412   CXIdxEntityRef_Implicit = 2
05413 } CXIdxEntityRefKind;
05414 
05415 /**
05416  * \brief Data for IndexerCallbacks#indexEntityReference.
05417  */
05418 typedef struct {
05419   CXIdxEntityRefKind kind;
05420   /**
05421    * \brief Reference cursor.
05422    */
05423   CXCursor cursor;
05424   CXIdxLoc loc;
05425   /**
05426    * \brief The entity that gets referenced.
05427    */
05428   const CXIdxEntityInfo *referencedEntity;
05429   /**
05430    * \brief Immediate "parent" of the reference. For example:
05431    * 
05432    * \code
05433    * Foo *var;
05434    * \endcode
05435    * 
05436    * The parent of reference of type 'Foo' is the variable 'var'.
05437    * For references inside statement bodies of functions/methods,
05438    * the parentEntity will be the function/method.
05439    */
05440   const CXIdxEntityInfo *parentEntity;
05441   /**
05442    * \brief Lexical container context of the reference.
05443    */
05444   const CXIdxContainerInfo *container;
05445 } CXIdxEntityRefInfo;
05446 
05447 /**
05448  * \brief A group of callbacks used by #clang_indexSourceFile and
05449  * #clang_indexTranslationUnit.
05450  */
05451 typedef struct {
05452   /**
05453    * \brief Called periodically to check whether indexing should be aborted.
05454    * Should return 0 to continue, and non-zero to abort.
05455    */
05456   int (*abortQuery)(CXClientData client_data, void *reserved);
05457 
05458   /**
05459    * \brief Called at the end of indexing; passes the complete diagnostic set.
05460    */
05461   void (*diagnostic)(CXClientData client_data,
05462                      CXDiagnosticSet, void *reserved);
05463 
05464   CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
05465                                      CXFile mainFile, void *reserved);
05466   
05467   /**
05468    * \brief Called when a file gets \#included/\#imported.
05469    */
05470   CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
05471                                     const CXIdxIncludedFileInfo *);
05472   
05473   /**
05474    * \brief Called when a AST file (PCH or module) gets imported.
05475    * 
05476    * AST files will not get indexed (there will not be callbacks to index all
05477    * the entities in an AST file). The recommended action is that, if the AST
05478    * file is not already indexed, to initiate a new indexing job specific to
05479    * the AST file.
05480    */
05481   CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
05482                                         const CXIdxImportedASTFileInfo *);
05483 
05484   /**
05485    * \brief Called at the beginning of indexing a translation unit.
05486    */
05487   CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
05488                                                  void *reserved);
05489 
05490   void (*indexDeclaration)(CXClientData client_data,
05491                            const CXIdxDeclInfo *);
05492 
05493   /**
05494    * \brief Called to index a reference of an entity.
05495    */
05496   void (*indexEntityReference)(CXClientData client_data,
05497                                const CXIdxEntityRefInfo *);
05498 
05499 } IndexerCallbacks;
05500 
05501 CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
05502 CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
05503 clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
05504 
05505 CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
05506 clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
05507 
05508 CINDEX_LINKAGE
05509 const CXIdxObjCCategoryDeclInfo *
05510 clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
05511 
05512 CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
05513 clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
05514 
05515 CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
05516 clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
05517 
05518 CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
05519 clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
05520 
05521 CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
05522 clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
05523 
05524 /**
05525  * \brief For retrieving a custom CXIdxClientContainer attached to a
05526  * container.
05527  */
05528 CINDEX_LINKAGE CXIdxClientContainer
05529 clang_index_getClientContainer(const CXIdxContainerInfo *);
05530 
05531 /**
05532  * \brief For setting a custom CXIdxClientContainer attached to a
05533  * container.
05534  */
05535 CINDEX_LINKAGE void
05536 clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
05537 
05538 /**
05539  * \brief For retrieving a custom CXIdxClientEntity attached to an entity.
05540  */
05541 CINDEX_LINKAGE CXIdxClientEntity
05542 clang_index_getClientEntity(const CXIdxEntityInfo *);
05543 
05544 /**
05545  * \brief For setting a custom CXIdxClientEntity attached to an entity.
05546  */
05547 CINDEX_LINKAGE void
05548 clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
05549 
05550 /**
05551  * \brief An indexing action/session, to be applied to one or multiple
05552  * translation units.
05553  */
05554 typedef void *CXIndexAction;
05555 
05556 /**
05557  * \brief An indexing action/session, to be applied to one or multiple
05558  * translation units.
05559  *
05560  * \param CIdx The index object with which the index action will be associated.
05561  */
05562 CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
05563 
05564 /**
05565  * \brief Destroy the given index action.
05566  *
05567  * The index action must not be destroyed until all of the translation units
05568  * created within that index action have been destroyed.
05569  */
05570 CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
05571 
05572 typedef enum {
05573   /**
05574    * \brief Used to indicate that no special indexing options are needed.
05575    */
05576   CXIndexOpt_None = 0x0,
05577   
05578   /**
05579    * \brief Used to indicate that IndexerCallbacks#indexEntityReference should
05580    * be invoked for only one reference of an entity per source file that does
05581    * not also include a declaration/definition of the entity.
05582    */
05583   CXIndexOpt_SuppressRedundantRefs = 0x1,
05584 
05585   /**
05586    * \brief Function-local symbols should be indexed. If this is not set
05587    * function-local symbols will be ignored.
05588    */
05589   CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
05590 
05591   /**
05592    * \brief Implicit function/class template instantiations should be indexed.
05593    * If this is not set, implicit instantiations will be ignored.
05594    */
05595   CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
05596 
05597   /**
05598    * \brief Suppress all compiler warnings when parsing for indexing.
05599    */
05600   CXIndexOpt_SuppressWarnings = 0x8,
05601 
05602   /**
05603    * \brief Skip a function/method body that was already parsed during an
05604    * indexing session associated with a \c CXIndexAction object.
05605    * Bodies in system headers are always skipped.
05606    */
05607   CXIndexOpt_SkipParsedBodiesInSession = 0x10
05608 
05609 } CXIndexOptFlags;
05610 
05611 /**
05612  * \brief Index the given source file and the translation unit corresponding
05613  * to that file via callbacks implemented through #IndexerCallbacks.
05614  *
05615  * \param client_data pointer data supplied by the client, which will
05616  * be passed to the invoked callbacks.
05617  *
05618  * \param index_callbacks Pointer to indexing callbacks that the client
05619  * implements.
05620  *
05621  * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
05622  * passed in index_callbacks.
05623  *
05624  * \param index_options A bitmask of options that affects how indexing is
05625  * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
05626  *
05627  * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
05628  * reused after indexing is finished. Set to \c NULL if you do not require it.
05629  *
05630  * \returns 0 on success or if there were errors from which the compiler could
05631  * recover.  If there is a failure from which the there is no recovery, returns
05632  * a non-zero \c CXErrorCode.
05633  *
05634  * The rest of the parameters are the same as #clang_parseTranslationUnit.
05635  */
05636 CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
05637                                          CXClientData client_data,
05638                                          IndexerCallbacks *index_callbacks,
05639                                          unsigned index_callbacks_size,
05640                                          unsigned index_options,
05641                                          const char *source_filename,
05642                                          const char * const *command_line_args,
05643                                          int num_command_line_args,
05644                                          struct CXUnsavedFile *unsaved_files,
05645                                          unsigned num_unsaved_files,
05646                                          CXTranslationUnit *out_TU,
05647                                          unsigned TU_options);
05648 
05649 /**
05650  * \brief Index the given translation unit via callbacks implemented through
05651  * #IndexerCallbacks.
05652  * 
05653  * The order of callback invocations is not guaranteed to be the same as
05654  * when indexing a source file. The high level order will be:
05655  * 
05656  *   -Preprocessor callbacks invocations
05657  *   -Declaration/reference callbacks invocations
05658  *   -Diagnostic callback invocations
05659  *
05660  * The parameters are the same as #clang_indexSourceFile.
05661  * 
05662  * \returns If there is a failure from which the there is no recovery, returns
05663  * non-zero, otherwise returns 0.
05664  */
05665 CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
05666                                               CXClientData client_data,
05667                                               IndexerCallbacks *index_callbacks,
05668                                               unsigned index_callbacks_size,
05669                                               unsigned index_options,
05670                                               CXTranslationUnit);
05671 
05672 /**
05673  * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by
05674  * the given CXIdxLoc.
05675  *
05676  * If the location refers into a macro expansion, retrieves the
05677  * location of the macro expansion and if it refers into a macro argument
05678  * retrieves the location of the argument.
05679  */
05680 CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
05681                                                    CXIdxClientFile *indexFile,
05682                                                    CXFile *file,
05683                                                    unsigned *line,
05684                                                    unsigned *column,
05685                                                    unsigned *offset);
05686 
05687 /**
05688  * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
05689  */
05690 CINDEX_LINKAGE
05691 CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
05692 
05693 /**
05694  * \brief Visitor invoked for each field found by a traversal.
05695  *
05696  * This visitor function will be invoked for each field found by
05697  * \c clang_Type_visitFields. Its first argument is the cursor being
05698  * visited, its second argument is the client data provided to
05699  * \c clang_Type_visitFields.
05700  *
05701  * The visitor should return one of the \c CXVisitorResult values
05702  * to direct \c clang_Type_visitFields.
05703  */
05704 typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
05705                                                CXClientData client_data);
05706 
05707 /**
05708  * \brief Visit the fields of a particular type.
05709  *
05710  * This function visits all the direct fields of the given cursor,
05711  * invoking the given \p visitor function with the cursors of each
05712  * visited field. The traversal may be ended prematurely, if
05713  * the visitor returns \c CXFieldVisit_Break.
05714  *
05715  * \param T the record type whose field may be visited.
05716  *
05717  * \param visitor the visitor function that will be invoked for each
05718  * field of \p T.
05719  *
05720  * \param client_data pointer data supplied by the client, which will
05721  * be passed to the visitor each time it is invoked.
05722  *
05723  * \returns a non-zero value if the traversal was terminated
05724  * prematurely by the visitor returning \c CXFieldVisit_Break.
05725  */
05726 CINDEX_LINKAGE unsigned clang_Type_visitFields(CXType T,
05727                                                CXFieldVisitor visitor,
05728                                                CXClientData client_data);
05729 
05730 
05731 /**
05732  * @}
05733  */
05734 
05735 /**
05736  * @}
05737  */
05738 
05739 #ifdef __cplusplus
05740 }
05741 #endif
05742 #endif
05743