1 /*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header provides a public inferface to a Clang library for extracting *|
11 |* high-level symbol information from source files without exposing the full *|
14 \*===----------------------------------------------------------------------===*/
16 #ifndef LLVM_CLANG_C_INDEX_H
17 #define LLVM_CLANG_C_INDEX_H
21 #include "clang-c/Platform.h"
22 #include "clang-c/CXErrorCode.h"
23 #include "clang-c/CXString.h"
24 #include "clang-c/BuildSystem.h"
27 * \brief The version constants for the libclang API.
28 * CINDEX_VERSION_MINOR should increase when there are API additions.
29 * CINDEX_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
31 * The policy about the libclang API was always to keep it source and ABI
32 * compatible, thus CINDEX_VERSION_MAJOR is expected to remain stable.
34 #define CINDEX_VERSION_MAJOR 0
35 #define CINDEX_VERSION_MINOR 30
37 #define CINDEX_VERSION_ENCODE(major, minor) ( \
41 #define CINDEX_VERSION CINDEX_VERSION_ENCODE( \
42 CINDEX_VERSION_MAJOR, \
43 CINDEX_VERSION_MINOR )
45 #define CINDEX_VERSION_STRINGIZE_(major, minor) \
47 #define CINDEX_VERSION_STRINGIZE(major, minor) \
48 CINDEX_VERSION_STRINGIZE_(major, minor)
50 #define CINDEX_VERSION_STRING CINDEX_VERSION_STRINGIZE( \
51 CINDEX_VERSION_MAJOR, \
58 /** \defgroup CINDEX libclang: C Interface to Clang
60 * The C Interface to Clang provides a relatively small API that exposes
61 * facilities for parsing source code into an abstract syntax tree (AST),
62 * loading already-parsed ASTs, traversing the AST, associating
63 * physical source locations with elements within the AST, and other
64 * facilities that support Clang-based development tools.
66 * This C interface to Clang will never provide all of the information
67 * representation stored in Clang's C++ AST, nor should it: the intent is to
68 * maintain an API that is relatively stable from one release to the next,
69 * providing only the basic functionality needed to support development tools.
71 * To avoid namespace pollution, data types are prefixed with "CX" and
72 * functions are prefixed with "clang_".
78 * \brief An "index" that consists of a set of translation units that would
79 * typically be linked together into an executable or library.
81 typedef void *CXIndex;
84 * \brief A single translation unit, which resides in an index.
86 typedef struct CXTranslationUnitImpl *CXTranslationUnit;
89 * \brief Opaque pointer representing client data that will be passed through
90 * to various callbacks and visitors.
92 typedef void *CXClientData;
95 * \brief Provides the contents of a file that has not yet been saved to disk.
97 * Each CXUnsavedFile instance provides the name of a file on the
98 * system along with the current contents of that file that have not
99 * yet been saved to disk.
101 struct CXUnsavedFile {
103 * \brief The file whose contents have not yet been saved.
105 * This file must already exist in the file system.
107 const char *Filename;
110 * \brief A buffer containing the unsaved contents of this file.
112 const char *Contents;
115 * \brief The length of the unsaved contents of this buffer.
117 unsigned long Length;
121 * \brief Describes the availability of a particular entity, which indicates
122 * whether the use of this entity will result in a warning or error due to
123 * it being deprecated or unavailable.
125 enum CXAvailabilityKind {
127 * \brief The entity is available.
129 CXAvailability_Available,
131 * \brief The entity is available, but has been deprecated (and its use is
134 CXAvailability_Deprecated,
136 * \brief The entity is not available; any use of it will be an error.
138 CXAvailability_NotAvailable,
140 * \brief The entity is available, but not accessible; any use of it will be
143 CXAvailability_NotAccessible
147 * \brief Describes a version number of the form major.minor.subminor.
149 typedef struct CXVersion {
151 * \brief The major version number, e.g., the '10' in '10.7.3'. A negative
152 * value indicates that there is no version number at all.
156 * \brief The minor version number, e.g., the '7' in '10.7.3'. This value
157 * will be negative if no minor version number was provided, e.g., for
162 * \brief The subminor version number, e.g., the '3' in '10.7.3'. This value
163 * will be negative if no minor or subminor version number was provided,
164 * e.g., in version '10' or '10.7'.
170 * \brief Provides a shared context for creating translation units.
172 * It provides two options:
174 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
175 * declarations (when loading any new translation units). A "local" declaration
176 * is one that belongs in the translation unit itself and not in a precompiled
177 * header that was used by the translation unit. If zero, all declarations
178 * will be enumerated.
180 * Here is an example:
183 * // excludeDeclsFromPCH = 1, displayDiagnostics=1
184 * Idx = clang_createIndex(1, 1);
186 * // IndexTest.pch was produced with the following command:
187 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
188 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
190 * // This will load all the symbols from 'IndexTest.pch'
191 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
192 * TranslationUnitVisitor, 0);
193 * clang_disposeTranslationUnit(TU);
195 * // This will load all the symbols from 'IndexTest.c', excluding symbols
196 * // from 'IndexTest.pch'.
197 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
198 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
200 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
201 * TranslationUnitVisitor, 0);
202 * clang_disposeTranslationUnit(TU);
205 * This process of creating the 'pch', loading it separately, and using it (via
206 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
207 * (which gives the indexer the same performance benefit as the compiler).
209 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
210 int displayDiagnostics);
213 * \brief Destroy the given index.
215 * The index must not be destroyed until all of the translation units created
216 * within that index have been destroyed.
218 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
222 * \brief Used to indicate that no special CXIndex options are needed.
224 CXGlobalOpt_None = 0x0,
227 * \brief Used to indicate that threads that libclang creates for indexing
228 * purposes should use background priority.
230 * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
231 * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
233 CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1,
236 * \brief Used to indicate that threads that libclang creates for editing
237 * purposes should use background priority.
239 * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
240 * #clang_annotateTokens
242 CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2,
245 * \brief Used to indicate that all threads that libclang creates should use
246 * background priority.
248 CXGlobalOpt_ThreadBackgroundPriorityForAll =
249 CXGlobalOpt_ThreadBackgroundPriorityForIndexing |
250 CXGlobalOpt_ThreadBackgroundPriorityForEditing
255 * \brief Sets general options associated with a CXIndex.
260 * clang_CXIndex_setGlobalOptions(idx,
261 * clang_CXIndex_getGlobalOptions(idx) |
262 * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
265 * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
267 CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
270 * \brief Gets the general options associated with a CXIndex.
272 * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
273 * are associated with the given CXIndex object.
275 CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex);
278 * \defgroup CINDEX_FILES File manipulation routines
284 * \brief A particular source file that is part of a translation unit.
286 typedef void *CXFile;
290 * \brief Retrieve the complete file and path name of the given file.
292 CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
295 * \brief Retrieve the last modification time of the given file.
297 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
300 * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
301 * across an indexing session.
304 unsigned long long data[3];
308 * \brief Retrieve the unique ID for the given \c file.
310 * \param file the file to get the ID for.
311 * \param outID stores the returned CXFileUniqueID.
312 * \returns If there was a failure getting the unique ID, returns non-zero,
313 * otherwise returns 0.
315 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
318 * \brief Determine whether the given header is guarded against
319 * multiple inclusions, either with the conventional
320 * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
322 CINDEX_LINKAGE unsigned
323 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
326 * \brief Retrieve a file handle within the given translation unit.
328 * \param tu the translation unit
330 * \param file_name the name of the file.
332 * \returns the file handle for the named file in the translation unit \p tu,
333 * or a NULL file handle if the file was not a part of this translation unit.
335 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
336 const char *file_name);
339 * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
340 * or they are both NULL.
342 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
349 * \defgroup CINDEX_LOCATIONS Physical source locations
351 * Clang represents physical source locations in its abstract syntax tree in
352 * great detail, with file, line, and column information for the majority of
353 * the tokens parsed in the source code. These data types and functions are
354 * used to represent source location information, either for a particular
355 * point in the program or for a range of points in the program, and extract
356 * specific location information from those data types.
362 * \brief Identifies a specific source location within a translation
365 * Use clang_getExpansionLocation() or clang_getSpellingLocation()
366 * to map a source location to a particular file, line, and column.
369 const void *ptr_data[2];
374 * \brief Identifies a half-open character range in the source code.
376 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
377 * starting and end locations from a source range, respectively.
380 const void *ptr_data[2];
381 unsigned begin_int_data;
382 unsigned end_int_data;
386 * \brief Retrieve a NULL (invalid) source location.
388 CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(void);
391 * \brief Determine whether two source locations, which must refer into
392 * the same translation unit, refer to exactly the same point in the source
395 * \returns non-zero if the source locations refer to the same location, zero
396 * if they refer to different locations.
398 CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
399 CXSourceLocation loc2);
402 * \brief Retrieves the source location associated with a given file/line/column
403 * in a particular translation unit.
405 CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
410 * \brief Retrieves the source location associated with a given character offset
411 * in a particular translation unit.
413 CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
418 * \brief Returns non-zero if the given source location is in a system header.
420 CINDEX_LINKAGE int clang_Location_isInSystemHeader(CXSourceLocation location);
423 * \brief Returns non-zero if the given source location is in the main file of
424 * the corresponding translation unit.
426 CINDEX_LINKAGE int clang_Location_isFromMainFile(CXSourceLocation location);
429 * \brief Retrieve a NULL (invalid) source range.
431 CINDEX_LINKAGE CXSourceRange clang_getNullRange(void);
434 * \brief Retrieve a source range given the beginning and ending source
437 CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
438 CXSourceLocation end);
441 * \brief Determine whether two ranges are equivalent.
443 * \returns non-zero if the ranges are the same, zero if they differ.
445 CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
446 CXSourceRange range2);
449 * \brief Returns non-zero if \p range is null.
451 CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
454 * \brief Retrieve the file, line, column, and offset represented by
455 * the given source location.
457 * If the location refers into a macro expansion, retrieves the
458 * location of the macro expansion.
460 * \param location the location within a source file that will be decomposed
463 * \param file [out] if non-NULL, will be set to the file to which the given
464 * source location points.
466 * \param line [out] if non-NULL, will be set to the line to which the given
467 * source location points.
469 * \param column [out] if non-NULL, will be set to the column to which the given
470 * source location points.
472 * \param offset [out] if non-NULL, will be set to the offset into the
473 * buffer to which the given source location points.
475 CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location,
482 * \brief Retrieve the file, line, column, and offset represented by
483 * the given source location, as specified in a # line directive.
485 * Example: given the following source code in a file somefile.c
490 * static int func(void)
496 * the location information returned by this function would be
498 * File: dummy.c Line: 124 Column: 12
500 * whereas clang_getExpansionLocation would have returned
502 * File: somefile.c Line: 3 Column: 12
504 * \param location the location within a source file that will be decomposed
507 * \param filename [out] if non-NULL, will be set to the filename of the
508 * source location. Note that filenames returned will be for "virtual" files,
509 * which don't necessarily exist on the machine running clang - e.g. when
510 * parsing preprocessed output obtained from a different environment. If
511 * a non-NULL value is passed in, remember to dispose of the returned value
512 * using \c clang_disposeString() once you've finished with it. For an invalid
513 * source location, an empty string is returned.
515 * \param line [out] if non-NULL, will be set to the line number of the
516 * source location. For an invalid source location, zero is returned.
518 * \param column [out] if non-NULL, will be set to the column number of the
519 * source location. For an invalid source location, zero is returned.
521 CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location,
527 * \brief Legacy API to retrieve the file, line, column, and offset represented
528 * by the given source location.
530 * This interface has been replaced by the newer interface
531 * #clang_getExpansionLocation(). See that interface's documentation for
534 CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
541 * \brief Retrieve the file, line, column, and offset represented by
542 * the given source location.
544 * If the location refers into a macro instantiation, return where the
545 * location was originally spelled in the source file.
547 * \param location the location within a source file that will be decomposed
550 * \param file [out] if non-NULL, will be set to the file to which the given
551 * source location points.
553 * \param line [out] if non-NULL, will be set to the line to which the given
554 * source location points.
556 * \param column [out] if non-NULL, will be set to the column to which the given
557 * source location points.
559 * \param offset [out] if non-NULL, will be set to the offset into the
560 * buffer to which the given source location points.
562 CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
569 * \brief Retrieve the file, line, column, and offset represented by
570 * the given source location.
572 * If the location refers into a macro expansion, return where the macro was
573 * expanded or where the macro argument was written, if the location points at
576 * \param location the location within a source file that will be decomposed
579 * \param file [out] if non-NULL, will be set to the file to which the given
580 * source location points.
582 * \param line [out] if non-NULL, will be set to the line to which the given
583 * source location points.
585 * \param column [out] if non-NULL, will be set to the column to which the given
586 * source location points.
588 * \param offset [out] if non-NULL, will be set to the offset into the
589 * buffer to which the given source location points.
591 CINDEX_LINKAGE void clang_getFileLocation(CXSourceLocation location,
598 * \brief Retrieve a source location representing the first character within a
601 CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
604 * \brief Retrieve a source location representing the last character within a
607 CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
610 * \brief Identifies an array of ranges.
613 /** \brief The number of ranges in the \c ranges array. */
616 * \brief An array of \c CXSourceRanges.
618 CXSourceRange *ranges;
622 * \brief Retrieve all ranges that were skipped by the preprocessor.
624 * The preprocessor will skip lines when they are surrounded by an
625 * if/ifdef/ifndef directive whose condition does not evaluate to true.
627 CINDEX_LINKAGE CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit tu,
631 * \brief Destroy the given \c CXSourceRangeList.
633 CINDEX_LINKAGE void clang_disposeSourceRangeList(CXSourceRangeList *ranges);
640 * \defgroup CINDEX_DIAG Diagnostic reporting
646 * \brief Describes the severity of a particular diagnostic.
648 enum CXDiagnosticSeverity {
650 * \brief A diagnostic that has been suppressed, e.g., by a command-line
653 CXDiagnostic_Ignored = 0,
656 * \brief This diagnostic is a note that should be attached to the
657 * previous (non-note) diagnostic.
659 CXDiagnostic_Note = 1,
662 * \brief This diagnostic indicates suspicious code that may not be
665 CXDiagnostic_Warning = 2,
668 * \brief This diagnostic indicates that the code is ill-formed.
670 CXDiagnostic_Error = 3,
673 * \brief This diagnostic indicates that the code is ill-formed such
674 * that future parser recovery is unlikely to produce useful
677 CXDiagnostic_Fatal = 4
681 * \brief A single diagnostic, containing the diagnostic's severity,
682 * location, text, source ranges, and fix-it hints.
684 typedef void *CXDiagnostic;
687 * \brief A group of CXDiagnostics.
689 typedef void *CXDiagnosticSet;
692 * \brief Determine the number of diagnostics in a CXDiagnosticSet.
694 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
697 * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
699 * \param Diags the CXDiagnosticSet to query.
700 * \param Index the zero-based diagnostic number to retrieve.
702 * \returns the requested diagnostic. This diagnostic must be freed
703 * via a call to \c clang_disposeDiagnostic().
705 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
710 * \brief Describes the kind of error that occurred (if any) in a call to
711 * \c clang_loadDiagnostics.
713 enum CXLoadDiag_Error {
715 * \brief Indicates that no error occurred.
720 * \brief Indicates that an unknown error occurred while attempting to
721 * deserialize diagnostics.
723 CXLoadDiag_Unknown = 1,
726 * \brief Indicates that the file containing the serialized diagnostics
727 * could not be opened.
729 CXLoadDiag_CannotLoad = 2,
732 * \brief Indicates that the serialized diagnostics file is invalid or
735 CXLoadDiag_InvalidFile = 3
739 * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
742 * \param file The name of the file to deserialize.
743 * \param error A pointer to a enum value recording if there was a problem
744 * deserializing the diagnostics.
745 * \param errorString A pointer to a CXString for recording the error string
746 * if the file was not successfully loaded.
748 * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
749 * diagnostics should be released using clang_disposeDiagnosticSet().
751 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
752 enum CXLoadDiag_Error *error,
753 CXString *errorString);
756 * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
758 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
761 * \brief Retrieve the child diagnostics of a CXDiagnostic.
763 * This CXDiagnosticSet does not need to be released by
764 * clang_disposeDiagnosticSet.
766 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
769 * \brief Determine the number of diagnostics produced for the given
772 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
775 * \brief Retrieve a diagnostic associated with the given translation unit.
777 * \param Unit the translation unit to query.
778 * \param Index the zero-based diagnostic number to retrieve.
780 * \returns the requested diagnostic. This diagnostic must be freed
781 * via a call to \c clang_disposeDiagnostic().
783 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
787 * \brief Retrieve the complete set of diagnostics associated with a
790 * \param Unit the translation unit to query.
792 CINDEX_LINKAGE CXDiagnosticSet
793 clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
796 * \brief Destroy a diagnostic.
798 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
801 * \brief Options to control the display of diagnostics.
803 * The values in this enum are meant to be combined to customize the
804 * behavior of \c clang_formatDiagnostic().
806 enum CXDiagnosticDisplayOptions {
808 * \brief Display the source-location information where the
809 * diagnostic was located.
811 * When set, diagnostics will be prefixed by the file, line, and
812 * (optionally) column to which the diagnostic refers. For example,
815 * test.c:28: warning: extra tokens at end of #endif directive
818 * This option corresponds to the clang flag \c -fshow-source-location.
820 CXDiagnostic_DisplaySourceLocation = 0x01,
823 * \brief If displaying the source-location information of the
824 * diagnostic, also include the column number.
826 * This option corresponds to the clang flag \c -fshow-column.
828 CXDiagnostic_DisplayColumn = 0x02,
831 * \brief If displaying the source-location information of the
832 * diagnostic, also include information about source ranges in a
833 * machine-parsable format.
835 * This option corresponds to the clang flag
836 * \c -fdiagnostics-print-source-range-info.
838 CXDiagnostic_DisplaySourceRanges = 0x04,
841 * \brief Display the option name associated with this diagnostic, if any.
843 * The option name displayed (e.g., -Wconversion) will be placed in brackets
844 * after the diagnostic text. This option corresponds to the clang flag
845 * \c -fdiagnostics-show-option.
847 CXDiagnostic_DisplayOption = 0x08,
850 * \brief Display the category number associated with this diagnostic, if any.
852 * The category number is displayed within brackets after the diagnostic text.
853 * This option corresponds to the clang flag
854 * \c -fdiagnostics-show-category=id.
856 CXDiagnostic_DisplayCategoryId = 0x10,
859 * \brief Display the category name associated with this diagnostic, if any.
861 * The category name is displayed within brackets after the diagnostic text.
862 * This option corresponds to the clang flag
863 * \c -fdiagnostics-show-category=name.
865 CXDiagnostic_DisplayCategoryName = 0x20
869 * \brief Format the given diagnostic in a manner that is suitable for display.
871 * This routine will format the given diagnostic to a string, rendering
872 * the diagnostic according to the various options given. The
873 * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
874 * options that most closely mimics the behavior of the clang compiler.
876 * \param Diagnostic The diagnostic to print.
878 * \param Options A set of options that control the diagnostic display,
879 * created by combining \c CXDiagnosticDisplayOptions values.
881 * \returns A new string containing for formatted diagnostic.
883 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
887 * \brief Retrieve the set of display options most similar to the
888 * default behavior of the clang compiler.
890 * \returns A set of display options suitable for use with \c
891 * clang_formatDiagnostic().
893 CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
896 * \brief Determine the severity of the given diagnostic.
898 CINDEX_LINKAGE enum CXDiagnosticSeverity
899 clang_getDiagnosticSeverity(CXDiagnostic);
902 * \brief Retrieve the source location of the given diagnostic.
904 * This location is where Clang would print the caret ('^') when
905 * displaying the diagnostic on the command line.
907 CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
910 * \brief Retrieve the text of the given diagnostic.
912 CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
915 * \brief Retrieve the name of the command-line option that enabled this
918 * \param Diag The diagnostic to be queried.
920 * \param Disable If non-NULL, will be set to the option that disables this
921 * diagnostic (if any).
923 * \returns A string that contains the command-line option used to enable this
924 * warning, such as "-Wconversion" or "-pedantic".
926 CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
930 * \brief Retrieve the category number for this diagnostic.
932 * Diagnostics can be categorized into groups along with other, related
933 * diagnostics (e.g., diagnostics under the same warning flag). This routine
934 * retrieves the category number for the given diagnostic.
936 * \returns The number of the category that contains this diagnostic, or zero
937 * if this diagnostic is uncategorized.
939 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
942 * \brief Retrieve the name of a particular diagnostic category. This
943 * is now deprecated. Use clang_getDiagnosticCategoryText()
946 * \param Category A diagnostic category number, as returned by
947 * \c clang_getDiagnosticCategory().
949 * \returns The name of the given diagnostic category.
951 CINDEX_DEPRECATED CINDEX_LINKAGE
952 CXString clang_getDiagnosticCategoryName(unsigned Category);
955 * \brief Retrieve the diagnostic category text for a given diagnostic.
957 * \returns The text of the given diagnostic category.
959 CINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic);
962 * \brief Determine the number of source ranges associated with the given
965 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
968 * \brief Retrieve a source range associated with the diagnostic.
970 * A diagnostic's source ranges highlight important elements in the source
971 * code. On the command line, Clang displays source ranges by
972 * underlining them with '~' characters.
974 * \param Diagnostic the diagnostic whose range is being extracted.
976 * \param Range the zero-based index specifying which range to
978 * \returns the requested source range.
980 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
984 * \brief Determine the number of fix-it hints associated with the
987 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
990 * \brief Retrieve the replacement information for a given fix-it.
992 * Fix-its are described in terms of a source range whose contents
993 * should be replaced by a string. This approach generalizes over
994 * three kinds of operations: removal of source code (the range covers
995 * the code to be removed and the replacement string is empty),
996 * replacement of source code (the range covers the code to be
997 * replaced and the replacement string provides the new code), and
998 * insertion (both the start and end of the range point at the
999 * insertion location, and the replacement string provides the text to
1002 * \param Diagnostic The diagnostic whose fix-its are being queried.
1004 * \param FixIt The zero-based index of the fix-it.
1006 * \param ReplacementRange The source range whose contents will be
1007 * replaced with the returned replacement string. Note that source
1008 * ranges are half-open ranges [a, b), so the source code should be
1009 * replaced from a and up to (but not including) b.
1011 * \returns A string containing text that should be replace the source
1012 * code indicated by the \c ReplacementRange.
1014 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1016 CXSourceRange *ReplacementRange);
1023 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1025 * The routines in this group provide the ability to create and destroy
1026 * translation units from files, either by parsing the contents of the files or
1027 * by reading in a serialized representation of a translation unit.
1033 * \brief Get the original translation unit source file name.
1035 CINDEX_LINKAGE CXString
1036 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1039 * \brief Return the CXTranslationUnit for a given source file and the provided
1040 * command line arguments one would pass to the compiler.
1042 * Note: The 'source_filename' argument is optional. If the caller provides a
1043 * NULL pointer, the name of the source file is expected to reside in the
1044 * specified command line arguments.
1046 * Note: When encountered in 'clang_command_line_args', the following options
1052 * '-o \<output file>' (both '-o' and '\<output file>' are ignored)
1054 * \param CIdx The index object with which the translation unit will be
1057 * \param source_filename The name of the source file to load, or NULL if the
1058 * source file is included in \p clang_command_line_args.
1060 * \param num_clang_command_line_args The number of command-line arguments in
1061 * \p clang_command_line_args.
1063 * \param clang_command_line_args The command-line arguments that would be
1064 * passed to the \c clang executable if it were being invoked out-of-process.
1065 * These command-line options will be parsed and will affect how the translation
1066 * unit is parsed. Note that the following options are ignored: '-c',
1067 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1069 * \param num_unsaved_files the number of unsaved file entries in \p
1072 * \param unsaved_files the files that have not yet been saved to disk
1073 * but may be required for code completion, including the contents of
1074 * those files. The contents and name of these files (as specified by
1075 * CXUnsavedFile) are copied when necessary, so the client only needs to
1076 * guarantee their validity until the call to this function returns.
1078 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
1080 const char *source_filename,
1081 int num_clang_command_line_args,
1082 const char * const *clang_command_line_args,
1083 unsigned num_unsaved_files,
1084 struct CXUnsavedFile *unsaved_files);
1087 * \brief Same as \c clang_createTranslationUnit2, but returns
1088 * the \c CXTranslationUnit instead of an error code. In case of an error this
1089 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1092 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(
1094 const char *ast_filename);
1097 * \brief Create a translation unit from an AST file (\c -emit-ast).
1099 * \param[out] out_TU A non-NULL pointer to store the created
1100 * \c CXTranslationUnit.
1102 * \returns Zero on success, otherwise returns an error code.
1104 CINDEX_LINKAGE enum CXErrorCode clang_createTranslationUnit2(
1106 const char *ast_filename,
1107 CXTranslationUnit *out_TU);
1110 * \brief Flags that control the creation of translation units.
1112 * The enumerators in this enumeration type are meant to be bitwise
1113 * ORed together to specify which options should be used when
1114 * constructing the translation unit.
1116 enum CXTranslationUnit_Flags {
1118 * \brief Used to indicate that no special translation-unit options are
1121 CXTranslationUnit_None = 0x0,
1124 * \brief Used to indicate that the parser should construct a "detailed"
1125 * preprocessing record, including all macro definitions and instantiations.
1127 * Constructing a detailed preprocessing record requires more memory
1128 * and time to parse, since the information contained in the record
1129 * is usually not retained. However, it can be useful for
1130 * applications that require more detailed information about the
1131 * behavior of the preprocessor.
1133 CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
1136 * \brief Used to indicate that the translation unit is incomplete.
1138 * When a translation unit is considered "incomplete", semantic
1139 * analysis that is typically performed at the end of the
1140 * translation unit will be suppressed. For example, this suppresses
1141 * the completion of tentative declarations in C and of
1142 * instantiation of implicitly-instantiation function templates in
1143 * C++. This option is typically used when parsing a header with the
1144 * intent of producing a precompiled header.
1146 CXTranslationUnit_Incomplete = 0x02,
1149 * \brief Used to indicate that the translation unit should be built with an
1150 * implicit precompiled header for the preamble.
1152 * An implicit precompiled header is used as an optimization when a
1153 * particular translation unit is likely to be reparsed many times
1154 * when the sources aren't changing that often. In this case, an
1155 * implicit precompiled header will be built containing all of the
1156 * initial includes at the top of the main file (what we refer to as
1157 * the "preamble" of the file). In subsequent parses, if the
1158 * preamble or the files in it have not changed, \c
1159 * clang_reparseTranslationUnit() will re-use the implicit
1160 * precompiled header to improve parsing performance.
1162 CXTranslationUnit_PrecompiledPreamble = 0x04,
1165 * \brief Used to indicate that the translation unit should cache some
1166 * code-completion results with each reparse of the source file.
1168 * Caching of code-completion results is a performance optimization that
1169 * introduces some overhead to reparsing but improves the performance of
1170 * code-completion operations.
1172 CXTranslationUnit_CacheCompletionResults = 0x08,
1175 * \brief Used to indicate that the translation unit will be serialized with
1176 * \c clang_saveTranslationUnit.
1178 * This option is typically used when parsing a header with the intent of
1179 * producing a precompiled header.
1181 CXTranslationUnit_ForSerialization = 0x10,
1184 * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1186 * Note: this is a *temporary* option that is available only while
1187 * we are testing C++ precompiled preamble support. It is deprecated.
1189 CXTranslationUnit_CXXChainedPCH = 0x20,
1192 * \brief Used to indicate that function/method bodies should be skipped while
1195 * This option can be used to search for declarations/definitions while
1196 * ignoring the usages.
1198 CXTranslationUnit_SkipFunctionBodies = 0x40,
1201 * \brief Used to indicate that brief documentation comments should be
1202 * included into the set of code completions returned from this translation
1205 CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80
1209 * \brief Returns the set of flags that is suitable for parsing a translation
1210 * unit that is being edited.
1212 * The set of flags returned provide options for \c clang_parseTranslationUnit()
1213 * to indicate that the translation unit is likely to be reparsed many times,
1214 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1215 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1216 * set contains an unspecified set of optimizations (e.g., the precompiled
1217 * preamble) geared toward improving the performance of these routines. The
1218 * set of optimizations enabled may change from one version to the next.
1220 CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
1223 * \brief Same as \c clang_parseTranslationUnit2, but returns
1224 * the \c CXTranslationUnit instead of an error code. In case of an error this
1225 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1228 CINDEX_LINKAGE CXTranslationUnit
1229 clang_parseTranslationUnit(CXIndex CIdx,
1230 const char *source_filename,
1231 const char *const *command_line_args,
1232 int num_command_line_args,
1233 struct CXUnsavedFile *unsaved_files,
1234 unsigned num_unsaved_files,
1238 * \brief Parse the given source file and the translation unit corresponding
1241 * This routine is the main entry point for the Clang C API, providing the
1242 * ability to parse a source file into a translation unit that can then be
1243 * queried by other functions in the API. This routine accepts a set of
1244 * command-line arguments so that the compilation can be configured in the same
1245 * way that the compiler is configured on the command line.
1247 * \param CIdx The index object with which the translation unit will be
1250 * \param source_filename The name of the source file to load, or NULL if the
1251 * source file is included in \c command_line_args.
1253 * \param command_line_args The command-line arguments that would be
1254 * passed to the \c clang executable if it were being invoked out-of-process.
1255 * These command-line options will be parsed and will affect how the translation
1256 * unit is parsed. Note that the following options are ignored: '-c',
1257 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1259 * \param num_command_line_args The number of command-line arguments in
1260 * \c command_line_args.
1262 * \param unsaved_files the files that have not yet been saved to disk
1263 * but may be required for parsing, including the contents of
1264 * those files. The contents and name of these files (as specified by
1265 * CXUnsavedFile) are copied when necessary, so the client only needs to
1266 * guarantee their validity until the call to this function returns.
1268 * \param num_unsaved_files the number of unsaved file entries in \p
1271 * \param options A bitmask of options that affects how the translation unit
1272 * is managed but not its compilation. This should be a bitwise OR of the
1273 * CXTranslationUnit_XXX flags.
1275 * \param[out] out_TU A non-NULL pointer to store the created
1276 * \c CXTranslationUnit, describing the parsed code and containing any
1277 * diagnostics produced by the compiler.
1279 * \returns Zero on success, otherwise returns an error code.
1281 CINDEX_LINKAGE enum CXErrorCode
1282 clang_parseTranslationUnit2(CXIndex CIdx,
1283 const char *source_filename,
1284 const char *const *command_line_args,
1285 int num_command_line_args,
1286 struct CXUnsavedFile *unsaved_files,
1287 unsigned num_unsaved_files,
1289 CXTranslationUnit *out_TU);
1292 * \brief Flags that control how translation units are saved.
1294 * The enumerators in this enumeration type are meant to be bitwise
1295 * ORed together to specify which options should be used when
1296 * saving the translation unit.
1298 enum CXSaveTranslationUnit_Flags {
1300 * \brief Used to indicate that no special saving options are needed.
1302 CXSaveTranslationUnit_None = 0x0
1306 * \brief Returns the set of flags that is suitable for saving a translation
1309 * The set of flags returned provide options for
1310 * \c clang_saveTranslationUnit() by default. The returned flag
1311 * set contains an unspecified set of options that save translation units with
1312 * the most commonly-requested data.
1314 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1317 * \brief Describes the kind of error that occurred (if any) in a call to
1318 * \c clang_saveTranslationUnit().
1322 * \brief Indicates that no error occurred while saving a translation unit.
1324 CXSaveError_None = 0,
1327 * \brief Indicates that an unknown error occurred while attempting to save
1330 * This error typically indicates that file I/O failed when attempting to
1333 CXSaveError_Unknown = 1,
1336 * \brief Indicates that errors during translation prevented this attempt
1337 * to save the translation unit.
1339 * Errors that prevent the translation unit from being saved can be
1340 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1342 CXSaveError_TranslationErrors = 2,
1345 * \brief Indicates that the translation unit to be saved was somehow
1346 * invalid (e.g., NULL).
1348 CXSaveError_InvalidTU = 3
1352 * \brief Saves a translation unit into a serialized representation of
1353 * that translation unit on disk.
1355 * Any translation unit that was parsed without error can be saved
1356 * into a file. The translation unit can then be deserialized into a
1357 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1358 * if it is an incomplete translation unit that corresponds to a
1359 * header, used as a precompiled header when parsing other translation
1362 * \param TU The translation unit to save.
1364 * \param FileName The file to which the translation unit will be saved.
1366 * \param options A bitmask of options that affects how the translation unit
1367 * is saved. This should be a bitwise OR of the
1368 * CXSaveTranslationUnit_XXX flags.
1370 * \returns A value that will match one of the enumerators of the CXSaveError
1371 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1372 * saved successfully, while a non-zero value indicates that a problem occurred.
1374 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1375 const char *FileName,
1379 * \brief Destroy the specified CXTranslationUnit object.
1381 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1384 * \brief Flags that control the reparsing of translation units.
1386 * The enumerators in this enumeration type are meant to be bitwise
1387 * ORed together to specify which options should be used when
1388 * reparsing the translation unit.
1390 enum CXReparse_Flags {
1392 * \brief Used to indicate that no special reparsing options are needed.
1394 CXReparse_None = 0x0
1398 * \brief Returns the set of flags that is suitable for reparsing a translation
1401 * The set of flags returned provide options for
1402 * \c clang_reparseTranslationUnit() by default. The returned flag
1403 * set contains an unspecified set of optimizations geared toward common uses
1404 * of reparsing. The set of optimizations enabled may change from one version
1407 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1410 * \brief Reparse the source files that produced this translation unit.
1412 * This routine can be used to re-parse the source files that originally
1413 * created the given translation unit, for example because those source files
1414 * have changed (either on disk or as passed via \p unsaved_files). The
1415 * source code will be reparsed with the same command-line options as it
1416 * was originally parsed.
1418 * Reparsing a translation unit invalidates all cursors and source locations
1419 * that refer into that translation unit. This makes reparsing a translation
1420 * unit semantically equivalent to destroying the translation unit and then
1421 * creating a new translation unit with the same command-line arguments.
1422 * However, it may be more efficient to reparse a translation
1423 * unit using this routine.
1425 * \param TU The translation unit whose contents will be re-parsed. The
1426 * translation unit must originally have been built with
1427 * \c clang_createTranslationUnitFromSourceFile().
1429 * \param num_unsaved_files The number of unsaved file entries in \p
1432 * \param unsaved_files The files that have not yet been saved to disk
1433 * but may be required for parsing, including the contents of
1434 * those files. The contents and name of these files (as specified by
1435 * CXUnsavedFile) are copied when necessary, so the client only needs to
1436 * guarantee their validity until the call to this function returns.
1438 * \param options A bitset of options composed of the flags in CXReparse_Flags.
1439 * The function \c clang_defaultReparseOptions() produces a default set of
1440 * options recommended for most uses, based on the translation unit.
1442 * \returns 0 if the sources could be reparsed. A non-zero error code will be
1443 * returned if reparsing was impossible, such that the translation unit is
1444 * invalid. In such cases, the only valid call for \c TU is
1445 * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1446 * routine are described by the \c CXErrorCode enum.
1448 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1449 unsigned num_unsaved_files,
1450 struct CXUnsavedFile *unsaved_files,
1454 * \brief Categorizes how memory is being used by a translation unit.
1456 enum CXTUResourceUsageKind {
1457 CXTUResourceUsage_AST = 1,
1458 CXTUResourceUsage_Identifiers = 2,
1459 CXTUResourceUsage_Selectors = 3,
1460 CXTUResourceUsage_GlobalCompletionResults = 4,
1461 CXTUResourceUsage_SourceManagerContentCache = 5,
1462 CXTUResourceUsage_AST_SideTables = 6,
1463 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
1464 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
1465 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
1466 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
1467 CXTUResourceUsage_Preprocessor = 11,
1468 CXTUResourceUsage_PreprocessingRecord = 12,
1469 CXTUResourceUsage_SourceManager_DataStructures = 13,
1470 CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
1471 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
1472 CXTUResourceUsage_MEMORY_IN_BYTES_END =
1473 CXTUResourceUsage_Preprocessor_HeaderSearch,
1475 CXTUResourceUsage_First = CXTUResourceUsage_AST,
1476 CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
1480 * \brief Returns the human-readable null-terminated C string that represents
1481 * the name of the memory category. This string should never be freed.
1484 const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
1486 typedef struct CXTUResourceUsageEntry {
1487 /* \brief The memory usage category. */
1488 enum CXTUResourceUsageKind kind;
1489 /* \brief Amount of resources used.
1490 The units will depend on the resource kind. */
1491 unsigned long amount;
1492 } CXTUResourceUsageEntry;
1495 * \brief The memory usage of a CXTranslationUnit, broken into categories.
1497 typedef struct CXTUResourceUsage {
1498 /* \brief Private data member, used for queries. */
1501 /* \brief The number of entries in the 'entries' array. */
1502 unsigned numEntries;
1504 /* \brief An array of key-value pairs, representing the breakdown of memory
1506 CXTUResourceUsageEntry *entries;
1508 } CXTUResourceUsage;
1511 * \brief Return the memory usage of a translation unit. This object
1512 * should be released with clang_disposeCXTUResourceUsage().
1514 CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
1516 CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
1523 * \brief Describes the kind of entity that a cursor refers to.
1528 * \brief A declaration whose specific kind is not exposed via this
1531 * Unexposed declarations have the same operations as any other kind
1532 * of declaration; one can extract their location information,
1533 * spelling, find their definitions, etc. However, the specific kind
1534 * of the declaration is not reported.
1536 CXCursor_UnexposedDecl = 1,
1537 /** \brief A C or C++ struct. */
1538 CXCursor_StructDecl = 2,
1539 /** \brief A C or C++ union. */
1540 CXCursor_UnionDecl = 3,
1541 /** \brief A C++ class. */
1542 CXCursor_ClassDecl = 4,
1543 /** \brief An enumeration. */
1544 CXCursor_EnumDecl = 5,
1546 * \brief A field (in C) or non-static data member (in C++) in a
1547 * struct, union, or C++ class.
1549 CXCursor_FieldDecl = 6,
1550 /** \brief An enumerator constant. */
1551 CXCursor_EnumConstantDecl = 7,
1552 /** \brief A function. */
1553 CXCursor_FunctionDecl = 8,
1554 /** \brief A variable. */
1555 CXCursor_VarDecl = 9,
1556 /** \brief A function or method parameter. */
1557 CXCursor_ParmDecl = 10,
1558 /** \brief An Objective-C \@interface. */
1559 CXCursor_ObjCInterfaceDecl = 11,
1560 /** \brief An Objective-C \@interface for a category. */
1561 CXCursor_ObjCCategoryDecl = 12,
1562 /** \brief An Objective-C \@protocol declaration. */
1563 CXCursor_ObjCProtocolDecl = 13,
1564 /** \brief An Objective-C \@property declaration. */
1565 CXCursor_ObjCPropertyDecl = 14,
1566 /** \brief An Objective-C instance variable. */
1567 CXCursor_ObjCIvarDecl = 15,
1568 /** \brief An Objective-C instance method. */
1569 CXCursor_ObjCInstanceMethodDecl = 16,
1570 /** \brief An Objective-C class method. */
1571 CXCursor_ObjCClassMethodDecl = 17,
1572 /** \brief An Objective-C \@implementation. */
1573 CXCursor_ObjCImplementationDecl = 18,
1574 /** \brief An Objective-C \@implementation for a category. */
1575 CXCursor_ObjCCategoryImplDecl = 19,
1576 /** \brief A typedef */
1577 CXCursor_TypedefDecl = 20,
1578 /** \brief A C++ class method. */
1579 CXCursor_CXXMethod = 21,
1580 /** \brief A C++ namespace. */
1581 CXCursor_Namespace = 22,
1582 /** \brief A linkage specification, e.g. 'extern "C"'. */
1583 CXCursor_LinkageSpec = 23,
1584 /** \brief A C++ constructor. */
1585 CXCursor_Constructor = 24,
1586 /** \brief A C++ destructor. */
1587 CXCursor_Destructor = 25,
1588 /** \brief A C++ conversion function. */
1589 CXCursor_ConversionFunction = 26,
1590 /** \brief A C++ template type parameter. */
1591 CXCursor_TemplateTypeParameter = 27,
1592 /** \brief A C++ non-type template parameter. */
1593 CXCursor_NonTypeTemplateParameter = 28,
1594 /** \brief A C++ template template parameter. */
1595 CXCursor_TemplateTemplateParameter = 29,
1596 /** \brief A C++ function template. */
1597 CXCursor_FunctionTemplate = 30,
1598 /** \brief A C++ class template. */
1599 CXCursor_ClassTemplate = 31,
1600 /** \brief A C++ class template partial specialization. */
1601 CXCursor_ClassTemplatePartialSpecialization = 32,
1602 /** \brief A C++ namespace alias declaration. */
1603 CXCursor_NamespaceAlias = 33,
1604 /** \brief A C++ using directive. */
1605 CXCursor_UsingDirective = 34,
1606 /** \brief A C++ using declaration. */
1607 CXCursor_UsingDeclaration = 35,
1608 /** \brief A C++ alias declaration */
1609 CXCursor_TypeAliasDecl = 36,
1610 /** \brief An Objective-C \@synthesize definition. */
1611 CXCursor_ObjCSynthesizeDecl = 37,
1612 /** \brief An Objective-C \@dynamic definition. */
1613 CXCursor_ObjCDynamicDecl = 38,
1614 /** \brief An access specifier. */
1615 CXCursor_CXXAccessSpecifier = 39,
1617 CXCursor_FirstDecl = CXCursor_UnexposedDecl,
1618 CXCursor_LastDecl = CXCursor_CXXAccessSpecifier,
1621 CXCursor_FirstRef = 40, /* Decl references */
1622 CXCursor_ObjCSuperClassRef = 40,
1623 CXCursor_ObjCProtocolRef = 41,
1624 CXCursor_ObjCClassRef = 42,
1626 * \brief A reference to a type declaration.
1628 * A type reference occurs anywhere where a type is named but not
1629 * declared. For example, given:
1632 * typedef unsigned size_type;
1636 * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1637 * while the type of the variable "size" is referenced. The cursor
1638 * referenced by the type of size is the typedef for size_type.
1640 CXCursor_TypeRef = 43,
1641 CXCursor_CXXBaseSpecifier = 44,
1643 * \brief A reference to a class template, function template, template
1644 * template parameter, or class template partial specialization.
1646 CXCursor_TemplateRef = 45,
1648 * \brief A reference to a namespace or namespace alias.
1650 CXCursor_NamespaceRef = 46,
1652 * \brief A reference to a member of a struct, union, or class that occurs in
1653 * some non-expression context, e.g., a designated initializer.
1655 CXCursor_MemberRef = 47,
1657 * \brief A reference to a labeled statement.
1659 * This cursor kind is used to describe the jump to "start_over" in the
1660 * goto statement in the following example:
1669 * A label reference cursor refers to a label statement.
1671 CXCursor_LabelRef = 48,
1674 * \brief A reference to a set of overloaded functions or function templates
1675 * that has not yet been resolved to a specific function or function template.
1677 * An overloaded declaration reference cursor occurs in C++ templates where
1678 * a dependent name refers to a function. For example:
1681 * template<typename T> void swap(T&, T&);
1684 * void swap(X&, X&);
1686 * template<typename T>
1687 * void reverse(T* first, T* last) {
1688 * while (first < last - 1) {
1689 * swap(*first, *--last);
1695 * void swap(Y&, Y&);
1698 * Here, the identifier "swap" is associated with an overloaded declaration
1699 * reference. In the template definition, "swap" refers to either of the two
1700 * "swap" functions declared above, so both results will be available. At
1701 * instantiation time, "swap" may also refer to other functions found via
1702 * argument-dependent lookup (e.g., the "swap" function at the end of the
1705 * The functions \c clang_getNumOverloadedDecls() and
1706 * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1707 * referenced by this cursor.
1709 CXCursor_OverloadedDeclRef = 49,
1712 * \brief A reference to a variable that occurs in some non-expression
1713 * context, e.g., a C++ lambda capture list.
1715 CXCursor_VariableRef = 50,
1717 CXCursor_LastRef = CXCursor_VariableRef,
1719 /* Error conditions */
1720 CXCursor_FirstInvalid = 70,
1721 CXCursor_InvalidFile = 70,
1722 CXCursor_NoDeclFound = 71,
1723 CXCursor_NotImplemented = 72,
1724 CXCursor_InvalidCode = 73,
1725 CXCursor_LastInvalid = CXCursor_InvalidCode,
1728 CXCursor_FirstExpr = 100,
1731 * \brief An expression whose specific kind is not exposed via this
1734 * Unexposed expressions have the same operations as any other kind
1735 * of expression; one can extract their location information,
1736 * spelling, children, etc. However, the specific kind of the
1737 * expression is not reported.
1739 CXCursor_UnexposedExpr = 100,
1742 * \brief An expression that refers to some value declaration, such
1743 * as a function, variable, or enumerator.
1745 CXCursor_DeclRefExpr = 101,
1748 * \brief An expression that refers to a member of a struct, union,
1749 * class, Objective-C class, etc.
1751 CXCursor_MemberRefExpr = 102,
1753 /** \brief An expression that calls a function. */
1754 CXCursor_CallExpr = 103,
1756 /** \brief An expression that sends a message to an Objective-C
1758 CXCursor_ObjCMessageExpr = 104,
1760 /** \brief An expression that represents a block literal. */
1761 CXCursor_BlockExpr = 105,
1763 /** \brief An integer literal.
1765 CXCursor_IntegerLiteral = 106,
1767 /** \brief A floating point number literal.
1769 CXCursor_FloatingLiteral = 107,
1771 /** \brief An imaginary number literal.
1773 CXCursor_ImaginaryLiteral = 108,
1775 /** \brief A string literal.
1777 CXCursor_StringLiteral = 109,
1779 /** \brief A character literal.
1781 CXCursor_CharacterLiteral = 110,
1783 /** \brief A parenthesized expression, e.g. "(1)".
1785 * This AST node is only formed if full location information is requested.
1787 CXCursor_ParenExpr = 111,
1789 /** \brief This represents the unary-expression's (except sizeof and
1792 CXCursor_UnaryOperator = 112,
1794 /** \brief [C99 6.5.2.1] Array Subscripting.
1796 CXCursor_ArraySubscriptExpr = 113,
1798 /** \brief A builtin binary operation expression such as "x + y" or
1801 CXCursor_BinaryOperator = 114,
1803 /** \brief Compound assignment such as "+=".
1805 CXCursor_CompoundAssignOperator = 115,
1807 /** \brief The ?: ternary operator.
1809 CXCursor_ConditionalOperator = 116,
1811 /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1812 * (C++ [expr.cast]), which uses the syntax (Type)expr.
1814 * For example: (int)f.
1816 CXCursor_CStyleCastExpr = 117,
1818 /** \brief [C99 6.5.2.5]
1820 CXCursor_CompoundLiteralExpr = 118,
1822 /** \brief Describes an C or C++ initializer list.
1824 CXCursor_InitListExpr = 119,
1826 /** \brief The GNU address of label extension, representing &&label.
1828 CXCursor_AddrLabelExpr = 120,
1830 /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1832 CXCursor_StmtExpr = 121,
1834 /** \brief Represents a C11 generic selection.
1836 CXCursor_GenericSelectionExpr = 122,
1838 /** \brief Implements the GNU __null extension, which is a name for a null
1839 * pointer constant that has integral type (e.g., int or long) and is the same
1840 * size and alignment as a pointer.
1842 * The __null extension is typically only used by system headers, which define
1843 * NULL as __null in C++ rather than using 0 (which is an integer that may not
1844 * match the size of a pointer).
1846 CXCursor_GNUNullExpr = 123,
1848 /** \brief C++'s static_cast<> expression.
1850 CXCursor_CXXStaticCastExpr = 124,
1852 /** \brief C++'s dynamic_cast<> expression.
1854 CXCursor_CXXDynamicCastExpr = 125,
1856 /** \brief C++'s reinterpret_cast<> expression.
1858 CXCursor_CXXReinterpretCastExpr = 126,
1860 /** \brief C++'s const_cast<> expression.
1862 CXCursor_CXXConstCastExpr = 127,
1864 /** \brief Represents an explicit C++ type conversion that uses "functional"
1865 * notion (C++ [expr.type.conv]).
1872 CXCursor_CXXFunctionalCastExpr = 128,
1874 /** \brief A C++ typeid expression (C++ [expr.typeid]).
1876 CXCursor_CXXTypeidExpr = 129,
1878 /** \brief [C++ 2.13.5] C++ Boolean Literal.
1880 CXCursor_CXXBoolLiteralExpr = 130,
1882 /** \brief [C++0x 2.14.7] C++ Pointer Literal.
1884 CXCursor_CXXNullPtrLiteralExpr = 131,
1886 /** \brief Represents the "this" expression in C++
1888 CXCursor_CXXThisExpr = 132,
1890 /** \brief [C++ 15] C++ Throw Expression.
1892 * This handles 'throw' and 'throw' assignment-expression. When
1893 * assignment-expression isn't present, Op will be null.
1895 CXCursor_CXXThrowExpr = 133,
1897 /** \brief A new expression for memory allocation and constructor calls, e.g:
1898 * "new CXXNewExpr(foo)".
1900 CXCursor_CXXNewExpr = 134,
1902 /** \brief A delete expression for memory deallocation and destructor calls,
1903 * e.g. "delete[] pArray".
1905 CXCursor_CXXDeleteExpr = 135,
1907 /** \brief A unary expression.
1909 CXCursor_UnaryExpr = 136,
1911 /** \brief An Objective-C string literal i.e. @"foo".
1913 CXCursor_ObjCStringLiteral = 137,
1915 /** \brief An Objective-C \@encode expression.
1917 CXCursor_ObjCEncodeExpr = 138,
1919 /** \brief An Objective-C \@selector expression.
1921 CXCursor_ObjCSelectorExpr = 139,
1923 /** \brief An Objective-C \@protocol expression.
1925 CXCursor_ObjCProtocolExpr = 140,
1927 /** \brief An Objective-C "bridged" cast expression, which casts between
1928 * Objective-C pointers and C pointers, transferring ownership in the process.
1931 * NSString *str = (__bridge_transfer NSString *)CFCreateString();
1934 CXCursor_ObjCBridgedCastExpr = 141,
1936 /** \brief Represents a C++0x pack expansion that produces a sequence of
1939 * A pack expansion expression contains a pattern (which itself is an
1940 * expression) followed by an ellipsis. For example:
1943 * template<typename F, typename ...Types>
1944 * void forward(F f, Types &&...args) {
1945 * f(static_cast<Types&&>(args)...);
1949 CXCursor_PackExpansionExpr = 142,
1951 /** \brief Represents an expression that computes the length of a parameter
1955 * template<typename ...Types>
1957 * static const unsigned value = sizeof...(Types);
1961 CXCursor_SizeOfPackExpr = 143,
1963 /* \brief Represents a C++ lambda expression that produces a local function
1967 * void abssort(float *x, unsigned N) {
1968 * std::sort(x, x + N,
1969 * [](float a, float b) {
1970 * return std::abs(a) < std::abs(b);
1975 CXCursor_LambdaExpr = 144,
1977 /** \brief Objective-c Boolean Literal.
1979 CXCursor_ObjCBoolLiteralExpr = 145,
1981 /** \brief Represents the "self" expression in an Objective-C method.
1983 CXCursor_ObjCSelfExpr = 146,
1985 CXCursor_LastExpr = CXCursor_ObjCSelfExpr,
1988 CXCursor_FirstStmt = 200,
1990 * \brief A statement whose specific kind is not exposed via this
1993 * Unexposed statements have the same operations as any other kind of
1994 * statement; one can extract their location information, spelling,
1995 * children, etc. However, the specific kind of the statement is not
1998 CXCursor_UnexposedStmt = 200,
2000 /** \brief A labelled statement in a function.
2002 * This cursor kind is used to describe the "start_over:" label statement in
2003 * the following example:
2011 CXCursor_LabelStmt = 201,
2013 /** \brief A group of statements like { stmt stmt }.
2015 * This cursor kind is used to describe compound statements, e.g. function
2018 CXCursor_CompoundStmt = 202,
2020 /** \brief A case statement.
2022 CXCursor_CaseStmt = 203,
2024 /** \brief A default statement.
2026 CXCursor_DefaultStmt = 204,
2028 /** \brief An if statement
2030 CXCursor_IfStmt = 205,
2032 /** \brief A switch statement.
2034 CXCursor_SwitchStmt = 206,
2036 /** \brief A while statement.
2038 CXCursor_WhileStmt = 207,
2040 /** \brief A do statement.
2042 CXCursor_DoStmt = 208,
2044 /** \brief A for statement.
2046 CXCursor_ForStmt = 209,
2048 /** \brief A goto statement.
2050 CXCursor_GotoStmt = 210,
2052 /** \brief An indirect goto statement.
2054 CXCursor_IndirectGotoStmt = 211,
2056 /** \brief A continue statement.
2058 CXCursor_ContinueStmt = 212,
2060 /** \brief A break statement.
2062 CXCursor_BreakStmt = 213,
2064 /** \brief A return statement.
2066 CXCursor_ReturnStmt = 214,
2068 /** \brief A GCC inline assembly statement extension.
2070 CXCursor_GCCAsmStmt = 215,
2071 CXCursor_AsmStmt = CXCursor_GCCAsmStmt,
2073 /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2075 CXCursor_ObjCAtTryStmt = 216,
2077 /** \brief Objective-C's \@catch statement.
2079 CXCursor_ObjCAtCatchStmt = 217,
2081 /** \brief Objective-C's \@finally statement.
2083 CXCursor_ObjCAtFinallyStmt = 218,
2085 /** \brief Objective-C's \@throw statement.
2087 CXCursor_ObjCAtThrowStmt = 219,
2089 /** \brief Objective-C's \@synchronized statement.
2091 CXCursor_ObjCAtSynchronizedStmt = 220,
2093 /** \brief Objective-C's autorelease pool statement.
2095 CXCursor_ObjCAutoreleasePoolStmt = 221,
2097 /** \brief Objective-C's collection statement.
2099 CXCursor_ObjCForCollectionStmt = 222,
2101 /** \brief C++'s catch statement.
2103 CXCursor_CXXCatchStmt = 223,
2105 /** \brief C++'s try statement.
2107 CXCursor_CXXTryStmt = 224,
2109 /** \brief C++'s for (* : *) statement.
2111 CXCursor_CXXForRangeStmt = 225,
2113 /** \brief Windows Structured Exception Handling's try statement.
2115 CXCursor_SEHTryStmt = 226,
2117 /** \brief Windows Structured Exception Handling's except statement.
2119 CXCursor_SEHExceptStmt = 227,
2121 /** \brief Windows Structured Exception Handling's finally statement.
2123 CXCursor_SEHFinallyStmt = 228,
2125 /** \brief A MS inline assembly statement extension.
2127 CXCursor_MSAsmStmt = 229,
2129 /** \brief The null statement ";": C99 6.8.3p3.
2131 * This cursor kind is used to describe the null statement.
2133 CXCursor_NullStmt = 230,
2135 /** \brief Adaptor class for mixing declarations with statements and
2138 CXCursor_DeclStmt = 231,
2140 /** \brief OpenMP parallel directive.
2142 CXCursor_OMPParallelDirective = 232,
2144 /** \brief OpenMP SIMD directive.
2146 CXCursor_OMPSimdDirective = 233,
2148 /** \brief OpenMP for directive.
2150 CXCursor_OMPForDirective = 234,
2152 /** \brief OpenMP sections directive.
2154 CXCursor_OMPSectionsDirective = 235,
2156 /** \brief OpenMP section directive.
2158 CXCursor_OMPSectionDirective = 236,
2160 /** \brief OpenMP single directive.
2162 CXCursor_OMPSingleDirective = 237,
2164 /** \brief OpenMP parallel for directive.
2166 CXCursor_OMPParallelForDirective = 238,
2168 /** \brief OpenMP parallel sections directive.
2170 CXCursor_OMPParallelSectionsDirective = 239,
2172 /** \brief OpenMP task directive.
2174 CXCursor_OMPTaskDirective = 240,
2176 /** \brief OpenMP master directive.
2178 CXCursor_OMPMasterDirective = 241,
2180 /** \brief OpenMP critical directive.
2182 CXCursor_OMPCriticalDirective = 242,
2184 /** \brief OpenMP taskyield directive.
2186 CXCursor_OMPTaskyieldDirective = 243,
2188 /** \brief OpenMP barrier directive.
2190 CXCursor_OMPBarrierDirective = 244,
2192 /** \brief OpenMP taskwait directive.
2194 CXCursor_OMPTaskwaitDirective = 245,
2196 /** \brief OpenMP flush directive.
2198 CXCursor_OMPFlushDirective = 246,
2200 /** \brief Windows Structured Exception Handling's leave statement.
2202 CXCursor_SEHLeaveStmt = 247,
2204 /** \brief OpenMP ordered directive.
2206 CXCursor_OMPOrderedDirective = 248,
2208 /** \brief OpenMP atomic directive.
2210 CXCursor_OMPAtomicDirective = 249,
2212 /** \brief OpenMP for SIMD directive.
2214 CXCursor_OMPForSimdDirective = 250,
2216 /** \brief OpenMP parallel for SIMD directive.
2218 CXCursor_OMPParallelForSimdDirective = 251,
2220 /** \brief OpenMP target directive.
2222 CXCursor_OMPTargetDirective = 252,
2224 /** \brief OpenMP teams directive.
2226 CXCursor_OMPTeamsDirective = 253,
2228 CXCursor_LastStmt = CXCursor_OMPTeamsDirective,
2231 * \brief Cursor that represents the translation unit itself.
2233 * The translation unit cursor exists primarily to act as the root
2234 * cursor for traversing the contents of a translation unit.
2236 CXCursor_TranslationUnit = 300,
2239 CXCursor_FirstAttr = 400,
2241 * \brief An attribute whose specific kind is not exposed via this
2244 CXCursor_UnexposedAttr = 400,
2246 CXCursor_IBActionAttr = 401,
2247 CXCursor_IBOutletAttr = 402,
2248 CXCursor_IBOutletCollectionAttr = 403,
2249 CXCursor_CXXFinalAttr = 404,
2250 CXCursor_CXXOverrideAttr = 405,
2251 CXCursor_AnnotateAttr = 406,
2252 CXCursor_AsmLabelAttr = 407,
2253 CXCursor_PackedAttr = 408,
2254 CXCursor_PureAttr = 409,
2255 CXCursor_ConstAttr = 410,
2256 CXCursor_NoDuplicateAttr = 411,
2257 CXCursor_CUDAConstantAttr = 412,
2258 CXCursor_CUDADeviceAttr = 413,
2259 CXCursor_CUDAGlobalAttr = 414,
2260 CXCursor_CUDAHostAttr = 415,
2261 CXCursor_CUDASharedAttr = 416,
2262 CXCursor_LastAttr = CXCursor_CUDASharedAttr,
2265 CXCursor_PreprocessingDirective = 500,
2266 CXCursor_MacroDefinition = 501,
2267 CXCursor_MacroExpansion = 502,
2268 CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
2269 CXCursor_InclusionDirective = 503,
2270 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
2271 CXCursor_LastPreprocessing = CXCursor_InclusionDirective,
2273 /* Extra Declarations */
2275 * \brief A module import declaration.
2277 CXCursor_ModuleImportDecl = 600,
2278 CXCursor_FirstExtraDecl = CXCursor_ModuleImportDecl,
2279 CXCursor_LastExtraDecl = CXCursor_ModuleImportDecl,
2282 * \brief A code completion overload candidate.
2284 CXCursor_OverloadCandidate = 700
2288 * \brief A cursor representing some element in the abstract syntax tree for
2289 * a translation unit.
2291 * The cursor abstraction unifies the different kinds of entities in a
2292 * program--declaration, statements, expressions, references to declarations,
2293 * etc.--under a single "cursor" abstraction with a common set of operations.
2294 * Common operation for a cursor include: getting the physical location in
2295 * a source file where the cursor points, getting the name associated with a
2296 * cursor, and retrieving cursors for any child nodes of a particular cursor.
2298 * Cursors can be produced in two specific ways.
2299 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2300 * from which one can use clang_visitChildren() to explore the rest of the
2301 * translation unit. clang_getCursor() maps from a physical source location
2302 * to the entity that resides at that location, allowing one to map from the
2303 * source code into the AST.
2306 enum CXCursorKind kind;
2308 const void *data[3];
2312 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2318 * \brief Retrieve the NULL cursor, which represents no entity.
2320 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
2323 * \brief Retrieve the cursor that represents the given translation unit.
2325 * The translation unit cursor can be used to start traversing the
2326 * various declarations within the given translation unit.
2328 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
2331 * \brief Determine whether two cursors are equivalent.
2333 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
2336 * \brief Returns non-zero if \p cursor is null.
2338 CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
2341 * \brief Compute a hash value for the given cursor.
2343 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
2346 * \brief Retrieve the kind of the given cursor.
2348 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
2351 * \brief Determine whether the given cursor kind represents a declaration.
2353 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
2356 * \brief Determine whether the given cursor kind represents a simple
2359 * Note that other kinds of cursors (such as expressions) can also refer to
2360 * other cursors. Use clang_getCursorReferenced() to determine whether a
2361 * particular cursor refers to another entity.
2363 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
2366 * \brief Determine whether the given cursor kind represents an expression.
2368 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
2371 * \brief Determine whether the given cursor kind represents a statement.
2373 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
2376 * \brief Determine whether the given cursor kind represents an attribute.
2378 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
2381 * \brief Determine whether the given cursor kind represents an invalid
2384 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
2387 * \brief Determine whether the given cursor kind represents a translation
2390 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
2393 * \brief Determine whether the given cursor represents a preprocessing
2394 * element, such as a preprocessor directive or macro instantiation.
2396 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
2399 * \brief Determine whether the given cursor represents a currently
2400 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2402 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
2405 * \brief Describe the linkage of the entity referred to by a cursor.
2407 enum CXLinkageKind {
2408 /** \brief This value indicates that no linkage information is available
2409 * for a provided CXCursor. */
2412 * \brief This is the linkage for variables, parameters, and so on that
2413 * have automatic storage. This covers normal (non-extern) local variables.
2415 CXLinkage_NoLinkage,
2416 /** \brief This is the linkage for static variables and static functions. */
2418 /** \brief This is the linkage for entities with external linkage that live
2419 * in C++ anonymous namespaces.*/
2420 CXLinkage_UniqueExternal,
2421 /** \brief This is the linkage for entities with true, external linkage. */
2426 * \brief Determine the linkage of the entity referred to by a given cursor.
2428 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
2431 * \brief Determine the availability of the entity that this cursor refers to,
2432 * taking the current target platform into account.
2434 * \param cursor The cursor to query.
2436 * \returns The availability of the cursor.
2438 CINDEX_LINKAGE enum CXAvailabilityKind
2439 clang_getCursorAvailability(CXCursor cursor);
2442 * Describes the availability of a given entity on a particular platform, e.g.,
2443 * a particular class might only be available on Mac OS 10.7 or newer.
2445 typedef struct CXPlatformAvailability {
2447 * \brief A string that describes the platform for which this structure
2448 * provides availability information.
2450 * Possible values are "ios" or "macosx".
2454 * \brief The version number in which this entity was introduced.
2456 CXVersion Introduced;
2458 * \brief The version number in which this entity was deprecated (but is
2461 CXVersion Deprecated;
2463 * \brief The version number in which this entity was obsoleted, and therefore
2464 * is no longer available.
2466 CXVersion Obsoleted;
2468 * \brief Whether the entity is unconditionally unavailable on this platform.
2472 * \brief An optional message to provide to a user of this API, e.g., to
2473 * suggest replacement APIs.
2476 } CXPlatformAvailability;
2479 * \brief Determine the availability of the entity that this cursor refers to
2480 * on any platforms for which availability information is known.
2482 * \param cursor The cursor to query.
2484 * \param always_deprecated If non-NULL, will be set to indicate whether the
2485 * entity is deprecated on all platforms.
2487 * \param deprecated_message If non-NULL, will be set to the message text
2488 * provided along with the unconditional deprecation of this entity. The client
2489 * is responsible for deallocating this string.
2491 * \param always_unavailable If non-NULL, will be set to indicate whether the
2492 * entity is unavailable on all platforms.
2494 * \param unavailable_message If non-NULL, will be set to the message text
2495 * provided along with the unconditional unavailability of this entity. The
2496 * client is responsible for deallocating this string.
2498 * \param availability If non-NULL, an array of CXPlatformAvailability instances
2499 * that will be populated with platform availability information, up to either
2500 * the number of platforms for which availability information is available (as
2501 * returned by this function) or \c availability_size, whichever is smaller.
2503 * \param availability_size The number of elements available in the
2504 * \c availability array.
2506 * \returns The number of platforms (N) for which availability information is
2507 * available (which is unrelated to \c availability_size).
2509 * Note that the client is responsible for calling
2510 * \c clang_disposeCXPlatformAvailability to free each of the
2511 * platform-availability structures returned. There are
2512 * \c min(N, availability_size) such structures.
2515 clang_getCursorPlatformAvailability(CXCursor cursor,
2516 int *always_deprecated,
2517 CXString *deprecated_message,
2518 int *always_unavailable,
2519 CXString *unavailable_message,
2520 CXPlatformAvailability *availability,
2521 int availability_size);
2524 * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2527 clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
2530 * \brief Describe the "language" of the entity referred to by a cursor.
2532 enum CXLanguageKind {
2533 CXLanguage_Invalid = 0,
2536 CXLanguage_CPlusPlus
2540 * \brief Determine the "language" of the entity referred to by a given cursor.
2542 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
2545 * \brief Returns the translation unit that a cursor originated from.
2547 CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
2551 * \brief A fast container representing a set of CXCursors.
2553 typedef struct CXCursorSetImpl *CXCursorSet;
2556 * \brief Creates an empty CXCursorSet.
2558 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2561 * \brief Disposes a CXCursorSet and releases its associated memory.
2563 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2566 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2568 * \returns non-zero if the set contains the specified cursor.
2570 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2574 * \brief Inserts a CXCursor into a CXCursorSet.
2576 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2578 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2582 * \brief Determine the semantic parent of the given cursor.
2584 * The semantic parent of a cursor is the cursor that semantically contains
2585 * the given \p cursor. For many declarations, the lexical and semantic parents
2586 * are equivalent (the lexical parent is returned by
2587 * \c clang_getCursorLexicalParent()). They diverge when declarations or
2588 * definitions are provided out-of-line. For example:
2598 * In the out-of-line definition of \c C::f, the semantic parent is
2599 * the class \c C, of which this function is a member. The lexical parent is
2600 * the place where the declaration actually occurs in the source code; in this
2601 * case, the definition occurs in the translation unit. In general, the
2602 * lexical parent for a given entity can change without affecting the semantics
2603 * of the program, and the lexical parent of different declarations of the
2604 * same entity may be different. Changing the semantic parent of a declaration,
2605 * on the other hand, can have a major impact on semantics, and redeclarations
2606 * of a particular entity should all have the same semantic context.
2608 * In the example above, both declarations of \c C::f have \c C as their
2609 * semantic context, while the lexical context of the first \c C::f is \c C
2610 * and the lexical context of the second \c C::f is the translation unit.
2612 * For global declarations, the semantic parent is the translation unit.
2614 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
2617 * \brief Determine the lexical parent of the given cursor.
2619 * The lexical parent of a cursor is the cursor in which the given \p cursor
2620 * was actually written. For many declarations, the lexical and semantic parents
2621 * are equivalent (the semantic parent is returned by
2622 * \c clang_getCursorSemanticParent()). They diverge when declarations or
2623 * definitions are provided out-of-line. For example:
2633 * In the out-of-line definition of \c C::f, the semantic parent is
2634 * the class \c C, of which this function is a member. The lexical parent is
2635 * the place where the declaration actually occurs in the source code; in this
2636 * case, the definition occurs in the translation unit. In general, the
2637 * lexical parent for a given entity can change without affecting the semantics
2638 * of the program, and the lexical parent of different declarations of the
2639 * same entity may be different. Changing the semantic parent of a declaration,
2640 * on the other hand, can have a major impact on semantics, and redeclarations
2641 * of a particular entity should all have the same semantic context.
2643 * In the example above, both declarations of \c C::f have \c C as their
2644 * semantic context, while the lexical context of the first \c C::f is \c C
2645 * and the lexical context of the second \c C::f is the translation unit.
2647 * For declarations written in the global scope, the lexical parent is
2648 * the translation unit.
2650 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
2653 * \brief Determine the set of methods that are overridden by the given
2656 * In both Objective-C and C++, a method (aka virtual member function,
2657 * in C++) can override a virtual method in a base class. For
2658 * Objective-C, a method is said to override any method in the class's
2659 * base class, its protocols, or its categories' protocols, that has the same
2660 * selector and is of the same kind (class or instance).
2661 * If no such method exists, the search continues to the class's superclass,
2662 * its protocols, and its categories, and so on. A method from an Objective-C
2663 * implementation is considered to override the same methods as its
2664 * corresponding method in the interface.
2666 * For C++, a virtual member function overrides any virtual member
2667 * function with the same signature that occurs in its base
2668 * classes. With multiple inheritance, a virtual member function can
2669 * override several virtual member functions coming from different
2672 * In all cases, this function determines the immediate overridden
2673 * method, rather than all of the overridden methods. For example, if
2674 * a method is originally declared in a class A, then overridden in B
2675 * (which in inherits from A) and also in C (which inherited from B),
2676 * then the only overridden method returned from this function when
2677 * invoked on C's method will be B's method. The client may then
2678 * invoke this function again, given the previously-found overridden
2679 * methods, to map out the complete method-override set.
2681 * \param cursor A cursor representing an Objective-C or C++
2682 * method. This routine will compute the set of methods that this
2685 * \param overridden A pointer whose pointee will be replaced with a
2686 * pointer to an array of cursors, representing the set of overridden
2687 * methods. If there are no overridden methods, the pointee will be
2688 * set to NULL. The pointee must be freed via a call to
2689 * \c clang_disposeOverriddenCursors().
2691 * \param num_overridden A pointer to the number of overridden
2692 * functions, will be set to the number of overridden functions in the
2693 * array pointed to by \p overridden.
2695 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
2696 CXCursor **overridden,
2697 unsigned *num_overridden);
2700 * \brief Free the set of overridden cursors returned by \c
2701 * clang_getOverriddenCursors().
2703 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
2706 * \brief Retrieve the file that is included by the given inclusion directive
2709 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
2716 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2718 * Cursors represent a location within the Abstract Syntax Tree (AST). These
2719 * routines help map between cursors and the physical locations where the
2720 * described entities occur in the source code. The mapping is provided in
2721 * both directions, so one can map from source code to the AST and back.
2727 * \brief Map a source location to the cursor that describes the entity at that
2728 * location in the source code.
2730 * clang_getCursor() maps an arbitrary source location within a translation
2731 * unit down to the most specific cursor that describes the entity at that
2732 * location. For example, given an expression \c x + y, invoking
2733 * clang_getCursor() with a source location pointing to "x" will return the
2734 * cursor for "x"; similarly for "y". If the cursor points anywhere between
2735 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2736 * will return a cursor referring to the "+" expression.
2738 * \returns a cursor representing the entity at the given source location, or
2739 * a NULL cursor if no such entity can be found.
2741 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
2744 * \brief Retrieve the physical location of the source constructor referenced
2745 * by the given cursor.
2747 * The location of a declaration is typically the location of the name of that
2748 * declaration, where the name of that declaration would occur if it is
2749 * unnamed, or some keyword that introduces that particular declaration.
2750 * The location of a reference is where that reference occurs within the
2753 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
2756 * \brief Retrieve the physical extent of the source construct referenced by
2759 * The extent of a cursor starts with the file/line/column pointing at the
2760 * first character within the source construct that the cursor refers to and
2761 * ends with the last character within that source construct. For a
2762 * declaration, the extent covers the declaration itself. For a reference,
2763 * the extent covers the location of the reference (e.g., where the referenced
2764 * entity was actually used).
2766 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
2773 * \defgroup CINDEX_TYPES Type information for CXCursors
2779 * \brief Describes the kind of type
2783 * \brief Represents an invalid type (e.g., where no type is available).
2788 * \brief A type whose specific kind is not exposed via this
2791 CXType_Unexposed = 1,
2803 CXType_ULongLong = 11,
2804 CXType_UInt128 = 12,
2811 CXType_LongLong = 19,
2815 CXType_LongDouble = 23,
2816 CXType_NullPtr = 24,
2817 CXType_Overload = 25,
2818 CXType_Dependent = 26,
2820 CXType_ObjCClass = 28,
2821 CXType_ObjCSel = 29,
2822 CXType_FirstBuiltin = CXType_Void,
2823 CXType_LastBuiltin = CXType_ObjCSel,
2825 CXType_Complex = 100,
2826 CXType_Pointer = 101,
2827 CXType_BlockPointer = 102,
2828 CXType_LValueReference = 103,
2829 CXType_RValueReference = 104,
2830 CXType_Record = 105,
2832 CXType_Typedef = 107,
2833 CXType_ObjCInterface = 108,
2834 CXType_ObjCObjectPointer = 109,
2835 CXType_FunctionNoProto = 110,
2836 CXType_FunctionProto = 111,
2837 CXType_ConstantArray = 112,
2838 CXType_Vector = 113,
2839 CXType_IncompleteArray = 114,
2840 CXType_VariableArray = 115,
2841 CXType_DependentSizedArray = 116,
2842 CXType_MemberPointer = 117
2846 * \brief Describes the calling convention of a function type
2848 enum CXCallingConv {
2849 CXCallingConv_Default = 0,
2850 CXCallingConv_C = 1,
2851 CXCallingConv_X86StdCall = 2,
2852 CXCallingConv_X86FastCall = 3,
2853 CXCallingConv_X86ThisCall = 4,
2854 CXCallingConv_X86Pascal = 5,
2855 CXCallingConv_AAPCS = 6,
2856 CXCallingConv_AAPCS_VFP = 7,
2857 /* Value 8 was PnaclCall, but it was never used, so it could safely be re-used. */
2858 CXCallingConv_IntelOclBicc = 9,
2859 CXCallingConv_X86_64Win64 = 10,
2860 CXCallingConv_X86_64SysV = 11,
2861 CXCallingConv_X86VectorCall = 12,
2863 CXCallingConv_Invalid = 100,
2864 CXCallingConv_Unexposed = 200
2869 * \brief The type of an element in the abstract syntax tree.
2873 enum CXTypeKind kind;
2878 * \brief Retrieve the type of a CXCursor (if any).
2880 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
2883 * \brief Pretty-print the underlying type using the rules of the
2884 * language of the translation unit from which it came.
2886 * If the type is invalid, an empty string is returned.
2888 CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
2891 * \brief Retrieve the underlying type of a typedef declaration.
2893 * If the cursor does not reference a typedef declaration, an invalid type is
2896 CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
2899 * \brief Retrieve the integer type of an enum declaration.
2901 * If the cursor does not reference an enum declaration, an invalid type is
2904 CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
2907 * \brief Retrieve the integer value of an enum constant declaration as a signed
2910 * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
2911 * Since this is also potentially a valid constant value, the kind of the cursor
2912 * must be verified before calling this function.
2914 CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C);
2917 * \brief Retrieve the integer value of an enum constant declaration as an unsigned
2920 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
2921 * Since this is also potentially a valid constant value, the kind of the cursor
2922 * must be verified before calling this function.
2924 CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C);
2927 * \brief Retrieve the bit width of a bit field declaration as an integer.
2929 * If a cursor that is not a bit field declaration is passed in, -1 is returned.
2931 CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
2934 * \brief Retrieve the number of non-variadic arguments associated with a given
2937 * The number of arguments can be determined for calls as well as for
2938 * declarations of functions or methods. For other cursors -1 is returned.
2940 CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
2943 * \brief Retrieve the argument cursor of a function or method.
2945 * The argument cursor can be determined for calls as well as for declarations
2946 * of functions or methods. For other cursors and for invalid indices, an
2947 * invalid cursor is returned.
2949 CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
2952 * \brief Describes the kind of a template argument.
2954 * See the definition of llvm::clang::TemplateArgument::ArgKind for full
2955 * element descriptions.
2957 enum CXTemplateArgumentKind {
2958 CXTemplateArgumentKind_Null,
2959 CXTemplateArgumentKind_Type,
2960 CXTemplateArgumentKind_Declaration,
2961 CXTemplateArgumentKind_NullPtr,
2962 CXTemplateArgumentKind_Integral,
2963 CXTemplateArgumentKind_Template,
2964 CXTemplateArgumentKind_TemplateExpansion,
2965 CXTemplateArgumentKind_Expression,
2966 CXTemplateArgumentKind_Pack,
2967 /* Indicates an error case, preventing the kind from being deduced. */
2968 CXTemplateArgumentKind_Invalid
2972 *\brief Returns the number of template args of a function decl representing a
2973 * template specialization.
2975 * If the argument cursor cannot be converted into a template function
2976 * declaration, -1 is returned.
2978 * For example, for the following declaration and specialization:
2979 * template <typename T, int kInt, bool kBool>
2980 * void foo() { ... }
2983 * void foo<float, -7, true>();
2985 * The value 3 would be returned from this call.
2987 CINDEX_LINKAGE int clang_Cursor_getNumTemplateArguments(CXCursor C);
2990 * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
2992 * If the argument CXCursor does not represent a FunctionDecl, an invalid
2993 * template argument kind is returned.
2995 * For example, for the following declaration and specialization:
2996 * template <typename T, int kInt, bool kBool>
2997 * void foo() { ... }
3000 * void foo<float, -7, true>();
3002 * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3005 CINDEX_LINKAGE enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(
3006 CXCursor C, unsigned I);
3009 * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3010 * function decl representing a template specialization.
3012 * If the argument CXCursor does not represent a FunctionDecl whose I'th
3013 * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3016 * For example, for the following declaration and specialization:
3017 * template <typename T, int kInt, bool kBool>
3018 * void foo() { ... }
3021 * void foo<float, -7, true>();
3023 * If called with I = 0, "float", will be returned.
3024 * Invalid types will be returned for I == 1 or 2.
3026 CINDEX_LINKAGE CXType clang_Cursor_getTemplateArgumentType(CXCursor C,
3030 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3031 * decl representing a template specialization) as a signed long long.
3033 * It is undefined to call this function on a CXCursor that does not represent a
3034 * FunctionDecl or whose I'th template argument is not an integral value.
3036 * For example, for the following declaration and specialization:
3037 * template <typename T, int kInt, bool kBool>
3038 * void foo() { ... }
3041 * void foo<float, -7, true>();
3043 * If called with I = 1 or 2, -7 or true will be returned, respectively.
3044 * For I == 0, this function's behavior is undefined.
3046 CINDEX_LINKAGE long long clang_Cursor_getTemplateArgumentValue(CXCursor C,
3050 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3051 * decl representing a template specialization) as an unsigned long long.
3053 * It is undefined to call this function on a CXCursor that does not represent a
3054 * FunctionDecl or whose I'th template argument is not an integral value.
3056 * For example, for the following declaration and specialization:
3057 * template <typename T, int kInt, bool kBool>
3058 * void foo() { ... }
3061 * void foo<float, 2147483649, true>();
3063 * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3064 * For I == 0, this function's behavior is undefined.
3066 CINDEX_LINKAGE unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(
3067 CXCursor C, unsigned I);
3070 * \brief Determine whether two CXTypes represent the same type.
3072 * \returns non-zero if the CXTypes represent the same type and
3075 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
3078 * \brief Return the canonical type for a CXType.
3080 * Clang's type system explicitly models typedefs and all the ways
3081 * a specific type can be represented. The canonical type is the underlying
3082 * type with all the "sugar" removed. For example, if 'T' is a typedef
3083 * for 'int', the canonical type for 'T' would be 'int'.
3085 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
3088 * \brief Determine whether a CXType has the "const" qualifier set,
3089 * without looking through typedefs that may have added "const" at a
3092 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
3095 * \brief Determine whether a CXType has the "volatile" qualifier set,
3096 * without looking through typedefs that may have added "volatile" at
3097 * a different level.
3099 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
3102 * \brief Determine whether a CXType has the "restrict" qualifier set,
3103 * without looking through typedefs that may have added "restrict" at a
3106 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
3109 * \brief For pointer types, returns the type of the pointee.
3111 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
3114 * \brief Return the cursor for the declaration of the given type.
3116 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
3119 * Returns the Objective-C type encoding for the specified declaration.
3121 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
3124 * \brief Retrieve the spelling of a given CXTypeKind.
3126 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
3129 * \brief Retrieve the calling convention associated with a function type.
3131 * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3133 CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
3136 * \brief Retrieve the return type associated with a function type.
3138 * If a non-function type is passed in, an invalid type is returned.
3140 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
3143 * \brief Retrieve the number of non-variadic parameters associated with a
3146 * If a non-function type is passed in, -1 is returned.
3148 CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
3151 * \brief Retrieve the type of a parameter of a function type.
3153 * If a non-function type is passed in or the function does not have enough
3154 * parameters, an invalid type is returned.
3156 CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
3159 * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3161 CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
3164 * \brief Retrieve the return type associated with a given cursor.
3166 * This only returns a valid type if the cursor refers to a function or method.
3168 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
3171 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3174 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
3177 * \brief Return the element type of an array, complex, or vector type.
3179 * If a type is passed in that is not an array, complex, or vector type,
3180 * an invalid type is returned.
3182 CINDEX_LINKAGE CXType clang_getElementType(CXType T);
3185 * \brief Return the number of elements of an array or vector type.
3187 * If a type is passed in that is not an array or vector type,
3190 CINDEX_LINKAGE long long clang_getNumElements(CXType T);
3193 * \brief Return the element type of an array type.
3195 * If a non-array type is passed in, an invalid type is returned.
3197 CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
3200 * \brief Return the array size of a constant array.
3202 * If a non-array type is passed in, -1 is returned.
3204 CINDEX_LINKAGE long long clang_getArraySize(CXType T);
3207 * \brief List the possible error codes for \c clang_Type_getSizeOf,
3208 * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3209 * \c clang_Cursor_getOffsetOf.
3211 * A value of this enumeration type can be returned if the target type is not
3212 * a valid argument to sizeof, alignof or offsetof.
3214 enum CXTypeLayoutError {
3216 * \brief Type is of kind CXType_Invalid.
3218 CXTypeLayoutError_Invalid = -1,
3220 * \brief The type is an incomplete Type.
3222 CXTypeLayoutError_Incomplete = -2,
3224 * \brief The type is a dependent Type.
3226 CXTypeLayoutError_Dependent = -3,
3228 * \brief The type is not a constant size type.
3230 CXTypeLayoutError_NotConstantSize = -4,
3232 * \brief The Field name is not valid for this record.
3234 CXTypeLayoutError_InvalidFieldName = -5
3238 * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3241 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3242 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3244 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3246 * If the type declaration is not a constant size type,
3247 * CXTypeLayoutError_NotConstantSize is returned.
3249 CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
3252 * \brief Return the class type of an member pointer type.
3254 * If a non-member-pointer type is passed in, an invalid type is returned.
3256 CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
3259 * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3261 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3262 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3264 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3267 CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
3270 * \brief Return the offset of a field named S in a record of type T in bits
3271 * as it would be returned by __offsetof__ as per C++11[18.2p4]
3273 * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3275 * If the field's type declaration is an incomplete type,
3276 * CXTypeLayoutError_Incomplete is returned.
3277 * If the field's type declaration is a dependent type,
3278 * CXTypeLayoutError_Dependent is returned.
3279 * If the field's name S is not found,
3280 * CXTypeLayoutError_InvalidFieldName is returned.
3282 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3285 * \brief Return the offset of the field represented by the Cursor.
3287 * If the cursor is not a field declaration, -1 is returned.
3288 * If the cursor semantic parent is not a record field declaration,
3289 * CXTypeLayoutError_Invalid is returned.
3290 * If the field's type declaration is an incomplete type,
3291 * CXTypeLayoutError_Incomplete is returned.
3292 * If the field's type declaration is a dependent type,
3293 * CXTypeLayoutError_Dependent is returned.
3294 * If the field's name S is not found,
3295 * CXTypeLayoutError_InvalidFieldName is returned.
3297 CINDEX_LINKAGE long long clang_Cursor_getOffsetOfField(CXCursor C);
3300 * \brief Determine whether the given cursor represents an anonymous record
3303 CINDEX_LINKAGE unsigned clang_Cursor_isAnonymous(CXCursor C);
3306 enum CXRefQualifierKind {
3307 /** \brief No ref-qualifier was provided. */
3308 CXRefQualifier_None = 0,
3309 /** \brief An lvalue ref-qualifier was provided (\c &). */
3310 CXRefQualifier_LValue,
3311 /** \brief An rvalue ref-qualifier was provided (\c &&). */
3312 CXRefQualifier_RValue
3316 * \brief Returns the number of template arguments for given class template
3317 * specialization, or -1 if type \c T is not a class template specialization.
3319 * Variadic argument packs count as only one argument, and can not be inspected
3322 CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
3325 * \brief Returns the type template argument of a template class specialization
3328 * This function only returns template type arguments and does not handle
3329 * template template arguments or variadic packs.
3331 CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
3334 * \brief Retrieve the ref-qualifier kind of a function or method.
3336 * The ref-qualifier is returned for C++ functions or methods. For other types
3337 * or non-C++ declarations, CXRefQualifier_None is returned.
3339 CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
3342 * \brief Returns non-zero if the cursor specifies a Record member that is a
3345 CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
3348 * \brief Returns 1 if the base class specified by the cursor with kind
3349 * CX_CXXBaseSpecifier is virtual.
3351 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
3354 * \brief Represents the C++ access control level to a base class for a
3355 * cursor with kind CX_CXXBaseSpecifier.
3357 enum CX_CXXAccessSpecifier {
3358 CX_CXXInvalidAccessSpecifier,
3365 * \brief Returns the access control level for the referenced object.
3367 * If the cursor refers to a C++ declaration, its access control level within its
3368 * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3369 * access specifier, the specifier itself is returned.
3371 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
3374 * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3375 * was added for the case that the passed cursor in not a declaration.
3377 enum CX_StorageClass {
3382 CX_SC_PrivateExtern,
3383 CX_SC_OpenCLWorkGroupLocal,
3389 * \brief Returns the storage class for a function or variable declaration.
3391 * If the passed in Cursor is not a function or variable declaration,
3392 * CX_SC_Invalid is returned else the storage class.
3394 CINDEX_LINKAGE enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor);
3397 * \brief Determine the number of overloaded declarations referenced by a
3398 * \c CXCursor_OverloadedDeclRef cursor.
3400 * \param cursor The cursor whose overloaded declarations are being queried.
3402 * \returns The number of overloaded declarations referenced by \c cursor. If it
3403 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3405 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
3408 * \brief Retrieve a cursor for one of the overloaded declarations referenced
3409 * by a \c CXCursor_OverloadedDeclRef cursor.
3411 * \param cursor The cursor whose overloaded declarations are being queried.
3413 * \param index The zero-based index into the set of overloaded declarations in
3416 * \returns A cursor representing the declaration referenced by the given
3417 * \c cursor at the specified \c index. If the cursor does not have an
3418 * associated set of overloaded declarations, or if the index is out of bounds,
3419 * returns \c clang_getNullCursor();
3421 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
3429 * \defgroup CINDEX_ATTRIBUTES Information for attributes
3436 * \brief For cursors representing an iboutletcollection attribute,
3437 * this function returns the collection element type.
3440 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
3447 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3449 * These routines provide the ability to traverse the abstract syntax tree
3456 * \brief Describes how the traversal of the children of a particular
3457 * cursor should proceed after visiting a particular child cursor.
3459 * A value of this enumeration type should be returned by each
3460 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3462 enum CXChildVisitResult {
3464 * \brief Terminates the cursor traversal.
3468 * \brief Continues the cursor traversal with the next sibling of
3469 * the cursor just visited, without visiting its children.
3471 CXChildVisit_Continue,
3473 * \brief Recursively traverse the children of this cursor, using
3474 * the same visitor and client data.
3476 CXChildVisit_Recurse
3480 * \brief Visitor invoked for each cursor found by a traversal.
3482 * This visitor function will be invoked for each cursor found by
3483 * clang_visitCursorChildren(). Its first argument is the cursor being
3484 * visited, its second argument is the parent visitor for that cursor,
3485 * and its third argument is the client data provided to
3486 * clang_visitCursorChildren().
3488 * The visitor should return one of the \c CXChildVisitResult values
3489 * to direct clang_visitCursorChildren().
3491 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
3493 CXClientData client_data);
3496 * \brief Visit the children of a particular cursor.
3498 * This function visits all the direct children of the given cursor,
3499 * invoking the given \p visitor function with the cursors of each
3500 * visited child. The traversal may be recursive, if the visitor returns
3501 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3502 * the visitor returns \c CXChildVisit_Break.
3504 * \param parent the cursor whose child may be visited. All kinds of
3505 * cursors can be visited, including invalid cursors (which, by
3506 * definition, have no children).
3508 * \param visitor the visitor function that will be invoked for each
3509 * child of \p parent.
3511 * \param client_data pointer data supplied by the client, which will
3512 * be passed to the visitor each time it is invoked.
3514 * \returns a non-zero value if the traversal was terminated
3515 * prematurely by the visitor returning \c CXChildVisit_Break.
3517 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
3518 CXCursorVisitor visitor,
3519 CXClientData client_data);
3520 #ifdef __has_feature
3521 # if __has_feature(blocks)
3523 * \brief Visitor invoked for each cursor found by a traversal.
3525 * This visitor block will be invoked for each cursor found by
3526 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3527 * visited, its second argument is the parent visitor for that cursor.
3529 * The visitor should return one of the \c CXChildVisitResult values
3530 * to direct clang_visitChildrenWithBlock().
3532 typedef enum CXChildVisitResult
3533 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3536 * Visits the children of a cursor using the specified block. Behaves
3537 * identically to clang_visitChildren() in all other respects.
3539 unsigned clang_visitChildrenWithBlock(CXCursor parent,
3540 CXCursorVisitorBlock block);
3549 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3551 * These routines provide the ability to determine references within and
3552 * across translation units, by providing the names of the entities referenced
3553 * by cursors, follow reference cursors to the declarations they reference,
3554 * and associate declarations with their definitions.
3560 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3561 * by the given cursor.
3563 * A Unified Symbol Resolution (USR) is a string that identifies a particular
3564 * entity (function, class, variable, etc.) within a program. USRs can be
3565 * compared across translation units to determine, e.g., when references in
3566 * one translation refer to an entity defined in another translation unit.
3568 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
3571 * \brief Construct a USR for a specified Objective-C class.
3573 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3576 * \brief Construct a USR for a specified Objective-C category.
3578 CINDEX_LINKAGE CXString
3579 clang_constructUSR_ObjCCategory(const char *class_name,
3580 const char *category_name);
3583 * \brief Construct a USR for a specified Objective-C protocol.
3585 CINDEX_LINKAGE CXString
3586 clang_constructUSR_ObjCProtocol(const char *protocol_name);
3590 * \brief Construct a USR for a specified Objective-C instance variable and
3591 * the USR for its containing class.
3593 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
3597 * \brief Construct a USR for a specified Objective-C method and
3598 * the USR for its containing class.
3600 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
3601 unsigned isInstanceMethod,
3605 * \brief Construct a USR for a specified Objective-C property and the USR
3606 * for its containing class.
3608 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
3612 * \brief Retrieve a name for the entity referenced by this cursor.
3614 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
3617 * \brief Retrieve a range for a piece that forms the cursors spelling name.
3618 * Most of the times there is only one range for the complete spelling but for
3619 * Objective-C methods and Objective-C message expressions, there are multiple
3620 * pieces for each selector identifier.
3622 * \param pieceIndex the index of the spelling name piece. If this is greater
3623 * than the actual number of pieces, it will return a NULL (invalid) range.
3625 * \param options Reserved.
3627 CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor,
3628 unsigned pieceIndex,
3632 * \brief Retrieve the display name for the entity referenced by this cursor.
3634 * The display name contains extra information that helps identify the cursor,
3635 * such as the parameters of a function or template or the arguments of a
3636 * class template specialization.
3638 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
3640 /** \brief For a cursor that is a reference, retrieve a cursor representing the
3641 * entity that it references.
3643 * Reference cursors refer to other entities in the AST. For example, an
3644 * Objective-C superclass reference cursor refers to an Objective-C class.
3645 * This function produces the cursor for the Objective-C class from the
3646 * cursor for the superclass reference. If the input cursor is a declaration or
3647 * definition, it returns that declaration or definition unchanged.
3648 * Otherwise, returns the NULL cursor.
3650 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
3653 * \brief For a cursor that is either a reference to or a declaration
3654 * of some entity, retrieve a cursor that describes the definition of
3657 * Some entities can be declared multiple times within a translation
3658 * unit, but only one of those declarations can also be a
3659 * definition. For example, given:
3663 * int g(int x, int y) { return f(x, y); }
3664 * int f(int a, int b) { return a + b; }
3668 * there are three declarations of the function "f", but only the
3669 * second one is a definition. The clang_getCursorDefinition()
3670 * function will take any cursor pointing to a declaration of "f"
3671 * (the first or fourth lines of the example) or a cursor referenced
3672 * that uses "f" (the call to "f' inside "g") and will return a
3673 * declaration cursor pointing to the definition (the second "f"
3676 * If given a cursor for which there is no corresponding definition,
3677 * e.g., because there is no definition of that entity within this
3678 * translation unit, returns a NULL cursor.
3680 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
3683 * \brief Determine whether the declaration pointed to by this cursor
3684 * is also a definition of that entity.
3686 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
3689 * \brief Retrieve the canonical cursor corresponding to the given cursor.
3691 * In the C family of languages, many kinds of entities can be declared several
3692 * times within a single translation unit. For example, a structure type can
3693 * be forward-declared (possibly multiple times) and later defined:
3703 * The declarations and the definition of \c X are represented by three
3704 * different cursors, all of which are declarations of the same underlying
3705 * entity. One of these cursor is considered the "canonical" cursor, which
3706 * is effectively the representative for the underlying entity. One can
3707 * determine if two cursors are declarations of the same underlying entity by
3708 * comparing their canonical cursors.
3710 * \returns The canonical cursor for the entity referred to by the given cursor.
3712 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
3716 * \brief If the cursor points to a selector identifier in an Objective-C
3717 * method or message expression, this returns the selector index.
3719 * After getting a cursor with #clang_getCursor, this can be called to
3720 * determine if the location points to a selector identifier.
3722 * \returns The selector index if the cursor is an Objective-C method or message
3723 * expression and the cursor is pointing to a selector identifier, or -1
3726 CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
3729 * \brief Given a cursor pointing to a C++ method call or an Objective-C
3730 * message, returns non-zero if the method/message is "dynamic", meaning:
3732 * For a C++ method: the call is virtual.
3733 * For an Objective-C message: the receiver is an object instance, not 'super'
3734 * or a specific class.
3736 * If the method/message is "static" or the cursor does not point to a
3737 * method/message, it will return zero.
3739 CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
3742 * \brief Given a cursor pointing to an Objective-C message, returns the CXType
3745 CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
3748 * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
3751 CXObjCPropertyAttr_noattr = 0x00,
3752 CXObjCPropertyAttr_readonly = 0x01,
3753 CXObjCPropertyAttr_getter = 0x02,
3754 CXObjCPropertyAttr_assign = 0x04,
3755 CXObjCPropertyAttr_readwrite = 0x08,
3756 CXObjCPropertyAttr_retain = 0x10,
3757 CXObjCPropertyAttr_copy = 0x20,
3758 CXObjCPropertyAttr_nonatomic = 0x40,
3759 CXObjCPropertyAttr_setter = 0x80,
3760 CXObjCPropertyAttr_atomic = 0x100,
3761 CXObjCPropertyAttr_weak = 0x200,
3762 CXObjCPropertyAttr_strong = 0x400,
3763 CXObjCPropertyAttr_unsafe_unretained = 0x800
3764 } CXObjCPropertyAttrKind;
3767 * \brief Given a cursor that represents a property declaration, return the
3768 * associated property attributes. The bits are formed from
3769 * \c CXObjCPropertyAttrKind.
3771 * \param reserved Reserved for future use, pass 0.
3773 CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C,
3777 * \brief 'Qualifiers' written next to the return and parameter types in
3778 * Objective-C method declarations.
3781 CXObjCDeclQualifier_None = 0x0,
3782 CXObjCDeclQualifier_In = 0x1,
3783 CXObjCDeclQualifier_Inout = 0x2,
3784 CXObjCDeclQualifier_Out = 0x4,
3785 CXObjCDeclQualifier_Bycopy = 0x8,
3786 CXObjCDeclQualifier_Byref = 0x10,
3787 CXObjCDeclQualifier_Oneway = 0x20
3788 } CXObjCDeclQualifierKind;
3791 * \brief Given a cursor that represents an Objective-C method or parameter
3792 * declaration, return the associated Objective-C qualifiers for the return
3793 * type or the parameter respectively. The bits are formed from
3794 * CXObjCDeclQualifierKind.
3796 CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
3799 * \brief Given a cursor that represents an Objective-C method or property
3800 * declaration, return non-zero if the declaration was affected by "@optional".
3801 * Returns zero if the cursor is not such a declaration or it is "@required".
3803 CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
3806 * \brief Returns non-zero if the given cursor is a variadic function or method.
3808 CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
3811 * \brief Given a cursor that represents a declaration, return the associated
3812 * comment's source range. The range may include multiple consecutive comments
3813 * with whitespace in between.
3815 CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
3818 * \brief Given a cursor that represents a declaration, return the associated
3819 * comment text, including comment markers.
3821 CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
3824 * \brief Given a cursor that represents a documentable entity (e.g.,
3825 * declaration), return the associated \\brief paragraph; otherwise return the
3828 CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
3834 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
3840 * \brief Retrieve the CXString representing the mangled name of the cursor.
3842 CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
3849 * \defgroup CINDEX_MODULE Module introspection
3851 * The functions in this group provide access to information about modules.
3856 typedef void *CXModule;
3859 * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
3861 CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
3864 * \brief Given a CXFile header file, return the module that contains it, if one
3867 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
3870 * \param Module a module object.
3872 * \returns the module file where the provided module object came from.
3874 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
3877 * \param Module a module object.
3879 * \returns the parent of a sub-module or NULL if the given module is top-level,
3880 * e.g. for 'std.vector' it will return the 'std' module.
3882 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
3885 * \param Module a module object.
3887 * \returns the name of the module, e.g. for the 'std.vector' sub-module it
3888 * will return "vector".
3890 CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
3893 * \param Module a module object.
3895 * \returns the full name of the module, e.g. "std.vector".
3897 CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
3900 * \param Module a module object.
3902 * \returns non-zero if the module is a system one.
3904 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
3907 * \param Module a module object.
3909 * \returns the number of top level headers associated with this module.
3911 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
3915 * \param Module a module object.
3917 * \param Index top level header index (zero-based).
3919 * \returns the specified top level header associated with the module.
3922 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
3923 CXModule Module, unsigned Index);
3930 * \defgroup CINDEX_CPP C++ AST introspection
3932 * The routines in this group provide access information in the ASTs specific
3933 * to C++ language features.
3939 * \brief Determine if a C++ member function or member function template is
3942 CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
3945 * \brief Determine if a C++ member function or member function template is
3946 * declared 'static'.
3948 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
3951 * \brief Determine if a C++ member function or member function template is
3952 * explicitly declared 'virtual' or if it overrides a virtual method from
3953 * one of the base classes.
3955 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
3958 * \brief Determine if a C++ member function or member function template is
3961 CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
3964 * \brief Given a cursor that represents a template, determine
3965 * the cursor kind of the specializations would be generated by instantiating
3968 * This routine can be used to determine what flavor of function template,
3969 * class template, or class template partial specialization is stored in the
3970 * cursor. For example, it can describe whether a class template cursor is
3971 * declared with "struct", "class" or "union".
3973 * \param C The cursor to query. This cursor should represent a template
3976 * \returns The cursor kind of the specializations that would be generated
3977 * by instantiating the template \p C. If \p C is not a template, returns
3978 * \c CXCursor_NoDeclFound.
3980 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
3983 * \brief Given a cursor that may represent a specialization or instantiation
3984 * of a template, retrieve the cursor that represents the template that it
3985 * specializes or from which it was instantiated.
3987 * This routine determines the template involved both for explicit
3988 * specializations of templates and for implicit instantiations of the template,
3989 * both of which are referred to as "specializations". For a class template
3990 * specialization (e.g., \c std::vector<bool>), this routine will return
3991 * either the primary template (\c std::vector) or, if the specialization was
3992 * instantiated from a class template partial specialization, the class template
3993 * partial specialization. For a class template partial specialization and a
3994 * function template specialization (including instantiations), this
3995 * this routine will return the specialized template.
3997 * For members of a class template (e.g., member functions, member classes, or
3998 * static data members), returns the specialized or instantiated member.
3999 * Although not strictly "templates" in the C++ language, members of class
4000 * templates have the same notions of specializations and instantiations that
4001 * templates do, so this routine treats them similarly.
4003 * \param C A cursor that may be a specialization of a template or a member
4006 * \returns If the given cursor is a specialization or instantiation of a
4007 * template or a member thereof, the template or member that it specializes or
4008 * from which it was instantiated. Otherwise, returns a NULL cursor.
4010 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
4013 * \brief Given a cursor that references something else, return the source range
4014 * covering that reference.
4016 * \param C A cursor pointing to a member reference, a declaration reference, or
4018 * \param NameFlags A bitset with three independent flags:
4019 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4020 * CXNameRange_WantSinglePiece.
4021 * \param PieceIndex For contiguous names or when passing the flag
4022 * CXNameRange_WantSinglePiece, only one piece with index 0 is
4023 * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4024 * non-contiguous names, this index can be used to retrieve the individual
4025 * pieces of the name. See also CXNameRange_WantSinglePiece.
4027 * \returns The piece of the name pointed to by the given cursor. If there is no
4028 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4030 CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
4032 unsigned PieceIndex);
4034 enum CXNameRefFlags {
4036 * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4039 CXNameRange_WantQualifier = 0x1,
4042 * \brief Include the explicit template arguments, e.g. \<int> in x.f<int>,
4045 CXNameRange_WantTemplateArgs = 0x2,
4048 * \brief If the name is non-contiguous, return the full spanning range.
4050 * Non-contiguous names occur in Objective-C when a selector with two or more
4051 * parameters is used, or in C++ when using an operator:
4053 * [object doSomething:here withValue:there]; // Objective-C
4054 * return some_vector[1]; // C++
4057 CXNameRange_WantSinglePiece = 0x4
4065 * \defgroup CINDEX_LEX Token extraction and manipulation
4067 * The routines in this group provide access to the tokens within a
4068 * translation unit, along with a semantic mapping of those tokens to
4069 * their corresponding cursors.
4075 * \brief Describes a kind of token.
4077 typedef enum CXTokenKind {
4079 * \brief A token that contains some kind of punctuation.
4081 CXToken_Punctuation,
4084 * \brief A language keyword.
4089 * \brief An identifier (that is not a keyword).
4094 * \brief A numeric, string, or character literal.
4105 * \brief Describes a single preprocessing token.
4108 unsigned int_data[4];
4113 * \brief Determine the kind of the given token.
4115 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
4118 * \brief Determine the spelling of the given token.
4120 * The spelling of a token is the textual representation of that token, e.g.,
4121 * the text of an identifier or keyword.
4123 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
4126 * \brief Retrieve the source location of the given token.
4128 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
4132 * \brief Retrieve a source range that covers the given token.
4134 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
4137 * \brief Tokenize the source code described by the given range into raw
4140 * \param TU the translation unit whose text is being tokenized.
4142 * \param Range the source range in which text should be tokenized. All of the
4143 * tokens produced by tokenization will fall within this source range,
4145 * \param Tokens this pointer will be set to point to the array of tokens
4146 * that occur within the given source range. The returned pointer must be
4147 * freed with clang_disposeTokens() before the translation unit is destroyed.
4149 * \param NumTokens will be set to the number of tokens in the \c *Tokens
4153 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4154 CXToken **Tokens, unsigned *NumTokens);
4157 * \brief Annotate the given set of tokens by providing cursors for each token
4158 * that can be mapped to a specific entity within the abstract syntax tree.
4160 * This token-annotation routine is equivalent to invoking
4161 * clang_getCursor() for the source locations of each of the
4162 * tokens. The cursors provided are filtered, so that only those
4163 * cursors that have a direct correspondence to the token are
4164 * accepted. For example, given a function call \c f(x),
4165 * clang_getCursor() would provide the following cursors:
4167 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4168 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4169 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4171 * Only the first and last of these cursors will occur within the
4172 * annotate, since the tokens "f" and "x' directly refer to a function
4173 * and a variable, respectively, but the parentheses are just a small
4174 * part of the full syntax of the function call expression, which is
4175 * not provided as an annotation.
4177 * \param TU the translation unit that owns the given tokens.
4179 * \param Tokens the set of tokens to annotate.
4181 * \param NumTokens the number of tokens in \p Tokens.
4183 * \param Cursors an array of \p NumTokens cursors, whose contents will be
4184 * replaced with the cursors corresponding to each token.
4186 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4187 CXToken *Tokens, unsigned NumTokens,
4191 * \brief Free the given set of tokens.
4193 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4194 CXToken *Tokens, unsigned NumTokens);
4201 * \defgroup CINDEX_DEBUG Debugging facilities
4203 * These routines are used for testing and debugging, only, and should not
4209 /* for debug/testing */
4210 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
4211 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
4212 const char **startBuf,
4213 const char **endBuf,
4214 unsigned *startLine,
4215 unsigned *startColumn,
4217 unsigned *endColumn);
4218 CINDEX_LINKAGE void clang_enableStackTraces(void);
4219 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4220 unsigned stack_size);
4227 * \defgroup CINDEX_CODE_COMPLET Code completion
4229 * Code completion involves taking an (incomplete) source file, along with
4230 * knowledge of where the user is actively editing that file, and suggesting
4231 * syntactically- and semantically-valid constructs that the user might want to
4232 * use at that particular point in the source code. These data structures and
4233 * routines provide support for code completion.
4239 * \brief A semantic string that describes a code-completion result.
4241 * A semantic string that describes the formatting of a code-completion
4242 * result as a single "template" of text that should be inserted into the
4243 * source buffer when a particular code-completion result is selected.
4244 * Each semantic string is made up of some number of "chunks", each of which
4245 * contains some text along with a description of what that text means, e.g.,
4246 * the name of the entity being referenced, whether the text chunk is part of
4247 * the template, or whether it is a "placeholder" that the user should replace
4248 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4249 * description of the different kinds of chunks.
4251 typedef void *CXCompletionString;
4254 * \brief A single result of code completion.
4258 * \brief The kind of entity that this completion refers to.
4260 * The cursor kind will be a macro, keyword, or a declaration (one of the
4261 * *Decl cursor kinds), describing the entity that the completion is
4264 * \todo In the future, we would like to provide a full cursor, to allow
4265 * the client to extract additional information from declaration.
4267 enum CXCursorKind CursorKind;
4270 * \brief The code-completion string that describes how to insert this
4271 * code-completion result into the editing buffer.
4273 CXCompletionString CompletionString;
4274 } CXCompletionResult;
4277 * \brief Describes a single piece of text within a code-completion string.
4279 * Each "chunk" within a code-completion string (\c CXCompletionString) is
4280 * either a piece of text with a specific "kind" that describes how that text
4281 * should be interpreted by the client or is another completion string.
4283 enum CXCompletionChunkKind {
4285 * \brief A code-completion string that describes "optional" text that
4286 * could be a part of the template (but is not required).
4288 * The Optional chunk is the only kind of chunk that has a code-completion
4289 * string for its representation, which is accessible via
4290 * \c clang_getCompletionChunkCompletionString(). The code-completion string
4291 * describes an additional part of the template that is completely optional.
4292 * For example, optional chunks can be used to describe the placeholders for
4293 * arguments that match up with defaulted function parameters, e.g. given:
4296 * void f(int x, float y = 3.14, double z = 2.71828);
4299 * The code-completion string for this function would contain:
4300 * - a TypedText chunk for "f".
4301 * - a LeftParen chunk for "(".
4302 * - a Placeholder chunk for "int x"
4303 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4304 * - a Comma chunk for ","
4305 * - a Placeholder chunk for "float y"
4306 * - an Optional chunk containing the last defaulted argument:
4307 * - a Comma chunk for ","
4308 * - a Placeholder chunk for "double z"
4309 * - a RightParen chunk for ")"
4311 * There are many ways to handle Optional chunks. Two simple approaches are:
4312 * - Completely ignore optional chunks, in which case the template for the
4313 * function "f" would only include the first parameter ("int x").
4314 * - Fully expand all optional chunks, in which case the template for the
4315 * function "f" would have all of the parameters.
4317 CXCompletionChunk_Optional,
4319 * \brief Text that a user would be expected to type to get this
4320 * code-completion result.
4322 * There will be exactly one "typed text" chunk in a semantic string, which
4323 * will typically provide the spelling of a keyword or the name of a
4324 * declaration that could be used at the current code point. Clients are
4325 * expected to filter the code-completion results based on the text in this
4328 CXCompletionChunk_TypedText,
4330 * \brief Text that should be inserted as part of a code-completion result.
4332 * A "text" chunk represents text that is part of the template to be
4333 * inserted into user code should this particular code-completion result
4336 CXCompletionChunk_Text,
4338 * \brief Placeholder text that should be replaced by the user.
4340 * A "placeholder" chunk marks a place where the user should insert text
4341 * into the code-completion template. For example, placeholders might mark
4342 * the function parameters for a function declaration, to indicate that the
4343 * user should provide arguments for each of those parameters. The actual
4344 * text in a placeholder is a suggestion for the text to display before
4345 * the user replaces the placeholder with real code.
4347 CXCompletionChunk_Placeholder,
4349 * \brief Informative text that should be displayed but never inserted as
4350 * part of the template.
4352 * An "informative" chunk contains annotations that can be displayed to
4353 * help the user decide whether a particular code-completion result is the
4354 * right option, but which is not part of the actual template to be inserted
4355 * by code completion.
4357 CXCompletionChunk_Informative,
4359 * \brief Text that describes the current parameter when code-completion is
4360 * referring to function call, message send, or template specialization.
4362 * A "current parameter" chunk occurs when code-completion is providing
4363 * information about a parameter corresponding to the argument at the
4364 * code-completion point. For example, given a function
4367 * int add(int x, int y);
4370 * and the source code \c add(, where the code-completion point is after the
4371 * "(", the code-completion string will contain a "current parameter" chunk
4372 * for "int x", indicating that the current argument will initialize that
4373 * parameter. After typing further, to \c add(17, (where the code-completion
4374 * point is after the ","), the code-completion string will contain a
4375 * "current paremeter" chunk to "int y".
4377 CXCompletionChunk_CurrentParameter,
4379 * \brief A left parenthesis ('('), used to initiate a function call or
4380 * signal the beginning of a function parameter list.
4382 CXCompletionChunk_LeftParen,
4384 * \brief A right parenthesis (')'), used to finish a function call or
4385 * signal the end of a function parameter list.
4387 CXCompletionChunk_RightParen,
4389 * \brief A left bracket ('[').
4391 CXCompletionChunk_LeftBracket,
4393 * \brief A right bracket (']').
4395 CXCompletionChunk_RightBracket,
4397 * \brief A left brace ('{').
4399 CXCompletionChunk_LeftBrace,
4401 * \brief A right brace ('}').
4403 CXCompletionChunk_RightBrace,
4405 * \brief A left angle bracket ('<').
4407 CXCompletionChunk_LeftAngle,
4409 * \brief A right angle bracket ('>').
4411 CXCompletionChunk_RightAngle,
4413 * \brief A comma separator (',').
4415 CXCompletionChunk_Comma,
4417 * \brief Text that specifies the result type of a given result.
4419 * This special kind of informative chunk is not meant to be inserted into
4420 * the text buffer. Rather, it is meant to illustrate the type that an
4421 * expression using the given completion string would have.
4423 CXCompletionChunk_ResultType,
4425 * \brief A colon (':').
4427 CXCompletionChunk_Colon,
4429 * \brief A semicolon (';').
4431 CXCompletionChunk_SemiColon,
4433 * \brief An '=' sign.
4435 CXCompletionChunk_Equal,
4437 * Horizontal space (' ').
4439 CXCompletionChunk_HorizontalSpace,
4441 * Vertical space ('\n'), after which it is generally a good idea to
4442 * perform indentation.
4444 CXCompletionChunk_VerticalSpace
4448 * \brief Determine the kind of a particular chunk within a completion string.
4450 * \param completion_string the completion string to query.
4452 * \param chunk_number the 0-based index of the chunk in the completion string.
4454 * \returns the kind of the chunk at the index \c chunk_number.
4456 CINDEX_LINKAGE enum CXCompletionChunkKind
4457 clang_getCompletionChunkKind(CXCompletionString completion_string,
4458 unsigned chunk_number);
4461 * \brief Retrieve the text associated with a particular chunk within a
4462 * completion string.
4464 * \param completion_string the completion string to query.
4466 * \param chunk_number the 0-based index of the chunk in the completion string.
4468 * \returns the text associated with the chunk at index \c chunk_number.
4470 CINDEX_LINKAGE CXString
4471 clang_getCompletionChunkText(CXCompletionString completion_string,
4472 unsigned chunk_number);
4475 * \brief Retrieve the completion string associated with a particular chunk
4476 * within a completion string.
4478 * \param completion_string the completion string to query.
4480 * \param chunk_number the 0-based index of the chunk in the completion string.
4482 * \returns the completion string associated with the chunk at index
4485 CINDEX_LINKAGE CXCompletionString
4486 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4487 unsigned chunk_number);
4490 * \brief Retrieve the number of chunks in the given code-completion string.
4492 CINDEX_LINKAGE unsigned
4493 clang_getNumCompletionChunks(CXCompletionString completion_string);
4496 * \brief Determine the priority of this code completion.
4498 * The priority of a code completion indicates how likely it is that this
4499 * particular completion is the completion that the user will select. The
4500 * priority is selected by various internal heuristics.
4502 * \param completion_string The completion string to query.
4504 * \returns The priority of this completion string. Smaller values indicate
4505 * higher-priority (more likely) completions.
4507 CINDEX_LINKAGE unsigned
4508 clang_getCompletionPriority(CXCompletionString completion_string);
4511 * \brief Determine the availability of the entity that this code-completion
4514 * \param completion_string The completion string to query.
4516 * \returns The availability of the completion string.
4518 CINDEX_LINKAGE enum CXAvailabilityKind
4519 clang_getCompletionAvailability(CXCompletionString completion_string);
4522 * \brief Retrieve the number of annotations associated with the given
4523 * completion string.
4525 * \param completion_string the completion string to query.
4527 * \returns the number of annotations associated with the given completion
4530 CINDEX_LINKAGE unsigned
4531 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4534 * \brief Retrieve the annotation associated with the given completion string.
4536 * \param completion_string the completion string to query.
4538 * \param annotation_number the 0-based index of the annotation of the
4539 * completion string.
4541 * \returns annotation string associated with the completion at index
4542 * \c annotation_number, or a NULL string if that annotation is not available.
4544 CINDEX_LINKAGE CXString
4545 clang_getCompletionAnnotation(CXCompletionString completion_string,
4546 unsigned annotation_number);
4549 * \brief Retrieve the parent context of the given completion string.
4551 * The parent context of a completion string is the semantic parent of
4552 * the declaration (if any) that the code completion represents. For example,
4553 * a code completion for an Objective-C method would have the method's class
4554 * or protocol as its context.
4556 * \param completion_string The code completion string whose parent is
4559 * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
4561 * \returns The name of the completion parent, e.g., "NSObject" if
4562 * the completion string represents a method in the NSObject class.
4564 CINDEX_LINKAGE CXString
4565 clang_getCompletionParent(CXCompletionString completion_string,
4566 enum CXCursorKind *kind);
4569 * \brief Retrieve the brief documentation comment attached to the declaration
4570 * that corresponds to the given completion string.
4572 CINDEX_LINKAGE CXString
4573 clang_getCompletionBriefComment(CXCompletionString completion_string);
4576 * \brief Retrieve a completion string for an arbitrary declaration or macro
4577 * definition cursor.
4579 * \param cursor The cursor to query.
4581 * \returns A non-context-sensitive completion string for declaration and macro
4582 * definition cursors, or NULL for other kinds of cursors.
4584 CINDEX_LINKAGE CXCompletionString
4585 clang_getCursorCompletionString(CXCursor cursor);
4588 * \brief Contains the results of code-completion.
4590 * This data structure contains the results of code completion, as
4591 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
4592 * \c clang_disposeCodeCompleteResults.
4596 * \brief The code-completion results.
4598 CXCompletionResult *Results;
4601 * \brief The number of code-completion results stored in the
4604 unsigned NumResults;
4605 } CXCodeCompleteResults;
4608 * \brief Flags that can be passed to \c clang_codeCompleteAt() to
4609 * modify its behavior.
4611 * The enumerators in this enumeration can be bitwise-OR'd together to
4612 * provide multiple options to \c clang_codeCompleteAt().
4614 enum CXCodeComplete_Flags {
4616 * \brief Whether to include macros within the set of code
4617 * completions returned.
4619 CXCodeComplete_IncludeMacros = 0x01,
4622 * \brief Whether to include code patterns for language constructs
4623 * within the set of code completions, e.g., for loops.
4625 CXCodeComplete_IncludeCodePatterns = 0x02,
4628 * \brief Whether to include brief documentation within the set of code
4629 * completions returned.
4631 CXCodeComplete_IncludeBriefComments = 0x04
4635 * \brief Bits that represent the context under which completion is occurring.
4637 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
4638 * contexts are occurring simultaneously.
4640 enum CXCompletionContext {
4642 * \brief The context for completions is unexposed, as only Clang results
4643 * should be included. (This is equivalent to having no context bits set.)
4645 CXCompletionContext_Unexposed = 0,
4648 * \brief Completions for any possible type should be included in the results.
4650 CXCompletionContext_AnyType = 1 << 0,
4653 * \brief Completions for any possible value (variables, function calls, etc.)
4654 * should be included in the results.
4656 CXCompletionContext_AnyValue = 1 << 1,
4658 * \brief Completions for values that resolve to an Objective-C object should
4659 * be included in the results.
4661 CXCompletionContext_ObjCObjectValue = 1 << 2,
4663 * \brief Completions for values that resolve to an Objective-C selector
4664 * should be included in the results.
4666 CXCompletionContext_ObjCSelectorValue = 1 << 3,
4668 * \brief Completions for values that resolve to a C++ class type should be
4669 * included in the results.
4671 CXCompletionContext_CXXClassTypeValue = 1 << 4,
4674 * \brief Completions for fields of the member being accessed using the dot
4675 * operator should be included in the results.
4677 CXCompletionContext_DotMemberAccess = 1 << 5,
4679 * \brief Completions for fields of the member being accessed using the arrow
4680 * operator should be included in the results.
4682 CXCompletionContext_ArrowMemberAccess = 1 << 6,
4684 * \brief Completions for properties of the Objective-C object being accessed
4685 * using the dot operator should be included in the results.
4687 CXCompletionContext_ObjCPropertyAccess = 1 << 7,
4690 * \brief Completions for enum tags should be included in the results.
4692 CXCompletionContext_EnumTag = 1 << 8,
4694 * \brief Completions for union tags should be included in the results.
4696 CXCompletionContext_UnionTag = 1 << 9,
4698 * \brief Completions for struct tags should be included in the results.
4700 CXCompletionContext_StructTag = 1 << 10,
4703 * \brief Completions for C++ class names should be included in the results.
4705 CXCompletionContext_ClassTag = 1 << 11,
4707 * \brief Completions for C++ namespaces and namespace aliases should be
4708 * included in the results.
4710 CXCompletionContext_Namespace = 1 << 12,
4712 * \brief Completions for C++ nested name specifiers should be included in
4715 CXCompletionContext_NestedNameSpecifier = 1 << 13,
4718 * \brief Completions for Objective-C interfaces (classes) should be included
4721 CXCompletionContext_ObjCInterface = 1 << 14,
4723 * \brief Completions for Objective-C protocols should be included in
4726 CXCompletionContext_ObjCProtocol = 1 << 15,
4728 * \brief Completions for Objective-C categories should be included in
4731 CXCompletionContext_ObjCCategory = 1 << 16,
4733 * \brief Completions for Objective-C instance messages should be included
4736 CXCompletionContext_ObjCInstanceMessage = 1 << 17,
4738 * \brief Completions for Objective-C class messages should be included in
4741 CXCompletionContext_ObjCClassMessage = 1 << 18,
4743 * \brief Completions for Objective-C selector names should be included in
4746 CXCompletionContext_ObjCSelectorName = 1 << 19,
4749 * \brief Completions for preprocessor macro names should be included in
4752 CXCompletionContext_MacroName = 1 << 20,
4755 * \brief Natural language completions should be included in the results.
4757 CXCompletionContext_NaturalLanguage = 1 << 21,
4760 * \brief The current context is unknown, so set all contexts.
4762 CXCompletionContext_Unknown = ((1 << 22) - 1)
4766 * \brief Returns a default set of code-completion options that can be
4767 * passed to\c clang_codeCompleteAt().
4769 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
4772 * \brief Perform code completion at a given location in a translation unit.
4774 * This function performs code completion at a particular file, line, and
4775 * column within source code, providing results that suggest potential
4776 * code snippets based on the context of the completion. The basic model
4777 * for code completion is that Clang will parse a complete source file,
4778 * performing syntax checking up to the location where code-completion has
4779 * been requested. At that point, a special code-completion token is passed
4780 * to the parser, which recognizes this token and determines, based on the
4781 * current location in the C/Objective-C/C++ grammar and the state of
4782 * semantic analysis, what completions to provide. These completions are
4783 * returned via a new \c CXCodeCompleteResults structure.
4785 * Code completion itself is meant to be triggered by the client when the
4786 * user types punctuation characters or whitespace, at which point the
4787 * code-completion location will coincide with the cursor. For example, if \c p
4788 * is a pointer, code-completion might be triggered after the "-" and then
4789 * after the ">" in \c p->. When the code-completion location is afer the ">",
4790 * the completion results will provide, e.g., the members of the struct that
4791 * "p" points to. The client is responsible for placing the cursor at the
4792 * beginning of the token currently being typed, then filtering the results
4793 * based on the contents of the token. For example, when code-completing for
4794 * the expression \c p->get, the client should provide the location just after
4795 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
4796 * client can filter the results based on the current token text ("get"), only
4797 * showing those results that start with "get". The intent of this interface
4798 * is to separate the relatively high-latency acquisition of code-completion
4799 * results from the filtering of results on a per-character basis, which must
4800 * have a lower latency.
4802 * \param TU The translation unit in which code-completion should
4803 * occur. The source files for this translation unit need not be
4804 * completely up-to-date (and the contents of those source files may
4805 * be overridden via \p unsaved_files). Cursors referring into the
4806 * translation unit may be invalidated by this invocation.
4808 * \param complete_filename The name of the source file where code
4809 * completion should be performed. This filename may be any file
4810 * included in the translation unit.
4812 * \param complete_line The line at which code-completion should occur.
4814 * \param complete_column The column at which code-completion should occur.
4815 * Note that the column should point just after the syntactic construct that
4816 * initiated code completion, and not in the middle of a lexical token.
4818 * \param unsaved_files the Tiles that have not yet been saved to disk
4819 * but may be required for parsing or code completion, including the
4820 * contents of those files. The contents and name of these files (as
4821 * specified by CXUnsavedFile) are copied when necessary, so the
4822 * client only needs to guarantee their validity until the call to
4823 * this function returns.
4825 * \param num_unsaved_files The number of unsaved file entries in \p
4828 * \param options Extra options that control the behavior of code
4829 * completion, expressed as a bitwise OR of the enumerators of the
4830 * CXCodeComplete_Flags enumeration. The
4831 * \c clang_defaultCodeCompleteOptions() function returns a default set
4832 * of code-completion options.
4834 * \returns If successful, a new \c CXCodeCompleteResults structure
4835 * containing code-completion results, which should eventually be
4836 * freed with \c clang_disposeCodeCompleteResults(). If code
4837 * completion fails, returns NULL.
4840 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
4841 const char *complete_filename,
4842 unsigned complete_line,
4843 unsigned complete_column,
4844 struct CXUnsavedFile *unsaved_files,
4845 unsigned num_unsaved_files,
4849 * \brief Sort the code-completion results in case-insensitive alphabetical
4852 * \param Results The set of results to sort.
4853 * \param NumResults The number of results in \p Results.
4856 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
4857 unsigned NumResults);
4860 * \brief Free the given set of code-completion results.
4863 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
4866 * \brief Determine the number of diagnostics produced prior to the
4867 * location where code completion was performed.
4870 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
4873 * \brief Retrieve a diagnostic associated with the given code completion.
4875 * \param Results the code completion results to query.
4876 * \param Index the zero-based diagnostic number to retrieve.
4878 * \returns the requested diagnostic. This diagnostic must be freed
4879 * via a call to \c clang_disposeDiagnostic().
4882 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
4886 * \brief Determines what completions are appropriate for the context
4887 * the given code completion.
4889 * \param Results the code completion results to query
4891 * \returns the kinds of completions that are appropriate for use
4892 * along with the given code completion results.
4895 unsigned long long clang_codeCompleteGetContexts(
4896 CXCodeCompleteResults *Results);
4899 * \brief Returns the cursor kind for the container for the current code
4900 * completion context. The container is only guaranteed to be set for
4901 * contexts where a container exists (i.e. member accesses or Objective-C
4902 * message sends); if there is not a container, this function will return
4903 * CXCursor_InvalidCode.
4905 * \param Results the code completion results to query
4907 * \param IsIncomplete on return, this value will be false if Clang has complete
4908 * information about the container. If Clang does not have complete
4909 * information, this value will be true.
4911 * \returns the container kind, or CXCursor_InvalidCode if there is not a
4915 enum CXCursorKind clang_codeCompleteGetContainerKind(
4916 CXCodeCompleteResults *Results,
4917 unsigned *IsIncomplete);
4920 * \brief Returns the USR for the container for the current code completion
4921 * context. If there is not a container for the current context, this
4922 * function will return the empty string.
4924 * \param Results the code completion results to query
4926 * \returns the USR for the container
4929 CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
4933 * \brief Returns the currently-entered selector for an Objective-C message
4934 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
4935 * non-empty string for CXCompletionContext_ObjCInstanceMessage and
4936 * CXCompletionContext_ObjCClassMessage.
4938 * \param Results the code completion results to query
4940 * \returns the selector (or partial selector) that has been entered thus far
4941 * for an Objective-C message send.
4944 CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
4952 * \defgroup CINDEX_MISC Miscellaneous utility functions
4958 * \brief Return a version string, suitable for showing to a user, but not
4959 * intended to be parsed (the format is not guaranteed to be stable).
4961 CINDEX_LINKAGE CXString clang_getClangVersion(void);
4965 * \brief Enable/disable crash recovery.
4967 * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
4968 * value enables crash recovery, while 0 disables it.
4970 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
4973 * \brief Visitor invoked for each file in a translation unit
4974 * (used with clang_getInclusions()).
4976 * This visitor function will be invoked by clang_getInclusions() for each
4977 * file included (either at the top-level or by \#include directives) within
4978 * a translation unit. The first argument is the file being included, and
4979 * the second and third arguments provide the inclusion stack. The
4980 * array is sorted in order of immediate inclusion. For example,
4981 * the first element refers to the location that included 'included_file'.
4983 typedef void (*CXInclusionVisitor)(CXFile included_file,
4984 CXSourceLocation* inclusion_stack,
4985 unsigned include_len,
4986 CXClientData client_data);
4989 * \brief Visit the set of preprocessor inclusions in a translation unit.
4990 * The visitor function is called with the provided data for every included
4991 * file. This does not include headers included by the PCH file (unless one
4992 * is inspecting the inclusions in the PCH file itself).
4994 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
4995 CXInclusionVisitor visitor,
4996 CXClientData client_data);
5002 /** \defgroup CINDEX_REMAPPING Remapping functions
5008 * \brief A remapping of original source files and their translated files.
5010 typedef void *CXRemapping;
5013 * \brief Retrieve a remapping.
5015 * \param path the path that contains metadata about remappings.
5017 * \returns the requested remapping. This remapping must be freed
5018 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5020 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5023 * \brief Retrieve a remapping.
5025 * \param filePaths pointer to an array of file paths containing remapping info.
5027 * \param numFiles number of file paths.
5029 * \returns the requested remapping. This remapping must be freed
5030 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5033 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5037 * \brief Determine the number of remappings.
5039 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5042 * \brief Get the original and the associated filename from the remapping.
5044 * \param original If non-NULL, will be set to the original filename.
5046 * \param transformed If non-NULL, will be set to the filename that the original
5047 * is associated with.
5049 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5050 CXString *original, CXString *transformed);
5053 * \brief Dispose the remapping.
5055 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5061 /** \defgroup CINDEX_HIGH Higher level API functions
5066 enum CXVisitorResult {
5073 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5074 } CXCursorAndRangeVisitor;
5078 * \brief Function returned successfully.
5080 CXResult_Success = 0,
5082 * \brief One of the parameters was invalid for the function.
5084 CXResult_Invalid = 1,
5086 * \brief The function was terminated by a callback (e.g. it returned
5089 CXResult_VisitBreak = 2
5094 * \brief Find references of a declaration in a specific file.
5096 * \param cursor pointing to a declaration or a reference of one.
5098 * \param file to search for references.
5100 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5101 * each reference found.
5102 * The CXSourceRange will point inside the file; if the reference is inside
5103 * a macro (and not a macro argument) the CXSourceRange will be invalid.
5105 * \returns one of the CXResult enumerators.
5107 CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file,
5108 CXCursorAndRangeVisitor visitor);
5111 * \brief Find #import/#include directives in a specific file.
5113 * \param TU translation unit containing the file to query.
5115 * \param file to search for #import/#include directives.
5117 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5118 * each directive found.
5120 * \returns one of the CXResult enumerators.
5122 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5124 CXCursorAndRangeVisitor visitor);
5126 #ifdef __has_feature
5127 # if __has_feature(blocks)
5129 typedef enum CXVisitorResult
5130 (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5133 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5134 CXCursorAndRangeVisitorBlock);
5137 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5138 CXCursorAndRangeVisitorBlock);
5144 * \brief The client's data object that is associated with a CXFile.
5146 typedef void *CXIdxClientFile;
5149 * \brief The client's data object that is associated with a semantic entity.
5151 typedef void *CXIdxClientEntity;
5154 * \brief The client's data object that is associated with a semantic container
5157 typedef void *CXIdxClientContainer;
5160 * \brief The client's data object that is associated with an AST file (PCH
5163 typedef void *CXIdxClientASTFile;
5166 * \brief Source location passed to index callbacks.
5174 * \brief Data for ppIncludedFile callback.
5178 * \brief Location of '#' in the \#include/\#import directive.
5182 * \brief Filename as written in the \#include/\#import directive.
5184 const char *filename;
5186 * \brief The actual file that the \#include/\#import directive resolved to.
5192 * \brief Non-zero if the directive was automatically turned into a module
5196 } CXIdxIncludedFileInfo;
5199 * \brief Data for IndexerCallbacks#importedASTFile.
5203 * \brief Top level AST file containing the imported PCH, module or submodule.
5207 * \brief The imported module or NULL if the AST file is a PCH.
5211 * \brief Location where the file is imported. Applicable only for modules.
5215 * \brief Non-zero if an inclusion directive was automatically turned into
5216 * a module import. Applicable only for modules.
5220 } CXIdxImportedASTFileInfo;
5223 CXIdxEntity_Unexposed = 0,
5224 CXIdxEntity_Typedef = 1,
5225 CXIdxEntity_Function = 2,
5226 CXIdxEntity_Variable = 3,
5227 CXIdxEntity_Field = 4,
5228 CXIdxEntity_EnumConstant = 5,
5230 CXIdxEntity_ObjCClass = 6,
5231 CXIdxEntity_ObjCProtocol = 7,
5232 CXIdxEntity_ObjCCategory = 8,
5234 CXIdxEntity_ObjCInstanceMethod = 9,
5235 CXIdxEntity_ObjCClassMethod = 10,
5236 CXIdxEntity_ObjCProperty = 11,
5237 CXIdxEntity_ObjCIvar = 12,
5239 CXIdxEntity_Enum = 13,
5240 CXIdxEntity_Struct = 14,
5241 CXIdxEntity_Union = 15,
5243 CXIdxEntity_CXXClass = 16,
5244 CXIdxEntity_CXXNamespace = 17,
5245 CXIdxEntity_CXXNamespaceAlias = 18,
5246 CXIdxEntity_CXXStaticVariable = 19,
5247 CXIdxEntity_CXXStaticMethod = 20,
5248 CXIdxEntity_CXXInstanceMethod = 21,
5249 CXIdxEntity_CXXConstructor = 22,
5250 CXIdxEntity_CXXDestructor = 23,
5251 CXIdxEntity_CXXConversionFunction = 24,
5252 CXIdxEntity_CXXTypeAlias = 25,
5253 CXIdxEntity_CXXInterface = 26
5258 CXIdxEntityLang_None = 0,
5259 CXIdxEntityLang_C = 1,
5260 CXIdxEntityLang_ObjC = 2,
5261 CXIdxEntityLang_CXX = 3
5262 } CXIdxEntityLanguage;
5265 * \brief Extra C++ template information for an entity. This can apply to:
5266 * CXIdxEntity_Function
5267 * CXIdxEntity_CXXClass
5268 * CXIdxEntity_CXXStaticMethod
5269 * CXIdxEntity_CXXInstanceMethod
5270 * CXIdxEntity_CXXConstructor
5271 * CXIdxEntity_CXXConversionFunction
5272 * CXIdxEntity_CXXTypeAlias
5275 CXIdxEntity_NonTemplate = 0,
5276 CXIdxEntity_Template = 1,
5277 CXIdxEntity_TemplatePartialSpecialization = 2,
5278 CXIdxEntity_TemplateSpecialization = 3
5279 } CXIdxEntityCXXTemplateKind;
5282 CXIdxAttr_Unexposed = 0,
5283 CXIdxAttr_IBAction = 1,
5284 CXIdxAttr_IBOutlet = 2,
5285 CXIdxAttr_IBOutletCollection = 3
5295 CXIdxEntityKind kind;
5296 CXIdxEntityCXXTemplateKind templateKind;
5297 CXIdxEntityLanguage lang;
5301 const CXIdxAttrInfo *const *attributes;
5302 unsigned numAttributes;
5307 } CXIdxContainerInfo;
5310 const CXIdxAttrInfo *attrInfo;
5311 const CXIdxEntityInfo *objcClass;
5312 CXCursor classCursor;
5314 } CXIdxIBOutletCollectionAttrInfo;
5317 CXIdxDeclFlag_Skipped = 0x1
5318 } CXIdxDeclInfoFlags;
5321 const CXIdxEntityInfo *entityInfo;
5324 const CXIdxContainerInfo *semanticContainer;
5326 * \brief Generally same as #semanticContainer but can be different in
5327 * cases like out-of-line C++ member functions.
5329 const CXIdxContainerInfo *lexicalContainer;
5330 int isRedeclaration;
5333 const CXIdxContainerInfo *declAsContainer;
5335 * \brief Whether the declaration exists in code or was created implicitly
5336 * by the compiler, e.g. implicit Objective-C methods for properties.
5339 const CXIdxAttrInfo *const *attributes;
5340 unsigned numAttributes;
5347 CXIdxObjCContainer_ForwardRef = 0,
5348 CXIdxObjCContainer_Interface = 1,
5349 CXIdxObjCContainer_Implementation = 2
5350 } CXIdxObjCContainerKind;
5353 const CXIdxDeclInfo *declInfo;
5354 CXIdxObjCContainerKind kind;
5355 } CXIdxObjCContainerDeclInfo;
5358 const CXIdxEntityInfo *base;
5361 } CXIdxBaseClassInfo;
5364 const CXIdxEntityInfo *protocol;
5367 } CXIdxObjCProtocolRefInfo;
5370 const CXIdxObjCProtocolRefInfo *const *protocols;
5371 unsigned numProtocols;
5372 } CXIdxObjCProtocolRefListInfo;
5375 const CXIdxObjCContainerDeclInfo *containerInfo;
5376 const CXIdxBaseClassInfo *superInfo;
5377 const CXIdxObjCProtocolRefListInfo *protocols;
5378 } CXIdxObjCInterfaceDeclInfo;
5381 const CXIdxObjCContainerDeclInfo *containerInfo;
5382 const CXIdxEntityInfo *objcClass;
5383 CXCursor classCursor;
5385 const CXIdxObjCProtocolRefListInfo *protocols;
5386 } CXIdxObjCCategoryDeclInfo;
5389 const CXIdxDeclInfo *declInfo;
5390 const CXIdxEntityInfo *getter;
5391 const CXIdxEntityInfo *setter;
5392 } CXIdxObjCPropertyDeclInfo;
5395 const CXIdxDeclInfo *declInfo;
5396 const CXIdxBaseClassInfo *const *bases;
5398 } CXIdxCXXClassDeclInfo;
5401 * \brief Data for IndexerCallbacks#indexEntityReference.
5405 * \brief The entity is referenced directly in user's code.
5407 CXIdxEntityRef_Direct = 1,
5409 * \brief An implicit reference, e.g. a reference of an Objective-C method
5410 * via the dot syntax.
5412 CXIdxEntityRef_Implicit = 2
5413 } CXIdxEntityRefKind;
5416 * \brief Data for IndexerCallbacks#indexEntityReference.
5419 CXIdxEntityRefKind kind;
5421 * \brief Reference cursor.
5426 * \brief The entity that gets referenced.
5428 const CXIdxEntityInfo *referencedEntity;
5430 * \brief Immediate "parent" of the reference. For example:
5436 * The parent of reference of type 'Foo' is the variable 'var'.
5437 * For references inside statement bodies of functions/methods,
5438 * the parentEntity will be the function/method.
5440 const CXIdxEntityInfo *parentEntity;
5442 * \brief Lexical container context of the reference.
5444 const CXIdxContainerInfo *container;
5445 } CXIdxEntityRefInfo;
5448 * \brief A group of callbacks used by #clang_indexSourceFile and
5449 * #clang_indexTranslationUnit.
5453 * \brief Called periodically to check whether indexing should be aborted.
5454 * Should return 0 to continue, and non-zero to abort.
5456 int (*abortQuery)(CXClientData client_data, void *reserved);
5459 * \brief Called at the end of indexing; passes the complete diagnostic set.
5461 void (*diagnostic)(CXClientData client_data,
5462 CXDiagnosticSet, void *reserved);
5464 CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
5465 CXFile mainFile, void *reserved);
5468 * \brief Called when a file gets \#included/\#imported.
5470 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
5471 const CXIdxIncludedFileInfo *);
5474 * \brief Called when a AST file (PCH or module) gets imported.
5476 * AST files will not get indexed (there will not be callbacks to index all
5477 * the entities in an AST file). The recommended action is that, if the AST
5478 * file is not already indexed, to initiate a new indexing job specific to
5481 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
5482 const CXIdxImportedASTFileInfo *);
5485 * \brief Called at the beginning of indexing a translation unit.
5487 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
5490 void (*indexDeclaration)(CXClientData client_data,
5491 const CXIdxDeclInfo *);
5494 * \brief Called to index a reference of an entity.
5496 void (*indexEntityReference)(CXClientData client_data,
5497 const CXIdxEntityRefInfo *);
5501 CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
5502 CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
5503 clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
5505 CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
5506 clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
5509 const CXIdxObjCCategoryDeclInfo *
5510 clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
5512 CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
5513 clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
5515 CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
5516 clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
5518 CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
5519 clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
5521 CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
5522 clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
5525 * \brief For retrieving a custom CXIdxClientContainer attached to a
5528 CINDEX_LINKAGE CXIdxClientContainer
5529 clang_index_getClientContainer(const CXIdxContainerInfo *);
5532 * \brief For setting a custom CXIdxClientContainer attached to a
5536 clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
5539 * \brief For retrieving a custom CXIdxClientEntity attached to an entity.
5541 CINDEX_LINKAGE CXIdxClientEntity
5542 clang_index_getClientEntity(const CXIdxEntityInfo *);
5545 * \brief For setting a custom CXIdxClientEntity attached to an entity.
5548 clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
5551 * \brief An indexing action/session, to be applied to one or multiple
5552 * translation units.
5554 typedef void *CXIndexAction;
5557 * \brief An indexing action/session, to be applied to one or multiple
5558 * translation units.
5560 * \param CIdx The index object with which the index action will be associated.
5562 CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
5565 * \brief Destroy the given index action.
5567 * The index action must not be destroyed until all of the translation units
5568 * created within that index action have been destroyed.
5570 CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
5574 * \brief Used to indicate that no special indexing options are needed.
5576 CXIndexOpt_None = 0x0,
5579 * \brief Used to indicate that IndexerCallbacks#indexEntityReference should
5580 * be invoked for only one reference of an entity per source file that does
5581 * not also include a declaration/definition of the entity.
5583 CXIndexOpt_SuppressRedundantRefs = 0x1,
5586 * \brief Function-local symbols should be indexed. If this is not set
5587 * function-local symbols will be ignored.
5589 CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
5592 * \brief Implicit function/class template instantiations should be indexed.
5593 * If this is not set, implicit instantiations will be ignored.
5595 CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
5598 * \brief Suppress all compiler warnings when parsing for indexing.
5600 CXIndexOpt_SuppressWarnings = 0x8,
5603 * \brief Skip a function/method body that was already parsed during an
5604 * indexing session associated with a \c CXIndexAction object.
5605 * Bodies in system headers are always skipped.
5607 CXIndexOpt_SkipParsedBodiesInSession = 0x10
5612 * \brief Index the given source file and the translation unit corresponding
5613 * to that file via callbacks implemented through #IndexerCallbacks.
5615 * \param client_data pointer data supplied by the client, which will
5616 * be passed to the invoked callbacks.
5618 * \param index_callbacks Pointer to indexing callbacks that the client
5621 * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
5622 * passed in index_callbacks.
5624 * \param index_options A bitmask of options that affects how indexing is
5625 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
5627 * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
5628 * reused after indexing is finished. Set to \c NULL if you do not require it.
5630 * \returns 0 on success or if there were errors from which the compiler could
5631 * recover. If there is a failure from which the there is no recovery, returns
5632 * a non-zero \c CXErrorCode.
5634 * The rest of the parameters are the same as #clang_parseTranslationUnit.
5636 CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
5637 CXClientData client_data,
5638 IndexerCallbacks *index_callbacks,
5639 unsigned index_callbacks_size,
5640 unsigned index_options,
5641 const char *source_filename,
5642 const char * const *command_line_args,
5643 int num_command_line_args,
5644 struct CXUnsavedFile *unsaved_files,
5645 unsigned num_unsaved_files,
5646 CXTranslationUnit *out_TU,
5647 unsigned TU_options);
5650 * \brief Index the given translation unit via callbacks implemented through
5651 * #IndexerCallbacks.
5653 * The order of callback invocations is not guaranteed to be the same as
5654 * when indexing a source file. The high level order will be:
5656 * -Preprocessor callbacks invocations
5657 * -Declaration/reference callbacks invocations
5658 * -Diagnostic callback invocations
5660 * The parameters are the same as #clang_indexSourceFile.
5662 * \returns If there is a failure from which the there is no recovery, returns
5663 * non-zero, otherwise returns 0.
5665 CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
5666 CXClientData client_data,
5667 IndexerCallbacks *index_callbacks,
5668 unsigned index_callbacks_size,
5669 unsigned index_options,
5673 * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by
5674 * the given CXIdxLoc.
5676 * If the location refers into a macro expansion, retrieves the
5677 * location of the macro expansion and if it refers into a macro argument
5678 * retrieves the location of the argument.
5680 CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
5681 CXIdxClientFile *indexFile,
5688 * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
5691 CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
5694 * \brief Visitor invoked for each field found by a traversal.
5696 * This visitor function will be invoked for each field found by
5697 * \c clang_Type_visitFields. Its first argument is the cursor being
5698 * visited, its second argument is the client data provided to
5699 * \c clang_Type_visitFields.
5701 * The visitor should return one of the \c CXVisitorResult values
5702 * to direct \c clang_Type_visitFields.
5704 typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
5705 CXClientData client_data);
5708 * \brief Visit the fields of a particular type.
5710 * This function visits all the direct fields of the given cursor,
5711 * invoking the given \p visitor function with the cursors of each
5712 * visited field. The traversal may be ended prematurely, if
5713 * the visitor returns \c CXFieldVisit_Break.
5715 * \param T the record type whose field may be visited.
5717 * \param visitor the visitor function that will be invoked for each
5720 * \param client_data pointer data supplied by the client, which will
5721 * be passed to the visitor each time it is invoked.
5723 * \returns a non-zero value if the traversal was terminated
5724 * prematurely by the visitor returning \c CXFieldVisit_Break.
5726 CINDEX_LINKAGE unsigned clang_Type_visitFields(CXType T,
5727 CXFieldVisitor visitor,
5728 CXClientData client_data);