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 35
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;
289 * \brief Retrieve the complete file and path name of the given file.
291 CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
294 * \brief Retrieve the last modification time of the given file.
296 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
299 * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
300 * across an indexing session.
303 unsigned long long data[3];
307 * \brief Retrieve the unique ID for the given \c file.
309 * \param file the file to get the ID for.
310 * \param outID stores the returned CXFileUniqueID.
311 * \returns If there was a failure getting the unique ID, returns non-zero,
312 * otherwise returns 0.
314 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
317 * \brief Determine whether the given header is guarded against
318 * multiple inclusions, either with the conventional
319 * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
321 CINDEX_LINKAGE unsigned
322 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
325 * \brief Retrieve a file handle within the given translation unit.
327 * \param tu the translation unit
329 * \param file_name the name of the file.
331 * \returns the file handle for the named file in the translation unit \p tu,
332 * or a NULL file handle if the file was not a part of this translation unit.
334 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
335 const char *file_name);
338 * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
339 * or they are both NULL.
341 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
348 * \defgroup CINDEX_LOCATIONS Physical source locations
350 * Clang represents physical source locations in its abstract syntax tree in
351 * great detail, with file, line, and column information for the majority of
352 * the tokens parsed in the source code. These data types and functions are
353 * used to represent source location information, either for a particular
354 * point in the program or for a range of points in the program, and extract
355 * specific location information from those data types.
361 * \brief Identifies a specific source location within a translation
364 * Use clang_getExpansionLocation() or clang_getSpellingLocation()
365 * to map a source location to a particular file, line, and column.
368 const void *ptr_data[2];
373 * \brief Identifies a half-open character range in the source code.
375 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
376 * starting and end locations from a source range, respectively.
379 const void *ptr_data[2];
380 unsigned begin_int_data;
381 unsigned end_int_data;
385 * \brief Retrieve a NULL (invalid) source location.
387 CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(void);
390 * \brief Determine whether two source locations, which must refer into
391 * the same translation unit, refer to exactly the same point in the source
394 * \returns non-zero if the source locations refer to the same location, zero
395 * if they refer to different locations.
397 CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
398 CXSourceLocation loc2);
401 * \brief Retrieves the source location associated with a given file/line/column
402 * in a particular translation unit.
404 CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
409 * \brief Retrieves the source location associated with a given character offset
410 * in a particular translation unit.
412 CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
417 * \brief Returns non-zero if the given source location is in a system header.
419 CINDEX_LINKAGE int clang_Location_isInSystemHeader(CXSourceLocation location);
422 * \brief Returns non-zero if the given source location is in the main file of
423 * the corresponding translation unit.
425 CINDEX_LINKAGE int clang_Location_isFromMainFile(CXSourceLocation location);
428 * \brief Retrieve a NULL (invalid) source range.
430 CINDEX_LINKAGE CXSourceRange clang_getNullRange(void);
433 * \brief Retrieve a source range given the beginning and ending source
436 CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
437 CXSourceLocation end);
440 * \brief Determine whether two ranges are equivalent.
442 * \returns non-zero if the ranges are the same, zero if they differ.
444 CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
445 CXSourceRange range2);
448 * \brief Returns non-zero if \p range is null.
450 CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
453 * \brief Retrieve the file, line, column, and offset represented by
454 * the given source location.
456 * If the location refers into a macro expansion, retrieves the
457 * location of the macro expansion.
459 * \param location the location within a source file that will be decomposed
462 * \param file [out] if non-NULL, will be set to the file to which the given
463 * source location points.
465 * \param line [out] if non-NULL, will be set to the line to which the given
466 * source location points.
468 * \param column [out] if non-NULL, will be set to the column to which the given
469 * source location points.
471 * \param offset [out] if non-NULL, will be set to the offset into the
472 * buffer to which the given source location points.
474 CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location,
481 * \brief Retrieve the file, line, column, and offset represented by
482 * the given source location, as specified in a # line directive.
484 * Example: given the following source code in a file somefile.c
489 * static int func(void)
495 * the location information returned by this function would be
497 * File: dummy.c Line: 124 Column: 12
499 * whereas clang_getExpansionLocation would have returned
501 * File: somefile.c Line: 3 Column: 12
503 * \param location the location within a source file that will be decomposed
506 * \param filename [out] if non-NULL, will be set to the filename of the
507 * source location. Note that filenames returned will be for "virtual" files,
508 * which don't necessarily exist on the machine running clang - e.g. when
509 * parsing preprocessed output obtained from a different environment. If
510 * a non-NULL value is passed in, remember to dispose of the returned value
511 * using \c clang_disposeString() once you've finished with it. For an invalid
512 * source location, an empty string is returned.
514 * \param line [out] if non-NULL, will be set to the line number of the
515 * source location. For an invalid source location, zero is returned.
517 * \param column [out] if non-NULL, will be set to the column number of the
518 * source location. For an invalid source location, zero is returned.
520 CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location,
526 * \brief Legacy API to retrieve the file, line, column, and offset represented
527 * by the given source location.
529 * This interface has been replaced by the newer interface
530 * #clang_getExpansionLocation(). See that interface's documentation for
533 CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
540 * \brief Retrieve the file, line, column, and offset represented by
541 * the given source location.
543 * If the location refers into a macro instantiation, return where the
544 * location was originally spelled in the source file.
546 * \param location the location within a source file that will be decomposed
549 * \param file [out] if non-NULL, will be set to the file to which the given
550 * source location points.
552 * \param line [out] if non-NULL, will be set to the line to which the given
553 * source location points.
555 * \param column [out] if non-NULL, will be set to the column to which the given
556 * source location points.
558 * \param offset [out] if non-NULL, will be set to the offset into the
559 * buffer to which the given source location points.
561 CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
568 * \brief Retrieve the file, line, column, and offset represented by
569 * the given source location.
571 * If the location refers into a macro expansion, return where the macro was
572 * expanded or where the macro argument was written, if the location points at
575 * \param location the location within a source file that will be decomposed
578 * \param file [out] if non-NULL, will be set to the file to which the given
579 * source location points.
581 * \param line [out] if non-NULL, will be set to the line to which the given
582 * source location points.
584 * \param column [out] if non-NULL, will be set to the column to which the given
585 * source location points.
587 * \param offset [out] if non-NULL, will be set to the offset into the
588 * buffer to which the given source location points.
590 CINDEX_LINKAGE void clang_getFileLocation(CXSourceLocation location,
597 * \brief Retrieve a source location representing the first character within a
600 CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
603 * \brief Retrieve a source location representing the last character within a
606 CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
609 * \brief Identifies an array of ranges.
612 /** \brief The number of ranges in the \c ranges array. */
615 * \brief An array of \c CXSourceRanges.
617 CXSourceRange *ranges;
621 * \brief Retrieve all ranges that were skipped by the preprocessor.
623 * The preprocessor will skip lines when they are surrounded by an
624 * if/ifdef/ifndef directive whose condition does not evaluate to true.
626 CINDEX_LINKAGE CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit tu,
630 * \brief Destroy the given \c CXSourceRangeList.
632 CINDEX_LINKAGE void clang_disposeSourceRangeList(CXSourceRangeList *ranges);
639 * \defgroup CINDEX_DIAG Diagnostic reporting
645 * \brief Describes the severity of a particular diagnostic.
647 enum CXDiagnosticSeverity {
649 * \brief A diagnostic that has been suppressed, e.g., by a command-line
652 CXDiagnostic_Ignored = 0,
655 * \brief This diagnostic is a note that should be attached to the
656 * previous (non-note) diagnostic.
658 CXDiagnostic_Note = 1,
661 * \brief This diagnostic indicates suspicious code that may not be
664 CXDiagnostic_Warning = 2,
667 * \brief This diagnostic indicates that the code is ill-formed.
669 CXDiagnostic_Error = 3,
672 * \brief This diagnostic indicates that the code is ill-formed such
673 * that future parser recovery is unlikely to produce useful
676 CXDiagnostic_Fatal = 4
680 * \brief A single diagnostic, containing the diagnostic's severity,
681 * location, text, source ranges, and fix-it hints.
683 typedef void *CXDiagnostic;
686 * \brief A group of CXDiagnostics.
688 typedef void *CXDiagnosticSet;
691 * \brief Determine the number of diagnostics in a CXDiagnosticSet.
693 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
696 * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
698 * \param Diags the CXDiagnosticSet to query.
699 * \param Index the zero-based diagnostic number to retrieve.
701 * \returns the requested diagnostic. This diagnostic must be freed
702 * via a call to \c clang_disposeDiagnostic().
704 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
708 * \brief Describes the kind of error that occurred (if any) in a call to
709 * \c clang_loadDiagnostics.
711 enum CXLoadDiag_Error {
713 * \brief Indicates that no error occurred.
718 * \brief Indicates that an unknown error occurred while attempting to
719 * deserialize diagnostics.
721 CXLoadDiag_Unknown = 1,
724 * \brief Indicates that the file containing the serialized diagnostics
725 * could not be opened.
727 CXLoadDiag_CannotLoad = 2,
730 * \brief Indicates that the serialized diagnostics file is invalid or
733 CXLoadDiag_InvalidFile = 3
737 * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
740 * \param file The name of the file to deserialize.
741 * \param error A pointer to a enum value recording if there was a problem
742 * deserializing the diagnostics.
743 * \param errorString A pointer to a CXString for recording the error string
744 * if the file was not successfully loaded.
746 * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
747 * diagnostics should be released using clang_disposeDiagnosticSet().
749 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
750 enum CXLoadDiag_Error *error,
751 CXString *errorString);
754 * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
756 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
759 * \brief Retrieve the child diagnostics of a CXDiagnostic.
761 * This CXDiagnosticSet does not need to be released by
762 * clang_disposeDiagnosticSet.
764 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
767 * \brief Determine the number of diagnostics produced for the given
770 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
773 * \brief Retrieve a diagnostic associated with the given translation unit.
775 * \param Unit the translation unit to query.
776 * \param Index the zero-based diagnostic number to retrieve.
778 * \returns the requested diagnostic. This diagnostic must be freed
779 * via a call to \c clang_disposeDiagnostic().
781 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
785 * \brief Retrieve the complete set of diagnostics associated with a
788 * \param Unit the translation unit to query.
790 CINDEX_LINKAGE CXDiagnosticSet
791 clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
794 * \brief Destroy a diagnostic.
796 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
799 * \brief Options to control the display of diagnostics.
801 * The values in this enum are meant to be combined to customize the
802 * behavior of \c clang_formatDiagnostic().
804 enum CXDiagnosticDisplayOptions {
806 * \brief Display the source-location information where the
807 * diagnostic was located.
809 * When set, diagnostics will be prefixed by the file, line, and
810 * (optionally) column to which the diagnostic refers. For example,
813 * test.c:28: warning: extra tokens at end of #endif directive
816 * This option corresponds to the clang flag \c -fshow-source-location.
818 CXDiagnostic_DisplaySourceLocation = 0x01,
821 * \brief If displaying the source-location information of the
822 * diagnostic, also include the column number.
824 * This option corresponds to the clang flag \c -fshow-column.
826 CXDiagnostic_DisplayColumn = 0x02,
829 * \brief If displaying the source-location information of the
830 * diagnostic, also include information about source ranges in a
831 * machine-parsable format.
833 * This option corresponds to the clang flag
834 * \c -fdiagnostics-print-source-range-info.
836 CXDiagnostic_DisplaySourceRanges = 0x04,
839 * \brief Display the option name associated with this diagnostic, if any.
841 * The option name displayed (e.g., -Wconversion) will be placed in brackets
842 * after the diagnostic text. This option corresponds to the clang flag
843 * \c -fdiagnostics-show-option.
845 CXDiagnostic_DisplayOption = 0x08,
848 * \brief Display the category number associated with this diagnostic, if any.
850 * The category number is displayed within brackets after the diagnostic text.
851 * This option corresponds to the clang flag
852 * \c -fdiagnostics-show-category=id.
854 CXDiagnostic_DisplayCategoryId = 0x10,
857 * \brief Display the category name associated with this diagnostic, if any.
859 * The category name is displayed within brackets after the diagnostic text.
860 * This option corresponds to the clang flag
861 * \c -fdiagnostics-show-category=name.
863 CXDiagnostic_DisplayCategoryName = 0x20
867 * \brief Format the given diagnostic in a manner that is suitable for display.
869 * This routine will format the given diagnostic to a string, rendering
870 * the diagnostic according to the various options given. The
871 * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
872 * options that most closely mimics the behavior of the clang compiler.
874 * \param Diagnostic The diagnostic to print.
876 * \param Options A set of options that control the diagnostic display,
877 * created by combining \c CXDiagnosticDisplayOptions values.
879 * \returns A new string containing for formatted diagnostic.
881 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
885 * \brief Retrieve the set of display options most similar to the
886 * default behavior of the clang compiler.
888 * \returns A set of display options suitable for use with \c
889 * clang_formatDiagnostic().
891 CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
894 * \brief Determine the severity of the given diagnostic.
896 CINDEX_LINKAGE enum CXDiagnosticSeverity
897 clang_getDiagnosticSeverity(CXDiagnostic);
900 * \brief Retrieve the source location of the given diagnostic.
902 * This location is where Clang would print the caret ('^') when
903 * displaying the diagnostic on the command line.
905 CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
908 * \brief Retrieve the text of the given diagnostic.
910 CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
913 * \brief Retrieve the name of the command-line option that enabled this
916 * \param Diag The diagnostic to be queried.
918 * \param Disable If non-NULL, will be set to the option that disables this
919 * diagnostic (if any).
921 * \returns A string that contains the command-line option used to enable this
922 * warning, such as "-Wconversion" or "-pedantic".
924 CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
928 * \brief Retrieve the category number for this diagnostic.
930 * Diagnostics can be categorized into groups along with other, related
931 * diagnostics (e.g., diagnostics under the same warning flag). This routine
932 * retrieves the category number for the given diagnostic.
934 * \returns The number of the category that contains this diagnostic, or zero
935 * if this diagnostic is uncategorized.
937 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
940 * \brief Retrieve the name of a particular diagnostic category. This
941 * is now deprecated. Use clang_getDiagnosticCategoryText()
944 * \param Category A diagnostic category number, as returned by
945 * \c clang_getDiagnosticCategory().
947 * \returns The name of the given diagnostic category.
949 CINDEX_DEPRECATED CINDEX_LINKAGE
950 CXString clang_getDiagnosticCategoryName(unsigned Category);
953 * \brief Retrieve the diagnostic category text for a given diagnostic.
955 * \returns The text of the given diagnostic category.
957 CINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic);
960 * \brief Determine the number of source ranges associated with the given
963 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
966 * \brief Retrieve a source range associated with the diagnostic.
968 * A diagnostic's source ranges highlight important elements in the source
969 * code. On the command line, Clang displays source ranges by
970 * underlining them with '~' characters.
972 * \param Diagnostic the diagnostic whose range is being extracted.
974 * \param Range the zero-based index specifying which range to
976 * \returns the requested source range.
978 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
982 * \brief Determine the number of fix-it hints associated with the
985 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
988 * \brief Retrieve the replacement information for a given fix-it.
990 * Fix-its are described in terms of a source range whose contents
991 * should be replaced by a string. This approach generalizes over
992 * three kinds of operations: removal of source code (the range covers
993 * the code to be removed and the replacement string is empty),
994 * replacement of source code (the range covers the code to be
995 * replaced and the replacement string provides the new code), and
996 * insertion (both the start and end of the range point at the
997 * insertion location, and the replacement string provides the text to
1000 * \param Diagnostic The diagnostic whose fix-its are being queried.
1002 * \param FixIt The zero-based index of the fix-it.
1004 * \param ReplacementRange The source range whose contents will be
1005 * replaced with the returned replacement string. Note that source
1006 * ranges are half-open ranges [a, b), so the source code should be
1007 * replaced from a and up to (but not including) b.
1009 * \returns A string containing text that should be replace the source
1010 * code indicated by the \c ReplacementRange.
1012 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1014 CXSourceRange *ReplacementRange);
1021 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1023 * The routines in this group provide the ability to create and destroy
1024 * translation units from files, either by parsing the contents of the files or
1025 * by reading in a serialized representation of a translation unit.
1031 * \brief Get the original translation unit source file name.
1033 CINDEX_LINKAGE CXString
1034 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1037 * \brief Return the CXTranslationUnit for a given source file and the provided
1038 * command line arguments one would pass to the compiler.
1040 * Note: The 'source_filename' argument is optional. If the caller provides a
1041 * NULL pointer, the name of the source file is expected to reside in the
1042 * specified command line arguments.
1044 * Note: When encountered in 'clang_command_line_args', the following options
1050 * '-o \<output file>' (both '-o' and '\<output file>' are ignored)
1052 * \param CIdx The index object with which the translation unit will be
1055 * \param source_filename The name of the source file to load, or NULL if the
1056 * source file is included in \p clang_command_line_args.
1058 * \param num_clang_command_line_args The number of command-line arguments in
1059 * \p clang_command_line_args.
1061 * \param clang_command_line_args The command-line arguments that would be
1062 * passed to the \c clang executable if it were being invoked out-of-process.
1063 * These command-line options will be parsed and will affect how the translation
1064 * unit is parsed. Note that the following options are ignored: '-c',
1065 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1067 * \param num_unsaved_files the number of unsaved file entries in \p
1070 * \param unsaved_files the files that have not yet been saved to disk
1071 * but may be required for code completion, including the contents of
1072 * those files. The contents and name of these files (as specified by
1073 * CXUnsavedFile) are copied when necessary, so the client only needs to
1074 * guarantee their validity until the call to this function returns.
1076 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
1078 const char *source_filename,
1079 int num_clang_command_line_args,
1080 const char * const *clang_command_line_args,
1081 unsigned num_unsaved_files,
1082 struct CXUnsavedFile *unsaved_files);
1085 * \brief Same as \c clang_createTranslationUnit2, but returns
1086 * the \c CXTranslationUnit instead of an error code. In case of an error this
1087 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1090 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(
1092 const char *ast_filename);
1095 * \brief Create a translation unit from an AST file (\c -emit-ast).
1097 * \param[out] out_TU A non-NULL pointer to store the created
1098 * \c CXTranslationUnit.
1100 * \returns Zero on success, otherwise returns an error code.
1102 CINDEX_LINKAGE enum CXErrorCode clang_createTranslationUnit2(
1104 const char *ast_filename,
1105 CXTranslationUnit *out_TU);
1108 * \brief Flags that control the creation of translation units.
1110 * The enumerators in this enumeration type are meant to be bitwise
1111 * ORed together to specify which options should be used when
1112 * constructing the translation unit.
1114 enum CXTranslationUnit_Flags {
1116 * \brief Used to indicate that no special translation-unit options are
1119 CXTranslationUnit_None = 0x0,
1122 * \brief Used to indicate that the parser should construct a "detailed"
1123 * preprocessing record, including all macro definitions and instantiations.
1125 * Constructing a detailed preprocessing record requires more memory
1126 * and time to parse, since the information contained in the record
1127 * is usually not retained. However, it can be useful for
1128 * applications that require more detailed information about the
1129 * behavior of the preprocessor.
1131 CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
1134 * \brief Used to indicate that the translation unit is incomplete.
1136 * When a translation unit is considered "incomplete", semantic
1137 * analysis that is typically performed at the end of the
1138 * translation unit will be suppressed. For example, this suppresses
1139 * the completion of tentative declarations in C and of
1140 * instantiation of implicitly-instantiation function templates in
1141 * C++. This option is typically used when parsing a header with the
1142 * intent of producing a precompiled header.
1144 CXTranslationUnit_Incomplete = 0x02,
1147 * \brief Used to indicate that the translation unit should be built with an
1148 * implicit precompiled header for the preamble.
1150 * An implicit precompiled header is used as an optimization when a
1151 * particular translation unit is likely to be reparsed many times
1152 * when the sources aren't changing that often. In this case, an
1153 * implicit precompiled header will be built containing all of the
1154 * initial includes at the top of the main file (what we refer to as
1155 * the "preamble" of the file). In subsequent parses, if the
1156 * preamble or the files in it have not changed, \c
1157 * clang_reparseTranslationUnit() will re-use the implicit
1158 * precompiled header to improve parsing performance.
1160 CXTranslationUnit_PrecompiledPreamble = 0x04,
1163 * \brief Used to indicate that the translation unit should cache some
1164 * code-completion results with each reparse of the source file.
1166 * Caching of code-completion results is a performance optimization that
1167 * introduces some overhead to reparsing but improves the performance of
1168 * code-completion operations.
1170 CXTranslationUnit_CacheCompletionResults = 0x08,
1173 * \brief Used to indicate that the translation unit will be serialized with
1174 * \c clang_saveTranslationUnit.
1176 * This option is typically used when parsing a header with the intent of
1177 * producing a precompiled header.
1179 CXTranslationUnit_ForSerialization = 0x10,
1182 * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1184 * Note: this is a *temporary* option that is available only while
1185 * we are testing C++ precompiled preamble support. It is deprecated.
1187 CXTranslationUnit_CXXChainedPCH = 0x20,
1190 * \brief Used to indicate that function/method bodies should be skipped while
1193 * This option can be used to search for declarations/definitions while
1194 * ignoring the usages.
1196 CXTranslationUnit_SkipFunctionBodies = 0x40,
1199 * \brief Used to indicate that brief documentation comments should be
1200 * included into the set of code completions returned from this translation
1203 CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80,
1206 * \brief Used to indicate that the precompiled preamble should be created on
1207 * the first parse. Otherwise it will be created on the first reparse. This
1208 * trades runtime on the first parse (serializing the preamble takes time) for
1209 * reduced runtime on the second parse (can now reuse the preamble).
1211 CXTranslationUnit_CreatePreambleOnFirstParse = 0x100,
1214 * \brief Do not stop processing when fatal errors are encountered.
1216 * When fatal errors are encountered while parsing a translation unit,
1217 * semantic analysis is typically stopped early when compiling code. A common
1218 * source for fatal errors are unresolvable include files. For the
1219 * purposes of an IDE, this is undesirable behavior and as much information
1220 * as possible should be reported. Use this flag to enable this behavior.
1222 CXTranslationUnit_KeepGoing = 0x200
1226 * \brief Returns the set of flags that is suitable for parsing a translation
1227 * unit that is being edited.
1229 * The set of flags returned provide options for \c clang_parseTranslationUnit()
1230 * to indicate that the translation unit is likely to be reparsed many times,
1231 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1232 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1233 * set contains an unspecified set of optimizations (e.g., the precompiled
1234 * preamble) geared toward improving the performance of these routines. The
1235 * set of optimizations enabled may change from one version to the next.
1237 CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
1240 * \brief Same as \c clang_parseTranslationUnit2, but returns
1241 * the \c CXTranslationUnit instead of an error code. In case of an error this
1242 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1245 CINDEX_LINKAGE CXTranslationUnit
1246 clang_parseTranslationUnit(CXIndex CIdx,
1247 const char *source_filename,
1248 const char *const *command_line_args,
1249 int num_command_line_args,
1250 struct CXUnsavedFile *unsaved_files,
1251 unsigned num_unsaved_files,
1255 * \brief Parse the given source file and the translation unit corresponding
1258 * This routine is the main entry point for the Clang C API, providing the
1259 * ability to parse a source file into a translation unit that can then be
1260 * queried by other functions in the API. This routine accepts a set of
1261 * command-line arguments so that the compilation can be configured in the same
1262 * way that the compiler is configured on the command line.
1264 * \param CIdx The index object with which the translation unit will be
1267 * \param source_filename The name of the source file to load, or NULL if the
1268 * source file is included in \c command_line_args.
1270 * \param command_line_args The command-line arguments that would be
1271 * passed to the \c clang executable if it were being invoked out-of-process.
1272 * These command-line options will be parsed and will affect how the translation
1273 * unit is parsed. Note that the following options are ignored: '-c',
1274 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1276 * \param num_command_line_args The number of command-line arguments in
1277 * \c command_line_args.
1279 * \param unsaved_files the files that have not yet been saved to disk
1280 * but may be required for parsing, including the contents of
1281 * those files. The contents and name of these files (as specified by
1282 * CXUnsavedFile) are copied when necessary, so the client only needs to
1283 * guarantee their validity until the call to this function returns.
1285 * \param num_unsaved_files the number of unsaved file entries in \p
1288 * \param options A bitmask of options that affects how the translation unit
1289 * is managed but not its compilation. This should be a bitwise OR of the
1290 * CXTranslationUnit_XXX flags.
1292 * \param[out] out_TU A non-NULL pointer to store the created
1293 * \c CXTranslationUnit, describing the parsed code and containing any
1294 * diagnostics produced by the compiler.
1296 * \returns Zero on success, otherwise returns an error code.
1298 CINDEX_LINKAGE enum CXErrorCode
1299 clang_parseTranslationUnit2(CXIndex CIdx,
1300 const char *source_filename,
1301 const char *const *command_line_args,
1302 int num_command_line_args,
1303 struct CXUnsavedFile *unsaved_files,
1304 unsigned num_unsaved_files,
1306 CXTranslationUnit *out_TU);
1309 * \brief Same as clang_parseTranslationUnit2 but requires a full command line
1310 * for \c command_line_args including argv[0]. This is useful if the standard
1311 * library paths are relative to the binary.
1313 CINDEX_LINKAGE enum CXErrorCode clang_parseTranslationUnit2FullArgv(
1314 CXIndex CIdx, const char *source_filename,
1315 const char *const *command_line_args, int num_command_line_args,
1316 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
1317 unsigned options, CXTranslationUnit *out_TU);
1320 * \brief Flags that control how translation units are saved.
1322 * The enumerators in this enumeration type are meant to be bitwise
1323 * ORed together to specify which options should be used when
1324 * saving the translation unit.
1326 enum CXSaveTranslationUnit_Flags {
1328 * \brief Used to indicate that no special saving options are needed.
1330 CXSaveTranslationUnit_None = 0x0
1334 * \brief Returns the set of flags that is suitable for saving a translation
1337 * The set of flags returned provide options for
1338 * \c clang_saveTranslationUnit() by default. The returned flag
1339 * set contains an unspecified set of options that save translation units with
1340 * the most commonly-requested data.
1342 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1345 * \brief Describes the kind of error that occurred (if any) in a call to
1346 * \c clang_saveTranslationUnit().
1350 * \brief Indicates that no error occurred while saving a translation unit.
1352 CXSaveError_None = 0,
1355 * \brief Indicates that an unknown error occurred while attempting to save
1358 * This error typically indicates that file I/O failed when attempting to
1361 CXSaveError_Unknown = 1,
1364 * \brief Indicates that errors during translation prevented this attempt
1365 * to save the translation unit.
1367 * Errors that prevent the translation unit from being saved can be
1368 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1370 CXSaveError_TranslationErrors = 2,
1373 * \brief Indicates that the translation unit to be saved was somehow
1374 * invalid (e.g., NULL).
1376 CXSaveError_InvalidTU = 3
1380 * \brief Saves a translation unit into a serialized representation of
1381 * that translation unit on disk.
1383 * Any translation unit that was parsed without error can be saved
1384 * into a file. The translation unit can then be deserialized into a
1385 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1386 * if it is an incomplete translation unit that corresponds to a
1387 * header, used as a precompiled header when parsing other translation
1390 * \param TU The translation unit to save.
1392 * \param FileName The file to which the translation unit will be saved.
1394 * \param options A bitmask of options that affects how the translation unit
1395 * is saved. This should be a bitwise OR of the
1396 * CXSaveTranslationUnit_XXX flags.
1398 * \returns A value that will match one of the enumerators of the CXSaveError
1399 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1400 * saved successfully, while a non-zero value indicates that a problem occurred.
1402 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1403 const char *FileName,
1407 * \brief Destroy the specified CXTranslationUnit object.
1409 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1412 * \brief Flags that control the reparsing of translation units.
1414 * The enumerators in this enumeration type are meant to be bitwise
1415 * ORed together to specify which options should be used when
1416 * reparsing the translation unit.
1418 enum CXReparse_Flags {
1420 * \brief Used to indicate that no special reparsing options are needed.
1422 CXReparse_None = 0x0
1426 * \brief Returns the set of flags that is suitable for reparsing a translation
1429 * The set of flags returned provide options for
1430 * \c clang_reparseTranslationUnit() by default. The returned flag
1431 * set contains an unspecified set of optimizations geared toward common uses
1432 * of reparsing. The set of optimizations enabled may change from one version
1435 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1438 * \brief Reparse the source files that produced this translation unit.
1440 * This routine can be used to re-parse the source files that originally
1441 * created the given translation unit, for example because those source files
1442 * have changed (either on disk or as passed via \p unsaved_files). The
1443 * source code will be reparsed with the same command-line options as it
1444 * was originally parsed.
1446 * Reparsing a translation unit invalidates all cursors and source locations
1447 * that refer into that translation unit. This makes reparsing a translation
1448 * unit semantically equivalent to destroying the translation unit and then
1449 * creating a new translation unit with the same command-line arguments.
1450 * However, it may be more efficient to reparse a translation
1451 * unit using this routine.
1453 * \param TU The translation unit whose contents will be re-parsed. The
1454 * translation unit must originally have been built with
1455 * \c clang_createTranslationUnitFromSourceFile().
1457 * \param num_unsaved_files The number of unsaved file entries in \p
1460 * \param unsaved_files The files that have not yet been saved to disk
1461 * but may be required for parsing, including the contents of
1462 * those files. The contents and name of these files (as specified by
1463 * CXUnsavedFile) are copied when necessary, so the client only needs to
1464 * guarantee their validity until the call to this function returns.
1466 * \param options A bitset of options composed of the flags in CXReparse_Flags.
1467 * The function \c clang_defaultReparseOptions() produces a default set of
1468 * options recommended for most uses, based on the translation unit.
1470 * \returns 0 if the sources could be reparsed. A non-zero error code will be
1471 * returned if reparsing was impossible, such that the translation unit is
1472 * invalid. In such cases, the only valid call for \c TU is
1473 * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1474 * routine are described by the \c CXErrorCode enum.
1476 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1477 unsigned num_unsaved_files,
1478 struct CXUnsavedFile *unsaved_files,
1482 * \brief Categorizes how memory is being used by a translation unit.
1484 enum CXTUResourceUsageKind {
1485 CXTUResourceUsage_AST = 1,
1486 CXTUResourceUsage_Identifiers = 2,
1487 CXTUResourceUsage_Selectors = 3,
1488 CXTUResourceUsage_GlobalCompletionResults = 4,
1489 CXTUResourceUsage_SourceManagerContentCache = 5,
1490 CXTUResourceUsage_AST_SideTables = 6,
1491 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
1492 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
1493 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
1494 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
1495 CXTUResourceUsage_Preprocessor = 11,
1496 CXTUResourceUsage_PreprocessingRecord = 12,
1497 CXTUResourceUsage_SourceManager_DataStructures = 13,
1498 CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
1499 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
1500 CXTUResourceUsage_MEMORY_IN_BYTES_END =
1501 CXTUResourceUsage_Preprocessor_HeaderSearch,
1503 CXTUResourceUsage_First = CXTUResourceUsage_AST,
1504 CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
1508 * \brief Returns the human-readable null-terminated C string that represents
1509 * the name of the memory category. This string should never be freed.
1512 const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
1514 typedef struct CXTUResourceUsageEntry {
1515 /* \brief The memory usage category. */
1516 enum CXTUResourceUsageKind kind;
1517 /* \brief Amount of resources used.
1518 The units will depend on the resource kind. */
1519 unsigned long amount;
1520 } CXTUResourceUsageEntry;
1523 * \brief The memory usage of a CXTranslationUnit, broken into categories.
1525 typedef struct CXTUResourceUsage {
1526 /* \brief Private data member, used for queries. */
1529 /* \brief The number of entries in the 'entries' array. */
1530 unsigned numEntries;
1532 /* \brief An array of key-value pairs, representing the breakdown of memory
1534 CXTUResourceUsageEntry *entries;
1536 } CXTUResourceUsage;
1539 * \brief Return the memory usage of a translation unit. This object
1540 * should be released with clang_disposeCXTUResourceUsage().
1542 CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
1544 CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
1551 * \brief Describes the kind of entity that a cursor refers to.
1556 * \brief A declaration whose specific kind is not exposed via this
1559 * Unexposed declarations have the same operations as any other kind
1560 * of declaration; one can extract their location information,
1561 * spelling, find their definitions, etc. However, the specific kind
1562 * of the declaration is not reported.
1564 CXCursor_UnexposedDecl = 1,
1565 /** \brief A C or C++ struct. */
1566 CXCursor_StructDecl = 2,
1567 /** \brief A C or C++ union. */
1568 CXCursor_UnionDecl = 3,
1569 /** \brief A C++ class. */
1570 CXCursor_ClassDecl = 4,
1571 /** \brief An enumeration. */
1572 CXCursor_EnumDecl = 5,
1574 * \brief A field (in C) or non-static data member (in C++) in a
1575 * struct, union, or C++ class.
1577 CXCursor_FieldDecl = 6,
1578 /** \brief An enumerator constant. */
1579 CXCursor_EnumConstantDecl = 7,
1580 /** \brief A function. */
1581 CXCursor_FunctionDecl = 8,
1582 /** \brief A variable. */
1583 CXCursor_VarDecl = 9,
1584 /** \brief A function or method parameter. */
1585 CXCursor_ParmDecl = 10,
1586 /** \brief An Objective-C \@interface. */
1587 CXCursor_ObjCInterfaceDecl = 11,
1588 /** \brief An Objective-C \@interface for a category. */
1589 CXCursor_ObjCCategoryDecl = 12,
1590 /** \brief An Objective-C \@protocol declaration. */
1591 CXCursor_ObjCProtocolDecl = 13,
1592 /** \brief An Objective-C \@property declaration. */
1593 CXCursor_ObjCPropertyDecl = 14,
1594 /** \brief An Objective-C instance variable. */
1595 CXCursor_ObjCIvarDecl = 15,
1596 /** \brief An Objective-C instance method. */
1597 CXCursor_ObjCInstanceMethodDecl = 16,
1598 /** \brief An Objective-C class method. */
1599 CXCursor_ObjCClassMethodDecl = 17,
1600 /** \brief An Objective-C \@implementation. */
1601 CXCursor_ObjCImplementationDecl = 18,
1602 /** \brief An Objective-C \@implementation for a category. */
1603 CXCursor_ObjCCategoryImplDecl = 19,
1604 /** \brief A typedef. */
1605 CXCursor_TypedefDecl = 20,
1606 /** \brief A C++ class method. */
1607 CXCursor_CXXMethod = 21,
1608 /** \brief A C++ namespace. */
1609 CXCursor_Namespace = 22,
1610 /** \brief A linkage specification, e.g. 'extern "C"'. */
1611 CXCursor_LinkageSpec = 23,
1612 /** \brief A C++ constructor. */
1613 CXCursor_Constructor = 24,
1614 /** \brief A C++ destructor. */
1615 CXCursor_Destructor = 25,
1616 /** \brief A C++ conversion function. */
1617 CXCursor_ConversionFunction = 26,
1618 /** \brief A C++ template type parameter. */
1619 CXCursor_TemplateTypeParameter = 27,
1620 /** \brief A C++ non-type template parameter. */
1621 CXCursor_NonTypeTemplateParameter = 28,
1622 /** \brief A C++ template template parameter. */
1623 CXCursor_TemplateTemplateParameter = 29,
1624 /** \brief A C++ function template. */
1625 CXCursor_FunctionTemplate = 30,
1626 /** \brief A C++ class template. */
1627 CXCursor_ClassTemplate = 31,
1628 /** \brief A C++ class template partial specialization. */
1629 CXCursor_ClassTemplatePartialSpecialization = 32,
1630 /** \brief A C++ namespace alias declaration. */
1631 CXCursor_NamespaceAlias = 33,
1632 /** \brief A C++ using directive. */
1633 CXCursor_UsingDirective = 34,
1634 /** \brief A C++ using declaration. */
1635 CXCursor_UsingDeclaration = 35,
1636 /** \brief A C++ alias declaration */
1637 CXCursor_TypeAliasDecl = 36,
1638 /** \brief An Objective-C \@synthesize definition. */
1639 CXCursor_ObjCSynthesizeDecl = 37,
1640 /** \brief An Objective-C \@dynamic definition. */
1641 CXCursor_ObjCDynamicDecl = 38,
1642 /** \brief An access specifier. */
1643 CXCursor_CXXAccessSpecifier = 39,
1645 CXCursor_FirstDecl = CXCursor_UnexposedDecl,
1646 CXCursor_LastDecl = CXCursor_CXXAccessSpecifier,
1649 CXCursor_FirstRef = 40, /* Decl references */
1650 CXCursor_ObjCSuperClassRef = 40,
1651 CXCursor_ObjCProtocolRef = 41,
1652 CXCursor_ObjCClassRef = 42,
1654 * \brief A reference to a type declaration.
1656 * A type reference occurs anywhere where a type is named but not
1657 * declared. For example, given:
1660 * typedef unsigned size_type;
1664 * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1665 * while the type of the variable "size" is referenced. The cursor
1666 * referenced by the type of size is the typedef for size_type.
1668 CXCursor_TypeRef = 43,
1669 CXCursor_CXXBaseSpecifier = 44,
1671 * \brief A reference to a class template, function template, template
1672 * template parameter, or class template partial specialization.
1674 CXCursor_TemplateRef = 45,
1676 * \brief A reference to a namespace or namespace alias.
1678 CXCursor_NamespaceRef = 46,
1680 * \brief A reference to a member of a struct, union, or class that occurs in
1681 * some non-expression context, e.g., a designated initializer.
1683 CXCursor_MemberRef = 47,
1685 * \brief A reference to a labeled statement.
1687 * This cursor kind is used to describe the jump to "start_over" in the
1688 * goto statement in the following example:
1697 * A label reference cursor refers to a label statement.
1699 CXCursor_LabelRef = 48,
1702 * \brief A reference to a set of overloaded functions or function templates
1703 * that has not yet been resolved to a specific function or function template.
1705 * An overloaded declaration reference cursor occurs in C++ templates where
1706 * a dependent name refers to a function. For example:
1709 * template<typename T> void swap(T&, T&);
1712 * void swap(X&, X&);
1714 * template<typename T>
1715 * void reverse(T* first, T* last) {
1716 * while (first < last - 1) {
1717 * swap(*first, *--last);
1723 * void swap(Y&, Y&);
1726 * Here, the identifier "swap" is associated with an overloaded declaration
1727 * reference. In the template definition, "swap" refers to either of the two
1728 * "swap" functions declared above, so both results will be available. At
1729 * instantiation time, "swap" may also refer to other functions found via
1730 * argument-dependent lookup (e.g., the "swap" function at the end of the
1733 * The functions \c clang_getNumOverloadedDecls() and
1734 * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1735 * referenced by this cursor.
1737 CXCursor_OverloadedDeclRef = 49,
1740 * \brief A reference to a variable that occurs in some non-expression
1741 * context, e.g., a C++ lambda capture list.
1743 CXCursor_VariableRef = 50,
1745 CXCursor_LastRef = CXCursor_VariableRef,
1747 /* Error conditions */
1748 CXCursor_FirstInvalid = 70,
1749 CXCursor_InvalidFile = 70,
1750 CXCursor_NoDeclFound = 71,
1751 CXCursor_NotImplemented = 72,
1752 CXCursor_InvalidCode = 73,
1753 CXCursor_LastInvalid = CXCursor_InvalidCode,
1756 CXCursor_FirstExpr = 100,
1759 * \brief An expression whose specific kind is not exposed via this
1762 * Unexposed expressions have the same operations as any other kind
1763 * of expression; one can extract their location information,
1764 * spelling, children, etc. However, the specific kind of the
1765 * expression is not reported.
1767 CXCursor_UnexposedExpr = 100,
1770 * \brief An expression that refers to some value declaration, such
1771 * as a function, variable, or enumerator.
1773 CXCursor_DeclRefExpr = 101,
1776 * \brief An expression that refers to a member of a struct, union,
1777 * class, Objective-C class, etc.
1779 CXCursor_MemberRefExpr = 102,
1781 /** \brief An expression that calls a function. */
1782 CXCursor_CallExpr = 103,
1784 /** \brief An expression that sends a message to an Objective-C
1786 CXCursor_ObjCMessageExpr = 104,
1788 /** \brief An expression that represents a block literal. */
1789 CXCursor_BlockExpr = 105,
1791 /** \brief An integer literal.
1793 CXCursor_IntegerLiteral = 106,
1795 /** \brief A floating point number literal.
1797 CXCursor_FloatingLiteral = 107,
1799 /** \brief An imaginary number literal.
1801 CXCursor_ImaginaryLiteral = 108,
1803 /** \brief A string literal.
1805 CXCursor_StringLiteral = 109,
1807 /** \brief A character literal.
1809 CXCursor_CharacterLiteral = 110,
1811 /** \brief A parenthesized expression, e.g. "(1)".
1813 * This AST node is only formed if full location information is requested.
1815 CXCursor_ParenExpr = 111,
1817 /** \brief This represents the unary-expression's (except sizeof and
1820 CXCursor_UnaryOperator = 112,
1822 /** \brief [C99 6.5.2.1] Array Subscripting.
1824 CXCursor_ArraySubscriptExpr = 113,
1826 /** \brief A builtin binary operation expression such as "x + y" or
1829 CXCursor_BinaryOperator = 114,
1831 /** \brief Compound assignment such as "+=".
1833 CXCursor_CompoundAssignOperator = 115,
1835 /** \brief The ?: ternary operator.
1837 CXCursor_ConditionalOperator = 116,
1839 /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1840 * (C++ [expr.cast]), which uses the syntax (Type)expr.
1842 * For example: (int)f.
1844 CXCursor_CStyleCastExpr = 117,
1846 /** \brief [C99 6.5.2.5]
1848 CXCursor_CompoundLiteralExpr = 118,
1850 /** \brief Describes an C or C++ initializer list.
1852 CXCursor_InitListExpr = 119,
1854 /** \brief The GNU address of label extension, representing &&label.
1856 CXCursor_AddrLabelExpr = 120,
1858 /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1860 CXCursor_StmtExpr = 121,
1862 /** \brief Represents a C11 generic selection.
1864 CXCursor_GenericSelectionExpr = 122,
1866 /** \brief Implements the GNU __null extension, which is a name for a null
1867 * pointer constant that has integral type (e.g., int or long) and is the same
1868 * size and alignment as a pointer.
1870 * The __null extension is typically only used by system headers, which define
1871 * NULL as __null in C++ rather than using 0 (which is an integer that may not
1872 * match the size of a pointer).
1874 CXCursor_GNUNullExpr = 123,
1876 /** \brief C++'s static_cast<> expression.
1878 CXCursor_CXXStaticCastExpr = 124,
1880 /** \brief C++'s dynamic_cast<> expression.
1882 CXCursor_CXXDynamicCastExpr = 125,
1884 /** \brief C++'s reinterpret_cast<> expression.
1886 CXCursor_CXXReinterpretCastExpr = 126,
1888 /** \brief C++'s const_cast<> expression.
1890 CXCursor_CXXConstCastExpr = 127,
1892 /** \brief Represents an explicit C++ type conversion that uses "functional"
1893 * notion (C++ [expr.type.conv]).
1900 CXCursor_CXXFunctionalCastExpr = 128,
1902 /** \brief A C++ typeid expression (C++ [expr.typeid]).
1904 CXCursor_CXXTypeidExpr = 129,
1906 /** \brief [C++ 2.13.5] C++ Boolean Literal.
1908 CXCursor_CXXBoolLiteralExpr = 130,
1910 /** \brief [C++0x 2.14.7] C++ Pointer Literal.
1912 CXCursor_CXXNullPtrLiteralExpr = 131,
1914 /** \brief Represents the "this" expression in C++
1916 CXCursor_CXXThisExpr = 132,
1918 /** \brief [C++ 15] C++ Throw Expression.
1920 * This handles 'throw' and 'throw' assignment-expression. When
1921 * assignment-expression isn't present, Op will be null.
1923 CXCursor_CXXThrowExpr = 133,
1925 /** \brief A new expression for memory allocation and constructor calls, e.g:
1926 * "new CXXNewExpr(foo)".
1928 CXCursor_CXXNewExpr = 134,
1930 /** \brief A delete expression for memory deallocation and destructor calls,
1931 * e.g. "delete[] pArray".
1933 CXCursor_CXXDeleteExpr = 135,
1935 /** \brief A unary expression. (noexcept, sizeof, or other traits)
1937 CXCursor_UnaryExpr = 136,
1939 /** \brief An Objective-C string literal i.e. @"foo".
1941 CXCursor_ObjCStringLiteral = 137,
1943 /** \brief An Objective-C \@encode expression.
1945 CXCursor_ObjCEncodeExpr = 138,
1947 /** \brief An Objective-C \@selector expression.
1949 CXCursor_ObjCSelectorExpr = 139,
1951 /** \brief An Objective-C \@protocol expression.
1953 CXCursor_ObjCProtocolExpr = 140,
1955 /** \brief An Objective-C "bridged" cast expression, which casts between
1956 * Objective-C pointers and C pointers, transferring ownership in the process.
1959 * NSString *str = (__bridge_transfer NSString *)CFCreateString();
1962 CXCursor_ObjCBridgedCastExpr = 141,
1964 /** \brief Represents a C++0x pack expansion that produces a sequence of
1967 * A pack expansion expression contains a pattern (which itself is an
1968 * expression) followed by an ellipsis. For example:
1971 * template<typename F, typename ...Types>
1972 * void forward(F f, Types &&...args) {
1973 * f(static_cast<Types&&>(args)...);
1977 CXCursor_PackExpansionExpr = 142,
1979 /** \brief Represents an expression that computes the length of a parameter
1983 * template<typename ...Types>
1985 * static const unsigned value = sizeof...(Types);
1989 CXCursor_SizeOfPackExpr = 143,
1991 /* \brief Represents a C++ lambda expression that produces a local function
1995 * void abssort(float *x, unsigned N) {
1996 * std::sort(x, x + N,
1997 * [](float a, float b) {
1998 * return std::abs(a) < std::abs(b);
2003 CXCursor_LambdaExpr = 144,
2005 /** \brief Objective-c Boolean Literal.
2007 CXCursor_ObjCBoolLiteralExpr = 145,
2009 /** \brief Represents the "self" expression in an Objective-C method.
2011 CXCursor_ObjCSelfExpr = 146,
2013 /** \brief OpenMP 4.0 [2.4, Array Section].
2015 CXCursor_OMPArraySectionExpr = 147,
2017 /** \brief Represents an @available(...) check.
2019 CXCursor_ObjCAvailabilityCheckExpr = 148,
2021 CXCursor_LastExpr = CXCursor_ObjCAvailabilityCheckExpr,
2024 CXCursor_FirstStmt = 200,
2026 * \brief A statement whose specific kind is not exposed via this
2029 * Unexposed statements have the same operations as any other kind of
2030 * statement; one can extract their location information, spelling,
2031 * children, etc. However, the specific kind of the statement is not
2034 CXCursor_UnexposedStmt = 200,
2036 /** \brief A labelled statement in a function.
2038 * This cursor kind is used to describe the "start_over:" label statement in
2039 * the following example:
2047 CXCursor_LabelStmt = 201,
2049 /** \brief A group of statements like { stmt stmt }.
2051 * This cursor kind is used to describe compound statements, e.g. function
2054 CXCursor_CompoundStmt = 202,
2056 /** \brief A case statement.
2058 CXCursor_CaseStmt = 203,
2060 /** \brief A default statement.
2062 CXCursor_DefaultStmt = 204,
2064 /** \brief An if statement
2066 CXCursor_IfStmt = 205,
2068 /** \brief A switch statement.
2070 CXCursor_SwitchStmt = 206,
2072 /** \brief A while statement.
2074 CXCursor_WhileStmt = 207,
2076 /** \brief A do statement.
2078 CXCursor_DoStmt = 208,
2080 /** \brief A for statement.
2082 CXCursor_ForStmt = 209,
2084 /** \brief A goto statement.
2086 CXCursor_GotoStmt = 210,
2088 /** \brief An indirect goto statement.
2090 CXCursor_IndirectGotoStmt = 211,
2092 /** \brief A continue statement.
2094 CXCursor_ContinueStmt = 212,
2096 /** \brief A break statement.
2098 CXCursor_BreakStmt = 213,
2100 /** \brief A return statement.
2102 CXCursor_ReturnStmt = 214,
2104 /** \brief A GCC inline assembly statement extension.
2106 CXCursor_GCCAsmStmt = 215,
2107 CXCursor_AsmStmt = CXCursor_GCCAsmStmt,
2109 /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2111 CXCursor_ObjCAtTryStmt = 216,
2113 /** \brief Objective-C's \@catch statement.
2115 CXCursor_ObjCAtCatchStmt = 217,
2117 /** \brief Objective-C's \@finally statement.
2119 CXCursor_ObjCAtFinallyStmt = 218,
2121 /** \brief Objective-C's \@throw statement.
2123 CXCursor_ObjCAtThrowStmt = 219,
2125 /** \brief Objective-C's \@synchronized statement.
2127 CXCursor_ObjCAtSynchronizedStmt = 220,
2129 /** \brief Objective-C's autorelease pool statement.
2131 CXCursor_ObjCAutoreleasePoolStmt = 221,
2133 /** \brief Objective-C's collection statement.
2135 CXCursor_ObjCForCollectionStmt = 222,
2137 /** \brief C++'s catch statement.
2139 CXCursor_CXXCatchStmt = 223,
2141 /** \brief C++'s try statement.
2143 CXCursor_CXXTryStmt = 224,
2145 /** \brief C++'s for (* : *) statement.
2147 CXCursor_CXXForRangeStmt = 225,
2149 /** \brief Windows Structured Exception Handling's try statement.
2151 CXCursor_SEHTryStmt = 226,
2153 /** \brief Windows Structured Exception Handling's except statement.
2155 CXCursor_SEHExceptStmt = 227,
2157 /** \brief Windows Structured Exception Handling's finally statement.
2159 CXCursor_SEHFinallyStmt = 228,
2161 /** \brief A MS inline assembly statement extension.
2163 CXCursor_MSAsmStmt = 229,
2165 /** \brief The null statement ";": C99 6.8.3p3.
2167 * This cursor kind is used to describe the null statement.
2169 CXCursor_NullStmt = 230,
2171 /** \brief Adaptor class for mixing declarations with statements and
2174 CXCursor_DeclStmt = 231,
2176 /** \brief OpenMP parallel directive.
2178 CXCursor_OMPParallelDirective = 232,
2180 /** \brief OpenMP SIMD directive.
2182 CXCursor_OMPSimdDirective = 233,
2184 /** \brief OpenMP for directive.
2186 CXCursor_OMPForDirective = 234,
2188 /** \brief OpenMP sections directive.
2190 CXCursor_OMPSectionsDirective = 235,
2192 /** \brief OpenMP section directive.
2194 CXCursor_OMPSectionDirective = 236,
2196 /** \brief OpenMP single directive.
2198 CXCursor_OMPSingleDirective = 237,
2200 /** \brief OpenMP parallel for directive.
2202 CXCursor_OMPParallelForDirective = 238,
2204 /** \brief OpenMP parallel sections directive.
2206 CXCursor_OMPParallelSectionsDirective = 239,
2208 /** \brief OpenMP task directive.
2210 CXCursor_OMPTaskDirective = 240,
2212 /** \brief OpenMP master directive.
2214 CXCursor_OMPMasterDirective = 241,
2216 /** \brief OpenMP critical directive.
2218 CXCursor_OMPCriticalDirective = 242,
2220 /** \brief OpenMP taskyield directive.
2222 CXCursor_OMPTaskyieldDirective = 243,
2224 /** \brief OpenMP barrier directive.
2226 CXCursor_OMPBarrierDirective = 244,
2228 /** \brief OpenMP taskwait directive.
2230 CXCursor_OMPTaskwaitDirective = 245,
2232 /** \brief OpenMP flush directive.
2234 CXCursor_OMPFlushDirective = 246,
2236 /** \brief Windows Structured Exception Handling's leave statement.
2238 CXCursor_SEHLeaveStmt = 247,
2240 /** \brief OpenMP ordered directive.
2242 CXCursor_OMPOrderedDirective = 248,
2244 /** \brief OpenMP atomic directive.
2246 CXCursor_OMPAtomicDirective = 249,
2248 /** \brief OpenMP for SIMD directive.
2250 CXCursor_OMPForSimdDirective = 250,
2252 /** \brief OpenMP parallel for SIMD directive.
2254 CXCursor_OMPParallelForSimdDirective = 251,
2256 /** \brief OpenMP target directive.
2258 CXCursor_OMPTargetDirective = 252,
2260 /** \brief OpenMP teams directive.
2262 CXCursor_OMPTeamsDirective = 253,
2264 /** \brief OpenMP taskgroup directive.
2266 CXCursor_OMPTaskgroupDirective = 254,
2268 /** \brief OpenMP cancellation point directive.
2270 CXCursor_OMPCancellationPointDirective = 255,
2272 /** \brief OpenMP cancel directive.
2274 CXCursor_OMPCancelDirective = 256,
2276 /** \brief OpenMP target data directive.
2278 CXCursor_OMPTargetDataDirective = 257,
2280 /** \brief OpenMP taskloop directive.
2282 CXCursor_OMPTaskLoopDirective = 258,
2284 /** \brief OpenMP taskloop simd directive.
2286 CXCursor_OMPTaskLoopSimdDirective = 259,
2288 /** \brief OpenMP distribute directive.
2290 CXCursor_OMPDistributeDirective = 260,
2292 /** \brief OpenMP target enter data directive.
2294 CXCursor_OMPTargetEnterDataDirective = 261,
2296 /** \brief OpenMP target exit data directive.
2298 CXCursor_OMPTargetExitDataDirective = 262,
2300 /** \brief OpenMP target parallel directive.
2302 CXCursor_OMPTargetParallelDirective = 263,
2304 /** \brief OpenMP target parallel for directive.
2306 CXCursor_OMPTargetParallelForDirective = 264,
2308 /** \brief OpenMP target update directive.
2310 CXCursor_OMPTargetUpdateDirective = 265,
2312 /** \brief OpenMP distribute parallel for directive.
2314 CXCursor_OMPDistributeParallelForDirective = 266,
2316 /** \brief OpenMP distribute parallel for simd directive.
2318 CXCursor_OMPDistributeParallelForSimdDirective = 267,
2320 /** \brief OpenMP distribute simd directive.
2322 CXCursor_OMPDistributeSimdDirective = 268,
2324 /** \brief OpenMP target parallel for simd directive.
2326 CXCursor_OMPTargetParallelForSimdDirective = 269,
2328 CXCursor_LastStmt = CXCursor_OMPTargetParallelForSimdDirective,
2331 * \brief Cursor that represents the translation unit itself.
2333 * The translation unit cursor exists primarily to act as the root
2334 * cursor for traversing the contents of a translation unit.
2336 CXCursor_TranslationUnit = 300,
2339 CXCursor_FirstAttr = 400,
2341 * \brief An attribute whose specific kind is not exposed via this
2344 CXCursor_UnexposedAttr = 400,
2346 CXCursor_IBActionAttr = 401,
2347 CXCursor_IBOutletAttr = 402,
2348 CXCursor_IBOutletCollectionAttr = 403,
2349 CXCursor_CXXFinalAttr = 404,
2350 CXCursor_CXXOverrideAttr = 405,
2351 CXCursor_AnnotateAttr = 406,
2352 CXCursor_AsmLabelAttr = 407,
2353 CXCursor_PackedAttr = 408,
2354 CXCursor_PureAttr = 409,
2355 CXCursor_ConstAttr = 410,
2356 CXCursor_NoDuplicateAttr = 411,
2357 CXCursor_CUDAConstantAttr = 412,
2358 CXCursor_CUDADeviceAttr = 413,
2359 CXCursor_CUDAGlobalAttr = 414,
2360 CXCursor_CUDAHostAttr = 415,
2361 CXCursor_CUDASharedAttr = 416,
2362 CXCursor_VisibilityAttr = 417,
2363 CXCursor_DLLExport = 418,
2364 CXCursor_DLLImport = 419,
2365 CXCursor_LastAttr = CXCursor_DLLImport,
2368 CXCursor_PreprocessingDirective = 500,
2369 CXCursor_MacroDefinition = 501,
2370 CXCursor_MacroExpansion = 502,
2371 CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
2372 CXCursor_InclusionDirective = 503,
2373 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
2374 CXCursor_LastPreprocessing = CXCursor_InclusionDirective,
2376 /* Extra Declarations */
2378 * \brief A module import declaration.
2380 CXCursor_ModuleImportDecl = 600,
2381 CXCursor_TypeAliasTemplateDecl = 601,
2383 * \brief A static_assert or _Static_assert node
2385 CXCursor_StaticAssert = 602,
2386 CXCursor_FirstExtraDecl = CXCursor_ModuleImportDecl,
2387 CXCursor_LastExtraDecl = CXCursor_StaticAssert,
2390 * \brief A code completion overload candidate.
2392 CXCursor_OverloadCandidate = 700
2396 * \brief A cursor representing some element in the abstract syntax tree for
2397 * a translation unit.
2399 * The cursor abstraction unifies the different kinds of entities in a
2400 * program--declaration, statements, expressions, references to declarations,
2401 * etc.--under a single "cursor" abstraction with a common set of operations.
2402 * Common operation for a cursor include: getting the physical location in
2403 * a source file where the cursor points, getting the name associated with a
2404 * cursor, and retrieving cursors for any child nodes of a particular cursor.
2406 * Cursors can be produced in two specific ways.
2407 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2408 * from which one can use clang_visitChildren() to explore the rest of the
2409 * translation unit. clang_getCursor() maps from a physical source location
2410 * to the entity that resides at that location, allowing one to map from the
2411 * source code into the AST.
2414 enum CXCursorKind kind;
2416 const void *data[3];
2420 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2426 * \brief Retrieve the NULL cursor, which represents no entity.
2428 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
2431 * \brief Retrieve the cursor that represents the given translation unit.
2433 * The translation unit cursor can be used to start traversing the
2434 * various declarations within the given translation unit.
2436 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
2439 * \brief Determine whether two cursors are equivalent.
2441 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
2444 * \brief Returns non-zero if \p cursor is null.
2446 CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
2449 * \brief Compute a hash value for the given cursor.
2451 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
2454 * \brief Retrieve the kind of the given cursor.
2456 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
2459 * \brief Determine whether the given cursor kind represents a declaration.
2461 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
2464 * \brief Determine whether the given cursor kind represents a simple
2467 * Note that other kinds of cursors (such as expressions) can also refer to
2468 * other cursors. Use clang_getCursorReferenced() to determine whether a
2469 * particular cursor refers to another entity.
2471 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
2474 * \brief Determine whether the given cursor kind represents an expression.
2476 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
2479 * \brief Determine whether the given cursor kind represents a statement.
2481 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
2484 * \brief Determine whether the given cursor kind represents an attribute.
2486 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
2489 * \brief Determine whether the given cursor has any attributes.
2491 CINDEX_LINKAGE unsigned clang_Cursor_hasAttrs(CXCursor C);
2494 * \brief Determine whether the given cursor kind represents an invalid
2497 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
2500 * \brief Determine whether the given cursor kind represents a translation
2503 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
2506 * \brief Determine whether the given cursor represents a preprocessing
2507 * element, such as a preprocessor directive or macro instantiation.
2509 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
2512 * \brief Determine whether the given cursor represents a currently
2513 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2515 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
2518 * \brief Describe the linkage of the entity referred to by a cursor.
2520 enum CXLinkageKind {
2521 /** \brief This value indicates that no linkage information is available
2522 * for a provided CXCursor. */
2525 * \brief This is the linkage for variables, parameters, and so on that
2526 * have automatic storage. This covers normal (non-extern) local variables.
2528 CXLinkage_NoLinkage,
2529 /** \brief This is the linkage for static variables and static functions. */
2531 /** \brief This is the linkage for entities with external linkage that live
2532 * in C++ anonymous namespaces.*/
2533 CXLinkage_UniqueExternal,
2534 /** \brief This is the linkage for entities with true, external linkage. */
2539 * \brief Determine the linkage of the entity referred to by a given cursor.
2541 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
2543 enum CXVisibilityKind {
2544 /** \brief This value indicates that no visibility information is available
2545 * for a provided CXCursor. */
2546 CXVisibility_Invalid,
2548 /** \brief Symbol not seen by the linker. */
2549 CXVisibility_Hidden,
2550 /** \brief Symbol seen by the linker but resolves to a symbol inside this object. */
2551 CXVisibility_Protected,
2552 /** \brief Symbol seen by the linker and acts like a normal symbol. */
2553 CXVisibility_Default
2557 * \brief Describe the visibility of the entity referred to by a cursor.
2559 * This returns the default visibility if not explicitly specified by
2560 * a visibility attribute. The default visibility may be changed by
2561 * commandline arguments.
2563 * \param cursor The cursor to query.
2565 * \returns The visibility of the cursor.
2567 CINDEX_LINKAGE enum CXVisibilityKind clang_getCursorVisibility(CXCursor cursor);
2570 * \brief Determine the availability of the entity that this cursor refers to,
2571 * taking the current target platform into account.
2573 * \param cursor The cursor to query.
2575 * \returns The availability of the cursor.
2577 CINDEX_LINKAGE enum CXAvailabilityKind
2578 clang_getCursorAvailability(CXCursor cursor);
2581 * Describes the availability of a given entity on a particular platform, e.g.,
2582 * a particular class might only be available on Mac OS 10.7 or newer.
2584 typedef struct CXPlatformAvailability {
2586 * \brief A string that describes the platform for which this structure
2587 * provides availability information.
2589 * Possible values are "ios" or "macos".
2593 * \brief The version number in which this entity was introduced.
2595 CXVersion Introduced;
2597 * \brief The version number in which this entity was deprecated (but is
2600 CXVersion Deprecated;
2602 * \brief The version number in which this entity was obsoleted, and therefore
2603 * is no longer available.
2605 CXVersion Obsoleted;
2607 * \brief Whether the entity is unconditionally unavailable on this platform.
2611 * \brief An optional message to provide to a user of this API, e.g., to
2612 * suggest replacement APIs.
2615 } CXPlatformAvailability;
2618 * \brief Determine the availability of the entity that this cursor refers to
2619 * on any platforms for which availability information is known.
2621 * \param cursor The cursor to query.
2623 * \param always_deprecated If non-NULL, will be set to indicate whether the
2624 * entity is deprecated on all platforms.
2626 * \param deprecated_message If non-NULL, will be set to the message text
2627 * provided along with the unconditional deprecation of this entity. The client
2628 * is responsible for deallocating this string.
2630 * \param always_unavailable If non-NULL, will be set to indicate whether the
2631 * entity is unavailable on all platforms.
2633 * \param unavailable_message If non-NULL, will be set to the message text
2634 * provided along with the unconditional unavailability of this entity. The
2635 * client is responsible for deallocating this string.
2637 * \param availability If non-NULL, an array of CXPlatformAvailability instances
2638 * that will be populated with platform availability information, up to either
2639 * the number of platforms for which availability information is available (as
2640 * returned by this function) or \c availability_size, whichever is smaller.
2642 * \param availability_size The number of elements available in the
2643 * \c availability array.
2645 * \returns The number of platforms (N) for which availability information is
2646 * available (which is unrelated to \c availability_size).
2648 * Note that the client is responsible for calling
2649 * \c clang_disposeCXPlatformAvailability to free each of the
2650 * platform-availability structures returned. There are
2651 * \c min(N, availability_size) such structures.
2654 clang_getCursorPlatformAvailability(CXCursor cursor,
2655 int *always_deprecated,
2656 CXString *deprecated_message,
2657 int *always_unavailable,
2658 CXString *unavailable_message,
2659 CXPlatformAvailability *availability,
2660 int availability_size);
2663 * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2666 clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
2669 * \brief Describe the "language" of the entity referred to by a cursor.
2671 enum CXLanguageKind {
2672 CXLanguage_Invalid = 0,
2675 CXLanguage_CPlusPlus
2679 * \brief Determine the "language" of the entity referred to by a given cursor.
2681 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
2684 * \brief Returns the translation unit that a cursor originated from.
2686 CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
2689 * \brief A fast container representing a set of CXCursors.
2691 typedef struct CXCursorSetImpl *CXCursorSet;
2694 * \brief Creates an empty CXCursorSet.
2696 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2699 * \brief Disposes a CXCursorSet and releases its associated memory.
2701 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2704 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2706 * \returns non-zero if the set contains the specified cursor.
2708 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2712 * \brief Inserts a CXCursor into a CXCursorSet.
2714 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2716 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2720 * \brief Determine the semantic parent of the given cursor.
2722 * The semantic parent of a cursor is the cursor that semantically contains
2723 * the given \p cursor. For many declarations, the lexical and semantic parents
2724 * are equivalent (the lexical parent is returned by
2725 * \c clang_getCursorLexicalParent()). They diverge when declarations or
2726 * definitions are provided out-of-line. For example:
2736 * In the out-of-line definition of \c C::f, the semantic parent is
2737 * the class \c C, of which this function is a member. The lexical parent is
2738 * the place where the declaration actually occurs in the source code; in this
2739 * case, the definition occurs in the translation unit. In general, the
2740 * lexical parent for a given entity can change without affecting the semantics
2741 * of the program, and the lexical parent of different declarations of the
2742 * same entity may be different. Changing the semantic parent of a declaration,
2743 * on the other hand, can have a major impact on semantics, and redeclarations
2744 * of a particular entity should all have the same semantic context.
2746 * In the example above, both declarations of \c C::f have \c C as their
2747 * semantic context, while the lexical context of the first \c C::f is \c C
2748 * and the lexical context of the second \c C::f is the translation unit.
2750 * For global declarations, the semantic parent is the translation unit.
2752 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
2755 * \brief Determine the lexical parent of the given cursor.
2757 * The lexical parent of a cursor is the cursor in which the given \p cursor
2758 * was actually written. For many declarations, the lexical and semantic parents
2759 * are equivalent (the semantic parent is returned by
2760 * \c clang_getCursorSemanticParent()). They diverge when declarations or
2761 * definitions are provided out-of-line. For example:
2771 * In the out-of-line definition of \c C::f, the semantic parent is
2772 * the class \c C, of which this function is a member. The lexical parent is
2773 * the place where the declaration actually occurs in the source code; in this
2774 * case, the definition occurs in the translation unit. In general, the
2775 * lexical parent for a given entity can change without affecting the semantics
2776 * of the program, and the lexical parent of different declarations of the
2777 * same entity may be different. Changing the semantic parent of a declaration,
2778 * on the other hand, can have a major impact on semantics, and redeclarations
2779 * of a particular entity should all have the same semantic context.
2781 * In the example above, both declarations of \c C::f have \c C as their
2782 * semantic context, while the lexical context of the first \c C::f is \c C
2783 * and the lexical context of the second \c C::f is the translation unit.
2785 * For declarations written in the global scope, the lexical parent is
2786 * the translation unit.
2788 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
2791 * \brief Determine the set of methods that are overridden by the given
2794 * In both Objective-C and C++, a method (aka virtual member function,
2795 * in C++) can override a virtual method in a base class. For
2796 * Objective-C, a method is said to override any method in the class's
2797 * base class, its protocols, or its categories' protocols, that has the same
2798 * selector and is of the same kind (class or instance).
2799 * If no such method exists, the search continues to the class's superclass,
2800 * its protocols, and its categories, and so on. A method from an Objective-C
2801 * implementation is considered to override the same methods as its
2802 * corresponding method in the interface.
2804 * For C++, a virtual member function overrides any virtual member
2805 * function with the same signature that occurs in its base
2806 * classes. With multiple inheritance, a virtual member function can
2807 * override several virtual member functions coming from different
2810 * In all cases, this function determines the immediate overridden
2811 * method, rather than all of the overridden methods. For example, if
2812 * a method is originally declared in a class A, then overridden in B
2813 * (which in inherits from A) and also in C (which inherited from B),
2814 * then the only overridden method returned from this function when
2815 * invoked on C's method will be B's method. The client may then
2816 * invoke this function again, given the previously-found overridden
2817 * methods, to map out the complete method-override set.
2819 * \param cursor A cursor representing an Objective-C or C++
2820 * method. This routine will compute the set of methods that this
2823 * \param overridden A pointer whose pointee will be replaced with a
2824 * pointer to an array of cursors, representing the set of overridden
2825 * methods. If there are no overridden methods, the pointee will be
2826 * set to NULL. The pointee must be freed via a call to
2827 * \c clang_disposeOverriddenCursors().
2829 * \param num_overridden A pointer to the number of overridden
2830 * functions, will be set to the number of overridden functions in the
2831 * array pointed to by \p overridden.
2833 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
2834 CXCursor **overridden,
2835 unsigned *num_overridden);
2838 * \brief Free the set of overridden cursors returned by \c
2839 * clang_getOverriddenCursors().
2841 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
2844 * \brief Retrieve the file that is included by the given inclusion directive
2847 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
2854 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2856 * Cursors represent a location within the Abstract Syntax Tree (AST). These
2857 * routines help map between cursors and the physical locations where the
2858 * described entities occur in the source code. The mapping is provided in
2859 * both directions, so one can map from source code to the AST and back.
2865 * \brief Map a source location to the cursor that describes the entity at that
2866 * location in the source code.
2868 * clang_getCursor() maps an arbitrary source location within a translation
2869 * unit down to the most specific cursor that describes the entity at that
2870 * location. For example, given an expression \c x + y, invoking
2871 * clang_getCursor() with a source location pointing to "x" will return the
2872 * cursor for "x"; similarly for "y". If the cursor points anywhere between
2873 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2874 * will return a cursor referring to the "+" expression.
2876 * \returns a cursor representing the entity at the given source location, or
2877 * a NULL cursor if no such entity can be found.
2879 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
2882 * \brief Retrieve the physical location of the source constructor referenced
2883 * by the given cursor.
2885 * The location of a declaration is typically the location of the name of that
2886 * declaration, where the name of that declaration would occur if it is
2887 * unnamed, or some keyword that introduces that particular declaration.
2888 * The location of a reference is where that reference occurs within the
2891 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
2894 * \brief Retrieve the physical extent of the source construct referenced by
2897 * The extent of a cursor starts with the file/line/column pointing at the
2898 * first character within the source construct that the cursor refers to and
2899 * ends with the last character within that source construct. For a
2900 * declaration, the extent covers the declaration itself. For a reference,
2901 * the extent covers the location of the reference (e.g., where the referenced
2902 * entity was actually used).
2904 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
2911 * \defgroup CINDEX_TYPES Type information for CXCursors
2917 * \brief Describes the kind of type
2921 * \brief Represents an invalid type (e.g., where no type is available).
2926 * \brief A type whose specific kind is not exposed via this
2929 CXType_Unexposed = 1,
2941 CXType_ULongLong = 11,
2942 CXType_UInt128 = 12,
2949 CXType_LongLong = 19,
2953 CXType_LongDouble = 23,
2954 CXType_NullPtr = 24,
2955 CXType_Overload = 25,
2956 CXType_Dependent = 26,
2958 CXType_ObjCClass = 28,
2959 CXType_ObjCSel = 29,
2960 CXType_Float128 = 30,
2961 CXType_FirstBuiltin = CXType_Void,
2962 CXType_LastBuiltin = CXType_ObjCSel,
2964 CXType_Complex = 100,
2965 CXType_Pointer = 101,
2966 CXType_BlockPointer = 102,
2967 CXType_LValueReference = 103,
2968 CXType_RValueReference = 104,
2969 CXType_Record = 105,
2971 CXType_Typedef = 107,
2972 CXType_ObjCInterface = 108,
2973 CXType_ObjCObjectPointer = 109,
2974 CXType_FunctionNoProto = 110,
2975 CXType_FunctionProto = 111,
2976 CXType_ConstantArray = 112,
2977 CXType_Vector = 113,
2978 CXType_IncompleteArray = 114,
2979 CXType_VariableArray = 115,
2980 CXType_DependentSizedArray = 116,
2981 CXType_MemberPointer = 117,
2985 * \brief Represents a type that was referred to using an elaborated type keyword.
2987 * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
2989 CXType_Elaborated = 119
2993 * \brief Describes the calling convention of a function type
2995 enum CXCallingConv {
2996 CXCallingConv_Default = 0,
2997 CXCallingConv_C = 1,
2998 CXCallingConv_X86StdCall = 2,
2999 CXCallingConv_X86FastCall = 3,
3000 CXCallingConv_X86ThisCall = 4,
3001 CXCallingConv_X86Pascal = 5,
3002 CXCallingConv_AAPCS = 6,
3003 CXCallingConv_AAPCS_VFP = 7,
3004 /* Value 8 was PnaclCall, but it was never used, so it could safely be re-used. */
3005 CXCallingConv_IntelOclBicc = 9,
3006 CXCallingConv_X86_64Win64 = 10,
3007 CXCallingConv_X86_64SysV = 11,
3008 CXCallingConv_X86VectorCall = 12,
3009 CXCallingConv_Swift = 13,
3010 CXCallingConv_PreserveMost = 14,
3011 CXCallingConv_PreserveAll = 15,
3013 CXCallingConv_Invalid = 100,
3014 CXCallingConv_Unexposed = 200
3018 * \brief The type of an element in the abstract syntax tree.
3022 enum CXTypeKind kind;
3027 * \brief Retrieve the type of a CXCursor (if any).
3029 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
3032 * \brief Pretty-print the underlying type using the rules of the
3033 * language of the translation unit from which it came.
3035 * If the type is invalid, an empty string is returned.
3037 CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
3040 * \brief Retrieve the underlying type of a typedef declaration.
3042 * If the cursor does not reference a typedef declaration, an invalid type is
3045 CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
3048 * \brief Retrieve the integer type of an enum declaration.
3050 * If the cursor does not reference an enum declaration, an invalid type is
3053 CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
3056 * \brief Retrieve the integer value of an enum constant declaration as a signed
3059 * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
3060 * Since this is also potentially a valid constant value, the kind of the cursor
3061 * must be verified before calling this function.
3063 CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C);
3066 * \brief Retrieve the integer value of an enum constant declaration as an unsigned
3069 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
3070 * Since this is also potentially a valid constant value, the kind of the cursor
3071 * must be verified before calling this function.
3073 CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C);
3076 * \brief Retrieve the bit width of a bit field declaration as an integer.
3078 * If a cursor that is not a bit field declaration is passed in, -1 is returned.
3080 CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
3083 * \brief Retrieve the number of non-variadic arguments associated with a given
3086 * The number of arguments can be determined for calls as well as for
3087 * declarations of functions or methods. For other cursors -1 is returned.
3089 CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
3092 * \brief Retrieve the argument cursor of a function or method.
3094 * The argument cursor can be determined for calls as well as for declarations
3095 * of functions or methods. For other cursors and for invalid indices, an
3096 * invalid cursor is returned.
3098 CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
3101 * \brief Describes the kind of a template argument.
3103 * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3104 * element descriptions.
3106 enum CXTemplateArgumentKind {
3107 CXTemplateArgumentKind_Null,
3108 CXTemplateArgumentKind_Type,
3109 CXTemplateArgumentKind_Declaration,
3110 CXTemplateArgumentKind_NullPtr,
3111 CXTemplateArgumentKind_Integral,
3112 CXTemplateArgumentKind_Template,
3113 CXTemplateArgumentKind_TemplateExpansion,
3114 CXTemplateArgumentKind_Expression,
3115 CXTemplateArgumentKind_Pack,
3116 /* Indicates an error case, preventing the kind from being deduced. */
3117 CXTemplateArgumentKind_Invalid
3121 *\brief Returns the number of template args of a function decl representing a
3122 * template specialization.
3124 * If the argument cursor cannot be converted into a template function
3125 * declaration, -1 is returned.
3127 * For example, for the following declaration and specialization:
3128 * template <typename T, int kInt, bool kBool>
3129 * void foo() { ... }
3132 * void foo<float, -7, true>();
3134 * The value 3 would be returned from this call.
3136 CINDEX_LINKAGE int clang_Cursor_getNumTemplateArguments(CXCursor C);
3139 * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3141 * If the argument CXCursor does not represent a FunctionDecl, an invalid
3142 * template argument kind is returned.
3144 * For example, for the following declaration and specialization:
3145 * template <typename T, int kInt, bool kBool>
3146 * void foo() { ... }
3149 * void foo<float, -7, true>();
3151 * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3154 CINDEX_LINKAGE enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(
3155 CXCursor C, unsigned I);
3158 * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3159 * function decl representing a template specialization.
3161 * If the argument CXCursor does not represent a FunctionDecl whose I'th
3162 * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3165 * For example, for the following declaration and specialization:
3166 * template <typename T, int kInt, bool kBool>
3167 * void foo() { ... }
3170 * void foo<float, -7, true>();
3172 * If called with I = 0, "float", will be returned.
3173 * Invalid types will be returned for I == 1 or 2.
3175 CINDEX_LINKAGE CXType clang_Cursor_getTemplateArgumentType(CXCursor C,
3179 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3180 * decl representing a template specialization) as a signed long long.
3182 * It is undefined to call this function on a CXCursor that does not represent a
3183 * FunctionDecl or whose I'th template argument is not an integral value.
3185 * For example, for the following declaration and specialization:
3186 * template <typename T, int kInt, bool kBool>
3187 * void foo() { ... }
3190 * void foo<float, -7, true>();
3192 * If called with I = 1 or 2, -7 or true will be returned, respectively.
3193 * For I == 0, this function's behavior is undefined.
3195 CINDEX_LINKAGE long long clang_Cursor_getTemplateArgumentValue(CXCursor C,
3199 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3200 * decl representing a template specialization) as an unsigned long long.
3202 * It is undefined to call this function on a CXCursor that does not represent a
3203 * FunctionDecl or whose I'th template argument is not an integral value.
3205 * For example, for the following declaration and specialization:
3206 * template <typename T, int kInt, bool kBool>
3207 * void foo() { ... }
3210 * void foo<float, 2147483649, true>();
3212 * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3213 * For I == 0, this function's behavior is undefined.
3215 CINDEX_LINKAGE unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(
3216 CXCursor C, unsigned I);
3219 * \brief Determine whether two CXTypes represent the same type.
3221 * \returns non-zero if the CXTypes represent the same type and
3224 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
3227 * \brief Return the canonical type for a CXType.
3229 * Clang's type system explicitly models typedefs and all the ways
3230 * a specific type can be represented. The canonical type is the underlying
3231 * type with all the "sugar" removed. For example, if 'T' is a typedef
3232 * for 'int', the canonical type for 'T' would be 'int'.
3234 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
3237 * \brief Determine whether a CXType has the "const" qualifier set,
3238 * without looking through typedefs that may have added "const" at a
3241 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
3244 * \brief Determine whether a CXCursor that is a macro, is
3247 CINDEX_LINKAGE unsigned clang_Cursor_isMacroFunctionLike(CXCursor C);
3250 * \brief Determine whether a CXCursor that is a macro, is a
3253 CINDEX_LINKAGE unsigned clang_Cursor_isMacroBuiltin(CXCursor C);
3256 * \brief Determine whether a CXCursor that is a function declaration, is an
3257 * inline declaration.
3259 CINDEX_LINKAGE unsigned clang_Cursor_isFunctionInlined(CXCursor C);
3262 * \brief Determine whether a CXType has the "volatile" qualifier set,
3263 * without looking through typedefs that may have added "volatile" at
3264 * a different level.
3266 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
3269 * \brief Determine whether a CXType has the "restrict" qualifier set,
3270 * without looking through typedefs that may have added "restrict" at a
3273 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
3276 * \brief For pointer types, returns the type of the pointee.
3278 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
3281 * \brief Return the cursor for the declaration of the given type.
3283 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
3286 * Returns the Objective-C type encoding for the specified declaration.
3288 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
3291 * Returns the Objective-C type encoding for the specified CXType.
3293 CINDEX_LINKAGE CXString clang_Type_getObjCEncoding(CXType type);
3296 * \brief Retrieve the spelling of a given CXTypeKind.
3298 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
3301 * \brief Retrieve the calling convention associated with a function type.
3303 * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3305 CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
3308 * \brief Retrieve the return type associated with a function type.
3310 * If a non-function type is passed in, an invalid type is returned.
3312 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
3315 * \brief Retrieve the number of non-variadic parameters associated with a
3318 * If a non-function type is passed in, -1 is returned.
3320 CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
3323 * \brief Retrieve the type of a parameter of a function type.
3325 * If a non-function type is passed in or the function does not have enough
3326 * parameters, an invalid type is returned.
3328 CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
3331 * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3333 CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
3336 * \brief Retrieve the return type associated with a given cursor.
3338 * This only returns a valid type if the cursor refers to a function or method.
3340 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
3343 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3346 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
3349 * \brief Return the element type of an array, complex, or vector type.
3351 * If a type is passed in that is not an array, complex, or vector type,
3352 * an invalid type is returned.
3354 CINDEX_LINKAGE CXType clang_getElementType(CXType T);
3357 * \brief Return the number of elements of an array or vector type.
3359 * If a type is passed in that is not an array or vector type,
3362 CINDEX_LINKAGE long long clang_getNumElements(CXType T);
3365 * \brief Return the element type of an array type.
3367 * If a non-array type is passed in, an invalid type is returned.
3369 CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
3372 * \brief Return the array size of a constant array.
3374 * If a non-array type is passed in, -1 is returned.
3376 CINDEX_LINKAGE long long clang_getArraySize(CXType T);
3379 * \brief Retrieve the type named by the qualified-id.
3381 * If a non-elaborated type is passed in, an invalid type is returned.
3383 CINDEX_LINKAGE CXType clang_Type_getNamedType(CXType T);
3386 * \brief List the possible error codes for \c clang_Type_getSizeOf,
3387 * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3388 * \c clang_Cursor_getOffsetOf.
3390 * A value of this enumeration type can be returned if the target type is not
3391 * a valid argument to sizeof, alignof or offsetof.
3393 enum CXTypeLayoutError {
3395 * \brief Type is of kind CXType_Invalid.
3397 CXTypeLayoutError_Invalid = -1,
3399 * \brief The type is an incomplete Type.
3401 CXTypeLayoutError_Incomplete = -2,
3403 * \brief The type is a dependent Type.
3405 CXTypeLayoutError_Dependent = -3,
3407 * \brief The type is not a constant size type.
3409 CXTypeLayoutError_NotConstantSize = -4,
3411 * \brief The Field name is not valid for this record.
3413 CXTypeLayoutError_InvalidFieldName = -5
3417 * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3420 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3421 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3423 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3425 * If the type declaration is not a constant size type,
3426 * CXTypeLayoutError_NotConstantSize is returned.
3428 CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
3431 * \brief Return the class type of an member pointer type.
3433 * If a non-member-pointer type is passed in, an invalid type is returned.
3435 CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
3438 * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3440 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3441 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3443 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3446 CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
3449 * \brief Return the offset of a field named S in a record of type T in bits
3450 * as it would be returned by __offsetof__ as per C++11[18.2p4]
3452 * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3454 * If the field's type declaration is an incomplete type,
3455 * CXTypeLayoutError_Incomplete is returned.
3456 * If the field's type declaration is a dependent type,
3457 * CXTypeLayoutError_Dependent is returned.
3458 * If the field's name S is not found,
3459 * CXTypeLayoutError_InvalidFieldName is returned.
3461 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3464 * \brief Return the offset of the field represented by the Cursor.
3466 * If the cursor is not a field declaration, -1 is returned.
3467 * If the cursor semantic parent is not a record field declaration,
3468 * CXTypeLayoutError_Invalid is returned.
3469 * If the field's type declaration is an incomplete type,
3470 * CXTypeLayoutError_Incomplete is returned.
3471 * If the field's type declaration is a dependent type,
3472 * CXTypeLayoutError_Dependent is returned.
3473 * If the field's name S is not found,
3474 * CXTypeLayoutError_InvalidFieldName is returned.
3476 CINDEX_LINKAGE long long clang_Cursor_getOffsetOfField(CXCursor C);
3479 * \brief Determine whether the given cursor represents an anonymous record
3482 CINDEX_LINKAGE unsigned clang_Cursor_isAnonymous(CXCursor C);
3484 enum CXRefQualifierKind {
3485 /** \brief No ref-qualifier was provided. */
3486 CXRefQualifier_None = 0,
3487 /** \brief An lvalue ref-qualifier was provided (\c &). */
3488 CXRefQualifier_LValue,
3489 /** \brief An rvalue ref-qualifier was provided (\c &&). */
3490 CXRefQualifier_RValue
3494 * \brief Returns the number of template arguments for given class template
3495 * specialization, or -1 if type \c T is not a class template specialization.
3497 * Variadic argument packs count as only one argument, and can not be inspected
3500 CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
3503 * \brief Returns the type template argument of a template class specialization
3506 * This function only returns template type arguments and does not handle
3507 * template template arguments or variadic packs.
3509 CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
3512 * \brief Retrieve the ref-qualifier kind of a function or method.
3514 * The ref-qualifier is returned for C++ functions or methods. For other types
3515 * or non-C++ declarations, CXRefQualifier_None is returned.
3517 CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
3520 * \brief Returns non-zero if the cursor specifies a Record member that is a
3523 CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
3526 * \brief Returns 1 if the base class specified by the cursor with kind
3527 * CX_CXXBaseSpecifier is virtual.
3529 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
3532 * \brief Represents the C++ access control level to a base class for a
3533 * cursor with kind CX_CXXBaseSpecifier.
3535 enum CX_CXXAccessSpecifier {
3536 CX_CXXInvalidAccessSpecifier,
3543 * \brief Returns the access control level for the referenced object.
3545 * If the cursor refers to a C++ declaration, its access control level within its
3546 * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3547 * access specifier, the specifier itself is returned.
3549 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
3552 * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3553 * was added for the case that the passed cursor in not a declaration.
3555 enum CX_StorageClass {
3560 CX_SC_PrivateExtern,
3561 CX_SC_OpenCLWorkGroupLocal,
3567 * \brief Returns the storage class for a function or variable declaration.
3569 * If the passed in Cursor is not a function or variable declaration,
3570 * CX_SC_Invalid is returned else the storage class.
3572 CINDEX_LINKAGE enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor);
3575 * \brief Determine the number of overloaded declarations referenced by a
3576 * \c CXCursor_OverloadedDeclRef cursor.
3578 * \param cursor The cursor whose overloaded declarations are being queried.
3580 * \returns The number of overloaded declarations referenced by \c cursor. If it
3581 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3583 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
3586 * \brief Retrieve a cursor for one of the overloaded declarations referenced
3587 * by a \c CXCursor_OverloadedDeclRef cursor.
3589 * \param cursor The cursor whose overloaded declarations are being queried.
3591 * \param index The zero-based index into the set of overloaded declarations in
3594 * \returns A cursor representing the declaration referenced by the given
3595 * \c cursor at the specified \c index. If the cursor does not have an
3596 * associated set of overloaded declarations, or if the index is out of bounds,
3597 * returns \c clang_getNullCursor();
3599 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
3607 * \defgroup CINDEX_ATTRIBUTES Information for attributes
3613 * \brief For cursors representing an iboutletcollection attribute,
3614 * this function returns the collection element type.
3617 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
3624 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3626 * These routines provide the ability to traverse the abstract syntax tree
3633 * \brief Describes how the traversal of the children of a particular
3634 * cursor should proceed after visiting a particular child cursor.
3636 * A value of this enumeration type should be returned by each
3637 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3639 enum CXChildVisitResult {
3641 * \brief Terminates the cursor traversal.
3645 * \brief Continues the cursor traversal with the next sibling of
3646 * the cursor just visited, without visiting its children.
3648 CXChildVisit_Continue,
3650 * \brief Recursively traverse the children of this cursor, using
3651 * the same visitor and client data.
3653 CXChildVisit_Recurse
3657 * \brief Visitor invoked for each cursor found by a traversal.
3659 * This visitor function will be invoked for each cursor found by
3660 * clang_visitCursorChildren(). Its first argument is the cursor being
3661 * visited, its second argument is the parent visitor for that cursor,
3662 * and its third argument is the client data provided to
3663 * clang_visitCursorChildren().
3665 * The visitor should return one of the \c CXChildVisitResult values
3666 * to direct clang_visitCursorChildren().
3668 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
3670 CXClientData client_data);
3673 * \brief Visit the children of a particular cursor.
3675 * This function visits all the direct children of the given cursor,
3676 * invoking the given \p visitor function with the cursors of each
3677 * visited child. The traversal may be recursive, if the visitor returns
3678 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3679 * the visitor returns \c CXChildVisit_Break.
3681 * \param parent the cursor whose child may be visited. All kinds of
3682 * cursors can be visited, including invalid cursors (which, by
3683 * definition, have no children).
3685 * \param visitor the visitor function that will be invoked for each
3686 * child of \p parent.
3688 * \param client_data pointer data supplied by the client, which will
3689 * be passed to the visitor each time it is invoked.
3691 * \returns a non-zero value if the traversal was terminated
3692 * prematurely by the visitor returning \c CXChildVisit_Break.
3694 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
3695 CXCursorVisitor visitor,
3696 CXClientData client_data);
3697 #ifdef __has_feature
3698 # if __has_feature(blocks)
3700 * \brief Visitor invoked for each cursor found by a traversal.
3702 * This visitor block will be invoked for each cursor found by
3703 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3704 * visited, its second argument is the parent visitor for that cursor.
3706 * The visitor should return one of the \c CXChildVisitResult values
3707 * to direct clang_visitChildrenWithBlock().
3709 typedef enum CXChildVisitResult
3710 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3713 * Visits the children of a cursor using the specified block. Behaves
3714 * identically to clang_visitChildren() in all other respects.
3716 CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
3717 CXCursorVisitorBlock block);
3726 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3728 * These routines provide the ability to determine references within and
3729 * across translation units, by providing the names of the entities referenced
3730 * by cursors, follow reference cursors to the declarations they reference,
3731 * and associate declarations with their definitions.
3737 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3738 * by the given cursor.
3740 * A Unified Symbol Resolution (USR) is a string that identifies a particular
3741 * entity (function, class, variable, etc.) within a program. USRs can be
3742 * compared across translation units to determine, e.g., when references in
3743 * one translation refer to an entity defined in another translation unit.
3745 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
3748 * \brief Construct a USR for a specified Objective-C class.
3750 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3753 * \brief Construct a USR for a specified Objective-C category.
3755 CINDEX_LINKAGE CXString
3756 clang_constructUSR_ObjCCategory(const char *class_name,
3757 const char *category_name);
3760 * \brief Construct a USR for a specified Objective-C protocol.
3762 CINDEX_LINKAGE CXString
3763 clang_constructUSR_ObjCProtocol(const char *protocol_name);
3766 * \brief Construct a USR for a specified Objective-C instance variable and
3767 * the USR for its containing class.
3769 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
3773 * \brief Construct a USR for a specified Objective-C method and
3774 * the USR for its containing class.
3776 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
3777 unsigned isInstanceMethod,
3781 * \brief Construct a USR for a specified Objective-C property and the USR
3782 * for its containing class.
3784 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
3788 * \brief Retrieve a name for the entity referenced by this cursor.
3790 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
3793 * \brief Retrieve a range for a piece that forms the cursors spelling name.
3794 * Most of the times there is only one range for the complete spelling but for
3795 * Objective-C methods and Objective-C message expressions, there are multiple
3796 * pieces for each selector identifier.
3798 * \param pieceIndex the index of the spelling name piece. If this is greater
3799 * than the actual number of pieces, it will return a NULL (invalid) range.
3801 * \param options Reserved.
3803 CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor,
3804 unsigned pieceIndex,
3808 * \brief Retrieve the display name for the entity referenced by this cursor.
3810 * The display name contains extra information that helps identify the cursor,
3811 * such as the parameters of a function or template or the arguments of a
3812 * class template specialization.
3814 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
3816 /** \brief For a cursor that is a reference, retrieve a cursor representing the
3817 * entity that it references.
3819 * Reference cursors refer to other entities in the AST. For example, an
3820 * Objective-C superclass reference cursor refers to an Objective-C class.
3821 * This function produces the cursor for the Objective-C class from the
3822 * cursor for the superclass reference. If the input cursor is a declaration or
3823 * definition, it returns that declaration or definition unchanged.
3824 * Otherwise, returns the NULL cursor.
3826 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
3829 * \brief For a cursor that is either a reference to or a declaration
3830 * of some entity, retrieve a cursor that describes the definition of
3833 * Some entities can be declared multiple times within a translation
3834 * unit, but only one of those declarations can also be a
3835 * definition. For example, given:
3839 * int g(int x, int y) { return f(x, y); }
3840 * int f(int a, int b) { return a + b; }
3844 * there are three declarations of the function "f", but only the
3845 * second one is a definition. The clang_getCursorDefinition()
3846 * function will take any cursor pointing to a declaration of "f"
3847 * (the first or fourth lines of the example) or a cursor referenced
3848 * that uses "f" (the call to "f' inside "g") and will return a
3849 * declaration cursor pointing to the definition (the second "f"
3852 * If given a cursor for which there is no corresponding definition,
3853 * e.g., because there is no definition of that entity within this
3854 * translation unit, returns a NULL cursor.
3856 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
3859 * \brief Determine whether the declaration pointed to by this cursor
3860 * is also a definition of that entity.
3862 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
3865 * \brief Retrieve the canonical cursor corresponding to the given cursor.
3867 * In the C family of languages, many kinds of entities can be declared several
3868 * times within a single translation unit. For example, a structure type can
3869 * be forward-declared (possibly multiple times) and later defined:
3879 * The declarations and the definition of \c X are represented by three
3880 * different cursors, all of which are declarations of the same underlying
3881 * entity. One of these cursor is considered the "canonical" cursor, which
3882 * is effectively the representative for the underlying entity. One can
3883 * determine if two cursors are declarations of the same underlying entity by
3884 * comparing their canonical cursors.
3886 * \returns The canonical cursor for the entity referred to by the given cursor.
3888 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
3891 * \brief If the cursor points to a selector identifier in an Objective-C
3892 * method or message expression, this returns the selector index.
3894 * After getting a cursor with #clang_getCursor, this can be called to
3895 * determine if the location points to a selector identifier.
3897 * \returns The selector index if the cursor is an Objective-C method or message
3898 * expression and the cursor is pointing to a selector identifier, or -1
3901 CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
3904 * \brief Given a cursor pointing to a C++ method call or an Objective-C
3905 * message, returns non-zero if the method/message is "dynamic", meaning:
3907 * For a C++ method: the call is virtual.
3908 * For an Objective-C message: the receiver is an object instance, not 'super'
3909 * or a specific class.
3911 * If the method/message is "static" or the cursor does not point to a
3912 * method/message, it will return zero.
3914 CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
3917 * \brief Given a cursor pointing to an Objective-C message, returns the CXType
3920 CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
3923 * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
3926 CXObjCPropertyAttr_noattr = 0x00,
3927 CXObjCPropertyAttr_readonly = 0x01,
3928 CXObjCPropertyAttr_getter = 0x02,
3929 CXObjCPropertyAttr_assign = 0x04,
3930 CXObjCPropertyAttr_readwrite = 0x08,
3931 CXObjCPropertyAttr_retain = 0x10,
3932 CXObjCPropertyAttr_copy = 0x20,
3933 CXObjCPropertyAttr_nonatomic = 0x40,
3934 CXObjCPropertyAttr_setter = 0x80,
3935 CXObjCPropertyAttr_atomic = 0x100,
3936 CXObjCPropertyAttr_weak = 0x200,
3937 CXObjCPropertyAttr_strong = 0x400,
3938 CXObjCPropertyAttr_unsafe_unretained = 0x800,
3939 CXObjCPropertyAttr_class = 0x1000
3940 } CXObjCPropertyAttrKind;
3943 * \brief Given a cursor that represents a property declaration, return the
3944 * associated property attributes. The bits are formed from
3945 * \c CXObjCPropertyAttrKind.
3947 * \param reserved Reserved for future use, pass 0.
3949 CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C,
3953 * \brief 'Qualifiers' written next to the return and parameter types in
3954 * Objective-C method declarations.
3957 CXObjCDeclQualifier_None = 0x0,
3958 CXObjCDeclQualifier_In = 0x1,
3959 CXObjCDeclQualifier_Inout = 0x2,
3960 CXObjCDeclQualifier_Out = 0x4,
3961 CXObjCDeclQualifier_Bycopy = 0x8,
3962 CXObjCDeclQualifier_Byref = 0x10,
3963 CXObjCDeclQualifier_Oneway = 0x20
3964 } CXObjCDeclQualifierKind;
3967 * \brief Given a cursor that represents an Objective-C method or parameter
3968 * declaration, return the associated Objective-C qualifiers for the return
3969 * type or the parameter respectively. The bits are formed from
3970 * CXObjCDeclQualifierKind.
3972 CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
3975 * \brief Given a cursor that represents an Objective-C method or property
3976 * declaration, return non-zero if the declaration was affected by "@optional".
3977 * Returns zero if the cursor is not such a declaration or it is "@required".
3979 CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
3982 * \brief Returns non-zero if the given cursor is a variadic function or method.
3984 CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
3987 * \brief Given a cursor that represents a declaration, return the associated
3988 * comment's source range. The range may include multiple consecutive comments
3989 * with whitespace in between.
3991 CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
3994 * \brief Given a cursor that represents a declaration, return the associated
3995 * comment text, including comment markers.
3997 CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
4000 * \brief Given a cursor that represents a documentable entity (e.g.,
4001 * declaration), return the associated \\brief paragraph; otherwise return the
4004 CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
4010 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
4016 * \brief Retrieve the CXString representing the mangled name of the cursor.
4018 CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
4021 * \brief Retrieve the CXStrings representing the mangled symbols of the C++
4022 * constructor or destructor at the cursor.
4024 CINDEX_LINKAGE CXStringSet *clang_Cursor_getCXXManglings(CXCursor);
4031 * \defgroup CINDEX_MODULE Module introspection
4033 * The functions in this group provide access to information about modules.
4038 typedef void *CXModule;
4041 * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4043 CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
4046 * \brief Given a CXFile header file, return the module that contains it, if one
4049 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4052 * \param Module a module object.
4054 * \returns the module file where the provided module object came from.
4056 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4059 * \param Module a module object.
4061 * \returns the parent of a sub-module or NULL if the given module is top-level,
4062 * e.g. for 'std.vector' it will return the 'std' module.
4064 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4067 * \param Module a module object.
4069 * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4070 * will return "vector".
4072 CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
4075 * \param Module a module object.
4077 * \returns the full name of the module, e.g. "std.vector".
4079 CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
4082 * \param Module a module object.
4084 * \returns non-zero if the module is a system one.
4086 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4089 * \param Module a module object.
4091 * \returns the number of top level headers associated with this module.
4093 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4097 * \param Module a module object.
4099 * \param Index top level header index (zero-based).
4101 * \returns the specified top level header associated with the module.
4104 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
4105 CXModule Module, unsigned Index);
4112 * \defgroup CINDEX_CPP C++ AST introspection
4114 * The routines in this group provide access information in the ASTs specific
4115 * to C++ language features.
4121 * \brief Determine if a C++ constructor is a converting constructor.
4123 CINDEX_LINKAGE unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C);
4126 * \brief Determine if a C++ constructor is a copy constructor.
4128 CINDEX_LINKAGE unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C);
4131 * \brief Determine if a C++ constructor is the default constructor.
4133 CINDEX_LINKAGE unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C);
4136 * \brief Determine if a C++ constructor is a move constructor.
4138 CINDEX_LINKAGE unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C);
4141 * \brief Determine if a C++ field is declared 'mutable'.
4143 CINDEX_LINKAGE unsigned clang_CXXField_isMutable(CXCursor C);
4146 * \brief Determine if a C++ method is declared '= default'.
4148 CINDEX_LINKAGE unsigned clang_CXXMethod_isDefaulted(CXCursor C);
4151 * \brief Determine if a C++ member function or member function template is
4154 CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
4157 * \brief Determine if a C++ member function or member function template is
4158 * declared 'static'.
4160 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
4163 * \brief Determine if a C++ member function or member function template is
4164 * explicitly declared 'virtual' or if it overrides a virtual method from
4165 * one of the base classes.
4167 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
4170 * \brief Determine if a C++ member function or member function template is
4173 CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
4176 * \brief Given a cursor that represents a template, determine
4177 * the cursor kind of the specializations would be generated by instantiating
4180 * This routine can be used to determine what flavor of function template,
4181 * class template, or class template partial specialization is stored in the
4182 * cursor. For example, it can describe whether a class template cursor is
4183 * declared with "struct", "class" or "union".
4185 * \param C The cursor to query. This cursor should represent a template
4188 * \returns The cursor kind of the specializations that would be generated
4189 * by instantiating the template \p C. If \p C is not a template, returns
4190 * \c CXCursor_NoDeclFound.
4192 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
4195 * \brief Given a cursor that may represent a specialization or instantiation
4196 * of a template, retrieve the cursor that represents the template that it
4197 * specializes or from which it was instantiated.
4199 * This routine determines the template involved both for explicit
4200 * specializations of templates and for implicit instantiations of the template,
4201 * both of which are referred to as "specializations". For a class template
4202 * specialization (e.g., \c std::vector<bool>), this routine will return
4203 * either the primary template (\c std::vector) or, if the specialization was
4204 * instantiated from a class template partial specialization, the class template
4205 * partial specialization. For a class template partial specialization and a
4206 * function template specialization (including instantiations), this
4207 * this routine will return the specialized template.
4209 * For members of a class template (e.g., member functions, member classes, or
4210 * static data members), returns the specialized or instantiated member.
4211 * Although not strictly "templates" in the C++ language, members of class
4212 * templates have the same notions of specializations and instantiations that
4213 * templates do, so this routine treats them similarly.
4215 * \param C A cursor that may be a specialization of a template or a member
4218 * \returns If the given cursor is a specialization or instantiation of a
4219 * template or a member thereof, the template or member that it specializes or
4220 * from which it was instantiated. Otherwise, returns a NULL cursor.
4222 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
4225 * \brief Given a cursor that references something else, return the source range
4226 * covering that reference.
4228 * \param C A cursor pointing to a member reference, a declaration reference, or
4230 * \param NameFlags A bitset with three independent flags:
4231 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4232 * CXNameRange_WantSinglePiece.
4233 * \param PieceIndex For contiguous names or when passing the flag
4234 * CXNameRange_WantSinglePiece, only one piece with index 0 is
4235 * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4236 * non-contiguous names, this index can be used to retrieve the individual
4237 * pieces of the name. See also CXNameRange_WantSinglePiece.
4239 * \returns The piece of the name pointed to by the given cursor. If there is no
4240 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4242 CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
4244 unsigned PieceIndex);
4246 enum CXNameRefFlags {
4248 * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4251 CXNameRange_WantQualifier = 0x1,
4254 * \brief Include the explicit template arguments, e.g. \<int> in x.f<int>,
4257 CXNameRange_WantTemplateArgs = 0x2,
4260 * \brief If the name is non-contiguous, return the full spanning range.
4262 * Non-contiguous names occur in Objective-C when a selector with two or more
4263 * parameters is used, or in C++ when using an operator:
4265 * [object doSomething:here withValue:there]; // Objective-C
4266 * return some_vector[1]; // C++
4269 CXNameRange_WantSinglePiece = 0x4
4277 * \defgroup CINDEX_LEX Token extraction and manipulation
4279 * The routines in this group provide access to the tokens within a
4280 * translation unit, along with a semantic mapping of those tokens to
4281 * their corresponding cursors.
4287 * \brief Describes a kind of token.
4289 typedef enum CXTokenKind {
4291 * \brief A token that contains some kind of punctuation.
4293 CXToken_Punctuation,
4296 * \brief A language keyword.
4301 * \brief An identifier (that is not a keyword).
4306 * \brief A numeric, string, or character literal.
4317 * \brief Describes a single preprocessing token.
4320 unsigned int_data[4];
4325 * \brief Determine the kind of the given token.
4327 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
4330 * \brief Determine the spelling of the given token.
4332 * The spelling of a token is the textual representation of that token, e.g.,
4333 * the text of an identifier or keyword.
4335 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
4338 * \brief Retrieve the source location of the given token.
4340 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
4344 * \brief Retrieve a source range that covers the given token.
4346 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
4349 * \brief Tokenize the source code described by the given range into raw
4352 * \param TU the translation unit whose text is being tokenized.
4354 * \param Range the source range in which text should be tokenized. All of the
4355 * tokens produced by tokenization will fall within this source range,
4357 * \param Tokens this pointer will be set to point to the array of tokens
4358 * that occur within the given source range. The returned pointer must be
4359 * freed with clang_disposeTokens() before the translation unit is destroyed.
4361 * \param NumTokens will be set to the number of tokens in the \c *Tokens
4365 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4366 CXToken **Tokens, unsigned *NumTokens);
4369 * \brief Annotate the given set of tokens by providing cursors for each token
4370 * that can be mapped to a specific entity within the abstract syntax tree.
4372 * This token-annotation routine is equivalent to invoking
4373 * clang_getCursor() for the source locations of each of the
4374 * tokens. The cursors provided are filtered, so that only those
4375 * cursors that have a direct correspondence to the token are
4376 * accepted. For example, given a function call \c f(x),
4377 * clang_getCursor() would provide the following cursors:
4379 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4380 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4381 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4383 * Only the first and last of these cursors will occur within the
4384 * annotate, since the tokens "f" and "x' directly refer to a function
4385 * and a variable, respectively, but the parentheses are just a small
4386 * part of the full syntax of the function call expression, which is
4387 * not provided as an annotation.
4389 * \param TU the translation unit that owns the given tokens.
4391 * \param Tokens the set of tokens to annotate.
4393 * \param NumTokens the number of tokens in \p Tokens.
4395 * \param Cursors an array of \p NumTokens cursors, whose contents will be
4396 * replaced with the cursors corresponding to each token.
4398 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4399 CXToken *Tokens, unsigned NumTokens,
4403 * \brief Free the given set of tokens.
4405 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4406 CXToken *Tokens, unsigned NumTokens);
4413 * \defgroup CINDEX_DEBUG Debugging facilities
4415 * These routines are used for testing and debugging, only, and should not
4421 /* for debug/testing */
4422 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
4423 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
4424 const char **startBuf,
4425 const char **endBuf,
4426 unsigned *startLine,
4427 unsigned *startColumn,
4429 unsigned *endColumn);
4430 CINDEX_LINKAGE void clang_enableStackTraces(void);
4431 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4432 unsigned stack_size);
4439 * \defgroup CINDEX_CODE_COMPLET Code completion
4441 * Code completion involves taking an (incomplete) source file, along with
4442 * knowledge of where the user is actively editing that file, and suggesting
4443 * syntactically- and semantically-valid constructs that the user might want to
4444 * use at that particular point in the source code. These data structures and
4445 * routines provide support for code completion.
4451 * \brief A semantic string that describes a code-completion result.
4453 * A semantic string that describes the formatting of a code-completion
4454 * result as a single "template" of text that should be inserted into the
4455 * source buffer when a particular code-completion result is selected.
4456 * Each semantic string is made up of some number of "chunks", each of which
4457 * contains some text along with a description of what that text means, e.g.,
4458 * the name of the entity being referenced, whether the text chunk is part of
4459 * the template, or whether it is a "placeholder" that the user should replace
4460 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4461 * description of the different kinds of chunks.
4463 typedef void *CXCompletionString;
4466 * \brief A single result of code completion.
4470 * \brief The kind of entity that this completion refers to.
4472 * The cursor kind will be a macro, keyword, or a declaration (one of the
4473 * *Decl cursor kinds), describing the entity that the completion is
4476 * \todo In the future, we would like to provide a full cursor, to allow
4477 * the client to extract additional information from declaration.
4479 enum CXCursorKind CursorKind;
4482 * \brief The code-completion string that describes how to insert this
4483 * code-completion result into the editing buffer.
4485 CXCompletionString CompletionString;
4486 } CXCompletionResult;
4489 * \brief Describes a single piece of text within a code-completion string.
4491 * Each "chunk" within a code-completion string (\c CXCompletionString) is
4492 * either a piece of text with a specific "kind" that describes how that text
4493 * should be interpreted by the client or is another completion string.
4495 enum CXCompletionChunkKind {
4497 * \brief A code-completion string that describes "optional" text that
4498 * could be a part of the template (but is not required).
4500 * The Optional chunk is the only kind of chunk that has a code-completion
4501 * string for its representation, which is accessible via
4502 * \c clang_getCompletionChunkCompletionString(). The code-completion string
4503 * describes an additional part of the template that is completely optional.
4504 * For example, optional chunks can be used to describe the placeholders for
4505 * arguments that match up with defaulted function parameters, e.g. given:
4508 * void f(int x, float y = 3.14, double z = 2.71828);
4511 * The code-completion string for this function would contain:
4512 * - a TypedText chunk for "f".
4513 * - a LeftParen chunk for "(".
4514 * - a Placeholder chunk for "int x"
4515 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4516 * - a Comma chunk for ","
4517 * - a Placeholder chunk for "float y"
4518 * - an Optional chunk containing the last defaulted argument:
4519 * - a Comma chunk for ","
4520 * - a Placeholder chunk for "double z"
4521 * - a RightParen chunk for ")"
4523 * There are many ways to handle Optional chunks. Two simple approaches are:
4524 * - Completely ignore optional chunks, in which case the template for the
4525 * function "f" would only include the first parameter ("int x").
4526 * - Fully expand all optional chunks, in which case the template for the
4527 * function "f" would have all of the parameters.
4529 CXCompletionChunk_Optional,
4531 * \brief Text that a user would be expected to type to get this
4532 * code-completion result.
4534 * There will be exactly one "typed text" chunk in a semantic string, which
4535 * will typically provide the spelling of a keyword or the name of a
4536 * declaration that could be used at the current code point. Clients are
4537 * expected to filter the code-completion results based on the text in this
4540 CXCompletionChunk_TypedText,
4542 * \brief Text that should be inserted as part of a code-completion result.
4544 * A "text" chunk represents text that is part of the template to be
4545 * inserted into user code should this particular code-completion result
4548 CXCompletionChunk_Text,
4550 * \brief Placeholder text that should be replaced by the user.
4552 * A "placeholder" chunk marks a place where the user should insert text
4553 * into the code-completion template. For example, placeholders might mark
4554 * the function parameters for a function declaration, to indicate that the
4555 * user should provide arguments for each of those parameters. The actual
4556 * text in a placeholder is a suggestion for the text to display before
4557 * the user replaces the placeholder with real code.
4559 CXCompletionChunk_Placeholder,
4561 * \brief Informative text that should be displayed but never inserted as
4562 * part of the template.
4564 * An "informative" chunk contains annotations that can be displayed to
4565 * help the user decide whether a particular code-completion result is the
4566 * right option, but which is not part of the actual template to be inserted
4567 * by code completion.
4569 CXCompletionChunk_Informative,
4571 * \brief Text that describes the current parameter when code-completion is
4572 * referring to function call, message send, or template specialization.
4574 * A "current parameter" chunk occurs when code-completion is providing
4575 * information about a parameter corresponding to the argument at the
4576 * code-completion point. For example, given a function
4579 * int add(int x, int y);
4582 * and the source code \c add(, where the code-completion point is after the
4583 * "(", the code-completion string will contain a "current parameter" chunk
4584 * for "int x", indicating that the current argument will initialize that
4585 * parameter. After typing further, to \c add(17, (where the code-completion
4586 * point is after the ","), the code-completion string will contain a
4587 * "current paremeter" chunk to "int y".
4589 CXCompletionChunk_CurrentParameter,
4591 * \brief A left parenthesis ('('), used to initiate a function call or
4592 * signal the beginning of a function parameter list.
4594 CXCompletionChunk_LeftParen,
4596 * \brief A right parenthesis (')'), used to finish a function call or
4597 * signal the end of a function parameter list.
4599 CXCompletionChunk_RightParen,
4601 * \brief A left bracket ('[').
4603 CXCompletionChunk_LeftBracket,
4605 * \brief A right bracket (']').
4607 CXCompletionChunk_RightBracket,
4609 * \brief A left brace ('{').
4611 CXCompletionChunk_LeftBrace,
4613 * \brief A right brace ('}').
4615 CXCompletionChunk_RightBrace,
4617 * \brief A left angle bracket ('<').
4619 CXCompletionChunk_LeftAngle,
4621 * \brief A right angle bracket ('>').
4623 CXCompletionChunk_RightAngle,
4625 * \brief A comma separator (',').
4627 CXCompletionChunk_Comma,
4629 * \brief Text that specifies the result type of a given result.
4631 * This special kind of informative chunk is not meant to be inserted into
4632 * the text buffer. Rather, it is meant to illustrate the type that an
4633 * expression using the given completion string would have.
4635 CXCompletionChunk_ResultType,
4637 * \brief A colon (':').
4639 CXCompletionChunk_Colon,
4641 * \brief A semicolon (';').
4643 CXCompletionChunk_SemiColon,
4645 * \brief An '=' sign.
4647 CXCompletionChunk_Equal,
4649 * Horizontal space (' ').
4651 CXCompletionChunk_HorizontalSpace,
4653 * Vertical space ('\n'), after which it is generally a good idea to
4654 * perform indentation.
4656 CXCompletionChunk_VerticalSpace
4660 * \brief Determine the kind of a particular chunk within a completion string.
4662 * \param completion_string the completion string to query.
4664 * \param chunk_number the 0-based index of the chunk in the completion string.
4666 * \returns the kind of the chunk at the index \c chunk_number.
4668 CINDEX_LINKAGE enum CXCompletionChunkKind
4669 clang_getCompletionChunkKind(CXCompletionString completion_string,
4670 unsigned chunk_number);
4673 * \brief Retrieve the text associated with a particular chunk within a
4674 * completion string.
4676 * \param completion_string the completion string to query.
4678 * \param chunk_number the 0-based index of the chunk in the completion string.
4680 * \returns the text associated with the chunk at index \c chunk_number.
4682 CINDEX_LINKAGE CXString
4683 clang_getCompletionChunkText(CXCompletionString completion_string,
4684 unsigned chunk_number);
4687 * \brief Retrieve the completion string associated with a particular chunk
4688 * within a completion string.
4690 * \param completion_string the completion string to query.
4692 * \param chunk_number the 0-based index of the chunk in the completion string.
4694 * \returns the completion string associated with the chunk at index
4697 CINDEX_LINKAGE CXCompletionString
4698 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4699 unsigned chunk_number);
4702 * \brief Retrieve the number of chunks in the given code-completion string.
4704 CINDEX_LINKAGE unsigned
4705 clang_getNumCompletionChunks(CXCompletionString completion_string);
4708 * \brief Determine the priority of this code completion.
4710 * The priority of a code completion indicates how likely it is that this
4711 * particular completion is the completion that the user will select. The
4712 * priority is selected by various internal heuristics.
4714 * \param completion_string The completion string to query.
4716 * \returns The priority of this completion string. Smaller values indicate
4717 * higher-priority (more likely) completions.
4719 CINDEX_LINKAGE unsigned
4720 clang_getCompletionPriority(CXCompletionString completion_string);
4723 * \brief Determine the availability of the entity that this code-completion
4726 * \param completion_string The completion string to query.
4728 * \returns The availability of the completion string.
4730 CINDEX_LINKAGE enum CXAvailabilityKind
4731 clang_getCompletionAvailability(CXCompletionString completion_string);
4734 * \brief Retrieve the number of annotations associated with the given
4735 * completion string.
4737 * \param completion_string the completion string to query.
4739 * \returns the number of annotations associated with the given completion
4742 CINDEX_LINKAGE unsigned
4743 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4746 * \brief Retrieve the annotation associated with the given completion string.
4748 * \param completion_string the completion string to query.
4750 * \param annotation_number the 0-based index of the annotation of the
4751 * completion string.
4753 * \returns annotation string associated with the completion at index
4754 * \c annotation_number, or a NULL string if that annotation is not available.
4756 CINDEX_LINKAGE CXString
4757 clang_getCompletionAnnotation(CXCompletionString completion_string,
4758 unsigned annotation_number);
4761 * \brief Retrieve the parent context of the given completion string.
4763 * The parent context of a completion string is the semantic parent of
4764 * the declaration (if any) that the code completion represents. For example,
4765 * a code completion for an Objective-C method would have the method's class
4766 * or protocol as its context.
4768 * \param completion_string The code completion string whose parent is
4771 * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
4773 * \returns The name of the completion parent, e.g., "NSObject" if
4774 * the completion string represents a method in the NSObject class.
4776 CINDEX_LINKAGE CXString
4777 clang_getCompletionParent(CXCompletionString completion_string,
4778 enum CXCursorKind *kind);
4781 * \brief Retrieve the brief documentation comment attached to the declaration
4782 * that corresponds to the given completion string.
4784 CINDEX_LINKAGE CXString
4785 clang_getCompletionBriefComment(CXCompletionString completion_string);
4788 * \brief Retrieve a completion string for an arbitrary declaration or macro
4789 * definition cursor.
4791 * \param cursor The cursor to query.
4793 * \returns A non-context-sensitive completion string for declaration and macro
4794 * definition cursors, or NULL for other kinds of cursors.
4796 CINDEX_LINKAGE CXCompletionString
4797 clang_getCursorCompletionString(CXCursor cursor);
4800 * \brief Contains the results of code-completion.
4802 * This data structure contains the results of code completion, as
4803 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
4804 * \c clang_disposeCodeCompleteResults.
4808 * \brief The code-completion results.
4810 CXCompletionResult *Results;
4813 * \brief The number of code-completion results stored in the
4816 unsigned NumResults;
4817 } CXCodeCompleteResults;
4820 * \brief Flags that can be passed to \c clang_codeCompleteAt() to
4821 * modify its behavior.
4823 * The enumerators in this enumeration can be bitwise-OR'd together to
4824 * provide multiple options to \c clang_codeCompleteAt().
4826 enum CXCodeComplete_Flags {
4828 * \brief Whether to include macros within the set of code
4829 * completions returned.
4831 CXCodeComplete_IncludeMacros = 0x01,
4834 * \brief Whether to include code patterns for language constructs
4835 * within the set of code completions, e.g., for loops.
4837 CXCodeComplete_IncludeCodePatterns = 0x02,
4840 * \brief Whether to include brief documentation within the set of code
4841 * completions returned.
4843 CXCodeComplete_IncludeBriefComments = 0x04
4847 * \brief Bits that represent the context under which completion is occurring.
4849 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
4850 * contexts are occurring simultaneously.
4852 enum CXCompletionContext {
4854 * \brief The context for completions is unexposed, as only Clang results
4855 * should be included. (This is equivalent to having no context bits set.)
4857 CXCompletionContext_Unexposed = 0,
4860 * \brief Completions for any possible type should be included in the results.
4862 CXCompletionContext_AnyType = 1 << 0,
4865 * \brief Completions for any possible value (variables, function calls, etc.)
4866 * should be included in the results.
4868 CXCompletionContext_AnyValue = 1 << 1,
4870 * \brief Completions for values that resolve to an Objective-C object should
4871 * be included in the results.
4873 CXCompletionContext_ObjCObjectValue = 1 << 2,
4875 * \brief Completions for values that resolve to an Objective-C selector
4876 * should be included in the results.
4878 CXCompletionContext_ObjCSelectorValue = 1 << 3,
4880 * \brief Completions for values that resolve to a C++ class type should be
4881 * included in the results.
4883 CXCompletionContext_CXXClassTypeValue = 1 << 4,
4886 * \brief Completions for fields of the member being accessed using the dot
4887 * operator should be included in the results.
4889 CXCompletionContext_DotMemberAccess = 1 << 5,
4891 * \brief Completions for fields of the member being accessed using the arrow
4892 * operator should be included in the results.
4894 CXCompletionContext_ArrowMemberAccess = 1 << 6,
4896 * \brief Completions for properties of the Objective-C object being accessed
4897 * using the dot operator should be included in the results.
4899 CXCompletionContext_ObjCPropertyAccess = 1 << 7,
4902 * \brief Completions for enum tags should be included in the results.
4904 CXCompletionContext_EnumTag = 1 << 8,
4906 * \brief Completions for union tags should be included in the results.
4908 CXCompletionContext_UnionTag = 1 << 9,
4910 * \brief Completions for struct tags should be included in the results.
4912 CXCompletionContext_StructTag = 1 << 10,
4915 * \brief Completions for C++ class names should be included in the results.
4917 CXCompletionContext_ClassTag = 1 << 11,
4919 * \brief Completions for C++ namespaces and namespace aliases should be
4920 * included in the results.
4922 CXCompletionContext_Namespace = 1 << 12,
4924 * \brief Completions for C++ nested name specifiers should be included in
4927 CXCompletionContext_NestedNameSpecifier = 1 << 13,
4930 * \brief Completions for Objective-C interfaces (classes) should be included
4933 CXCompletionContext_ObjCInterface = 1 << 14,
4935 * \brief Completions for Objective-C protocols should be included in
4938 CXCompletionContext_ObjCProtocol = 1 << 15,
4940 * \brief Completions for Objective-C categories should be included in
4943 CXCompletionContext_ObjCCategory = 1 << 16,
4945 * \brief Completions for Objective-C instance messages should be included
4948 CXCompletionContext_ObjCInstanceMessage = 1 << 17,
4950 * \brief Completions for Objective-C class messages should be included in
4953 CXCompletionContext_ObjCClassMessage = 1 << 18,
4955 * \brief Completions for Objective-C selector names should be included in
4958 CXCompletionContext_ObjCSelectorName = 1 << 19,
4961 * \brief Completions for preprocessor macro names should be included in
4964 CXCompletionContext_MacroName = 1 << 20,
4967 * \brief Natural language completions should be included in the results.
4969 CXCompletionContext_NaturalLanguage = 1 << 21,
4972 * \brief The current context is unknown, so set all contexts.
4974 CXCompletionContext_Unknown = ((1 << 22) - 1)
4978 * \brief Returns a default set of code-completion options that can be
4979 * passed to\c clang_codeCompleteAt().
4981 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
4984 * \brief Perform code completion at a given location in a translation unit.
4986 * This function performs code completion at a particular file, line, and
4987 * column within source code, providing results that suggest potential
4988 * code snippets based on the context of the completion. The basic model
4989 * for code completion is that Clang will parse a complete source file,
4990 * performing syntax checking up to the location where code-completion has
4991 * been requested. At that point, a special code-completion token is passed
4992 * to the parser, which recognizes this token and determines, based on the
4993 * current location in the C/Objective-C/C++ grammar and the state of
4994 * semantic analysis, what completions to provide. These completions are
4995 * returned via a new \c CXCodeCompleteResults structure.
4997 * Code completion itself is meant to be triggered by the client when the
4998 * user types punctuation characters or whitespace, at which point the
4999 * code-completion location will coincide with the cursor. For example, if \c p
5000 * is a pointer, code-completion might be triggered after the "-" and then
5001 * after the ">" in \c p->. When the code-completion location is afer the ">",
5002 * the completion results will provide, e.g., the members of the struct that
5003 * "p" points to. The client is responsible for placing the cursor at the
5004 * beginning of the token currently being typed, then filtering the results
5005 * based on the contents of the token. For example, when code-completing for
5006 * the expression \c p->get, the client should provide the location just after
5007 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5008 * client can filter the results based on the current token text ("get"), only
5009 * showing those results that start with "get". The intent of this interface
5010 * is to separate the relatively high-latency acquisition of code-completion
5011 * results from the filtering of results on a per-character basis, which must
5012 * have a lower latency.
5014 * \param TU The translation unit in which code-completion should
5015 * occur. The source files for this translation unit need not be
5016 * completely up-to-date (and the contents of those source files may
5017 * be overridden via \p unsaved_files). Cursors referring into the
5018 * translation unit may be invalidated by this invocation.
5020 * \param complete_filename The name of the source file where code
5021 * completion should be performed. This filename may be any file
5022 * included in the translation unit.
5024 * \param complete_line The line at which code-completion should occur.
5026 * \param complete_column The column at which code-completion should occur.
5027 * Note that the column should point just after the syntactic construct that
5028 * initiated code completion, and not in the middle of a lexical token.
5030 * \param unsaved_files the Files that have not yet been saved to disk
5031 * but may be required for parsing or code completion, including the
5032 * contents of those files. The contents and name of these files (as
5033 * specified by CXUnsavedFile) are copied when necessary, so the
5034 * client only needs to guarantee their validity until the call to
5035 * this function returns.
5037 * \param num_unsaved_files The number of unsaved file entries in \p
5040 * \param options Extra options that control the behavior of code
5041 * completion, expressed as a bitwise OR of the enumerators of the
5042 * CXCodeComplete_Flags enumeration. The
5043 * \c clang_defaultCodeCompleteOptions() function returns a default set
5044 * of code-completion options.
5046 * \returns If successful, a new \c CXCodeCompleteResults structure
5047 * containing code-completion results, which should eventually be
5048 * freed with \c clang_disposeCodeCompleteResults(). If code
5049 * completion fails, returns NULL.
5052 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
5053 const char *complete_filename,
5054 unsigned complete_line,
5055 unsigned complete_column,
5056 struct CXUnsavedFile *unsaved_files,
5057 unsigned num_unsaved_files,
5061 * \brief Sort the code-completion results in case-insensitive alphabetical
5064 * \param Results The set of results to sort.
5065 * \param NumResults The number of results in \p Results.
5068 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
5069 unsigned NumResults);
5072 * \brief Free the given set of code-completion results.
5075 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
5078 * \brief Determine the number of diagnostics produced prior to the
5079 * location where code completion was performed.
5082 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
5085 * \brief Retrieve a diagnostic associated with the given code completion.
5087 * \param Results the code completion results to query.
5088 * \param Index the zero-based diagnostic number to retrieve.
5090 * \returns the requested diagnostic. This diagnostic must be freed
5091 * via a call to \c clang_disposeDiagnostic().
5094 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
5098 * \brief Determines what completions are appropriate for the context
5099 * the given code completion.
5101 * \param Results the code completion results to query
5103 * \returns the kinds of completions that are appropriate for use
5104 * along with the given code completion results.
5107 unsigned long long clang_codeCompleteGetContexts(
5108 CXCodeCompleteResults *Results);
5111 * \brief Returns the cursor kind for the container for the current code
5112 * completion context. The container is only guaranteed to be set for
5113 * contexts where a container exists (i.e. member accesses or Objective-C
5114 * message sends); if there is not a container, this function will return
5115 * CXCursor_InvalidCode.
5117 * \param Results the code completion results to query
5119 * \param IsIncomplete on return, this value will be false if Clang has complete
5120 * information about the container. If Clang does not have complete
5121 * information, this value will be true.
5123 * \returns the container kind, or CXCursor_InvalidCode if there is not a
5127 enum CXCursorKind clang_codeCompleteGetContainerKind(
5128 CXCodeCompleteResults *Results,
5129 unsigned *IsIncomplete);
5132 * \brief Returns the USR for the container for the current code completion
5133 * context. If there is not a container for the current context, this
5134 * function will return the empty string.
5136 * \param Results the code completion results to query
5138 * \returns the USR for the container
5141 CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
5144 * \brief Returns the currently-entered selector for an Objective-C message
5145 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5146 * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5147 * CXCompletionContext_ObjCClassMessage.
5149 * \param Results the code completion results to query
5151 * \returns the selector (or partial selector) that has been entered thus far
5152 * for an Objective-C message send.
5155 CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
5162 * \defgroup CINDEX_MISC Miscellaneous utility functions
5168 * \brief Return a version string, suitable for showing to a user, but not
5169 * intended to be parsed (the format is not guaranteed to be stable).
5171 CINDEX_LINKAGE CXString clang_getClangVersion(void);
5174 * \brief Enable/disable crash recovery.
5176 * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5177 * value enables crash recovery, while 0 disables it.
5179 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
5182 * \brief Visitor invoked for each file in a translation unit
5183 * (used with clang_getInclusions()).
5185 * This visitor function will be invoked by clang_getInclusions() for each
5186 * file included (either at the top-level or by \#include directives) within
5187 * a translation unit. The first argument is the file being included, and
5188 * the second and third arguments provide the inclusion stack. The
5189 * array is sorted in order of immediate inclusion. For example,
5190 * the first element refers to the location that included 'included_file'.
5192 typedef void (*CXInclusionVisitor)(CXFile included_file,
5193 CXSourceLocation* inclusion_stack,
5194 unsigned include_len,
5195 CXClientData client_data);
5198 * \brief Visit the set of preprocessor inclusions in a translation unit.
5199 * The visitor function is called with the provided data for every included
5200 * file. This does not include headers included by the PCH file (unless one
5201 * is inspecting the inclusions in the PCH file itself).
5203 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5204 CXInclusionVisitor visitor,
5205 CXClientData client_data);
5210 CXEval_ObjCStrLiteral = 3,
5211 CXEval_StrLiteral = 4,
5215 CXEval_UnExposed = 0
5217 } CXEvalResultKind ;
5220 * \brief Evaluation result of a cursor
5222 typedef void * CXEvalResult;
5225 * \brief If cursor is a statement declaration tries to evaluate the
5226 * statement and if its variable, tries to evaluate its initializer,
5227 * into its corresponding type.
5229 CINDEX_LINKAGE CXEvalResult clang_Cursor_Evaluate(CXCursor C);
5232 * \brief Returns the kind of the evaluated result.
5234 CINDEX_LINKAGE CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E);
5237 * \brief Returns the evaluation result as integer if the
5240 CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
5243 * \brief Returns the evaluation result as double if the
5246 CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
5249 * \brief Returns the evaluation result as a constant string if the
5250 * kind is other than Int or float. User must not free this pointer,
5251 * instead call clang_EvalResult_dispose on the CXEvalResult returned
5252 * by clang_Cursor_Evaluate.
5254 CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
5257 * \brief Disposes the created Eval memory.
5259 CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
5264 /** \defgroup CINDEX_REMAPPING Remapping functions
5270 * \brief A remapping of original source files and their translated files.
5272 typedef void *CXRemapping;
5275 * \brief Retrieve a remapping.
5277 * \param path the path that contains metadata about remappings.
5279 * \returns the requested remapping. This remapping must be freed
5280 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5282 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5285 * \brief Retrieve a remapping.
5287 * \param filePaths pointer to an array of file paths containing remapping info.
5289 * \param numFiles number of file paths.
5291 * \returns the requested remapping. This remapping must be freed
5292 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5295 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5299 * \brief Determine the number of remappings.
5301 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5304 * \brief Get the original and the associated filename from the remapping.
5306 * \param original If non-NULL, will be set to the original filename.
5308 * \param transformed If non-NULL, will be set to the filename that the original
5309 * is associated with.
5311 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5312 CXString *original, CXString *transformed);
5315 * \brief Dispose the remapping.
5317 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5323 /** \defgroup CINDEX_HIGH Higher level API functions
5328 enum CXVisitorResult {
5333 typedef struct CXCursorAndRangeVisitor {
5335 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5336 } CXCursorAndRangeVisitor;
5340 * \brief Function returned successfully.
5342 CXResult_Success = 0,
5344 * \brief One of the parameters was invalid for the function.
5346 CXResult_Invalid = 1,
5348 * \brief The function was terminated by a callback (e.g. it returned
5351 CXResult_VisitBreak = 2
5356 * \brief Find references of a declaration in a specific file.
5358 * \param cursor pointing to a declaration or a reference of one.
5360 * \param file to search for references.
5362 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5363 * each reference found.
5364 * The CXSourceRange will point inside the file; if the reference is inside
5365 * a macro (and not a macro argument) the CXSourceRange will be invalid.
5367 * \returns one of the CXResult enumerators.
5369 CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file,
5370 CXCursorAndRangeVisitor visitor);
5373 * \brief Find #import/#include directives in a specific file.
5375 * \param TU translation unit containing the file to query.
5377 * \param file to search for #import/#include directives.
5379 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5380 * each directive found.
5382 * \returns one of the CXResult enumerators.
5384 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5386 CXCursorAndRangeVisitor visitor);
5388 #ifdef __has_feature
5389 # if __has_feature(blocks)
5391 typedef enum CXVisitorResult
5392 (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5395 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5396 CXCursorAndRangeVisitorBlock);
5399 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5400 CXCursorAndRangeVisitorBlock);
5406 * \brief The client's data object that is associated with a CXFile.
5408 typedef void *CXIdxClientFile;
5411 * \brief The client's data object that is associated with a semantic entity.
5413 typedef void *CXIdxClientEntity;
5416 * \brief The client's data object that is associated with a semantic container
5419 typedef void *CXIdxClientContainer;
5422 * \brief The client's data object that is associated with an AST file (PCH
5425 typedef void *CXIdxClientASTFile;
5428 * \brief Source location passed to index callbacks.
5436 * \brief Data for ppIncludedFile callback.
5440 * \brief Location of '#' in the \#include/\#import directive.
5444 * \brief Filename as written in the \#include/\#import directive.
5446 const char *filename;
5448 * \brief The actual file that the \#include/\#import directive resolved to.
5454 * \brief Non-zero if the directive was automatically turned into a module
5458 } CXIdxIncludedFileInfo;
5461 * \brief Data for IndexerCallbacks#importedASTFile.
5465 * \brief Top level AST file containing the imported PCH, module or submodule.
5469 * \brief The imported module or NULL if the AST file is a PCH.
5473 * \brief Location where the file is imported. Applicable only for modules.
5477 * \brief Non-zero if an inclusion directive was automatically turned into
5478 * a module import. Applicable only for modules.
5482 } CXIdxImportedASTFileInfo;
5485 CXIdxEntity_Unexposed = 0,
5486 CXIdxEntity_Typedef = 1,
5487 CXIdxEntity_Function = 2,
5488 CXIdxEntity_Variable = 3,
5489 CXIdxEntity_Field = 4,
5490 CXIdxEntity_EnumConstant = 5,
5492 CXIdxEntity_ObjCClass = 6,
5493 CXIdxEntity_ObjCProtocol = 7,
5494 CXIdxEntity_ObjCCategory = 8,
5496 CXIdxEntity_ObjCInstanceMethod = 9,
5497 CXIdxEntity_ObjCClassMethod = 10,
5498 CXIdxEntity_ObjCProperty = 11,
5499 CXIdxEntity_ObjCIvar = 12,
5501 CXIdxEntity_Enum = 13,
5502 CXIdxEntity_Struct = 14,
5503 CXIdxEntity_Union = 15,
5505 CXIdxEntity_CXXClass = 16,
5506 CXIdxEntity_CXXNamespace = 17,
5507 CXIdxEntity_CXXNamespaceAlias = 18,
5508 CXIdxEntity_CXXStaticVariable = 19,
5509 CXIdxEntity_CXXStaticMethod = 20,
5510 CXIdxEntity_CXXInstanceMethod = 21,
5511 CXIdxEntity_CXXConstructor = 22,
5512 CXIdxEntity_CXXDestructor = 23,
5513 CXIdxEntity_CXXConversionFunction = 24,
5514 CXIdxEntity_CXXTypeAlias = 25,
5515 CXIdxEntity_CXXInterface = 26
5520 CXIdxEntityLang_None = 0,
5521 CXIdxEntityLang_C = 1,
5522 CXIdxEntityLang_ObjC = 2,
5523 CXIdxEntityLang_CXX = 3
5524 } CXIdxEntityLanguage;
5527 * \brief Extra C++ template information for an entity. This can apply to:
5528 * CXIdxEntity_Function
5529 * CXIdxEntity_CXXClass
5530 * CXIdxEntity_CXXStaticMethod
5531 * CXIdxEntity_CXXInstanceMethod
5532 * CXIdxEntity_CXXConstructor
5533 * CXIdxEntity_CXXConversionFunction
5534 * CXIdxEntity_CXXTypeAlias
5537 CXIdxEntity_NonTemplate = 0,
5538 CXIdxEntity_Template = 1,
5539 CXIdxEntity_TemplatePartialSpecialization = 2,
5540 CXIdxEntity_TemplateSpecialization = 3
5541 } CXIdxEntityCXXTemplateKind;
5544 CXIdxAttr_Unexposed = 0,
5545 CXIdxAttr_IBAction = 1,
5546 CXIdxAttr_IBOutlet = 2,
5547 CXIdxAttr_IBOutletCollection = 3
5557 CXIdxEntityKind kind;
5558 CXIdxEntityCXXTemplateKind templateKind;
5559 CXIdxEntityLanguage lang;
5563 const CXIdxAttrInfo *const *attributes;
5564 unsigned numAttributes;
5569 } CXIdxContainerInfo;
5572 const CXIdxAttrInfo *attrInfo;
5573 const CXIdxEntityInfo *objcClass;
5574 CXCursor classCursor;
5576 } CXIdxIBOutletCollectionAttrInfo;
5579 CXIdxDeclFlag_Skipped = 0x1
5580 } CXIdxDeclInfoFlags;
5583 const CXIdxEntityInfo *entityInfo;
5586 const CXIdxContainerInfo *semanticContainer;
5588 * \brief Generally same as #semanticContainer but can be different in
5589 * cases like out-of-line C++ member functions.
5591 const CXIdxContainerInfo *lexicalContainer;
5592 int isRedeclaration;
5595 const CXIdxContainerInfo *declAsContainer;
5597 * \brief Whether the declaration exists in code or was created implicitly
5598 * by the compiler, e.g. implicit Objective-C methods for properties.
5601 const CXIdxAttrInfo *const *attributes;
5602 unsigned numAttributes;
5609 CXIdxObjCContainer_ForwardRef = 0,
5610 CXIdxObjCContainer_Interface = 1,
5611 CXIdxObjCContainer_Implementation = 2
5612 } CXIdxObjCContainerKind;
5615 const CXIdxDeclInfo *declInfo;
5616 CXIdxObjCContainerKind kind;
5617 } CXIdxObjCContainerDeclInfo;
5620 const CXIdxEntityInfo *base;
5623 } CXIdxBaseClassInfo;
5626 const CXIdxEntityInfo *protocol;
5629 } CXIdxObjCProtocolRefInfo;
5632 const CXIdxObjCProtocolRefInfo *const *protocols;
5633 unsigned numProtocols;
5634 } CXIdxObjCProtocolRefListInfo;
5637 const CXIdxObjCContainerDeclInfo *containerInfo;
5638 const CXIdxBaseClassInfo *superInfo;
5639 const CXIdxObjCProtocolRefListInfo *protocols;
5640 } CXIdxObjCInterfaceDeclInfo;
5643 const CXIdxObjCContainerDeclInfo *containerInfo;
5644 const CXIdxEntityInfo *objcClass;
5645 CXCursor classCursor;
5647 const CXIdxObjCProtocolRefListInfo *protocols;
5648 } CXIdxObjCCategoryDeclInfo;
5651 const CXIdxDeclInfo *declInfo;
5652 const CXIdxEntityInfo *getter;
5653 const CXIdxEntityInfo *setter;
5654 } CXIdxObjCPropertyDeclInfo;
5657 const CXIdxDeclInfo *declInfo;
5658 const CXIdxBaseClassInfo *const *bases;
5660 } CXIdxCXXClassDeclInfo;
5663 * \brief Data for IndexerCallbacks#indexEntityReference.
5667 * \brief The entity is referenced directly in user's code.
5669 CXIdxEntityRef_Direct = 1,
5671 * \brief An implicit reference, e.g. a reference of an Objective-C method
5672 * via the dot syntax.
5674 CXIdxEntityRef_Implicit = 2
5675 } CXIdxEntityRefKind;
5678 * \brief Data for IndexerCallbacks#indexEntityReference.
5681 CXIdxEntityRefKind kind;
5683 * \brief Reference cursor.
5688 * \brief The entity that gets referenced.
5690 const CXIdxEntityInfo *referencedEntity;
5692 * \brief Immediate "parent" of the reference. For example:
5698 * The parent of reference of type 'Foo' is the variable 'var'.
5699 * For references inside statement bodies of functions/methods,
5700 * the parentEntity will be the function/method.
5702 const CXIdxEntityInfo *parentEntity;
5704 * \brief Lexical container context of the reference.
5706 const CXIdxContainerInfo *container;
5707 } CXIdxEntityRefInfo;
5710 * \brief A group of callbacks used by #clang_indexSourceFile and
5711 * #clang_indexTranslationUnit.
5715 * \brief Called periodically to check whether indexing should be aborted.
5716 * Should return 0 to continue, and non-zero to abort.
5718 int (*abortQuery)(CXClientData client_data, void *reserved);
5721 * \brief Called at the end of indexing; passes the complete diagnostic set.
5723 void (*diagnostic)(CXClientData client_data,
5724 CXDiagnosticSet, void *reserved);
5726 CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
5727 CXFile mainFile, void *reserved);
5730 * \brief Called when a file gets \#included/\#imported.
5732 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
5733 const CXIdxIncludedFileInfo *);
5736 * \brief Called when a AST file (PCH or module) gets imported.
5738 * AST files will not get indexed (there will not be callbacks to index all
5739 * the entities in an AST file). The recommended action is that, if the AST
5740 * file is not already indexed, to initiate a new indexing job specific to
5743 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
5744 const CXIdxImportedASTFileInfo *);
5747 * \brief Called at the beginning of indexing a translation unit.
5749 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
5752 void (*indexDeclaration)(CXClientData client_data,
5753 const CXIdxDeclInfo *);
5756 * \brief Called to index a reference of an entity.
5758 void (*indexEntityReference)(CXClientData client_data,
5759 const CXIdxEntityRefInfo *);
5763 CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
5764 CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
5765 clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
5767 CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
5768 clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
5771 const CXIdxObjCCategoryDeclInfo *
5772 clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
5774 CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
5775 clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
5777 CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
5778 clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
5780 CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
5781 clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
5783 CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
5784 clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
5787 * \brief For retrieving a custom CXIdxClientContainer attached to a
5790 CINDEX_LINKAGE CXIdxClientContainer
5791 clang_index_getClientContainer(const CXIdxContainerInfo *);
5794 * \brief For setting a custom CXIdxClientContainer attached to a
5798 clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
5801 * \brief For retrieving a custom CXIdxClientEntity attached to an entity.
5803 CINDEX_LINKAGE CXIdxClientEntity
5804 clang_index_getClientEntity(const CXIdxEntityInfo *);
5807 * \brief For setting a custom CXIdxClientEntity attached to an entity.
5810 clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
5813 * \brief An indexing action/session, to be applied to one or multiple
5814 * translation units.
5816 typedef void *CXIndexAction;
5819 * \brief An indexing action/session, to be applied to one or multiple
5820 * translation units.
5822 * \param CIdx The index object with which the index action will be associated.
5824 CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
5827 * \brief Destroy the given index action.
5829 * The index action must not be destroyed until all of the translation units
5830 * created within that index action have been destroyed.
5832 CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
5836 * \brief Used to indicate that no special indexing options are needed.
5838 CXIndexOpt_None = 0x0,
5841 * \brief Used to indicate that IndexerCallbacks#indexEntityReference should
5842 * be invoked for only one reference of an entity per source file that does
5843 * not also include a declaration/definition of the entity.
5845 CXIndexOpt_SuppressRedundantRefs = 0x1,
5848 * \brief Function-local symbols should be indexed. If this is not set
5849 * function-local symbols will be ignored.
5851 CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
5854 * \brief Implicit function/class template instantiations should be indexed.
5855 * If this is not set, implicit instantiations will be ignored.
5857 CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
5860 * \brief Suppress all compiler warnings when parsing for indexing.
5862 CXIndexOpt_SuppressWarnings = 0x8,
5865 * \brief Skip a function/method body that was already parsed during an
5866 * indexing session associated with a \c CXIndexAction object.
5867 * Bodies in system headers are always skipped.
5869 CXIndexOpt_SkipParsedBodiesInSession = 0x10
5874 * \brief Index the given source file and the translation unit corresponding
5875 * to that file via callbacks implemented through #IndexerCallbacks.
5877 * \param client_data pointer data supplied by the client, which will
5878 * be passed to the invoked callbacks.
5880 * \param index_callbacks Pointer to indexing callbacks that the client
5883 * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
5884 * passed in index_callbacks.
5886 * \param index_options A bitmask of options that affects how indexing is
5887 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
5889 * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
5890 * reused after indexing is finished. Set to \c NULL if you do not require it.
5892 * \returns 0 on success or if there were errors from which the compiler could
5893 * recover. If there is a failure from which there is no recovery, returns
5894 * a non-zero \c CXErrorCode.
5896 * The rest of the parameters are the same as #clang_parseTranslationUnit.
5898 CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
5899 CXClientData client_data,
5900 IndexerCallbacks *index_callbacks,
5901 unsigned index_callbacks_size,
5902 unsigned index_options,
5903 const char *source_filename,
5904 const char * const *command_line_args,
5905 int num_command_line_args,
5906 struct CXUnsavedFile *unsaved_files,
5907 unsigned num_unsaved_files,
5908 CXTranslationUnit *out_TU,
5909 unsigned TU_options);
5912 * \brief Same as clang_indexSourceFile but requires a full command line
5913 * for \c command_line_args including argv[0]. This is useful if the standard
5914 * library paths are relative to the binary.
5916 CINDEX_LINKAGE int clang_indexSourceFileFullArgv(
5917 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
5918 unsigned index_callbacks_size, unsigned index_options,
5919 const char *source_filename, const char *const *command_line_args,
5920 int num_command_line_args, struct CXUnsavedFile *unsaved_files,
5921 unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
5924 * \brief Index the given translation unit via callbacks implemented through
5925 * #IndexerCallbacks.
5927 * The order of callback invocations is not guaranteed to be the same as
5928 * when indexing a source file. The high level order will be:
5930 * -Preprocessor callbacks invocations
5931 * -Declaration/reference callbacks invocations
5932 * -Diagnostic callback invocations
5934 * The parameters are the same as #clang_indexSourceFile.
5936 * \returns If there is a failure from which there is no recovery, returns
5937 * non-zero, otherwise returns 0.
5939 CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
5940 CXClientData client_data,
5941 IndexerCallbacks *index_callbacks,
5942 unsigned index_callbacks_size,
5943 unsigned index_options,
5947 * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by
5948 * the given CXIdxLoc.
5950 * If the location refers into a macro expansion, retrieves the
5951 * location of the macro expansion and if it refers into a macro argument
5952 * retrieves the location of the argument.
5954 CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
5955 CXIdxClientFile *indexFile,
5962 * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
5965 CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
5968 * \brief Visitor invoked for each field found by a traversal.
5970 * This visitor function will be invoked for each field found by
5971 * \c clang_Type_visitFields. Its first argument is the cursor being
5972 * visited, its second argument is the client data provided to
5973 * \c clang_Type_visitFields.
5975 * The visitor should return one of the \c CXVisitorResult values
5976 * to direct \c clang_Type_visitFields.
5978 typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
5979 CXClientData client_data);
5982 * \brief Visit the fields of a particular type.
5984 * This function visits all the direct fields of the given cursor,
5985 * invoking the given \p visitor function with the cursors of each
5986 * visited field. The traversal may be ended prematurely, if
5987 * the visitor returns \c CXFieldVisit_Break.
5989 * \param T the record type whose field may be visited.
5991 * \param visitor the visitor function that will be invoked for each
5994 * \param client_data pointer data supplied by the client, which will
5995 * be passed to the visitor each time it is invoked.
5997 * \returns a non-zero value if the traversal was terminated
5998 * prematurely by the visitor returning \c CXFieldVisit_Break.
6000 CINDEX_LINKAGE unsigned clang_Type_visitFields(CXType T,
6001 CXFieldVisitor visitor,
6002 CXClientData client_data);