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 interface 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 43
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 Describes the exception specification of a cursor.
178 * A negative value indicates that the cursor is not a function declaration.
180 enum CXCursor_ExceptionSpecificationKind {
183 * \brief The cursor has no exception specification.
185 CXCursor_ExceptionSpecificationKind_None,
188 * \brief The cursor has exception specification throw()
190 CXCursor_ExceptionSpecificationKind_DynamicNone,
193 * \brief The cursor has exception specification throw(T1, T2)
195 CXCursor_ExceptionSpecificationKind_Dynamic,
198 * \brief The cursor has exception specification throw(...).
200 CXCursor_ExceptionSpecificationKind_MSAny,
203 * \brief The cursor has exception specification basic noexcept.
205 CXCursor_ExceptionSpecificationKind_BasicNoexcept,
208 * \brief The cursor has exception specification computed noexcept.
210 CXCursor_ExceptionSpecificationKind_ComputedNoexcept,
213 * \brief The exception specification has not yet been evaluated.
215 CXCursor_ExceptionSpecificationKind_Unevaluated,
218 * \brief The exception specification has not yet been instantiated.
220 CXCursor_ExceptionSpecificationKind_Uninstantiated,
223 * \brief The exception specification has not been parsed yet.
225 CXCursor_ExceptionSpecificationKind_Unparsed
229 * \brief Provides a shared context for creating translation units.
231 * It provides two options:
233 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
234 * declarations (when loading any new translation units). A "local" declaration
235 * is one that belongs in the translation unit itself and not in a precompiled
236 * header that was used by the translation unit. If zero, all declarations
237 * will be enumerated.
239 * Here is an example:
242 * // excludeDeclsFromPCH = 1, displayDiagnostics=1
243 * Idx = clang_createIndex(1, 1);
245 * // IndexTest.pch was produced with the following command:
246 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
247 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
249 * // This will load all the symbols from 'IndexTest.pch'
250 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
251 * TranslationUnitVisitor, 0);
252 * clang_disposeTranslationUnit(TU);
254 * // This will load all the symbols from 'IndexTest.c', excluding symbols
255 * // from 'IndexTest.pch'.
256 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
257 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
259 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
260 * TranslationUnitVisitor, 0);
261 * clang_disposeTranslationUnit(TU);
264 * This process of creating the 'pch', loading it separately, and using it (via
265 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
266 * (which gives the indexer the same performance benefit as the compiler).
268 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
269 int displayDiagnostics);
272 * \brief Destroy the given index.
274 * The index must not be destroyed until all of the translation units created
275 * within that index have been destroyed.
277 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
281 * \brief Used to indicate that no special CXIndex options are needed.
283 CXGlobalOpt_None = 0x0,
286 * \brief Used to indicate that threads that libclang creates for indexing
287 * purposes should use background priority.
289 * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
290 * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
292 CXGlobalOpt_ThreadBackgroundPriorityForIndexing = 0x1,
295 * \brief Used to indicate that threads that libclang creates for editing
296 * purposes should use background priority.
298 * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
299 * #clang_annotateTokens
301 CXGlobalOpt_ThreadBackgroundPriorityForEditing = 0x2,
304 * \brief Used to indicate that all threads that libclang creates should use
305 * background priority.
307 CXGlobalOpt_ThreadBackgroundPriorityForAll =
308 CXGlobalOpt_ThreadBackgroundPriorityForIndexing |
309 CXGlobalOpt_ThreadBackgroundPriorityForEditing
314 * \brief Sets general options associated with a CXIndex.
319 * clang_CXIndex_setGlobalOptions(idx,
320 * clang_CXIndex_getGlobalOptions(idx) |
321 * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
324 * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
326 CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
329 * \brief Gets the general options associated with a CXIndex.
331 * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
332 * are associated with the given CXIndex object.
334 CINDEX_LINKAGE unsigned clang_CXIndex_getGlobalOptions(CXIndex);
337 * \defgroup CINDEX_FILES File manipulation routines
343 * \brief A particular source file that is part of a translation unit.
345 typedef void *CXFile;
348 * \brief Retrieve the complete file and path name of the given file.
350 CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
353 * \brief Retrieve the last modification time of the given file.
355 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
358 * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
359 * across an indexing session.
362 unsigned long long data[3];
366 * \brief Retrieve the unique ID for the given \c file.
368 * \param file the file to get the ID for.
369 * \param outID stores the returned CXFileUniqueID.
370 * \returns If there was a failure getting the unique ID, returns non-zero,
371 * otherwise returns 0.
373 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
376 * \brief Determine whether the given header is guarded against
377 * multiple inclusions, either with the conventional
378 * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
380 CINDEX_LINKAGE unsigned
381 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
384 * \brief Retrieve a file handle within the given translation unit.
386 * \param tu the translation unit
388 * \param file_name the name of the file.
390 * \returns the file handle for the named file in the translation unit \p tu,
391 * or a NULL file handle if the file was not a part of this translation unit.
393 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
394 const char *file_name);
397 * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
398 * or they are both NULL.
400 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
407 * \defgroup CINDEX_LOCATIONS Physical source locations
409 * Clang represents physical source locations in its abstract syntax tree in
410 * great detail, with file, line, and column information for the majority of
411 * the tokens parsed in the source code. These data types and functions are
412 * used to represent source location information, either for a particular
413 * point in the program or for a range of points in the program, and extract
414 * specific location information from those data types.
420 * \brief Identifies a specific source location within a translation
423 * Use clang_getExpansionLocation() or clang_getSpellingLocation()
424 * to map a source location to a particular file, line, and column.
427 const void *ptr_data[2];
432 * \brief Identifies a half-open character range in the source code.
434 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
435 * starting and end locations from a source range, respectively.
438 const void *ptr_data[2];
439 unsigned begin_int_data;
440 unsigned end_int_data;
444 * \brief Retrieve a NULL (invalid) source location.
446 CINDEX_LINKAGE CXSourceLocation clang_getNullLocation(void);
449 * \brief Determine whether two source locations, which must refer into
450 * the same translation unit, refer to exactly the same point in the source
453 * \returns non-zero if the source locations refer to the same location, zero
454 * if they refer to different locations.
456 CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
457 CXSourceLocation loc2);
460 * \brief Retrieves the source location associated with a given file/line/column
461 * in a particular translation unit.
463 CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
468 * \brief Retrieves the source location associated with a given character offset
469 * in a particular translation unit.
471 CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
476 * \brief Returns non-zero if the given source location is in a system header.
478 CINDEX_LINKAGE int clang_Location_isInSystemHeader(CXSourceLocation location);
481 * \brief Returns non-zero if the given source location is in the main file of
482 * the corresponding translation unit.
484 CINDEX_LINKAGE int clang_Location_isFromMainFile(CXSourceLocation location);
487 * \brief Retrieve a NULL (invalid) source range.
489 CINDEX_LINKAGE CXSourceRange clang_getNullRange(void);
492 * \brief Retrieve a source range given the beginning and ending source
495 CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
496 CXSourceLocation end);
499 * \brief Determine whether two ranges are equivalent.
501 * \returns non-zero if the ranges are the same, zero if they differ.
503 CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
504 CXSourceRange range2);
507 * \brief Returns non-zero if \p range is null.
509 CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
512 * \brief Retrieve the file, line, column, and offset represented by
513 * the given source location.
515 * If the location refers into a macro expansion, retrieves the
516 * location of the macro expansion.
518 * \param location the location within a source file that will be decomposed
521 * \param file [out] if non-NULL, will be set to the file to which the given
522 * source location points.
524 * \param line [out] if non-NULL, will be set to the line to which the given
525 * source location points.
527 * \param column [out] if non-NULL, will be set to the column to which the given
528 * source location points.
530 * \param offset [out] if non-NULL, will be set to the offset into the
531 * buffer to which the given source location points.
533 CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location,
540 * \brief Retrieve the file, line and column represented by the given source
541 * location, as specified in a # line directive.
543 * Example: given the following source code in a file somefile.c
548 * static int func(void)
554 * the location information returned by this function would be
556 * File: dummy.c Line: 124 Column: 12
558 * whereas clang_getExpansionLocation would have returned
560 * File: somefile.c Line: 3 Column: 12
562 * \param location the location within a source file that will be decomposed
565 * \param filename [out] if non-NULL, will be set to the filename of the
566 * source location. Note that filenames returned will be for "virtual" files,
567 * which don't necessarily exist on the machine running clang - e.g. when
568 * parsing preprocessed output obtained from a different environment. If
569 * a non-NULL value is passed in, remember to dispose of the returned value
570 * using \c clang_disposeString() once you've finished with it. For an invalid
571 * source location, an empty string is returned.
573 * \param line [out] if non-NULL, will be set to the line number of the
574 * source location. For an invalid source location, zero is returned.
576 * \param column [out] if non-NULL, will be set to the column number of the
577 * source location. For an invalid source location, zero is returned.
579 CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location,
585 * \brief Legacy API to retrieve the file, line, column, and offset represented
586 * by the given source location.
588 * This interface has been replaced by the newer interface
589 * #clang_getExpansionLocation(). See that interface's documentation for
592 CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
599 * \brief Retrieve the file, line, column, and offset represented by
600 * the given source location.
602 * If the location refers into a macro instantiation, return where the
603 * location was originally spelled in the source file.
605 * \param location the location within a source file that will be decomposed
608 * \param file [out] if non-NULL, will be set to the file to which the given
609 * source location points.
611 * \param line [out] if non-NULL, will be set to the line to which the given
612 * source location points.
614 * \param column [out] if non-NULL, will be set to the column to which the given
615 * source location points.
617 * \param offset [out] if non-NULL, will be set to the offset into the
618 * buffer to which the given source location points.
620 CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
627 * \brief Retrieve the file, line, column, and offset represented by
628 * the given source location.
630 * If the location refers into a macro expansion, return where the macro was
631 * expanded or where the macro argument was written, if the location points at
634 * \param location the location within a source file that will be decomposed
637 * \param file [out] if non-NULL, will be set to the file to which the given
638 * source location points.
640 * \param line [out] if non-NULL, will be set to the line to which the given
641 * source location points.
643 * \param column [out] if non-NULL, will be set to the column to which the given
644 * source location points.
646 * \param offset [out] if non-NULL, will be set to the offset into the
647 * buffer to which the given source location points.
649 CINDEX_LINKAGE void clang_getFileLocation(CXSourceLocation location,
656 * \brief Retrieve a source location representing the first character within a
659 CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
662 * \brief Retrieve a source location representing the last character within a
665 CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
668 * \brief Identifies an array of ranges.
671 /** \brief The number of ranges in the \c ranges array. */
674 * \brief An array of \c CXSourceRanges.
676 CXSourceRange *ranges;
680 * \brief Retrieve all ranges that were skipped by the preprocessor.
682 * The preprocessor will skip lines when they are surrounded by an
683 * if/ifdef/ifndef directive whose condition does not evaluate to true.
685 CINDEX_LINKAGE CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit tu,
689 * \brief Retrieve all ranges from all files that were skipped by the
692 * The preprocessor will skip lines when they are surrounded by an
693 * if/ifdef/ifndef directive whose condition does not evaluate to true.
695 CINDEX_LINKAGE CXSourceRangeList *clang_getAllSkippedRanges(CXTranslationUnit tu);
698 * \brief Destroy the given \c CXSourceRangeList.
700 CINDEX_LINKAGE void clang_disposeSourceRangeList(CXSourceRangeList *ranges);
707 * \defgroup CINDEX_DIAG Diagnostic reporting
713 * \brief Describes the severity of a particular diagnostic.
715 enum CXDiagnosticSeverity {
717 * \brief A diagnostic that has been suppressed, e.g., by a command-line
720 CXDiagnostic_Ignored = 0,
723 * \brief This diagnostic is a note that should be attached to the
724 * previous (non-note) diagnostic.
726 CXDiagnostic_Note = 1,
729 * \brief This diagnostic indicates suspicious code that may not be
732 CXDiagnostic_Warning = 2,
735 * \brief This diagnostic indicates that the code is ill-formed.
737 CXDiagnostic_Error = 3,
740 * \brief This diagnostic indicates that the code is ill-formed such
741 * that future parser recovery is unlikely to produce useful
744 CXDiagnostic_Fatal = 4
748 * \brief A single diagnostic, containing the diagnostic's severity,
749 * location, text, source ranges, and fix-it hints.
751 typedef void *CXDiagnostic;
754 * \brief A group of CXDiagnostics.
756 typedef void *CXDiagnosticSet;
759 * \brief Determine the number of diagnostics in a CXDiagnosticSet.
761 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
764 * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
766 * \param Diags the CXDiagnosticSet to query.
767 * \param Index the zero-based diagnostic number to retrieve.
769 * \returns the requested diagnostic. This diagnostic must be freed
770 * via a call to \c clang_disposeDiagnostic().
772 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
776 * \brief Describes the kind of error that occurred (if any) in a call to
777 * \c clang_loadDiagnostics.
779 enum CXLoadDiag_Error {
781 * \brief Indicates that no error occurred.
786 * \brief Indicates that an unknown error occurred while attempting to
787 * deserialize diagnostics.
789 CXLoadDiag_Unknown = 1,
792 * \brief Indicates that the file containing the serialized diagnostics
793 * could not be opened.
795 CXLoadDiag_CannotLoad = 2,
798 * \brief Indicates that the serialized diagnostics file is invalid or
801 CXLoadDiag_InvalidFile = 3
805 * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
808 * \param file The name of the file to deserialize.
809 * \param error A pointer to a enum value recording if there was a problem
810 * deserializing the diagnostics.
811 * \param errorString A pointer to a CXString for recording the error string
812 * if the file was not successfully loaded.
814 * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
815 * diagnostics should be released using clang_disposeDiagnosticSet().
817 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
818 enum CXLoadDiag_Error *error,
819 CXString *errorString);
822 * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
824 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
827 * \brief Retrieve the child diagnostics of a CXDiagnostic.
829 * This CXDiagnosticSet does not need to be released by
830 * clang_disposeDiagnosticSet.
832 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
835 * \brief Determine the number of diagnostics produced for the given
838 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
841 * \brief Retrieve a diagnostic associated with the given translation unit.
843 * \param Unit the translation unit to query.
844 * \param Index the zero-based diagnostic number to retrieve.
846 * \returns the requested diagnostic. This diagnostic must be freed
847 * via a call to \c clang_disposeDiagnostic().
849 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
853 * \brief Retrieve the complete set of diagnostics associated with a
856 * \param Unit the translation unit to query.
858 CINDEX_LINKAGE CXDiagnosticSet
859 clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
862 * \brief Destroy a diagnostic.
864 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
867 * \brief Options to control the display of diagnostics.
869 * The values in this enum are meant to be combined to customize the
870 * behavior of \c clang_formatDiagnostic().
872 enum CXDiagnosticDisplayOptions {
874 * \brief Display the source-location information where the
875 * diagnostic was located.
877 * When set, diagnostics will be prefixed by the file, line, and
878 * (optionally) column to which the diagnostic refers. For example,
881 * test.c:28: warning: extra tokens at end of #endif directive
884 * This option corresponds to the clang flag \c -fshow-source-location.
886 CXDiagnostic_DisplaySourceLocation = 0x01,
889 * \brief If displaying the source-location information of the
890 * diagnostic, also include the column number.
892 * This option corresponds to the clang flag \c -fshow-column.
894 CXDiagnostic_DisplayColumn = 0x02,
897 * \brief If displaying the source-location information of the
898 * diagnostic, also include information about source ranges in a
899 * machine-parsable format.
901 * This option corresponds to the clang flag
902 * \c -fdiagnostics-print-source-range-info.
904 CXDiagnostic_DisplaySourceRanges = 0x04,
907 * \brief Display the option name associated with this diagnostic, if any.
909 * The option name displayed (e.g., -Wconversion) will be placed in brackets
910 * after the diagnostic text. This option corresponds to the clang flag
911 * \c -fdiagnostics-show-option.
913 CXDiagnostic_DisplayOption = 0x08,
916 * \brief Display the category number associated with this diagnostic, if any.
918 * The category number is displayed within brackets after the diagnostic text.
919 * This option corresponds to the clang flag
920 * \c -fdiagnostics-show-category=id.
922 CXDiagnostic_DisplayCategoryId = 0x10,
925 * \brief Display the category name associated with this diagnostic, if any.
927 * The category name is displayed within brackets after the diagnostic text.
928 * This option corresponds to the clang flag
929 * \c -fdiagnostics-show-category=name.
931 CXDiagnostic_DisplayCategoryName = 0x20
935 * \brief Format the given diagnostic in a manner that is suitable for display.
937 * This routine will format the given diagnostic to a string, rendering
938 * the diagnostic according to the various options given. The
939 * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
940 * options that most closely mimics the behavior of the clang compiler.
942 * \param Diagnostic The diagnostic to print.
944 * \param Options A set of options that control the diagnostic display,
945 * created by combining \c CXDiagnosticDisplayOptions values.
947 * \returns A new string containing for formatted diagnostic.
949 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
953 * \brief Retrieve the set of display options most similar to the
954 * default behavior of the clang compiler.
956 * \returns A set of display options suitable for use with \c
957 * clang_formatDiagnostic().
959 CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
962 * \brief Determine the severity of the given diagnostic.
964 CINDEX_LINKAGE enum CXDiagnosticSeverity
965 clang_getDiagnosticSeverity(CXDiagnostic);
968 * \brief Retrieve the source location of the given diagnostic.
970 * This location is where Clang would print the caret ('^') when
971 * displaying the diagnostic on the command line.
973 CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
976 * \brief Retrieve the text of the given diagnostic.
978 CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
981 * \brief Retrieve the name of the command-line option that enabled this
984 * \param Diag The diagnostic to be queried.
986 * \param Disable If non-NULL, will be set to the option that disables this
987 * diagnostic (if any).
989 * \returns A string that contains the command-line option used to enable this
990 * warning, such as "-Wconversion" or "-pedantic".
992 CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
996 * \brief Retrieve the category number for this diagnostic.
998 * Diagnostics can be categorized into groups along with other, related
999 * diagnostics (e.g., diagnostics under the same warning flag). This routine
1000 * retrieves the category number for the given diagnostic.
1002 * \returns The number of the category that contains this diagnostic, or zero
1003 * if this diagnostic is uncategorized.
1005 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
1008 * \brief Retrieve the name of a particular diagnostic category. This
1009 * is now deprecated. Use clang_getDiagnosticCategoryText()
1012 * \param Category A diagnostic category number, as returned by
1013 * \c clang_getDiagnosticCategory().
1015 * \returns The name of the given diagnostic category.
1017 CINDEX_DEPRECATED CINDEX_LINKAGE
1018 CXString clang_getDiagnosticCategoryName(unsigned Category);
1021 * \brief Retrieve the diagnostic category text for a given diagnostic.
1023 * \returns The text of the given diagnostic category.
1025 CINDEX_LINKAGE CXString clang_getDiagnosticCategoryText(CXDiagnostic);
1028 * \brief Determine the number of source ranges associated with the given
1031 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
1034 * \brief Retrieve a source range associated with the diagnostic.
1036 * A diagnostic's source ranges highlight important elements in the source
1037 * code. On the command line, Clang displays source ranges by
1038 * underlining them with '~' characters.
1040 * \param Diagnostic the diagnostic whose range is being extracted.
1042 * \param Range the zero-based index specifying which range to
1044 * \returns the requested source range.
1046 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
1050 * \brief Determine the number of fix-it hints associated with the
1053 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
1056 * \brief Retrieve the replacement information for a given fix-it.
1058 * Fix-its are described in terms of a source range whose contents
1059 * should be replaced by a string. This approach generalizes over
1060 * three kinds of operations: removal of source code (the range covers
1061 * the code to be removed and the replacement string is empty),
1062 * replacement of source code (the range covers the code to be
1063 * replaced and the replacement string provides the new code), and
1064 * insertion (both the start and end of the range point at the
1065 * insertion location, and the replacement string provides the text to
1068 * \param Diagnostic The diagnostic whose fix-its are being queried.
1070 * \param FixIt The zero-based index of the fix-it.
1072 * \param ReplacementRange The source range whose contents will be
1073 * replaced with the returned replacement string. Note that source
1074 * ranges are half-open ranges [a, b), so the source code should be
1075 * replaced from a and up to (but not including) b.
1077 * \returns A string containing text that should be replace the source
1078 * code indicated by the \c ReplacementRange.
1080 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1082 CXSourceRange *ReplacementRange);
1089 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1091 * The routines in this group provide the ability to create and destroy
1092 * translation units from files, either by parsing the contents of the files or
1093 * by reading in a serialized representation of a translation unit.
1099 * \brief Get the original translation unit source file name.
1101 CINDEX_LINKAGE CXString
1102 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1105 * \brief Return the CXTranslationUnit for a given source file and the provided
1106 * command line arguments one would pass to the compiler.
1108 * Note: The 'source_filename' argument is optional. If the caller provides a
1109 * NULL pointer, the name of the source file is expected to reside in the
1110 * specified command line arguments.
1112 * Note: When encountered in 'clang_command_line_args', the following options
1118 * '-o \<output file>' (both '-o' and '\<output file>' are ignored)
1120 * \param CIdx The index object with which the translation unit will be
1123 * \param source_filename The name of the source file to load, or NULL if the
1124 * source file is included in \p clang_command_line_args.
1126 * \param num_clang_command_line_args The number of command-line arguments in
1127 * \p clang_command_line_args.
1129 * \param clang_command_line_args The command-line arguments that would be
1130 * passed to the \c clang executable if it were being invoked out-of-process.
1131 * These command-line options will be parsed and will affect how the translation
1132 * unit is parsed. Note that the following options are ignored: '-c',
1133 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1135 * \param num_unsaved_files the number of unsaved file entries in \p
1138 * \param unsaved_files the files that have not yet been saved to disk
1139 * but may be required for code completion, including the contents of
1140 * those files. The contents and name of these files (as specified by
1141 * CXUnsavedFile) are copied when necessary, so the client only needs to
1142 * guarantee their validity until the call to this function returns.
1144 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
1146 const char *source_filename,
1147 int num_clang_command_line_args,
1148 const char * const *clang_command_line_args,
1149 unsigned num_unsaved_files,
1150 struct CXUnsavedFile *unsaved_files);
1153 * \brief Same as \c clang_createTranslationUnit2, but returns
1154 * the \c CXTranslationUnit instead of an error code. In case of an error this
1155 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1158 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(
1160 const char *ast_filename);
1163 * \brief Create a translation unit from an AST file (\c -emit-ast).
1165 * \param[out] out_TU A non-NULL pointer to store the created
1166 * \c CXTranslationUnit.
1168 * \returns Zero on success, otherwise returns an error code.
1170 CINDEX_LINKAGE enum CXErrorCode clang_createTranslationUnit2(
1172 const char *ast_filename,
1173 CXTranslationUnit *out_TU);
1176 * \brief Flags that control the creation of translation units.
1178 * The enumerators in this enumeration type are meant to be bitwise
1179 * ORed together to specify which options should be used when
1180 * constructing the translation unit.
1182 enum CXTranslationUnit_Flags {
1184 * \brief Used to indicate that no special translation-unit options are
1187 CXTranslationUnit_None = 0x0,
1190 * \brief Used to indicate that the parser should construct a "detailed"
1191 * preprocessing record, including all macro definitions and instantiations.
1193 * Constructing a detailed preprocessing record requires more memory
1194 * and time to parse, since the information contained in the record
1195 * is usually not retained. However, it can be useful for
1196 * applications that require more detailed information about the
1197 * behavior of the preprocessor.
1199 CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
1202 * \brief Used to indicate that the translation unit is incomplete.
1204 * When a translation unit is considered "incomplete", semantic
1205 * analysis that is typically performed at the end of the
1206 * translation unit will be suppressed. For example, this suppresses
1207 * the completion of tentative declarations in C and of
1208 * instantiation of implicitly-instantiation function templates in
1209 * C++. This option is typically used when parsing a header with the
1210 * intent of producing a precompiled header.
1212 CXTranslationUnit_Incomplete = 0x02,
1215 * \brief Used to indicate that the translation unit should be built with an
1216 * implicit precompiled header for the preamble.
1218 * An implicit precompiled header is used as an optimization when a
1219 * particular translation unit is likely to be reparsed many times
1220 * when the sources aren't changing that often. In this case, an
1221 * implicit precompiled header will be built containing all of the
1222 * initial includes at the top of the main file (what we refer to as
1223 * the "preamble" of the file). In subsequent parses, if the
1224 * preamble or the files in it have not changed, \c
1225 * clang_reparseTranslationUnit() will re-use the implicit
1226 * precompiled header to improve parsing performance.
1228 CXTranslationUnit_PrecompiledPreamble = 0x04,
1231 * \brief Used to indicate that the translation unit should cache some
1232 * code-completion results with each reparse of the source file.
1234 * Caching of code-completion results is a performance optimization that
1235 * introduces some overhead to reparsing but improves the performance of
1236 * code-completion operations.
1238 CXTranslationUnit_CacheCompletionResults = 0x08,
1241 * \brief Used to indicate that the translation unit will be serialized with
1242 * \c clang_saveTranslationUnit.
1244 * This option is typically used when parsing a header with the intent of
1245 * producing a precompiled header.
1247 CXTranslationUnit_ForSerialization = 0x10,
1250 * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1252 * Note: this is a *temporary* option that is available only while
1253 * we are testing C++ precompiled preamble support. It is deprecated.
1255 CXTranslationUnit_CXXChainedPCH = 0x20,
1258 * \brief Used to indicate that function/method bodies should be skipped while
1261 * This option can be used to search for declarations/definitions while
1262 * ignoring the usages.
1264 CXTranslationUnit_SkipFunctionBodies = 0x40,
1267 * \brief Used to indicate that brief documentation comments should be
1268 * included into the set of code completions returned from this translation
1271 CXTranslationUnit_IncludeBriefCommentsInCodeCompletion = 0x80,
1274 * \brief Used to indicate that the precompiled preamble should be created on
1275 * the first parse. Otherwise it will be created on the first reparse. This
1276 * trades runtime on the first parse (serializing the preamble takes time) for
1277 * reduced runtime on the second parse (can now reuse the preamble).
1279 CXTranslationUnit_CreatePreambleOnFirstParse = 0x100,
1282 * \brief Do not stop processing when fatal errors are encountered.
1284 * When fatal errors are encountered while parsing a translation unit,
1285 * semantic analysis is typically stopped early when compiling code. A common
1286 * source for fatal errors are unresolvable include files. For the
1287 * purposes of an IDE, this is undesirable behavior and as much information
1288 * as possible should be reported. Use this flag to enable this behavior.
1290 CXTranslationUnit_KeepGoing = 0x200,
1293 * \brief Sets the preprocessor in a mode for parsing a single file only.
1295 CXTranslationUnit_SingleFileParse = 0x400
1299 * \brief Returns the set of flags that is suitable for parsing a translation
1300 * unit that is being edited.
1302 * The set of flags returned provide options for \c clang_parseTranslationUnit()
1303 * to indicate that the translation unit is likely to be reparsed many times,
1304 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1305 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1306 * set contains an unspecified set of optimizations (e.g., the precompiled
1307 * preamble) geared toward improving the performance of these routines. The
1308 * set of optimizations enabled may change from one version to the next.
1310 CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
1313 * \brief Same as \c clang_parseTranslationUnit2, but returns
1314 * the \c CXTranslationUnit instead of an error code. In case of an error this
1315 * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1318 CINDEX_LINKAGE CXTranslationUnit
1319 clang_parseTranslationUnit(CXIndex CIdx,
1320 const char *source_filename,
1321 const char *const *command_line_args,
1322 int num_command_line_args,
1323 struct CXUnsavedFile *unsaved_files,
1324 unsigned num_unsaved_files,
1328 * \brief Parse the given source file and the translation unit corresponding
1331 * This routine is the main entry point for the Clang C API, providing the
1332 * ability to parse a source file into a translation unit that can then be
1333 * queried by other functions in the API. This routine accepts a set of
1334 * command-line arguments so that the compilation can be configured in the same
1335 * way that the compiler is configured on the command line.
1337 * \param CIdx The index object with which the translation unit will be
1340 * \param source_filename The name of the source file to load, or NULL if the
1341 * source file is included in \c command_line_args.
1343 * \param command_line_args The command-line arguments that would be
1344 * passed to the \c clang executable if it were being invoked out-of-process.
1345 * These command-line options will be parsed and will affect how the translation
1346 * unit is parsed. Note that the following options are ignored: '-c',
1347 * '-emit-ast', '-fsyntax-only' (which is the default), and '-o \<output file>'.
1349 * \param num_command_line_args The number of command-line arguments in
1350 * \c command_line_args.
1352 * \param unsaved_files the files that have not yet been saved to disk
1353 * but may be required for parsing, including the contents of
1354 * those files. The contents and name of these files (as specified by
1355 * CXUnsavedFile) are copied when necessary, so the client only needs to
1356 * guarantee their validity until the call to this function returns.
1358 * \param num_unsaved_files the number of unsaved file entries in \p
1361 * \param options A bitmask of options that affects how the translation unit
1362 * is managed but not its compilation. This should be a bitwise OR of the
1363 * CXTranslationUnit_XXX flags.
1365 * \param[out] out_TU A non-NULL pointer to store the created
1366 * \c CXTranslationUnit, describing the parsed code and containing any
1367 * diagnostics produced by the compiler.
1369 * \returns Zero on success, otherwise returns an error code.
1371 CINDEX_LINKAGE enum CXErrorCode
1372 clang_parseTranslationUnit2(CXIndex CIdx,
1373 const char *source_filename,
1374 const char *const *command_line_args,
1375 int num_command_line_args,
1376 struct CXUnsavedFile *unsaved_files,
1377 unsigned num_unsaved_files,
1379 CXTranslationUnit *out_TU);
1382 * \brief Same as clang_parseTranslationUnit2 but requires a full command line
1383 * for \c command_line_args including argv[0]. This is useful if the standard
1384 * library paths are relative to the binary.
1386 CINDEX_LINKAGE enum CXErrorCode clang_parseTranslationUnit2FullArgv(
1387 CXIndex CIdx, const char *source_filename,
1388 const char *const *command_line_args, int num_command_line_args,
1389 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
1390 unsigned options, CXTranslationUnit *out_TU);
1393 * \brief Flags that control how translation units are saved.
1395 * The enumerators in this enumeration type are meant to be bitwise
1396 * ORed together to specify which options should be used when
1397 * saving the translation unit.
1399 enum CXSaveTranslationUnit_Flags {
1401 * \brief Used to indicate that no special saving options are needed.
1403 CXSaveTranslationUnit_None = 0x0
1407 * \brief Returns the set of flags that is suitable for saving a translation
1410 * The set of flags returned provide options for
1411 * \c clang_saveTranslationUnit() by default. The returned flag
1412 * set contains an unspecified set of options that save translation units with
1413 * the most commonly-requested data.
1415 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1418 * \brief Describes the kind of error that occurred (if any) in a call to
1419 * \c clang_saveTranslationUnit().
1423 * \brief Indicates that no error occurred while saving a translation unit.
1425 CXSaveError_None = 0,
1428 * \brief Indicates that an unknown error occurred while attempting to save
1431 * This error typically indicates that file I/O failed when attempting to
1434 CXSaveError_Unknown = 1,
1437 * \brief Indicates that errors during translation prevented this attempt
1438 * to save the translation unit.
1440 * Errors that prevent the translation unit from being saved can be
1441 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1443 CXSaveError_TranslationErrors = 2,
1446 * \brief Indicates that the translation unit to be saved was somehow
1447 * invalid (e.g., NULL).
1449 CXSaveError_InvalidTU = 3
1453 * \brief Saves a translation unit into a serialized representation of
1454 * that translation unit on disk.
1456 * Any translation unit that was parsed without error can be saved
1457 * into a file. The translation unit can then be deserialized into a
1458 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1459 * if it is an incomplete translation unit that corresponds to a
1460 * header, used as a precompiled header when parsing other translation
1463 * \param TU The translation unit to save.
1465 * \param FileName The file to which the translation unit will be saved.
1467 * \param options A bitmask of options that affects how the translation unit
1468 * is saved. This should be a bitwise OR of the
1469 * CXSaveTranslationUnit_XXX flags.
1471 * \returns A value that will match one of the enumerators of the CXSaveError
1472 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1473 * saved successfully, while a non-zero value indicates that a problem occurred.
1475 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1476 const char *FileName,
1480 * \brief Suspend a translation unit in order to free memory associated with it.
1482 * A suspended translation unit uses significantly less memory but on the other
1483 * side does not support any other calls than \c clang_reparseTranslationUnit
1484 * to resume it or \c clang_disposeTranslationUnit to dispose it completely.
1486 CINDEX_LINKAGE unsigned clang_suspendTranslationUnit(CXTranslationUnit);
1489 * \brief Destroy the specified CXTranslationUnit object.
1491 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1494 * \brief Flags that control the reparsing of translation units.
1496 * The enumerators in this enumeration type are meant to be bitwise
1497 * ORed together to specify which options should be used when
1498 * reparsing the translation unit.
1500 enum CXReparse_Flags {
1502 * \brief Used to indicate that no special reparsing options are needed.
1504 CXReparse_None = 0x0
1508 * \brief Returns the set of flags that is suitable for reparsing a translation
1511 * The set of flags returned provide options for
1512 * \c clang_reparseTranslationUnit() by default. The returned flag
1513 * set contains an unspecified set of optimizations geared toward common uses
1514 * of reparsing. The set of optimizations enabled may change from one version
1517 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1520 * \brief Reparse the source files that produced this translation unit.
1522 * This routine can be used to re-parse the source files that originally
1523 * created the given translation unit, for example because those source files
1524 * have changed (either on disk or as passed via \p unsaved_files). The
1525 * source code will be reparsed with the same command-line options as it
1526 * was originally parsed.
1528 * Reparsing a translation unit invalidates all cursors and source locations
1529 * that refer into that translation unit. This makes reparsing a translation
1530 * unit semantically equivalent to destroying the translation unit and then
1531 * creating a new translation unit with the same command-line arguments.
1532 * However, it may be more efficient to reparse a translation
1533 * unit using this routine.
1535 * \param TU The translation unit whose contents will be re-parsed. The
1536 * translation unit must originally have been built with
1537 * \c clang_createTranslationUnitFromSourceFile().
1539 * \param num_unsaved_files The number of unsaved file entries in \p
1542 * \param unsaved_files The files that have not yet been saved to disk
1543 * but may be required for parsing, including the contents of
1544 * those files. The contents and name of these files (as specified by
1545 * CXUnsavedFile) are copied when necessary, so the client only needs to
1546 * guarantee their validity until the call to this function returns.
1548 * \param options A bitset of options composed of the flags in CXReparse_Flags.
1549 * The function \c clang_defaultReparseOptions() produces a default set of
1550 * options recommended for most uses, based on the translation unit.
1552 * \returns 0 if the sources could be reparsed. A non-zero error code will be
1553 * returned if reparsing was impossible, such that the translation unit is
1554 * invalid. In such cases, the only valid call for \c TU is
1555 * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1556 * routine are described by the \c CXErrorCode enum.
1558 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1559 unsigned num_unsaved_files,
1560 struct CXUnsavedFile *unsaved_files,
1564 * \brief Categorizes how memory is being used by a translation unit.
1566 enum CXTUResourceUsageKind {
1567 CXTUResourceUsage_AST = 1,
1568 CXTUResourceUsage_Identifiers = 2,
1569 CXTUResourceUsage_Selectors = 3,
1570 CXTUResourceUsage_GlobalCompletionResults = 4,
1571 CXTUResourceUsage_SourceManagerContentCache = 5,
1572 CXTUResourceUsage_AST_SideTables = 6,
1573 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
1574 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
1575 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
1576 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
1577 CXTUResourceUsage_Preprocessor = 11,
1578 CXTUResourceUsage_PreprocessingRecord = 12,
1579 CXTUResourceUsage_SourceManager_DataStructures = 13,
1580 CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
1581 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
1582 CXTUResourceUsage_MEMORY_IN_BYTES_END =
1583 CXTUResourceUsage_Preprocessor_HeaderSearch,
1585 CXTUResourceUsage_First = CXTUResourceUsage_AST,
1586 CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
1590 * \brief Returns the human-readable null-terminated C string that represents
1591 * the name of the memory category. This string should never be freed.
1594 const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
1596 typedef struct CXTUResourceUsageEntry {
1597 /* \brief The memory usage category. */
1598 enum CXTUResourceUsageKind kind;
1599 /* \brief Amount of resources used.
1600 The units will depend on the resource kind. */
1601 unsigned long amount;
1602 } CXTUResourceUsageEntry;
1605 * \brief The memory usage of a CXTranslationUnit, broken into categories.
1607 typedef struct CXTUResourceUsage {
1608 /* \brief Private data member, used for queries. */
1611 /* \brief The number of entries in the 'entries' array. */
1612 unsigned numEntries;
1614 /* \brief An array of key-value pairs, representing the breakdown of memory
1616 CXTUResourceUsageEntry *entries;
1618 } CXTUResourceUsage;
1621 * \brief Return the memory usage of a translation unit. This object
1622 * should be released with clang_disposeCXTUResourceUsage().
1624 CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
1626 CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
1629 * \brief Get target information for this translation unit.
1631 * The CXTargetInfo object cannot outlive the CXTranslationUnit object.
1633 CINDEX_LINKAGE CXTargetInfo
1634 clang_getTranslationUnitTargetInfo(CXTranslationUnit CTUnit);
1637 * \brief Destroy the CXTargetInfo object.
1640 clang_TargetInfo_dispose(CXTargetInfo Info);
1643 * \brief Get the normalized target triple as a string.
1645 * Returns the empty string in case of any error.
1647 CINDEX_LINKAGE CXString
1648 clang_TargetInfo_getTriple(CXTargetInfo Info);
1651 * \brief Get the pointer width of the target in bits.
1653 * Returns -1 in case of error.
1656 clang_TargetInfo_getPointerWidth(CXTargetInfo Info);
1663 * \brief Describes the kind of entity that a cursor refers to.
1668 * \brief A declaration whose specific kind is not exposed via this
1671 * Unexposed declarations have the same operations as any other kind
1672 * of declaration; one can extract their location information,
1673 * spelling, find their definitions, etc. However, the specific kind
1674 * of the declaration is not reported.
1676 CXCursor_UnexposedDecl = 1,
1677 /** \brief A C or C++ struct. */
1678 CXCursor_StructDecl = 2,
1679 /** \brief A C or C++ union. */
1680 CXCursor_UnionDecl = 3,
1681 /** \brief A C++ class. */
1682 CXCursor_ClassDecl = 4,
1683 /** \brief An enumeration. */
1684 CXCursor_EnumDecl = 5,
1686 * \brief A field (in C) or non-static data member (in C++) in a
1687 * struct, union, or C++ class.
1689 CXCursor_FieldDecl = 6,
1690 /** \brief An enumerator constant. */
1691 CXCursor_EnumConstantDecl = 7,
1692 /** \brief A function. */
1693 CXCursor_FunctionDecl = 8,
1694 /** \brief A variable. */
1695 CXCursor_VarDecl = 9,
1696 /** \brief A function or method parameter. */
1697 CXCursor_ParmDecl = 10,
1698 /** \brief An Objective-C \@interface. */
1699 CXCursor_ObjCInterfaceDecl = 11,
1700 /** \brief An Objective-C \@interface for a category. */
1701 CXCursor_ObjCCategoryDecl = 12,
1702 /** \brief An Objective-C \@protocol declaration. */
1703 CXCursor_ObjCProtocolDecl = 13,
1704 /** \brief An Objective-C \@property declaration. */
1705 CXCursor_ObjCPropertyDecl = 14,
1706 /** \brief An Objective-C instance variable. */
1707 CXCursor_ObjCIvarDecl = 15,
1708 /** \brief An Objective-C instance method. */
1709 CXCursor_ObjCInstanceMethodDecl = 16,
1710 /** \brief An Objective-C class method. */
1711 CXCursor_ObjCClassMethodDecl = 17,
1712 /** \brief An Objective-C \@implementation. */
1713 CXCursor_ObjCImplementationDecl = 18,
1714 /** \brief An Objective-C \@implementation for a category. */
1715 CXCursor_ObjCCategoryImplDecl = 19,
1716 /** \brief A typedef. */
1717 CXCursor_TypedefDecl = 20,
1718 /** \brief A C++ class method. */
1719 CXCursor_CXXMethod = 21,
1720 /** \brief A C++ namespace. */
1721 CXCursor_Namespace = 22,
1722 /** \brief A linkage specification, e.g. 'extern "C"'. */
1723 CXCursor_LinkageSpec = 23,
1724 /** \brief A C++ constructor. */
1725 CXCursor_Constructor = 24,
1726 /** \brief A C++ destructor. */
1727 CXCursor_Destructor = 25,
1728 /** \brief A C++ conversion function. */
1729 CXCursor_ConversionFunction = 26,
1730 /** \brief A C++ template type parameter. */
1731 CXCursor_TemplateTypeParameter = 27,
1732 /** \brief A C++ non-type template parameter. */
1733 CXCursor_NonTypeTemplateParameter = 28,
1734 /** \brief A C++ template template parameter. */
1735 CXCursor_TemplateTemplateParameter = 29,
1736 /** \brief A C++ function template. */
1737 CXCursor_FunctionTemplate = 30,
1738 /** \brief A C++ class template. */
1739 CXCursor_ClassTemplate = 31,
1740 /** \brief A C++ class template partial specialization. */
1741 CXCursor_ClassTemplatePartialSpecialization = 32,
1742 /** \brief A C++ namespace alias declaration. */
1743 CXCursor_NamespaceAlias = 33,
1744 /** \brief A C++ using directive. */
1745 CXCursor_UsingDirective = 34,
1746 /** \brief A C++ using declaration. */
1747 CXCursor_UsingDeclaration = 35,
1748 /** \brief A C++ alias declaration */
1749 CXCursor_TypeAliasDecl = 36,
1750 /** \brief An Objective-C \@synthesize definition. */
1751 CXCursor_ObjCSynthesizeDecl = 37,
1752 /** \brief An Objective-C \@dynamic definition. */
1753 CXCursor_ObjCDynamicDecl = 38,
1754 /** \brief An access specifier. */
1755 CXCursor_CXXAccessSpecifier = 39,
1757 CXCursor_FirstDecl = CXCursor_UnexposedDecl,
1758 CXCursor_LastDecl = CXCursor_CXXAccessSpecifier,
1761 CXCursor_FirstRef = 40, /* Decl references */
1762 CXCursor_ObjCSuperClassRef = 40,
1763 CXCursor_ObjCProtocolRef = 41,
1764 CXCursor_ObjCClassRef = 42,
1766 * \brief A reference to a type declaration.
1768 * A type reference occurs anywhere where a type is named but not
1769 * declared. For example, given:
1772 * typedef unsigned size_type;
1776 * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1777 * while the type of the variable "size" is referenced. The cursor
1778 * referenced by the type of size is the typedef for size_type.
1780 CXCursor_TypeRef = 43,
1781 CXCursor_CXXBaseSpecifier = 44,
1783 * \brief A reference to a class template, function template, template
1784 * template parameter, or class template partial specialization.
1786 CXCursor_TemplateRef = 45,
1788 * \brief A reference to a namespace or namespace alias.
1790 CXCursor_NamespaceRef = 46,
1792 * \brief A reference to a member of a struct, union, or class that occurs in
1793 * some non-expression context, e.g., a designated initializer.
1795 CXCursor_MemberRef = 47,
1797 * \brief A reference to a labeled statement.
1799 * This cursor kind is used to describe the jump to "start_over" in the
1800 * goto statement in the following example:
1809 * A label reference cursor refers to a label statement.
1811 CXCursor_LabelRef = 48,
1814 * \brief A reference to a set of overloaded functions or function templates
1815 * that has not yet been resolved to a specific function or function template.
1817 * An overloaded declaration reference cursor occurs in C++ templates where
1818 * a dependent name refers to a function. For example:
1821 * template<typename T> void swap(T&, T&);
1824 * void swap(X&, X&);
1826 * template<typename T>
1827 * void reverse(T* first, T* last) {
1828 * while (first < last - 1) {
1829 * swap(*first, *--last);
1835 * void swap(Y&, Y&);
1838 * Here, the identifier "swap" is associated with an overloaded declaration
1839 * reference. In the template definition, "swap" refers to either of the two
1840 * "swap" functions declared above, so both results will be available. At
1841 * instantiation time, "swap" may also refer to other functions found via
1842 * argument-dependent lookup (e.g., the "swap" function at the end of the
1845 * The functions \c clang_getNumOverloadedDecls() and
1846 * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1847 * referenced by this cursor.
1849 CXCursor_OverloadedDeclRef = 49,
1852 * \brief A reference to a variable that occurs in some non-expression
1853 * context, e.g., a C++ lambda capture list.
1855 CXCursor_VariableRef = 50,
1857 CXCursor_LastRef = CXCursor_VariableRef,
1859 /* Error conditions */
1860 CXCursor_FirstInvalid = 70,
1861 CXCursor_InvalidFile = 70,
1862 CXCursor_NoDeclFound = 71,
1863 CXCursor_NotImplemented = 72,
1864 CXCursor_InvalidCode = 73,
1865 CXCursor_LastInvalid = CXCursor_InvalidCode,
1868 CXCursor_FirstExpr = 100,
1871 * \brief An expression whose specific kind is not exposed via this
1874 * Unexposed expressions have the same operations as any other kind
1875 * of expression; one can extract their location information,
1876 * spelling, children, etc. However, the specific kind of the
1877 * expression is not reported.
1879 CXCursor_UnexposedExpr = 100,
1882 * \brief An expression that refers to some value declaration, such
1883 * as a function, variable, or enumerator.
1885 CXCursor_DeclRefExpr = 101,
1888 * \brief An expression that refers to a member of a struct, union,
1889 * class, Objective-C class, etc.
1891 CXCursor_MemberRefExpr = 102,
1893 /** \brief An expression that calls a function. */
1894 CXCursor_CallExpr = 103,
1896 /** \brief An expression that sends a message to an Objective-C
1898 CXCursor_ObjCMessageExpr = 104,
1900 /** \brief An expression that represents a block literal. */
1901 CXCursor_BlockExpr = 105,
1903 /** \brief An integer literal.
1905 CXCursor_IntegerLiteral = 106,
1907 /** \brief A floating point number literal.
1909 CXCursor_FloatingLiteral = 107,
1911 /** \brief An imaginary number literal.
1913 CXCursor_ImaginaryLiteral = 108,
1915 /** \brief A string literal.
1917 CXCursor_StringLiteral = 109,
1919 /** \brief A character literal.
1921 CXCursor_CharacterLiteral = 110,
1923 /** \brief A parenthesized expression, e.g. "(1)".
1925 * This AST node is only formed if full location information is requested.
1927 CXCursor_ParenExpr = 111,
1929 /** \brief This represents the unary-expression's (except sizeof and
1932 CXCursor_UnaryOperator = 112,
1934 /** \brief [C99 6.5.2.1] Array Subscripting.
1936 CXCursor_ArraySubscriptExpr = 113,
1938 /** \brief A builtin binary operation expression such as "x + y" or
1941 CXCursor_BinaryOperator = 114,
1943 /** \brief Compound assignment such as "+=".
1945 CXCursor_CompoundAssignOperator = 115,
1947 /** \brief The ?: ternary operator.
1949 CXCursor_ConditionalOperator = 116,
1951 /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1952 * (C++ [expr.cast]), which uses the syntax (Type)expr.
1954 * For example: (int)f.
1956 CXCursor_CStyleCastExpr = 117,
1958 /** \brief [C99 6.5.2.5]
1960 CXCursor_CompoundLiteralExpr = 118,
1962 /** \brief Describes an C or C++ initializer list.
1964 CXCursor_InitListExpr = 119,
1966 /** \brief The GNU address of label extension, representing &&label.
1968 CXCursor_AddrLabelExpr = 120,
1970 /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1972 CXCursor_StmtExpr = 121,
1974 /** \brief Represents a C11 generic selection.
1976 CXCursor_GenericSelectionExpr = 122,
1978 /** \brief Implements the GNU __null extension, which is a name for a null
1979 * pointer constant that has integral type (e.g., int or long) and is the same
1980 * size and alignment as a pointer.
1982 * The __null extension is typically only used by system headers, which define
1983 * NULL as __null in C++ rather than using 0 (which is an integer that may not
1984 * match the size of a pointer).
1986 CXCursor_GNUNullExpr = 123,
1988 /** \brief C++'s static_cast<> expression.
1990 CXCursor_CXXStaticCastExpr = 124,
1992 /** \brief C++'s dynamic_cast<> expression.
1994 CXCursor_CXXDynamicCastExpr = 125,
1996 /** \brief C++'s reinterpret_cast<> expression.
1998 CXCursor_CXXReinterpretCastExpr = 126,
2000 /** \brief C++'s const_cast<> expression.
2002 CXCursor_CXXConstCastExpr = 127,
2004 /** \brief Represents an explicit C++ type conversion that uses "functional"
2005 * notion (C++ [expr.type.conv]).
2012 CXCursor_CXXFunctionalCastExpr = 128,
2014 /** \brief A C++ typeid expression (C++ [expr.typeid]).
2016 CXCursor_CXXTypeidExpr = 129,
2018 /** \brief [C++ 2.13.5] C++ Boolean Literal.
2020 CXCursor_CXXBoolLiteralExpr = 130,
2022 /** \brief [C++0x 2.14.7] C++ Pointer Literal.
2024 CXCursor_CXXNullPtrLiteralExpr = 131,
2026 /** \brief Represents the "this" expression in C++
2028 CXCursor_CXXThisExpr = 132,
2030 /** \brief [C++ 15] C++ Throw Expression.
2032 * This handles 'throw' and 'throw' assignment-expression. When
2033 * assignment-expression isn't present, Op will be null.
2035 CXCursor_CXXThrowExpr = 133,
2037 /** \brief A new expression for memory allocation and constructor calls, e.g:
2038 * "new CXXNewExpr(foo)".
2040 CXCursor_CXXNewExpr = 134,
2042 /** \brief A delete expression for memory deallocation and destructor calls,
2043 * e.g. "delete[] pArray".
2045 CXCursor_CXXDeleteExpr = 135,
2047 /** \brief A unary expression. (noexcept, sizeof, or other traits)
2049 CXCursor_UnaryExpr = 136,
2051 /** \brief An Objective-C string literal i.e. @"foo".
2053 CXCursor_ObjCStringLiteral = 137,
2055 /** \brief An Objective-C \@encode expression.
2057 CXCursor_ObjCEncodeExpr = 138,
2059 /** \brief An Objective-C \@selector expression.
2061 CXCursor_ObjCSelectorExpr = 139,
2063 /** \brief An Objective-C \@protocol expression.
2065 CXCursor_ObjCProtocolExpr = 140,
2067 /** \brief An Objective-C "bridged" cast expression, which casts between
2068 * Objective-C pointers and C pointers, transferring ownership in the process.
2071 * NSString *str = (__bridge_transfer NSString *)CFCreateString();
2074 CXCursor_ObjCBridgedCastExpr = 141,
2076 /** \brief Represents a C++0x pack expansion that produces a sequence of
2079 * A pack expansion expression contains a pattern (which itself is an
2080 * expression) followed by an ellipsis. For example:
2083 * template<typename F, typename ...Types>
2084 * void forward(F f, Types &&...args) {
2085 * f(static_cast<Types&&>(args)...);
2089 CXCursor_PackExpansionExpr = 142,
2091 /** \brief Represents an expression that computes the length of a parameter
2095 * template<typename ...Types>
2097 * static const unsigned value = sizeof...(Types);
2101 CXCursor_SizeOfPackExpr = 143,
2103 /* \brief Represents a C++ lambda expression that produces a local function
2107 * void abssort(float *x, unsigned N) {
2108 * std::sort(x, x + N,
2109 * [](float a, float b) {
2110 * return std::abs(a) < std::abs(b);
2115 CXCursor_LambdaExpr = 144,
2117 /** \brief Objective-c Boolean Literal.
2119 CXCursor_ObjCBoolLiteralExpr = 145,
2121 /** \brief Represents the "self" expression in an Objective-C method.
2123 CXCursor_ObjCSelfExpr = 146,
2125 /** \brief OpenMP 4.0 [2.4, Array Section].
2127 CXCursor_OMPArraySectionExpr = 147,
2129 /** \brief Represents an @available(...) check.
2131 CXCursor_ObjCAvailabilityCheckExpr = 148,
2133 CXCursor_LastExpr = CXCursor_ObjCAvailabilityCheckExpr,
2136 CXCursor_FirstStmt = 200,
2138 * \brief A statement whose specific kind is not exposed via this
2141 * Unexposed statements have the same operations as any other kind of
2142 * statement; one can extract their location information, spelling,
2143 * children, etc. However, the specific kind of the statement is not
2146 CXCursor_UnexposedStmt = 200,
2148 /** \brief A labelled statement in a function.
2150 * This cursor kind is used to describe the "start_over:" label statement in
2151 * the following example:
2159 CXCursor_LabelStmt = 201,
2161 /** \brief A group of statements like { stmt stmt }.
2163 * This cursor kind is used to describe compound statements, e.g. function
2166 CXCursor_CompoundStmt = 202,
2168 /** \brief A case statement.
2170 CXCursor_CaseStmt = 203,
2172 /** \brief A default statement.
2174 CXCursor_DefaultStmt = 204,
2176 /** \brief An if statement
2178 CXCursor_IfStmt = 205,
2180 /** \brief A switch statement.
2182 CXCursor_SwitchStmt = 206,
2184 /** \brief A while statement.
2186 CXCursor_WhileStmt = 207,
2188 /** \brief A do statement.
2190 CXCursor_DoStmt = 208,
2192 /** \brief A for statement.
2194 CXCursor_ForStmt = 209,
2196 /** \brief A goto statement.
2198 CXCursor_GotoStmt = 210,
2200 /** \brief An indirect goto statement.
2202 CXCursor_IndirectGotoStmt = 211,
2204 /** \brief A continue statement.
2206 CXCursor_ContinueStmt = 212,
2208 /** \brief A break statement.
2210 CXCursor_BreakStmt = 213,
2212 /** \brief A return statement.
2214 CXCursor_ReturnStmt = 214,
2216 /** \brief A GCC inline assembly statement extension.
2218 CXCursor_GCCAsmStmt = 215,
2219 CXCursor_AsmStmt = CXCursor_GCCAsmStmt,
2221 /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2223 CXCursor_ObjCAtTryStmt = 216,
2225 /** \brief Objective-C's \@catch statement.
2227 CXCursor_ObjCAtCatchStmt = 217,
2229 /** \brief Objective-C's \@finally statement.
2231 CXCursor_ObjCAtFinallyStmt = 218,
2233 /** \brief Objective-C's \@throw statement.
2235 CXCursor_ObjCAtThrowStmt = 219,
2237 /** \brief Objective-C's \@synchronized statement.
2239 CXCursor_ObjCAtSynchronizedStmt = 220,
2241 /** \brief Objective-C's autorelease pool statement.
2243 CXCursor_ObjCAutoreleasePoolStmt = 221,
2245 /** \brief Objective-C's collection statement.
2247 CXCursor_ObjCForCollectionStmt = 222,
2249 /** \brief C++'s catch statement.
2251 CXCursor_CXXCatchStmt = 223,
2253 /** \brief C++'s try statement.
2255 CXCursor_CXXTryStmt = 224,
2257 /** \brief C++'s for (* : *) statement.
2259 CXCursor_CXXForRangeStmt = 225,
2261 /** \brief Windows Structured Exception Handling's try statement.
2263 CXCursor_SEHTryStmt = 226,
2265 /** \brief Windows Structured Exception Handling's except statement.
2267 CXCursor_SEHExceptStmt = 227,
2269 /** \brief Windows Structured Exception Handling's finally statement.
2271 CXCursor_SEHFinallyStmt = 228,
2273 /** \brief A MS inline assembly statement extension.
2275 CXCursor_MSAsmStmt = 229,
2277 /** \brief The null statement ";": C99 6.8.3p3.
2279 * This cursor kind is used to describe the null statement.
2281 CXCursor_NullStmt = 230,
2283 /** \brief Adaptor class for mixing declarations with statements and
2286 CXCursor_DeclStmt = 231,
2288 /** \brief OpenMP parallel directive.
2290 CXCursor_OMPParallelDirective = 232,
2292 /** \brief OpenMP SIMD directive.
2294 CXCursor_OMPSimdDirective = 233,
2296 /** \brief OpenMP for directive.
2298 CXCursor_OMPForDirective = 234,
2300 /** \brief OpenMP sections directive.
2302 CXCursor_OMPSectionsDirective = 235,
2304 /** \brief OpenMP section directive.
2306 CXCursor_OMPSectionDirective = 236,
2308 /** \brief OpenMP single directive.
2310 CXCursor_OMPSingleDirective = 237,
2312 /** \brief OpenMP parallel for directive.
2314 CXCursor_OMPParallelForDirective = 238,
2316 /** \brief OpenMP parallel sections directive.
2318 CXCursor_OMPParallelSectionsDirective = 239,
2320 /** \brief OpenMP task directive.
2322 CXCursor_OMPTaskDirective = 240,
2324 /** \brief OpenMP master directive.
2326 CXCursor_OMPMasterDirective = 241,
2328 /** \brief OpenMP critical directive.
2330 CXCursor_OMPCriticalDirective = 242,
2332 /** \brief OpenMP taskyield directive.
2334 CXCursor_OMPTaskyieldDirective = 243,
2336 /** \brief OpenMP barrier directive.
2338 CXCursor_OMPBarrierDirective = 244,
2340 /** \brief OpenMP taskwait directive.
2342 CXCursor_OMPTaskwaitDirective = 245,
2344 /** \brief OpenMP flush directive.
2346 CXCursor_OMPFlushDirective = 246,
2348 /** \brief Windows Structured Exception Handling's leave statement.
2350 CXCursor_SEHLeaveStmt = 247,
2352 /** \brief OpenMP ordered directive.
2354 CXCursor_OMPOrderedDirective = 248,
2356 /** \brief OpenMP atomic directive.
2358 CXCursor_OMPAtomicDirective = 249,
2360 /** \brief OpenMP for SIMD directive.
2362 CXCursor_OMPForSimdDirective = 250,
2364 /** \brief OpenMP parallel for SIMD directive.
2366 CXCursor_OMPParallelForSimdDirective = 251,
2368 /** \brief OpenMP target directive.
2370 CXCursor_OMPTargetDirective = 252,
2372 /** \brief OpenMP teams directive.
2374 CXCursor_OMPTeamsDirective = 253,
2376 /** \brief OpenMP taskgroup directive.
2378 CXCursor_OMPTaskgroupDirective = 254,
2380 /** \brief OpenMP cancellation point directive.
2382 CXCursor_OMPCancellationPointDirective = 255,
2384 /** \brief OpenMP cancel directive.
2386 CXCursor_OMPCancelDirective = 256,
2388 /** \brief OpenMP target data directive.
2390 CXCursor_OMPTargetDataDirective = 257,
2392 /** \brief OpenMP taskloop directive.
2394 CXCursor_OMPTaskLoopDirective = 258,
2396 /** \brief OpenMP taskloop simd directive.
2398 CXCursor_OMPTaskLoopSimdDirective = 259,
2400 /** \brief OpenMP distribute directive.
2402 CXCursor_OMPDistributeDirective = 260,
2404 /** \brief OpenMP target enter data directive.
2406 CXCursor_OMPTargetEnterDataDirective = 261,
2408 /** \brief OpenMP target exit data directive.
2410 CXCursor_OMPTargetExitDataDirective = 262,
2412 /** \brief OpenMP target parallel directive.
2414 CXCursor_OMPTargetParallelDirective = 263,
2416 /** \brief OpenMP target parallel for directive.
2418 CXCursor_OMPTargetParallelForDirective = 264,
2420 /** \brief OpenMP target update directive.
2422 CXCursor_OMPTargetUpdateDirective = 265,
2424 /** \brief OpenMP distribute parallel for directive.
2426 CXCursor_OMPDistributeParallelForDirective = 266,
2428 /** \brief OpenMP distribute parallel for simd directive.
2430 CXCursor_OMPDistributeParallelForSimdDirective = 267,
2432 /** \brief OpenMP distribute simd directive.
2434 CXCursor_OMPDistributeSimdDirective = 268,
2436 /** \brief OpenMP target parallel for simd directive.
2438 CXCursor_OMPTargetParallelForSimdDirective = 269,
2440 /** \brief OpenMP target simd directive.
2442 CXCursor_OMPTargetSimdDirective = 270,
2444 /** \brief OpenMP teams distribute directive.
2446 CXCursor_OMPTeamsDistributeDirective = 271,
2448 /** \brief OpenMP teams distribute simd directive.
2450 CXCursor_OMPTeamsDistributeSimdDirective = 272,
2452 /** \brief OpenMP teams distribute parallel for simd directive.
2454 CXCursor_OMPTeamsDistributeParallelForSimdDirective = 273,
2456 /** \brief OpenMP teams distribute parallel for directive.
2458 CXCursor_OMPTeamsDistributeParallelForDirective = 274,
2460 /** \brief OpenMP target teams directive.
2462 CXCursor_OMPTargetTeamsDirective = 275,
2464 /** \brief OpenMP target teams distribute directive.
2466 CXCursor_OMPTargetTeamsDistributeDirective = 276,
2468 /** \brief OpenMP target teams distribute parallel for directive.
2470 CXCursor_OMPTargetTeamsDistributeParallelForDirective = 277,
2472 /** \brief OpenMP target teams distribute parallel for simd directive.
2474 CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective = 278,
2476 /** \brief OpenMP target teams distribute simd directive.
2478 CXCursor_OMPTargetTeamsDistributeSimdDirective = 279,
2480 CXCursor_LastStmt = CXCursor_OMPTargetTeamsDistributeSimdDirective,
2483 * \brief Cursor that represents the translation unit itself.
2485 * The translation unit cursor exists primarily to act as the root
2486 * cursor for traversing the contents of a translation unit.
2488 CXCursor_TranslationUnit = 300,
2491 CXCursor_FirstAttr = 400,
2493 * \brief An attribute whose specific kind is not exposed via this
2496 CXCursor_UnexposedAttr = 400,
2498 CXCursor_IBActionAttr = 401,
2499 CXCursor_IBOutletAttr = 402,
2500 CXCursor_IBOutletCollectionAttr = 403,
2501 CXCursor_CXXFinalAttr = 404,
2502 CXCursor_CXXOverrideAttr = 405,
2503 CXCursor_AnnotateAttr = 406,
2504 CXCursor_AsmLabelAttr = 407,
2505 CXCursor_PackedAttr = 408,
2506 CXCursor_PureAttr = 409,
2507 CXCursor_ConstAttr = 410,
2508 CXCursor_NoDuplicateAttr = 411,
2509 CXCursor_CUDAConstantAttr = 412,
2510 CXCursor_CUDADeviceAttr = 413,
2511 CXCursor_CUDAGlobalAttr = 414,
2512 CXCursor_CUDAHostAttr = 415,
2513 CXCursor_CUDASharedAttr = 416,
2514 CXCursor_VisibilityAttr = 417,
2515 CXCursor_DLLExport = 418,
2516 CXCursor_DLLImport = 419,
2517 CXCursor_LastAttr = CXCursor_DLLImport,
2520 CXCursor_PreprocessingDirective = 500,
2521 CXCursor_MacroDefinition = 501,
2522 CXCursor_MacroExpansion = 502,
2523 CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
2524 CXCursor_InclusionDirective = 503,
2525 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
2526 CXCursor_LastPreprocessing = CXCursor_InclusionDirective,
2528 /* Extra Declarations */
2530 * \brief A module import declaration.
2532 CXCursor_ModuleImportDecl = 600,
2533 CXCursor_TypeAliasTemplateDecl = 601,
2535 * \brief A static_assert or _Static_assert node
2537 CXCursor_StaticAssert = 602,
2539 * \brief a friend declaration.
2541 CXCursor_FriendDecl = 603,
2542 CXCursor_FirstExtraDecl = CXCursor_ModuleImportDecl,
2543 CXCursor_LastExtraDecl = CXCursor_FriendDecl,
2546 * \brief A code completion overload candidate.
2548 CXCursor_OverloadCandidate = 700
2552 * \brief A cursor representing some element in the abstract syntax tree for
2553 * a translation unit.
2555 * The cursor abstraction unifies the different kinds of entities in a
2556 * program--declaration, statements, expressions, references to declarations,
2557 * etc.--under a single "cursor" abstraction with a common set of operations.
2558 * Common operation for a cursor include: getting the physical location in
2559 * a source file where the cursor points, getting the name associated with a
2560 * cursor, and retrieving cursors for any child nodes of a particular cursor.
2562 * Cursors can be produced in two specific ways.
2563 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2564 * from which one can use clang_visitChildren() to explore the rest of the
2565 * translation unit. clang_getCursor() maps from a physical source location
2566 * to the entity that resides at that location, allowing one to map from the
2567 * source code into the AST.
2570 enum CXCursorKind kind;
2572 const void *data[3];
2576 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2582 * \brief Retrieve the NULL cursor, which represents no entity.
2584 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
2587 * \brief Retrieve the cursor that represents the given translation unit.
2589 * The translation unit cursor can be used to start traversing the
2590 * various declarations within the given translation unit.
2592 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
2595 * \brief Determine whether two cursors are equivalent.
2597 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
2600 * \brief Returns non-zero if \p cursor is null.
2602 CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
2605 * \brief Compute a hash value for the given cursor.
2607 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
2610 * \brief Retrieve the kind of the given cursor.
2612 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
2615 * \brief Determine whether the given cursor kind represents a declaration.
2617 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
2620 * \brief Determine whether the given cursor kind represents a simple
2623 * Note that other kinds of cursors (such as expressions) can also refer to
2624 * other cursors. Use clang_getCursorReferenced() to determine whether a
2625 * particular cursor refers to another entity.
2627 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
2630 * \brief Determine whether the given cursor kind represents an expression.
2632 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
2635 * \brief Determine whether the given cursor kind represents a statement.
2637 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
2640 * \brief Determine whether the given cursor kind represents an attribute.
2642 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
2645 * \brief Determine whether the given cursor has any attributes.
2647 CINDEX_LINKAGE unsigned clang_Cursor_hasAttrs(CXCursor C);
2650 * \brief Determine whether the given cursor kind represents an invalid
2653 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
2656 * \brief Determine whether the given cursor kind represents a translation
2659 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
2662 * \brief Determine whether the given cursor represents a preprocessing
2663 * element, such as a preprocessor directive or macro instantiation.
2665 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
2668 * \brief Determine whether the given cursor represents a currently
2669 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2671 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
2674 * \brief Describe the linkage of the entity referred to by a cursor.
2676 enum CXLinkageKind {
2677 /** \brief This value indicates that no linkage information is available
2678 * for a provided CXCursor. */
2681 * \brief This is the linkage for variables, parameters, and so on that
2682 * have automatic storage. This covers normal (non-extern) local variables.
2684 CXLinkage_NoLinkage,
2685 /** \brief This is the linkage for static variables and static functions. */
2687 /** \brief This is the linkage for entities with external linkage that live
2688 * in C++ anonymous namespaces.*/
2689 CXLinkage_UniqueExternal,
2690 /** \brief This is the linkage for entities with true, external linkage. */
2695 * \brief Determine the linkage of the entity referred to by a given cursor.
2697 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
2699 enum CXVisibilityKind {
2700 /** \brief This value indicates that no visibility information is available
2701 * for a provided CXCursor. */
2702 CXVisibility_Invalid,
2704 /** \brief Symbol not seen by the linker. */
2705 CXVisibility_Hidden,
2706 /** \brief Symbol seen by the linker but resolves to a symbol inside this object. */
2707 CXVisibility_Protected,
2708 /** \brief Symbol seen by the linker and acts like a normal symbol. */
2709 CXVisibility_Default
2713 * \brief Describe the visibility of the entity referred to by a cursor.
2715 * This returns the default visibility if not explicitly specified by
2716 * a visibility attribute. The default visibility may be changed by
2717 * commandline arguments.
2719 * \param cursor The cursor to query.
2721 * \returns The visibility of the cursor.
2723 CINDEX_LINKAGE enum CXVisibilityKind clang_getCursorVisibility(CXCursor cursor);
2726 * \brief Determine the availability of the entity that this cursor refers to,
2727 * taking the current target platform into account.
2729 * \param cursor The cursor to query.
2731 * \returns The availability of the cursor.
2733 CINDEX_LINKAGE enum CXAvailabilityKind
2734 clang_getCursorAvailability(CXCursor cursor);
2737 * Describes the availability of a given entity on a particular platform, e.g.,
2738 * a particular class might only be available on Mac OS 10.7 or newer.
2740 typedef struct CXPlatformAvailability {
2742 * \brief A string that describes the platform for which this structure
2743 * provides availability information.
2745 * Possible values are "ios" or "macos".
2749 * \brief The version number in which this entity was introduced.
2751 CXVersion Introduced;
2753 * \brief The version number in which this entity was deprecated (but is
2756 CXVersion Deprecated;
2758 * \brief The version number in which this entity was obsoleted, and therefore
2759 * is no longer available.
2761 CXVersion Obsoleted;
2763 * \brief Whether the entity is unconditionally unavailable on this platform.
2767 * \brief An optional message to provide to a user of this API, e.g., to
2768 * suggest replacement APIs.
2771 } CXPlatformAvailability;
2774 * \brief Determine the availability of the entity that this cursor refers to
2775 * on any platforms for which availability information is known.
2777 * \param cursor The cursor to query.
2779 * \param always_deprecated If non-NULL, will be set to indicate whether the
2780 * entity is deprecated on all platforms.
2782 * \param deprecated_message If non-NULL, will be set to the message text
2783 * provided along with the unconditional deprecation of this entity. The client
2784 * is responsible for deallocating this string.
2786 * \param always_unavailable If non-NULL, will be set to indicate whether the
2787 * entity is unavailable on all platforms.
2789 * \param unavailable_message If non-NULL, will be set to the message text
2790 * provided along with the unconditional unavailability of this entity. The
2791 * client is responsible for deallocating this string.
2793 * \param availability If non-NULL, an array of CXPlatformAvailability instances
2794 * that will be populated with platform availability information, up to either
2795 * the number of platforms for which availability information is available (as
2796 * returned by this function) or \c availability_size, whichever is smaller.
2798 * \param availability_size The number of elements available in the
2799 * \c availability array.
2801 * \returns The number of platforms (N) for which availability information is
2802 * available (which is unrelated to \c availability_size).
2804 * Note that the client is responsible for calling
2805 * \c clang_disposeCXPlatformAvailability to free each of the
2806 * platform-availability structures returned. There are
2807 * \c min(N, availability_size) such structures.
2810 clang_getCursorPlatformAvailability(CXCursor cursor,
2811 int *always_deprecated,
2812 CXString *deprecated_message,
2813 int *always_unavailable,
2814 CXString *unavailable_message,
2815 CXPlatformAvailability *availability,
2816 int availability_size);
2819 * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2822 clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability);
2825 * \brief Describe the "language" of the entity referred to by a cursor.
2827 enum CXLanguageKind {
2828 CXLanguage_Invalid = 0,
2831 CXLanguage_CPlusPlus
2835 * \brief Determine the "language" of the entity referred to by a given cursor.
2837 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
2840 * \brief Returns the translation unit that a cursor originated from.
2842 CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
2845 * \brief A fast container representing a set of CXCursors.
2847 typedef struct CXCursorSetImpl *CXCursorSet;
2850 * \brief Creates an empty CXCursorSet.
2852 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2855 * \brief Disposes a CXCursorSet and releases its associated memory.
2857 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2860 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2862 * \returns non-zero if the set contains the specified cursor.
2864 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2868 * \brief Inserts a CXCursor into a CXCursorSet.
2870 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2872 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2876 * \brief Determine the semantic parent of the given cursor.
2878 * The semantic parent of a cursor is the cursor that semantically contains
2879 * the given \p cursor. For many declarations, the lexical and semantic parents
2880 * are equivalent (the lexical parent is returned by
2881 * \c clang_getCursorLexicalParent()). They diverge when declarations or
2882 * definitions are provided out-of-line. For example:
2892 * In the out-of-line definition of \c C::f, the semantic parent is
2893 * the class \c C, of which this function is a member. The lexical parent is
2894 * the place where the declaration actually occurs in the source code; in this
2895 * case, the definition occurs in the translation unit. In general, the
2896 * lexical parent for a given entity can change without affecting the semantics
2897 * of the program, and the lexical parent of different declarations of the
2898 * same entity may be different. Changing the semantic parent of a declaration,
2899 * on the other hand, can have a major impact on semantics, and redeclarations
2900 * of a particular entity should all have the same semantic context.
2902 * In the example above, both declarations of \c C::f have \c C as their
2903 * semantic context, while the lexical context of the first \c C::f is \c C
2904 * and the lexical context of the second \c C::f is the translation unit.
2906 * For global declarations, the semantic parent is the translation unit.
2908 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
2911 * \brief Determine the lexical parent of the given cursor.
2913 * The lexical parent of a cursor is the cursor in which the given \p cursor
2914 * was actually written. For many declarations, the lexical and semantic parents
2915 * are equivalent (the semantic parent is returned by
2916 * \c clang_getCursorSemanticParent()). They diverge when declarations or
2917 * definitions are provided out-of-line. For example:
2927 * In the out-of-line definition of \c C::f, the semantic parent is
2928 * the class \c C, of which this function is a member. The lexical parent is
2929 * the place where the declaration actually occurs in the source code; in this
2930 * case, the definition occurs in the translation unit. In general, the
2931 * lexical parent for a given entity can change without affecting the semantics
2932 * of the program, and the lexical parent of different declarations of the
2933 * same entity may be different. Changing the semantic parent of a declaration,
2934 * on the other hand, can have a major impact on semantics, and redeclarations
2935 * of a particular entity should all have the same semantic context.
2937 * In the example above, both declarations of \c C::f have \c C as their
2938 * semantic context, while the lexical context of the first \c C::f is \c C
2939 * and the lexical context of the second \c C::f is the translation unit.
2941 * For declarations written in the global scope, the lexical parent is
2942 * the translation unit.
2944 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
2947 * \brief Determine the set of methods that are overridden by the given
2950 * In both Objective-C and C++, a method (aka virtual member function,
2951 * in C++) can override a virtual method in a base class. For
2952 * Objective-C, a method is said to override any method in the class's
2953 * base class, its protocols, or its categories' protocols, that has the same
2954 * selector and is of the same kind (class or instance).
2955 * If no such method exists, the search continues to the class's superclass,
2956 * its protocols, and its categories, and so on. A method from an Objective-C
2957 * implementation is considered to override the same methods as its
2958 * corresponding method in the interface.
2960 * For C++, a virtual member function overrides any virtual member
2961 * function with the same signature that occurs in its base
2962 * classes. With multiple inheritance, a virtual member function can
2963 * override several virtual member functions coming from different
2966 * In all cases, this function determines the immediate overridden
2967 * method, rather than all of the overridden methods. For example, if
2968 * a method is originally declared in a class A, then overridden in B
2969 * (which in inherits from A) and also in C (which inherited from B),
2970 * then the only overridden method returned from this function when
2971 * invoked on C's method will be B's method. The client may then
2972 * invoke this function again, given the previously-found overridden
2973 * methods, to map out the complete method-override set.
2975 * \param cursor A cursor representing an Objective-C or C++
2976 * method. This routine will compute the set of methods that this
2979 * \param overridden A pointer whose pointee will be replaced with a
2980 * pointer to an array of cursors, representing the set of overridden
2981 * methods. If there are no overridden methods, the pointee will be
2982 * set to NULL. The pointee must be freed via a call to
2983 * \c clang_disposeOverriddenCursors().
2985 * \param num_overridden A pointer to the number of overridden
2986 * functions, will be set to the number of overridden functions in the
2987 * array pointed to by \p overridden.
2989 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
2990 CXCursor **overridden,
2991 unsigned *num_overridden);
2994 * \brief Free the set of overridden cursors returned by \c
2995 * clang_getOverriddenCursors().
2997 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
3000 * \brief Retrieve the file that is included by the given inclusion directive
3003 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
3010 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
3012 * Cursors represent a location within the Abstract Syntax Tree (AST). These
3013 * routines help map between cursors and the physical locations where the
3014 * described entities occur in the source code. The mapping is provided in
3015 * both directions, so one can map from source code to the AST and back.
3021 * \brief Map a source location to the cursor that describes the entity at that
3022 * location in the source code.
3024 * clang_getCursor() maps an arbitrary source location within a translation
3025 * unit down to the most specific cursor that describes the entity at that
3026 * location. For example, given an expression \c x + y, invoking
3027 * clang_getCursor() with a source location pointing to "x" will return the
3028 * cursor for "x"; similarly for "y". If the cursor points anywhere between
3029 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
3030 * will return a cursor referring to the "+" expression.
3032 * \returns a cursor representing the entity at the given source location, or
3033 * a NULL cursor if no such entity can be found.
3035 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
3038 * \brief Retrieve the physical location of the source constructor referenced
3039 * by the given cursor.
3041 * The location of a declaration is typically the location of the name of that
3042 * declaration, where the name of that declaration would occur if it is
3043 * unnamed, or some keyword that introduces that particular declaration.
3044 * The location of a reference is where that reference occurs within the
3047 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
3050 * \brief Retrieve the physical extent of the source construct referenced by
3053 * The extent of a cursor starts with the file/line/column pointing at the
3054 * first character within the source construct that the cursor refers to and
3055 * ends with the last character within that source construct. For a
3056 * declaration, the extent covers the declaration itself. For a reference,
3057 * the extent covers the location of the reference (e.g., where the referenced
3058 * entity was actually used).
3060 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
3067 * \defgroup CINDEX_TYPES Type information for CXCursors
3073 * \brief Describes the kind of type
3077 * \brief Represents an invalid type (e.g., where no type is available).
3082 * \brief A type whose specific kind is not exposed via this
3085 CXType_Unexposed = 1,
3097 CXType_ULongLong = 11,
3098 CXType_UInt128 = 12,
3105 CXType_LongLong = 19,
3109 CXType_LongDouble = 23,
3110 CXType_NullPtr = 24,
3111 CXType_Overload = 25,
3112 CXType_Dependent = 26,
3114 CXType_ObjCClass = 28,
3115 CXType_ObjCSel = 29,
3116 CXType_Float128 = 30,
3118 CXType_FirstBuiltin = CXType_Void,
3119 CXType_LastBuiltin = CXType_Half,
3121 CXType_Complex = 100,
3122 CXType_Pointer = 101,
3123 CXType_BlockPointer = 102,
3124 CXType_LValueReference = 103,
3125 CXType_RValueReference = 104,
3126 CXType_Record = 105,
3128 CXType_Typedef = 107,
3129 CXType_ObjCInterface = 108,
3130 CXType_ObjCObjectPointer = 109,
3131 CXType_FunctionNoProto = 110,
3132 CXType_FunctionProto = 111,
3133 CXType_ConstantArray = 112,
3134 CXType_Vector = 113,
3135 CXType_IncompleteArray = 114,
3136 CXType_VariableArray = 115,
3137 CXType_DependentSizedArray = 116,
3138 CXType_MemberPointer = 117,
3142 * \brief Represents a type that was referred to using an elaborated type keyword.
3144 * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
3146 CXType_Elaborated = 119,
3148 /* OpenCL PipeType. */
3151 /* OpenCL builtin types. */
3152 CXType_OCLImage1dRO = 121,
3153 CXType_OCLImage1dArrayRO = 122,
3154 CXType_OCLImage1dBufferRO = 123,
3155 CXType_OCLImage2dRO = 124,
3156 CXType_OCLImage2dArrayRO = 125,
3157 CXType_OCLImage2dDepthRO = 126,
3158 CXType_OCLImage2dArrayDepthRO = 127,
3159 CXType_OCLImage2dMSAARO = 128,
3160 CXType_OCLImage2dArrayMSAARO = 129,
3161 CXType_OCLImage2dMSAADepthRO = 130,
3162 CXType_OCLImage2dArrayMSAADepthRO = 131,
3163 CXType_OCLImage3dRO = 132,
3164 CXType_OCLImage1dWO = 133,
3165 CXType_OCLImage1dArrayWO = 134,
3166 CXType_OCLImage1dBufferWO = 135,
3167 CXType_OCLImage2dWO = 136,
3168 CXType_OCLImage2dArrayWO = 137,
3169 CXType_OCLImage2dDepthWO = 138,
3170 CXType_OCLImage2dArrayDepthWO = 139,
3171 CXType_OCLImage2dMSAAWO = 140,
3172 CXType_OCLImage2dArrayMSAAWO = 141,
3173 CXType_OCLImage2dMSAADepthWO = 142,
3174 CXType_OCLImage2dArrayMSAADepthWO = 143,
3175 CXType_OCLImage3dWO = 144,
3176 CXType_OCLImage1dRW = 145,
3177 CXType_OCLImage1dArrayRW = 146,
3178 CXType_OCLImage1dBufferRW = 147,
3179 CXType_OCLImage2dRW = 148,
3180 CXType_OCLImage2dArrayRW = 149,
3181 CXType_OCLImage2dDepthRW = 150,
3182 CXType_OCLImage2dArrayDepthRW = 151,
3183 CXType_OCLImage2dMSAARW = 152,
3184 CXType_OCLImage2dArrayMSAARW = 153,
3185 CXType_OCLImage2dMSAADepthRW = 154,
3186 CXType_OCLImage2dArrayMSAADepthRW = 155,
3187 CXType_OCLImage3dRW = 156,
3188 CXType_OCLSampler = 157,
3189 CXType_OCLEvent = 158,
3190 CXType_OCLQueue = 159,
3191 CXType_OCLReserveID = 160
3195 * \brief Describes the calling convention of a function type
3197 enum CXCallingConv {
3198 CXCallingConv_Default = 0,
3199 CXCallingConv_C = 1,
3200 CXCallingConv_X86StdCall = 2,
3201 CXCallingConv_X86FastCall = 3,
3202 CXCallingConv_X86ThisCall = 4,
3203 CXCallingConv_X86Pascal = 5,
3204 CXCallingConv_AAPCS = 6,
3205 CXCallingConv_AAPCS_VFP = 7,
3206 CXCallingConv_X86RegCall = 8,
3207 CXCallingConv_IntelOclBicc = 9,
3208 CXCallingConv_Win64 = 10,
3209 CXCallingConv_X86_64SysV = 11,
3210 CXCallingConv_X86VectorCall = 12,
3211 CXCallingConv_Swift = 13,
3212 CXCallingConv_PreserveMost = 14,
3213 CXCallingConv_PreserveAll = 15,
3215 CXCallingConv_Invalid = 100,
3216 CXCallingConv_Unexposed = 200
3220 * \brief The type of an element in the abstract syntax tree.
3224 enum CXTypeKind kind;
3229 * \brief Retrieve the type of a CXCursor (if any).
3231 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
3234 * \brief Pretty-print the underlying type using the rules of the
3235 * language of the translation unit from which it came.
3237 * If the type is invalid, an empty string is returned.
3239 CINDEX_LINKAGE CXString clang_getTypeSpelling(CXType CT);
3242 * \brief Retrieve the underlying type of a typedef declaration.
3244 * If the cursor does not reference a typedef declaration, an invalid type is
3247 CINDEX_LINKAGE CXType clang_getTypedefDeclUnderlyingType(CXCursor C);
3250 * \brief Retrieve the integer type of an enum declaration.
3252 * If the cursor does not reference an enum declaration, an invalid type is
3255 CINDEX_LINKAGE CXType clang_getEnumDeclIntegerType(CXCursor C);
3258 * \brief Retrieve the integer value of an enum constant declaration as a signed
3261 * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
3262 * Since this is also potentially a valid constant value, the kind of the cursor
3263 * must be verified before calling this function.
3265 CINDEX_LINKAGE long long clang_getEnumConstantDeclValue(CXCursor C);
3268 * \brief Retrieve the integer value of an enum constant declaration as an unsigned
3271 * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
3272 * Since this is also potentially a valid constant value, the kind of the cursor
3273 * must be verified before calling this function.
3275 CINDEX_LINKAGE unsigned long long clang_getEnumConstantDeclUnsignedValue(CXCursor C);
3278 * \brief Retrieve the bit width of a bit field declaration as an integer.
3280 * If a cursor that is not a bit field declaration is passed in, -1 is returned.
3282 CINDEX_LINKAGE int clang_getFieldDeclBitWidth(CXCursor C);
3285 * \brief Retrieve the number of non-variadic arguments associated with a given
3288 * The number of arguments can be determined for calls as well as for
3289 * declarations of functions or methods. For other cursors -1 is returned.
3291 CINDEX_LINKAGE int clang_Cursor_getNumArguments(CXCursor C);
3294 * \brief Retrieve the argument cursor of a function or method.
3296 * The argument cursor can be determined for calls as well as for declarations
3297 * of functions or methods. For other cursors and for invalid indices, an
3298 * invalid cursor is returned.
3300 CINDEX_LINKAGE CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i);
3303 * \brief Describes the kind of a template argument.
3305 * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3306 * element descriptions.
3308 enum CXTemplateArgumentKind {
3309 CXTemplateArgumentKind_Null,
3310 CXTemplateArgumentKind_Type,
3311 CXTemplateArgumentKind_Declaration,
3312 CXTemplateArgumentKind_NullPtr,
3313 CXTemplateArgumentKind_Integral,
3314 CXTemplateArgumentKind_Template,
3315 CXTemplateArgumentKind_TemplateExpansion,
3316 CXTemplateArgumentKind_Expression,
3317 CXTemplateArgumentKind_Pack,
3318 /* Indicates an error case, preventing the kind from being deduced. */
3319 CXTemplateArgumentKind_Invalid
3323 *\brief Returns the number of template args of a function decl representing a
3324 * template specialization.
3326 * If the argument cursor cannot be converted into a template function
3327 * declaration, -1 is returned.
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 * The value 3 would be returned from this call.
3338 CINDEX_LINKAGE int clang_Cursor_getNumTemplateArguments(CXCursor C);
3341 * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3343 * If the argument CXCursor does not represent a FunctionDecl, an invalid
3344 * template argument kind is returned.
3346 * For example, for the following declaration and specialization:
3347 * template <typename T, int kInt, bool kBool>
3348 * void foo() { ... }
3351 * void foo<float, -7, true>();
3353 * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3356 CINDEX_LINKAGE enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(
3357 CXCursor C, unsigned I);
3360 * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3361 * function decl representing a template specialization.
3363 * If the argument CXCursor does not represent a FunctionDecl whose I'th
3364 * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3367 * For example, for the following declaration and specialization:
3368 * template <typename T, int kInt, bool kBool>
3369 * void foo() { ... }
3372 * void foo<float, -7, true>();
3374 * If called with I = 0, "float", will be returned.
3375 * Invalid types will be returned for I == 1 or 2.
3377 CINDEX_LINKAGE CXType clang_Cursor_getTemplateArgumentType(CXCursor C,
3381 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3382 * decl representing a template specialization) as a signed long long.
3384 * It is undefined to call this function on a CXCursor that does not represent a
3385 * FunctionDecl or whose I'th template argument is not an integral value.
3387 * For example, for the following declaration and specialization:
3388 * template <typename T, int kInt, bool kBool>
3389 * void foo() { ... }
3392 * void foo<float, -7, true>();
3394 * If called with I = 1 or 2, -7 or true will be returned, respectively.
3395 * For I == 0, this function's behavior is undefined.
3397 CINDEX_LINKAGE long long clang_Cursor_getTemplateArgumentValue(CXCursor C,
3401 * \brief Retrieve the value of an Integral TemplateArgument (of a function
3402 * decl representing a template specialization) as an unsigned long long.
3404 * It is undefined to call this function on a CXCursor that does not represent a
3405 * FunctionDecl or whose I'th template argument is not an integral value.
3407 * For example, for the following declaration and specialization:
3408 * template <typename T, int kInt, bool kBool>
3409 * void foo() { ... }
3412 * void foo<float, 2147483649, true>();
3414 * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3415 * For I == 0, this function's behavior is undefined.
3417 CINDEX_LINKAGE unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(
3418 CXCursor C, unsigned I);
3421 * \brief Determine whether two CXTypes represent the same type.
3423 * \returns non-zero if the CXTypes represent the same type and
3426 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
3429 * \brief Return the canonical type for a CXType.
3431 * Clang's type system explicitly models typedefs and all the ways
3432 * a specific type can be represented. The canonical type is the underlying
3433 * type with all the "sugar" removed. For example, if 'T' is a typedef
3434 * for 'int', the canonical type for 'T' would be 'int'.
3436 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
3439 * \brief Determine whether a CXType has the "const" qualifier set,
3440 * without looking through typedefs that may have added "const" at a
3443 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
3446 * \brief Determine whether a CXCursor that is a macro, is
3449 CINDEX_LINKAGE unsigned clang_Cursor_isMacroFunctionLike(CXCursor C);
3452 * \brief Determine whether a CXCursor that is a macro, is a
3455 CINDEX_LINKAGE unsigned clang_Cursor_isMacroBuiltin(CXCursor C);
3458 * \brief Determine whether a CXCursor that is a function declaration, is an
3459 * inline declaration.
3461 CINDEX_LINKAGE unsigned clang_Cursor_isFunctionInlined(CXCursor C);
3464 * \brief Determine whether a CXType has the "volatile" qualifier set,
3465 * without looking through typedefs that may have added "volatile" at
3466 * a different level.
3468 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
3471 * \brief Determine whether a CXType has the "restrict" qualifier set,
3472 * without looking through typedefs that may have added "restrict" at a
3475 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
3478 * \brief Returns the address space of the given type.
3480 CINDEX_LINKAGE unsigned clang_getAddressSpace(CXType T);
3483 * \brief Returns the typedef name of the given type.
3485 CINDEX_LINKAGE CXString clang_getTypedefName(CXType CT);
3488 * \brief For pointer types, returns the type of the pointee.
3490 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
3493 * \brief Return the cursor for the declaration of the given type.
3495 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
3498 * Returns the Objective-C type encoding for the specified declaration.
3500 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
3503 * Returns the Objective-C type encoding for the specified CXType.
3505 CINDEX_LINKAGE CXString clang_Type_getObjCEncoding(CXType type);
3508 * \brief Retrieve the spelling of a given CXTypeKind.
3510 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
3513 * \brief Retrieve the calling convention associated with a function type.
3515 * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3517 CINDEX_LINKAGE enum CXCallingConv clang_getFunctionTypeCallingConv(CXType T);
3520 * \brief Retrieve the return type associated with a function type.
3522 * If a non-function type is passed in, an invalid type is returned.
3524 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
3527 * \brief Retrieve the exception specification type associated with a function type.
3529 * If a non-function type is passed in, an error code of -1 is returned.
3531 CINDEX_LINKAGE int clang_getExceptionSpecificationType(CXType T);
3534 * \brief Retrieve the number of non-variadic parameters associated with a
3537 * If a non-function type is passed in, -1 is returned.
3539 CINDEX_LINKAGE int clang_getNumArgTypes(CXType T);
3542 * \brief Retrieve the type of a parameter of a function type.
3544 * If a non-function type is passed in or the function does not have enough
3545 * parameters, an invalid type is returned.
3547 CINDEX_LINKAGE CXType clang_getArgType(CXType T, unsigned i);
3550 * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3552 CINDEX_LINKAGE unsigned clang_isFunctionTypeVariadic(CXType T);
3555 * \brief Retrieve the return type associated with a given cursor.
3557 * This only returns a valid type if the cursor refers to a function or method.
3559 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
3562 * \brief Retrieve the exception specification type associated with a given cursor.
3564 * This only returns a valid result if the cursor refers to a function or method.
3566 CINDEX_LINKAGE int clang_getCursorExceptionSpecificationType(CXCursor C);
3569 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3572 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
3575 * \brief Return the element type of an array, complex, or vector type.
3577 * If a type is passed in that is not an array, complex, or vector type,
3578 * an invalid type is returned.
3580 CINDEX_LINKAGE CXType clang_getElementType(CXType T);
3583 * \brief Return the number of elements of an array or vector type.
3585 * If a type is passed in that is not an array or vector type,
3588 CINDEX_LINKAGE long long clang_getNumElements(CXType T);
3591 * \brief Return the element type of an array type.
3593 * If a non-array type is passed in, an invalid type is returned.
3595 CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
3598 * \brief Return the array size of a constant array.
3600 * If a non-array type is passed in, -1 is returned.
3602 CINDEX_LINKAGE long long clang_getArraySize(CXType T);
3605 * \brief Retrieve the type named by the qualified-id.
3607 * If a non-elaborated type is passed in, an invalid type is returned.
3609 CINDEX_LINKAGE CXType clang_Type_getNamedType(CXType T);
3612 * \brief Determine if a typedef is 'transparent' tag.
3614 * A typedef is considered 'transparent' if it shares a name and spelling
3615 * location with its underlying tag type, as is the case with the NS_ENUM macro.
3617 * \returns non-zero if transparent and zero otherwise.
3619 CINDEX_LINKAGE unsigned clang_Type_isTransparentTagTypedef(CXType T);
3622 * \brief List the possible error codes for \c clang_Type_getSizeOf,
3623 * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3624 * \c clang_Cursor_getOffsetOf.
3626 * A value of this enumeration type can be returned if the target type is not
3627 * a valid argument to sizeof, alignof or offsetof.
3629 enum CXTypeLayoutError {
3631 * \brief Type is of kind CXType_Invalid.
3633 CXTypeLayoutError_Invalid = -1,
3635 * \brief The type is an incomplete Type.
3637 CXTypeLayoutError_Incomplete = -2,
3639 * \brief The type is a dependent Type.
3641 CXTypeLayoutError_Dependent = -3,
3643 * \brief The type is not a constant size type.
3645 CXTypeLayoutError_NotConstantSize = -4,
3647 * \brief The Field name is not valid for this record.
3649 CXTypeLayoutError_InvalidFieldName = -5
3653 * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3656 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3657 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3659 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3661 * If the type declaration is not a constant size type,
3662 * CXTypeLayoutError_NotConstantSize is returned.
3664 CINDEX_LINKAGE long long clang_Type_getAlignOf(CXType T);
3667 * \brief Return the class type of an member pointer type.
3669 * If a non-member-pointer type is passed in, an invalid type is returned.
3671 CINDEX_LINKAGE CXType clang_Type_getClassType(CXType T);
3674 * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3676 * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3677 * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3679 * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3682 CINDEX_LINKAGE long long clang_Type_getSizeOf(CXType T);
3685 * \brief Return the offset of a field named S in a record of type T in bits
3686 * as it would be returned by __offsetof__ as per C++11[18.2p4]
3688 * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3690 * If the field's type declaration is an incomplete type,
3691 * CXTypeLayoutError_Incomplete is returned.
3692 * If the field's type declaration is a dependent type,
3693 * CXTypeLayoutError_Dependent is returned.
3694 * If the field's name S is not found,
3695 * CXTypeLayoutError_InvalidFieldName is returned.
3697 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3700 * \brief Return the offset of the field represented by the Cursor.
3702 * If the cursor is not a field declaration, -1 is returned.
3703 * If the cursor semantic parent is not a record field declaration,
3704 * CXTypeLayoutError_Invalid is returned.
3705 * If the field's type declaration is an incomplete type,
3706 * CXTypeLayoutError_Incomplete is returned.
3707 * If the field's type declaration is a dependent type,
3708 * CXTypeLayoutError_Dependent is returned.
3709 * If the field's name S is not found,
3710 * CXTypeLayoutError_InvalidFieldName is returned.
3712 CINDEX_LINKAGE long long clang_Cursor_getOffsetOfField(CXCursor C);
3715 * \brief Determine whether the given cursor represents an anonymous record
3718 CINDEX_LINKAGE unsigned clang_Cursor_isAnonymous(CXCursor C);
3720 enum CXRefQualifierKind {
3721 /** \brief No ref-qualifier was provided. */
3722 CXRefQualifier_None = 0,
3723 /** \brief An lvalue ref-qualifier was provided (\c &). */
3724 CXRefQualifier_LValue,
3725 /** \brief An rvalue ref-qualifier was provided (\c &&). */
3726 CXRefQualifier_RValue
3730 * \brief Returns the number of template arguments for given template
3731 * specialization, or -1 if type \c T is not a template specialization.
3733 CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
3736 * \brief Returns the type template argument of a template class specialization
3739 * This function only returns template type arguments and does not handle
3740 * template template arguments or variadic packs.
3742 CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
3745 * \brief Retrieve the ref-qualifier kind of a function or method.
3747 * The ref-qualifier is returned for C++ functions or methods. For other types
3748 * or non-C++ declarations, CXRefQualifier_None is returned.
3750 CINDEX_LINKAGE enum CXRefQualifierKind clang_Type_getCXXRefQualifier(CXType T);
3753 * \brief Returns non-zero if the cursor specifies a Record member that is a
3756 CINDEX_LINKAGE unsigned clang_Cursor_isBitField(CXCursor C);
3759 * \brief Returns 1 if the base class specified by the cursor with kind
3760 * CX_CXXBaseSpecifier is virtual.
3762 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
3765 * \brief Represents the C++ access control level to a base class for a
3766 * cursor with kind CX_CXXBaseSpecifier.
3768 enum CX_CXXAccessSpecifier {
3769 CX_CXXInvalidAccessSpecifier,
3776 * \brief Returns the access control level for the referenced object.
3778 * If the cursor refers to a C++ declaration, its access control level within its
3779 * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3780 * access specifier, the specifier itself is returned.
3782 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
3785 * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3786 * was added for the case that the passed cursor in not a declaration.
3788 enum CX_StorageClass {
3793 CX_SC_PrivateExtern,
3794 CX_SC_OpenCLWorkGroupLocal,
3800 * \brief Returns the storage class for a function or variable declaration.
3802 * If the passed in Cursor is not a function or variable declaration,
3803 * CX_SC_Invalid is returned else the storage class.
3805 CINDEX_LINKAGE enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor);
3808 * \brief Determine the number of overloaded declarations referenced by a
3809 * \c CXCursor_OverloadedDeclRef cursor.
3811 * \param cursor The cursor whose overloaded declarations are being queried.
3813 * \returns The number of overloaded declarations referenced by \c cursor. If it
3814 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3816 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
3819 * \brief Retrieve a cursor for one of the overloaded declarations referenced
3820 * by a \c CXCursor_OverloadedDeclRef cursor.
3822 * \param cursor The cursor whose overloaded declarations are being queried.
3824 * \param index The zero-based index into the set of overloaded declarations in
3827 * \returns A cursor representing the declaration referenced by the given
3828 * \c cursor at the specified \c index. If the cursor does not have an
3829 * associated set of overloaded declarations, or if the index is out of bounds,
3830 * returns \c clang_getNullCursor();
3832 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
3840 * \defgroup CINDEX_ATTRIBUTES Information for attributes
3846 * \brief For cursors representing an iboutletcollection attribute,
3847 * this function returns the collection element type.
3850 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
3857 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3859 * These routines provide the ability to traverse the abstract syntax tree
3866 * \brief Describes how the traversal of the children of a particular
3867 * cursor should proceed after visiting a particular child cursor.
3869 * A value of this enumeration type should be returned by each
3870 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3872 enum CXChildVisitResult {
3874 * \brief Terminates the cursor traversal.
3878 * \brief Continues the cursor traversal with the next sibling of
3879 * the cursor just visited, without visiting its children.
3881 CXChildVisit_Continue,
3883 * \brief Recursively traverse the children of this cursor, using
3884 * the same visitor and client data.
3886 CXChildVisit_Recurse
3890 * \brief Visitor invoked for each cursor found by a traversal.
3892 * This visitor function will be invoked for each cursor found by
3893 * clang_visitCursorChildren(). Its first argument is the cursor being
3894 * visited, its second argument is the parent visitor for that cursor,
3895 * and its third argument is the client data provided to
3896 * clang_visitCursorChildren().
3898 * The visitor should return one of the \c CXChildVisitResult values
3899 * to direct clang_visitCursorChildren().
3901 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
3903 CXClientData client_data);
3906 * \brief Visit the children of a particular cursor.
3908 * This function visits all the direct children of the given cursor,
3909 * invoking the given \p visitor function with the cursors of each
3910 * visited child. The traversal may be recursive, if the visitor returns
3911 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3912 * the visitor returns \c CXChildVisit_Break.
3914 * \param parent the cursor whose child may be visited. All kinds of
3915 * cursors can be visited, including invalid cursors (which, by
3916 * definition, have no children).
3918 * \param visitor the visitor function that will be invoked for each
3919 * child of \p parent.
3921 * \param client_data pointer data supplied by the client, which will
3922 * be passed to the visitor each time it is invoked.
3924 * \returns a non-zero value if the traversal was terminated
3925 * prematurely by the visitor returning \c CXChildVisit_Break.
3927 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
3928 CXCursorVisitor visitor,
3929 CXClientData client_data);
3930 #ifdef __has_feature
3931 # if __has_feature(blocks)
3933 * \brief Visitor invoked for each cursor found by a traversal.
3935 * This visitor block will be invoked for each cursor found by
3936 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3937 * visited, its second argument is the parent visitor for that cursor.
3939 * The visitor should return one of the \c CXChildVisitResult values
3940 * to direct clang_visitChildrenWithBlock().
3942 typedef enum CXChildVisitResult
3943 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3946 * Visits the children of a cursor using the specified block. Behaves
3947 * identically to clang_visitChildren() in all other respects.
3949 CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
3950 CXCursorVisitorBlock block);
3959 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3961 * These routines provide the ability to determine references within and
3962 * across translation units, by providing the names of the entities referenced
3963 * by cursors, follow reference cursors to the declarations they reference,
3964 * and associate declarations with their definitions.
3970 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3971 * by the given cursor.
3973 * A Unified Symbol Resolution (USR) is a string that identifies a particular
3974 * entity (function, class, variable, etc.) within a program. USRs can be
3975 * compared across translation units to determine, e.g., when references in
3976 * one translation refer to an entity defined in another translation unit.
3978 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
3981 * \brief Construct a USR for a specified Objective-C class.
3983 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3986 * \brief Construct a USR for a specified Objective-C category.
3988 CINDEX_LINKAGE CXString
3989 clang_constructUSR_ObjCCategory(const char *class_name,
3990 const char *category_name);
3993 * \brief Construct a USR for a specified Objective-C protocol.
3995 CINDEX_LINKAGE CXString
3996 clang_constructUSR_ObjCProtocol(const char *protocol_name);
3999 * \brief Construct a USR for a specified Objective-C instance variable and
4000 * the USR for its containing class.
4002 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
4006 * \brief Construct a USR for a specified Objective-C method and
4007 * the USR for its containing class.
4009 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
4010 unsigned isInstanceMethod,
4014 * \brief Construct a USR for a specified Objective-C property and the USR
4015 * for its containing class.
4017 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
4021 * \brief Retrieve a name for the entity referenced by this cursor.
4023 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
4026 * \brief Retrieve a range for a piece that forms the cursors spelling name.
4027 * Most of the times there is only one range for the complete spelling but for
4028 * Objective-C methods and Objective-C message expressions, there are multiple
4029 * pieces for each selector identifier.
4031 * \param pieceIndex the index of the spelling name piece. If this is greater
4032 * than the actual number of pieces, it will return a NULL (invalid) range.
4034 * \param options Reserved.
4036 CINDEX_LINKAGE CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor,
4037 unsigned pieceIndex,
4041 * \brief Retrieve the display name for the entity referenced by this cursor.
4043 * The display name contains extra information that helps identify the cursor,
4044 * such as the parameters of a function or template or the arguments of a
4045 * class template specialization.
4047 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
4049 /** \brief For a cursor that is a reference, retrieve a cursor representing the
4050 * entity that it references.
4052 * Reference cursors refer to other entities in the AST. For example, an
4053 * Objective-C superclass reference cursor refers to an Objective-C class.
4054 * This function produces the cursor for the Objective-C class from the
4055 * cursor for the superclass reference. If the input cursor is a declaration or
4056 * definition, it returns that declaration or definition unchanged.
4057 * Otherwise, returns the NULL cursor.
4059 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
4062 * \brief For a cursor that is either a reference to or a declaration
4063 * of some entity, retrieve a cursor that describes the definition of
4066 * Some entities can be declared multiple times within a translation
4067 * unit, but only one of those declarations can also be a
4068 * definition. For example, given:
4072 * int g(int x, int y) { return f(x, y); }
4073 * int f(int a, int b) { return a + b; }
4077 * there are three declarations of the function "f", but only the
4078 * second one is a definition. The clang_getCursorDefinition()
4079 * function will take any cursor pointing to a declaration of "f"
4080 * (the first or fourth lines of the example) or a cursor referenced
4081 * that uses "f" (the call to "f' inside "g") and will return a
4082 * declaration cursor pointing to the definition (the second "f"
4085 * If given a cursor for which there is no corresponding definition,
4086 * e.g., because there is no definition of that entity within this
4087 * translation unit, returns a NULL cursor.
4089 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
4092 * \brief Determine whether the declaration pointed to by this cursor
4093 * is also a definition of that entity.
4095 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
4098 * \brief Retrieve the canonical cursor corresponding to the given cursor.
4100 * In the C family of languages, many kinds of entities can be declared several
4101 * times within a single translation unit. For example, a structure type can
4102 * be forward-declared (possibly multiple times) and later defined:
4112 * The declarations and the definition of \c X are represented by three
4113 * different cursors, all of which are declarations of the same underlying
4114 * entity. One of these cursor is considered the "canonical" cursor, which
4115 * is effectively the representative for the underlying entity. One can
4116 * determine if two cursors are declarations of the same underlying entity by
4117 * comparing their canonical cursors.
4119 * \returns The canonical cursor for the entity referred to by the given cursor.
4121 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
4124 * \brief If the cursor points to a selector identifier in an Objective-C
4125 * method or message expression, this returns the selector index.
4127 * After getting a cursor with #clang_getCursor, this can be called to
4128 * determine if the location points to a selector identifier.
4130 * \returns The selector index if the cursor is an Objective-C method or message
4131 * expression and the cursor is pointing to a selector identifier, or -1
4134 CINDEX_LINKAGE int clang_Cursor_getObjCSelectorIndex(CXCursor);
4137 * \brief Given a cursor pointing to a C++ method call or an Objective-C
4138 * message, returns non-zero if the method/message is "dynamic", meaning:
4140 * For a C++ method: the call is virtual.
4141 * For an Objective-C message: the receiver is an object instance, not 'super'
4142 * or a specific class.
4144 * If the method/message is "static" or the cursor does not point to a
4145 * method/message, it will return zero.
4147 CINDEX_LINKAGE int clang_Cursor_isDynamicCall(CXCursor C);
4150 * \brief Given a cursor pointing to an Objective-C message or property
4151 * reference, or C++ method call, returns the CXType of the receiver.
4153 CINDEX_LINKAGE CXType clang_Cursor_getReceiverType(CXCursor C);
4156 * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
4159 CXObjCPropertyAttr_noattr = 0x00,
4160 CXObjCPropertyAttr_readonly = 0x01,
4161 CXObjCPropertyAttr_getter = 0x02,
4162 CXObjCPropertyAttr_assign = 0x04,
4163 CXObjCPropertyAttr_readwrite = 0x08,
4164 CXObjCPropertyAttr_retain = 0x10,
4165 CXObjCPropertyAttr_copy = 0x20,
4166 CXObjCPropertyAttr_nonatomic = 0x40,
4167 CXObjCPropertyAttr_setter = 0x80,
4168 CXObjCPropertyAttr_atomic = 0x100,
4169 CXObjCPropertyAttr_weak = 0x200,
4170 CXObjCPropertyAttr_strong = 0x400,
4171 CXObjCPropertyAttr_unsafe_unretained = 0x800,
4172 CXObjCPropertyAttr_class = 0x1000
4173 } CXObjCPropertyAttrKind;
4176 * \brief Given a cursor that represents a property declaration, return the
4177 * associated property attributes. The bits are formed from
4178 * \c CXObjCPropertyAttrKind.
4180 * \param reserved Reserved for future use, pass 0.
4182 CINDEX_LINKAGE unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C,
4186 * \brief 'Qualifiers' written next to the return and parameter types in
4187 * Objective-C method declarations.
4190 CXObjCDeclQualifier_None = 0x0,
4191 CXObjCDeclQualifier_In = 0x1,
4192 CXObjCDeclQualifier_Inout = 0x2,
4193 CXObjCDeclQualifier_Out = 0x4,
4194 CXObjCDeclQualifier_Bycopy = 0x8,
4195 CXObjCDeclQualifier_Byref = 0x10,
4196 CXObjCDeclQualifier_Oneway = 0x20
4197 } CXObjCDeclQualifierKind;
4200 * \brief Given a cursor that represents an Objective-C method or parameter
4201 * declaration, return the associated Objective-C qualifiers for the return
4202 * type or the parameter respectively. The bits are formed from
4203 * CXObjCDeclQualifierKind.
4205 CINDEX_LINKAGE unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C);
4208 * \brief Given a cursor that represents an Objective-C method or property
4209 * declaration, return non-zero if the declaration was affected by "\@optional".
4210 * Returns zero if the cursor is not such a declaration or it is "\@required".
4212 CINDEX_LINKAGE unsigned clang_Cursor_isObjCOptional(CXCursor C);
4215 * \brief Returns non-zero if the given cursor is a variadic function or method.
4217 CINDEX_LINKAGE unsigned clang_Cursor_isVariadic(CXCursor C);
4220 * \brief Returns non-zero if the given cursor points to a symbol marked with
4221 * external_source_symbol attribute.
4223 * \param language If non-NULL, and the attribute is present, will be set to
4224 * the 'language' string from the attribute.
4226 * \param definedIn If non-NULL, and the attribute is present, will be set to
4227 * the 'definedIn' string from the attribute.
4229 * \param isGenerated If non-NULL, and the attribute is present, will be set to
4230 * non-zero if the 'generated_declaration' is set in the attribute.
4232 CINDEX_LINKAGE unsigned clang_Cursor_isExternalSymbol(CXCursor C,
4233 CXString *language, CXString *definedIn,
4234 unsigned *isGenerated);
4237 * \brief Given a cursor that represents a declaration, return the associated
4238 * comment's source range. The range may include multiple consecutive comments
4239 * with whitespace in between.
4241 CINDEX_LINKAGE CXSourceRange clang_Cursor_getCommentRange(CXCursor C);
4244 * \brief Given a cursor that represents a declaration, return the associated
4245 * comment text, including comment markers.
4247 CINDEX_LINKAGE CXString clang_Cursor_getRawCommentText(CXCursor C);
4250 * \brief Given a cursor that represents a documentable entity (e.g.,
4251 * declaration), return the associated \\brief paragraph; otherwise return the
4254 CINDEX_LINKAGE CXString clang_Cursor_getBriefCommentText(CXCursor C);
4260 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
4266 * \brief Retrieve the CXString representing the mangled name of the cursor.
4268 CINDEX_LINKAGE CXString clang_Cursor_getMangling(CXCursor);
4271 * \brief Retrieve the CXStrings representing the mangled symbols of the C++
4272 * constructor or destructor at the cursor.
4274 CINDEX_LINKAGE CXStringSet *clang_Cursor_getCXXManglings(CXCursor);
4281 * \defgroup CINDEX_MODULE Module introspection
4283 * The functions in this group provide access to information about modules.
4288 typedef void *CXModule;
4291 * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4293 CINDEX_LINKAGE CXModule clang_Cursor_getModule(CXCursor C);
4296 * \brief Given a CXFile header file, return the module that contains it, if one
4299 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4302 * \param Module a module object.
4304 * \returns the module file where the provided module object came from.
4306 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4309 * \param Module a module object.
4311 * \returns the parent of a sub-module or NULL if the given module is top-level,
4312 * e.g. for 'std.vector' it will return the 'std' module.
4314 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4317 * \param Module a module object.
4319 * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4320 * will return "vector".
4322 CINDEX_LINKAGE CXString clang_Module_getName(CXModule Module);
4325 * \param Module a module object.
4327 * \returns the full name of the module, e.g. "std.vector".
4329 CINDEX_LINKAGE CXString clang_Module_getFullName(CXModule Module);
4332 * \param Module a module object.
4334 * \returns non-zero if the module is a system one.
4336 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4339 * \param Module a module object.
4341 * \returns the number of top level headers associated with this module.
4343 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4347 * \param Module a module object.
4349 * \param Index top level header index (zero-based).
4351 * \returns the specified top level header associated with the module.
4354 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
4355 CXModule Module, unsigned Index);
4362 * \defgroup CINDEX_CPP C++ AST introspection
4364 * The routines in this group provide access information in the ASTs specific
4365 * to C++ language features.
4371 * \brief Determine if a C++ constructor is a converting constructor.
4373 CINDEX_LINKAGE unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C);
4376 * \brief Determine if a C++ constructor is a copy constructor.
4378 CINDEX_LINKAGE unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C);
4381 * \brief Determine if a C++ constructor is the default constructor.
4383 CINDEX_LINKAGE unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C);
4386 * \brief Determine if a C++ constructor is a move constructor.
4388 CINDEX_LINKAGE unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C);
4391 * \brief Determine if a C++ field is declared 'mutable'.
4393 CINDEX_LINKAGE unsigned clang_CXXField_isMutable(CXCursor C);
4396 * \brief Determine if a C++ method is declared '= default'.
4398 CINDEX_LINKAGE unsigned clang_CXXMethod_isDefaulted(CXCursor C);
4401 * \brief Determine if a C++ member function or member function template is
4404 CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
4407 * \brief Determine if a C++ member function or member function template is
4408 * declared 'static'.
4410 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
4413 * \brief Determine if a C++ member function or member function template is
4414 * explicitly declared 'virtual' or if it overrides a virtual method from
4415 * one of the base classes.
4417 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
4420 * \brief Determine if an enum declaration refers to a scoped enum.
4422 CINDEX_LINKAGE unsigned clang_EnumDecl_isScoped(CXCursor C);
4425 * \brief Determine if a C++ member function or member function template is
4428 CINDEX_LINKAGE unsigned clang_CXXMethod_isConst(CXCursor C);
4431 * \brief Given a cursor that represents a template, determine
4432 * the cursor kind of the specializations would be generated by instantiating
4435 * This routine can be used to determine what flavor of function template,
4436 * class template, or class template partial specialization is stored in the
4437 * cursor. For example, it can describe whether a class template cursor is
4438 * declared with "struct", "class" or "union".
4440 * \param C The cursor to query. This cursor should represent a template
4443 * \returns The cursor kind of the specializations that would be generated
4444 * by instantiating the template \p C. If \p C is not a template, returns
4445 * \c CXCursor_NoDeclFound.
4447 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
4450 * \brief Given a cursor that may represent a specialization or instantiation
4451 * of a template, retrieve the cursor that represents the template that it
4452 * specializes or from which it was instantiated.
4454 * This routine determines the template involved both for explicit
4455 * specializations of templates and for implicit instantiations of the template,
4456 * both of which are referred to as "specializations". For a class template
4457 * specialization (e.g., \c std::vector<bool>), this routine will return
4458 * either the primary template (\c std::vector) or, if the specialization was
4459 * instantiated from a class template partial specialization, the class template
4460 * partial specialization. For a class template partial specialization and a
4461 * function template specialization (including instantiations), this
4462 * this routine will return the specialized template.
4464 * For members of a class template (e.g., member functions, member classes, or
4465 * static data members), returns the specialized or instantiated member.
4466 * Although not strictly "templates" in the C++ language, members of class
4467 * templates have the same notions of specializations and instantiations that
4468 * templates do, so this routine treats them similarly.
4470 * \param C A cursor that may be a specialization of a template or a member
4473 * \returns If the given cursor is a specialization or instantiation of a
4474 * template or a member thereof, the template or member that it specializes or
4475 * from which it was instantiated. Otherwise, returns a NULL cursor.
4477 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
4480 * \brief Given a cursor that references something else, return the source range
4481 * covering that reference.
4483 * \param C A cursor pointing to a member reference, a declaration reference, or
4485 * \param NameFlags A bitset with three independent flags:
4486 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4487 * CXNameRange_WantSinglePiece.
4488 * \param PieceIndex For contiguous names or when passing the flag
4489 * CXNameRange_WantSinglePiece, only one piece with index 0 is
4490 * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4491 * non-contiguous names, this index can be used to retrieve the individual
4492 * pieces of the name. See also CXNameRange_WantSinglePiece.
4494 * \returns The piece of the name pointed to by the given cursor. If there is no
4495 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4497 CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
4499 unsigned PieceIndex);
4501 enum CXNameRefFlags {
4503 * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4506 CXNameRange_WantQualifier = 0x1,
4509 * \brief Include the explicit template arguments, e.g. \<int> in x.f<int>,
4512 CXNameRange_WantTemplateArgs = 0x2,
4515 * \brief If the name is non-contiguous, return the full spanning range.
4517 * Non-contiguous names occur in Objective-C when a selector with two or more
4518 * parameters is used, or in C++ when using an operator:
4520 * [object doSomething:here withValue:there]; // Objective-C
4521 * return some_vector[1]; // C++
4524 CXNameRange_WantSinglePiece = 0x4
4532 * \defgroup CINDEX_LEX Token extraction and manipulation
4534 * The routines in this group provide access to the tokens within a
4535 * translation unit, along with a semantic mapping of those tokens to
4536 * their corresponding cursors.
4542 * \brief Describes a kind of token.
4544 typedef enum CXTokenKind {
4546 * \brief A token that contains some kind of punctuation.
4548 CXToken_Punctuation,
4551 * \brief A language keyword.
4556 * \brief An identifier (that is not a keyword).
4561 * \brief A numeric, string, or character literal.
4572 * \brief Describes a single preprocessing token.
4575 unsigned int_data[4];
4580 * \brief Determine the kind of the given token.
4582 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
4585 * \brief Determine the spelling of the given token.
4587 * The spelling of a token is the textual representation of that token, e.g.,
4588 * the text of an identifier or keyword.
4590 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
4593 * \brief Retrieve the source location of the given token.
4595 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
4599 * \brief Retrieve a source range that covers the given token.
4601 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
4604 * \brief Tokenize the source code described by the given range into raw
4607 * \param TU the translation unit whose text is being tokenized.
4609 * \param Range the source range in which text should be tokenized. All of the
4610 * tokens produced by tokenization will fall within this source range,
4612 * \param Tokens this pointer will be set to point to the array of tokens
4613 * that occur within the given source range. The returned pointer must be
4614 * freed with clang_disposeTokens() before the translation unit is destroyed.
4616 * \param NumTokens will be set to the number of tokens in the \c *Tokens
4620 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4621 CXToken **Tokens, unsigned *NumTokens);
4624 * \brief Annotate the given set of tokens by providing cursors for each token
4625 * that can be mapped to a specific entity within the abstract syntax tree.
4627 * This token-annotation routine is equivalent to invoking
4628 * clang_getCursor() for the source locations of each of the
4629 * tokens. The cursors provided are filtered, so that only those
4630 * cursors that have a direct correspondence to the token are
4631 * accepted. For example, given a function call \c f(x),
4632 * clang_getCursor() would provide the following cursors:
4634 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4635 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4636 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4638 * Only the first and last of these cursors will occur within the
4639 * annotate, since the tokens "f" and "x' directly refer to a function
4640 * and a variable, respectively, but the parentheses are just a small
4641 * part of the full syntax of the function call expression, which is
4642 * not provided as an annotation.
4644 * \param TU the translation unit that owns the given tokens.
4646 * \param Tokens the set of tokens to annotate.
4648 * \param NumTokens the number of tokens in \p Tokens.
4650 * \param Cursors an array of \p NumTokens cursors, whose contents will be
4651 * replaced with the cursors corresponding to each token.
4653 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4654 CXToken *Tokens, unsigned NumTokens,
4658 * \brief Free the given set of tokens.
4660 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4661 CXToken *Tokens, unsigned NumTokens);
4668 * \defgroup CINDEX_DEBUG Debugging facilities
4670 * These routines are used for testing and debugging, only, and should not
4676 /* for debug/testing */
4677 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
4678 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
4679 const char **startBuf,
4680 const char **endBuf,
4681 unsigned *startLine,
4682 unsigned *startColumn,
4684 unsigned *endColumn);
4685 CINDEX_LINKAGE void clang_enableStackTraces(void);
4686 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4687 unsigned stack_size);
4694 * \defgroup CINDEX_CODE_COMPLET Code completion
4696 * Code completion involves taking an (incomplete) source file, along with
4697 * knowledge of where the user is actively editing that file, and suggesting
4698 * syntactically- and semantically-valid constructs that the user might want to
4699 * use at that particular point in the source code. These data structures and
4700 * routines provide support for code completion.
4706 * \brief A semantic string that describes a code-completion result.
4708 * A semantic string that describes the formatting of a code-completion
4709 * result as a single "template" of text that should be inserted into the
4710 * source buffer when a particular code-completion result is selected.
4711 * Each semantic string is made up of some number of "chunks", each of which
4712 * contains some text along with a description of what that text means, e.g.,
4713 * the name of the entity being referenced, whether the text chunk is part of
4714 * the template, or whether it is a "placeholder" that the user should replace
4715 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4716 * description of the different kinds of chunks.
4718 typedef void *CXCompletionString;
4721 * \brief A single result of code completion.
4725 * \brief The kind of entity that this completion refers to.
4727 * The cursor kind will be a macro, keyword, or a declaration (one of the
4728 * *Decl cursor kinds), describing the entity that the completion is
4731 * \todo In the future, we would like to provide a full cursor, to allow
4732 * the client to extract additional information from declaration.
4734 enum CXCursorKind CursorKind;
4737 * \brief The code-completion string that describes how to insert this
4738 * code-completion result into the editing buffer.
4740 CXCompletionString CompletionString;
4741 } CXCompletionResult;
4744 * \brief Describes a single piece of text within a code-completion string.
4746 * Each "chunk" within a code-completion string (\c CXCompletionString) is
4747 * either a piece of text with a specific "kind" that describes how that text
4748 * should be interpreted by the client or is another completion string.
4750 enum CXCompletionChunkKind {
4752 * \brief A code-completion string that describes "optional" text that
4753 * could be a part of the template (but is not required).
4755 * The Optional chunk is the only kind of chunk that has a code-completion
4756 * string for its representation, which is accessible via
4757 * \c clang_getCompletionChunkCompletionString(). The code-completion string
4758 * describes an additional part of the template that is completely optional.
4759 * For example, optional chunks can be used to describe the placeholders for
4760 * arguments that match up with defaulted function parameters, e.g. given:
4763 * void f(int x, float y = 3.14, double z = 2.71828);
4766 * The code-completion string for this function would contain:
4767 * - a TypedText chunk for "f".
4768 * - a LeftParen chunk for "(".
4769 * - a Placeholder chunk for "int x"
4770 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4771 * - a Comma chunk for ","
4772 * - a Placeholder chunk for "float y"
4773 * - an Optional chunk containing the last defaulted argument:
4774 * - a Comma chunk for ","
4775 * - a Placeholder chunk for "double z"
4776 * - a RightParen chunk for ")"
4778 * There are many ways to handle Optional chunks. Two simple approaches are:
4779 * - Completely ignore optional chunks, in which case the template for the
4780 * function "f" would only include the first parameter ("int x").
4781 * - Fully expand all optional chunks, in which case the template for the
4782 * function "f" would have all of the parameters.
4784 CXCompletionChunk_Optional,
4786 * \brief Text that a user would be expected to type to get this
4787 * code-completion result.
4789 * There will be exactly one "typed text" chunk in a semantic string, which
4790 * will typically provide the spelling of a keyword or the name of a
4791 * declaration that could be used at the current code point. Clients are
4792 * expected to filter the code-completion results based on the text in this
4795 CXCompletionChunk_TypedText,
4797 * \brief Text that should be inserted as part of a code-completion result.
4799 * A "text" chunk represents text that is part of the template to be
4800 * inserted into user code should this particular code-completion result
4803 CXCompletionChunk_Text,
4805 * \brief Placeholder text that should be replaced by the user.
4807 * A "placeholder" chunk marks a place where the user should insert text
4808 * into the code-completion template. For example, placeholders might mark
4809 * the function parameters for a function declaration, to indicate that the
4810 * user should provide arguments for each of those parameters. The actual
4811 * text in a placeholder is a suggestion for the text to display before
4812 * the user replaces the placeholder with real code.
4814 CXCompletionChunk_Placeholder,
4816 * \brief Informative text that should be displayed but never inserted as
4817 * part of the template.
4819 * An "informative" chunk contains annotations that can be displayed to
4820 * help the user decide whether a particular code-completion result is the
4821 * right option, but which is not part of the actual template to be inserted
4822 * by code completion.
4824 CXCompletionChunk_Informative,
4826 * \brief Text that describes the current parameter when code-completion is
4827 * referring to function call, message send, or template specialization.
4829 * A "current parameter" chunk occurs when code-completion is providing
4830 * information about a parameter corresponding to the argument at the
4831 * code-completion point. For example, given a function
4834 * int add(int x, int y);
4837 * and the source code \c add(, where the code-completion point is after the
4838 * "(", the code-completion string will contain a "current parameter" chunk
4839 * for "int x", indicating that the current argument will initialize that
4840 * parameter. After typing further, to \c add(17, (where the code-completion
4841 * point is after the ","), the code-completion string will contain a
4842 * "current paremeter" chunk to "int y".
4844 CXCompletionChunk_CurrentParameter,
4846 * \brief A left parenthesis ('('), used to initiate a function call or
4847 * signal the beginning of a function parameter list.
4849 CXCompletionChunk_LeftParen,
4851 * \brief A right parenthesis (')'), used to finish a function call or
4852 * signal the end of a function parameter list.
4854 CXCompletionChunk_RightParen,
4856 * \brief A left bracket ('[').
4858 CXCompletionChunk_LeftBracket,
4860 * \brief A right bracket (']').
4862 CXCompletionChunk_RightBracket,
4864 * \brief A left brace ('{').
4866 CXCompletionChunk_LeftBrace,
4868 * \brief A right brace ('}').
4870 CXCompletionChunk_RightBrace,
4872 * \brief A left angle bracket ('<').
4874 CXCompletionChunk_LeftAngle,
4876 * \brief A right angle bracket ('>').
4878 CXCompletionChunk_RightAngle,
4880 * \brief A comma separator (',').
4882 CXCompletionChunk_Comma,
4884 * \brief Text that specifies the result type of a given result.
4886 * This special kind of informative chunk is not meant to be inserted into
4887 * the text buffer. Rather, it is meant to illustrate the type that an
4888 * expression using the given completion string would have.
4890 CXCompletionChunk_ResultType,
4892 * \brief A colon (':').
4894 CXCompletionChunk_Colon,
4896 * \brief A semicolon (';').
4898 CXCompletionChunk_SemiColon,
4900 * \brief An '=' sign.
4902 CXCompletionChunk_Equal,
4904 * Horizontal space (' ').
4906 CXCompletionChunk_HorizontalSpace,
4908 * Vertical space ('\\n'), after which it is generally a good idea to
4909 * perform indentation.
4911 CXCompletionChunk_VerticalSpace
4915 * \brief Determine the kind of a particular chunk within a completion string.
4917 * \param completion_string the completion string to query.
4919 * \param chunk_number the 0-based index of the chunk in the completion string.
4921 * \returns the kind of the chunk at the index \c chunk_number.
4923 CINDEX_LINKAGE enum CXCompletionChunkKind
4924 clang_getCompletionChunkKind(CXCompletionString completion_string,
4925 unsigned chunk_number);
4928 * \brief Retrieve the text associated with a particular chunk within a
4929 * completion string.
4931 * \param completion_string the completion string to query.
4933 * \param chunk_number the 0-based index of the chunk in the completion string.
4935 * \returns the text associated with the chunk at index \c chunk_number.
4937 CINDEX_LINKAGE CXString
4938 clang_getCompletionChunkText(CXCompletionString completion_string,
4939 unsigned chunk_number);
4942 * \brief Retrieve the completion string associated with a particular chunk
4943 * within a completion string.
4945 * \param completion_string the completion string to query.
4947 * \param chunk_number the 0-based index of the chunk in the completion string.
4949 * \returns the completion string associated with the chunk at index
4952 CINDEX_LINKAGE CXCompletionString
4953 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4954 unsigned chunk_number);
4957 * \brief Retrieve the number of chunks in the given code-completion string.
4959 CINDEX_LINKAGE unsigned
4960 clang_getNumCompletionChunks(CXCompletionString completion_string);
4963 * \brief Determine the priority of this code completion.
4965 * The priority of a code completion indicates how likely it is that this
4966 * particular completion is the completion that the user will select. The
4967 * priority is selected by various internal heuristics.
4969 * \param completion_string The completion string to query.
4971 * \returns The priority of this completion string. Smaller values indicate
4972 * higher-priority (more likely) completions.
4974 CINDEX_LINKAGE unsigned
4975 clang_getCompletionPriority(CXCompletionString completion_string);
4978 * \brief Determine the availability of the entity that this code-completion
4981 * \param completion_string The completion string to query.
4983 * \returns The availability of the completion string.
4985 CINDEX_LINKAGE enum CXAvailabilityKind
4986 clang_getCompletionAvailability(CXCompletionString completion_string);
4989 * \brief Retrieve the number of annotations associated with the given
4990 * completion string.
4992 * \param completion_string the completion string to query.
4994 * \returns the number of annotations associated with the given completion
4997 CINDEX_LINKAGE unsigned
4998 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
5001 * \brief Retrieve the annotation associated with the given completion string.
5003 * \param completion_string the completion string to query.
5005 * \param annotation_number the 0-based index of the annotation of the
5006 * completion string.
5008 * \returns annotation string associated with the completion at index
5009 * \c annotation_number, or a NULL string if that annotation is not available.
5011 CINDEX_LINKAGE CXString
5012 clang_getCompletionAnnotation(CXCompletionString completion_string,
5013 unsigned annotation_number);
5016 * \brief Retrieve the parent context of the given completion string.
5018 * The parent context of a completion string is the semantic parent of
5019 * the declaration (if any) that the code completion represents. For example,
5020 * a code completion for an Objective-C method would have the method's class
5021 * or protocol as its context.
5023 * \param completion_string The code completion string whose parent is
5026 * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
5028 * \returns The name of the completion parent, e.g., "NSObject" if
5029 * the completion string represents a method in the NSObject class.
5031 CINDEX_LINKAGE CXString
5032 clang_getCompletionParent(CXCompletionString completion_string,
5033 enum CXCursorKind *kind);
5036 * \brief Retrieve the brief documentation comment attached to the declaration
5037 * that corresponds to the given completion string.
5039 CINDEX_LINKAGE CXString
5040 clang_getCompletionBriefComment(CXCompletionString completion_string);
5043 * \brief Retrieve a completion string for an arbitrary declaration or macro
5044 * definition cursor.
5046 * \param cursor The cursor to query.
5048 * \returns A non-context-sensitive completion string for declaration and macro
5049 * definition cursors, or NULL for other kinds of cursors.
5051 CINDEX_LINKAGE CXCompletionString
5052 clang_getCursorCompletionString(CXCursor cursor);
5055 * \brief Contains the results of code-completion.
5057 * This data structure contains the results of code completion, as
5058 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
5059 * \c clang_disposeCodeCompleteResults.
5063 * \brief The code-completion results.
5065 CXCompletionResult *Results;
5068 * \brief The number of code-completion results stored in the
5071 unsigned NumResults;
5072 } CXCodeCompleteResults;
5075 * \brief Flags that can be passed to \c clang_codeCompleteAt() to
5076 * modify its behavior.
5078 * The enumerators in this enumeration can be bitwise-OR'd together to
5079 * provide multiple options to \c clang_codeCompleteAt().
5081 enum CXCodeComplete_Flags {
5083 * \brief Whether to include macros within the set of code
5084 * completions returned.
5086 CXCodeComplete_IncludeMacros = 0x01,
5089 * \brief Whether to include code patterns for language constructs
5090 * within the set of code completions, e.g., for loops.
5092 CXCodeComplete_IncludeCodePatterns = 0x02,
5095 * \brief Whether to include brief documentation within the set of code
5096 * completions returned.
5098 CXCodeComplete_IncludeBriefComments = 0x04
5102 * \brief Bits that represent the context under which completion is occurring.
5104 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
5105 * contexts are occurring simultaneously.
5107 enum CXCompletionContext {
5109 * \brief The context for completions is unexposed, as only Clang results
5110 * should be included. (This is equivalent to having no context bits set.)
5112 CXCompletionContext_Unexposed = 0,
5115 * \brief Completions for any possible type should be included in the results.
5117 CXCompletionContext_AnyType = 1 << 0,
5120 * \brief Completions for any possible value (variables, function calls, etc.)
5121 * should be included in the results.
5123 CXCompletionContext_AnyValue = 1 << 1,
5125 * \brief Completions for values that resolve to an Objective-C object should
5126 * be included in the results.
5128 CXCompletionContext_ObjCObjectValue = 1 << 2,
5130 * \brief Completions for values that resolve to an Objective-C selector
5131 * should be included in the results.
5133 CXCompletionContext_ObjCSelectorValue = 1 << 3,
5135 * \brief Completions for values that resolve to a C++ class type should be
5136 * included in the results.
5138 CXCompletionContext_CXXClassTypeValue = 1 << 4,
5141 * \brief Completions for fields of the member being accessed using the dot
5142 * operator should be included in the results.
5144 CXCompletionContext_DotMemberAccess = 1 << 5,
5146 * \brief Completions for fields of the member being accessed using the arrow
5147 * operator should be included in the results.
5149 CXCompletionContext_ArrowMemberAccess = 1 << 6,
5151 * \brief Completions for properties of the Objective-C object being accessed
5152 * using the dot operator should be included in the results.
5154 CXCompletionContext_ObjCPropertyAccess = 1 << 7,
5157 * \brief Completions for enum tags should be included in the results.
5159 CXCompletionContext_EnumTag = 1 << 8,
5161 * \brief Completions for union tags should be included in the results.
5163 CXCompletionContext_UnionTag = 1 << 9,
5165 * \brief Completions for struct tags should be included in the results.
5167 CXCompletionContext_StructTag = 1 << 10,
5170 * \brief Completions for C++ class names should be included in the results.
5172 CXCompletionContext_ClassTag = 1 << 11,
5174 * \brief Completions for C++ namespaces and namespace aliases should be
5175 * included in the results.
5177 CXCompletionContext_Namespace = 1 << 12,
5179 * \brief Completions for C++ nested name specifiers should be included in
5182 CXCompletionContext_NestedNameSpecifier = 1 << 13,
5185 * \brief Completions for Objective-C interfaces (classes) should be included
5188 CXCompletionContext_ObjCInterface = 1 << 14,
5190 * \brief Completions for Objective-C protocols should be included in
5193 CXCompletionContext_ObjCProtocol = 1 << 15,
5195 * \brief Completions for Objective-C categories should be included in
5198 CXCompletionContext_ObjCCategory = 1 << 16,
5200 * \brief Completions for Objective-C instance messages should be included
5203 CXCompletionContext_ObjCInstanceMessage = 1 << 17,
5205 * \brief Completions for Objective-C class messages should be included in
5208 CXCompletionContext_ObjCClassMessage = 1 << 18,
5210 * \brief Completions for Objective-C selector names should be included in
5213 CXCompletionContext_ObjCSelectorName = 1 << 19,
5216 * \brief Completions for preprocessor macro names should be included in
5219 CXCompletionContext_MacroName = 1 << 20,
5222 * \brief Natural language completions should be included in the results.
5224 CXCompletionContext_NaturalLanguage = 1 << 21,
5227 * \brief The current context is unknown, so set all contexts.
5229 CXCompletionContext_Unknown = ((1 << 22) - 1)
5233 * \brief Returns a default set of code-completion options that can be
5234 * passed to\c clang_codeCompleteAt().
5236 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
5239 * \brief Perform code completion at a given location in a translation unit.
5241 * This function performs code completion at a particular file, line, and
5242 * column within source code, providing results that suggest potential
5243 * code snippets based on the context of the completion. The basic model
5244 * for code completion is that Clang will parse a complete source file,
5245 * performing syntax checking up to the location where code-completion has
5246 * been requested. At that point, a special code-completion token is passed
5247 * to the parser, which recognizes this token and determines, based on the
5248 * current location in the C/Objective-C/C++ grammar and the state of
5249 * semantic analysis, what completions to provide. These completions are
5250 * returned via a new \c CXCodeCompleteResults structure.
5252 * Code completion itself is meant to be triggered by the client when the
5253 * user types punctuation characters or whitespace, at which point the
5254 * code-completion location will coincide with the cursor. For example, if \c p
5255 * is a pointer, code-completion might be triggered after the "-" and then
5256 * after the ">" in \c p->. When the code-completion location is afer the ">",
5257 * the completion results will provide, e.g., the members of the struct that
5258 * "p" points to. The client is responsible for placing the cursor at the
5259 * beginning of the token currently being typed, then filtering the results
5260 * based on the contents of the token. For example, when code-completing for
5261 * the expression \c p->get, the client should provide the location just after
5262 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
5263 * client can filter the results based on the current token text ("get"), only
5264 * showing those results that start with "get". The intent of this interface
5265 * is to separate the relatively high-latency acquisition of code-completion
5266 * results from the filtering of results on a per-character basis, which must
5267 * have a lower latency.
5269 * \param TU The translation unit in which code-completion should
5270 * occur. The source files for this translation unit need not be
5271 * completely up-to-date (and the contents of those source files may
5272 * be overridden via \p unsaved_files). Cursors referring into the
5273 * translation unit may be invalidated by this invocation.
5275 * \param complete_filename The name of the source file where code
5276 * completion should be performed. This filename may be any file
5277 * included in the translation unit.
5279 * \param complete_line The line at which code-completion should occur.
5281 * \param complete_column The column at which code-completion should occur.
5282 * Note that the column should point just after the syntactic construct that
5283 * initiated code completion, and not in the middle of a lexical token.
5285 * \param unsaved_files the Files that have not yet been saved to disk
5286 * but may be required for parsing or code completion, including the
5287 * contents of those files. The contents and name of these files (as
5288 * specified by CXUnsavedFile) are copied when necessary, so the
5289 * client only needs to guarantee their validity until the call to
5290 * this function returns.
5292 * \param num_unsaved_files The number of unsaved file entries in \p
5295 * \param options Extra options that control the behavior of code
5296 * completion, expressed as a bitwise OR of the enumerators of the
5297 * CXCodeComplete_Flags enumeration. The
5298 * \c clang_defaultCodeCompleteOptions() function returns a default set
5299 * of code-completion options.
5301 * \returns If successful, a new \c CXCodeCompleteResults structure
5302 * containing code-completion results, which should eventually be
5303 * freed with \c clang_disposeCodeCompleteResults(). If code
5304 * completion fails, returns NULL.
5307 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
5308 const char *complete_filename,
5309 unsigned complete_line,
5310 unsigned complete_column,
5311 struct CXUnsavedFile *unsaved_files,
5312 unsigned num_unsaved_files,
5316 * \brief Sort the code-completion results in case-insensitive alphabetical
5319 * \param Results The set of results to sort.
5320 * \param NumResults The number of results in \p Results.
5323 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
5324 unsigned NumResults);
5327 * \brief Free the given set of code-completion results.
5330 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
5333 * \brief Determine the number of diagnostics produced prior to the
5334 * location where code completion was performed.
5337 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
5340 * \brief Retrieve a diagnostic associated with the given code completion.
5342 * \param Results the code completion results to query.
5343 * \param Index the zero-based diagnostic number to retrieve.
5345 * \returns the requested diagnostic. This diagnostic must be freed
5346 * via a call to \c clang_disposeDiagnostic().
5349 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
5353 * \brief Determines what completions are appropriate for the context
5354 * the given code completion.
5356 * \param Results the code completion results to query
5358 * \returns the kinds of completions that are appropriate for use
5359 * along with the given code completion results.
5362 unsigned long long clang_codeCompleteGetContexts(
5363 CXCodeCompleteResults *Results);
5366 * \brief Returns the cursor kind for the container for the current code
5367 * completion context. The container is only guaranteed to be set for
5368 * contexts where a container exists (i.e. member accesses or Objective-C
5369 * message sends); if there is not a container, this function will return
5370 * CXCursor_InvalidCode.
5372 * \param Results the code completion results to query
5374 * \param IsIncomplete on return, this value will be false if Clang has complete
5375 * information about the container. If Clang does not have complete
5376 * information, this value will be true.
5378 * \returns the container kind, or CXCursor_InvalidCode if there is not a
5382 enum CXCursorKind clang_codeCompleteGetContainerKind(
5383 CXCodeCompleteResults *Results,
5384 unsigned *IsIncomplete);
5387 * \brief Returns the USR for the container for the current code completion
5388 * context. If there is not a container for the current context, this
5389 * function will return the empty string.
5391 * \param Results the code completion results to query
5393 * \returns the USR for the container
5396 CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
5399 * \brief Returns the currently-entered selector for an Objective-C message
5400 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5401 * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5402 * CXCompletionContext_ObjCClassMessage.
5404 * \param Results the code completion results to query
5406 * \returns the selector (or partial selector) that has been entered thus far
5407 * for an Objective-C message send.
5410 CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
5417 * \defgroup CINDEX_MISC Miscellaneous utility functions
5423 * \brief Return a version string, suitable for showing to a user, but not
5424 * intended to be parsed (the format is not guaranteed to be stable).
5426 CINDEX_LINKAGE CXString clang_getClangVersion(void);
5429 * \brief Enable/disable crash recovery.
5431 * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5432 * value enables crash recovery, while 0 disables it.
5434 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
5437 * \brief Visitor invoked for each file in a translation unit
5438 * (used with clang_getInclusions()).
5440 * This visitor function will be invoked by clang_getInclusions() for each
5441 * file included (either at the top-level or by \#include directives) within
5442 * a translation unit. The first argument is the file being included, and
5443 * the second and third arguments provide the inclusion stack. The
5444 * array is sorted in order of immediate inclusion. For example,
5445 * the first element refers to the location that included 'included_file'.
5447 typedef void (*CXInclusionVisitor)(CXFile included_file,
5448 CXSourceLocation* inclusion_stack,
5449 unsigned include_len,
5450 CXClientData client_data);
5453 * \brief Visit the set of preprocessor inclusions in a translation unit.
5454 * The visitor function is called with the provided data for every included
5455 * file. This does not include headers included by the PCH file (unless one
5456 * is inspecting the inclusions in the PCH file itself).
5458 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5459 CXInclusionVisitor visitor,
5460 CXClientData client_data);
5465 CXEval_ObjCStrLiteral = 3,
5466 CXEval_StrLiteral = 4,
5470 CXEval_UnExposed = 0
5472 } CXEvalResultKind ;
5475 * \brief Evaluation result of a cursor
5477 typedef void * CXEvalResult;
5480 * \brief If cursor is a statement declaration tries to evaluate the
5481 * statement and if its variable, tries to evaluate its initializer,
5482 * into its corresponding type.
5484 CINDEX_LINKAGE CXEvalResult clang_Cursor_Evaluate(CXCursor C);
5487 * \brief Returns the kind of the evaluated result.
5489 CINDEX_LINKAGE CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E);
5492 * \brief Returns the evaluation result as integer if the
5495 CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
5498 * \brief Returns the evaluation result as a long long integer if the
5499 * kind is Int. This prevents overflows that may happen if the result is
5500 * returned with clang_EvalResult_getAsInt.
5502 CINDEX_LINKAGE long long clang_EvalResult_getAsLongLong(CXEvalResult E);
5505 * \brief Returns a non-zero value if the kind is Int and the evaluation
5506 * result resulted in an unsigned integer.
5508 CINDEX_LINKAGE unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E);
5511 * \brief Returns the evaluation result as an unsigned integer if
5512 * the kind is Int and clang_EvalResult_isUnsignedInt is non-zero.
5514 CINDEX_LINKAGE unsigned long long clang_EvalResult_getAsUnsigned(CXEvalResult E);
5517 * \brief Returns the evaluation result as double if the
5520 CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
5523 * \brief Returns the evaluation result as a constant string if the
5524 * kind is other than Int or float. User must not free this pointer,
5525 * instead call clang_EvalResult_dispose on the CXEvalResult returned
5526 * by clang_Cursor_Evaluate.
5528 CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
5531 * \brief Disposes the created Eval memory.
5533 CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
5538 /** \defgroup CINDEX_REMAPPING Remapping functions
5544 * \brief A remapping of original source files and their translated files.
5546 typedef void *CXRemapping;
5549 * \brief Retrieve a remapping.
5551 * \param path the path that contains metadata about remappings.
5553 * \returns the requested remapping. This remapping must be freed
5554 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5556 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5559 * \brief Retrieve a remapping.
5561 * \param filePaths pointer to an array of file paths containing remapping info.
5563 * \param numFiles number of file paths.
5565 * \returns the requested remapping. This remapping must be freed
5566 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5569 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5573 * \brief Determine the number of remappings.
5575 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5578 * \brief Get the original and the associated filename from the remapping.
5580 * \param original If non-NULL, will be set to the original filename.
5582 * \param transformed If non-NULL, will be set to the filename that the original
5583 * is associated with.
5585 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5586 CXString *original, CXString *transformed);
5589 * \brief Dispose the remapping.
5591 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5597 /** \defgroup CINDEX_HIGH Higher level API functions
5602 enum CXVisitorResult {
5607 typedef struct CXCursorAndRangeVisitor {
5609 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5610 } CXCursorAndRangeVisitor;
5614 * \brief Function returned successfully.
5616 CXResult_Success = 0,
5618 * \brief One of the parameters was invalid for the function.
5620 CXResult_Invalid = 1,
5622 * \brief The function was terminated by a callback (e.g. it returned
5625 CXResult_VisitBreak = 2
5630 * \brief Find references of a declaration in a specific file.
5632 * \param cursor pointing to a declaration or a reference of one.
5634 * \param file to search for references.
5636 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5637 * each reference found.
5638 * The CXSourceRange will point inside the file; if the reference is inside
5639 * a macro (and not a macro argument) the CXSourceRange will be invalid.
5641 * \returns one of the CXResult enumerators.
5643 CINDEX_LINKAGE CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file,
5644 CXCursorAndRangeVisitor visitor);
5647 * \brief Find #import/#include directives in a specific file.
5649 * \param TU translation unit containing the file to query.
5651 * \param file to search for #import/#include directives.
5653 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5654 * each directive found.
5656 * \returns one of the CXResult enumerators.
5658 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5660 CXCursorAndRangeVisitor visitor);
5662 #ifdef __has_feature
5663 # if __has_feature(blocks)
5665 typedef enum CXVisitorResult
5666 (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5669 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5670 CXCursorAndRangeVisitorBlock);
5673 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5674 CXCursorAndRangeVisitorBlock);
5680 * \brief The client's data object that is associated with a CXFile.
5682 typedef void *CXIdxClientFile;
5685 * \brief The client's data object that is associated with a semantic entity.
5687 typedef void *CXIdxClientEntity;
5690 * \brief The client's data object that is associated with a semantic container
5693 typedef void *CXIdxClientContainer;
5696 * \brief The client's data object that is associated with an AST file (PCH
5699 typedef void *CXIdxClientASTFile;
5702 * \brief Source location passed to index callbacks.
5710 * \brief Data for ppIncludedFile callback.
5714 * \brief Location of '#' in the \#include/\#import directive.
5718 * \brief Filename as written in the \#include/\#import directive.
5720 const char *filename;
5722 * \brief The actual file that the \#include/\#import directive resolved to.
5728 * \brief Non-zero if the directive was automatically turned into a module
5732 } CXIdxIncludedFileInfo;
5735 * \brief Data for IndexerCallbacks#importedASTFile.
5739 * \brief Top level AST file containing the imported PCH, module or submodule.
5743 * \brief The imported module or NULL if the AST file is a PCH.
5747 * \brief Location where the file is imported. Applicable only for modules.
5751 * \brief Non-zero if an inclusion directive was automatically turned into
5752 * a module import. Applicable only for modules.
5756 } CXIdxImportedASTFileInfo;
5759 CXIdxEntity_Unexposed = 0,
5760 CXIdxEntity_Typedef = 1,
5761 CXIdxEntity_Function = 2,
5762 CXIdxEntity_Variable = 3,
5763 CXIdxEntity_Field = 4,
5764 CXIdxEntity_EnumConstant = 5,
5766 CXIdxEntity_ObjCClass = 6,
5767 CXIdxEntity_ObjCProtocol = 7,
5768 CXIdxEntity_ObjCCategory = 8,
5770 CXIdxEntity_ObjCInstanceMethod = 9,
5771 CXIdxEntity_ObjCClassMethod = 10,
5772 CXIdxEntity_ObjCProperty = 11,
5773 CXIdxEntity_ObjCIvar = 12,
5775 CXIdxEntity_Enum = 13,
5776 CXIdxEntity_Struct = 14,
5777 CXIdxEntity_Union = 15,
5779 CXIdxEntity_CXXClass = 16,
5780 CXIdxEntity_CXXNamespace = 17,
5781 CXIdxEntity_CXXNamespaceAlias = 18,
5782 CXIdxEntity_CXXStaticVariable = 19,
5783 CXIdxEntity_CXXStaticMethod = 20,
5784 CXIdxEntity_CXXInstanceMethod = 21,
5785 CXIdxEntity_CXXConstructor = 22,
5786 CXIdxEntity_CXXDestructor = 23,
5787 CXIdxEntity_CXXConversionFunction = 24,
5788 CXIdxEntity_CXXTypeAlias = 25,
5789 CXIdxEntity_CXXInterface = 26
5794 CXIdxEntityLang_None = 0,
5795 CXIdxEntityLang_C = 1,
5796 CXIdxEntityLang_ObjC = 2,
5797 CXIdxEntityLang_CXX = 3,
5798 CXIdxEntityLang_Swift = 4
5799 } CXIdxEntityLanguage;
5802 * \brief Extra C++ template information for an entity. This can apply to:
5803 * CXIdxEntity_Function
5804 * CXIdxEntity_CXXClass
5805 * CXIdxEntity_CXXStaticMethod
5806 * CXIdxEntity_CXXInstanceMethod
5807 * CXIdxEntity_CXXConstructor
5808 * CXIdxEntity_CXXConversionFunction
5809 * CXIdxEntity_CXXTypeAlias
5812 CXIdxEntity_NonTemplate = 0,
5813 CXIdxEntity_Template = 1,
5814 CXIdxEntity_TemplatePartialSpecialization = 2,
5815 CXIdxEntity_TemplateSpecialization = 3
5816 } CXIdxEntityCXXTemplateKind;
5819 CXIdxAttr_Unexposed = 0,
5820 CXIdxAttr_IBAction = 1,
5821 CXIdxAttr_IBOutlet = 2,
5822 CXIdxAttr_IBOutletCollection = 3
5832 CXIdxEntityKind kind;
5833 CXIdxEntityCXXTemplateKind templateKind;
5834 CXIdxEntityLanguage lang;
5838 const CXIdxAttrInfo *const *attributes;
5839 unsigned numAttributes;
5844 } CXIdxContainerInfo;
5847 const CXIdxAttrInfo *attrInfo;
5848 const CXIdxEntityInfo *objcClass;
5849 CXCursor classCursor;
5851 } CXIdxIBOutletCollectionAttrInfo;
5854 CXIdxDeclFlag_Skipped = 0x1
5855 } CXIdxDeclInfoFlags;
5858 const CXIdxEntityInfo *entityInfo;
5861 const CXIdxContainerInfo *semanticContainer;
5863 * \brief Generally same as #semanticContainer but can be different in
5864 * cases like out-of-line C++ member functions.
5866 const CXIdxContainerInfo *lexicalContainer;
5867 int isRedeclaration;
5870 const CXIdxContainerInfo *declAsContainer;
5872 * \brief Whether the declaration exists in code or was created implicitly
5873 * by the compiler, e.g. implicit Objective-C methods for properties.
5876 const CXIdxAttrInfo *const *attributes;
5877 unsigned numAttributes;
5884 CXIdxObjCContainer_ForwardRef = 0,
5885 CXIdxObjCContainer_Interface = 1,
5886 CXIdxObjCContainer_Implementation = 2
5887 } CXIdxObjCContainerKind;
5890 const CXIdxDeclInfo *declInfo;
5891 CXIdxObjCContainerKind kind;
5892 } CXIdxObjCContainerDeclInfo;
5895 const CXIdxEntityInfo *base;
5898 } CXIdxBaseClassInfo;
5901 const CXIdxEntityInfo *protocol;
5904 } CXIdxObjCProtocolRefInfo;
5907 const CXIdxObjCProtocolRefInfo *const *protocols;
5908 unsigned numProtocols;
5909 } CXIdxObjCProtocolRefListInfo;
5912 const CXIdxObjCContainerDeclInfo *containerInfo;
5913 const CXIdxBaseClassInfo *superInfo;
5914 const CXIdxObjCProtocolRefListInfo *protocols;
5915 } CXIdxObjCInterfaceDeclInfo;
5918 const CXIdxObjCContainerDeclInfo *containerInfo;
5919 const CXIdxEntityInfo *objcClass;
5920 CXCursor classCursor;
5922 const CXIdxObjCProtocolRefListInfo *protocols;
5923 } CXIdxObjCCategoryDeclInfo;
5926 const CXIdxDeclInfo *declInfo;
5927 const CXIdxEntityInfo *getter;
5928 const CXIdxEntityInfo *setter;
5929 } CXIdxObjCPropertyDeclInfo;
5932 const CXIdxDeclInfo *declInfo;
5933 const CXIdxBaseClassInfo *const *bases;
5935 } CXIdxCXXClassDeclInfo;
5938 * \brief Data for IndexerCallbacks#indexEntityReference.
5942 * \brief The entity is referenced directly in user's code.
5944 CXIdxEntityRef_Direct = 1,
5946 * \brief An implicit reference, e.g. a reference of an Objective-C method
5947 * via the dot syntax.
5949 CXIdxEntityRef_Implicit = 2
5950 } CXIdxEntityRefKind;
5953 * \brief Data for IndexerCallbacks#indexEntityReference.
5956 CXIdxEntityRefKind kind;
5958 * \brief Reference cursor.
5963 * \brief The entity that gets referenced.
5965 const CXIdxEntityInfo *referencedEntity;
5967 * \brief Immediate "parent" of the reference. For example:
5973 * The parent of reference of type 'Foo' is the variable 'var'.
5974 * For references inside statement bodies of functions/methods,
5975 * the parentEntity will be the function/method.
5977 const CXIdxEntityInfo *parentEntity;
5979 * \brief Lexical container context of the reference.
5981 const CXIdxContainerInfo *container;
5982 } CXIdxEntityRefInfo;
5985 * \brief A group of callbacks used by #clang_indexSourceFile and
5986 * #clang_indexTranslationUnit.
5990 * \brief Called periodically to check whether indexing should be aborted.
5991 * Should return 0 to continue, and non-zero to abort.
5993 int (*abortQuery)(CXClientData client_data, void *reserved);
5996 * \brief Called at the end of indexing; passes the complete diagnostic set.
5998 void (*diagnostic)(CXClientData client_data,
5999 CXDiagnosticSet, void *reserved);
6001 CXIdxClientFile (*enteredMainFile)(CXClientData client_data,
6002 CXFile mainFile, void *reserved);
6005 * \brief Called when a file gets \#included/\#imported.
6007 CXIdxClientFile (*ppIncludedFile)(CXClientData client_data,
6008 const CXIdxIncludedFileInfo *);
6011 * \brief Called when a AST file (PCH or module) gets imported.
6013 * AST files will not get indexed (there will not be callbacks to index all
6014 * the entities in an AST file). The recommended action is that, if the AST
6015 * file is not already indexed, to initiate a new indexing job specific to
6018 CXIdxClientASTFile (*importedASTFile)(CXClientData client_data,
6019 const CXIdxImportedASTFileInfo *);
6022 * \brief Called at the beginning of indexing a translation unit.
6024 CXIdxClientContainer (*startedTranslationUnit)(CXClientData client_data,
6027 void (*indexDeclaration)(CXClientData client_data,
6028 const CXIdxDeclInfo *);
6031 * \brief Called to index a reference of an entity.
6033 void (*indexEntityReference)(CXClientData client_data,
6034 const CXIdxEntityRefInfo *);
6038 CINDEX_LINKAGE int clang_index_isEntityObjCContainerKind(CXIdxEntityKind);
6039 CINDEX_LINKAGE const CXIdxObjCContainerDeclInfo *
6040 clang_index_getObjCContainerDeclInfo(const CXIdxDeclInfo *);
6042 CINDEX_LINKAGE const CXIdxObjCInterfaceDeclInfo *
6043 clang_index_getObjCInterfaceDeclInfo(const CXIdxDeclInfo *);
6046 const CXIdxObjCCategoryDeclInfo *
6047 clang_index_getObjCCategoryDeclInfo(const CXIdxDeclInfo *);
6049 CINDEX_LINKAGE const CXIdxObjCProtocolRefListInfo *
6050 clang_index_getObjCProtocolRefListInfo(const CXIdxDeclInfo *);
6052 CINDEX_LINKAGE const CXIdxObjCPropertyDeclInfo *
6053 clang_index_getObjCPropertyDeclInfo(const CXIdxDeclInfo *);
6055 CINDEX_LINKAGE const CXIdxIBOutletCollectionAttrInfo *
6056 clang_index_getIBOutletCollectionAttrInfo(const CXIdxAttrInfo *);
6058 CINDEX_LINKAGE const CXIdxCXXClassDeclInfo *
6059 clang_index_getCXXClassDeclInfo(const CXIdxDeclInfo *);
6062 * \brief For retrieving a custom CXIdxClientContainer attached to a
6065 CINDEX_LINKAGE CXIdxClientContainer
6066 clang_index_getClientContainer(const CXIdxContainerInfo *);
6069 * \brief For setting a custom CXIdxClientContainer attached to a
6073 clang_index_setClientContainer(const CXIdxContainerInfo *,CXIdxClientContainer);
6076 * \brief For retrieving a custom CXIdxClientEntity attached to an entity.
6078 CINDEX_LINKAGE CXIdxClientEntity
6079 clang_index_getClientEntity(const CXIdxEntityInfo *);
6082 * \brief For setting a custom CXIdxClientEntity attached to an entity.
6085 clang_index_setClientEntity(const CXIdxEntityInfo *, CXIdxClientEntity);
6088 * \brief An indexing action/session, to be applied to one or multiple
6089 * translation units.
6091 typedef void *CXIndexAction;
6094 * \brief An indexing action/session, to be applied to one or multiple
6095 * translation units.
6097 * \param CIdx The index object with which the index action will be associated.
6099 CINDEX_LINKAGE CXIndexAction clang_IndexAction_create(CXIndex CIdx);
6102 * \brief Destroy the given index action.
6104 * The index action must not be destroyed until all of the translation units
6105 * created within that index action have been destroyed.
6107 CINDEX_LINKAGE void clang_IndexAction_dispose(CXIndexAction);
6111 * \brief Used to indicate that no special indexing options are needed.
6113 CXIndexOpt_None = 0x0,
6116 * \brief Used to indicate that IndexerCallbacks#indexEntityReference should
6117 * be invoked for only one reference of an entity per source file that does
6118 * not also include a declaration/definition of the entity.
6120 CXIndexOpt_SuppressRedundantRefs = 0x1,
6123 * \brief Function-local symbols should be indexed. If this is not set
6124 * function-local symbols will be ignored.
6126 CXIndexOpt_IndexFunctionLocalSymbols = 0x2,
6129 * \brief Implicit function/class template instantiations should be indexed.
6130 * If this is not set, implicit instantiations will be ignored.
6132 CXIndexOpt_IndexImplicitTemplateInstantiations = 0x4,
6135 * \brief Suppress all compiler warnings when parsing for indexing.
6137 CXIndexOpt_SuppressWarnings = 0x8,
6140 * \brief Skip a function/method body that was already parsed during an
6141 * indexing session associated with a \c CXIndexAction object.
6142 * Bodies in system headers are always skipped.
6144 CXIndexOpt_SkipParsedBodiesInSession = 0x10
6149 * \brief Index the given source file and the translation unit corresponding
6150 * to that file via callbacks implemented through #IndexerCallbacks.
6152 * \param client_data pointer data supplied by the client, which will
6153 * be passed to the invoked callbacks.
6155 * \param index_callbacks Pointer to indexing callbacks that the client
6158 * \param index_callbacks_size Size of #IndexerCallbacks structure that gets
6159 * passed in index_callbacks.
6161 * \param index_options A bitmask of options that affects how indexing is
6162 * performed. This should be a bitwise OR of the CXIndexOpt_XXX flags.
6164 * \param[out] out_TU pointer to store a \c CXTranslationUnit that can be
6165 * reused after indexing is finished. Set to \c NULL if you do not require it.
6167 * \returns 0 on success or if there were errors from which the compiler could
6168 * recover. If there is a failure from which there is no recovery, returns
6169 * a non-zero \c CXErrorCode.
6171 * The rest of the parameters are the same as #clang_parseTranslationUnit.
6173 CINDEX_LINKAGE int clang_indexSourceFile(CXIndexAction,
6174 CXClientData client_data,
6175 IndexerCallbacks *index_callbacks,
6176 unsigned index_callbacks_size,
6177 unsigned index_options,
6178 const char *source_filename,
6179 const char * const *command_line_args,
6180 int num_command_line_args,
6181 struct CXUnsavedFile *unsaved_files,
6182 unsigned num_unsaved_files,
6183 CXTranslationUnit *out_TU,
6184 unsigned TU_options);
6187 * \brief Same as clang_indexSourceFile but requires a full command line
6188 * for \c command_line_args including argv[0]. This is useful if the standard
6189 * library paths are relative to the binary.
6191 CINDEX_LINKAGE int clang_indexSourceFileFullArgv(
6192 CXIndexAction, CXClientData client_data, IndexerCallbacks *index_callbacks,
6193 unsigned index_callbacks_size, unsigned index_options,
6194 const char *source_filename, const char *const *command_line_args,
6195 int num_command_line_args, struct CXUnsavedFile *unsaved_files,
6196 unsigned num_unsaved_files, CXTranslationUnit *out_TU, unsigned TU_options);
6199 * \brief Index the given translation unit via callbacks implemented through
6200 * #IndexerCallbacks.
6202 * The order of callback invocations is not guaranteed to be the same as
6203 * when indexing a source file. The high level order will be:
6205 * -Preprocessor callbacks invocations
6206 * -Declaration/reference callbacks invocations
6207 * -Diagnostic callback invocations
6209 * The parameters are the same as #clang_indexSourceFile.
6211 * \returns If there is a failure from which there is no recovery, returns
6212 * non-zero, otherwise returns 0.
6214 CINDEX_LINKAGE int clang_indexTranslationUnit(CXIndexAction,
6215 CXClientData client_data,
6216 IndexerCallbacks *index_callbacks,
6217 unsigned index_callbacks_size,
6218 unsigned index_options,
6222 * \brief Retrieve the CXIdxFile, file, line, column, and offset represented by
6223 * the given CXIdxLoc.
6225 * If the location refers into a macro expansion, retrieves the
6226 * location of the macro expansion and if it refers into a macro argument
6227 * retrieves the location of the argument.
6229 CINDEX_LINKAGE void clang_indexLoc_getFileLocation(CXIdxLoc loc,
6230 CXIdxClientFile *indexFile,
6237 * \brief Retrieve the CXSourceLocation represented by the given CXIdxLoc.
6240 CXSourceLocation clang_indexLoc_getCXSourceLocation(CXIdxLoc loc);
6243 * \brief Visitor invoked for each field found by a traversal.
6245 * This visitor function will be invoked for each field found by
6246 * \c clang_Type_visitFields. Its first argument is the cursor being
6247 * visited, its second argument is the client data provided to
6248 * \c clang_Type_visitFields.
6250 * The visitor should return one of the \c CXVisitorResult values
6251 * to direct \c clang_Type_visitFields.
6253 typedef enum CXVisitorResult (*CXFieldVisitor)(CXCursor C,
6254 CXClientData client_data);
6257 * \brief Visit the fields of a particular type.
6259 * This function visits all the direct fields of the given cursor,
6260 * invoking the given \p visitor function with the cursors of each
6261 * visited field. The traversal may be ended prematurely, if
6262 * the visitor returns \c CXFieldVisit_Break.
6264 * \param T the record type whose field may be visited.
6266 * \param visitor the visitor function that will be invoked for each
6269 * \param client_data pointer data supplied by the client, which will
6270 * be passed to the visitor each time it is invoked.
6272 * \returns a non-zero value if the traversal was terminated
6273 * prematurely by the visitor returning \c CXFieldVisit_Break.
6275 CINDEX_LINKAGE unsigned clang_Type_visitFields(CXType T,
6276 CXFieldVisitor visitor,
6277 CXClientData client_data);