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 41
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 An opaque type representing target information for a given translation
87 typedef struct CXTargetInfoImpl *CXTargetInfo;
90 * \brief A single translation unit, which resides in an index.
92 typedef struct CXTranslationUnitImpl *CXTranslationUnit;
95 * \brief Opaque pointer representing client data that will be passed through
96 * to various callbacks and visitors.
98 typedef void *CXClientData;
101 * \brief Provides the contents of a file that has not yet been saved to disk.
103 * Each CXUnsavedFile instance provides the name of a file on the
104 * system along with the current contents of that file that have not
105 * yet been saved to disk.
107 struct CXUnsavedFile {
109 * \brief The file whose contents have not yet been saved.
111 * This file must already exist in the file system.
113 const char *Filename;
116 * \brief A buffer containing the unsaved contents of this file.
118 const char *Contents;
121 * \brief The length of the unsaved contents of this buffer.
123 unsigned long Length;
127 * \brief Describes the availability of a particular entity, which indicates
128 * whether the use of this entity will result in a warning or error due to
129 * it being deprecated or unavailable.
131 enum CXAvailabilityKind {
133 * \brief The entity is available.
135 CXAvailability_Available,
137 * \brief The entity is available, but has been deprecated (and its use is
140 CXAvailability_Deprecated,
142 * \brief The entity is not available; any use of it will be an error.
144 CXAvailability_NotAvailable,
146 * \brief The entity is available, but not accessible; any use of it will be
149 CXAvailability_NotAccessible
153 * \brief Describes a version number of the form major.minor.subminor.
155 typedef struct CXVersion {
157 * \brief The major version number, e.g., the '10' in '10.7.3'. A negative
158 * value indicates that there is no version number at all.
162 * \brief The minor version number, e.g., the '7' in '10.7.3'. This value
163 * will be negative if no minor version number was provided, e.g., for
168 * \brief The subminor version number, e.g., the '3' in '10.7.3'. This value
169 * will be negative if no minor or subminor version number was provided,
170 * e.g., in version '10' or '10.7'.
176 * \brief Provides a shared context for creating translation units.
178 * It provides two options:
180 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
181 * declarations (when loading any new translation units). A "local" declaration
182 * is one that belongs in the translation unit itself and not in a precompiled
183 * header that was used by the translation unit. If zero, all declarations
184 * will be enumerated.
186 * Here is an example:
189 * // excludeDeclsFromPCH = 1, displayDiagnostics=1
190 * Idx = clang_createIndex(1, 1);
192 * // IndexTest.pch was produced with the following command:
193 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
194 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
196 * // This will load all the symbols from 'IndexTest.pch'
197 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
198 * TranslationUnitVisitor, 0);
199 * clang_disposeTranslationUnit(TU);
201 * // This will load all the symbols from 'IndexTest.c', excluding symbols
202 * // from 'IndexTest.pch'.
203 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
204 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
206 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
207 * TranslationUnitVisitor, 0);
208 * clang_disposeTranslationUnit(TU);
211 * This process of creating the 'pch', loading it separately, and using it (via
212 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
213 * (which gives the indexer the same performance benefit as the compiler).
215 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
216 int displayDiagnostics);
219 * \brief Destroy the given index.
221 * The index must not be destroyed until all of the translation units created
222 * within that index have been destroyed.
224 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
228 * \brief Used to indicate that no special CXIndex options are needed.
230 CXGlobalOpt_None = 0x0,
233 * \brief Used to indicate that threads that libclang creates for indexing
234 * purposes should use background priority.
236 * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
237 * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
239 CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1,
242 * \brief Used to indicate that threads that libclang creates for editing
243 * purposes should use background priority.
245 * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
246 * #clang_annotateTokens
248 CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2,
251 * \brief Used to indicate that all threads that libclang creates should use
252 * background priority.
254 CXGlobalOpt_ThreadBackgroundPriorityForAll =
255 CXGlobalOpt_ThreadBackgroundPriorityForIndexing |
256 CXGlobalOpt_ThreadBackgroundPriorityForEditing
261 * \brief Sets general options associated with a CXIndex.
266 * clang_CXIndex_setGlobalOptions(idx,
267 * clang_CXIndex_getGlobalOptions(idx) |
268 * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
271 * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
273 CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
276 * \brief Gets the general options associated with a CXIndex.
278 * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
279 * are associated with the given CXIndex object.
281 CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex);
284 * \defgroup CINDEX_FILES File manipulation routines
290 * \brief A particular source file that is part of a translation unit.
292 typedef void *CXFile;
295 * \brief Retrieve the complete file and path name of the given file.
297 CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
300 * \brief Retrieve the last modification time of the given file.
302 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
305 * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
306 * across an indexing session.
309 unsigned long long data[3];
313 * \brief Retrieve the unique ID for the given \c file.
315 * \param file the file to get the ID for.
316 * \param outID stores the returned CXFileUniqueID.
317 * \returns If there was a failure getting the unique ID, returns non-zero,
318 * otherwise returns 0.
320 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
323 * \brief Determine whether the given header is guarded against
324 * multiple inclusions, either with the conventional
325 * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
327 CINDEX_LINKAGE unsigned
328 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
331 * \brief Retrieve a file handle within the given translation unit.
333 * \param tu the translation unit
335 * \param file_name the name of the file.
337 * \returns the file handle for the named file in the translation unit \p tu,
338 * or a NULL file handle if the file was not a part of this translation unit.
340 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
341 const char *file_name);
344 * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
345 * or they are both NULL.
347 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
354 * \defgroup CINDEX_LOCATIONS Physical source locations
356 * Clang represents physical source locations in its abstract syntax tree in
357 * great detail, with file, line, and column information for the majority of
358 * the tokens parsed in the source code. These data types and functions are
359 * used to represent source location information, either for a particular
360 * point in the program or for a range of points in the program, and extract
361 * specific location information from those data types.
367 * \brief Identifies a specific source location within a translation
370 * Use clang_getExpansionLocation() or clang_getSpellingLocation()
371 * to map a source location to a particular file, line, and column.
374 const void *ptr_data[2];
379 * \brief Identifies a half-open character range in the source code.
381 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
382 * starting and end locations from a source range, respectively.
385 const void *ptr_data[2];
386 unsigned begin_int_data;
387 unsigned end_int_data;
391 * \brief Retrieve a NULL (invalid) source location.
393 CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(void);
396 * \brief Determine whether two source locations, which must refer into
397 * the same translation unit, refer to exactly the same point in the source
400 * \returns non-zero if the source locations refer to the same location, zero
401 * if they refer to different locations.
403 CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
404 CXSourceLocation loc2);
407 * \brief Retrieves the source location associated with a given file/line/column
408 * in a particular translation unit.
410 CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
415 * \brief Retrieves the source location associated with a given character offset
416 * in a particular translation unit.
418 CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
423 * \brief Returns non-zero if the given source location is in a system header.
425 CINDEX_LINKAGE int clang_Location_isInSystemHeader(CXSourceLocation location);
428 * \brief Returns non-zero if the given source location is in the main file of
429 * the corresponding translation unit.
431 CINDEX_LINKAGE int clang_Location_isFromMainFile(CXSourceLocation location);
434 * \brief Retrieve a NULL (invalid) source range.
436 CINDEX_LINKAGE CXSourceRange clang_getNullRange(void);
439 * \brief Retrieve a source range given the beginning and ending source
442 CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
443 CXSourceLocation end);
446 * \brief Determine whether two ranges are equivalent.
448 * \returns non-zero if the ranges are the same, zero if they differ.
450 CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
451 CXSourceRange range2);
454 * \brief Returns non-zero if \p range is null.
456 CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
459 * \brief Retrieve the file, line, column, and offset represented by
460 * the given source location.
462 * If the location refers into a macro expansion, retrieves the
463 * location of the macro expansion.
465 * \param location the location within a source file that will be decomposed
468 * \param file [out] if non-NULL, will be set to the file to which the given
469 * source location points.
471 * \param line [out] if non-NULL, will be set to the line to which the given
472 * source location points.
474 * \param column [out] if non-NULL, will be set to the column to which the given
475 * source location points.
477 * \param offset [out] if non-NULL, will be set to the offset into the
478 * buffer to which the given source location points.
480 CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location,
487 * \brief Retrieve the file, line and column represented by the given source
488 * location, as specified in a # line directive.
490 * Example: given the following source code in a file somefile.c
495 * static int func(void)
501 * the location information returned by this function would be
503 * File: dummy.c Line: 124 Column: 12
505 * whereas clang_getExpansionLocation would have returned
507 * File: somefile.c Line: 3 Column: 12
509 * \param location the location within a source file that will be decomposed
512 * \param filename [out] if non-NULL, will be set to the filename of the
513 * source location. Note that filenames returned will be for "virtual" files,
514 * which don't necessarily exist on the machine running clang - e.g. when
515 * parsing preprocessed output obtained from a different environment. If
516 * a non-NULL value is passed in, remember to dispose of the returned value
517 * using \c clang_disposeString() once you've finished with it. For an invalid
518 * source location, an empty string is returned.
520 * \param line [out] if non-NULL, will be set to the line number of the
521 * source location. For an invalid source location, zero is returned.
523 * \param column [out] if non-NULL, will be set to the column number of the
524 * source location. For an invalid source location, zero is returned.
526 CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location,
532 * \brief Legacy API to retrieve the file, line, column, and offset represented
533 * by the given source location.
535 * This interface has been replaced by the newer interface
536 * #clang_getExpansionLocation(). See that interface's documentation for
539 CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
546 * \brief Retrieve the file, line, column, and offset represented by
547 * the given source location.
549 * If the location refers into a macro instantiation, return where the
550 * location was originally spelled in the source file.
552 * \param location the location within a source file that will be decomposed
555 * \param file [out] if non-NULL, will be set to the file to which the given
556 * source location points.
558 * \param line [out] if non-NULL, will be set to the line to which the given
559 * source location points.
561 * \param column [out] if non-NULL, will be set to the column to which the given
562 * source location points.
564 * \param offset [out] if non-NULL, will be set to the offset into the
565 * buffer to which the given source location points.
567 CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
574 * \brief Retrieve the file, line, column, and offset represented by
575 * the given source location.
577 * If the location refers into a macro expansion, return where the macro was
578 * expanded or where the macro argument was written, if the location points at
581 * \param location the location within a source file that will be decomposed
584 * \param file [out] if non-NULL, will be set to the file to which the given
585 * source location points.
587 * \param line [out] if non-NULL, will be set to the line to which the given
588 * source location points.
590 * \param column [out] if non-NULL, will be set to the column to which the given
591 * source location points.
593 * \param offset [out] if non-NULL, will be set to the offset into the
594 * buffer to which the given source location points.
596 CINDEX_LINKAGE void clang_getFileLocation(CXSourceLocation location,
603 * \brief Retrieve a source location representing the first character within a
606 CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
609 * \brief Retrieve a source location representing the last character within a
612 CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
615 * \brief Identifies an array of ranges.
618 /** \brief The number of ranges in the \c ranges array. */
621 * \brief An array of \c CXSourceRanges.
623 CXSourceRange *ranges;
627 * \brief Retrieve all ranges that were skipped by the preprocessor.
629 * The preprocessor will skip lines when they are surrounded by an
630 * if/ifdef/ifndef directive whose condition does not evaluate to true.
632 CINDEX_LINKAGE CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit tu,
636 * \brief Retrieve all ranges from all files that were skipped by the
639 * The preprocessor will skip lines when they are surrounded by an
640 * if/ifdef/ifndef directive whose condition does not evaluate to true.
642 CINDEX_LINKAGE CXSourceRangeList *clang_getAllSkippedRanges(CXTranslationUnit tu);
645 * \brief Destroy the given \c CXSourceRangeList.
647 CINDEX_LINKAGE void clang_disposeSourceRangeList(CXSourceRangeList *ranges);
654 * \defgroup CINDEX_DIAG Diagnostic reporting
660 * \brief Describes the severity of a particular diagnostic.
662 enum CXDiagnosticSeverity {
664 * \brief A diagnostic that has been suppressed, e.g., by a command-line
667 CXDiagnostic_Ignored = 0,
670 * \brief This diagnostic is a note that should be attached to the
671 * previous (non-note) diagnostic.
673 CXDiagnostic_Note = 1,
676 * \brief This diagnostic indicates suspicious code that may not be
679 CXDiagnostic_Warning = 2,
682 * \brief This diagnostic indicates that the code is ill-formed.
684 CXDiagnostic_Error = 3,
687 * \brief This diagnostic indicates that the code is ill-formed such
688 * that future parser recovery is unlikely to produce useful
691 CXDiagnostic_Fatal = 4
695 * \brief A single diagnostic, containing the diagnostic's severity,
696 * location, text, source ranges, and fix-it hints.
698 typedef void *CXDiagnostic;
701 * \brief A group of CXDiagnostics.
703 typedef void *CXDiagnosticSet;
706 * \brief Determine the number of diagnostics in a CXDiagnosticSet.
708 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
711 * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
713 * \param Diags the CXDiagnosticSet to query.
714 * \param Index the zero-based diagnostic number to retrieve.
716 * \returns the requested diagnostic. This diagnostic must be freed
717 * via a call to \c clang_disposeDiagnostic().
719 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
723 * \brief Describes the kind of error that occurred (if any) in a call to
724 * \c clang_loadDiagnostics.
726 enum CXLoadDiag_Error {
728 * \brief Indicates that no error occurred.
733 * \brief Indicates that an unknown error occurred while attempting to
734 * deserialize diagnostics.
736 CXLoadDiag_Unknown = 1,
739 * \brief Indicates that the file containing the serialized diagnostics
740 * could not be opened.
742 CXLoadDiag_CannotLoad = 2,
745 * \brief Indicates that the serialized diagnostics file is invalid or
748 CXLoadDiag_InvalidFile = 3
752 * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
755 * \param file The name of the file to deserialize.
756 * \param error A pointer to a enum value recording if there was a problem
757 * deserializing the diagnostics.
758 * \param errorString A pointer to a CXString for recording the error string
759 * if the file was not successfully loaded.
761 * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
762 * diagnostics should be released using clang_disposeDiagnosticSet().
764 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
765 enum CXLoadDiag_Error *error,
766 CXString *errorString);
769 * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
771 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
774 * \brief Retrieve the child diagnostics of a CXDiagnostic.
776 * This CXDiagnosticSet does not need to be released by
777 * clang_disposeDiagnosticSet.
779 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
782 * \brief Determine the number of diagnostics produced for the given
785 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
788 * \brief Retrieve a diagnostic associated with the given translation unit.
790 * \param Unit the translation unit to query.
791 * \param Index the zero-based diagnostic number to retrieve.
793 * \returns the requested diagnostic. This diagnostic must be freed
794 * via a call to \c clang_disposeDiagnostic().
796 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
800 * \brief Retrieve the complete set of diagnostics associated with a
803 * \param Unit the translation unit to query.
805 CINDEX_LINKAGE CXDiagnosticSet
806 clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
809 * \brief Destroy a diagnostic.
811 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
814 * \brief Options to control the display of diagnostics.
816 * The values in this enum are meant to be combined to customize the
817 * behavior of \c clang_formatDiagnostic().
819 enum CXDiagnosticDisplayOptions {
821 * \brief Display the source-location information where the
822 * diagnostic was located.
824 * When set, diagnostics will be prefixed by the file, line, and
825 * (optionally) column to which the diagnostic refers. For example,
828 * test.c:28: warning: extra tokens at end of #endif directive
831 * This option corresponds to the clang flag \c -fshow-source-location.
833 CXDiagnostic_DisplaySourceLocation = 0x01,
836 * \brief If displaying the source-location information of the
837 * diagnostic, also include the column number.
839 * This option corresponds to the clang flag \c -fshow-column.
841 CXDiagnostic_DisplayColumn = 0x02,
844 * \brief If displaying the source-location information of the
845 * diagnostic, also include information about source ranges in a
846 * machine-parsable format.
848 * This option corresponds to the clang flag
849 * \c -fdiagnostics-print-source-range-info.
851 CXDiagnostic_DisplaySourceRanges = 0x04,
854 * \brief Display the option name associated with this diagnostic, if any.
856 * The option name displayed (e.g., -Wconversion) will be placed in brackets
857 * after the diagnostic text. This option corresponds to the clang flag
858 * \c -fdiagnostics-show-option.
860 CXDiagnostic_DisplayOption = 0x08,
863 * \brief Display the category number associated with this diagnostic, if any.
865 * The category number is displayed within brackets after the diagnostic text.
866 * This option corresponds to the clang flag
867 * \c -fdiagnostics-show-category=id.
869 CXDiagnostic_DisplayCategoryId = 0x10,
872 * \brief Display the category name associated with this diagnostic, if any.
874 * The category name is displayed within brackets after the diagnostic text.
875 * This option corresponds to the clang flag
876 * \c -fdiagnostics-show-category=name.
878 CXDiagnostic_DisplayCategoryName = 0x20
882 * \brief Format the given diagnostic in a manner that is suitable for display.
884 * This routine will format the given diagnostic to a string, rendering
885 * the diagnostic according to the various options given. The
886 * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
887 * options that most closely mimics the behavior of the clang compiler.
889 * \param Diagnostic The diagnostic to print.
891 * \param Options A set of options that control the diagnostic display,
892 * created by combining \c CXDiagnosticDisplayOptions values.
894 * \returns A new string containing for formatted diagnostic.
896 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
900 * \brief Retrieve the set of display options most similar to the
901 * default behavior of the clang compiler.
903 * \returns A set of display options suitable for use with \c
904 * clang_formatDiagnostic().
906 CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
909 * \brief Determine the severity of the given diagnostic.
911 CINDEX_LINKAGE enum CXDiagnosticSeverity
912 clang_getDiagnosticSeverity(CXDiagnostic);
915 * \brief Retrieve the source location of the given diagnostic.
917 * This location is where Clang would print the caret ('^') when
918 * displaying the diagnostic on the command line.
920 CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
923 * \brief Retrieve the text of the given diagnostic.
925 CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
928 * \brief Retrieve the name of the command-line option that enabled this
931 * \param Diag The diagnostic to be queried.
933 * \param Disable If non-NULL, will be set to the option that disables this
934 * diagnostic (if any).
936 * \returns A string that contains the command-line option used to enable this
937 * warning, such as "-Wconversion" or "-pedantic".
939 CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
943 * \brief Retrieve the category number for this diagnostic.
945 * Diagnostics can be categorized into groups along with other, related
946 * diagnostics (e.g., diagnostics under the same warning flag). This routine
947 * retrieves the category number for the given diagnostic.
949 * \returns The number of the category that contains this diagnostic, or zero
950 * if this diagnostic is uncategorized.
952 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
955 * \brief Retrieve the name of a particular diagnostic category. This
956 * is now deprecated. Use clang_getDiagnosticCategoryText()
959 * \param Category A diagnostic category number, as returned by
960 * \c clang_getDiagnosticCategory().
962 * \returns The name of the given diagnostic category.
964 CINDEX_DEPRECATED CINDEX_LINKAGE
965 CXString clang_getDiagnosticCategoryName(unsigned Category);
968 * \brief Retrieve the diagnostic category text for a given diagnostic.
970 * \returns The text of the given diagnostic category.
972 CINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic);
975 * \brief Determine the number of source ranges associated with the given
978 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
981 * \brief Retrieve a source range associated with the diagnostic.
983 * A diagnostic's source ranges highlight important elements in the source
984 * code. On the command line, Clang displays source ranges by
985 * underlining them with '~' characters.
987 * \param Diagnostic the diagnostic whose range is being extracted.
989 * \param Range the zero-based index specifying which range to
991 * \returns the requested source range.
993 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
997 * \brief Determine the number of fix-it hints associated with the
1000 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
1003 * \brief Retrieve the replacement information for a given fix-it.
1005 * Fix-its are described in terms of a source range whose contents
1006 * should be replaced by a string. This approach generalizes over
1007 * three kinds of operations: removal of source code (the range covers
1008 * the code to be removed and the replacement string is empty),
1009 * replacement of source code (the range covers the code to be
1010 * replaced and the replacement string provides the new code), and
1011 * insertion (both the start and end of the range point at the
1012 * insertion location, and the replacement string provides the text to
1015 * \param Diagnostic The diagnostic whose fix-its are being queried.
1017 * \param FixIt The zero-based index of the fix-it.
1019 * \param ReplacementRange The source range whose contents will be
1020 * replaced with the returned replacement string. Note that source
1021 * ranges are half-open ranges [a, b), so the source code should be
1022 * replaced from a and up to (but not including) b.
1024 * \returns A string containing text that should be replace the source
1025 * code indicated by the \c ReplacementRange.
1027 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1029 CXSourceRange *ReplacementRange);
1036 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1038 * The routines in this group provide the ability to create and destroy
1039 * translation units from files, either by parsing the contents of the files or
1040 * by reading in a serialized representation of a translation unit.
1046 * \brief Get the original translation unit source file name.
1048 CINDEX_LINKAGE CXString
1049 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1052 * \brief Return the CXTranslationUnit for a given source file and the provided
1053 * command line arguments one would pass to the compiler.
1055 * Note: The 'source_filename' argument is optional. If the caller provides a
1056 * NULL pointer, the name of the source file is expected to reside in the
1057 * specified command line arguments.
1059 * Note: When encountered in 'clang_command_line_args', the following options
1065 * '-o \<output file>' (both '-o' and '\<output file>' are ignored)
1067 * \param CIdx The index object with which the translation unit will be
1070 * \param source_filename The name of the source file to load, or NULL if the
1071 * source file is included in \p clang_command_line_args.
1073 * \param num_clang_command_line_args The number of command-line arguments in
1074 * \p clang_command_line_args.
1076 * \param clang_command_line_args The command-line arguments that would be
1077 * passed to the \c clang executable if it were being invoked out-of-process.
1078 * These command-line options will be parsed and will affect how the translation
1079 * unit is parsed. Note that the following options are ignored: '-c',
1080 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1082 * \param num_unsaved_files the number of unsaved file entries in \p
1085 * \param unsaved_files the files that have not yet been saved to disk
1086 * but may be required for code completion, including the contents of
1087 * those files. The contents and name of these files (as specified by
1088 * CXUnsavedFile) are copied when necessary, so the client only needs to
1089 * guarantee their validity until the call to this function returns.
1091 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
1093 const char *source_filename,
1094 int num_clang_command_line_args,
1095 const char * const *clang_command_line_args,
1096 unsigned num_unsaved_files,
1097 struct CXUnsavedFile *unsaved_files);
1100 * \brief Same as \c clang_createTranslationUnit2, but returns
1101 * the \c CXTranslationUnit instead of an error code. In case of an error this
1102 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1105 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(
1107 const char *ast_filename);
1110 * \brief Create a translation unit from an AST file (\c -emit-ast).
1112 * \param[out] out_TU A non-NULL pointer to store the created
1113 * \c CXTranslationUnit.
1115 * \returns Zero on success, otherwise returns an error code.
1117 CINDEX_LINKAGE enum CXErrorCode clang_createTranslationUnit2(
1119 const char *ast_filename,
1120 CXTranslationUnit *out_TU);
1123 * \brief Flags that control the creation of translation units.
1125 * The enumerators in this enumeration type are meant to be bitwise
1126 * ORed together to specify which options should be used when
1127 * constructing the translation unit.
1129 enum CXTranslationUnit_Flags {
1131 * \brief Used to indicate that no special translation-unit options are
1134 CXTranslationUnit_None = 0x0,
1137 * \brief Used to indicate that the parser should construct a "detailed"
1138 * preprocessing record, including all macro definitions and instantiations.
1140 * Constructing a detailed preprocessing record requires more memory
1141 * and time to parse, since the information contained in the record
1142 * is usually not retained. However, it can be useful for
1143 * applications that require more detailed information about the
1144 * behavior of the preprocessor.
1146 CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
1149 * \brief Used to indicate that the translation unit is incomplete.
1151 * When a translation unit is considered "incomplete", semantic
1152 * analysis that is typically performed at the end of the
1153 * translation unit will be suppressed. For example, this suppresses
1154 * the completion of tentative declarations in C and of
1155 * instantiation of implicitly-instantiation function templates in
1156 * C++. This option is typically used when parsing a header with the
1157 * intent of producing a precompiled header.
1159 CXTranslationUnit_Incomplete = 0x02,
1162 * \brief Used to indicate that the translation unit should be built with an
1163 * implicit precompiled header for the preamble.
1165 * An implicit precompiled header is used as an optimization when a
1166 * particular translation unit is likely to be reparsed many times
1167 * when the sources aren't changing that often. In this case, an
1168 * implicit precompiled header will be built containing all of the
1169 * initial includes at the top of the main file (what we refer to as
1170 * the "preamble" of the file). In subsequent parses, if the
1171 * preamble or the files in it have not changed, \c
1172 * clang_reparseTranslationUnit() will re-use the implicit
1173 * precompiled header to improve parsing performance.
1175 CXTranslationUnit_PrecompiledPreamble = 0x04,
1178 * \brief Used to indicate that the translation unit should cache some
1179 * code-completion results with each reparse of the source file.
1181 * Caching of code-completion results is a performance optimization that
1182 * introduces some overhead to reparsing but improves the performance of
1183 * code-completion operations.
1185 CXTranslationUnit_CacheCompletionResults = 0x08,
1188 * \brief Used to indicate that the translation unit will be serialized with
1189 * \c clang_saveTranslationUnit.
1191 * This option is typically used when parsing a header with the intent of
1192 * producing a precompiled header.
1194 CXTranslationUnit_ForSerialization = 0x10,
1197 * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1199 * Note: this is a *temporary* option that is available only while
1200 * we are testing C++ precompiled preamble support. It is deprecated.
1202 CXTranslationUnit_CXXChainedPCH = 0x20,
1205 * \brief Used to indicate that function/method bodies should be skipped while
1208 * This option can be used to search for declarations/definitions while
1209 * ignoring the usages.
1211 CXTranslationUnit_SkipFunctionBodies = 0x40,
1214 * \brief Used to indicate that brief documentation comments should be
1215 * included into the set of code completions returned from this translation
1218 CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80,
1221 * \brief Used to indicate that the precompiled preamble should be created on
1222 * the first parse. Otherwise it will be created on the first reparse. This
1223 * trades runtime on the first parse (serializing the preamble takes time) for
1224 * reduced runtime on the second parse (can now reuse the preamble).
1226 CXTranslationUnit_CreatePreambleOnFirstParse = 0x100,
1229 * \brief Do not stop processing when fatal errors are encountered.
1231 * When fatal errors are encountered while parsing a translation unit,
1232 * semantic analysis is typically stopped early when compiling code. A common
1233 * source for fatal errors are unresolvable include files. For the
1234 * purposes of an IDE, this is undesirable behavior and as much information
1235 * as possible should be reported. Use this flag to enable this behavior.
1237 CXTranslationUnit_KeepGoing = 0x200
1241 * \brief Returns the set of flags that is suitable for parsing a translation
1242 * unit that is being edited.
1244 * The set of flags returned provide options for \c clang_parseTranslationUnit()
1245 * to indicate that the translation unit is likely to be reparsed many times,
1246 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1247 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1248 * set contains an unspecified set of optimizations (e.g., the precompiled
1249 * preamble) geared toward improving the performance of these routines. The
1250 * set of optimizations enabled may change from one version to the next.
1252 CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
1255 * \brief Same as \c clang_parseTranslationUnit2, but returns
1256 * the \c CXTranslationUnit instead of an error code. In case of an error this
1257 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1260 CINDEX_LINKAGE CXTranslationUnit
1261 clang_parseTranslationUnit(CXIndex CIdx,
1262 const char *source_filename,
1263 const char *const *command_line_args,
1264 int num_command_line_args,
1265 struct CXUnsavedFile *unsaved_files,
1266 unsigned num_unsaved_files,
1270 * \brief Parse the given source file and the translation unit corresponding
1273 * This routine is the main entry point for the Clang C API, providing the
1274 * ability to parse a source file into a translation unit that can then be
1275 * queried by other functions in the API. This routine accepts a set of
1276 * command-line arguments so that the compilation can be configured in the same
1277 * way that the compiler is configured on the command line.
1279 * \param CIdx The index object with which the translation unit will be
1282 * \param source_filename The name of the source file to load, or NULL if the
1283 * source file is included in \c command_line_args.
1285 * \param command_line_args The command-line arguments that would be
1286 * passed to the \c clang executable if it were being invoked out-of-process.
1287 * These command-line options will be parsed and will affect how the translation
1288 * unit is parsed. Note that the following options are ignored: '-c',
1289 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1291 * \param num_command_line_args The number of command-line arguments in
1292 * \c command_line_args.
1294 * \param unsaved_files the files that have not yet been saved to disk
1295 * but may be required for parsing, including the contents of
1296 * those files. The contents and name of these files (as specified by
1297 * CXUnsavedFile) are copied when necessary, so the client only needs to
1298 * guarantee their validity until the call to this function returns.
1300 * \param num_unsaved_files the number of unsaved file entries in \p
1303 * \param options A bitmask of options that affects how the translation unit
1304 * is managed but not its compilation. This should be a bitwise OR of the
1305 * CXTranslationUnit_XXX flags.
1307 * \param[out] out_TU A non-NULL pointer to store the created
1308 * \c CXTranslationUnit, describing the parsed code and containing any
1309 * diagnostics produced by the compiler.
1311 * \returns Zero on success, otherwise returns an error code.
1313 CINDEX_LINKAGE enum CXErrorCode
1314 clang_parseTranslationUnit2(CXIndex CIdx,
1315 const char *source_filename,
1316 const char *const *command_line_args,
1317 int num_command_line_args,
1318 struct CXUnsavedFile *unsaved_files,
1319 unsigned num_unsaved_files,
1321 CXTranslationUnit *out_TU);
1324 * \brief Same as clang_parseTranslationUnit2 but requires a full command line
1325 * for \c command_line_args including argv[0]. This is useful if the standard
1326 * library paths are relative to the binary.
1328 CINDEX_LINKAGE enum CXErrorCode clang_parseTranslationUnit2FullArgv(
1329 CXIndex CIdx, const char *source_filename,
1330 const char *const *command_line_args, int num_command_line_args,
1331 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
1332 unsigned options, CXTranslationUnit *out_TU);
1335 * \brief Flags that control how translation units are saved.
1337 * The enumerators in this enumeration type are meant to be bitwise
1338 * ORed together to specify which options should be used when
1339 * saving the translation unit.
1341 enum CXSaveTranslationUnit_Flags {
1343 * \brief Used to indicate that no special saving options are needed.
1345 CXSaveTranslationUnit_None = 0x0
1349 * \brief Returns the set of flags that is suitable for saving a translation
1352 * The set of flags returned provide options for
1353 * \c clang_saveTranslationUnit() by default. The returned flag
1354 * set contains an unspecified set of options that save translation units with
1355 * the most commonly-requested data.
1357 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1360 * \brief Describes the kind of error that occurred (if any) in a call to
1361 * \c clang_saveTranslationUnit().
1365 * \brief Indicates that no error occurred while saving a translation unit.
1367 CXSaveError_None = 0,
1370 * \brief Indicates that an unknown error occurred while attempting to save
1373 * This error typically indicates that file I/O failed when attempting to
1376 CXSaveError_Unknown = 1,
1379 * \brief Indicates that errors during translation prevented this attempt
1380 * to save the translation unit.
1382 * Errors that prevent the translation unit from being saved can be
1383 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1385 CXSaveError_TranslationErrors = 2,
1388 * \brief Indicates that the translation unit to be saved was somehow
1389 * invalid (e.g., NULL).
1391 CXSaveError_InvalidTU = 3
1395 * \brief Saves a translation unit into a serialized representation of
1396 * that translation unit on disk.
1398 * Any translation unit that was parsed without error can be saved
1399 * into a file. The translation unit can then be deserialized into a
1400 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1401 * if it is an incomplete translation unit that corresponds to a
1402 * header, used as a precompiled header when parsing other translation
1405 * \param TU The translation unit to save.
1407 * \param FileName The file to which the translation unit will be saved.
1409 * \param options A bitmask of options that affects how the translation unit
1410 * is saved. This should be a bitwise OR of the
1411 * CXSaveTranslationUnit_XXX flags.
1413 * \returns A value that will match one of the enumerators of the CXSaveError
1414 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1415 * saved successfully, while a non-zero value indicates that a problem occurred.
1417 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1418 const char *FileName,
1422 * \brief Suspend a translation unit in order to free memory associated with it.
1424 * A suspended translation unit uses significantly less memory but on the other
1425 * side does not support any other calls than \c clang_reparseTranslationUnit
1426 * to resume it or \c clang_disposeTranslationUnit to dispose it completely.
1428 CINDEX_LINKAGE unsigned clang_suspendTranslationUnit(CXTranslationUnit);
1431 * \brief Destroy the specified CXTranslationUnit object.
1433 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1436 * \brief Flags that control the reparsing of translation units.
1438 * The enumerators in this enumeration type are meant to be bitwise
1439 * ORed together to specify which options should be used when
1440 * reparsing the translation unit.
1442 enum CXReparse_Flags {
1444 * \brief Used to indicate that no special reparsing options are needed.
1446 CXReparse_None = 0x0
1450 * \brief Returns the set of flags that is suitable for reparsing a translation
1453 * The set of flags returned provide options for
1454 * \c clang_reparseTranslationUnit() by default. The returned flag
1455 * set contains an unspecified set of optimizations geared toward common uses
1456 * of reparsing. The set of optimizations enabled may change from one version
1459 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1462 * \brief Reparse the source files that produced this translation unit.
1464 * This routine can be used to re-parse the source files that originally
1465 * created the given translation unit, for example because those source files
1466 * have changed (either on disk or as passed via \p unsaved_files). The
1467 * source code will be reparsed with the same command-line options as it
1468 * was originally parsed.
1470 * Reparsing a translation unit invalidates all cursors and source locations
1471 * that refer into that translation unit. This makes reparsing a translation
1472 * unit semantically equivalent to destroying the translation unit and then
1473 * creating a new translation unit with the same command-line arguments.
1474 * However, it may be more efficient to reparse a translation
1475 * unit using this routine.
1477 * \param TU The translation unit whose contents will be re-parsed. The
1478 * translation unit must originally have been built with
1479 * \c clang_createTranslationUnitFromSourceFile().
1481 * \param num_unsaved_files The number of unsaved file entries in \p
1484 * \param unsaved_files The files that have not yet been saved to disk
1485 * but may be required for parsing, including the contents of
1486 * those files. The contents and name of these files (as specified by
1487 * CXUnsavedFile) are copied when necessary, so the client only needs to
1488 * guarantee their validity until the call to this function returns.
1490 * \param options A bitset of options composed of the flags in CXReparse_Flags.
1491 * The function \c clang_defaultReparseOptions() produces a default set of
1492 * options recommended for most uses, based on the translation unit.
1494 * \returns 0 if the sources could be reparsed. A non-zero error code will be
1495 * returned if reparsing was impossible, such that the translation unit is
1496 * invalid. In such cases, the only valid call for \c TU is
1497 * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1498 * routine are described by the \c CXErrorCode enum.
1500 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1501 unsigned num_unsaved_files,
1502 struct CXUnsavedFile *unsaved_files,
1506 * \brief Categorizes how memory is being used by a translation unit.
1508 enum CXTUResourceUsageKind {
1509 CXTUResourceUsage_AST = 1,
1510 CXTUResourceUsage_Identifiers = 2,
1511 CXTUResourceUsage_Selectors = 3,
1512 CXTUResourceUsage_GlobalCompletionResults = 4,
1513 CXTUResourceUsage_SourceManagerContentCache = 5,
1514 CXTUResourceUsage_AST_SideTables = 6,
1515 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
1516 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
1517 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
1518 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
1519 CXTUResourceUsage_Preprocessor = 11,
1520 CXTUResourceUsage_PreprocessingRecord = 12,
1521 CXTUResourceUsage_SourceManager_DataStructures = 13,
1522 CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
1523 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
1524 CXTUResourceUsage_MEMORY_IN_BYTES_END =
1525 CXTUResourceUsage_Preprocessor_HeaderSearch,
1527 CXTUResourceUsage_First = CXTUResourceUsage_AST,
1528 CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
1532 * \brief Returns the human-readable null-terminated C string that represents
1533 * the name of the memory category. This string should never be freed.
1536 const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
1538 typedef struct CXTUResourceUsageEntry {
1539 /* \brief The memory usage category. */
1540 enum CXTUResourceUsageKind kind;
1541 /* \brief Amount of resources used.
1542 The units will depend on the resource kind. */
1543 unsigned long amount;
1544 } CXTUResourceUsageEntry;
1547 * \brief The memory usage of a CXTranslationUnit, broken into categories.
1549 typedef struct CXTUResourceUsage {
1550 /* \brief Private data member, used for queries. */
1553 /* \brief The number of entries in the 'entries' array. */
1554 unsigned numEntries;
1556 /* \brief An array of key-value pairs, representing the breakdown of memory
1558 CXTUResourceUsageEntry *entries;
1560 } CXTUResourceUsage;
1563 * \brief Return the memory usage of a translation unit. This object
1564 * should be released with clang_disposeCXTUResourceUsage().
1566 CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
1568 CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
1571 * \brief Get target information for this translation unit.
1573 * The CXTargetInfo object cannot outlive the CXTranslationUnit object.
1575 CINDEX_LINKAGE CXTargetInfo
1576 clang_getTranslationUnitTargetInfo(CXTranslationUnit CTUnit);
1579 * \brief Destroy the CXTargetInfo object.
1582 clang_TargetInfo_dispose(CXTargetInfo Info);
1585 * \brief Get the normalized target triple as a string.
1587 * Returns the empty string in case of any error.
1589 CINDEX_LINKAGE CXString
1590 clang_TargetInfo_getTriple(CXTargetInfo Info);
1593 * \brief Get the pointer width of the target in bits.
1595 * Returns -1 in case of error.
1598 clang_TargetInfo_getPointerWidth(CXTargetInfo Info);
1605 * \brief Describes the kind of entity that a cursor refers to.
1610 * \brief A declaration whose specific kind is not exposed via this
1613 * Unexposed declarations have the same operations as any other kind
1614 * of declaration; one can extract their location information,
1615 * spelling, find their definitions, etc. However, the specific kind
1616 * of the declaration is not reported.
1618 CXCursor_UnexposedDecl = 1,
1619 /** \brief A C or C++ struct. */
1620 CXCursor_StructDecl = 2,
1621 /** \brief A C or C++ union. */
1622 CXCursor_UnionDecl = 3,
1623 /** \brief A C++ class. */
1624 CXCursor_ClassDecl = 4,
1625 /** \brief An enumeration. */
1626 CXCursor_EnumDecl = 5,
1628 * \brief A field (in C) or non-static data member (in C++) in a
1629 * struct, union, or C++ class.
1631 CXCursor_FieldDecl = 6,
1632 /** \brief An enumerator constant. */
1633 CXCursor_EnumConstantDecl = 7,
1634 /** \brief A function. */
1635 CXCursor_FunctionDecl = 8,
1636 /** \brief A variable. */
1637 CXCursor_VarDecl = 9,
1638 /** \brief A function or method parameter. */
1639 CXCursor_ParmDecl = 10,
1640 /** \brief An Objective-C \@interface. */
1641 CXCursor_ObjCInterfaceDecl = 11,
1642 /** \brief An Objective-C \@interface for a category. */
1643 CXCursor_ObjCCategoryDecl = 12,
1644 /** \brief An Objective-C \@protocol declaration. */
1645 CXCursor_ObjCProtocolDecl = 13,
1646 /** \brief An Objective-C \@property declaration. */
1647 CXCursor_ObjCPropertyDecl = 14,
1648 /** \brief An Objective-C instance variable. */
1649 CXCursor_ObjCIvarDecl = 15,
1650 /** \brief An Objective-C instance method. */
1651 CXCursor_ObjCInstanceMethodDecl = 16,
1652 /** \brief An Objective-C class method. */
1653 CXCursor_ObjCClassMethodDecl = 17,
1654 /** \brief An Objective-C \@implementation. */
1655 CXCursor_ObjCImplementationDecl = 18,
1656 /** \brief An Objective-C \@implementation for a category. */
1657 CXCursor_ObjCCategoryImplDecl = 19,
1658 /** \brief A typedef. */
1659 CXCursor_TypedefDecl = 20,
1660 /** \brief A C++ class method. */
1661 CXCursor_CXXMethod = 21,
1662 /** \brief A C++ namespace. */
1663 CXCursor_Namespace = 22,
1664 /** \brief A linkage specification, e.g. 'extern "C"'. */
1665 CXCursor_LinkageSpec = 23,
1666 /** \brief A C++ constructor. */
1667 CXCursor_Constructor = 24,
1668 /** \brief A C++ destructor. */
1669 CXCursor_Destructor = 25,
1670 /** \brief A C++ conversion function. */
1671 CXCursor_ConversionFunction = 26,
1672 /** \brief A C++ template type parameter. */
1673 CXCursor_TemplateTypeParameter = 27,
1674 /** \brief A C++ non-type template parameter. */
1675 CXCursor_NonTypeTemplateParameter = 28,
1676 /** \brief A C++ template template parameter. */
1677 CXCursor_TemplateTemplateParameter = 29,
1678 /** \brief A C++ function template. */
1679 CXCursor_FunctionTemplate = 30,
1680 /** \brief A C++ class template. */
1681 CXCursor_ClassTemplate = 31,
1682 /** \brief A C++ class template partial specialization. */
1683 CXCursor_ClassTemplatePartialSpecialization = 32,
1684 /** \brief A C++ namespace alias declaration. */
1685 CXCursor_NamespaceAlias = 33,
1686 /** \brief A C++ using directive. */
1687 CXCursor_UsingDirective = 34,
1688 /** \brief A C++ using declaration. */
1689 CXCursor_UsingDeclaration = 35,
1690 /** \brief A C++ alias declaration */
1691 CXCursor_TypeAliasDecl = 36,
1692 /** \brief An Objective-C \@synthesize definition. */
1693 CXCursor_ObjCSynthesizeDecl = 37,
1694 /** \brief An Objective-C \@dynamic definition. */
1695 CXCursor_ObjCDynamicDecl = 38,
1696 /** \brief An access specifier. */
1697 CXCursor_CXXAccessSpecifier = 39,
1699 CXCursor_FirstDecl = CXCursor_UnexposedDecl,
1700 CXCursor_LastDecl = CXCursor_CXXAccessSpecifier,
1703 CXCursor_FirstRef = 40, /* Decl references */
1704 CXCursor_ObjCSuperClassRef = 40,
1705 CXCursor_ObjCProtocolRef = 41,
1706 CXCursor_ObjCClassRef = 42,
1708 * \brief A reference to a type declaration.
1710 * A type reference occurs anywhere where a type is named but not
1711 * declared. For example, given:
1714 * typedef unsigned size_type;
1718 * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1719 * while the type of the variable "size" is referenced. The cursor
1720 * referenced by the type of size is the typedef for size_type.
1722 CXCursor_TypeRef = 43,
1723 CXCursor_CXXBaseSpecifier = 44,
1725 * \brief A reference to a class template, function template, template
1726 * template parameter, or class template partial specialization.
1728 CXCursor_TemplateRef = 45,
1730 * \brief A reference to a namespace or namespace alias.
1732 CXCursor_NamespaceRef = 46,
1734 * \brief A reference to a member of a struct, union, or class that occurs in
1735 * some non-expression context, e.g., a designated initializer.
1737 CXCursor_MemberRef = 47,
1739 * \brief A reference to a labeled statement.
1741 * This cursor kind is used to describe the jump to "start_over" in the
1742 * goto statement in the following example:
1751 * A label reference cursor refers to a label statement.
1753 CXCursor_LabelRef = 48,
1756 * \brief A reference to a set of overloaded functions or function templates
1757 * that has not yet been resolved to a specific function or function template.
1759 * An overloaded declaration reference cursor occurs in C++ templates where
1760 * a dependent name refers to a function. For example:
1763 * template<typename T> void swap(T&, T&);
1766 * void swap(X&, X&);
1768 * template<typename T>
1769 * void reverse(T* first, T* last) {
1770 * while (first < last - 1) {
1771 * swap(*first, *--last);
1777 * void swap(Y&, Y&);
1780 * Here, the identifier "swap" is associated with an overloaded declaration
1781 * reference. In the template definition, "swap" refers to either of the two
1782 * "swap" functions declared above, so both results will be available. At
1783 * instantiation time, "swap" may also refer to other functions found via
1784 * argument-dependent lookup (e.g., the "swap" function at the end of the
1787 * The functions \c clang_getNumOverloadedDecls() and
1788 * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1789 * referenced by this cursor.
1791 CXCursor_OverloadedDeclRef = 49,
1794 * \brief A reference to a variable that occurs in some non-expression
1795 * context, e.g., a C++ lambda capture list.
1797 CXCursor_VariableRef = 50,
1799 CXCursor_LastRef = CXCursor_VariableRef,
1801 /* Error conditions */
1802 CXCursor_FirstInvalid = 70,
1803 CXCursor_InvalidFile = 70,
1804 CXCursor_NoDeclFound = 71,
1805 CXCursor_NotImplemented = 72,
1806 CXCursor_InvalidCode = 73,
1807 CXCursor_LastInvalid = CXCursor_InvalidCode,
1810 CXCursor_FirstExpr = 100,
1813 * \brief An expression whose specific kind is not exposed via this
1816 * Unexposed expressions have the same operations as any other kind
1817 * of expression; one can extract their location information,
1818 * spelling, children, etc. However, the specific kind of the
1819 * expression is not reported.
1821 CXCursor_UnexposedExpr = 100,
1824 * \brief An expression that refers to some value declaration, such
1825 * as a function, variable, or enumerator.
1827 CXCursor_DeclRefExpr = 101,
1830 * \brief An expression that refers to a member of a struct, union,
1831 * class, Objective-C class, etc.
1833 CXCursor_MemberRefExpr = 102,
1835 /** \brief An expression that calls a function. */
1836 CXCursor_CallExpr = 103,
1838 /** \brief An expression that sends a message to an Objective-C
1840 CXCursor_ObjCMessageExpr = 104,
1842 /** \brief An expression that represents a block literal. */
1843 CXCursor_BlockExpr = 105,
1845 /** \brief An integer literal.
1847 CXCursor_IntegerLiteral = 106,
1849 /** \brief A floating point number literal.
1851 CXCursor_FloatingLiteral = 107,
1853 /** \brief An imaginary number literal.
1855 CXCursor_ImaginaryLiteral = 108,
1857 /** \brief A string literal.
1859 CXCursor_StringLiteral = 109,
1861 /** \brief A character literal.
1863 CXCursor_CharacterLiteral = 110,
1865 /** \brief A parenthesized expression, e.g. "(1)".
1867 * This AST node is only formed if full location information is requested.
1869 CXCursor_ParenExpr = 111,
1871 /** \brief This represents the unary-expression's (except sizeof and
1874 CXCursor_UnaryOperator = 112,
1876 /** \brief [C99 6.5.2.1] Array Subscripting.
1878 CXCursor_ArraySubscriptExpr = 113,
1880 /** \brief A builtin binary operation expression such as "x + y" or
1883 CXCursor_BinaryOperator = 114,
1885 /** \brief Compound assignment such as "+=".
1887 CXCursor_CompoundAssignOperator = 115,
1889 /** \brief The ?: ternary operator.
1891 CXCursor_ConditionalOperator = 116,
1893 /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1894 * (C++ [expr.cast]), which uses the syntax (Type)expr.
1896 * For example: (int)f.
1898 CXCursor_CStyleCastExpr = 117,
1900 /** \brief [C99 6.5.2.5]
1902 CXCursor_CompoundLiteralExpr = 118,
1904 /** \brief Describes an C or C++ initializer list.
1906 CXCursor_InitListExpr = 119,
1908 /** \brief The GNU address of label extension, representing &&label.
1910 CXCursor_AddrLabelExpr = 120,
1912 /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1914 CXCursor_StmtExpr = 121,
1916 /** \brief Represents a C11 generic selection.
1918 CXCursor_GenericSelectionExpr = 122,
1920 /** \brief Implements the GNU __null extension, which is a name for a null
1921 * pointer constant that has integral type (e.g., int or long) and is the same
1922 * size and alignment as a pointer.
1924 * The __null extension is typically only used by system headers, which define
1925 * NULL as __null in C++ rather than using 0 (which is an integer that may not
1926 * match the size of a pointer).
1928 CXCursor_GNUNullExpr = 123,
1930 /** \brief C++'s static_cast<> expression.
1932 CXCursor_CXXStaticCastExpr = 124,
1934 /** \brief C++'s dynamic_cast<> expression.
1936 CXCursor_CXXDynamicCastExpr = 125,
1938 /** \brief C++'s reinterpret_cast<> expression.
1940 CXCursor_CXXReinterpretCastExpr = 126,
1942 /** \brief C++'s const_cast<> expression.
1944 CXCursor_CXXConstCastExpr = 127,
1946 /** \brief Represents an explicit C++ type conversion that uses "functional"
1947 * notion (C++ [expr.type.conv]).
1954 CXCursor_CXXFunctionalCastExpr = 128,
1956 /** \brief A C++ typeid expression (C++ [expr.typeid]).
1958 CXCursor_CXXTypeidExpr = 129,
1960 /** \brief [C++ 2.13.5] C++ Boolean Literal.
1962 CXCursor_CXXBoolLiteralExpr = 130,
1964 /** \brief [C++0x 2.14.7] C++ Pointer Literal.
1966 CXCursor_CXXNullPtrLiteralExpr = 131,
1968 /** \brief Represents the "this" expression in C++
1970 CXCursor_CXXThisExpr = 132,
1972 /** \brief [C++ 15] C++ Throw Expression.
1974 * This handles 'throw' and 'throw' assignment-expression. When
1975 * assignment-expression isn't present, Op will be null.
1977 CXCursor_CXXThrowExpr = 133,
1979 /** \brief A new expression for memory allocation and constructor calls, e.g:
1980 * "new CXXNewExpr(foo)".
1982 CXCursor_CXXNewExpr = 134,
1984 /** \brief A delete expression for memory deallocation and destructor calls,
1985 * e.g. "delete[] pArray".
1987 CXCursor_CXXDeleteExpr = 135,
1989 /** \brief A unary expression. (noexcept, sizeof, or other traits)
1991 CXCursor_UnaryExpr = 136,
1993 /** \brief An Objective-C string literal i.e. @"foo".
1995 CXCursor_ObjCStringLiteral = 137,
1997 /** \brief An Objective-C \@encode expression.
1999 CXCursor_ObjCEncodeExpr = 138,
2001 /** \brief An Objective-C \@selector expression.
2003 CXCursor_ObjCSelectorExpr = 139,
2005 /** \brief An Objective-C \@protocol expression.
2007 CXCursor_ObjCProtocolExpr = 140,
2009 /** \brief An Objective-C "bridged" cast expression, which casts between
2010 * Objective-C pointers and C pointers, transferring ownership in the process.
2013 * NSString *str = (__bridge_transfer NSString *)CFCreateString();
2016 CXCursor_ObjCBridgedCastExpr = 141,
2018 /** \brief Represents a C++0x pack expansion that produces a sequence of
2021 * A pack expansion expression contains a pattern (which itself is an
2022 * expression) followed by an ellipsis. For example:
2025 * template<typename F, typename ...Types>
2026 * void forward(F f, Types &&...args) {
2027 * f(static_cast<Types&&>(args)...);
2031 CXCursor_PackExpansionExpr = 142,
2033 /** \brief Represents an expression that computes the length of a parameter
2037 * template<typename ...Types>
2039 * static const unsigned value = sizeof...(Types);
2043 CXCursor_SizeOfPackExpr = 143,
2045 /* \brief Represents a C++ lambda expression that produces a local function
2049 * void abssort(float *x, unsigned N) {
2050 * std::sort(x, x + N,
2051 * [](float a, float b) {
2052 * return std::abs(a) < std::abs(b);
2057 CXCursor_LambdaExpr = 144,
2059 /** \brief Objective-c Boolean Literal.
2061 CXCursor_ObjCBoolLiteralExpr = 145,
2063 /** \brief Represents the "self" expression in an Objective-C method.
2065 CXCursor_ObjCSelfExpr = 146,
2067 /** \brief OpenMP 4.0 [2.4, Array Section].
2069 CXCursor_OMPArraySectionExpr = 147,
2071 /** \brief Represents an @available(...) check.
2073 CXCursor_ObjCAvailabilityCheckExpr = 148,
2075 CXCursor_LastExpr = CXCursor_ObjCAvailabilityCheckExpr,
2078 CXCursor_FirstStmt = 200,
2080 * \brief A statement whose specific kind is not exposed via this
2083 * Unexposed statements have the same operations as any other kind of
2084 * statement; one can extract their location information, spelling,
2085 * children, etc. However, the specific kind of the statement is not
2088 CXCursor_UnexposedStmt = 200,
2090 /** \brief A labelled statement in a function.
2092 * This cursor kind is used to describe the "start_over:" label statement in
2093 * the following example:
2101 CXCursor_LabelStmt = 201,
2103 /** \brief A group of statements like { stmt stmt }.
2105 * This cursor kind is used to describe compound statements, e.g. function
2108 CXCursor_CompoundStmt = 202,
2110 /** \brief A case statement.
2112 CXCursor_CaseStmt = 203,
2114 /** \brief A default statement.
2116 CXCursor_DefaultStmt = 204,
2118 /** \brief An if statement
2120 CXCursor_IfStmt = 205,
2122 /** \brief A switch statement.
2124 CXCursor_SwitchStmt = 206,
2126 /** \brief A while statement.
2128 CXCursor_WhileStmt = 207,
2130 /** \brief A do statement.
2132 CXCursor_DoStmt = 208,
2134 /** \brief A for statement.
2136 CXCursor_ForStmt = 209,
2138 /** \brief A goto statement.
2140 CXCursor_GotoStmt = 210,
2142 /** \brief An indirect goto statement.
2144 CXCursor_IndirectGotoStmt = 211,
2146 /** \brief A continue statement.
2148 CXCursor_ContinueStmt = 212,
2150 /** \brief A break statement.
2152 CXCursor_BreakStmt = 213,
2154 /** \brief A return statement.
2156 CXCursor_ReturnStmt = 214,
2158 /** \brief A GCC inline assembly statement extension.
2160 CXCursor_GCCAsmStmt = 215,
2161 CXCursor_AsmStmt = CXCursor_GCCAsmStmt,
2163 /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2165 CXCursor_ObjCAtTryStmt = 216,
2167 /** \brief Objective-C's \@catch statement.
2169 CXCursor_ObjCAtCatchStmt = 217,
2171 /** \brief Objective-C's \@finally statement.
2173 CXCursor_ObjCAtFinallyStmt = 218,
2175 /** \brief Objective-C's \@throw statement.
2177 CXCursor_ObjCAtThrowStmt = 219,
2179 /** \brief Objective-C's \@synchronized statement.
2181 CXCursor_ObjCAtSynchronizedStmt = 220,
2183 /** \brief Objective-C's autorelease pool statement.
2185 CXCursor_ObjCAutoreleasePoolStmt = 221,
2187 /** \brief Objective-C's collection statement.
2189 CXCursor_ObjCForCollectionStmt = 222,
2191 /** \brief C++'s catch statement.
2193 CXCursor_CXXCatchStmt = 223,
2195 /** \brief C++'s try statement.
2197 CXCursor_CXXTryStmt = 224,
2199 /** \brief C++'s for (* : *) statement.
2201 CXCursor_CXXForRangeStmt = 225,
2203 /** \brief Windows Structured Exception Handling's try statement.
2205 CXCursor_SEHTryStmt = 226,
2207 /** \brief Windows Structured Exception Handling's except statement.
2209 CXCursor_SEHExceptStmt = 227,
2211 /** \brief Windows Structured Exception Handling's finally statement.
2213 CXCursor_SEHFinallyStmt = 228,
2215 /** \brief A MS inline assembly statement extension.
2217 CXCursor_MSAsmStmt = 229,
2219 /** \brief The null statement ";": C99 6.8.3p3.
2221 * This cursor kind is used to describe the null statement.
2223 CXCursor_NullStmt = 230,
2225 /** \brief Adaptor class for mixing declarations with statements and
2228 CXCursor_DeclStmt = 231,
2230 /** \brief OpenMP parallel directive.
2232 CXCursor_OMPParallelDirective = 232,
2234 /** \brief OpenMP SIMD directive.
2236 CXCursor_OMPSimdDirective = 233,
2238 /** \brief OpenMP for directive.
2240 CXCursor_OMPForDirective = 234,
2242 /** \brief OpenMP sections directive.
2244 CXCursor_OMPSectionsDirective = 235,
2246 /** \brief OpenMP section directive.
2248 CXCursor_OMPSectionDirective = 236,
2250 /** \brief OpenMP single directive.
2252 CXCursor_OMPSingleDirective = 237,
2254 /** \brief OpenMP parallel for directive.
2256 CXCursor_OMPParallelForDirective = 238,
2258 /** \brief OpenMP parallel sections directive.
2260 CXCursor_OMPParallelSectionsDirective = 239,
2262 /** \brief OpenMP task directive.
2264 CXCursor_OMPTaskDirective = 240,
2266 /** \brief OpenMP master directive.
2268 CXCursor_OMPMasterDirective = 241,
2270 /** \brief OpenMP critical directive.
2272 CXCursor_OMPCriticalDirective = 242,
2274 /** \brief OpenMP taskyield directive.
2276 CXCursor_OMPTaskyieldDirective = 243,
2278 /** \brief OpenMP barrier directive.
2280 CXCursor_OMPBarrierDirective = 244,
2282 /** \brief OpenMP taskwait directive.
2284 CXCursor_OMPTaskwaitDirective = 245,
2286 /** \brief OpenMP flush directive.
2288 CXCursor_OMPFlushDirective = 246,
2290 /** \brief Windows Structured Exception Handling's leave statement.
2292 CXCursor_SEHLeaveStmt = 247,
2294 /** \brief OpenMP ordered directive.
2296 CXCursor_OMPOrderedDirective = 248,
2298 /** \brief OpenMP atomic directive.
2300 CXCursor_OMPAtomicDirective = 249,
2302 /** \brief OpenMP for SIMD directive.
2304 CXCursor_OMPForSimdDirective = 250,
2306 /** \brief OpenMP parallel for SIMD directive.
2308 CXCursor_OMPParallelForSimdDirective = 251,
2310 /** \brief OpenMP target directive.
2312 CXCursor_OMPTargetDirective = 252,
2314 /** \brief OpenMP teams directive.
2316 CXCursor_OMPTeamsDirective = 253,
2318 /** \brief OpenMP taskgroup directive.
2320 CXCursor_OMPTaskgroupDirective = 254,
2322 /** \brief OpenMP cancellation point directive.
2324 CXCursor_OMPCancellationPointDirective = 255,
2326 /** \brief OpenMP cancel directive.
2328 CXCursor_OMPCancelDirective = 256,
2330 /** \brief OpenMP target data directive.
2332 CXCursor_OMPTargetDataDirective = 257,
2334 /** \brief OpenMP taskloop directive.
2336 CXCursor_OMPTaskLoopDirective = 258,
2338 /** \brief OpenMP taskloop simd directive.
2340 CXCursor_OMPTaskLoopSimdDirective = 259,
2342 /** \brief OpenMP distribute directive.
2344 CXCursor_OMPDistributeDirective = 260,
2346 /** \brief OpenMP target enter data directive.
2348 CXCursor_OMPTargetEnterDataDirective = 261,
2350 /** \brief OpenMP target exit data directive.
2352 CXCursor_OMPTargetExitDataDirective = 262,
2354 /** \brief OpenMP target parallel directive.
2356 CXCursor_OMPTargetParallelDirective = 263,
2358 /** \brief OpenMP target parallel for directive.
2360 CXCursor_OMPTargetParallelForDirective = 264,
2362 /** \brief OpenMP target update directive.
2364 CXCursor_OMPTargetUpdateDirective = 265,
2366 /** \brief OpenMP distribute parallel for directive.
2368 CXCursor_OMPDistributeParallelForDirective = 266,
2370 /** \brief OpenMP distribute parallel for simd directive.
2372 CXCursor_OMPDistributeParallelForSimdDirective = 267,
2374 /** \brief OpenMP distribute simd directive.
2376 CXCursor_OMPDistributeSimdDirective = 268,
2378 /** \brief OpenMP target parallel for simd directive.
2380 CXCursor_OMPTargetParallelForSimdDirective = 269,
2382 /** \brief OpenMP target simd directive.
2384 CXCursor_OMPTargetSimdDirective = 270,
2386 /** \brief OpenMP teams distribute directive.
2388 CXCursor_OMPTeamsDistributeDirective = 271,
2390 /** \brief OpenMP teams distribute simd directive.
2392 CXCursor_OMPTeamsDistributeSimdDirective = 272,
2394 /** \brief OpenMP teams distribute parallel for simd directive.
2396 CXCursor_OMPTeamsDistributeParallelForSimdDirective = 273,
2398 /** \brief OpenMP teams distribute parallel for directive.
2400 CXCursor_OMPTeamsDistributeParallelForDirective = 274,
2402 /** \brief OpenMP target teams directive.
2404 CXCursor_OMPTargetTeamsDirective = 275,
2406 /** \brief OpenMP target teams distribute directive.
2408 CXCursor_OMPTargetTeamsDistributeDirective = 276,
2410 /** \brief OpenMP target teams distribute parallel for directive.
2412 CXCursor_OMPTargetTeamsDistributeParallelForDirective = 277,
2414 /** \brief OpenMP target teams distribute parallel for simd directive.
2416 CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective = 278,
2418 /** \brief OpenMP target teams distribute simd directive.
2420 CXCursor_OMPTargetTeamsDistributeSimdDirective = 279,
2422 CXCursor_LastStmt = CXCursor_OMPTargetTeamsDistributeSimdDirective,
2425 * \brief Cursor that represents the translation unit itself.
2427 * The translation unit cursor exists primarily to act as the root
2428 * cursor for traversing the contents of a translation unit.
2430 CXCursor_TranslationUnit = 300,
2433 CXCursor_FirstAttr = 400,
2435 * \brief An attribute whose specific kind is not exposed via this
2438 CXCursor_UnexposedAttr = 400,
2440 CXCursor_IBActionAttr = 401,
2441 CXCursor_IBOutletAttr = 402,
2442 CXCursor_IBOutletCollectionAttr = 403,
2443 CXCursor_CXXFinalAttr = 404,
2444 CXCursor_CXXOverrideAttr = 405,
2445 CXCursor_AnnotateAttr = 406,
2446 CXCursor_AsmLabelAttr = 407,
2447 CXCursor_PackedAttr = 408,
2448 CXCursor_PureAttr = 409,
2449 CXCursor_ConstAttr = 410,
2450 CXCursor_NoDuplicateAttr = 411,
2451 CXCursor_CUDAConstantAttr = 412,
2452 CXCursor_CUDADeviceAttr = 413,
2453 CXCursor_CUDAGlobalAttr = 414,
2454 CXCursor_CUDAHostAttr = 415,
2455 CXCursor_CUDASharedAttr = 416,
2456 CXCursor_VisibilityAttr = 417,
2457 CXCursor_DLLExport = 418,
2458 CXCursor_DLLImport = 419,
2459 CXCursor_LastAttr = CXCursor_DLLImport,
2462 CXCursor_PreprocessingDirective = 500,
2463 CXCursor_MacroDefinition = 501,
2464 CXCursor_MacroExpansion = 502,
2465 CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
2466 CXCursor_InclusionDirective = 503,
2467 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
2468 CXCursor_LastPreprocessing = CXCursor_InclusionDirective,
2470 /* Extra Declarations */
2472 * \brief A module import declaration.
2474 CXCursor_ModuleImportDecl = 600,
2475 CXCursor_TypeAliasTemplateDecl = 601,
2477 * \brief A static_assert or _Static_assert node
2479 CXCursor_StaticAssert = 602,
2481 * \brief a friend declaration.
2483 CXCursor_FriendDecl = 603,
2484 CXCursor_FirstExtraDecl = CXCursor_ModuleImportDecl,
2485 CXCursor_LastExtraDecl = CXCursor_FriendDecl,
2488 * \brief A code completion overload candidate.
2490 CXCursor_OverloadCandidate = 700
2494 * \brief A cursor representing some element in the abstract syntax tree for
2495 * a translation unit.
2497 * The cursor abstraction unifies the different kinds of entities in a
2498 * program--declaration, statements, expressions, references to declarations,
2499 * etc.--under a single "cursor" abstraction with a common set of operations.
2500 * Common operation for a cursor include: getting the physical location in
2501 * a source file where the cursor points, getting the name associated with a
2502 * cursor, and retrieving cursors for any child nodes of a particular cursor.
2504 * Cursors can be produced in two specific ways.
2505 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2506 * from which one can use clang_visitChildren() to explore the rest of the
2507 * translation unit. clang_getCursor() maps from a physical source location
2508 * to the entity that resides at that location, allowing one to map from the
2509 * source code into the AST.
2512 enum CXCursorKind kind;
2514 const void *data[3];
2518 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2524 * \brief Retrieve the NULL cursor, which represents no entity.
2526 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
2529 * \brief Retrieve the cursor that represents the given translation unit.
2531 * The translation unit cursor can be used to start traversing the
2532 * various declarations within the given translation unit.
2534 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
2537 * \brief Determine whether two cursors are equivalent.
2539 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
2542 * \brief Returns non-zero if \p cursor is null.
2544 CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
2547 * \brief Compute a hash value for the given cursor.
2549 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
2552 * \brief Retrieve the kind of the given cursor.
2554 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
2557 * \brief Determine whether the given cursor kind represents a declaration.
2559 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
2562 * \brief Determine whether the given cursor kind represents a simple
2565 * Note that other kinds of cursors (such as expressions) can also refer to
2566 * other cursors. Use clang_getCursorReferenced() to determine whether a
2567 * particular cursor refers to another entity.
2569 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
2572 * \brief Determine whether the given cursor kind represents an expression.
2574 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
2577 * \brief Determine whether the given cursor kind represents a statement.
2579 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
2582 * \brief Determine whether the given cursor kind represents an attribute.
2584 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
2587 * \brief Determine whether the given cursor has any attributes.
2589 CINDEX_LINKAGE unsigned clang_Cursor_hasAttrs(CXCursor C);
2592 * \brief Determine whether the given cursor kind represents an invalid
2595 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
2598 * \brief Determine whether the given cursor kind represents a translation
2601 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
2604 * \brief Determine whether the given cursor represents a preprocessing
2605 * element, such as a preprocessor directive or macro instantiation.
2607 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
2610 * \brief Determine whether the given cursor represents a currently
2611 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2613 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
2616 * \brief Describe the linkage of the entity referred to by a cursor.
2618 enum CXLinkageKind {
2619 /** \brief This value indicates that no linkage information is available
2620 * for a provided CXCursor. */
2623 * \brief This is the linkage for variables, parameters, and so on that
2624 * have automatic storage. This covers normal (non-extern) local variables.
2626 CXLinkage_NoLinkage,
2627 /** \brief This is the linkage for static variables and static functions. */
2629 /** \brief This is the linkage for entities with external linkage that live
2630 * in C++ anonymous namespaces.*/
2631 CXLinkage_UniqueExternal,
2632 /** \brief This is the linkage for entities with true, external linkage. */
2637 * \brief Determine the linkage of the entity referred to by a given cursor.
2639 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
2641 enum CXVisibilityKind {
2642 /** \brief This value indicates that no visibility information is available
2643 * for a provided CXCursor. */
2644 CXVisibility_Invalid,
2646 /** \brief Symbol not seen by the linker. */
2647 CXVisibility_Hidden,
2648 /** \brief Symbol seen by the linker but resolves to a symbol inside this object. */
2649 CXVisibility_Protected,
2650 /** \brief Symbol seen by the linker and acts like a normal symbol. */
2651 CXVisibility_Default
2655 * \brief Describe the visibility of the entity referred to by a cursor.
2657 * This returns the default visibility if not explicitly specified by
2658 * a visibility attribute. The default visibility may be changed by
2659 * commandline arguments.
2661 * \param cursor The cursor to query.
2663 * \returns The visibility of the cursor.
2665 CINDEX_LINKAGE enum CXVisibilityKind clang_getCursorVisibility(CXCursor cursor);
2668 * \brief Determine the availability of the entity that this cursor refers to,
2669 * taking the current target platform into account.
2671 * \param cursor The cursor to query.
2673 * \returns The availability of the cursor.
2675 CINDEX_LINKAGE enum CXAvailabilityKind
2676 clang_getCursorAvailability(CXCursor cursor);
2679 * Describes the availability of a given entity on a particular platform, e.g.,
2680 * a particular class might only be available on Mac OS 10.7 or newer.
2682 typedef struct CXPlatformAvailability {
2684 * \brief A string that describes the platform for which this structure
2685 * provides availability information.
2687 * Possible values are "ios" or "macos".
2691 * \brief The version number in which this entity was introduced.
2693 CXVersion Introduced;
2695 * \brief The version number in which this entity was deprecated (but is
2698 CXVersion Deprecated;
2700 * \brief The version number in which this entity was obsoleted, and therefore
2701 * is no longer available.
2703 CXVersion Obsoleted;
2705 * \brief Whether the entity is unconditionally unavailable on this platform.
2709 * \brief An optional message to provide to a user of this API, e.g., to
2710 * suggest replacement APIs.
2713 } CXPlatformAvailability;
2716 * \brief Determine the availability of the entity that this cursor refers to
2717 * on any platforms for which availability information is known.
2719 * \param cursor The cursor to query.
2721 * \param always_deprecated If non-NULL, will be set to indicate whether the
2722 * entity is deprecated on all platforms.
2724 * \param deprecated_message If non-NULL, will be set to the message text
2725 * provided along with the unconditional deprecation of this entity. The client
2726 * is responsible for deallocating this string.
2728 * \param always_unavailable If non-NULL, will be set to indicate whether the
2729 * entity is unavailable on all platforms.
2731 * \param unavailable_message If non-NULL, will be set to the message text
2732 * provided along with the unconditional unavailability of this entity. The
2733 * client is responsible for deallocating this string.
2735 * \param availability If non-NULL, an array of CXPlatformAvailability instances
2736 * that will be populated with platform availability information, up to either
2737 * the number of platforms for which availability information is available (as
2738 * returned by this function) or \c availability_size, whichever is smaller.
2740 * \param availability_size The number of elements available in the
2741 * \c availability array.
2743 * \returns The number of platforms (N) for which availability information is
2744 * available (which is unrelated to \c availability_size).
2746 * Note that the client is responsible for calling
2747 * \c clang_disposeCXPlatformAvailability to free each of the
2748 * platform-availability structures returned. There are
2749 * \c min(N, availability_size) such structures.
2752 clang_getCursorPlatformAvailability(CXCursor cursor,
2753 int *always_deprecated,
2754 CXString *deprecated_message,
2755 int *always_unavailable,
2756 CXString *unavailable_message,
2757 CXPlatformAvailability *availability,
2758 int availability_size);
2761 * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2764 clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
2767 * \brief Describe the "language" of the entity referred to by a cursor.
2769 enum CXLanguageKind {
2770 CXLanguage_Invalid = 0,
2773 CXLanguage_CPlusPlus
2777 * \brief Determine the "language" of the entity referred to by a given cursor.
2779 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
2782 * \brief Returns the translation unit that a cursor originated from.
2784 CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
2787 * \brief A fast container representing a set of CXCursors.
2789 typedef struct CXCursorSetImpl *CXCursorSet;
2792 * \brief Creates an empty CXCursorSet.
2794 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2797 * \brief Disposes a CXCursorSet and releases its associated memory.
2799 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2802 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2804 * \returns non-zero if the set contains the specified cursor.
2806 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2810 * \brief Inserts a CXCursor into a CXCursorSet.
2812 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2814 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2818 * \brief Determine the semantic parent of the given cursor.
2820 * The semantic parent of a cursor is the cursor that semantically contains
2821 * the given \p cursor. For many declarations, the lexical and semantic parents
2822 * are equivalent (the lexical parent is returned by
2823 * \c clang_getCursorLexicalParent()). They diverge when declarations or
2824 * definitions are provided out-of-line. For example:
2834 * In the out-of-line definition of \c C::f, the semantic parent is
2835 * the class \c C, of which this function is a member. The lexical parent is
2836 * the place where the declaration actually occurs in the source code; in this
2837 * case, the definition occurs in the translation unit. In general, the
2838 * lexical parent for a given entity can change without affecting the semantics
2839 * of the program, and the lexical parent of different declarations of the
2840 * same entity may be different. Changing the semantic parent of a declaration,
2841 * on the other hand, can have a major impact on semantics, and redeclarations
2842 * of a particular entity should all have the same semantic context.
2844 * In the example above, both declarations of \c C::f have \c C as their
2845 * semantic context, while the lexical context of the first \c C::f is \c C
2846 * and the lexical context of the second \c C::f is the translation unit.
2848 * For global declarations, the semantic parent is the translation unit.
2850 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
2853 * \brief Determine the lexical parent of the given cursor.
2855 * The lexical parent of a cursor is the cursor in which the given \p cursor
2856 * was actually written. For many declarations, the lexical and semantic parents
2857 * are equivalent (the semantic parent is returned by
2858 * \c clang_getCursorSemanticParent()). They diverge when declarations or
2859 * definitions are provided out-of-line. For example:
2869 * In the out-of-line definition of \c C::f, the semantic parent is
2870 * the class \c C, of which this function is a member. The lexical parent is
2871 * the place where the declaration actually occurs in the source code; in this
2872 * case, the definition occurs in the translation unit. In general, the
2873 * lexical parent for a given entity can change without affecting the semantics
2874 * of the program, and the lexical parent of different declarations of the
2875 * same entity may be different. Changing the semantic parent of a declaration,
2876 * on the other hand, can have a major impact on semantics, and redeclarations
2877 * of a particular entity should all have the same semantic context.
2879 * In the example above, both declarations of \c C::f have \c C as their
2880 * semantic context, while the lexical context of the first \c C::f is \c C
2881 * and the lexical context of the second \c C::f is the translation unit.
2883 * For declarations written in the global scope, the lexical parent is
2884 * the translation unit.
2886 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
2889 * \brief Determine the set of methods that are overridden by the given
2892 * In both Objective-C and C++, a method (aka virtual member function,
2893 * in C++) can override a virtual method in a base class. For
2894 * Objective-C, a method is said to override any method in the class's
2895 * base class, its protocols, or its categories' protocols, that has the same
2896 * selector and is of the same kind (class or instance).
2897 * If no such method exists, the search continues to the class's superclass,
2898 * its protocols, and its categories, and so on. A method from an Objective-C
2899 * implementation is considered to override the same methods as its
2900 * corresponding method in the interface.
2902 * For C++, a virtual member function overrides any virtual member
2903 * function with the same signature that occurs in its base
2904 * classes. With multiple inheritance, a virtual member function can
2905 * override several virtual member functions coming from different
2908 * In all cases, this function determines the immediate overridden
2909 * method, rather than all of the overridden methods. For example, if
2910 * a method is originally declared in a class A, then overridden in B
2911 * (which in inherits from A) and also in C (which inherited from B),
2912 * then the only overridden method returned from this function when
2913 * invoked on C's method will be B's method. The client may then
2914 * invoke this function again, given the previously-found overridden
2915 * methods, to map out the complete method-override set.
2917 * \param cursor A cursor representing an Objective-C or C++
2918 * method. This routine will compute the set of methods that this
2921 * \param overridden A pointer whose pointee will be replaced with a
2922 * pointer to an array of cursors, representing the set of overridden
2923 * methods. If there are no overridden methods, the pointee will be
2924 * set to NULL. The pointee must be freed via a call to
2925 * \c clang_disposeOverriddenCursors().
2927 * \param num_overridden A pointer to the number of overridden
2928 * functions, will be set to the number of overridden functions in the
2929 * array pointed to by \p overridden.
2931 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
2932 CXCursor **overridden,
2933 unsigned *num_overridden);
2936 * \brief Free the set of overridden cursors returned by \c
2937 * clang_getOverriddenCursors().
2939 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
2942 * \brief Retrieve the file that is included by the given inclusion directive
2945 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
2952 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2954 * Cursors represent a location within the Abstract Syntax Tree (AST). These
2955 * routines help map between cursors and the physical locations where the
2956 * described entities occur in the source code. The mapping is provided in
2957 * both directions, so one can map from source code to the AST and back.
2963 * \brief Map a source location to the cursor that describes the entity at that
2964 * location in the source code.
2966 * clang_getCursor() maps an arbitrary source location within a translation
2967 * unit down to the most specific cursor that describes the entity at that
2968 * location. For example, given an expression \c x + y, invoking
2969 * clang_getCursor() with a source location pointing to "x" will return the
2970 * cursor for "x"; similarly for "y". If the cursor points anywhere between
2971 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2972 * will return a cursor referring to the "+" expression.
2974 * \returns a cursor representing the entity at the given source location, or
2975 * a NULL cursor if no such entity can be found.
2977 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
2980 * \brief Retrieve the physical location of the source constructor referenced
2981 * by the given cursor.
2983 * The location of a declaration is typically the location of the name of that
2984 * declaration, where the name of that declaration would occur if it is
2985 * unnamed, or some keyword that introduces that particular declaration.
2986 * The location of a reference is where that reference occurs within the
2989 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
2992 * \brief Retrieve the physical extent of the source construct referenced by
2995 * The extent of a cursor starts with the file/line/column pointing at the
2996 * first character within the source construct that the cursor refers to and
2997 * ends with the last character within that source construct. For a
2998 * declaration, the extent covers the declaration itself. For a reference,
2999 * the extent covers the location of the reference (e.g., where the referenced
3000 * entity was actually used).
3002 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
3009 * \defgroup CINDEX_TYPES Type information for CXCursors
3015 * \brief Describes the kind of type
3019 * \brief Represents an invalid type (e.g., where no type is available).
3024 * \brief A type whose specific kind is not exposed via this
3027 CXType_Unexposed = 1,
3039 CXType_ULongLong = 11,
3040 CXType_UInt128 = 12,
3047 CXType_LongLong = 19,
3051 CXType_LongDouble = 23,
3052 CXType_NullPtr = 24,
3053 CXType_Overload = 25,
3054 CXType_Dependent = 26,
3056 CXType_ObjCClass = 28,
3057 CXType_ObjCSel = 29,
3058 CXType_Float128 = 30,
3060 CXType_FirstBuiltin = CXType_Void,
3061 CXType_LastBuiltin = CXType_Half,
3063 CXType_Complex = 100,
3064 CXType_Pointer = 101,
3065 CXType_BlockPointer = 102,
3066 CXType_LValueReference = 103,
3067 CXType_RValueReference = 104,
3068 CXType_Record = 105,
3070 CXType_Typedef = 107,
3071 CXType_ObjCInterface = 108,
3072 CXType_ObjCObjectPointer = 109,
3073 CXType_FunctionNoProto = 110,
3074 CXType_FunctionProto = 111,
3075 CXType_ConstantArray = 112,
3076 CXType_Vector = 113,
3077 CXType_IncompleteArray = 114,
3078 CXType_VariableArray = 115,
3079 CXType_DependentSizedArray = 116,
3080 CXType_MemberPointer = 117,
3084 * \brief Represents a type that was referred to using an elaborated type keyword.
3086 * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
3088 CXType_Elaborated = 119,
3090 /* OpenCL PipeType. */
3093 /* OpenCL builtin types. */
3094 CXType_OCLImage1dRO = 121,
3095 CXType_OCLImage1dArrayRO = 122,
3096 CXType_OCLImage1dBufferRO = 123,
3097 CXType_OCLImage2dRO = 124,
3098 CXType_OCLImage2dArrayRO = 125,
3099 CXType_OCLImage2dDepthRO = 126,
3100 CXType_OCLImage2dArrayDepthRO = 127,
3101 CXType_OCLImage2dMSAARO = 128,
3102 CXType_OCLImage2dArrayMSAARO = 129,
3103 CXType_OCLImage2dMSAADepthRO = 130,
3104 CXType_OCLImage2dArrayMSAADepthRO = 131,
3105 CXType_OCLImage3dRO = 132,
3106 CXType_OCLImage1dWO = 133,
3107 CXType_OCLImage1dArrayWO = 134,
3108 CXType_OCLImage1dBufferWO = 135,
3109 CXType_OCLImage2dWO = 136,
3110 CXType_OCLImage2dArrayWO = 137,
3111 CXType_OCLImage2dDepthWO = 138,
3112 CXType_OCLImage2dArrayDepthWO = 139,
3113 CXType_OCLImage2dMSAAWO = 140,
3114 CXType_OCLImage2dArrayMSAAWO = 141,
3115 CXType_OCLImage2dMSAADepthWO = 142,
3116 CXType_OCLImage2dArrayMSAADepthWO = 143,
3117 CXType_OCLImage3dWO = 144,
3118 CXType_OCLImage1dRW = 145,
3119 CXType_OCLImage1dArrayRW = 146,
3120 CXType_OCLImage1dBufferRW = 147,
3121 CXType_OCLImage2dRW = 148,
3122 CXType_OCLImage2dArrayRW = 149,
3123 CXType_OCLImage2dDepthRW = 150,
3124 CXType_OCLImage2dArrayDepthRW = 151,
3125 CXType_OCLImage2dMSAARW = 152,
3126 CXType_OCLImage2dArrayMSAARW = 153,
3127 CXType_OCLImage2dMSAADepthRW = 154,
3128 CXType_OCLImage2dArrayMSAADepthRW = 155,
3129 CXType_OCLImage3dRW = 156,
3130 CXType_OCLSampler = 157,
3131 CXType_OCLEvent = 158,
3132 CXType_OCLQueue = 159,
3133 CXType_OCLReserveID = 160
3137 * \brief Describes the calling convention of a function type
3139 enum CXCallingConv {
3140 CXCallingConv_Default = 0,
3141 CXCallingConv_C = 1,
3142 CXCallingConv_X86StdCall = 2,
3143 CXCallingConv_X86FastCall = 3,
3144 CXCallingConv_X86ThisCall = 4,
3145 CXCallingConv_X86Pascal = 5,
3146 CXCallingConv_AAPCS = 6,
3147 CXCallingConv_AAPCS_VFP = 7,
3148 CXCallingConv_X86RegCall = 8,
3149 CXCallingConv_IntelOclBicc = 9,
3150 CXCallingConv_X86_64Win64 = 10,
3151 CXCallingConv_X86_64SysV = 11,
3152 CXCallingConv_X86VectorCall = 12,
3153 CXCallingConv_Swift = 13,
3154 CXCallingConv_PreserveMost = 14,
3155 CXCallingConv_PreserveAll = 15,
3157 CXCallingConv_Invalid = 100,
3158 CXCallingConv_Unexposed = 200
3162 * \brief The type of an element in the abstract syntax tree.
3166 enum CXTypeKind kind;
3171 * \brief Retrieve the type of a CXCursor (if any).
3173 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
3176 * \brief Pretty-print the underlying type using the rules of the
3177 * language of the translation unit from which it came.
3179 * If the type is invalid, an empty string is returned.
3181 CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
3184 * \brief Retrieve the underlying type of a typedef declaration.
3186 * If the cursor does not reference a typedef declaration, an invalid type is
3189 CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
3192 * \brief Retrieve the integer type of an enum declaration.
3194 * If the cursor does not reference an enum declaration, an invalid type is
3197 CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
3200 * \brief Retrieve the integer value of an enum constant declaration as a signed
3203 * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
3204 * Since this is also potentially a valid constant value, the kind of the cursor
3205 * must be verified before calling this function.
3207 CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C);
3210 * \brief Retrieve the integer value of an enum constant declaration as an unsigned
3213 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
3214 * Since this is also potentially a valid constant value, the kind of the cursor
3215 * must be verified before calling this function.
3217 CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C);
3220 * \brief Retrieve the bit width of a bit field declaration as an integer.
3222 * If a cursor that is not a bit field declaration is passed in, -1 is returned.
3224 CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
3227 * \brief Retrieve the number of non-variadic arguments associated with a given
3230 * The number of arguments can be determined for calls as well as for
3231 * declarations of functions or methods. For other cursors -1 is returned.
3233 CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
3236 * \brief Retrieve the argument cursor of a function or method.
3238 * The argument cursor can be determined for calls as well as for declarations
3239 * of functions or methods. For other cursors and for invalid indices, an
3240 * invalid cursor is returned.
3242 CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
3245 * \brief Describes the kind of a template argument.
3247 * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3248 * element descriptions.
3250 enum CXTemplateArgumentKind {
3251 CXTemplateArgumentKind_Null,
3252 CXTemplateArgumentKind_Type,
3253 CXTemplateArgumentKind_Declaration,
3254 CXTemplateArgumentKind_NullPtr,
3255 CXTemplateArgumentKind_Integral,
3256 CXTemplateArgumentKind_Template,
3257 CXTemplateArgumentKind_TemplateExpansion,
3258 CXTemplateArgumentKind_Expression,
3259 CXTemplateArgumentKind_Pack,
3260 /* Indicates an error case, preventing the kind from being deduced. */
3261 CXTemplateArgumentKind_Invalid
3265 *\brief Returns the number of template args of a function decl representing a
3266 * template specialization.
3268 * If the argument cursor cannot be converted into a template function
3269 * declaration, -1 is returned.
3271 * For example, for the following declaration and specialization:
3272 * template <typename T, int kInt, bool kBool>
3273 * void foo() { ... }
3276 * void foo<float, -7, true>();
3278 * The value 3 would be returned from this call.
3280 CINDEX_LINKAGE int clang_Cursor_getNumTemplateArguments(CXCursor C);
3283 * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3285 * If the argument CXCursor does not represent a FunctionDecl, an invalid
3286 * template argument kind is returned.
3288 * For example, for the following declaration and specialization:
3289 * template <typename T, int kInt, bool kBool>
3290 * void foo() { ... }
3293 * void foo<float, -7, true>();
3295 * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3298 CINDEX_LINKAGE enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(
3299 CXCursor C, unsigned I);
3302 * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3303 * function decl representing a template specialization.
3305 * If the argument CXCursor does not represent a FunctionDecl whose I'th
3306 * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3309 * For example, for the following declaration and specialization:
3310 * template <typename T, int kInt, bool kBool>
3311 * void foo() { ... }
3314 * void foo<float, -7, true>();
3316 * If called with I = 0, "float", will be returned.
3317 * Invalid types will be returned for I == 1 or 2.
3319 CINDEX_LINKAGE CXType clang_Cursor_getTemplateArgumentType(CXCursor C,
3323 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3324 * decl representing a template specialization) as a signed long long.
3326 * It is undefined to call this function on a CXCursor that does not represent a
3327 * FunctionDecl or whose I'th template argument is not an integral value.
3329 * For example, for the following declaration and specialization:
3330 * template <typename T, int kInt, bool kBool>
3331 * void foo() { ... }
3334 * void foo<float, -7, true>();
3336 * If called with I = 1 or 2, -7 or true will be returned, respectively.
3337 * For I == 0, this function's behavior is undefined.
3339 CINDEX_LINKAGE long long clang_Cursor_getTemplateArgumentValue(CXCursor C,
3343 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3344 * decl representing a template specialization) as an unsigned long long.
3346 * It is undefined to call this function on a CXCursor that does not represent a
3347 * FunctionDecl or whose I'th template argument is not an integral value.
3349 * For example, for the following declaration and specialization:
3350 * template <typename T, int kInt, bool kBool>
3351 * void foo() { ... }
3354 * void foo<float, 2147483649, true>();
3356 * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3357 * For I == 0, this function's behavior is undefined.
3359 CINDEX_LINKAGE unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(
3360 CXCursor C, unsigned I);
3363 * \brief Determine whether two CXTypes represent the same type.
3365 * \returns non-zero if the CXTypes represent the same type and
3368 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
3371 * \brief Return the canonical type for a CXType.
3373 * Clang's type system explicitly models typedefs and all the ways
3374 * a specific type can be represented. The canonical type is the underlying
3375 * type with all the "sugar" removed. For example, if 'T' is a typedef
3376 * for 'int', the canonical type for 'T' would be 'int'.
3378 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
3381 * \brief Determine whether a CXType has the "const" qualifier set,
3382 * without looking through typedefs that may have added "const" at a
3385 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
3388 * \brief Determine whether a CXCursor that is a macro, is
3391 CINDEX_LINKAGE unsigned clang_Cursor_isMacroFunctionLike(CXCursor C);
3394 * \brief Determine whether a CXCursor that is a macro, is a
3397 CINDEX_LINKAGE unsigned clang_Cursor_isMacroBuiltin(CXCursor C);
3400 * \brief Determine whether a CXCursor that is a function declaration, is an
3401 * inline declaration.
3403 CINDEX_LINKAGE unsigned clang_Cursor_isFunctionInlined(CXCursor C);
3406 * \brief Determine whether a CXType has the "volatile" qualifier set,
3407 * without looking through typedefs that may have added "volatile" at
3408 * a different level.
3410 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
3413 * \brief Determine whether a CXType has the "restrict" qualifier set,
3414 * without looking through typedefs that may have added "restrict" at a
3417 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
3420 * \brief For pointer types, returns the type of the pointee.
3422 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
3425 * \brief Return the cursor for the declaration of the given type.
3427 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
3430 * Returns the Objective-C type encoding for the specified declaration.
3432 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
3435 * Returns the Objective-C type encoding for the specified CXType.
3437 CINDEX_LINKAGE CXString clang_Type_getObjCEncoding(CXType type);
3440 * \brief Retrieve the spelling of a given CXTypeKind.
3442 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
3445 * \brief Retrieve the calling convention associated with a function type.
3447 * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3449 CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
3452 * \brief Retrieve the return type associated with a function type.
3454 * If a non-function type is passed in, an invalid type is returned.
3456 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
3459 * \brief Retrieve the number of non-variadic parameters associated with a
3462 * If a non-function type is passed in, -1 is returned.
3464 CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
3467 * \brief Retrieve the type of a parameter of a function type.
3469 * If a non-function type is passed in or the function does not have enough
3470 * parameters, an invalid type is returned.
3472 CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
3475 * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3477 CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
3480 * \brief Retrieve the return type associated with a given cursor.
3482 * This only returns a valid type if the cursor refers to a function or method.
3484 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
3487 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3490 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
3493 * \brief Return the element type of an array, complex, or vector type.
3495 * If a type is passed in that is not an array, complex, or vector type,
3496 * an invalid type is returned.
3498 CINDEX_LINKAGE CXType clang_getElementType(CXType T);
3501 * \brief Return the number of elements of an array or vector type.
3503 * If a type is passed in that is not an array or vector type,
3506 CINDEX_LINKAGE long long clang_getNumElements(CXType T);
3509 * \brief Return the element type of an array type.
3511 * If a non-array type is passed in, an invalid type is returned.
3513 CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
3516 * \brief Return the array size of a constant array.
3518 * If a non-array type is passed in, -1 is returned.
3520 CINDEX_LINKAGE long long clang_getArraySize(CXType T);
3523 * \brief Retrieve the type named by the qualified-id.
3525 * If a non-elaborated type is passed in, an invalid type is returned.
3527 CINDEX_LINKAGE CXType clang_Type_getNamedType(CXType T);
3530 * \brief Determine if a typedef is 'transparent' tag.
3532 * A typedef is considered 'transparent' if it shares a name and spelling
3533 * location with its underlying tag type, as is the case with the NS_ENUM macro.
3535 * \returns non-zero if transparent and zero otherwise.
3537 CINDEX_LINKAGE unsigned clang_Type_isTransparentTagTypedef(CXType T);
3540 * \brief List the possible error codes for \c clang_Type_getSizeOf,
3541 * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3542 * \c clang_Cursor_getOffsetOf.
3544 * A value of this enumeration type can be returned if the target type is not
3545 * a valid argument to sizeof, alignof or offsetof.
3547 enum CXTypeLayoutError {
3549 * \brief Type is of kind CXType_Invalid.
3551 CXTypeLayoutError_Invalid = -1,
3553 * \brief The type is an incomplete Type.
3555 CXTypeLayoutError_Incomplete = -2,
3557 * \brief The type is a dependent Type.
3559 CXTypeLayoutError_Dependent = -3,
3561 * \brief The type is not a constant size type.
3563 CXTypeLayoutError_NotConstantSize = -4,
3565 * \brief The Field name is not valid for this record.
3567 CXTypeLayoutError_InvalidFieldName = -5
3571 * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3574 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3575 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3577 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3579 * If the type declaration is not a constant size type,
3580 * CXTypeLayoutError_NotConstantSize is returned.
3582 CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
3585 * \brief Return the class type of an member pointer type.
3587 * If a non-member-pointer type is passed in, an invalid type is returned.
3589 CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
3592 * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3594 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3595 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3597 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3600 CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
3603 * \brief Return the offset of a field named S in a record of type T in bits
3604 * as it would be returned by __offsetof__ as per C++11[18.2p4]
3606 * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3608 * If the field's type declaration is an incomplete type,
3609 * CXTypeLayoutError_Incomplete is returned.
3610 * If the field's type declaration is a dependent type,
3611 * CXTypeLayoutError_Dependent is returned.
3612 * If the field's name S is not found,
3613 * CXTypeLayoutError_InvalidFieldName is returned.
3615 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3618 * \brief Return the offset of the field represented by the Cursor.
3620 * If the cursor is not a field declaration, -1 is returned.
3621 * If the cursor semantic parent is not a record field declaration,
3622 * CXTypeLayoutError_Invalid is returned.
3623 * If the field's type declaration is an incomplete type,
3624 * CXTypeLayoutError_Incomplete is returned.
3625 * If the field's type declaration is a dependent type,
3626 * CXTypeLayoutError_Dependent is returned.
3627 * If the field's name S is not found,
3628 * CXTypeLayoutError_InvalidFieldName is returned.
3630 CINDEX_LINKAGE long long clang_Cursor_getOffsetOfField(CXCursor C);
3633 * \brief Determine whether the given cursor represents an anonymous record
3636 CINDEX_LINKAGE unsigned clang_Cursor_isAnonymous(CXCursor C);
3638 enum CXRefQualifierKind {
3639 /** \brief No ref-qualifier was provided. */
3640 CXRefQualifier_None = 0,
3641 /** \brief An lvalue ref-qualifier was provided (\c &). */
3642 CXRefQualifier_LValue,
3643 /** \brief An rvalue ref-qualifier was provided (\c &&). */
3644 CXRefQualifier_RValue
3648 * \brief Returns the number of template arguments for given template
3649 * specialization, or -1 if type \c T is not a template specialization.
3651 CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
3654 * \brief Returns the type template argument of a template class specialization
3657 * This function only returns template type arguments and does not handle
3658 * template template arguments or variadic packs.
3660 CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
3663 * \brief Retrieve the ref-qualifier kind of a function or method.
3665 * The ref-qualifier is returned for C++ functions or methods. For other types
3666 * or non-C++ declarations, CXRefQualifier_None is returned.
3668 CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
3671 * \brief Returns non-zero if the cursor specifies a Record member that is a
3674 CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
3677 * \brief Returns 1 if the base class specified by the cursor with kind
3678 * CX_CXXBaseSpecifier is virtual.
3680 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
3683 * \brief Represents the C++ access control level to a base class for a
3684 * cursor with kind CX_CXXBaseSpecifier.
3686 enum CX_CXXAccessSpecifier {
3687 CX_CXXInvalidAccessSpecifier,
3694 * \brief Returns the access control level for the referenced object.
3696 * If the cursor refers to a C++ declaration, its access control level within its
3697 * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3698 * access specifier, the specifier itself is returned.
3700 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
3703 * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3704 * was added for the case that the passed cursor in not a declaration.
3706 enum CX_StorageClass {
3711 CX_SC_PrivateExtern,
3712 CX_SC_OpenCLWorkGroupLocal,
3718 * \brief Returns the storage class for a function or variable declaration.
3720 * If the passed in Cursor is not a function or variable declaration,
3721 * CX_SC_Invalid is returned else the storage class.
3723 CINDEX_LINKAGE enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor);
3726 * \brief Determine the number of overloaded declarations referenced by a
3727 * \c CXCursor_OverloadedDeclRef cursor.
3729 * \param cursor The cursor whose overloaded declarations are being queried.
3731 * \returns The number of overloaded declarations referenced by \c cursor. If it
3732 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3734 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
3737 * \brief Retrieve a cursor for one of the overloaded declarations referenced
3738 * by a \c CXCursor_OverloadedDeclRef cursor.
3740 * \param cursor The cursor whose overloaded declarations are being queried.
3742 * \param index The zero-based index into the set of overloaded declarations in
3745 * \returns A cursor representing the declaration referenced by the given
3746 * \c cursor at the specified \c index. If the cursor does not have an
3747 * associated set of overloaded declarations, or if the index is out of bounds,
3748 * returns \c clang_getNullCursor();
3750 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
3758 * \defgroup CINDEX_ATTRIBUTES Information for attributes
3764 * \brief For cursors representing an iboutletcollection attribute,
3765 * this function returns the collection element type.
3768 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
3775 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3777 * These routines provide the ability to traverse the abstract syntax tree
3784 * \brief Describes how the traversal of the children of a particular
3785 * cursor should proceed after visiting a particular child cursor.
3787 * A value of this enumeration type should be returned by each
3788 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3790 enum CXChildVisitResult {
3792 * \brief Terminates the cursor traversal.
3796 * \brief Continues the cursor traversal with the next sibling of
3797 * the cursor just visited, without visiting its children.
3799 CXChildVisit_Continue,
3801 * \brief Recursively traverse the children of this cursor, using
3802 * the same visitor and client data.
3804 CXChildVisit_Recurse
3808 * \brief Visitor invoked for each cursor found by a traversal.
3810 * This visitor function will be invoked for each cursor found by
3811 * clang_visitCursorChildren(). Its first argument is the cursor being
3812 * visited, its second argument is the parent visitor for that cursor,
3813 * and its third argument is the client data provided to
3814 * clang_visitCursorChildren().
3816 * The visitor should return one of the \c CXChildVisitResult values
3817 * to direct clang_visitCursorChildren().
3819 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
3821 CXClientData client_data);
3824 * \brief Visit the children of a particular cursor.
3826 * This function visits all the direct children of the given cursor,
3827 * invoking the given \p visitor function with the cursors of each
3828 * visited child. The traversal may be recursive, if the visitor returns
3829 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3830 * the visitor returns \c CXChildVisit_Break.
3832 * \param parent the cursor whose child may be visited. All kinds of
3833 * cursors can be visited, including invalid cursors (which, by
3834 * definition, have no children).
3836 * \param visitor the visitor function that will be invoked for each
3837 * child of \p parent.
3839 * \param client_data pointer data supplied by the client, which will
3840 * be passed to the visitor each time it is invoked.
3842 * \returns a non-zero value if the traversal was terminated
3843 * prematurely by the visitor returning \c CXChildVisit_Break.
3845 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
3846 CXCursorVisitor visitor,
3847 CXClientData client_data);
3848 #ifdef __has_feature
3849 # if __has_feature(blocks)
3851 * \brief Visitor invoked for each cursor found by a traversal.
3853 * This visitor block will be invoked for each cursor found by
3854 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3855 * visited, its second argument is the parent visitor for that cursor.
3857 * The visitor should return one of the \c CXChildVisitResult values
3858 * to direct clang_visitChildrenWithBlock().
3860 typedef enum CXChildVisitResult
3861 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3864 * Visits the children of a cursor using the specified block. Behaves
3865 * identically to clang_visitChildren() in all other respects.
3867 CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
3868 CXCursorVisitorBlock block);
3877 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3879 * These routines provide the ability to determine references within and
3880 * across translation units, by providing the names of the entities referenced
3881 * by cursors, follow reference cursors to the declarations they reference,
3882 * and associate declarations with their definitions.
3888 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3889 * by the given cursor.
3891 * A Unified Symbol Resolution (USR) is a string that identifies a particular
3892 * entity (function, class, variable, etc.) within a program. USRs can be
3893 * compared across translation units to determine, e.g., when references in
3894 * one translation refer to an entity defined in another translation unit.
3896 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
3899 * \brief Construct a USR for a specified Objective-C class.
3901 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3904 * \brief Construct a USR for a specified Objective-C category.
3906 CINDEX_LINKAGE CXString
3907 clang_constructUSR_ObjCCategory(const char *class_name,
3908 const char *category_name);
3911 * \brief Construct a USR for a specified Objective-C protocol.
3913 CINDEX_LINKAGE CXString
3914 clang_constructUSR_ObjCProtocol(const char *protocol_name);
3917 * \brief Construct a USR for a specified Objective-C instance variable and
3918 * the USR for its containing class.
3920 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
3924 * \brief Construct a USR for a specified Objective-C method and
3925 * the USR for its containing class.
3927 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
3928 unsigned isInstanceMethod,
3932 * \brief Construct a USR for a specified Objective-C property and the USR
3933 * for its containing class.
3935 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
3939 * \brief Retrieve a name for the entity referenced by this cursor.
3941 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
3944 * \brief Retrieve a range for a piece that forms the cursors spelling name.
3945 * Most of the times there is only one range for the complete spelling but for
3946 * Objective-C methods and Objective-C message expressions, there are multiple
3947 * pieces for each selector identifier.
3949 * \param pieceIndex the index of the spelling name piece. If this is greater
3950 * than the actual number of pieces, it will return a NULL (invalid) range.
3952 * \param options Reserved.
3954 CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor,
3955 unsigned pieceIndex,
3959 * \brief Retrieve the display name for the entity referenced by this cursor.
3961 * The display name contains extra information that helps identify the cursor,
3962 * such as the parameters of a function or template or the arguments of a
3963 * class template specialization.
3965 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
3967 /** \brief For a cursor that is a reference, retrieve a cursor representing the
3968 * entity that it references.
3970 * Reference cursors refer to other entities in the AST. For example, an
3971 * Objective-C superclass reference cursor refers to an Objective-C class.
3972 * This function produces the cursor for the Objective-C class from the
3973 * cursor for the superclass reference. If the input cursor is a declaration or
3974 * definition, it returns that declaration or definition unchanged.
3975 * Otherwise, returns the NULL cursor.
3977 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
3980 * \brief For a cursor that is either a reference to or a declaration
3981 * of some entity, retrieve a cursor that describes the definition of
3984 * Some entities can be declared multiple times within a translation
3985 * unit, but only one of those declarations can also be a
3986 * definition. For example, given:
3990 * int g(int x, int y) { return f(x, y); }
3991 * int f(int a, int b) { return a + b; }
3995 * there are three declarations of the function "f", but only the
3996 * second one is a definition. The clang_getCursorDefinition()
3997 * function will take any cursor pointing to a declaration of "f"
3998 * (the first or fourth lines of the example) or a cursor referenced
3999 * that uses "f" (the call to "f' inside "g") and will return a
4000 * declaration cursor pointing to the definition (the second "f"
4003 * If given a cursor for which there is no corresponding definition,
4004 * e.g., because there is no definition of that entity within this
4005 * translation unit, returns a NULL cursor.
4007 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
4010 * \brief Determine whether the declaration pointed to by this cursor
4011 * is also a definition of that entity.
4013 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
4016 * \brief Retrieve the canonical cursor corresponding to the given cursor.
4018 * In the C family of languages, many kinds of entities can be declared several
4019 * times within a single translation unit. For example, a structure type can
4020 * be forward-declared (possibly multiple times) and later defined:
4030 * The declarations and the definition of \c X are represented by three
4031 * different cursors, all of which are declarations of the same underlying
4032 * entity. One of these cursor is considered the "canonical" cursor, which
4033 * is effectively the representative for the underlying entity. One can
4034 * determine if two cursors are declarations of the same underlying entity by
4035 * comparing their canonical cursors.
4037 * \returns The canonical cursor for the entity referred to by the given cursor.
4039 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
4042 * \brief If the cursor points to a selector identifier in an Objective-C
4043 * method or message expression, this returns the selector index.
4045 * After getting a cursor with #clang_getCursor, this can be called to
4046 * determine if the location points to a selector identifier.
4048 * \returns The selector index if the cursor is an Objective-C method or message
4049 * expression and the cursor is pointing to a selector identifier, or -1
4052 CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
4055 * \brief Given a cursor pointing to a C++ method call or an Objective-C
4056 * message, returns non-zero if the method/message is "dynamic", meaning:
4058 * For a C++ method: the call is virtual.
4059 * For an Objective-C message: the receiver is an object instance, not 'super'
4060 * or a specific class.
4062 * If the method/message is "static" or the cursor does not point to a
4063 * method/message, it will return zero.
4065 CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
4068 * \brief Given a cursor pointing to an Objective-C message or property
4069 * reference, or C++ method call, returns the CXType of the receiver.
4071 CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
4074 * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
4077 CXObjCPropertyAttr_noattr = 0x00,
4078 CXObjCPropertyAttr_readonly = 0x01,
4079 CXObjCPropertyAttr_getter = 0x02,
4080 CXObjCPropertyAttr_assign = 0x04,
4081 CXObjCPropertyAttr_readwrite = 0x08,
4082 CXObjCPropertyAttr_retain = 0x10,
4083 CXObjCPropertyAttr_copy = 0x20,
4084 CXObjCPropertyAttr_nonatomic = 0x40,
4085 CXObjCPropertyAttr_setter = 0x80,
4086 CXObjCPropertyAttr_atomic = 0x100,
4087 CXObjCPropertyAttr_weak = 0x200,
4088 CXObjCPropertyAttr_strong = 0x400,
4089 CXObjCPropertyAttr_unsafe_unretained = 0x800,
4090 CXObjCPropertyAttr_class = 0x1000
4091 } CXObjCPropertyAttrKind;
4094 * \brief Given a cursor that represents a property declaration, return the
4095 * associated property attributes. The bits are formed from
4096 * \c CXObjCPropertyAttrKind.
4098 * \param reserved Reserved for future use, pass 0.
4100 CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C,
4104 * \brief 'Qualifiers' written next to the return and parameter types in
4105 * Objective-C method declarations.
4108 CXObjCDeclQualifier_None = 0x0,
4109 CXObjCDeclQualifier_In = 0x1,
4110 CXObjCDeclQualifier_Inout = 0x2,
4111 CXObjCDeclQualifier_Out = 0x4,
4112 CXObjCDeclQualifier_Bycopy = 0x8,
4113 CXObjCDeclQualifier_Byref = 0x10,
4114 CXObjCDeclQualifier_Oneway = 0x20
4115 } CXObjCDeclQualifierKind;
4118 * \brief Given a cursor that represents an Objective-C method or parameter
4119 * declaration, return the associated Objective-C qualifiers for the return
4120 * type or the parameter respectively. The bits are formed from
4121 * CXObjCDeclQualifierKind.
4123 CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
4126 * \brief Given a cursor that represents an Objective-C method or property
4127 * declaration, return non-zero if the declaration was affected by "\@optional".
4128 * Returns zero if the cursor is not such a declaration or it is "\@required".
4130 CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
4133 * \brief Returns non-zero if the given cursor is a variadic function or method.
4135 CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
4138 * \brief Returns non-zero if the given cursor points to a symbol marked with
4139 * external_source_symbol attribute.
4141 * \param language If non-NULL, and the attribute is present, will be set to
4142 * the 'language' string from the attribute.
4144 * \param definedIn If non-NULL, and the attribute is present, will be set to
4145 * the 'definedIn' string from the attribute.
4147 * \param isGenerated If non-NULL, and the attribute is present, will be set to
4148 * non-zero if the 'generated_declaration' is set in the attribute.
4150 CINDEX_LINKAGE unsigned clang_Cursor_isExternalSymbol(CXCursor C,
4151 CXString *language, CXString *definedIn,
4152 unsigned *isGenerated);
4155 * \brief Given a cursor that represents a declaration, return the associated
4156 * comment's source range. The range may include multiple consecutive comments
4157 * with whitespace in between.
4159 CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
4162 * \brief Given a cursor that represents a declaration, return the associated
4163 * comment text, including comment markers.
4165 CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
4168 * \brief Given a cursor that represents a documentable entity (e.g.,
4169 * declaration), return the associated \\brief paragraph; otherwise return the
4172 CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
4178 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
4184 * \brief Retrieve the CXString representing the mangled name of the cursor.
4186 CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
4189 * \brief Retrieve the CXStrings representing the mangled symbols of the C++
4190 * constructor or destructor at the cursor.
4192 CINDEX_LINKAGE CXStringSet *clang_Cursor_getCXXManglings(CXCursor);
4199 * \defgroup CINDEX_MODULE Module introspection
4201 * The functions in this group provide access to information about modules.
4206 typedef void *CXModule;
4209 * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4211 CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
4214 * \brief Given a CXFile header file, return the module that contains it, if one
4217 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4220 * \param Module a module object.
4222 * \returns the module file where the provided module object came from.
4224 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4227 * \param Module a module object.
4229 * \returns the parent of a sub-module or NULL if the given module is top-level,
4230 * e.g. for 'std.vector' it will return the 'std' module.
4232 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4235 * \param Module a module object.
4237 * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4238 * will return "vector".
4240 CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
4243 * \param Module a module object.
4245 * \returns the full name of the module, e.g. "std.vector".
4247 CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
4250 * \param Module a module object.
4252 * \returns non-zero if the module is a system one.
4254 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4257 * \param Module a module object.
4259 * \returns the number of top level headers associated with this module.
4261 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4265 * \param Module a module object.
4267 * \param Index top level header index (zero-based).
4269 * \returns the specified top level header associated with the module.
4272 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
4273 CXModule Module, unsigned Index);
4280 * \defgroup CINDEX_CPP C++ AST introspection
4282 * The routines in this group provide access information in the ASTs specific
4283 * to C++ language features.
4289 * \brief Determine if a C++ constructor is a converting constructor.
4291 CINDEX_LINKAGE unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C);
4294 * \brief Determine if a C++ constructor is a copy constructor.
4296 CINDEX_LINKAGE unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C);
4299 * \brief Determine if a C++ constructor is the default constructor.
4301 CINDEX_LINKAGE unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C);
4304 * \brief Determine if a C++ constructor is a move constructor.
4306 CINDEX_LINKAGE unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C);
4309 * \brief Determine if a C++ field is declared 'mutable'.
4311 CINDEX_LINKAGE unsigned clang_CXXField_isMutable(CXCursor C);
4314 * \brief Determine if a C++ method is declared '= default'.
4316 CINDEX_LINKAGE unsigned clang_CXXMethod_isDefaulted(CXCursor C);
4319 * \brief Determine if a C++ member function or member function template is
4322 CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
4325 * \brief Determine if a C++ member function or member function template is
4326 * declared 'static'.
4328 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
4331 * \brief Determine if a C++ member function or member function template is
4332 * explicitly declared 'virtual' or if it overrides a virtual method from
4333 * one of the base classes.
4335 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
4338 * \brief Determine if a C++ member function or member function template is
4341 CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
4344 * \brief Given a cursor that represents a template, determine
4345 * the cursor kind of the specializations would be generated by instantiating
4348 * This routine can be used to determine what flavor of function template,
4349 * class template, or class template partial specialization is stored in the
4350 * cursor. For example, it can describe whether a class template cursor is
4351 * declared with "struct", "class" or "union".
4353 * \param C The cursor to query. This cursor should represent a template
4356 * \returns The cursor kind of the specializations that would be generated
4357 * by instantiating the template \p C. If \p C is not a template, returns
4358 * \c CXCursor_NoDeclFound.
4360 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
4363 * \brief Given a cursor that may represent a specialization or instantiation
4364 * of a template, retrieve the cursor that represents the template that it
4365 * specializes or from which it was instantiated.
4367 * This routine determines the template involved both for explicit
4368 * specializations of templates and for implicit instantiations of the template,
4369 * both of which are referred to as "specializations". For a class template
4370 * specialization (e.g., \c std::vector<bool>), this routine will return
4371 * either the primary template (\c std::vector) or, if the specialization was
4372 * instantiated from a class template partial specialization, the class template
4373 * partial specialization. For a class template partial specialization and a
4374 * function template specialization (including instantiations), this
4375 * this routine will return the specialized template.
4377 * For members of a class template (e.g., member functions, member classes, or
4378 * static data members), returns the specialized or instantiated member.
4379 * Although not strictly "templates" in the C++ language, members of class
4380 * templates have the same notions of specializations and instantiations that
4381 * templates do, so this routine treats them similarly.
4383 * \param C A cursor that may be a specialization of a template or a member
4386 * \returns If the given cursor is a specialization or instantiation of a
4387 * template or a member thereof, the template or member that it specializes or
4388 * from which it was instantiated. Otherwise, returns a NULL cursor.
4390 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
4393 * \brief Given a cursor that references something else, return the source range
4394 * covering that reference.
4396 * \param C A cursor pointing to a member reference, a declaration reference, or
4398 * \param NameFlags A bitset with three independent flags:
4399 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4400 * CXNameRange_WantSinglePiece.
4401 * \param PieceIndex For contiguous names or when passing the flag
4402 * CXNameRange_WantSinglePiece, only one piece with index 0 is
4403 * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4404 * non-contiguous names, this index can be used to retrieve the individual
4405 * pieces of the name. See also CXNameRange_WantSinglePiece.
4407 * \returns The piece of the name pointed to by the given cursor. If there is no
4408 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4410 CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
4412 unsigned PieceIndex);
4414 enum CXNameRefFlags {
4416 * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4419 CXNameRange_WantQualifier = 0x1,
4422 * \brief Include the explicit template arguments, e.g. \<int> in x.f<int>,
4425 CXNameRange_WantTemplateArgs = 0x2,
4428 * \brief If the name is non-contiguous, return the full spanning range.
4430 * Non-contiguous names occur in Objective-C when a selector with two or more
4431 * parameters is used, or in C++ when using an operator:
4433 * [object doSomething:here withValue:there]; // Objective-C
4434 * return some_vector[1]; // C++
4437 CXNameRange_WantSinglePiece = 0x4
4445 * \defgroup CINDEX_LEX Token extraction and manipulation
4447 * The routines in this group provide access to the tokens within a
4448 * translation unit, along with a semantic mapping of those tokens to
4449 * their corresponding cursors.
4455 * \brief Describes a kind of token.
4457 typedef enum CXTokenKind {
4459 * \brief A token that contains some kind of punctuation.
4461 CXToken_Punctuation,
4464 * \brief A language keyword.
4469 * \brief An identifier (that is not a keyword).
4474 * \brief A numeric, string, or character literal.
4485 * \brief Describes a single preprocessing token.
4488 unsigned int_data[4];
4493 * \brief Determine the kind of the given token.
4495 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
4498 * \brief Determine the spelling of the given token.
4500 * The spelling of a token is the textual representation of that token, e.g.,
4501 * the text of an identifier or keyword.
4503 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
4506 * \brief Retrieve the source location of the given token.
4508 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
4512 * \brief Retrieve a source range that covers the given token.
4514 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
4517 * \brief Tokenize the source code described by the given range into raw
4520 * \param TU the translation unit whose text is being tokenized.
4522 * \param Range the source range in which text should be tokenized. All of the
4523 * tokens produced by tokenization will fall within this source range,
4525 * \param Tokens this pointer will be set to point to the array of tokens
4526 * that occur within the given source range. The returned pointer must be
4527 * freed with clang_disposeTokens() before the translation unit is destroyed.
4529 * \param NumTokens will be set to the number of tokens in the \c *Tokens
4533 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4534 CXToken **Tokens, unsigned *NumTokens);
4537 * \brief Annotate the given set of tokens by providing cursors for each token
4538 * that can be mapped to a specific entity within the abstract syntax tree.
4540 * This token-annotation routine is equivalent to invoking
4541 * clang_getCursor() for the source locations of each of the
4542 * tokens. The cursors provided are filtered, so that only those
4543 * cursors that have a direct correspondence to the token are
4544 * accepted. For example, given a function call \c f(x),
4545 * clang_getCursor() would provide the following cursors:
4547 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4548 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4549 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4551 * Only the first and last of these cursors will occur within the
4552 * annotate, since the tokens "f" and "x' directly refer to a function
4553 * and a variable, respectively, but the parentheses are just a small
4554 * part of the full syntax of the function call expression, which is
4555 * not provided as an annotation.
4557 * \param TU the translation unit that owns the given tokens.
4559 * \param Tokens the set of tokens to annotate.
4561 * \param NumTokens the number of tokens in \p Tokens.
4563 * \param Cursors an array of \p NumTokens cursors, whose contents will be
4564 * replaced with the cursors corresponding to each token.
4566 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4567 CXToken *Tokens, unsigned NumTokens,
4571 * \brief Free the given set of tokens.
4573 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4574 CXToken *Tokens, unsigned NumTokens);
4581 * \defgroup CINDEX_DEBUG Debugging facilities
4583 * These routines are used for testing and debugging, only, and should not
4589 /* for debug/testing */
4590 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
4591 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
4592 const char **startBuf,
4593 const char **endBuf,
4594 unsigned *startLine,
4595 unsigned *startColumn,
4597 unsigned *endColumn);
4598 CINDEX_LINKAGE void clang_enableStackTraces(void);
4599 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4600 unsigned stack_size);
4607 * \defgroup CINDEX_CODE_COMPLET Code completion
4609 * Code completion involves taking an (incomplete) source file, along with
4610 * knowledge of where the user is actively editing that file, and suggesting
4611 * syntactically- and semantically-valid constructs that the user might want to
4612 * use at that particular point in the source code. These data structures and
4613 * routines provide support for code completion.
4619 * \brief A semantic string that describes a code-completion result.
4621 * A semantic string that describes the formatting of a code-completion
4622 * result as a single "template" of text that should be inserted into the
4623 * source buffer when a particular code-completion result is selected.
4624 * Each semantic string is made up of some number of "chunks", each of which
4625 * contains some text along with a description of what that text means, e.g.,
4626 * the name of the entity being referenced, whether the text chunk is part of
4627 * the template, or whether it is a "placeholder" that the user should replace
4628 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4629 * description of the different kinds of chunks.
4631 typedef void *CXCompletionString;
4634 * \brief A single result of code completion.
4638 * \brief The kind of entity that this completion refers to.
4640 * The cursor kind will be a macro, keyword, or a declaration (one of the
4641 * *Decl cursor kinds), describing the entity that the completion is
4644 * \todo In the future, we would like to provide a full cursor, to allow
4645 * the client to extract additional information from declaration.
4647 enum CXCursorKind CursorKind;
4650 * \brief The code-completion string that describes how to insert this
4651 * code-completion result into the editing buffer.
4653 CXCompletionString CompletionString;
4654 } CXCompletionResult;
4657 * \brief Describes a single piece of text within a code-completion string.
4659 * Each "chunk" within a code-completion string (\c CXCompletionString) is
4660 * either a piece of text with a specific "kind" that describes how that text
4661 * should be interpreted by the client or is another completion string.
4663 enum CXCompletionChunkKind {
4665 * \brief A code-completion string that describes "optional" text that
4666 * could be a part of the template (but is not required).
4668 * The Optional chunk is the only kind of chunk that has a code-completion
4669 * string for its representation, which is accessible via
4670 * \c clang_getCompletionChunkCompletionString(). The code-completion string
4671 * describes an additional part of the template that is completely optional.
4672 * For example, optional chunks can be used to describe the placeholders for
4673 * arguments that match up with defaulted function parameters, e.g. given:
4676 * void f(int x, float y = 3.14, double z = 2.71828);
4679 * The code-completion string for this function would contain:
4680 * - a TypedText chunk for "f".
4681 * - a LeftParen chunk for "(".
4682 * - a Placeholder chunk for "int x"
4683 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4684 * - a Comma chunk for ","
4685 * - a Placeholder chunk for "float y"
4686 * - an Optional chunk containing the last defaulted argument:
4687 * - a Comma chunk for ","
4688 * - a Placeholder chunk for "double z"
4689 * - a RightParen chunk for ")"
4691 * There are many ways to handle Optional chunks. Two simple approaches are:
4692 * - Completely ignore optional chunks, in which case the template for the
4693 * function "f" would only include the first parameter ("int x").
4694 * - Fully expand all optional chunks, in which case the template for the
4695 * function "f" would have all of the parameters.
4697 CXCompletionChunk_Optional,
4699 * \brief Text that a user would be expected to type to get this
4700 * code-completion result.
4702 * There will be exactly one "typed text" chunk in a semantic string, which
4703 * will typically provide the spelling of a keyword or the name of a
4704 * declaration that could be used at the current code point. Clients are
4705 * expected to filter the code-completion results based on the text in this
4708 CXCompletionChunk_TypedText,
4710 * \brief Text that should be inserted as part of a code-completion result.
4712 * A "text" chunk represents text that is part of the template to be
4713 * inserted into user code should this particular code-completion result
4716 CXCompletionChunk_Text,
4718 * \brief Placeholder text that should be replaced by the user.
4720 * A "placeholder" chunk marks a place where the user should insert text
4721 * into the code-completion template. For example, placeholders might mark
4722 * the function parameters for a function declaration, to indicate that the
4723 * user should provide arguments for each of those parameters. The actual
4724 * text in a placeholder is a suggestion for the text to display before
4725 * the user replaces the placeholder with real code.
4727 CXCompletionChunk_Placeholder,
4729 * \brief Informative text that should be displayed but never inserted as
4730 * part of the template.
4732 * An "informative" chunk contains annotations that can be displayed to
4733 * help the user decide whether a particular code-completion result is the
4734 * right option, but which is not part of the actual template to be inserted
4735 * by code completion.
4737 CXCompletionChunk_Informative,
4739 * \brief Text that describes the current parameter when code-completion is
4740 * referring to function call, message send, or template specialization.
4742 * A "current parameter" chunk occurs when code-completion is providing
4743 * information about a parameter corresponding to the argument at the
4744 * code-completion point. For example, given a function
4747 * int add(int x, int y);
4750 * and the source code \c add(, where the code-completion point is after the
4751 * "(", the code-completion string will contain a "current parameter" chunk
4752 * for "int x", indicating that the current argument will initialize that
4753 * parameter. After typing further, to \c add(17, (where the code-completion
4754 * point is after the ","), the code-completion string will contain a
4755 * "current paremeter" chunk to "int y".
4757 CXCompletionChunk_CurrentParameter,
4759 * \brief A left parenthesis ('('), used to initiate a function call or
4760 * signal the beginning of a function parameter list.
4762 CXCompletionChunk_LeftParen,
4764 * \brief A right parenthesis (')'), used to finish a function call or
4765 * signal the end of a function parameter list.
4767 CXCompletionChunk_RightParen,
4769 * \brief A left bracket ('[').
4771 CXCompletionChunk_LeftBracket,
4773 * \brief A right bracket (']').
4775 CXCompletionChunk_RightBracket,
4777 * \brief A left brace ('{').
4779 CXCompletionChunk_LeftBrace,
4781 * \brief A right brace ('}').
4783 CXCompletionChunk_RightBrace,
4785 * \brief A left angle bracket ('<').
4787 CXCompletionChunk_LeftAngle,
4789 * \brief A right angle bracket ('>').
4791 CXCompletionChunk_RightAngle,
4793 * \brief A comma separator (',').
4795 CXCompletionChunk_Comma,
4797 * \brief Text that specifies the result type of a given result.
4799 * This special kind of informative chunk is not meant to be inserted into
4800 * the text buffer. Rather, it is meant to illustrate the type that an
4801 * expression using the given completion string would have.
4803 CXCompletionChunk_ResultType,
4805 * \brief A colon (':').
4807 CXCompletionChunk_Colon,
4809 * \brief A semicolon (';').
4811 CXCompletionChunk_SemiColon,
4813 * \brief An '=' sign.
4815 CXCompletionChunk_Equal,
4817 * Horizontal space (' ').
4819 CXCompletionChunk_HorizontalSpace,
4821 * Vertical space ('\\n'), after which it is generally a good idea to
4822 * perform indentation.
4824 CXCompletionChunk_VerticalSpace
4828 * \brief Determine the kind of a particular chunk within a completion string.
4830 * \param completion_string the completion string to query.
4832 * \param chunk_number the 0-based index of the chunk in the completion string.
4834 * \returns the kind of the chunk at the index \c chunk_number.
4836 CINDEX_LINKAGE enum CXCompletionChunkKind
4837 clang_getCompletionChunkKind(CXCompletionString completion_string,
4838 unsigned chunk_number);
4841 * \brief Retrieve the text associated with a particular chunk within a
4842 * completion string.
4844 * \param completion_string the completion string to query.
4846 * \param chunk_number the 0-based index of the chunk in the completion string.
4848 * \returns the text associated with the chunk at index \c chunk_number.
4850 CINDEX_LINKAGE CXString
4851 clang_getCompletionChunkText(CXCompletionString completion_string,
4852 unsigned chunk_number);
4855 * \brief Retrieve the completion string associated with a particular chunk
4856 * within a completion string.
4858 * \param completion_string the completion string to query.
4860 * \param chunk_number the 0-based index of the chunk in the completion string.
4862 * \returns the completion string associated with the chunk at index
4865 CINDEX_LINKAGE CXCompletionString
4866 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4867 unsigned chunk_number);
4870 * \brief Retrieve the number of chunks in the given code-completion string.
4872 CINDEX_LINKAGE unsigned
4873 clang_getNumCompletionChunks(CXCompletionString completion_string);
4876 * \brief Determine the priority of this code completion.
4878 * The priority of a code completion indicates how likely it is that this
4879 * particular completion is the completion that the user will select. The
4880 * priority is selected by various internal heuristics.
4882 * \param completion_string The completion string to query.
4884 * \returns The priority of this completion string. Smaller values indicate
4885 * higher-priority (more likely) completions.
4887 CINDEX_LINKAGE unsigned
4888 clang_getCompletionPriority(CXCompletionString completion_string);
4891 * \brief Determine the availability of the entity that this code-completion
4894 * \param completion_string The completion string to query.
4896 * \returns The availability of the completion string.
4898 CINDEX_LINKAGE enum CXAvailabilityKind
4899 clang_getCompletionAvailability(CXCompletionString completion_string);
4902 * \brief Retrieve the number of annotations associated with the given
4903 * completion string.
4905 * \param completion_string the completion string to query.
4907 * \returns the number of annotations associated with the given completion
4910 CINDEX_LINKAGE unsigned
4911 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4914 * \brief Retrieve the annotation associated with the given completion string.
4916 * \param completion_string the completion string to query.
4918 * \param annotation_number the 0-based index of the annotation of the
4919 * completion string.
4921 * \returns annotation string associated with the completion at index
4922 * \c annotation_number, or a NULL string if that annotation is not available.
4924 CINDEX_LINKAGE CXString
4925 clang_getCompletionAnnotation(CXCompletionString completion_string,
4926 unsigned annotation_number);
4929 * \brief Retrieve the parent context of the given completion string.
4931 * The parent context of a completion string is the semantic parent of
4932 * the declaration (if any) that the code completion represents. For example,
4933 * a code completion for an Objective-C method would have the method's class
4934 * or protocol as its context.
4936 * \param completion_string The code completion string whose parent is
4939 * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
4941 * \returns The name of the completion parent, e.g., "NSObject" if
4942 * the completion string represents a method in the NSObject class.
4944 CINDEX_LINKAGE CXString
4945 clang_getCompletionParent(CXCompletionString completion_string,
4946 enum CXCursorKind *kind);
4949 * \brief Retrieve the brief documentation comment attached to the declaration
4950 * that corresponds to the given completion string.
4952 CINDEX_LINKAGE CXString
4953 clang_getCompletionBriefComment(CXCompletionString completion_string);
4956 * \brief Retrieve a completion string for an arbitrary declaration or macro
4957 * definition cursor.
4959 * \param cursor The cursor to query.
4961 * \returns A non-context-sensitive completion string for declaration and macro
4962 * definition cursors, or NULL for other kinds of cursors.
4964 CINDEX_LINKAGE CXCompletionString
4965 clang_getCursorCompletionString(CXCursor cursor);
4968 * \brief Contains the results of code-completion.
4970 * This data structure contains the results of code completion, as
4971 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
4972 * \c clang_disposeCodeCompleteResults.
4976 * \brief The code-completion results.
4978 CXCompletionResult *Results;
4981 * \brief The number of code-completion results stored in the
4984 unsigned NumResults;
4985 } CXCodeCompleteResults;
4988 * \brief Flags that can be passed to \c clang_codeCompleteAt() to
4989 * modify its behavior.
4991 * The enumerators in this enumeration can be bitwise-OR'd together to
4992 * provide multiple options to \c clang_codeCompleteAt().
4994 enum CXCodeComplete_Flags {
4996 * \brief Whether to include macros within the set of code
4997 * completions returned.
4999 CXCodeComplete_IncludeMacros = 0x01,
5002 * \brief Whether to include code patterns for language constructs
5003 * within the set of code completions, e.g., for loops.
5005 CXCodeComplete_IncludeCodePatterns = 0x02,
5008 * \brief Whether to include brief documentation within the set of code
5009 * completions returned.
5011 CXCodeComplete_IncludeBriefComments = 0x04
5015 * \brief Bits that represent the context under which completion is occurring.
5017 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
5018 * contexts are occurring simultaneously.
5020 enum CXCompletionContext {
5022 * \brief The context for completions is unexposed, as only Clang results
5023 * should be included. (This is equivalent to having no context bits set.)
5025 CXCompletionContext_Unexposed = 0,
5028 * \brief Completions for any possible type should be included in the results.
5030 CXCompletionContext_AnyType = 1 << 0,
5033 * \brief Completions for any possible value (variables, function calls, etc.)
5034 * should be included in the results.
5036 CXCompletionContext_AnyValue = 1 << 1,
5038 * \brief Completions for values that resolve to an Objective-C object should
5039 * be included in the results.
5041 CXCompletionContext_ObjCObjectValue = 1 << 2,
5043 * \brief Completions for values that resolve to an Objective-C selector
5044 * should be included in the results.
5046 CXCompletionContext_ObjCSelectorValue = 1 << 3,
5048 * \brief Completions for values that resolve to a C++ class type should be
5049 * included in the results.
5051 CXCompletionContext_CXXClassTypeValue = 1 << 4,
5054 * \brief Completions for fields of the member being accessed using the dot
5055 * operator should be included in the results.
5057 CXCompletionContext_DotMemberAccess = 1 << 5,
5059 * \brief Completions for fields of the member being accessed using the arrow
5060 * operator should be included in the results.
5062 CXCompletionContext_ArrowMemberAccess = 1 << 6,
5064 * \brief Completions for properties of the Objective-C object being accessed
5065 * using the dot operator should be included in the results.
5067 CXCompletionContext_ObjCPropertyAccess = 1 << 7,
5070 * \brief Completions for enum tags should be included in the results.
5072 CXCompletionContext_EnumTag = 1 << 8,
5074 * \brief Completions for union tags should be included in the results.
5076 CXCompletionContext_UnionTag = 1 << 9,
5078 * \brief Completions for struct tags should be included in the results.
5080 CXCompletionContext_StructTag = 1 << 10,
5083 * \brief Completions for C++ class names should be included in the results.
5085 CXCompletionContext_ClassTag = 1 << 11,
5087 * \brief Completions for C++ namespaces and namespace aliases should be
5088 * included in the results.
5090 CXCompletionContext_Namespace = 1 << 12,
5092 * \brief Completions for C++ nested name specifiers should be included in
5095 CXCompletionContext_NestedNameSpecifier = 1 << 13,
5098 * \brief Completions for Objective-C interfaces (classes) should be included
5101 CXCompletionContext_ObjCInterface = 1 << 14,
5103 * \brief Completions for Objective-C protocols should be included in
5106 CXCompletionContext_ObjCProtocol = 1 << 15,
5108 * \brief Completions for Objective-C categories should be included in
5111 CXCompletionContext_ObjCCategory = 1 << 16,
5113 * \brief Completions for Objective-C instance messages should be included
5116 CXCompletionContext_ObjCInstanceMessage = 1 << 17,
5118 * \brief Completions for Objective-C class messages should be included in
5121 CXCompletionContext_ObjCClassMessage = 1 << 18,
5123 * \brief Completions for Objective-C selector names should be included in
5126 CXCompletionContext_ObjCSelectorName = 1 << 19,
5129 * \brief Completions for preprocessor macro names should be included in
5132 CXCompletionContext_MacroName = 1 << 20,
5135 * \brief Natural language completions should be included in the results.
5137 CXCompletionContext_NaturalLanguage = 1 << 21,
5140 * \brief The current context is unknown, so set all contexts.
5142 CXCompletionContext_Unknown = ((1 << 22) - 1)
5146 * \brief Returns a default set of code-completion options that can be
5147 * passed to\c clang_codeCompleteAt().
5149 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
5152 * \brief Perform code completion at a given location in a translation unit.
5154 * This function performs code completion at a particular file, line, and
5155 * column within source code, providing results that suggest potential
5156 * code snippets based on the context of the completion. The basic model
5157 * for code completion is that Clang will parse a complete source file,
5158 * performing syntax checking up to the location where code-completion has
5159 * been requested. At that point, a special code-completion token is passed
5160 * to the parser, which recognizes this token and determines, based on the
5161 * current location in the C/Objective-C/C++ grammar and the state of
5162 * semantic analysis, what completions to provide. These completions are
5163 * returned via a new \c CXCodeCompleteResults structure.
5165 * Code completion itself is meant to be triggered by the client when the
5166 * user types punctuation characters or whitespace, at which point the
5167 * code-completion location will coincide with the cursor. For example, if \c p
5168 * is a pointer, code-completion might be triggered after the "-" and then
5169 * after the ">" in \c p->. When the code-completion location is afer the ">",
5170 * the completion results will provide, e.g., the members of the struct that
5171 * "p" points to. The client is responsible for placing the cursor at the
5172 * beginning of the token currently being typed, then filtering the results
5173 * based on the contents of the token. For example, when code-completing for
5174 * the expression \c p->get, the client should provide the location just after
5175 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5176 * client can filter the results based on the current token text ("get"), only
5177 * showing those results that start with "get". The intent of this interface
5178 * is to separate the relatively high-latency acquisition of code-completion
5179 * results from the filtering of results on a per-character basis, which must
5180 * have a lower latency.
5182 * \param TU The translation unit in which code-completion should
5183 * occur. The source files for this translation unit need not be
5184 * completely up-to-date (and the contents of those source files may
5185 * be overridden via \p unsaved_files). Cursors referring into the
5186 * translation unit may be invalidated by this invocation.
5188 * \param complete_filename The name of the source file where code
5189 * completion should be performed. This filename may be any file
5190 * included in the translation unit.
5192 * \param complete_line The line at which code-completion should occur.
5194 * \param complete_column The column at which code-completion should occur.
5195 * Note that the column should point just after the syntactic construct that
5196 * initiated code completion, and not in the middle of a lexical token.
5198 * \param unsaved_files the Files that have not yet been saved to disk
5199 * but may be required for parsing or code completion, including the
5200 * contents of those files. The contents and name of these files (as
5201 * specified by CXUnsavedFile) are copied when necessary, so the
5202 * client only needs to guarantee their validity until the call to
5203 * this function returns.
5205 * \param num_unsaved_files The number of unsaved file entries in \p
5208 * \param options Extra options that control the behavior of code
5209 * completion, expressed as a bitwise OR of the enumerators of the
5210 * CXCodeComplete_Flags enumeration. The
5211 * \c clang_defaultCodeCompleteOptions() function returns a default set
5212 * of code-completion options.
5214 * \returns If successful, a new \c CXCodeCompleteResults structure
5215 * containing code-completion results, which should eventually be
5216 * freed with \c clang_disposeCodeCompleteResults(). If code
5217 * completion fails, returns NULL.
5220 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
5221 const char *complete_filename,
5222 unsigned complete_line,
5223 unsigned complete_column,
5224 struct CXUnsavedFile *unsaved_files,
5225 unsigned num_unsaved_files,
5229 * \brief Sort the code-completion results in case-insensitive alphabetical
5232 * \param Results The set of results to sort.
5233 * \param NumResults The number of results in \p Results.
5236 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
5237 unsigned NumResults);
5240 * \brief Free the given set of code-completion results.
5243 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
5246 * \brief Determine the number of diagnostics produced prior to the
5247 * location where code completion was performed.
5250 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
5253 * \brief Retrieve a diagnostic associated with the given code completion.
5255 * \param Results the code completion results to query.
5256 * \param Index the zero-based diagnostic number to retrieve.
5258 * \returns the requested diagnostic. This diagnostic must be freed
5259 * via a call to \c clang_disposeDiagnostic().
5262 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
5266 * \brief Determines what completions are appropriate for the context
5267 * the given code completion.
5269 * \param Results the code completion results to query
5271 * \returns the kinds of completions that are appropriate for use
5272 * along with the given code completion results.
5275 unsigned long long clang_codeCompleteGetContexts(
5276 CXCodeCompleteResults *Results);
5279 * \brief Returns the cursor kind for the container for the current code
5280 * completion context. The container is only guaranteed to be set for
5281 * contexts where a container exists (i.e. member accesses or Objective-C
5282 * message sends); if there is not a container, this function will return
5283 * CXCursor_InvalidCode.
5285 * \param Results the code completion results to query
5287 * \param IsIncomplete on return, this value will be false if Clang has complete
5288 * information about the container. If Clang does not have complete
5289 * information, this value will be true.
5291 * \returns the container kind, or CXCursor_InvalidCode if there is not a
5295 enum CXCursorKind clang_codeCompleteGetContainerKind(
5296 CXCodeCompleteResults *Results,
5297 unsigned *IsIncomplete);
5300 * \brief Returns the USR for the container for the current code completion
5301 * context. If there is not a container for the current context, this
5302 * function will return the empty string.
5304 * \param Results the code completion results to query
5306 * \returns the USR for the container
5309 CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
5312 * \brief Returns the currently-entered selector for an Objective-C message
5313 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5314 * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5315 * CXCompletionContext_ObjCClassMessage.
5317 * \param Results the code completion results to query
5319 * \returns the selector (or partial selector) that has been entered thus far
5320 * for an Objective-C message send.
5323 CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
5330 * \defgroup CINDEX_MISC Miscellaneous utility functions
5336 * \brief Return a version string, suitable for showing to a user, but not
5337 * intended to be parsed (the format is not guaranteed to be stable).
5339 CINDEX_LINKAGE CXString clang_getClangVersion(void);
5342 * \brief Enable/disable crash recovery.
5344 * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5345 * value enables crash recovery, while 0 disables it.
5347 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
5350 * \brief Visitor invoked for each file in a translation unit
5351 * (used with clang_getInclusions()).
5353 * This visitor function will be invoked by clang_getInclusions() for each
5354 * file included (either at the top-level or by \#include directives) within
5355 * a translation unit. The first argument is the file being included, and
5356 * the second and third arguments provide the inclusion stack. The
5357 * array is sorted in order of immediate inclusion. For example,
5358 * the first element refers to the location that included 'included_file'.
5360 typedef void (*CXInclusionVisitor)(CXFile included_file,
5361 CXSourceLocation* inclusion_stack,
5362 unsigned include_len,
5363 CXClientData client_data);
5366 * \brief Visit the set of preprocessor inclusions in a translation unit.
5367 * The visitor function is called with the provided data for every included
5368 * file. This does not include headers included by the PCH file (unless one
5369 * is inspecting the inclusions in the PCH file itself).
5371 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5372 CXInclusionVisitor visitor,
5373 CXClientData client_data);
5378 CXEval_ObjCStrLiteral = 3,
5379 CXEval_StrLiteral = 4,
5383 CXEval_UnExposed = 0
5385 } CXEvalResultKind ;
5388 * \brief Evaluation result of a cursor
5390 typedef void * CXEvalResult;
5393 * \brief If cursor is a statement declaration tries to evaluate the
5394 * statement and if its variable, tries to evaluate its initializer,
5395 * into its corresponding type.
5397 CINDEX_LINKAGE CXEvalResult clang_Cursor_Evaluate(CXCursor C);
5400 * \brief Returns the kind of the evaluated result.
5402 CINDEX_LINKAGE CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E);
5405 * \brief Returns the evaluation result as integer if the
5408 CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
5411 * \brief Returns the evaluation result as a long long integer if the
5412 * kind is Int. This prevents overflows that may happen if the result is
5413 * returned with clang_EvalResult_getAsInt.
5415 CINDEX_LINKAGE long long clang_EvalResult_getAsLongLong(CXEvalResult E);
5418 * \brief Returns a non-zero value if the kind is Int and the evaluation
5419 * result resulted in an unsigned integer.
5421 CINDEX_LINKAGE unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E);
5424 * \brief Returns the evaluation result as an unsigned integer if
5425 * the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
5427 CINDEX_LINKAGE unsigned long long clang_EvalResult_getAsUnsigned(CXEvalResult E);
5430 * \brief Returns the evaluation result as double if the
5433 CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
5436 * \brief Returns the evaluation result as a constant string if the
5437 * kind is other than Int or float. User must not free this pointer,
5438 * instead call clang_EvalResult_dispose on the CXEvalResult returned
5439 * by clang_Cursor_Evaluate.
5441 CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
5444 * \brief Disposes the created Eval memory.
5446 CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
5451 /** \defgroup CINDEX_REMAPPING Remapping functions
5457 * \brief A remapping of original source files and their translated files.
5459 typedef void *CXRemapping;
5462 * \brief Retrieve a remapping.
5464 * \param path the path that contains metadata about remappings.
5466 * \returns the requested remapping. This remapping must be freed
5467 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5469 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5472 * \brief Retrieve a remapping.
5474 * \param filePaths pointer to an array of file paths containing remapping info.
5476 * \param numFiles number of file paths.
5478 * \returns the requested remapping. This remapping must be freed
5479 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5482 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5486 * \brief Determine the number of remappings.
5488 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5491 * \brief Get the original and the associated filename from the remapping.
5493 * \param original If non-NULL, will be set to the original filename.
5495 * \param transformed If non-NULL, will be set to the filename that the original
5496 * is associated with.
5498 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5499 CXString *original, CXString *transformed);
5502 * \brief Dispose the remapping.
5504 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5510 /** \defgroup CINDEX_HIGH Higher level API functions
5515 enum CXVisitorResult {
5520 typedef struct CXCursorAndRangeVisitor {
5522 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5523 } CXCursorAndRangeVisitor;
5527 * \brief Function returned successfully.
5529 CXResult_Success = 0,
5531 * \brief One of the parameters was invalid for the function.
5533 CXResult_Invalid = 1,
5535 * \brief The function was terminated by a callback (e.g. it returned
5538 CXResult_VisitBreak = 2
5543 * \brief Find references of a declaration in a specific file.
5545 * \param cursor pointing to a declaration or a reference of one.
5547 * \param file to search for references.
5549 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5550 * each reference found.
5551 * The CXSourceRange will point inside the file; if the reference is inside
5552 * a macro (and not a macro argument) the CXSourceRange will be invalid.
5554 * \returns one of the CXResult enumerators.
5556 CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file,
5557 CXCursorAndRangeVisitor visitor);
5560 * \brief Find #import/#include directives in a specific file.
5562 * \param TU translation unit containing the file to query.
5564 * \param file to search for #import/#include directives.
5566 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5567 * each directive found.
5569 * \returns one of the CXResult enumerators.
5571 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5573 CXCursorAndRangeVisitor visitor);
5575 #ifdef __has_feature
5576 # if __has_feature(blocks)
5578 typedef enum CXVisitorResult
5579 (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5582 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5583 CXCursorAndRangeVisitorBlock);
5586 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5587 CXCursorAndRangeVisitorBlock);
5593 * \brief The client's data object that is associated with a CXFile.
5595 typedef void *CXIdxClientFile;
5598 * \brief The client's data object that is associated with a semantic entity.
5600 typedef void *CXIdxClientEntity;
5603 * \brief The client's data object that is associated with a semantic container
5606 typedef void *CXIdxClientContainer;
5609 * \brief The client's data object that is associated with an AST file (PCH
5612 typedef void *CXIdxClientASTFile;
5615 * \brief Source location passed to index callbacks.
5623 * \brief Data for ppIncludedFile callback.
5627 * \brief Location of '#' in the \#include/\#import directive.
5631 * \brief Filename as written in the \#include/\#import directive.
5633 const char *filename;
5635 * \brief The actual file that the \#include/\#import directive resolved to.
5641 * \brief Non-zero if the directive was automatically turned into a module
5645 } CXIdxIncludedFileInfo;
5648 * \brief Data for IndexerCallbacks#importedASTFile.
5652 * \brief Top level AST file containing the imported PCH, module or submodule.
5656 * \brief The imported module or NULL if the AST file is a PCH.
5660 * \brief Location where the file is imported. Applicable only for modules.
5664 * \brief Non-zero if an inclusion directive was automatically turned into
5665 * a module import. Applicable only for modules.
5669 } CXIdxImportedASTFileInfo;
5672 CXIdxEntity_Unexposed = 0,
5673 CXIdxEntity_Typedef = 1,
5674 CXIdxEntity_Function = 2,
5675 CXIdxEntity_Variable = 3,
5676 CXIdxEntity_Field = 4,
5677 CXIdxEntity_EnumConstant = 5,
5679 CXIdxEntity_ObjCClass = 6,
5680 CXIdxEntity_ObjCProtocol = 7,
5681 CXIdxEntity_ObjCCategory = 8,
5683 CXIdxEntity_ObjCInstanceMethod = 9,
5684 CXIdxEntity_ObjCClassMethod = 10,
5685 CXIdxEntity_ObjCProperty = 11,
5686 CXIdxEntity_ObjCIvar = 12,
5688 CXIdxEntity_Enum = 13,
5689 CXIdxEntity_Struct = 14,
5690 CXIdxEntity_Union = 15,
5692 CXIdxEntity_CXXClass = 16,
5693 CXIdxEntity_CXXNamespace = 17,
5694 CXIdxEntity_CXXNamespaceAlias = 18,
5695 CXIdxEntity_CXXStaticVariable = 19,
5696 CXIdxEntity_CXXStaticMethod = 20,
5697 CXIdxEntity_CXXInstanceMethod = 21,
5698 CXIdxEntity_CXXConstructor = 22,
5699 CXIdxEntity_CXXDestructor = 23,
5700 CXIdxEntity_CXXConversionFunction = 24,
5701 CXIdxEntity_CXXTypeAlias = 25,
5702 CXIdxEntity_CXXInterface = 26
5707 CXIdxEntityLang_None = 0,
5708 CXIdxEntityLang_C = 1,
5709 CXIdxEntityLang_ObjC = 2,
5710 CXIdxEntityLang_CXX = 3,
5711 CXIdxEntityLang_Swift = 4
5712 } CXIdxEntityLanguage;
5715 * \brief Extra C++ template information for an entity. This can apply to:
5716 * CXIdxEntity_Function
5717 * CXIdxEntity_CXXClass
5718 * CXIdxEntity_CXXStaticMethod
5719 * CXIdxEntity_CXXInstanceMethod
5720 * CXIdxEntity_CXXConstructor
5721 * CXIdxEntity_CXXConversionFunction
5722 * CXIdxEntity_CXXTypeAlias
5725 CXIdxEntity_NonTemplate = 0,
5726 CXIdxEntity_Template = 1,
5727 CXIdxEntity_TemplatePartialSpecialization = 2,
5728 CXIdxEntity_TemplateSpecialization = 3
5729 } CXIdxEntityCXXTemplateKind;
5732 CXIdxAttr_Unexposed = 0,
5733 CXIdxAttr_IBAction = 1,
5734 CXIdxAttr_IBOutlet = 2,
5735 CXIdxAttr_IBOutletCollection = 3
5745 CXIdxEntityKind kind;
5746 CXIdxEntityCXXTemplateKind templateKind;
5747 CXIdxEntityLanguage lang;
5751 const CXIdxAttrInfo *const *attributes;
5752 unsigned numAttributes;
5757 } CXIdxContainerInfo;
5760 const CXIdxAttrInfo *attrInfo;
5761 const CXIdxEntityInfo *objcClass;
5762 CXCursor classCursor;
5764 } CXIdxIBOutletCollectionAttrInfo;
5767 CXIdxDeclFlag_Skipped = 0x1
5768 } CXIdxDeclInfoFlags;
5771 const CXIdxEntityInfo *entityInfo;
5774 const CXIdxContainerInfo *semanticContainer;
5776 * \brief Generally same as #semanticContainer but can be different in
5777 * cases like out-of-line C++ member functions.
5779 const CXIdxContainerInfo *lexicalContainer;
5780 int isRedeclaration;
5783 const CXIdxContainerInfo *declAsContainer;
5785 * \brief Whether the declaration exists in code or was created implicitly
5786 * by the compiler, e.g. implicit Objective-C methods for properties.
5789 const CXIdxAttrInfo *const *attributes;
5790 unsigned numAttributes;
5797 CXIdxObjCContainer_ForwardRef = 0,
5798 CXIdxObjCContainer_Interface = 1,
5799 CXIdxObjCContainer_Implementation = 2
5800 } CXIdxObjCContainerKind;
5803 const CXIdxDeclInfo *declInfo;
5804 CXIdxObjCContainerKind kind;
5805 } CXIdxObjCContainerDeclInfo;
5808 const CXIdxEntityInfo *base;
5811 } CXIdxBaseClassInfo;
5814 const CXIdxEntityInfo *protocol;
5817 } CXIdxObjCProtocolRefInfo;
5820 const CXIdxObjCProtocolRefInfo *const *protocols;
5821 unsigned numProtocols;
5822 } CXIdxObjCProtocolRefListInfo;
5825 const CXIdxObjCContainerDeclInfo *containerInfo;
5826 const CXIdxBaseClassInfo *superInfo;
5827 const CXIdxObjCProtocolRefListInfo *protocols;
5828 } CXIdxObjCInterfaceDeclInfo;
5831 const CXIdxObjCContainerDeclInfo *containerInfo;
5832 const CXIdxEntityInfo *objcClass;
5833 CXCursor classCursor;
5835 const CXIdxObjCProtocolRefListInfo *protocols;
5836 } CXIdxObjCCategoryDeclInfo;
5839 const CXIdxDeclInfo *declInfo;
5840 const CXIdxEntityInfo *getter;
5841 const CXIdxEntityInfo *setter;
5842 } CXIdxObjCPropertyDeclInfo;
5845 const CXIdxDeclInfo *declInfo;
5846 const CXIdxBaseClassInfo *const *bases;
5848 } CXIdxCXXClassDeclInfo;
5851 * \brief Data for IndexerCallbacks#indexEntityReference.
5855 * \brief The entity is referenced directly in user's code.
5857 CXIdxEntityRef_Direct = 1,
5859 * \brief An implicit reference, e.g. a reference of an Objective-C method
5860 * via the dot syntax.
5862 CXIdxEntityRef_Implicit = 2
5863 } CXIdxEntityRefKind;
5866 * \brief Data for IndexerCallbacks#indexEntityReference.
5869 CXIdxEntityRefKind kind;
5871 * \brief Reference cursor.
5876 * \brief The entity that gets referenced.
5878 const CXIdxEntityInfo *referencedEntity;
5880 * \brief Immediate "parent" of the reference. For example:
5886 * The parent of reference of type 'Foo' is the variable 'var'.
5887 * For references inside statement bodies of functions/methods,
5888 * the parentEntity will be the function/method.
5890 const CXIdxEntityInfo *parentEntity;
5892 * \brief Lexical container context of the reference.
5894 const CXIdxContainerInfo *container;
5895 } CXIdxEntityRefInfo;
5898 * \brief A group of callbacks used by #clang_indexSourceFile and
5899 * #clang_indexTranslationUnit.
5903 * \brief Called periodically to check whether indexing should be aborted.
5904 * Should return 0 to continue, and non-zero to abort.
5906 int (*abortQuery)(CXClientData client_data, void *reserved);
5909 * \brief Called at the end of indexing; passes the complete diagnostic set.
5911 void (*diagnostic)(CXClientData client_data,
5912 CXDiagnosticSet, void *reserved);
5914 CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
5915 CXFile mainFile, void *reserved);
5918 * \brief Called when a file gets \#included/\#imported.
5920 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
5921 const CXIdxIncludedFileInfo *);
5924 * \brief Called when a AST file (PCH or module) gets imported.
5926 * AST files will not get indexed (there will not be callbacks to index all
5927 * the entities in an AST file). The recommended action is that, if the AST
5928 * file is not already indexed, to initiate a new indexing job specific to
5931 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
5932 const CXIdxImportedASTFileInfo *);
5935 * \brief Called at the beginning of indexing a translation unit.
5937 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
5940 void (*indexDeclaration)(CXClientData client_data,
5941 const CXIdxDeclInfo *);
5944 * \brief Called to index a reference of an entity.
5946 void (*indexEntityReference)(CXClientData client_data,
5947 const CXIdxEntityRefInfo *);
5951 CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
5952 CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
5953 clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
5955 CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
5956 clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
5959 const CXIdxObjCCategoryDeclInfo *
5960 clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
5962 CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
5963 clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
5965 CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
5966 clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
5968 CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
5969 clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
5971 CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
5972 clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
5975 * \brief For retrieving a custom CXIdxClientContainer attached to a
5978 CINDEX_LINKAGE CXIdxClientContainer
5979 clang_index_getClientContainer(const CXIdxContainerInfo *);
5982 * \brief For setting a custom CXIdxClientContainer attached to a
5986 clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
5989 * \brief For retrieving a custom CXIdxClientEntity attached to an entity.
5991 CINDEX_LINKAGE CXIdxClientEntity
5992 clang_index_getClientEntity(const CXIdxEntityInfo *);
5995 * \brief For setting a custom CXIdxClientEntity attached to an entity.
5998 clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
6001 * \brief An indexing action/session, to be applied to one or multiple
6002 * translation units.
6004 typedef void *CXIndexAction;
6007 * \brief An indexing action/session, to be applied to one or multiple
6008 * translation units.
6010 * \param CIdx The index object with which the index action will be associated.
6012 CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
6015 * \brief Destroy the given index action.
6017 * The index action must not be destroyed until all of the translation units
6018 * created within that index action have been destroyed.
6020 CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
6024 * \brief Used to indicate that no special indexing options are needed.
6026 CXIndexOpt_None = 0x0,
6029 * \brief Used to indicate that IndexerCallbacks#indexEntityReference should
6030 * be invoked for only one reference of an entity per source file that does
6031 * not also include a declaration/definition of the entity.
6033 CXIndexOpt_SuppressRedundantRefs = 0x1,
6036 * \brief Function-local symbols should be indexed. If this is not set
6037 * function-local symbols will be ignored.
6039 CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
6042 * \brief Implicit function/class template instantiations should be indexed.
6043 * If this is not set, implicit instantiations will be ignored.
6045 CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
6048 * \brief Suppress all compiler warnings when parsing for indexing.
6050 CXIndexOpt_SuppressWarnings = 0x8,
6053 * \brief Skip a function/method body that was already parsed during an
6054 * indexing session associated with a \c CXIndexAction object.
6055 * Bodies in system headers are always skipped.
6057 CXIndexOpt_SkipParsedBodiesInSession = 0x10
6062 * \brief Index the given source file and the translation unit corresponding
6063 * to that file via callbacks implemented through #IndexerCallbacks.
6065 * \param client_data pointer data supplied by the client, which will
6066 * be passed to the invoked callbacks.
6068 * \param index_callbacks Pointer to indexing callbacks that the client
6071 * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
6072 * passed in index_callbacks.
6074 * \param index_options A bitmask of options that affects how indexing is
6075 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
6077 * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
6078 * reused after indexing is finished. Set to \c NULL if you do not require it.
6080 * \returns 0 on success or if there were errors from which the compiler could
6081 * recover. If there is a failure from which there is no recovery, returns
6082 * a non-zero \c CXErrorCode.
6084 * The rest of the parameters are the same as #clang_parseTranslationUnit.
6086 CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
6087 CXClientData client_data,
6088 IndexerCallbacks *index_callbacks,
6089 unsigned index_callbacks_size,
6090 unsigned index_options,
6091 const char *source_filename,
6092 const char * const *command_line_args,
6093 int num_command_line_args,
6094 struct CXUnsavedFile *unsaved_files,
6095 unsigned num_unsaved_files,
6096 CXTranslationUnit *out_TU,
6097 unsigned TU_options);
6100 * \brief Same as clang_indexSourceFile but requires a full command line
6101 * for \c command_line_args including argv[0]. This is useful if the standard
6102 * library paths are relative to the binary.
6104 CINDEX_LINKAGE int clang_indexSourceFileFullArgv(
6105 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6106 unsigned index_callbacks_size, unsigned index_options,
6107 const char *source_filename, const char *const *command_line_args,
6108 int num_command_line_args, struct CXUnsavedFile *unsaved_files,
6109 unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
6112 * \brief Index the given translation unit via callbacks implemented through
6113 * #IndexerCallbacks.
6115 * The order of callback invocations is not guaranteed to be the same as
6116 * when indexing a source file. The high level order will be:
6118 * -Preprocessor callbacks invocations
6119 * -Declaration/reference callbacks invocations
6120 * -Diagnostic callback invocations
6122 * The parameters are the same as #clang_indexSourceFile.
6124 * \returns If there is a failure from which there is no recovery, returns
6125 * non-zero, otherwise returns 0.
6127 CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
6128 CXClientData client_data,
6129 IndexerCallbacks *index_callbacks,
6130 unsigned index_callbacks_size,
6131 unsigned index_options,
6135 * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by
6136 * the given CXIdxLoc.
6138 * If the location refers into a macro expansion, retrieves the
6139 * location of the macro expansion and if it refers into a macro argument
6140 * retrieves the location of the argument.
6142 CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
6143 CXIdxClientFile *indexFile,
6150 * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
6153 CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
6156 * \brief Visitor invoked for each field found by a traversal.
6158 * This visitor function will be invoked for each field found by
6159 * \c clang_Type_visitFields. Its first argument is the cursor being
6160 * visited, its second argument is the client data provided to
6161 * \c clang_Type_visitFields.
6163 * The visitor should return one of the \c CXVisitorResult values
6164 * to direct \c clang_Type_visitFields.
6166 typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
6167 CXClientData client_data);
6170 * \brief Visit the fields of a particular type.
6172 * This function visits all the direct fields of the given cursor,
6173 * invoking the given \p visitor function with the cursors of each
6174 * visited field. The traversal may be ended prematurely, if
6175 * the visitor returns \c CXFieldVisit_Break.
6177 * \param T the record type whose field may be visited.
6179 * \param visitor the visitor function that will be invoked for each
6182 * \param client_data pointer data supplied by the client, which will
6183 * be passed to the visitor each time it is invoked.
6185 * \returns a non-zero value if the traversal was terminated
6186 * prematurely by the visitor returning \c CXFieldVisit_Break.
6188 CINDEX_LINKAGE unsigned clang_Type_visitFields(CXType T,
6189 CXFieldVisitor visitor,
6190 CXClientData client_data);