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
122 * \defgroup CINDEX_STRING String manipulation routines
128 * \brief A character string.
130 * The \c CXString type is used to return strings from the interface when
131 * the ownership of that string might different from one call to the next.
132 * Use \c clang_getCString() to retrieve the string data and, once finished
133 * with the string data, call \c clang_disposeString() to free the string.
137 unsigned private_flags;
141 * \brief Retrieve the character data associated with the given string.
143 CINDEX_LINKAGE const char *clang_getCString(CXString string);
146 * \brief Free the given string,
148 CINDEX_LINKAGE void clang_disposeString(CXString string);
155 * \brief clang_createIndex() provides a shared context for creating
156 * translation units. It provides two options:
158 * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
159 * declarations (when loading any new translation units). A "local" declaration
160 * is one that belongs in the translation unit itself and not in a precompiled
161 * header that was used by the translation unit. If zero, all declarations
162 * will be enumerated.
164 * Here is an example:
166 * // excludeDeclsFromPCH = 1, displayDiagnostics=1
167 * Idx = clang_createIndex(1, 1);
169 * // IndexTest.pch was produced with the following command:
170 * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
171 * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
173 * // This will load all the symbols from 'IndexTest.pch'
174 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
175 * TranslationUnitVisitor, 0);
176 * clang_disposeTranslationUnit(TU);
178 * // This will load all the symbols from 'IndexTest.c', excluding symbols
179 * // from 'IndexTest.pch'.
180 * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
181 * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
183 * clang_visitChildren(clang_getTranslationUnitCursor(TU),
184 * TranslationUnitVisitor, 0);
185 * clang_disposeTranslationUnit(TU);
187 * This process of creating the 'pch', loading it separately, and using it (via
188 * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
189 * (which gives the indexer the same performance benefit as the compiler).
191 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
192 int displayDiagnostics);
195 * \brief Destroy the given index.
197 * The index must not be destroyed until all of the translation units created
198 * within that index have been destroyed.
200 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
203 * \defgroup CINDEX_FILES File manipulation routines
209 * \brief A particular source file that is part of a translation unit.
211 typedef void *CXFile;
215 * \brief Retrieve the complete file and path name of the given file.
217 CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
220 * \brief Retrieve the last modification time of the given file.
222 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
225 * \brief Determine whether the given header is guarded against
226 * multiple inclusions, either with the conventional
227 * #ifndef/#define/#endif macro guards or with #pragma once.
229 CINDEX_LINKAGE unsigned
230 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
233 * \brief Retrieve a file handle within the given translation unit.
235 * \param tu the translation unit
237 * \param file_name the name of the file.
239 * \returns the file handle for the named file in the translation unit \p tu,
240 * or a NULL file handle if the file was not a part of this translation unit.
242 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
243 const char *file_name);
250 * \defgroup CINDEX_LOCATIONS Physical source locations
252 * Clang represents physical source locations in its abstract syntax tree in
253 * great detail, with file, line, and column information for the majority of
254 * the tokens parsed in the source code. These data types and functions are
255 * used to represent source location information, either for a particular
256 * point in the program or for a range of points in the program, and extract
257 * specific location information from those data types.
263 * \brief Identifies a specific source location within a translation
266 * Use clang_getInstantiationLocation() or clang_getSpellingLocation()
267 * to map a source location to a particular file, line, and column.
275 * \brief Identifies a half-open character range in the source code.
277 * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
278 * starting and end locations from a source range, respectively.
282 unsigned begin_int_data;
283 unsigned end_int_data;
287 * \brief Retrieve a NULL (invalid) source location.
289 CINDEX_LINKAGE CXSourceLocation clang_getNullLocation();
292 * \determine Determine whether two source locations, which must refer into
293 * the same translation unit, refer to exactly the same point in the source
296 * \returns non-zero if the source locations refer to the same location, zero
297 * if they refer to different locations.
299 CINDEX_LINKAGE unsigned clang_equalLocations(CXSourceLocation loc1,
300 CXSourceLocation loc2);
303 * \brief Retrieves the source location associated with a given file/line/column
304 * in a particular translation unit.
306 CINDEX_LINKAGE CXSourceLocation clang_getLocation(CXTranslationUnit tu,
311 * \brief Retrieves the source location associated with a given character offset
312 * in a particular translation unit.
314 CINDEX_LINKAGE CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
319 * \brief Retrieve a NULL (invalid) source range.
321 CINDEX_LINKAGE CXSourceRange clang_getNullRange();
324 * \brief Retrieve a source range given the beginning and ending source
327 CINDEX_LINKAGE CXSourceRange clang_getRange(CXSourceLocation begin,
328 CXSourceLocation end);
331 * \brief Retrieve the file, line, column, and offset represented by
332 * the given source location.
334 * If the location refers into a macro instantiation, retrieves the
335 * location of the macro instantiation.
337 * \param location the location within a source file that will be decomposed
340 * \param file [out] if non-NULL, will be set to the file to which the given
341 * source location points.
343 * \param line [out] if non-NULL, will be set to the line to which the given
344 * source location points.
346 * \param column [out] if non-NULL, will be set to the column to which the given
347 * source location points.
349 * \param offset [out] if non-NULL, will be set to the offset into the
350 * buffer to which the given source location points.
352 CINDEX_LINKAGE void clang_getInstantiationLocation(CXSourceLocation location,
359 * \brief Retrieve the file, line, column, and offset represented by
360 * the given source location.
362 * If the location refers into a macro instantiation, return where the
363 * location was originally spelled in the source file.
365 * \param location the location within a source file that will be decomposed
368 * \param file [out] if non-NULL, will be set to the file to which the given
369 * source location points.
371 * \param line [out] if non-NULL, will be set to the line to which the given
372 * source location points.
374 * \param column [out] if non-NULL, will be set to the column to which the given
375 * source location points.
377 * \param offset [out] if non-NULL, will be set to the offset into the
378 * buffer to which the given source location points.
380 CINDEX_LINKAGE void clang_getSpellingLocation(CXSourceLocation location,
387 * \brief Retrieve a source location representing the first character within a
390 CINDEX_LINKAGE CXSourceLocation clang_getRangeStart(CXSourceRange range);
393 * \brief Retrieve a source location representing the last character within a
396 CINDEX_LINKAGE CXSourceLocation clang_getRangeEnd(CXSourceRange range);
403 * \defgroup CINDEX_DIAG Diagnostic reporting
409 * \brief Describes the severity of a particular diagnostic.
411 enum CXDiagnosticSeverity {
413 * \brief A diagnostic that has been suppressed, e.g., by a command-line
416 CXDiagnostic_Ignored = 0,
419 * \brief This diagnostic is a note that should be attached to the
420 * previous (non-note) diagnostic.
422 CXDiagnostic_Note = 1,
425 * \brief This diagnostic indicates suspicious code that may not be
428 CXDiagnostic_Warning = 2,
431 * \brief This diagnostic indicates that the code is ill-formed.
433 CXDiagnostic_Error = 3,
436 * \brief This diagnostic indicates that the code is ill-formed such
437 * that future parser recovery is unlikely to produce useful
440 CXDiagnostic_Fatal = 4
444 * \brief A single diagnostic, containing the diagnostic's severity,
445 * location, text, source ranges, and fix-it hints.
447 typedef void *CXDiagnostic;
450 * \brief Determine the number of diagnostics produced for the given
453 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
456 * \brief Retrieve a diagnostic associated with the given translation unit.
458 * \param Unit the translation unit to query.
459 * \param Index the zero-based diagnostic number to retrieve.
461 * \returns the requested diagnostic. This diagnostic must be freed
462 * via a call to \c clang_disposeDiagnostic().
464 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
468 * \brief Destroy a diagnostic.
470 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
473 * \brief Options to control the display of diagnostics.
475 * The values in this enum are meant to be combined to customize the
476 * behavior of \c clang_displayDiagnostic().
478 enum CXDiagnosticDisplayOptions {
480 * \brief Display the source-location information where the
481 * diagnostic was located.
483 * When set, diagnostics will be prefixed by the file, line, and
484 * (optionally) column to which the diagnostic refers. For example,
487 * test.c:28: warning: extra tokens at end of #endif directive
490 * This option corresponds to the clang flag \c -fshow-source-location.
492 CXDiagnostic_DisplaySourceLocation = 0x01,
495 * \brief If displaying the source-location information of the
496 * diagnostic, also include the column number.
498 * This option corresponds to the clang flag \c -fshow-column.
500 CXDiagnostic_DisplayColumn = 0x02,
503 * \brief If displaying the source-location information of the
504 * diagnostic, also include information about source ranges in a
505 * machine-parsable format.
507 * This option corresponds to the clang flag
508 * \c -fdiagnostics-print-source-range-info.
510 CXDiagnostic_DisplaySourceRanges = 0x04,
513 * \brief Display the option name associated with this diagnostic, if any.
515 * The option name displayed (e.g., -Wconversion) will be placed in brackets
516 * after the diagnostic text. This option corresponds to the clang flag
517 * \c -fdiagnostics-show-option.
519 CXDiagnostic_DisplayOption = 0x08,
522 * \brief Display the category number associated with this diagnostic, if any.
524 * The category number is displayed within brackets after the diagnostic text.
525 * This option corresponds to the clang flag
526 * \c -fdiagnostics-show-category=id.
528 CXDiagnostic_DisplayCategoryId = 0x10,
531 * \brief Display the category name associated with this diagnostic, if any.
533 * The category name is displayed within brackets after the diagnostic text.
534 * This option corresponds to the clang flag
535 * \c -fdiagnostics-show-category=name.
537 CXDiagnostic_DisplayCategoryName = 0x20
541 * \brief Format the given diagnostic in a manner that is suitable for display.
543 * This routine will format the given diagnostic to a string, rendering
544 * the diagnostic according to the various options given. The
545 * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
546 * options that most closely mimics the behavior of the clang compiler.
548 * \param Diagnostic The diagnostic to print.
550 * \param Options A set of options that control the diagnostic display,
551 * created by combining \c CXDiagnosticDisplayOptions values.
553 * \returns A new string containing for formatted diagnostic.
555 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
559 * \brief Retrieve the set of display options most similar to the
560 * default behavior of the clang compiler.
562 * \returns A set of display options suitable for use with \c
563 * clang_displayDiagnostic().
565 CINDEX_LINKAGE unsigned clang_defaultDiagnosticDisplayOptions(void);
568 * \brief Determine the severity of the given diagnostic.
570 CINDEX_LINKAGE enum CXDiagnosticSeverity
571 clang_getDiagnosticSeverity(CXDiagnostic);
574 * \brief Retrieve the source location of the given diagnostic.
576 * This location is where Clang would print the caret ('^') when
577 * displaying the diagnostic on the command line.
579 CINDEX_LINKAGE CXSourceLocation clang_getDiagnosticLocation(CXDiagnostic);
582 * \brief Retrieve the text of the given diagnostic.
584 CINDEX_LINKAGE CXString clang_getDiagnosticSpelling(CXDiagnostic);
587 * \brief Retrieve the name of the command-line option that enabled this
590 * \param Diag The diagnostic to be queried.
592 * \param Disable If non-NULL, will be set to the option that disables this
593 * diagnostic (if any).
595 * \returns A string that contains the command-line option used to enable this
596 * warning, such as "-Wconversion" or "-pedantic".
598 CINDEX_LINKAGE CXString clang_getDiagnosticOption(CXDiagnostic Diag,
602 * \brief Retrieve the category number for this diagnostic.
604 * Diagnostics can be categorized into groups along with other, related
605 * diagnostics (e.g., diagnostics under the same warning flag). This routine
606 * retrieves the category number for the given diagnostic.
608 * \returns The number of the category that contains this diagnostic, or zero
609 * if this diagnostic is uncategorized.
611 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
614 * \brief Retrieve the name of a particular diagnostic category.
616 * \param Category A diagnostic category number, as returned by
617 * \c clang_getDiagnosticCategory().
619 * \returns The name of the given diagnostic category.
621 CINDEX_LINKAGE CXString clang_getDiagnosticCategoryName(unsigned Category);
624 * \brief Determine the number of source ranges associated with the given
627 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
630 * \brief Retrieve a source range associated with the diagnostic.
632 * A diagnostic's source ranges highlight important elements in the source
633 * code. On the command line, Clang displays source ranges by
634 * underlining them with '~' characters.
636 * \param Diagnostic the diagnostic whose range is being extracted.
638 * \param Range the zero-based index specifying which range to
640 * \returns the requested source range.
642 CINDEX_LINKAGE CXSourceRange clang_getDiagnosticRange(CXDiagnostic Diagnostic,
646 * \brief Determine the number of fix-it hints associated with the
649 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
652 * \brief Retrieve the replacement information for a given fix-it.
654 * Fix-its are described in terms of a source range whose contents
655 * should be replaced by a string. This approach generalizes over
656 * three kinds of operations: removal of source code (the range covers
657 * the code to be removed and the replacement string is empty),
658 * replacement of source code (the range covers the code to be
659 * replaced and the replacement string provides the new code), and
660 * insertion (both the start and end of the range point at the
661 * insertion location, and the replacement string provides the text to
664 * \param Diagnostic The diagnostic whose fix-its are being queried.
666 * \param FixIt The zero-based index of the fix-it.
668 * \param ReplacementRange The source range whose contents will be
669 * replaced with the returned replacement string. Note that source
670 * ranges are half-open ranges [a, b), so the source code should be
671 * replaced from a and up to (but not including) b.
673 * \returns A string containing text that should be replace the source
674 * code indicated by the \c ReplacementRange.
676 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
678 CXSourceRange *ReplacementRange);
685 * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
687 * The routines in this group provide the ability to create and destroy
688 * translation units from files, either by parsing the contents of the files or
689 * by reading in a serialized representation of a translation unit.
695 * \brief Get the original translation unit source file name.
697 CINDEX_LINKAGE CXString
698 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
701 * \brief Return the CXTranslationUnit for a given source file and the provided
702 * command line arguments one would pass to the compiler.
704 * Note: The 'source_filename' argument is optional. If the caller provides a
705 * NULL pointer, the name of the source file is expected to reside in the
706 * specified command line arguments.
708 * Note: When encountered in 'clang_command_line_args', the following options
714 * '-o <output file>' (both '-o' and '<output file>' are ignored)
716 * \param CIdx The index object with which the translation unit will be
719 * \param source_filename - The name of the source file to load, or NULL if the
720 * source file is included in \p clang_command_line_args.
722 * \param num_clang_command_line_args The number of command-line arguments in
723 * \p clang_command_line_args.
725 * \param clang_command_line_args The command-line arguments that would be
726 * passed to the \c clang executable if it were being invoked out-of-process.
727 * These command-line options will be parsed and will affect how the translation
728 * unit is parsed. Note that the following options are ignored: '-c',
729 * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'.
731 * \param num_unsaved_files the number of unsaved file entries in \p
734 * \param unsaved_files the files that have not yet been saved to disk
735 * but may be required for code completion, including the contents of
736 * those files. The contents and name of these files (as specified by
737 * CXUnsavedFile) are copied when necessary, so the client only needs to
738 * guarantee their validity until the call to this function returns.
740 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnitFromSourceFile(
742 const char *source_filename,
743 int num_clang_command_line_args,
744 const char * const *clang_command_line_args,
745 unsigned num_unsaved_files,
746 struct CXUnsavedFile *unsaved_files);
749 * \brief Create a translation unit from an AST file (-emit-ast).
751 CINDEX_LINKAGE CXTranslationUnit clang_createTranslationUnit(CXIndex,
752 const char *ast_filename);
755 * \brief Flags that control the creation of translation units.
757 * The enumerators in this enumeration type are meant to be bitwise
758 * ORed together to specify which options should be used when
759 * constructing the translation unit.
761 enum CXTranslationUnit_Flags {
763 * \brief Used to indicate that no special translation-unit options are
766 CXTranslationUnit_None = 0x0,
769 * \brief Used to indicate that the parser should construct a "detailed"
770 * preprocessing record, including all macro definitions and instantiations.
772 * Constructing a detailed preprocessing record requires more memory
773 * and time to parse, since the information contained in the record
774 * is usually not retained. However, it can be useful for
775 * applications that require more detailed information about the
776 * behavior of the preprocessor.
778 CXTranslationUnit_DetailedPreprocessingRecord = 0x01,
781 * \brief Used to indicate that the translation unit is incomplete.
783 * When a translation unit is considered "incomplete", semantic
784 * analysis that is typically performed at the end of the
785 * translation unit will be suppressed. For example, this suppresses
786 * the completion of tentative declarations in C and of
787 * instantiation of implicitly-instantiation function templates in
788 * C++. This option is typically used when parsing a header with the
789 * intent of producing a precompiled header.
791 CXTranslationUnit_Incomplete = 0x02,
794 * \brief Used to indicate that the translation unit should be built with an
795 * implicit precompiled header for the preamble.
797 * An implicit precompiled header is used as an optimization when a
798 * particular translation unit is likely to be reparsed many times
799 * when the sources aren't changing that often. In this case, an
800 * implicit precompiled header will be built containing all of the
801 * initial includes at the top of the main file (what we refer to as
802 * the "preamble" of the file). In subsequent parses, if the
803 * preamble or the files in it have not changed, \c
804 * clang_reparseTranslationUnit() will re-use the implicit
805 * precompiled header to improve parsing performance.
807 CXTranslationUnit_PrecompiledPreamble = 0x04,
810 * \brief Used to indicate that the translation unit should cache some
811 * code-completion results with each reparse of the source file.
813 * Caching of code-completion results is a performance optimization that
814 * introduces some overhead to reparsing but improves the performance of
815 * code-completion operations.
817 CXTranslationUnit_CacheCompletionResults = 0x08,
819 * \brief Enable precompiled preambles in C++.
821 * Note: this is a *temporary* option that is available only while
822 * we are testing C++ precompiled preamble support.
824 CXTranslationUnit_CXXPrecompiledPreamble = 0x10,
827 * \brief Enabled chained precompiled preambles in C++.
829 * Note: this is a *temporary* option that is available only while
830 * we are testing C++ precompiled preamble support.
832 CXTranslationUnit_CXXChainedPCH = 0x20,
835 * \brief Used to indicate that the "detailed" preprocessing record,
836 * if requested, should also contain nested macro expansions.
838 * Nested macro expansions (i.e., macro expansions that occur
839 * inside another macro expansion) can, in some code bases, require
840 * a large amount of storage to due preprocessor metaprogramming. Moreover,
841 * its fairly rare that this information is useful for libclang clients.
843 CXTranslationUnit_NestedMacroExpansions = 0x40,
846 * \brief Legacy name to indicate that the "detailed" preprocessing record,
847 * if requested, should contain nested macro expansions.
849 * \see CXTranslationUnit_NestedMacroExpansions for the current name for this
850 * value, and its semantics. This is just an alias.
852 CXTranslationUnit_NestedMacroInstantiations =
853 CXTranslationUnit_NestedMacroExpansions
857 * \brief Returns the set of flags that is suitable for parsing a translation
858 * unit that is being edited.
860 * The set of flags returned provide options for \c clang_parseTranslationUnit()
861 * to indicate that the translation unit is likely to be reparsed many times,
862 * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
863 * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
864 * set contains an unspecified set of optimizations (e.g., the precompiled
865 * preamble) geared toward improving the performance of these routines. The
866 * set of optimizations enabled may change from one version to the next.
868 CINDEX_LINKAGE unsigned clang_defaultEditingTranslationUnitOptions(void);
871 * \brief Parse the given source file and the translation unit corresponding
874 * This routine is the main entry point for the Clang C API, providing the
875 * ability to parse a source file into a translation unit that can then be
876 * queried by other functions in the API. This routine accepts a set of
877 * command-line arguments so that the compilation can be configured in the same
878 * way that the compiler is configured on the command line.
880 * \param CIdx The index object with which the translation unit will be
883 * \param source_filename The name of the source file to load, or NULL if the
884 * source file is included in \p command_line_args.
886 * \param command_line_args The command-line arguments that would be
887 * passed to the \c clang executable if it were being invoked out-of-process.
888 * These command-line options will be parsed and will affect how the translation
889 * unit is parsed. Note that the following options are ignored: '-c',
890 * '-emit-ast', '-fsyntex-only' (which is the default), and '-o <output file>'.
892 * \param num_command_line_args The number of command-line arguments in
893 * \p command_line_args.
895 * \param unsaved_files the files that have not yet been saved to disk
896 * but may be required for parsing, including the contents of
897 * those files. The contents and name of these files (as specified by
898 * CXUnsavedFile) are copied when necessary, so the client only needs to
899 * guarantee their validity until the call to this function returns.
901 * \param num_unsaved_files the number of unsaved file entries in \p
904 * \param options A bitmask of options that affects how the translation unit
905 * is managed but not its compilation. This should be a bitwise OR of the
906 * CXTranslationUnit_XXX flags.
908 * \returns A new translation unit describing the parsed code and containing
909 * any diagnostics produced by the compiler. If there is a failure from which
910 * the compiler cannot recover, returns NULL.
912 CINDEX_LINKAGE CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
913 const char *source_filename,
914 const char * const *command_line_args,
915 int num_command_line_args,
916 struct CXUnsavedFile *unsaved_files,
917 unsigned num_unsaved_files,
921 * \brief Flags that control how translation units are saved.
923 * The enumerators in this enumeration type are meant to be bitwise
924 * ORed together to specify which options should be used when
925 * saving the translation unit.
927 enum CXSaveTranslationUnit_Flags {
929 * \brief Used to indicate that no special saving options are needed.
931 CXSaveTranslationUnit_None = 0x0
935 * \brief Returns the set of flags that is suitable for saving a translation
938 * The set of flags returned provide options for
939 * \c clang_saveTranslationUnit() by default. The returned flag
940 * set contains an unspecified set of options that save translation units with
941 * the most commonly-requested data.
943 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
946 * \brief Describes the kind of error that occurred (if any) in a call to
947 * \c clang_saveTranslationUnit().
951 * \brief Indicates that no error occurred while saving a translation unit.
953 CXSaveError_None = 0,
956 * \brief Indicates that an unknown error occurred while attempting to save
959 * This error typically indicates that file I/O failed when attempting to
962 CXSaveError_Unknown = 1,
965 * \brief Indicates that errors during translation prevented this attempt
966 * to save the translation unit.
968 * Errors that prevent the translation unit from being saved can be
969 * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
971 CXSaveError_TranslationErrors = 2,
974 * \brief Indicates that the translation unit to be saved was somehow
975 * invalid (e.g., NULL).
977 CXSaveError_InvalidTU = 3
981 * \brief Saves a translation unit into a serialized representation of
982 * that translation unit on disk.
984 * Any translation unit that was parsed without error can be saved
985 * into a file. The translation unit can then be deserialized into a
986 * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
987 * if it is an incomplete translation unit that corresponds to a
988 * header, used as a precompiled header when parsing other translation
991 * \param TU The translation unit to save.
993 * \param FileName The file to which the translation unit will be saved.
995 * \param options A bitmask of options that affects how the translation unit
996 * is saved. This should be a bitwise OR of the
997 * CXSaveTranslationUnit_XXX flags.
999 * \returns A value that will match one of the enumerators of the CXSaveError
1000 * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1001 * saved successfully, while a non-zero value indicates that a problem occurred.
1003 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1004 const char *FileName,
1008 * \brief Destroy the specified CXTranslationUnit object.
1010 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1013 * \brief Flags that control the reparsing of translation units.
1015 * The enumerators in this enumeration type are meant to be bitwise
1016 * ORed together to specify which options should be used when
1017 * reparsing the translation unit.
1019 enum CXReparse_Flags {
1021 * \brief Used to indicate that no special reparsing options are needed.
1023 CXReparse_None = 0x0
1027 * \brief Returns the set of flags that is suitable for reparsing a translation
1030 * The set of flags returned provide options for
1031 * \c clang_reparseTranslationUnit() by default. The returned flag
1032 * set contains an unspecified set of optimizations geared toward common uses
1033 * of reparsing. The set of optimizations enabled may change from one version
1036 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1039 * \brief Reparse the source files that produced this translation unit.
1041 * This routine can be used to re-parse the source files that originally
1042 * created the given translation unit, for example because those source files
1043 * have changed (either on disk or as passed via \p unsaved_files). The
1044 * source code will be reparsed with the same command-line options as it
1045 * was originally parsed.
1047 * Reparsing a translation unit invalidates all cursors and source locations
1048 * that refer into that translation unit. This makes reparsing a translation
1049 * unit semantically equivalent to destroying the translation unit and then
1050 * creating a new translation unit with the same command-line arguments.
1051 * However, it may be more efficient to reparse a translation
1052 * unit using this routine.
1054 * \param TU The translation unit whose contents will be re-parsed. The
1055 * translation unit must originally have been built with
1056 * \c clang_createTranslationUnitFromSourceFile().
1058 * \param num_unsaved_files The number of unsaved file entries in \p
1061 * \param unsaved_files The files that have not yet been saved to disk
1062 * but may be required for parsing, including the contents of
1063 * those files. The contents and name of these files (as specified by
1064 * CXUnsavedFile) are copied when necessary, so the client only needs to
1065 * guarantee their validity until the call to this function returns.
1067 * \param options A bitset of options composed of the flags in CXReparse_Flags.
1068 * The function \c clang_defaultReparseOptions() produces a default set of
1069 * options recommended for most uses, based on the translation unit.
1071 * \returns 0 if the sources could be reparsed. A non-zero value will be
1072 * returned if reparsing was impossible, such that the translation unit is
1073 * invalid. In such cases, the only valid call for \p TU is
1074 * \c clang_disposeTranslationUnit(TU).
1076 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1077 unsigned num_unsaved_files,
1078 struct CXUnsavedFile *unsaved_files,
1082 * \brief Categorizes how memory is being used by a translation unit.
1084 enum CXTUResourceUsageKind {
1085 CXTUResourceUsage_AST = 1,
1086 CXTUResourceUsage_Identifiers = 2,
1087 CXTUResourceUsage_Selectors = 3,
1088 CXTUResourceUsage_GlobalCompletionResults = 4,
1089 CXTUResourceUsage_SourceManagerContentCache = 5,
1090 CXTUResourceUsage_AST_SideTables = 6,
1091 CXTUResourceUsage_SourceManager_Membuffer_Malloc = 7,
1092 CXTUResourceUsage_SourceManager_Membuffer_MMap = 8,
1093 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc = 9,
1094 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap = 10,
1095 CXTUResourceUsage_Preprocessor = 11,
1096 CXTUResourceUsage_PreprocessingRecord = 12,
1097 CXTUResourceUsage_MEMORY_IN_BYTES_BEGIN = CXTUResourceUsage_AST,
1098 CXTUResourceUsage_MEMORY_IN_BYTES_END =
1099 CXTUResourceUsage_PreprocessingRecord,
1101 CXTUResourceUsage_First = CXTUResourceUsage_AST,
1102 CXTUResourceUsage_Last = CXTUResourceUsage_PreprocessingRecord
1106 * \brief Returns the human-readable null-terminated C string that represents
1107 * the name of the memory category. This string should never be freed.
1110 const char *clang_getTUResourceUsageName(enum CXTUResourceUsageKind kind);
1112 typedef struct CXTUResourceUsageEntry {
1113 /* \brief The memory usage category. */
1114 enum CXTUResourceUsageKind kind;
1115 /* \brief Amount of resources used.
1116 The units will depend on the resource kind. */
1117 unsigned long amount;
1118 } CXTUResourceUsageEntry;
1121 * \brief The memory usage of a CXTranslationUnit, broken into categories.
1123 typedef struct CXTUResourceUsage {
1124 /* \brief Private data member, used for queries. */
1127 /* \brief The number of entries in the 'entries' array. */
1128 unsigned numEntries;
1130 /* \brief An array of key-value pairs, representing the breakdown of memory
1132 CXTUResourceUsageEntry *entries;
1134 } CXTUResourceUsage;
1137 * \brief Return the memory usage of a translation unit. This object
1138 * should be released with clang_disposeCXTUResourceUsage().
1140 CINDEX_LINKAGE CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU);
1142 CINDEX_LINKAGE void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage);
1149 * \brief Describes the kind of entity that a cursor refers to.
1154 * \brief A declaration whose specific kind is not exposed via this
1157 * Unexposed declarations have the same operations as any other kind
1158 * of declaration; one can extract their location information,
1159 * spelling, find their definitions, etc. However, the specific kind
1160 * of the declaration is not reported.
1162 CXCursor_UnexposedDecl = 1,
1163 /** \brief A C or C++ struct. */
1164 CXCursor_StructDecl = 2,
1165 /** \brief A C or C++ union. */
1166 CXCursor_UnionDecl = 3,
1167 /** \brief A C++ class. */
1168 CXCursor_ClassDecl = 4,
1169 /** \brief An enumeration. */
1170 CXCursor_EnumDecl = 5,
1172 * \brief A field (in C) or non-static data member (in C++) in a
1173 * struct, union, or C++ class.
1175 CXCursor_FieldDecl = 6,
1176 /** \brief An enumerator constant. */
1177 CXCursor_EnumConstantDecl = 7,
1178 /** \brief A function. */
1179 CXCursor_FunctionDecl = 8,
1180 /** \brief A variable. */
1181 CXCursor_VarDecl = 9,
1182 /** \brief A function or method parameter. */
1183 CXCursor_ParmDecl = 10,
1184 /** \brief An Objective-C @interface. */
1185 CXCursor_ObjCInterfaceDecl = 11,
1186 /** \brief An Objective-C @interface for a category. */
1187 CXCursor_ObjCCategoryDecl = 12,
1188 /** \brief An Objective-C @protocol declaration. */
1189 CXCursor_ObjCProtocolDecl = 13,
1190 /** \brief An Objective-C @property declaration. */
1191 CXCursor_ObjCPropertyDecl = 14,
1192 /** \brief An Objective-C instance variable. */
1193 CXCursor_ObjCIvarDecl = 15,
1194 /** \brief An Objective-C instance method. */
1195 CXCursor_ObjCInstanceMethodDecl = 16,
1196 /** \brief An Objective-C class method. */
1197 CXCursor_ObjCClassMethodDecl = 17,
1198 /** \brief An Objective-C @implementation. */
1199 CXCursor_ObjCImplementationDecl = 18,
1200 /** \brief An Objective-C @implementation for a category. */
1201 CXCursor_ObjCCategoryImplDecl = 19,
1202 /** \brief A typedef */
1203 CXCursor_TypedefDecl = 20,
1204 /** \brief A C++ class method. */
1205 CXCursor_CXXMethod = 21,
1206 /** \brief A C++ namespace. */
1207 CXCursor_Namespace = 22,
1208 /** \brief A linkage specification, e.g. 'extern "C"'. */
1209 CXCursor_LinkageSpec = 23,
1210 /** \brief A C++ constructor. */
1211 CXCursor_Constructor = 24,
1212 /** \brief A C++ destructor. */
1213 CXCursor_Destructor = 25,
1214 /** \brief A C++ conversion function. */
1215 CXCursor_ConversionFunction = 26,
1216 /** \brief A C++ template type parameter. */
1217 CXCursor_TemplateTypeParameter = 27,
1218 /** \brief A C++ non-type template parameter. */
1219 CXCursor_NonTypeTemplateParameter = 28,
1220 /** \brief A C++ template template parameter. */
1221 CXCursor_TemplateTemplateParameter = 29,
1222 /** \brief A C++ function template. */
1223 CXCursor_FunctionTemplate = 30,
1224 /** \brief A C++ class template. */
1225 CXCursor_ClassTemplate = 31,
1226 /** \brief A C++ class template partial specialization. */
1227 CXCursor_ClassTemplatePartialSpecialization = 32,
1228 /** \brief A C++ namespace alias declaration. */
1229 CXCursor_NamespaceAlias = 33,
1230 /** \brief A C++ using directive. */
1231 CXCursor_UsingDirective = 34,
1232 /** \brief A C++ using declaration. */
1233 CXCursor_UsingDeclaration = 35,
1234 /** \brief A C++ alias declaration */
1235 CXCursor_TypeAliasDecl = 36,
1236 /** \brief An Objective-C @synthesize definition. */
1237 CXCursor_ObjCSynthesizeDecl = 37,
1238 /** \brief An Objective-C @dynamic definition. */
1239 CXCursor_ObjCDynamicDecl = 38,
1240 CXCursor_FirstDecl = CXCursor_UnexposedDecl,
1241 CXCursor_LastDecl = CXCursor_ObjCDynamicDecl,
1244 CXCursor_FirstRef = 40, /* Decl references */
1245 CXCursor_ObjCSuperClassRef = 40,
1246 CXCursor_ObjCProtocolRef = 41,
1247 CXCursor_ObjCClassRef = 42,
1249 * \brief A reference to a type declaration.
1251 * A type reference occurs anywhere where a type is named but not
1252 * declared. For example, given:
1255 * typedef unsigned size_type;
1259 * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1260 * while the type of the variable "size" is referenced. The cursor
1261 * referenced by the type of size is the typedef for size_type.
1263 CXCursor_TypeRef = 43,
1264 CXCursor_CXXBaseSpecifier = 44,
1266 * \brief A reference to a class template, function template, template
1267 * template parameter, or class template partial specialization.
1269 CXCursor_TemplateRef = 45,
1271 * \brief A reference to a namespace or namespace alias.
1273 CXCursor_NamespaceRef = 46,
1275 * \brief A reference to a member of a struct, union, or class that occurs in
1276 * some non-expression context, e.g., a designated initializer.
1278 CXCursor_MemberRef = 47,
1280 * \brief A reference to a labeled statement.
1282 * This cursor kind is used to describe the jump to "start_over" in the
1283 * goto statement in the following example:
1292 * A label reference cursor refers to a label statement.
1294 CXCursor_LabelRef = 48,
1297 * \brief A reference to a set of overloaded functions or function templates
1298 * that has not yet been resolved to a specific function or function template.
1300 * An overloaded declaration reference cursor occurs in C++ templates where
1301 * a dependent name refers to a function. For example:
1304 * template<typename T> void swap(T&, T&);
1307 * void swap(X&, X&);
1309 * template<typename T>
1310 * void reverse(T* first, T* last) {
1311 * while (first < last - 1) {
1312 * swap(*first, *--last);
1318 * void swap(Y&, Y&);
1321 * Here, the identifier "swap" is associated with an overloaded declaration
1322 * reference. In the template definition, "swap" refers to either of the two
1323 * "swap" functions declared above, so both results will be available. At
1324 * instantiation time, "swap" may also refer to other functions found via
1325 * argument-dependent lookup (e.g., the "swap" function at the end of the
1328 * The functions \c clang_getNumOverloadedDecls() and
1329 * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1330 * referenced by this cursor.
1332 CXCursor_OverloadedDeclRef = 49,
1334 CXCursor_LastRef = CXCursor_OverloadedDeclRef,
1336 /* Error conditions */
1337 CXCursor_FirstInvalid = 70,
1338 CXCursor_InvalidFile = 70,
1339 CXCursor_NoDeclFound = 71,
1340 CXCursor_NotImplemented = 72,
1341 CXCursor_InvalidCode = 73,
1342 CXCursor_LastInvalid = CXCursor_InvalidCode,
1345 CXCursor_FirstExpr = 100,
1348 * \brief An expression whose specific kind is not exposed via this
1351 * Unexposed expressions have the same operations as any other kind
1352 * of expression; one can extract their location information,
1353 * spelling, children, etc. However, the specific kind of the
1354 * expression is not reported.
1356 CXCursor_UnexposedExpr = 100,
1359 * \brief An expression that refers to some value declaration, such
1360 * as a function, varible, or enumerator.
1362 CXCursor_DeclRefExpr = 101,
1365 * \brief An expression that refers to a member of a struct, union,
1366 * class, Objective-C class, etc.
1368 CXCursor_MemberRefExpr = 102,
1370 /** \brief An expression that calls a function. */
1371 CXCursor_CallExpr = 103,
1373 /** \brief An expression that sends a message to an Objective-C
1375 CXCursor_ObjCMessageExpr = 104,
1377 /** \brief An expression that represents a block literal. */
1378 CXCursor_BlockExpr = 105,
1380 CXCursor_LastExpr = 105,
1383 CXCursor_FirstStmt = 200,
1385 * \brief A statement whose specific kind is not exposed via this
1388 * Unexposed statements have the same operations as any other kind of
1389 * statement; one can extract their location information, spelling,
1390 * children, etc. However, the specific kind of the statement is not
1393 CXCursor_UnexposedStmt = 200,
1395 /** \brief A labelled statement in a function.
1397 * This cursor kind is used to describe the "start_over:" label statement in
1398 * the following example:
1406 CXCursor_LabelStmt = 201,
1408 CXCursor_LastStmt = CXCursor_LabelStmt,
1411 * \brief Cursor that represents the translation unit itself.
1413 * The translation unit cursor exists primarily to act as the root
1414 * cursor for traversing the contents of a translation unit.
1416 CXCursor_TranslationUnit = 300,
1419 CXCursor_FirstAttr = 400,
1421 * \brief An attribute whose specific kind is not exposed via this
1424 CXCursor_UnexposedAttr = 400,
1426 CXCursor_IBActionAttr = 401,
1427 CXCursor_IBOutletAttr = 402,
1428 CXCursor_IBOutletCollectionAttr = 403,
1429 CXCursor_LastAttr = CXCursor_IBOutletCollectionAttr,
1432 CXCursor_PreprocessingDirective = 500,
1433 CXCursor_MacroDefinition = 501,
1434 CXCursor_MacroExpansion = 502,
1435 CXCursor_MacroInstantiation = CXCursor_MacroExpansion,
1436 CXCursor_InclusionDirective = 503,
1437 CXCursor_FirstPreprocessing = CXCursor_PreprocessingDirective,
1438 CXCursor_LastPreprocessing = CXCursor_InclusionDirective
1442 * \brief A cursor representing some element in the abstract syntax tree for
1443 * a translation unit.
1445 * The cursor abstraction unifies the different kinds of entities in a
1446 * program--declaration, statements, expressions, references to declarations,
1447 * etc.--under a single "cursor" abstraction with a common set of operations.
1448 * Common operation for a cursor include: getting the physical location in
1449 * a source file where the cursor points, getting the name associated with a
1450 * cursor, and retrieving cursors for any child nodes of a particular cursor.
1452 * Cursors can be produced in two specific ways.
1453 * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
1454 * from which one can use clang_visitChildren() to explore the rest of the
1455 * translation unit. clang_getCursor() maps from a physical source location
1456 * to the entity that resides at that location, allowing one to map from the
1457 * source code into the AST.
1460 enum CXCursorKind kind;
1465 * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
1471 * \brief Retrieve the NULL cursor, which represents no entity.
1473 CINDEX_LINKAGE CXCursor clang_getNullCursor(void);
1476 * \brief Retrieve the cursor that represents the given translation unit.
1478 * The translation unit cursor can be used to start traversing the
1479 * various declarations within the given translation unit.
1481 CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
1484 * \brief Determine whether two cursors are equivalent.
1486 CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
1489 * \brief Compute a hash value for the given cursor.
1491 CINDEX_LINKAGE unsigned clang_hashCursor(CXCursor);
1494 * \brief Retrieve the kind of the given cursor.
1496 CINDEX_LINKAGE enum CXCursorKind clang_getCursorKind(CXCursor);
1499 * \brief Determine whether the given cursor kind represents a declaration.
1501 CINDEX_LINKAGE unsigned clang_isDeclaration(enum CXCursorKind);
1504 * \brief Determine whether the given cursor kind represents a simple
1507 * Note that other kinds of cursors (such as expressions) can also refer to
1508 * other cursors. Use clang_getCursorReferenced() to determine whether a
1509 * particular cursor refers to another entity.
1511 CINDEX_LINKAGE unsigned clang_isReference(enum CXCursorKind);
1514 * \brief Determine whether the given cursor kind represents an expression.
1516 CINDEX_LINKAGE unsigned clang_isExpression(enum CXCursorKind);
1519 * \brief Determine whether the given cursor kind represents a statement.
1521 CINDEX_LINKAGE unsigned clang_isStatement(enum CXCursorKind);
1524 * \brief Determine whether the given cursor kind represents an attribute.
1526 CINDEX_LINKAGE unsigned clang_isAttribute(enum CXCursorKind);
1529 * \brief Determine whether the given cursor kind represents an invalid
1532 CINDEX_LINKAGE unsigned clang_isInvalid(enum CXCursorKind);
1535 * \brief Determine whether the given cursor kind represents a translation
1538 CINDEX_LINKAGE unsigned clang_isTranslationUnit(enum CXCursorKind);
1541 * \brief Determine whether the given cursor represents a preprocessing
1542 * element, such as a preprocessor directive or macro instantiation.
1544 CINDEX_LINKAGE unsigned clang_isPreprocessing(enum CXCursorKind);
1547 * \brief Determine whether the given cursor represents a currently
1548 * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
1550 CINDEX_LINKAGE unsigned clang_isUnexposed(enum CXCursorKind);
1553 * \brief Describe the linkage of the entity referred to by a cursor.
1555 enum CXLinkageKind {
1556 /** \brief This value indicates that no linkage information is available
1557 * for a provided CXCursor. */
1560 * \brief This is the linkage for variables, parameters, and so on that
1561 * have automatic storage. This covers normal (non-extern) local variables.
1563 CXLinkage_NoLinkage,
1564 /** \brief This is the linkage for static variables and static functions. */
1566 /** \brief This is the linkage for entities with external linkage that live
1567 * in C++ anonymous namespaces.*/
1568 CXLinkage_UniqueExternal,
1569 /** \brief This is the linkage for entities with true, external linkage. */
1574 * \brief Determine the linkage of the entity referred to by a given cursor.
1576 CINDEX_LINKAGE enum CXLinkageKind clang_getCursorLinkage(CXCursor cursor);
1579 * \brief Determine the availability of the entity that this cursor refers to.
1581 * \param cursor The cursor to query.
1583 * \returns The availability of the cursor.
1585 CINDEX_LINKAGE enum CXAvailabilityKind
1586 clang_getCursorAvailability(CXCursor cursor);
1589 * \brief Describe the "language" of the entity referred to by a cursor.
1591 CINDEX_LINKAGE enum CXLanguageKind {
1592 CXLanguage_Invalid = 0,
1595 CXLanguage_CPlusPlus
1599 * \brief Determine the "language" of the entity referred to by a given cursor.
1601 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
1605 * \brief A fast container representing a set of CXCursors.
1607 typedef struct CXCursorSetImpl *CXCursorSet;
1610 * \brief Creates an empty CXCursorSet.
1612 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet();
1615 * \brief Disposes a CXCursorSet and releases its associated memory.
1617 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
1620 * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
1622 * \returns non-zero if the set contains the specified cursor.
1624 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
1628 * \brief Inserts a CXCursor into a CXCursorSet.
1630 * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
1632 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
1636 * \brief Determine the semantic parent of the given cursor.
1638 * The semantic parent of a cursor is the cursor that semantically contains
1639 * the given \p cursor. For many declarations, the lexical and semantic parents
1640 * are equivalent (the lexical parent is returned by
1641 * \c clang_getCursorLexicalParent()). They diverge when declarations or
1642 * definitions are provided out-of-line. For example:
1652 * In the out-of-line definition of \c C::f, the semantic parent is the
1653 * the class \c C, of which this function is a member. The lexical parent is
1654 * the place where the declaration actually occurs in the source code; in this
1655 * case, the definition occurs in the translation unit. In general, the
1656 * lexical parent for a given entity can change without affecting the semantics
1657 * of the program, and the lexical parent of different declarations of the
1658 * same entity may be different. Changing the semantic parent of a declaration,
1659 * on the other hand, can have a major impact on semantics, and redeclarations
1660 * of a particular entity should all have the same semantic context.
1662 * In the example above, both declarations of \c C::f have \c C as their
1663 * semantic context, while the lexical context of the first \c C::f is \c C
1664 * and the lexical context of the second \c C::f is the translation unit.
1666 * For global declarations, the semantic parent is the translation unit.
1668 CINDEX_LINKAGE CXCursor clang_getCursorSemanticParent(CXCursor cursor);
1671 * \brief Determine the lexical parent of the given cursor.
1673 * The lexical parent of a cursor is the cursor in which the given \p cursor
1674 * was actually written. For many declarations, the lexical and semantic parents
1675 * are equivalent (the semantic parent is returned by
1676 * \c clang_getCursorSemanticParent()). They diverge when declarations or
1677 * definitions are provided out-of-line. For example:
1687 * In the out-of-line definition of \c C::f, the semantic parent is the
1688 * the class \c C, of which this function is a member. The lexical parent is
1689 * the place where the declaration actually occurs in the source code; in this
1690 * case, the definition occurs in the translation unit. In general, the
1691 * lexical parent for a given entity can change without affecting the semantics
1692 * of the program, and the lexical parent of different declarations of the
1693 * same entity may be different. Changing the semantic parent of a declaration,
1694 * on the other hand, can have a major impact on semantics, and redeclarations
1695 * of a particular entity should all have the same semantic context.
1697 * In the example above, both declarations of \c C::f have \c C as their
1698 * semantic context, while the lexical context of the first \c C::f is \c C
1699 * and the lexical context of the second \c C::f is the translation unit.
1701 * For declarations written in the global scope, the lexical parent is
1702 * the translation unit.
1704 CINDEX_LINKAGE CXCursor clang_getCursorLexicalParent(CXCursor cursor);
1707 * \brief Determine the set of methods that are overridden by the given
1710 * In both Objective-C and C++, a method (aka virtual member function,
1711 * in C++) can override a virtual method in a base class. For
1712 * Objective-C, a method is said to override any method in the class's
1713 * interface (if we're coming from an implementation), its protocols,
1714 * or its categories, that has the same selector and is of the same
1715 * kind (class or instance). If no such method exists, the search
1716 * continues to the class's superclass, its protocols, and its
1717 * categories, and so on.
1719 * For C++, a virtual member function overrides any virtual member
1720 * function with the same signature that occurs in its base
1721 * classes. With multiple inheritance, a virtual member function can
1722 * override several virtual member functions coming from different
1725 * In all cases, this function determines the immediate overridden
1726 * method, rather than all of the overridden methods. For example, if
1727 * a method is originally declared in a class A, then overridden in B
1728 * (which in inherits from A) and also in C (which inherited from B),
1729 * then the only overridden method returned from this function when
1730 * invoked on C's method will be B's method. The client may then
1731 * invoke this function again, given the previously-found overridden
1732 * methods, to map out the complete method-override set.
1734 * \param cursor A cursor representing an Objective-C or C++
1735 * method. This routine will compute the set of methods that this
1738 * \param overridden A pointer whose pointee will be replaced with a
1739 * pointer to an array of cursors, representing the set of overridden
1740 * methods. If there are no overridden methods, the pointee will be
1741 * set to NULL. The pointee must be freed via a call to
1742 * \c clang_disposeOverriddenCursors().
1744 * \param num_overridden A pointer to the number of overridden
1745 * functions, will be set to the number of overridden functions in the
1746 * array pointed to by \p overridden.
1748 CINDEX_LINKAGE void clang_getOverriddenCursors(CXCursor cursor,
1749 CXCursor **overridden,
1750 unsigned *num_overridden);
1753 * \brief Free the set of overridden cursors returned by \c
1754 * clang_getOverriddenCursors().
1756 CINDEX_LINKAGE void clang_disposeOverriddenCursors(CXCursor *overridden);
1759 * \brief Retrieve the file that is included by the given inclusion directive
1762 CINDEX_LINKAGE CXFile clang_getIncludedFile(CXCursor cursor);
1769 * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
1771 * Cursors represent a location within the Abstract Syntax Tree (AST). These
1772 * routines help map between cursors and the physical locations where the
1773 * described entities occur in the source code. The mapping is provided in
1774 * both directions, so one can map from source code to the AST and back.
1780 * \brief Map a source location to the cursor that describes the entity at that
1781 * location in the source code.
1783 * clang_getCursor() maps an arbitrary source location within a translation
1784 * unit down to the most specific cursor that describes the entity at that
1785 * location. For example, given an expression \c x + y, invoking
1786 * clang_getCursor() with a source location pointing to "x" will return the
1787 * cursor for "x"; similarly for "y". If the cursor points anywhere between
1788 * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
1789 * will return a cursor referring to the "+" expression.
1791 * \returns a cursor representing the entity at the given source location, or
1792 * a NULL cursor if no such entity can be found.
1794 CINDEX_LINKAGE CXCursor clang_getCursor(CXTranslationUnit, CXSourceLocation);
1797 * \brief Retrieve the physical location of the source constructor referenced
1798 * by the given cursor.
1800 * The location of a declaration is typically the location of the name of that
1801 * declaration, where the name of that declaration would occur if it is
1802 * unnamed, or some keyword that introduces that particular declaration.
1803 * The location of a reference is where that reference occurs within the
1806 CINDEX_LINKAGE CXSourceLocation clang_getCursorLocation(CXCursor);
1809 * \brief Retrieve the physical extent of the source construct referenced by
1812 * The extent of a cursor starts with the file/line/column pointing at the
1813 * first character within the source construct that the cursor refers to and
1814 * ends with the last character withinin that source construct. For a
1815 * declaration, the extent covers the declaration itself. For a reference,
1816 * the extent covers the location of the reference (e.g., where the referenced
1817 * entity was actually used).
1819 CINDEX_LINKAGE CXSourceRange clang_getCursorExtent(CXCursor);
1826 * \defgroup CINDEX_TYPES Type information for CXCursors
1832 * \brief Describes the kind of type
1836 * \brief Reprents an invalid type (e.g., where no type is available).
1841 * \brief A type whose specific kind is not exposed via this
1844 CXType_Unexposed = 1,
1856 CXType_ULongLong = 11,
1857 CXType_UInt128 = 12,
1864 CXType_LongLong = 19,
1868 CXType_LongDouble = 23,
1869 CXType_NullPtr = 24,
1870 CXType_Overload = 25,
1871 CXType_Dependent = 26,
1873 CXType_ObjCClass = 28,
1874 CXType_ObjCSel = 29,
1875 CXType_FirstBuiltin = CXType_Void,
1876 CXType_LastBuiltin = CXType_ObjCSel,
1878 CXType_Complex = 100,
1879 CXType_Pointer = 101,
1880 CXType_BlockPointer = 102,
1881 CXType_LValueReference = 103,
1882 CXType_RValueReference = 104,
1883 CXType_Record = 105,
1885 CXType_Typedef = 107,
1886 CXType_ObjCInterface = 108,
1887 CXType_ObjCObjectPointer = 109,
1888 CXType_FunctionNoProto = 110,
1889 CXType_FunctionProto = 111
1893 * \brief The type of an element in the abstract syntax tree.
1897 enum CXTypeKind kind;
1902 * \brief Retrieve the type of a CXCursor (if any).
1904 CINDEX_LINKAGE CXType clang_getCursorType(CXCursor C);
1907 * \determine Determine whether two CXTypes represent the same type.
1909 * \returns non-zero if the CXTypes represent the same type and
1912 CINDEX_LINKAGE unsigned clang_equalTypes(CXType A, CXType B);
1915 * \brief Return the canonical type for a CXType.
1917 * Clang's type system explicitly models typedefs and all the ways
1918 * a specific type can be represented. The canonical type is the underlying
1919 * type with all the "sugar" removed. For example, if 'T' is a typedef
1920 * for 'int', the canonical type for 'T' would be 'int'.
1922 CINDEX_LINKAGE CXType clang_getCanonicalType(CXType T);
1925 * \determine Determine whether a CXType has the "const" qualifier set,
1926 * without looking through typedefs that may have added "const" at a different level.
1928 CINDEX_LINKAGE unsigned clang_isConstQualifiedType(CXType T);
1931 * \determine Determine whether a CXType has the "volatile" qualifier set,
1932 * without looking through typedefs that may have added "volatile" at a different level.
1934 CINDEX_LINKAGE unsigned clang_isVolatileQualifiedType(CXType T);
1937 * \determine Determine whether a CXType has the "restrict" qualifier set,
1938 * without looking through typedefs that may have added "restrict" at a different level.
1940 CINDEX_LINKAGE unsigned clang_isRestrictQualifiedType(CXType T);
1943 * \brief For pointer types, returns the type of the pointee.
1946 CINDEX_LINKAGE CXType clang_getPointeeType(CXType T);
1949 * \brief Return the cursor for the declaration of the given type.
1951 CINDEX_LINKAGE CXCursor clang_getTypeDeclaration(CXType T);
1954 * Returns the Objective-C type encoding for the specified declaration.
1956 CINDEX_LINKAGE CXString clang_getDeclObjCTypeEncoding(CXCursor C);
1959 * \brief Retrieve the spelling of a given CXTypeKind.
1961 CINDEX_LINKAGE CXString clang_getTypeKindSpelling(enum CXTypeKind K);
1964 * \brief Retrieve the result type associated with a function type.
1966 CINDEX_LINKAGE CXType clang_getResultType(CXType T);
1969 * \brief Retrieve the result type associated with a given cursor. This only
1970 * returns a valid type of the cursor refers to a function or method.
1972 CINDEX_LINKAGE CXType clang_getCursorResultType(CXCursor C);
1975 * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
1978 CINDEX_LINKAGE unsigned clang_isPODType(CXType T);
1981 * \brief Returns 1 if the base class specified by the cursor with kind
1982 * CX_CXXBaseSpecifier is virtual.
1984 CINDEX_LINKAGE unsigned clang_isVirtualBase(CXCursor);
1987 * \brief Represents the C++ access control level to a base class for a
1988 * cursor with kind CX_CXXBaseSpecifier.
1990 enum CX_CXXAccessSpecifier {
1991 CX_CXXInvalidAccessSpecifier,
1998 * \brief Returns the access control level for the C++ base specifier
1999 * represented by a cursor with kind CX_CXXBaseSpecifier.
2001 CINDEX_LINKAGE enum CX_CXXAccessSpecifier clang_getCXXAccessSpecifier(CXCursor);
2004 * \brief Determine the number of overloaded declarations referenced by a
2005 * \c CXCursor_OverloadedDeclRef cursor.
2007 * \param cursor The cursor whose overloaded declarations are being queried.
2009 * \returns The number of overloaded declarations referenced by \c cursor. If it
2010 * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
2012 CINDEX_LINKAGE unsigned clang_getNumOverloadedDecls(CXCursor cursor);
2015 * \brief Retrieve a cursor for one of the overloaded declarations referenced
2016 * by a \c CXCursor_OverloadedDeclRef cursor.
2018 * \param cursor The cursor whose overloaded declarations are being queried.
2020 * \param index The zero-based index into the set of overloaded declarations in
2023 * \returns A cursor representing the declaration referenced by the given
2024 * \c cursor at the specified \c index. If the cursor does not have an
2025 * associated set of overloaded declarations, or if the index is out of bounds,
2026 * returns \c clang_getNullCursor();
2028 CINDEX_LINKAGE CXCursor clang_getOverloadedDecl(CXCursor cursor,
2036 * \defgroup CINDEX_ATTRIBUTES Information for attributes
2043 * \brief For cursors representing an iboutletcollection attribute,
2044 * this function returns the collection element type.
2047 CINDEX_LINKAGE CXType clang_getIBOutletCollectionType(CXCursor);
2054 * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
2056 * These routines provide the ability to traverse the abstract syntax tree
2063 * \brief Describes how the traversal of the children of a particular
2064 * cursor should proceed after visiting a particular child cursor.
2066 * A value of this enumeration type should be returned by each
2067 * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
2069 enum CXChildVisitResult {
2071 * \brief Terminates the cursor traversal.
2075 * \brief Continues the cursor traversal with the next sibling of
2076 * the cursor just visited, without visiting its children.
2078 CXChildVisit_Continue,
2080 * \brief Recursively traverse the children of this cursor, using
2081 * the same visitor and client data.
2083 CXChildVisit_Recurse
2087 * \brief Visitor invoked for each cursor found by a traversal.
2089 * This visitor function will be invoked for each cursor found by
2090 * clang_visitCursorChildren(). Its first argument is the cursor being
2091 * visited, its second argument is the parent visitor for that cursor,
2092 * and its third argument is the client data provided to
2093 * clang_visitCursorChildren().
2095 * The visitor should return one of the \c CXChildVisitResult values
2096 * to direct clang_visitCursorChildren().
2098 typedef enum CXChildVisitResult (*CXCursorVisitor)(CXCursor cursor,
2100 CXClientData client_data);
2103 * \brief Visit the children of a particular cursor.
2105 * This function visits all the direct children of the given cursor,
2106 * invoking the given \p visitor function with the cursors of each
2107 * visited child. The traversal may be recursive, if the visitor returns
2108 * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
2109 * the visitor returns \c CXChildVisit_Break.
2111 * \param parent the cursor whose child may be visited. All kinds of
2112 * cursors can be visited, including invalid cursors (which, by
2113 * definition, have no children).
2115 * \param visitor the visitor function that will be invoked for each
2116 * child of \p parent.
2118 * \param client_data pointer data supplied by the client, which will
2119 * be passed to the visitor each time it is invoked.
2121 * \returns a non-zero value if the traversal was terminated
2122 * prematurely by the visitor returning \c CXChildVisit_Break.
2124 CINDEX_LINKAGE unsigned clang_visitChildren(CXCursor parent,
2125 CXCursorVisitor visitor,
2126 CXClientData client_data);
2127 #ifdef __has_feature
2128 # if __has_feature(blocks)
2130 * \brief Visitor invoked for each cursor found by a traversal.
2132 * This visitor block will be invoked for each cursor found by
2133 * clang_visitChildrenWithBlock(). Its first argument is the cursor being
2134 * visited, its second argument is the parent visitor for that cursor.
2136 * The visitor should return one of the \c CXChildVisitResult values
2137 * to direct clang_visitChildrenWithBlock().
2139 typedef enum CXChildVisitResult
2140 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
2143 * Visits the children of a cursor using the specified block. Behaves
2144 * identically to clang_visitChildren() in all other respects.
2146 unsigned clang_visitChildrenWithBlock(CXCursor parent,
2147 CXCursorVisitorBlock block);
2156 * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
2158 * These routines provide the ability to determine references within and
2159 * across translation units, by providing the names of the entities referenced
2160 * by cursors, follow reference cursors to the declarations they reference,
2161 * and associate declarations with their definitions.
2167 * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
2168 * by the given cursor.
2170 * A Unified Symbol Resolution (USR) is a string that identifies a particular
2171 * entity (function, class, variable, etc.) within a program. USRs can be
2172 * compared across translation units to determine, e.g., when references in
2173 * one translation refer to an entity defined in another translation unit.
2175 CINDEX_LINKAGE CXString clang_getCursorUSR(CXCursor);
2178 * \brief Construct a USR for a specified Objective-C class.
2180 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
2183 * \brief Construct a USR for a specified Objective-C category.
2185 CINDEX_LINKAGE CXString
2186 clang_constructUSR_ObjCCategory(const char *class_name,
2187 const char *category_name);
2190 * \brief Construct a USR for a specified Objective-C protocol.
2192 CINDEX_LINKAGE CXString
2193 clang_constructUSR_ObjCProtocol(const char *protocol_name);
2197 * \brief Construct a USR for a specified Objective-C instance variable and
2198 * the USR for its containing class.
2200 CINDEX_LINKAGE CXString clang_constructUSR_ObjCIvar(const char *name,
2204 * \brief Construct a USR for a specified Objective-C method and
2205 * the USR for its containing class.
2207 CINDEX_LINKAGE CXString clang_constructUSR_ObjCMethod(const char *name,
2208 unsigned isInstanceMethod,
2212 * \brief Construct a USR for a specified Objective-C property and the USR
2213 * for its containing class.
2215 CINDEX_LINKAGE CXString clang_constructUSR_ObjCProperty(const char *property,
2219 * \brief Retrieve a name for the entity referenced by this cursor.
2221 CINDEX_LINKAGE CXString clang_getCursorSpelling(CXCursor);
2224 * \brief Retrieve the display name for the entity referenced by this cursor.
2226 * The display name contains extra information that helps identify the cursor,
2227 * such as the parameters of a function or template or the arguments of a
2228 * class template specialization.
2230 CINDEX_LINKAGE CXString clang_getCursorDisplayName(CXCursor);
2232 /** \brief For a cursor that is a reference, retrieve a cursor representing the
2233 * entity that it references.
2235 * Reference cursors refer to other entities in the AST. For example, an
2236 * Objective-C superclass reference cursor refers to an Objective-C class.
2237 * This function produces the cursor for the Objective-C class from the
2238 * cursor for the superclass reference. If the input cursor is a declaration or
2239 * definition, it returns that declaration or definition unchanged.
2240 * Otherwise, returns the NULL cursor.
2242 CINDEX_LINKAGE CXCursor clang_getCursorReferenced(CXCursor);
2245 * \brief For a cursor that is either a reference to or a declaration
2246 * of some entity, retrieve a cursor that describes the definition of
2249 * Some entities can be declared multiple times within a translation
2250 * unit, but only one of those declarations can also be a
2251 * definition. For example, given:
2255 * int g(int x, int y) { return f(x, y); }
2256 * int f(int a, int b) { return a + b; }
2260 * there are three declarations of the function "f", but only the
2261 * second one is a definition. The clang_getCursorDefinition()
2262 * function will take any cursor pointing to a declaration of "f"
2263 * (the first or fourth lines of the example) or a cursor referenced
2264 * that uses "f" (the call to "f' inside "g") and will return a
2265 * declaration cursor pointing to the definition (the second "f"
2268 * If given a cursor for which there is no corresponding definition,
2269 * e.g., because there is no definition of that entity within this
2270 * translation unit, returns a NULL cursor.
2272 CINDEX_LINKAGE CXCursor clang_getCursorDefinition(CXCursor);
2275 * \brief Determine whether the declaration pointed to by this cursor
2276 * is also a definition of that entity.
2278 CINDEX_LINKAGE unsigned clang_isCursorDefinition(CXCursor);
2281 * \brief Retrieve the canonical cursor corresponding to the given cursor.
2283 * In the C family of languages, many kinds of entities can be declared several
2284 * times within a single translation unit. For example, a structure type can
2285 * be forward-declared (possibly multiple times) and later defined:
2295 * The declarations and the definition of \c X are represented by three
2296 * different cursors, all of which are declarations of the same underlying
2297 * entity. One of these cursor is considered the "canonical" cursor, which
2298 * is effectively the representative for the underlying entity. One can
2299 * determine if two cursors are declarations of the same underlying entity by
2300 * comparing their canonical cursors.
2302 * \returns The canonical cursor for the entity referred to by the given cursor.
2304 CINDEX_LINKAGE CXCursor clang_getCanonicalCursor(CXCursor);
2311 * \defgroup CINDEX_CPP C++ AST introspection
2313 * The routines in this group provide access information in the ASTs specific
2314 * to C++ language features.
2320 * \brief Determine if a C++ member function or member function template is
2321 * declared 'static'.
2323 CINDEX_LINKAGE unsigned clang_CXXMethod_isStatic(CXCursor C);
2326 * \brief Determine if a C++ member function or member function template is
2327 * explicitly declared 'virtual' or if it overrides a virtual method from
2328 * one of the base classes.
2330 CINDEX_LINKAGE unsigned clang_CXXMethod_isVirtual(CXCursor C);
2333 * \brief Given a cursor that represents a template, determine
2334 * the cursor kind of the specializations would be generated by instantiating
2337 * This routine can be used to determine what flavor of function template,
2338 * class template, or class template partial specialization is stored in the
2339 * cursor. For example, it can describe whether a class template cursor is
2340 * declared with "struct", "class" or "union".
2342 * \param C The cursor to query. This cursor should represent a template
2345 * \returns The cursor kind of the specializations that would be generated
2346 * by instantiating the template \p C. If \p C is not a template, returns
2347 * \c CXCursor_NoDeclFound.
2349 CINDEX_LINKAGE enum CXCursorKind clang_getTemplateCursorKind(CXCursor C);
2352 * \brief Given a cursor that may represent a specialization or instantiation
2353 * of a template, retrieve the cursor that represents the template that it
2354 * specializes or from which it was instantiated.
2356 * This routine determines the template involved both for explicit
2357 * specializations of templates and for implicit instantiations of the template,
2358 * both of which are referred to as "specializations". For a class template
2359 * specialization (e.g., \c std::vector<bool>), this routine will return
2360 * either the primary template (\c std::vector) or, if the specialization was
2361 * instantiated from a class template partial specialization, the class template
2362 * partial specialization. For a class template partial specialization and a
2363 * function template specialization (including instantiations), this
2364 * this routine will return the specialized template.
2366 * For members of a class template (e.g., member functions, member classes, or
2367 * static data members), returns the specialized or instantiated member.
2368 * Although not strictly "templates" in the C++ language, members of class
2369 * templates have the same notions of specializations and instantiations that
2370 * templates do, so this routine treats them similarly.
2372 * \param C A cursor that may be a specialization of a template or a member
2375 * \returns If the given cursor is a specialization or instantiation of a
2376 * template or a member thereof, the template or member that it specializes or
2377 * from which it was instantiated. Otherwise, returns a NULL cursor.
2379 CINDEX_LINKAGE CXCursor clang_getSpecializedCursorTemplate(CXCursor C);
2386 * \defgroup CINDEX_LEX Token extraction and manipulation
2388 * The routines in this group provide access to the tokens within a
2389 * translation unit, along with a semantic mapping of those tokens to
2390 * their corresponding cursors.
2396 * \brief Describes a kind of token.
2398 typedef enum CXTokenKind {
2400 * \brief A token that contains some kind of punctuation.
2402 CXToken_Punctuation,
2405 * \brief A language keyword.
2410 * \brief An identifier (that is not a keyword).
2415 * \brief A numeric, string, or character literal.
2426 * \brief Describes a single preprocessing token.
2429 unsigned int_data[4];
2434 * \brief Determine the kind of the given token.
2436 CINDEX_LINKAGE CXTokenKind clang_getTokenKind(CXToken);
2439 * \brief Determine the spelling of the given token.
2441 * The spelling of a token is the textual representation of that token, e.g.,
2442 * the text of an identifier or keyword.
2444 CINDEX_LINKAGE CXString clang_getTokenSpelling(CXTranslationUnit, CXToken);
2447 * \brief Retrieve the source location of the given token.
2449 CINDEX_LINKAGE CXSourceLocation clang_getTokenLocation(CXTranslationUnit,
2453 * \brief Retrieve a source range that covers the given token.
2455 CINDEX_LINKAGE CXSourceRange clang_getTokenExtent(CXTranslationUnit, CXToken);
2458 * \brief Tokenize the source code described by the given range into raw
2461 * \param TU the translation unit whose text is being tokenized.
2463 * \param Range the source range in which text should be tokenized. All of the
2464 * tokens produced by tokenization will fall within this source range,
2466 * \param Tokens this pointer will be set to point to the array of tokens
2467 * that occur within the given source range. The returned pointer must be
2468 * freed with clang_disposeTokens() before the translation unit is destroyed.
2470 * \param NumTokens will be set to the number of tokens in the \c *Tokens
2474 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
2475 CXToken **Tokens, unsigned *NumTokens);
2478 * \brief Annotate the given set of tokens by providing cursors for each token
2479 * that can be mapped to a specific entity within the abstract syntax tree.
2481 * This token-annotation routine is equivalent to invoking
2482 * clang_getCursor() for the source locations of each of the
2483 * tokens. The cursors provided are filtered, so that only those
2484 * cursors that have a direct correspondence to the token are
2485 * accepted. For example, given a function call \c f(x),
2486 * clang_getCursor() would provide the following cursors:
2488 * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
2489 * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
2490 * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
2492 * Only the first and last of these cursors will occur within the
2493 * annotate, since the tokens "f" and "x' directly refer to a function
2494 * and a variable, respectively, but the parentheses are just a small
2495 * part of the full syntax of the function call expression, which is
2496 * not provided as an annotation.
2498 * \param TU the translation unit that owns the given tokens.
2500 * \param Tokens the set of tokens to annotate.
2502 * \param NumTokens the number of tokens in \p Tokens.
2504 * \param Cursors an array of \p NumTokens cursors, whose contents will be
2505 * replaced with the cursors corresponding to each token.
2507 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
2508 CXToken *Tokens, unsigned NumTokens,
2512 * \brief Free the given set of tokens.
2514 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
2515 CXToken *Tokens, unsigned NumTokens);
2522 * \defgroup CINDEX_DEBUG Debugging facilities
2524 * These routines are used for testing and debugging, only, and should not
2530 /* for debug/testing */
2531 CINDEX_LINKAGE CXString clang_getCursorKindSpelling(enum CXCursorKind Kind);
2532 CINDEX_LINKAGE void clang_getDefinitionSpellingAndExtent(CXCursor,
2533 const char **startBuf,
2534 const char **endBuf,
2535 unsigned *startLine,
2536 unsigned *startColumn,
2538 unsigned *endColumn);
2539 CINDEX_LINKAGE void clang_enableStackTraces(void);
2540 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
2541 unsigned stack_size);
2548 * \defgroup CINDEX_CODE_COMPLET Code completion
2550 * Code completion involves taking an (incomplete) source file, along with
2551 * knowledge of where the user is actively editing that file, and suggesting
2552 * syntactically- and semantically-valid constructs that the user might want to
2553 * use at that particular point in the source code. These data structures and
2554 * routines provide support for code completion.
2560 * \brief A semantic string that describes a code-completion result.
2562 * A semantic string that describes the formatting of a code-completion
2563 * result as a single "template" of text that should be inserted into the
2564 * source buffer when a particular code-completion result is selected.
2565 * Each semantic string is made up of some number of "chunks", each of which
2566 * contains some text along with a description of what that text means, e.g.,
2567 * the name of the entity being referenced, whether the text chunk is part of
2568 * the template, or whether it is a "placeholder" that the user should replace
2569 * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
2570 * description of the different kinds of chunks.
2572 typedef void *CXCompletionString;
2575 * \brief A single result of code completion.
2579 * \brief The kind of entity that this completion refers to.
2581 * The cursor kind will be a macro, keyword, or a declaration (one of the
2582 * *Decl cursor kinds), describing the entity that the completion is
2585 * \todo In the future, we would like to provide a full cursor, to allow
2586 * the client to extract additional information from declaration.
2588 enum CXCursorKind CursorKind;
2591 * \brief The code-completion string that describes how to insert this
2592 * code-completion result into the editing buffer.
2594 CXCompletionString CompletionString;
2595 } CXCompletionResult;
2598 * \brief Describes a single piece of text within a code-completion string.
2600 * Each "chunk" within a code-completion string (\c CXCompletionString) is
2601 * either a piece of text with a specific "kind" that describes how that text
2602 * should be interpreted by the client or is another completion string.
2604 enum CXCompletionChunkKind {
2606 * \brief A code-completion string that describes "optional" text that
2607 * could be a part of the template (but is not required).
2609 * The Optional chunk is the only kind of chunk that has a code-completion
2610 * string for its representation, which is accessible via
2611 * \c clang_getCompletionChunkCompletionString(). The code-completion string
2612 * describes an additional part of the template that is completely optional.
2613 * For example, optional chunks can be used to describe the placeholders for
2614 * arguments that match up with defaulted function parameters, e.g. given:
2617 * void f(int x, float y = 3.14, double z = 2.71828);
2620 * The code-completion string for this function would contain:
2621 * - a TypedText chunk for "f".
2622 * - a LeftParen chunk for "(".
2623 * - a Placeholder chunk for "int x"
2624 * - an Optional chunk containing the remaining defaulted arguments, e.g.,
2625 * - a Comma chunk for ","
2626 * - a Placeholder chunk for "float y"
2627 * - an Optional chunk containing the last defaulted argument:
2628 * - a Comma chunk for ","
2629 * - a Placeholder chunk for "double z"
2630 * - a RightParen chunk for ")"
2632 * There are many ways to handle Optional chunks. Two simple approaches are:
2633 * - Completely ignore optional chunks, in which case the template for the
2634 * function "f" would only include the first parameter ("int x").
2635 * - Fully expand all optional chunks, in which case the template for the
2636 * function "f" would have all of the parameters.
2638 CXCompletionChunk_Optional,
2640 * \brief Text that a user would be expected to type to get this
2641 * code-completion result.
2643 * There will be exactly one "typed text" chunk in a semantic string, which
2644 * will typically provide the spelling of a keyword or the name of a
2645 * declaration that could be used at the current code point. Clients are
2646 * expected to filter the code-completion results based on the text in this
2649 CXCompletionChunk_TypedText,
2651 * \brief Text that should be inserted as part of a code-completion result.
2653 * A "text" chunk represents text that is part of the template to be
2654 * inserted into user code should this particular code-completion result
2657 CXCompletionChunk_Text,
2659 * \brief Placeholder text that should be replaced by the user.
2661 * A "placeholder" chunk marks a place where the user should insert text
2662 * into the code-completion template. For example, placeholders might mark
2663 * the function parameters for a function declaration, to indicate that the
2664 * user should provide arguments for each of those parameters. The actual
2665 * text in a placeholder is a suggestion for the text to display before
2666 * the user replaces the placeholder with real code.
2668 CXCompletionChunk_Placeholder,
2670 * \brief Informative text that should be displayed but never inserted as
2671 * part of the template.
2673 * An "informative" chunk contains annotations that can be displayed to
2674 * help the user decide whether a particular code-completion result is the
2675 * right option, but which is not part of the actual template to be inserted
2676 * by code completion.
2678 CXCompletionChunk_Informative,
2680 * \brief Text that describes the current parameter when code-completion is
2681 * referring to function call, message send, or template specialization.
2683 * A "current parameter" chunk occurs when code-completion is providing
2684 * information about a parameter corresponding to the argument at the
2685 * code-completion point. For example, given a function
2688 * int add(int x, int y);
2691 * and the source code \c add(, where the code-completion point is after the
2692 * "(", the code-completion string will contain a "current parameter" chunk
2693 * for "int x", indicating that the current argument will initialize that
2694 * parameter. After typing further, to \c add(17, (where the code-completion
2695 * point is after the ","), the code-completion string will contain a
2696 * "current paremeter" chunk to "int y".
2698 CXCompletionChunk_CurrentParameter,
2700 * \brief A left parenthesis ('('), used to initiate a function call or
2701 * signal the beginning of a function parameter list.
2703 CXCompletionChunk_LeftParen,
2705 * \brief A right parenthesis (')'), used to finish a function call or
2706 * signal the end of a function parameter list.
2708 CXCompletionChunk_RightParen,
2710 * \brief A left bracket ('[').
2712 CXCompletionChunk_LeftBracket,
2714 * \brief A right bracket (']').
2716 CXCompletionChunk_RightBracket,
2718 * \brief A left brace ('{').
2720 CXCompletionChunk_LeftBrace,
2722 * \brief A right brace ('}').
2724 CXCompletionChunk_RightBrace,
2726 * \brief A left angle bracket ('<').
2728 CXCompletionChunk_LeftAngle,
2730 * \brief A right angle bracket ('>').
2732 CXCompletionChunk_RightAngle,
2734 * \brief A comma separator (',').
2736 CXCompletionChunk_Comma,
2738 * \brief Text that specifies the result type of a given result.
2740 * This special kind of informative chunk is not meant to be inserted into
2741 * the text buffer. Rather, it is meant to illustrate the type that an
2742 * expression using the given completion string would have.
2744 CXCompletionChunk_ResultType,
2746 * \brief A colon (':').
2748 CXCompletionChunk_Colon,
2750 * \brief A semicolon (';').
2752 CXCompletionChunk_SemiColon,
2754 * \brief An '=' sign.
2756 CXCompletionChunk_Equal,
2758 * Horizontal space (' ').
2760 CXCompletionChunk_HorizontalSpace,
2762 * Vertical space ('\n'), after which it is generally a good idea to
2763 * perform indentation.
2765 CXCompletionChunk_VerticalSpace
2769 * \brief Determine the kind of a particular chunk within a completion string.
2771 * \param completion_string the completion string to query.
2773 * \param chunk_number the 0-based index of the chunk in the completion string.
2775 * \returns the kind of the chunk at the index \c chunk_number.
2777 CINDEX_LINKAGE enum CXCompletionChunkKind
2778 clang_getCompletionChunkKind(CXCompletionString completion_string,
2779 unsigned chunk_number);
2782 * \brief Retrieve the text associated with a particular chunk within a
2783 * completion string.
2785 * \param completion_string the completion string to query.
2787 * \param chunk_number the 0-based index of the chunk in the completion string.
2789 * \returns the text associated with the chunk at index \c chunk_number.
2791 CINDEX_LINKAGE CXString
2792 clang_getCompletionChunkText(CXCompletionString completion_string,
2793 unsigned chunk_number);
2796 * \brief Retrieve the completion string associated with a particular chunk
2797 * within a completion string.
2799 * \param completion_string the completion string to query.
2801 * \param chunk_number the 0-based index of the chunk in the completion string.
2803 * \returns the completion string associated with the chunk at index
2804 * \c chunk_number, or NULL if that chunk is not represented by a completion
2807 CINDEX_LINKAGE CXCompletionString
2808 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
2809 unsigned chunk_number);
2812 * \brief Retrieve the number of chunks in the given code-completion string.
2814 CINDEX_LINKAGE unsigned
2815 clang_getNumCompletionChunks(CXCompletionString completion_string);
2818 * \brief Determine the priority of this code completion.
2820 * The priority of a code completion indicates how likely it is that this
2821 * particular completion is the completion that the user will select. The
2822 * priority is selected by various internal heuristics.
2824 * \param completion_string The completion string to query.
2826 * \returns The priority of this completion string. Smaller values indicate
2827 * higher-priority (more likely) completions.
2829 CINDEX_LINKAGE unsigned
2830 clang_getCompletionPriority(CXCompletionString completion_string);
2833 * \brief Determine the availability of the entity that this code-completion
2836 * \param completion_string The completion string to query.
2838 * \returns The availability of the completion string.
2840 CINDEX_LINKAGE enum CXAvailabilityKind
2841 clang_getCompletionAvailability(CXCompletionString completion_string);
2844 * \brief Contains the results of code-completion.
2846 * This data structure contains the results of code completion, as
2847 * produced by \c clang_codeCompleteAt(). Its contents must be freed by
2848 * \c clang_disposeCodeCompleteResults.
2852 * \brief The code-completion results.
2854 CXCompletionResult *Results;
2857 * \brief The number of code-completion results stored in the
2860 unsigned NumResults;
2861 } CXCodeCompleteResults;
2864 * \brief Flags that can be passed to \c clang_codeCompleteAt() to
2865 * modify its behavior.
2867 * The enumerators in this enumeration can be bitwise-OR'd together to
2868 * provide multiple options to \c clang_codeCompleteAt().
2870 enum CXCodeComplete_Flags {
2872 * \brief Whether to include macros within the set of code
2873 * completions returned.
2875 CXCodeComplete_IncludeMacros = 0x01,
2878 * \brief Whether to include code patterns for language constructs
2879 * within the set of code completions, e.g., for loops.
2881 CXCodeComplete_IncludeCodePatterns = 0x02
2885 * \brief Bits that represent the context under which completion is occurring.
2887 * The enumerators in this enumeration may be bitwise-OR'd together if multiple
2888 * contexts are occurring simultaneously.
2890 enum CXCompletionContext {
2892 * \brief The context for completions is unexposed, as only Clang results
2893 * should be included. (This is equivalent to having no context bits set.)
2895 CXCompletionContext_Unexposed = 0,
2898 * \brief Completions for any possible type should be included in the results.
2900 CXCompletionContext_AnyType = 1 << 0,
2903 * \brief Completions for any possible value (variables, function calls, etc.)
2904 * should be included in the results.
2906 CXCompletionContext_AnyValue = 1 << 1,
2908 * \brief Completions for values that resolve to an Objective-C object should
2909 * be included in the results.
2911 CXCompletionContext_ObjCObjectValue = 1 << 2,
2913 * \brief Completions for values that resolve to an Objective-C selector
2914 * should be included in the results.
2916 CXCompletionContext_ObjCSelectorValue = 1 << 3,
2918 * \brief Completions for values that resolve to a C++ class type should be
2919 * included in the results.
2921 CXCompletionContext_CXXClassTypeValue = 1 << 4,
2924 * \brief Completions for fields of the member being accessed using the dot
2925 * operator should be included in the results.
2927 CXCompletionContext_DotMemberAccess = 1 << 5,
2929 * \brief Completions for fields of the member being accessed using the arrow
2930 * operator should be included in the results.
2932 CXCompletionContext_ArrowMemberAccess = 1 << 6,
2934 * \brief Completions for properties of the Objective-C object being accessed
2935 * using the dot operator should be included in the results.
2937 CXCompletionContext_ObjCPropertyAccess = 1 << 7,
2940 * \brief Completions for enum tags should be included in the results.
2942 CXCompletionContext_EnumTag = 1 << 8,
2944 * \brief Completions for union tags should be included in the results.
2946 CXCompletionContext_UnionTag = 1 << 9,
2948 * \brief Completions for struct tags should be included in the results.
2950 CXCompletionContext_StructTag = 1 << 10,
2953 * \brief Completions for C++ class names should be included in the results.
2955 CXCompletionContext_ClassTag = 1 << 11,
2957 * \brief Completions for C++ namespaces and namespace aliases should be
2958 * included in the results.
2960 CXCompletionContext_Namespace = 1 << 12,
2962 * \brief Completions for C++ nested name specifiers should be included in
2965 CXCompletionContext_NestedNameSpecifier = 1 << 13,
2968 * \brief Completions for Objective-C interfaces (classes) should be included
2971 CXCompletionContext_ObjCInterface = 1 << 14,
2973 * \brief Completions for Objective-C protocols should be included in
2976 CXCompletionContext_ObjCProtocol = 1 << 15,
2978 * \brief Completions for Objective-C categories should be included in
2981 CXCompletionContext_ObjCCategory = 1 << 16,
2983 * \brief Completions for Objective-C instance messages should be included
2986 CXCompletionContext_ObjCInstanceMessage = 1 << 17,
2988 * \brief Completions for Objective-C class messages should be included in
2991 CXCompletionContext_ObjCClassMessage = 1 << 18,
2993 * \brief Completions for Objective-C selector names should be included in
2996 CXCompletionContext_ObjCSelectorName = 1 << 19,
2999 * \brief Completions for preprocessor macro names should be included in
3002 CXCompletionContext_MacroName = 1 << 20,
3005 * \brief Natural language completions should be included in the results.
3007 CXCompletionContext_NaturalLanguage = 1 << 21,
3010 * \brief The current context is unknown, so set all contexts.
3012 CXCompletionContext_Unknown = ((1 << 22) - 1)
3016 * \brief Returns a default set of code-completion options that can be
3017 * passed to\c clang_codeCompleteAt().
3019 CINDEX_LINKAGE unsigned clang_defaultCodeCompleteOptions(void);
3022 * \brief Perform code completion at a given location in a translation unit.
3024 * This function performs code completion at a particular file, line, and
3025 * column within source code, providing results that suggest potential
3026 * code snippets based on the context of the completion. The basic model
3027 * for code completion is that Clang will parse a complete source file,
3028 * performing syntax checking up to the location where code-completion has
3029 * been requested. At that point, a special code-completion token is passed
3030 * to the parser, which recognizes this token and determines, based on the
3031 * current location in the C/Objective-C/C++ grammar and the state of
3032 * semantic analysis, what completions to provide. These completions are
3033 * returned via a new \c CXCodeCompleteResults structure.
3035 * Code completion itself is meant to be triggered by the client when the
3036 * user types punctuation characters or whitespace, at which point the
3037 * code-completion location will coincide with the cursor. For example, if \c p
3038 * is a pointer, code-completion might be triggered after the "-" and then
3039 * after the ">" in \c p->. When the code-completion location is afer the ">",
3040 * the completion results will provide, e.g., the members of the struct that
3041 * "p" points to. The client is responsible for placing the cursor at the
3042 * beginning of the token currently being typed, then filtering the results
3043 * based on the contents of the token. For example, when code-completing for
3044 * the expression \c p->get, the client should provide the location just after
3045 * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
3046 * client can filter the results based on the current token text ("get"), only
3047 * showing those results that start with "get". The intent of this interface
3048 * is to separate the relatively high-latency acquisition of code-completion
3049 * results from the filtering of results on a per-character basis, which must
3050 * have a lower latency.
3052 * \param TU The translation unit in which code-completion should
3053 * occur. The source files for this translation unit need not be
3054 * completely up-to-date (and the contents of those source files may
3055 * be overridden via \p unsaved_files). Cursors referring into the
3056 * translation unit may be invalidated by this invocation.
3058 * \param complete_filename The name of the source file where code
3059 * completion should be performed. This filename may be any file
3060 * included in the translation unit.
3062 * \param complete_line The line at which code-completion should occur.
3064 * \param complete_column The column at which code-completion should occur.
3065 * Note that the column should point just after the syntactic construct that
3066 * initiated code completion, and not in the middle of a lexical token.
3068 * \param unsaved_files the Tiles that have not yet been saved to disk
3069 * but may be required for parsing or code completion, including the
3070 * contents of those files. The contents and name of these files (as
3071 * specified by CXUnsavedFile) are copied when necessary, so the
3072 * client only needs to guarantee their validity until the call to
3073 * this function returns.
3075 * \param num_unsaved_files The number of unsaved file entries in \p
3078 * \param options Extra options that control the behavior of code
3079 * completion, expressed as a bitwise OR of the enumerators of the
3080 * CXCodeComplete_Flags enumeration. The
3081 * \c clang_defaultCodeCompleteOptions() function returns a default set
3082 * of code-completion options.
3084 * \returns If successful, a new \c CXCodeCompleteResults structure
3085 * containing code-completion results, which should eventually be
3086 * freed with \c clang_disposeCodeCompleteResults(). If code
3087 * completion fails, returns NULL.
3090 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
3091 const char *complete_filename,
3092 unsigned complete_line,
3093 unsigned complete_column,
3094 struct CXUnsavedFile *unsaved_files,
3095 unsigned num_unsaved_files,
3099 * \brief Sort the code-completion results in case-insensitive alphabetical
3102 * \param Results The set of results to sort.
3103 * \param NumResults The number of results in \p Results.
3106 void clang_sortCodeCompletionResults(CXCompletionResult *Results,
3107 unsigned NumResults);
3110 * \brief Free the given set of code-completion results.
3113 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
3116 * \brief Determine the number of diagnostics produced prior to the
3117 * location where code completion was performed.
3120 unsigned clang_codeCompleteGetNumDiagnostics(CXCodeCompleteResults *Results);
3123 * \brief Retrieve a diagnostic associated with the given code completion.
3125 * \param Result the code completion results to query.
3126 * \param Index the zero-based diagnostic number to retrieve.
3128 * \returns the requested diagnostic. This diagnostic must be freed
3129 * via a call to \c clang_disposeDiagnostic().
3132 CXDiagnostic clang_codeCompleteGetDiagnostic(CXCodeCompleteResults *Results,
3136 * \brief Determines what compeltions are appropriate for the context
3137 * the given code completion.
3139 * \param Results the code completion results to query
3141 * \returns the kinds of completions that are appropriate for use
3142 * along with the given code completion results.
3145 unsigned long long clang_codeCompleteGetContexts(
3146 CXCodeCompleteResults *Results);
3154 * \defgroup CINDEX_MISC Miscellaneous utility functions
3160 * \brief Return a version string, suitable for showing to a user, but not
3161 * intended to be parsed (the format is not guaranteed to be stable).
3163 CINDEX_LINKAGE CXString clang_getClangVersion();
3167 * \brief Enable/disable crash recovery.
3169 * \param Flag to indicate if crash recovery is enabled. A non-zero value
3170 * enables crash recovery, while 0 disables it.
3172 CINDEX_LINKAGE void clang_toggleCrashRecovery(unsigned isEnabled);
3175 * \brief Visitor invoked for each file in a translation unit
3176 * (used with clang_getInclusions()).
3178 * This visitor function will be invoked by clang_getInclusions() for each
3179 * file included (either at the top-level or by #include directives) within
3180 * a translation unit. The first argument is the file being included, and
3181 * the second and third arguments provide the inclusion stack. The
3182 * array is sorted in order of immediate inclusion. For example,
3183 * the first element refers to the location that included 'included_file'.
3185 typedef void (*CXInclusionVisitor)(CXFile included_file,
3186 CXSourceLocation* inclusion_stack,
3187 unsigned include_len,
3188 CXClientData client_data);
3191 * \brief Visit the set of preprocessor inclusions in a translation unit.
3192 * The visitor function is called with the provided data for every included
3193 * file. This does not include headers included by the PCH file (unless one
3194 * is inspecting the inclusions in the PCH file itself).
3196 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
3197 CXInclusionVisitor visitor,
3198 CXClientData client_data);
3204 /** \defgroup CINDEX_REMAPPING Remapping functions
3210 * \brief A remapping of original source files and their translated files.
3212 typedef void *CXRemapping;
3215 * \brief Retrieve a remapping.
3217 * \param path the path that contains metadata about remappings.
3219 * \returns the requested remapping. This remapping must be freed
3220 * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
3222 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
3225 * \brief Determine the number of remappings.
3227 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
3230 * \brief Get the original and the associated filename from the remapping.
3232 * \param original If non-NULL, will be set to the original filename.
3234 * \param transformed If non-NULL, will be set to the filename that the original
3235 * is associated with.
3237 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
3238 CXString *original, CXString *transformed);
3241 * \brief Dispose the remapping.
3243 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);