1 /*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header provides a public inferface to a Clang library for extracting *|
11 |* high-level symbol information from source files without exposing the full *|
14 \*===----------------------------------------------------------------------===*/
16 #ifndef CLANG_C_INDEX_H
17 #define CLANG_C_INDEX_H
27 /* MSVC DLL import/export. */
30 #define CINDEX_LINKAGE __declspec(dllexport)
32 #define CINDEX_LINKAGE __declspec(dllimport)
35 #define CINDEX_LINKAGE
38 /** \defgroup CINDEX libclang: C Interface to Clang
40 * The C Interface to Clang provides a relatively small API that exposes
41 * facilities for parsing source code into an abstract syntax tree (AST),
42 * loading already-parsed ASTs, traversing the AST, associating
43 * physical source locations with elements within the AST, and other
44 * facilities that support Clang-based development tools.
46 * This C interface to Clang will never provide all of the information
47 * representation stored in Clang's C++ AST, nor should it: the intent is to
48 * maintain an API that is relatively stable from one release to the next,
49 * providing only the basic functionality needed to support development tools.
51 * To avoid namespace pollution, data types are prefixed with "CX" and
52 * functions are prefixed with "clang_".
58 * \brief An "index" that consists of a set of translation units that would
59 * typically be linked together into an executable or library.
61 typedef void *CXIndex;
64 * \brief A single translation unit, which resides in an index.
66 typedef struct CXTranslationUnitImpl *CXTranslationUnit;
69 * \brief Opaque pointer representing client data that will be passed through
70 * to various callbacks and visitors.
72 typedef void *CXClientData;
75 * \brief Provides the contents of a file that has not yet been saved to disk.
77 * Each CXUnsavedFile instance provides the name of a file on the
78 * system along with the current contents of that file that have not
79 * yet been saved to disk.
81 struct CXUnsavedFile {
83 * \brief The file whose contents have not yet been saved.
85 * This file must already exist in the file system.
90 * \brief A buffer containing the unsaved contents of this file.
95 * \brief The length of the unsaved contents of this buffer.
101 * \brief Describes the availability of a particular entity, which indicates
102 * whether the use of this entity will result in a warning or error due to
103 * it being deprecated or unavailable.
105 enum CXAvailabilityKind {
107 * \brief The entity is available.
109 CXAvailability_Available,
111 * \brief The entity is available, but has been deprecated (and its use is
114 CXAvailability_Deprecated,
116 * \brief The entity is not available; any use of it will be an error.
118 CXAvailability_NotAvailable,
120 * \brief The entity is available, but not accessible; any use of it will be
123 CXAvailability_NotAccessible
127 * \defgroup CINDEX_STRING String manipulation routines
133 * \brief A character string.
135 * The \c CXString type is used to return strings from the interface when
136 * the ownership of that string might different from one call to the next.
137 * Use \c clang_getCString() to retrieve the string data and, once finished
138 * with the string data, call \c clang_disposeString() to free the string.
142 unsigned private_flags;
146 * \brief Retrieve the character data associated with the given string.
148 CINDEX_LINKAGE const char *clang_getCString(CXString string);
151 * \brief Free the given string,
153 CINDEX_LINKAGE void clang_disposeString(CXString string);
160 * \brief clang_createIndex() provides a shared context for creating
161 * translation units. It provides two options:
163 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
164 * declarations (when loading any new translation units). A "local" declaration
165 * is one that belongs in the translation unit itself and not in a precompiled
166 * header that was used by the translation unit. If zero, all declarations
167 * will be enumerated.
169 * Here is an example:
171 * // excludeDeclsFromPCH = 1, displayDiagnostics=1
172 * Idx = clang_createIndex(1, 1);
174 * // IndexTest.pch was produced with the following command:
175 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
176 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
178 * // This will load all the symbols from 'IndexTest.pch'
179 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
180 * TranslationUnitVisitor, 0);
181 * clang_disposeTranslationUnit(TU);
183 * // This will load all the symbols from 'IndexTest.c', excluding symbols
184 * // from 'IndexTest.pch'.
185 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
186 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
188 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
189 * TranslationUnitVisitor, 0);
190 * clang_disposeTranslationUnit(TU);
192 * This process of creating the 'pch', loading it separately, and using it (via
193 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
194 * (which gives the indexer the same performance benefit as the compiler).
196 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
197 int displayDiagnostics);
200 * \brief Destroy the given index.
202 * The index must not be destroyed until all of the translation units created
203 * within that index have been destroyed.
205 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
208 * \defgroup CINDEX_FILES File manipulation routines
214 * \brief A particular source file that is part of a translation unit.
216 typedef void *CXFile;
220 * \brief Retrieve the complete file and path name of the given file.
222 CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
225 * \brief Retrieve the last modification time of the given file.
227 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
230 * \brief Determine whether the given header is guarded against
231 * multiple inclusions, either with the conventional
232 * #ifndef/#define/#endif macro guards or with #pragma once.
234 CINDEX_LINKAGE unsigned
235 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
238 * \brief Retrieve a file handle within the given translation unit.
240 * \param tu the translation unit
242 * \param file_name the name of the file.
244 * \returns the file handle for the named file in the translation unit \p tu,
245 * or a NULL file handle if the file was not a part of this translation unit.
247 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
248 const char *file_name);
255 * \defgroup CINDEX_LOCATIONS Physical source locations
257 * Clang represents physical source locations in its abstract syntax tree in
258 * great detail, with file, line, and column information for the majority of
259 * the tokens parsed in the source code. These data types and functions are
260 * used to represent source location information, either for a particular
261 * point in the program or for a range of points in the program, and extract
262 * specific location information from those data types.
268 * \brief Identifies a specific source location within a translation
271 * Use clang_getExpansionLocation() or clang_getSpellingLocation()
272 * to map a source location to a particular file, line, and column.
280 * \brief Identifies a half-open character range in the source code.
282 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
283 * starting and end locations from a source range, respectively.
287 unsigned begin_int_data;
288 unsigned end_int_data;
292 * \brief Retrieve a NULL (invalid) source location.
294 CINDEX_LINKAGE CXSourceLocation clang_getNullLocation();
297 * \determine Determine whether two source locations, which must refer into
298 * the same translation unit, refer to exactly the same point in the source
301 * \returns non-zero if the source locations refer to the same location, zero
302 * if they refer to different locations.
304 CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
305 CXSourceLocation loc2);
308 * \brief Retrieves the source location associated with a given file/line/column
309 * in a particular translation unit.
311 CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
316 * \brief Retrieves the source location associated with a given character offset
317 * in a particular translation unit.
319 CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
324 * \brief Retrieve a NULL (invalid) source range.
326 CINDEX_LINKAGE CXSourceRange clang_getNullRange();
329 * \brief Retrieve a source range given the beginning and ending source
332 CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
333 CXSourceLocation end);
336 * \brief Determine whether two ranges are equivalent.
338 * \returns non-zero if the ranges are the same, zero if they differ.
340 CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
341 CXSourceRange range2);
344 * \brief Returns non-zero if \arg range is null.
346 CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
349 * \brief Retrieve the file, line, column, and offset represented by
350 * the given source location.
352 * If the location refers into a macro expansion, retrieves the
353 * location of the macro expansion.
355 * \param location the location within a source file that will be decomposed
358 * \param file [out] if non-NULL, will be set to the file to which the given
359 * source location points.
361 * \param line [out] if non-NULL, will be set to the line to which the given
362 * source location points.
364 * \param column [out] if non-NULL, will be set to the column to which the given
365 * source location points.
367 * \param offset [out] if non-NULL, will be set to the offset into the
368 * buffer to which the given source location points.
370 CINDEX_LINKAGE void clang_getExpansionLocation(CXSourceLocation location,
377 * \brief Retrieve the file, line, column, and offset represented by
378 * the given source location, as specified in a # line directive.
380 * Example: given the following source code in a file somefile.c
384 * static int func(void)
389 * the location information returned by this function would be
391 * File: dummy.c Line: 124 Column: 12
393 * whereas clang_getExpansionLocation would have returned
395 * File: somefile.c Line: 3 Column: 12
397 * \param location the location within a source file that will be decomposed
400 * \param filename [out] if non-NULL, will be set to the filename of the
401 * source location. Note that filenames returned will be for "virtual" files,
402 * which don't necessarily exist on the machine running clang - e.g. when
403 * parsing preprocessed output obtained from a different environment. If
404 * a non-NULL value is passed in, remember to dispose of the returned value
405 * using \c clang_disposeString() once you've finished with it. For an invalid
406 * source location, an empty string is returned.
408 * \param line [out] if non-NULL, will be set to the line number of the
409 * source location. For an invalid source location, zero is returned.
411 * \param column [out] if non-NULL, will be set to the column number of the
412 * source location. For an invalid source location, zero is returned.
414 CINDEX_LINKAGE void clang_getPresumedLocation(CXSourceLocation location,
420 * \brief Legacy API to retrieve the file, line, column, and offset represented
421 * by the given source location.
423 * This interface has been replaced by the newer interface
424 * \see clang_getExpansionLocation(). See that interface's documentation for
427 CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
434 * \brief Retrieve the file, line, column, and offset represented by
435 * the given source location.
437 * If the location refers into a macro instantiation, return where the
438 * location was originally spelled in the source file.
440 * \param location the location within a source file that will be decomposed
443 * \param file [out] if non-NULL, will be set to the file to which the given
444 * source location points.
446 * \param line [out] if non-NULL, will be set to the line to which the given
447 * source location points.
449 * \param column [out] if non-NULL, will be set to the column to which the given
450 * source location points.
452 * \param offset [out] if non-NULL, will be set to the offset into the
453 * buffer to which the given source location points.
455 CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
462 * \brief Retrieve a source location representing the first character within a
465 CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
468 * \brief Retrieve a source location representing the last character within a
471 CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
478 * \defgroup CINDEX_DIAG Diagnostic reporting
484 * \brief Describes the severity of a particular diagnostic.
486 enum CXDiagnosticSeverity {
488 * \brief A diagnostic that has been suppressed, e.g., by a command-line
491 CXDiagnostic_Ignored = 0,
494 * \brief This diagnostic is a note that should be attached to the
495 * previous (non-note) diagnostic.
497 CXDiagnostic_Note = 1,
500 * \brief This diagnostic indicates suspicious code that may not be
503 CXDiagnostic_Warning = 2,
506 * \brief This diagnostic indicates that the code is ill-formed.
508 CXDiagnostic_Error = 3,
511 * \brief This diagnostic indicates that the code is ill-formed such
512 * that future parser recovery is unlikely to produce useful
515 CXDiagnostic_Fatal = 4
519 * \brief A single diagnostic, containing the diagnostic's severity,
520 * location, text, source ranges, and fix-it hints.
522 typedef void *CXDiagnostic;
525 * \brief Determine the number of diagnostics produced for the given
528 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
531 * \brief Retrieve a diagnostic associated with the given translation unit.
533 * \param Unit the translation unit to query.
534 * \param Index the zero-based diagnostic number to retrieve.
536 * \returns the requested diagnostic. This diagnostic must be freed
537 * via a call to \c clang_disposeDiagnostic().
539 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
543 * \brief Destroy a diagnostic.
545 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
548 * \brief Options to control the display of diagnostics.
550 * The values in this enum are meant to be combined to customize the
551 * behavior of \c clang_displayDiagnostic().
553 enum CXDiagnosticDisplayOptions {
555 * \brief Display the source-location information where the
556 * diagnostic was located.
558 * When set, diagnostics will be prefixed by the file, line, and
559 * (optionally) column to which the diagnostic refers. For example,
562 * test.c:28: warning: extra tokens at end of #endif directive
565 * This option corresponds to the clang flag \c -fshow-source-location.
567 CXDiagnostic_DisplaySourceLocation = 0x01,
570 * \brief If displaying the source-location information of the
571 * diagnostic, also include the column number.
573 * This option corresponds to the clang flag \c -fshow-column.
575 CXDiagnostic_DisplayColumn = 0x02,
578 * \brief If displaying the source-location information of the
579 * diagnostic, also include information about source ranges in a
580 * machine-parsable format.
582 * This option corresponds to the clang flag
583 * \c -fdiagnostics-print-source-range-info.
585 CXDiagnostic_DisplaySourceRanges = 0x04,
588 * \brief Display the option name associated with this diagnostic, if any.
590 * The option name displayed (e.g., -Wconversion) will be placed in brackets
591 * after the diagnostic text. This option corresponds to the clang flag
592 * \c -fdiagnostics-show-option.
594 CXDiagnostic_DisplayOption = 0x08,
597 * \brief Display the category number associated with this diagnostic, if any.
599 * The category number is displayed within brackets after the diagnostic text.
600 * This option corresponds to the clang flag
601 * \c -fdiagnostics-show-category=id.
603 CXDiagnostic_DisplayCategoryId = 0x10,
606 * \brief Display the category name associated with this diagnostic, if any.
608 * The category name is displayed within brackets after the diagnostic text.
609 * This option corresponds to the clang flag
610 * \c -fdiagnostics-show-category=name.
612 CXDiagnostic_DisplayCategoryName = 0x20
616 * \brief Format the given diagnostic in a manner that is suitable for display.
618 * This routine will format the given diagnostic to a string, rendering
619 * the diagnostic according to the various options given. The
620 * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
621 * options that most closely mimics the behavior of the clang compiler.
623 * \param Diagnostic The diagnostic to print.
625 * \param Options A set of options that control the diagnostic display,
626 * created by combining \c CXDiagnosticDisplayOptions values.
628 * \returns A new string containing for formatted diagnostic.
630 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
634 * \brief Retrieve the set of display options most similar to the
635 * default behavior of the clang compiler.
637 * \returns A set of display options suitable for use with \c
638 * clang_displayDiagnostic().
640 CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
643 * \brief Determine the severity of the given diagnostic.
645 CINDEX_LINKAGE enum CXDiagnosticSeverity
646 clang_getDiagnosticSeverity(CXDiagnostic);
649 * \brief Retrieve the source location of the given diagnostic.
651 * This location is where Clang would print the caret ('^') when
652 * displaying the diagnostic on the command line.
654 CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
657 * \brief Retrieve the text of the given diagnostic.
659 CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
662 * \brief Retrieve the name of the command-line option that enabled this
665 * \param Diag The diagnostic to be queried.
667 * \param Disable If non-NULL, will be set to the option that disables this
668 * diagnostic (if any).
670 * \returns A string that contains the command-line option used to enable this
671 * warning, such as "-Wconversion" or "-pedantic".
673 CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
677 * \brief Retrieve the category number for this diagnostic.
679 * Diagnostics can be categorized into groups along with other, related
680 * diagnostics (e.g., diagnostics under the same warning flag). This routine
681 * retrieves the category number for the given diagnostic.
683 * \returns The number of the category that contains this diagnostic, or zero
684 * if this diagnostic is uncategorized.
686 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
689 * \brief Retrieve the name of a particular diagnostic category.
691 * \param Category A diagnostic category number, as returned by
692 * \c clang_getDiagnosticCategory().
694 * \returns The name of the given diagnostic category.
696 CINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category);
699 * \brief Determine the number of source ranges associated with the given
702 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
705 * \brief Retrieve a source range associated with the diagnostic.
707 * A diagnostic's source ranges highlight important elements in the source
708 * code. On the command line, Clang displays source ranges by
709 * underlining them with '~' characters.
711 * \param Diagnostic the diagnostic whose range is being extracted.
713 * \param Range the zero-based index specifying which range to
715 * \returns the requested source range.
717 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
721 * \brief Determine the number of fix-it hints associated with the
724 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
727 * \brief Retrieve the replacement information for a given fix-it.
729 * Fix-its are described in terms of a source range whose contents
730 * should be replaced by a string. This approach generalizes over
731 * three kinds of operations: removal of source code (the range covers
732 * the code to be removed and the replacement string is empty),
733 * replacement of source code (the range covers the code to be
734 * replaced and the replacement string provides the new code), and
735 * insertion (both the start and end of the range point at the
736 * insertion location, and the replacement string provides the text to
739 * \param Diagnostic The diagnostic whose fix-its are being queried.
741 * \param FixIt The zero-based index of the fix-it.
743 * \param ReplacementRange The source range whose contents will be
744 * replaced with the returned replacement string. Note that source
745 * ranges are half-open ranges [a, b), so the source code should be
746 * replaced from a and up to (but not including) b.
748 * \returns A string containing text that should be replace the source
749 * code indicated by the \c ReplacementRange.
751 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
753 CXSourceRange *ReplacementRange);
760 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
762 * The routines in this group provide the ability to create and destroy
763 * translation units from files, either by parsing the contents of the files or
764 * by reading in a serialized representation of a translation unit.
770 * \brief Get the original translation unit source file name.
772 CINDEX_LINKAGE CXString
773 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
776 * \brief Return the CXTranslationUnit for a given source file and the provided
777 * command line arguments one would pass to the compiler.
779 * Note: The 'source_filename' argument is optional. If the caller provides a
780 * NULL pointer, the name of the source file is expected to reside in the
781 * specified command line arguments.
783 * Note: When encountered in 'clang_command_line_args', the following options
789 * '-o <output file>' (both '-o' and '<output file>' are ignored)
791 * \param CIdx The index object with which the translation unit will be
794 * \param source_filename - The name of the source file to load, or NULL if the
795 * source file is included in \p clang_command_line_args.
797 * \param num_clang_command_line_args The number of command-line arguments in
798 * \p clang_command_line_args.
800 * \param clang_command_line_args The command-line arguments that would be
801 * passed to the \c clang executable if it were being invoked out-of-process.
802 * These command-line options will be parsed and will affect how the translation
803 * unit is parsed. Note that the following options are ignored: '-c',
804 * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'.
806 * \param num_unsaved_files the number of unsaved file entries in \p
809 * \param unsaved_files the files that have not yet been saved to disk
810 * but may be required for code completion, including the contents of
811 * those files. The contents and name of these files (as specified by
812 * CXUnsavedFile) are copied when necessary, so the client only needs to
813 * guarantee their validity until the call to this function returns.
815 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
817 const char *source_filename,
818 int num_clang_command_line_args,
819 const char * const *clang_command_line_args,
820 unsigned num_unsaved_files,
821 struct CXUnsavedFile *unsaved_files);
824 * \brief Create a translation unit from an AST file (-emit-ast).
826 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex,
827 const char *ast_filename);
830 * \brief Flags that control the creation of translation units.
832 * The enumerators in this enumeration type are meant to be bitwise
833 * ORed together to specify which options should be used when
834 * constructing the translation unit.
836 enum CXTranslationUnit_Flags {
838 * \brief Used to indicate that no special translation-unit options are
841 CXTranslationUnit_None = 0x0,
844 * \brief Used to indicate that the parser should construct a "detailed"
845 * preprocessing record, including all macro definitions and instantiations.
847 * Constructing a detailed preprocessing record requires more memory
848 * and time to parse, since the information contained in the record
849 * is usually not retained. However, it can be useful for
850 * applications that require more detailed information about the
851 * behavior of the preprocessor.
853 CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
856 * \brief Used to indicate that the translation unit is incomplete.
858 * When a translation unit is considered "incomplete", semantic
859 * analysis that is typically performed at the end of the
860 * translation unit will be suppressed. For example, this suppresses
861 * the completion of tentative declarations in C and of
862 * instantiation of implicitly-instantiation function templates in
863 * C++. This option is typically used when parsing a header with the
864 * intent of producing a precompiled header.
866 CXTranslationUnit_Incomplete = 0x02,
869 * \brief Used to indicate that the translation unit should be built with an
870 * implicit precompiled header for the preamble.
872 * An implicit precompiled header is used as an optimization when a
873 * particular translation unit is likely to be reparsed many times
874 * when the sources aren't changing that often. In this case, an
875 * implicit precompiled header will be built containing all of the
876 * initial includes at the top of the main file (what we refer to as
877 * the "preamble" of the file). In subsequent parses, if the
878 * preamble or the files in it have not changed, \c
879 * clang_reparseTranslationUnit() will re-use the implicit
880 * precompiled header to improve parsing performance.
882 CXTranslationUnit_PrecompiledPreamble = 0x04,
885 * \brief Used to indicate that the translation unit should cache some
886 * code-completion results with each reparse of the source file.
888 * Caching of code-completion results is a performance optimization that
889 * introduces some overhead to reparsing but improves the performance of
890 * code-completion operations.
892 CXTranslationUnit_CacheCompletionResults = 0x08,
894 * \brief DEPRECATED: Enable precompiled preambles in C++.
896 * Note: this is a *temporary* option that is available only while
897 * we are testing C++ precompiled preamble support. It is deprecated.
899 CXTranslationUnit_CXXPrecompiledPreamble = 0x10,
902 * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
904 * Note: this is a *temporary* option that is available only while
905 * we are testing C++ precompiled preamble support. It is deprecated.
907 CXTranslationUnit_CXXChainedPCH = 0x20,
910 * \brief Used to indicate that the "detailed" preprocessing record,
911 * if requested, should also contain nested macro expansions.
913 * Nested macro expansions (i.e., macro expansions that occur
914 * inside another macro expansion) can, in some code bases, require
915 * a large amount of storage to due preprocessor metaprogramming. Moreover,
916 * its fairly rare that this information is useful for libclang clients.
918 CXTranslationUnit_NestedMacroExpansions = 0x40,
921 * \brief Legacy name to indicate that the "detailed" preprocessing record,
922 * if requested, should contain nested macro expansions.
924 * \see CXTranslationUnit_NestedMacroExpansions for the current name for this
925 * value, and its semantics. This is just an alias.
927 CXTranslationUnit_NestedMacroInstantiations =
928 CXTranslationUnit_NestedMacroExpansions
932 * \brief Returns the set of flags that is suitable for parsing a translation
933 * unit that is being edited.
935 * The set of flags returned provide options for \c clang_parseTranslationUnit()
936 * to indicate that the translation unit is likely to be reparsed many times,
937 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
938 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
939 * set contains an unspecified set of optimizations (e.g., the precompiled
940 * preamble) geared toward improving the performance of these routines. The
941 * set of optimizations enabled may change from one version to the next.
943 CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
946 * \brief Parse the given source file and the translation unit corresponding
949 * This routine is the main entry point for the Clang C API, providing the
950 * ability to parse a source file into a translation unit that can then be
951 * queried by other functions in the API. This routine accepts a set of
952 * command-line arguments so that the compilation can be configured in the same
953 * way that the compiler is configured on the command line.
955 * \param CIdx The index object with which the translation unit will be
958 * \param source_filename The name of the source file to load, or NULL if the
959 * source file is included in \p command_line_args.
961 * \param command_line_args The command-line arguments that would be
962 * passed to the \c clang executable if it were being invoked out-of-process.
963 * These command-line options will be parsed and will affect how the translation
964 * unit is parsed. Note that the following options are ignored: '-c',
965 * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'.
967 * \param num_command_line_args The number of command-line arguments in
968 * \p command_line_args.
970 * \param unsaved_files the files that have not yet been saved to disk
971 * but may be required for parsing, including the contents of
972 * those files. The contents and name of these files (as specified by
973 * CXUnsavedFile) are copied when necessary, so the client only needs to
974 * guarantee their validity until the call to this function returns.
976 * \param num_unsaved_files the number of unsaved file entries in \p
979 * \param options A bitmask of options that affects how the translation unit
980 * is managed but not its compilation. This should be a bitwise OR of the
981 * CXTranslationUnit_XXX flags.
983 * \returns A new translation unit describing the parsed code and containing
984 * any diagnostics produced by the compiler. If there is a failure from which
985 * the compiler cannot recover, returns NULL.
987 CINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
988 const char *source_filename,
989 const char * const *command_line_args,
990 int num_command_line_args,
991 struct CXUnsavedFile *unsaved_files,
992 unsigned num_unsaved_files,
996 * \brief Flags that control how translation units are saved.
998 * The enumerators in this enumeration type are meant to be bitwise
999 * ORed together to specify which options should be used when
1000 * saving the translation unit.
1002 enum CXSaveTranslationUnit_Flags {
1004 * \brief Used to indicate that no special saving options are needed.
1006 CXSaveTranslationUnit_None = 0x0
1010 * \brief Returns the set of flags that is suitable for saving a translation
1013 * The set of flags returned provide options for
1014 * \c clang_saveTranslationUnit() by default. The returned flag
1015 * set contains an unspecified set of options that save translation units with
1016 * the most commonly-requested data.
1018 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1021 * \brief Describes the kind of error that occurred (if any) in a call to
1022 * \c clang_saveTranslationUnit().
1026 * \brief Indicates that no error occurred while saving a translation unit.
1028 CXSaveError_None = 0,
1031 * \brief Indicates that an unknown error occurred while attempting to save
1034 * This error typically indicates that file I/O failed when attempting to
1037 CXSaveError_Unknown = 1,
1040 * \brief Indicates that errors during translation prevented this attempt
1041 * to save the translation unit.
1043 * Errors that prevent the translation unit from being saved can be
1044 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1046 CXSaveError_TranslationErrors = 2,
1049 * \brief Indicates that the translation unit to be saved was somehow
1050 * invalid (e.g., NULL).
1052 CXSaveError_InvalidTU = 3
1056 * \brief Saves a translation unit into a serialized representation of
1057 * that translation unit on disk.
1059 * Any translation unit that was parsed without error can be saved
1060 * into a file. The translation unit can then be deserialized into a
1061 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1062 * if it is an incomplete translation unit that corresponds to a
1063 * header, used as a precompiled header when parsing other translation
1066 * \param TU The translation unit to save.
1068 * \param FileName The file to which the translation unit will be saved.
1070 * \param options A bitmask of options that affects how the translation unit
1071 * is saved. This should be a bitwise OR of the
1072 * CXSaveTranslationUnit_XXX flags.
1074 * \returns A value that will match one of the enumerators of the CXSaveError
1075 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1076 * saved successfully, while a non-zero value indicates that a problem occurred.
1078 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1079 const char *FileName,
1083 * \brief Destroy the specified CXTranslationUnit object.
1085 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1088 * \brief Flags that control the reparsing of translation units.
1090 * The enumerators in this enumeration type are meant to be bitwise
1091 * ORed together to specify which options should be used when
1092 * reparsing the translation unit.
1094 enum CXReparse_Flags {
1096 * \brief Used to indicate that no special reparsing options are needed.
1098 CXReparse_None = 0x0
1102 * \brief Returns the set of flags that is suitable for reparsing a translation
1105 * The set of flags returned provide options for
1106 * \c clang_reparseTranslationUnit() by default. The returned flag
1107 * set contains an unspecified set of optimizations geared toward common uses
1108 * of reparsing. The set of optimizations enabled may change from one version
1111 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1114 * \brief Reparse the source files that produced this translation unit.
1116 * This routine can be used to re-parse the source files that originally
1117 * created the given translation unit, for example because those source files
1118 * have changed (either on disk or as passed via \p unsaved_files). The
1119 * source code will be reparsed with the same command-line options as it
1120 * was originally parsed.
1122 * Reparsing a translation unit invalidates all cursors and source locations
1123 * that refer into that translation unit. This makes reparsing a translation
1124 * unit semantically equivalent to destroying the translation unit and then
1125 * creating a new translation unit with the same command-line arguments.
1126 * However, it may be more efficient to reparse a translation
1127 * unit using this routine.
1129 * \param TU The translation unit whose contents will be re-parsed. The
1130 * translation unit must originally have been built with
1131 * \c clang_createTranslationUnitFromSourceFile().
1133 * \param num_unsaved_files The number of unsaved file entries in \p
1136 * \param unsaved_files The files that have not yet been saved to disk
1137 * but may be required for parsing, including the contents of
1138 * those files. The contents and name of these files (as specified by
1139 * CXUnsavedFile) are copied when necessary, so the client only needs to
1140 * guarantee their validity until the call to this function returns.
1142 * \param options A bitset of options composed of the flags in CXReparse_Flags.
1143 * The function \c clang_defaultReparseOptions() produces a default set of
1144 * options recommended for most uses, based on the translation unit.
1146 * \returns 0 if the sources could be reparsed. A non-zero value will be
1147 * returned if reparsing was impossible, such that the translation unit is
1148 * invalid. In such cases, the only valid call for \p TU is
1149 * \c clang_disposeTranslationUnit(TU).
1151 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1152 unsigned num_unsaved_files,
1153 struct CXUnsavedFile *unsaved_files,
1157 * \brief Categorizes how memory is being used by a translation unit.
1159 enum CXTUResourceUsageKind {
1160 CXTUResourceUsage_AST = 1,
1161 CXTUResourceUsage_Identifiers = 2,
1162 CXTUResourceUsage_Selectors = 3,
1163 CXTUResourceUsage_GlobalCompletionResults = 4,
1164 CXTUResourceUsage_SourceManagerContentCache = 5,
1165 CXTUResourceUsage_AST_SideTables = 6,
1166 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
1167 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
1168 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
1169 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
1170 CXTUResourceUsage_Preprocessor = 11,
1171 CXTUResourceUsage_PreprocessingRecord = 12,
1172 CXTUResourceUsage_SourceManager_DataStructures = 13,
1173 CXTUResourceUsage_Preprocessor_HeaderSearch = 14,
1174 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
1175 CXTUResourceUsage_MEMORY_IN_BYTES_END =
1176 CXTUResourceUsage_Preprocessor_HeaderSearch,
1178 CXTUResourceUsage_First = CXTUResourceUsage_AST,
1179 CXTUResourceUsage_Last = CXTUResourceUsage_Preprocessor_HeaderSearch
1183 * \brief Returns the human-readable null-terminated C string that represents
1184 * the name of the memory category. This string should never be freed.
1187 const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
1189 typedef struct CXTUResourceUsageEntry {
1190 /* \brief The memory usage category. */
1191 enum CXTUResourceUsageKind kind;
1192 /* \brief Amount of resources used.
1193 The units will depend on the resource kind. */
1194 unsigned long amount;
1195 } CXTUResourceUsageEntry;
1198 * \brief The memory usage of a CXTranslationUnit, broken into categories.
1200 typedef struct CXTUResourceUsage {
1201 /* \brief Private data member, used for queries. */
1204 /* \brief The number of entries in the 'entries' array. */
1205 unsigned numEntries;
1207 /* \brief An array of key-value pairs, representing the breakdown of memory
1209 CXTUResourceUsageEntry *entries;
1211 } CXTUResourceUsage;
1214 * \brief Return the memory usage of a translation unit. This object
1215 * should be released with clang_disposeCXTUResourceUsage().
1217 CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
1219 CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
1226 * \brief Describes the kind of entity that a cursor refers to.
1231 * \brief A declaration whose specific kind is not exposed via this
1234 * Unexposed declarations have the same operations as any other kind
1235 * of declaration; one can extract their location information,
1236 * spelling, find their definitions, etc. However, the specific kind
1237 * of the declaration is not reported.
1239 CXCursor_UnexposedDecl = 1,
1240 /** \brief A C or C++ struct. */
1241 CXCursor_StructDecl = 2,
1242 /** \brief A C or C++ union. */
1243 CXCursor_UnionDecl = 3,
1244 /** \brief A C++ class. */
1245 CXCursor_ClassDecl = 4,
1246 /** \brief An enumeration. */
1247 CXCursor_EnumDecl = 5,
1249 * \brief A field (in C) or non-static data member (in C++) in a
1250 * struct, union, or C++ class.
1252 CXCursor_FieldDecl = 6,
1253 /** \brief An enumerator constant. */
1254 CXCursor_EnumConstantDecl = 7,
1255 /** \brief A function. */
1256 CXCursor_FunctionDecl = 8,
1257 /** \brief A variable. */
1258 CXCursor_VarDecl = 9,
1259 /** \brief A function or method parameter. */
1260 CXCursor_ParmDecl = 10,
1261 /** \brief An Objective-C @interface. */
1262 CXCursor_ObjCInterfaceDecl = 11,
1263 /** \brief An Objective-C @interface for a category. */
1264 CXCursor_ObjCCategoryDecl = 12,
1265 /** \brief An Objective-C @protocol declaration. */
1266 CXCursor_ObjCProtocolDecl = 13,
1267 /** \brief An Objective-C @property declaration. */
1268 CXCursor_ObjCPropertyDecl = 14,
1269 /** \brief An Objective-C instance variable. */
1270 CXCursor_ObjCIvarDecl = 15,
1271 /** \brief An Objective-C instance method. */
1272 CXCursor_ObjCInstanceMethodDecl = 16,
1273 /** \brief An Objective-C class method. */
1274 CXCursor_ObjCClassMethodDecl = 17,
1275 /** \brief An Objective-C @implementation. */
1276 CXCursor_ObjCImplementationDecl = 18,
1277 /** \brief An Objective-C @implementation for a category. */
1278 CXCursor_ObjCCategoryImplDecl = 19,
1279 /** \brief A typedef */
1280 CXCursor_TypedefDecl = 20,
1281 /** \brief A C++ class method. */
1282 CXCursor_CXXMethod = 21,
1283 /** \brief A C++ namespace. */
1284 CXCursor_Namespace = 22,
1285 /** \brief A linkage specification, e.g. 'extern "C"'. */
1286 CXCursor_LinkageSpec = 23,
1287 /** \brief A C++ constructor. */
1288 CXCursor_Constructor = 24,
1289 /** \brief A C++ destructor. */
1290 CXCursor_Destructor = 25,
1291 /** \brief A C++ conversion function. */
1292 CXCursor_ConversionFunction = 26,
1293 /** \brief A C++ template type parameter. */
1294 CXCursor_TemplateTypeParameter = 27,
1295 /** \brief A C++ non-type template parameter. */
1296 CXCursor_NonTypeTemplateParameter = 28,
1297 /** \brief A C++ template template parameter. */
1298 CXCursor_TemplateTemplateParameter = 29,
1299 /** \brief A C++ function template. */
1300 CXCursor_FunctionTemplate = 30,
1301 /** \brief A C++ class template. */
1302 CXCursor_ClassTemplate = 31,
1303 /** \brief A C++ class template partial specialization. */
1304 CXCursor_ClassTemplatePartialSpecialization = 32,
1305 /** \brief A C++ namespace alias declaration. */
1306 CXCursor_NamespaceAlias = 33,
1307 /** \brief A C++ using directive. */
1308 CXCursor_UsingDirective = 34,
1309 /** \brief A C++ using declaration. */
1310 CXCursor_UsingDeclaration = 35,
1311 /** \brief A C++ alias declaration */
1312 CXCursor_TypeAliasDecl = 36,
1313 /** \brief An Objective-C @synthesize definition. */
1314 CXCursor_ObjCSynthesizeDecl = 37,
1315 /** \brief An Objective-C @dynamic definition. */
1316 CXCursor_ObjCDynamicDecl = 38,
1317 /** \brief An access specifier. */
1318 CXCursor_CXXAccessSpecifier = 39,
1320 CXCursor_FirstDecl = CXCursor_UnexposedDecl,
1321 CXCursor_LastDecl = CXCursor_CXXAccessSpecifier,
1324 CXCursor_FirstRef = 40, /* Decl references */
1325 CXCursor_ObjCSuperClassRef = 40,
1326 CXCursor_ObjCProtocolRef = 41,
1327 CXCursor_ObjCClassRef = 42,
1329 * \brief A reference to a type declaration.
1331 * A type reference occurs anywhere where a type is named but not
1332 * declared. For example, given:
1335 * typedef unsigned size_type;
1339 * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1340 * while the type of the variable "size" is referenced. The cursor
1341 * referenced by the type of size is the typedef for size_type.
1343 CXCursor_TypeRef = 43,
1344 CXCursor_CXXBaseSpecifier = 44,
1346 * \brief A reference to a class template, function template, template
1347 * template parameter, or class template partial specialization.
1349 CXCursor_TemplateRef = 45,
1351 * \brief A reference to a namespace or namespace alias.
1353 CXCursor_NamespaceRef = 46,
1355 * \brief A reference to a member of a struct, union, or class that occurs in
1356 * some non-expression context, e.g., a designated initializer.
1358 CXCursor_MemberRef = 47,
1360 * \brief A reference to a labeled statement.
1362 * This cursor kind is used to describe the jump to "start_over" in the
1363 * goto statement in the following example:
1372 * A label reference cursor refers to a label statement.
1374 CXCursor_LabelRef = 48,
1377 * \brief A reference to a set of overloaded functions or function templates
1378 * that has not yet been resolved to a specific function or function template.
1380 * An overloaded declaration reference cursor occurs in C++ templates where
1381 * a dependent name refers to a function. For example:
1384 * template<typename T> void swap(T&, T&);
1387 * void swap(X&, X&);
1389 * template<typename T>
1390 * void reverse(T* first, T* last) {
1391 * while (first < last - 1) {
1392 * swap(*first, *--last);
1398 * void swap(Y&, Y&);
1401 * Here, the identifier "swap" is associated with an overloaded declaration
1402 * reference. In the template definition, "swap" refers to either of the two
1403 * "swap" functions declared above, so both results will be available. At
1404 * instantiation time, "swap" may also refer to other functions found via
1405 * argument-dependent lookup (e.g., the "swap" function at the end of the
1408 * The functions \c clang_getNumOverloadedDecls() and
1409 * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1410 * referenced by this cursor.
1412 CXCursor_OverloadedDeclRef = 49,
1414 CXCursor_LastRef = CXCursor_OverloadedDeclRef,
1416 /* Error conditions */
1417 CXCursor_FirstInvalid = 70,
1418 CXCursor_InvalidFile = 70,
1419 CXCursor_NoDeclFound = 71,
1420 CXCursor_NotImplemented = 72,
1421 CXCursor_InvalidCode = 73,
1422 CXCursor_LastInvalid = CXCursor_InvalidCode,
1425 CXCursor_FirstExpr = 100,
1428 * \brief An expression whose specific kind is not exposed via this
1431 * Unexposed expressions have the same operations as any other kind
1432 * of expression; one can extract their location information,
1433 * spelling, children, etc. However, the specific kind of the
1434 * expression is not reported.
1436 CXCursor_UnexposedExpr = 100,
1439 * \brief An expression that refers to some value declaration, such
1440 * as a function, varible, or enumerator.
1442 CXCursor_DeclRefExpr = 101,
1445 * \brief An expression that refers to a member of a struct, union,
1446 * class, Objective-C class, etc.
1448 CXCursor_MemberRefExpr = 102,
1450 /** \brief An expression that calls a function. */
1451 CXCursor_CallExpr = 103,
1453 /** \brief An expression that sends a message to an Objective-C
1455 CXCursor_ObjCMessageExpr = 104,
1457 /** \brief An expression that represents a block literal. */
1458 CXCursor_BlockExpr = 105,
1460 /** \brief An integer literal.
1462 CXCursor_IntegerLiteral = 106,
1464 /** \brief A floating point number literal.
1466 CXCursor_FloatingLiteral = 107,
1468 /** \brief An imaginary number literal.
1470 CXCursor_ImaginaryLiteral = 108,
1472 /** \brief A string literal.
1474 CXCursor_StringLiteral = 109,
1476 /** \brief A character literal.
1478 CXCursor_CharacterLiteral = 110,
1480 /** \brief A parenthesized expression, e.g. "(1)".
1482 * This AST node is only formed if full location information is requested.
1484 CXCursor_ParenExpr = 111,
1486 /** \brief This represents the unary-expression's (except sizeof and
1489 CXCursor_UnaryOperator = 112,
1491 /** \brief [C99 6.5.2.1] Array Subscripting.
1493 CXCursor_ArraySubscriptExpr = 113,
1495 /** \brief A builtin binary operation expression such as "x + y" or
1498 CXCursor_BinaryOperator = 114,
1500 /** \brief Compound assignment such as "+=".
1502 CXCursor_CompoundAssignOperator = 115,
1504 /** \brief The ?: ternary operator.
1506 CXCursor_ConditionalOperator = 116,
1508 /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1509 * (C++ [expr.cast]), which uses the syntax (Type)expr.
1511 * For example: (int)f.
1513 CXCursor_CStyleCastExpr = 117,
1515 /** \brief [C99 6.5.2.5]
1517 CXCursor_CompoundLiteralExpr = 118,
1519 /** \brief Describes an C or C++ initializer list.
1521 CXCursor_InitListExpr = 119,
1523 /** \brief The GNU address of label extension, representing &&label.
1525 CXCursor_AddrLabelExpr = 120,
1527 /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1529 CXCursor_StmtExpr = 121,
1531 /** \brief Represents a C1X generic selection.
1533 CXCursor_GenericSelectionExpr = 122,
1535 /** \brief Implements the GNU __null extension, which is a name for a null
1536 * pointer constant that has integral type (e.g., int or long) and is the same
1537 * size and alignment as a pointer.
1539 * The __null extension is typically only used by system headers, which define
1540 * NULL as __null in C++ rather than using 0 (which is an integer that may not
1541 * match the size of a pointer).
1543 CXCursor_GNUNullExpr = 123,
1545 /** \brief C++'s static_cast<> expression.
1547 CXCursor_CXXStaticCastExpr = 124,
1549 /** \brief C++'s dynamic_cast<> expression.
1551 CXCursor_CXXDynamicCastExpr = 125,
1553 /** \brief C++'s reinterpret_cast<> expression.
1555 CXCursor_CXXReinterpretCastExpr = 126,
1557 /** \brief C++'s const_cast<> expression.
1559 CXCursor_CXXConstCastExpr = 127,
1561 /** \brief Represents an explicit C++ type conversion that uses "functional"
1562 * notion (C++ [expr.type.conv]).
1569 CXCursor_CXXFunctionalCastExpr = 128,
1571 /** \brief A C++ typeid expression (C++ [expr.typeid]).
1573 CXCursor_CXXTypeidExpr = 129,
1575 /** \brief [C++ 2.13.5] C++ Boolean Literal.
1577 CXCursor_CXXBoolLiteralExpr = 130,
1579 /** \brief [C++0x 2.14.7] C++ Pointer Literal.
1581 CXCursor_CXXNullPtrLiteralExpr = 131,
1583 /** \brief Represents the "this" expression in C++
1585 CXCursor_CXXThisExpr = 132,
1587 /** \brief [C++ 15] C++ Throw Expression.
1589 * This handles 'throw' and 'throw' assignment-expression. When
1590 * assignment-expression isn't present, Op will be null.
1592 CXCursor_CXXThrowExpr = 133,
1594 /** \brief A new expression for memory allocation and constructor calls, e.g:
1595 * "new CXXNewExpr(foo)".
1597 CXCursor_CXXNewExpr = 134,
1599 /** \brief A delete expression for memory deallocation and destructor calls,
1600 * e.g. "delete[] pArray".
1602 CXCursor_CXXDeleteExpr = 135,
1604 /** \brief A unary expression.
1606 CXCursor_UnaryExpr = 136,
1608 /** \brief ObjCStringLiteral, used for Objective-C string literals i.e. "foo".
1610 CXCursor_ObjCStringLiteral = 137,
1612 /** \brief ObjCEncodeExpr, used for in Objective-C.
1614 CXCursor_ObjCEncodeExpr = 138,
1616 /** \brief ObjCSelectorExpr used for in Objective-C.
1618 CXCursor_ObjCSelectorExpr = 139,
1620 /** \brief Objective-C's protocol expression.
1622 CXCursor_ObjCProtocolExpr = 140,
1624 /** \brief An Objective-C "bridged" cast expression, which casts between
1625 * Objective-C pointers and C pointers, transferring ownership in the process.
1628 * NSString *str = (__bridge_transfer NSString *)CFCreateString();
1631 CXCursor_ObjCBridgedCastExpr = 141,
1633 /** \brief Represents a C++0x pack expansion that produces a sequence of
1636 * A pack expansion expression contains a pattern (which itself is an
1637 * expression) followed by an ellipsis. For example:
1640 * template<typename F, typename ...Types>
1641 * void forward(F f, Types &&...args) {
1642 * f(static_cast<Types&&>(args)...);
1646 CXCursor_PackExpansionExpr = 142,
1648 /** \brief Represents an expression that computes the length of a parameter
1652 * template<typename ...Types>
1654 * static const unsigned value = sizeof...(Types);
1658 CXCursor_SizeOfPackExpr = 143,
1660 CXCursor_LastExpr = CXCursor_SizeOfPackExpr,
1663 CXCursor_FirstStmt = 200,
1665 * \brief A statement whose specific kind is not exposed via this
1668 * Unexposed statements have the same operations as any other kind of
1669 * statement; one can extract their location information, spelling,
1670 * children, etc. However, the specific kind of the statement is not
1673 CXCursor_UnexposedStmt = 200,
1675 /** \brief A labelled statement in a function.
1677 * This cursor kind is used to describe the "start_over:" label statement in
1678 * the following example:
1686 CXCursor_LabelStmt = 201,
1688 /** \brief A group of statements like { stmt stmt }.
1690 * This cursor kind is used to describe compound statements, e.g. function
1693 CXCursor_CompoundStmt = 202,
1695 /** \brief A case statment.
1697 CXCursor_CaseStmt = 203,
1699 /** \brief A default statement.
1701 CXCursor_DefaultStmt = 204,
1703 /** \brief An if statement
1705 CXCursor_IfStmt = 205,
1707 /** \brief A switch statement.
1709 CXCursor_SwitchStmt = 206,
1711 /** \brief A while statement.
1713 CXCursor_WhileStmt = 207,
1715 /** \brief A do statement.
1717 CXCursor_DoStmt = 208,
1719 /** \brief A for statement.
1721 CXCursor_ForStmt = 209,
1723 /** \brief A goto statement.
1725 CXCursor_GotoStmt = 210,
1727 /** \brief An indirect goto statement.
1729 CXCursor_IndirectGotoStmt = 211,
1731 /** \brief A continue statement.
1733 CXCursor_ContinueStmt = 212,
1735 /** \brief A break statement.
1737 CXCursor_BreakStmt = 213,
1739 /** \brief A return statement.
1741 CXCursor_ReturnStmt = 214,
1743 /** \brief A GNU inline assembly statement extension.
1745 CXCursor_AsmStmt = 215,
1747 /** \brief Objective-C's overall @try-@catc-@finall statement.
1749 CXCursor_ObjCAtTryStmt = 216,
1751 /** \brief Objective-C's @catch statement.
1753 CXCursor_ObjCAtCatchStmt = 217,
1755 /** \brief Objective-C's @finally statement.
1757 CXCursor_ObjCAtFinallyStmt = 218,
1759 /** \brief Objective-C's @throw statement.
1761 CXCursor_ObjCAtThrowStmt = 219,
1763 /** \brief Objective-C's @synchronized statement.
1765 CXCursor_ObjCAtSynchronizedStmt = 220,
1767 /** \brief Objective-C's autorelease pool statement.
1769 CXCursor_ObjCAutoreleasePoolStmt = 221,
1771 /** \brief Objective-C's collection statement.
1773 CXCursor_ObjCForCollectionStmt = 222,
1775 /** \brief C++'s catch statement.
1777 CXCursor_CXXCatchStmt = 223,
1779 /** \brief C++'s try statement.
1781 CXCursor_CXXTryStmt = 224,
1783 /** \brief C++'s for (* : *) statement.
1785 CXCursor_CXXForRangeStmt = 225,
1787 /** \brief Windows Structured Exception Handling's try statement.
1789 CXCursor_SEHTryStmt = 226,
1791 /** \brief Windows Structured Exception Handling's except statement.
1793 CXCursor_SEHExceptStmt = 227,
1795 /** \brief Windows Structured Exception Handling's finally statement.
1797 CXCursor_SEHFinallyStmt = 228,
1799 /** \brief The null satement ";": C99 6.8.3p3.
1801 * This cursor kind is used to describe the null statement.
1803 CXCursor_NullStmt = 230,
1805 /** \brief Adaptor class for mixing declarations with statements and
1808 CXCursor_DeclStmt = 231,
1810 CXCursor_LastStmt = CXCursor_DeclStmt,
1813 * \brief Cursor that represents the translation unit itself.
1815 * The translation unit cursor exists primarily to act as the root
1816 * cursor for traversing the contents of a translation unit.
1818 CXCursor_TranslationUnit = 300,
1821 CXCursor_FirstAttr = 400,
1823 * \brief An attribute whose specific kind is not exposed via this
1826 CXCursor_UnexposedAttr = 400,
1828 CXCursor_IBActionAttr = 401,
1829 CXCursor_IBOutletAttr = 402,
1830 CXCursor_IBOutletCollectionAttr = 403,
1831 CXCursor_CXXFinalAttr = 404,
1832 CXCursor_CXXOverrideAttr = 405,
1833 CXCursor_AnnotateAttr = 406,
1834 CXCursor_LastAttr = CXCursor_AnnotateAttr,
1837 CXCursor_PreprocessingDirective = 500,
1838 CXCursor_MacroDefinition = 501,
1839 CXCursor_MacroExpansion = 502,
1840 CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
1841 CXCursor_InclusionDirective = 503,
1842 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
1843 CXCursor_LastPreprocessing = CXCursor_InclusionDirective
1847 * \brief A cursor representing some element in the abstract syntax tree for
1848 * a translation unit.
1850 * The cursor abstraction unifies the different kinds of entities in a
1851 * program--declaration, statements, expressions, references to declarations,
1852 * etc.--under a single "cursor" abstraction with a common set of operations.
1853 * Common operation for a cursor include: getting the physical location in
1854 * a source file where the cursor points, getting the name associated with a
1855 * cursor, and retrieving cursors for any child nodes of a particular cursor.
1857 * Cursors can be produced in two specific ways.
1858 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
1859 * from which one can use clang_visitChildren() to explore the rest of the
1860 * translation unit. clang_getCursor() maps from a physical source location
1861 * to the entity that resides at that location, allowing one to map from the
1862 * source code into the AST.
1865 enum CXCursorKind kind;
1871 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
1877 * \brief Retrieve the NULL cursor, which represents no entity.
1879 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
1882 * \brief Retrieve the cursor that represents the given translation unit.
1884 * The translation unit cursor can be used to start traversing the
1885 * various declarations within the given translation unit.
1887 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
1890 * \brief Determine whether two cursors are equivalent.
1892 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
1895 * \brief Returns non-zero if \arg cursor is null.
1897 int clang_Cursor_isNull(CXCursor);
1900 * \brief Compute a hash value for the given cursor.
1902 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
1905 * \brief Retrieve the kind of the given cursor.
1907 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
1910 * \brief Determine whether the given cursor kind represents a declaration.
1912 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
1915 * \brief Determine whether the given cursor kind represents a simple
1918 * Note that other kinds of cursors (such as expressions) can also refer to
1919 * other cursors. Use clang_getCursorReferenced() to determine whether a
1920 * particular cursor refers to another entity.
1922 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
1925 * \brief Determine whether the given cursor kind represents an expression.
1927 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
1930 * \brief Determine whether the given cursor kind represents a statement.
1932 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
1935 * \brief Determine whether the given cursor kind represents an attribute.
1937 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
1940 * \brief Determine whether the given cursor kind represents an invalid
1943 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
1946 * \brief Determine whether the given cursor kind represents a translation
1949 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
1952 * \brief Determine whether the given cursor represents a preprocessing
1953 * element, such as a preprocessor directive or macro instantiation.
1955 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
1958 * \brief Determine whether the given cursor represents a currently
1959 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
1961 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
1964 * \brief Describe the linkage of the entity referred to by a cursor.
1966 enum CXLinkageKind {
1967 /** \brief This value indicates that no linkage information is available
1968 * for a provided CXCursor. */
1971 * \brief This is the linkage for variables, parameters, and so on that
1972 * have automatic storage. This covers normal (non-extern) local variables.
1974 CXLinkage_NoLinkage,
1975 /** \brief This is the linkage for static variables and static functions. */
1977 /** \brief This is the linkage for entities with external linkage that live
1978 * in C++ anonymous namespaces.*/
1979 CXLinkage_UniqueExternal,
1980 /** \brief This is the linkage for entities with true, external linkage. */
1985 * \brief Determine the linkage of the entity referred to by a given cursor.
1987 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
1990 * \brief Determine the availability of the entity that this cursor refers to.
1992 * \param cursor The cursor to query.
1994 * \returns The availability of the cursor.
1996 CINDEX_LINKAGE enum CXAvailabilityKind
1997 clang_getCursorAvailability(CXCursor cursor);
2000 * \brief Describe the "language" of the entity referred to by a cursor.
2002 CINDEX_LINKAGE enum CXLanguageKind {
2003 CXLanguage_Invalid = 0,
2006 CXLanguage_CPlusPlus
2010 * \brief Determine the "language" of the entity referred to by a given cursor.
2012 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
2015 * \brief Returns the translation unit that a cursor originated from.
2017 CINDEX_LINKAGE CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor);
2021 * \brief A fast container representing a set of CXCursors.
2023 typedef struct CXCursorSetImpl *CXCursorSet;
2026 * \brief Creates an empty CXCursorSet.
2028 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet();
2031 * \brief Disposes a CXCursorSet and releases its associated memory.
2033 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2036 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2038 * \returns non-zero if the set contains the specified cursor.
2040 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2044 * \brief Inserts a CXCursor into a CXCursorSet.
2046 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2048 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2052 * \brief Determine the semantic parent of the given cursor.
2054 * The semantic parent of a cursor is the cursor that semantically contains
2055 * the given \p cursor. For many declarations, the lexical and semantic parents
2056 * are equivalent (the lexical parent is returned by
2057 * \c clang_getCursorLexicalParent()). They diverge when declarations or
2058 * definitions are provided out-of-line. For example:
2068 * In the out-of-line definition of \c C::f, the semantic parent is the
2069 * the class \c C, of which this function is a member. The lexical parent is
2070 * the place where the declaration actually occurs in the source code; in this
2071 * case, the definition occurs in the translation unit. In general, the
2072 * lexical parent for a given entity can change without affecting the semantics
2073 * of the program, and the lexical parent of different declarations of the
2074 * same entity may be different. Changing the semantic parent of a declaration,
2075 * on the other hand, can have a major impact on semantics, and redeclarations
2076 * of a particular entity should all have the same semantic context.
2078 * In the example above, both declarations of \c C::f have \c C as their
2079 * semantic context, while the lexical context of the first \c C::f is \c C
2080 * and the lexical context of the second \c C::f is the translation unit.
2082 * For global declarations, the semantic parent is the translation unit.
2084 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
2087 * \brief Determine the lexical parent of the given cursor.
2089 * The lexical parent of a cursor is the cursor in which the given \p cursor
2090 * was actually written. For many declarations, the lexical and semantic parents
2091 * are equivalent (the semantic parent is returned by
2092 * \c clang_getCursorSemanticParent()). They diverge when declarations or
2093 * definitions are provided out-of-line. For example:
2103 * In the out-of-line definition of \c C::f, the semantic parent is the
2104 * the class \c C, of which this function is a member. The lexical parent is
2105 * the place where the declaration actually occurs in the source code; in this
2106 * case, the definition occurs in the translation unit. In general, the
2107 * lexical parent for a given entity can change without affecting the semantics
2108 * of the program, and the lexical parent of different declarations of the
2109 * same entity may be different. Changing the semantic parent of a declaration,
2110 * on the other hand, can have a major impact on semantics, and redeclarations
2111 * of a particular entity should all have the same semantic context.
2113 * In the example above, both declarations of \c C::f have \c C as their
2114 * semantic context, while the lexical context of the first \c C::f is \c C
2115 * and the lexical context of the second \c C::f is the translation unit.
2117 * For declarations written in the global scope, the lexical parent is
2118 * the translation unit.
2120 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
2123 * \brief Determine the set of methods that are overridden by the given
2126 * In both Objective-C and C++, a method (aka virtual member function,
2127 * in C++) can override a virtual method in a base class. For
2128 * Objective-C, a method is said to override any method in the class's
2129 * interface (if we're coming from an implementation), its protocols,
2130 * or its categories, that has the same selector and is of the same
2131 * kind (class or instance). If no such method exists, the search
2132 * continues to the class's superclass, its protocols, and its
2133 * categories, and so on.
2135 * For C++, a virtual member function overrides any virtual member
2136 * function with the same signature that occurs in its base
2137 * classes. With multiple inheritance, a virtual member function can
2138 * override several virtual member functions coming from different
2141 * In all cases, this function determines the immediate overridden
2142 * method, rather than all of the overridden methods. For example, if
2143 * a method is originally declared in a class A, then overridden in B
2144 * (which in inherits from A) and also in C (which inherited from B),
2145 * then the only overridden method returned from this function when
2146 * invoked on C's method will be B's method. The client may then
2147 * invoke this function again, given the previously-found overridden
2148 * methods, to map out the complete method-override set.
2150 * \param cursor A cursor representing an Objective-C or C++
2151 * method. This routine will compute the set of methods that this
2154 * \param overridden A pointer whose pointee will be replaced with a
2155 * pointer to an array of cursors, representing the set of overridden
2156 * methods. If there are no overridden methods, the pointee will be
2157 * set to NULL. The pointee must be freed via a call to
2158 * \c clang_disposeOverriddenCursors().
2160 * \param num_overridden A pointer to the number of overridden
2161 * functions, will be set to the number of overridden functions in the
2162 * array pointed to by \p overridden.
2164 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
2165 CXCursor **overridden,
2166 unsigned *num_overridden);
2169 * \brief Free the set of overridden cursors returned by \c
2170 * clang_getOverriddenCursors().
2172 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
2175 * \brief Retrieve the file that is included by the given inclusion directive
2178 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
2185 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2187 * Cursors represent a location within the Abstract Syntax Tree (AST). These
2188 * routines help map between cursors and the physical locations where the
2189 * described entities occur in the source code. The mapping is provided in
2190 * both directions, so one can map from source code to the AST and back.
2196 * \brief Map a source location to the cursor that describes the entity at that
2197 * location in the source code.
2199 * clang_getCursor() maps an arbitrary source location within a translation
2200 * unit down to the most specific cursor that describes the entity at that
2201 * location. For example, given an expression \c x + y, invoking
2202 * clang_getCursor() with a source location pointing to "x" will return the
2203 * cursor for "x"; similarly for "y". If the cursor points anywhere between
2204 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2205 * will return a cursor referring to the "+" expression.
2207 * \returns a cursor representing the entity at the given source location, or
2208 * a NULL cursor if no such entity can be found.
2210 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
2213 * \brief Retrieve the physical location of the source constructor referenced
2214 * by the given cursor.
2216 * The location of a declaration is typically the location of the name of that
2217 * declaration, where the name of that declaration would occur if it is
2218 * unnamed, or some keyword that introduces that particular declaration.
2219 * The location of a reference is where that reference occurs within the
2222 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
2225 * \brief Retrieve the physical extent of the source construct referenced by
2228 * The extent of a cursor starts with the file/line/column pointing at the
2229 * first character within the source construct that the cursor refers to and
2230 * ends with the last character withinin that source construct. For a
2231 * declaration, the extent covers the declaration itself. For a reference,
2232 * the extent covers the location of the reference (e.g., where the referenced
2233 * entity was actually used).
2235 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
2242 * \defgroup CINDEX_TYPES Type information for CXCursors
2248 * \brief Describes the kind of type
2252 * \brief Reprents an invalid type (e.g., where no type is available).
2257 * \brief A type whose specific kind is not exposed via this
2260 CXType_Unexposed = 1,
2272 CXType_ULongLong = 11,
2273 CXType_UInt128 = 12,
2280 CXType_LongLong = 19,
2284 CXType_LongDouble = 23,
2285 CXType_NullPtr = 24,
2286 CXType_Overload = 25,
2287 CXType_Dependent = 26,
2289 CXType_ObjCClass = 28,
2290 CXType_ObjCSel = 29,
2291 CXType_FirstBuiltin = CXType_Void,
2292 CXType_LastBuiltin = CXType_ObjCSel,
2294 CXType_Complex = 100,
2295 CXType_Pointer = 101,
2296 CXType_BlockPointer = 102,
2297 CXType_LValueReference = 103,
2298 CXType_RValueReference = 104,
2299 CXType_Record = 105,
2301 CXType_Typedef = 107,
2302 CXType_ObjCInterface = 108,
2303 CXType_ObjCObjectPointer = 109,
2304 CXType_FunctionNoProto = 110,
2305 CXType_FunctionProto = 111,
2306 CXType_ConstantArray = 112
2310 * \brief The type of an element in the abstract syntax tree.
2314 enum CXTypeKind kind;
2319 * \brief Retrieve the type of a CXCursor (if any).
2321 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
2324 * \determine Determine whether two CXTypes represent the same type.
2326 * \returns non-zero if the CXTypes represent the same type and
2329 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
2332 * \brief Return the canonical type for a CXType.
2334 * Clang's type system explicitly models typedefs and all the ways
2335 * a specific type can be represented. The canonical type is the underlying
2336 * type with all the "sugar" removed. For example, if 'T' is a typedef
2337 * for 'int', the canonical type for 'T' would be 'int'.
2339 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
2342 * \determine Determine whether a CXType has the "const" qualifier set,
2343 * without looking through typedefs that may have added "const" at a different level.
2345 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
2348 * \determine Determine whether a CXType has the "volatile" qualifier set,
2349 * without looking through typedefs that may have added "volatile" at a different level.
2351 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
2354 * \determine Determine whether a CXType has the "restrict" qualifier set,
2355 * without looking through typedefs that may have added "restrict" at a different level.
2357 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
2360 * \brief For pointer types, returns the type of the pointee.
2363 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
2366 * \brief Return the cursor for the declaration of the given type.
2368 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
2371 * Returns the Objective-C type encoding for the specified declaration.
2373 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
2376 * \brief Retrieve the spelling of a given CXTypeKind.
2378 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
2381 * \brief Retrieve the result type associated with a function type.
2383 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
2386 * \brief Retrieve the result type associated with a given cursor. This only
2387 * returns a valid type of the cursor refers to a function or method.
2389 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
2392 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
2395 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
2398 * \brief Return the element type of an array type.
2400 * If a non-array type is passed in, an invalid type is returned.
2402 CINDEX_LINKAGE CXType clang_getArrayElementType(CXType T);
2405 * \brief Return the the array size of a constant array.
2407 * If a non-array type is passed in, -1 is returned.
2409 CINDEX_LINKAGE long long clang_getArraySize(CXType T);
2412 * \brief Returns 1 if the base class specified by the cursor with kind
2413 * CX_CXXBaseSpecifier is virtual.
2415 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
2418 * \brief Represents the C++ access control level to a base class for a
2419 * cursor with kind CX_CXXBaseSpecifier.
2421 enum CX_CXXAccessSpecifier {
2422 CX_CXXInvalidAccessSpecifier,
2429 * \brief Returns the access control level for the C++ base specifier
2430 * represented by a cursor with kind CXCursor_CXXBaseSpecifier or
2431 * CXCursor_AccessSpecifier.
2433 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
2436 * \brief Determine the number of overloaded declarations referenced by a
2437 * \c CXCursor_OverloadedDeclRef cursor.
2439 * \param cursor The cursor whose overloaded declarations are being queried.
2441 * \returns The number of overloaded declarations referenced by \c cursor. If it
2442 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
2444 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
2447 * \brief Retrieve a cursor for one of the overloaded declarations referenced
2448 * by a \c CXCursor_OverloadedDeclRef cursor.
2450 * \param cursor The cursor whose overloaded declarations are being queried.
2452 * \param index The zero-based index into the set of overloaded declarations in
2455 * \returns A cursor representing the declaration referenced by the given
2456 * \c cursor at the specified \c index. If the cursor does not have an
2457 * associated set of overloaded declarations, or if the index is out of bounds,
2458 * returns \c clang_getNullCursor();
2460 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
2468 * \defgroup CINDEX_ATTRIBUTES Information for attributes
2475 * \brief For cursors representing an iboutletcollection attribute,
2476 * this function returns the collection element type.
2479 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
2486 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
2488 * These routines provide the ability to traverse the abstract syntax tree
2495 * \brief Describes how the traversal of the children of a particular
2496 * cursor should proceed after visiting a particular child cursor.
2498 * A value of this enumeration type should be returned by each
2499 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
2501 enum CXChildVisitResult {
2503 * \brief Terminates the cursor traversal.
2507 * \brief Continues the cursor traversal with the next sibling of
2508 * the cursor just visited, without visiting its children.
2510 CXChildVisit_Continue,
2512 * \brief Recursively traverse the children of this cursor, using
2513 * the same visitor and client data.
2515 CXChildVisit_Recurse
2519 * \brief Visitor invoked for each cursor found by a traversal.
2521 * This visitor function will be invoked for each cursor found by
2522 * clang_visitCursorChildren(). Its first argument is the cursor being
2523 * visited, its second argument is the parent visitor for that cursor,
2524 * and its third argument is the client data provided to
2525 * clang_visitCursorChildren().
2527 * The visitor should return one of the \c CXChildVisitResult values
2528 * to direct clang_visitCursorChildren().
2530 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
2532 CXClientData client_data);
2535 * \brief Visit the children of a particular cursor.
2537 * This function visits all the direct children of the given cursor,
2538 * invoking the given \p visitor function with the cursors of each
2539 * visited child. The traversal may be recursive, if the visitor returns
2540 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
2541 * the visitor returns \c CXChildVisit_Break.
2543 * \param parent the cursor whose child may be visited. All kinds of
2544 * cursors can be visited, including invalid cursors (which, by
2545 * definition, have no children).
2547 * \param visitor the visitor function that will be invoked for each
2548 * child of \p parent.
2550 * \param client_data pointer data supplied by the client, which will
2551 * be passed to the visitor each time it is invoked.
2553 * \returns a non-zero value if the traversal was terminated
2554 * prematurely by the visitor returning \c CXChildVisit_Break.
2556 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
2557 CXCursorVisitor visitor,
2558 CXClientData client_data);
2559 #ifdef __has_feature
2560 # if __has_feature(blocks)
2562 * \brief Visitor invoked for each cursor found by a traversal.
2564 * This visitor block will be invoked for each cursor found by
2565 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
2566 * visited, its second argument is the parent visitor for that cursor.
2568 * The visitor should return one of the \c CXChildVisitResult values
2569 * to direct clang_visitChildrenWithBlock().
2571 typedef enum CXChildVisitResult
2572 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
2575 * Visits the children of a cursor using the specified block. Behaves
2576 * identically to clang_visitChildren() in all other respects.
2578 unsigned clang_visitChildrenWithBlock(CXCursor parent,
2579 CXCursorVisitorBlock block);
2588 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
2590 * These routines provide the ability to determine references within and
2591 * across translation units, by providing the names of the entities referenced
2592 * by cursors, follow reference cursors to the declarations they reference,
2593 * and associate declarations with their definitions.
2599 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
2600 * by the given cursor.
2602 * A Unified Symbol Resolution (USR) is a string that identifies a particular
2603 * entity (function, class, variable, etc.) within a program. USRs can be
2604 * compared across translation units to determine, e.g., when references in
2605 * one translation refer to an entity defined in another translation unit.
2607 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
2610 * \brief Construct a USR for a specified Objective-C class.
2612 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
2615 * \brief Construct a USR for a specified Objective-C category.
2617 CINDEX_LINKAGE CXString
2618 clang_constructUSR_ObjCCategory(const char *class_name,
2619 const char *category_name);
2622 * \brief Construct a USR for a specified Objective-C protocol.
2624 CINDEX_LINKAGE CXString
2625 clang_constructUSR_ObjCProtocol(const char *protocol_name);
2629 * \brief Construct a USR for a specified Objective-C instance variable and
2630 * the USR for its containing class.
2632 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
2636 * \brief Construct a USR for a specified Objective-C method and
2637 * the USR for its containing class.
2639 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
2640 unsigned isInstanceMethod,
2644 * \brief Construct a USR for a specified Objective-C property and the USR
2645 * for its containing class.
2647 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
2651 * \brief Retrieve a name for the entity referenced by this cursor.
2653 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
2656 * \brief Retrieve the display name for the entity referenced by this cursor.
2658 * The display name contains extra information that helps identify the cursor,
2659 * such as the parameters of a function or template or the arguments of a
2660 * class template specialization.
2662 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
2664 /** \brief For a cursor that is a reference, retrieve a cursor representing the
2665 * entity that it references.
2667 * Reference cursors refer to other entities in the AST. For example, an
2668 * Objective-C superclass reference cursor refers to an Objective-C class.
2669 * This function produces the cursor for the Objective-C class from the
2670 * cursor for the superclass reference. If the input cursor is a declaration or
2671 * definition, it returns that declaration or definition unchanged.
2672 * Otherwise, returns the NULL cursor.
2674 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
2677 * \brief For a cursor that is either a reference to or a declaration
2678 * of some entity, retrieve a cursor that describes the definition of
2681 * Some entities can be declared multiple times within a translation
2682 * unit, but only one of those declarations can also be a
2683 * definition. For example, given:
2687 * int g(int x, int y) { return f(x, y); }
2688 * int f(int a, int b) { return a + b; }
2692 * there are three declarations of the function "f", but only the
2693 * second one is a definition. The clang_getCursorDefinition()
2694 * function will take any cursor pointing to a declaration of "f"
2695 * (the first or fourth lines of the example) or a cursor referenced
2696 * that uses "f" (the call to "f' inside "g") and will return a
2697 * declaration cursor pointing to the definition (the second "f"
2700 * If given a cursor for which there is no corresponding definition,
2701 * e.g., because there is no definition of that entity within this
2702 * translation unit, returns a NULL cursor.
2704 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
2707 * \brief Determine whether the declaration pointed to by this cursor
2708 * is also a definition of that entity.
2710 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
2713 * \brief Retrieve the canonical cursor corresponding to the given cursor.
2715 * In the C family of languages, many kinds of entities can be declared several
2716 * times within a single translation unit. For example, a structure type can
2717 * be forward-declared (possibly multiple times) and later defined:
2727 * The declarations and the definition of \c X are represented by three
2728 * different cursors, all of which are declarations of the same underlying
2729 * entity. One of these cursor is considered the "canonical" cursor, which
2730 * is effectively the representative for the underlying entity. One can
2731 * determine if two cursors are declarations of the same underlying entity by
2732 * comparing their canonical cursors.
2734 * \returns The canonical cursor for the entity referred to by the given cursor.
2736 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
2743 * \defgroup CINDEX_CPP C++ AST introspection
2745 * The routines in this group provide access information in the ASTs specific
2746 * to C++ language features.
2752 * \brief Determine if a C++ member function or member function template is
2753 * declared 'static'.
2755 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
2758 * \brief Determine if a C++ member function or member function template is
2759 * explicitly declared 'virtual' or if it overrides a virtual method from
2760 * one of the base classes.
2762 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
2765 * \brief Given a cursor that represents a template, determine
2766 * the cursor kind of the specializations would be generated by instantiating
2769 * This routine can be used to determine what flavor of function template,
2770 * class template, or class template partial specialization is stored in the
2771 * cursor. For example, it can describe whether a class template cursor is
2772 * declared with "struct", "class" or "union".
2774 * \param C The cursor to query. This cursor should represent a template
2777 * \returns The cursor kind of the specializations that would be generated
2778 * by instantiating the template \p C. If \p C is not a template, returns
2779 * \c CXCursor_NoDeclFound.
2781 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
2784 * \brief Given a cursor that may represent a specialization or instantiation
2785 * of a template, retrieve the cursor that represents the template that it
2786 * specializes or from which it was instantiated.
2788 * This routine determines the template involved both for explicit
2789 * specializations of templates and for implicit instantiations of the template,
2790 * both of which are referred to as "specializations". For a class template
2791 * specialization (e.g., \c std::vector<bool>), this routine will return
2792 * either the primary template (\c std::vector) or, if the specialization was
2793 * instantiated from a class template partial specialization, the class template
2794 * partial specialization. For a class template partial specialization and a
2795 * function template specialization (including instantiations), this
2796 * this routine will return the specialized template.
2798 * For members of a class template (e.g., member functions, member classes, or
2799 * static data members), returns the specialized or instantiated member.
2800 * Although not strictly "templates" in the C++ language, members of class
2801 * templates have the same notions of specializations and instantiations that
2802 * templates do, so this routine treats them similarly.
2804 * \param C A cursor that may be a specialization of a template or a member
2807 * \returns If the given cursor is a specialization or instantiation of a
2808 * template or a member thereof, the template or member that it specializes or
2809 * from which it was instantiated. Otherwise, returns a NULL cursor.
2811 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
2814 * \brief Given a cursor that references something else, return the source range
2815 * covering that reference.
2817 * \param C A cursor pointing to a member reference, a declaration reference, or
2819 * \param NameFlags A bitset with three independent flags:
2820 * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
2821 * CXNameRange_WantSinglePiece.
2822 * \param PieceIndex For contiguous names or when passing the flag
2823 * CXNameRange_WantSinglePiece, only one piece with index 0 is
2824 * available. When the CXNameRange_WantSinglePiece flag is not passed for a
2825 * non-contiguous names, this index can be used to retreive the individual
2826 * pieces of the name. See also CXNameRange_WantSinglePiece.
2828 * \returns The piece of the name pointed to by the given cursor. If there is no
2829 * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
2831 CINDEX_LINKAGE CXSourceRange clang_getCursorReferenceNameRange(CXCursor C,
2833 unsigned PieceIndex);
2835 enum CXNameRefFlags {
2837 * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
2840 CXNameRange_WantQualifier = 0x1,
2843 * \brief Include the explicit template arguments, e.g. <int> in x.f<int>, in
2846 CXNameRange_WantTemplateArgs = 0x2,
2849 * \brief If the name is non-contiguous, return the full spanning range.
2851 * Non-contiguous names occur in Objective-C when a selector with two or more
2852 * parameters is used, or in C++ when using an operator:
2854 * [object doSomething:here withValue:there]; // ObjC
2855 * return some_vector[1]; // C++
2858 CXNameRange_WantSinglePiece = 0x4
2866 * \defgroup CINDEX_LEX Token extraction and manipulation
2868 * The routines in this group provide access to the tokens within a
2869 * translation unit, along with a semantic mapping of those tokens to
2870 * their corresponding cursors.
2876 * \brief Describes a kind of token.
2878 typedef enum CXTokenKind {
2880 * \brief A token that contains some kind of punctuation.
2882 CXToken_Punctuation,
2885 * \brief A language keyword.
2890 * \brief An identifier (that is not a keyword).
2895 * \brief A numeric, string, or character literal.
2906 * \brief Describes a single preprocessing token.
2909 unsigned int_data[4];
2914 * \brief Determine the kind of the given token.
2916 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
2919 * \brief Determine the spelling of the given token.
2921 * The spelling of a token is the textual representation of that token, e.g.,
2922 * the text of an identifier or keyword.
2924 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
2927 * \brief Retrieve the source location of the given token.
2929 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
2933 * \brief Retrieve a source range that covers the given token.
2935 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
2938 * \brief Tokenize the source code described by the given range into raw
2941 * \param TU the translation unit whose text is being tokenized.
2943 * \param Range the source range in which text should be tokenized. All of the
2944 * tokens produced by tokenization will fall within this source range,
2946 * \param Tokens this pointer will be set to point to the array of tokens
2947 * that occur within the given source range. The returned pointer must be
2948 * freed with clang_disposeTokens() before the translation unit is destroyed.
2950 * \param NumTokens will be set to the number of tokens in the \c *Tokens
2954 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
2955 CXToken **Tokens, unsigned *NumTokens);
2958 * \brief Annotate the given set of tokens by providing cursors for each token
2959 * that can be mapped to a specific entity within the abstract syntax tree.
2961 * This token-annotation routine is equivalent to invoking
2962 * clang_getCursor() for the source locations of each of the
2963 * tokens. The cursors provided are filtered, so that only those
2964 * cursors that have a direct correspondence to the token are
2965 * accepted. For example, given a function call \c f(x),
2966 * clang_getCursor() would provide the following cursors:
2968 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
2969 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
2970 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
2972 * Only the first and last of these cursors will occur within the
2973 * annotate, since the tokens "f" and "x' directly refer to a function
2974 * and a variable, respectively, but the parentheses are just a small
2975 * part of the full syntax of the function call expression, which is
2976 * not provided as an annotation.
2978 * \param TU the translation unit that owns the given tokens.
2980 * \param Tokens the set of tokens to annotate.
2982 * \param NumTokens the number of tokens in \p Tokens.
2984 * \param Cursors an array of \p NumTokens cursors, whose contents will be
2985 * replaced with the cursors corresponding to each token.
2987 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
2988 CXToken *Tokens, unsigned NumTokens,
2992 * \brief Free the given set of tokens.
2994 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
2995 CXToken *Tokens, unsigned NumTokens);
3002 * \defgroup CINDEX_DEBUG Debugging facilities
3004 * These routines are used for testing and debugging, only, and should not
3010 /* for debug/testing */
3011 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
3012 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
3013 const char **startBuf,
3014 const char **endBuf,
3015 unsigned *startLine,
3016 unsigned *startColumn,
3018 unsigned *endColumn);
3019 CINDEX_LINKAGE void clang_enableStackTraces(void);
3020 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
3021 unsigned stack_size);
3028 * \defgroup CINDEX_CODE_COMPLET Code completion
3030 * Code completion involves taking an (incomplete) source file, along with
3031 * knowledge of where the user is actively editing that file, and suggesting
3032 * syntactically- and semantically-valid constructs that the user might want to
3033 * use at that particular point in the source code. These data structures and
3034 * routines provide support for code completion.
3040 * \brief A semantic string that describes a code-completion result.
3042 * A semantic string that describes the formatting of a code-completion
3043 * result as a single "template" of text that should be inserted into the
3044 * source buffer when a particular code-completion result is selected.
3045 * Each semantic string is made up of some number of "chunks", each of which
3046 * contains some text along with a description of what that text means, e.g.,
3047 * the name of the entity being referenced, whether the text chunk is part of
3048 * the template, or whether it is a "placeholder" that the user should replace
3049 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
3050 * description of the different kinds of chunks.
3052 typedef void *CXCompletionString;
3055 * \brief A single result of code completion.
3059 * \brief The kind of entity that this completion refers to.
3061 * The cursor kind will be a macro, keyword, or a declaration (one of the
3062 * *Decl cursor kinds), describing the entity that the completion is
3065 * \todo In the future, we would like to provide a full cursor, to allow
3066 * the client to extract additional information from declaration.
3068 enum CXCursorKind CursorKind;
3071 * \brief The code-completion string that describes how to insert this
3072 * code-completion result into the editing buffer.
3074 CXCompletionString CompletionString;
3075 } CXCompletionResult;
3078 * \brief Describes a single piece of text within a code-completion string.
3080 * Each "chunk" within a code-completion string (\c CXCompletionString) is
3081 * either a piece of text with a specific "kind" that describes how that text
3082 * should be interpreted by the client or is another completion string.
3084 enum CXCompletionChunkKind {
3086 * \brief A code-completion string that describes "optional" text that
3087 * could be a part of the template (but is not required).
3089 * The Optional chunk is the only kind of chunk that has a code-completion
3090 * string for its representation, which is accessible via
3091 * \c clang_getCompletionChunkCompletionString(). The code-completion string
3092 * describes an additional part of the template that is completely optional.
3093 * For example, optional chunks can be used to describe the placeholders for
3094 * arguments that match up with defaulted function parameters, e.g. given:
3097 * void f(int x, float y = 3.14, double z = 2.71828);
3100 * The code-completion string for this function would contain:
3101 * - a TypedText chunk for "f".
3102 * - a LeftParen chunk for "(".
3103 * - a Placeholder chunk for "int x"
3104 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
3105 * - a Comma chunk for ","
3106 * - a Placeholder chunk for "float y"
3107 * - an Optional chunk containing the last defaulted argument:
3108 * - a Comma chunk for ","
3109 * - a Placeholder chunk for "double z"
3110 * - a RightParen chunk for ")"
3112 * There are many ways to handle Optional chunks. Two simple approaches are:
3113 * - Completely ignore optional chunks, in which case the template for the
3114 * function "f" would only include the first parameter ("int x").
3115 * - Fully expand all optional chunks, in which case the template for the
3116 * function "f" would have all of the parameters.
3118 CXCompletionChunk_Optional,
3120 * \brief Text that a user would be expected to type to get this
3121 * code-completion result.
3123 * There will be exactly one "typed text" chunk in a semantic string, which
3124 * will typically provide the spelling of a keyword or the name of a
3125 * declaration that could be used at the current code point. Clients are
3126 * expected to filter the code-completion results based on the text in this
3129 CXCompletionChunk_TypedText,
3131 * \brief Text that should be inserted as part of a code-completion result.
3133 * A "text" chunk represents text that is part of the template to be
3134 * inserted into user code should this particular code-completion result
3137 CXCompletionChunk_Text,
3139 * \brief Placeholder text that should be replaced by the user.
3141 * A "placeholder" chunk marks a place where the user should insert text
3142 * into the code-completion template. For example, placeholders might mark
3143 * the function parameters for a function declaration, to indicate that the
3144 * user should provide arguments for each of those parameters. The actual
3145 * text in a placeholder is a suggestion for the text to display before
3146 * the user replaces the placeholder with real code.
3148 CXCompletionChunk_Placeholder,
3150 * \brief Informative text that should be displayed but never inserted as
3151 * part of the template.
3153 * An "informative" chunk contains annotations that can be displayed to
3154 * help the user decide whether a particular code-completion result is the
3155 * right option, but which is not part of the actual template to be inserted
3156 * by code completion.
3158 CXCompletionChunk_Informative,
3160 * \brief Text that describes the current parameter when code-completion is
3161 * referring to function call, message send, or template specialization.
3163 * A "current parameter" chunk occurs when code-completion is providing
3164 * information about a parameter corresponding to the argument at the
3165 * code-completion point. For example, given a function
3168 * int add(int x, int y);
3171 * and the source code \c add(, where the code-completion point is after the
3172 * "(", the code-completion string will contain a "current parameter" chunk
3173 * for "int x", indicating that the current argument will initialize that
3174 * parameter. After typing further, to \c add(17, (where the code-completion
3175 * point is after the ","), the code-completion string will contain a
3176 * "current paremeter" chunk to "int y".
3178 CXCompletionChunk_CurrentParameter,
3180 * \brief A left parenthesis ('('), used to initiate a function call or
3181 * signal the beginning of a function parameter list.
3183 CXCompletionChunk_LeftParen,
3185 * \brief A right parenthesis (')'), used to finish a function call or
3186 * signal the end of a function parameter list.
3188 CXCompletionChunk_RightParen,
3190 * \brief A left bracket ('[').
3192 CXCompletionChunk_LeftBracket,
3194 * \brief A right bracket (']').
3196 CXCompletionChunk_RightBracket,
3198 * \brief A left brace ('{').
3200 CXCompletionChunk_LeftBrace,
3202 * \brief A right brace ('}').
3204 CXCompletionChunk_RightBrace,
3206 * \brief A left angle bracket ('<').
3208 CXCompletionChunk_LeftAngle,
3210 * \brief A right angle bracket ('>').
3212 CXCompletionChunk_RightAngle,
3214 * \brief A comma separator (',').
3216 CXCompletionChunk_Comma,
3218 * \brief Text that specifies the result type of a given result.
3220 * This special kind of informative chunk is not meant to be inserted into
3221 * the text buffer. Rather, it is meant to illustrate the type that an
3222 * expression using the given completion string would have.
3224 CXCompletionChunk_ResultType,
3226 * \brief A colon (':').
3228 CXCompletionChunk_Colon,
3230 * \brief A semicolon (';').
3232 CXCompletionChunk_SemiColon,
3234 * \brief An '=' sign.
3236 CXCompletionChunk_Equal,
3238 * Horizontal space (' ').
3240 CXCompletionChunk_HorizontalSpace,
3242 * Vertical space ('\n'), after which it is generally a good idea to
3243 * perform indentation.
3245 CXCompletionChunk_VerticalSpace
3249 * \brief Determine the kind of a particular chunk within a completion string.
3251 * \param completion_string the completion string to query.
3253 * \param chunk_number the 0-based index of the chunk in the completion string.
3255 * \returns the kind of the chunk at the index \c chunk_number.
3257 CINDEX_LINKAGE enum CXCompletionChunkKind
3258 clang_getCompletionChunkKind(CXCompletionString completion_string,
3259 unsigned chunk_number);
3262 * \brief Retrieve the text associated with a particular chunk within a
3263 * completion string.
3265 * \param completion_string the completion string to query.
3267 * \param chunk_number the 0-based index of the chunk in the completion string.
3269 * \returns the text associated with the chunk at index \c chunk_number.
3271 CINDEX_LINKAGE CXString
3272 clang_getCompletionChunkText(CXCompletionString completion_string,
3273 unsigned chunk_number);
3276 * \brief Retrieve the completion string associated with a particular chunk
3277 * within a completion string.
3279 * \param completion_string the completion string to query.
3281 * \param chunk_number the 0-based index of the chunk in the completion string.
3283 * \returns the completion string associated with the chunk at index
3286 CINDEX_LINKAGE CXCompletionString
3287 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
3288 unsigned chunk_number);
3291 * \brief Retrieve the number of chunks in the given code-completion string.
3293 CINDEX_LINKAGE unsigned
3294 clang_getNumCompletionChunks(CXCompletionString completion_string);
3297 * \brief Determine the priority of this code completion.
3299 * The priority of a code completion indicates how likely it is that this
3300 * particular completion is the completion that the user will select. The
3301 * priority is selected by various internal heuristics.
3303 * \param completion_string The completion string to query.
3305 * \returns The priority of this completion string. Smaller values indicate
3306 * higher-priority (more likely) completions.
3308 CINDEX_LINKAGE unsigned
3309 clang_getCompletionPriority(CXCompletionString completion_string);
3312 * \brief Determine the availability of the entity that this code-completion
3315 * \param completion_string The completion string to query.
3317 * \returns The availability of the completion string.
3319 CINDEX_LINKAGE enum CXAvailabilityKind
3320 clang_getCompletionAvailability(CXCompletionString completion_string);
3323 * \brief Retrieve the number of annotations associated with the given
3324 * completion string.
3326 * \param completion_string the completion string to query.
3328 * \returns the number of annotations associated with the given completion
3331 CINDEX_LINKAGE unsigned
3332 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
3335 * \brief Retrieve the annotation associated with the given completion string.
3337 * \param completion_string the completion string to query.
3339 * \param annotation_number the 0-based index of the annotation of the
3340 * completion string.
3342 * \returns annotation string associated with the completion at index
3343 * \c annotation_number, or a NULL string if that annotation is not available.
3345 CINDEX_LINKAGE CXString
3346 clang_getCompletionAnnotation(CXCompletionString completion_string,
3347 unsigned annotation_number);
3350 * \brief Retrieve a completion string for an arbitrary declaration or macro
3351 * definition cursor.
3353 * \param cursor The cursor to query.
3355 * \returns A non-context-sensitive completion string for declaration and macro
3356 * definition cursors, or NULL for other kinds of cursors.
3358 CINDEX_LINKAGE CXCompletionString
3359 clang_getCursorCompletionString(CXCursor cursor);
3362 * \brief Contains the results of code-completion.
3364 * This data structure contains the results of code completion, as
3365 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
3366 * \c clang_disposeCodeCompleteResults.
3370 * \brief The code-completion results.
3372 CXCompletionResult *Results;
3375 * \brief The number of code-completion results stored in the
3378 unsigned NumResults;
3379 } CXCodeCompleteResults;
3382 * \brief Flags that can be passed to \c clang_codeCompleteAt() to
3383 * modify its behavior.
3385 * The enumerators in this enumeration can be bitwise-OR'd together to
3386 * provide multiple options to \c clang_codeCompleteAt().
3388 enum CXCodeComplete_Flags {
3390 * \brief Whether to include macros within the set of code
3391 * completions returned.
3393 CXCodeComplete_IncludeMacros = 0x01,
3396 * \brief Whether to include code patterns for language constructs
3397 * within the set of code completions, e.g., for loops.
3399 CXCodeComplete_IncludeCodePatterns = 0x02
3403 * \brief Bits that represent the context under which completion is occurring.
3405 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
3406 * contexts are occurring simultaneously.
3408 enum CXCompletionContext {
3410 * \brief The context for completions is unexposed, as only Clang results
3411 * should be included. (This is equivalent to having no context bits set.)
3413 CXCompletionContext_Unexposed = 0,
3416 * \brief Completions for any possible type should be included in the results.
3418 CXCompletionContext_AnyType = 1 << 0,
3421 * \brief Completions for any possible value (variables, function calls, etc.)
3422 * should be included in the results.
3424 CXCompletionContext_AnyValue = 1 << 1,
3426 * \brief Completions for values that resolve to an Objective-C object should
3427 * be included in the results.
3429 CXCompletionContext_ObjCObjectValue = 1 << 2,
3431 * \brief Completions for values that resolve to an Objective-C selector
3432 * should be included in the results.
3434 CXCompletionContext_ObjCSelectorValue = 1 << 3,
3436 * \brief Completions for values that resolve to a C++ class type should be
3437 * included in the results.
3439 CXCompletionContext_CXXClassTypeValue = 1 << 4,
3442 * \brief Completions for fields of the member being accessed using the dot
3443 * operator should be included in the results.
3445 CXCompletionContext_DotMemberAccess = 1 << 5,
3447 * \brief Completions for fields of the member being accessed using the arrow
3448 * operator should be included in the results.
3450 CXCompletionContext_ArrowMemberAccess = 1 << 6,
3452 * \brief Completions for properties of the Objective-C object being accessed
3453 * using the dot operator should be included in the results.
3455 CXCompletionContext_ObjCPropertyAccess = 1 << 7,
3458 * \brief Completions for enum tags should be included in the results.
3460 CXCompletionContext_EnumTag = 1 << 8,
3462 * \brief Completions for union tags should be included in the results.
3464 CXCompletionContext_UnionTag = 1 << 9,
3466 * \brief Completions for struct tags should be included in the results.
3468 CXCompletionContext_StructTag = 1 << 10,
3471 * \brief Completions for C++ class names should be included in the results.
3473 CXCompletionContext_ClassTag = 1 << 11,
3475 * \brief Completions for C++ namespaces and namespace aliases should be
3476 * included in the results.
3478 CXCompletionContext_Namespace = 1 << 12,
3480 * \brief Completions for C++ nested name specifiers should be included in
3483 CXCompletionContext_NestedNameSpecifier = 1 << 13,
3486 * \brief Completions for Objective-C interfaces (classes) should be included
3489 CXCompletionContext_ObjCInterface = 1 << 14,
3491 * \brief Completions for Objective-C protocols should be included in
3494 CXCompletionContext_ObjCProtocol = 1 << 15,
3496 * \brief Completions for Objective-C categories should be included in
3499 CXCompletionContext_ObjCCategory = 1 << 16,
3501 * \brief Completions for Objective-C instance messages should be included
3504 CXCompletionContext_ObjCInstanceMessage = 1 << 17,
3506 * \brief Completions for Objective-C class messages should be included in
3509 CXCompletionContext_ObjCClassMessage = 1 << 18,
3511 * \brief Completions for Objective-C selector names should be included in
3514 CXCompletionContext_ObjCSelectorName = 1 << 19,
3517 * \brief Completions for preprocessor macro names should be included in
3520 CXCompletionContext_MacroName = 1 << 20,
3523 * \brief Natural language completions should be included in the results.
3525 CXCompletionContext_NaturalLanguage = 1 << 21,
3528 * \brief The current context is unknown, so set all contexts.
3530 CXCompletionContext_Unknown = ((1 << 22) - 1)
3534 * \brief Returns a default set of code-completion options that can be
3535 * passed to\c clang_codeCompleteAt().
3537 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
3540 * \brief Perform code completion at a given location in a translation unit.
3542 * This function performs code completion at a particular file, line, and
3543 * column within source code, providing results that suggest potential
3544 * code snippets based on the context of the completion. The basic model
3545 * for code completion is that Clang will parse a complete source file,
3546 * performing syntax checking up to the location where code-completion has
3547 * been requested. At that point, a special code-completion token is passed
3548 * to the parser, which recognizes this token and determines, based on the
3549 * current location in the C/Objective-C/C++ grammar and the state of
3550 * semantic analysis, what completions to provide. These completions are
3551 * returned via a new \c CXCodeCompleteResults structure.
3553 * Code completion itself is meant to be triggered by the client when the
3554 * user types punctuation characters or whitespace, at which point the
3555 * code-completion location will coincide with the cursor. For example, if \c p
3556 * is a pointer, code-completion might be triggered after the "-" and then
3557 * after the ">" in \c p->. When the code-completion location is afer the ">",
3558 * the completion results will provide, e.g., the members of the struct that
3559 * "p" points to. The client is responsible for placing the cursor at the
3560 * beginning of the token currently being typed, then filtering the results
3561 * based on the contents of the token. For example, when code-completing for
3562 * the expression \c p->get, the client should provide the location just after
3563 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
3564 * client can filter the results based on the current token text ("get"), only
3565 * showing those results that start with "get". The intent of this interface
3566 * is to separate the relatively high-latency acquisition of code-completion
3567 * results from the filtering of results on a per-character basis, which must
3568 * have a lower latency.
3570 * \param TU The translation unit in which code-completion should
3571 * occur. The source files for this translation unit need not be
3572 * completely up-to-date (and the contents of those source files may
3573 * be overridden via \p unsaved_files). Cursors referring into the
3574 * translation unit may be invalidated by this invocation.
3576 * \param complete_filename The name of the source file where code
3577 * completion should be performed. This filename may be any file
3578 * included in the translation unit.
3580 * \param complete_line The line at which code-completion should occur.
3582 * \param complete_column The column at which code-completion should occur.
3583 * Note that the column should point just after the syntactic construct that
3584 * initiated code completion, and not in the middle of a lexical token.
3586 * \param unsaved_files the Tiles that have not yet been saved to disk
3587 * but may be required for parsing or code completion, including the
3588 * contents of those files. The contents and name of these files (as
3589 * specified by CXUnsavedFile) are copied when necessary, so the
3590 * client only needs to guarantee their validity until the call to
3591 * this function returns.
3593 * \param num_unsaved_files The number of unsaved file entries in \p
3596 * \param options Extra options that control the behavior of code
3597 * completion, expressed as a bitwise OR of the enumerators of the
3598 * CXCodeComplete_Flags enumeration. The
3599 * \c clang_defaultCodeCompleteOptions() function returns a default set
3600 * of code-completion options.
3602 * \returns If successful, a new \c CXCodeCompleteResults structure
3603 * containing code-completion results, which should eventually be
3604 * freed with \c clang_disposeCodeCompleteResults(). If code
3605 * completion fails, returns NULL.
3608 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
3609 const char *complete_filename,
3610 unsigned complete_line,
3611 unsigned complete_column,
3612 struct CXUnsavedFile *unsaved_files,
3613 unsigned num_unsaved_files,
3617 * \brief Sort the code-completion results in case-insensitive alphabetical
3620 * \param Results The set of results to sort.
3621 * \param NumResults The number of results in \p Results.
3624 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
3625 unsigned NumResults);
3628 * \brief Free the given set of code-completion results.
3631 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
3634 * \brief Determine the number of diagnostics produced prior to the
3635 * location where code completion was performed.
3638 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
3641 * \brief Retrieve a diagnostic associated with the given code completion.
3643 * \param Result the code completion results to query.
3644 * \param Index the zero-based diagnostic number to retrieve.
3646 * \returns the requested diagnostic. This diagnostic must be freed
3647 * via a call to \c clang_disposeDiagnostic().
3650 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
3654 * \brief Determines what compeltions are appropriate for the context
3655 * the given code completion.
3657 * \param Results the code completion results to query
3659 * \returns the kinds of completions that are appropriate for use
3660 * along with the given code completion results.
3663 unsigned long long clang_codeCompleteGetContexts(
3664 CXCodeCompleteResults *Results);
3667 * \brief Returns the cursor kind for the container for the current code
3668 * completion context. The container is only guaranteed to be set for
3669 * contexts where a container exists (i.e. member accesses or Objective-C
3670 * message sends); if there is not a container, this function will return
3671 * CXCursor_InvalidCode.
3673 * \param Results the code completion results to query
3675 * \param IsIncomplete on return, this value will be false if Clang has complete
3676 * information about the container. If Clang does not have complete
3677 * information, this value will be true.
3679 * \returns the container kind, or CXCursor_InvalidCode if there is not a
3683 enum CXCursorKind clang_codeCompleteGetContainerKind(
3684 CXCodeCompleteResults *Results,
3685 unsigned *IsIncomplete);
3688 * \brief Returns the USR for the container for the current code completion
3689 * context. If there is not a container for the current context, this
3690 * function will return the empty string.
3692 * \param Results the code completion results to query
3694 * \returns the USR for the container
3697 CXString clang_codeCompleteGetContainerUSR(CXCodeCompleteResults *Results);
3701 * \brief Returns the currently-entered selector for an Objective-C message
3702 * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
3703 * non-empty string for CXCompletionContext_ObjCInstanceMessage and
3704 * CXCompletionContext_ObjCClassMessage.
3706 * \param Results the code completion results to query
3708 * \returns the selector (or partial selector) that has been entered thus far
3709 * for an Objective-C message send.
3712 CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *Results);
3720 * \defgroup CINDEX_MISC Miscellaneous utility functions
3726 * \brief Return a version string, suitable for showing to a user, but not
3727 * intended to be parsed (the format is not guaranteed to be stable).
3729 CINDEX_LINKAGE CXString clang_getClangVersion();
3733 * \brief Enable/disable crash recovery.
3735 * \param Flag to indicate if crash recovery is enabled. A non-zero value
3736 * enables crash recovery, while 0 disables it.
3738 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
3741 * \brief Visitor invoked for each file in a translation unit
3742 * (used with clang_getInclusions()).
3744 * This visitor function will be invoked by clang_getInclusions() for each
3745 * file included (either at the top-level or by #include directives) within
3746 * a translation unit. The first argument is the file being included, and
3747 * the second and third arguments provide the inclusion stack. The
3748 * array is sorted in order of immediate inclusion. For example,
3749 * the first element refers to the location that included 'included_file'.
3751 typedef void (*CXInclusionVisitor)(CXFile included_file,
3752 CXSourceLocation* inclusion_stack,
3753 unsigned include_len,
3754 CXClientData client_data);
3757 * \brief Visit the set of preprocessor inclusions in a translation unit.
3758 * The visitor function is called with the provided data for every included
3759 * file. This does not include headers included by the PCH file (unless one
3760 * is inspecting the inclusions in the PCH file itself).
3762 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
3763 CXInclusionVisitor visitor,
3764 CXClientData client_data);
3770 /** \defgroup CINDEX_REMAPPING Remapping functions
3776 * \brief A remapping of original source files and their translated files.
3778 typedef void *CXRemapping;
3781 * \brief Retrieve a remapping.
3783 * \param path the path that contains metadata about remappings.
3785 * \returns the requested remapping. This remapping must be freed
3786 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
3788 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
3791 * \brief Determine the number of remappings.
3793 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
3796 * \brief Get the original and the associated filename from the remapping.
3798 * \param original If non-NULL, will be set to the original filename.
3800 * \param transformed If non-NULL, will be set to the filename that the original
3801 * is associated with.
3803 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
3804 CXString *original, CXString *transformed);
3807 * \brief Dispose the remapping.
3809 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
3815 /** \defgroup CINDEX_HIGH Higher level API functions
3820 enum CXVisitorResult {
3827 enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
3828 } CXCursorAndRangeVisitor;
3831 * \brief Find references of a declaration in a specific file.
3833 * \param cursor pointing to a declaration or a reference of one.
3835 * \param file to search for references.
3837 * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
3838 * each reference found.
3839 * The CXSourceRange will point inside the file; if the reference is inside
3840 * a macro (and not a macro argument) the CXSourceRange will be invalid.
3842 CINDEX_LINKAGE void clang_findReferencesInFile(CXCursor cursor, CXFile file,
3843 CXCursorAndRangeVisitor visitor);
3845 #ifdef __has_feature
3846 # if __has_feature(blocks)
3848 typedef enum CXVisitorResult
3849 (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
3852 void clang_findReferencesInFileWithBlock(CXCursor, CXFile,
3853 CXCursorAndRangeVisitorBlock);