clang  3.9.0svn
Index.h
Go to the documentation of this file.
1 /*===-- clang-c/Index.h - Indexing Public C Interface -------------*- C -*-===*\
2 |* *|
3 |* The LLVM Compiler Infrastructure *|
4 |* *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
7 |* *|
8 |*===----------------------------------------------------------------------===*|
9 |* *|
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 *|
12 |* Clang C++ API. *|
13 |* *|
14 \*===----------------------------------------------------------------------===*/
15 
16 #ifndef LLVM_CLANG_C_INDEX_H
17 #define LLVM_CLANG_C_INDEX_H
18 
19 #include <time.h>
20 
21 #include "clang-c/Platform.h"
22 #include "clang-c/CXErrorCode.h"
23 #include "clang-c/CXString.h"
24 #include "clang-c/BuildSystem.h"
25 
26 /**
27  * \brief The version constants for the libclang API.
28  * CINDEX_VERSION_MINOR should increase when there are API additions.
29  * CINDEX_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
30  *
31  * The policy about the libclang API was always to keep it source and ABI
32  * compatible, thus CINDEX_VERSION_MAJOR is expected to remain stable.
33  */
34 #define CINDEX_VERSION_MAJOR 0
35 #define CINDEX_VERSION_MINOR 34
36 
37 #define CINDEX_VERSION_ENCODE(major, minor) ( \
38  ((major) * 10000) \
39  + ((minor) * 1))
40 
41 #define CINDEX_VERSION CINDEX_VERSION_ENCODE( \
42  CINDEX_VERSION_MAJOR, \
43  CINDEX_VERSION_MINOR )
44 
45 #define CINDEX_VERSION_STRINGIZE_(major, minor) \
46  #major"."#minor
47 #define CINDEX_VERSION_STRINGIZE(major, minor) \
48  CINDEX_VERSION_STRINGIZE_(major, minor)
49 
50 #define CINDEX_VERSION_STRING CINDEX_VERSION_STRINGIZE( \
51  CINDEX_VERSION_MAJOR, \
52  CINDEX_VERSION_MINOR)
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 /** \defgroup CINDEX libclang: C Interface to Clang
59  *
60  * The C Interface to Clang provides a relatively small API that exposes
61  * facilities for parsing source code into an abstract syntax tree (AST),
62  * loading already-parsed ASTs, traversing the AST, associating
63  * physical source locations with elements within the AST, and other
64  * facilities that support Clang-based development tools.
65  *
66  * This C interface to Clang will never provide all of the information
67  * representation stored in Clang's C++ AST, nor should it: the intent is to
68  * maintain an API that is relatively stable from one release to the next,
69  * providing only the basic functionality needed to support development tools.
70  *
71  * To avoid namespace pollution, data types are prefixed with "CX" and
72  * functions are prefixed with "clang_".
73  *
74  * @{
75  */
76 
77 /**
78  * \brief An "index" that consists of a set of translation units that would
79  * typically be linked together into an executable or library.
80  */
81 typedef void *CXIndex;
82 
83 /**
84  * \brief A single translation unit, which resides in an index.
85  */
86 typedef struct CXTranslationUnitImpl *CXTranslationUnit;
87 
88 /**
89  * \brief Opaque pointer representing client data that will be passed through
90  * to various callbacks and visitors.
91  */
92 typedef void *CXClientData;
93 
94 /**
95  * \brief Provides the contents of a file that has not yet been saved to disk.
96  *
97  * Each CXUnsavedFile instance provides the name of a file on the
98  * system along with the current contents of that file that have not
99  * yet been saved to disk.
100  */
102  /**
103  * \brief The file whose contents have not yet been saved.
104  *
105  * This file must already exist in the file system.
106  */
107  const char *Filename;
108 
109  /**
110  * \brief A buffer containing the unsaved contents of this file.
111  */
112  const char *Contents;
113 
114  /**
115  * \brief The length of the unsaved contents of this buffer.
116  */
117  unsigned long Length;
118 };
119 
120 /**
121  * \brief Describes the availability of a particular entity, which indicates
122  * whether the use of this entity will result in a warning or error due to
123  * it being deprecated or unavailable.
124  */
126  /**
127  * \brief The entity is available.
128  */
130  /**
131  * \brief The entity is available, but has been deprecated (and its use is
132  * not recommended).
133  */
135  /**
136  * \brief The entity is not available; any use of it will be an error.
137  */
139  /**
140  * \brief The entity is available, but not accessible; any use of it will be
141  * an error.
142  */
144 };
145 
146 /**
147  * \brief Describes a version number of the form major.minor.subminor.
148  */
149 typedef struct CXVersion {
150  /**
151  * \brief The major version number, e.g., the '10' in '10.7.3'. A negative
152  * value indicates that there is no version number at all.
153  */
154  int Major;
155  /**
156  * \brief The minor version number, e.g., the '7' in '10.7.3'. This value
157  * will be negative if no minor version number was provided, e.g., for
158  * version '10'.
159  */
160  int Minor;
161  /**
162  * \brief The subminor version number, e.g., the '3' in '10.7.3'. This value
163  * will be negative if no minor or subminor version number was provided,
164  * e.g., in version '10' or '10.7'.
165  */
166  int Subminor;
167 } CXVersion;
168 
169 /**
170  * \brief Provides a shared context for creating translation units.
171  *
172  * It provides two options:
173  *
174  * - excludeDeclarationsFromPCH: When non-zero, allows enumeration of "local"
175  * declarations (when loading any new translation units). A "local" declaration
176  * is one that belongs in the translation unit itself and not in a precompiled
177  * header that was used by the translation unit. If zero, all declarations
178  * will be enumerated.
179  *
180  * Here is an example:
181  *
182  * \code
183  * // excludeDeclsFromPCH = 1, displayDiagnostics=1
184  * Idx = clang_createIndex(1, 1);
185  *
186  * // IndexTest.pch was produced with the following command:
187  * // "clang -x c IndexTest.h -emit-ast -o IndexTest.pch"
188  * TU = clang_createTranslationUnit(Idx, "IndexTest.pch");
189  *
190  * // This will load all the symbols from 'IndexTest.pch'
191  * clang_visitChildren(clang_getTranslationUnitCursor(TU),
192  * TranslationUnitVisitor, 0);
193  * clang_disposeTranslationUnit(TU);
194  *
195  * // This will load all the symbols from 'IndexTest.c', excluding symbols
196  * // from 'IndexTest.pch'.
197  * char *args[] = { "-Xclang", "-include-pch=IndexTest.pch" };
198  * TU = clang_createTranslationUnitFromSourceFile(Idx, "IndexTest.c", 2, args,
199  * 0, 0);
200  * clang_visitChildren(clang_getTranslationUnitCursor(TU),
201  * TranslationUnitVisitor, 0);
202  * clang_disposeTranslationUnit(TU);
203  * \endcode
204  *
205  * This process of creating the 'pch', loading it separately, and using it (via
206  * -include-pch) allows 'excludeDeclsFromPCH' to remove redundant callbacks
207  * (which gives the indexer the same performance benefit as the compiler).
208  */
209 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
210  int displayDiagnostics);
211 
212 /**
213  * \brief Destroy the given index.
214  *
215  * The index must not be destroyed until all of the translation units created
216  * within that index have been destroyed.
217  */
218 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
219 
220 typedef enum {
221  /**
222  * \brief Used to indicate that no special CXIndex options are needed.
223  */
225 
226  /**
227  * \brief Used to indicate that threads that libclang creates for indexing
228  * purposes should use background priority.
229  *
230  * Affects #clang_indexSourceFile, #clang_indexTranslationUnit,
231  * #clang_parseTranslationUnit, #clang_saveTranslationUnit.
232  */
234 
235  /**
236  * \brief Used to indicate that threads that libclang creates for editing
237  * purposes should use background priority.
238  *
239  * Affects #clang_reparseTranslationUnit, #clang_codeCompleteAt,
240  * #clang_annotateTokens
241  */
243 
244  /**
245  * \brief Used to indicate that all threads that libclang creates should use
246  * background priority.
247  */
251 
253 
254 /**
255  * \brief Sets general options associated with a CXIndex.
256  *
257  * For example:
258  * \code
259  * CXIndex idx = ...;
260  * clang_CXIndex_setGlobalOptions(idx,
261  * clang_CXIndex_getGlobalOptions(idx) |
262  * CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
263  * \endcode
264  *
265  * \param options A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags.
266  */
267 CINDEX_LINKAGE void clang_CXIndex_setGlobalOptions(CXIndex, unsigned options);
268 
269 /**
270  * \brief Gets the general options associated with a CXIndex.
271  *
272  * \returns A bitmask of options, a bitwise OR of CXGlobalOpt_XXX flags that
273  * are associated with the given CXIndex object.
274  */
276 
277 /**
278  * \defgroup CINDEX_FILES File manipulation routines
279  *
280  * @{
281  */
282 
283 /**
284  * \brief A particular source file that is part of a translation unit.
285  */
286 typedef void *CXFile;
287 
288 /**
289  * \brief Retrieve the complete file and path name of the given file.
290  */
292 
293 /**
294  * \brief Retrieve the last modification time of the given file.
295  */
296 CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
297 
298 /**
299  * \brief Uniquely identifies a CXFile, that refers to the same underlying file,
300  * across an indexing session.
301  */
302 typedef struct {
303  unsigned long long data[3];
305 
306 /**
307  * \brief Retrieve the unique ID for the given \c file.
308  *
309  * \param file the file to get the ID for.
310  * \param outID stores the returned CXFileUniqueID.
311  * \returns If there was a failure getting the unique ID, returns non-zero,
312  * otherwise returns 0.
313 */
314 CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
315 
316 /**
317  * \brief Determine whether the given header is guarded against
318  * multiple inclusions, either with the conventional
319  * \#ifndef/\#define/\#endif macro guards or with \#pragma once.
320  */
321 CINDEX_LINKAGE unsigned
322 clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file);
323 
324 /**
325  * \brief Retrieve a file handle within the given translation unit.
326  *
327  * \param tu the translation unit
328  *
329  * \param file_name the name of the file.
330  *
331  * \returns the file handle for the named file in the translation unit \p tu,
332  * or a NULL file handle if the file was not a part of this translation unit.
333  */
334 CINDEX_LINKAGE CXFile clang_getFile(CXTranslationUnit tu,
335  const char *file_name);
336 
337 /**
338  * \brief Returns non-zero if the \c file1 and \c file2 point to the same file,
339  * or they are both NULL.
340  */
341 CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
342 
343 /**
344  * @}
345  */
346 
347 /**
348  * \defgroup CINDEX_LOCATIONS Physical source locations
349  *
350  * Clang represents physical source locations in its abstract syntax tree in
351  * great detail, with file, line, and column information for the majority of
352  * the tokens parsed in the source code. These data types and functions are
353  * used to represent source location information, either for a particular
354  * point in the program or for a range of points in the program, and extract
355  * specific location information from those data types.
356  *
357  * @{
358  */
359 
360 /**
361  * \brief Identifies a specific source location within a translation
362  * unit.
363  *
364  * Use clang_getExpansionLocation() or clang_getSpellingLocation()
365  * to map a source location to a particular file, line, and column.
366  */
367 typedef struct {
368  const void *ptr_data[2];
369  unsigned int_data;
371 
372 /**
373  * \brief Identifies a half-open character range in the source code.
374  *
375  * Use clang_getRangeStart() and clang_getRangeEnd() to retrieve the
376  * starting and end locations from a source range, respectively.
377  */
378 typedef struct {
379  const void *ptr_data[2];
380  unsigned begin_int_data;
381  unsigned end_int_data;
382 } CXSourceRange;
383 
384 /**
385  * \brief Retrieve a NULL (invalid) source location.
386  */
388 
389 /**
390  * \brief Determine whether two source locations, which must refer into
391  * the same translation unit, refer to exactly the same point in the source
392  * code.
393  *
394  * \returns non-zero if the source locations refer to the same location, zero
395  * if they refer to different locations.
396  */
398  CXSourceLocation loc2);
399 
400 /**
401  * \brief Retrieves the source location associated with a given file/line/column
402  * in a particular translation unit.
403  */
405  CXFile file,
406  unsigned line,
407  unsigned column);
408 /**
409  * \brief Retrieves the source location associated with a given character offset
410  * in a particular translation unit.
411  */
413  CXFile file,
414  unsigned offset);
415 
416 /**
417  * \brief Returns non-zero if the given source location is in a system header.
418  */
420 
421 /**
422  * \brief Returns non-zero if the given source location is in the main file of
423  * the corresponding translation unit.
424  */
426 
427 /**
428  * \brief Retrieve a NULL (invalid) source range.
429  */
431 
432 /**
433  * \brief Retrieve a source range given the beginning and ending source
434  * locations.
435  */
437  CXSourceLocation end);
438 
439 /**
440  * \brief Determine whether two ranges are equivalent.
441  *
442  * \returns non-zero if the ranges are the same, zero if they differ.
443  */
445  CXSourceRange range2);
446 
447 /**
448  * \brief Returns non-zero if \p range is null.
449  */
451 
452 /**
453  * \brief Retrieve the file, line, column, and offset represented by
454  * the given source location.
455  *
456  * If the location refers into a macro expansion, retrieves the
457  * location of the macro expansion.
458  *
459  * \param location the location within a source file that will be decomposed
460  * into its parts.
461  *
462  * \param file [out] if non-NULL, will be set to the file to which the given
463  * source location points.
464  *
465  * \param line [out] if non-NULL, will be set to the line to which the given
466  * source location points.
467  *
468  * \param column [out] if non-NULL, will be set to the column to which the given
469  * source location points.
470  *
471  * \param offset [out] if non-NULL, will be set to the offset into the
472  * buffer to which the given source location points.
473  */
475  CXFile *file,
476  unsigned *line,
477  unsigned *column,
478  unsigned *offset);
479 
480 /**
481  * \brief Retrieve the file, line, column, and offset represented by
482  * the given source location, as specified in a # line directive.
483  *
484  * Example: given the following source code in a file somefile.c
485  *
486  * \code
487  * #123 "dummy.c" 1
488  *
489  * static int func(void)
490  * {
491  * return 0;
492  * }
493  * \endcode
494  *
495  * the location information returned by this function would be
496  *
497  * File: dummy.c Line: 124 Column: 12
498  *
499  * whereas clang_getExpansionLocation would have returned
500  *
501  * File: somefile.c Line: 3 Column: 12
502  *
503  * \param location the location within a source file that will be decomposed
504  * into its parts.
505  *
506  * \param filename [out] if non-NULL, will be set to the filename of the
507  * source location. Note that filenames returned will be for "virtual" files,
508  * which don't necessarily exist on the machine running clang - e.g. when
509  * parsing preprocessed output obtained from a different environment. If
510  * a non-NULL value is passed in, remember to dispose of the returned value
511  * using \c clang_disposeString() once you've finished with it. For an invalid
512  * source location, an empty string is returned.
513  *
514  * \param line [out] if non-NULL, will be set to the line number of the
515  * source location. For an invalid source location, zero is returned.
516  *
517  * \param column [out] if non-NULL, will be set to the column number of the
518  * source location. For an invalid source location, zero is returned.
519  */
521  CXString *filename,
522  unsigned *line,
523  unsigned *column);
524 
525 /**
526  * \brief Legacy API to retrieve the file, line, column, and offset represented
527  * by the given source location.
528  *
529  * This interface has been replaced by the newer interface
530  * #clang_getExpansionLocation(). See that interface's documentation for
531  * details.
532  */
534  CXFile *file,
535  unsigned *line,
536  unsigned *column,
537  unsigned *offset);
538 
539 /**
540  * \brief Retrieve the file, line, column, and offset represented by
541  * the given source location.
542  *
543  * If the location refers into a macro instantiation, return where the
544  * location was originally spelled in the source file.
545  *
546  * \param location the location within a source file that will be decomposed
547  * into its parts.
548  *
549  * \param file [out] if non-NULL, will be set to the file to which the given
550  * source location points.
551  *
552  * \param line [out] if non-NULL, will be set to the line to which the given
553  * source location points.
554  *
555  * \param column [out] if non-NULL, will be set to the column to which the given
556  * source location points.
557  *
558  * \param offset [out] if non-NULL, will be set to the offset into the
559  * buffer to which the given source location points.
560  */
562  CXFile *file,
563  unsigned *line,
564  unsigned *column,
565  unsigned *offset);
566 
567 /**
568  * \brief Retrieve the file, line, column, and offset represented by
569  * the given source location.
570  *
571  * If the location refers into a macro expansion, return where the macro was
572  * expanded or where the macro argument was written, if the location points at
573  * a macro argument.
574  *
575  * \param location the location within a source file that will be decomposed
576  * into its parts.
577  *
578  * \param file [out] if non-NULL, will be set to the file to which the given
579  * source location points.
580  *
581  * \param line [out] if non-NULL, will be set to the line to which the given
582  * source location points.
583  *
584  * \param column [out] if non-NULL, will be set to the column to which the given
585  * source location points.
586  *
587  * \param offset [out] if non-NULL, will be set to the offset into the
588  * buffer to which the given source location points.
589  */
591  CXFile *file,
592  unsigned *line,
593  unsigned *column,
594  unsigned *offset);
595 
596 /**
597  * \brief Retrieve a source location representing the first character within a
598  * source range.
599  */
601 
602 /**
603  * \brief Retrieve a source location representing the last character within a
604  * source range.
605  */
607 
608 /**
609  * \brief Identifies an array of ranges.
610  */
611 typedef struct {
612  /** \brief The number of ranges in the \c ranges array. */
613  unsigned count;
614  /**
615  * \brief An array of \c CXSourceRanges.
616  */
619 
620 /**
621  * \brief Retrieve all ranges that were skipped by the preprocessor.
622  *
623  * The preprocessor will skip lines when they are surrounded by an
624  * if/ifdef/ifndef directive whose condition does not evaluate to true.
625  */
627  CXFile file);
628 
629 /**
630  * \brief Destroy the given \c CXSourceRangeList.
631  */
633 
634 /**
635  * @}
636  */
637 
638 /**
639  * \defgroup CINDEX_DIAG Diagnostic reporting
640  *
641  * @{
642  */
643 
644 /**
645  * \brief Describes the severity of a particular diagnostic.
646  */
648  /**
649  * \brief A diagnostic that has been suppressed, e.g., by a command-line
650  * option.
651  */
653 
654  /**
655  * \brief This diagnostic is a note that should be attached to the
656  * previous (non-note) diagnostic.
657  */
659 
660  /**
661  * \brief This diagnostic indicates suspicious code that may not be
662  * wrong.
663  */
665 
666  /**
667  * \brief This diagnostic indicates that the code is ill-formed.
668  */
670 
671  /**
672  * \brief This diagnostic indicates that the code is ill-formed such
673  * that future parser recovery is unlikely to produce useful
674  * results.
675  */
677 };
678 
679 /**
680  * \brief A single diagnostic, containing the diagnostic's severity,
681  * location, text, source ranges, and fix-it hints.
682  */
683 typedef void *CXDiagnostic;
684 
685 /**
686  * \brief A group of CXDiagnostics.
687  */
688 typedef void *CXDiagnosticSet;
689 
690 /**
691  * \brief Determine the number of diagnostics in a CXDiagnosticSet.
692  */
693 CINDEX_LINKAGE unsigned clang_getNumDiagnosticsInSet(CXDiagnosticSet Diags);
694 
695 /**
696  * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
697  *
698  * \param Diags the CXDiagnosticSet to query.
699  * \param Index the zero-based diagnostic number to retrieve.
700  *
701  * \returns the requested diagnostic. This diagnostic must be freed
702  * via a call to \c clang_disposeDiagnostic().
703  */
704 CINDEX_LINKAGE CXDiagnostic clang_getDiagnosticInSet(CXDiagnosticSet Diags,
705  unsigned Index);
706 
707 /**
708  * \brief Describes the kind of error that occurred (if any) in a call to
709  * \c clang_loadDiagnostics.
710  */
712  /**
713  * \brief Indicates that no error occurred.
714  */
716 
717  /**
718  * \brief Indicates that an unknown error occurred while attempting to
719  * deserialize diagnostics.
720  */
722 
723  /**
724  * \brief Indicates that the file containing the serialized diagnostics
725  * could not be opened.
726  */
728 
729  /**
730  * \brief Indicates that the serialized diagnostics file is invalid or
731  * corrupt.
732  */
734 };
735 
736 /**
737  * \brief Deserialize a set of diagnostics from a Clang diagnostics bitcode
738  * file.
739  *
740  * \param file The name of the file to deserialize.
741  * \param error A pointer to a enum value recording if there was a problem
742  * deserializing the diagnostics.
743  * \param errorString A pointer to a CXString for recording the error string
744  * if the file was not successfully loaded.
745  *
746  * \returns A loaded CXDiagnosticSet if successful, and NULL otherwise. These
747  * diagnostics should be released using clang_disposeDiagnosticSet().
748  */
749 CINDEX_LINKAGE CXDiagnosticSet clang_loadDiagnostics(const char *file,
750  enum CXLoadDiag_Error *error,
751  CXString *errorString);
752 
753 /**
754  * \brief Release a CXDiagnosticSet and all of its contained diagnostics.
755  */
756 CINDEX_LINKAGE void clang_disposeDiagnosticSet(CXDiagnosticSet Diags);
757 
758 /**
759  * \brief Retrieve the child diagnostics of a CXDiagnostic.
760  *
761  * This CXDiagnosticSet does not need to be released by
762  * clang_disposeDiagnosticSet.
763  */
764 CINDEX_LINKAGE CXDiagnosticSet clang_getChildDiagnostics(CXDiagnostic D);
765 
766 /**
767  * \brief Determine the number of diagnostics produced for the given
768  * translation unit.
769  */
770 CINDEX_LINKAGE unsigned clang_getNumDiagnostics(CXTranslationUnit Unit);
771 
772 /**
773  * \brief Retrieve a diagnostic associated with the given translation unit.
774  *
775  * \param Unit the translation unit to query.
776  * \param Index the zero-based diagnostic number to retrieve.
777  *
778  * \returns the requested diagnostic. This diagnostic must be freed
779  * via a call to \c clang_disposeDiagnostic().
780  */
781 CINDEX_LINKAGE CXDiagnostic clang_getDiagnostic(CXTranslationUnit Unit,
782  unsigned Index);
783 
784 /**
785  * \brief Retrieve the complete set of diagnostics associated with a
786  * translation unit.
787  *
788  * \param Unit the translation unit to query.
789  */
790 CINDEX_LINKAGE CXDiagnosticSet
791  clang_getDiagnosticSetFromTU(CXTranslationUnit Unit);
792 
793 /**
794  * \brief Destroy a diagnostic.
795  */
796 CINDEX_LINKAGE void clang_disposeDiagnostic(CXDiagnostic Diagnostic);
797 
798 /**
799  * \brief Options to control the display of diagnostics.
800  *
801  * The values in this enum are meant to be combined to customize the
802  * behavior of \c clang_formatDiagnostic().
803  */
805  /**
806  * \brief Display the source-location information where the
807  * diagnostic was located.
808  *
809  * When set, diagnostics will be prefixed by the file, line, and
810  * (optionally) column to which the diagnostic refers. For example,
811  *
812  * \code
813  * test.c:28: warning: extra tokens at end of #endif directive
814  * \endcode
815  *
816  * This option corresponds to the clang flag \c -fshow-source-location.
817  */
819 
820  /**
821  * \brief If displaying the source-location information of the
822  * diagnostic, also include the column number.
823  *
824  * This option corresponds to the clang flag \c -fshow-column.
825  */
827 
828  /**
829  * \brief If displaying the source-location information of the
830  * diagnostic, also include information about source ranges in a
831  * machine-parsable format.
832  *
833  * This option corresponds to the clang flag
834  * \c -fdiagnostics-print-source-range-info.
835  */
837 
838  /**
839  * \brief Display the option name associated with this diagnostic, if any.
840  *
841  * The option name displayed (e.g., -Wconversion) will be placed in brackets
842  * after the diagnostic text. This option corresponds to the clang flag
843  * \c -fdiagnostics-show-option.
844  */
846 
847  /**
848  * \brief Display the category number associated with this diagnostic, if any.
849  *
850  * The category number is displayed within brackets after the diagnostic text.
851  * This option corresponds to the clang flag
852  * \c -fdiagnostics-show-category=id.
853  */
855 
856  /**
857  * \brief Display the category name associated with this diagnostic, if any.
858  *
859  * The category name is displayed within brackets after the diagnostic text.
860  * This option corresponds to the clang flag
861  * \c -fdiagnostics-show-category=name.
862  */
864 };
865 
866 /**
867  * \brief Format the given diagnostic in a manner that is suitable for display.
868  *
869  * This routine will format the given diagnostic to a string, rendering
870  * the diagnostic according to the various options given. The
871  * \c clang_defaultDiagnosticDisplayOptions() function returns the set of
872  * options that most closely mimics the behavior of the clang compiler.
873  *
874  * \param Diagnostic The diagnostic to print.
875  *
876  * \param Options A set of options that control the diagnostic display,
877  * created by combining \c CXDiagnosticDisplayOptions values.
878  *
879  * \returns A new string containing for formatted diagnostic.
880  */
881 CINDEX_LINKAGE CXString clang_formatDiagnostic(CXDiagnostic Diagnostic,
882  unsigned Options);
883 
884 /**
885  * \brief Retrieve the set of display options most similar to the
886  * default behavior of the clang compiler.
887  *
888  * \returns A set of display options suitable for use with \c
889  * clang_formatDiagnostic().
890  */
892 
893 /**
894  * \brief Determine the severity of the given diagnostic.
895  */
897 clang_getDiagnosticSeverity(CXDiagnostic);
898 
899 /**
900  * \brief Retrieve the source location of the given diagnostic.
901  *
902  * This location is where Clang would print the caret ('^') when
903  * displaying the diagnostic on the command line.
904  */
906 
907 /**
908  * \brief Retrieve the text of the given diagnostic.
909  */
911 
912 /**
913  * \brief Retrieve the name of the command-line option that enabled this
914  * diagnostic.
915  *
916  * \param Diag The diagnostic to be queried.
917  *
918  * \param Disable If non-NULL, will be set to the option that disables this
919  * diagnostic (if any).
920  *
921  * \returns A string that contains the command-line option used to enable this
922  * warning, such as "-Wconversion" or "-pedantic".
923  */
925  CXString *Disable);
926 
927 /**
928  * \brief Retrieve the category number for this diagnostic.
929  *
930  * Diagnostics can be categorized into groups along with other, related
931  * diagnostics (e.g., diagnostics under the same warning flag). This routine
932  * retrieves the category number for the given diagnostic.
933  *
934  * \returns The number of the category that contains this diagnostic, or zero
935  * if this diagnostic is uncategorized.
936  */
937 CINDEX_LINKAGE unsigned clang_getDiagnosticCategory(CXDiagnostic);
938 
939 /**
940  * \brief Retrieve the name of a particular diagnostic category. This
941  * is now deprecated. Use clang_getDiagnosticCategoryText()
942  * instead.
943  *
944  * \param Category A diagnostic category number, as returned by
945  * \c clang_getDiagnosticCategory().
946  *
947  * \returns The name of the given diagnostic category.
948  */
951 
952 /**
953  * \brief Retrieve the diagnostic category text for a given diagnostic.
954  *
955  * \returns The text of the given diagnostic category.
956  */
958 
959 /**
960  * \brief Determine the number of source ranges associated with the given
961  * diagnostic.
962  */
963 CINDEX_LINKAGE unsigned clang_getDiagnosticNumRanges(CXDiagnostic);
964 
965 /**
966  * \brief Retrieve a source range associated with the diagnostic.
967  *
968  * A diagnostic's source ranges highlight important elements in the source
969  * code. On the command line, Clang displays source ranges by
970  * underlining them with '~' characters.
971  *
972  * \param Diagnostic the diagnostic whose range is being extracted.
973  *
974  * \param Range the zero-based index specifying which range to
975  *
976  * \returns the requested source range.
977  */
979  unsigned Range);
980 
981 /**
982  * \brief Determine the number of fix-it hints associated with the
983  * given diagnostic.
984  */
985 CINDEX_LINKAGE unsigned clang_getDiagnosticNumFixIts(CXDiagnostic Diagnostic);
986 
987 /**
988  * \brief Retrieve the replacement information for a given fix-it.
989  *
990  * Fix-its are described in terms of a source range whose contents
991  * should be replaced by a string. This approach generalizes over
992  * three kinds of operations: removal of source code (the range covers
993  * the code to be removed and the replacement string is empty),
994  * replacement of source code (the range covers the code to be
995  * replaced and the replacement string provides the new code), and
996  * insertion (both the start and end of the range point at the
997  * insertion location, and the replacement string provides the text to
998  * insert).
999  *
1000  * \param Diagnostic The diagnostic whose fix-its are being queried.
1001  *
1002  * \param FixIt The zero-based index of the fix-it.
1003  *
1004  * \param ReplacementRange The source range whose contents will be
1005  * replaced with the returned replacement string. Note that source
1006  * ranges are half-open ranges [a, b), so the source code should be
1007  * replaced from a and up to (but not including) b.
1008  *
1009  * \returns A string containing text that should be replace the source
1010  * code indicated by the \c ReplacementRange.
1011  */
1012 CINDEX_LINKAGE CXString clang_getDiagnosticFixIt(CXDiagnostic Diagnostic,
1013  unsigned FixIt,
1014  CXSourceRange *ReplacementRange);
1015 
1016 /**
1017  * @}
1018  */
1019 
1020 /**
1021  * \defgroup CINDEX_TRANSLATION_UNIT Translation unit manipulation
1022  *
1023  * The routines in this group provide the ability to create and destroy
1024  * translation units from files, either by parsing the contents of the files or
1025  * by reading in a serialized representation of a translation unit.
1026  *
1027  * @{
1028  */
1029 
1030 /**
1031  * \brief Get the original translation unit source file name.
1032  */
1034 clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit);
1035 
1036 /**
1037  * \brief Return the CXTranslationUnit for a given source file and the provided
1038  * command line arguments one would pass to the compiler.
1039  *
1040  * Note: The 'source_filename' argument is optional. If the caller provides a
1041  * NULL pointer, the name of the source file is expected to reside in the
1042  * specified command line arguments.
1043  *
1044  * Note: When encountered in 'clang_command_line_args', the following options
1045  * are ignored:
1046  *
1047  * '-c'
1048  * '-emit-ast'
1049  * '-fsyntax-only'
1050  * '-o <output file>' (both '-o' and '<output file>' are ignored)
1051  *
1052  * \param CIdx The index object with which the translation unit will be
1053  * associated.
1054  *
1055  * \param source_filename The name of the source file to load, or NULL if the
1056  * source file is included in \p clang_command_line_args.
1057  *
1058  * \param num_clang_command_line_args The number of command-line arguments in
1059  * \p clang_command_line_args.
1060  *
1061  * \param clang_command_line_args The command-line arguments that would be
1062  * passed to the \c clang executable if it were being invoked out-of-process.
1063  * These command-line options will be parsed and will affect how the translation
1064  * unit is parsed. Note that the following options are ignored: '-c',
1065  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1066  *
1067  * \param num_unsaved_files the number of unsaved file entries in \p
1068  * unsaved_files.
1069  *
1070  * \param unsaved_files the files that have not yet been saved to disk
1071  * but may be required for code completion, including the contents of
1072  * those files. The contents and name of these files (as specified by
1073  * CXUnsavedFile) are copied when necessary, so the client only needs to
1074  * guarantee their validity until the call to this function returns.
1075  */
1077  CXIndex CIdx,
1078  const char *source_filename,
1079  int num_clang_command_line_args,
1080  const char * const *clang_command_line_args,
1081  unsigned num_unsaved_files,
1082  struct CXUnsavedFile *unsaved_files);
1083 
1084 /**
1085  * \brief Same as \c clang_createTranslationUnit2, but returns
1086  * the \c CXTranslationUnit instead of an error code. In case of an error this
1087  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1088  * error codes.
1089  */
1091  CXIndex CIdx,
1092  const char *ast_filename);
1093 
1094 /**
1095  * \brief Create a translation unit from an AST file (\c -emit-ast).
1096  *
1097  * \param[out] out_TU A non-NULL pointer to store the created
1098  * \c CXTranslationUnit.
1099  *
1100  * \returns Zero on success, otherwise returns an error code.
1101  */
1103  CXIndex CIdx,
1104  const char *ast_filename,
1105  CXTranslationUnit *out_TU);
1106 
1107 /**
1108  * \brief Flags that control the creation of translation units.
1109  *
1110  * The enumerators in this enumeration type are meant to be bitwise
1111  * ORed together to specify which options should be used when
1112  * constructing the translation unit.
1113  */
1115  /**
1116  * \brief Used to indicate that no special translation-unit options are
1117  * needed.
1118  */
1120 
1121  /**
1122  * \brief Used to indicate that the parser should construct a "detailed"
1123  * preprocessing record, including all macro definitions and instantiations.
1124  *
1125  * Constructing a detailed preprocessing record requires more memory
1126  * and time to parse, since the information contained in the record
1127  * is usually not retained. However, it can be useful for
1128  * applications that require more detailed information about the
1129  * behavior of the preprocessor.
1130  */
1132 
1133  /**
1134  * \brief Used to indicate that the translation unit is incomplete.
1135  *
1136  * When a translation unit is considered "incomplete", semantic
1137  * analysis that is typically performed at the end of the
1138  * translation unit will be suppressed. For example, this suppresses
1139  * the completion of tentative declarations in C and of
1140  * instantiation of implicitly-instantiation function templates in
1141  * C++. This option is typically used when parsing a header with the
1142  * intent of producing a precompiled header.
1143  */
1145 
1146  /**
1147  * \brief Used to indicate that the translation unit should be built with an
1148  * implicit precompiled header for the preamble.
1149  *
1150  * An implicit precompiled header is used as an optimization when a
1151  * particular translation unit is likely to be reparsed many times
1152  * when the sources aren't changing that often. In this case, an
1153  * implicit precompiled header will be built containing all of the
1154  * initial includes at the top of the main file (what we refer to as
1155  * the "preamble" of the file). In subsequent parses, if the
1156  * preamble or the files in it have not changed, \c
1157  * clang_reparseTranslationUnit() will re-use the implicit
1158  * precompiled header to improve parsing performance.
1159  */
1161 
1162  /**
1163  * \brief Used to indicate that the translation unit should cache some
1164  * code-completion results with each reparse of the source file.
1165  *
1166  * Caching of code-completion results is a performance optimization that
1167  * introduces some overhead to reparsing but improves the performance of
1168  * code-completion operations.
1169  */
1171 
1172  /**
1173  * \brief Used to indicate that the translation unit will be serialized with
1174  * \c clang_saveTranslationUnit.
1175  *
1176  * This option is typically used when parsing a header with the intent of
1177  * producing a precompiled header.
1178  */
1180 
1181  /**
1182  * \brief DEPRECATED: Enabled chained precompiled preambles in C++.
1183  *
1184  * Note: this is a *temporary* option that is available only while
1185  * we are testing C++ precompiled preamble support. It is deprecated.
1186  */
1188 
1189  /**
1190  * \brief Used to indicate that function/method bodies should be skipped while
1191  * parsing.
1192  *
1193  * This option can be used to search for declarations/definitions while
1194  * ignoring the usages.
1195  */
1197 
1198  /**
1199  * \brief Used to indicate that brief documentation comments should be
1200  * included into the set of code completions returned from this translation
1201  * unit.
1202  */
1204 
1205  /**
1206  * \brief Used to indicate that the precompiled preamble should be created on
1207  * the first parse. Otherwise it will be created on the first reparse. This
1208  * trades runtime on the first parse (serializing the preamble takes time) for
1209  * reduced runtime on the second parse (can now reuse the preamble).
1210  */
1212 
1213  /**
1214  * \brief Do not stop processing when fatal errors are encountered.
1215  *
1216  * When fatal errors are encountered while parsing a translation unit,
1217  * semantic analysis is typically stopped early when compiling code. A common
1218  * source for fatal errors are unresolvable include files. For the
1219  * purposes of an IDE, this is undesirable behavior and as much information
1220  * as possible should be reported. Use this flag to enable this behavior.
1221  */
1223 };
1224 
1225 /**
1226  * \brief Returns the set of flags that is suitable for parsing a translation
1227  * unit that is being edited.
1228  *
1229  * The set of flags returned provide options for \c clang_parseTranslationUnit()
1230  * to indicate that the translation unit is likely to be reparsed many times,
1231  * either explicitly (via \c clang_reparseTranslationUnit()) or implicitly
1232  * (e.g., by code completion (\c clang_codeCompletionAt())). The returned flag
1233  * set contains an unspecified set of optimizations (e.g., the precompiled
1234  * preamble) geared toward improving the performance of these routines. The
1235  * set of optimizations enabled may change from one version to the next.
1236  */
1238 
1239 /**
1240  * \brief Same as \c clang_parseTranslationUnit2, but returns
1241  * the \c CXTranslationUnit instead of an error code. In case of an error this
1242  * routine returns a \c NULL \c CXTranslationUnit, without further detailed
1243  * error codes.
1244  */
1245 CINDEX_LINKAGE CXTranslationUnit
1246 clang_parseTranslationUnit(CXIndex CIdx,
1247  const char *source_filename,
1248  const char *const *command_line_args,
1249  int num_command_line_args,
1250  struct CXUnsavedFile *unsaved_files,
1251  unsigned num_unsaved_files,
1252  unsigned options);
1253 
1254 /**
1255  * \brief Parse the given source file and the translation unit corresponding
1256  * to that file.
1257  *
1258  * This routine is the main entry point for the Clang C API, providing the
1259  * ability to parse a source file into a translation unit that can then be
1260  * queried by other functions in the API. This routine accepts a set of
1261  * command-line arguments so that the compilation can be configured in the same
1262  * way that the compiler is configured on the command line.
1263  *
1264  * \param CIdx The index object with which the translation unit will be
1265  * associated.
1266  *
1267  * \param source_filename The name of the source file to load, or NULL if the
1268  * source file is included in \c command_line_args.
1269  *
1270  * \param command_line_args The command-line arguments that would be
1271  * passed to the \c clang executable if it were being invoked out-of-process.
1272  * These command-line options will be parsed and will affect how the translation
1273  * unit is parsed. Note that the following options are ignored: '-c',
1274  * '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
1275  *
1276  * \param num_command_line_args The number of command-line arguments in
1277  * \c command_line_args.
1278  *
1279  * \param unsaved_files the files that have not yet been saved to disk
1280  * but may be required for parsing, including the contents of
1281  * those files. The contents and name of these files (as specified by
1282  * CXUnsavedFile) are copied when necessary, so the client only needs to
1283  * guarantee their validity until the call to this function returns.
1284  *
1285  * \param num_unsaved_files the number of unsaved file entries in \p
1286  * unsaved_files.
1287  *
1288  * \param options A bitmask of options that affects how the translation unit
1289  * is managed but not its compilation. This should be a bitwise OR of the
1290  * CXTranslationUnit_XXX flags.
1291  *
1292  * \param[out] out_TU A non-NULL pointer to store the created
1293  * \c CXTranslationUnit, describing the parsed code and containing any
1294  * diagnostics produced by the compiler.
1295  *
1296  * \returns Zero on success, otherwise returns an error code.
1297  */
1299 clang_parseTranslationUnit2(CXIndex CIdx,
1300  const char *source_filename,
1301  const char *const *command_line_args,
1302  int num_command_line_args,
1303  struct CXUnsavedFile *unsaved_files,
1304  unsigned num_unsaved_files,
1305  unsigned options,
1306  CXTranslationUnit *out_TU);
1307 
1308 /**
1309  * \brief Same as clang_parseTranslationUnit2 but requires a full command line
1310  * for \c command_line_args including argv[0]. This is useful if the standard
1311  * library paths are relative to the binary.
1312  */
1314  CXIndex CIdx, const char *source_filename,
1315  const char *const *command_line_args, int num_command_line_args,
1316  struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
1317  unsigned options, CXTranslationUnit *out_TU);
1318 
1319 /**
1320  * \brief Flags that control how translation units are saved.
1321  *
1322  * The enumerators in this enumeration type are meant to be bitwise
1323  * ORed together to specify which options should be used when
1324  * saving the translation unit.
1325  */
1327  /**
1328  * \brief Used to indicate that no special saving options are needed.
1329  */
1331 };
1332 
1333 /**
1334  * \brief Returns the set of flags that is suitable for saving a translation
1335  * unit.
1336  *
1337  * The set of flags returned provide options for
1338  * \c clang_saveTranslationUnit() by default. The returned flag
1339  * set contains an unspecified set of options that save translation units with
1340  * the most commonly-requested data.
1341  */
1342 CINDEX_LINKAGE unsigned clang_defaultSaveOptions(CXTranslationUnit TU);
1343 
1344 /**
1345  * \brief Describes the kind of error that occurred (if any) in a call to
1346  * \c clang_saveTranslationUnit().
1347  */
1349  /**
1350  * \brief Indicates that no error occurred while saving a translation unit.
1351  */
1353 
1354  /**
1355  * \brief Indicates that an unknown error occurred while attempting to save
1356  * the file.
1357  *
1358  * This error typically indicates that file I/O failed when attempting to
1359  * write the file.
1360  */
1362 
1363  /**
1364  * \brief Indicates that errors during translation prevented this attempt
1365  * to save the translation unit.
1366  *
1367  * Errors that prevent the translation unit from being saved can be
1368  * extracted using \c clang_getNumDiagnostics() and \c clang_getDiagnostic().
1369  */
1371 
1372  /**
1373  * \brief Indicates that the translation unit to be saved was somehow
1374  * invalid (e.g., NULL).
1375  */
1377 };
1378 
1379 /**
1380  * \brief Saves a translation unit into a serialized representation of
1381  * that translation unit on disk.
1382  *
1383  * Any translation unit that was parsed without error can be saved
1384  * into a file. The translation unit can then be deserialized into a
1385  * new \c CXTranslationUnit with \c clang_createTranslationUnit() or,
1386  * if it is an incomplete translation unit that corresponds to a
1387  * header, used as a precompiled header when parsing other translation
1388  * units.
1389  *
1390  * \param TU The translation unit to save.
1391  *
1392  * \param FileName The file to which the translation unit will be saved.
1393  *
1394  * \param options A bitmask of options that affects how the translation unit
1395  * is saved. This should be a bitwise OR of the
1396  * CXSaveTranslationUnit_XXX flags.
1397  *
1398  * \returns A value that will match one of the enumerators of the CXSaveError
1399  * enumeration. Zero (CXSaveError_None) indicates that the translation unit was
1400  * saved successfully, while a non-zero value indicates that a problem occurred.
1401  */
1402 CINDEX_LINKAGE int clang_saveTranslationUnit(CXTranslationUnit TU,
1403  const char *FileName,
1404  unsigned options);
1405 
1406 /**
1407  * \brief Destroy the specified CXTranslationUnit object.
1408  */
1409 CINDEX_LINKAGE void clang_disposeTranslationUnit(CXTranslationUnit);
1410 
1411 /**
1412  * \brief Flags that control the reparsing of translation units.
1413  *
1414  * The enumerators in this enumeration type are meant to be bitwise
1415  * ORed together to specify which options should be used when
1416  * reparsing the translation unit.
1417  */
1419  /**
1420  * \brief Used to indicate that no special reparsing options are needed.
1421  */
1423 };
1424 
1425 /**
1426  * \brief Returns the set of flags that is suitable for reparsing a translation
1427  * unit.
1428  *
1429  * The set of flags returned provide options for
1430  * \c clang_reparseTranslationUnit() by default. The returned flag
1431  * set contains an unspecified set of optimizations geared toward common uses
1432  * of reparsing. The set of optimizations enabled may change from one version
1433  * to the next.
1434  */
1435 CINDEX_LINKAGE unsigned clang_defaultReparseOptions(CXTranslationUnit TU);
1436 
1437 /**
1438  * \brief Reparse the source files that produced this translation unit.
1439  *
1440  * This routine can be used to re-parse the source files that originally
1441  * created the given translation unit, for example because those source files
1442  * have changed (either on disk or as passed via \p unsaved_files). The
1443  * source code will be reparsed with the same command-line options as it
1444  * was originally parsed.
1445  *
1446  * Reparsing a translation unit invalidates all cursors and source locations
1447  * that refer into that translation unit. This makes reparsing a translation
1448  * unit semantically equivalent to destroying the translation unit and then
1449  * creating a new translation unit with the same command-line arguments.
1450  * However, it may be more efficient to reparse a translation
1451  * unit using this routine.
1452  *
1453  * \param TU The translation unit whose contents will be re-parsed. The
1454  * translation unit must originally have been built with
1455  * \c clang_createTranslationUnitFromSourceFile().
1456  *
1457  * \param num_unsaved_files The number of unsaved file entries in \p
1458  * unsaved_files.
1459  *
1460  * \param unsaved_files The files that have not yet been saved to disk
1461  * but may be required for parsing, including the contents of
1462  * those files. The contents and name of these files (as specified by
1463  * CXUnsavedFile) are copied when necessary, so the client only needs to
1464  * guarantee their validity until the call to this function returns.
1465  *
1466  * \param options A bitset of options composed of the flags in CXReparse_Flags.
1467  * The function \c clang_defaultReparseOptions() produces a default set of
1468  * options recommended for most uses, based on the translation unit.
1469  *
1470  * \returns 0 if the sources could be reparsed. A non-zero error code will be
1471  * returned if reparsing was impossible, such that the translation unit is
1472  * invalid. In such cases, the only valid call for \c TU is
1473  * \c clang_disposeTranslationUnit(TU). The error codes returned by this
1474  * routine are described by the \c CXErrorCode enum.
1475  */
1476 CINDEX_LINKAGE int clang_reparseTranslationUnit(CXTranslationUnit TU,
1477  unsigned num_unsaved_files,
1478  struct CXUnsavedFile *unsaved_files,
1479  unsigned options);
1480 
1481 /**
1482  * \brief Categorizes how memory is being used by a translation unit.
1483  */
1502 
1505 };
1506 
1507 /**
1508  * \brief Returns the human-readable null-terminated C string that represents
1509  * the name of the memory category. This string should never be freed.
1510  */
1513 
1514 typedef struct CXTUResourceUsageEntry {
1515  /* \brief The memory usage category. */
1517  /* \brief Amount of resources used.
1518  The units will depend on the resource kind. */
1519  unsigned long amount;
1521 
1522 /**
1523  * \brief The memory usage of a CXTranslationUnit, broken into categories.
1524  */
1525 typedef struct CXTUResourceUsage {
1526  /* \brief Private data member, used for queries. */
1527  void *data;
1528 
1529  /* \brief The number of entries in the 'entries' array. */
1530  unsigned numEntries;
1531 
1532  /* \brief An array of key-value pairs, representing the breakdown of memory
1533  usage. */
1535 
1537 
1538 /**
1539  * \brief Return the memory usage of a translation unit. This object
1540  * should be released with clang_disposeCXTUResourceUsage().
1541  */
1543 
1545 
1546 /**
1547  * @}
1548  */
1549 
1550 /**
1551  * \brief Describes the kind of entity that a cursor refers to.
1552  */
1554  /* Declarations */
1555  /**
1556  * \brief A declaration whose specific kind is not exposed via this
1557  * interface.
1558  *
1559  * Unexposed declarations have the same operations as any other kind
1560  * of declaration; one can extract their location information,
1561  * spelling, find their definitions, etc. However, the specific kind
1562  * of the declaration is not reported.
1563  */
1565  /** \brief A C or C++ struct. */
1567  /** \brief A C or C++ union. */
1569  /** \brief A C++ class. */
1571  /** \brief An enumeration. */
1573  /**
1574  * \brief A field (in C) or non-static data member (in C++) in a
1575  * struct, union, or C++ class.
1576  */
1578  /** \brief An enumerator constant. */
1580  /** \brief A function. */
1582  /** \brief A variable. */
1584  /** \brief A function or method parameter. */
1586  /** \brief An Objective-C \@interface. */
1588  /** \brief An Objective-C \@interface for a category. */
1590  /** \brief An Objective-C \@protocol declaration. */
1592  /** \brief An Objective-C \@property declaration. */
1594  /** \brief An Objective-C instance variable. */
1596  /** \brief An Objective-C instance method. */
1598  /** \brief An Objective-C class method. */
1600  /** \brief An Objective-C \@implementation. */
1602  /** \brief An Objective-C \@implementation for a category. */
1604  /** \brief A typedef. */
1606  /** \brief A C++ class method. */
1608  /** \brief A C++ namespace. */
1610  /** \brief A linkage specification, e.g. 'extern "C"'. */
1612  /** \brief A C++ constructor. */
1614  /** \brief A C++ destructor. */
1616  /** \brief A C++ conversion function. */
1618  /** \brief A C++ template type parameter. */
1620  /** \brief A C++ non-type template parameter. */
1622  /** \brief A C++ template template parameter. */
1624  /** \brief A C++ function template. */
1626  /** \brief A C++ class template. */
1628  /** \brief A C++ class template partial specialization. */
1630  /** \brief A C++ namespace alias declaration. */
1632  /** \brief A C++ using directive. */
1634  /** \brief A C++ using declaration. */
1636  /** \brief A C++ alias declaration */
1638  /** \brief An Objective-C \@synthesize definition. */
1640  /** \brief An Objective-C \@dynamic definition. */
1642  /** \brief An access specifier. */
1644 
1647 
1648  /* References */
1649  CXCursor_FirstRef = 40, /* Decl references */
1653  /**
1654  * \brief A reference to a type declaration.
1655  *
1656  * A type reference occurs anywhere where a type is named but not
1657  * declared. For example, given:
1658  *
1659  * \code
1660  * typedef unsigned size_type;
1661  * size_type size;
1662  * \endcode
1663  *
1664  * The typedef is a declaration of size_type (CXCursor_TypedefDecl),
1665  * while the type of the variable "size" is referenced. The cursor
1666  * referenced by the type of size is the typedef for size_type.
1667  */
1670  /**
1671  * \brief A reference to a class template, function template, template
1672  * template parameter, or class template partial specialization.
1673  */
1675  /**
1676  * \brief A reference to a namespace or namespace alias.
1677  */
1679  /**
1680  * \brief A reference to a member of a struct, union, or class that occurs in
1681  * some non-expression context, e.g., a designated initializer.
1682  */
1684  /**
1685  * \brief A reference to a labeled statement.
1686  *
1687  * This cursor kind is used to describe the jump to "start_over" in the
1688  * goto statement in the following example:
1689  *
1690  * \code
1691  * start_over:
1692  * ++counter;
1693  *
1694  * goto start_over;
1695  * \endcode
1696  *
1697  * A label reference cursor refers to a label statement.
1698  */
1700 
1701  /**
1702  * \brief A reference to a set of overloaded functions or function templates
1703  * that has not yet been resolved to a specific function or function template.
1704  *
1705  * An overloaded declaration reference cursor occurs in C++ templates where
1706  * a dependent name refers to a function. For example:
1707  *
1708  * \code
1709  * template<typename T> void swap(T&, T&);
1710  *
1711  * struct X { ... };
1712  * void swap(X&, X&);
1713  *
1714  * template<typename T>
1715  * void reverse(T* first, T* last) {
1716  * while (first < last - 1) {
1717  * swap(*first, *--last);
1718  * ++first;
1719  * }
1720  * }
1721  *
1722  * struct Y { };
1723  * void swap(Y&, Y&);
1724  * \endcode
1725  *
1726  * Here, the identifier "swap" is associated with an overloaded declaration
1727  * reference. In the template definition, "swap" refers to either of the two
1728  * "swap" functions declared above, so both results will be available. At
1729  * instantiation time, "swap" may also refer to other functions found via
1730  * argument-dependent lookup (e.g., the "swap" function at the end of the
1731  * example).
1732  *
1733  * The functions \c clang_getNumOverloadedDecls() and
1734  * \c clang_getOverloadedDecl() can be used to retrieve the definitions
1735  * referenced by this cursor.
1736  */
1738 
1739  /**
1740  * \brief A reference to a variable that occurs in some non-expression
1741  * context, e.g., a C++ lambda capture list.
1742  */
1744 
1746 
1747  /* Error conditions */
1754 
1755  /* Expressions */
1757 
1758  /**
1759  * \brief An expression whose specific kind is not exposed via this
1760  * interface.
1761  *
1762  * Unexposed expressions have the same operations as any other kind
1763  * of expression; one can extract their location information,
1764  * spelling, children, etc. However, the specific kind of the
1765  * expression is not reported.
1766  */
1768 
1769  /**
1770  * \brief An expression that refers to some value declaration, such
1771  * as a function, variable, or enumerator.
1772  */
1774 
1775  /**
1776  * \brief An expression that refers to a member of a struct, union,
1777  * class, Objective-C class, etc.
1778  */
1780 
1781  /** \brief An expression that calls a function. */
1783 
1784  /** \brief An expression that sends a message to an Objective-C
1785  object or class. */
1787 
1788  /** \brief An expression that represents a block literal. */
1790 
1791  /** \brief An integer literal.
1792  */
1794 
1795  /** \brief A floating point number literal.
1796  */
1798 
1799  /** \brief An imaginary number literal.
1800  */
1802 
1803  /** \brief A string literal.
1804  */
1806 
1807  /** \brief A character literal.
1808  */
1810 
1811  /** \brief A parenthesized expression, e.g. "(1)".
1812  *
1813  * This AST node is only formed if full location information is requested.
1814  */
1816 
1817  /** \brief This represents the unary-expression's (except sizeof and
1818  * alignof).
1819  */
1821 
1822  /** \brief [C99 6.5.2.1] Array Subscripting.
1823  */
1825 
1826  /** \brief A builtin binary operation expression such as "x + y" or
1827  * "x <= y".
1828  */
1830 
1831  /** \brief Compound assignment such as "+=".
1832  */
1834 
1835  /** \brief The ?: ternary operator.
1836  */
1838 
1839  /** \brief An explicit cast in C (C99 6.5.4) or a C-style cast in C++
1840  * (C++ [expr.cast]), which uses the syntax (Type)expr.
1841  *
1842  * For example: (int)f.
1843  */
1845 
1846  /** \brief [C99 6.5.2.5]
1847  */
1849 
1850  /** \brief Describes an C or C++ initializer list.
1851  */
1853 
1854  /** \brief The GNU address of label extension, representing &&label.
1855  */
1857 
1858  /** \brief This is the GNU Statement Expression extension: ({int X=4; X;})
1859  */
1861 
1862  /** \brief Represents a C11 generic selection.
1863  */
1865 
1866  /** \brief Implements the GNU __null extension, which is a name for a null
1867  * pointer constant that has integral type (e.g., int or long) and is the same
1868  * size and alignment as a pointer.
1869  *
1870  * The __null extension is typically only used by system headers, which define
1871  * NULL as __null in C++ rather than using 0 (which is an integer that may not
1872  * match the size of a pointer).
1873  */
1875 
1876  /** \brief C++'s static_cast<> expression.
1877  */
1879 
1880  /** \brief C++'s dynamic_cast<> expression.
1881  */
1883 
1884  /** \brief C++'s reinterpret_cast<> expression.
1885  */
1887 
1888  /** \brief C++'s const_cast<> expression.
1889  */
1891 
1892  /** \brief Represents an explicit C++ type conversion that uses "functional"
1893  * notion (C++ [expr.type.conv]).
1894  *
1895  * Example:
1896  * \code
1897  * x = int(0.5);
1898  * \endcode
1899  */
1901 
1902  /** \brief A C++ typeid expression (C++ [expr.typeid]).
1903  */
1905 
1906  /** \brief [C++ 2.13.5] C++ Boolean Literal.
1907  */
1909 
1910  /** \brief [C++0x 2.14.7] C++ Pointer Literal.
1911  */
1913 
1914  /** \brief Represents the "this" expression in C++
1915  */
1917 
1918  /** \brief [C++ 15] C++ Throw Expression.
1919  *
1920  * This handles 'throw' and 'throw' assignment-expression. When
1921  * assignment-expression isn't present, Op will be null.
1922  */
1924 
1925  /** \brief A new expression for memory allocation and constructor calls, e.g:
1926  * "new CXXNewExpr(foo)".
1927  */
1929 
1930  /** \brief A delete expression for memory deallocation and destructor calls,
1931  * e.g. "delete[] pArray".
1932  */
1934 
1935  /** \brief A unary expression.
1936  */
1938 
1939  /** \brief An Objective-C string literal i.e. @"foo".
1940  */
1942 
1943  /** \brief An Objective-C \@encode expression.
1944  */
1946 
1947  /** \brief An Objective-C \@selector expression.
1948  */
1950 
1951  /** \brief An Objective-C \@protocol expression.
1952  */
1954 
1955  /** \brief An Objective-C "bridged" cast expression, which casts between
1956  * Objective-C pointers and C pointers, transferring ownership in the process.
1957  *
1958  * \code
1959  * NSString *str = (__bridge_transfer NSString *)CFCreateString();
1960  * \endcode
1961  */
1963 
1964  /** \brief Represents a C++0x pack expansion that produces a sequence of
1965  * expressions.
1966  *
1967  * A pack expansion expression contains a pattern (which itself is an
1968  * expression) followed by an ellipsis. For example:
1969  *
1970  * \code
1971  * template<typename F, typename ...Types>
1972  * void forward(F f, Types &&...args) {
1973  * f(static_cast<Types&&>(args)...);
1974  * }
1975  * \endcode
1976  */
1978 
1979  /** \brief Represents an expression that computes the length of a parameter
1980  * pack.
1981  *
1982  * \code
1983  * template<typename ...Types>
1984  * struct count {
1985  * static const unsigned value = sizeof...(Types);
1986  * };
1987  * \endcode
1988  */
1990 
1991  /* \brief Represents a C++ lambda expression that produces a local function
1992  * object.
1993  *
1994  * \code
1995  * void abssort(float *x, unsigned N) {
1996  * std::sort(x, x + N,
1997  * [](float a, float b) {
1998  * return std::abs(a) < std::abs(b);
1999  * });
2000  * }
2001  * \endcode
2002  */
2004 
2005  /** \brief Objective-c Boolean Literal.
2006  */
2008 
2009  /** \brief Represents the "self" expression in an Objective-C method.
2010  */
2012 
2013  /** \brief OpenMP 4.0 [2.4, Array Section].
2014  */
2016 
2018 
2019  /* Statements */
2021  /**
2022  * \brief A statement whose specific kind is not exposed via this
2023  * interface.
2024  *
2025  * Unexposed statements have the same operations as any other kind of
2026  * statement; one can extract their location information, spelling,
2027  * children, etc. However, the specific kind of the statement is not
2028  * reported.
2029  */
2031 
2032  /** \brief A labelled statement in a function.
2033  *
2034  * This cursor kind is used to describe the "start_over:" label statement in
2035  * the following example:
2036  *
2037  * \code
2038  * start_over:
2039  * ++counter;
2040  * \endcode
2041  *
2042  */
2044 
2045  /** \brief A group of statements like { stmt stmt }.
2046  *
2047  * This cursor kind is used to describe compound statements, e.g. function
2048  * bodies.
2049  */
2051 
2052  /** \brief A case statement.
2053  */
2055 
2056  /** \brief A default statement.
2057  */
2059 
2060  /** \brief An if statement
2061  */
2063 
2064  /** \brief A switch statement.
2065  */
2067 
2068  /** \brief A while statement.
2069  */
2071 
2072  /** \brief A do statement.
2073  */
2075 
2076  /** \brief A for statement.
2077  */
2079 
2080  /** \brief A goto statement.
2081  */
2083 
2084  /** \brief An indirect goto statement.
2085  */
2087 
2088  /** \brief A continue statement.
2089  */
2091 
2092  /** \brief A break statement.
2093  */
2095 
2096  /** \brief A return statement.
2097  */
2099 
2100  /** \brief A GCC inline assembly statement extension.
2101  */
2104 
2105  /** \brief Objective-C's overall \@try-\@catch-\@finally statement.
2106  */
2108 
2109  /** \brief Objective-C's \@catch statement.
2110  */
2112 
2113  /** \brief Objective-C's \@finally statement.
2114  */
2116 
2117  /** \brief Objective-C's \@throw statement.
2118  */
2120 
2121  /** \brief Objective-C's \@synchronized statement.
2122  */
2124 
2125  /** \brief Objective-C's autorelease pool statement.
2126  */
2128 
2129  /** \brief Objective-C's collection statement.
2130  */
2132 
2133  /** \brief C++'s catch statement.
2134  */
2136 
2137  /** \brief C++'s try statement.
2138  */
2140 
2141  /** \brief C++'s for (* : *) statement.
2142  */
2144 
2145  /** \brief Windows Structured Exception Handling's try statement.
2146  */
2148 
2149  /** \brief Windows Structured Exception Handling's except statement.
2150  */
2152 
2153  /** \brief Windows Structured Exception Handling's finally statement.
2154  */
2156 
2157  /** \brief A MS inline assembly statement extension.
2158  */
2160 
2161  /** \brief The null statement ";": C99 6.8.3p3.
2162  *
2163  * This cursor kind is used to describe the null statement.
2164  */
2166 
2167  /** \brief Adaptor class for mixing declarations with statements and
2168  * expressions.
2169  */
2171 
2172  /** \brief OpenMP parallel directive.
2173  */
2175 
2176  /** \brief OpenMP SIMD directive.
2177  */
2179 
2180  /** \brief OpenMP for directive.
2181  */
2183 
2184  /** \brief OpenMP sections directive.
2185  */
2187 
2188  /** \brief OpenMP section directive.
2189  */
2191 
2192  /** \brief OpenMP single directive.
2193  */
2195 
2196  /** \brief OpenMP parallel for directive.
2197  */
2199 
2200  /** \brief OpenMP parallel sections directive.
2201  */
2203 
2204  /** \brief OpenMP task directive.
2205  */
2207 
2208  /** \brief OpenMP master directive.
2209  */
2211 
2212  /** \brief OpenMP critical directive.
2213  */
2215 
2216  /** \brief OpenMP taskyield directive.
2217  */
2219 
2220  /** \brief OpenMP barrier directive.
2221  */
2223 
2224  /** \brief OpenMP taskwait directive.
2225  */
2227 
2228  /** \brief OpenMP flush directive.
2229  */
2231 
2232  /** \brief Windows Structured Exception Handling's leave statement.
2233  */
2235 
2236  /** \brief OpenMP ordered directive.
2237  */
2239 
2240  /** \brief OpenMP atomic directive.
2241  */
2243 
2244  /** \brief OpenMP for SIMD directive.
2245  */
2247 
2248  /** \brief OpenMP parallel for SIMD directive.
2249  */
2251 
2252  /** \brief OpenMP target directive.
2253  */
2255 
2256  /** \brief OpenMP teams directive.
2257  */
2259 
2260  /** \brief OpenMP taskgroup directive.
2261  */
2263 
2264  /** \brief OpenMP cancellation point directive.
2265  */
2267 
2268  /** \brief OpenMP cancel directive.
2269  */
2271 
2272  /** \brief OpenMP target data directive.
2273  */
2275 
2276  /** \brief OpenMP taskloop directive.
2277  */
2279 
2280  /** \brief OpenMP taskloop simd directive.
2281  */
2283 
2284  /** \brief OpenMP distribute directive.
2285  */
2287 
2288  /** \brief OpenMP target enter data directive.
2289  */
2291 
2292  /** \brief OpenMP target exit data directive.
2293  */
2295 
2296  /** \brief OpenMP target parallel directive.
2297  */
2299 
2300  /** \brief OpenMP target parallel for directive.
2301  */
2303 
2305 
2306  /**
2307  * \brief Cursor that represents the translation unit itself.
2308  *
2309  * The translation unit cursor exists primarily to act as the root
2310  * cursor for traversing the contents of a translation unit.
2311  */
2313 
2314  /* Attributes */
2316  /**
2317  * \brief An attribute whose specific kind is not exposed via this
2318  * interface.
2319  */
2321 
2342 
2343  /* Preprocessing */
2351 
2352  /* Extra Declarations */
2353  /**
2354  * \brief A module import declaration.
2355  */
2360 
2361  /**
2362  * \brief A code completion overload candidate.
2363  */
2365 };
2366 
2367 /**
2368  * \brief A cursor representing some element in the abstract syntax tree for
2369  * a translation unit.
2370  *
2371  * The cursor abstraction unifies the different kinds of entities in a
2372  * program--declaration, statements, expressions, references to declarations,
2373  * etc.--under a single "cursor" abstraction with a common set of operations.
2374  * Common operation for a cursor include: getting the physical location in
2375  * a source file where the cursor points, getting the name associated with a
2376  * cursor, and retrieving cursors for any child nodes of a particular cursor.
2377  *
2378  * Cursors can be produced in two specific ways.
2379  * clang_getTranslationUnitCursor() produces a cursor for a translation unit,
2380  * from which one can use clang_visitChildren() to explore the rest of the
2381  * translation unit. clang_getCursor() maps from a physical source location
2382  * to the entity that resides at that location, allowing one to map from the
2383  * source code into the AST.
2384  */
2385 typedef struct {
2387  int xdata;
2388  const void *data[3];
2389 } CXCursor;
2390 
2391 /**
2392  * \defgroup CINDEX_CURSOR_MANIP Cursor manipulations
2393  *
2394  * @{
2395  */
2396 
2397 /**
2398  * \brief Retrieve the NULL cursor, which represents no entity.
2399  */
2401 
2402 /**
2403  * \brief Retrieve the cursor that represents the given translation unit.
2404  *
2405  * The translation unit cursor can be used to start traversing the
2406  * various declarations within the given translation unit.
2407  */
2409 
2410 /**
2411  * \brief Determine whether two cursors are equivalent.
2412  */
2414 
2415 /**
2416  * \brief Returns non-zero if \p cursor is null.
2417  */
2419 
2420 /**
2421  * \brief Compute a hash value for the given cursor.
2422  */
2424 
2425 /**
2426  * \brief Retrieve the kind of the given cursor.
2427  */
2429 
2430 /**
2431  * \brief Determine whether the given cursor kind represents a declaration.
2432  */
2434 
2435 /**
2436  * \brief Determine whether the given cursor kind represents a simple
2437  * reference.
2438  *
2439  * Note that other kinds of cursors (such as expressions) can also refer to
2440  * other cursors. Use clang_getCursorReferenced() to determine whether a
2441  * particular cursor refers to another entity.
2442  */
2444 
2445 /**
2446  * \brief Determine whether the given cursor kind represents an expression.
2447  */
2449 
2450 /**
2451  * \brief Determine whether the given cursor kind represents a statement.
2452  */
2454 
2455 /**
2456  * \brief Determine whether the given cursor kind represents an attribute.
2457  */
2459 
2460 /**
2461  * \brief Determine whether the given cursor has any attributes.
2462  */
2464 
2465 /**
2466  * \brief Determine whether the given cursor kind represents an invalid
2467  * cursor.
2468  */
2470 
2471 /**
2472  * \brief Determine whether the given cursor kind represents a translation
2473  * unit.
2474  */
2476 
2477 /***
2478  * \brief Determine whether the given cursor represents a preprocessing
2479  * element, such as a preprocessor directive or macro instantiation.
2480  */
2482 
2483 /***
2484  * \brief Determine whether the given cursor represents a currently
2485  * unexposed piece of the AST (e.g., CXCursor_UnexposedStmt).
2486  */
2488 
2489 /**
2490  * \brief Describe the linkage of the entity referred to by a cursor.
2491  */
2493  /** \brief This value indicates that no linkage information is available
2494  * for a provided CXCursor. */
2496  /**
2497  * \brief This is the linkage for variables, parameters, and so on that
2498  * have automatic storage. This covers normal (non-extern) local variables.
2499  */
2501  /** \brief This is the linkage for static variables and static functions. */
2503  /** \brief This is the linkage for entities with external linkage that live
2504  * in C++ anonymous namespaces.*/
2506  /** \brief This is the linkage for entities with true, external linkage. */
2508 };
2509 
2510 /**
2511  * \brief Determine the linkage of the entity referred to by a given cursor.
2512  */
2514 
2516  /** \brief This value indicates that no visibility information is available
2517  * for a provided CXCursor. */
2519 
2520  /** \brief Symbol not seen by the linker. */
2522  /** \brief Symbol seen by the linker but resolves to a symbol inside this object. */
2524  /** \brief Symbol seen by the linker and acts like a normal symbol. */
2526 };
2527 
2528 /**
2529  * \brief Describe the visibility of the entity referred to by a cursor.
2530  *
2531  * This returns the default visibility if not explicitly specified by
2532  * a visibility attribute. The default visibility may be changed by
2533  * commandline arguments.
2534  *
2535  * \param cursor The cursor to query.
2536  *
2537  * \returns The visibility of the cursor.
2538  */
2540 
2541 /**
2542  * \brief Determine the availability of the entity that this cursor refers to,
2543  * taking the current target platform into account.
2544  *
2545  * \param cursor The cursor to query.
2546  *
2547  * \returns The availability of the cursor.
2548  */
2551 
2552 /**
2553  * Describes the availability of a given entity on a particular platform, e.g.,
2554  * a particular class might only be available on Mac OS 10.7 or newer.
2555  */
2556 typedef struct CXPlatformAvailability {
2557  /**
2558  * \brief A string that describes the platform for which this structure
2559  * provides availability information.
2560  *
2561  * Possible values are "ios" or "macosx".
2562  */
2564  /**
2565  * \brief The version number in which this entity was introduced.
2566  */
2568  /**
2569  * \brief The version number in which this entity was deprecated (but is
2570  * still available).
2571  */
2573  /**
2574  * \brief The version number in which this entity was obsoleted, and therefore
2575  * is no longer available.
2576  */
2578  /**
2579  * \brief Whether the entity is unconditionally unavailable on this platform.
2580  */
2582  /**
2583  * \brief An optional message to provide to a user of this API, e.g., to
2584  * suggest replacement APIs.
2585  */
2588 
2589 /**
2590  * \brief Determine the availability of the entity that this cursor refers to
2591  * on any platforms for which availability information is known.
2592  *
2593  * \param cursor The cursor to query.
2594  *
2595  * \param always_deprecated If non-NULL, will be set to indicate whether the
2596  * entity is deprecated on all platforms.
2597  *
2598  * \param deprecated_message If non-NULL, will be set to the message text
2599  * provided along with the unconditional deprecation of this entity. The client
2600  * is responsible for deallocating this string.
2601  *
2602  * \param always_unavailable If non-NULL, will be set to indicate whether the
2603  * entity is unavailable on all platforms.
2604  *
2605  * \param unavailable_message If non-NULL, will be set to the message text
2606  * provided along with the unconditional unavailability of this entity. The
2607  * client is responsible for deallocating this string.
2608  *
2609  * \param availability If non-NULL, an array of CXPlatformAvailability instances
2610  * that will be populated with platform availability information, up to either
2611  * the number of platforms for which availability information is available (as
2612  * returned by this function) or \c availability_size, whichever is smaller.
2613  *
2614  * \param availability_size The number of elements available in the
2615  * \c availability array.
2616  *
2617  * \returns The number of platforms (N) for which availability information is
2618  * available (which is unrelated to \c availability_size).
2619  *
2620  * Note that the client is responsible for calling
2621  * \c clang_disposeCXPlatformAvailability to free each of the
2622  * platform-availability structures returned. There are
2623  * \c min(N, availability_size) such structures.
2624  */
2625 CINDEX_LINKAGE int
2627  int *always_deprecated,
2628  CXString *deprecated_message,
2629  int *always_unavailable,
2630  CXString *unavailable_message,
2631  CXPlatformAvailability *availability,
2632  int availability_size);
2633 
2634 /**
2635  * \brief Free the memory associated with a \c CXPlatformAvailability structure.
2636  */
2637 CINDEX_LINKAGE void
2639 
2640 /**
2641  * \brief Describe the "language" of the entity referred to by a cursor.
2642  */
2648 };
2649 
2650 /**
2651  * \brief Determine the "language" of the entity referred to by a given cursor.
2652  */
2654 
2655 /**
2656  * \brief Returns the translation unit that a cursor originated from.
2657  */
2659 
2660 /**
2661  * \brief A fast container representing a set of CXCursors.
2662  */
2663 typedef struct CXCursorSetImpl *CXCursorSet;
2664 
2665 /**
2666  * \brief Creates an empty CXCursorSet.
2667  */
2668 CINDEX_LINKAGE CXCursorSet clang_createCXCursorSet(void);
2669 
2670 /**
2671  * \brief Disposes a CXCursorSet and releases its associated memory.
2672  */
2673 CINDEX_LINKAGE void clang_disposeCXCursorSet(CXCursorSet cset);
2674 
2675 /**
2676  * \brief Queries a CXCursorSet to see if it contains a specific CXCursor.
2677  *
2678  * \returns non-zero if the set contains the specified cursor.
2679 */
2680 CINDEX_LINKAGE unsigned clang_CXCursorSet_contains(CXCursorSet cset,
2681  CXCursor cursor);
2682 
2683 /**
2684  * \brief Inserts a CXCursor into a CXCursorSet.
2685  *
2686  * \returns zero if the CXCursor was already in the set, and non-zero otherwise.
2687 */
2688 CINDEX_LINKAGE unsigned clang_CXCursorSet_insert(CXCursorSet cset,
2689  CXCursor cursor);
2690 
2691 /**
2692  * \brief Determine the semantic parent of the given cursor.
2693  *
2694  * The semantic parent of a cursor is the cursor that semantically contains
2695  * the given \p cursor. For many declarations, the lexical and semantic parents
2696  * are equivalent (the lexical parent is returned by
2697  * \c clang_getCursorLexicalParent()). They diverge when declarations or
2698  * definitions are provided out-of-line. For example:
2699  *
2700  * \code
2701  * class C {
2702  * void f();
2703  * };
2704  *
2705  * void C::f() { }
2706  * \endcode
2707  *
2708  * In the out-of-line definition of \c C::f, the semantic parent is
2709  * the class \c C, of which this function is a member. The lexical parent is
2710  * the place where the declaration actually occurs in the source code; in this
2711  * case, the definition occurs in the translation unit. In general, the
2712  * lexical parent for a given entity can change without affecting the semantics
2713  * of the program, and the lexical parent of different declarations of the
2714  * same entity may be different. Changing the semantic parent of a declaration,
2715  * on the other hand, can have a major impact on semantics, and redeclarations
2716  * of a particular entity should all have the same semantic context.
2717  *
2718  * In the example above, both declarations of \c C::f have \c C as their
2719  * semantic context, while the lexical context of the first \c C::f is \c C
2720  * and the lexical context of the second \c C::f is the translation unit.
2721  *
2722  * For global declarations, the semantic parent is the translation unit.
2723  */
2725 
2726 /**
2727  * \brief Determine the lexical parent of the given cursor.
2728  *
2729  * The lexical parent of a cursor is the cursor in which the given \p cursor
2730  * was actually written. For many declarations, the lexical and semantic parents
2731  * are equivalent (the semantic parent is returned by
2732  * \c clang_getCursorSemanticParent()). They diverge when declarations or
2733  * definitions are provided out-of-line. For example:
2734  *
2735  * \code
2736  * class C {
2737  * void f();
2738  * };
2739  *
2740  * void C::f() { }
2741  * \endcode
2742  *
2743  * In the out-of-line definition of \c C::f, the semantic parent is
2744  * the class \c C, of which this function is a member. The lexical parent is
2745  * the place where the declaration actually occurs in the source code; in this
2746  * case, the definition occurs in the translation unit. In general, the
2747  * lexical parent for a given entity can change without affecting the semantics
2748  * of the program, and the lexical parent of different declarations of the
2749  * same entity may be different. Changing the semantic parent of a declaration,
2750  * on the other hand, can have a major impact on semantics, and redeclarations
2751  * of a particular entity should all have the same semantic context.
2752  *
2753  * In the example above, both declarations of \c C::f have \c C as their
2754  * semantic context, while the lexical context of the first \c C::f is \c C
2755  * and the lexical context of the second \c C::f is the translation unit.
2756  *
2757  * For declarations written in the global scope, the lexical parent is
2758  * the translation unit.
2759  */
2761 
2762 /**
2763  * \brief Determine the set of methods that are overridden by the given
2764  * method.
2765  *
2766  * In both Objective-C and C++, a method (aka virtual member function,
2767  * in C++) can override a virtual method in a base class. For
2768  * Objective-C, a method is said to override any method in the class's
2769  * base class, its protocols, or its categories' protocols, that has the same
2770  * selector and is of the same kind (class or instance).
2771  * If no such method exists, the search continues to the class's superclass,
2772  * its protocols, and its categories, and so on. A method from an Objective-C
2773  * implementation is considered to override the same methods as its
2774  * corresponding method in the interface.
2775  *
2776  * For C++, a virtual member function overrides any virtual member
2777  * function with the same signature that occurs in its base
2778  * classes. With multiple inheritance, a virtual member function can
2779  * override several virtual member functions coming from different
2780  * base classes.
2781  *
2782  * In all cases, this function determines the immediate overridden
2783  * method, rather than all of the overridden methods. For example, if
2784  * a method is originally declared in a class A, then overridden in B
2785  * (which in inherits from A) and also in C (which inherited from B),
2786  * then the only overridden method returned from this function when
2787  * invoked on C's method will be B's method. The client may then
2788  * invoke this function again, given the previously-found overridden
2789  * methods, to map out the complete method-override set.
2790  *
2791  * \param cursor A cursor representing an Objective-C or C++
2792  * method. This routine will compute the set of methods that this
2793  * method overrides.
2794  *
2795  * \param overridden A pointer whose pointee will be replaced with a
2796  * pointer to an array of cursors, representing the set of overridden
2797  * methods. If there are no overridden methods, the pointee will be
2798  * set to NULL. The pointee must be freed via a call to
2799  * \c clang_disposeOverriddenCursors().
2800  *
2801  * \param num_overridden A pointer to the number of overridden
2802  * functions, will be set to the number of overridden functions in the
2803  * array pointed to by \p overridden.
2804  */
2806  CXCursor **overridden,
2807  unsigned *num_overridden);
2808 
2809 /**
2810  * \brief Free the set of overridden cursors returned by \c
2811  * clang_getOverriddenCursors().
2812  */
2814 
2815 /**
2816  * \brief Retrieve the file that is included by the given inclusion directive
2817  * cursor.
2818  */
2820 
2821 /**
2822  * @}
2823  */
2824 
2825 /**
2826  * \defgroup CINDEX_CURSOR_SOURCE Mapping between cursors and source code
2827  *
2828  * Cursors represent a location within the Abstract Syntax Tree (AST). These
2829  * routines help map between cursors and the physical locations where the
2830  * described entities occur in the source code. The mapping is provided in
2831  * both directions, so one can map from source code to the AST and back.
2832  *
2833  * @{
2834  */
2835 
2836 /**
2837  * \brief Map a source location to the cursor that describes the entity at that
2838  * location in the source code.
2839  *
2840  * clang_getCursor() maps an arbitrary source location within a translation
2841  * unit down to the most specific cursor that describes the entity at that
2842  * location. For example, given an expression \c x + y, invoking
2843  * clang_getCursor() with a source location pointing to "x" will return the
2844  * cursor for "x"; similarly for "y". If the cursor points anywhere between
2845  * "x" or "y" (e.g., on the + or the whitespace around it), clang_getCursor()
2846  * will return a cursor referring to the "+" expression.
2847  *
2848  * \returns a cursor representing the entity at the given source location, or
2849  * a NULL cursor if no such entity can be found.
2850  */
2852 
2853 /**
2854  * \brief Retrieve the physical location of the source constructor referenced
2855  * by the given cursor.
2856  *
2857  * The location of a declaration is typically the location of the name of that
2858  * declaration, where the name of that declaration would occur if it is
2859  * unnamed, or some keyword that introduces that particular declaration.
2860  * The location of a reference is where that reference occurs within the
2861  * source code.
2862  */
2864 
2865 /**
2866  * \brief Retrieve the physical extent of the source construct referenced by
2867  * the given cursor.
2868  *
2869  * The extent of a cursor starts with the file/line/column pointing at the
2870  * first character within the source construct that the cursor refers to and
2871  * ends with the last character within that source construct. For a
2872  * declaration, the extent covers the declaration itself. For a reference,
2873  * the extent covers the location of the reference (e.g., where the referenced
2874  * entity was actually used).
2875  */
2877 
2878 /**
2879  * @}
2880  */
2881 
2882 /**
2883  * \defgroup CINDEX_TYPES Type information for CXCursors
2884  *
2885  * @{
2886  */
2887 
2888 /**
2889  * \brief Describes the kind of type
2890  */
2892  /**
2893  * \brief Represents an invalid type (e.g., where no type is available).
2894  */
2896 
2897  /**
2898  * \brief A type whose specific kind is not exposed via this
2899  * interface.
2900  */
2902 
2903  /* Builtin types */
2934 
2954 
2955  /**
2956  * \brief Represents a type that was referred to using an elaborated type keyword.
2957  *
2958  * E.g., struct S, or via a qualified name, e.g., N::M::type, or both.
2959  */
2961 };
2962 
2963 /**
2964  * \brief Describes the calling convention of a function type
2965  */
2975  /* Value 8 was PnaclCall, but it was never used, so it could safely be re-used. */
2983 
2986 };
2987 
2988 /**
2989  * \brief The type of an element in the abstract syntax tree.
2990  *
2991  */
2992 typedef struct {
2994  void *data[2];
2995 } CXType;
2996 
2997 /**
2998  * \brief Retrieve the type of a CXCursor (if any).
2999  */
3001 
3002 /**
3003  * \brief Pretty-print the underlying type using the rules of the
3004  * language of the translation unit from which it came.
3005  *
3006  * If the type is invalid, an empty string is returned.
3007  */
3009 
3010 /**
3011  * \brief Retrieve the underlying type of a typedef declaration.
3012  *
3013  * If the cursor does not reference a typedef declaration, an invalid type is
3014  * returned.
3015  */
3017 
3018 /**
3019  * \brief Retrieve the integer type of an enum declaration.
3020  *
3021  * If the cursor does not reference an enum declaration, an invalid type is
3022  * returned.
3023  */
3025 
3026 /**
3027  * \brief Retrieve the integer value of an enum constant declaration as a signed
3028  * long long.
3029  *
3030  * If the cursor does not reference an enum constant declaration, LLONG_MIN is returned.
3031  * Since this is also potentially a valid constant value, the kind of the cursor
3032  * must be verified before calling this function.
3033  */
3035 
3036 /**
3037  * \brief Retrieve the integer value of an enum constant declaration as an unsigned
3038  * long long.
3039  *
3040  * If the cursor does not reference an enum constant declaration, ULLONG_MAX is returned.
3041  * Since this is also potentially a valid constant value, the kind of the cursor
3042  * must be verified before calling this function.
3043  */
3045 
3046 /**
3047  * \brief Retrieve the bit width of a bit field declaration as an integer.
3048  *
3049  * If a cursor that is not a bit field declaration is passed in, -1 is returned.
3050  */
3052 
3053 /**
3054  * \brief Retrieve the number of non-variadic arguments associated with a given
3055  * cursor.
3056  *
3057  * The number of arguments can be determined for calls as well as for
3058  * declarations of functions or methods. For other cursors -1 is returned.
3059  */
3061 
3062 /**
3063  * \brief Retrieve the argument cursor of a function or method.
3064  *
3065  * The argument cursor can be determined for calls as well as for declarations
3066  * of functions or methods. For other cursors and for invalid indices, an
3067  * invalid cursor is returned.
3068  */
3070 
3071 /**
3072  * \brief Describes the kind of a template argument.
3073  *
3074  * See the definition of llvm::clang::TemplateArgument::ArgKind for full
3075  * element descriptions.
3076  */
3087  /* Indicates an error case, preventing the kind from being deduced. */
3089 };
3090 
3091 /**
3092  *\brief Returns the number of template args of a function decl representing a
3093  * template specialization.
3094  *
3095  * If the argument cursor cannot be converted into a template function
3096  * declaration, -1 is returned.
3097  *
3098  * For example, for the following declaration and specialization:
3099  * template <typename T, int kInt, bool kBool>
3100  * void foo() { ... }
3101  *
3102  * template <>
3103  * void foo<float, -7, true>();
3104  *
3105  * The value 3 would be returned from this call.
3106  */
3108 
3109 /**
3110  * \brief Retrieve the kind of the I'th template argument of the CXCursor C.
3111  *
3112  * If the argument CXCursor does not represent a FunctionDecl, an invalid
3113  * template argument kind is returned.
3114  *
3115  * For example, for the following declaration and specialization:
3116  * template <typename T, int kInt, bool kBool>
3117  * void foo() { ... }
3118  *
3119  * template <>
3120  * void foo<float, -7, true>();
3121  *
3122  * For I = 0, 1, and 2, Type, Integral, and Integral will be returned,
3123  * respectively.
3124  */
3126  CXCursor C, unsigned I);
3127 
3128 /**
3129  * \brief Retrieve a CXType representing the type of a TemplateArgument of a
3130  * function decl representing a template specialization.
3131  *
3132  * If the argument CXCursor does not represent a FunctionDecl whose I'th
3133  * template argument has a kind of CXTemplateArgKind_Integral, an invalid type
3134  * is returned.
3135  *
3136  * For example, for the following declaration and specialization:
3137  * template <typename T, int kInt, bool kBool>
3138  * void foo() { ... }
3139  *
3140  * template <>
3141  * void foo<float, -7, true>();
3142  *
3143  * If called with I = 0, "float", will be returned.
3144  * Invalid types will be returned for I == 1 or 2.
3145  */
3147  unsigned I);
3148 
3149 /**
3150  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3151  * decl representing a template specialization) as a signed long long.
3152  *
3153  * It is undefined to call this function on a CXCursor that does not represent a
3154  * FunctionDecl or whose I'th template argument is not an integral value.
3155  *
3156  * For example, for the following declaration and specialization:
3157  * template <typename T, int kInt, bool kBool>
3158  * void foo() { ... }
3159  *
3160  * template <>
3161  * void foo<float, -7, true>();
3162  *
3163  * If called with I = 1 or 2, -7 or true will be returned, respectively.
3164  * For I == 0, this function's behavior is undefined.
3165  */
3167  unsigned I);
3168 
3169 /**
3170  * \brief Retrieve the value of an Integral TemplateArgument (of a function
3171  * decl representing a template specialization) as an unsigned long long.
3172  *
3173  * It is undefined to call this function on a CXCursor that does not represent a
3174  * FunctionDecl or whose I'th template argument is not an integral value.
3175  *
3176  * For example, for the following declaration and specialization:
3177  * template <typename T, int kInt, bool kBool>
3178  * void foo() { ... }
3179  *
3180  * template <>
3181  * void foo<float, 2147483649, true>();
3182  *
3183  * If called with I = 1 or 2, 2147483649 or true will be returned, respectively.
3184  * For I == 0, this function's behavior is undefined.
3185  */
3187  CXCursor C, unsigned I);
3188 
3189 /**
3190  * \brief Determine whether two CXTypes represent the same type.
3191  *
3192  * \returns non-zero if the CXTypes represent the same type and
3193  * zero otherwise.
3194  */
3196 
3197 /**
3198  * \brief Return the canonical type for a CXType.
3199  *
3200  * Clang's type system explicitly models typedefs and all the ways
3201  * a specific type can be represented. The canonical type is the underlying
3202  * type with all the "sugar" removed. For example, if 'T' is a typedef
3203  * for 'int', the canonical type for 'T' would be 'int'.
3204  */
3206 
3207 /**
3208  * \brief Determine whether a CXType has the "const" qualifier set,
3209  * without looking through typedefs that may have added "const" at a
3210  * different level.
3211  */
3213 
3214 /**
3215  * \brief Determine whether a CXCursor that is a macro, is
3216  * function like.
3217  */
3219 
3220 /**
3221  * \brief Determine whether a CXCursor that is a macro, is a
3222  * builtin one.
3223  */
3225 
3226 /**
3227  * \brief Determine whether a CXCursor that is a function declaration, is an
3228  * inline declaration.
3229  */
3231 
3232 /**
3233  * \brief Determine whether a CXType has the "volatile" qualifier set,
3234  * without looking through typedefs that may have added "volatile" at
3235  * a different level.
3236  */
3238 
3239 /**
3240  * \brief Determine whether a CXType has the "restrict" qualifier set,
3241  * without looking through typedefs that may have added "restrict" at a
3242  * different level.
3243  */
3245 
3246 /**
3247  * \brief For pointer types, returns the type of the pointee.
3248  */
3250 
3251 /**
3252  * \brief Return the cursor for the declaration of the given type.
3253  */
3255 
3256 /**
3257  * Returns the Objective-C type encoding for the specified declaration.
3258  */
3260 
3261 /**
3262  * Returns the Objective-C type encoding for the specified CXType.
3263  */
3265 
3266 /**
3267  * \brief Retrieve the spelling of a given CXTypeKind.
3268  */
3270 
3271 /**
3272  * \brief Retrieve the calling convention associated with a function type.
3273  *
3274  * If a non-function type is passed in, CXCallingConv_Invalid is returned.
3275  */
3277 
3278 /**
3279  * \brief Retrieve the return type associated with a function type.
3280  *
3281  * If a non-function type is passed in, an invalid type is returned.
3282  */
3284 
3285 /**
3286  * \brief Retrieve the number of non-variadic parameters associated with a
3287  * function type.
3288  *
3289  * If a non-function type is passed in, -1 is returned.
3290  */
3292 
3293 /**
3294  * \brief Retrieve the type of a parameter of a function type.
3295  *
3296  * If a non-function type is passed in or the function does not have enough
3297  * parameters, an invalid type is returned.
3298  */
3300 
3301 /**
3302  * \brief Return 1 if the CXType is a variadic function type, and 0 otherwise.
3303  */
3305 
3306 /**
3307  * \brief Retrieve the return type associated with a given cursor.
3308  *
3309  * This only returns a valid type if the cursor refers to a function or method.
3310  */
3312 
3313 /**
3314  * \brief Return 1 if the CXType is a POD (plain old data) type, and 0
3315  * otherwise.
3316  */
3318 
3319 /**
3320  * \brief Return the element type of an array, complex, or vector type.
3321  *
3322  * If a type is passed in that is not an array, complex, or vector type,
3323  * an invalid type is returned.
3324  */
3326 
3327 /**
3328  * \brief Return the number of elements of an array or vector type.
3329  *
3330  * If a type is passed in that is not an array or vector type,
3331  * -1 is returned.
3332  */
3334 
3335 /**
3336  * \brief Return the element type of an array type.
3337  *
3338  * If a non-array type is passed in, an invalid type is returned.
3339  */
3341 
3342 /**
3343  * \brief Return the array size of a constant array.
3344  *
3345  * If a non-array type is passed in, -1 is returned.
3346  */
3348 
3349 /**
3350  * \brief Retrieve the type named by the qualified-id.
3351  *
3352  * If a non-elaborated type is passed in, an invalid type is returned.
3353  */
3355 
3356 /**
3357  * \brief List the possible error codes for \c clang_Type_getSizeOf,
3358  * \c clang_Type_getAlignOf, \c clang_Type_getOffsetOf and
3359  * \c clang_Cursor_getOffsetOf.
3360  *
3361  * A value of this enumeration type can be returned if the target type is not
3362  * a valid argument to sizeof, alignof or offsetof.
3363  */
3365  /**
3366  * \brief Type is of kind CXType_Invalid.
3367  */
3369  /**
3370  * \brief The type is an incomplete Type.
3371  */
3373  /**
3374  * \brief The type is a dependent Type.
3375  */
3377  /**
3378  * \brief The type is not a constant size type.
3379  */
3381  /**
3382  * \brief The Field name is not valid for this record.
3383  */
3385 };
3386 
3387 /**
3388  * \brief Return the alignment of a type in bytes as per C++[expr.alignof]
3389  * standard.
3390  *
3391  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3392  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3393  * is returned.
3394  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3395  * returned.
3396  * If the type declaration is not a constant size type,
3397  * CXTypeLayoutError_NotConstantSize is returned.
3398  */
3400 
3401 /**
3402  * \brief Return the class type of an member pointer type.
3403  *
3404  * If a non-member-pointer type is passed in, an invalid type is returned.
3405  */
3407 
3408 /**
3409  * \brief Return the size of a type in bytes as per C++[expr.sizeof] standard.
3410  *
3411  * If the type declaration is invalid, CXTypeLayoutError_Invalid is returned.
3412  * If the type declaration is an incomplete type, CXTypeLayoutError_Incomplete
3413  * is returned.
3414  * If the type declaration is a dependent type, CXTypeLayoutError_Dependent is
3415  * returned.
3416  */
3418 
3419 /**
3420  * \brief Return the offset of a field named S in a record of type T in bits
3421  * as it would be returned by __offsetof__ as per C++11[18.2p4]
3422  *
3423  * If the cursor is not a record field declaration, CXTypeLayoutError_Invalid
3424  * is returned.
3425  * If the field's type declaration is an incomplete type,
3426  * CXTypeLayoutError_Incomplete is returned.
3427  * If the field's type declaration is a dependent type,
3428  * CXTypeLayoutError_Dependent is returned.
3429  * If the field's name S is not found,
3430  * CXTypeLayoutError_InvalidFieldName is returned.
3431  */
3432 CINDEX_LINKAGE long long clang_Type_getOffsetOf(CXType T, const char *S);
3433 
3434 /**
3435  * \brief Return the offset of the field represented by the Cursor.
3436  *
3437  * If the cursor is not a field declaration, -1 is returned.
3438  * If the cursor semantic parent is not a record field declaration,
3439  * CXTypeLayoutError_Invalid is returned.
3440  * If the field's type declaration is an incomplete type,
3441  * CXTypeLayoutError_Incomplete is returned.
3442  * If the field's type declaration is a dependent type,
3443  * CXTypeLayoutError_Dependent is returned.
3444  * If the field's name S is not found,
3445  * CXTypeLayoutError_InvalidFieldName is returned.
3446  */
3448 
3449 /**
3450  * \brief Determine whether the given cursor represents an anonymous record
3451  * declaration.
3452  */
3454 
3456  /** \brief No ref-qualifier was provided. */
3458  /** \brief An lvalue ref-qualifier was provided (\c &). */
3460  /** \brief An rvalue ref-qualifier was provided (\c &&). */
3462 };
3463 
3464 /**
3465  * \brief Returns the number of template arguments for given class template
3466  * specialization, or -1 if type \c T is not a class template specialization.
3467  *
3468  * Variadic argument packs count as only one argument, and can not be inspected
3469  * further.
3470  */
3472 
3473 /**
3474  * \brief Returns the type template argument of a template class specialization
3475  * at given index.
3476  *
3477  * This function only returns template type arguments and does not handle
3478  * template template arguments or variadic packs.
3479  */
3481 
3482 /**
3483  * \brief Retrieve the ref-qualifier kind of a function or method.
3484  *
3485  * The ref-qualifier is returned for C++ functions or methods. For other types
3486  * or non-C++ declarations, CXRefQualifier_None is returned.
3487  */
3489 
3490 /**
3491  * \brief Returns non-zero if the cursor specifies a Record member that is a
3492  * bitfield.
3493  */
3495 
3496 /**
3497  * \brief Returns 1 if the base class specified by the cursor with kind
3498  * CX_CXXBaseSpecifier is virtual.
3499  */
3501 
3502 /**
3503  * \brief Represents the C++ access control level to a base class for a
3504  * cursor with kind CX_CXXBaseSpecifier.
3505  */
3511 };
3512 
3513 /**
3514  * \brief Returns the access control level for the referenced object.
3515  *
3516  * If the cursor refers to a C++ declaration, its access control level within its
3517  * parent scope is returned. Otherwise, if the cursor refers to a base specifier or
3518  * access specifier, the specifier itself is returned.
3519  */
3521 
3522 /**
3523  * \brief Represents the storage classes as declared in the source. CX_SC_Invalid
3524  * was added for the case that the passed cursor in not a declaration.
3525  */
3535 };
3536 
3537 /**
3538  * \brief Returns the storage class for a function or variable declaration.
3539  *
3540  * If the passed in Cursor is not a function or variable declaration,
3541  * CX_SC_Invalid is returned else the storage class.
3542  */
3544 
3545 /**
3546  * \brief Determine the number of overloaded declarations referenced by a
3547  * \c CXCursor_OverloadedDeclRef cursor.
3548  *
3549  * \param cursor The cursor whose overloaded declarations are being queried.
3550  *
3551  * \returns The number of overloaded declarations referenced by \c cursor. If it
3552  * is not a \c CXCursor_OverloadedDeclRef cursor, returns 0.
3553  */
3555 
3556 /**
3557  * \brief Retrieve a cursor for one of the overloaded declarations referenced
3558  * by a \c CXCursor_OverloadedDeclRef cursor.
3559  *
3560  * \param cursor The cursor whose overloaded declarations are being queried.
3561  *
3562  * \param index The zero-based index into the set of overloaded declarations in
3563  * the cursor.
3564  *
3565  * \returns A cursor representing the declaration referenced by the given
3566  * \c cursor at the specified \c index. If the cursor does not have an
3567  * associated set of overloaded declarations, or if the index is out of bounds,
3568  * returns \c clang_getNullCursor();
3569  */
3571  unsigned index);
3572 
3573 /**
3574  * @}
3575  */
3576 
3577 /**
3578  * \defgroup CINDEX_ATTRIBUTES Information for attributes
3579  *
3580  * @{
3581  */
3582 
3583 /**
3584  * \brief For cursors representing an iboutletcollection attribute,
3585  * this function returns the collection element type.
3586  *
3587  */
3589 
3590 /**
3591  * @}
3592  */
3593 
3594 /**
3595  * \defgroup CINDEX_CURSOR_TRAVERSAL Traversing the AST with cursors
3596  *
3597  * These routines provide the ability to traverse the abstract syntax tree
3598  * using cursors.
3599  *
3600  * @{
3601  */
3602 
3603 /**
3604  * \brief Describes how the traversal of the children of a particular
3605  * cursor should proceed after visiting a particular child cursor.
3606  *
3607  * A value of this enumeration type should be returned by each
3608  * \c CXCursorVisitor to indicate how clang_visitChildren() proceed.
3609  */
3611  /**
3612  * \brief Terminates the cursor traversal.
3613  */
3615  /**
3616  * \brief Continues the cursor traversal with the next sibling of
3617  * the cursor just visited, without visiting its children.
3618  */
3620  /**
3621  * \brief Recursively traverse the children of this cursor, using
3622  * the same visitor and client data.
3623  */
3625 };
3626 
3627 /**
3628  * \brief Visitor invoked for each cursor found by a traversal.
3629  *
3630  * This visitor function will be invoked for each cursor found by
3631  * clang_visitCursorChildren(). Its first argument is the cursor being
3632  * visited, its second argument is the parent visitor for that cursor,
3633  * and its third argument is the client data provided to
3634  * clang_visitCursorChildren().
3635  *
3636  * The visitor should return one of the \c CXChildVisitResult values
3637  * to direct clang_visitCursorChildren().
3638  */
3640  CXCursor parent,
3641  CXClientData client_data);
3642 
3643 /**
3644  * \brief Visit the children of a particular cursor.
3645  *
3646  * This function visits all the direct children of the given cursor,
3647  * invoking the given \p visitor function with the cursors of each
3648  * visited child. The traversal may be recursive, if the visitor returns
3649  * \c CXChildVisit_Recurse. The traversal may also be ended prematurely, if
3650  * the visitor returns \c CXChildVisit_Break.
3651  *
3652  * \param parent the cursor whose child may be visited. All kinds of
3653  * cursors can be visited, including invalid cursors (which, by
3654  * definition, have no children).
3655  *
3656  * \param visitor the visitor function that will be invoked for each
3657  * child of \p parent.
3658  *
3659  * \param client_data pointer data supplied by the client, which will
3660  * be passed to the visitor each time it is invoked.
3661  *
3662  * \returns a non-zero value if the traversal was terminated
3663  * prematurely by the visitor returning \c CXChildVisit_Break.
3664  */
3666  CXCursorVisitor visitor,
3667  CXClientData client_data);
3668 #ifdef __has_feature
3669 # if __has_feature(blocks)
3670 /**
3671  * \brief Visitor invoked for each cursor found by a traversal.
3672  *
3673  * This visitor block will be invoked for each cursor found by
3674  * clang_visitChildrenWithBlock(). Its first argument is the cursor being
3675  * visited, its second argument is the parent visitor for that cursor.
3676  *
3677  * The visitor should return one of the \c CXChildVisitResult values
3678  * to direct clang_visitChildrenWithBlock().
3679  */
3680 typedef enum CXChildVisitResult
3681  (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3682 
3683 /**
3684  * Visits the children of a cursor using the specified block. Behaves
3685  * identically to clang_visitChildren() in all other respects.
3686  */
3687 CINDEX_LINKAGE unsigned clang_visitChildrenWithBlock(CXCursor parent,
3688  CXCursorVisitorBlock block);
3689 # endif
3690 #endif
3691 
3692 /**
3693  * @}
3694  */
3695 
3696 /**
3697  * \defgroup CINDEX_CURSOR_XREF Cross-referencing in the AST
3698  *
3699  * These routines provide the ability to determine references within and
3700  * across translation units, by providing the names of the entities referenced
3701  * by cursors, follow reference cursors to the declarations they reference,
3702  * and associate declarations with their definitions.
3703  *
3704  * @{
3705  */
3706 
3707 /**
3708  * \brief Retrieve a Unified Symbol Resolution (USR) for the entity referenced
3709  * by the given cursor.
3710  *
3711  * A Unified Symbol Resolution (USR) is a string that identifies a particular
3712  * entity (function, class, variable, etc.) within a program. USRs can be
3713  * compared across translation units to determine, e.g., when references in
3714  * one translation refer to an entity defined in another translation unit.
3715  */
3717 
3718 /**
3719  * \brief Construct a USR for a specified Objective-C class.
3720  */
3721 CINDEX_LINKAGE CXString clang_constructUSR_ObjCClass(const char *class_name);
3722 
3723 /**
3724  * \brief Construct a USR for a specified Objective-C category.
3725  */
3727  clang_constructUSR_ObjCCategory(const char *class_name,
3728  const char *category_name);
3729 
3730 /**
3731  * \brief Construct a USR for a specified Objective-C protocol.
3732  */
3734  clang_constructUSR_ObjCProtocol(const char *protocol_name);
3735 
3736 /**
3737  * \brief Construct a USR for a specified Objective-C instance variable and
3738  * the USR for its containing class.
3739  */
3741  CXString classUSR);
3742 
3743 /**
3744  * \brief Construct a USR for a specified Objective-C method and
3745  * the USR for its containing class.
3746  */
3748  unsigned isInstanceMethod,
3749  CXString classUSR);
3750 
3751 /**
3752  * \brief Construct a USR for a specified Objective-C property and the USR
3753  * for its containing class.
3754  */
3756  CXString classUSR);
3757 
3758 /**
3759  * \brief Retrieve a name for the entity referenced by this cursor.
3760  */
3762 
3763 /**
3764  * \brief Retrieve a range for a piece that forms the cursors spelling name.
3765  * Most of the times there is only one range for the complete spelling but for
3766  * Objective-C methods and Objective-C message expressions, there are multiple
3767  * pieces for each selector identifier.
3768  *
3769  * \param pieceIndex the index of the spelling name piece. If this is greater
3770  * than the actual number of pieces, it will return a NULL (invalid) range.
3771  *
3772  * \param options Reserved.
3773  */
3775  unsigned pieceIndex,
3776  unsigned options);
3777 
3778 /**
3779  * \brief Retrieve the display name for the entity referenced by this cursor.
3780  *
3781  * The display name contains extra information that helps identify the cursor,
3782  * such as the parameters of a function or template or the arguments of a
3783  * class template specialization.
3784  */
3786 
3787 /** \brief For a cursor that is a reference, retrieve a cursor representing the
3788  * entity that it references.
3789  *
3790  * Reference cursors refer to other entities in the AST. For example, an
3791  * Objective-C superclass reference cursor refers to an Objective-C class.
3792  * This function produces the cursor for the Objective-C class from the
3793  * cursor for the superclass reference. If the input cursor is a declaration or
3794  * definition, it returns that declaration or definition unchanged.
3795  * Otherwise, returns the NULL cursor.
3796  */
3798 
3799 /**
3800  * \brief For a cursor that is either a reference to or a declaration
3801  * of some entity, retrieve a cursor that describes the definition of
3802  * that entity.
3803  *
3804  * Some entities can be declared multiple times within a translation
3805  * unit, but only one of those declarations can also be a
3806  * definition. For example, given:
3807  *
3808  * \code
3809  * int f(int, int);
3810  * int g(int x, int y) { return f(x, y); }
3811  * int f(int a, int b) { return a + b; }
3812  * int f(int, int);
3813  * \endcode
3814  *
3815  * there are three declarations of the function "f", but only the
3816  * second one is a definition. The clang_getCursorDefinition()
3817  * function will take any cursor pointing to a declaration of "f"
3818  * (the first or fourth lines of the example) or a cursor referenced
3819  * that uses "f" (the call to "f' inside "g") and will return a
3820  * declaration cursor pointing to the definition (the second "f"
3821  * declaration).
3822  *
3823  * If given a cursor for which there is no corresponding definition,
3824  * e.g., because there is no definition of that entity within this
3825  * translation unit, returns a NULL cursor.
3826  */
3828 
3829 /**
3830  * \brief Determine whether the declaration pointed to by this cursor
3831  * is also a definition of that entity.
3832  */
3834 
3835 /**
3836  * \brief Retrieve the canonical cursor corresponding to the given cursor.
3837  *
3838  * In the C family of languages, many kinds of entities can be declared several
3839  * times within a single translation unit. For example, a structure type can
3840  * be forward-declared (possibly multiple times) and later defined:
3841  *
3842  * \code
3843  * struct X;
3844  * struct X;
3845  * struct X {
3846  * int member;
3847  * };
3848  * \endcode
3849  *
3850  * The declarations and the definition of \c X are represented by three
3851  * different cursors, all of which are declarations of the same underlying
3852  * entity. One of these cursor is considered the "canonical" cursor, which
3853  * is effectively the representative for the underlying entity. One can
3854  * determine if two cursors are declarations of the same underlying entity by
3855  * comparing their canonical cursors.
3856  *
3857  * \returns The canonical cursor for the entity referred to by the given cursor.
3858  */
3860 
3861 /**
3862  * \brief If the cursor points to a selector identifier in an Objective-C
3863  * method or message expression, this returns the selector index.
3864  *
3865  * After getting a cursor with #clang_getCursor, this can be called to
3866  * determine if the location points to a selector identifier.
3867  *
3868  * \returns The selector index if the cursor is an Objective-C method or message
3869  * expression and the cursor is pointing to a selector identifier, or -1
3870  * otherwise.
3871  */
3873 
3874 /**
3875  * \brief Given a cursor pointing to a C++ method call or an Objective-C
3876  * message, returns non-zero if the method/message is "dynamic", meaning:
3877  *
3878  * For a C++ method: the call is virtual.
3879  * For an Objective-C message: the receiver is an object instance, not 'super'
3880  * or a specific class.
3881  *
3882  * If the method/message is "static" or the cursor does not point to a
3883  * method/message, it will return zero.
3884  */
3886 
3887 /**
3888  * \brief Given a cursor pointing to an Objective-C message, returns the CXType
3889  * of the receiver.
3890  */
3892 
3893 /**
3894  * \brief Property attributes for a \c CXCursor_ObjCPropertyDecl.
3895  */
3896 typedef enum {
3911 
3912 /**
3913  * \brief Given a cursor that represents a property declaration, return the
3914  * associated property attributes. The bits are formed from
3915  * \c CXObjCPropertyAttrKind.
3916  *
3917  * \param reserved Reserved for future use, pass 0.
3918  */
3920  unsigned reserved);
3921 
3922 /**
3923  * \brief 'Qualifiers' written next to the return and parameter types in
3924  * Objective-C method declarations.
3925  */
3926 typedef enum {
3935 
3936 /**
3937  * \brief Given a cursor that represents an Objective-C method or parameter
3938  * declaration, return the associated Objective-C qualifiers for the return
3939  * type or the parameter respectively. The bits are formed from
3940  * CXObjCDeclQualifierKind.
3941  */
3943 
3944 /**
3945  * \brief Given a cursor that represents an Objective-C method or property
3946  * declaration, return non-zero if the declaration was affected by "@optional".
3947  * Returns zero if the cursor is not such a declaration or it is "@required".
3948  */
3950 
3951 /**
3952  * \brief Returns non-zero if the given cursor is a variadic function or method.
3953  */
3955 
3956 /**
3957  * \brief Given a cursor that represents a declaration, return the associated
3958  * comment's source range. The range may include multiple consecutive comments
3959  * with whitespace in between.
3960  */
3962 
3963 /**
3964  * \brief Given a cursor that represents a declaration, return the associated
3965  * comment text, including comment markers.
3966  */
3968 
3969 /**
3970  * \brief Given a cursor that represents a documentable entity (e.g.,
3971  * declaration), return the associated \\brief paragraph; otherwise return the
3972  * first paragraph.
3973  */
3975 
3976 /**
3977  * @}
3978  */
3979 
3980 /** \defgroup CINDEX_MANGLE Name Mangling API Functions
3981  *
3982  * @{
3983  */
3984 
3985 /**
3986  * \brief Retrieve the CXString representing the mangled name of the cursor.
3987  */
3989 
3990 /**
3991  * \brief Retrieve the CXStrings representing the mangled symbols of the C++
3992  * constructor or destructor at the cursor.
3993  */
3995 
3996 /**
3997  * @}
3998  */
3999 
4000 /**
4001  * \defgroup CINDEX_MODULE Module introspection
4002  *
4003  * The functions in this group provide access to information about modules.
4004  *
4005  * @{
4006  */
4007 
4008 typedef void *CXModule;
4009 
4010 /**
4011  * \brief Given a CXCursor_ModuleImportDecl cursor, return the associated module.
4012  */
4014 
4015 /**
4016  * \brief Given a CXFile header file, return the module that contains it, if one
4017  * exists.
4018  */
4019 CINDEX_LINKAGE CXModule clang_getModuleForFile(CXTranslationUnit, CXFile);
4020 
4021 /**
4022  * \param Module a module object.
4023  *
4024  * \returns the module file where the provided module object came from.
4025  */
4026 CINDEX_LINKAGE CXFile clang_Module_getASTFile(CXModule Module);
4027 
4028 /**
4029  * \param Module a module object.
4030  *
4031  * \returns the parent of a sub-module or NULL if the given module is top-level,
4032  * e.g. for 'std.vector' it will return the 'std' module.
4033  */
4034 CINDEX_LINKAGE CXModule clang_Module_getParent(CXModule Module);
4035 
4036 /**
4037  * \param Module a module object.
4038  *
4039  * \returns the name of the module, e.g. for the 'std.vector' sub-module it
4040  * will return "vector".
4041  */
4043 
4044 /**
4045  * \param Module a module object.
4046  *
4047  * \returns the full name of the module, e.g. "std.vector".
4048  */
4050 
4051 /**
4052  * \param Module a module object.
4053  *
4054  * \returns non-zero if the module is a system one.
4055  */
4056 CINDEX_LINKAGE int clang_Module_isSystem(CXModule Module);
4057 
4058 /**
4059  * \param Module a module object.
4060  *
4061  * \returns the number of top level headers associated with this module.
4062  */
4063 CINDEX_LINKAGE unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit,
4064  CXModule Module);
4065 
4066 /**
4067  * \param Module a module object.
4068  *
4069  * \param Index top level header index (zero-based).
4070  *
4071  * \returns the specified top level header associated with the module.
4072  */
4074 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit,
4075  CXModule Module, unsigned Index);
4076 
4077 /**
4078  * @}
4079  */
4080 
4081 /**
4082  * \defgroup CINDEX_CPP C++ AST introspection
4083  *
4084  * The routines in this group provide access information in the ASTs specific
4085  * to C++ language features.
4086  *
4087  * @{
4088  */
4089 
4090 /**
4091  * \brief Determine if a C++ constructor is a converting constructor.
4092  */
4094 
4095 /**
4096  * \brief Determine if a C++ constructor is a copy constructor.
4097  */
4099 
4100 /**
4101  * \brief Determine if a C++ constructor is the default constructor.
4102  */
4104 
4105 /**
4106  * \brief Determine if a C++ constructor is a move constructor.
4107  */
4109 
4110 /**
4111  * \brief Determine if a C++ field is declared 'mutable'.
4112  */
4114 
4115 /**
4116  * \brief Determine if a C++ method is declared '= default'.
4117  */
4119 
4120 /**
4121  * \brief Determine if a C++ member function or member function template is
4122  * pure virtual.
4123  */
4125 
4126 /**
4127  * \brief Determine if a C++ member function or member function template is
4128  * declared 'static'.
4129  */
4131 
4132 /**
4133  * \brief Determine if a C++ member function or member function template is
4134  * explicitly declared 'virtual' or if it overrides a virtual method from
4135  * one of the base classes.
4136  */
4138 
4139 /**
4140  * \brief Determine if a C++ member function or member function template is
4141  * declared 'const'.
4142  */
4144 
4145 /**
4146  * \brief Given a cursor that represents a template, determine
4147  * the cursor kind of the specializations would be generated by instantiating
4148  * the template.
4149  *
4150  * This routine can be used to determine what flavor of function template,
4151  * class template, or class template partial specialization is stored in the
4152  * cursor. For example, it can describe whether a class template cursor is
4153  * declared with "struct", "class" or "union".
4154  *
4155  * \param C The cursor to query. This cursor should represent a template
4156  * declaration.
4157  *
4158  * \returns The cursor kind of the specializations that would be generated
4159  * by instantiating the template \p C. If \p C is not a template, returns
4160  * \c CXCursor_NoDeclFound.
4161  */
4163 
4164 /**
4165  * \brief Given a cursor that may represent a specialization or instantiation
4166  * of a template, retrieve the cursor that represents the template that it
4167  * specializes or from which it was instantiated.
4168  *
4169  * This routine determines the template involved both for explicit
4170  * specializations of templates and for implicit instantiations of the template,
4171  * both of which are referred to as "specializations". For a class template
4172  * specialization (e.g., \c std::vector<bool>), this routine will return
4173  * either the primary template (\c std::vector) or, if the specialization was
4174  * instantiated from a class template partial specialization, the class template
4175  * partial specialization. For a class template partial specialization and a
4176  * function template specialization (including instantiations), this
4177  * this routine will return the specialized template.
4178  *
4179  * For members of a class template (e.g., member functions, member classes, or
4180  * static data members), returns the specialized or instantiated member.
4181  * Although not strictly "templates" in the C++ language, members of class
4182  * templates have the same notions of specializations and instantiations that
4183  * templates do, so this routine treats them similarly.
4184  *
4185  * \param C A cursor that may be a specialization of a template or a member
4186  * of a template.
4187  *
4188  * \returns If the given cursor is a specialization or instantiation of a
4189  * template or a member thereof, the template or member that it specializes or
4190  * from which it was instantiated. Otherwise, returns a NULL cursor.
4191  */
4193 
4194 /**
4195  * \brief Given a cursor that references something else, return the source range
4196  * covering that reference.
4197  *
4198  * \param C A cursor pointing to a member reference, a declaration reference, or
4199  * an operator call.
4200  * \param NameFlags A bitset with three independent flags:
4201  * CXNameRange_WantQualifier, CXNameRange_WantTemplateArgs, and
4202  * CXNameRange_WantSinglePiece.
4203  * \param PieceIndex For contiguous names or when passing the flag
4204  * CXNameRange_WantSinglePiece, only one piece with index 0 is
4205  * available. When the CXNameRange_WantSinglePiece flag is not passed for a
4206  * non-contiguous names, this index can be used to retrieve the individual
4207  * pieces of the name. See also CXNameRange_WantSinglePiece.
4208  *
4209  * \returns The piece of the name pointed to by the given cursor. If there is no
4210  * name, or if the PieceIndex is out-of-range, a null-cursor will be returned.
4211  */
4213  unsigned NameFlags,
4214  unsigned PieceIndex);
4215 
4217  /**
4218  * \brief Include the nested-name-specifier, e.g. Foo:: in x.Foo::y, in the
4219  * range.
4220  */
4222 
4223  /**
4224  * \brief Include the explicit template arguments, e.g. <int> in x.f<int>,
4225  * in the range.
4226  */
4228 
4229  /**
4230  * \brief If the name is non-contiguous, return the full spanning range.
4231  *
4232  * Non-contiguous names occur in Objective-C when a selector with two or more
4233  * parameters is used, or in C++ when using an operator:
4234  * \code
4235  * [object doSomething:here withValue:there]; // Objective-C
4236  * return some_vector[1]; // C++
4237  * \endcode
4238  */
4240 };
4241 
4242 /**
4243  * @}
4244  */
4245 
4246 /**
4247  * \defgroup CINDEX_LEX Token extraction and manipulation
4248  *
4249  * The routines in this group provide access to the tokens within a
4250  * translation unit, along with a semantic mapping of those tokens to
4251  * their corresponding cursors.
4252  *
4253  * @{
4254  */
4255 
4256 /**
4257  * \brief Describes a kind of token.
4258  */
4259 typedef enum CXTokenKind {
4260  /**
4261  * \brief A token that contains some kind of punctuation.
4262  */
4264 
4265  /**
4266  * \brief A language keyword.
4267  */
4269 
4270  /**
4271  * \brief An identifier (that is not a keyword).
4272  */
4274 
4275  /**
4276  * \brief A numeric, string, or character literal.
4277  */
4279 
4280  /**
4281  * \brief A comment.
4282  */
4284 } CXTokenKind;
4285 
4286 /**
4287  * \brief Describes a single preprocessing token.
4288  */
4289 typedef struct {
4290  unsigned int_data[4];
4291  void *ptr_data;
4292 } CXToken;
4293 
4294 /**
4295  * \brief Determine the kind of the given token.
4296  */
4298 
4299 /**
4300  * \brief Determine the spelling of the given token.
4301  *
4302  * The spelling of a token is the textual representation of that token, e.g.,
4303  * the text of an identifier or keyword.
4304  */
4306 
4307 /**
4308  * \brief Retrieve the source location of the given token.
4309  */
4311  CXToken);
4312 
4313 /**
4314  * \brief Retrieve a source range that covers the given token.
4315  */
4317 
4318 /**
4319  * \brief Tokenize the source code described by the given range into raw
4320  * lexical tokens.
4321  *
4322  * \param TU the translation unit whose text is being tokenized.
4323  *
4324  * \param Range the source range in which text should be tokenized. All of the
4325  * tokens produced by tokenization will fall within this source range,
4326  *
4327  * \param Tokens this pointer will be set to point to the array of tokens
4328  * that occur within the given source range. The returned pointer must be
4329  * freed with clang_disposeTokens() before the translation unit is destroyed.
4330  *
4331  * \param NumTokens will be set to the number of tokens in the \c *Tokens
4332  * array.
4333  *
4334  */
4335 CINDEX_LINKAGE void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4336  CXToken **Tokens, unsigned *NumTokens);
4337 
4338 /**
4339  * \brief Annotate the given set of tokens by providing cursors for each token
4340  * that can be mapped to a specific entity within the abstract syntax tree.
4341  *
4342  * This token-annotation routine is equivalent to invoking
4343  * clang_getCursor() for the source locations of each of the
4344  * tokens. The cursors provided are filtered, so that only those
4345  * cursors that have a direct correspondence to the token are
4346  * accepted. For example, given a function call \c f(x),
4347  * clang_getCursor() would provide the following cursors:
4348  *
4349  * * when the cursor is over the 'f', a DeclRefExpr cursor referring to 'f'.
4350  * * when the cursor is over the '(' or the ')', a CallExpr referring to 'f'.
4351  * * when the cursor is over the 'x', a DeclRefExpr cursor referring to 'x'.
4352  *
4353  * Only the first and last of these cursors will occur within the
4354  * annotate, since the tokens "f" and "x' directly refer to a function
4355  * and a variable, respectively, but the parentheses are just a small
4356  * part of the full syntax of the function call expression, which is
4357  * not provided as an annotation.
4358  *
4359  * \param TU the translation unit that owns the given tokens.
4360  *
4361  * \param Tokens the set of tokens to annotate.
4362  *
4363  * \param NumTokens the number of tokens in \p Tokens.
4364  *
4365  * \param Cursors an array of \p NumTokens cursors, whose contents will be
4366  * replaced with the cursors corresponding to each token.
4367  */
4368 CINDEX_LINKAGE void clang_annotateTokens(CXTranslationUnit TU,
4369  CXToken *Tokens, unsigned NumTokens,
4370  CXCursor *Cursors);
4371 
4372 /**
4373  * \brief Free the given set of tokens.
4374  */
4375 CINDEX_LINKAGE void clang_disposeTokens(CXTranslationUnit TU,
4376  CXToken *Tokens, unsigned NumTokens);
4377 
4378 /**
4379  * @}
4380  */
4381 
4382 /**
4383  * \defgroup CINDEX_DEBUG Debugging facilities
4384  *
4385  * These routines are used for testing and debugging, only, and should not
4386  * be relied upon.
4387  *
4388  * @{
4389  */
4390 
4391 /* for debug/testing */
4394  const char **startBuf,
4395  const char **endBuf,
4396  unsigned *startLine,
4397  unsigned *startColumn,
4398  unsigned *endLine,
4399  unsigned *endColumn);
4401 CINDEX_LINKAGE void clang_executeOnThread(void (*fn)(void*), void *user_data,
4402  unsigned stack_size);
4403 
4404 /**
4405  * @}
4406  */
4407 
4408 /**
4409  * \defgroup CINDEX_CODE_COMPLET Code completion
4410  *
4411  * Code completion involves taking an (incomplete) source file, along with
4412  * knowledge of where the user is actively editing that file, and suggesting
4413  * syntactically- and semantically-valid constructs that the user might want to
4414  * use at that particular point in the source code. These data structures and
4415  * routines provide support for code completion.
4416  *
4417  * @{
4418  */
4419 
4420 /**
4421  * \brief A semantic string that describes a code-completion result.
4422  *
4423  * A semantic string that describes the formatting of a code-completion
4424  * result as a single "template" of text that should be inserted into the
4425  * source buffer when a particular code-completion result is selected.
4426  * Each semantic string is made up of some number of "chunks", each of which
4427  * contains some text along with a description of what that text means, e.g.,
4428  * the name of the entity being referenced, whether the text chunk is part of
4429  * the template, or whether it is a "placeholder" that the user should replace
4430  * with actual code,of a specific kind. See \c CXCompletionChunkKind for a
4431  * description of the different kinds of chunks.
4432  */
4433 typedef void *CXCompletionString;
4434 
4435 /**
4436  * \brief A single result of code completion.
4437  */
4438 typedef struct {
4439  /**
4440  * \brief The kind of entity that this completion refers to.
4441  *
4442  * The cursor kind will be a macro, keyword, or a declaration (one of the
4443  * *Decl cursor kinds), describing the entity that the completion is
4444  * referring to.
4445  *
4446  * \todo In the future, we would like to provide a full cursor, to allow
4447  * the client to extract additional information from declaration.
4448  */
4449  enum CXCursorKind CursorKind;
4450 
4451  /**
4452  * \brief The code-completion string that describes how to insert this
4453  * code-completion result into the editing buffer.
4454  */
4455  CXCompletionString CompletionString;
4457 
4458 /**
4459  * \brief Describes a single piece of text within a code-completion string.
4460  *
4461  * Each "chunk" within a code-completion string (\c CXCompletionString) is
4462  * either a piece of text with a specific "kind" that describes how that text
4463  * should be interpreted by the client or is another completion string.
4464  */
4466  /**
4467  * \brief A code-completion string that describes "optional" text that
4468  * could be a part of the template (but is not required).
4469  *
4470  * The Optional chunk is the only kind of chunk that has a code-completion
4471  * string for its representation, which is accessible via
4472  * \c clang_getCompletionChunkCompletionString(). The code-completion string
4473  * describes an additional part of the template that is completely optional.
4474  * For example, optional chunks can be used to describe the placeholders for
4475  * arguments that match up with defaulted function parameters, e.g. given:
4476  *
4477  * \code
4478  * void f(int x, float y = 3.14, double z = 2.71828);
4479  * \endcode
4480  *
4481  * The code-completion string for this function would contain:
4482  * - a TypedText chunk for "f".
4483  * - a LeftParen chunk for "(".
4484  * - a Placeholder chunk for "int x"
4485  * - an Optional chunk containing the remaining defaulted arguments, e.g.,
4486  * - a Comma chunk for ","
4487  * - a Placeholder chunk for "float y"
4488  * - an Optional chunk containing the last defaulted argument:
4489  * - a Comma chunk for ","
4490  * - a Placeholder chunk for "double z"
4491  * - a RightParen chunk for ")"
4492  *
4493  * There are many ways to handle Optional chunks. Two simple approaches are:
4494  * - Completely ignore optional chunks, in which case the template for the
4495  * function "f" would only include the first parameter ("int x").
4496  * - Fully expand all optional chunks, in which case the template for the
4497  * function "f" would have all of the parameters.
4498  */
4500  /**
4501  * \brief Text that a user would be expected to type to get this
4502  * code-completion result.
4503  *
4504  * There will be exactly one "typed text" chunk in a semantic string, which
4505  * will typically provide the spelling of a keyword or the name of a
4506  * declaration that could be used at the current code point. Clients are
4507  * expected to filter the code-completion results based on the text in this
4508  * chunk.
4509  */
4511  /**
4512  * \brief Text that should be inserted as part of a code-completion result.
4513  *
4514  * A "text" chunk represents text that is part of the template to be
4515  * inserted into user code should this particular code-completion result
4516  * be selected.
4517  */
4519  /**
4520  * \brief Placeholder text that should be replaced by the user.
4521  *
4522  * A "placeholder" chunk marks a place where the user should insert text
4523  * into the code-completion template. For example, placeholders might mark
4524  * the function parameters for a function declaration, to indicate that the
4525  * user should provide arguments for each of those parameters. The actual
4526  * text in a placeholder is a suggestion for the text to display before
4527  * the user replaces the placeholder with real code.
4528  */
4530  /**
4531  * \brief Informative text that should be displayed but never inserted as
4532  * part of the template.
4533  *
4534  * An "informative" chunk contains annotations that can be displayed to
4535  * help the user decide whether a particular code-completion result is the
4536  * right option, but which is not part of the actual template to be inserted
4537  * by code completion.
4538  */
4540  /**
4541  * \brief Text that describes the current parameter when code-completion is
4542  * referring to function call, message send, or template specialization.
4543  *
4544  * A "current parameter" chunk occurs when code-completion is providing
4545  * information about a parameter corresponding to the argument at the
4546  * code-completion point. For example, given a function
4547  *
4548  * \code
4549  * int add(int x, int y);
4550  * \endcode
4551  *
4552  * and the source code \c add(, where the code-completion point is after the
4553  * "(", the code-completion string will contain a "current parameter" chunk
4554  * for "int x", indicating that the current argument will initialize that
4555  * parameter. After typing further, to \c add(17, (where the code-completion
4556  * point is after the ","), the code-completion string will contain a
4557  * "current paremeter" chunk to "int y".
4558  */
4560  /**
4561  * \brief A left parenthesis ('('), used to initiate a function call or
4562  * signal the beginning of a function parameter list.
4563  */
4565  /**
4566  * \brief A right parenthesis (')'), used to finish a function call or
4567  * signal the end of a function parameter list.
4568  */
4570  /**
4571  * \brief A left bracket ('[').
4572  */
4574  /**
4575  * \brief A right bracket (']').
4576  */
4578  /**
4579  * \brief A left brace ('{').
4580  */
4582  /**
4583  * \brief A right brace ('}').
4584  */
4586  /**
4587  * \brief A left angle bracket ('<').
4588  */
4590  /**
4591  * \brief A right angle bracket ('>').
4592  */
4594  /**
4595  * \brief A comma separator (',').
4596  */
4598  /**
4599  * \brief Text that specifies the result type of a given result.
4600  *
4601  * This special kind of informative chunk is not meant to be inserted into
4602  * the text buffer. Rather, it is meant to illustrate the type that an
4603  * expression using the given completion string would have.
4604  */
4606  /**
4607  * \brief A colon (':').
4608  */
4610  /**
4611  * \brief A semicolon (';').
4612  */
4614  /**
4615  * \brief An '=' sign.
4616  */
4618  /**
4619  * Horizontal space (' ').
4620  */
4622  /**
4623  * Vertical space ('\n'), after which it is generally a good idea to
4624  * perform indentation.
4625  */
4627 };
4628 
4629 /**
4630  * \brief Determine the kind of a particular chunk within a completion string.
4631  *
4632  * \param completion_string the completion string to query.
4633  *
4634  * \param chunk_number the 0-based index of the chunk in the completion string.
4635  *
4636  * \returns the kind of the chunk at the index \c chunk_number.
4637  */
4639 clang_getCompletionChunkKind(CXCompletionString completion_string,
4640  unsigned chunk_number);
4641 
4642 /**
4643  * \brief Retrieve the text associated with a particular chunk within a
4644  * completion string.
4645  *
4646  * \param completion_string the completion string to query.
4647  *
4648  * \param chunk_number the 0-based index of the chunk in the completion string.
4649  *
4650  * \returns the text associated with the chunk at index \c chunk_number.
4651  */
4653 clang_getCompletionChunkText(CXCompletionString completion_string,
4654  unsigned chunk_number);
4655 
4656 /**
4657  * \brief Retrieve the completion string associated with a particular chunk
4658  * within a completion string.
4659  *
4660  * \param completion_string the completion string to query.
4661  *
4662  * \param chunk_number the 0-based index of the chunk in the completion string.
4663  *
4664  * \returns the completion string associated with the chunk at index
4665  * \c chunk_number.
4666  */
4667 CINDEX_LINKAGE CXCompletionString
4668 clang_getCompletionChunkCompletionString(CXCompletionString completion_string,
4669  unsigned chunk_number);
4670 
4671 /**
4672  * \brief Retrieve the number of chunks in the given code-completion string.
4673  */
4674 CINDEX_LINKAGE unsigned
4675 clang_getNumCompletionChunks(CXCompletionString completion_string);
4676 
4677 /**
4678  * \brief Determine the priority of this code completion.
4679  *
4680  * The priority of a code completion indicates how likely it is that this
4681  * particular completion is the completion that the user will select. The
4682  * priority is selected by various internal heuristics.
4683  *
4684  * \param completion_string The completion string to query.
4685  *
4686  * \returns The priority of this completion string. Smaller values indicate
4687  * higher-priority (more likely) completions.
4688  */
4689 CINDEX_LINKAGE unsigned
4690 clang_getCompletionPriority(CXCompletionString completion_string);
4691 
4692 /**
4693  * \brief Determine the availability of the entity that this code-completion
4694  * string refers to.
4695  *
4696  * \param completion_string The completion string to query.
4697  *
4698  * \returns The availability of the completion string.
4699  */
4701 clang_getCompletionAvailability(CXCompletionString completion_string);
4702 
4703 /**
4704  * \brief Retrieve the number of annotations associated with the given
4705  * completion string.
4706  *
4707  * \param completion_string the completion string to query.
4708  *
4709  * \returns the number of annotations associated with the given completion
4710  * string.
4711  */
4712 CINDEX_LINKAGE unsigned
4713 clang_getCompletionNumAnnotations(CXCompletionString completion_string);
4714 
4715 /**
4716  * \brief Retrieve the annotation associated with the given completion string.
4717  *
4718  * \param completion_string the completion string to query.
4719  *
4720  * \param annotation_number the 0-based index of the annotation of the
4721  * completion string.
4722  *
4723  * \returns annotation string associated with the completion at index
4724  * \c annotation_number, or a NULL string if that annotation is not available.
4725  */
4727 clang_getCompletionAnnotation(CXCompletionString completion_string,
4728  unsigned annotation_number);
4729 
4730 /**
4731  * \brief Retrieve the parent context of the given completion string.
4732  *
4733  * The parent context of a completion string is the semantic parent of
4734  * the declaration (if any) that the code completion represents. For example,
4735  * a code completion for an Objective-C method would have the method's class
4736  * or protocol as its context.
4737  *
4738  * \param completion_string The code completion string whose parent is
4739  * being queried.
4740  *
4741  * \param kind DEPRECATED: always set to CXCursor_NotImplemented if non-NULL.
4742  *
4743  * \returns The name of the completion parent, e.g., "NSObject" if
4744  * the completion string represents a method in the NSObject class.
4745  */
4747 clang_getCompletionParent(CXCompletionString completion_string,
4748  enum CXCursorKind *kind);
4749 
4750 /**
4751  * \brief Retrieve the brief documentation comment attached to the declaration
4752  * that corresponds to the given completion string.
4753  */
4755 clang_getCompletionBriefComment(CXCompletionString completion_string);
4756 
4757 /**
4758  * \brief Retrieve a completion string for an arbitrary declaration or macro
4759  * definition cursor.
4760  *
4761  * \param cursor The cursor to query.
4762  *
4763  * \returns A non-context-sensitive completion string for declaration and macro
4764  * definition cursors, or NULL for other kinds of cursors.
4765  */
4766 CINDEX_LINKAGE CXCompletionString
4768 
4769 /**
4770  * \brief Contains the results of code-completion.
4771  *
4772  * This data structure contains the results of code completion, as
4773  * produced by \c clang_codeCompleteAt(). Its contents must be freed by
4774  * \c clang_disposeCodeCompleteResults.
4775  */
4776 typedef struct {
4777  /**
4778  * \brief The code-completion results.
4779  */
4781 
4782  /**
4783  * \brief The number of code-completion results stored in the
4784  * \c Results array.
4785  */
4786  unsigned NumResults;
4788 
4789 /**
4790  * \brief Flags that can be passed to \c clang_codeCompleteAt() to
4791  * modify its behavior.
4792  *
4793  * The enumerators in this enumeration can be bitwise-OR'd together to
4794  * provide multiple options to \c clang_codeCompleteAt().
4795  */
4797  /**
4798  * \brief Whether to include macros within the set of code
4799  * completions returned.
4800  */
4802 
4803  /**
4804  * \brief Whether to include code patterns for language constructs
4805  * within the set of code completions, e.g., for loops.
4806  */
4808 
4809  /**
4810  * \brief Whether to include brief documentation within the set of code
4811  * completions returned.
4812  */
4814 };
4815 
4816 /**
4817  * \brief Bits that represent the context under which completion is occurring.
4818  *
4819  * The enumerators in this enumeration may be bitwise-OR'd together if multiple
4820  * contexts are occurring simultaneously.
4821  */
4823  /**
4824  * \brief The context for completions is unexposed, as only Clang results
4825  * should be included. (This is equivalent to having no context bits set.)
4826  */
4828 
4829  /**
4830  * \brief Completions for any possible type should be included in the results.
4831  */
4833 
4834  /**
4835  * \brief Completions for any possible value (variables, function calls, etc.)
4836  * should be included in the results.
4837  */
4839  /**
4840  * \brief Completions for values that resolve to an Objective-C object should
4841  * be included in the results.
4842  */
4844  /**
4845  * \brief Completions for values that resolve to an Objective-C selector
4846  * should be included in the results.
4847  */
4849  /**
4850  * \brief Completions for values that resolve to a C++ class type should be
4851  * included in the results.
4852  */
4854 
4855  /**
4856  * \brief Completions for fields of the member being accessed using the dot
4857  * operator should be included in the results.
4858  */
4860  /**
4861  * \brief Completions for fields of the member being accessed using the arrow
4862  * operator should be included in the results.
4863  */
4865  /**
4866  * \brief Completions for properties of the Objective-C object being accessed
4867  * using the dot operator should be included in the results.
4868  */
4870 
4871  /**
4872  * \brief Completions for enum tags should be included in the results.
4873  */
4875  /**
4876  * \brief Completions for union tags should be included in the results.
4877  */
4879  /**
4880  * \brief Completions for struct tags should be included in the results.
4881  */
4883 
4884  /**
4885  * \brief Completions for C++ class names should be included in the results.
4886  */
4888  /**
4889  * \brief Completions for C++ namespaces and namespace aliases should be
4890  * included in the results.
4891  */
4893  /**
4894  * \brief Completions for C++ nested name specifiers should be included in
4895  * the results.
4896  */
4898 
4899  /**
4900  * \brief Completions for Objective-C interfaces (classes) should be included
4901  * in the results.
4902  */
4904  /**
4905  * \brief Completions for Objective-C protocols should be included in
4906  * the results.
4907  */
4909  /**
4910  * \brief Completions for Objective-C categories should be included in
4911  * the results.
4912  */
4914  /**
4915  * \brief Completions for Objective-C instance messages should be included
4916  * in the results.
4917  */
4919  /**
4920  * \brief Completions for Objective-C class messages should be included in
4921  * the results.
4922  */
4924  /**
4925  * \brief Completions for Objective-C selector names should be included in
4926  * the results.
4927  */
4929 
4930  /**
4931  * \brief Completions for preprocessor macro names should be included in
4932  * the results.
4933  */
4935 
4936  /**
4937  * \brief Natural language completions should be included in the results.
4938  */
4940 
4941  /**
4942  * \brief The current context is unknown, so set all contexts.
4943  */
4945 };
4946 
4947 /**
4948  * \brief Returns a default set of code-completion options that can be
4949  * passed to\c clang_codeCompleteAt().
4950  */
4952 
4953 /**
4954  * \brief Perform code completion at a given location in a translation unit.
4955  *
4956  * This function performs code completion at a particular file, line, and
4957  * column within source code, providing results that suggest potential
4958  * code snippets based on the context of the completion. The basic model
4959  * for code completion is that Clang will parse a complete source file,
4960  * performing syntax checking up to the location where code-completion has
4961  * been requested. At that point, a special code-completion token is passed
4962  * to the parser, which recognizes this token and determines, based on the
4963  * current location in the C/Objective-C/C++ grammar and the state of
4964  * semantic analysis, what completions to provide. These completions are
4965  * returned via a new \c CXCodeCompleteResults structure.
4966  *
4967  * Code completion itself is meant to be triggered by the client when the
4968  * user types punctuation characters or whitespace, at which point the
4969  * code-completion location will coincide with the cursor. For example, if \c p
4970  * is a pointer, code-completion might be triggered after the "-" and then
4971  * after the ">" in \c p->. When the code-completion location is afer the ">",
4972  * the completion results will provide, e.g., the members of the struct that
4973  * "p" points to. The client is responsible for placing the cursor at the
4974  * beginning of the token currently being typed, then filtering the results
4975  * based on the contents of the token. For example, when code-completing for
4976  * the expression \c p->get, the client should provide the location just after
4977  * the ">" (e.g., pointing at the "g") to this code-completion hook. Then, the
4978  * client can filter the results based on the current token text ("get"), only
4979  * showing those results that start with "get". The intent of this interface
4980  * is to separate the relatively high-latency acquisition of code-completion
4981  * results from the filtering of results on a per-character basis, which must
4982  * have a lower latency.
4983  *
4984  * \param TU The translation unit in which code-completion should
4985  * occur. The source files for this translation unit need not be
4986  * completely up-to-date (and the contents of those source files may
4987  * be overridden via \p unsaved_files). Cursors referring into the
4988  * translation unit may be invalidated by this invocation.
4989  *
4990  * \param complete_filename The name of the source file where code
4991  * completion should be performed. This filename may be any file
4992  * included in the translation unit.
4993  *
4994  * \param complete_line The line at which code-completion should occur.
4995  *
4996  * \param complete_column The column at which code-completion should occur.
4997  * Note that the column should point just after the syntactic construct that
4998  * initiated code completion, and not in the middle of a lexical token.
4999  *
5000  * \param unsaved_files the Files that have not yet been saved to disk
5001  * but may be required for parsing or code completion, including the
5002  * contents of those files. The contents and name of these files (as
5003  * specified by CXUnsavedFile) are copied when necessary, so the
5004  * client only needs to guarantee their validity until the call to
5005  * this function returns.
5006  *
5007  * \param num_unsaved_files The number of unsaved file entries in \p
5008  * unsaved_files.
5009  *
5010  * \param options Extra options that control the behavior of code
5011  * completion, expressed as a bitwise OR of the enumerators of the
5012  * CXCodeComplete_Flags enumeration. The
5013  * \c clang_defaultCodeCompleteOptions() function returns a default set
5014  * of code-completion options.
5015  *
5016  * \returns If successful, a new \c CXCodeCompleteResults structure
5017  * containing code-completion results, which should eventually be
5018  * freed with \c clang_disposeCodeCompleteResults(). If code
5019  * completion fails, returns NULL.
5020  */
5022 CXCodeCompleteResults *clang_codeCompleteAt(CXTranslationUnit TU,
5023  const char *complete_filename,
5024  unsigned complete_line,
5025  unsigned complete_column,
5026  struct CXUnsavedFile *unsaved_files,
5027  unsigned num_unsaved_files,
5028  unsigned options);
5029 
5030 /**
5031  * \brief Sort the code-completion results in case-insensitive alphabetical
5032  * order.
5033  *
5034  * \param Results The set of results to sort.
5035  * \param NumResults The number of results in \p Results.
5036  */
5039  unsigned NumResults);
5040 
5041 /**
5042  * \brief Free the given set of code-completion results.
5043  */
5046 
5047 /**
5048  * \brief Determine the number of diagnostics produced prior to the
5049  * location where code completion was performed.
5050  */
5053 
5054 /**
5055  * \brief Retrieve a diagnostic associated with the given code completion.
5056  *
5057  * \param Results the code completion results to query.
5058  * \param Index the zero-based diagnostic number to retrieve.
5059  *
5060  * \returns the requested diagnostic. This diagnostic must be freed
5061  * via a call to \c clang_disposeDiagnostic().
5062  */
5065  unsigned Index);
5066 
5067 /**
5068  * \brief Determines what completions are appropriate for the context
5069  * the given code completion.
5070  *
5071  * \param Results the code completion results to query
5072  *
5073  * \returns the kinds of completions that are appropriate for use
5074  * along with the given code completion results.
5075  */
5077 unsigned long long clang_codeCompleteGetContexts(
5078  CXCodeCompleteResults *Results);
5079 
5080 /**
5081  * \brief Returns the cursor kind for the container for the current code
5082  * completion context. The container is only guaranteed to be set for
5083  * contexts where a container exists (i.e. member accesses or Objective-C
5084  * message sends); if there is not a container, this function will return
5085  * CXCursor_InvalidCode.
5086  *
5087  * \param Results the code completion results to query
5088  *
5089  * \param IsIncomplete on return, this value will be false if Clang has complete
5090  * information about the container. If Clang does not have complete
5091  * information, this value will be true.
5092  *
5093  * \returns the container kind, or CXCursor_InvalidCode if there is not a
5094  * container
5095  */
5098  CXCodeCompleteResults *Results,
5099  unsigned *IsIncomplete);
5100 
5101 /**
5102  * \brief Returns the USR for the container for the current code completion
5103  * context. If there is not a container for the current context, this
5104  * function will return the empty string.
5105  *
5106  * \param Results the code completion results to query
5107  *
5108  * \returns the USR for the container
5109  */
5112 
5113 /**
5114  * \brief Returns the currently-entered selector for an Objective-C message
5115  * send, formatted like "initWithFoo:bar:". Only guaranteed to return a
5116  * non-empty string for CXCompletionContext_ObjCInstanceMessage and
5117  * CXCompletionContext_ObjCClassMessage.
5118  *
5119  * \param Results the code completion results to query
5120  *
5121  * \returns the selector (or partial selector) that has been entered thus far
5122  * for an Objective-C message send.
5123  */
5126 
5127 /**
5128  * @}
5129  */
5130 
5131 /**
5132  * \defgroup CINDEX_MISC Miscellaneous utility functions
5133  *
5134  * @{
5135  */
5136 
5137 /**
5138  * \brief Return a version string, suitable for showing to a user, but not
5139  * intended to be parsed (the format is not guaranteed to be stable).
5140  */
5142 
5143 /**
5144  * \brief Enable/disable crash recovery.
5145  *
5146  * \param isEnabled Flag to indicate if crash recovery is enabled. A non-zero
5147  * value enables crash recovery, while 0 disables it.
5148  */
5150 
5151  /**
5152  * \brief Visitor invoked for each file in a translation unit
5153  * (used with clang_getInclusions()).
5154  *
5155  * This visitor function will be invoked by clang_getInclusions() for each
5156  * file included (either at the top-level or by \#include directives) within
5157  * a translation unit. The first argument is the file being included, and
5158  * the second and third arguments provide the inclusion stack. The
5159  * array is sorted in order of immediate inclusion. For example,
5160  * the first element refers to the location that included 'included_file'.
5161  */
5162 typedef void (*CXInclusionVisitor)(CXFile included_file,
5163  CXSourceLocation* inclusion_stack,
5164  unsigned include_len,
5165  CXClientData client_data);
5166 
5167 /**
5168  * \brief Visit the set of preprocessor inclusions in a translation unit.
5169  * The visitor function is called with the provided data for every included
5170  * file. This does not include headers included by the PCH file (unless one
5171  * is inspecting the inclusions in the PCH file itself).
5172  */
5173 CINDEX_LINKAGE void clang_getInclusions(CXTranslationUnit tu,
5174  CXInclusionVisitor visitor,
5175  CXClientData client_data);
5176 
5177 typedef enum {
5184 
5186 
5187 } CXEvalResultKind ;
5188 
5189 /**
5190  * \brief Evaluation result of a cursor
5191  */
5192 typedef void * CXEvalResult;
5193 
5194 /**
5195  * \brief If cursor is a statement declaration tries to evaluate the
5196  * statement and if its variable, tries to evaluate its initializer,
5197  * into its corresponding type.
5198  */
5200 
5201 /**
5202  * \brief Returns the kind of the evaluated result.
5203  */
5205 
5206 /**
5207  * \brief Returns the evaluation result as integer if the
5208  * kind is Int.
5209  */
5210 CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);
5211 
5212 /**
5213  * \brief Returns the evaluation result as double if the
5214  * kind is double.
5215  */
5216 CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);
5217 
5218 /**
5219  * \brief Returns the evaluation result as a constant string if the
5220  * kind is other than Int or float. User must not free this pointer,
5221  * instead call clang_EvalResult_dispose on the CXEvalResult returned
5222  * by clang_Cursor_Evaluate.
5223  */
5224 CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);
5225 
5226 /**
5227  * \brief Disposes the created Eval memory.
5228  */
5229 CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
5230 /**
5231  * @}
5232  */
5233 
5234 /** \defgroup CINDEX_REMAPPING Remapping functions
5235  *
5236  * @{
5237  */
5238 
5239 /**
5240  * \brief A remapping of original source files and their translated files.
5241  */
5242 typedef void *CXRemapping;
5243 
5244 /**
5245  * \brief Retrieve a remapping.
5246  *
5247  * \param path the path that contains metadata about remappings.
5248  *
5249  * \returns the requested remapping. This remapping must be freed
5250  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5251  */
5252 CINDEX_LINKAGE CXRemapping clang_getRemappings(const char *path);
5253 
5254 /**
5255  * \brief Retrieve a remapping.
5256  *
5257  * \param filePaths pointer to an array of file paths containing remapping info.
5258  *
5259  * \param numFiles number of file paths.
5260  *
5261  * \returns the requested remapping. This remapping must be freed
5262  * via a call to \c clang_remap_dispose(). Can return NULL if an error occurred.
5263  */
5265 CXRemapping clang_getRemappingsFromFileList(const char **filePaths,
5266  unsigned numFiles);
5267 
5268 /**
5269  * \brief Determine the number of remappings.
5270  */
5271 CINDEX_LINKAGE unsigned clang_remap_getNumFiles(CXRemapping);
5272 
5273 /**
5274  * \brief Get the original and the associated filename from the remapping.
5275  *
5276  * \param original If non-NULL, will be set to the original filename.
5277  *
5278  * \param transformed If non-NULL, will be set to the filename that the original
5279  * is associated with.
5280  */
5281 CINDEX_LINKAGE void clang_remap_getFilenames(CXRemapping, unsigned index,
5282  CXString *original, CXString *transformed);
5283 
5284 /**
5285  * \brief Dispose the remapping.
5286  */
5287 CINDEX_LINKAGE void clang_remap_dispose(CXRemapping);
5288 
5289 /**
5290  * @}
5291  */
5292 
5293 /** \defgroup CINDEX_HIGH Higher level API functions
5294  *
5295  * @{
5296  */
5297 
5301 };
5302 
5303 typedef struct {
5304  void *context;
5305  enum CXVisitorResult (*visit)(void *context, CXCursor, CXSourceRange);
5307 
5308 typedef enum {
5309  /**
5310  * \brief Function returned successfully.
5311  */
5313  /**
5314  * \brief One of the parameters was invalid for the function.
5315  */
5317  /**
5318  * \brief The function was terminated by a callback (e.g. it returned
5319  * CXVisit_Break)
5320  */
5322 
5323 } CXResult;
5324 
5325 /**
5326  * \brief Find references of a declaration in a specific file.
5327  *
5328  * \param cursor pointing to a declaration or a reference of one.
5329  *
5330  * \param file to search for references.
5331  *
5332  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5333  * each reference found.
5334  * The CXSourceRange will point inside the file; if the reference is inside
5335  * a macro (and not a macro argument) the CXSourceRange will be invalid.
5336  *
5337  * \returns one of the CXResult enumerators.
5338  */
5340  CXCursorAndRangeVisitor visitor);
5341 
5342 /**
5343  * \brief Find #import/#include directives in a specific file.
5344  *
5345  * \param TU translation unit containing the file to query.
5346  *
5347  * \param file to search for #import/#include directives.
5348  *
5349  * \param visitor callback that will receive pairs of CXCursor/CXSourceRange for
5350  * each directive found.
5351  *
5352  * \returns one of the CXResult enumerators.
5353  */
5354 CINDEX_LINKAGE CXResult clang_findIncludesInFile(CXTranslationUnit TU,
5355  CXFile file,
5356  CXCursorAndRangeVisitor visitor);
5357 
5358 #ifdef __has_feature
5359 # if __has_feature(blocks)
5360 
5361 typedef enum CXVisitorResult
5362  (^CXCursorAndRangeVisitorBlock)(CXCursor, CXSourceRange);
5363 
5365 CXResult clang_findReferencesInFileWithBlock(CXCursor, CXFile,
5366  CXCursorAndRangeVisitorBlock);
5367 
5369 CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit, CXFile,
5370  CXCursorAndRangeVisitorBlock);
5371 
5372 # endif
5373 #endif
5374 
5375 /**
5376  * \brief The client's data object that is associated with a CXFile.
5377  */
5378 typedef void *CXIdxClientFile;
5379 
5380 /**
5381  * \brief The client's data object that is associated with a semantic entity.
5382  */
5383 typedef void *CXIdxClientEntity;
5384 
5385 /**
5386  * \brief The client's data object that is associated with a semantic container
5387  * of entities.
5388  */
5389 typedef void *CXIdxClientContainer;
5390 
5391 /**
5392  * \brief The client's data object that is associated with an AST file (PCH
5393  * or module).
5394  */
5395 typedef void *CXIdxClientASTFile;
5396 
5397 /**
5398  * \brief Source location passed to index callbacks.
5399  */
5400 typedef struct {
5401  void *ptr_data[2];
5402  unsigned int_data;
5403 } CXIdxLoc;
5404 
5405 /**
5406  * \brief Data for ppIncludedFile callback.
5407  */
5408 typedef struct {
5409  /**
5410  * \brief Location of '#' in the \#include/\#import directive.
5411  */
5413  /**
5414  * \brief Filename as written in the \#include/\#import directive.
5415  */
5416  const char *filename;
5417  /**
5418  * \brief The actual file that the \#include/\#import directive resolved to.
5419  */
5420  CXFile file;
5423  /**
5424  * \brief Non-zero if the directive was automatically turned into a module
5425  * import.
5426  */
5429 
5430 /**
5431  * \brief Data for IndexerCallbacks#importedASTFile.
5432  */
5433 typedef struct {
5434  /**
5435  * \brief Top level AST file containing the imported PCH, module or submodule.
5436  */
5437  CXFile file;
5438  /**
5439  * \brief The imported module or NULL if the AST file is a PCH.
5440  */
5441  CXModule module;
5442  /**
5443  * \brief Location where the file is imported. Applicable only for modules.
5444  */
5446  /**
5447  * \brief Non-zero if an inclusion directive was automatically turned into
5448  * a module import. Applicable only for modules.
5449  */
5451 
5453 
5454 typedef enum {
5461 
5465 
5470 
5474 
5486 
5487 } CXIdxEntityKind;
5488 
5489 typedef enum {
5495 
5496 /**
5497  * \brief Extra C++ template information for an entity. This can apply to:
5498  * CXIdxEntity_Function
5499  * CXIdxEntity_CXXClass
5500  * CXIdxEntity_CXXStaticMethod
5501  * CXIdxEntity_CXXInstanceMethod
5502  * CXIdxEntity_CXXConstructor
5503  * CXIdxEntity_CXXConversionFunction
5504  * CXIdxEntity_CXXTypeAlias
5505  */
5506 typedef enum {
5512 
5513 typedef enum {
5518 } CXIdxAttrKind;
5519 
5520 typedef struct {
5522  CXCursor cursor;
5524 } CXIdxAttrInfo;
5525 
5526 typedef struct {
5530  const char *name;
5531  const char *USR;
5532  CXCursor cursor;
5533  const CXIdxAttrInfo *const *attributes;
5534  unsigned numAttributes;
5535 } CXIdxEntityInfo;
5536 
5537 typedef struct {
5538  CXCursor cursor;
5540 
5541 typedef struct {
5544  CXCursor classCursor;
5547 
5548 typedef enum {
5551 
5552 typedef struct {
5554  CXCursor cursor;
5557  /**
5558  * \brief Generally same as #semanticContainer but can be different in
5559  * cases like out-of-line C++ member functions.
5560  */
5566  /**
5567  * \brief Whether the declaration exists in code or was created implicitly
5568  * by the compiler, e.g. implicit Objective-C methods for properties.
5569  */
5571  const CXIdxAttrInfo *const *attributes;
5572  unsigned numAttributes;
5573 
5574  unsigned flags;
5575 
5576 } CXIdxDeclInfo;
5577 
5578 typedef enum {
5583 
5584 typedef struct {
5588 
5589 typedef struct {
5591  CXCursor cursor;
5594 
5595 typedef struct {
5597  CXCursor cursor;
5600 
5601 typedef struct {
5603  unsigned numProtocols;
5605 
5606 typedef struct {
5611 
5612 typedef struct {
5615  CXCursor classCursor;
5619 
5620 typedef struct {
5625 
5626 typedef struct {
5628  const CXIdxBaseClassInfo *const *bases;
5629  unsigned numBases;
5631 
5632 /**
5633  * \brief Data for IndexerCallbacks#indexEntityReference.
5634  */
5635 typedef enum {
5636  /**
5637  * \brief The entity is referenced directly in user's code.
5638  */
5640  /**
5641  * \brief An implicit reference, e.g. a reference of an Objective-C method
5642  * via the dot syntax.
5643  */
5646 
5647 /**
5648  * \brief Data for IndexerCallbacks#indexEntityReference.
5649  */
5650 typedef struct {
5652  /**
5653  * \brief Reference cursor.
5654  */
5655  CXCursor cursor;
5657  /**
5658  * \brief The entity that gets referenced.
5659  */
5661  /**
5662  * \brief Immediate "parent" of the reference. For example:
5663  *
5664  * \code
5665  * Foo *var;
5666  * \endcode
5667  *
5668  * The parent of reference of type 'Foo' is the variable 'var'.
5669  * For references inside statement bodies of functions/methods,
5670  * the parentEntity will be the function/method.
5671  */
5673  /**
5674  * \brief Lexical container context of the reference.
5675  */
5678 
5679 /**
5680  * \brief A group of callbacks used by #clang_indexSourceFile and
5681  * #clang_indexTranslationUnit.
5682  */
5683 typedef struct {
5684  /**
5685  * \brief Called periodically to check whether indexing should be aborted.
5686  * Should return 0 to continue, and non-zero to abort.
5687  */
5688  int (*abortQuery)(CXClientData client_data, void *reserved);
5689 
5690  /**
5691  * \brief Called at the end of indexing; passes the complete diagnostic set.
5692  */
5693  voi